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      * @fixme WARNING WARNING WARNING base plugin stuff below tries to close
 151      * a div that this function opens in the BookmarkPlugin child class.
 152      * This is probably wrong.
 153      */
 154     abstract function showNotice($notice, $out);
 155
 156     /**
 157      * When building the primary notice form, we'll fetch also some
 158      * alternate forms for specialized types -- that's you!
 159      *
 160      * Return a custom Widget or Form object for the given output
 161      * object, and it'll be included in the HTML output. Beware that
 162      * your form may be initially hidden.
 163      *
 164      * All micro-app classes must override this method.
 165      *
 166      * @param HTMLOutputter $out
 167      * @return Widget
 168      */
 169     abstract function entryForm($out);
 170
 171     /**
 172      * When a notice is deleted, you'll be called here for a chance
 173      * to clean up any related resources.
 174      *
 175      * All micro-app classes must override this method.
 176      *
 177      * @param Notice $notice
 178      */
 179     abstract function deleteRelated($notice);
 180
 181     /**
 182      * Check if a given notice object should be handled by this micro-app
 183      * plugin.
 184      *
 185      * The default implementation checks against the activity type list
 186      * returned by $this->types(). You can override this method to expand
 187      * your checks.
 188      *
 189      * @param Notice $notice
 190      * @return boolean
 191      */
 192     function isMyNotice($notice) {
 193         $types = $this->types();
 194         return in_array($notice->object_type, $types);
 195     }
 196
 197     /**
 198      * Check if a given ActivityStreams activity should be handled by this
 199      * micro-app plugin.
 200      *
 201      * The default implementation checks against the activity type list
 202      * returned by $this->types(), and requires that exactly one matching
 203      * object be present. You can override this method to expand
 204      * your checks or to compare the activity's verb, etc.
 205      *
 206      * @param Activity $activity
 207      * @return boolean
 208      */
 209     function isMyActivity($activity) {
 210         $types = $this->types();
 211         return (count($activity->objects) == 1 &&
 212                 in_array($activity->objects[0]->type, $types));
 213     }
 214
 215     /**
 216      * When a notice is deleted, delete the related objects
 217      * by calling the overridable $this->deleteRelated().
 218      *
 219      * @param Notice $notice Notice being deleted
 220      *
 221      * @return boolean hook value
 222      */
 223
 224     function onNoticeDeleteRelated($notice)
 225     {
 226         if ($this->isMyNotice($notice)) {
 227             $this->deleteRelated($notice);
 228         }
 229
 230         return true;
 231     }
 232
 233     /**
 234      * Output the HTML for this kind of object in a list
 235      *
 236      * @param NoticeListItem $nli The list item being shown.
 237      *
 238      * @return boolean hook value
 239      *
 240      * @fixme WARNING WARNING WARNING this closes a 'div' that is implicitly opened in BookmarkPlugin's showNotice implementation
 241      */
 242
 243     function onStartShowNoticeItem($nli)
 244     {
 245         if (!$this->isMyNotice($nli->notice)) {
 246             return true;
 247         }
 248
 249         $out = $nli->out;
 250         $notice = $nli->notice;
 251
 252         $this->showNotice($notice, $out);
 253
 254         $nli->showNoticeLink();
 255         $nli->showNoticeSource();
 256         $nli->showNoticeLocation();
 257         $nli->showContext();
 258         $nli->showRepeat();
 259
 260         $out->elementEnd('div');
 261
 262         $nli->showNoticeOptions();
 263
 264         return false;
 265     }
 266
 267     /**
 268      * Render a notice as one of our objects
 269      *
 270      * @param Notice         $notice  Notice to render
 271      * @param ActivityObject &$object Empty object to fill
 272      *
 273      * @return boolean hook value
 274      */
 275
 276     function onStartActivityObjectFromNotice($notice, &$object)
 277     {
 278         if ($this->isMyNotice($notice)) {
 279             $object = $this->activityObjectFromNotice($notice);
 280             return false;
 281         }
 282
 283         return true;
 284     }
 285
 286     /**
 287      * Handle a posted object from PuSH
 288      *
 289      * @param Activity        $activity activity to handle
 290      * @param Ostatus_profile $oprofile Profile for the feed
 291      *
 292      * @return boolean hook value
 293      */
 294
 295     function onStartHandleFeedEntryWithProfile($activity, $oprofile)
 296     {
 297         if ($this->isMyActivity($activity)) {
 298
 299             $actor = $oprofile->checkAuthorship($activity);
 300
 301             if (empty($actor)) {
 302                 throw new ClientException(_('Can\'t get author for activity.'));
 303             }
 304
 305             $object = $activity->objects[0];
 306
 307             $options = array('uri' => $object->id,
 308                              'url' => $object->link,
 309                              'is_local' => Notice::REMOTE_OMB,
 310                              'source' => 'ostatus');
 311
 312             // $actor is an ostatus_profile
 313             $this->saveNoticeFromActivity($activity, $actor->localProfile(), $options);
 314
 315             return false;
 316         }
 317
 318         return true;
 319     }
 320
 321     /**
 322      * Handle a posted object from Salmon
 323      *
 324      * @param Activity $activity activity to handle
 325      * @param mixed    $target   user or group targeted
 326      *
 327      * @return boolean hook value
 328      */
 329
 330     function onStartHandleSalmonTarget($activity, $target)
 331     {
 332         if ($this->isMyActivity($activity)) {
 333
 334             $this->log(LOG_INFO, "Checking {$activity->id} as a valid Salmon slap.");
 335
 336             if ($target instanceof User_group) {
 337                 $uri = $target->getUri();
 338                 if (!in_array($uri, $activity->context->attention)) {
 339                     throw new ClientException(_("Bookmark not posted ".
 340                                                 "to this group."));
 341                 }
 342             } else if ($target instanceof User) {
 343                 $uri      = $target->uri;
 344                 $original = null;
 345                 if (!empty($activity->context->replyToID)) {
 346                     $original = Notice::staticGet('uri',
 347                                                   $activity->context->replyToID);
 348                 }
 349                 if (!in_array($uri, $activity->context->attention) &&
 350                     (empty($original) ||
 351                      $original->profile_id != $target->id)) {
 352                     throw new ClientException(_("Object not posted ".
 353                                                 "to this user."));
 354                 }
 355             } else {
 356                 throw new ServerException(_("Don't know how to handle ".
 357                                             "this kind of target."));
 358             }
 359
 360             $actor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
 361
 362             $object = $activity->objects[0];
 363
 364             $options = array('uri' => $object->id,
 365                              'url' => $object->link,
 366                              'is_local' => Notice::REMOTE_OMB,
 367                              'source' => 'ostatus');
 368
 369             // $actor is an ostatus_profile
 370             $this->saveNoticeFromActivity($activity, $actor->localProfile(), $options);
 371
 372             return false;
 373         }
 374
 375         return true;
 376     }
 377
 378     /**
 379      * Handle object posted via AtomPub
 380      *
 381      * @param Activity &$activity Activity that was posted
 382      * @param User     $user      User that posted it
 383      * @param Notice   &$notice   Resulting notice
 384      *
 385      * @return boolean hook value
 386      */
 387
 388     function onStartAtomPubNewActivity(&$activity, $user, &$notice)
 389     {
 390         if ($this->isMyActivity($activity)) {
 391
 392             $options = array('source' => 'atompub');
 393
 394             // $user->getProfile() is a Profile
 395             $this->saveNoticeFromActivity($activity,
 396                                           $user->getProfile(),
 397                                           $options);
 398
 399             return false;
 400         }
 401
 402         return true;
 403     }
 404
 405     /**
 406      * Handle object imported from a backup file
 407      *
 408      * @param User           $user     User to import for
 409      * @param ActivityObject $author   Original author per import file
 410      * @param Activity       $activity Activity to import
 411      * @param boolean        $trusted  Is this a trusted user?
 412      * @param boolean        &$done    Is this done (success or unrecoverable error)
 413      *
 414      * @return boolean hook value
 415      */
 416
 417     function onStartImportActivity($user, $author, $activity, $trusted, &$done)
 418     {
 419         if ($this->isMyActivity($activity)) {
 420
 421             $obj = $activity->objects[0];
 422
 423             $options = array('uri' => $object->id,
 424                              'url' => $object->link,
 425                              'source' => 'restore');
 426
 427             // $user->getProfile() is a Profile
 428             $saved = $this->saveNoticeFromActivity($activity,
 429                                                    $user->getProfile(),
 430                                                    $options);
 431
 432             if (!empty($saved)) {
 433                 $done = true;
 434             }
 435
 436             return false;
 437         }
 438
 439         return true;
 440     }
 441
 442     function onStartShowEntryForms(&$tabs)
 443     {
 444         $tabs[$this->tag()] = $this->appTitle();
 445         return true;
 446     }
 447
 448     function onStartMakeEntryForm($tag, $out, &$form)
 449     {
 450         $this->log(LOG_INFO, "onStartMakeEntryForm() called for tag '$tag'");
 451
 452         if ($tag == $this->tag()) {
 453             $form = $this->entryForm($out);
 454             return false;
 455         }
 456
 457         return true;
 458     }
 459 }