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::compareTypes($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.
168 protected function saveObjectFromActivity(Activity $activity, Notice $stored, array $options=array())
170 throw new ServerException('This function should be abstract when all plugins have migrated to saveObjectFromActivity');
174 * This usually gets called from Notice::saveActivity after a Notice object has been created,
175 * so it contains a proper id and a uri for the object to be saved.
177 public function onStoreActivityObject(Activity $act, Notice $stored, array $options=array(), &$object) {
178 // $this->oldSaveNew is there during a migration period of plugins, to start using
179 // Notice::saveActivity instead of Notice::saveNew
180 if (!$this->isMyActivity($act) || isset($this->oldSaveNew)) {
183 $object = $this->saveObjectFromActivity($act, $stored, $options);
185 // In the future we probably want to use something like ActivityVerb_DataObject for the kind
186 // of objects which are returned from saveObjectFromActivity.
187 if ($object instanceof Managed_DataObject) {
188 // If the verb handling plugin figured out some more attention URIs, add them here to the
189 // original activity.
190 $act->context->attention = array_merge($act->context->attention, $object->getAttentionArray());
192 } catch (Exception $e) {
193 common_debug('WARNING: Could not get attention list from object '.get_class($object).'!');
199 * Given an existing Notice object, your plugin gets to
200 * figure out how to arrange it into an ActivityStreams
203 * This will be how your specialized notice gets output in
204 * Atom feeds and JSON-based ActivityStreams output, including
205 * account backup/restore and OStatus (PuSH and Salmon transports).
207 * You should be able to round-trip data from this format back
208 * through $this->saveNoticeFromActivity(). Where applicable, try
209 * to use existing ActivityStreams structures and object types,
210 * and consider interop with other compatible apps.
212 * All micro-app classes must override this method.
214 * @fixme this outputs an ActivityObject, not an Activity. Any compat issues?
216 * @param Notice $notice
218 * @return ActivityObject
220 abstract function activityObjectFromNotice(Notice $notice);
223 * When a notice is deleted, you'll be called here for a chance
224 * to clean up any related resources.
226 * All micro-app classes must override this method.
228 * @param Notice $notice
230 abstract function deleteRelated(Notice $notice);
232 protected function notifyMentioned(Notice $stored, array &$mentioned_ids)
234 // pass through silently by default
238 * Called when generating Atom XML ActivityStreams output from an
239 * ActivityObject belonging to this plugin. Gives the plugin
240 * a chance to add custom output.
242 * Note that you can only add output of additional XML elements,
243 * not change existing stuff here.
245 * If output is already handled by the base Activity classes,
246 * you can leave this base implementation as a no-op.
248 * @param ActivityObject $obj
249 * @param XMLOutputter $out to add elements at end of object
251 function activityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
253 // default is a no-op
257 * Called when generating JSON ActivityStreams output from an
258 * ActivityObject belonging to this plugin. Gives the plugin
259 * a chance to add custom output.
261 * Modify the array contents to your heart's content, and it'll
262 * all get serialized out as JSON.
264 * If output is already handled by the base Activity classes,
265 * you can leave this base implementation as a no-op.
267 * @param ActivityObject $obj
268 * @param array &$out JSON-targeted array which can be modified
270 public function activityObjectOutputJson(ActivityObject $obj, array &$out)
272 // default is a no-op
276 * When a notice is deleted, delete the related objects
277 * by calling the overridable $this->deleteRelated().
279 * @param Notice $notice Notice being deleted
281 * @return boolean hook value
283 function onNoticeDeleteRelated(Notice $notice)
285 if ($this->isMyNotice($notice)) {
286 $this->deleteRelated($notice);
289 // Always continue this event in our activity handling plugins.
294 * @param Notice $stored The notice being distributed
295 * @param array &$mentioned_ids List of profiles (from $stored->getReplies())
297 public function onStartNotifyMentioned(Notice $stored, array &$mentioned_ids)
299 if (!$this->isMyNotice($stored)) {
303 $this->notifyMentioned($stored, $mentioned_ids);
305 // If it was _our_ notice, only we should do anything with the mentions.
310 * Render a notice as one of our objects
312 * @param Notice $notice Notice to render
313 * @param ActivityObject &$object Empty object to fill
315 * @return boolean hook value
317 function onStartActivityObjectFromNotice(Notice $notice, &$object)
319 if (!$this->isMyNotice($notice)) {
324 $object = $this->activityObjectFromNotice($notice);
325 } catch (NoResultException $e) {
326 $object = null; // because getKV returns null on failure
332 * Handle a posted object from PuSH
334 * @param Activity $activity activity to handle
335 * @param Profile $actor Profile for the feed
337 * @return boolean hook value
339 function onStartHandleFeedEntryWithProfile(Activity $activity, Profile $profile, &$notice)
341 if (!$this->isMyActivity($activity)) {
345 // We are guaranteed to get a Profile back from checkAuthorship (or it throws an exception)
346 $profile = ActivityUtils::checkAuthorship($activity, $profile);
348 $object = $activity->objects[0];
350 $options = array('uri' => $object->id,
351 'url' => $object->link,
352 'is_local' => Notice::REMOTE,
353 'source' => 'ostatus');
355 if (!isset($this->oldSaveNew)) {
356 $notice = Notice::saveActivity($activity, $profile, $options);
358 $notice = $this->saveNoticeFromActivity($activity, $profile, $options);
365 * Handle a posted object from Salmon
367 * @param Activity $activity activity to handle
368 * @param mixed $target user or group targeted
370 * @return boolean hook value
373 function onStartHandleSalmonTarget(Activity $activity, $target)
375 if (!$this->isMyActivity($activity)) {
379 $this->log(LOG_INFO, "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::compareTypes($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::compareTypes($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 if (!isset($this->oldSaveNew)) {
427 $notice = Notice::saveActivity($activity, $actor, $options);
429 $notice = $this->saveNoticeFromActivity($activity, $actor, $options);
436 * Handle object posted via AtomPub
438 * @param Activity &$activity Activity that was posted
439 * @param Profile $scoped Profile of user posting
440 * @param Notice &$notice Resulting notice
442 * @return boolean hook value
444 // FIXME: Make sure we can really do strong Notice typing with a $notice===null without having =null here
445 public function onStartAtomPubNewActivity(Activity &$activity, Profile $scoped, Notice &$notice)
447 if (!$this->isMyActivity($activity)) {
451 $options = array('source' => 'atompub');
453 $notice = $this->saveNoticeFromActivity($activity, $scoped, $options);
455 Event::handle('EndAtomPubNewActivity', array($activity, $scoped, $notice));
461 * Handle object imported from a backup file
463 * @param User $user User to import for
464 * @param ActivityObject $author Original author per import file
465 * @param Activity $activity Activity to import
466 * @param boolean $trusted Is this a trusted user?
467 * @param boolean &$done Is this done (success or unrecoverable error)
469 * @return boolean hook value
471 function onStartImportActivity($user, $author, Activity $activity, $trusted, &$done)
473 if (!$this->isMyActivity($activity)) {
477 $obj = $activity->objects[0];
479 $options = array('uri' => $object->id,
480 'url' => $object->link,
481 'source' => 'restore');
483 // $user->getProfile() is a Profile
484 $saved = $this->saveNoticeFromActivity($activity,
488 if (!empty($saved)) {
496 * Event handler gives the plugin a chance to add custom
497 * Atom XML ActivityStreams output from a previously filled-out
500 * The atomOutput method is called if it's one of
501 * our matching types.
503 * @param ActivityObject $obj
504 * @param XMLOutputter $out to add elements at end of object
505 * @return boolean hook return value
507 function onEndActivityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
509 if (in_array($obj->type, $this->types())) {
510 $this->activityObjectOutputAtom($obj, $out);
516 * Event handler gives the plugin a chance to add custom
517 * JSON ActivityStreams output from a previously filled-out
520 * The activityObjectOutputJson method is called if it's one of
521 * our matching types.
523 * @param ActivityObject $obj
524 * @param array &$out JSON-targeted array which can be modified
525 * @return boolean hook return value
527 function onEndActivityObjectOutputJson(ActivityObject $obj, array &$out)
529 if (in_array($obj->type, $this->types())) {
530 $this->activityObjectOutputJson($obj, $out);
535 public function onStartOpenNoticeListItemElement(NoticeListItem $nli)
537 if (!$this->isMyNotice($nli->notice)) {
541 $this->openNoticeListItemElement($nli);
543 Event::handle('EndOpenNoticeListItemElement', array($nli));
547 public function onStartCloseNoticeListItemElement(NoticeListItem $nli)
549 if (!$this->isMyNotice($nli->notice)) {
553 $this->closeNoticeListItemElement($nli);
555 Event::handle('EndCloseNoticeListItemElement', array($nli));
559 protected function openNoticeListItemElement(NoticeListItem $nli)
561 $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
562 $class = 'h-entry notice ' . $this->tag();
563 if ($nli->notice->scope != 0 && $nli->notice->scope != 1) {
564 $class .= ' limited-scope';
566 $nli->out->elementStart('li', array('class' => $class,
567 'id' => 'notice-' . $id));
570 protected function closeNoticeListItemElement(NoticeListItem $nli)
572 $nli->out->elementEnd('li');
576 // FIXME: This is overriden in MicroAppPlugin but shouldn't have to be
577 public function onStartShowNoticeItem(NoticeListItem $nli)
579 if (!$this->isMyNotice($nli->notice)) {
584 $this->showNoticeListItem($nli);
585 } catch (Exception $e) {
586 $nli->out->element('p', 'error', 'Error showing notice: '.htmlspecialchars($e->getMessage()));
589 Event::handle('EndShowNoticeItem', array($nli));
593 protected function showNoticeListItem(NoticeListItem $nli)
596 $nli->showNoticeAttachments();
597 $nli->showNoticeInfo();
598 $nli->showNoticeOptions();
600 $nli->showNoticeLink();
601 $nli->showNoticeSource();
602 $nli->showNoticeLocation();
603 $nli->showPermalink();
606 $nli->showNoticeOptions();
609 public function onStartShowNoticeItemNotice(NoticeListItem $nli)
611 if (!$this->isMyNotice($nli->notice)) {
615 $this->showNoticeItemNotice($nli);
617 Event::handle('EndShowNoticeItemNotice', array($nli));
621 protected function showNoticeItemNotice(NoticeListItem $nli)
623 $nli->showNoticeTitle();
625 $nli->showAddressees();
629 public function onStartShowNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
631 if (!$this->isMyNotice($stored)) {
635 $this->showNoticeContent($stored, $out, $scoped);
639 protected function showNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
641 $out->text($stored->getContent());