Commit fcdd061b authored by mmn's avatar mmn

pluginified most of hasFave, getFaves and related calls

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.
parent 29730b6c
......@@ -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
......
......@@ -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;
}
}
......@@ -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);
......
......@@ -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 ".
......
......@@ -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;
}
......
......@@ -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";
}
......
......@@ -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;
......
......@@ -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;
}
Fave::pivotGet('notice_id', $ids, array('user_id' => $p->id));
Notice::pivotGet('repeat_of', $ids, array('profile_id' => $p->id));
if ($scoped instanceof Profile) {
Notice::pivotGet('repeat_of', $notice_ids, array('profile_id' => $scoped->id));
}
Event::handle('EndNoticeListPrefill', array(&$notices, &$profiles, $avatarSize));
Event::handle('EndNoticeListPrefill', array(&$notices, &$profiles, $notice_ids, $scoped));
}
}
}
<?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));
}
}
}
......@@ -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
*
......
......@@ -70,4 +70,9 @@ class NoticeListItemAdapter
{
return call_user_func_array(array($this->nli, $name), $arguments);
}
function __get($name)
{
return $this->nli->$name;
}
}
......@@ -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))) {
$item = new ThreadedNoticeListRepeatsItem($this->notice, $this->out);
$hasRepeats = $item->show();
// 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);
$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,18 +253,16 @@ 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();
}
$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();
$item = new ThreadedNoticeListInlineRepeatsItem($this->notice, $this->out);
$hasRepeats = $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...
*/
......
......@@ -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