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  * @author    Julien C <chaumond@gmail.com>
  24  * @copyright 2009-2010 Control Yourself, Inc.
  25  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  26  * @link      http://status.net/
  27  */
  28
  29 if (!defined('STATUSNET')) {
  30     exit(1);
  31 }
  32
  33 require_once INSTALLDIR . '/plugins/TwitterBridge/twitter.php';
  34
  35 /**
  36  * Plugin for sending and importing Twitter statuses
  37  *
  38  * This class allows users to link their Twitter accounts
  39  *
  40  * @category Plugin
  41  * @package  StatusNet
  42  * @author   Zach Copley <zach@status.net>
  43  * @author   Julien C <chaumond@gmail.com>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  * @link     http://twitter.com/
  47  */
  48 class TwitterBridgePlugin extends Plugin
  49 {
  50     const VERSION = STATUSNET_VERSION;
  51     public $adminImportControl = false; // Should the 'import' checkbox be exposed in the admin panel?
  52
  53     /**
  54      * Initializer for the plugin.
  55      */
  56     function initialize()
  57     {
  58         // Allow the key and secret to be passed in
  59         // Control panel will override
  60
  61         if (isset($this->consumer_key)) {
  62             $key = common_config('twitter', 'consumer_key');
  63             if (empty($key)) {
  64                 Config::save('twitter', 'consumer_key', $this->consumer_key);
  65             }
  66         }
  67
  68         if (isset($this->consumer_secret)) {
  69             $secret = common_config('twitter', 'consumer_secret');
  70             if (empty($secret)) {
  71                 Config::save(
  72                     'twitter',
  73                     'consumer_secret',
  74                     $this->consumer_secret
  75                 );
  76             }
  77         }
  78     }
  79
  80     /**
  81      * Check to see if there is a consumer key and secret defined
  82      * for Twitter integration.
  83      *
  84      * @return boolean result
  85      */
  86     static function hasKeys()
  87     {
  88         $ckey    = common_config('twitter', 'consumer_key');
  89         $csecret = common_config('twitter', 'consumer_secret');
  90
  91         if (empty($ckey) && empty($csecret)) {
  92             $ckey    = common_config('twitter', 'global_consumer_key');
  93             $csecret = common_config('twitter', 'global_consumer_secret');
  94         }
  95
  96         if (!empty($ckey) && !empty($csecret)) {
  97             return true;
  98         }
  99
 100         return false;
 101     }
 102
 103     /**
 104      * Add Twitter-related paths to the router table
 105      *
 106      * Hook for RouterInitialized event.
 107      *
 108      * @param Net_URL_Mapper $m path-to-action mapper
 109      *
 110      * @return boolean hook return
 111      */
 112     function onRouterInitialized($m)
 113     {
 114         $m->connect('admin/twitter', array('action' => 'twitteradminpanel'));
 115
 116         if (self::hasKeys()) {
 117             $m->connect(
 118                 'twitter/authorization',
 119                 array('action' => 'twitterauthorization')
 120             );
 121             $m->connect(
 122                 'settings/twitter', array(
 123                     'action' => 'twittersettings'
 124                     )
 125                 );
 126             if (common_config('twitter', 'signin')) {
 127                 $m->connect(
 128                     'main/twitterlogin',
 129                     array('action' => 'twitterlogin')
 130                 );
 131             }
 132         }
 133
 134         return true;
 135     }
 136
 137     /*
 138      * Add a login tab for 'Sign in with Twitter'
 139      *
 140      * @param Action &action the current action
 141      *
 142      * @return void
 143      */
 144     function onEndLoginGroupNav(&$action)
 145     {
 146         $action_name = $action->trimmed('action');
 147
 148         if (self::hasKeys() && common_config('twitter', 'signin')) {
 149             $action->menuItem(
 150                 common_local_url('twitterlogin'),
 151                 _m('Twitter'),
 152                 _m('Login or register using Twitter'),
 153                 'twitterlogin' === $action_name
 154             );
 155         }
 156
 157         return true;
 158     }
 159
 160     /**
 161      * Add the Twitter Settings page to the Connect Settings menu
 162      *
 163      * @param Action &$action The calling page
 164      *
 165      * @return boolean hook return
 166      */
 167     function onEndConnectSettingsNav(&$action)
 168     {
 169         if (self::hasKeys()) {
 170             $action_name = $action->trimmed('action');
 171
 172             $action->menuItem(
 173                 common_local_url('twittersettings'),
 174                 _m('Twitter'),
 175                 _m('Twitter integration options'),
 176                 $action_name === 'twittersettings'
 177             );
 178         }
 179         return true;
 180     }
 181
 182     /**
 183      * Automatically load the actions and libraries used by the Twitter bridge
 184      *
 185      * @param Class $cls the class
 186      *
 187      * @return boolean hook return
 188      *
 189      */
 190     function onAutoload($cls)
 191     {
 192         $dir = dirname(__FILE__);
 193
 194         switch ($cls) {
 195         case 'TwittersettingsAction':
 196         case 'TwitterauthorizationAction':
 197         case 'TwitterloginAction':
 198         case 'TwitteradminpanelAction':
 199             include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
 200             return false;
 201         case 'TwitterOAuthClient':
 202         case 'TwitterQueueHandler':
 203         case 'TwitterImport':
 204             include_once $dir . '/' . strtolower($cls) . '.php';
 205             return false;
 206         case 'Notice_to_status':
 207         case 'Twitter_synch_status':
 208             include_once $dir . '/' . $cls . '.php';
 209             return false;
 210         default:
 211             return true;
 212         }
 213     }
 214
 215     /**
 216      * Add a Twitter queue item for each notice
 217      *
 218      * @param Notice $notice      the notice
 219      * @param array  &$transports the list of transports (queues)
 220      *
 221      * @return boolean hook return
 222      */
 223     function onStartEnqueueNotice($notice, &$transports)
 224     {
 225         if (self::hasKeys() && $notice->isLocal()) {
 226             // Avoid a possible loop
 227             if ($notice->source != 'twitter') {
 228                 array_push($transports, 'twitter');
 229             }
 230         }
 231         return true;
 232     }
 233
 234     /**
 235      * Add Twitter bridge daemons to the list of daemons to start
 236      *
 237      * @param array $daemons the list fo daemons to run
 238      *
 239      * @return boolean hook return
 240      */
 241     function onGetValidDaemons($daemons)
 242     {
 243         if (self::hasKeys()) {
 244             array_push(
 245                 $daemons,
 246                 INSTALLDIR
 247                 . '/plugins/TwitterBridge/daemons/synctwitterfriends.php'
 248             );
 249             if (common_config('twitterimport', 'enabled')) {
 250                 array_push(
 251                     $daemons,
 252                     INSTALLDIR
 253                     . '/plugins/TwitterBridge/daemons/twitterstatusfetcher.php'
 254                     );
 255             }
 256         }
 257
 258         return true;
 259     }
 260
 261     /**
 262      * Register Twitter notice queue handler
 263      *
 264      * @param QueueManager $manager
 265      *
 266      * @return boolean hook return
 267      */
 268     function onEndInitializeQueueManager($manager)
 269     {
 270         if (self::hasKeys()) {
 271             $manager->connect('twitter', 'TwitterQueueHandler');
 272         }
 273         return true;
 274     }
 275
 276     /**
 277      * Add a Twitter tab to the admin panel
 278      *
 279      * @param Widget $nav Admin panel nav
 280      *
 281      * @return boolean hook value
 282      */
 283
 284     function onEndAdminPanelNav($nav)
 285     {
 286         if (AdminPanelAction::canAdmin('twitter')) {
 287
 288             $action_name = $nav->action->trimmed('action');
 289
 290             $nav->out->menuItem(
 291                 common_local_url('twitteradminpanel'),
 292                 _m('Twitter'),
 293                 _m('Twitter bridge configuration'),
 294                 $action_name == 'twitteradminpanel',
 295                 'nav_twitter_admin_panel'
 296             );
 297         }
 298
 299         return true;
 300     }
 301
 302     /**
 303      * Plugin version data
 304      *
 305      * @param array &$versions array of version blocks
 306      *
 307      * @return boolean hook value
 308      */
 309     function onPluginVersion(&$versions)
 310     {
 311         $versions[] = array(
 312             'name' => 'TwitterBridge',
 313             'version' => self::VERSION,
 314             'author' => 'Zach Copley, Julien C',
 315             'homepage' => 'http://status.net/wiki/Plugin:TwitterBridge',
 316             'rawdescription' => _m(
 317                 'The Twitter "bridge" plugin allows integration ' .
 318                 'of a StatusNet instance with ' .
 319                 '<a href="http://twitter.com/">Twitter</a>.'
 320             )
 321         );
 322         return true;
 323     }
 324
 325     /**
 326      * Expose the adminImportControl setting to the administration panel code.
 327      * This allows us to disable the import bridge enabling checkbox for administrators,
 328      * since on a bulk farm site we can't yet automate the import daemon setup.
 329      *
 330      * @return boolean hook value;
 331      */
 332     function onTwitterBridgeAdminImportControl()
 333     {
 334         return (bool)$this->adminImportControl;
 335     }
 336
 337     /**
 338      * When the site is set to ssl=sometimes mode, we should make sure our
 339      * various auth-related pages are on SSL to keep things looking happy.
 340      * Although we're not submitting passwords directly, we do link out to
 341      * an authentication source and it's a lot happier if we've got some
 342      * protection against MitM.
 343      *
 344      * @param string $action name
 345      * @param boolean $ssl outval to force SSL
 346      * @return mixed hook return value
 347      */
 348     function onSensitiveAction($action, &$ssl)
 349     {
 350         $sensitive = array('twitteradminpanel',
 351                            'twittersettings',
 352                            'twitterauthorization',
 353                            'twitterlogin');
 354         if (in_array($action, $sensitive)) {
 355             $ssl = true;
 356             return false;
 357         } else {
 358             return true;
 359         }
 360     }
 361
 362     /**
 363      * Database schema setup
 364      *
 365      * We maintain a table mapping StatusNet notices to Twitter statuses
 366      *
 367      * @see Schema
 368      * @see ColumnDef
 369      *
 370      * @return boolean hook value; true means continue processing, false means stop.
 371      */
 372     function onCheckSchema()
 373     {
 374         $schema = Schema::get();
 375
 376         // For saving the last-synched status of various timelines
 377         // home_timeline, messages (in), messages (out), ...
 378
 379         $schema->ensureTable('twitter_synch_status',
 380                              array(new ColumnDef('foreign_id', 'bigint', null,
 381                                                  false, 'PRI'),
 382                                    new ColumnDef('timeline', 'varchar', 255,
 383                                                  false, 'PRI'),
 384                                    new ColumnDef('last_id', 'bigint', null, // XXX: check for PostgreSQL
 385                                                  false),
 386                                    new ColumnDef('created', 'datetime', null,
 387                                                  false),
 388                                    new ColumnDef('modified', 'datetime', null,
 389                                                  false)));
 390
 391         // For storing user-submitted flags on profiles
 392
 393         $schema->ensureTable('notice_to_status',
 394                              array(new ColumnDef('notice_id', 'integer', null,
 395                                                  false, 'PRI'),
 396                                    new ColumnDef('status_id', 'bigint', null, // XXX: check for PostgreSQL
 397                                                  false, 'UNI'),
 398                                    new ColumnDef('created', 'datetime', null,
 399                                                  false)));
 400
 401         return true;
 402     }
 403
 404     /**
 405      * If a notice gets deleted, remove the Notice_to_status mapping and
 406      * delete the status on Twitter.
 407      *
 408      * @param User   $user   The user doing the deleting
 409      * @param Notice $notice The notice getting deleted
 410      *
 411      * @return boolean hook value
 412      */
 413     function onStartDeleteOwnNotice(User $user, Notice $notice)
 414     {
 415         $n2s = Notice_to_status::staticGet('notice_id', $notice->id);
 416
 417         if (!empty($n2s)) {
 418
 419             $flink = Foreign_link::getByUserID($notice->profile_id,
 420                                                TWITTER_SERVICE); // twitter service
 421
 422             if (empty($flink)) {
 423                 return true;
 424             }
 425
 426             if (!TwitterOAuthClient::isPackedToken($flink->credentials)) {
 427                 $this->log(LOG_INFO, "Skipping deleting notice for {$notice->id} since link is not OAuth.");
 428                 return true;
 429             }
 430
 431             $token = TwitterOAuthClient::unpackToken($flink->credentials);
 432             $client = new TwitterOAuthClient($token->key, $token->secret);
 433
 434             $client->statusesDestroy($n2s->status_id);
 435
 436             $n2s->delete();
 437         }
 438         return true;
 439     }
 440
 441     /**
 442      * Notify remote users when their notices get favorited.
 443      *
 444      * @param Profile or User $profile of local user doing the faving
 445      * @param Notice $notice being favored
 446      * @return hook return value
 447      */
 448     function onEndFavorNotice(Profile $profile, Notice $notice)
 449     {
 450         $flink = Foreign_link::getByUserID($profile->id,
 451                                            TWITTER_SERVICE); // twitter service
 452
 453         if (empty($flink)) {
 454             return true;
 455         }
 456
 457         if (!TwitterOAuthClient::isPackedToken($flink->credentials)) {
 458             $this->log(LOG_INFO, "Skipping fave processing for {$profile->id} since link is not OAuth.");
 459             return true;
 460         }
 461
 462         $status_id = twitter_status_id($notice);
 463
 464         if (empty($status_id)) {
 465             return true;
 466         }
 467
 468         $token = TwitterOAuthClient::unpackToken($flink->credentials);
 469         $client = new TwitterOAuthClient($token->key, $token->secret);
 470
 471         $client->favoritesCreate($status_id);
 472
 473         return true;
 474     }
 475
 476     /**
 477      * Notify remote users when their notices get de-favorited.
 478      *
 479      * @param Profile $profile Profile person doing the de-faving
 480      * @param Notice  $notice  Notice being favored
 481      *
 482      * @return hook return value
 483      */
 484     function onEndDisfavorNotice(Profile $profile, Notice $notice)
 485     {
 486         $flink = Foreign_link::getByUserID($profile->id,
 487                                            TWITTER_SERVICE); // twitter service
 488
 489         if (empty($flink)) {
 490             return true;
 491         }
 492
 493         if (!TwitterOAuthClient::isPackedToken($flink->credentials)) {
 494             $this->log(LOG_INFO, "Skipping fave processing for {$profile->id} since link is not OAuth.");
 495             return true;
 496         }
 497
 498         $status_id = twitter_status_id($notice);
 499
 500         if (empty($status_id)) {
 501             return true;
 502         }
 503
 504         $token = TwitterOAuthClient::unpackToken($flink->credentials);
 505         $client = new TwitterOAuthClient($token->key, $token->secret);
 506
 507         $client->favoritesDestroy($status_id);
 508
 509         return true;
 510     }
 511 }