3 * GNU Social - a federating social network
4 * Copyright (C) 2014, Free Software Foundation, Inc.
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.
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.
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/>.
20 if (!defined('GNUSOCIAL')) { exit(1); }
23 * Superclass for plugins which add Activity types and such
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
32 abstract class ActivityHandlerPlugin extends Plugin
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().
39 * @return string (compatible with HTML classes)
41 abstract function tag();
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.
50 * An empty list means any type is ok. (Favorite verb etc.)
52 * @return array of strings
54 abstract function types();
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.
63 * All micro-app classes must override this method.
65 * @return array of strings
67 public function verbs() {
68 return array(ActivityVerb::POST);
72 * Check if a given ActivityStreams activity should be handled by this
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.
80 * @param Activity $activity
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));
91 * Check if a given notice object should be handled by this micro-app
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.
98 * @param Notice $notice
101 function isMyNotice(Notice $notice) {
102 return $this->isMyVerb($notice->verb) && $this->isMyType($notice->object_type);
105 function isMyVerb($verb) {
106 $verb = $verb ?: ActivityVerb::POST; // post is the default verb
107 return ActivityUtils::compareVerbs($verb, $this->verbs());
110 function isMyType($type) {
111 return count($this->types())===0 || ActivityUtils::compareTypes($type, $this->types());
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.
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).
123 * @param Activity $activity
124 * @param Profile $actor
125 * @param array $options=array()
127 * @return Notice the resulting notice
129 public function saveNoticeFromActivity(Activity $activity, Profile $actor, array $options=array())
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).
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');
139 return Notice::saveActivity($activity, $actor, $options);
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.
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.
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.
158 * All micro-app classes must override this method.
160 * @fixme are there any standard options?
162 * @param Activity $activity
163 * @param Notice $stored The notice in our database for this certain object
164 * @param array $options=array()
166 * @return object If the verb handling plugin creates an object, it can be returned here (otherwise true)
167 * @throws exception On any error.
169 protected function saveObjectFromActivity(Activity $activity, Notice $stored, array $options=array())
171 throw new ServerException('This function should be abstract when all plugins have migrated to saveObjectFromActivity');
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.
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)) {
184 $object = $this->saveObjectFromActivity($act, $stored, $options);
189 * Given an existing Notice object, your plugin gets to
190 * figure out how to arrange it into an ActivityStreams
193 * This will be how your specialized notice gets output in
194 * Atom feeds and JSON-based ActivityStreams output, including
195 * account backup/restore and OStatus (PuSH and Salmon transports).
197 * You should be able to round-trip data from this format back
198 * through $this->saveNoticeFromActivity(). Where applicable, try
199 * to use existing ActivityStreams structures and object types,
200 * and consider interop with other compatible apps.
202 * All micro-app classes must override this method.
204 * @fixme this outputs an ActivityObject, not an Activity. Any compat issues?
206 * @param Notice $notice
208 * @return ActivityObject
210 abstract function activityObjectFromNotice(Notice $notice);
213 * When a notice is deleted, you'll be called here for a chance
214 * to clean up any related resources.
216 * All micro-app classes must override this method.
218 * @param Notice $notice
220 abstract function deleteRelated(Notice $notice);
222 protected function notifyMentioned(Notice $stored, array &$mentioned_ids)
224 // pass through silently by default
226 // If we want to stop any other plugin from notifying based on this activity, return false instead.
231 * Called when generating Atom XML ActivityStreams output from an
232 * ActivityObject belonging to this plugin. Gives the plugin
233 * a chance to add custom output.
235 * Note that you can only add output of additional XML elements,
236 * not change existing stuff here.
238 * If output is already handled by the base Activity classes,
239 * you can leave this base implementation as a no-op.
241 * @param ActivityObject $obj
242 * @param XMLOutputter $out to add elements at end of object
244 function activityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
246 // default is a no-op
250 * Called when generating JSON ActivityStreams output from an
251 * ActivityObject belonging to this plugin. Gives the plugin
252 * a chance to add custom output.
254 * Modify the array contents to your heart's content, and it'll
255 * all get serialized out as JSON.
257 * If output is already handled by the base Activity classes,
258 * you can leave this base implementation as a no-op.
260 * @param ActivityObject $obj
261 * @param array &$out JSON-targeted array which can be modified
263 public function activityObjectOutputJson(ActivityObject $obj, array &$out)
265 // default is a no-op
269 * When a notice is deleted, delete the related objects
270 * by calling the overridable $this->deleteRelated().
272 * @param Notice $notice Notice being deleted
274 * @return boolean hook value
276 public function onNoticeDeleteRelated(Notice $notice)
278 if ($this->isMyNotice($notice)) {
280 $this->deleteRelated($notice);
281 } catch (AlreadyFulfilledException $e) {
282 // Nothing to see here, it's obviously already gone...
286 // Always continue this event in our activity handling plugins.
291 * @param Notice $stored The notice being distributed
292 * @param array &$mentioned_ids List of profiles (from $stored->getReplies())
294 public function onStartNotifyMentioned(Notice $stored, array &$mentioned_ids)
296 if (!$this->isMyNotice($stored)) {
300 return $this->notifyMentioned($stored, $mentioned_ids);
304 * Render a notice as one of our objects
306 * @param Notice $notice Notice to render
307 * @param ActivityObject &$object Empty object to fill
309 * @return boolean hook value
311 function onStartActivityObjectFromNotice(Notice $notice, &$object)
313 if (!$this->isMyNotice($notice)) {
317 $object = $this->activityObjectFromNotice($notice);
322 * Handle a posted object from PuSH
324 * @param Activity $activity activity to handle
325 * @param Profile $actor Profile for the feed
327 * @return boolean hook value
329 function onStartHandleFeedEntryWithProfile(Activity $activity, Profile $profile, &$notice)
331 if (!$this->isMyActivity($activity)) {
335 // We are guaranteed to get a Profile back from checkAuthorship (or it throws an exception)
336 $profile = ActivityUtils::checkAuthorship($activity, $profile);
338 $object = $activity->objects[0];
340 $options = array('uri' => $object->id,
341 'url' => $object->link,
342 'is_local' => Notice::REMOTE,
343 'source' => 'ostatus');
345 if (!isset($this->oldSaveNew)) {
346 $notice = Notice::saveActivity($activity, $profile, $options);
348 $notice = $this->saveNoticeFromActivity($activity, $profile, $options);
355 * Handle a posted object from Salmon
357 * @param Activity $activity activity to handle
358 * @param mixed $target user or group targeted
360 * @return boolean hook value
363 function onStartHandleSalmonTarget(Activity $activity, $target)
365 if (!$this->isMyActivity($activity)) {
368 if (!isset($this->oldSaveNew)) {
369 // Handle saveActivity in OStatus class for incoming salmon, remove this event
370 // handler when all plugins have gotten rid of "oldSaveNew".
374 $this->log(LOG_INFO, get_called_class()." checking {$activity->id} as a valid Salmon slap.");
376 if ($target instanceof User_group || $target->isGroup()) {
377 $uri = $target->getUri();
378 if (!array_key_exists($uri, $activity->context->attention)) {
379 // @todo FIXME: please document (i18n).
380 // TRANS: Client exception thrown when ...
381 throw new ClientException(_('Object not posted to this group.'));
383 } elseif ($target instanceof Profile && $target->isLocal()) {
385 // FIXME: Shouldn't favorites show up with a 'target' activityobject?
386 if (!ActivityUtils::compareVerbs($activity->verb, array(ActivityVerb::POST)) && isset($activity->objects[0])) {
387 // If this is not a post, it's a verb targeted at something (such as a Favorite attached to a note)
388 if (!empty($activity->objects[0]->id)) {
389 $activity->context->replyToID = $activity->objects[0]->id;
392 if (!empty($activity->context->replyToID)) {
393 $original = Notice::getKV('uri', $activity->context->replyToID);
395 if ((!$original instanceof Notice || $original->profile_id != $target->id)
396 && !array_key_exists($target->getUri(), $activity->context->attention)) {
397 // @todo FIXME: Please document (i18n).
398 // TRANS: Client exception when ...
399 throw new ClientException(_('Object not posted to this user.'));
402 // TRANS: Server exception thrown when a micro app plugin uses a target that cannot be handled.
403 throw new ServerException(_('Do not know how to handle this kind of target.'));
406 $oactor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
407 $actor = $oactor->localProfile();
409 // FIXME: will this work in all cases? I made it work for Favorite...
410 if (ActivityUtils::compareVerbs($activity->verb, array(ActivityVerb::POST))) {
411 $object = $activity->objects[0];
416 $options = array('uri' => $object->id,
417 'url' => $object->link,
418 'is_local' => Notice::REMOTE,
419 'source' => 'ostatus');
421 $notice = $this->saveNoticeFromActivity($activity, $actor, $options);
427 * Handle object posted via AtomPub
429 * @param Activity $activity Activity that was posted
430 * @param Profile $scoped Profile of user posting
431 * @param Notice &$notice Resulting notice
433 * @return boolean hook value
435 public function onStartAtomPubNewActivity(Activity $activity, Profile $scoped, Notice &$notice=null)
437 if (!$this->isMyActivity($activity)) {
441 $options = array('source' => 'atompub');
443 $notice = $this->saveNoticeFromActivity($activity, $scoped, $options);
449 * Handle object imported from a backup file
451 * @param User $user User to import for
452 * @param ActivityObject $author Original author per import file
453 * @param Activity $activity Activity to import
454 * @param boolean $trusted Is this a trusted user?
455 * @param boolean &$done Is this done (success or unrecoverable error)
457 * @return boolean hook value
459 function onStartImportActivity($user, $author, Activity $activity, $trusted, &$done)
461 if (!$this->isMyActivity($activity)) {
465 $obj = $activity->objects[0];
467 $options = array('uri' => $object->id,
468 'url' => $object->link,
469 'source' => 'restore');
471 // $user->getProfile() is a Profile
472 $saved = $this->saveNoticeFromActivity($activity,
476 if (!empty($saved)) {
484 * Event handler gives the plugin a chance to add custom
485 * Atom XML ActivityStreams output from a previously filled-out
488 * The atomOutput method is called if it's one of
489 * our matching types.
491 * @param ActivityObject $obj
492 * @param XMLOutputter $out to add elements at end of object
493 * @return boolean hook return value
495 function onEndActivityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
497 if (in_array($obj->type, $this->types())) {
498 $this->activityObjectOutputAtom($obj, $out);
504 * Event handler gives the plugin a chance to add custom
505 * JSON ActivityStreams output from a previously filled-out
508 * The activityObjectOutputJson method is called if it's one of
509 * our matching types.
511 * @param ActivityObject $obj
512 * @param array &$out JSON-targeted array which can be modified
513 * @return boolean hook return value
515 function onEndActivityObjectOutputJson(ActivityObject $obj, array &$out)
517 if (in_array($obj->type, $this->types())) {
518 $this->activityObjectOutputJson($obj, $out);
523 public function onStartOpenNoticeListItemElement(NoticeListItem $nli)
525 if (!$this->isMyNotice($nli->notice)) {
529 $this->openNoticeListItemElement($nli);
531 Event::handle('EndOpenNoticeListItemElement', array($nli));
535 public function onStartCloseNoticeListItemElement(NoticeListItem $nli)
537 if (!$this->isMyNotice($nli->notice)) {
541 $this->closeNoticeListItemElement($nli);
543 Event::handle('EndCloseNoticeListItemElement', array($nli));
547 protected function openNoticeListItemElement(NoticeListItem $nli)
549 $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
550 $class = 'h-entry notice ' . $this->tag();
551 if ($nli->notice->scope != 0 && $nli->notice->scope != 1) {
552 $class .= ' limited-scope';
554 $nli->out->elementStart('li', array('class' => $class,
555 'id' => 'notice-' . $id));
558 protected function closeNoticeListItemElement(NoticeListItem $nli)
560 $nli->out->elementEnd('li');
564 // FIXME: This is overriden in MicroAppPlugin but shouldn't have to be
565 public function onStartShowNoticeItem(NoticeListItem $nli)
567 if (!$this->isMyNotice($nli->notice)) {
572 $this->showNoticeListItem($nli);
573 } catch (Exception $e) {
574 common_log(LOG_ERR, 'Error showing notice '.$nli->getNotice()->getID().': ' . $e->getMessage());
575 $nli->out->element('p', 'error', sprintf(_('Error showing notice: %s'), $e->getMessage()));
578 Event::handle('EndShowNoticeItem', array($nli));
582 protected function showNoticeListItem(NoticeListItem $nli)
584 $nli->showNoticeHeaders();
586 $nli->showNoticeFooter();
589 public function onStartShowNoticeItemNotice(NoticeListItem $nli)
591 if (!$this->isMyNotice($nli->notice)) {
595 $this->showNoticeItemNotice($nli);
597 Event::handle('EndShowNoticeItemNotice', array($nli));
601 protected function showNoticeItemNotice(NoticeListItem $nli)
603 $nli->showNoticeTitle();
605 $nli->showAddressees();
609 public function onStartShowNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
611 if (!$this->isMyNotice($stored)) {
616 $this->showNoticeContent($stored, $out, $scoped);
617 } catch (Exception $e) {
618 $out->element('div', 'error', $e->getMessage());
623 protected function showNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
625 $out->text($stored->getContent());