]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/Favorite/FavoritePlugin.php
Repeats shown in threaded noticelist now handled by plugin
[quix0rs-gnu-social.git] / plugins / Favorite / FavoritePlugin.php
1 <?php
2 /*
3  * GNU Social - a federating social network
4  * Copyright (C) 2014, Free Software Foundation, Inc.
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 if (!defined('GNUSOCIAL')) { exit(1); }
21
22 /**
23  * @package     Activity
24  * @maintainer  Mikael Nordfeldth <mmn@hethane.se>
25  */
26 class FavoritePlugin extends ActivityVerbHandlerPlugin
27 {
28     protected $email_notify_fave = 1;
29
30     public function tag()
31     {
32         return 'favorite';
33     }
34
35     public function types()
36     {
37         return array();
38     }
39
40     public function verbs()
41     {
42         return array(ActivityVerb::FAVORITE, ActivityVerb::LIKE,
43                     ActivityVerb::UNFAVORITE, ActivityVerb::UNLIKE);
44     }
45
46     public function onCheckSchema()
47     {
48         $schema = Schema::get();
49         $schema->ensureTable('fave', Fave::schemaDef());
50         return true;
51     }
52
53     public function initialize()
54     {
55         common_config_set('email', 'notify_fave', $this->email_notify_fave);
56     }
57
58     public function onStartUpgrade()
59     {
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
64         $user = new User();
65         $user->whereAdd('emailnotifyfav IS NOT NULL');
66         if ($user->find()) {
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());
71
72             // Make sure we have our own tables setup properly
73             while ($user->fetch()) {
74                 $user->setPref('email', 'notify_fave', $user->emailnotifyfav);
75                 $orig = clone($user);
76                 $user->emailnotifyfav = 'null';   // flag this preference as migrated
77                 $user->update($orig);
78             }
79             printfnq("DONE.\n");
80         }
81     }
82
83     public function onEndUpgrade()
84     {
85         printfnq("Ensuring all faves have a URI...");
86
87         $fave = new Fave();
88         $fave->whereAdd('uri IS NULL');
89
90         if ($fave->find()) {
91             while ($fave->fetch()) {
92                 try {
93                     $fave->decache();
94                     $fave->query(sprintf('UPDATE fave '.
95                                          'SET uri = "%s", '.
96                                          '    modified = "%s" '.
97                                          'WHERE user_id = %d '.
98                                          'AND notice_id = %d',
99                                          Fave::newUri($fave->user_id, $fave->notice_id, $fave->modified),
100                                          common_sql_date(strtotime($fave->modified)),
101                                          $fave->user_id,
102                                          $fave->notice_id));
103                 } catch (Exception $e) {
104                     common_log(LOG_ERR, "Error updating fave URI: " . $e->getMessage());
105                 }
106             }
107         }
108
109         printfnq("DONE.\n");
110     }
111
112     public function onRouterInitialized(URLMapper $m)
113     {
114         // Web UI actions
115         $m->connect('main/favor', array('action' => 'favor'));
116         $m->connect('main/disfavor', array('action' => 'disfavor'));
117
118         if (common_config('singleuser', 'enabled')) {
119             $nickname = User::singleUserNickname();
120
121             $m->connect('favorites',
122                         array('action' => 'showfavorites',
123                               'nickname' => $nickname));
124             $m->connect('favoritesrss',
125                         array('action' => 'favoritesrss',
126                               'nickname' => $nickname));
127         } else {
128             $m->connect('favoritedrss', array('action' => 'favoritedrss'));
129             $m->connect('favorited/', array('action' => 'favorited'));
130             $m->connect('favorited', array('action' => 'favorited'));
131
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));
138         }
139
140         // Favorites for API
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)'));
165
166         // AtomPub API
167         $m->connect('api/statusnet/app/favorites/:profile/:notice.atom',
168                     array('action' => 'AtomPubShowFavorite'),
169                     array('profile' => '[0-9]+',
170                           'notice' => '[0-9]+'));
171
172         $m->connect('api/statusnet/app/favorites/:profile.atom',
173                     array('action' => 'AtomPubFavoriteFeed'),
174                     array('profile' => '[0-9]+'));
175
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)'));
181     }
182
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())
185     {
186         assert($this->isMyActivity($act));
187
188         // If empty, we should've created it ourselves on our node.
189         if (!isset($options['created'])) {
190             $options['created'] = !empty($act->time) ? common_sql_date($act->time) : common_sql_now();
191         }
192
193         // We must have an objects[0] here because in isMyActivity we require the count to be == 1
194         $actobj = $act->objects[0];
195
196         $object = Fave::saveActivityObject($actobj, $stored);
197         return $object;
198     }
199
200     // FIXME: Put this in lib/activityhandlerplugin.php when we're ready
201     //          with the other microapps/activityhandlers as well.
202     //          Also it should be StartNoticeAsActivity (with a prepped Activity, including ->context etc.)
203     public function onEndNoticeAsActivity(Notice $stored, Activity $act, Profile $scoped=null)
204     {
205         if (!$this->isMyNotice($stored)) {
206             return true;
207         }
208
209         common_debug('Extending activity '.$stored->id.' with '.get_called_class());
210         $this->extendActivity($stored, $act, $scoped);
211         return false;
212     }
213
214     public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
215     {
216         Fave::extendActivity($stored, $act, $scoped);
217     }
218
219     public function activityObjectFromNotice(Notice $notice)
220     {
221         $fave = Fave::fromStored($notice);
222         return $fave->asActivityObject();
223     }
224
225     public function deleteRelated(Notice $notice)
226     {
227         try {
228             $fave = Fave::fromStored($notice);
229             $fave->delete();
230         } catch (NoResultException $e) {
231             // Cool, no problem. We wanted to get rid of it anyway.
232         }
233     }
234
235     // API stuff
236
237     /**
238      * Typically just used to fill out Twitter-compatible API status data.
239      *
240      * FIXME: Make all the calls before this end up with a Notice instead of ArrayWrapper please...
241      */
242     public function onNoticeSimpleStatusArray($notice, array &$status, Profile $scoped=null, array $args=array())
243     {
244         if ($scoped instanceof Profile) {
245             $status['favorited'] = Fave::existsForProfile($notice, $scoped);
246         } else {
247             $status['favorited'] = false;
248         }
249         return true;
250     }
251
252     public function onTwitterUserArray(Profile $profile, array &$userdata, Profile $scoped=null, array $args=array())
253     {
254         $userdata['favourites_count'] = Fave::countByProfile($profile);
255     }
256
257     /**
258      * Typically just used to fill out StatusNet specific data in API calls in the referenced $info array.
259      */
260     public function onStatusNetApiNoticeInfo(Notice $notice, array &$info, Profile $scoped=null, array $args=array())
261     {
262         if ($scoped instanceof Profile) {
263             $info['favorite'] = Fave::existsForProfile($notice, $scoped) ? 'true' : 'false';
264         }
265         return true;
266     }
267
268     public function onNoticeDeleteRelated(Notice $notice)
269     {
270         parent::onNoticeDeleteRelated($notice);
271
272         // The below algorithm is because we want to delete fave
273         // activities on any notice which _has_ faves, and not as
274         // in the parent function only ones that _are_ faves.
275
276         $fave = new Fave();
277         $fave->notice_id = $notice->id;
278
279         if ($fave->find()) {
280             while ($fave->fetch()) {
281                 $fave->delete();
282             }
283         }
284
285         $fave->free();
286     }
287
288     public function onProfileDeleteRelated(Profile $profile, array &$related)
289     {
290         $fave = new Fave();
291         $fave->user_id = $profile->id;
292         $fave->delete();    // Will perform a DELETE matching "user_id = {$user->id}"
293         $fave->free();
294
295         Fave::blowCacheForProfileId($profile->id);
296         return true;
297     }
298
299     public function onStartNoticeListPrefill(array &$notices, array $notice_ids, Profile $scoped=null)
300     {
301         // prefill array of objects, before pluginfication it was Notice::fillFaves($notices)
302         Fave::fillFaves($notice_ids);
303
304         // DB caching
305         if ($scoped instanceof Profile) {
306             Fave::pivotGet('notice_id', $notice_ids, array('user_id' => $scoped->id));
307         }
308     }
309
310     /**
311      * show the "favorite" form in the notice options element
312      * FIXME: Don't let a NoticeListItemAdapter slip in here (or extend that from NoticeListItem)
313      *
314      * @return void
315      */
316     public function onStartShowNoticeOptionItems($nli)
317     {
318         if (Event::handle('StartShowFaveForm', array($nli))) {
319             $scoped = Profile::current();
320             if ($scoped instanceof Profile) {
321                 if (Fave::existsForProfile($nli->notice, $scoped)) {
322                     $disfavor = new DisfavorForm($nli->out, $nli->notice);
323                     $disfavor->show();
324                 } else {
325                     $favor = new FavorForm($nli->out, $nli->notice);
326                     $favor->show();
327                 }
328             }
329             Event::handle('EndShowFaveForm', array($nli));
330         }
331     }
332
333     public function showNoticeListItem(NoticeListItem $nli)
334     {
335         // pass
336     }
337     public function openNoticeListItemElement(NoticeListItem $nli)
338     {
339         // pass
340     }
341     public function closeNoticeListItemElement(NoticeListItem $nli)
342     {
343         // pass
344     }
345
346     public function onAppendUserActivityStreamObjects(UserActivityStream $uas, array &$objs)
347     {
348         $fave = new Fave();
349         $fave->user_id = $uas->getUser()->id;
350
351         if (!empty($uas->after)) {
352             $fave->whereAdd("modified > '" . common_sql_date($uas->after) . "'");
353         }
354
355         if ($fave->find()) {
356             while ($fave->fetch()) {
357                 $objs[] = clone($fave);
358             }
359         }
360
361         return true;
362     }
363
364     public function onEndShowThreadedNoticeTailItems(NoticeListItem $nli, Notice $notice, &$threadActive)
365     {
366         if ($nli instanceof ThreadedNoticeListSubItem) {
367             // The sub-items are replies to a conversation, thus we use different HTML elements etc.
368             $item = new ThreadedNoticeListInlineFavesItem($notice, $nli->out);
369         } else {
370             $item = new ThreadedNoticeListFavesItem($notice, $nli->out);
371         }
372         $threadActive = $item->show() || $threadActive;
373         return true;
374     }
375
376     public function onEndFavorNotice(Profile $actor, Notice $target)
377     {
378         try {
379             $notice_author = $target->getProfile();
380             // Don't notify ourselves of our own favorite on our own notice,
381             // or if it's a remote user (since we don't know their email addresses etc.)
382             if ($notice_author->id == $actor->id || !$notice_author->isLocal()) {
383                 return true;
384             }
385             $local_user = $notice_author->getUser();
386             mail_notify_fave($local_user, $actor, $target);
387         } catch (Exception $e) {
388             // Mm'kay, probably not a local user. Let's skip this favor notification.
389         }
390     }
391
392     /**
393      * EndInterpretCommand for FavoritePlugin will handle the 'fav' command
394      * using the class FavCommand.
395      *
396      * @param string  $cmd     Command being run
397      * @param string  $arg     Rest of the message (including address)
398      * @param User    $user    User sending the message
399      * @param Command &$result The resulting command object to be run.
400      *
401      * @return boolean hook value
402      */
403     public function onStartInterpretCommand($cmd, $arg, $user, &$result)
404     {
405         if ($result === false && $cmd == 'fav') {
406             if (empty($arg)) {
407                 $result = null;
408             } else {
409                 list($other, $extra) = CommandInterpreter::split_arg($arg);
410                 if (!empty($extra)) {
411                     $result = null;
412                 } else {
413                     $result = new FavCommand($user, $other);
414                 }
415             }
416             return false;
417         }
418         return true;
419     }
420
421     public function onHelpCommandMessages(HelpCommand $help, array &$commands)
422     {
423         // TRANS: Help message for IM/SMS command "fav <nickname>".
424         $commands['fav <nickname>'] = _m('COMMANDHELP', "add user's last notice as a 'fave'");
425         // TRANS: Help message for IM/SMS command "fav #<notice_id>".
426         $commands['fav #<notice_id>'] = _m('COMMANDHELP', "add notice with the given id as a 'fave'");
427     }
428
429     /**
430      * Are we allowed to perform a certain command over the API?
431      */
432     public function onCommandSupportedAPI(Command $cmd, &$supported)
433     {
434         $supported = $supported || $cmd instanceof FavCommand;
435     }
436
437     // Form stuff (settings etc.)
438
439     public function onEndEmailFormData(Action $action, Profile $scoped)
440     {
441         $emailfave = $scoped->getConfigPref('email', 'notify_fave') ? 1 : 0;
442
443         $action->elementStart('li');
444         $action->checkbox('email-notify_fave',
445                         // TRANS: Checkbox label in e-mail preferences form.
446                         _('Send me email when someone adds my notice as a favorite.'),
447                         $emailfave);
448         $action->elementEnd('li');
449
450         return true;
451     }
452
453     public function onStartEmailSaveForm(Action $action, Profile $scoped)
454     {
455         $emailfave = $action->booleanintstring('email-notify_fave');
456         try {
457             if ($emailfave == $scoped->getPref('email', 'notify_fave')) {
458                 // No need to update setting
459                 return true;
460             }
461         } catch (NoResultException $e) {
462             // Apparently there's no previously stored setting, then continue to save it as it is now.
463         }
464
465         $scoped->setPref('email', 'notify_fave', $emailfave);
466
467         return true;
468     }
469
470     // Layout stuff
471
472     public function onEndPersonalGroupNav(Menu $menu, Profile $target, Profile $scoped=null)
473     {
474         $menu->out->menuItem(common_local_url('showfavorites', array('nickname' => $target->getNickname())),
475                              // TRANS: Menu item in personal group navigation menu.
476                              _m('MENU','Favorites'),
477                              // @todo i18n FIXME: Need to make this two messages.
478                              // TRANS: Menu item title in personal group navigation menu.
479                              // TRANS: %s is a username.
480                              sprintf(_('%s\'s favorite notices'), $target->getBestName()),
481                              $scoped instanceof Profile && $target->id === $scoped->id && $menu->actionName =='showfavorites',
482                             'nav_timeline_favorites');
483     }
484
485     public function onEndPublicGroupNav(Menu $menu)
486     {
487         if (!common_config('singleuser', 'enabled')) {
488             // TRANS: Menu item in search group navigation panel.
489             $menu->out->menuItem(common_local_url('favorited'), _m('MENU','Popular'),
490                                  // TRANS: Menu item title in search group navigation panel.
491                                  _('Popular notices'), $menu->actionName == 'favorited', 'nav_timeline_favorited');
492         }
493     }
494
495     public function onEndShowSections(Action $action)
496     {
497         if (!$action->isAction(array('all', 'public'))) {
498             return true;
499         }
500
501         if (!common_config('performance', 'high')) {
502             $section = new PopularNoticeSection($action, $action->getScoped());
503             $section->show();
504         }
505     }
506
507     protected function getActionTitle(ManagedAction $action, $verb, Notice $target, Profile $scoped)
508     {
509         return Fave::existsForProfile($target, $scoped)
510                 // TRANS: Page/dialog box title when a notice is marked as favorite already
511                 ? _m('TITLE', 'Unmark notice as favorite')
512                 // TRANS: Page/dialog box title when a notice is not marked as favorite
513                 : _m('TITLE', 'Mark notice as favorite');
514     }
515
516     protected function doActionPreparation(ManagedAction $action, $verb, Notice $target, Profile $scoped)
517     {
518         if ($action->isPost()) {
519             // The below tests are only for presenting to the user. POSTs which inflict
520             // duplicate favorite entries are handled with AlreadyFulfilledException. 
521             return false;
522         }
523
524         $exists = Fave::existsForProfile($target, $scoped);
525         $expected_verb = $exists ? ActivityVerb::UNFAVORITE : ActivityVerb::FAVORITE;
526
527         switch (true) {
528         case $exists && ActivityUtils::compareTypes($verb, array(ActivityVerb::FAVORITE, ActivityVerb::LIKE)):
529         case !$exists && ActivityUtils::compareTypes($verb, array(ActivityVerb::UNFAVORITE, ActivityVerb::UNLIKE)):
530             common_redirect(common_local_url('activityverb',
531                                 array('id'   => $target->getID(),
532                                       'verb' => ActivityUtils::resolveUri($expected_verb, true))));
533             break;
534         default:
535             // No need to redirect as we are on the correct action already.
536         }
537
538         return false;
539     }
540
541     protected function doActionPost(ManagedAction $action, $verb, Notice $target, Profile $scoped)
542     {
543         switch (true) {
544         case ActivityUtils::compareTypes($verb, array(ActivityVerb::FAVORITE, ActivityVerb::LIKE)):
545             Fave::addNew($scoped, $target);
546             break;
547         case ActivityUtils::compareTypes($verb, array(ActivityVerb::UNFAVORITE, ActivityVerb::UNLIKE)):
548             Fave::removeEntry($scoped, $target);
549             break;
550         default:
551             throw new ServerException('ActivityVerb POST not handled by plugin that was supposed to do it.');
552         }
553         return false;
554     }
555
556     protected function getActivityForm(ManagedAction $action, $verb, Notice $target, Profile $scoped)
557     {
558         return Fave::existsForProfile($target, $scoped)
559                 ? new DisfavorForm($action, $target)
560                 : new FavorForm($action, $target);
561     }
562
563     public function onPluginVersion(array &$versions)
564     {
565         $versions[] = array('name' => 'Favorite',
566                             'version' => GNUSOCIAL_VERSION,
567                             'author' => 'Mikael Nordfeldth',
568                             'homepage' => 'http://gnu.io/',
569                             'rawdescription' =>
570                             // TRANS: Plugin description.
571                             _m('Favorites (likes) using ActivityStreams.'));
572
573         return true;
574     }
575 }
576
577 /**
578  * Notify a user that one of their notices has been chosen as a 'fave'
579  *
580  * @param User    $rcpt   The user whose notice was faved
581  * @param Profile $sender The user who faved the notice
582  * @param Notice  $notice The notice that was faved
583  *
584  * @return void
585  */
586 function mail_notify_fave(User $rcpt, Profile $sender, Notice $notice)
587 {
588     if (!$rcpt->receivesEmailNotifications() || !$rcpt->getConfigPref('email', 'notify_fave')) {
589         return;
590     }
591
592     // This test is actually "if the sender is sandboxed"
593     if (!$sender->hasRight(Right::EMAILONFAVE)) {
594         return;
595     }
596
597     if ($rcpt->hasBlocked($sender)) {
598         // If the author has blocked us, don't spam them with a notification.
599         return;
600     }
601
602     // We need the global mail.php for various mail related functions below.
603     require_once INSTALLDIR.'/lib/mail.php';
604
605     $bestname = $sender->getBestName();
606
607     common_switch_locale($rcpt->language);
608
609     // TRANS: Subject for favorite notification e-mail.
610     // TRANS: %1$s is the adding user's long name, %2$s is the adding user's nickname.
611     $subject = sprintf(_('%1$s (@%2$s) added your notice as a favorite'), $bestname, $sender->getNickname());
612
613     // TRANS: Body for favorite notification e-mail.
614     // TRANS: %1$s is the adding user's long name, $2$s is the date the notice was created,
615     // TRANS: %3$s is a URL to the faved notice, %4$s is the faved notice text,
616     // TRANS: %5$s is a URL to all faves of the adding user, %6$s is the StatusNet sitename,
617     // TRANS: %7$s is the adding user's nickname.
618     $body = sprintf(_("%1\$s (@%7\$s) just added your notice from %2\$s".
619                       " as one of their favorites.\n\n" .
620                       "The URL of your notice is:\n\n" .
621                       "%3\$s\n\n" .
622                       "The text of your notice is:\n\n" .
623                       "%4\$s\n\n" .
624                       "You can see the list of %1\$s's favorites here:\n\n" .
625                       "%5\$s"),
626                     $bestname,
627                     common_exact_date($notice->created),
628                     common_local_url('shownotice',
629                                      array('notice' => $notice->id)),
630                     $notice->content,
631                     common_local_url('showfavorites',
632                                      array('nickname' => $sender->getNickname())),
633                     common_config('site', 'name'),
634                     $sender->getNickname()) .
635             mail_footer_block();
636
637     $headers = _mail_prepare_headers('fave', $rcpt->getNickname(), $sender->getNickname());
638
639     common_switch_locale();
640     mail_to_user($rcpt, $subject, $body, $headers);
641 }