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
  52 abstract class MicroAppPlugin extends Plugin
  53 {
  54     /**
  55      * Returns a localized string which represents this micro-app,
  56      * to be shown to users selecting what type of post to make.
  57      * This is paired with the key string in $this->tag().
  58      *
  59      * All micro-app classes must override this method.
  60      *
  61      * @return string
  62      */
  63     abstract function appTitle();
  64
  65     /**
  66      * Returns a key string which represents this micro-app in HTML
  67      * ids etc, as when offering selection of what type of post to make.
  68      * This is paired with the user-visible localizable $this->appTitle().
  69      *
  70      * All micro-app classes must override this method.
  71      */
  72     abstract function tag();
  73
  74     /**
  75      * Return a list of ActivityStreams object type URIs
  76      * which this micro-app handles. Default implementations
  77      * of the base class will use this list to check if a
  78      * given ActivityStreams object belongs to us, via
  79      * $this->isMyNotice() or $this->isMyActivity.
  80      *
  81      * All micro-app classes must override this method.
  82      *
  83      * @fixme can we confirm that these types are the same
  84      * for Atom and JSON streams? Any limitations or issues?
  85      *
  86      * @return array of strings
  87      */
  88     abstract function types();
  89
  90     /**
  91      * Given a parsed ActivityStreams activity, your plugin
  92      * gets to figure out how to actually save it into a notice
  93      * and any additional data structures you require.
  94      *
  95      * This will handle things received via AtomPub, OStatus
  96      * (PuSH and Salmon transports), or ActivityStreams-based
  97      * backup/restore of account data.
  98      *
  99      * You should be able to accept as input the output from your
 100      * $this->activityObjectFromNotice(). Where applicable, try to
 101      * use existing ActivityStreams structures and object types,
 102      * and be liberal in accepting input from what might be other
 103      * compatible apps.
 104      *
 105      * All micro-app classes must override this method.
 106      *
 107      * @fixme are there any standard options?
 108      *
 109      * @param Activity $activity
 110      * @param Profile $actor
 111      * @param array $options=array()
 112      *
 113      * @return Notice the resulting notice
 114      */
 115     abstract function saveNoticeFromActivity($activity, $actor, $options=array());
 116
 117     /**
 118      * Given an existing Notice object, your plugin gets to
 119      * figure out how to arrange it into an ActivityStreams
 120      * object.
 121      *
 122      * This will be how your specialized notice gets output in
 123      * Atom feeds and JSON-based ActivityStreams output, including
 124      * account backup/restore and OStatus (PuSH and Salmon transports).
 125      *
 126      * You should be able to round-trip data from this format back
 127      * through $this->saveNoticeFromActivity(). Where applicable, try
 128      * to use existing ActivityStreams structures and object types,
 129      * and consider interop with other compatible apps.
 130      *
 131      * All micro-app classes must override this method.
 132      *
 133      * @fixme this outputs an ActivityObject, not an Activity. Any compat issues?
 134      *
 135      * @param Notice $notice
 136      *
 137      * @return ActivityObject
 138      */
 139     abstract function activityObjectFromNotice($notice);
 140
 141     /**
 142      * Custom HTML output for your special notice; called when a
 143      * matching notice turns up in a NoticeListItem.
 144      *
 145      * All micro-app classes must override this method.
 146      *
 147      * @param Notice $notice
 148      * @param HTMLOutputter $out
 149      */
 150     abstract function showNotice($notice, $out);
 151
 152     /**
 153      * When building the primary notice form, we'll fetch also some
 154      * alternate forms for specialized types -- that's you!
 155      *
 156      * Return a custom Widget or Form object for the given output
 157      * object, and it'll be included in the HTML output. Beware that
 158      * your form may be initially hidden.
 159      *
 160      * All micro-app classes must override this method.
 161      *
 162      * @param HTMLOutputter $out
 163      * @return Widget
 164      */
 165     abstract function entryForm($out);
 166
 167     /**
 168      * When a notice is deleted, you'll be called here for a chance
 169      * to clean up any related resources.
 170      *
 171      * All micro-app classes must override this method.
 172      *
 173      * @param Notice $notice
 174      */
 175     abstract function deleteRelated($notice);
 176
 177     /**
 178      * Check if a given notice object should be handled by this micro-app
 179      * plugin.
 180      *
 181      * The default implementation checks against the activity type list
 182      * returned by $this->types(). You can override this method to expand
 183      * your checks.
 184      *
 185      * @param Notice $notice
 186      * @return boolean
 187      */
 188     function isMyNotice($notice) {
 189         $types = $this->types();
 190         return in_array($notice->object_type, $types);
 191     }
 192
 193     /**
 194      * Check if a given ActivityStreams activity should be handled by this
 195      * micro-app plugin.
 196      *
 197      * The default implementation checks against the activity type list
 198      * returned by $this->types(), and requires that exactly one matching
 199      * object be present. You can override this method to expand
 200      * your checks or to compare the activity's verb, etc.
 201      *
 202      * @param Activity $activity
 203      * @return boolean
 204      */
 205     function isMyActivity($activity) {
 206         $types = $this->types();
 207         return (count($activity->objects) == 1 &&
 208                 in_array($activity->objects[0]->type, $types));
 209     }
 210
 211     /**
 212      * When a notice is deleted, delete the related objects
 213      * by calling the overridable $this->deleteRelated().
 214      *
 215      * @param Notice $notice Notice being deleted
 216      *
 217      * @return boolean hook value
 218      */
 219
 220     function onNoticeDeleteRelated($notice)
 221     {
 222         if ($this->isMyNotice($notice)) {
 223             $this->deleteRelated($notice);
 224         }
 225
 226         return true;
 227     }
 228
 229     /**
 230      * Output the HTML for this kind of object in a list
 231      *
 232      * @param NoticeListItem $nli The list item being shown.
 233      *
 234      * @return boolean hook value
 235      */
 236
 237     function onStartShowNoticeItem($nli)
 238     {
 239         if (!$this->isMyNotice($nli->notice)) {
 240             return true;
 241         }
 242
 243         $out = $nli->out;
 244         $notice = $nli->notice;
 245
 246         $this->showNotice($notice, $out);
 247
 248         $nli->showNoticeLink();
 249         $nli->showNoticeSource();
 250         $nli->showNoticeLocation();
 251         $nli->showContext();
 252         $nli->showRepeat();
 253
 254         $out->elementEnd('div');
 255
 256         $nli->showNoticeOptions();
 257
 258         return false;
 259     }
 260
 261     /**
 262      * Render a notice as one of our objects
 263      *
 264      * @param Notice         $notice  Notice to render
 265      * @param ActivityObject &$object Empty object to fill
 266      *
 267      * @return boolean hook value
 268      */
 269
 270     function onStartActivityObjectFromNotice($notice, &$object)
 271     {
 272         if ($this->isMyNotice($notice)) {
 273             $object = $this->activityObjectFromNotice($notice);
 274             return false;
 275         }
 276
 277         return true;
 278     }
 279
 280     /**
 281      * Handle a posted object from PuSH
 282      *
 283      * @param Activity        $activity activity to handle
 284      * @param Ostatus_profile $oprofile Profile for the feed
 285      *
 286      * @return boolean hook value
 287      */
 288
 289     function onStartHandleFeedEntryWithProfile($activity, $oprofile)
 290     {
 291         if ($this->isMyActivity($activity)) {
 292
 293             $actor = $oprofile->checkAuthorship($activity);
 294
 295             if (empty($actor)) {
 296                 throw new ClientException(_('Can\'t get author for activity.'));
 297             }
 298
 299             $object = $activity->objects[0];
 300
 301             $options = array('uri' => $object->id,
 302                              'url' => $object->link,
 303                              'is_local' => Notice::REMOTE_OMB,
 304                              'source' => 'ostatus');
 305
 306             $this->saveNoticeFromActivity($activity, $actor);
 307
 308             return false;
 309         }
 310
 311         return true;
 312     }
 313
 314     /**
 315      * Handle a posted object from Salmon
 316      *
 317      * @param Activity $activity activity to handle
 318      * @param mixed    $target   user or group targeted
 319      *
 320      * @return boolean hook value
 321      */
 322
 323     function onStartHandleSalmonTarget($activity, $target)
 324     {
 325         if ($this->isMyActivity($activity)) {
 326
 327             $this->log(LOG_INFO, "Checking {$activity->id} as a valid Salmon slap.");
 328
 329             if ($target instanceof User_group) {
 330                 $uri = $target->getUri();
 331                 if (!in_array($uri, $activity->context->attention)) {
 332                     throw new ClientException(_("Bookmark not posted ".
 333                                                 "to this group."));
 334                 }
 335             } else if ($target instanceof User) {
 336                 $uri      = $target->uri;
 337                 $original = null;
 338                 if (!empty($activity->context->replyToID)) {
 339                     $original = Notice::staticGet('uri',
 340                                                   $activity->context->replyToID);
 341                 }
 342                 if (!in_array($uri, $activity->context->attention) &&
 343                     (empty($original) ||
 344                      $original->profile_id != $target->id)) {
 345                     throw new ClientException(_("Object not posted ".
 346                                                 "to this user."));
 347                 }
 348             } else {
 349                 throw new ServerException(_("Don't know how to handle ".
 350                                             "this kind of target."));
 351             }
 352
 353             $actor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
 354
 355             $object = $activity->objects[0];
 356
 357             $options = array('uri' => $object->id,
 358                              'url' => $object->link,
 359                              'is_local' => Notice::REMOTE_OMB,
 360                              'source' => 'ostatus');
 361
 362             $this->saveNoticeFromActivity($activity, $actor, $options);
 363
 364             return false;
 365         }
 366
 367         return true;
 368     }
 369
 370     /**
 371      * Handle object posted via AtomPub
 372      *
 373      * @param Activity &$activity Activity that was posted
 374      * @param User     $user      User that posted it
 375      * @param Notice   &$notice   Resulting notice
 376      *
 377      * @return boolean hook value
 378      */
 379
 380     function onStartAtomPubNewActivity(&$activity, $user, &$notice)
 381     {
 382         if ($this->isMyActivity($activity)) {
 383
 384             $options = array('source' => 'atompub');
 385
 386             $this->saveNoticeFromActivity($activity,
 387                                           $user->getProfile(),
 388                                           $options);
 389
 390             return false;
 391         }
 392
 393         return true;
 394     }
 395
 396     /**
 397      * Handle object imported from a backup file
 398      *
 399      * @param User           $user     User to import for
 400      * @param ActivityObject $author   Original author per import file
 401      * @param Activity       $activity Activity to import
 402      * @param boolean        $trusted  Is this a trusted user?
 403      * @param boolean        &$done    Is this done (success or unrecoverable error)
 404      *
 405      * @return boolean hook value
 406      */
 407
 408     function onStartImportActivity($user, $author, $activity, $trusted, &$done)
 409     {
 410         if ($this->isMyActivity($activity)) {
 411
 412             $obj = $activity->objects[0];
 413
 414             $options = array('uri' => $object->id,
 415                              'url' => $object->link,
 416                              'source' => 'restore');
 417
 418             $saved = $this->saveNoticeFromActivity($activity,
 419                                                    $user->getProfile(),
 420                                                    $options);
 421
 422             if (!empty($saved)) {
 423                 $done = true;
 424             }
 425
 426             return false;
 427         }
 428
 429         return true;
 430     }
 431
 432     function onStartShowEntryForms(&$tabs)
 433     {
 434         $tabs[$this->tag()] = $this->appTitle();
 435         return true;
 436     }
 437
 438     function onStartMakeEntryForm($tag, $out, &$form)
 439     {
 440         $this->log(LOG_INFO, "onStartMakeEntryForm() called for tag '$tag'");
 441
 442         if ($tag == $this->tag()) {
 443             $form = $this->entryForm($out);
 444             return false;
 445         }
 446
 447         return true;
 448     }
 449 }