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::compareVerbs($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 Notice   $stored       The notice in our database for this certain object
 164     * @param array $options=array()
 165     *
 166     * @return object    If the verb handling plugin creates an object, it can be returned here (otherwise true)
 167     * @throws exception On any error.
 168     */
 169     protected function saveObjectFromActivity(Activity $activity, Notice $stored, array $options=array())
 170     {
 171         throw new ServerException('This function should be abstract when all plugins have migrated to saveObjectFromActivity');
 172     }
 173
 174     /*
 175      * This usually gets called from Notice::saveActivity after a Notice object has been created,
 176      * so it contains a proper id and a uri for the object to be saved.
 177      */
 178     public function onStoreActivityObject(Activity $act, Notice $stored, array $options, &$object) {
 179         // $this->oldSaveNew is there during a migration period of plugins, to start using
 180         // Notice::saveActivity instead of Notice::saveNew
 181         if (!$this->isMyActivity($act) || isset($this->oldSaveNew)) {
 182             return true;
 183         }
 184         $object = $this->saveObjectFromActivity($act, $stored, $options);
 185         try {
 186             // In the future we probably want to use something like ActivityVerb_DataObject for the kind
 187             // of objects which are returned from saveObjectFromActivity.
 188             if ($object instanceof Managed_DataObject) {
 189                 // If the verb handling plugin figured out some more attention URIs, add them here to the
 190                 // original activity. This is only done if a separate object is actually needed to be saved.
 191                 $act->context->attention = array_merge($act->context->attention, $object->getAttentionArray());
 192             }
 193         } catch (Exception $e) {
 194             common_debug('WARNING: Could not get attention list from object '.get_class($object).'!');
 195         }
 196         return false;
 197     }
 198
 199     /**
 200      * Given an existing Notice object, your plugin gets to
 201      * figure out how to arrange it into an ActivityStreams
 202      * object.
 203      *
 204      * This will be how your specialized notice gets output in
 205      * Atom feeds and JSON-based ActivityStreams output, including
 206      * account backup/restore and OStatus (PuSH and Salmon transports).
 207      *
 208      * You should be able to round-trip data from this format back
 209      * through $this->saveNoticeFromActivity(). Where applicable, try
 210      * to use existing ActivityStreams structures and object types,
 211      * and consider interop with other compatible apps.
 212      *
 213      * All micro-app classes must override this method.
 214      *
 215      * @fixme this outputs an ActivityObject, not an Activity. Any compat issues?
 216      *
 217      * @param Notice $notice
 218      *
 219      * @return ActivityObject
 220      */
 221     abstract function activityObjectFromNotice(Notice $notice);
 222
 223     /**
 224      * When a notice is deleted, you'll be called here for a chance
 225      * to clean up any related resources.
 226      *
 227      * All micro-app classes must override this method.
 228      *
 229      * @param Notice $notice
 230      */
 231     abstract function deleteRelated(Notice $notice);
 232
 233     protected function notifyMentioned(Notice $stored, array &$mentioned_ids)
 234     {
 235         // pass through silently by default
 236     }
 237
 238     /**
 239      * Called when generating Atom XML ActivityStreams output from an
 240      * ActivityObject belonging to this plugin. Gives the plugin
 241      * a chance to add custom output.
 242      *
 243      * Note that you can only add output of additional XML elements,
 244      * not change existing stuff here.
 245      *
 246      * If output is already handled by the base Activity classes,
 247      * you can leave this base implementation as a no-op.
 248      *
 249      * @param ActivityObject $obj
 250      * @param XMLOutputter $out to add elements at end of object
 251      */
 252     function activityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
 253     {
 254         // default is a no-op
 255     }
 256
 257     /**
 258      * Called when generating JSON ActivityStreams output from an
 259      * ActivityObject belonging to this plugin. Gives the plugin
 260      * a chance to add custom output.
 261      *
 262      * Modify the array contents to your heart's content, and it'll
 263      * all get serialized out as JSON.
 264      *
 265      * If output is already handled by the base Activity classes,
 266      * you can leave this base implementation as a no-op.
 267      *
 268      * @param ActivityObject $obj
 269      * @param array &$out JSON-targeted array which can be modified
 270      */
 271     public function activityObjectOutputJson(ActivityObject $obj, array &$out)
 272     {
 273         // default is a no-op
 274     }
 275
 276     /**
 277      * When a notice is deleted, delete the related objects
 278      * by calling the overridable $this->deleteRelated().
 279      *
 280      * @param Notice $notice Notice being deleted
 281      *
 282      * @return boolean hook value
 283      */
 284     public function onNoticeDeleteRelated(Notice $notice)
 285     {
 286         if ($this->isMyNotice($notice)) {
 287             try {
 288                 $this->deleteRelated($notice);
 289             } catch (AlreadyFulfilledException $e) {
 290                 // Nothing to see here, it's obviously already gone...
 291             }
 292         }
 293
 294         // Always continue this event in our activity handling plugins.
 295         return true;
 296     }
 297
 298     /**
 299      * @param Notice $stored            The notice being distributed
 300      * @param array  &$mentioned_ids    List of profiles (from $stored->getReplies())
 301      */
 302     public function onStartNotifyMentioned(Notice $stored, array &$mentioned_ids)
 303     {
 304         if (!$this->isMyNotice($stored)) {
 305             return true;
 306         }
 307
 308         $this->notifyMentioned($stored, $mentioned_ids);
 309
 310         // If it was _our_ notice, only we should do anything with the mentions.
 311         return false;
 312     }
 313
 314     /**
 315      * Render a notice as one of our objects
 316      *
 317      * @param Notice         $notice  Notice to render
 318      * @param ActivityObject &$object Empty object to fill
 319      *
 320      * @return boolean hook value
 321      */
 322     function onStartActivityObjectFromNotice(Notice $notice, &$object)
 323     {
 324         if (!$this->isMyNotice($notice)) {
 325             return true;
 326         }
 327
 328         try {
 329             $object = $this->activityObjectFromNotice($notice);
 330         } catch (NoResultException $e) {
 331             $object = null; // because getKV returns null on failure
 332         }
 333         return false;
 334     }
 335
 336     /**
 337      * Handle a posted object from PuSH
 338      *
 339      * @param Activity        $activity activity to handle
 340      * @param Profile         $actor Profile for the feed
 341      *
 342      * @return boolean hook value
 343      */
 344     function onStartHandleFeedEntryWithProfile(Activity $activity, Profile $profile, &$notice)
 345     {
 346         if (!$this->isMyActivity($activity)) {
 347             return true;
 348         }
 349
 350         // We are guaranteed to get a Profile back from checkAuthorship (or it throws an exception)
 351         $profile = ActivityUtils::checkAuthorship($activity, $profile);
 352
 353         $object = $activity->objects[0];
 354
 355         $options = array('uri' => $object->id,
 356                          'url' => $object->link,
 357                          'is_local' => Notice::REMOTE,
 358                          'source' => 'ostatus');
 359
 360         if (!isset($this->oldSaveNew)) {
 361             $notice = Notice::saveActivity($activity, $profile, $options);
 362         } else {
 363             $notice = $this->saveNoticeFromActivity($activity, $profile, $options);
 364         }
 365
 366         return false;
 367     }
 368
 369     /**
 370      * Handle a posted object from Salmon
 371      *
 372      * @param Activity $activity activity to handle
 373      * @param mixed    $target   user or group targeted
 374      *
 375      * @return boolean hook value
 376      */
 377
 378     function onStartHandleSalmonTarget(Activity $activity, $target)
 379     {
 380         if (!$this->isMyActivity($activity)) {
 381             return true;
 382         }
 383
 384         $this->log(LOG_INFO, "Checking {$activity->id} as a valid Salmon slap.");
 385
 386         if ($target instanceof User_group || $target->isGroup()) {
 387             $uri = $target->getUri();
 388             if (!array_key_exists($uri, $activity->context->attention)) {
 389                 // @todo FIXME: please document (i18n).
 390                 // TRANS: Client exception thrown when ...
 391                 throw new ClientException(_('Object not posted to this group.'));
 392             }
 393         } elseif ($target instanceof Profile && $target->isLocal()) {
 394             $original = null;
 395             // FIXME: Shouldn't favorites show up with a 'target' activityobject?
 396             if (!ActivityUtils::compareVerbs($activity->verb, array(ActivityVerb::POST)) && isset($activity->objects[0])) {
 397                 // If this is not a post, it's a verb targeted at something (such as a Favorite attached to a note)
 398                 if (!empty($activity->objects[0]->id)) {
 399                     $activity->context->replyToID = $activity->objects[0]->id;
 400                 }
 401             }
 402             if (!empty($activity->context->replyToID)) {
 403                 $original = Notice::getKV('uri', $activity->context->replyToID);
 404             }
 405             if ((!$original instanceof Notice || $original->profile_id != $target->id)
 406                     && !array_key_exists($target->getUri(), $activity->context->attention)) {
 407                 // @todo FIXME: Please document (i18n).
 408                 // TRANS: Client exception when ...
 409                 throw new ClientException(_('Object not posted to this user.'));
 410             }
 411         } else {
 412             // TRANS: Server exception thrown when a micro app plugin uses a target that cannot be handled.
 413             throw new ServerException(_('Do not know how to handle this kind of target.'));
 414         }
 415
 416         $oactor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
 417         $actor = $oactor->localProfile();
 418
 419         // FIXME: will this work in all cases? I made it work for Favorite...
 420         if (ActivityUtils::compareVerbs($activity->verb, array(ActivityVerb::POST))) {
 421             $object = $activity->objects[0];
 422         } else {
 423             $object = $activity;
 424         }
 425
 426         $options = array('uri' => $object->id,
 427                          'url' => $object->link,
 428                          'is_local' => Notice::REMOTE,
 429                          'source' => 'ostatus');
 430
 431         if (!isset($this->oldSaveNew)) {
 432             $notice = Notice::saveActivity($activity, $actor, $options);
 433         } else {
 434             $notice = $this->saveNoticeFromActivity($activity, $actor, $options);
 435         }
 436
 437         return false;
 438     }
 439
 440     /**
 441      * Handle object posted via AtomPub
 442      *
 443      * @param Activity  $activity Activity that was posted
 444      * @param Profile   $scoped   Profile of user posting
 445      * @param Notice   &$notice   Resulting notice
 446      *
 447      * @return boolean hook value
 448      */
 449     public function onStartAtomPubNewActivity(Activity $activity, Profile $scoped, Notice &$notice=null)
 450     {
 451         if (!$this->isMyActivity($activity)) {
 452             return true;
 453         }
 454
 455         $options = array('source' => 'atompub');
 456
 457         $notice = $this->saveNoticeFromActivity($activity, $scoped, $options);
 458
 459         return false;
 460     }
 461
 462     /**
 463      * Handle object imported from a backup file
 464      *
 465      * @param User           $user     User to import for
 466      * @param ActivityObject $author   Original author per import file
 467      * @param Activity       $activity Activity to import
 468      * @param boolean        $trusted  Is this a trusted user?
 469      * @param boolean        &$done    Is this done (success or unrecoverable error)
 470      *
 471      * @return boolean hook value
 472      */
 473     function onStartImportActivity($user, $author, Activity $activity, $trusted, &$done)
 474     {
 475         if (!$this->isMyActivity($activity)) {
 476             return true;
 477         }
 478
 479         $obj = $activity->objects[0];
 480
 481         $options = array('uri' => $object->id,
 482                          'url' => $object->link,
 483                          'source' => 'restore');
 484
 485         // $user->getProfile() is a Profile
 486         $saved = $this->saveNoticeFromActivity($activity,
 487                                                $user->getProfile(),
 488                                                $options);
 489
 490         if (!empty($saved)) {
 491             $done = true;
 492         }
 493
 494         return false;
 495     }
 496
 497     /**
 498      * Event handler gives the plugin a chance to add custom
 499      * Atom XML ActivityStreams output from a previously filled-out
 500      * ActivityObject.
 501      *
 502      * The atomOutput method is called if it's one of
 503      * our matching types.
 504      *
 505      * @param ActivityObject $obj
 506      * @param XMLOutputter $out to add elements at end of object
 507      * @return boolean hook return value
 508      */
 509     function onEndActivityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
 510     {
 511         if (in_array($obj->type, $this->types())) {
 512             $this->activityObjectOutputAtom($obj, $out);
 513         }
 514         return true;
 515     }
 516
 517     /**
 518      * Event handler gives the plugin a chance to add custom
 519      * JSON ActivityStreams output from a previously filled-out
 520      * ActivityObject.
 521      *
 522      * The activityObjectOutputJson method is called if it's one of
 523      * our matching types.
 524      *
 525      * @param ActivityObject $obj
 526      * @param array &$out JSON-targeted array which can be modified
 527      * @return boolean hook return value
 528      */
 529     function onEndActivityObjectOutputJson(ActivityObject $obj, array &$out)
 530     {
 531         if (in_array($obj->type, $this->types())) {
 532             $this->activityObjectOutputJson($obj, $out);
 533         }
 534         return true;
 535     }
 536
 537     public function onStartOpenNoticeListItemElement(NoticeListItem $nli)
 538     {
 539         if (!$this->isMyNotice($nli->notice)) {
 540             return true;
 541         }
 542
 543         $this->openNoticeListItemElement($nli);
 544
 545         Event::handle('EndOpenNoticeListItemElement', array($nli));
 546         return false;
 547     }
 548
 549     public function onStartCloseNoticeListItemElement(NoticeListItem $nli)
 550     {
 551         if (!$this->isMyNotice($nli->notice)) {
 552             return true;
 553         }
 554
 555         $this->closeNoticeListItemElement($nli);
 556
 557         Event::handle('EndCloseNoticeListItemElement', array($nli));
 558         return false;
 559     }
 560
 561     protected function openNoticeListItemElement(NoticeListItem $nli)
 562     {
 563         $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
 564         $class = 'h-entry notice ' . $this->tag();
 565         if ($nli->notice->scope != 0 && $nli->notice->scope != 1) {
 566             $class .= ' limited-scope';
 567         }
 568         $nli->out->elementStart('li', array('class' => $class,
 569                                             'id' => 'notice-' . $id));
 570     }
 571
 572     protected function closeNoticeListItemElement(NoticeListItem $nli)
 573     {
 574         $nli->out->elementEnd('li');
 575     }
 576
 577
 578     // FIXME: This is overriden in MicroAppPlugin but shouldn't have to be
 579     public function onStartShowNoticeItem(NoticeListItem $nli)
 580     {
 581         if (!$this->isMyNotice($nli->notice)) {
 582             return true;
 583         }
 584
 585         try {
 586             $this->showNoticeListItem($nli);
 587         } catch (Exception $e) {
 588             $nli->out->element('p', 'error', 'Error showing notice: '.htmlspecialchars($e->getMessage()));
 589         }
 590
 591         Event::handle('EndShowNoticeItem', array($nli));
 592         return false;
 593     }
 594
 595     protected function showNoticeListItem(NoticeListItem $nli)
 596     {
 597         $nli->showNoticeHeaders();
 598         $nli->showContent();
 599         $nli->showNoticeFooter();
 600     }
 601
 602     public function onStartShowNoticeItemNotice(NoticeListItem $nli)
 603     {
 604         if (!$this->isMyNotice($nli->notice)) {
 605             return true;
 606         }
 607
 608         $this->showNoticeItemNotice($nli);
 609
 610         Event::handle('EndShowNoticeItemNotice', array($nli));
 611         return false;
 612     }
 613
 614     protected function showNoticeItemNotice(NoticeListItem $nli)
 615     {
 616         $nli->showNoticeTitle();
 617         $nli->showAuthor();
 618         $nli->showAddressees();
 619         $nli->showContent();
 620     }
 621
 622     public function onStartShowNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
 623     {
 624         if (!$this->isMyNotice($stored)) {
 625             return true;
 626         }
 627
 628         try {
 629             $this->showNoticeContent($stored, $out, $scoped);
 630         } catch (Exception $e) {
 631             $out->element('div', 'error', $e->getMessage());
 632         }
 633         return false;
 634     }
 635
 636     protected function showNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
 637     {
 638         $out->text($stored->getContent());
 639     }
 640 }