]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/activityhandlerplugin.php
Always naming it 'plugin' is not good, it can easily confuse. So better name it
[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::compareTypes($verb, $this->verbs());
108     }
109
110     function isMyType($type) {
111         return count($this->types())===0 || ActivityUtils::compareTypes($type, $this->types());
112     }
113
114     /**
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.
118      *
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).
122      *
123      * @param Activity $activity
124      * @param Profile $actor
125      * @param array $options=array()
126      *
127      * @return Notice the resulting notice
128      */
129     public function saveNoticeFromActivity(Activity $activity, Profile $actor, array $options=array())
130     {
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).
134
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');
137         }
138
139         return Notice::saveActivity($activity, $actor, $options);
140     }
141
142     /**
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.
146     *
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.
151     *
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.
157     *
158     * All micro-app classes must override this method.
159     *
160     * @fixme are there any standard options?
161     *
162     * @param Activity $activity
163     * @param Notice   $stored       The notice in our database for this certain object
164     * @param array $options=array()
165     *
166     * @return object    If the verb handling plugin creates an object, it can be returned here (otherwise true)
167     * @throws exception On any error.
168     */
169     protected function saveObjectFromActivity(Activity $activity, Notice $stored, array $options=array())
170     {
171         throw new ServerException('This function should be abstract when all plugins have migrated to saveObjectFromActivity');
172     }
173
174     /*
175      * This usually gets called from Notice::saveActivity after a Notice object has been created,
176      * so it contains a proper id and a uri for the object to be saved.
177      */
178     public function onStoreActivityObject(Activity $act, Notice $stored, array $options, &$object) {
179         // $this->oldSaveNew is there during a migration period of plugins, to start using
180         // Notice::saveActivity instead of Notice::saveNew
181         if (!$this->isMyActivity($act) || isset($this->oldSaveNew)) {
182             return true;
183         }
184         $object = $this->saveObjectFromActivity($act, $stored, $options);
185         try {
186             // In the future we probably want to use something like ActivityVerb_DataObject for the kind
187             // of objects which are returned from saveObjectFromActivity.
188             if ($object instanceof Managed_DataObject) {
189                 // If the verb handling plugin figured out some more attention URIs, add them here to the
190                 // original activity. This is only done if a separate object is actually needed to be saved.
191                 $act->context->attention = array_merge($act->context->attention, $object->getAttentionArray());
192             }
193         } catch (Exception $e) {
194             common_debug('WARNING: Could not get attention list from object '.get_class($object).'!');
195         }
196         return false;
197     }
198
199     /**
200      * Given an existing Notice object, your plugin gets to
201      * figure out how to arrange it into an ActivityStreams
202      * object.
203      *
204      * This will be how your specialized notice gets output in
205      * Atom feeds and JSON-based ActivityStreams output, including
206      * account backup/restore and OStatus (PuSH and Salmon transports).
207      *
208      * You should be able to round-trip data from this format back
209      * through $this->saveNoticeFromActivity(). Where applicable, try
210      * to use existing ActivityStreams structures and object types,
211      * and consider interop with other compatible apps.
212      *
213      * All micro-app classes must override this method.
214      *
215      * @fixme this outputs an ActivityObject, not an Activity. Any compat issues?
216      *
217      * @param Notice $notice
218      *
219      * @return ActivityObject
220      */
221     abstract function activityObjectFromNotice(Notice $notice);
222
223     /**
224      * When a notice is deleted, you'll be called here for a chance
225      * to clean up any related resources.
226      *
227      * All micro-app classes must override this method.
228      *
229      * @param Notice $notice
230      */
231     abstract function deleteRelated(Notice $notice);
232
233     protected function notifyMentioned(Notice $stored, array &$mentioned_ids)
234     {
235         // pass through silently by default
236     }
237
238     /**
239      * Called when generating Atom XML ActivityStreams output from an
240      * ActivityObject belonging to this plugin. Gives the plugin
241      * a chance to add custom output.
242      *
243      * Note that you can only add output of additional XML elements,
244      * not change existing stuff here.
245      *
246      * If output is already handled by the base Activity classes,
247      * you can leave this base implementation as a no-op.
248      *
249      * @param ActivityObject $obj
250      * @param XMLOutputter $out to add elements at end of object
251      */
252     function activityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
253     {
254         // default is a no-op
255     }
256
257     /**
258      * Called when generating JSON ActivityStreams output from an
259      * ActivityObject belonging to this plugin. Gives the plugin
260      * a chance to add custom output.
261      *
262      * Modify the array contents to your heart's content, and it'll
263      * all get serialized out as JSON.
264      *
265      * If output is already handled by the base Activity classes,
266      * you can leave this base implementation as a no-op.
267      *
268      * @param ActivityObject $obj
269      * @param array &$out JSON-targeted array which can be modified
270      */
271     public function activityObjectOutputJson(ActivityObject $obj, array &$out)
272     {
273         // default is a no-op
274     }
275
276     /**
277      * When a notice is deleted, delete the related objects
278      * by calling the overridable $this->deleteRelated().
279      *
280      * @param Notice $notice Notice being deleted
281      *
282      * @return boolean hook value
283      */
284     function onNoticeDeleteRelated(Notice $notice)
285     {
286         if ($this->isMyNotice($notice)) {
287             $this->deleteRelated($notice);
288         }
289
290         // Always continue this event in our activity handling plugins.
291         return true;
292     }
293
294     /**
295      * @param Notice $stored            The notice being distributed
296      * @param array  &$mentioned_ids    List of profiles (from $stored->getReplies())
297      */
298     public function onStartNotifyMentioned(Notice $stored, array &$mentioned_ids)
299     {
300         if (!$this->isMyNotice($stored)) {
301             return true;
302         }
303
304         $this->notifyMentioned($stored, $mentioned_ids);
305
306         // If it was _our_ notice, only we should do anything with the mentions.
307         return false;
308     }
309
310     /**
311      * Render a notice as one of our objects
312      *
313      * @param Notice         $notice  Notice to render
314      * @param ActivityObject &$object Empty object to fill
315      *
316      * @return boolean hook value
317      */
318     function onStartActivityObjectFromNotice(Notice $notice, &$object)
319     {
320         if (!$this->isMyNotice($notice)) {
321             return true;
322         }
323
324         try {
325             $object = $this->activityObjectFromNotice($notice);
326         } catch (NoResultException $e) {
327             $object = null; // because getKV returns null on failure
328         }
329         return false;
330     }
331
332     /**
333      * Handle a posted object from PuSH
334      *
335      * @param Activity        $activity activity to handle
336      * @param Profile         $actor Profile for the feed
337      *
338      * @return boolean hook value
339      */
340     function onStartHandleFeedEntryWithProfile(Activity $activity, Profile $profile, &$notice)
341     {
342         if (!$this->isMyActivity($activity)) {
343             return true;
344         }
345
346         // We are guaranteed to get a Profile back from checkAuthorship (or it throws an exception)
347         $profile = ActivityUtils::checkAuthorship($activity, $profile);
348
349         $object = $activity->objects[0];
350
351         $options = array('uri' => $object->id,
352                          'url' => $object->link,
353                          'is_local' => Notice::REMOTE,
354                          'source' => 'ostatus');
355
356         if (!isset($this->oldSaveNew)) {
357             $notice = Notice::saveActivity($activity, $profile, $options);
358         } else {
359             $notice = $this->saveNoticeFromActivity($activity, $profile, $options);
360         }
361
362         return false;
363     }
364
365     /**
366      * Handle a posted object from Salmon
367      *
368      * @param Activity $activity activity to handle
369      * @param mixed    $target   user or group targeted
370      *
371      * @return boolean hook value
372      */
373
374     function onStartHandleSalmonTarget(Activity $activity, $target)
375     {
376         if (!$this->isMyActivity($activity)) {
377             return true;
378         }
379
380         $this->log(LOG_INFO, "Checking {$activity->id} as a valid Salmon slap.");
381
382         if ($target instanceof User_group || $target->isGroup()) {
383             $uri = $target->getUri();
384             if (!array_key_exists($uri, $activity->context->attention)) {
385                 // @todo FIXME: please document (i18n).
386                 // TRANS: Client exception thrown when ...
387                 throw new ClientException(_('Object not posted to this group.'));
388             }
389         } elseif ($target instanceof Profile && $target->isLocal()) {
390             $original = null;
391             // FIXME: Shouldn't favorites show up with a 'target' activityobject?
392             if (!ActivityUtils::compareTypes($activity->verb, array(ActivityVerb::POST)) && isset($activity->objects[0])) {
393                 // If this is not a post, it's a verb targeted at something (such as a Favorite attached to a note)
394                 if (!empty($activity->objects[0]->id)) {
395                     $activity->context->replyToID = $activity->objects[0]->id;
396                 }
397             }
398             if (!empty($activity->context->replyToID)) {
399                 $original = Notice::getKV('uri', $activity->context->replyToID);
400             }
401             if ((!$original instanceof Notice || $original->profile_id != $target->id)
402                     && !array_key_exists($target->getUri(), $activity->context->attention)) {
403                 // @todo FIXME: Please document (i18n).
404                 // TRANS: Client exception when ...
405                 throw new ClientException(_('Object not posted to this user.'));
406             }
407         } else {
408             // TRANS: Server exception thrown when a micro app plugin uses a target that cannot be handled.
409             throw new ServerException(_('Do not know how to handle this kind of target.'));
410         }
411
412         $oactor = Ostatus_profile::ensureActivityObjectProfile($activity->actor);
413         $actor = $oactor->localProfile();
414
415         // FIXME: will this work in all cases? I made it work for Favorite...
416         if (ActivityUtils::compareTypes($activity->verb, array(ActivityVerb::POST))) {
417             $object = $activity->objects[0];
418         } else {
419             $object = $activity;
420         }
421
422         $options = array('uri' => $object->id,
423                          'url' => $object->link,
424                          'is_local' => Notice::REMOTE,
425                          'source' => 'ostatus');
426
427         if (!isset($this->oldSaveNew)) {
428             $notice = Notice::saveActivity($activity, $actor, $options);
429         } else {
430             $notice = $this->saveNoticeFromActivity($activity, $actor, $options);
431         }
432
433         return false;
434     }
435
436     /**
437      * Handle object posted via AtomPub
438      *
439      * @param Activity &$activity Activity that was posted
440      * @param Profile   $scoped   Profile of user posting
441      * @param Notice   &$notice   Resulting notice
442      *
443      * @return boolean hook value
444      */
445     // FIXME: Make sure we can really do strong Notice typing with a $notice===null without having =null here
446     public function onStartAtomPubNewActivity(Activity &$activity, Profile $scoped, Notice &$notice)
447     {
448         if (!$this->isMyActivity($activity)) {
449             return true;
450         }
451
452         $options = array('source' => 'atompub');
453
454         $notice = $this->saveNoticeFromActivity($activity, $scoped, $options);
455
456         Event::handle('EndAtomPubNewActivity', array($activity, $scoped, $notice));
457
458         return false;
459     }
460
461     /**
462      * Handle object imported from a backup file
463      *
464      * @param User           $user     User to import for
465      * @param ActivityObject $author   Original author per import file
466      * @param Activity       $activity Activity to import
467      * @param boolean        $trusted  Is this a trusted user?
468      * @param boolean        &$done    Is this done (success or unrecoverable error)
469      *
470      * @return boolean hook value
471      */
472     function onStartImportActivity($user, $author, Activity $activity, $trusted, &$done)
473     {
474         if (!$this->isMyActivity($activity)) {
475             return true;
476         }
477
478         $obj = $activity->objects[0];
479
480         $options = array('uri' => $object->id,
481                          'url' => $object->link,
482                          'source' => 'restore');
483
484         // $user->getProfile() is a Profile
485         $saved = $this->saveNoticeFromActivity($activity,
486                                                $user->getProfile(),
487                                                $options);
488
489         if (!empty($saved)) {
490             $done = true;
491         }
492
493         return false;
494     }
495
496     /**
497      * Event handler gives the plugin a chance to add custom
498      * Atom XML ActivityStreams output from a previously filled-out
499      * ActivityObject.
500      *
501      * The atomOutput method is called if it's one of
502      * our matching types.
503      *
504      * @param ActivityObject $obj
505      * @param XMLOutputter $out to add elements at end of object
506      * @return boolean hook return value
507      */
508     function onEndActivityObjectOutputAtom(ActivityObject $obj, XMLOutputter $out)
509     {
510         if (in_array($obj->type, $this->types())) {
511             $this->activityObjectOutputAtom($obj, $out);
512         }
513         return true;
514     }
515
516     /**
517      * Event handler gives the plugin a chance to add custom
518      * JSON ActivityStreams output from a previously filled-out
519      * ActivityObject.
520      *
521      * The activityObjectOutputJson method is called if it's one of
522      * our matching types.
523      *
524      * @param ActivityObject $obj
525      * @param array &$out JSON-targeted array which can be modified
526      * @return boolean hook return value
527      */
528     function onEndActivityObjectOutputJson(ActivityObject $obj, array &$out)
529     {
530         if (in_array($obj->type, $this->types())) {
531             $this->activityObjectOutputJson($obj, $out);
532         }
533         return true;
534     }
535
536     public function onStartOpenNoticeListItemElement(NoticeListItem $nli)
537     {   
538         if (!$this->isMyNotice($nli->notice)) {
539             return true;
540         }
541
542         $this->openNoticeListItemElement($nli);
543
544         Event::handle('EndOpenNoticeListItemElement', array($nli));
545         return false;
546     }
547
548     public function onStartCloseNoticeListItemElement(NoticeListItem $nli)
549     {   
550         if (!$this->isMyNotice($nli->notice)) {
551             return true;
552         }
553
554         $this->closeNoticeListItemElement($nli);
555
556         Event::handle('EndCloseNoticeListItemElement', array($nli));
557         return false;
558     }
559
560     protected function openNoticeListItemElement(NoticeListItem $nli)
561     {
562         $id = (empty($nli->repeat)) ? $nli->notice->id : $nli->repeat->id;
563         $class = 'h-entry notice ' . $this->tag();
564         if ($nli->notice->scope != 0 && $nli->notice->scope != 1) {
565             $class .= ' limited-scope';
566         }
567         $nli->out->elementStart('li', array('class' => $class,
568                                             'id' => 'notice-' . $id));
569     }
570
571     protected function closeNoticeListItemElement(NoticeListItem $nli)
572     {
573         $nli->out->elementEnd('li');
574     }
575
576
577     // FIXME: This is overriden in MicroAppPlugin but shouldn't have to be
578     public function onStartShowNoticeItem(NoticeListItem $nli)
579     {   
580         if (!$this->isMyNotice($nli->notice)) {
581             return true;
582         }
583
584         try {
585             $this->showNoticeListItem($nli);
586         } catch (Exception $e) {
587             $nli->out->element('p', 'error', 'Error showing notice: '.htmlspecialchars($e->getMessage()));
588         }
589
590         Event::handle('EndShowNoticeItem', array($nli));
591         return false;
592     }
593
594     protected function showNoticeListItem(NoticeListItem $nli)
595     {
596         $nli->showNotice();
597         $nli->showNoticeAttachments();
598         $nli->showNoticeInfo();
599         $nli->showNoticeOptions();
600
601         $nli->showNoticeLink();
602         $nli->showNoticeSource();
603         $nli->showNoticeLocation();
604         $nli->showPermalink();
605
606         $nli->showNoticeOptions();
607     }
608
609     public function onStartShowNoticeItemNotice(NoticeListItem $nli)
610     {
611         if (!$this->isMyNotice($nli->notice)) {
612             return true;
613         }
614
615         $this->showNoticeItemNotice($nli);
616
617         Event::handle('EndShowNoticeItemNotice', array($nli));
618         return false;
619     }
620
621     protected function showNoticeItemNotice(NoticeListItem $nli)
622     {
623         $nli->showNoticeTitle();
624         $nli->showAuthor();
625         $nli->showAddressees();
626         $nli->showContent();
627     }
628
629     public function onStartShowNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
630     {
631         if (!$this->isMyNotice($stored)) {
632             return true;
633         }
634
635         $this->showNoticeContent($stored, $out, $scoped);
636         return false;
637     }
638
639     protected function showNoticeContent(Notice $stored, HTMLOutputter $out, Profile $scoped=null)
640     {
641         $out->text($stored->getContent());
642     }
643 }