GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

pluginified most of hasFave, getFaves and related calls

Browse Source 
The code is now more event-driven when it comes to rendering notices
and their related HTML elements, since we can't have direct calls from
core to a plugin.

lib/activitymover.php has a function to move a Favorite activity which
will not happen now. The move must be pluginified and performed as an
event which plugins can catch on to.
This commit is contained in:
Mikael Nordfeldth 2014-06-27 13:58:35 +02:00
parent 29730b6ca7
commit fcdd061b4f
29 changed files with 580 additions and 421 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
EVENTS.txt
View File

@ -267,12 +267,6 @@ StartShowNoticeOptions: just before showing notice options like fave, repeat, et
EndShowNoticeOptions: just after showing notice options like fave, repeat, etc.
- $item: the NoticeListItem object being shown
StartShowFaveForm: just before showing the fave form
- $item: the NoticeListItem object being shown
EndShowFaveForm: just after showing the fave form
- $item: the NoticeListItem object being shown
StartShowPageNotice: just before showing the page notice (instructions or error)
- $action: action object being shown

10
actions/apistatusesupdate.php
View File

@ -337,12 +337,14 @@ class ApiStatusesUpdateAction extends ApiAuthAction
function supported($cmd)
{
static $cmdlist = array('MessageCommand', 'SubCommand', 'UnsubCommand',
'FavCommand', 'OnCommand', 'OffCommand', 'JoinCommand', 'LeaveCommand');
'OnCommand', 'OffCommand', 'JoinCommand', 'LeaveCommand');
if (in_array(get_class($cmd), $cmdlist)) {
return true;
$supported = null;
if (Event::handle('CommandSupportedAPI', array($cmd, &$supported))) {
$supported = $supported || in_array(get_class($cmd), $cmdlist);
}
return false;
return $supported;
}
}

75
classes/Notice.php
View File

@ -194,7 +194,6 @@ class Notice extends Managed_DataObject
$this->clearReplies();
$this->clearRepeats();
$this->clearFaves();
$this->clearTags();
$this->clearGroupInboxes();
$this->clearFiles();
@ -1730,16 +1729,18 @@ class Notice extends Managed_DataObject
// favorite and repeated
$scoped = null;
if (!empty($cur)) {
$cp = $cur->getProfile();
$noticeInfoAttr['favorite'] = ($cp->hasFave($this)) ? "true" : "false";
$noticeInfoAttr['repeated'] = ($cp->hasRepeated($this)) ? "true" : "false";
$scoped = $cur->getProfile();
$noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
}
if (!empty($this->repeat_of)) {
$noticeInfoAttr['repeat_of'] = $this->repeat_of;
}
Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
return array('statusnet:notice_info', $noticeInfoAttr, null);
}
@ -2021,24 +2022,6 @@ class Notice extends Managed_DataObject
}
}
function clearFaves()
{
$fave = new Fave();
$fave->notice_id = $this->id;
if ($fave->find()) {
while ($fave->fetch()) {
self::blow('fave:ids_by_user_own:%d', $fave->user_id);
self::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
self::blow('fave:ids_by_user:%d', $fave->user_id);
self::blow('fave:ids_by_user:%d;last', $fave->user_id);
$fave->delete();
}
}
$fave->free();
}
function clearTags()
{
$tag = new Notice_tag();
@ -2570,14 +2553,13 @@ class Notice extends Managed_DataObject
}
}
static function _idsOf(&$notices)
static function _idsOf(array &$notices)
{
$ids = array();
foreach ($notices as $notice) {
$ids[] = $notice->id;
$ids[$notice->id] = true;
}
$ids = array_unique($ids);
return $ids;
return array_keys($ids);
}
static function fillAttachments(&$notices)
@ -2609,47 +2591,6 @@ class Notice extends Managed_DataObject
}
}
protected $_faves = array();
/**
* All faves of this notice
*
* @return array Array of Fave objects
*/
function getFaves()
{
if (isset($this->_faves[$this->id])) {
return $this->_faves[$this->id];
}
$faveMap = Fave::listGet('notice_id', array($this->id));
$this->_faves[$this->id] = $faveMap[$this->id];
return $this->_faves[$this->id];
}
function _setFaves($faves)
{
$this->_faves[$this->id] = $faves;
}
static function fillFaves(&$notices)
{
$ids = self::_idsOf($notices);
$faveMap = Fave::listGet('notice_id', $ids);
$cnt = 0;
$faved = array();
foreach ($faveMap as $id => $faves) {
$cnt += count($faves);
if (count($faves) > 0) {
$faved[] = $id;
}
}
foreach ($notices as $notice) {
$faves = $faveMap[$notice->id];
$notice->_setFaves($faves);
}
}
static function fillReplies(&$notices)
{
$ids = self::_idsOf($notices);

4
lib/activitymover.php
View File

@ -93,7 +93,7 @@ class ActivityMover extends QueueHandler
}
switch ($act->verb) {
case ActivityVerb::FAVORITE:
/* case ActivityVerb::FAVORITE:
$this->log(LOG_INFO,
"Moving favorite of {$act->objects[0]->id} by ".
"{$act->actor->id} to {$remote->nickname}.");
@ -105,7 +105,7 @@ class ActivityMover extends QueueHandler
'notice_id' => $notice->id));
$fave->delete();
}
break;
break;*/
case ActivityVerb::POST:
$this->log(LOG_INFO,
"Moving notice {$act->objects[0]->id} by ".

13
lib/apiaction.php
View File

@ -295,13 +295,18 @@ class ApiAction extends Action
function twitterStatusArray($notice, $include_user=true)
{
// The event call to handle NoticeSimpleStatusArray lets plugins add data to the output array
$base = $this->twitterSimpleStatusArray($notice, $include_user);
Event::handle('NoticeSimpleStatusArray', array($notice, &$base, $this->scoped,
array('include_user'=>$include_user)));
if (!empty($notice->repeat_of)) {
$original = Notice::getKV('id', $notice->repeat_of);
if (!empty($original)) {
$original_array = $this->twitterSimpleStatusArray($original, $include_user);
$base['retweeted_status'] = $original_array;
if ($original instanceof Notice) {
$orig_array = $this->twitterSimpleStatusArray($original, $include_user);
Event::handle('NoticeSimpleStatusArray', array($original, &$orig_array, $this->scoped,
array('include_user'=>$include_user)));
$base['retweeted_status'] = $orig_array;
}
}
@ -369,10 +374,8 @@ class ApiAction extends Action
}
if (!is_null($this->scoped)) {
$twitter_status['favorited'] = $this->scoped->hasFave($notice);
$twitter_status['repeated'] = $this->scoped->hasRepeated($notice);
} else {
$twitter_status['favorited'] = false;
$twitter_status['repeated'] = false;
}

57
lib/command.php
View File

@ -276,57 +276,6 @@ class StatsCommand extends Command
}
}
class FavCommand extends Command
{
var $other = null;
function __construct($user, $other)
{
parent::__construct($user);
$this->other = $other;
}
function handle($channel)
{
$notice = $this->getNotice($this->other);
$fave = new Fave();
$fave->user_id = $this->user->id;
$fave->notice_id = $notice->id;
$fave->find();
if ($fave->fetch()) {
// TRANS: Error message text shown when a favorite could not be set because it has already been favorited.
$channel->error($this->user, _('Could not create favorite: Already favorited.'));
return;
}
$fave = Fave::addNew($this->user->getProfile(), $notice);
if (!$fave) {
// TRANS: Error message text shown when a favorite could not be set.
$channel->error($this->user, _('Could not create favorite.'));
return;
}
// @fixme favorite notification should be triggered
// at a lower level
$other = User::getKV('id', $notice->profile_id);
if ($other && $other->id != $this->user->id) {
if ($other->email && $other->emailnotifyfav) {
mail_notify_fave($other, $this->user, $notice);
}
}
$this->user->blowFavesCache();
// TRANS: Text shown when a notice has been marked as favourite successfully.
$channel->output($this->user, _('Notice marked as fave.'));
}
}
class JoinCommand extends Command
{
var $other = null;
@ -1036,10 +985,6 @@ class HelpCommand extends Command
"whois <nickname>" => _m('COMMANDHELP', "get profile info on user"),
// TRANS: Help message for IM/SMS command "lose <nickname>".
"lose <nickname>" => _m('COMMANDHELP', "force user to stop following you"),
// TRANS: Help message for IM/SMS command "fav <nickname>".
"fav <nickname>" => _m('COMMANDHELP', "add user's last notice as a 'fave'"),
// TRANS: Help message for IM/SMS command "fav #<notice_id>".
"fav #<notice_id>" => _m('COMMANDHELP', "add notice with the given id as a 'fave'"),
// TRANS: Help message for IM/SMS command "repeat #<notice_id>".
"repeat #<notice_id>" => _m('COMMANDHELP', "repeat a notice with a given id"),
// TRANS: Help message for IM/SMS command "repeat <nickname>".
@ -1089,6 +1034,8 @@ class HelpCommand extends Command
// Give plugins a chance to add or override...
Event::handle('HelpCommandMessages', array($this, &$commands));
sort($commands);
foreach ($commands as $command => $help) {
$out[] = "$command - $help";
}

14
lib/commandinterpreter.php
View File

@ -37,7 +37,7 @@ class CommandInterpreter
$cmd = strtolower($cmd);
if (Event::handle('StartIntepretCommand', array($cmd, $arg, $user, &$result))) {
if (Event::handle('StartInterpretCommand', array($cmd, $arg, $user, &$result))) {
switch($cmd) {
case 'help':
if ($arg) {
@ -231,18 +231,6 @@ class CommandInterpreter
}
}
break;
case 'fav':
if (!$arg) {
$result = null;
} else {
list($other, $extra) = $this->split_arg($arg);
if ($extra) {
$result = null;
} else {
$result = new FavCommand($user, $other);
}
}
break;
case 'nudge':
if (!$arg) {
$result = null;

24
lib/noticelist.php
View File

@ -116,33 +116,25 @@ class NoticeList extends Widget
return new NoticeListItem($notice, $this->out);
}
static function prefill(&$notices, $avatarSize=AVATAR_STREAM_SIZE)
static function prefill(array &$notices)
{
if (Event::handle('StartNoticeListPrefill', array(&$notices, $avatarSize))) {
$scoped = Profile::current();
$notice_ids = Notice::_idsOf($notices);
if (Event::handle('StartNoticeListPrefill', array(&$notices, $notice_ids, $scoped))) {
// Prefill attachments
Notice::fillAttachments($notices);
// Prefill attachments
Notice::fillFaves($notices);
// Prefill repeat data
Notice::fillRepeats($notices);
// Prefill the profiles
$profiles = Notice::fillProfiles($notices);
$p = Profile::current();
if ($p instanceof Profile) {
$ids = array();
foreach ($notices as $notice) {
$ids[] = $notice->id;
if ($scoped instanceof Profile) {
Notice::pivotGet('repeat_of', $notice_ids, array('profile_id' => $scoped->id));
}
Fave::pivotGet('notice_id', $ids, array('user_id' => $p->id));
Notice::pivotGet('repeat_of', $ids, array('profile_id' => $p->id));
}
Event::handle('EndNoticeListPrefill', array(&$notices, &$profiles, $avatarSize));
Event::handle('EndNoticeListPrefill', array(&$notices, &$profiles, $notice_ids, $scoped));
}
}
}

84
lib/noticelistactorsitem.php Normal file
View File

@ -0,0 +1,84 @@
<?php
/**
* GNU Social - a federating social network
* Copyright (C) 2014, Free Software Foundation, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
if (!defined('GNUSOCIAL')) { exit(1); }
/**
* Placeholder for showing faves...
*/
abstract class NoticeListActorsItem extends NoticeListItem
{
/**
* @return array of profile IDs
*/
abstract function getProfiles();
abstract function getListMessage($count, $you);
function show()
{
$links = array();
$you = false;
$cur = common_current_user();
foreach ($this->getProfiles() as $id) {
if ($cur && $cur->id == $id) {
$you = true;
// TRANS: Reference to the logged in user in favourite list.
array_unshift($links, _m('FAVELIST', 'You'));
} else {
$profile = Profile::getKV('id', $id);
if ($profile instanceof Profile) {
$links[] = sprintf('<a class="h-card" href="%s">%s</a>',
htmlspecialchars($profile->getUrl()),
htmlspecialchars($profile->getBestName()));
}
}
}
if ($links) {
$count = count($links);
$msg = $this->getListMessage($count, $you);
$out = sprintf($msg, $this->magicList($links));
$this->showStart();
$this->out->raw($out);
$this->showEnd();
return $count;
} else {
return 0;
}
}
function magicList($items)
{
if (count($items) == 0) {
return '';
} else if (count($items) == 1) {
return $items[0];
} else {
$first = array_slice($items, 0, -1);
$last = array_slice($items, -1, 1);
// TRANS: Separator in list of user names like "Jim, Bob, Mary".
$separator = _(', ');
// TRANS: For building a list such as "Jim, Bob, Mary and 5 others like this".
// TRANS: %1$s is a list of users, separated by a separator (default: ", "), %2$s is the last user in the list.
return sprintf(_m('FAVELIST', '%1$s and %2$s'), implode($separator, $first), implode($separator, $last));
}
}
}

23
lib/noticelistitem.php
View File

@ -153,7 +153,6 @@ class NoticeListItem extends Widget
if ($user) {
$this->out->elementStart('div', 'notice-options');
if (Event::handle('StartShowNoticeOptionItems', array($this))) {
$this->showFaveForm();
$this->showReplyLink();
$this->showRepeatForm();
$this->showDeleteLink();
@ -187,28 +186,6 @@ class NoticeListItem extends Widget
}
}
/**
* show the "favorite" form
*
* @return void
*/
function showFaveForm()
{
if (Event::handle('StartShowFaveForm', array($this))) {
$user = common_current_user();
if ($user) {
if ($user->hasFave($this->notice)) {
$disfavor = new DisfavorForm($this->out, $this->notice);
$disfavor->show();
} else {
$favor = new FavorForm($this->out, $this->notice);
$favor->show();
}
}
Event::handle('EndShowFaveForm', array($this));
}
}
/**
* show the author of a notice
*

5
lib/noticelistitemadapter.php
View File

@ -70,4 +70,9 @@ class NoticeListItemAdapter
{
return call_user_func_array(array($this->nli, $name), $arguments);
}
function __get($name)
{
return $this->nli->$name;
}
}

164
lib/threadednoticelist.php
View File

@ -229,16 +229,22 @@ class ThreadedNoticeListItem extends NoticeListItem
}
if (Event::handle('StartShowThreadedNoticeTail', array($this, $this->notice, &$notices))) {
$threadActive = count($notices) > 0; // has this thread had any activity?
$this->out->elementStart('ul', 'notices threaded-replies xoxo');
$item = new ThreadedNoticeListFavesItem($this->notice, $this->out);
$hasFaves = $item->show();
if (Event::handle('StartShowThreadedNoticeTailItems', array($this, $this->notice, &$threadActive))) {
// Show the repeats-button for this notice. If there are repeats,
// the show() function will return true, definitely setting our
// $threadActive flag, which will be used later to show a reply box.
$item = new ThreadedNoticeListRepeatsItem($this->notice, $this->out);
$hasRepeats = $item->show();
$threadActive = $item->show() || $threadActive;
if ($notices) {
Event::handle('EndShowThreadedNoticeTailItems', array($this, $this->notice, &$threadActive));
}
if (count($notices)>0) {
if ($moreCutoff) {
$item = new ThreadedNoticeListMoreItem($moreCutoff, $this->out, count($notices));
$item->show();
@ -247,19 +253,17 @@ class ThreadedNoticeListItem extends NoticeListItem
if (Event::handle('StartShowThreadedNoticeSub', array($this, $this->notice, $notice))) {
$item = new ThreadedNoticeListSubItem($notice, $this->notice, $this->out);
$item->show();
Event::handle('StartShowThreadedNoticeSub', array($this, $this->notice, $notice));
Event::handle('EndShowThreadedNoticeSub', array($this, $this->notice, $notice));
}
}
}
if ($notices || $hasFaves || $hasRepeats) {
if ($threadActive && Profile::current() instanceof Profile) {
// @fixme do a proper can-post check that's consistent
// with the JS side
if (common_current_user()) {
$item = new ThreadedNoticeListReplyItem($this->notice, $this->out);
$item->show();
}
}
$this->out->elementEnd('ul');
Event::handle('EndShowThreadedNoticeTail', array($this, $this->notice, $notices));
}
@ -319,10 +323,12 @@ class ThreadedNoticeListSubItem extends NoticeListItem
function showEnd()
{
$item = new ThreadedNoticeListInlineFavesItem($this->notice, $this->out);
$hasFaves = $item->show();
$threadActive = null; // unused here for now, but maybe in the future?
if (Event::handle('StartShowThreadedNoticeTailItems', array($this, $this->notice, &$threadActive))) {
$item = new ThreadedNoticeListInlineRepeatsItem($this->notice, $this->out);
$hasRepeats = $item->show();
Event::handle('EndShowThreadedNoticeTailItems', array($this, $this->notice, &$threadActive));
}
parent::showEnd();
}
}
@ -419,144 +425,6 @@ class ThreadedNoticeListReplyItem extends NoticeListItem
}
}
/**
* Placeholder for showing faves...
*/
abstract class NoticeListActorsItem extends NoticeListItem
{
/**
* @return array of profile IDs
*/
abstract function getProfiles();
abstract function getListMessage($count, $you);
function show()
{
$links = array();
$you = false;
$cur = common_current_user();
foreach ($this->getProfiles() as $id) {
if ($cur && $cur->id == $id) {
$you = true;
// TRANS: Reference to the logged in user in favourite list.
array_unshift($links, _m('FAVELIST', 'You'));
} else {
$profile = Profile::getKV('id', $id);
if ($profile instanceof Profile) {
$links[] = sprintf('<a class="h-card" href="%s">%s</a>',
htmlspecialchars($profile->getUrl()),
htmlspecialchars($profile->getBestName()));
}
}
}
if ($links) {
$count = count($links);
$msg = $this->getListMessage($count, $you);
$out = sprintf($msg, $this->magicList($links));
$this->showStart();
$this->out->raw($out);
$this->showEnd();
return $count;
} else {
return 0;
}
}
function magicList($items)
{
if (count($items) == 0) {
return '';
} else if (count($items) == 1) {
return $items[0];
} else {
$first = array_slice($items, 0, -1);
$last = array_slice($items, -1, 1);
// TRANS: Separator in list of user names like "Jim, Bob, Mary".
$separator = _(', ');
// TRANS: For building a list such as "Jim, Bob, Mary and 5 others like this".
// TRANS: %1$s is a list of users, separated by a separator (default: ", "), %2$s is the last user in the list.
return sprintf(_m('FAVELIST', '%1$s and %2$s'), implode($separator, $first), implode($separator, $last));
}
}
}
/**
* Placeholder for showing faves...
*/
class ThreadedNoticeListFavesItem extends NoticeListActorsItem
{
function getProfiles()
{
$faves = $this->notice->getFaves();
$profiles = array();
foreach ($faves as $fave) {
$profiles[] = $fave->user_id;
}
return $profiles;
}
function magicList($items)
{
if (count($items) > 4) {
return parent::magicList(array_slice($items, 0, 3));
} else {
return parent::magicList($items);
}
}
function getListMessage($count, $you)
{
if ($count == 1 && $you) {
// darn first person being different from third person!
// TRANS: List message for notice favoured by logged in user.
return _m('FAVELIST', 'You like this.');
} else if ($count > 4) {
// TRANS: List message for when more than 4 people like something.
// TRANS: %%s is a list of users liking a notice, %d is the number over 4 that like the notice.
// TRANS: Plural is decided on the total number of users liking the notice (count of %%s + %d).
return sprintf(_m('%%s and %d others like this.',
'%%s and %d others like this.',
$count),
$count - 3);
} else {
// TRANS: List message for favoured notices.
// TRANS: %%s is a list of users liking a notice.
// TRANS: Plural is based on the number of of users that have favoured a notice.
return sprintf(_m('%%s likes this.',
'%%s like this.',
$count),
$count);
}
}
function showStart()
{
$this->out->elementStart('li', array('class' => 'notice-data notice-faves'));
}
function showEnd()
{
$this->out->elementEnd('li');
}
}
// @todo FIXME: needs documentation.
class ThreadedNoticeListInlineFavesItem extends ThreadedNoticeListFavesItem
{
function showStart()
{
$this->out->elementStart('div', array('class' => 'notice-faves'));
}
function showEnd()
{
$this->out->elementEnd('div');
}
}
/**
* Placeholder for showing repeats...
*/

33
lib/useractivitystream.php
View File

@ -20,7 +20,7 @@
/**
* Class for activity streams
*
* Includes faves, notices, and subscriptions.
* Includes objects like notices, subscriptions and from plugins.
*
* We extend atomusernoticefeed since it does some nice setup for us.
*
@ -28,6 +28,7 @@
class UserActivityStream extends AtomUserNoticeFeed
{
public $activities = array();
public $after = null;
const OUTPUT_STRING = 1;
const OUTPUT_RAW = 2;
@ -74,21 +75,20 @@ class UserActivityStream extends AtomUserNoticeFeed
$subscriptions = $this->getSubscriptions();
$subscribers = $this->getSubscribers();
$groups = $this->getGroups();
$faves = $this->getFaves();
$messagesFrom = $this->getMessagesFrom();
$messagesTo = $this->getMessagesTo();
$objs = array_merge($subscriptions, $subscribers, $groups, $faves, $notices, $messagesFrom, $messagesTo);
$objs = array_merge($subscriptions, $subscribers, $groups, $notices, $messagesFrom, $messagesTo);
Event::handle('AppendUserActivityStreamObjects', array($this, &$objs));
$subscriptions = null;
$subscribers = null;
$groups = null;
$faves = null;
unset($subscriptions);
unset($subscribers);
unset($groups);
unset($faves);
// Sort by create date
@ -101,7 +101,7 @@ class UserActivityStream extends AtomUserNoticeFeed
}
/**
* Interleave the pre-sorted subs/groups/faves with the user's
* Interleave the pre-sorted objects with the user's
* notices, all in reverse chron order.
*/
function renderEntries($format=Feed::ATOM, $handle=null)
@ -278,27 +278,6 @@ class UserActivityStream extends AtomUserNoticeFeed
return $subs;
}
function getFaves()
{
$faves = array();
$fave = new Fave();
$fave->user_id = $this->user->id;
if (!empty($this->after)) {
$fave->whereAdd("modified > '" . common_sql_date($this->after) . "'");
}
if ($fave->find()) {
while ($fave->fetch()) {
$faves[] = clone($fave);
}
}
return $faves;
}
/**
*
* @param int $start unix timestamp for earliest

4
plugins/Activity/lib/systemlistitem.php
View File

@ -79,8 +79,10 @@ class SystemListItem extends NoticeListItemAdapter
$user = common_current_user();
if (!empty($user)) {
$this->nli->out->elementStart('div', 'notice-options');
$this->showFaveForm();
if (Event::handle('StartShowNoticeOptionItems', array($this))) {
$this->showReplyLink();
Event::handle('EndShowNoticeOptionItems', array($this));
}
$this->nli->out->elementEnd('div');
}
Event::handle('EndShowNoticeOptions', array($this));

7
plugins/ActivitySpam/ActivitySpamPlugin.php
View File

@ -249,12 +249,9 @@ class ActivitySpamPlugin extends Plugin
/**
* Pre-cache our spam scores if needed.
*/
function onEndNoticeListPrefill(&$notices, &$profiles, $avatarSize) {
function onEndNoticeListPrefill(array &$notices, array &$profiles, array $notice_ids, Profile $scoped=null) {
if ($this->hideSpam) {
foreach ($notices as $notice) {
$ids[] = $notice->id;
}
Spam_score::multiGet('notice_id', $ids);
Spam_score::multiGet('notice_id', $notice_ids);
}
return true;
}

4
plugins/AnonymousFave/AnonymousFavePlugin.php
View File

@ -124,8 +124,8 @@ class AnonymousFavePlugin extends Plugin
if (!common_logged_in() && $this->hasAnonFaving($item)) {
$profile = AnonymousFavePlugin::getAnonProfile();
if (!empty($profile)) {
if ($profile->hasFave($item->notice)) {
if ($profile instanceof Profile) {
if (Fave::existsForProfile($item->notice, $profile)) {
$disfavor = new AnonDisFavorForm($item->out, $item->notice);
$disfavor->show();
} else {

4
plugins/AnonymousFave/actions/anonfavor.php
View File

@ -62,9 +62,9 @@ class AnonFavorAction extends RedirectingAction
$notice = Notice::getKV($id);
$token = $this->checkSessionToken();
if ($profile->hasFave($notice)) {
if (Fave::existsForProfile($notice, $profile)) {
// TRANS: Client error.
$this->clientError(_m('This notice is already a favorite!'));
throw new AlreadyFulfilledException(_m('This notice is already a favorite!'));
}
$fave = Fave::addNew($profile, $notice);

7
plugins/Favorite/EVENTS.txt
View File

@ -34,3 +34,10 @@ StartDisFavorNoticeForm: starting the data in the form for disfavoring a notice
EndDisFavorNoticeForm: Ending the data in the form for disfavoring a notice
- $DisfavorForm: the disfavor form being shown
- $notice: notice being disfavored
StartShowFaveForm: just before showing the fave form
- $item: the NoticeListItem object being shown
EndShowFaveForm: just after showing the fave form
- $item: the NoticeListItem object being shown

209
plugins/Favorite/FavoritePlugin.php
View File

@ -20,11 +20,62 @@
if (!defined('GNUSOCIAL')) { exit(1); }
/**
* @package UI
* @package Activity
* @maintainer Mikael Nordfeldth <mmn@hethane.se>
*/
class FavoritePlugin extends Plugin
class FavoritePlugin extends ActivityHandlerPlugin
{
public function tag()
{
return 'favorite';
}
public function types()
{
return array();
}
public function verbs()
{
return array(ActivityVerb::FAVORITE);
}
public function onCheckSchema()
{
$schema = Schema::get();
$schema->ensureTable('fave', Fave::schemaDef());
return true;
}
public function onEndUpgrade()
{
printfnq("Ensuring all faves have a URI...");
$fave = new Fave();
$fave->whereAdd('uri IS NULL');
if ($fave->find()) {
while ($fave->fetch()) {
try {
$fave->decache();
$fave->query(sprintf('UPDATE fave '.
'SET uri = "%s", '.
' modified = "%s" '.
'WHERE user_id = %d '.
'AND notice_id = %d',
Fave::newURI($fave->user_id, $fave->notice_id, $fave->modified),
common_sql_date(strtotime($fave->modified)),
$fave->user_id,
$fave->notice_id));
} catch (Exception $e) {
common_log(LOG_ERR, "Error updating fave URI: " . $e->getMessage());
}
}
}
printfnq("DONE.\n");
}
public function onRouterInitialized(URLMapper $m)
{
// Web UI actions
@ -96,6 +147,160 @@ class FavoritePlugin extends Plugin
'format' => '(xml|json)'));
}
/**
* Typically just used to fill out Twitter-compatible API status data.
*
* FIXME: Make all the calls before this end up with a Notice instead of ArrayWrapper please...
*/
public function onNoticeSimpleStatusArray($notice, array &$status, Profile $scoped=null, array $args=array())
{
if ($scoped instanceof Profile) {
$status['favorited'] = Fave::existsForProfile($notice, $scoped);
} else {
$status['favorited'] = false;
}
return true;
}
/**
* Typically just used to fill out StatusNet specific data in API calls in the referenced $info array.
*/
public function onStatusNetApiNoticeInfo(Notice $notice, array &$info, Profile $scoped=null, array $args=array())
{
if ($scoped instanceof Profile) {
$info['favorite'] = Fave::existsForProfile($notice, $scoped) ? 'true' : 'false';
}
return true;
}
public function onNoticeDeleteRelated(Notice $notice)
{
$fave = new Fave();
$fave->notice_id = $notice->id;
if ($fave->find()) {
while ($fave->fetch()) {
Memcached_DataObject::blow('fave:ids_by_user_own:%d', $fave->user_id);
Memcached_DataObject::blow('fave:ids_by_user_own:%d;last', $fave->user_id);
Memcached_DataObject::blow('fave:ids_by_user:%d', $fave->user_id);
Memcached_DataObject::blow('fave:ids_by_user:%d;last', $fave->user_id);
$fave->delete();
}
}
$fave->free();
}
public function onStartNoticeListPrefill(array &$notices, array $notice_ids, Profile $scoped=null)
{
// prefill array of objects, before pluginfication it was Notice::fillFaves($notices)
Fave::fillFaves($notice_ids);
// DB caching
if ($scoped instanceof Profile) {
Fave::pivotGet('notice_id', $notice_ids, array('user_id' => $scoped->id));
}
}
/**
* show the "favorite" form in the notice options element
* FIXME: Don't let a NoticeListItemAdapter slip in here (or extend that from NoticeListItem)
*
* @return void
*/
public function onStartShowNoticeOptionItems($nli)
{
if (Event::handle('StartShowFaveForm', array($nli))) {
$scoped = Profile::current();
if ($scoped instanceof Profile) {
if (Fave::existsForProfile($nli->notice, $scoped)) {
$disfavor = new DisfavorForm($nli->out, $nli->notice);
$disfavor->show();
} else {
$favor = new FavorForm($nli->out, $nli->notice);
$favor->show();
}
}
Event::handle('EndShowFaveForm', array($nli));
}
}
public function onAppendUserActivityStreamObjects(UserActivityStream $uas, array &$objs)
{
$faves = array();
$fave = new Fave();
$fave->user_id = $uas->user->id;
if (!empty($uas->after)) {
$fave->whereAdd("modified > '" . common_sql_date($uas->after) . "'");
}
if ($fave->find()) {
while ($fave->fetch()) {
$faves[] = clone($fave);
}
}
return $faves;
}
public function onStartShowThreadedNoticeTailItems(NoticeListItem $nli, Notice $notice, &$threadActive)
{
if ($nli instanceof ThreadedNoticeListSubItem) {
// The sub-items are replies to a conversation, thus we use different HTML elements etc.
$item = new ThreadedNoticeListInlineFavesItem($notice, $nli->out);
} else {
$item = new ThreadedNoticeListFavesItem($notice, $nli->out);
}
$threadActive = $item->show() || $threadActive;
return true;
}
/**
* EndInterpretCommand for FavoritePlugin will handle the 'fav' command
* using the class FavCommand.
*
* @param string $cmd Command being run
* @param string $arg Rest of the message (including address)
* @param User $user User sending the message
* @param Command &$result The resulting command object to be run.
*
* @return boolean hook value
*/
public function onStartInterpretCommand($cmd, $arg, $user, &$result)
{
if ($result === false && $cmd == 'fav') {
if (empty($arg)) {
$result = null;
} else {
list($other, $extra) = $this->split_arg($arg);
if (!empty($extra)) {
$result = null;
} else {
$result = new FavCommand($user, $other);
}
}
return false;
}
return true;
}
public function onHelpCommandMessages(HelpCommand $help, array &$commands)
{
// TRANS: Help message for IM/SMS command "fav <nickname>".
$commands['fav <nickname>'] = _m('COMMANDHELP', "add user's last notice as a 'fave'");
// TRANS: Help message for IM/SMS command "fav #<notice_id>".
$commands['fav #<notice_id>'] = _m('COMMANDHELP', "add notice with the given id as a 'fave'");
}
/**
* Are we allowed to perform a certain command over the API?
*/
public function onCommandSupportedAPI(Command $cmd, array &$supported)
{
$supported = $supported || $cmd instanceof FavCommand;
}
public function onPluginVersion(array &$versions)
{
$versions[] = array('name' => 'Favorite',

2
plugins/Favorite/actions/apifavoritecreate.php
View File

@ -118,7 +118,7 @@ class ApiFavoriteCreateAction extends ApiAuthAction
// Note: Twitter lets you fave things repeatedly via API.
if ($this->user->hasFave($this->notice)) {
if (Fave::existsForProfile($this->notice, $this->scoped)) {
$this->clientError(
// TRANS: Client error displayed when trying to mark a notice favourite that already is a favourite.
_('This status is already a favorite.'),

6
plugins/Favorite/actions/favor.php
View File

@ -55,12 +55,12 @@ class FavorAction extends FormAction
if (!($notice instanceof Notice)) {
$this->serverError(_('Notice not found'));
}
if ($this->scoped->hasFave($notice)) {
if (Fave::existsForProfile($notice, $this->scoped)) {
// TRANS: Client error displayed when trying to mark a notice as favorite that already is a favorite.
$this->clientError(_('This notice is already a favorite!'));
throw new AlreadyFulfilledException(_('This notice is already a favorite!'));
}
$fave = Fave::addNew($this->scoped, $notice);
if (!$fave) {
if (!$fave instanceof Fave) {
// TRANS: Server error displayed when trying to mark a notice as favorite fails in the database.
$this->serverError(_('Could not create favorite.'));
}

30
plugins/Favorite/classes/Fave.php
View File

@ -157,6 +157,12 @@ class Fave extends Managed_DataObject
return $act;
}
static function existsForProfile($notice, Profile $scoped) {
$fave = self::pkeyGet(array('user_id'=>$scoped->id, 'notice_id'=>$notice->id));
return ($fave instanceof Fave);
}
/**
* Fetch a stream of favorites by profile
*
@ -201,4 +207,28 @@ class Fave extends Managed_DataObject
$notice_id,
common_date_iso8601($modified));
}
static protected $_faves = array();
/**
* All faves of this notice
*
* @param Notice $notice A notice we wish to get faves for (may still be ArrayWrapper)
*
* @return array Array of Fave objects
*/
static public function byNotice($notice)
{
if (!isset(self::$_faves[$notice->id])) {
self::fillFaves(array($notice->id));
}
return self::$_faves[$notice->id];
}
static public function fillFaves(array $notice_ids)
{
$faveMap = Fave::listGet('notice_id', $notice_ids);
self::$_faves = array_replace(self::$_faves, $faveMap);
}
}

52
plugins/Favorite/lib/favcommand.php Normal file
View File

@ -0,0 +1,52 @@
<?php
class FavCommand extends Command
{
var $other = null;
function __construct($user, $other)
{
parent::__construct($user);
$this->other = $other;
}
function handle($channel)
{
$notice = $this->getNotice($this->other);
$fave = new Fave();
$fave->user_id = $this->user->id;
$fave->notice_id = $notice->id;
$fave->find();
if ($fave->fetch()) {
// TRANS: Error message text shown when a favorite could not be set because it has already been favorited.
$channel->error($this->user, _('Could not create favorite: Already favorited.'));
return;
}
$fave = Fave::addNew($this->user->getProfile(), $notice);
if (!$fave) {
// TRANS: Error message text shown when a favorite could not be set.
$channel->error($this->user, _('Could not create favorite.'));
return;
}
// @fixme favorite notification should be triggered
// at a lower level
$other = User::getKV('id', $notice->profile_id);
if ($other && $other->id != $this->user->id) {
if ($other->email && $other->emailnotifyfav) {
mail_notify_fave($other, $this->user, $notice);
}
}
$this->user->blowFavesCache();
// TRANS: Text shown when a notice has been marked as favourite successfully.
$channel->output($this->user, _('Notice marked as fave.'));
}
}

80
plugins/Favorite/lib/threadednoticelistfavesitem.php Normal file
View File

@ -0,0 +1,80 @@
<?php
/**
* GNU Social - a federating social network
* Copyright (C) 2014, Free Software Foundation, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
if (!defined('GNUSOCIAL')) { exit(1); }
/**
* Placeholder for showing faves...
*/
class ThreadedNoticeListFavesItem extends NoticeListActorsItem
{
function getProfiles()
{
$faves = Fave::byNotice($this->notice);
$profiles = array();
foreach ($faves as $fave) {
$profiles[] = $fave->user_id;
}
return $profiles;
}
function magicList($items)
{
if (count($items) > 4) {
return parent::magicList(array_slice($items, 0, 3));
} else {
return parent::magicList($items);
}
}
function getListMessage($count, $you)
{
if ($count == 1 && $you) {
// darn first person being different from third person!
// TRANS: List message for notice favoured by logged in user.
return _m('FAVELIST', 'You like this.');
} else if ($count > 4) {
// TRANS: List message for when more than 4 people like something.
// TRANS: %%s is a list of users liking a notice, %d is the number over 4 that like the notice.
// TRANS: Plural is decided on the total number of users liking the notice (count of %%s + %d).
return sprintf(_m('%%s and %d others like this.',
'%%s and %d others like this.',
$count),
$count - 3);
} else {
// TRANS: List message for favoured notices.
// TRANS: %%s is a list of users liking a notice.
// TRANS: Plural is based on the number of of users that have favoured a notice.
return sprintf(_m('%%s likes this.',
'%%s like this.',
$count),
$count);
}
}
function showStart()
{
$this->out->elementStart('li', array('class' => 'notice-data notice-faves'));
}
function showEnd()
{
$this->out->elementEnd('li');
}
}

34
plugins/Favorite/lib/threadednoticelistinlinefavesitem.php Normal file
View File

@ -0,0 +1,34 @@
<?php
/**
* GNU Social - a federating social network
* Copyright (C) 2014, Free Software Foundation, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
if (!defined('GNUSOCIAL')) { exit(1); }
// @todo FIXME: needs documentation.
class ThreadedNoticeListInlineFavesItem extends ThreadedNoticeListFavesItem
{
function showStart()
{
$this->out->elementStart('div', array('class' => 'notice-faves'));
}
function showEnd()
{
$this->out->elementEnd('div');
}
}

2
plugins/GroupPrivateMessage/GroupPrivateMessagePlugin.php
View File

@ -230,7 +230,7 @@ class GroupPrivateMessagePlugin extends Plugin
*
* @return boolean hook value
*/
function onStartIntepretCommand($cmd, $arg, $user, &$result)
function onStartInterpretCommand($cmd, $arg, $user, &$result)
{
if ($cmd == 'd' || $cmd == 'dm') {

2
plugins/Realtime/RealtimePlugin.php
View File

@ -37,6 +37,8 @@ if (!defined('GNUSOCIAL')) { exit(1); }
* Based on experience with the Comet and Meteor plugins,
* this superclass extracts out some of the common functionality
*
* Currently depends on Favorite plugin.
*
* @category Plugin
* @package StatusNet
* @author Evan Prodromou <evan@status.net>

30
scripts/upgrade.php
View File

@ -51,7 +51,6 @@ function main()
initLocalGroup();
initNoticeReshare();
initFaveURI();
initSubscriptionURI();
initGroupMemberURI();
@ -292,35 +291,6 @@ function initNoticeReshare()
printfnq("DONE.\n");
}
function initFaveURI()
{
printfnq("Ensuring all faves have a URI...");
$fave = new Fave();
$fave->whereAdd('uri IS NULL');
if ($fave->find()) {
while ($fave->fetch()) {
try {
$fave->decache();
$fave->query(sprintf('update fave '.
'set uri = "%s", '.
' modified = "%s" '.
'where user_id = %d '.
'and notice_id = %d',
Fave::newURI($fave->user_id, $fave->notice_id, $fave->modified),
common_sql_date(strtotime($fave->modified)),
$fave->user_id,
$fave->notice_id));
} catch (Exception $e) {
common_log(LOG_ERR, "Error updated fave URI: " . $e->getMessage());
}
}
}
printfnq("DONE.\n");
}
function initSubscriptionURI()
{
printfnq("Ensuring all subscriptions have a URI...");

4
tests/CommandInterperterTest.php
View File

@ -133,9 +133,9 @@ class CommandInterpreterTest extends PHPUnit_Framework_TestCase
array('whois foo', 'WhoisCommand'),
array('whois foo bar', null),
array('fav', null),
/* array('fav', null),
array('fav foo', 'FavCommand'),
array('fav foo bar', null),
array('fav foo bar', null),*/
array('nudge', null),
array('nudge foo', 'NudgeCommand'),