lib/microappplugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Superclass for microapp plugin
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Microapp
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Superclass for microapp plugins
  39  *
  40  * This class lets you define micro-applications with different kinds of activities.
  41  *
  42  * The applications work more-or-less like other
  43  *
  44  * @category  Microapp
  45  * @package   StatusNet
  46  * @author    Evan Prodromou <evan@status.net>
  47  * @copyright 2011 StatusNet, Inc.
  48  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  49  * @link      http://status.net/
  50  */
  51 abstract class MicroAppPlugin extends Plugin
  52 {
  53     /**
  54      * Returns a localized string which represents this micro-app,
  55      * to be shown to users selecting what type of post to make.
  56      * This is paired with the key string in $this->tag().
  57      *
  58      * All micro-app classes must override this method.
  59      *
  60      * @return string
  61      */
  62     abstract function appTitle();
  63
  64     /**
  65      * Returns a key string which represents this micro-app in HTML
  66      * ids etc, as when offering selection of what type of post to make.
  67      * This is paired with the user-visible localizable $this->appTitle().
  68      *
  69      * All micro-app classes must override this method.
  70      */
  71     abstract function tag();
  72
  73     /**
  74      * Return a list of ActivityStreams object type URIs
  75      * which this micro-app handles. Default implementations
  76      * of the base class will use this list to check if a
  77      * given ActivityStreams object belongs to us, via
  78      * $this->isMyNotice() or $this->isMyActivity.
  79      *
  80      * All micro-app classes must override this method.
  81      *
  82      * @fixme can we confirm that these types are the same
  83      * for Atom and JSON streams? Any limitations or issues?
  84      *
  85      * @return array of strings
  86      */
  87     abstract function types();
  88
  89     /**
  90      * Given a parsed ActivityStreams activity, your plugin
  91      * gets to figure out how to actually save it into a notice
  92      * and any additional data structures you require.
  93      *
  94      * This will handle things received via AtomPub, OStatus
  95      * (PuSH and Salmon transports), or ActivityStreams-based
  96      * backup/restore of account data.
  97      *
  98      * You should be able to accept as input the output from your
  99      * $this->activityObjectFromNotice(). Where applicable, try to
 100      * use existing ActivityStreams structures and object types,
 101      * and be liberal in accepting input from what might be other
 102      * compatible apps.
 103      *
 104      * All micro-app classes must override this method.
 105      *
 106      * @fixme are there any standard options?
 107      *
 108      * @param Activity $activity
 109      * @param Profile $actor
 110      * @param array $options=array()
 111      *
 112      * @return Notice the resulting notice
 113      */
 114     abstract function saveNoticeFromActivity($activity, $actor, $options=array());
 115
 116     /**
 117      * Given an existing Notice object, your plugin gets to
 118      * figure out how to arrange it into an ActivityStreams
 119      * object.
 120      *
 121      * This will be how your specialized notice gets output in
 122      * Atom feeds and JSON-based ActivityStreams output, including
 123      * account backup/restore and OStatus (PuSH and Salmon transports).
 124      *
 125      * You should be able to round-trip data from this format back
 126      * through $this->saveNoticeFromActivity(). Where applicable, try
 127      * to use existing ActivityStreams structures and object types,
 128      * and consider interop with other compatible apps.
 129      *
 130      * All micro-app classes must override this method.
 131      *
 132      * @fixme this outputs an ActivityObject, not an Activity. Any compat issues?
 133      *
 134      * @param Notice $notice
 135      *
 136      * @return ActivityObject
 137      */
 138     abstract function activityObjectFromNotice($notice);
 139
 140     /**
 141      * Custom HTML output for your special notice; called when a
 142      * matching notice turns up in a NoticeListItem.
 143      *
 144      * All micro-app classes must override this method.
 145      *
 146      * @param Notice $notice
 147      * @param HTMLOutputter $out
 148      *
 149      * @fixme WARNING WARNING WARNING base plugin stuff below tries to close
 150      * a div that this function opens in the BookmarkPlugin child class.
 151      * This is probably wrong.
 152      */
 153     abstract function showNotice($notice, $out);
 154
 155     /**
 156      * When building the primary notice form, we'll fetch also some
 157      * alternate forms for specialized types -- that's you!
 158      *
 159      * Return a custom Widget or Form object for the given output
 160      * object, and it'll be included in the HTML output. Beware that
 161      * your form may be initially hidden.
 162      *
 163      * All micro-app classes must override this method.
 164      *
 165      * @param HTMLOutputter $out
 166      * @return Widget
 167      */
 168     abstract function entryForm($out);
 169
 170     /**
 171      * When a notice is deleted, you'll be called here for a chance
 172      * to clean up any related resources.
 173      *
 174      * All micro-app classes must override this method.
 175      *
 176      * @param Notice $notice
 177      */
 178     abstract function deleteRelated($notice);
 179
 180     /**
 181      * Check if a given notice object should be handled by this micro-app
 182      * plugin.
 183      *
 184      * The default implementation checks against the activity type list
 185      * returned by $this->types(). You can override this method to expand
 186      * your checks.
 187      *
 188      * @param Notice $notice
 189      * @return boolean
 190      */
 191     function isMyNotice($notice) {
 192         $types = $this->types();
 193         return in_array($notice->object_type, $types);
 194     }
 195
 196     /**
 197      * Check if a given ActivityStreams activity should be handled by this
 198      * micro-app plugin.
 199      *
 200      * The default implementation checks against the activity type list
 201      * returned by $this->types(), and requires that exactly one matching
 202      * object be present. You can override this method to expand
 203      * your checks or to compare the activity's verb, etc.
 204      *
 205      * @param Activity $activity
 206      * @return boolean
 207      */
 208     function isMyActivity($activity) {
 209         $types = $this->types();
 210         return (count($activity->objects) == 1 &&
 211                 in_array($activity->objects[0]->type, $types));
 212     }
 213
 214     /**
 215      * Called when generating Atom XML ActivityStreams output from an
 216      * ActivityObject belonging to this plugin. Gives the plugin
 217      * a chance to add custom output.
 218      *
 219      * Note that you can only add output of additional XML elements,
 220      * not change existing stuff here.
 221      *
 222      * If output is already handled by the base Activity classes,
 223      * you can leave this base implementation as a no-op.
 224      *
 225      * @param ActivityObject $obj
 226      * @param XMLOutputter $out to add elements at end of object
 227      */
 228     function activityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
 229     {
 230         // default is a no-op
 231     }
 232
 233     /**
 234      * Called when generating JSON ActivityStreams output from an
 235      * ActivityObject belonging to this plugin. Gives the plugin
 236      * a chance to add custom output.
 237      *
 238      * Modify the array contents to your heart's content, and it'll
 239      * all get serialized out as JSON.
 240      *
 241      * If output is already handled by the base Activity classes,
 242      * you can leave this base implementation as a no-op.
 243      *
 244      * @param ActivityObject $obj
 245      * @param array &$out JSON-targeted array which can be modified
 246      */
 247     public function activityObjectOutputJson(ActivityObject $obj, array &$out)
 248     {
 249         // default is a no-op
 250     }
 251
 252     /**
 253      * When a notice is deleted, delete the related objects
 254      * by calling the overridable $this->deleteRelated().
 255      *
 256      * @param Notice $notice Notice being deleted
 257      *
 258      * @return boolean hook value
 259      */
 260     function onNoticeDeleteRelated($notice)
 261     {
 262         if ($this->isMyNotice($notice)) {
 263             $this->deleteRelated($notice);
 264         }
 265
 266         return true;
 267     }
 268
 269     /**
 270      * Output the HTML for this kind of object in a list
 271      *
 272      * @param NoticeListItem $nli The list item being shown.
 273      *
 274      * @return boolean hook value
 275      *
 276      * @fixme WARNING WARNING WARNING this closes a 'div' that is implicitly opened in BookmarkPlugin's showNotice implementation
 277      */
 278     function onStartShowNoticeItem($nli)
 279     {
 280         if (!$this->isMyNotice($nli->notice)) {
 281             return true;
 282         }
 283
 284         $out = $nli->out;
 285         $notice = $nli->notice;
 286
 287         try {
 288             $this->showNotice($notice, $out);
 289         } catch (Exception $e) {
 290             common_log(LOG_ERR, $e->getMessage());
 291             // try to fall back
 292             $out->elementStart('div');
 293             $nli->showAuthor();
 294             $nli->showContent();
 295         }
 296
 297         $nli->showNoticeLink();
 298         $nli->showNoticeSource();
 299         $nli->showNoticeLocation();
 300         $nli->showContext();
 301         $nli->showRepeat();
 302
 303         $out->elementEnd('div');
 304
 305         $nli->showNoticeOptions();
 306
 307         return false;
 308     }
 309
 310     /**
 311      * Render a notice as one of our objects
 312      *
 313      * @param Notice         $notice  Notice to render
 314      * @param ActivityObject &$object Empty object to fill
 315      *
 316      * @return boolean hook value
 317      */
 318     function onStartActivityObjectFromNotice($notice, &$object)
 319     {
 320         if ($this->isMyNotice($notice)) {
 321             $object = $this->activityObjectFromNotice($notice);
 322             return false;
 323         }
 324
 325         return true;
 326     }
 327
 328     /**
 329      * Handle a posted object from PuSH
 330      *
 331      * @param Activity        $activity activity to handle
 332      * @param Ostatus_profile $oprofile Profile for the feed
 333      *
 334      * @return boolean hook value
 335      */
 336     function onStartHandleFeedEntryWithProfile($activity, $oprofile)
 337     {
 338         if ($this->isMyActivity($activity)) {
 339
 340             $actor = $oprofile->checkAuthorship($activity);
 341
 342             if (empty($actor)) {
 343                 // TRANS: Client exception thrown when no author for an activity was found.
 344                 throw new ClientException(_('Cannot get author for activity.'));
 345             }
 346
 347             $object = $activity->objects[0];
 348
 349             $options = array('uri' => $object->id,
 350                              'url' => $object->link,
 351                              'is_local' => Notice::REMOTE_OMB,
 352                              'source' => 'ostatus');
 353
 354             // $actor is an ostatus_profile
 355             $this->saveNoticeFromActivity($activity, $actor->localProfile(), $options);
 356
 357             return false;
 358         }
 359
 360         return true;
 361     }
 362
 363     /**
 364      * Handle a posted object from Salmon
 365      *
 366      * @param Activity $activity activity to handle
 367      * @param mixed    $target   user or group targeted
 368      *
 369      * @return boolean hook value
 370      */
 371
 372     function onStartHandleSalmonTarget($activity, $target)
 373     {
 374         if ($this->isMyActivity($activity)) {
 375             $this->log(LOG_INFO, "Checking {$activity->id} as a valid Salmon slap.");
 376
 377             if ($target instanceof User_group) {
 378                 $uri = $target->getUri();
 379                 if (!in_array($uri, $activity->context->attention)) {
 380                     // @todo FIXME: please document (i18n).
 381                     // TRANS: Client exception.
 382                     throw new ClientException(_('Bookmark not posted to this group.'));
 383                 }
 384             } else if ($target instanceof User) {
 385                 $uri      = $target->uri;
 386                 $original = null;
 387                 if (!empty($activity->context->replyToID)) {
 388                     $original = Notice::staticGet('uri',
 389                                                   $activity->context->replyToID);
 390                 }
 391                 if (!in_array($uri, $activity->context->attention) &&
 392                     (empty($original) ||
 393                      $original->profile_id != $target->id)) {
 394                     // @todo FIXME: Please document (i18n).
 395                     // TRANS: Client exception.
 396                     throw new ClientException(_('Object not posted to this user.'));
 397                 }
 398             } else {
 399                 // TRANS: Server exception thrown when a micro app plugin uses a target that cannot be handled.
 400                 throw new ServerException(_('Do not know how to handle this kind of target.'));
 401             }
 402
 403             $actor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
 404
 405             $object = $activity->objects[0];
 406
 407             $options = array('uri' => $object->id,
 408                              'url' => $object->link,
 409                              'is_local' => Notice::REMOTE_OMB,
 410                              'source' => 'ostatus');
 411
 412             // $actor is an ostatus_profile
 413             $this->saveNoticeFromActivity($activity, $actor->localProfile(), $options);
 414
 415             return false;
 416         }
 417
 418         return true;
 419     }
 420
 421     /**
 422      * Handle object posted via AtomPub
 423      *
 424      * @param Activity &$activity Activity that was posted
 425      * @param User     $user      User that posted it
 426      * @param Notice   &$notice   Resulting notice
 427      *
 428      * @return boolean hook value
 429      */
 430     function onStartAtomPubNewActivity(&$activity, $user, &$notice)
 431     {
 432         if ($this->isMyActivity($activity)) {
 433
 434             $options = array('source' => 'atompub');
 435
 436             // $user->getProfile() is a Profile
 437             $this->saveNoticeFromActivity($activity,
 438                                           $user->getProfile(),
 439                                           $options);
 440
 441             return false;
 442         }
 443
 444         return true;
 445     }
 446
 447     /**
 448      * Handle object imported from a backup file
 449      *
 450      * @param User           $user     User to import for
 451      * @param ActivityObject $author   Original author per import file
 452      * @param Activity       $activity Activity to import
 453      * @param boolean        $trusted  Is this a trusted user?
 454      * @param boolean        &$done    Is this done (success or unrecoverable error)
 455      *
 456      * @return boolean hook value
 457      */
 458     function onStartImportActivity($user, $author, $activity, $trusted, &$done)
 459     {
 460         if ($this->isMyActivity($activity)) {
 461
 462             $obj = $activity->objects[0];
 463
 464             $options = array('uri' => $object->id,
 465                              'url' => $object->link,
 466                              'source' => 'restore');
 467
 468             // $user->getProfile() is a Profile
 469             $saved = $this->saveNoticeFromActivity($activity,
 470                                                    $user->getProfile(),
 471                                                    $options);
 472
 473             if (!empty($saved)) {
 474                 $done = true;
 475             }
 476
 477             return false;
 478         }
 479
 480         return true;
 481     }
 482
 483     /**
 484      * Event handler gives the plugin a chance to add custom
 485      * Atom XML ActivityStreams output from a previously filled-out
 486      * ActivityObject.
 487      *
 488      * The atomOutput method is called if it's one of
 489      * our matching types.
 490      *
 491      * @param ActivityObject $obj
 492      * @param XMLOutputter $out to add elements at end of object
 493      * @return boolean hook return value
 494      */
 495     function onEndActivityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
 496     {
 497         if (in_array($obj->type, $this->types())) {
 498             $this->activityObjectOutputAtom($obj, $out);
 499         }
 500         return true;
 501     }
 502
 503     /**
 504      * Event handler gives the plugin a chance to add custom
 505      * JSON ActivityStreams output from a previously filled-out
 506      * ActivityObject.
 507      *
 508      * The activityObjectOutputJson method is called if it's one of
 509      * our matching types.
 510      *
 511      * @param ActivityObject $obj
 512      * @param array &$out JSON-targeted array which can be modified
 513      * @return boolean hook return value
 514      */
 515     function onEndActivityObjectOutputJson(ActivityObject $obj, array &$out)
 516     {
 517         if (in_array($obj->type, $this->types())) {
 518             $this->activityObjectOutputJson($obj, $out);
 519         }
 520         return true;
 521     }
 522
 523     function onStartShowEntryForms(&$tabs)
 524     {
 525         $tabs[$this->tag()] = $this->appTitle();
 526         return true;
 527     }
 528
 529     function onStartMakeEntryForm($tag, $out, &$form)
 530     {
 531         if ($tag == $this->tag()) {
 532             $form = $this->entryForm($out);
 533             return false;
 534         }
 535
 536         return true;
 537     }
 538 }