plugins/TagSub/TagSubPlugin.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  TagSubPlugin
  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  * TagSub plugin main class
  37  *
  38  * @category  TagSubPlugin
  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 TagSubPlugin 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('tagsub', TagSub::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 'TagSub':
  77             include_once $dir.'/'.$cls.'.php';
  78             return false;
  79         case 'TagsubAction':
  80         case 'TagunsubAction':
  81         case 'TagsubsAction':
  82         case 'TagSubForm':
  83         case 'TagSubMenu':
  84         case 'TagUnsubForm':
  85             include_once $dir.'/'.strtolower($cls).'.php';
  86             return false;
  87         default:
  88             return true;
  89         }
  90     }
  91
  92     /**
  93      * Map URLs to actions
  94      *
  95      * @param Net_URL_Mapper $m path-to-action mapper
  96      *
  97      * @return boolean hook value; true means continue processing, false means stop.
  98      */
  99     function onRouterInitialized($m)
 100     {
 101         $m->connect('tag/:tag/subscribe',
 102                     array('action' => 'tagsub'),
 103                     array('tag' => Router::REGEX_TAG));
 104         $m->connect('tag/:tag/unsubscribe',
 105                     array('action' => 'tagunsub'),
 106                     array('tag' => Router::REGEX_TAG));
 107
 108         $m->connect(':nickname/tag-subscriptions',
 109                     array('action' => 'tagsubs'),
 110                     array('nickname' => Nickname::DISPLAY_FMT));
 111         return true;
 112     }
 113
 114     /**
 115      * Plugin version data
 116      *
 117      * @param array &$versions array of version data
 118      *
 119      * @return value
 120      */
 121     function onPluginVersion(&$versions)
 122     {
 123         $versions[] = array('name' => 'TagSub',
 124                             'version' => self::VERSION,
 125                             'author' => 'Brion Vibber',
 126                             'homepage' => 'http://status.net/wiki/Plugin:TagSub',
 127                             'rawdescription' =>
 128                             // TRANS: Plugin description.
 129                             _m('Plugin to allow following all messages with a given tag.'));
 130         return true;
 131     }
 132
 133     /**
 134      * Hook inbox delivery setup so tag subscribers receive all
 135      * notices with that tag in their inbox.
 136      *
 137      * Currently makes no distinction between local messages and
 138      * remote ones which happen to come in to the system. Remote
 139      * notices that don't come in at all won't ever reach this.
 140      *
 141      * @param Notice $notice
 142      * @param array $ni in/out map of profile IDs to inbox constants
 143      * @return boolean hook result
 144      */
 145     function onStartNoticeWhoGets(Notice $notice, array &$ni)
 146     {
 147         foreach ($notice->getTags() as $tag) {
 148             $tagsub = new TagSub();
 149             $tagsub->tag = $tag;
 150             $tagsub->find();
 151
 152             while ($tagsub->fetch()) {
 153                 // These constants are currently not actually used, iirc
 154                 $ni[$tagsub->profile_id] = NOTICE_INBOX_SOURCE_SUB;
 155             }
 156         }
 157         return true;
 158     }
 159
 160     /**
 161      *
 162      * @param TagAction $action
 163      * @return boolean hook result
 164      */
 165     function onStartTagShowContent(TagAction $action)
 166     {
 167         $user = common_current_user();
 168         if ($user) {
 169             $tag = $action->trimmed('tag');
 170             $tagsub = TagSub::pkeyGet(array('tag' => $tag,
 171                                             'profile_id' => $user->id));
 172             if ($tagsub) {
 173                 $form = new TagUnsubForm($action, $tag);
 174             } else {
 175                 $form = new TagSubForm($action, $tag);
 176             }
 177             $action->elementStart('div', 'entity_actions');
 178             $action->elementStart('ul');
 179             $action->elementStart('li', 'entity_subscribe');
 180             $form->show();
 181             $action->elementEnd('li');
 182             $action->elementEnd('ul');
 183             $action->elementEnd('div');
 184         }
 185         return true;
 186     }
 187
 188     /**
 189      * Menu item for personal subscriptions/groups area
 190      *
 191      * @param Widget $widget Widget being executed
 192      *
 193      * @return boolean hook return
 194      */
 195     function onEndSubGroupNav($widget)
 196     {
 197         $action = $widget->out;
 198         $action_name = $action->trimmed('action');
 199
 200         $action->menuItem(common_local_url('tagsubs', array('nickname' => $action->user->nickname)),
 201                           // TRANS: SubMirror plugin menu item on user settings page.
 202                           _m('MENU', 'Tags'),
 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);
 206
 207         return true;
 208     }
 209
 210     function onEndDefaultLocalNav($menu, $user)
 211     {
 212         $user = common_current_user();
 213
 214         if (!empty($user)) {
 215
 216             $tags = TagSub::forProfile($user->getProfile());
 217
 218             if (!empty($tags) && count($tags) > 0) {
 219                 $tagSubMenu = new TagSubMenu($menu->out, $user, $tags);
 220                 // TRANS: Menu item text for tags submenu.
 221                 $menu->submenu(_m('Tags'), $tagSubMenu);
 222             }
 223         }
 224
 225         return true;
 226     }
 227 }