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 ActivityHandlerPlugin
28 protected $email_notify_fave = 1;
35 public function types()
40 public function verbs()
42 return array(ActivityVerb::FAVORITE);
45 public function onCheckSchema()
47 $schema = Schema::get();
48 $schema->ensureTable('fave', Fave::schemaDef());
52 public function initialize()
54 common_config_set('email', 'notify_fave', $this->email_notify_fave);
57 public function onStartUpgrade()
59 // This is a migration feature that will make sure we move
60 // certain User preferences to the Profile_prefs table.
61 // Introduced after commit b5fd2a048fc621ea05d756caba17275ab3dd0af4
62 // on Sun Jul 13 16:30:37 2014 +0200
64 $user->whereAdd('emailnotifyfav IS NOT NULL');
66 printfnq("Detected old User table (emailnotifyfav IS NOT NULL). Moving 'emailnotifyfav' property to Profile_prefs...");
67 // First we'll make sure Profile_prefs exists
68 $schema = Schema::get();
69 $schema->ensureTable('profile_prefs', Profile_prefs::schemaDef());
71 // Make sure we have our own tables setup properly
72 while ($user->fetch()) {
73 $user->setPref('email', 'notify_fave', $user->emailnotifyfav);
75 $user->emailnotifyfav = 'null'; // flag this preference as migrated
82 public function onEndUpgrade()
84 printfnq("Ensuring all faves have a URI...");
87 $fave->whereAdd('uri IS NULL');
90 while ($fave->fetch()) {
93 $fave->query(sprintf('UPDATE fave '.
96 'WHERE user_id = %d '.
98 Fave::newUri($fave->user_id, $fave->notice_id, $fave->modified),
99 common_sql_date(strtotime($fave->modified)),
102 } catch (Exception $e) {
103 common_log(LOG_ERR, "Error updating fave URI: " . $e->getMessage());
111 public function onRouterInitialized(URLMapper $m)
114 $m->connect('main/favor', array('action' => 'favor'));
115 $m->connect('main/disfavor', array('action' => 'disfavor'));
117 if (common_config('singleuser', 'enabled')) {
118 $nickname = User::singleUserNickname();
120 $m->connect('favorites',
121 array('action' => 'showfavorites',
122 'nickname' => $nickname));
123 $m->connect('favoritesrss',
124 array('action' => 'favoritesrss',
125 'nickname' => $nickname));
127 $m->connect('favoritedrss', array('action' => 'favoritedrss'));
128 $m->connect('favorited/', array('action' => 'favorited'));
129 $m->connect('favorited', array('action' => 'favorited'));
131 $m->connect(':nickname/favorites',
132 array('action' => 'showfavorites'),
133 array('nickname' => Nickname::DISPLAY_FMT));
134 $m->connect(':nickname/favorites/rss',
135 array('action' => 'favoritesrss'),
136 array('nickname' => Nickname::DISPLAY_FMT));
140 $m->connect('api/favorites/create.:format',
141 array('action' => 'ApiFavoriteCreate',
142 'format' => '(xml|json)'));
143 $m->connect('api/favorites/destroy.:format',
144 array('action' => 'ApiFavoriteDestroy',
145 'format' => '(xml|json)'));
146 $m->connect('api/favorites/list.:format',
147 array('action' => 'ApiTimelineFavorites',
148 'format' => '(xml|json|rss|atom|as)'));
149 $m->connect('api/favorites/:id.:format',
150 array('action' => 'ApiTimelineFavorites',
151 'id' => Nickname::INPUT_FMT,
152 'format' => '(xml|json|rss|atom|as)'));
153 $m->connect('api/favorites.:format',
154 array('action' => 'ApiTimelineFavorites',
155 'format' => '(xml|json|rss|atom|as)'));
156 $m->connect('api/favorites/create/:id.:format',
157 array('action' => 'ApiFavoriteCreate',
159 'format' => '(xml|json)'));
160 $m->connect('api/favorites/destroy/:id.:format',
161 array('action' => 'ApiFavoriteDestroy',
163 'format' => '(xml|json)'));
166 $m->connect('api/statusnet/app/favorites/:profile/:notice.atom',
167 array('action' => 'AtomPubShowFavorite'),
168 array('profile' => '[0-9]+',
169 'notice' => '[0-9]+'));
171 $m->connect('api/statusnet/app/favorites/:profile.atom',
172 array('action' => 'AtomPubFavoriteFeed'),
173 array('profile' => '[0-9]+'));
175 // Required for qvitter API
176 $m->connect('api/statuses/favs/:id.:format',
177 array('action' => 'ApiStatusesFavs',
179 'format' => '(xml|json)'));
182 // FIXME: Set this to abstract public in lib/activityhandlerplugin.php ddwhen all plugins have migrated!
183 protected function saveObjectFromActivity(Activity $act, Notice $stored, array $options=array())
185 assert($this->isMyActivity($act));
187 // If empty, we should've created it ourselves on our node.
188 if (!isset($options['created'])) {
189 $options['created'] = !empty($act->time) ? common_sql_date($act->time) : common_sql_now();
192 // We must have an objects[0] here because in isMyActivity we require the count to be == 1
193 $actobj = $act->objects[0];
195 $object = Fave::saveActivityObject($actobj, $stored);
199 // FIXME: Put this in lib/activityhandlerplugin.php when we're ready
200 // with the other microapps/activityhandlers as well.
201 // Also it should be StartNoticeAsActivity (with a prepped Activity, including ->context etc.)
202 public function onEndNoticeAsActivity(Notice $stored, Activity $act, Profile $scoped=null)
204 if (!$this->isMyNotice($stored)) {
208 common_debug('Extending activity '.$stored->id.' with '.get_called_class());
209 $this->extendActivity($stored, $act, $scoped);
213 public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
215 Fave::extendActivity($stored, $act, $scoped);
218 public function activityObjectFromNotice(Notice $notice)
220 $fave = Fave::fromStored($notice);
221 return $fave->asActivityObject();
224 public function deleteRelated(Notice $notice)
227 $fave = Fave::fromStored($notice);
229 } catch (NoResultException $e) {
230 // Cool, no problem. We wanted to get rid of it anyway.
237 * Typically just used to fill out Twitter-compatible API status data.
239 * FIXME: Make all the calls before this end up with a Notice instead of ArrayWrapper please...
241 public function onNoticeSimpleStatusArray($notice, array &$status, Profile $scoped=null, array $args=array())
243 if ($scoped instanceof Profile) {
244 $status['favorited'] = Fave::existsForProfile($notice, $scoped);
246 $status['favorited'] = false;
251 public function onTwitterUserArray(Profile $profile, array &$userdata, Profile $scoped=null, array $args=array())
253 $userdata['favourites_count'] = Fave::countByProfile($profile);
257 * Typically just used to fill out StatusNet specific data in API calls in the referenced $info array.
259 public function onStatusNetApiNoticeInfo(Notice $notice, array &$info, Profile $scoped=null, array $args=array())
261 if ($scoped instanceof Profile) {
262 $info['favorite'] = Fave::existsForProfile($notice, $scoped) ? 'true' : 'false';
267 public function onNoticeDeleteRelated(Notice $notice)
269 parent::onNoticeDeleteRelated($notice);
271 // The below algorithm is because we want to delete fave
272 // activities on any notice which _has_ faves, and not as
273 // in the parent function only ones that _are_ faves.
276 $fave->notice_id = $notice->id;
279 while ($fave->fetch()) {
287 public function onProfileDeleteRelated(Profile $profile, array &$related)
290 $fave->user_id = $profile->id;
291 $fave->delete(); // Will perform a DELETE matching "user_id = {$user->id}"
294 Fave::blowCacheForProfileId($profile->id);
298 public function onStartNoticeListPrefill(array &$notices, array $notice_ids, Profile $scoped=null)
300 // prefill array of objects, before pluginfication it was Notice::fillFaves($notices)
301 Fave::fillFaves($notice_ids);
304 if ($scoped instanceof Profile) {
305 Fave::pivotGet('notice_id', $notice_ids, array('user_id' => $scoped->id));
310 * show the "favorite" form in the notice options element
311 * FIXME: Don't let a NoticeListItemAdapter slip in here (or extend that from NoticeListItem)
315 public function onStartShowNoticeOptionItems($nli)
317 if (Event::handle('StartShowFaveForm', array($nli))) {
318 $scoped = Profile::current();
319 if ($scoped instanceof Profile) {
320 if (Fave::existsForProfile($nli->notice, $scoped)) {
321 $disfavor = new DisfavorForm($nli->out, $nli->notice);
324 $favor = new FavorForm($nli->out, $nli->notice);
328 Event::handle('EndShowFaveForm', array($nli));
332 public function showNoticeListItem(NoticeListItem $nli)
336 public function openNoticeListItemElement(NoticeListItem $nli)
340 public function closeNoticeListItemElement(NoticeListItem $nli)
345 public function onAppendUserActivityStreamObjects(UserActivityStream $uas, array &$objs)
348 $fave->user_id = $uas->getUser()->id;
350 if (!empty($uas->after)) {
351 $fave->whereAdd("modified > '" . common_sql_date($uas->after) . "'");
355 while ($fave->fetch()) {
356 $objs[] = clone($fave);
363 public function onStartShowThreadedNoticeTailItems(NoticeListItem $nli, Notice $notice, &$threadActive)
365 if ($nli instanceof ThreadedNoticeListSubItem) {
366 // The sub-items are replies to a conversation, thus we use different HTML elements etc.
367 $item = new ThreadedNoticeListInlineFavesItem($notice, $nli->out);
369 $item = new ThreadedNoticeListFavesItem($notice, $nli->out);
371 $threadActive = $item->show() || $threadActive;
375 public function onEndFavorNotice(Profile $actor, Notice $target)
378 $notice_author = $target->getProfile();
379 // Don't notify ourselves of our own favorite on our own notice,
380 // or if it's a remote user (since we don't know their email addresses etc.)
381 if ($notice_author->id == $actor->id || !$notice_author->isLocal()) {
384 $local_user = $notice_author->getUser();
385 mail_notify_fave($local_user, $actor, $target);
386 } catch (Exception $e) {
387 // Mm'kay, probably not a local user. Let's skip this favor notification.
392 * EndInterpretCommand for FavoritePlugin will handle the 'fav' command
393 * using the class FavCommand.
395 * @param string $cmd Command being run
396 * @param string $arg Rest of the message (including address)
397 * @param User $user User sending the message
398 * @param Command &$result The resulting command object to be run.
400 * @return boolean hook value
402 public function onStartInterpretCommand($cmd, $arg, $user, &$result)
404 if ($result === false && $cmd == 'fav') {
408 list($other, $extra) = CommandInterpreter::split_arg($arg);
409 if (!empty($extra)) {
412 $result = new FavCommand($user, $other);
420 public function onHelpCommandMessages(HelpCommand $help, array &$commands)
422 // TRANS: Help message for IM/SMS command "fav <nickname>".
423 $commands['fav <nickname>'] = _m('COMMANDHELP', "add user's last notice as a 'fave'");
424 // TRANS: Help message for IM/SMS command "fav #<notice_id>".
425 $commands['fav #<notice_id>'] = _m('COMMANDHELP', "add notice with the given id as a 'fave'");
429 * Are we allowed to perform a certain command over the API?
431 public function onCommandSupportedAPI(Command $cmd, &$supported)
433 $supported = $supported || $cmd instanceof FavCommand;
436 // Form stuff (settings etc.)
438 public function onEndEmailFormData(Action $action, Profile $scoped)
440 $emailfave = $scoped->getConfigPref('email', 'notify_fave') ? 1 : 0;
442 $action->elementStart('li');
443 $action->checkbox('email-notify_fave',
444 // TRANS: Checkbox label in e-mail preferences form.
445 _('Send me email when someone adds my notice as a favorite.'),
447 $action->elementEnd('li');
452 public function onStartEmailSaveForm(Action $action, Profile $scoped)
454 $emailfave = $action->booleanintstring('email-notify_fave');
456 if ($emailfave == $scoped->getPref('email', 'notify_fave')) {
457 // No need to update setting
460 } catch (NoResultException $e) {
461 // Apparently there's no previously stored setting, then continue to save it as it is now.
464 $scoped->setPref('email', 'notify_fave', $emailfave);
471 public function onEndPersonalGroupNav(Menu $menu, Profile $target, Profile $scoped=null)
473 $menu->out->menuItem(common_local_url('showfavorites', array('nickname' => $target->getNickname())),
474 // TRANS: Menu item in personal group navigation menu.
475 _m('MENU','Favorites'),
476 // @todo i18n FIXME: Need to make this two messages.
477 // TRANS: Menu item title in personal group navigation menu.
478 // TRANS: %s is a username.
479 sprintf(_('%s\'s favorite notices'), $target->getBestName()),
480 $scoped instanceof Profile && $target->id === $scoped->id && $menu->actionName =='showfavorites',
481 'nav_timeline_favorites');
484 public function onEndPublicGroupNav(Menu $menu)
486 if (!common_config('singleuser', 'enabled')) {
487 // TRANS: Menu item in search group navigation panel.
488 $menu->out->menuItem(common_local_url('favorited'), _m('MENU','Popular'),
489 // TRANS: Menu item title in search group navigation panel.
490 _('Popular notices'), $menu->actionName == 'favorited', 'nav_timeline_favorited');
494 public function onEndShowSections(Action $action)
496 if (!$action->isAction(array('all', 'public'))) {
500 if (!common_config('performance', 'high')) {
501 $section = new PopularNoticeSection($action, $action->getScoped());
506 public function onPluginVersion(array &$versions)
508 $versions[] = array('name' => 'Favorite',
509 'version' => GNUSOCIAL_VERSION,
510 'author' => 'Mikael Nordfeldth',
511 'homepage' => 'http://gnu.io/',
513 // TRANS: Plugin description.
514 _m('Favorites (likes) using ActivityStreams.'));
521 * Notify a user that one of their notices has been chosen as a 'fave'
523 * @param User $rcpt The user whose notice was faved
524 * @param Profile $sender The user who faved the notice
525 * @param Notice $notice The notice that was faved
529 function mail_notify_fave(User $rcpt, Profile $sender, Notice $notice)
531 if (!$rcpt->receivesEmailNotifications() || !$rcpt->getConfigPref('email', 'notify_fave')) {
535 // This test is actually "if the sender is sandboxed"
536 if (!$sender->hasRight(Right::EMAILONFAVE)) {
540 if ($rcpt->hasBlocked($sender)) {
541 // If the author has blocked us, don't spam them with a notification.
545 // We need the global mail.php for various mail related functions below.
546 require_once INSTALLDIR.'/lib/mail.php';
548 $bestname = $sender->getBestName();
550 common_switch_locale($rcpt->language);
552 // TRANS: Subject for favorite notification e-mail.
553 // TRANS: %1$s is the adding user's long name, %2$s is the adding user's nickname.
554 $subject = sprintf(_('%1$s (@%2$s) added your notice as a favorite'), $bestname, $sender->getNickname());
556 // TRANS: Body for favorite notification e-mail.
557 // TRANS: %1$s is the adding user's long name, $2$s is the date the notice was created,
558 // TRANS: %3$s is a URL to the faved notice, %4$s is the faved notice text,
559 // TRANS: %5$s is a URL to all faves of the adding user, %6$s is the StatusNet sitename,
560 // TRANS: %7$s is the adding user's nickname.
561 $body = sprintf(_("%1\$s (@%7\$s) just added your notice from %2\$s".
562 " as one of their favorites.\n\n" .
563 "The URL of your notice is:\n\n" .
565 "The text of your notice is:\n\n" .
567 "You can see the list of %1\$s's favorites here:\n\n" .
570 common_exact_date($notice->created),
571 common_local_url('shownotice',
572 array('notice' => $notice->id)),
574 common_local_url('showfavorites',
575 array('nickname' => $sender->getNickname())),
576 common_config('site', 'name'),
577 $sender->getNickname()) .
580 $headers = _mail_prepare_headers('fave', $rcpt->getNickname(), $sender->getNickname());
582 common_switch_locale();
583 mail_to_user($rcpt, $subject, $body, $headers);