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 ActivityHandlerPlugin
  27 {
  28     public function tag()
  29     {
  30         return 'favorite';
  31     }
  32
  33     public function types()
  34     {
  35         return array();
  36     }
  37
  38     public function verbs()
  39     {
  40         return array(ActivityVerb::FAVORITE);
  41     }
  42
  43     public function onCheckSchema()
  44     {
  45         $schema = Schema::get();
  46         $schema->ensureTable('fave', Fave::schemaDef());
  47         return true;
  48     }
  49
  50     public function onEndUpgrade()
  51     {
  52         printfnq("Ensuring all faves have a URI...");
  53
  54         $fave = new Fave();
  55         $fave->whereAdd('uri IS NULL');
  56
  57         if ($fave->find()) {
  58             while ($fave->fetch()) {
  59                 try {
  60                     $fave->decache();
  61                     $fave->query(sprintf('UPDATE fave '.
  62                                          'SET uri = "%s", '.
  63                                          '    modified = "%s" '.
  64                                          'WHERE user_id = %d '.
  65                                          'AND notice_id = %d',
  66                                          Fave::newURI($fave->user_id, $fave->notice_id, $fave->modified),
  67                                          common_sql_date(strtotime($fave->modified)),
  68                                          $fave->user_id,
  69                                          $fave->notice_id));
  70                 } catch (Exception $e) {
  71                     common_log(LOG_ERR, "Error updating fave URI: " . $e->getMessage());
  72                 }
  73             }
  74         }
  75
  76         printfnq("DONE.\n");
  77     }
  78
  79     public function onRouterInitialized(URLMapper $m)
  80     {
  81         // Web UI actions
  82         $m->connect('main/favor', array('action' => 'favor'));
  83         $m->connect('main/disfavor', array('action' => 'disfavor'));
  84
  85         if (common_config('singleuser', 'enabled')) {
  86             $nickname = User::singleUserNickname();
  87
  88             $m->connect('favorites',
  89                         array('action' => 'showfavorites',
  90                               'nickname' => $nickname));
  91             $m->connect('favoritesrss',
  92                         array('action' => 'favoritesrss',
  93                               'nickname' => $nickname));
  94         } else {
  95             $m->connect('favoritedrss', array('action' => 'favoritedrss'));
  96             $m->connect('favorited/', array('action' => 'favorited'));
  97             $m->connect('favorited', array('action' => 'favorited'));
  98
  99             $m->connect(':nickname/favorites',
 100                         array('action' => 'showfavorites'),
 101                         array('nickname' => Nickname::DISPLAY_FMT));
 102             $m->connect(':nickname/favorites/rss',
 103                         array('action' => 'favoritesrss'),
 104                         array('nickname' => Nickname::DISPLAY_FMT));
 105         }
 106
 107         // Favorites for API
 108         $m->connect('api/favorites/create.:format',
 109                     array('action' => 'ApiFavoriteCreate',
 110                           'format' => '(xml|json)'));
 111         $m->connect('api/favorites/destroy.:format',
 112                     array('action' => 'ApiFavoriteDestroy',
 113                           'format' => '(xml|json)'));
 114         $m->connect('api/favorites/list.:format',
 115                     array('action' => 'ApiTimelineFavorites',
 116                           'format' => '(xml|json|rss|atom|as)'));
 117         $m->connect('api/favorites/:id.:format',
 118                     array('action' => 'ApiTimelineFavorites',
 119                           'id' => Nickname::INPUT_FMT,
 120                           'format' => '(xml|json|rss|atom|as)'));
 121         $m->connect('api/favorites.:format',
 122                     array('action' => 'ApiTimelineFavorites',
 123                           'format' => '(xml|json|rss|atom|as)'));
 124         $m->connect('api/favorites/create/:id.:format',
 125                     array('action' => 'ApiFavoriteCreate',
 126                           'id' => '[0-9]+',
 127                           'format' => '(xml|json)'));
 128         $m->connect('api/favorites/destroy/:id.:format',
 129                     array('action' => 'ApiFavoriteDestroy',
 130                           'id' => '[0-9]+',
 131                           'format' => '(xml|json)'));
 132
 133         // AtomPub API
 134         $m->connect('api/statusnet/app/favorites/:profile/:notice.atom',
 135                     array('action' => 'AtomPubShowFavorite'),
 136                     array('profile' => '[0-9]+',
 137                           'notice' => '[0-9]+'));
 138
 139         $m->connect('api/statusnet/app/favorites/:profile.atom',
 140                     array('action' => 'AtomPubFavoriteFeed'),
 141                     array('profile' => '[0-9]+'));
 142
 143         // Required for qvitter API
 144         $m->connect('api/statuses/favs/:id.:format',
 145                     array('action' => 'ApiStatusesFavs',
 146                           'id' => '[0-9]+',
 147                           'format' => '(xml|json)'));
 148     }
 149
 150     // FIXME: Set this to abstract public in lib/activityhandlerplugin.php ddwhen all plugins have migrated!
 151     protected function saveObjectFromActivity(Activity $act, Notice $stored, array $options=array())
 152     {
 153         assert($this->isMyActivity($act));
 154
 155         // If empty, we should've created it ourselves on our node.
 156         if (!isset($options['created'])) {
 157             $options['created'] = !empty($act->time) ? common_sql_date($act->time) : common_sql_now();
 158         }
 159         if (!isset($options['uri'])) {
 160             $options['uri'] = !empty($act->id) ? $act->id : $act->selfLink;
 161         }
 162
 163         // We must have an objects[0] here because in isMyActivity we require the count to be == 1
 164         $actobj = $act->objects[0];
 165
 166         try {
 167             $object = Fave::saveActivityObject($actobj, $stored);
 168         } catch (ServerException $e) {
 169             // Probably that the favored notice doesn't exist in our local database
 170             // but may also be some missing profile or so, which we could catch in a
 171             // more explicit catch-statement.
 172             return null;
 173         }
 174         common_debug(get_called_class().' returning '.get_class($object).' object with uri: '.$object->uri);
 175         return $object;
 176     }
 177
 178
 179     public function activityObjectFromNotice(Notice $notice)
 180     {
 181         $fave = Fave::fromStored($notice);
 182         return $fave->asActivityObject();
 183     }
 184
 185     public function deleteRelated(Notice $notice)
 186     {
 187         try {
 188             $fave = Fave::fromStored($notice);
 189             $fave->delete();
 190         } catch (NoResultException $e) {
 191             // Cool, no problem. We wanted to get rid of it anyway.
 192         }
 193     }
 194
 195     // API stuff
 196
 197     /**
 198      * Typically just used to fill out Twitter-compatible API status data.
 199      *
 200      * FIXME: Make all the calls before this end up with a Notice instead of ArrayWrapper please...
 201      */
 202     public function onNoticeSimpleStatusArray($notice, array &$status, Profile $scoped=null, array $args=array())
 203     {
 204         if ($scoped instanceof Profile) {
 205             $status['favorited'] = Fave::existsForProfile($notice, $scoped);
 206         } else {
 207             $status['favorited'] = false;
 208         }
 209         return true;
 210     }
 211
 212     public function onTwitterUserArray(Profile $profile, array &$userdata, Profile $scoped=null, array $args=array())
 213     {
 214         $userdata['favourites_count'] = Fave::countByProfile($profile);
 215     }
 216
 217     /**
 218      * Typically just used to fill out StatusNet specific data in API calls in the referenced $info array.
 219      */
 220     public function onStatusNetApiNoticeInfo(Notice $notice, array &$info, Profile $scoped=null, array $args=array())
 221     {
 222         if ($scoped instanceof Profile) {
 223             $info['favorite'] = Fave::existsForProfile($notice, $scoped) ? 'true' : 'false';
 224         }
 225         return true;
 226     }
 227
 228     public function onNoticeDeleteRelated(Notice $notice)
 229     {
 230         parent::onNoticeDeleteRelated($notice);
 231
 232         // The below algorithm is because we want to delete fave
 233         // activities on any notice which _has_ faves, and not as
 234         // in the parent function only ones that _are_ faves.
 235
 236         $fave = new Fave();
 237         $fave->notice_id = $notice->id;
 238
 239         if ($fave->find()) {
 240             while ($fave->fetch()) {
 241                 $fave->delete();
 242             }
 243         }
 244
 245         $fave->free();
 246     }
 247
 248     public function onUserDeleteRelated(User $user, array &$related)
 249     {
 250         $fave = new Fave();
 251         $fave->user_id = $user->id;
 252         $fave->delete();    // Will perform a DELETE matching "user_id = {$user->id}"
 253
 254         Fave::blowCacheForProfileId($user->id);
 255         return true;
 256     }
 257
 258     public function onStartNoticeListPrefill(array &$notices, array $notice_ids, Profile $scoped=null)
 259     {
 260         // prefill array of objects, before pluginfication it was Notice::fillFaves($notices)
 261         Fave::fillFaves($notice_ids);
 262
 263         // DB caching
 264         if ($scoped instanceof Profile) {
 265             Fave::pivotGet('notice_id', $notice_ids, array('user_id' => $scoped->id));
 266         }
 267     }
 268
 269     /**
 270      * show the "favorite" form in the notice options element
 271      * FIXME: Don't let a NoticeListItemAdapter slip in here (or extend that from NoticeListItem)
 272      *
 273      * @return void
 274      */
 275     public function onStartShowNoticeOptionItems($nli)
 276     {
 277         if (Event::handle('StartShowFaveForm', array($nli))) {
 278             $scoped = Profile::current();
 279             if ($scoped instanceof Profile) {
 280                 if (Fave::existsForProfile($nli->notice, $scoped)) {
 281                     $disfavor = new DisfavorForm($nli->out, $nli->notice);
 282                     $disfavor->show();
 283                 } else {
 284                     $favor = new FavorForm($nli->out, $nli->notice);
 285                     $favor->show();
 286                 }
 287             }
 288             Event::handle('EndShowFaveForm', array($nli));
 289         }
 290     }
 291
 292     public function showNoticeListItem(NoticeListItem $nli)
 293     {
 294         // pass
 295     }
 296     public function openNoticeListItemElement(NoticeListItem $nli)
 297     {
 298         // pass
 299     }
 300     public function closeNoticeListItemElement(NoticeListItem $nli)
 301     {
 302         // pass
 303     }
 304
 305     public function onAppendUserActivityStreamObjects(UserActivityStream $uas, array &$objs)
 306     {
 307         $faves = array();
 308         $fave = new Fave();
 309         $fave->user_id = $uas->user->id;
 310
 311         if (!empty($uas->after)) {
 312             $fave->whereAdd("modified > '" . common_sql_date($uas->after) . "'");
 313         }
 314
 315         if ($fave->find()) {
 316             while ($fave->fetch()) {
 317                 $faves[] = clone($fave);
 318             }
 319         }
 320
 321         return $faves;
 322     }
 323
 324     public function onStartShowThreadedNoticeTailItems(NoticeListItem $nli, Notice $notice, &$threadActive)
 325     {
 326         if ($nli instanceof ThreadedNoticeListSubItem) {
 327             // The sub-items are replies to a conversation, thus we use different HTML elements etc.
 328             $item = new ThreadedNoticeListInlineFavesItem($notice, $nli->out);
 329         } else {
 330             $item = new ThreadedNoticeListFavesItem($notice, $nli->out);
 331         }
 332         $threadActive = $item->show() || $threadActive;
 333         return true;
 334     }
 335
 336     /**
 337      * EndInterpretCommand for FavoritePlugin will handle the 'fav' command
 338      * using the class FavCommand.
 339      *
 340      * @param string  $cmd     Command being run
 341      * @param string  $arg     Rest of the message (including address)
 342      * @param User    $user    User sending the message
 343      * @param Command &$result The resulting command object to be run.
 344      *
 345      * @return boolean hook value
 346      */
 347     public function onStartInterpretCommand($cmd, $arg, $user, &$result)
 348     {
 349         if ($result === false && $cmd == 'fav') {
 350             if (empty($arg)) {
 351                 $result = null;
 352             } else {
 353                 list($other, $extra) = $this->split_arg($arg);
 354                 if (!empty($extra)) {
 355                     $result = null;
 356                 } else {
 357                     $result = new FavCommand($user, $other);
 358                 }
 359             }
 360             return false;
 361         }
 362         return true;
 363     }
 364
 365     public function onHelpCommandMessages(HelpCommand $help, array &$commands)
 366     {
 367         // TRANS: Help message for IM/SMS command "fav <nickname>".
 368         $commands['fav <nickname>'] = _m('COMMANDHELP', "add user's last notice as a 'fave'");
 369         // TRANS: Help message for IM/SMS command "fav #<notice_id>".
 370         $commands['fav #<notice_id>'] = _m('COMMANDHELP', "add notice with the given id as a 'fave'");
 371     }
 372
 373     /**
 374      * Are we allowed to perform a certain command over the API?
 375      */
 376     public function onCommandSupportedAPI(Command $cmd, array &$supported)
 377     {
 378         $supported = $supported || $cmd instanceof FavCommand;
 379     }
 380
 381     // Layout stuff
 382
 383     public function onEndPersonalGroupNav(Menu $menu, Profile $target, Profile $scoped=null)
 384     {
 385         $menu->out->menuItem(common_local_url('showfavorites', array('nickname' => $target->getNickname())),
 386                              // TRANS: Menu item in personal group navigation menu.
 387                              _m('MENU','Favorites'),
 388                              // @todo i18n FIXME: Need to make this two messages.
 389                              // TRANS: Menu item title in personal group navigation menu.
 390                              // TRANS: %s is a username.
 391                              sprintf(_('%s\'s favorite notices'), $target->getBestName()),
 392                              $scoped instanceof Profile && $target->id === $scoped->id && $menu->actionName =='showfavorites',
 393                             'nav_timeline_favorites');
 394     }
 395
 396     public function onEndPublicGroupNav(Menu $menu)
 397     {
 398         if (!common_config('singleuser', 'enabled')) {
 399             // TRANS: Menu item in search group navigation panel.
 400             $menu->out->menuItem(common_local_url('favorited'), _m('MENU','Popular'),
 401                                  // TRANS: Menu item title in search group navigation panel.
 402                                  _('Popular notices'), $menu->actionName == 'favorited', 'nav_timeline_favorited');
 403         }
 404     }
 405
 406     public function onEndShowSections(Action $action)
 407     {
 408         if (!$action->isAction(array('all', 'public'))) {
 409             return true;
 410         }
 411
 412         if (!common_config('performance', 'high')) {
 413             $section = new PopularNoticeSection($action, $action->getScoped());
 414             $section->show();
 415         }
 416     }
 417
 418     public function onPluginVersion(array &$versions)
 419     {
 420         $versions[] = array('name' => 'Favorite',
 421                             'version' => GNUSOCIAL_VERSION,
 422                             'author' => 'Mikael Nordfeldth',
 423                             'homepage' => 'http://gnu.io/',
 424                             'rawdescription' =>
 425                             // TRANS: Plugin description.
 426                             _m('Favorites (likes) using ActivityStreams.'));
 427
 428         return true;
 429     }
 430 }