lib/activityhandlerplugin.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  * Superclass for plugins which add Activity types and such
  24  *
  25  * @category  Activity
  26  * @package   GNUsocial
  27  * @author    Mikael Nordfeldth <mmn@hethane.se>
  28  * @copyright 2014 Free Software Foundation, Inc.
  29  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  30  * @link      http://gnu.io/social
  31  */
  32 abstract class ActivityHandlerPlugin extends Plugin
  33 {
  34     /**
  35      * Returns a key string which represents this activity in HTML classes,
  36      * ids etc, as when offering selection of what type of post to make.
  37      * In MicroAppPlugin, this is paired with the user-visible localizable appTitle().
  38      *
  39      * @return string (compatible with HTML classes)
  40      */
  41     abstract function tag();
  42
  43     /**
  44      * Return a list of ActivityStreams object type IRIs
  45      * which this micro-app handles. Default implementations
  46      * of the base class will use this list to check if a
  47      * given ActivityStreams object belongs to us, via
  48      * $this->isMyNotice() or $this->isMyActivity.
  49      *
  50      * An empty list means any type is ok. (Favorite verb etc.)
  51      *
  52      * @return array of strings
  53      */
  54     abstract function types();
  55
  56     /**
  57      * Return a list of ActivityStreams verb IRIs which
  58      * this micro-app handles. Default implementations
  59      * of the base class will use this list to check if a
  60      * given ActivityStreams verb belongs to us, via
  61      * $this->isMyNotice() or $this->isMyActivity.
  62      *
  63      * All micro-app classes must override this method.
  64      *
  65      * @return array of strings
  66      */
  67     public function verbs() {
  68         return array(ActivityVerb::POST);
  69     }
  70
  71     /**
  72      * Check if a given ActivityStreams activity should be handled by this
  73      * micro-app plugin.
  74      *
  75      * The default implementation checks against the activity type list
  76      * returned by $this->types(), and requires that exactly one matching
  77      * object be present. You can override this method to expand
  78      * your checks or to compare the activity's verb, etc.
  79      *
  80      * @param Activity $activity
  81      * @return boolean
  82      */
  83     function isMyActivity(Activity $act) {
  84         return (count($act->objects) == 1
  85             && ($act->objects[0] instanceof ActivityObject)
  86             && $this->isMyVerb($act->verb)
  87             && $this->isMyType($act->objects[0]->type));
  88     }
  89
  90     /**
  91      * Check if a given notice object should be handled by this micro-app
  92      * plugin.
  93      *
  94      * The default implementation checks against the activity type list
  95      * returned by $this->types(). You can override this method to expand
  96      * your checks, but follow the execution chain to get it right.
  97      *
  98      * @param Notice $notice
  99      * @return boolean
 100      */
 101     function isMyNotice(Notice $notice) {
 102         return $this->isMyVerb($notice->verb) && $this->isMyType($notice->object_type);
 103     }
 104
 105     function isMyVerb($verb) {
 106         $verb = $verb ?: ActivityVerb::POST;    // post is the default verb
 107         return ActivityUtils::compareTypes($verb, $this->verbs());
 108     }
 109
 110     function isMyType($type) {
 111         return count($this->types())===0 || ActivityUtils::compareTypes($type, $this->types());
 112     }
 113
 114     /**
 115      * Given a parsed ActivityStreams activity, your plugin
 116      * gets to figure out how to actually save it into a notice
 117      * and any additional data structures you require.
 118      *
 119      * This function is deprecated and in the future, Notice::saveActivity
 120      * should be called from onStartHandleFeedEntryWithProfile in this class
 121      * (which instead turns to saveObjectFromActivity).
 122      *
 123      * @param Activity $activity
 124      * @param Profile $actor
 125      * @param array $options=array()
 126      *
 127      * @return Notice the resulting notice
 128      */
 129     public function saveNoticeFromActivity(Activity $activity, Profile $actor, array $options=array())
 130     {
 131         // Any plugin which has not implemented saveObjectFromActivity _must_
 132         // override this function until they are migrated (this function will
 133         // be deleted when all plugins are migrated to saveObjectFromActivity).
 134
 135         if (isset($this->oldSaveNew)) {
 136             throw new ServerException('A function has been called for new saveActivity functionality, but is still set with an oldSaveNew configuration');
 137         }
 138
 139         return Notice::saveActivity($activity, $actor, $options);
 140     }
 141
 142     /**
 143     * Given a parsed ActivityStreams activity, your plugin gets
 144     * to figure out itself how to store the additional data into
 145     * the database, besides the base data stored by the core.
 146     *
 147     * This will handle just about all events where an activity
 148     * object gets saved, whether it is via AtomPub, OStatus
 149     * (PuSH and Salmon transports), or ActivityStreams-based
 150     * backup/restore of account data.
 151     *
 152     * You should be able to accept as input the output from an
 153     * asActivity() call on the stored object. Where applicable,
 154     * try to use existing ActivityStreams structures and object
 155     * types, and be liberal in accepting input from what might
 156     * be other compatible apps.
 157     *
 158     * All micro-app classes must override this method.
 159     *
 160     * @fixme are there any standard options?
 161     *
 162     * @param Activity $activity
 163     * @param Profile $actor
 164     * @param array $options=array()
 165     *
 166     * @return Notice the resulting notice
 167     */
 168     protected function saveObjectFromActivity(Activity $activity, Notice $stored, array $options=array())
 169     {
 170         throw new ServerException('This function should be abstract when all plugins have migrated to saveObjectFromActivity');
 171     }
 172
 173     /*
 174      * This usually gets called from Notice::saveActivity after a Notice object has been created,
 175      * so it contains a proper id and a uri for the object to be saved.
 176      */
 177     public function onStoreActivityObject(Activity $act, Notice $stored, array $options=array(), &$object) {
 178         // $this->oldSaveNew is there during a migration period of plugins, to start using
 179         // Notice::saveActivity instead of Notice::saveNew
 180         if (!$this->isMyActivity($act) || isset($this->oldSaveNew)) {
 181             return true;
 182         }
 183         $object = $this->saveObjectFromActivity($act, $stored, $options);
 184         try {
 185             $act->context->attention = array_merge($act->context->attention, $object->getAttentionArray());
 186         } catch (Exception $e) {
 187             common_debug('WARNING: Could not get attention list from object '.get_class($object).'!');
 188         }
 189         return false;
 190     }
 191
 192     /**
 193      * Given an existing Notice object, your plugin gets to
 194      * figure out how to arrange it into an ActivityStreams
 195      * object.
 196      *
 197      * This will be how your specialized notice gets output in
 198      * Atom feeds and JSON-based ActivityStreams output, including
 199      * account backup/restore and OStatus (PuSH and Salmon transports).
 200      *
 201      * You should be able to round-trip data from this format back
 202      * through $this->saveNoticeFromActivity(). Where applicable, try
 203      * to use existing ActivityStreams structures and object types,
 204      * and consider interop with other compatible apps.
 205      *
 206      * All micro-app classes must override this method.
 207      *
 208      * @fixme this outputs an ActivityObject, not an Activity. Any compat issues?
 209      *
 210      * @param Notice $notice
 211      *
 212      * @return ActivityObject
 213      */
 214     abstract function activityObjectFromNotice(Notice $notice);
 215
 216     /**
 217      * When a notice is deleted, you'll be called here for a chance
 218      * to clean up any related resources.
 219      *
 220      * All micro-app classes must override this method.
 221      *
 222      * @param Notice $notice
 223      */
 224     abstract function deleteRelated(Notice $notice);
 225
 226     protected function notifyMentioned(Notice $stored, array &$mentioned_ids)
 227     {
 228         // pass through silently by default
 229     }
 230
 231     /**
 232      * Called when generating Atom XML ActivityStreams output from an
 233      * ActivityObject belonging to this plugin. Gives the plugin
 234      * a chance to add custom output.
 235      *
 236      * Note that you can only add output of additional XML elements,
 237      * not change existing stuff here.
 238      *
 239      * If output is already handled by the base Activity classes,
 240      * you can leave this base implementation as a no-op.
 241      *
 242      * @param ActivityObject $obj
 243      * @param XMLOutputter $out to add elements at end of object
 244      */
 245     function activityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
 246     {
 247         // default is a no-op
 248     }
 249
 250     /**
 251      * Called when generating JSON ActivityStreams output from an
 252      * ActivityObject belonging to this plugin. Gives the plugin
 253      * a chance to add custom output.
 254      *
 255      * Modify the array contents to your heart's content, and it'll
 256      * all get serialized out as JSON.
 257      *
 258      * If output is already handled by the base Activity classes,
 259      * you can leave this base implementation as a no-op.
 260      *
 261      * @param ActivityObject $obj
 262      * @param array &$out JSON-targeted array which can be modified
 263      */
 264     public function activityObjectOutputJson(ActivityObject $obj, array &$out)
 265     {
 266         // default is a no-op
 267     }
 268
 269     /**
 270      * When a notice is deleted, delete the related objects
 271      * by calling the overridable $this->deleteRelated().
 272      *
 273      * @param Notice $notice Notice being deleted
 274      *
 275      * @return boolean hook value
 276      */
 277     function onNoticeDeleteRelated(Notice $notice)
 278     {
 279         if ($this->isMyNotice($notice)) {
 280             $this->deleteRelated($notice);
 281         }
 282
 283         // Always continue this event in our activity handling plugins.
 284         return true;
 285     }
 286
 287     /**
 288      * @param Notice $stored            The notice being distributed
 289      * @param array  &$mentioned_ids    List of profiles (from $stored->getReplies())
 290      */
 291     public function onStartNotifyMentioned(Notice $stored, array &$mentioned_ids)
 292     {
 293         if (!$this->isMyNotice($stored)) {
 294             return true;
 295         }
 296
 297         $this->notifyMentioned($stored, $mentioned_ids);
 298
 299         // If it was _our_ notice, only we should do anything with the mentions.
 300         return false;
 301     }
 302
 303     /**
 304      * Render a notice as one of our objects
 305      *
 306      * @param Notice         $notice  Notice to render
 307      * @param ActivityObject &$object Empty object to fill
 308      *
 309      * @return boolean hook value
 310      */
 311     function onStartActivityObjectFromNotice(Notice $notice, &$object)
 312     {
 313         if (!$this->isMyNotice($notice)) {
 314             return true;
 315         }
 316
 317         try {
 318             $object = $this->activityObjectFromNotice($notice);
 319         } catch (NoResultException $e) {
 320             $object = null; // because getKV returns null on failure
 321         }
 322         return false;
 323     }
 324
 325     /**
 326      * Handle a posted object from PuSH
 327      *
 328      * @param Activity        $activity activity to handle
 329      * @param Profile         $actor Profile for the feed
 330      *
 331      * @return boolean hook value
 332      */
 333     function onStartHandleFeedEntryWithProfile(Activity $activity, Profile $profile, &$notice)
 334     {
 335         if (!$this->isMyActivity($activity)) {
 336             return true;
 337         }
 338
 339         // We are guaranteed to get a Profile back from checkAuthorship (or it throws an exception)
 340         $profile = ActivityUtils::checkAuthorship($activity, $profile);
 341
 342         $object = $activity->objects[0];
 343
 344         $options = array('uri' => $object->id,
 345                          'url' => $object->link,
 346                          'is_local' => Notice::REMOTE,
 347                          'source' => 'ostatus');
 348
 349         if (!isset($this->oldSaveNew)) {
 350             $notice = Notice::saveActivity($activity, $profile, $options);
 351         } else {
 352             $notice = $this->saveNoticeFromActivity($activity, $profile, $options);
 353         }
 354
 355         return false;
 356     }
 357
 358     /**
 359      * Handle a posted object from Salmon
 360      *
 361      * @param Activity $activity activity to handle
 362      * @param mixed    $target   user or group targeted
 363      *
 364      * @return boolean hook value
 365      */
 366
 367     function onStartHandleSalmonTarget(Activity $activity, $target)
 368     {
 369         if (!$this->isMyActivity($activity)) {
 370             return true;
 371         }
 372
 373         $this->log(LOG_INFO, "Checking {$activity->id} as a valid Salmon slap.");
 374
 375         if ($target instanceof User_group || $target->isGroup()) {
 376             $uri = $target->getUri();
 377             if (!array_key_exists($uri, $activity->context->attention)) {
 378                 // @todo FIXME: please document (i18n).
 379                 // TRANS: Client exception thrown when ...
 380                 throw new ClientException(_('Object not posted to this group.'));
 381             }
 382         } elseif ($target instanceof Profile && $target->isLocal()) {
 383             $original = null;
 384             // FIXME: Shouldn't favorites show up with a 'target' activityobject?
 385             if (!ActivityUtils::compareTypes($activity->verb, array(ActivityVerb::POST)) && isset($activity->objects[0])) {
 386                 // If this is not a post, it's a verb targeted at something (such as a Favorite attached to a note)
 387                 if (!empty($activity->objects[0]->id)) {
 388                     $activity->context->replyToID = $activity->objects[0]->id;
 389                 }
 390             }
 391             if (!empty($activity->context->replyToID)) {
 392                 $original = Notice::getKV('uri', $activity->context->replyToID);
 393             }
 394             if ((!$original instanceof Notice || $original->profile_id != $target->id)
 395                     && !array_key_exists($target->getUri(), $activity->context->attention)) {
 396                 // @todo FIXME: Please document (i18n).
 397                 // TRANS: Client exception when ...
 398                 throw new ClientException(_('Object not posted to this user.'));
 399             }
 400         } else {
 401             // TRANS: Server exception thrown when a micro app plugin uses a target that cannot be handled.
 402             throw new ServerException(_('Do not know how to handle this kind of target.'));
 403         }
 404
 405         $oactor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
 406         $actor = $oactor->localProfile();
 407
 408         // FIXME: will this work in all cases? I made it work for Favorite...
 409         if (ActivityUtils::compareTypes($activity->verb, array(ActivityVerb::POST))) {
 410             $object = $activity->objects[0];
 411         } else {
 412             $object = $activity;
 413         }
 414
 415         $options = array('uri' => $object->id,
 416                          'url' => $object->link,
 417                          'is_local' => Notice::REMOTE,
 418                          'source' => 'ostatus');
 419
 420         if (!isset($this->oldSaveNew)) {
 421             $notice = Notice::saveActivity($activity, $actor, $options);
 422         } else {
 423             $notice = $this->saveNoticeFromActivity($activity, $actor, $options);
 424         }
 425
 426         return false;
 427     }
 428
 429     /**
 430      * Handle object posted via AtomPub
 431      *
 432      * @param Activity &$activity Activity that was posted
 433      * @param User     $user      User that posted it
 434      * @param Notice   &$notice   Resulting notice
 435      *
 436      * @return boolean hook value
 437      */
 438     function onStartAtomPubNewActivity(Activity &$activity, $user, &$notice)
 439     {
 440         if (!$this->isMyActivity($activity)) {
 441             return true;
 442         }
 443
 444         $options = array('source' => 'atompub');
 445
 446         // $user->getProfile() is a Profile
 447         $notice = $this->saveNoticeFromActivity($activity,
 448                                                 $user->getProfile(),
 449                                                 $options);
 450
 451         return false;
 452     }
 453
 454     /**
 455      * Handle object imported from a backup file
 456      *
 457      * @param User           $user     User to import for
 458      * @param ActivityObject $author   Original author per import file
 459      * @param Activity       $activity Activity to import
 460      * @param boolean        $trusted  Is this a trusted user?
 461      * @param boolean        &$done    Is this done (success or unrecoverable error)
 462      *
 463      * @return boolean hook value
 464      */
 465     function onStartImportActivity($user, $author, Activity $activity, $trusted, &$done)
 466     {
 467         if (!$this->isMyActivity($activity)) {
 468             return true;
 469         }
 470
 471         $obj = $activity->objects[0];
 472
 473         $options = array('uri' => $object->id,
 474                          'url' => $object->link,
 475                          'source' => 'restore');
 476
 477         // $user->getProfile() is a Profile
 478         $saved = $this->saveNoticeFromActivity($activity,
 479                                                $user->getProfile(),
 480                                                $options);
 481
 482         if (!empty($saved)) {
 483             $done = true;
 484         }
 485
 486         return false;
 487     }
 488
 489     /**
 490      * Event handler gives the plugin a chance to add custom
 491      * Atom XML ActivityStreams output from a previously filled-out
 492      * ActivityObject.
 493      *
 494      * The atomOutput method is called if it's one of
 495      * our matching types.
 496      *
 497      * @param ActivityObject $obj
 498      * @param XMLOutputter $out to add elements at end of object
 499      * @return boolean hook return value
 500      */
 501     function onEndActivityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
 502     {
 503         if (in_array($obj->type, $this->types())) {
 504             $this->activityObjectOutputAtom($obj, $out);
 505         }
 506         return true;
 507     }
 508
 509     /**
 510      * Event handler gives the plugin a chance to add custom
 511      * JSON ActivityStreams output from a previously filled-out
 512      * ActivityObject.
 513      *
 514      * The activityObjectOutputJson method is called if it's one of
 515      * our matching types.
 516      *
 517      * @param ActivityObject $obj
 518      * @param array &$out JSON-targeted array which can be modified
 519      * @return boolean hook return value
 520      */
 521     function onEndActivityObjectOutputJson(ActivityObject $obj, array &$out)
 522     {
 523         if (in_array($obj->type, $this->types())) {
 524             $this->activityObjectOutputJson($obj, $out);
 525         }
 526         return true;
 527     }
 528
 529     public function onStartOpenNoticeListItemElement(NoticeListItem $nli)
 530     {
 531         if (!$this->isMyNotice($nli->notice)) {
 532             return true;
 533         }
 534
 535         $this->openNoticeListItemElement($nli);
 536
 537         Event::handle('EndOpenNoticeListItemElement', array($nli));
 538         return false;
 539     }
 540
 541     public function onStartCloseNoticeListItemElement(NoticeListItem $nli)
 542     {
 543         if (!$this->isMyNotice($nli->notice)) {
 544             return true;
 545         }
 546
 547         $this->closeNoticeListItemElement($nli);
 548
 549         Event::handle('EndCloseNoticeListItemElement', array($nli));
 550         return false;
 551     }
 552
 553     protected function openNoticeListItemElement(NoticeListItem $nli)
 554     {
 555         $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
 556         $class = 'h-entry notice ' . $this->tag();
 557         if ($nli->notice->scope != 0 && $nli->notice->scope != 1) {
 558             $class .= ' limited-scope';
 559         }
 560         $nli->out->elementStart('li', array('class' => $class,
 561                                             'id' => 'notice-' . $id));
 562     }
 563
 564     protected function closeNoticeListItemElement(NoticeListItem $nli)
 565     {
 566         $nli->out->elementEnd('li');
 567     }
 568
 569
 570     // FIXME: This is overriden in MicroAppPlugin but shouldn't have to be
 571     public function onStartShowNoticeItem(NoticeListItem $nli)
 572     {
 573         if (!$this->isMyNotice($nli->notice)) {
 574             return true;
 575         }
 576
 577         try {
 578             $this->showNoticeListItem($nli);
 579         } catch (Exception $e) {
 580             $nli->out->element('p', 'error', 'Error showing notice: '.htmlspecialchars($e->getMessage()));
 581         }
 582
 583         Event::handle('EndShowNoticeItem', array($nli));
 584         return false;
 585     }
 586
 587     protected function showNoticeListItem(NoticeListItem $nli)
 588     {
 589         $nli->showNotice();
 590         $nli->showNoticeAttachments();
 591         $nli->showNoticeInfo();
 592         $nli->showNoticeOptions();
 593
 594         $nli->showNoticeLink();
 595         $nli->showNoticeSource();
 596         $nli->showNoticeLocation();
 597         $nli->showContext();
 598         $nli->showRepeat();
 599
 600         $nli->showNoticeOptions();
 601     }
 602
 603     public function onStartShowNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
 604     {
 605         if (!$this->isMyNotice($stored)) {
 606             return true;
 607         }
 608
 609         $out->text($stored->getContent());
 610         return false;
 611     }
 612 }