plugins/SearchSub/SearchSubPlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * A plugin to enable local tab subscription
   7  *
   8  * PHP version 5
   9  *
  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.
  14  *
  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.
  19  *
  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/>.
  22  *
  23  * @category  SearchSubPlugin
  24  * @package   StatusNet
  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/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * SearchSub plugin main class
  37  *
  38  * @category  SearchSubPlugin
  39  * @package   StatusNet
  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/
  44  */
  45 class SearchSubPlugin extends Plugin
  46 {
  47     const VERSION         = '0.1';
  48
  49     /**
  50      * Database schema setup
  51      *
  52      * @see Schema
  53      *
  54      * @return boolean hook value; true means continue processing, false means stop.
  55      */
  56     function onCheckSchema()
  57     {
  58         $schema = Schema::get();
  59         $schema->ensureTable('searchsub', SearchSub::schemaDef());
  60         return true;
  61     }
  62
  63     /**
  64      * Load related modules when needed
  65      *
  66      * @param string $cls Name of the class to be loaded
  67      *
  68      * @return boolean hook value; true means continue processing, false means stop.
  69      */
  70     function onAutoload($cls)
  71     {
  72         $dir = dirname(__FILE__);
  73
  74         switch ($cls)
  75         {
  76         case 'SearchSub':
  77             include_once $dir.'/'.$cls.'.php';
  78             return false;
  79         case 'SearchsubAction':
  80         case 'SearchunsubAction':
  81         case 'SearchsubsAction':
  82         case 'SearchSubForm':
  83         case 'SearchSubMenu':
  84         case 'SearchUnsubForm':
  85         case 'SearchSubTrackCommand':
  86         case 'SearchSubTrackOffCommand':
  87         case 'SearchSubTrackingCommand':
  88         case 'SearchSubUntrackCommand':
  89             include_once $dir.'/'.strtolower($cls).'.php';
  90             return false;
  91         default:
  92             return true;
  93         }
  94     }
  95
  96     /**
  97      * Map URLs to actions
  98      *
  99      * @param Net_URL_Mapper $m path-to-action mapper
 100      *
 101      * @return boolean hook value; true means continue processing, false means stop.
 102      */
 103     function onRouterInitialized($m)
 104     {
 105         $m->connect('search/:search/subscribe',
 106                     array('action' => 'searchsub'),
 107                     array('search' => Router::REGEX_TAG));
 108         $m->connect('search/:search/unsubscribe',
 109                     array('action' => 'searchunsub'),
 110                     array('search' => Router::REGEX_TAG));
 111         $m->connect(':nickname/search-subscriptions',
 112                     array('action' => 'searchsubs'),
 113                     array('nickname' => Nickname::DISPLAY_FMT));
 114         return true;
 115     }
 116
 117     /**
 118      * Plugin version data
 119      *
 120      * @param array &$versions array of version data
 121      *
 122      * @return value
 123      */
 124     function onPluginVersion(&$versions)
 125     {
 126         $versions[] = array('name' => 'SearchSub',
 127                             'version' => self::VERSION,
 128                             'author' => 'Brion Vibber',
 129                             'homepage' => 'http://status.net/wiki/Plugin:SearchSub',
 130                             'rawdescription' =>
 131                             // TRANS: Plugin description.
 132                             _m('Plugin to allow following all messages with a given search.'));
 133         return true;
 134     }
 135
 136     /**
 137      * Hook inbox delivery setup so search subscribers receive all
 138      * notices with that search in their inbox.
 139      *
 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.
 143      *
 144      * @param Notice $notice
 145      * @param array $ni in/out map of profile IDs to inbox constants
 146      * @return boolean hook result
 147      */
 148     function onStartNoticeWhoGets(Notice $notice, array &$ni)
 149     {
 150         // Warning: this is potentially very slow
 151         // with a lot of searches!
 152         $sub = new SearchSub();
 153         $sub->groupBy('search');
 154         $sub->find();
 155         while ($sub->fetch()) {
 156             $search = $sub->search;
 157
 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;
 163                 $searchsub->find();
 164
 165                 while ($searchsub->fetch()) {
 166                     // These constants are currently not actually used, iirc
 167                     $ni[$searchsub->profile_id] = NOTICE_INBOX_SOURCE_SUB;
 168                 }
 169             }
 170         }
 171         return true;
 172     }
 173
 174     /**
 175      * Does the given notice match the given fulltext search query?
 176      *
 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.
 181      *
 182      * @param Notice $notice
 183      * @param string $search
 184      * @return boolean
 185      */
 186     function matchSearch(Notice $notice, $search)
 187     {
 188         return (mb_stripos($notice->content, $search) !== false);
 189     }
 190
 191     /**
 192      *
 193      * @param NoticeSearchAction $action
 194      * @param string $q
 195      * @param Notice $notice
 196      * @return boolean hook result
 197      */
 198     function onStartNoticeSearchShowResults($action, $q, $notice)
 199     {
 200         $user = common_current_user();
 201         if ($user) {
 202             $search = $q;
 203             $searchsub = SearchSub::pkeyGet(array('search' => $search,
 204                                                   'profile_id' => $user->id));
 205             if ($searchsub) {
 206                 $form = new SearchUnsubForm($action, $search);
 207             } else {
 208                 $form = new SearchSubForm($action, $search);
 209             }
 210             $action->elementStart('div', 'entity_actions');
 211             $action->elementStart('ul');
 212             $action->elementStart('li', 'entity_subscribe');
 213             $form->show();
 214             $action->elementEnd('li');
 215             $action->elementEnd('ul');
 216             $action->elementEnd('div');
 217         }
 218         return true;
 219     }
 220
 221     /**
 222      * Menu item for personal subscriptions/groups area
 223      *
 224      * @param Widget $widget Widget being executed
 225      *
 226      * @return boolean hook return
 227      */
 228     function onEndSubGroupNav($widget)
 229     {
 230         $action = $widget->out;
 231         $action_name = $action->trimmed('action');
 232
 233         $action->menuItem(common_local_url('searchsubs', array('nickname' => $action->user->nickname)),
 234                           // TRANS: SearchSub plugin menu item on user settings page.
 235                           _m('MENU', 'Searches'),
 236                           // TRANS: SearchSub plugin tooltip for user settings menu item.
 237                           _m('Configure search subscriptions'),
 238                           $action_name == 'searchsubs' && $action->arg('nickname') == $action->user->nickname);
 239
 240         return true;
 241     }
 242
 243     /**
 244      * Replace the built-in stub track commands with ones that control
 245      * search subscriptions.
 246      *
 247      * @param CommandInterpreter $cmd
 248      * @param string $arg
 249      * @param User $user
 250      * @param Command $result
 251      * @return boolean hook result
 252      */
 253     function onEndInterpretCommand($cmd, $arg, $user, &$result)
 254     {
 255         if ($result instanceof TrackCommand) {
 256             $result = new SearchSubTrackCommand($user, $arg);
 257             return false;
 258         } else if ($result instanceof TrackOffCommand) {
 259             $result = new SearchSubTrackOffCommand($user);
 260             return false;
 261         } else if ($result instanceof TrackingCommand) {
 262             $result = new SearchSubTrackingCommand($user);
 263             return false;
 264         } else if ($result instanceof UntrackCommand) {
 265             $result = new SearchSubUntrackCommand($user, $arg);
 266             return false;
 267         } else {
 268             return true;
 269         }
 270     }
 271
 272     function onHelpCommandMessages($cmd, &$commands)
 273     {
 274         // TRANS: Help message for IM/SMS command "track <word>"
 275         $commands["track <word>"] = _m('COMMANDHELP', "Start following notices matching the given search query.");
 276         // TRANS: Help message for IM/SMS command "untrack <word>"
 277         $commands["untrack <word>"] = _m('COMMANDHELP', "Stop following notices matching the given search query.");
 278         // TRANS: Help message for IM/SMS command "track off"
 279         $commands["track off"] = _m('COMMANDHELP', "Disable all tracked search subscriptions.");
 280         // TRANS: Help message for IM/SMS command "untrack all"
 281         $commands["untrack all"] = _m('COMMANDHELP', "Disable all tracked search subscriptions.");
 282         // TRANS: Help message for IM/SMS command "tracks"
 283         $commands["tracks"] = _m('COMMANDHELP', "List all your search subscriptions.");
 284         // TRANS: Help message for IM/SMS command "tracking"
 285         $commands["tracking"] = _m('COMMANDHELP', "List all your search subscriptions.");
 286     }
 287
 288     function onEndDefaultLocalNav($menu, $user)
 289     {
 290         $user = common_current_user();
 291
 292         if (!empty($user)) {
 293             $searches = SearchSub::forProfile($user->getProfile());
 294
 295             if (!empty($searches) && count($searches) > 0) {
 296                 $searchSubMenu = new SearchSubMenu($menu->out, $user, $searches);
 297                 // TRANS: Sub menu for searches.
 298                 $menu->submenu(_m('MENU','Searches'), $searchSubMenu);
 299             }
 300         }
 301
 302         return true;
 303     }
 304 }