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 will handle things received via AtomPub, OStatus
113 * (PuSH and Salmon transports), or ActivityStreams-based
114 * backup/restore of account data.
116 * You should be able to accept as input the output from your
117 * $this->activityObjectFromNotice(). Where applicable, try to
118 * use existing ActivityStreams structures and object types,
119 * and be liberal in accepting input from what might be other
122 * All micro-app classes must override this method.
124 * @fixme are there any standard options?
126 * @param Activity $activity
127 * @param Profile $actor
128 * @param array $options=array()
130 * @return Notice the resulting notice
132 abstract function saveNoticeFromActivity(Activity $activity, Profile $actor, array $options=array());
135 * Given an existing Notice object, your plugin gets to
136 * figure out how to arrange it into an ActivityStreams
139 * This will be how your specialized notice gets output in
140 * Atom feeds and JSON-based ActivityStreams output, including
141 * account backup/restore and OStatus (PuSH and Salmon transports).
143 * You should be able to round-trip data from this format back
144 * through $this->saveNoticeFromActivity(). Where applicable, try
145 * to use existing ActivityStreams structures and object types,
146 * and consider interop with other compatible apps.
148 * All micro-app classes must override this method.
150 * @fixme this outputs an ActivityObject, not an Activity. Any compat issues?
152 * @param Notice $notice
154 * @return ActivityObject
156 abstract function activityObjectFromNotice(Notice $notice);
159 * When a notice is deleted, you'll be called here for a chance
160 * to clean up any related resources.
162 * All micro-app classes must override this method.
164 * @param Notice $notice
166 abstract function deleteRelated(Notice $notice);
169 * Called when generating Atom XML ActivityStreams output from an
170 * ActivityObject belonging to this plugin. Gives the plugin
171 * a chance to add custom output.
173 * Note that you can only add output of additional XML elements,
174 * not change existing stuff here.
176 * If output is already handled by the base Activity classes,
177 * you can leave this base implementation as a no-op.
179 * @param ActivityObject $obj
180 * @param XMLOutputter $out to add elements at end of object
182 function activityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
184 // default is a no-op
188 * Called when generating JSON ActivityStreams output from an
189 * ActivityObject belonging to this plugin. Gives the plugin
190 * a chance to add custom output.
192 * Modify the array contents to your heart's content, and it'll
193 * all get serialized out as JSON.
195 * If output is already handled by the base Activity classes,
196 * you can leave this base implementation as a no-op.
198 * @param ActivityObject $obj
199 * @param array &$out JSON-targeted array which can be modified
201 public function activityObjectOutputJson(ActivityObject $obj, array &$out)
203 // default is a no-op
207 * When a notice is deleted, delete the related objects
208 * by calling the overridable $this->deleteRelated().
210 * @param Notice $notice Notice being deleted
212 * @return boolean hook value
214 function onNoticeDeleteRelated(Notice $notice)
216 if (!$this->isMyNotice($notice)) {
220 $this->deleteRelated($notice);
224 * Render a notice as one of our objects
226 * @param Notice $notice Notice to render
227 * @param ActivityObject &$object Empty object to fill
229 * @return boolean hook value
231 function onStartActivityObjectFromNotice(Notice $notice, &$object)
233 if (!$this->isMyNotice($notice)) {
237 $object = $this->activityObjectFromNotice($notice);
242 * Handle a posted object from PuSH
244 * @param Activity $activity activity to handle
245 * @param Ostatus_profile $oprofile Profile for the feed
247 * @return boolean hook value
249 function onStartHandleFeedEntryWithProfile(Activity $activity, $oprofile, &$notice)
251 if (!$this->isMyActivity($activity)) {
255 $actor = $oprofile->checkAuthorship($activity);
257 if (!$actor instanceof Ostatus_profile) {
258 // TRANS: Client exception thrown when no author for an activity was found.
259 throw new ClientException(_('Cannot get author for activity.'));
262 $object = $activity->objects[0];
264 $options = array('uri' => $object->id,
265 'url' => $object->link,
266 'is_local' => Notice::REMOTE,
267 'source' => 'ostatus');
269 // $actor is an ostatus_profile
270 $notice = $this->saveNoticeFromActivity($activity, $actor->localProfile(), $options);
276 * Handle a posted object from Salmon
278 * @param Activity $activity activity to handle
279 * @param mixed $target user or group targeted
281 * @return boolean hook value
284 function onStartHandleSalmonTarget(Activity $activity, $target)
286 if (!$this->isMyActivity($activity)) {
290 $this->log(LOG_INFO, "Checking {$activity->id} as a valid Salmon slap.");
292 if ($target instanceof User_group) {
293 $uri = $target->getUri();
294 if (!array_key_exists($uri, $activity->context->attention)) {
295 // @todo FIXME: please document (i18n).
296 // TRANS: Client exception thrown when ...
297 throw new ClientException(_('Object not posted to this group.'));
299 } else if ($target instanceof User) {
302 if (!empty($activity->context->replyToID)) {
303 $original = Notice::getKV('uri', $activity->context->replyToID);
305 if (!array_key_exists($uri, $activity->context->attention) &&
307 $original->profile_id != $target->id)) {
308 // @todo FIXME: Please document (i18n).
309 // TRANS: Client exception when ...
310 throw new ClientException(_('Object not posted to this user.'));
313 // TRANS: Server exception thrown when a micro app plugin uses a target that cannot be handled.
314 throw new ServerException(_('Do not know how to handle this kind of target.'));
317 $actor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
319 $object = $activity->objects[0];
321 $options = array('uri' => $object->id,
322 'url' => $object->link,
323 'is_local' => Notice::REMOTE,
324 'source' => 'ostatus');
326 // $actor is an ostatus_profile
327 $this->saveNoticeFromActivity($activity, $actor->localProfile(), $options);
333 * Handle object posted via AtomPub
335 * @param Activity &$activity Activity that was posted
336 * @param User $user User that posted it
337 * @param Notice &$notice Resulting notice
339 * @return boolean hook value
341 function onStartAtomPubNewActivity(Activity &$activity, $user, &$notice)
343 if (!$this->isMyActivity($activity)) {
347 $options = array('source' => 'atompub');
349 // $user->getProfile() is a Profile
350 $notice = $this->saveNoticeFromActivity($activity,
358 * Handle object imported from a backup file
360 * @param User $user User to import for
361 * @param ActivityObject $author Original author per import file
362 * @param Activity $activity Activity to import
363 * @param boolean $trusted Is this a trusted user?
364 * @param boolean &$done Is this done (success or unrecoverable error)
366 * @return boolean hook value
368 function onStartImportActivity($user, $author, Activity $activity, $trusted, &$done)
370 if (!$this->isMyActivity($activity)) {
374 $obj = $activity->objects[0];
376 $options = array('uri' => $object->id,
377 'url' => $object->link,
378 'source' => 'restore');
380 // $user->getProfile() is a Profile
381 $saved = $this->saveNoticeFromActivity($activity,
385 if (!empty($saved)) {
393 * Event handler gives the plugin a chance to add custom
394 * Atom XML ActivityStreams output from a previously filled-out
397 * The atomOutput method is called if it's one of
398 * our matching types.
400 * @param ActivityObject $obj
401 * @param XMLOutputter $out to add elements at end of object
402 * @return boolean hook return value
404 function onEndActivityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
406 if (in_array($obj->type, $this->types())) {
407 $this->activityObjectOutputAtom($obj, $out);
413 * Event handler gives the plugin a chance to add custom
414 * JSON ActivityStreams output from a previously filled-out
417 * The activityObjectOutputJson method is called if it's one of
418 * our matching types.
420 * @param ActivityObject $obj
421 * @param array &$out JSON-targeted array which can be modified
422 * @return boolean hook return value
424 function onEndActivityObjectOutputJson(ActivityObject $obj, array &$out)
426 if (in_array($obj->type, $this->types())) {
427 $this->activityObjectOutputJson($obj, $out);