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 // Third argument to compareTypes is true, to allow for notices with empty object_type for example (verb-only)
112 return count($this->types())===0 || ActivityUtils::compareTypes($type, $this->types());
116 * Given a parsed ActivityStreams activity, your plugin
117 * gets to figure out how to actually save it into a notice
118 * and any additional data structures you require.
120 * This function is deprecated and in the future, Notice::saveActivity
121 * should be called from onStartHandleFeedEntryWithProfile in this class
122 * (which instead turns to saveObjectFromActivity).
124 * @param Activity $activity
125 * @param Profile $actor
126 * @param array $options=array()
128 * @return Notice the resulting notice
130 public function saveNoticeFromActivity(Activity $activity, Profile $actor, array $options=array())
132 // Any plugin which has not implemented saveObjectFromActivity _must_
133 // override this function until they are migrated (this function will
134 // be deleted when all plugins are migrated to saveObjectFromActivity).
136 if (isset($this->oldSaveNew)) {
137 throw new ServerException('A function has been called for new saveActivity functionality, but is still set with an oldSaveNew configuration');
140 return Notice::saveActivity($activity, $actor, $options);
144 * Given a parsed ActivityStreams activity, your plugin gets
145 * to figure out itself how to store the additional data into
146 * the database, besides the base data stored by the core.
148 * This will handle just about all events where an activity
149 * object gets saved, whether it is via AtomPub, OStatus
150 * (PuSH and Salmon transports), or ActivityStreams-based
151 * backup/restore of account data.
153 * You should be able to accept as input the output from an
154 * asActivity() call on the stored object. Where applicable,
155 * try to use existing ActivityStreams structures and object
156 * types, and be liberal in accepting input from what might
157 * be other compatible apps.
159 * All micro-app classes must override this method.
161 * @fixme are there any standard options?
163 * @param Activity $activity
164 * @param Notice $stored The notice in our database for this certain object
165 * @param array $options=array()
167 * @return object If the verb handling plugin creates an object, it can be returned here (otherwise true)
168 * @throws exception On any error.
170 protected function saveObjectFromActivity(Activity $activity, Notice $stored, array $options=array())
172 throw new ServerException('This function should be abstract when all plugins have migrated to saveObjectFromActivity');
176 * This usually gets called from Notice::saveActivity after a Notice object has been created,
177 * so it contains a proper id and a uri for the object to be saved.
179 public function onStoreActivityObject(Activity $act, Notice $stored, array $options, &$object) {
180 // $this->oldSaveNew is there during a migration period of plugins, to start using
181 // Notice::saveActivity instead of Notice::saveNew
182 if (!$this->isMyActivity($act) || isset($this->oldSaveNew)) {
185 $object = $this->saveObjectFromActivity($act, $stored, $options);
190 * Given an existing Notice object, your plugin gets to
191 * figure out how to arrange it into an ActivityStreams
194 * This will be how your specialized notice gets output in
195 * Atom feeds and JSON-based ActivityStreams output, including
196 * account backup/restore and OStatus (PuSH and Salmon transports).
198 * You should be able to round-trip data from this format back
199 * through $this->saveNoticeFromActivity(). Where applicable, try
200 * to use existing ActivityStreams structures and object types,
201 * and consider interop with other compatible apps.
203 * All micro-app classes must override this method.
205 * @fixme this outputs an ActivityObject, not an Activity. Any compat issues?
207 * @param Notice $notice
209 * @return ActivityObject
211 abstract function activityObjectFromNotice(Notice $notice);
214 * When a notice is deleted, you'll be called here for a chance
215 * to clean up any related resources.
217 * All micro-app classes must override this method.
219 * @param Notice $notice
221 abstract function deleteRelated(Notice $notice);
223 protected function notifyMentioned(Notice $stored, array &$mentioned_ids)
225 // pass through silently by default
227 // If we want to stop any other plugin from notifying based on this activity, return false instead.
232 * Called when generating Atom XML ActivityStreams output from an
233 * ActivityObject belonging to this plugin. Gives the plugin
234 * a chance to add custom output.
236 * Note that you can only add output of additional XML elements,
237 * not change existing stuff here.
239 * If output is already handled by the base Activity classes,
240 * you can leave this base implementation as a no-op.
242 * @param ActivityObject $obj
243 * @param XMLOutputter $out to add elements at end of object
245 function activityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
247 // default is a no-op
251 * Called when generating JSON ActivityStreams output from an
252 * ActivityObject belonging to this plugin. Gives the plugin
253 * a chance to add custom output.
255 * Modify the array contents to your heart's content, and it'll
256 * all get serialized out as JSON.
258 * If output is already handled by the base Activity classes,
259 * you can leave this base implementation as a no-op.
261 * @param ActivityObject $obj
262 * @param array &$out JSON-targeted array which can be modified
264 public function activityObjectOutputJson(ActivityObject $obj, array &$out)
266 // default is a no-op
270 * When a notice is deleted, delete the related objects
271 * by calling the overridable $this->deleteRelated().
273 * @param Notice $notice Notice being deleted
275 * @return boolean hook value
277 public function onNoticeDeleteRelated(Notice $notice)
279 if ($this->isMyNotice($notice)) {
281 $this->deleteRelated($notice);
282 } catch (NoProfileException $e) {
283 // we failed because of database lookup failure, Notice has no recognized profile as creator
284 // so we skip this. If we want to remove missing notices we should do a SQL constraints check
285 // in the affected plugin.
286 } catch (AlreadyFulfilledException $e) {
287 // Nothing to see here, it's obviously already gone...
291 // Always continue this event in our activity handling plugins.
296 * @param Notice $stored The notice being distributed
297 * @param array &$mentioned_ids List of profiles (from $stored->getReplies())
299 public function onStartNotifyMentioned(Notice $stored, array &$mentioned_ids)
301 if (!$this->isMyNotice($stored)) {
305 return $this->notifyMentioned($stored, $mentioned_ids);
309 * Render a notice as one of our objects
311 * @param Notice $notice Notice to render
312 * @param ActivityObject &$object Empty object to fill
314 * @return boolean hook value
316 function onStartActivityObjectFromNotice(Notice $notice, &$object)
318 if (!$this->isMyNotice($notice)) {
322 $object = $this->activityObjectFromNotice($notice);
327 * Handle a posted object from PuSH
329 * @param Activity $activity activity to handle
330 * @param Profile $actor Profile for the feed
332 * @return boolean hook value
334 function onStartHandleFeedEntryWithProfile(Activity $activity, Profile $profile, &$notice)
336 if (!$this->isMyActivity($activity)) {
340 // We are guaranteed to get a Profile back from checkAuthorship (or it throws an exception)
341 $profile = ActivityUtils::checkAuthorship($activity, $profile);
343 $object = $activity->objects[0];
345 $options = array('uri' => $object->id,
346 'url' => $object->link,
347 'is_local' => Notice::REMOTE,
348 'source' => 'ostatus');
350 if (!isset($this->oldSaveNew)) {
351 $notice = Notice::saveActivity($activity, $profile, $options);
353 $notice = $this->saveNoticeFromActivity($activity, $profile, $options);
360 * Handle a posted object from Salmon
362 * @param Activity $activity activity to handle
363 * @param mixed $target user or group targeted
365 * @return boolean hook value
368 function onStartHandleSalmonTarget(Activity $activity, $target)
370 if (!$this->isMyActivity($activity)) {
373 if (!isset($this->oldSaveNew)) {
374 // Handle saveActivity in OStatus class for incoming salmon, remove this event
375 // handler when all plugins have gotten rid of "oldSaveNew".
379 $this->log(LOG_INFO, get_called_class()." checking {$activity->id} as a valid Salmon slap.");
381 if ($target instanceof User_group || $target->isGroup()) {
382 $uri = $target->getUri();
383 if (!array_key_exists($uri, $activity->context->attention)) {
384 // @todo FIXME: please document (i18n).
385 // TRANS: Client exception thrown when ...
386 throw new ClientException(_('Object not posted to this group.'));
388 } elseif ($target instanceof Profile && $target->isLocal()) {
390 // FIXME: Shouldn't favorites show up with a 'target' activityobject?
391 if (!ActivityUtils::compareVerbs($activity->verb, array(ActivityVerb::POST)) && isset($activity->objects[0])) {
392 // If this is not a post, it's a verb targeted at something (such as a Favorite attached to a note)
393 if (!empty($activity->objects[0]->id)) {
394 $activity->context->replyToID = $activity->objects[0]->id;
397 if (!empty($activity->context->replyToID)) {
398 $original = Notice::getKV('uri', $activity->context->replyToID);
400 if ((!$original instanceof Notice || $original->profile_id != $target->id)
401 && !array_key_exists($target->getUri(), $activity->context->attention)) {
402 // @todo FIXME: Please document (i18n).
403 // TRANS: Client exception when ...
404 throw new ClientException(_('Object not posted to this user.'));
407 // TRANS: Server exception thrown when a micro app plugin uses a target that cannot be handled.
408 throw new ServerException(_('Do not know how to handle this kind of target.'));
411 $oactor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
412 $actor = $oactor->localProfile();
414 // FIXME: will this work in all cases? I made it work for Favorite...
415 if (ActivityUtils::compareVerbs($activity->verb, array(ActivityVerb::POST))) {
416 $object = $activity->objects[0];
421 $options = array('uri' => $object->id,
422 'url' => $object->link,
423 'is_local' => Notice::REMOTE,
424 'source' => 'ostatus');
426 $notice = $this->saveNoticeFromActivity($activity, $actor, $options);
432 * Handle object posted via AtomPub
434 * @param Activity $activity Activity that was posted
435 * @param Profile $scoped Profile of user posting
436 * @param Notice &$notice Resulting notice
438 * @return boolean hook value
440 public function onStartAtomPubNewActivity(Activity $activity, Profile $scoped, Notice &$notice=null)
442 if (!$this->isMyActivity($activity)) {
446 $options = array('source' => 'atompub');
448 $notice = $this->saveNoticeFromActivity($activity, $scoped, $options);
454 * Handle object imported from a backup file
456 * @param User $user User to import for
457 * @param ActivityObject $author Original author per import file
458 * @param Activity $activity Activity to import
459 * @param boolean $trusted Is this a trusted user?
460 * @param boolean &$done Is this done (success or unrecoverable error)
462 * @return boolean hook value
464 function onStartImportActivity($user, $author, Activity $activity, $trusted, &$done)
466 if (!$this->isMyActivity($activity)) {
470 $obj = $activity->objects[0];
472 $options = array('uri' => $object->id,
473 'url' => $object->link,
474 'source' => 'restore');
476 // $user->getProfile() is a Profile
477 $saved = $this->saveNoticeFromActivity($activity,
481 if (!empty($saved)) {
489 * Event handler gives the plugin a chance to add custom
490 * Atom XML ActivityStreams output from a previously filled-out
493 * The atomOutput method is called if it's one of
494 * our matching types.
496 * @param ActivityObject $obj
497 * @param XMLOutputter $out to add elements at end of object
498 * @return boolean hook return value
500 function onEndActivityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
502 if (in_array($obj->type, $this->types())) {
503 $this->activityObjectOutputAtom($obj, $out);
509 * Event handler gives the plugin a chance to add custom
510 * JSON ActivityStreams output from a previously filled-out
513 * The activityObjectOutputJson method is called if it's one of
514 * our matching types.
516 * @param ActivityObject $obj
517 * @param array &$out JSON-targeted array which can be modified
518 * @return boolean hook return value
520 function onEndActivityObjectOutputJson(ActivityObject $obj, array &$out)
522 if (in_array($obj->type, $this->types())) {
523 $this->activityObjectOutputJson($obj, $out);
528 public function onStartOpenNoticeListItemElement(NoticeListItem $nli)
530 if (!$this->isMyNotice($nli->notice)) {
534 $this->openNoticeListItemElement($nli);
536 Event::handle('EndOpenNoticeListItemElement', array($nli));
540 public function onStartCloseNoticeListItemElement(NoticeListItem $nli)
542 if (!$this->isMyNotice($nli->notice)) {
546 $this->closeNoticeListItemElement($nli);
548 Event::handle('EndCloseNoticeListItemElement', array($nli));
552 protected function openNoticeListItemElement(NoticeListItem $nli)
554 $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
555 $class = 'h-entry notice ' . $this->tag();
556 if ($nli->notice->scope != 0 && $nli->notice->scope != 1) {
557 $class .= ' limited-scope';
560 $class .= ' notice-source-'.common_to_alphanumeric($nli->notice->source);
561 } catch (Exception $e) {
562 // either source or what we filtered out was a zero-length string
564 $nli->out->elementStart('li', array('class' => $class,
565 'id' => 'notice-' . $id));
568 protected function closeNoticeListItemElement(NoticeListItem $nli)
570 $nli->out->elementEnd('li');
574 // FIXME: This is overriden in MicroAppPlugin but shouldn't have to be
575 public function onStartShowNoticeItem(NoticeListItem $nli)
577 if (!$this->isMyNotice($nli->notice)) {
582 $this->showNoticeListItem($nli);
583 } catch (Exception $e) {
584 common_log(LOG_ERR, 'Error showing notice '.$nli->getNotice()->getID().': ' . $e->getMessage());
585 $nli->out->element('p', 'error', sprintf(_('Error showing notice: %s'), $e->getMessage()));
588 Event::handle('EndShowNoticeItem', array($nli));
592 protected function showNoticeListItem(NoticeListItem $nli)
594 $nli->showNoticeHeaders();
596 $nli->showNoticeFooter();
599 public function onStartShowNoticeItemNotice(NoticeListItem $nli)
601 if (!$this->isMyNotice($nli->notice)) {
605 $this->showNoticeItemNotice($nli);
607 Event::handle('EndShowNoticeItemNotice', array($nli));
611 protected function showNoticeItemNotice(NoticeListItem $nli)
613 $nli->showNoticeTitle();
615 $nli->showAddressees();
619 public function onStartShowNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
621 if (!$this->isMyNotice($stored)) {
626 $this->showNoticeContent($stored, $out, $scoped);
627 } catch (Exception $e) {
628 $out->element('div', 'error', $e->getMessage());
633 protected function showNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
635 $out->text($stored->getContent());