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 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('search/:search/subscribe',
101 array('action' => 'searchsub'),
102 array('search' => Router::REGEX_TAG));
103 $m->connect('search/:search/unsubscribe',
104 array('action' => 'searchunsub'),
105 array('search' => Router::REGEX_TAG));
107 $m->connect(':nickname/search-subscriptions',
108 array('action' => 'searchsubs'),
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' => 'SearchSub',
123 'version' => self::VERSION,
124 'author' => 'Brion Vibber',
125 'homepage' => 'http://status.net/wiki/Plugin:SearchSub',
127 // TRANS: Plugin description.
128 _m('Plugin to allow following all messages with a given search.'));
133 * Hook inbox delivery setup so search subscribers receive all
134 * notices with that search 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 // Warning: this is potentially very slow
147 // with a lot of searches!
148 $sub = new SearchSub();
149 $sub->groupBy('search');
151 while ($sub->fetch()) {
152 $search = $sub->search;
154 if ($this->matchSearch($notice, $search)) {
155 // Match? Find all those who subscribed to this
156 // search term and get our delivery on...
157 $searchsub = new SearchSub();
158 $searchsub->search = $search;
161 while ($searchsub->fetch()) {
162 // These constants are currently not actually used, iirc
163 $ni[$searchsub->profile_id] = NOTICE_INBOX_SOURCE_SUB;
171 * Does the given notice match the given fulltext search query?
173 * Warning: not guaranteed to match other search engine behavior, etc.
174 * Currently using a basic case-insensitive substring match, which
175 * probably fits with the 'LIKE' search but not the default MySQL
176 * or Sphinx search backends.
178 * @param Notice $notice
179 * @param string $search
182 function matchSearch(Notice $notice, $search)
184 return (mb_stripos($notice->content, $search) !== false);
189 * @param NoticeSearchAction $action
191 * @param Notice $notice
192 * @return boolean hook result
194 function onStartNoticeSearchShowResults($action, $q, $notice)
196 $user = common_current_user();
199 $searchsub = SearchSub::pkeyGet(array('search' => $search,
200 'profile_id' => $user->id));
202 $form = new SearchUnsubForm($action, $search);
204 $form = new SearchSubForm($action, $search);
206 $action->elementStart('div', 'entity_actions');
207 $action->elementStart('ul');
208 $action->elementStart('li', 'entity_subscribe');
210 $action->elementEnd('li');
211 $action->elementEnd('ul');
212 $action->elementEnd('div');
218 * Menu item for personal subscriptions/groups area
220 * @param Widget $widget Widget being executed
222 * @return boolean hook return
225 function onEndSubGroupNav($widget)
227 $action = $widget->out;
228 $action_name = $action->trimmed('action');
230 $action->menuItem(common_local_url('searchsubs', array('nickname' => $action->user->nickname)),
231 // TRANS: SearchSub plugin menu item on user settings page.
232 _m('MENU', 'Searches'),
233 // TRANS: SearchSub plugin tooltip for user settings menu item.
234 _m('Configure search subscriptions'),
235 $action_name == 'searchsubs' && $action->arg('nickname') == $action->user->nickname);
241 * Add a count of mirrored feeds into a user's profile sidebar stats.
243 * @param Profile $profile
244 * @param array $stats
245 * @return boolean hook return value
247 function onProfileStats($profile, &$stats)
249 $cur = common_current_user();
250 if (!empty($cur) && $cur->id == $profile->id) {
251 $searchsub = new SearchSub();
252 $searchsub ->profile_id = $profile->id;
254 'id' => 'searchsubs',
255 'label' => _m('Search subscriptions'),
256 'link' => common_local_url('searchsubs', array('nickname' => $profile->nickname)),
257 'value' => $searchsub->count(),
260 $insertAt = count($stats);
261 foreach ($stats as $i => $row) {
262 if ($row['id'] == 'groups') {
263 // Slip us in after them.
268 array_splice($stats, $insertAt, 0, array($entry));