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         case 'JsonStreamReader':
 205         case 'TwitterStreamReader':
 206             include_once $dir . '/' . strtolower($cls) . '.php';
 207             return false;
 208         case 'TwitterSiteStream':
 209         case 'TwitterUserStream':
 210             include_once $dir . '/twitterstreamreader.php';
 211             return false;
 212         case 'Notice_to_status':
 213         case 'Twitter_synch_status':
 214             include_once $dir . '/' . $cls . '.php';
 215             return false;
 216         default:
 217             return true;
 218         }
 219     }
 220
 221     /**
 222      * Add a Twitter queue item for each notice
 223      *
 224      * @param Notice $notice      the notice
 225      * @param array  &$transports the list of transports (queues)
 226      *
 227      * @return boolean hook return
 228      */
 229     function onStartEnqueueNotice($notice, &$transports)
 230     {
 231         if (self::hasKeys() && $notice->isLocal()) {
 232             // Avoid a possible loop
 233             if ($notice->source != 'twitter') {
 234                 array_push($transports, 'twitter');
 235             }
 236         }
 237         return true;
 238     }
 239
 240     /**
 241      * Add Twitter bridge daemons to the list of daemons to start
 242      *
 243      * @param array $daemons the list fo daemons to run
 244      *
 245      * @return boolean hook return
 246      */
 247     function onGetValidDaemons($daemons)
 248     {
 249         if (self::hasKeys()) {
 250             array_push(
 251                 $daemons,
 252                 INSTALLDIR
 253                 . '/plugins/TwitterBridge/daemons/synctwitterfriends.php'
 254             );
 255             if (common_config('twitterimport', 'enabled')) {
 256                 array_push(
 257                     $daemons,
 258                     INSTALLDIR
 259                     . '/plugins/TwitterBridge/daemons/twitterstatusfetcher.php'
 260                     );
 261             }
 262         }
 263
 264         return true;
 265     }
 266
 267     /**
 268      * Register Twitter notice queue handler
 269      *
 270      * @param QueueManager $manager
 271      *
 272      * @return boolean hook return
 273      */
 274     function onEndInitializeQueueManager($manager)
 275     {
 276         if (self::hasKeys()) {
 277             // Outgoing notices -> twitter
 278             $manager->connect('twitter', 'TwitterQueueHandler');
 279
 280             // Incoming statuses <- twitter
 281             $manager->connect('tweetin', 'TweetInQueueHandler');
 282
 283             // Control messages from our web interface to the import daemon
 284             $manager->connect('tweetctl', 'TweetCtlQueueHandler', 'twitter');
 285         }
 286         return true;
 287     }
 288
 289     /**
 290      * Add a Twitter tab to the admin panel
 291      *
 292      * @param Widget $nav Admin panel nav
 293      *
 294      * @return boolean hook value
 295      */
 296
 297     function onEndAdminPanelNav($nav)
 298     {
 299         if (AdminPanelAction::canAdmin('twitter')) {
 300
 301             $action_name = $nav->action->trimmed('action');
 302
 303             $nav->out->menuItem(
 304                 common_local_url('twitteradminpanel'),
 305                 _m('Twitter'),
 306                 _m('Twitter bridge configuration'),
 307                 $action_name == 'twitteradminpanel',
 308                 'nav_twitter_admin_panel'
 309             );
 310         }
 311
 312         return true;
 313     }
 314
 315     /**
 316      * Plugin version data
 317      *
 318      * @param array &$versions array of version blocks
 319      *
 320      * @return boolean hook value
 321      */
 322     function onPluginVersion(&$versions)
 323     {
 324         $versions[] = array(
 325             'name' => 'TwitterBridge',
 326             'version' => self::VERSION,
 327             'author' => 'Zach Copley, Julien C',
 328             'homepage' => 'http://status.net/wiki/Plugin:TwitterBridge',
 329             'rawdescription' => _m(
 330                 'The Twitter "bridge" plugin allows integration ' .
 331                 'of a StatusNet instance with ' .
 332                 '<a href="http://twitter.com/">Twitter</a>.'
 333             )
 334         );
 335         return true;
 336     }
 337
 338     /**
 339      * Expose the adminImportControl setting to the administration panel code.
 340      * This allows us to disable the import bridge enabling checkbox for administrators,
 341      * since on a bulk farm site we can't yet automate the import daemon setup.
 342      *
 343      * @return boolean hook value;
 344      */
 345     function onTwitterBridgeAdminImportControl()
 346     {
 347         return (bool)$this->adminImportControl;
 348     }
 349
 350     /**
 351      * When the site is set to ssl=sometimes mode, we should make sure our
 352      * various auth-related pages are on SSL to keep things looking happy.
 353      * Although we're not submitting passwords directly, we do link out to
 354      * an authentication source and it's a lot happier if we've got some
 355      * protection against MitM.
 356      *
 357      * @param string $action name
 358      * @param boolean $ssl outval to force SSL
 359      * @return mixed hook return value
 360      */
 361     function onSensitiveAction($action, &$ssl)
 362     {
 363         $sensitive = array('twitteradminpanel',
 364                            'twittersettings',
 365                            'twitterauthorization',
 366                            'twitterlogin');
 367         if (in_array($action, $sensitive)) {
 368             $ssl = true;
 369             return false;
 370         } else {
 371             return true;
 372         }
 373     }
 374
 375     /**
 376      * Database schema setup
 377      *
 378      * We maintain a table mapping StatusNet notices to Twitter statuses
 379      *
 380      * @see Schema
 381      * @see ColumnDef
 382      *
 383      * @return boolean hook value; true means continue processing, false means stop.
 384      */
 385     function onCheckSchema()
 386     {
 387         $schema = Schema::get();
 388
 389         // For saving the last-synched status of various timelines
 390         // home_timeline, messages (in), messages (out), ...
 391
 392         $schema->ensureTable('twitter_synch_status',
 393                              array(new ColumnDef('foreign_id', 'bigint', null,
 394                                                  false, 'PRI'),
 395                                    new ColumnDef('timeline', 'varchar', 255,
 396                                                  false, 'PRI'),
 397                                    new ColumnDef('last_id', 'bigint', null, // XXX: check for PostgreSQL
 398                                                  false),
 399                                    new ColumnDef('created', 'datetime', null,
 400                                                  false),
 401                                    new ColumnDef('modified', 'datetime', null,
 402                                                  false)));
 403
 404         // For storing user-submitted flags on profiles
 405
 406         $schema->ensureTable('notice_to_status',
 407                              array(new ColumnDef('notice_id', 'integer', null,
 408                                                  false, 'PRI'),
 409                                    new ColumnDef('status_id', 'bigint', null, // XXX: check for PostgreSQL
 410                                                  false, 'UNI'),
 411                                    new ColumnDef('created', 'datetime', null,
 412                                                  false)));
 413
 414         return true;
 415     }
 416
 417     /**
 418      * If a notice gets deleted, remove the Notice_to_status mapping and
 419      * delete the status on Twitter.
 420      *
 421      * @param User   $user   The user doing the deleting
 422      * @param Notice $notice The notice getting deleted
 423      *
 424      * @return boolean hook value
 425      */
 426     function onStartDeleteOwnNotice(User $user, Notice $notice)
 427     {
 428         $n2s = Notice_to_status::staticGet('notice_id', $notice->id);
 429
 430         if (!empty($n2s)) {
 431
 432             $flink = Foreign_link::getByUserID($notice->profile_id,
 433                                                TWITTER_SERVICE); // twitter service
 434
 435             if (empty($flink)) {
 436                 return true;
 437             }
 438
 439             if (!TwitterOAuthClient::isPackedToken($flink->credentials)) {
 440                 $this->log(LOG_INFO, "Skipping deleting notice for {$notice->id} since link is not OAuth.");
 441                 return true;
 442             }
 443
 444             $token = TwitterOAuthClient::unpackToken($flink->credentials);
 445             $client = new TwitterOAuthClient($token->key, $token->secret);
 446
 447             $client->statusesDestroy($n2s->status_id);
 448
 449             $n2s->delete();
 450         }
 451         return true;
 452     }
 453
 454     /**
 455      * Notify remote users when their notices get favorited.
 456      *
 457      * @param Profile or User $profile of local user doing the faving
 458      * @param Notice $notice being favored
 459      * @return hook return value
 460      */
 461     function onEndFavorNotice(Profile $profile, Notice $notice)
 462     {
 463         $flink = Foreign_link::getByUserID($profile->id,
 464                                            TWITTER_SERVICE); // twitter service
 465
 466         if (empty($flink)) {
 467             return true;
 468         }
 469
 470         if (!TwitterOAuthClient::isPackedToken($flink->credentials)) {
 471             $this->log(LOG_INFO, "Skipping fave processing for {$profile->id} since link is not OAuth.");
 472             return true;
 473         }
 474
 475         $status_id = twitter_status_id($notice);
 476
 477         if (empty($status_id)) {
 478             return true;
 479         }
 480
 481         $token = TwitterOAuthClient::unpackToken($flink->credentials);
 482         $client = new TwitterOAuthClient($token->key, $token->secret);
 483
 484         $client->favoritesCreate($status_id);
 485
 486         return true;
 487     }
 488
 489     /**
 490      * Notify remote users when their notices get de-favorited.
 491      *
 492      * @param Profile $profile Profile person doing the de-faving
 493      * @param Notice  $notice  Notice being favored
 494      *
 495      * @return hook return value
 496      */
 497     function onEndDisfavorNotice(Profile $profile, Notice $notice)
 498     {
 499         $flink = Foreign_link::getByUserID($profile->id,
 500                                            TWITTER_SERVICE); // twitter service
 501
 502         if (empty($flink)) {
 503             return true;
 504         }
 505
 506         if (!TwitterOAuthClient::isPackedToken($flink->credentials)) {
 507             $this->log(LOG_INFO, "Skipping fave processing for {$profile->id} since link is not OAuth.");
 508             return true;
 509         }
 510
 511         $status_id = twitter_status_id($notice);
 512
 513         if (empty($status_id)) {
 514             return true;
 515         }
 516
 517         $token = TwitterOAuthClient::unpackToken($flink->credentials);
 518         $client = new TwitterOAuthClient($token->key, $token->secret);
 519
 520         $client->favoritesDestroy($status_id);
 521
 522         return true;
 523     }
 524 }