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 SearchSubPlugin
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 * SearchSub plugin main class
38 * @category SearchSubPlugin
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 SearchSubPlugin 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('searchsub', SearchSub::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';
79 case 'SearchsubAction':
80 case 'SearchunsubAction':
81 case 'SearchsubsAction':
83 case 'SearchUnsubForm':
84 case 'SearchSubTrackCommand':
85 case 'SearchSubTrackOffCommand':
86 case 'SearchSubTrackingCommand':
87 case 'SearchSubUntrackCommand':
88 include_once $dir.'/'.strtolower($cls).'.php';
98 * @param Net_URL_Mapper $m path-to-action mapper
100 * @return boolean hook value; true means continue processing, false means stop.
102 function onRouterInitialized($m)
104 $m->connect('search/:search/subscribe',
105 array('action' => 'searchsub'),
106 array('search' => Router::REGEX_TAG));
107 $m->connect('search/:search/unsubscribe',
108 array('action' => 'searchunsub'),
109 array('search' => Router::REGEX_TAG));
111 $m->connect(':nickname/search-subscriptions',
112 array('action' => 'searchsubs'),
113 array('nickname' => Nickname::DISPLAY_FMT));
118 * Plugin version data
120 * @param array &$versions array of version data
124 function onPluginVersion(&$versions)
126 $versions[] = array('name' => 'SearchSub',
127 'version' => self::VERSION,
128 'author' => 'Brion Vibber',
129 'homepage' => 'http://status.net/wiki/Plugin:SearchSub',
131 // TRANS: Plugin description.
132 _m('Plugin to allow following all messages with a given search.'));
137 * Hook inbox delivery setup so search subscribers receive all
138 * notices with that search in their inbox.
140 * Currently makes no distinction between local messages and
141 * remote ones which happen to come in to the system. Remote
142 * notices that don't come in at all won't ever reach this.
144 * @param Notice $notice
145 * @param array $ni in/out map of profile IDs to inbox constants
146 * @return boolean hook result
148 function onStartNoticeWhoGets(Notice $notice, array &$ni)
150 // Warning: this is potentially very slow
151 // with a lot of searches!
152 $sub = new SearchSub();
153 $sub->groupBy('search');
155 while ($sub->fetch()) {
156 $search = $sub->search;
158 if ($this->matchSearch($notice, $search)) {
159 // Match? Find all those who subscribed to this
160 // search term and get our delivery on...
161 $searchsub = new SearchSub();
162 $searchsub->search = $search;
165 while ($searchsub->fetch()) {
166 // These constants are currently not actually used, iirc
167 $ni[$searchsub->profile_id] = NOTICE_INBOX_SOURCE_SUB;
175 * Does the given notice match the given fulltext search query?
177 * Warning: not guaranteed to match other search engine behavior, etc.
178 * Currently using a basic case-insensitive substring match, which
179 * probably fits with the 'LIKE' search but not the default MySQL
180 * or Sphinx search backends.
182 * @param Notice $notice
183 * @param string $search
186 function matchSearch(Notice $notice, $search)
188 return (mb_stripos($notice->content, $search) !== false);
193 * @param NoticeSearchAction $action
195 * @param Notice $notice
196 * @return boolean hook result
198 function onStartNoticeSearchShowResults($action, $q, $notice)
200 $user = common_current_user();
203 $searchsub = SearchSub::pkeyGet(array('search' => $search,
204 'profile_id' => $user->id));
206 $form = new SearchUnsubForm($action, $search);
208 $form = new SearchSubForm($action, $search);
210 $action->elementStart('div', 'entity_actions');
211 $action->elementStart('ul');
212 $action->elementStart('li', 'entity_subscribe');
214 $action->elementEnd('li');
215 $action->elementEnd('ul');
216 $action->elementEnd('div');
222 * Menu item for personal subscriptions/groups area
224 * @param Widget $widget Widget being executed
226 * @return boolean hook return
229 function onEndSubGroupNav($widget)
231 $action = $widget->out;
232 $action_name = $action->trimmed('action');
234 $action->menuItem(common_local_url('searchsubs', array('nickname' => $action->user->nickname)),
235 // TRANS: SearchSub plugin menu item on user settings page.
236 _m('MENU', 'Searches'),
237 // TRANS: SearchSub plugin tooltip for user settings menu item.
238 _m('Configure search subscriptions'),
239 $action_name == 'searchsubs' && $action->arg('nickname') == $action->user->nickname);
245 * Add a count of mirrored feeds into a user's profile sidebar stats.
247 * @param Profile $profile
248 * @param array $stats
249 * @return boolean hook return value
251 function onProfileStats($profile, &$stats)
253 $cur = common_current_user();
254 if (!empty($cur) && $cur->id == $profile->id) {
255 $searchsub = new SearchSub();
256 $searchsub ->profile_id = $profile->id;
258 'id' => 'searchsubs',
259 'label' => _m('Search subscriptions'),
260 'link' => common_local_url('searchsubs', array('nickname' => $profile->nickname)),
261 'value' => $searchsub->count(),
264 $insertAt = count($stats);
265 foreach ($stats as $i => $row) {
266 if ($row['id'] == 'groups') {
267 // Slip us in after them.
272 array_splice($stats, $insertAt, 0, array($entry));
278 * Replace the built-in stub track commands with ones that control
279 * search subscriptions.
281 * @param CommandInterpreter $cmd
284 * @param Command $result
285 * @return boolean hook result
287 function onEndInterpretCommand($cmd, $arg, $user, &$result)
289 if ($result instanceof TrackCommand) {
290 $result = new SearchSubTrackCommand($user, $arg);
292 } else if ($result instanceof TrackOffCommand) {
293 $result = new SearchSubTrackOffCommand($user);
295 } else if ($result instanceof TrackingCommand) {
296 $result = new SearchSubTrackingCommand($user);
298 } else if ($result instanceof UntrackCommand) {
299 $result = new SearchSubUntrackCommand($user, $arg);
306 function onHelpCommandMessages($cmd, &$commands)
308 // TRANS: Help message for IM/SMS command "track <word>"
309 $commands["track <word>"] = _m('COMMANDHELP', "Start following notices matching the given search query.");
310 // TRANS: Help message for IM/SMS command "untrack <word>"
311 $commands["untrack <word>"] = _m('COMMANDHELP', "Stop following notices matching the given search query.");
312 // TRANS: Help message for IM/SMS command "track off"
313 $commands["track off"] = _m('COMMANDHELP', "Disable all tracked search subscriptions.");
314 // TRANS: Help message for IM/SMS command "untrack all"
315 $commands["untrack all"] = _m('COMMANDHELP', "Disable all tracked search subscriptions.");
316 // TRANS: Help message for IM/SMS command "tracks"
317 $commands["tracks"] = _m('COMMANDHELP', "List all your search subscriptions.");
318 // TRANS: Help message for IM/SMS command "tracking"
319 $commands["tracking"] = _m('COMMANDHELP', "List all your search subscriptions.");