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); }
24 * @maintainer Mikael Nordfeldth <mmn@hethane.se>
26 class FavoritePlugin extends ActivityHandlerPlugin
33 public function types()
38 public function verbs()
40 return array(ActivityVerb::FAVORITE);
43 public function onCheckSchema()
45 $schema = Schema::get();
46 $schema->ensureTable('fave', Fave::schemaDef());
50 public function onEndUpgrade()
52 printfnq("Ensuring all faves have a URI...");
55 $fave->whereAdd('uri IS NULL');
58 while ($fave->fetch()) {
61 $fave->query(sprintf('UPDATE fave '.
64 'WHERE user_id = %d '.
66 Fave::newURI($fave->user_id, $fave->notice_id, $fave->modified),
67 common_sql_date(strtotime($fave->modified)),
70 } catch (Exception $e) {
71 common_log(LOG_ERR, "Error updating fave URI: " . $e->getMessage());
79 public function onRouterInitialized(URLMapper $m)
82 $m->connect('main/favor', array('action' => 'favor'));
83 $m->connect('main/disfavor', array('action' => 'disfavor'));
85 if (common_config('singleuser', 'enabled')) {
86 $nickname = User::singleUserNickname();
88 $m->connect('favorites',
89 array('action' => 'showfavorites',
90 'nickname' => $nickname));
91 $m->connect('favoritesrss',
92 array('action' => 'favoritesrss',
93 'nickname' => $nickname));
95 $m->connect('favoritedrss', array('action' => 'favoritedrss'));
96 $m->connect('favorited/', array('action' => 'favorited'));
97 $m->connect('favorited', array('action' => 'favorited'));
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));
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',
127 'format' => '(xml|json)'));
128 $m->connect('api/favorites/destroy/:id.:format',
129 array('action' => 'ApiFavoriteDestroy',
131 'format' => '(xml|json)'));
134 $m->connect('api/statusnet/app/favorites/:profile/:notice.atom',
135 array('action' => 'AtomPubShowFavorite'),
136 array('profile' => '[0-9]+',
137 'notice' => '[0-9]+'));
139 $m->connect('api/statusnet/app/favorites/:profile.atom',
140 array('action' => 'AtomPubFavoriteFeed'),
141 array('profile' => '[0-9]+'));
143 // Required for qvitter API
144 $m->connect('api/statuses/favs/:id.:format',
145 array('action' => 'ApiStatusesFavs',
147 'format' => '(xml|json)'));
150 // FIXME: Set this to abstract public in lib/activityhandlerplugin.php ddwhen all plugins have migrated!
151 protected function saveObjectFromActivity(Activity $act, Notice $stored, array $options=array())
153 assert($this->isMyActivity($act));
155 // If empty, we should've created it ourselves on our node.
156 if (!isset($options['created'])) {
157 $options['created'] = !empty($act->time) ? common_sql_date($act->time) : common_sql_now();
159 if (!isset($options['uri'])) {
160 $options['uri'] = !empty($act->id) ? $act->id : $act->selfLink;
163 // We must have an objects[0] here because in isMyActivity we require the count to be == 1
164 $actobj = $act->objects[0];
167 $object = Fave::saveActivityObject($actobj, $stored);
168 } catch (ServerException $e) {
169 // Probably that the favored notice doesn't exist in our local database
170 // but may also be some missing profile or so, which we could catch in a
171 // more explicit catch-statement.
174 common_debug(get_called_class().' returning '.get_class($object).' object with uri: '.$object->uri);
179 public function activityObjectFromNotice(Notice $notice)
181 $fave = Fave::fromStored($notice);
182 return $fave->asActivityObject();
185 public function deleteRelated(Notice $notice)
188 $fave = Fave::fromStored($notice);
190 } catch (NoResultException $e) {
191 // Cool, no problem. We wanted to get rid of it anyway.
198 * Typically just used to fill out Twitter-compatible API status data.
200 * FIXME: Make all the calls before this end up with a Notice instead of ArrayWrapper please...
202 public function onNoticeSimpleStatusArray($notice, array &$status, Profile $scoped=null, array $args=array())
204 if ($scoped instanceof Profile) {
205 $status['favorited'] = Fave::existsForProfile($notice, $scoped);
207 $status['favorited'] = false;
212 public function onTwitterUserArray(Profile $profile, array &$userdata, Profile $scoped=null, array $args=array())
214 $userdata['favourites_count'] = Fave::countByProfile($profile);
218 * Typically just used to fill out StatusNet specific data in API calls in the referenced $info array.
220 public function onStatusNetApiNoticeInfo(Notice $notice, array &$info, Profile $scoped=null, array $args=array())
222 if ($scoped instanceof Profile) {
223 $info['favorite'] = Fave::existsForProfile($notice, $scoped) ? 'true' : 'false';
228 public function onNoticeDeleteRelated(Notice $notice)
230 parent::onNoticeDeleteRelated($notice);
232 // The below algorithm is because we want to delete fave
233 // activities on any notice which _has_ faves, and not as
234 // in the parent function only ones that _are_ faves.
237 $fave->notice_id = $notice->id;
240 while ($fave->fetch()) {
248 public function onUserDeleteRelated(User $user, array &$related)
251 $fave->user_id = $user->id;
252 $fave->delete(); // Will perform a DELETE matching "user_id = {$user->id}"
254 Fave::blowCacheForProfileId($user->id);
258 public function onStartNoticeListPrefill(array &$notices, array $notice_ids, Profile $scoped=null)
260 // prefill array of objects, before pluginfication it was Notice::fillFaves($notices)
261 Fave::fillFaves($notice_ids);
264 if ($scoped instanceof Profile) {
265 Fave::pivotGet('notice_id', $notice_ids, array('user_id' => $scoped->id));
270 * show the "favorite" form in the notice options element
271 * FIXME: Don't let a NoticeListItemAdapter slip in here (or extend that from NoticeListItem)
275 public function onStartShowNoticeOptionItems($nli)
277 if (Event::handle('StartShowFaveForm', array($nli))) {
278 $scoped = Profile::current();
279 if ($scoped instanceof Profile) {
280 if (Fave::existsForProfile($nli->notice, $scoped)) {
281 $disfavor = new DisfavorForm($nli->out, $nli->notice);
284 $favor = new FavorForm($nli->out, $nli->notice);
288 Event::handle('EndShowFaveForm', array($nli));
292 public function onAppendUserActivityStreamObjects(UserActivityStream $uas, array &$objs)
296 $fave->user_id = $uas->user->id;
298 if (!empty($uas->after)) {
299 $fave->whereAdd("modified > '" . common_sql_date($uas->after) . "'");
303 while ($fave->fetch()) {
304 $faves[] = clone($fave);
311 public function onStartShowThreadedNoticeTailItems(NoticeListItem $nli, Notice $notice, &$threadActive)
313 if ($nli instanceof ThreadedNoticeListSubItem) {
314 // The sub-items are replies to a conversation, thus we use different HTML elements etc.
315 $item = new ThreadedNoticeListInlineFavesItem($notice, $nli->out);
317 $item = new ThreadedNoticeListFavesItem($notice, $nli->out);
319 $threadActive = $item->show() || $threadActive;
324 * EndInterpretCommand for FavoritePlugin will handle the 'fav' command
325 * using the class FavCommand.
327 * @param string $cmd Command being run
328 * @param string $arg Rest of the message (including address)
329 * @param User $user User sending the message
330 * @param Command &$result The resulting command object to be run.
332 * @return boolean hook value
334 public function onStartInterpretCommand($cmd, $arg, $user, &$result)
336 if ($result === false && $cmd == 'fav') {
340 list($other, $extra) = $this->split_arg($arg);
341 if (!empty($extra)) {
344 $result = new FavCommand($user, $other);
352 public function onHelpCommandMessages(HelpCommand $help, array &$commands)
354 // TRANS: Help message for IM/SMS command "fav <nickname>".
355 $commands['fav <nickname>'] = _m('COMMANDHELP', "add user's last notice as a 'fave'");
356 // TRANS: Help message for IM/SMS command "fav #<notice_id>".
357 $commands['fav #<notice_id>'] = _m('COMMANDHELP', "add notice with the given id as a 'fave'");
361 * Are we allowed to perform a certain command over the API?
363 public function onCommandSupportedAPI(Command $cmd, array &$supported)
365 $supported = $supported || $cmd instanceof FavCommand;
370 public function onEndPersonalGroupNav(Menu $menu, Profile $target, Profile $scoped=null)
372 $menu->out->menuItem(common_local_url('showfavorites', array('nickname' => $target->getNickname())),
373 // TRANS: Menu item in personal group navigation menu.
374 _m('MENU','Favorites'),
375 // @todo i18n FIXME: Need to make this two messages.
376 // TRANS: Menu item title in personal group navigation menu.
377 // TRANS: %s is a username.
378 sprintf(_('%s\'s favorite notices'), $target->getBestName()),
379 $scoped instanceof Profile && $target->id === $scoped->id && $menu->actionName =='showfavorites',
380 'nav_timeline_favorites');
383 public function onEndPublicGroupNav(Menu $menu)
385 if (!common_config('singleuser', 'enabled')) {
386 // TRANS: Menu item in search group navigation panel.
387 $menu->out->menuItem(common_local_url('favorited'), _m('MENU','Popular'),
388 // TRANS: Menu item title in search group navigation panel.
389 _('Popular notices'), $menu->actionName == 'favorited', 'nav_timeline_favorited');
393 public function onEndShowSections(Action $action)
395 if (!$action->isAction(array('all', 'public'))) {
399 if (!common_config('performance', 'high')) {
400 $section = new PopularNoticeSection($action, $action->getScoped());
405 public function onPluginVersion(array &$versions)
407 $versions[] = array('name' => 'Favorite',
408 'version' => GNUSOCIAL_VERSION,
409 'author' => 'Mikael Nordfeldth',
410 'homepage' => 'http://gnu.io/',
412 // TRANS: Plugin description.
413 _m('Favorites (likes) using ActivityStreams.'));