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->getActor(), $fave->getTarget(), $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         // We must have an objects[0] here because in isMyActivity we require the count to be == 1
 189         $actobj = $act->objects[0];
 190
 191         $object = Fave::saveActivityObject($actobj, $stored);
 192
 193         return $object;
 194     }
 195
 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)
 200     {
 201         if (!$this->isMyNotice($stored)) {
 202             return true;
 203         }
 204
 205         common_debug('Extending activity '.$stored->id.' with '.get_called_class());
 206         $this->extendActivity($stored, $act, $scoped);
 207         return false;
 208     }
 209
 210     public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
 211     {
 212         Fave::extendActivity($stored, $act, $scoped);
 213     }
 214
 215     public function activityObjectFromNotice(Notice $notice)
 216     {
 217         $fave = Fave::fromStored($notice);
 218         return $fave->asActivityObject();
 219     }
 220
 221     public function deleteRelated(Notice $notice)
 222     {
 223         try {
 224             $fave = Fave::fromStored($notice);
 225             $fave->delete();
 226         } catch (NoResultException $e) {
 227             // Cool, no problem. We wanted to get rid of it anyway.
 228         }
 229     }
 230
 231     // API stuff
 232
 233     /**
 234      * Typically just used to fill out Twitter-compatible API status data.
 235      *
 236      * FIXME: Make all the calls before this end up with a Notice instead of ArrayWrapper please...
 237      */
 238     public function onNoticeSimpleStatusArray($notice, array &$status, Profile $scoped=null, array $args=array())
 239     {
 240         if ($scoped instanceof Profile) {
 241             $status['favorited'] = Fave::existsForProfile($notice, $scoped);
 242         } else {
 243             $status['favorited'] = false;
 244         }
 245         return true;
 246     }
 247
 248     public function onTwitterUserArray(Profile $profile, array &$userdata, Profile $scoped=null, array $args=array())
 249     {
 250         $userdata['favourites_count'] = Fave::countByProfile($profile);
 251     }
 252
 253     /**
 254      * Typically just used to fill out StatusNet specific data in API calls in the referenced $info array.
 255      */
 256     public function onStatusNetApiNoticeInfo(Notice $notice, array &$info, Profile $scoped=null, array $args=array())
 257     {
 258         if ($scoped instanceof Profile) {
 259             $info['favorite'] = Fave::existsForProfile($notice, $scoped) ? 'true' : 'false';
 260         }
 261         return true;
 262     }
 263
 264     public function onNoticeDeleteRelated(Notice $notice)
 265     {
 266         parent::onNoticeDeleteRelated($notice);
 267
 268         // The below algorithm is because we want to delete fave
 269         // activities on any notice which _has_ faves, and not as
 270         // in the parent function only ones that _are_ faves.
 271
 272         $fave = new Fave();
 273         $fave->notice_id = $notice->id;
 274
 275         if ($fave->find()) {
 276             while ($fave->fetch()) {
 277                 $fave->delete();
 278             }
 279         }
 280
 281         $fave->free();
 282     }
 283
 284     public function onProfileDeleteRelated(Profile $profile, array &$related)
 285     {
 286         $fave = new Fave();
 287         $fave->user_id = $profile->id;
 288         $fave->delete();    // Will perform a DELETE matching "user_id = {$user->id}"
 289         $fave->free();
 290
 291         Fave::blowCacheForProfileId($profile->id);
 292         return true;
 293     }
 294
 295     public function onStartNoticeListPrefill(array &$notices, array $notice_ids, Profile $scoped=null)
 296     {
 297         // prefill array of objects, before pluginfication it was Notice::fillFaves($notices)
 298         Fave::fillFaves($notice_ids);
 299
 300         // DB caching
 301         if ($scoped instanceof Profile) {
 302             Fave::pivotGet('notice_id', $notice_ids, array('user_id' => $scoped->id));
 303         }
 304     }
 305
 306     /**
 307      * show the "favorite" form in the notice options element
 308      * FIXME: Don't let a NoticeListItemAdapter slip in here (or extend that from NoticeListItem)
 309      *
 310      * @return void
 311      */
 312     public function onStartShowNoticeOptionItems($nli)
 313     {
 314         if (Event::handle('StartShowFaveForm', array($nli))) {
 315             $scoped = Profile::current();
 316             if ($scoped instanceof Profile) {
 317                 if (Fave::existsForProfile($nli->notice, $scoped)) {
 318                     $disfavor = new DisfavorForm($nli->out, $nli->notice);
 319                     $disfavor->show();
 320                 } else {
 321                     $favor = new FavorForm($nli->out, $nli->notice);
 322                     $favor->show();
 323                 }
 324             }
 325             Event::handle('EndShowFaveForm', array($nli));
 326         }
 327     }
 328
 329     protected function showNoticeListItem(NoticeListItem $nli)
 330     {
 331         // pass
 332     }
 333     public function openNoticeListItemElement(NoticeListItem $nli)
 334     {
 335         // pass
 336     }
 337     public function closeNoticeListItemElement(NoticeListItem $nli)
 338     {
 339         // pass
 340     }
 341
 342     public function onAppendUserActivityStreamObjects(UserActivityStream $uas, array &$objs)
 343     {
 344         $fave = new Fave();
 345         $fave->user_id = $uas->getUser()->id;
 346
 347         if (!empty($uas->after)) {
 348             $fave->whereAdd("modified > '" . common_sql_date($uas->after) . "'");
 349         }
 350
 351         if ($fave->find()) {
 352             while ($fave->fetch()) {
 353                 $objs[] = clone($fave);
 354             }
 355         }
 356
 357         return true;
 358     }
 359
 360     public function onEndShowThreadedNoticeTailItems(NoticeListItem $nli, Notice $notice, &$threadActive)
 361     {
 362         if ($nli instanceof ThreadedNoticeListSubItem) {
 363             // The sub-items are replies to a conversation, thus we use different HTML elements etc.
 364             $item = new ThreadedNoticeListInlineFavesItem($notice, $nli->out);
 365         } else {
 366             $item = new ThreadedNoticeListFavesItem($notice, $nli->out);
 367         }
 368         $threadActive = $item->show() || $threadActive;
 369         return true;
 370     }
 371
 372     public function onEndFavorNotice(Profile $actor, Notice $target)
 373     {
 374         try {
 375             $notice_author = $target->getProfile();
 376             // Don't notify ourselves of our own favorite on our own notice,
 377             // or if it's a remote user (since we don't know their email addresses etc.)
 378             if ($notice_author->id == $actor->id || !$notice_author->isLocal()) {
 379                 return true;
 380             }
 381             $local_user = $notice_author->getUser();
 382             mail_notify_fave($local_user, $actor, $target);
 383         } catch (Exception $e) {
 384             // Mm'kay, probably not a local user. Let's skip this favor notification.
 385         }
 386     }
 387
 388     /**
 389      * EndInterpretCommand for FavoritePlugin will handle the 'fav' command
 390      * using the class FavCommand.
 391      *
 392      * @param string  $cmd     Command being run
 393      * @param string  $arg     Rest of the message (including address)
 394      * @param User    $user    User sending the message
 395      * @param Command &$result The resulting command object to be run.
 396      *
 397      * @return boolean hook value
 398      */
 399     public function onStartInterpretCommand($cmd, $arg, $user, &$result)
 400     {
 401         if ($result === false && $cmd == 'fav') {
 402             if (empty($arg)) {
 403                 $result = null;
 404             } else {
 405                 list($other, $extra) = CommandInterpreter::split_arg($arg);
 406                 if (!empty($extra)) {
 407                     $result = null;
 408                 } else {
 409                     $result = new FavCommand($user, $other);
 410                 }
 411             }
 412             return false;
 413         }
 414         return true;
 415     }
 416
 417     public function onHelpCommandMessages(HelpCommand $help, array &$commands)
 418     {
 419         // TRANS: Help message for IM/SMS command "fav <nickname>".
 420         $commands['fav <nickname>'] = _m('COMMANDHELP', "add user's last notice as a 'fave'");
 421         // TRANS: Help message for IM/SMS command "fav #<notice_id>".
 422         $commands['fav #<notice_id>'] = _m('COMMANDHELP', "add notice with the given id as a 'fave'");
 423     }
 424
 425     /**
 426      * Are we allowed to perform a certain command over the API?
 427      */
 428     public function onCommandSupportedAPI(Command $cmd, &$supported)
 429     {
 430         $supported = $supported || $cmd instanceof FavCommand;
 431     }
 432
 433     // Form stuff (settings etc.)
 434
 435     public function onEndEmailFormData(Action $action, Profile $scoped)
 436     {
 437         $emailfave = $scoped->getConfigPref('email', 'notify_fave') ? 1 : 0;
 438
 439         $action->elementStart('li');
 440         $action->checkbox('email-notify_fave',
 441                         // TRANS: Checkbox label in e-mail preferences form.
 442                         _('Send me email when someone adds my notice as a favorite.'),
 443                         $emailfave);
 444         $action->elementEnd('li');
 445
 446         return true;
 447     }
 448
 449     public function onStartEmailSaveForm(Action $action, Profile $scoped)
 450     {
 451         $emailfave = $action->booleanintstring('email-notify_fave');
 452         try {
 453             if ($emailfave == $scoped->getPref('email', 'notify_fave')) {
 454                 // No need to update setting
 455                 return true;
 456             }
 457         } catch (NoResultException $e) {
 458             // Apparently there's no previously stored setting, then continue to save it as it is now.
 459         }
 460
 461         $scoped->setPref('email', 'notify_fave', $emailfave);
 462
 463         return true;
 464     }
 465
 466     // Layout stuff
 467
 468     public function onEndPersonalGroupNav(Menu $menu, Profile $target, Profile $scoped=null)
 469     {
 470         $menu->out->menuItem(common_local_url('showfavorites', array('nickname' => $target->getNickname())),
 471                              // TRANS: Menu item in personal group navigation menu.
 472                              _m('MENU','Favorites'),
 473                              // @todo i18n FIXME: Need to make this two messages.
 474                              // TRANS: Menu item title in personal group navigation menu.
 475                              // TRANS: %s is a username.
 476                              sprintf(_('%s\'s favorite notices'), $target->getBestName()),
 477                              $scoped instanceof Profile && $target->id === $scoped->id && $menu->actionName =='showfavorites',
 478                             'nav_timeline_favorites');
 479     }
 480
 481     public function onEndPublicGroupNav(Menu $menu)
 482     {
 483         if (!common_config('singleuser', 'enabled')) {
 484             // TRANS: Menu item in search group navigation panel.
 485             $menu->out->menuItem(common_local_url('favorited'), _m('MENU','Popular'),
 486                                  // TRANS: Menu item title in search group navigation panel.
 487                                  _('Popular notices'), $menu->actionName == 'favorited', 'nav_timeline_favorited');
 488         }
 489     }
 490
 491     public function onEndShowSections(Action $action)
 492     {
 493         if (!$action->isAction(array('all', 'public'))) {
 494             return true;
 495         }
 496
 497         if (!common_config('performance', 'high')) {
 498             $section = new PopularNoticeSection($action, $action->getScoped());
 499             $section->show();
 500         }
 501     }
 502
 503     protected function getActionTitle(ManagedAction $action, $verb, Notice $target, Profile $scoped)
 504     {
 505         return Fave::existsForProfile($target, $scoped)
 506                 // TRANS: Page/dialog box title when a notice is marked as favorite already
 507                 ? _m('TITLE', 'Unmark notice as favorite')
 508                 // TRANS: Page/dialog box title when a notice is not marked as favorite
 509                 : _m('TITLE', 'Mark notice as favorite');
 510     }
 511
 512     protected function doActionPreparation(ManagedAction $action, $verb, Notice $target, Profile $scoped)
 513     {
 514         if ($action->isPost()) {
 515             // The below tests are only for presenting to the user. POSTs which inflict
 516             // duplicate favorite entries are handled with AlreadyFulfilledException.
 517             return false;
 518         }
 519
 520         $exists = Fave::existsForProfile($target, $scoped);
 521         $expected_verb = $exists ? ActivityVerb::UNFAVORITE : ActivityVerb::FAVORITE;
 522
 523         switch (true) {
 524         case $exists && ActivityUtils::compareVerbs($verb, array(ActivityVerb::FAVORITE, ActivityVerb::LIKE)):
 525         case !$exists && ActivityUtils::compareVerbs($verb, array(ActivityVerb::UNFAVORITE, ActivityVerb::UNLIKE)):
 526             common_redirect(common_local_url('activityverb',
 527                                 array('id'   => $target->getID(),
 528                                       'verb' => ActivityUtils::resolveUri($expected_verb, true))));
 529             break;
 530         default:
 531             // No need to redirect as we are on the correct action already.
 532         }
 533
 534         return false;
 535     }
 536
 537     protected function doActionPost(ManagedAction $action, $verb, Notice $target, Profile $scoped)
 538     {
 539         switch (true) {
 540         case ActivityUtils::compareVerbs($verb, array(ActivityVerb::FAVORITE, ActivityVerb::LIKE)):
 541             Fave::addNew($scoped, $target);
 542             break;
 543         case ActivityUtils::compareVerbs($verb, array(ActivityVerb::UNFAVORITE, ActivityVerb::UNLIKE)):
 544             Fave::removeEntry($scoped, $target);
 545             break;
 546         default:
 547             throw new ServerException('ActivityVerb POST not handled by plugin that was supposed to do it.');
 548         }
 549         return false;
 550     }
 551
 552     protected function getActivityForm(ManagedAction $action, $verb, Notice $target, Profile $scoped)
 553     {
 554         return Fave::existsForProfile($target, $scoped)
 555                 ? new DisfavorForm($action, $target)
 556                 : new FavorForm($action, $target);
 557     }
 558
 559     public function onPluginVersion(array &$versions)
 560     {
 561         $versions[] = array('name' => 'Favorite',
 562                             'version' => GNUSOCIAL_VERSION,
 563                             'author' => 'Mikael Nordfeldth',
 564                             'homepage' => 'http://gnu.io/',
 565                             'rawdescription' =>
 566                             // TRANS: Plugin description.
 567                             _m('Favorites (likes) using ActivityStreams.'));
 568
 569         return true;
 570     }
 571 }
 572
 573 /**
 574  * Notify a user that one of their notices has been chosen as a 'fave'
 575  *
 576  * @param User    $rcpt   The user whose notice was faved
 577  * @param Profile $sender The user who faved the notice
 578  * @param Notice  $notice The notice that was faved
 579  *
 580  * @return void
 581  */
 582 function mail_notify_fave(User $rcpt, Profile $sender, Notice $notice)
 583 {
 584     if (!$rcpt->receivesEmailNotifications() || !$rcpt->getConfigPref('email', 'notify_fave')) {
 585         return;
 586     }
 587
 588     // This test is actually "if the sender is sandboxed"
 589     if (!$sender->hasRight(Right::EMAILONFAVE)) {
 590         return;
 591     }
 592
 593     if ($rcpt->hasBlocked($sender)) {
 594         // If the author has blocked us, don't spam them with a notification.
 595         return;
 596     }
 597
 598     // We need the global mail.php for various mail related functions below.
 599     require_once INSTALLDIR.'/lib/mail.php';
 600
 601     $bestname = $sender->getBestName();
 602
 603     common_switch_locale($rcpt->language);
 604
 605     // TRANS: Subject for favorite notification e-mail.
 606     // TRANS: %1$s is the adding user's long name, %2$s is the adding user's nickname.
 607     $subject = sprintf(_('%1$s (@%2$s) added your notice as a favorite'), $bestname, $sender->getNickname());
 608
 609     // TRANS: Body for favorite notification e-mail.
 610     // TRANS: %1$s is the adding user's long name, $2$s is the date the notice was created,
 611     // TRANS: %3$s is a URL to the faved notice, %4$s is the faved notice text,
 612     // TRANS: %5$s is a URL to all faves of the adding user, %6$s is the StatusNet sitename,
 613     // TRANS: %7$s is the adding user's nickname.
 614     $body = sprintf(_("%1\$s (@%7\$s) just added your notice from %2\$s".
 615                       " as one of their favorites.\n\n" .
 616                       "The URL of your notice is:\n\n" .
 617                       "%3\$s\n\n" .
 618                       "The text of your notice is:\n\n" .
 619                       "%4\$s\n\n" .
 620                       "You can see the list of %1\$s's favorites here:\n\n" .
 621                       "%5\$s"),
 622                     $bestname,
 623                     common_exact_date($notice->created),
 624                     common_local_url('shownotice',
 625                                      array('notice' => $notice->id)),
 626                     $notice->content,
 627                     common_local_url('showfavorites',
 628                                      array('nickname' => $sender->getNickname())),
 629                     common_config('site', 'name'),
 630                     $sender->getNickname()) .
 631             mail_footer_block();
 632
 633     $headers = _mail_prepare_headers('fave', $rcpt->getNickname(), $sender->getNickname());
 634
 635     common_switch_locale();
 636     mail_to_user($rcpt, $subject, $body, $headers);
 637 }