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());
64 * Load related modules when needed
66 * @param string $cls Name of the class to be loaded
68 * @return boolean hook value; true means continue processing, false means stop.
70 function onAutoload($cls)
72 $dir = dirname(__FILE__);
77 include_once $dir.'/'.$cls.'.php';
80 case 'TagunsubAction':
84 include_once $dir.'/'.strtolower($cls).'.php';
94 * @param Net_URL_Mapper $m path-to-action mapper
96 * @return boolean hook value; true means continue processing, false means stop.
98 function onRouterInitialized($m)
100 $m->connect('tag/:tag/subscribe',
101 array('action' => 'tagsub'),
102 array('tag' => Router::REGEX_TAG));
103 $m->connect('tag/:tag/unsubscribe',
104 array('action' => 'tagunsub'),
105 array('tag' => Router::REGEX_TAG));
107 $m->connect(':nickname/tag-subscriptions',
108 array('action' => 'tagsubs'),
109 array('nickname' => Nickname::DISPLAY_FMT));
114 * Plugin version data
116 * @param array &$versions array of version data
120 function onPluginVersion(&$versions)
122 $versions[] = array('name' => 'TagSub',
123 'version' => self::VERSION,
124 'author' => 'Brion Vibber',
125 'homepage' => 'http://status.net/wiki/Plugin:TagSub',
127 // TRANS: Plugin description.
128 _m('Plugin to allow following all messages with a given tag.'));
133 * Hook inbox delivery setup so tag subscribers receive all
134 * notices with that tag in their inbox.
136 * Currently makes no distinction between local messages and
137 * remote ones which happen to come in to the system. Remote
138 * notices that don't come in at all won't ever reach this.
140 * @param Notice $notice
141 * @param array $ni in/out map of profile IDs to inbox constants
142 * @return boolean hook result
144 function onStartNoticeWhoGets(Notice $notice, array &$ni)
146 foreach ($notice->getTags() as $tag) {
147 $tagsub = new TagSub();
151 while ($tagsub->fetch()) {
152 // These constants are currently not actually used, iirc
153 $ni[$tagsub->profile_id] = NOTICE_INBOX_SOURCE_SUB;
161 * @param TagAction $action
162 * @return boolean hook result
164 function onStartTagShowContent(TagAction $action)
166 $user = common_current_user();
168 $tag = $action->trimmed('tag');
169 $tagsub = TagSub::pkeyGet(array('tag' => $tag,
170 'profile_id' => $user->id));
172 $form = new TagUnsubForm($action, $tag);
174 $form = new TagSubForm($action, $tag);
176 $action->elementStart('div', 'entity_actions');
177 $action->elementStart('ul');
178 $action->elementStart('li', 'entity_subscribe');
180 $action->elementEnd('li');
181 $action->elementEnd('ul');
182 $action->elementEnd('div');
188 * Menu item for personal subscriptions/groups area
190 * @param Widget $widget Widget being executed
192 * @return boolean hook return
195 function onEndSubGroupNav($widget)
197 $action = $widget->out;
198 $action_name = $action->trimmed('action');
200 $action->menuItem(common_local_url('tagsubs', array('nickname' => $action->user->nickname)),
201 // TRANS: SubMirror plugin menu item on user settings page.
203 // TRANS: SubMirror plugin tooltip for user settings menu item.
204 _m('Configure tag subscriptions'),
205 $action_name == 'tagsubs' && $action->arg('nickname') == $action->user->nickname);
211 * Add a count of mirrored feeds into a user's profile sidebar stats.
213 * @param Profile $profile
214 * @param array $stats
215 * @return boolean hook return value
217 function onProfileStats($profile, &$stats)
219 $cur = common_current_user();
220 if (!empty($cur) && $cur->id == $profile->id) {
221 $tagsub = new TagSub();
222 $tagsub->profile_id = $profile->id;
225 'label' => _m('Tag subscriptions'),
226 'link' => common_local_url('tagsubs', array('nickname' => $profile->nickname)),
227 'value' => $tagsub->count(),
230 $insertAt = count($stats);
231 foreach ($stats as $i => $row) {
232 if ($row['id'] == 'groups') {
233 // Slip us in after them.
238 array_splice($stats, $insertAt, 0, array($entry));