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 'TagSubForm':
  82         case 'TagUnsubForm':
  83             include_once $dir.'/'.strtolower($cls).'.php';
  84             return false;
  85         default:
  86             return true;
  87         }
  88     }
  89
  90     /**
  91      * Map URLs to actions
  92      *
  93      * @param Net_URL_Mapper $m path-to-action mapper
  94      *
  95      * @return boolean hook value; true means continue processing, false means stop.
  96      */
  97     function onRouterInitialized($m)
  98     {
  99         $m->connect('tag/:tag/subscribe',
 100                     array('action' => 'tagsub'),
 101                     array('tag' => Router::REGEX_TAG));
 102         $m->connect('tag/:tag/unsubscribe',
 103                     array('action' => 'tagunsub'),
 104                     array('tag' => Router::REGEX_TAG));
 105
 106         return true;
 107     }
 108
 109     /**
 110      * Plugin version data
 111      *
 112      * @param array &$versions array of version data
 113      *
 114      * @return value
 115      */
 116     function onPluginVersion(&$versions)
 117     {
 118         $versions[] = array('name' => 'TagSub',
 119                             'version' => self::VERSION,
 120                             'author' => 'Brion Vibber',
 121                             'homepage' => 'http://status.net/wiki/Plugin:TagSub',
 122                             'rawdescription' =>
 123                             // TRANS: Plugin description.
 124                             _m('Plugin to allow following all messages with a given tag.'));
 125         return true;
 126     }
 127
 128     /**
 129      * Hook inbox delivery setup so tag subscribers receive all
 130      * notices with that tag in their inbox.
 131      *
 132      * Currently makes no distinction between local messages and
 133      * remote ones which happen to come in to the system. Remote
 134      * notices that don't come in at all won't ever reach this.
 135      *
 136      * @param Notice $notice
 137      * @param array $ni in/out map of profile IDs to inbox constants
 138      * @return boolean hook result
 139      */
 140     function onStartNoticeWhoGets(Notice $notice, array &$ni)
 141     {
 142         foreach ($notice->getTags() as $tag) {
 143             $tagsub = new TagSub();
 144             $tagsub->tag = $tag;
 145             $tagsub->find();
 146
 147             while ($tagsub->fetch()) {
 148                 // These constants are currently not actually used, iirc
 149                 $ni[$tagsub->profile_id] = NOTICE_INBOX_SOURCE_SUB;
 150             }
 151         }
 152         return true;
 153     }
 154
 155     /**
 156      *
 157      * @param TagAction $action
 158      * @return boolean hook result
 159      */
 160     function onStartTagShowContent(TagAction $action)
 161     {
 162         $user = common_current_user();
 163         if ($user) {
 164             $tag = $action->trimmed('tag');
 165             $tagsub = TagSub::pkeyGet(array('tag' => $tag,
 166                                             'profile_id' => $user->id));
 167             if ($tagsub) {
 168                 $form = new TagUnsubForm($action, $tag);
 169             } else {
 170                 $form = new TagSubForm($action, $tag);
 171             }
 172             $action->elementStart('div', 'entity_actions');
 173             $action->elementStart('ul');
 174             $action->elementStart('li', 'entity_subscribe');
 175             $form->show();
 176             $action->elementEnd('li');
 177             $action->elementEnd('ul');
 178             $action->elementEnd('div');
 179         }
 180         return true;
 181     }
 182 }