]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/Favorite/FavoritePlugin.php
Most of the activityobject-saving for Favorite implemented
[quix0rs-gnu-social.git] / plugins / Favorite / FavoritePlugin.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  * @package     Activity
24  * @maintainer  Mikael Nordfeldth <mmn@hethane.se>
25  */
26 class FavoritePlugin extends ActivityHandlerPlugin
27 {
28     public function tag()
29     {
30         return 'favorite';
31     }
32
33     public function types()
34     {
35         return array();
36     }
37
38     public function verbs()
39     {
40         return array(ActivityVerb::FAVORITE);
41     }
42     
43     public function onCheckSchema()
44     {
45         $schema = Schema::get();
46         $schema->ensureTable('fave', Fave::schemaDef());
47         return true;
48     }
49     
50     public function onEndUpgrade()
51     {
52         printfnq("Ensuring all faves have a URI...");
53     
54         $fave = new Fave();
55         $fave->whereAdd('uri IS NULL');
56     
57         if ($fave->find()) {
58             while ($fave->fetch()) {
59                 try {
60                     $fave->decache();
61                     $fave->query(sprintf('UPDATE fave '.
62                                          'SET uri = "%s", '.
63                                          '    modified = "%s" '.
64                                          'WHERE user_id = %d '.
65                                          'AND notice_id = %d',
66                                          Fave::newURI($fave->user_id, $fave->notice_id, $fave->modified),
67                                          common_sql_date(strtotime($fave->modified)),
68                                          $fave->user_id,
69                                          $fave->notice_id));
70                 } catch (Exception $e) {
71                     common_log(LOG_ERR, "Error updating fave URI: " . $e->getMessage());
72                 }
73             }
74         }
75     
76         printfnq("DONE.\n");
77     }
78
79     public function onRouterInitialized(URLMapper $m)
80     {
81         // Web UI actions
82         $m->connect('main/favor', array('action' => 'favor'));
83         $m->connect('main/disfavor', array('action' => 'disfavor'));
84
85         if (common_config('singleuser', 'enabled')) {
86             $nickname = User::singleUserNickname();
87
88             $m->connect('favorites',
89                         array('action' => 'showfavorites',
90                               'nickname' => $nickname));
91             $m->connect('favoritesrss',
92                         array('action' => 'favoritesrss',
93                               'nickname' => $nickname));
94         } else {
95             $m->connect('favoritedrss', array('action' => 'favoritedrss'));
96             $m->connect('favorited/', array('action' => 'favorited'));
97             $m->connect('favorited', array('action' => 'favorited'));
98
99             $m->connect(':nickname/favorites',
100                         array('action' => 'showfavorites'),
101                         array('nickname' => Nickname::DISPLAY_FMT));
102             $m->connect(':nickname/favorites/rss',
103                         array('action' => 'favoritesrss'),
104                         array('nickname' => Nickname::DISPLAY_FMT));
105         }
106
107         // Favorites for API
108         $m->connect('api/favorites/create.:format',
109                     array('action' => 'ApiFavoriteCreate',
110                           'format' => '(xml|json)'));
111         $m->connect('api/favorites/destroy.:format',
112                     array('action' => 'ApiFavoriteDestroy',
113                           'format' => '(xml|json)'));
114         $m->connect('api/favorites/list.:format',
115                     array('action' => 'ApiTimelineFavorites',
116                           'format' => '(xml|json|rss|atom|as)'));
117         $m->connect('api/favorites/:id.:format',
118                     array('action' => 'ApiTimelineFavorites',
119                           'id' => Nickname::INPUT_FMT,
120                           'format' => '(xml|json|rss|atom|as)'));
121         $m->connect('api/favorites.:format',
122                     array('action' => 'ApiTimelineFavorites',
123                           'format' => '(xml|json|rss|atom|as)'));
124         $m->connect('api/favorites/create/:id.:format',
125                     array('action' => 'ApiFavoriteCreate',
126                           'id' => '[0-9]+',
127                           'format' => '(xml|json)'));
128         $m->connect('api/favorites/destroy/:id.:format',
129                     array('action' => 'ApiFavoriteDestroy',
130                           'id' => '[0-9]+',
131                           'format' => '(xml|json)'));
132
133         // AtomPub API
134         $m->connect('api/statusnet/app/favorites/:profile/:notice.atom',
135                     array('action' => 'AtomPubShowFavorite'),
136                     array('profile' => '[0-9]+',
137                           'notice' => '[0-9]+'));
138
139         $m->connect('api/statusnet/app/favorites/:profile.atom',
140                     array('action' => 'AtomPubFavoriteFeed'),
141                     array('profile' => '[0-9]+'));
142
143         // Required for qvitter API
144         $m->connect('api/statuses/favs/:id.:format',
145                     array('action' => 'ApiStatusesFavs',
146                           'id' => '[0-9]+',
147                           'format' => '(xml|json)'));
148     }
149
150     public function saveNoticeFromActivity(Activity $activity, Profile $actor, array $options=array())
151     {
152     }
153
154     // FIXME: Set this to abstract public when all plugins have migrated!
155     public function saveObjectFromActivity(Activity $activity, Notice $stored, array $options=array())  
156     {
157         assert($this->isMyActivity($act));
158         $actor = $stored->getProfile();
159         $uris = array();
160         if (count($act->objects) != 1) {
161             // TRANS: Exception thrown when a favor activity has anything but 1 object
162             throw new ClientException(_('Favoring activites can only be done one at a time'));
163         }
164
165         $obj = $act->objects[0];
166         $type = isset($obj->type) ? ActivityUtils::resolveUri($obj->type, true) : ActivityObject::NOTE;
167         $uris = $obj->getIdentifiers();
168         try {
169             $local = ActivityUtils::findLocalObject($uris, $type);
170         } catch (Exception $e) {
171             // TODO: if it's not available locally, we should import the favorited object!
172             common_debug('Could not find favored notice locally: '.var_export($uris,true));
173             return null;
174         }
175
176         if (!empty($act->time)) {
177             // This should reasonably mean that it was created on our instance.
178             $options['created'] = common_sql_date($act->time);
179         }
180
181         $options['uri'] = !empty($act->id) ? $act->id : $act->selfLink;
182         $object = Fave::saveNew($actor, $local, $type, $options);
183         return $object;
184     }
185
186
187     public function activityObjectFromNotice(Notice $notice)
188     {
189         $fave = Fave::fromStored($notice);
190         return $fave->asActivityObject();
191     }
192
193     public function deleteRelated(Notice $notice)
194     {
195         try {
196             $fave = Fave::fromStored($notice);
197             $fave->delete();
198         } catch (NoResultException $e) {
199             // Cool, no problem. We wanted to get rid of it anyway.
200         }
201     }
202
203     // API stuff
204
205     /**
206      * Typically just used to fill out Twitter-compatible API status data.
207      *
208      * FIXME: Make all the calls before this end up with a Notice instead of ArrayWrapper please...
209      */
210     public function onNoticeSimpleStatusArray($notice, array &$status, Profile $scoped=null, array $args=array())
211     {
212         if ($scoped instanceof Profile) {
213             $status['favorited'] = Fave::existsForProfile($notice, $scoped);
214         } else {
215             $status['favorited'] = false;
216         }
217         return true;
218     }
219
220     public function onTwitterUserArray(Profile $profile, array &$userdata, Profile $scoped=null, array $args=array())
221     {
222         $userdata['favourites_count'] = Fave::countByProfile($profile);
223     }
224
225     /**
226      * Typically just used to fill out StatusNet specific data in API calls in the referenced $info array.
227      */
228     public function onStatusNetApiNoticeInfo(Notice $notice, array &$info, Profile $scoped=null, array $args=array())
229     {
230         if ($scoped instanceof Profile) {
231             $info['favorite'] = Fave::existsForProfile($notice, $scoped) ? 'true' : 'false';
232         }
233         return true;
234     }
235     
236     public function onNoticeDeleteRelated(Notice $notice)
237     {
238         parent::onNoticeDeleteRelated($notice);
239
240         // The below algorithm is because we want to delete fave
241         // activities on any notice which _has_ faves, and not as
242         // in the parent function only ones that _are_ faves.
243
244         $fave = new Fave();
245         $fave->notice_id = $notice->id;
246
247         if ($fave->find()) {
248             while ($fave->fetch()) {
249                 $fave->delete();
250             }
251         }
252
253         $fave->free();
254     }
255
256     public function onUserDeleteRelated(User $user, array &$related)
257     {
258         $fave = new Fave();
259         $fave->user_id = $user->id;
260         $fave->delete();    // Will perform a DELETE matching "user_id = {$user->id}"
261
262         Fave::blowCacheForProfileId($user->id);
263         return true;
264     }
265
266     public function onStartNoticeListPrefill(array &$notices, array $notice_ids, Profile $scoped=null)
267     {
268         // prefill array of objects, before pluginfication it was Notice::fillFaves($notices)
269         Fave::fillFaves($notice_ids);
270
271         // DB caching
272         if ($scoped instanceof Profile) {
273             Fave::pivotGet('notice_id', $notice_ids, array('user_id' => $scoped->id));
274         }
275     }
276
277     /**
278      * show the "favorite" form in the notice options element
279      * FIXME: Don't let a NoticeListItemAdapter slip in here (or extend that from NoticeListItem)
280      *
281      * @return void
282      */
283     public function onStartShowNoticeOptionItems($nli)
284     {
285         if (Event::handle('StartShowFaveForm', array($nli))) {
286             $scoped = Profile::current();
287             if ($scoped instanceof Profile) {
288                 if (Fave::existsForProfile($nli->notice, $scoped)) {
289                     $disfavor = new DisfavorForm($nli->out, $nli->notice);
290                     $disfavor->show();
291                 } else {
292                     $favor = new FavorForm($nli->out, $nli->notice);
293                     $favor->show();
294                 }
295             }
296             Event::handle('EndShowFaveForm', array($nli));
297         }
298     }
299
300     public function onAppendUserActivityStreamObjects(UserActivityStream $uas, array &$objs)
301     {
302         $faves = array();
303         $fave = new Fave();
304         $fave->user_id = $uas->user->id;
305
306         if (!empty($uas->after)) {
307             $fave->whereAdd("modified > '" . common_sql_date($uas->after) . "'");
308         }
309
310         if ($fave->find()) {
311             while ($fave->fetch()) {
312                 $faves[] = clone($fave);
313             }
314         }
315
316         return $faves;
317     }
318
319     public function onStartShowThreadedNoticeTailItems(NoticeListItem $nli, Notice $notice, &$threadActive)
320     {
321         if ($nli instanceof ThreadedNoticeListSubItem) {
322             // The sub-items are replies to a conversation, thus we use different HTML elements etc.
323             $item = new ThreadedNoticeListInlineFavesItem($notice, $nli->out);
324         } else {
325             $item = new ThreadedNoticeListFavesItem($notice, $nli->out);
326         }
327         $threadActive = $item->show() || $threadActive;
328         return true;
329     }
330
331     /**
332      * EndInterpretCommand for FavoritePlugin will handle the 'fav' command
333      * using the class FavCommand.
334      *
335      * @param string  $cmd     Command being run
336      * @param string  $arg     Rest of the message (including address)
337      * @param User    $user    User sending the message
338      * @param Command &$result The resulting command object to be run.
339      *
340      * @return boolean hook value
341      */
342     public function onStartInterpretCommand($cmd, $arg, $user, &$result)
343     {
344         if ($result === false && $cmd == 'fav') {
345             if (empty($arg)) {
346                 $result = null;
347             } else {
348                 list($other, $extra) = $this->split_arg($arg);
349                 if (!empty($extra)) {
350                     $result = null;
351                 } else {
352                     $result = new FavCommand($user, $other);
353                 }
354             }
355             return false;
356         }
357         return true;
358     }
359
360     public function onHelpCommandMessages(HelpCommand $help, array &$commands)
361     {
362         // TRANS: Help message for IM/SMS command "fav <nickname>".
363         $commands['fav <nickname>'] = _m('COMMANDHELP', "add user's last notice as a 'fave'");
364         // TRANS: Help message for IM/SMS command "fav #<notice_id>".
365         $commands['fav #<notice_id>'] = _m('COMMANDHELP', "add notice with the given id as a 'fave'");
366     }
367
368     /**
369      * Are we allowed to perform a certain command over the API?
370      */
371     public function onCommandSupportedAPI(Command $cmd, array &$supported)
372     {
373         $supported = $supported || $cmd instanceof FavCommand;
374     }
375
376     // Layout stuff
377
378     public function onEndPersonalGroupNav(Menu $menu, Profile $target, Profile $scoped=null)
379     {
380         $menu->out->menuItem(common_local_url('showfavorites', array('nickname' => $target->getNickname())),
381                              // TRANS: Menu item in personal group navigation menu.
382                              _m('MENU','Favorites'),
383                              // @todo i18n FIXME: Need to make this two messages.
384                              // TRANS: Menu item title in personal group navigation menu.
385                              // TRANS: %s is a username.
386                              sprintf(_('%s\'s favorite notices'), $target->getBestName()),
387                              $scoped instanceof Profile && $target->id === $scoped->id && $menu->actionName =='showfavorites',
388                             'nav_timeline_favorites');
389     }
390
391     public function onEndPublicGroupNav(Menu $menu)
392     {
393         if (!common_config('singleuser', 'enabled')) {
394             // TRANS: Menu item in search group navigation panel.
395             $menu->out->menuItem(common_local_url('favorited'), _m('MENU','Popular'),
396                                  // TRANS: Menu item title in search group navigation panel.
397                                  _('Popular notices'), $menu->actionName == 'favorited', 'nav_timeline_favorited');
398         }
399     }
400
401     public function onEndShowSections(Action $action)
402     {
403         if (!$action->isAction(array('all', 'public'))) {
404             return true;
405         }
406
407         if (!common_config('performance', 'high')) {
408             $section = new PopularNoticeSection($action, $action->getScoped());
409             $section->show();
410         }
411     }
412
413     public function onPluginVersion(array &$versions)
414     {
415         $versions[] = array('name' => 'Favorite',
416                             'version' => GNUSOCIAL_VERSION,
417                             'author' => 'Mikael Nordfeldth',
418                             'homepage' => 'http://gnu.io/',
419                             'rawdescription' =>
420                             // TRANS: Plugin description.
421                             _m('Favorites (likes) using ActivityStreams.'));
422
423         return true;
424     }
425 }