3 * GNU Social - a federating social network
4 * Copyright (C) 2014, Free Software Foundation, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 if (!defined('GNUSOCIAL')) { exit(1); }
24 * @maintainer Mikael Nordfeldth <mmn@hethane.se>
26 class FavoritePlugin extends ActivityVerbHandlerPlugin
28 protected $email_notify_fave = 1;
35 public function types()
40 public function verbs()
42 return array(ActivityVerb::FAVORITE, ActivityVerb::LIKE,
43 ActivityVerb::UNFAVORITE, ActivityVerb::UNLIKE);
46 public function onCheckSchema()
48 $schema = Schema::get();
49 $schema->ensureTable('fave', Fave::schemaDef());
53 public function initialize()
55 common_config_set('email', 'notify_fave', $this->email_notify_fave);
58 public function onStartUpgrade()
60 // This is a migration feature that will make sure we move
61 // certain User preferences to the Profile_prefs table.
62 // Introduced after commit b5fd2a048fc621ea05d756caba17275ab3dd0af4
63 // on Sun Jul 13 16:30:37 2014 +0200
65 $user->whereAdd('emailnotifyfav IS NOT NULL');
67 printfnq("Detected old User table (emailnotifyfav IS NOT NULL). Moving 'emailnotifyfav' property to Profile_prefs...");
68 // First we'll make sure Profile_prefs exists
69 $schema = Schema::get();
70 $schema->ensureTable('profile_prefs', Profile_prefs::schemaDef());
72 // Make sure we have our own tables setup properly
73 while ($user->fetch()) {
74 $user->setPref('email', 'notify_fave', $user->emailnotifyfav);
76 $user->emailnotifyfav = 'null'; // flag this preference as migrated
83 public function onEndUpgrade()
85 printfnq("Ensuring all faves have a URI...");
88 $fave->whereAdd('uri IS NULL');
91 while ($fave->fetch()) {
94 $fave->query(sprintf('UPDATE fave '.
97 'WHERE user_id = %d '.
99 Fave::newUri($fave->getActor(), $fave->getTarget(), $fave->modified),
100 common_sql_date(strtotime($fave->modified)),
103 } catch (Exception $e) {
104 common_log(LOG_ERR, "Error updating fave URI: " . $e->getMessage());
112 public function onRouterInitialized(URLMapper $m)
115 $m->connect('main/favor', array('action' => 'favor'));
116 $m->connect('main/disfavor', array('action' => 'disfavor'));
118 if (common_config('singleuser', 'enabled')) {
119 $nickname = User::singleUserNickname();
121 $m->connect('favorites',
122 array('action' => 'showfavorites',
123 'nickname' => $nickname));
124 $m->connect('favoritesrss',
125 array('action' => 'favoritesrss',
126 'nickname' => $nickname));
128 $m->connect('favoritedrss', array('action' => 'favoritedrss'));
129 $m->connect('favorited/', array('action' => 'favorited'));
130 $m->connect('favorited', array('action' => 'favorited'));
132 $m->connect(':nickname/favorites',
133 array('action' => 'showfavorites'),
134 array('nickname' => Nickname::DISPLAY_FMT));
135 $m->connect(':nickname/favorites/rss',
136 array('action' => 'favoritesrss'),
137 array('nickname' => Nickname::DISPLAY_FMT));
141 $m->connect('api/favorites/create.:format',
142 array('action' => 'ApiFavoriteCreate'),
143 array('format' => '(xml|json)'));
144 $m->connect('api/favorites/destroy.:format',
145 array('action' => 'ApiFavoriteDestroy'),
146 array('format' => '(xml|json)'));
147 $m->connect('api/favorites/list.:format',
148 array('action' => 'ApiTimelineFavorites'),
149 array('format' => '(xml|json|rss|atom|as)'));
150 $m->connect('api/favorites/:id.:format',
151 array('action' => 'ApiTimelineFavorites'),
152 array('id' => Nickname::INPUT_FMT,
153 'format' => '(xml|json|rss|atom|as)'));
154 $m->connect('api/favorites.:format',
155 array('action' => 'ApiTimelineFavorites'),
156 array('format' => '(xml|json|rss|atom|as)'));
157 $m->connect('api/favorites/create/:id.:format',
158 array('action' => 'ApiFavoriteCreate'),
159 array('id' => '[0-9]+',
160 'format' => '(xml|json)'));
161 $m->connect('api/favorites/destroy/:id.:format',
162 array('action' => 'ApiFavoriteDestroy'),
163 array('id' => '[0-9]+',
164 'format' => '(xml|json)'));
167 $m->connect('api/statusnet/app/favorites/:profile/:notice.atom',
168 array('action' => 'AtomPubShowFavorite'),
169 array('profile' => '[0-9]+',
170 'notice' => '[0-9]+'));
172 $m->connect('api/statusnet/app/favorites/:profile.atom',
173 array('action' => 'AtomPubFavoriteFeed'),
174 array('profile' => '[0-9]+'));
176 // Required for qvitter API
177 $m->connect('api/statuses/favs/:id.:format',
178 array('action' => 'ApiStatusesFavs'),
179 array('id' => '[0-9]+',
180 'format' => '(xml|json)'));
183 // FIXME: Set this to abstract public in lib/activityhandlerplugin.php ddwhen all plugins have migrated!
184 protected function saveObjectFromActivity(Activity $act, Notice $stored, array $options=array())
186 assert($this->isMyActivity($act));
188 // We must have an objects[0] here because in isMyActivity we require the count to be == 1
189 $actobj = $act->objects[0];
191 $object = Fave::saveActivityObject($actobj, $stored);
196 // FIXME: Put this in lib/activityhandlerplugin.php when we're ready
197 // with the other microapps/activityhandlers as well.
198 // Also it should be StartNoticeAsActivity (with a prepped Activity, including ->context etc.)
199 public function onEndNoticeAsActivity(Notice $stored, Activity $act, Profile $scoped=null)
201 if (!$this->isMyNotice($stored)) {
205 $this->extendActivity($stored, $act, $scoped);
209 public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
211 Fave::extendActivity($stored, $act, $scoped);
214 public function activityObjectFromNotice(Notice $notice)
216 $fave = Fave::fromStored($notice);
217 return $fave->asActivityObject();
220 public function deleteRelated(Notice $notice)
223 $fave = Fave::fromStored($notice);
225 } catch (NoResultException $e) {
226 // Cool, no problem. We wanted to get rid of it anyway.
233 * Typically just used to fill out Twitter-compatible API status data.
235 * FIXME: Make all the calls before this end up with a Notice instead of ArrayWrapper please...
237 public function onNoticeSimpleStatusArray($notice, array &$status, Profile $scoped=null, array $args=array())
239 if ($scoped instanceof Profile) {
240 $status['favorited'] = Fave::existsForProfile($notice, $scoped);
242 $status['favorited'] = false;
247 public function onTwitterUserArray(Profile $profile, array &$userdata, Profile $scoped=null, array $args=array())
249 $userdata['favourites_count'] = Fave::countByProfile($profile);
253 * Typically just used to fill out StatusNet specific data in API calls in the referenced $info array.
255 public function onStatusNetApiNoticeInfo(Notice $notice, array &$info, Profile $scoped=null, array $args=array())
257 if ($scoped instanceof Profile) {
258 $info['favorite'] = Fave::existsForProfile($notice, $scoped) ? 'true' : 'false';
263 public function onNoticeDeleteRelated(Notice $notice)
265 parent::onNoticeDeleteRelated($notice);
267 // The below algorithm is because we want to delete fave
268 // activities on any notice which _has_ faves, and not as
269 // in the parent function only ones that _are_ faves.
272 $fave->notice_id = $notice->id;
275 while ($fave->fetch()) {
283 public function onProfileDeleteRelated(Profile $profile, array &$related)
286 $fave->user_id = $profile->id;
287 $fave->delete(); // Will perform a DELETE matching "user_id = {$user->id}"
290 Fave::blowCacheForProfileId($profile->id);
294 public function onStartNoticeListPrefill(array &$notices, array $notice_ids, Profile $scoped=null)
296 // prefill array of objects, before pluginfication it was Notice::fillFaves($notices)
297 Fave::fillFaves($notice_ids);
300 if ($scoped instanceof Profile) {
301 Fave::pivotGet('notice_id', $notice_ids, array('user_id' => $scoped->id));
306 * show the "favorite" form in the notice options element
307 * FIXME: Don't let a NoticeListItemAdapter slip in here (or extend that from NoticeListItem)
311 public function onStartShowNoticeOptionItems($nli)
313 if (Event::handle('StartShowFaveForm', array($nli))) {
314 $scoped = Profile::current();
315 if ($scoped instanceof Profile) {
316 if (Fave::existsForProfile($nli->notice, $scoped)) {
317 $disfavor = new DisfavorForm($nli->out, $nli->notice);
320 $favor = new FavorForm($nli->out, $nli->notice);
324 Event::handle('EndShowFaveForm', array($nli));
328 protected function showNoticeListItem(NoticeListItem $nli)
332 public function openNoticeListItemElement(NoticeListItem $nli)
336 public function closeNoticeListItemElement(NoticeListItem $nli)
341 public function onAppendUserActivityStreamObjects(UserActivityStream $uas, array &$objs)
344 $fave->user_id = $uas->getUser()->id;
346 if (!empty($uas->after)) {
347 $fave->whereAdd("modified > '" . common_sql_date($uas->after) . "'");
351 while ($fave->fetch()) {
352 $objs[] = clone($fave);
359 public function onEndShowThreadedNoticeTailItems(NoticeListItem $nli, Notice $notice, &$threadActive)
361 if ($nli instanceof ThreadedNoticeListSubItem) {
362 // The sub-items are replies to a conversation, thus we use different HTML elements etc.
363 $item = new ThreadedNoticeListInlineFavesItem($notice, $nli->out);
365 $item = new ThreadedNoticeListFavesItem($notice, $nli->out);
367 $threadActive = $item->show() || $threadActive;
371 public function onEndFavorNotice(Profile $actor, Notice $target)
374 $notice_author = $target->getProfile();
375 // Don't notify ourselves of our own favorite on our own notice,
376 // or if it's a remote user (since we don't know their email addresses etc.)
377 if ($notice_author->id == $actor->id || !$notice_author->isLocal()) {
380 $local_user = $notice_author->getUser();
381 mail_notify_fave($local_user, $actor, $target);
382 } catch (Exception $e) {
383 // Mm'kay, probably not a local user. Let's skip this favor notification.
388 * EndInterpretCommand for FavoritePlugin will handle the 'fav' command
389 * using the class FavCommand.
391 * @param string $cmd Command being run
392 * @param string $arg Rest of the message (including address)
393 * @param User $user User sending the message
394 * @param Command &$result The resulting command object to be run.
396 * @return boolean hook value
398 public function onStartInterpretCommand($cmd, $arg, $user, &$result)
400 if ($result === false && $cmd == 'fav') {
404 list($other, $extra) = CommandInterpreter::split_arg($arg);
405 if (!empty($extra)) {
408 $result = new FavCommand($user, $other);
416 public function onHelpCommandMessages(HelpCommand $help, array &$commands)
418 // TRANS: Help message for IM/SMS command "fav <nickname>".
419 $commands['fav <nickname>'] = _m('COMMANDHELP', "add user's last notice as a 'fave'");
420 // TRANS: Help message for IM/SMS command "fav #<notice_id>".
421 $commands['fav #<notice_id>'] = _m('COMMANDHELP', "add notice with the given id as a 'fave'");
425 * Are we allowed to perform a certain command over the API?
427 public function onCommandSupportedAPI(Command $cmd, &$supported)
429 $supported = $supported || $cmd instanceof FavCommand;
432 // Form stuff (settings etc.)
434 public function onEndEmailFormData(Action $action, Profile $scoped)
436 $emailfave = $scoped->getConfigPref('email', 'notify_fave') ? 1 : 0;
438 $action->elementStart('li');
439 $action->checkbox('email-notify_fave',
440 // TRANS: Checkbox label in e-mail preferences form.
441 _('Send me email when someone adds my notice as a favorite.'),
443 $action->elementEnd('li');
448 public function onStartEmailSaveForm(Action $action, Profile $scoped)
450 $emailfave = $action->booleanintstring('email-notify_fave');
452 if ($emailfave == $scoped->getPref('email', 'notify_fave')) {
453 // No need to update setting
456 } catch (NoResultException $e) {
457 // Apparently there's no previously stored setting, then continue to save it as it is now.
460 $scoped->setPref('email', 'notify_fave', $emailfave);
467 public function onEndPersonalGroupNav(Menu $menu, Profile $target, Profile $scoped=null)
469 $menu->out->menuItem(common_local_url('showfavorites', array('nickname' => $target->getNickname())),
470 // TRANS: Menu item in personal group navigation menu.
471 _m('MENU','Favorites'),
472 // @todo i18n FIXME: Need to make this two messages.
473 // TRANS: Menu item title in personal group navigation menu.
474 // TRANS: %s is a username.
475 sprintf(_('%s\'s favorite notices'), $target->getBestName()),
476 $scoped instanceof Profile && $target->id === $scoped->id && $menu->actionName =='showfavorites',
477 'nav_timeline_favorites');
480 public function onEndPublicGroupNav(Menu $menu)
482 if (!common_config('singleuser', 'enabled')) {
483 // TRANS: Menu item in search group navigation panel.
484 $menu->out->menuItem(common_local_url('favorited'), _m('MENU','Popular'),
485 // TRANS: Menu item title in search group navigation panel.
486 _('Popular notices'), $menu->actionName == 'favorited', 'nav_timeline_favorited');
490 public function onEndShowSections(Action $action)
492 if (!$action->isAction(array('all', 'public'))) {
496 if (!common_config('performance', 'high')) {
497 $section = new PopularNoticeSection($action, $action->getScoped());
502 protected function getActionTitle(ManagedAction $action, $verb, Notice $target, Profile $scoped)
504 return Fave::existsForProfile($target, $scoped)
505 // TRANS: Page/dialog box title when a notice is marked as favorite already
506 ? _m('TITLE', 'Unmark notice as favorite')
507 // TRANS: Page/dialog box title when a notice is not marked as favorite
508 : _m('TITLE', 'Mark notice as favorite');
511 protected function doActionPreparation(ManagedAction $action, $verb, Notice $target, Profile $scoped)
513 if ($action->isPost()) {
514 // The below tests are only for presenting to the user. POSTs which inflict
515 // duplicate favorite entries are handled with AlreadyFulfilledException.
519 $exists = Fave::existsForProfile($target, $scoped);
520 $expected_verb = $exists ? ActivityVerb::UNFAVORITE : ActivityVerb::FAVORITE;
523 case $exists && ActivityUtils::compareVerbs($verb, array(ActivityVerb::FAVORITE, ActivityVerb::LIKE)):
524 case !$exists && ActivityUtils::compareVerbs($verb, array(ActivityVerb::UNFAVORITE, ActivityVerb::UNLIKE)):
525 common_redirect(common_local_url('activityverb',
526 array('id' => $target->getID(),
527 'verb' => ActivityUtils::resolveUri($expected_verb, true))));
530 // No need to redirect as we are on the correct action already.
536 protected function doActionPost(ManagedAction $action, $verb, Notice $target, Profile $scoped)
539 case ActivityUtils::compareVerbs($verb, array(ActivityVerb::FAVORITE, ActivityVerb::LIKE)):
540 Fave::addNew($scoped, $target);
542 case ActivityUtils::compareVerbs($verb, array(ActivityVerb::UNFAVORITE, ActivityVerb::UNLIKE)):
543 Fave::removeEntry($scoped, $target);
546 throw new ServerException('ActivityVerb POST not handled by plugin that was supposed to do it.');
551 protected function getActivityForm(ManagedAction $action, $verb, Notice $target, Profile $scoped)
553 return Fave::existsForProfile($target, $scoped)
554 ? new DisfavorForm($action, $target)
555 : new FavorForm($action, $target);
558 public function onPluginVersion(array &$versions)
560 $versions[] = array('name' => 'Favorite',
561 'version' => GNUSOCIAL_VERSION,
562 'author' => 'Mikael Nordfeldth',
563 'homepage' => 'http://gnu.io/',
565 // TRANS: Plugin description.
566 _m('Favorites (likes) using ActivityStreams.'));
573 * Notify a user that one of their notices has been chosen as a 'fave'
575 * @param User $rcpt The user whose notice was faved
576 * @param Profile $sender The user who faved the notice
577 * @param Notice $notice The notice that was faved
581 function mail_notify_fave(User $rcpt, Profile $sender, Notice $notice)
583 if (!$rcpt->receivesEmailNotifications() || !$rcpt->getConfigPref('email', 'notify_fave')) {
587 // This test is actually "if the sender is sandboxed"
588 if (!$sender->hasRight(Right::EMAILONFAVE)) {
592 if ($rcpt->hasBlocked($sender)) {
593 // If the author has blocked us, don't spam them with a notification.
597 // We need the global mail.php for various mail related functions below.
598 require_once INSTALLDIR.'/lib/mail.php';
600 $bestname = $sender->getBestName();
602 common_switch_locale($rcpt->language);
604 // TRANS: Subject for favorite notification e-mail.
605 // TRANS: %1$s is the adding user's long name, %2$s is the adding user's nickname.
606 $subject = sprintf(_('%1$s (@%2$s) added your notice as a favorite'), $bestname, $sender->getNickname());
608 // TRANS: Body for favorite notification e-mail.
609 // TRANS: %1$s is the adding user's long name, $2$s is the date the notice was created,
610 // TRANS: %3$s is a URL to the faved notice, %4$s is the faved notice text,
611 // TRANS: %5$s is a URL to all faves of the adding user, %6$s is the StatusNet sitename,
612 // TRANS: %7$s is the adding user's nickname.
613 $body = sprintf(_("%1\$s (@%7\$s) just added your notice from %2\$s".
614 " as one of their favorites.\n\n" .
615 "The URL of your notice is:\n\n" .
617 "The text of your notice is:\n\n" .
619 "You can see the list of %1\$s's favorites here:\n\n" .
622 common_exact_date($notice->created),
623 common_local_url('shownotice',
624 array('notice' => $notice->id)),
626 common_local_url('showfavorites',
627 array('nickname' => $sender->getNickname())),
628 common_config('site', 'name'),
629 $sender->getNickname()) .
632 $headers = _mail_prepare_headers('fave', $rcpt->getNickname(), $sender->getNickname());
634 common_switch_locale();
635 mail_to_user($rcpt, $subject, $body, $headers);