]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/TwitterBridge/TwitterBridgePlugin.php
- New base InfoAction for dialog box like msgs
[quix0rs-gnu-social.git] / plugins / TwitterBridge / TwitterBridgePlugin.php
index 6ce69d5e2b3f5b2434b465b87afb9852372abb32..097d4486f91c4d9d214ce2ef6118860237fa8221 100644 (file)
@@ -45,16 +45,14 @@ require_once INSTALLDIR . '/plugins/TwitterBridge/twitter.php';
  * @link     http://status.net/
  * @link     http://twitter.com/
  */
-
 class TwitterBridgePlugin extends Plugin
 {
-
     const VERSION = STATUSNET_VERSION;
+    public $adminImportControl = false; // Should the 'import' checkbox be exposed in the admin panel?
 
     /**
      * Initializer for the plugin.
      */
-
     function initialize()
     {
         // Allow the key and secret to be passed in
@@ -79,6 +77,29 @@ class TwitterBridgePlugin extends Plugin
         }
     }
 
+    /**
+     * Check to see if there is a consumer key and secret defined
+     * for Twitter integration.
+     *
+     * @return boolean result
+     */
+    static function hasKeys()
+    {
+        $ckey    = common_config('twitter', 'consumer_key');
+        $csecret = common_config('twitter', 'consumer_secret');
+
+        if (empty($ckey) && empty($csecret)) {
+            $ckey    = common_config('twitter', 'global_consumer_key');
+            $csecret = common_config('twitter', 'global_consumer_secret');
+        }
+
+        if (!empty($ckey) && !empty($csecret)) {
+            return true;
+        }
+
+        return false;
+    }
+
     /**
      * Add Twitter-related paths to the router table
      *
@@ -88,21 +109,28 @@ class TwitterBridgePlugin extends Plugin
      *
      * @return boolean hook return
      */
-
     function onRouterInitialized($m)
     {
-        $m->connect(
-            'twitter/authorization',
-            array('action' => 'twitterauthorization')
-        );
-        $m->connect('settings/twitter', array('action' => 'twittersettings'));
+        $m->connect('admin/twitter', array('action' => 'twitteradminpanel'));
 
-        if (common_config('twitter', 'signin')) {
-            $m->connect('main/twitterlogin', array('action' => 'twitterlogin'));
+        if (self::hasKeys()) {
+            $m->connect(
+                'twitter/authorization',
+                array('action' => 'twitterauthorization')
+            );
+            $m->connect(
+                'settings/twitter', array(
+                    'action' => 'twittersettings'
+                    )
+                );
+            if (common_config('twitter', 'signin')) {
+                $m->connect(
+                    'main/twitterlogin',
+                    array('action' => 'twitterlogin')
+                );
+            }
         }
 
-        $m->connect('admin/twitter', array('action' => 'twitteradminpanel'));
-
         return true;
     }
 
@@ -117,7 +145,7 @@ class TwitterBridgePlugin extends Plugin
     {
         $action_name = $action->trimmed('action');
 
-        if (common_config('twitter', 'signin')) {
+        if (self::hasKeys() && common_config('twitter', 'signin')) {
             $action->menuItem(
                 common_local_url('twitterlogin'),
                 _m('Twitter'),
@@ -138,15 +166,16 @@ class TwitterBridgePlugin extends Plugin
      */
     function onEndConnectSettingsNav(&$action)
     {
-        $action_name = $action->trimmed('action');
-
-        $action->menuItem(
-            common_local_url('twittersettings'),
-            _m('Twitter'),
-            _m('Twitter integration options'),
-            $action_name === 'twittersettings'
-        );
+        if (self::hasKeys()) {
+            $action_name = $action->trimmed('action');
 
+            $action->menuItem(
+                common_local_url('twittersettings'),
+                _m('Twitter'),
+                _m('Twitter integration options'),
+                $action_name === 'twittersettings'
+            );
+        }
         return true;
     }
 
@@ -160,18 +189,22 @@ class TwitterBridgePlugin extends Plugin
      */
     function onAutoload($cls)
     {
+        $dir = dirname(__FILE__);
+
         switch ($cls) {
         case 'TwittersettingsAction':
         case 'TwitterauthorizationAction':
         case 'TwitterloginAction':
         case 'TwitteradminpanelAction':
-            include_once INSTALLDIR . '/plugins/TwitterBridge/' .
-              strtolower(mb_substr($cls, 0, -6)) . '.php';
+            include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
             return false;
         case 'TwitterOAuthClient':
         case 'TwitterQueueHandler':
-            include_once INSTALLDIR . '/plugins/TwitterBridge/' .
-              strtolower($cls) . '.php';
+            include_once $dir . '/' . strtolower($cls) . '.php';
+            return false;
+        case 'Notice_to_status':
+        case 'Twitter_synch_status':
+            include_once $dir . '/' . $cls . '.php';
             return false;
         default:
             return true;
@@ -188,12 +221,12 @@ class TwitterBridgePlugin extends Plugin
      */
     function onStartEnqueueNotice($notice, &$transports)
     {
-        // Avoid a possible loop
-
-        if ($notice->source != 'twitter') {
-            array_push($transports, 'twitter');
+        if (self::hasKeys() && $notice->isLocal()) {
+            // Avoid a possible loop
+            if ($notice->source != 'twitter') {
+                array_push($transports, 'twitter');
+            }
         }
-
         return true;
     }
 
@@ -206,18 +239,19 @@ class TwitterBridgePlugin extends Plugin
      */
     function onGetValidDaemons($daemons)
     {
-        array_push(
-            $daemons,
-            INSTALLDIR
-            . '/plugins/TwitterBridge/daemons/synctwitterfriends.php'
-        );
-
-        if (common_config('twitterimport', 'enabled')) {
+        if (self::hasKeys()) {
             array_push(
                 $daemons,
                 INSTALLDIR
-                . '/plugins/TwitterBridge/daemons/twitterstatusfetcher.php'
+                . '/plugins/TwitterBridge/daemons/synctwitterfriends.php'
             );
+            if (common_config('twitterimport', 'enabled')) {
+                array_push(
+                    $daemons,
+                    INSTALLDIR
+                    . '/plugins/TwitterBridge/daemons/twitterstatusfetcher.php'
+                    );
+            }
         }
 
         return true;
@@ -232,7 +266,9 @@ class TwitterBridgePlugin extends Plugin
      */
     function onEndInitializeQueueManager($manager)
     {
-        $manager->connect('twitter', 'TwitterQueueHandler');
+        if (self::hasKeys()) {
+            $manager->connect('twitter', 'TwitterQueueHandler');
+        }
         return true;
     }
 
@@ -269,7 +305,6 @@ class TwitterBridgePlugin extends Plugin
      *
      * @return boolean hook value
      */
-
     function onPluginVersion(&$versions)
     {
         $versions[] = array(
@@ -278,13 +313,198 @@ class TwitterBridgePlugin extends Plugin
             'author' => 'Zach Copley, Julien C',
             'homepage' => 'http://status.net/wiki/Plugin:TwitterBridge',
             'rawdescription' => _m(
-                'The Twitter "bridge" plugin allows you to integrate ' .
-                'your StatusNet instance with ' .
+                'The Twitter "bridge" plugin allows integration ' .
+                'of a StatusNet instance with ' .
                 '<a href="http://twitter.com/">Twitter</a>.'
             )
         );
         return true;
     }
 
-}
+    /**
+     * Expose the adminImportControl setting to the administration panel code.
+     * This allows us to disable the import bridge enabling checkbox for administrators,
+     * since on a bulk farm site we can't yet automate the import daemon setup.
+     *
+     * @return boolean hook value;
+     */
+    function onTwitterBridgeAdminImportControl()
+    {
+        return (bool)$this->adminImportControl;
+    }
+
+    /**
+     * When the site is set to ssl=sometimes mode, we should make sure our
+     * various auth-related pages are on SSL to keep things looking happy.
+     * Although we're not submitting passwords directly, we do link out to
+     * an authentication source and it's a lot happier if we've got some
+     * protection against MitM.
+     *
+     * @param string $action name
+     * @param boolean $ssl outval to force SSL
+     * @return mixed hook return value
+     */
+    function onSensitiveAction($action, &$ssl)
+    {
+        $sensitive = array('twitteradminpanel',
+                           'twittersettings',
+                           'twitterauthorization',
+                           'twitterlogin');
+        if (in_array($action, $sensitive)) {
+            $ssl = true;
+            return false;
+        } else {
+            return true;
+        }
+    }
+
+    /**
+     * Database schema setup
+     *
+     * We maintain a table mapping StatusNet notices to Twitter statuses
+     *
+     * @see Schema
+     * @see ColumnDef
+     *
+     * @return boolean hook value; true means continue processing, false means stop.
+     */
+    function onCheckSchema()
+    {
+        $schema = Schema::get();
+
+        // For saving the last-synched status of various timelines
+        // home_timeline, messages (in), messages (out), ...
+
+        $schema->ensureTable('twitter_synch_status',
+                             array(new ColumnDef('foreign_id', 'bigint', null,
+                                                 false, 'PRI'),
+                                   new ColumnDef('timeline', 'varchar', 255,
+                                                 false, 'PRI'),
+                                   new ColumnDef('last_id', 'bigint', null, // XXX: check for PostgreSQL
+                                                 false),
+                                   new ColumnDef('created', 'datetime', null,
+                                                 false),
+                                   new ColumnDef('modified', 'datetime', null,
+                                                 false)));
+
+        // For storing user-submitted flags on profiles
+
+        $schema->ensureTable('notice_to_status',
+                             array(new ColumnDef('notice_id', 'integer', null,
+                                                 false, 'PRI'),
+                                   new ColumnDef('status_id', 'bigint', null, // XXX: check for PostgreSQL
+                                                 false, 'UNI'),
+                                   new ColumnDef('created', 'datetime', null,
+                                                 false)));
 
+        return true;
+    }
+
+    /**
+     * If a notice gets deleted, remove the Notice_to_status mapping and
+     * delete the status on Twitter.
+     *
+     * @param User   $user   The user doing the deleting
+     * @param Notice $notice The notice getting deleted
+     *
+     * @return boolean hook value
+     */
+    function onStartDeleteOwnNotice(User $user, Notice $notice)
+    {
+        $n2s = Notice_to_status::staticGet('notice_id', $notice->id);
+
+        if (!empty($n2s)) {
+
+            $flink = Foreign_link::getByUserID($notice->profile_id,
+                                               TWITTER_SERVICE); // twitter service
+
+            if (empty($flink)) {
+                return true;
+            }
+
+            if (!TwitterOAuthClient::isPackedToken($flink->credentials)) {
+                $this->log(LOG_INFO, "Skipping deleting notice for {$notice->id} since link is not OAuth.");
+                return true;
+            }
+
+            $token = TwitterOAuthClient::unpackToken($flink->credentials);
+            $client = new TwitterOAuthClient($token->key, $token->secret);
+
+            $client->statusesDestroy($n2s->status_id);
+
+            $n2s->delete();
+        }
+        return true;
+    }
+
+    /**
+     * Notify remote users when their notices get favorited.
+     *
+     * @param Profile or User $profile of local user doing the faving
+     * @param Notice $notice being favored
+     * @return hook return value
+     */
+    function onEndFavorNotice(Profile $profile, Notice $notice)
+    {
+        $flink = Foreign_link::getByUserID($profile->id,
+                                           TWITTER_SERVICE); // twitter service
+
+        if (empty($flink)) {
+            return true;
+        }
+
+        if (!TwitterOAuthClient::isPackedToken($flink->credentials)) {
+            $this->log(LOG_INFO, "Skipping fave processing for {$profile->id} since link is not OAuth.");
+            return true;
+        }
+
+        $status_id = twitter_status_id($notice);
+
+        if (empty($status_id)) {
+            return true;
+        }
+
+        $token = TwitterOAuthClient::unpackToken($flink->credentials);
+        $client = new TwitterOAuthClient($token->key, $token->secret);
+
+        $client->favoritesCreate($status_id);
+
+        return true;
+    }
+
+    /**
+     * Notify remote users when their notices get de-favorited.
+     *
+     * @param Profile $profile Profile person doing the de-faving
+     * @param Notice  $notice  Notice being favored
+     *
+     * @return hook return value
+     */
+    function onEndDisfavorNotice(Profile $profile, Notice $notice)
+    {
+        $flink = Foreign_link::getByUserID($profile->id,
+                                           TWITTER_SERVICE); // twitter service
+
+        if (empty($flink)) {
+            return true;
+        }
+
+        if (!TwitterOAuthClient::isPackedToken($flink->credentials)) {
+            $this->log(LOG_INFO, "Skipping fave processing for {$profile->id} since link is not OAuth.");
+            return true;
+        }
+
+        $status_id = twitter_status_id($notice);
+
+        if (empty($status_id)) {
+            return true;
+        }
+
+        $token = TwitterOAuthClient::unpackToken($flink->credentials);
+        $client = new TwitterOAuthClient($token->key, $token->secret);
+
+        $client->favoritesDestroy($status_id);
+
+        return true;
+    }
+}