3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2011, StatusNet, Inc.
6 * Superclass for microapp plugin
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.
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.
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/>.
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/
31 if (!defined('STATUSNET')) {
32 // This check helps protect against security problems;
33 // your code file can't be executed directly from the web.
38 * Superclass for microapp plugins
40 * This class lets you define micro-applications with different kinds of activities.
42 * The applications work more-or-less like other
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/
51 abstract class MicroAppPlugin extends Plugin
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().
58 * All micro-app classes must override this method.
62 abstract function appTitle();
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().
69 * All micro-app classes must override this method.
71 abstract function tag();
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.
80 * All micro-app classes must override this method.
82 * @fixme can we confirm that these types are the same
83 * for Atom and JSON streams? Any limitations or issues?
85 * @return array of strings
87 abstract function types();
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.
94 * This will handle things received via AtomPub, OStatus
95 * (PuSH and Salmon transports), or ActivityStreams-based
96 * backup/restore of account data.
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
104 * All micro-app classes must override this method.
106 * @fixme are there any standard options?
108 * @param Activity $activity
109 * @param Profile $actor
110 * @param array $options=array()
112 * @return Notice the resulting notice
114 abstract function saveNoticeFromActivity($activity, $actor, $options=array());
117 * Given an existing Notice object, your plugin gets to
118 * figure out how to arrange it into an ActivityStreams
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).
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.
130 * All micro-app classes must override this method.
132 * @fixme this outputs an ActivityObject, not an Activity. Any compat issues?
134 * @param Notice $notice
136 * @return ActivityObject
138 abstract function activityObjectFromNotice($notice);
141 * When building the primary notice form, we'll fetch also some
142 * alternate forms for specialized types -- that's you!
144 * Return a custom Widget or Form object for the given output
145 * object, and it'll be included in the HTML output. Beware that
146 * your form may be initially hidden.
148 * All micro-app classes must override this method.
150 * @param HTMLOutputter $out
153 abstract function entryForm($out);
156 * When a notice is deleted, you'll be called here for a chance
157 * to clean up any related resources.
159 * All micro-app classes must override this method.
161 * @param Notice $notice
163 abstract function deleteRelated($notice);
168 public function newFormAction() {
169 // such as 'newbookmark' or 'newevent' route
170 return 'new'.$this->tag();
174 * Check if a given notice object should be handled by this micro-app
177 * The default implementation checks against the activity type list
178 * returned by $this->types(). You can override this method to expand
181 * @param Notice $notice
184 function isMyNotice($notice) {
185 $types = $this->types();
186 return ($notice->verb == ActivityVerb::POST) && in_array($notice->object_type, $types);
190 * Check if a given ActivityStreams activity should be handled by this
193 * The default implementation checks against the activity type list
194 * returned by $this->types(), and requires that exactly one matching
195 * object be present. You can override this method to expand
196 * your checks or to compare the activity's verb, etc.
198 * @param Activity $activity
201 function isMyActivity($activity) {
202 $types = $this->types();
203 return (count($activity->objects) == 1 &&
204 ($activity->objects[0] instanceof ActivityObject) &&
205 ($activity->verb == ActivityVerb::POST) &&
206 in_array($activity->objects[0]->type, $types));
210 * Called when generating Atom XML ActivityStreams output from an
211 * ActivityObject belonging to this plugin. Gives the plugin
212 * a chance to add custom output.
214 * Note that you can only add output of additional XML elements,
215 * not change existing stuff here.
217 * If output is already handled by the base Activity classes,
218 * you can leave this base implementation as a no-op.
220 * @param ActivityObject $obj
221 * @param XMLOutputter $out to add elements at end of object
223 function activityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
225 // default is a no-op
229 * Called when generating JSON ActivityStreams output from an
230 * ActivityObject belonging to this plugin. Gives the plugin
231 * a chance to add custom output.
233 * Modify the array contents to your heart's content, and it'll
234 * all get serialized out as JSON.
236 * If output is already handled by the base Activity classes,
237 * you can leave this base implementation as a no-op.
239 * @param ActivityObject $obj
240 * @param array &$out JSON-targeted array which can be modified
242 public function activityObjectOutputJson(ActivityObject $obj, array &$out)
244 // default is a no-op
248 * When a notice is deleted, delete the related objects
249 * by calling the overridable $this->deleteRelated().
251 * @param Notice $notice Notice being deleted
253 * @return boolean hook value
255 function onNoticeDeleteRelated($notice)
257 if ($this->isMyNotice($notice)) {
258 $this->deleteRelated($notice);
265 * Output the HTML for this kind of object in a list
267 * @param NoticeListItem $nli The list item being shown.
269 * @return boolean hook value
271 * @fixme WARNING WARNING WARNING this closes a 'div' that is implicitly opened in BookmarkPlugin's showNotice implementation
273 function onStartShowNoticeItem($nli)
275 if (!$this->isMyNotice($nli->notice)) {
279 $adapter = $this->adaptNoticeListItem($nli);
281 if (!empty($adapter)) {
282 $adapter->showNotice();
283 $adapter->showNoticeAttachments();
284 $adapter->showNoticeInfo();
285 $adapter->showNoticeOptions();
287 $this->oldShowNotice($nli);
294 * Given a notice list item, returns an adapter specific
297 * @param NoticeListItem $nli item to adapt
299 * @return NoticeListItemAdapter adapter or null
301 function adaptNoticeListItem($nli)
306 function oldShowNotice($nli)
309 $notice = $nli->notice;
312 $this->showNotice($notice, $out);
313 } catch (Exception $e) {
314 common_log(LOG_ERR, $e->getMessage());
316 $out->elementStart('div');
321 $nli->showNoticeLink();
322 $nli->showNoticeSource();
323 $nli->showNoticeLocation();
327 $out->elementEnd('div');
329 $nli->showNoticeOptions();
333 * Render a notice as one of our objects
335 * @param Notice $notice Notice to render
336 * @param ActivityObject &$object Empty object to fill
338 * @return boolean hook value
340 function onStartActivityObjectFromNotice($notice, &$object)
342 if ($this->isMyNotice($notice)) {
343 $object = $this->activityObjectFromNotice($notice);
351 * Handle a posted object from PuSH
353 * @param Activity $activity activity to handle
354 * @param Ostatus_profile $oprofile Profile for the feed
356 * @return boolean hook value
358 function onStartHandleFeedEntryWithProfile($activity, $oprofile, &$notice)
360 if ($this->isMyActivity($activity)) {
362 $actor = $oprofile->checkAuthorship($activity);
364 if (!$actor instanceof Ostatus_profile) {
365 // TRANS: Client exception thrown when no author for an activity was found.
366 throw new ClientException(_('Cannot get author for activity.'));
369 $object = $activity->objects[0];
371 $options = array('uri' => $object->id,
372 'url' => $object->link,
373 'is_local' => Notice::REMOTE,
374 'source' => 'ostatus');
376 // $actor is an ostatus_profile
377 $notice = $this->saveNoticeFromActivity($activity, $actor->localProfile(), $options);
386 * Handle a posted object from Salmon
388 * @param Activity $activity activity to handle
389 * @param mixed $target user or group targeted
391 * @return boolean hook value
394 function onStartHandleSalmonTarget($activity, $target)
396 if ($this->isMyActivity($activity)) {
397 $this->log(LOG_INFO, "Checking {$activity->id} as a valid Salmon slap.");
399 if ($target instanceof User_group) {
400 $uri = $target->getUri();
401 if (!array_key_exists($uri, $activity->context->attention)) {
402 // @todo FIXME: please document (i18n).
403 // TRANS: Client exception thrown when ...
404 throw new ClientException(_('Object not posted to this group.'));
406 } else if ($target instanceof User) {
409 if (!empty($activity->context->replyToID)) {
410 $original = Notice::getKV('uri',
411 $activity->context->replyToID);
413 if (!array_key_exists($uri, $activity->context->attention) &&
415 $original->profile_id != $target->id)) {
416 // @todo FIXME: Please document (i18n).
417 // TRANS: Client exception when ...
418 throw new ClientException(_('Object not posted to this user.'));
421 // TRANS: Server exception thrown when a micro app plugin uses a target that cannot be handled.
422 throw new ServerException(_('Do not know how to handle this kind of target.'));
425 $actor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
427 $object = $activity->objects[0];
429 $options = array('uri' => $object->id,
430 'url' => $object->link,
431 'is_local' => Notice::REMOTE,
432 'source' => 'ostatus');
434 // $actor is an ostatus_profile
435 $this->saveNoticeFromActivity($activity, $actor->localProfile(), $options);
444 * Handle object posted via AtomPub
446 * @param Activity &$activity Activity that was posted
447 * @param User $user User that posted it
448 * @param Notice &$notice Resulting notice
450 * @return boolean hook value
452 function onStartAtomPubNewActivity(&$activity, $user, &$notice)
454 if ($this->isMyActivity($activity)) {
456 $options = array('source' => 'atompub');
458 // $user->getProfile() is a Profile
459 $notice = $this->saveNoticeFromActivity($activity,
470 * Handle object imported from a backup file
472 * @param User $user User to import for
473 * @param ActivityObject $author Original author per import file
474 * @param Activity $activity Activity to import
475 * @param boolean $trusted Is this a trusted user?
476 * @param boolean &$done Is this done (success or unrecoverable error)
478 * @return boolean hook value
480 function onStartImportActivity($user, $author, $activity, $trusted, &$done)
482 if ($this->isMyActivity($activity)) {
484 $obj = $activity->objects[0];
486 $options = array('uri' => $object->id,
487 'url' => $object->link,
488 'source' => 'restore');
490 // $user->getProfile() is a Profile
491 $saved = $this->saveNoticeFromActivity($activity,
495 if (!empty($saved)) {
506 * Event handler gives the plugin a chance to add custom
507 * Atom XML ActivityStreams output from a previously filled-out
510 * The atomOutput method is called if it's one of
511 * our matching types.
513 * @param ActivityObject $obj
514 * @param XMLOutputter $out to add elements at end of object
515 * @return boolean hook return value
517 function onEndActivityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
519 if (in_array($obj->type, $this->types())) {
520 $this->activityObjectOutputAtom($obj, $out);
526 * Event handler gives the plugin a chance to add custom
527 * JSON ActivityStreams output from a previously filled-out
530 * The activityObjectOutputJson method is called if it's one of
531 * our matching types.
533 * @param ActivityObject $obj
534 * @param array &$out JSON-targeted array which can be modified
535 * @return boolean hook return value
537 function onEndActivityObjectOutputJson(ActivityObject $obj, array &$out)
539 if (in_array($obj->type, $this->types())) {
540 $this->activityObjectOutputJson($obj, $out);
545 function onStartShowEntryForms(&$tabs)
547 $tabs[$this->tag()] = array('title' => $this->appTitle(),
548 'href' => common_local_url($this->newFormAction()),
553 function onStartMakeEntryForm($tag, $out, &$form)
555 if ($tag == $this->tag()) {
556 $form = $this->entryForm($out);
563 function showNotice($notice, $out)
565 // TRANS: Server exception thrown when a micro app plugin developer has not done his job too well.
566 throw new ServerException(_('You must implement either adaptNoticeListItem() or showNotice().'));