plugins/Share/SharePlugin.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 SharePlugin extends ActivityVerbHandlerPlugin
  27 {
  28     public function tag()
  29     {
  30         return 'share';
  31     }
  32
  33     public function types()
  34     {
  35         return array();
  36     }
  37
  38     public function verbs()
  39     {
  40         return array(ActivityVerb::SHARE);
  41     }
  42
  43     public function onRouterInitialized(URLMapper $m)
  44     {
  45         // Web UI actions
  46         $m->connect('main/repeat', array('action' => 'repeat'));
  47
  48         // Share for Twitter API ("Retweet")
  49         $m->connect('api/statuses/retweeted_by_me.:format',
  50                     array('action' => 'ApiTimelineRetweetedByMe',
  51                           'format' => '(xml|json|atom|as)'));
  52
  53         $m->connect('api/statuses/retweeted_to_me.:format',
  54                     array('action' => 'ApiTimelineRetweetedToMe',
  55                           'format' => '(xml|json|atom|as)'));
  56
  57         $m->connect('api/statuses/retweets_of_me.:format',
  58                     array('action' => 'ApiTimelineRetweetsOfMe',
  59                           'format' => '(xml|json|atom|as)'));
  60
  61         $m->connect('api/statuses/retweet/:id.:format',
  62                     array('action' => 'ApiStatusesRetweet',
  63                           'id' => '[0-9]+',
  64                           'format' => '(xml|json)'));
  65
  66         $m->connect('api/statuses/retweets/:id.:format',
  67                     array('action' => 'ApiStatusesRetweets',
  68                           'id' => '[0-9]+',
  69                           'format' => '(xml|json)'));
  70     }
  71
  72     // FIXME: Set this to abstract public in lib/activityhandlerplugin.php when all plugins have migrated!
  73     protected function saveObjectFromActivity(Activity $act, Notice $stored, array $options=array())
  74     {
  75         assert($this->isMyActivity($act));
  76
  77         // The below algorithm is mainly copied from the previous Ostatus_profile->processShare()
  78
  79         if (count($act->objects) !== 1) {
  80             // TRANS: Client exception thrown when trying to share multiple activities at once.
  81             throw new ClientException(_m('Can only handle share activities with exactly one object.'));
  82         }
  83
  84         $shared = $act->objects[0];
  85         if (!$shared instanceof Activity) {
  86             // TRANS: Client exception thrown when trying to share a non-activity object.
  87             throw new ClientException(_m('Can only handle shared activities.'));
  88         }
  89
  90         $sharedUri = $shared->id;
  91         if (!empty($shared->objects[0]->id)) {
  92             // Because StatusNet since commit 8cc4660 sets $shared->id to a TagURI which
  93             // fucks up federation, because the URI is no longer recognised by the origin.
  94             // So we set it to the object ID if it exists, otherwise we trust $shared->id
  95             $sharedUri = $shared->objects[0]->id;
  96         }
  97         if (empty($sharedUri)) {
  98             throw new ClientException(_m('Shared activity does not have an id'));
  99         }
 100
 101         try {
 102             // First check if we have the shared activity. This has to be done first, because
 103             // we can't use these functions to "ensureActivityObjectProfile" of a local user,
 104             // who might be the creator of the shared activity in question.
 105             $sharedNotice = Notice::getByUri($sharedUri);
 106         } catch (NoResultException $e) {
 107             // If no locally stored notice is found, process it!
 108             // TODO: Remember to check Deleted_notice!
 109             // TODO: If a post is shared that we can't retrieve - what to do?
 110             $other = Ostatus_profile::ensureActivityObjectProfile($shared->actor);
 111             $sharedNotice = $other->processActivity($shared, 'push');   // FIXME: push/salmon/what?
 112             if (!$sharedNotice instanceof Notice) {
 113                 // And if we apparently can't get the shared notice, we'll abort the whole thing.
 114                 // TRANS: Client exception thrown when saving an activity share fails.
 115                 // TRANS: %s is a share ID.
 116                 throw new ClientException(sprintf(_m('Failed to save activity %s.'), $sharedUri));
 117             }
 118         } catch (FeedSubException $e) {
 119             // Remote feed could not be found or verified, should we
 120             // transform this into an "RT @user Blah, blah, blah..."?
 121             common_log(LOG_INFO, __METHOD__ . ' got a ' . get_class($e) . ': ' . $e->getMessage());
 122             return false;
 123         }
 124
 125         // We don't have to save a repeat in a separate table, we can
 126         // find repeats by just looking at the notice.repeat_of field.
 127
 128         // By returning true here instead of something that evaluates
 129         // to false, we show that we have processed everything properly.
 130         return true;
 131     }
 132
 133     // FIXME: Put this in lib/activityhandlerplugin.php when we're ready
 134     //          with the other microapps/activityhandlers as well.
 135     //          Also it should be StartNoticeAsActivity (with a prepped Activity, including ->context etc.)
 136     public function onEndNoticeAsActivity(Notice $stored, Activity $act, Profile $scoped=null)
 137     {
 138         if (!$this->isMyNotice($stored)) {
 139             return true;
 140         }
 141
 142         common_debug('Extending activity '.$stored->id.' with '.get_called_class());
 143         $this->extendActivity($stored, $act, $scoped);
 144         return false;
 145     }
 146
 147     public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
 148     {
 149         // TODO: How to handle repeats of deleted notices?
 150         $target = Notice::getById($stored->repeat_of);
 151         // TRANS: A repeat activity's title. %1$s is repeater's nickname
 152         //        and %2$s is the repeated user's nickname.
 153         $act->title = sprintf(_('%1$s repeated a notice by %2$s'),
 154                               $stored->getProfile()->getNickname(),
 155                               $target->getProfile()->getNickname());
 156         $act->objects[] = $target->asActivity($scoped);
 157     }
 158
 159     public function activityObjectFromNotice(Notice $notice)
 160     {
 161         // Repeat is a little bit special. As it's an activity, our
 162         // ActivityObject is instead turned into an Activity
 163         $object          = new Activity();
 164         $object->verb    = ActivityVerb::SHARE;
 165         $object->content = $notice->rendered;
 166         $this->extendActivity($stored, $act);
 167
 168         return $object;
 169     }
 170
 171     public function deleteRelated(Notice $notice)
 172     {
 173         // No action needed as we don't have a separate table for share objects.
 174         return true;
 175     }
 176
 177     // API stuff
 178
 179     /**
 180      * Typically just used to fill out Twitter-compatible API status data.
 181      *
 182      * FIXME: Make all the calls before this end up with a Notice instead of ArrayWrapper please...
 183      */
 184     public function onNoticeSimpleStatusArray($notice, array &$status, Profile $scoped=null, array $args=array())
 185     {
 186         if ($scoped instanceof Profile) {
 187             $status['favorited'] = Fave::existsForProfile($notice, $scoped);
 188         } else {
 189             $status['favorited'] = false;
 190         }
 191         return true;
 192     }
 193
 194     public function onTwitterUserArray(Profile $profile, array &$userdata, Profile $scoped=null, array $args=array())
 195     {
 196         $userdata['favourites_count'] = Fave::countByProfile($profile);
 197     }
 198
 199     /**
 200      * Typically just used to fill out StatusNet specific data in API calls in the referenced $info array.
 201      */
 202     public function onStatusNetApiNoticeInfo(Notice $notice, array &$info, Profile $scoped=null, array $args=array())
 203     {
 204         if ($scoped instanceof Profile) {
 205             $info['favorite'] = Fave::existsForProfile($notice, $scoped) ? 'true' : 'false';
 206         }
 207         return true;
 208     }
 209
 210     public function onNoticeDeleteRelated(Notice $notice)
 211     {
 212         parent::onNoticeDeleteRelated($notice);
 213
 214         // The below algorithm is because we want to delete fave
 215         // activities on any notice which _has_ faves, and not as
 216         // in the parent function only ones that _are_ faves.
 217
 218         $fave = new Fave();
 219         $fave->notice_id = $notice->id;
 220
 221         if ($fave->find()) {
 222             while ($fave->fetch()) {
 223                 $fave->delete();
 224             }
 225         }
 226
 227         $fave->free();
 228     }
 229
 230     public function onProfileDeleteRelated(Profile $profile, array &$related)
 231     {
 232         $fave = new Fave();
 233         $fave->user_id = $profile->id;
 234         $fave->delete();    // Will perform a DELETE matching "user_id = {$user->id}"
 235         $fave->free();
 236
 237         Fave::blowCacheForProfileId($profile->id);
 238         return true;
 239     }
 240
 241     public function onStartNoticeListPrefill(array &$notices, array $notice_ids, Profile $scoped=null)
 242     {
 243         // prefill array of objects, before pluginfication it was Notice::fillFaves($notices)
 244         Fave::fillFaves($notice_ids);
 245
 246         // DB caching
 247         if ($scoped instanceof Profile) {
 248             Fave::pivotGet('notice_id', $notice_ids, array('user_id' => $scoped->id));
 249         }
 250     }
 251
 252     /**
 253      * show the "favorite" form in the notice options element
 254      * FIXME: Don't let a NoticeListItemAdapter slip in here (or extend that from NoticeListItem)
 255      *
 256      * @return void
 257      */
 258     public function onEndShowNoticeOptionItems($nli)
 259     {
 260         // FIXME: Use bitmasks (but be aware that PUBLIC_SCOPE is 0!)
 261         if ($nli->notice->scope == Notice::PUBLIC_SCOPE ||
 262                 $nli->notice->scope == Notice::SITE_SCOPE) {
 263             $scoped = Profile::current();
 264             if ($scoped instanceof Profile &&
 265                     $scoped->getID() !== $nli->notice->getProfile()->getID()) {
 266
 267                 if ($scoped->hasRepeated($nli->notice)) {
 268                     $nli->out->element('span', array('class' => 'repeated',
 269                                                       // TRANS: Title for repeat form status in notice list when a notice has been repeated.
 270                                                       'title' => _('Notice repeated.')),
 271                                         // TRANS: Repeat form status in notice list when a notice has been repeated.
 272                                         _('Repeated'));
 273                 } else {
 274                     $repeat = new RepeatForm($nli->out, $nli->notice);
 275                     $repeat->show();
 276                 }
 277             }
 278         }
 279     }
 280
 281     public function showNoticeListItem(NoticeListItem $nli)
 282     {
 283         // pass
 284     }
 285     public function openNoticeListItemElement(NoticeListItem $nli)
 286     {
 287         // pass
 288     }
 289     public function closeNoticeListItemElement(NoticeListItem $nli)
 290     {
 291         // pass
 292     }
 293
 294     public function onAppendUserActivityStreamObjects(UserActivityStream $uas, array &$objs)
 295     {
 296         $fave = new Fave();
 297         $fave->user_id = $uas->getUser()->id;
 298
 299         if (!empty($uas->after)) {
 300             $fave->whereAdd("modified > '" . common_sql_date($uas->after) . "'");
 301         }
 302
 303         if ($fave->find()) {
 304             while ($fave->fetch()) {
 305                 $objs[] = clone($fave);
 306             }
 307         }
 308
 309         return true;
 310     }
 311
 312     public function onStartShowThreadedNoticeTailItems(NoticeListItem $nli, Notice $notice, &$threadActive)
 313     {
 314         if ($nli instanceof ThreadedNoticeListSubItem) {
 315             // The sub-items are replies to a conversation, thus we use different HTML elements etc.
 316             $item = new ThreadedNoticeListInlineFavesItem($notice, $nli->out);
 317         } else {
 318             $item = new ThreadedNoticeListFavesItem($notice, $nli->out);
 319         }
 320         $threadActive = $item->show() || $threadActive;
 321         return true;
 322     }
 323
 324     public function onEndFavorNotice(Profile $actor, Notice $target)
 325     {
 326         try {
 327             $notice_author = $target->getProfile();
 328             // Don't notify ourselves of our own favorite on our own notice,
 329             // or if it's a remote user (since we don't know their email addresses etc.)
 330             if ($notice_author->id == $actor->id || !$notice_author->isLocal()) {
 331                 return true;
 332             }
 333             $local_user = $notice_author->getUser();
 334             mail_notify_fave($local_user, $actor, $target);
 335         } catch (Exception $e) {
 336             // Mm'kay, probably not a local user. Let's skip this favor notification.
 337         }
 338     }
 339
 340     /**
 341      * EndInterpretCommand for FavoritePlugin will handle the 'fav' command
 342      * using the class FavCommand.
 343      *
 344      * @param string  $cmd     Command being run
 345      * @param string  $arg     Rest of the message (including address)
 346      * @param User    $user    User sending the message
 347      * @param Command &$result The resulting command object to be run.
 348      *
 349      * @return boolean hook value
 350      */
 351     public function onStartInterpretCommand($cmd, $arg, $user, &$result)
 352     {
 353         if ($result === false && in_array($cmd, array('repeat', 'rp', 'rt', 'rd'))) {
 354             if (empty($arg)) {
 355                 $result = null;
 356             } else {
 357                 list($other, $extra) = CommandInterpreter::split_arg($arg);
 358                 if (!empty($extra)) {
 359                     $result = null;
 360                 } else {
 361                     $result = new RepeatCommand($user, $other);
 362                 }
 363             }
 364             return false;
 365         }
 366         return true;
 367     }
 368
 369     public function onHelpCommandMessages(HelpCommand $help, array &$commands)
 370     {
 371         // TRANS: Help message for IM/SMS command "fav <nickname>".
 372         $commands['fav <nickname>'] = _m('COMMANDHELP', "add user's last notice as a 'fave'");
 373         // TRANS: Help message for IM/SMS command "fav #<notice_id>".
 374         $commands['fav #<notice_id>'] = _m('COMMANDHELP', "add notice with the given id as a 'fave'");
 375     }
 376
 377     /**
 378      * Are we allowed to perform a certain command over the API?
 379      */
 380     public function onCommandSupportedAPI(Command $cmd, &$supported)
 381     {
 382         $supported = $supported || $cmd instanceof RepeatCommand;
 383     }
 384
 385     // Form stuff (settings etc.)
 386
 387     public function onEndEmailFormData(Action $action, Profile $scoped)
 388     {
 389         $emailfave = $scoped->getConfigPref('email', 'notify_fave') ? 1 : 0;
 390
 391         $action->elementStart('li');
 392         $action->checkbox('email-notify_fave',
 393                         // TRANS: Checkbox label in e-mail preferences form.
 394                         _('Send me email when someone adds my notice as a favorite.'),
 395                         $emailfave);
 396         $action->elementEnd('li');
 397
 398         return true;
 399     }
 400
 401     public function onStartEmailSaveForm(Action $action, Profile $scoped)
 402     {
 403         $emailfave = $action->booleanintstring('email-notify_fave');
 404         try {
 405             if ($emailfave == $scoped->getPref('email', 'notify_fave')) {
 406                 // No need to update setting
 407                 return true;
 408             }
 409         } catch (NoResultException $e) {
 410             // Apparently there's no previously stored setting, then continue to save it as it is now.
 411         }
 412
 413         $scoped->setPref('email', 'notify_fave', $emailfave);
 414
 415         return true;
 416     }
 417
 418     // Layout stuff
 419
 420     public function onEndPersonalGroupNav(Menu $menu, Profile $target, Profile $scoped=null)
 421     {
 422         $menu->out->menuItem(common_local_url('showfavorites', array('nickname' => $target->getNickname())),
 423                              // TRANS: Menu item in personal group navigation menu.
 424                              _m('MENU','Favorites'),
 425                              // @todo i18n FIXME: Need to make this two messages.
 426                              // TRANS: Menu item title in personal group navigation menu.
 427                              // TRANS: %s is a username.
 428                              sprintf(_('%s\'s favorite notices'), $target->getBestName()),
 429                              $scoped instanceof Profile && $target->id === $scoped->id && $menu->actionName =='showfavorites',
 430                             'nav_timeline_favorites');
 431     }
 432
 433     public function onEndPublicGroupNav(Menu $menu)
 434     {
 435         if (!common_config('singleuser', 'enabled')) {
 436             // TRANS: Menu item in search group navigation panel.
 437             $menu->out->menuItem(common_local_url('favorited'), _m('MENU','Popular'),
 438                                  // TRANS: Menu item title in search group navigation panel.
 439                                  _('Popular notices'), $menu->actionName == 'favorited', 'nav_timeline_favorited');
 440         }
 441     }
 442
 443     public function onEndShowSections(Action $action)
 444     {
 445         if (!$action->isAction(array('all', 'public'))) {
 446             return true;
 447         }
 448
 449         if (!common_config('performance', 'high')) {
 450             $section = new PopularNoticeSection($action, $action->getScoped());
 451             $section->show();
 452         }
 453     }
 454
 455     protected function getActionTitle(ManagedAction $action, $verb, Notice $target, Profile $scoped)
 456     {
 457         return Fave::existsForProfile($target, $scoped)
 458                 // TRANS: Page/dialog box title when a notice is marked as favorite already
 459                 ? _m('TITLE', 'Unmark notice as favorite')
 460                 // TRANS: Page/dialog box title when a notice is not marked as favorite
 461                 : _m('TITLE', 'Mark notice as favorite');
 462     }
 463
 464     protected function doActionPreparation(ManagedAction $action, $verb, Notice $target, Profile $scoped)
 465     {
 466         if ($action->isPost()) {
 467             // The below tests are only for presenting to the user. POSTs which inflict
 468             // duplicate favorite entries are handled with AlreadyFulfilledException.
 469             return false;
 470         }
 471
 472         $exists = Fave::existsForProfile($target, $scoped);
 473         $expected_verb = $exists ? ActivityVerb::UNFAVORITE : ActivityVerb::FAVORITE;
 474
 475         switch (true) {
 476         case $exists && ActivityUtils::compareTypes($verb, array(ActivityVerb::FAVORITE, ActivityVerb::LIKE)):
 477         case !$exists && ActivityUtils::compareTypes($verb, array(ActivityVerb::UNFAVORITE, ActivityVerb::UNLIKE)):
 478             common_redirect(common_local_url('activityverb',
 479                                 array('id'   => $target->getID(),
 480                                       'verb' => ActivityUtils::resolveUri($expected_verb, true))));
 481             break;
 482         default:
 483             // No need to redirect as we are on the correct action already.
 484         }
 485
 486         return false;
 487     }
 488
 489     protected function doActionPost(ManagedAction $action, $verb, Notice $target, Profile $scoped)
 490     {
 491         switch (true) {
 492         case ActivityUtils::compareTypes($verb, array(ActivityVerb::FAVORITE, ActivityVerb::LIKE)):
 493             Fave::addNew($scoped, $target);
 494             break;
 495         case ActivityUtils::compareTypes($verb, array(ActivityVerb::UNFAVORITE, ActivityVerb::UNLIKE)):
 496             Fave::removeEntry($scoped, $target);
 497             break;
 498         default:
 499             throw new ServerException('ActivityVerb POST not handled by plugin that was supposed to do it.');
 500         }
 501         return false;
 502     }
 503
 504     protected function getActivityForm(ManagedAction $action, $verb, Notice $target, Profile $scoped)
 505     {
 506         return Fave::existsForProfile($target, $scoped)
 507                 ? new DisfavorForm($action, $target)
 508                 : new FavorForm($action, $target);
 509     }
 510
 511     public function onPluginVersion(array &$versions)
 512     {
 513         $versions[] = array('name' => 'Share verb',
 514                             'version' => GNUSOCIAL_VERSION,
 515                             'author' => 'Mikael Nordfeldth',
 516                             'homepage' => 'https://gnu.io/',
 517                             'rawdescription' =>
 518                             // TRANS: Plugin description.
 519                             _m('Shares (repeats) using ActivityStreams.'));
 520
 521         return true;
 522     }
 523 }