]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/activityhandlerplugin.php
f97bb98aab8d49e7e73ef535784df1a1e7b8cdff
[quix0rs-gnu-social.git] / lib / activityhandlerplugin.php
1 <?php
2 /*
3  * GNU Social - a federating social network
4  * Copyright (C) 2014, Free Software Foundation, Inc.
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 if (!defined('GNUSOCIAL')) { exit(1); }
21
22 /**
23  * Superclass for plugins which add Activity types and such
24  *
25  * @category  Activity
26  * @package   GNUsocial
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
31  */
32 abstract class ActivityHandlerPlugin extends Plugin
33 {
34     /** 
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(). 
38      *
39      * @return string (compatible with HTML classes)
40      */ 
41     abstract function tag();
42
43     /**
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.
49      *
50      * An empty list means any type is ok. (Favorite verb etc.)
51      *
52      * @return array of strings
53      */
54     abstract function types();
55
56     /**
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.
62      *
63      * All micro-app classes must override this method.
64      *
65      * @return array of strings
66      */
67     public function verbs() {
68         return array(ActivityVerb::POST);
69     }
70
71     /**
72      * Check if a given ActivityStreams activity should be handled by this
73      * micro-app plugin.
74      *
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.
79      *
80      * @param Activity $activity
81      * @return boolean
82      */
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));
88     }
89
90     /**
91      * Check if a given notice object should be handled by this micro-app
92      * plugin.
93      *
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.
97      *
98      * @param Notice $notice
99      * @return boolean
100      */
101     function isMyNotice(Notice $notice) {
102         return $this->isMyVerb($notice->verb) && $this->isMyType($notice->object_type);
103     }
104
105     function isMyVerb($verb) {
106         $verb = $verb ?: ActivityVerb::POST;    // post is the default verb
107         return ActivityUtils::compareVerbs($verb, $this->verbs());
108     }
109
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());
113     }
114
115     /**
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.
119      *
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).
123      *
124      * @param Activity $activity
125      * @param Profile $actor
126      * @param array $options=array()
127      *
128      * @return Notice the resulting notice
129      */
130     public function saveNoticeFromActivity(Activity $activity, Profile $actor, array $options=array())
131     {
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).
135
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');
138         }
139
140         return Notice::saveActivity($activity, $actor, $options);
141     }
142
143     /**
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.
147     *
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.
152     *
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.
158     *
159     * All micro-app classes must override this method.
160     *
161     * @fixme are there any standard options?
162     *
163     * @param Activity $activity
164     * @param Notice   $stored       The notice in our database for this certain object
165     * @param array $options=array()
166     *
167     * @return object    If the verb handling plugin creates an object, it can be returned here (otherwise true)
168     * @throws exception On any error.
169     */
170     protected function saveObjectFromActivity(Activity $activity, Notice $stored, array $options=array())
171     {
172         throw new ServerException('This function should be abstract when all plugins have migrated to saveObjectFromActivity');
173     }
174
175     /*
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.
178      */
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)) {
183             return true;
184         }
185         $object = $this->saveObjectFromActivity($act, $stored, $options);
186         return false;
187     }
188
189     /**
190      * Given an existing Notice object, your plugin gets to
191      * figure out how to arrange it into an ActivityStreams
192      * object.
193      *
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).
197      *
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.
202      *
203      * All micro-app classes must override this method.
204      *
205      * @fixme this outputs an ActivityObject, not an Activity. Any compat issues?
206      *
207      * @param Notice $notice
208      *
209      * @return ActivityObject
210      */
211     abstract function activityObjectFromNotice(Notice $notice);
212
213     /**
214      * When a notice is deleted, you'll be called here for a chance
215      * to clean up any related resources.
216      *
217      * All micro-app classes must override this method.
218      *
219      * @param Notice $notice
220      */
221     abstract function deleteRelated(Notice $notice);
222
223     protected function notifyMentioned(Notice $stored, array &$mentioned_ids)
224     {
225         // pass through silently by default
226
227         // If we want to stop any other plugin from notifying based on this activity, return false instead.
228         return true;
229     }
230
231     /**
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.
235      *
236      * Note that you can only add output of additional XML elements,
237      * not change existing stuff here.
238      *
239      * If output is already handled by the base Activity classes,
240      * you can leave this base implementation as a no-op.
241      *
242      * @param ActivityObject $obj
243      * @param XMLOutputter $out to add elements at end of object
244      */
245     function activityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
246     {
247         // default is a no-op
248     }
249
250     /**
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.
254      *
255      * Modify the array contents to your heart's content, and it'll
256      * all get serialized out as JSON.
257      *
258      * If output is already handled by the base Activity classes,
259      * you can leave this base implementation as a no-op.
260      *
261      * @param ActivityObject $obj
262      * @param array &$out JSON-targeted array which can be modified
263      */
264     public function activityObjectOutputJson(ActivityObject $obj, array &$out)
265     {
266         // default is a no-op
267     }
268
269     /**
270      * When a notice is deleted, delete the related objects
271      * by calling the overridable $this->deleteRelated().
272      *
273      * @param Notice $notice Notice being deleted
274      *
275      * @return boolean hook value
276      */
277     public function onNoticeDeleteRelated(Notice $notice)
278     {
279         if ($this->isMyNotice($notice)) {
280             try {
281                 $this->deleteRelated($notice);
282             } catch (AlreadyFulfilledException $e) {
283                 // Nothing to see here, it's obviously already gone...
284             }
285         }
286
287         // Always continue this event in our activity handling plugins.
288         return true;
289     }
290
291     /**
292      * @param Notice $stored            The notice being distributed
293      * @param array  &$mentioned_ids    List of profiles (from $stored->getReplies())
294      */
295     public function onStartNotifyMentioned(Notice $stored, array &$mentioned_ids)
296     {
297         if (!$this->isMyNotice($stored)) {
298             return true;
299         }
300
301         return $this->notifyMentioned($stored, $mentioned_ids);
302     }
303
304     /**
305      * Render a notice as one of our objects
306      *
307      * @param Notice         $notice  Notice to render
308      * @param ActivityObject &$object Empty object to fill
309      *
310      * @return boolean hook value
311      */
312     function onStartActivityObjectFromNotice(Notice $notice, &$object)
313     {
314         if (!$this->isMyNotice($notice)) {
315             return true;
316         }
317
318         $object = $this->activityObjectFromNotice($notice);
319         return false;
320     }
321
322     /**
323      * Handle a posted object from PuSH
324      *
325      * @param Activity        $activity activity to handle
326      * @param Profile         $actor Profile for the feed
327      *
328      * @return boolean hook value
329      */
330     function onStartHandleFeedEntryWithProfile(Activity $activity, Profile $profile, &$notice)
331     {
332         if (!$this->isMyActivity($activity)) {
333             return true;
334         }
335
336         // We are guaranteed to get a Profile back from checkAuthorship (or it throws an exception)
337         $profile = ActivityUtils::checkAuthorship($activity, $profile);
338
339         $object = $activity->objects[0];
340
341         $options = array('uri' => $object->id,
342                          'url' => $object->link,
343                          'self' => $object->selfLink,
344                          'is_local' => Notice::REMOTE,
345                          'source' => 'ostatus');
346
347         if (!isset($this->oldSaveNew)) {
348             $notice = Notice::saveActivity($activity, $profile, $options);
349         } else {
350             $notice = $this->saveNoticeFromActivity($activity, $profile, $options);
351         }
352
353         return false;
354     }
355
356     /**
357      * Handle a posted object from Salmon
358      *
359      * @param Activity $activity activity to handle
360      * @param mixed    $target   user or group targeted
361      *
362      * @return boolean hook value
363      */
364
365     function onStartHandleSalmonTarget(Activity $activity, $target)
366     {
367         if (!$this->isMyActivity($activity)) {
368             return true;
369         }
370         if (!isset($this->oldSaveNew)) {
371             // Handle saveActivity in OStatus class for incoming salmon, remove this event
372             // handler when all plugins have gotten rid of "oldSaveNew".
373             return true;
374         }
375
376         $this->log(LOG_INFO, get_called_class()." checking {$activity->id} as a valid Salmon slap.");
377
378         if ($target instanceof User_group || $target->isGroup()) {
379             $uri = $target->getUri();
380             if (!array_key_exists($uri, $activity->context->attention)) {
381                 // @todo FIXME: please document (i18n).
382                 // TRANS: Client exception thrown when ...
383                 throw new ClientException(_('Object not posted to this group.'));
384             }
385         } elseif ($target instanceof Profile && $target->isLocal()) {
386             $original = null;
387             // FIXME: Shouldn't favorites show up with a 'target' activityobject?
388             if (!ActivityUtils::compareVerbs($activity->verb, array(ActivityVerb::POST)) && isset($activity->objects[0])) {
389                 // If this is not a post, it's a verb targeted at something (such as a Favorite attached to a note)
390                 if (!empty($activity->objects[0]->id)) {
391                     $activity->context->replyToID = $activity->objects[0]->id;
392                 }
393             }
394             if (!empty($activity->context->replyToID)) {
395                 $original = Notice::getKV('uri', $activity->context->replyToID);
396             }
397             if ((!$original instanceof Notice || $original->profile_id != $target->id)
398                     && !array_key_exists($target->getUri(), $activity->context->attention)) {
399                 // @todo FIXME: Please document (i18n).
400                 // TRANS: Client exception when ...
401                 throw new ClientException(_('Object not posted to this user.'));
402             }
403         } else {
404             // TRANS: Server exception thrown when a micro app plugin uses a target that cannot be handled.
405             throw new ServerException(_('Do not know how to handle this kind of target.'));
406         }
407
408         $oactor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
409         $actor = $oactor->localProfile();
410
411         // FIXME: will this work in all cases? I made it work for Favorite...
412         if (ActivityUtils::compareVerbs($activity->verb, array(ActivityVerb::POST))) {
413             $object = $activity->objects[0];
414         } else {
415             $object = $activity;
416         }
417
418         $options = array('uri' => $object->id,
419                          'url' => $object->link,
420                          'self' => $object->selfLink,
421                          'is_local' => Notice::REMOTE,
422                          'source' => 'ostatus');
423
424         $notice = $this->saveNoticeFromActivity($activity, $actor, $options);
425
426         return false;
427     }
428
429     /**
430      * Handle object posted via AtomPub
431      *
432      * @param Activity  $activity Activity that was posted
433      * @param Profile   $scoped   Profile of user posting
434      * @param Notice   &$notice   Resulting notice
435      *
436      * @return boolean hook value
437      */
438     public function onStartAtomPubNewActivity(Activity $activity, Profile $scoped, Notice &$notice=null)
439     {
440         if (!$this->isMyActivity($activity)) {
441             return true;
442         }
443
444         $options = array('source' => 'atompub');
445
446         $notice = $this->saveNoticeFromActivity($activity, $scoped, $options);
447
448         return false;
449     }
450
451     /**
452      * Handle object imported from a backup file
453      *
454      * @param User           $user     User to import for
455      * @param ActivityObject $author   Original author per import file
456      * @param Activity       $activity Activity to import
457      * @param boolean        $trusted  Is this a trusted user?
458      * @param boolean        &$done    Is this done (success or unrecoverable error)
459      *
460      * @return boolean hook value
461      */
462     function onStartImportActivity($user, $author, Activity $activity, $trusted, &$done)
463     {
464         if (!$this->isMyActivity($activity)) {
465             return true;
466         }
467
468         $obj = $activity->objects[0];
469
470         $options = array('uri' => $object->id,
471                          'url' => $object->link,
472                          'self' => $object->selfLink,
473                          'source' => 'restore');
474
475         // $user->getProfile() is a Profile
476         $saved = $this->saveNoticeFromActivity($activity,
477                                                $user->getProfile(),
478                                                $options);
479
480         if (!empty($saved)) {
481             $done = true;
482         }
483
484         return false;
485     }
486
487     /**
488      * Event handler gives the plugin a chance to add custom
489      * Atom XML ActivityStreams output from a previously filled-out
490      * ActivityObject.
491      *
492      * The atomOutput method is called if it's one of
493      * our matching types.
494      *
495      * @param ActivityObject $obj
496      * @param XMLOutputter $out to add elements at end of object
497      * @return boolean hook return value
498      */
499     function onEndActivityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
500     {
501         if (in_array($obj->type, $this->types())) {
502             $this->activityObjectOutputAtom($obj, $out);
503         }
504         return true;
505     }
506
507     /**
508      * Event handler gives the plugin a chance to add custom
509      * JSON ActivityStreams output from a previously filled-out
510      * ActivityObject.
511      *
512      * The activityObjectOutputJson method is called if it's one of
513      * our matching types.
514      *
515      * @param ActivityObject $obj
516      * @param array &$out JSON-targeted array which can be modified
517      * @return boolean hook return value
518      */
519     function onEndActivityObjectOutputJson(ActivityObject $obj, array &$out)
520     {
521         if (in_array($obj->type, $this->types())) {
522             $this->activityObjectOutputJson($obj, $out);
523         }
524         return true;
525     }
526
527     public function onStartOpenNoticeListItemElement(NoticeListItem $nli)
528     {   
529         if (!$this->isMyNotice($nli->notice)) {
530             return true;
531         }
532
533         $this->openNoticeListItemElement($nli);
534
535         Event::handle('EndOpenNoticeListItemElement', array($nli));
536         return false;
537     }
538
539     public function onStartCloseNoticeListItemElement(NoticeListItem $nli)
540     {   
541         if (!$this->isMyNotice($nli->notice)) {
542             return true;
543         }
544
545         $this->closeNoticeListItemElement($nli);
546
547         Event::handle('EndCloseNoticeListItemElement', array($nli));
548         return false;
549     }
550
551     protected function openNoticeListItemElement(NoticeListItem $nli)
552     {
553         $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
554         $class = 'h-entry notice ' . $this->tag();
555         if ($nli->notice->scope != 0 && $nli->notice->scope != 1) {
556             $class .= ' limited-scope';
557         }
558         try {
559             $class .= ' notice-source-'.common_to_alphanumeric($nli->notice->source);
560         } catch (Exception $e) {
561             // either source or what we filtered out was a zero-length string
562         }
563         $nli->out->elementStart('li', array('class' => $class,
564                                             'id' => 'notice-' . $id));
565     }
566
567     protected function closeNoticeListItemElement(NoticeListItem $nli)
568     {
569         $nli->out->elementEnd('li');
570     }
571
572
573     // FIXME: This is overriden in MicroAppPlugin but shouldn't have to be
574     public function onStartShowNoticeItem(NoticeListItem $nli)
575     {   
576         if (!$this->isMyNotice($nli->notice)) {
577             return true;
578         }
579
580         try {
581             $this->showNoticeListItem($nli);
582         } catch (Exception $e) {
583             common_log(LOG_ERR, 'Error showing notice '.$nli->getNotice()->getID().': ' . $e->getMessage());
584             $nli->out->element('p', 'error', sprintf(_('Error showing notice: %s'), $e->getMessage()));
585         }
586
587         Event::handle('EndShowNoticeItem', array($nli));
588         return false;
589     }
590
591     protected function showNoticeListItem(NoticeListItem $nli)
592     {
593         $nli->showNoticeHeaders();
594         $nli->showContent();
595         $nli->showNoticeFooter();
596     }
597
598     public function onStartShowNoticeItemNotice(NoticeListItem $nli)
599     {
600         if (!$this->isMyNotice($nli->notice)) {
601             return true;
602         }
603
604         $this->showNoticeItemNotice($nli);
605
606         Event::handle('EndShowNoticeItemNotice', array($nli));
607         return false;
608     }
609
610     protected function showNoticeItemNotice(NoticeListItem $nli)
611     {
612         $nli->showNoticeTitle();
613         $nli->showAuthor();
614         $nli->showAddressees();
615         $nli->showContent();
616     }
617
618     public function onStartShowNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
619     {
620         if (!$this->isMyNotice($stored)) {
621             return true;
622         }
623
624         try {
625             $this->showNoticeContent($stored, $out, $scoped);
626         } catch (Exception $e) {
627             $out->element('div', 'error', $e->getMessage());
628         }
629         return false;
630     }
631
632     protected function showNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
633     {
634         $out->text($stored->getContent());
635     }
636 }