3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2011, StatusNet, Inc.
6 * A plugin to enable local tab subscription
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Affero General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Affero General Public License for more details.
20 * You should have received a copy of the GNU Affero General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 * @category TagSubPlugin
25 * @author Brion Vibber <brion@status.net>
26 * @copyright 2011 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
36 * TagSub plugin main class
38 * @category TagSubPlugin
40 * @author Brion Vibber <brionv@status.net>
41 * @copyright 2011 StatusNet, Inc.
42 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
43 * @link http://status.net/
45 class TagSubPlugin extends Plugin
47 const VERSION = '0.1';
50 * Database schema setup
54 * @return boolean hook value; true means continue processing, false means stop.
56 function onCheckSchema()
58 $schema = Schema::get();
59 $schema->ensureTable('tagsub', TagSub::schemaDef());
66 * @param URLMapper $m path-to-action mapper
68 * @return boolean hook value; true means continue processing, false means stop.
70 public function onRouterInitialized(URLMapper $m)
72 $m->connect('tag/:tag/subscribe',
73 array('action' => 'tagsub'),
74 array('tag' => Router::REGEX_TAG));
75 $m->connect('tag/:tag/unsubscribe',
76 array('action' => 'tagunsub'),
77 array('tag' => Router::REGEX_TAG));
79 $m->connect(':nickname/tag-subscriptions',
80 array('action' => 'tagsubs'),
81 array('nickname' => Nickname::DISPLAY_FMT));
88 * @param array &$versions array of version data
92 function onPluginVersion(&$versions)
94 $versions[] = array('name' => 'TagSub',
95 'version' => self::VERSION,
96 'author' => 'Brion Vibber',
97 'homepage' => 'http://status.net/wiki/Plugin:TagSub',
99 // TRANS: Plugin description.
100 _m('Plugin to allow following all messages with a given tag.'));
105 * Hook inbox delivery setup so tag subscribers receive all
106 * notices with that tag in their inbox.
108 * Currently makes no distinction between local messages and
109 * remote ones which happen to come in to the system. Remote
110 * notices that don't come in at all won't ever reach this.
112 * @param Notice $notice
113 * @param array $ni in/out map of profile IDs to inbox constants
114 * @return boolean hook result
116 function onStartNoticeWhoGets(Notice $notice, array &$ni)
118 foreach ($notice->getTags() as $tag) {
119 $tagsub = new TagSub();
123 while ($tagsub->fetch()) {
124 // These constants are currently not actually used, iirc
125 $ni[$tagsub->profile_id] = NOTICE_INBOX_SOURCE_SUB;
133 * @param TagAction $action
134 * @return boolean hook result
136 function onStartTagShowContent(TagAction $action)
138 $user = common_current_user();
140 $tag = $action->trimmed('tag');
141 $tagsub = TagSub::pkeyGet(array('tag' => $tag,
142 'profile_id' => $user->id));
144 $form = new TagUnsubForm($action, $tag);
146 $form = new TagSubForm($action, $tag);
148 $action->elementStart('div', 'entity_actions');
149 $action->elementStart('ul');
150 $action->elementStart('li', 'entity_subscribe');
152 $action->elementEnd('li');
153 $action->elementEnd('ul');
154 $action->elementEnd('div');
160 * Menu item for personal subscriptions/groups area
162 * @param Widget $widget Widget being executed
164 * @return boolean hook return
166 function onEndSubGroupNav($widget)
168 $action = $widget->out;
169 $action_name = $action->trimmed('action');
171 $action->menuItem(common_local_url('tagsubs', array('nickname' => $action->user->nickname)),
172 // TRANS: SubMirror plugin menu item on user settings page.
174 // TRANS: SubMirror plugin tooltip for user settings menu item.
175 _m('Configure tag subscriptions'),
176 $action_name == 'tagsubs' && $action->arg('nickname') == $action->user->nickname);
181 function onEndDefaultLocalNav($menu, $user)
183 $user = common_current_user();
187 $tags = TagSub::forProfile($user->getProfile());
189 if (!empty($tags) && count($tags) > 0) {
190 $tagSubMenu = new TagSubMenu($menu->out, $user, $tags);
191 // TRANS: Menu item text for tags submenu.
192 $menu->submenu(_m('Tags'), $tagSubMenu);