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 * Return a list of ActivityStreams object type IRIs
36 * which this micro-app handles. Default implementations
37 * of the base class will use this list to check if a
38 * given ActivityStreams object belongs to us, via
39 * $this->isMyNotice() or $this->isMyActivity.
41 * An empty list means any type is ok. (Favorite verb etc.)
43 * All micro-app classes must override this method.
45 * @return array of strings
47 abstract function types();
50 * Return a list of ActivityStreams verb IRIs which
51 * this micro-app handles. Default implementations
52 * of the base class will use this list to check if a
53 * given ActivityStreams verb belongs to us, via
54 * $this->isMyNotice() or $this->isMyActivity.
56 * All micro-app classes must override this method.
58 * @return array of strings
61 return array(ActivityVerb::POST);
65 * Check if a given ActivityStreams activity should be handled by this
68 * The default implementation checks against the activity type list
69 * returned by $this->types(), and requires that exactly one matching
70 * object be present. You can override this method to expand
71 * your checks or to compare the activity's verb, etc.
73 * @param Activity $activity
76 function isMyActivity(Activity $act) {
77 return (count($act->objects) == 1
78 && ($act->objects[0] instanceof ActivityObject)
79 && $this->isMyVerb($act->verb)
80 && $this->isMyType($act->objects[0]->type));
84 * Check if a given notice object should be handled by this micro-app
87 * The default implementation checks against the activity type list
88 * returned by $this->types(). You can override this method to expand
89 * your checks, but follow the execution chain to get it right.
91 * @param Notice $notice
94 function isMyNotice(Notice $notice) {
95 return $this->isMyVerb($notice->verb) && $this->isMyType($notice->object_type);
98 function isMyVerb($verb) {
99 $verb = $verb ?: ActivityVerb::POST; // post is the default verb
100 return ActivityUtils::compareTypes($verb, $this->verbs());
103 function isMyType($type) {
104 return count($this->types())===0 || ActivityUtils::compareTypes($type, $this->types());
108 * Given a parsed ActivityStreams activity, your plugin
109 * gets to figure out how to actually save it into a notice
110 * and any additional data structures you require.
112 * This function is deprecated and in the future, Notice::saveActivity
113 * should be called from onStartHandleFeedEntryWithProfile in this class
114 * (which instead turns to saveObjectFromActivity).
116 * @param Activity $activity
117 * @param Profile $actor
118 * @param array $options=array()
120 * @return Notice the resulting notice
122 public function saveNoticeFromActivity(Activity $activity, Profile $actor, array $options=array())
124 // Any plugin which has not implemented saveObjectFromActivity _must_
125 // override this function until they are migrated (this function will
126 // be deleted when all plugins are migrated to saveObjectFromActivity).
128 if (isset($this->oldSaveNew)) {
129 throw new ServerException('A function has been called for new saveActivity functionality, but is still set with an oldSaveNew configuration');
132 return Notice::saveActivity($activity, $actor, $options);
136 * Given a parsed ActivityStreams activity, your plugin gets
137 * to figure out itself how to store the additional data into
138 * the database, besides the base data stored by the core.
140 * This will handle just about all events where an activity
141 * object gets saved, whether it is via AtomPub, OStatus
142 * (PuSH and Salmon transports), or ActivityStreams-based
143 * backup/restore of account data.
145 * You should be able to accept as input the output from an
146 * asActivity() call on the stored object. Where applicable,
147 * try to use existing ActivityStreams structures and object
148 * types, and be liberal in accepting input from what might
149 * be other compatible apps.
151 * All micro-app classes must override this method.
153 * @fixme are there any standard options?
155 * @param Activity $activity
156 * @param Profile $actor
157 * @param array $options=array()
159 * @return Notice the resulting notice
161 protected function saveObjectFromActivity(Activity $activity, Notice $stored, array $options=array())
163 throw new ServerException('This function should be abstract when all plugins have migrated to saveObjectFromActivity');
167 * This usually gets called from Notice::saveActivity after a Notice object has been created,
168 * so it contains a proper id and a uri for the object to be saved.
170 public function onStoreActivityObject(Activity $act, Notice $stored, array $options=array(), &$object) {
171 // $this->oldSaveNew is there during a migration period of plugins, to start using
172 // Notice::saveActivity instead of Notice::saveNew
173 if (!$this->isMyActivity($act) || isset($this->oldSaveNew)) {
176 $object = $this->saveObjectFromActivity($act, $stored, $options);
178 $act->context->attention = array_merge($act->context->attention, $object->getAttentionArray());
179 } catch (Exception $e) {
180 common_debug('WARNING: Could not get attention list from object '.get_class($object).'!');
186 * Given an existing Notice object, your plugin gets to
187 * figure out how to arrange it into an ActivityStreams
190 * This will be how your specialized notice gets output in
191 * Atom feeds and JSON-based ActivityStreams output, including
192 * account backup/restore and OStatus (PuSH and Salmon transports).
194 * You should be able to round-trip data from this format back
195 * through $this->saveNoticeFromActivity(). Where applicable, try
196 * to use existing ActivityStreams structures and object types,
197 * and consider interop with other compatible apps.
199 * All micro-app classes must override this method.
201 * @fixme this outputs an ActivityObject, not an Activity. Any compat issues?
203 * @param Notice $notice
205 * @return ActivityObject
207 abstract function activityObjectFromNotice(Notice $notice);
210 * When a notice is deleted, you'll be called here for a chance
211 * to clean up any related resources.
213 * All micro-app classes must override this method.
215 * @param Notice $notice
217 abstract function deleteRelated(Notice $notice);
220 * Called when generating Atom XML ActivityStreams output from an
221 * ActivityObject belonging to this plugin. Gives the plugin
222 * a chance to add custom output.
224 * Note that you can only add output of additional XML elements,
225 * not change existing stuff here.
227 * If output is already handled by the base Activity classes,
228 * you can leave this base implementation as a no-op.
230 * @param ActivityObject $obj
231 * @param XMLOutputter $out to add elements at end of object
233 function activityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
235 // default is a no-op
239 * Called when generating JSON ActivityStreams output from an
240 * ActivityObject belonging to this plugin. Gives the plugin
241 * a chance to add custom output.
243 * Modify the array contents to your heart's content, and it'll
244 * all get serialized out as JSON.
246 * If output is already handled by the base Activity classes,
247 * you can leave this base implementation as a no-op.
249 * @param ActivityObject $obj
250 * @param array &$out JSON-targeted array which can be modified
252 public function activityObjectOutputJson(ActivityObject $obj, array &$out)
254 // default is a no-op
258 * When a notice is deleted, delete the related objects
259 * by calling the overridable $this->deleteRelated().
261 * @param Notice $notice Notice being deleted
263 * @return boolean hook value
265 function onNoticeDeleteRelated(Notice $notice)
267 if (!$this->isMyNotice($notice)) {
271 $this->deleteRelated($notice);
275 * Render a notice as one of our objects
277 * @param Notice $notice Notice to render
278 * @param ActivityObject &$object Empty object to fill
280 * @return boolean hook value
282 function onStartActivityObjectFromNotice(Notice $notice, &$object)
284 if (!$this->isMyNotice($notice)) {
289 $object = $this->activityObjectFromNotice($notice);
290 } catch (NoResultException $e) {
291 $object = null; // because getKV returns null on failure
297 * Handle a posted object from PuSH
299 * @param Activity $activity activity to handle
300 * @param Profile $actor Profile for the feed
302 * @return boolean hook value
304 function onStartHandleFeedEntryWithProfile(Activity $activity, Profile $profile, &$notice)
306 if (!$this->isMyActivity($activity)) {
310 // We are guaranteed to get a Profile back from checkAuthorship (or it throws an exception)
311 $profile = ActivityUtils::checkAuthorship($activity, $profile);
313 $object = $activity->objects[0];
315 $options = array('uri' => $object->id,
316 'url' => $object->link,
317 'is_local' => Notice::REMOTE,
318 'source' => 'ostatus');
320 if (!isset($this->oldSaveNew)) {
321 $notice = Notice::saveActivity($activity, $profile, $options);
323 $notice = $this->saveNoticeFromActivity($activity, $profile, $options);
330 * Handle a posted object from Salmon
332 * @param Activity $activity activity to handle
333 * @param mixed $target user or group targeted
335 * @return boolean hook value
338 function onStartHandleSalmonTarget(Activity $activity, $target)
340 if (!$this->isMyActivity($activity)) {
344 $this->log(LOG_INFO, "Checking {$activity->id} as a valid Salmon slap.");
346 if ($target instanceof User_group || $target->isGroup()) {
347 $uri = $target->getUri();
348 if (!array_key_exists($uri, $activity->context->attention)) {
349 // @todo FIXME: please document (i18n).
350 // TRANS: Client exception thrown when ...
351 throw new ClientException(_('Object not posted to this group.'));
353 } elseif ($target instanceof Profile && $target->isLocal()) {
355 // FIXME: Shouldn't favorites show up with a 'target' activityobject?
356 if (!ActivityUtils::compareTypes($activity->verb, array(ActivityVerb::POST)) && isset($activity->objects[0])) {
357 // If this is not a post, it's a verb targeted at something (such as a Favorite attached to a note)
358 if (!empty($activity->objects[0]->id)) {
359 $activity->context->replyToID = $activity->objects[0]->id;
362 if (!empty($activity->context->replyToID)) {
363 $original = Notice::getKV('uri', $activity->context->replyToID);
365 if ((!$original instanceof Notice || $original->profile_id != $target->id)
366 && !array_key_exists($target->getUri(), $activity->context->attention)) {
367 // @todo FIXME: Please document (i18n).
368 // TRANS: Client exception when ...
369 throw new ClientException(_('Object not posted to this user.'));
372 // TRANS: Server exception thrown when a micro app plugin uses a target that cannot be handled.
373 throw new ServerException(_('Do not know how to handle this kind of target.'));
376 $oactor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
377 $actor = $oactor->localProfile();
379 // FIXME: will this work in all cases? I made it work for Favorite...
380 if (ActivityUtils::compareTypes($activity->verb, array(ActivityVerb::POST))) {
381 $object = $activity->objects[0];
386 $options = array('uri' => $object->id,
387 'url' => $object->link,
388 'is_local' => Notice::REMOTE,
389 'source' => 'ostatus');
391 if (!isset($this->oldSaveNew)) {
392 $notice = Notice::saveActivity($activity, $actor, $options);
394 $notice = $this->saveNoticeFromActivity($activity, $actor, $options);
401 * Handle object posted via AtomPub
403 * @param Activity &$activity Activity that was posted
404 * @param User $user User that posted it
405 * @param Notice &$notice Resulting notice
407 * @return boolean hook value
409 function onStartAtomPubNewActivity(Activity &$activity, $user, &$notice)
411 if (!$this->isMyActivity($activity)) {
415 $options = array('source' => 'atompub');
417 // $user->getProfile() is a Profile
418 $notice = $this->saveNoticeFromActivity($activity,
426 * Handle object imported from a backup file
428 * @param User $user User to import for
429 * @param ActivityObject $author Original author per import file
430 * @param Activity $activity Activity to import
431 * @param boolean $trusted Is this a trusted user?
432 * @param boolean &$done Is this done (success or unrecoverable error)
434 * @return boolean hook value
436 function onStartImportActivity($user, $author, Activity $activity, $trusted, &$done)
438 if (!$this->isMyActivity($activity)) {
442 $obj = $activity->objects[0];
444 $options = array('uri' => $object->id,
445 'url' => $object->link,
446 'source' => 'restore');
448 // $user->getProfile() is a Profile
449 $saved = $this->saveNoticeFromActivity($activity,
453 if (!empty($saved)) {
461 * Event handler gives the plugin a chance to add custom
462 * Atom XML ActivityStreams output from a previously filled-out
465 * The atomOutput method is called if it's one of
466 * our matching types.
468 * @param ActivityObject $obj
469 * @param XMLOutputter $out to add elements at end of object
470 * @return boolean hook return value
472 function onEndActivityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
474 if (in_array($obj->type, $this->types())) {
475 $this->activityObjectOutputAtom($obj, $out);
481 * Event handler gives the plugin a chance to add custom
482 * JSON ActivityStreams output from a previously filled-out
485 * The activityObjectOutputJson method is called if it's one of
486 * our matching types.
488 * @param ActivityObject $obj
489 * @param array &$out JSON-targeted array which can be modified
490 * @return boolean hook return value
492 function onEndActivityObjectOutputJson(ActivityObject $obj, array &$out)
494 if (in_array($obj->type, $this->types())) {
495 $this->activityObjectOutputJson($obj, $out);