plugins/TwitterBridge/TwitterBridgePlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * PHP version 5
   6  *
   7  * LICENCE: This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * @category  Plugin
  21  * @package   StatusNet
  22  * @author    Zach Copley <zach@status.net>
  23  * @copyright 2009 Control Yourself, Inc.
  24  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  25  * @link      http://laconi.ca/
  26  */
  27
  28 if (!defined('STATUSNET')) {
  29     exit(1);
  30 }
  31
  32 require_once INSTALLDIR . '/plugins/TwitterBridge/twitter.php';
  33
  34 define('TWITTERBRIDGEPLUGIN_VERSION', '0.9');
  35
  36 /**
  37  * Plugin for sending and importing Twitter statuses
  38  *
  39  * This class allows users to link their Twitter accounts
  40  *
  41  * @category Plugin
  42  * @package  StatusNet
  43  * @author   Zach Copley <zach@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://laconi.ca/
  46  * @link     http://twitter.com/
  47  */
  48
  49 class TwitterBridgePlugin extends Plugin
  50 {
  51     /**
  52      * Initializer for the plugin.
  53      */
  54
  55     function __construct()
  56     {
  57         parent::__construct();
  58     }
  59
  60     /**
  61      * Add Twitter-related paths to the router table
  62      *
  63      * Hook for RouterInitialized event.
  64      *
  65      * @param Net_URL_Mapper $m path-to-action mapper
  66      *
  67      * @return boolean hook return
  68      */
  69
  70     function onRouterInitialized($m)
  71     {
  72         $m->connect('twitter/authorization',
  73                     array('action' => 'twitterauthorization'));
  74         $m->connect('settings/twitter', array('action' => 'twittersettings'));
  75
  76         return true;
  77     }
  78
  79     /**
  80      * Add the Twitter Settings page to the Connect Settings menu
  81      *
  82      * @param Action &$action The calling page
  83      *
  84      * @return boolean hook return
  85      */
  86     function onEndConnectSettingsNav(&$action)
  87     {
  88         $action_name = $action->trimmed('action');
  89
  90         $action->menuItem(common_local_url('twittersettings'),
  91                           _m('Twitter'),
  92                           _m('Twitter integration options'),
  93                           $action_name === 'twittersettings');
  94
  95         return true;
  96     }
  97
  98     /**
  99      * Automatically load the actions and libraries used by the Twitter bridge
 100      *
 101      * @param Class $cls the class
 102      *
 103      * @return boolean hook return
 104      *
 105      */
 106     function onAutoload($cls)
 107     {
 108         switch ($cls) {
 109         case 'TwittersettingsAction':
 110         case 'TwitterauthorizationAction':
 111             include_once INSTALLDIR . '/plugins/TwitterBridge/' .
 112               strtolower(mb_substr($cls, 0, -6)) . '.php';
 113             return false;
 114         case 'TwitterOAuthClient':
 115         case 'TwitterQueueHandler':
 116             include_once INSTALLDIR . '/plugins/TwitterBridge/' .
 117               strtolower($cls) . '.php';
 118             return false;
 119         default:
 120             return true;
 121         }
 122     }
 123
 124     /**
 125      * Add a Twitter queue item for each notice
 126      *
 127      * @param Notice $notice      the notice
 128      * @param array  &$transports the list of transports (queues)
 129      *
 130      * @return boolean hook return
 131      */
 132     function onStartEnqueueNotice($notice, &$transports)
 133     {
 134         // Avoid a possible loop
 135
 136         if ($notice->source != 'twitter') {
 137             array_push($transports, 'twitter');
 138         }
 139
 140         return true;
 141     }
 142
 143     /**
 144      * Add Twitter bridge daemons to the list of daemons to start
 145      *
 146      * @param array $daemons the list fo daemons to run
 147      *
 148      * @return boolean hook return
 149      */
 150     function onGetValidDaemons($daemons)
 151     {
 152         array_push($daemons, INSTALLDIR .
 153                    '/plugins/TwitterBridge/daemons/synctwitterfriends.php');
 154
 155         if (common_config('twitterimport', 'enabled')) {
 156             array_push($daemons, INSTALLDIR
 157                 . '/plugins/TwitterBridge/daemons/twitterstatusfetcher.php');
 158         }
 159
 160         return true;
 161     }
 162
 163     /**
 164      * Register Twitter notice queue handler
 165      *
 166      * @param QueueManager $manager
 167      *
 168      * @return boolean hook return
 169      */
 170     function onEndInitializeQueueManager($manager)
 171     {
 172         $manager->connect('twitter', 'TwitterQueueHandler');
 173         return true;
 174     }
 175
 176     function onPluginVersion(&$versions)
 177     {
 178         $versions[] = array('name' => 'TwitterBridge',
 179                             'version' => TWITTERBRIDGEPLUGIN_VERSION,
 180                             'author' => 'Zach Copley',
 181                             'homepage' => 'http://status.net/wiki/Plugin:TwitterBridge',
 182                             'rawdescription' =>
 183                             _m('The Twitter "bridge" plugin allows you to integrate ' .
 184                                'your StatusNet instance with ' .
 185                                '<a href="http://twitter.com/">Twitter</a>.'));
 186         return true;
 187     }
 188
 189 }