]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/TwitterBridge/TwitterBridgePlugin.php
Merge branch 'nightly' into singpolyma/gnu-social-events-saveObjectFromActivity
[quix0rs-gnu-social.git] / plugins / TwitterBridge / TwitterBridgePlugin.php
index 8e3eba3186dfa28535824660de39f6317fc98143..72c28d4fa45eb4dfc4eefbaa1528cc357bf9055e 100644 (file)
  * @link      http://status.net/
  */
 
-if (!defined('STATUSNET')) {
-    exit(1);
-}
+if (!defined('GNUSOCIAL')) { exit(1); }
 
-require_once INSTALLDIR . '/plugins/TwitterBridge/twitter.php';
+require_once __DIR__ . '/twitter.php';
 
 /**
  * Plugin for sending and importing Twitter statuses
  *
  * This class allows users to link their Twitter accounts
  *
+ * Depends on Favorite plugin.
+ *
  * @category Plugin
  * @package  StatusNet
  * @author   Zach Copley <zach@status.net>
@@ -45,17 +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;
+    const VERSION = GNUSOCIAL_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
@@ -86,7 +83,6 @@ class TwitterBridgePlugin extends Plugin
      *
      * @return boolean result
      */
-
     static function hasKeys()
     {
         $ckey    = common_config('twitter', 'consumer_key');
@@ -109,14 +105,13 @@ class TwitterBridgePlugin extends Plugin
      *
      * Hook for RouterInitialized event.
      *
-     * @param Net_URL_Mapper $m path-to-action mapper
+     * @param URLMapper $m path-to-action mapper
      *
      * @return boolean hook return
      */
-
-    function onRouterInitialized($m)
+    public function onRouterInitialized(URLMapper $m)
     {
-        $m->connect('admin/twitter', array('action' => 'twitteradminpanel'));
+        $m->connect('panel/twitter', array('action' => 'twitteradminpanel'));
 
         if (self::hasKeys()) {
             $m->connect(
@@ -142,19 +137,21 @@ class TwitterBridgePlugin extends Plugin
     /*
      * Add a login tab for 'Sign in with Twitter'
      *
-     * @param Action &action the current action
+     * @param Action $action the current action
      *
      * @return void
      */
-    function onEndLoginGroupNav(&$action)
+    function onEndLoginGroupNav($action)
     {
         $action_name = $action->trimmed('action');
 
         if (self::hasKeys() && common_config('twitter', 'signin')) {
             $action->menuItem(
                 common_local_url('twitterlogin'),
-                _m('Twitter'),
-                _m('Login or register using Twitter'),
+                // TRANS: Menu item in login navigation.
+                _m('MENU','Twitter'),
+                // TRANS: Title for menu item in login navigation.
+                _m('Login or register using Twitter.'),
                 'twitterlogin' === $action_name
             );
         }
@@ -165,18 +162,20 @@ class TwitterBridgePlugin extends Plugin
     /**
      * Add the Twitter Settings page to the Connect Settings menu
      *
-     * @param Action &$action The calling page
+     * @param Action $action The calling page
      *
      * @return boolean hook return
      */
-    function onEndConnectSettingsNav(&$action)
+    function onEndConnectSettingsNav($action)
     {
         if (self::hasKeys()) {
             $action_name = $action->trimmed('action');
 
             $action->menuItem(
                 common_local_url('twittersettings'),
-                _m('Twitter'),
+                // TRANS: Menu item in connection settings navigation.
+                _m('MENU','Twitter'),
+                // TRANS: Title for menu item in connection settings navigation.
                 _m('Twitter integration options'),
                 $action_name === 'twittersettings'
             );
@@ -184,34 +183,6 @@ class TwitterBridgePlugin extends Plugin
         return true;
     }
 
-    /**
-     * Automatically load the actions and libraries used by the Twitter bridge
-     *
-     * @param Class $cls the class
-     *
-     * @return boolean hook return
-     *
-     */
-    function onAutoload($cls)
-    {
-        switch ($cls) {
-        case 'TwittersettingsAction':
-        case 'TwitterauthorizationAction':
-        case 'TwitterloginAction':
-        case 'TwitteradminpanelAction':
-            include_once INSTALLDIR . '/plugins/TwitterBridge/' .
-              strtolower(mb_substr($cls, 0, -6)) . '.php';
-            return false;
-        case 'TwitterOAuthClient':
-        case 'TwitterQueueHandler':
-            include_once INSTALLDIR . '/plugins/TwitterBridge/' .
-              strtolower($cls) . '.php';
-            return false;
-        default:
-            return true;
-        }
-    }
-
     /**
      * Add a Twitter queue item for each notice
      *
@@ -222,7 +193,7 @@ class TwitterBridgePlugin extends Plugin
      */
     function onStartEnqueueNotice($notice, &$transports)
     {
-        if (self::hasKeys() && $notice->isLocal()) {
+        if (self::hasKeys() && $notice->isLocal() && $notice->inScope(null)) {
             // Avoid a possible loop
             if ($notice->source != 'twitter') {
                 array_push($transports, 'twitter');
@@ -238,7 +209,7 @@ class TwitterBridgePlugin extends Plugin
      *
      * @return boolean hook return
      */
-    function onGetValidDaemons($daemons)
+    function onGetValidDaemons(&$daemons)
     {
         if (self::hasKeys()) {
             array_push(
@@ -268,7 +239,23 @@ class TwitterBridgePlugin extends Plugin
     function onEndInitializeQueueManager($manager)
     {
         if (self::hasKeys()) {
+            // Outgoing notices -> twitter
             $manager->connect('twitter', 'TwitterQueueHandler');
+
+            // Incoming statuses <- twitter
+            $manager->connect('tweetin', 'TweetInQueueHandler');
+        }
+        return true;
+    }
+
+    /**
+     * If the plugin's installed, this should be accessible to admins
+     */
+    function onAdminPanelCheck($name, &$isOK)
+    {
+        if ($name == 'twitter') {
+            $isOK = true;
+            return false;
         }
         return true;
     }
@@ -289,8 +276,10 @@ class TwitterBridgePlugin extends Plugin
 
             $nav->out->menuItem(
                 common_local_url('twitteradminpanel'),
+                // TRANS: Menu item in administrative panel that leads to the Twitter bridge configuration.
                 _m('Twitter'),
-                _m('Twitter bridge configuration'),
+                // TRANS: Menu item title in administrative panel that leads to the Twitter bridge configuration.
+                _m('Twitter bridge configuration page.'),
                 $action_name == 'twitteradminpanel',
                 'nav_twitter_admin_panel'
             );
@@ -306,17 +295,16 @@ class TwitterBridgePlugin extends Plugin
      *
      * @return boolean hook value
      */
-
-    function onPluginVersion(&$versions)
+    function onPluginVersion(array &$versions)
     {
         $versions[] = array(
             'name' => 'TwitterBridge',
             'version' => self::VERSION,
-            'author' => 'Zach Copley, Julien C',
+            'author' => 'Zach Copley, Julien C, Jean Baptiste Favre',
             'homepage' => 'http://status.net/wiki/Plugin:TwitterBridge',
-            'rawdescription' => _m(
-                'The Twitter "bridge" plugin allows you to integrate ' .
-                'your StatusNet instance with ' .
+            // TRANS: Plugin description.
+            'rawdescription' => _m('The Twitter "bridge" plugin allows integration ' .
+                'of a StatusNet instance with ' .
                 '<a href="http://twitter.com/">Twitter</a>.'
             )
         );
@@ -360,5 +348,251 @@ class TwitterBridgePlugin extends Plugin
         }
     }
 
-}
+    /**
+     * 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', Twitter_synch_status::schemaDef());
+
+        // For storing user-submitted flags on profiles
+        $schema->ensureTable('notice_to_status', Notice_to_status::schemaDef());
+
+        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::getKV('notice_id', $notice->id);
+
+        if ($n2s instanceof Notice_to_status) {
 
+            try {
+                $flink = Foreign_link::getByUserID($notice->profile_id, TWITTER_SERVICE); // twitter service
+            } catch (NoResultException $e) {
+                return true;
+            }
+
+            if (!TwitterOAuthClient::isPackedToken($flink->credentials)) {
+                $this->log(LOG_INFO, "Skipping deleting notice for {$notice->id} since link is not OAuth.");
+                return true;
+            }
+
+            try {
+                $token = TwitterOAuthClient::unpackToken($flink->credentials);
+                $client = new TwitterOAuthClient($token->key, $token->secret);
+
+                $client->statusesDestroy($n2s->status_id);
+            } catch (Exception $e) {
+                common_log(LOG_ERR, "Error attempting to delete bridged notice from Twitter: " . $e->getMessage());
+            }
+
+            $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)
+    {
+        try {
+            $flink = Foreign_link::getByUserID($profile->getID(), TWITTER_SERVICE); // twitter service
+        } catch (NoResultException $e) {
+            return true;
+        }
+
+        if (!TwitterOAuthClient::isPackedToken($flink->credentials)) {
+            $this->log(LOG_INFO, "Skipping fave processing for {$profile->getID()} since link is not OAuth.");
+            return true;
+        }
+
+        $status_id = twitter_status_id($notice);
+
+        if (empty($status_id)) {
+            return true;
+        }
+
+        try {
+            $token = TwitterOAuthClient::unpackToken($flink->credentials);
+            $client = new TwitterOAuthClient($token->key, $token->secret);
+
+            $client->favoritesCreate($status_id);
+        } catch (Exception $e) {
+            common_log(LOG_ERR, "Error attempting to favorite bridged notice on Twitter: " . $e->getMessage());
+        }
+
+        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)
+    {
+        try {
+            $flink = Foreign_link::getByUserID($profile->getID(), TWITTER_SERVICE); // twitter service
+        } catch (NoResultException $e) {
+            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;
+        }
+
+        try {
+            $token = TwitterOAuthClient::unpackToken($flink->credentials);
+            $client = new TwitterOAuthClient($token->key, $token->secret);
+
+            $client->favoritesDestroy($status_id);
+        } catch (Exception $e) {
+            common_log(LOG_ERR, "Error attempting to unfavorite bridged notice on Twitter: " . $e->getMessage());
+        }
+
+        return true;
+    }
+
+    function onStartGetProfileUri($profile, &$uri)
+    {
+        if (preg_match('!^https?://twitter.com/!', $profile->profileurl)) {
+            $uri = $profile->profileurl;
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Add links in the user's profile block to their Twitter profile URL.
+     *
+     * @param Profile $profile The profile being shown
+     * @param Array   &$links  Writeable array of arrays (href, text, image).
+     *
+     * @return boolean hook value (true)
+     */
+
+    function onOtherAccountProfiles($profile, &$links)
+    {
+        $fuser = null;
+
+        try {
+            $flink = Foreign_link::getByUserID($profile->id, TWITTER_SERVICE);
+            $fuser = $flink->getForeignUser();
+
+            $links[] = array("href" => $fuser->uri,
+                             "text" => sprintf(_("@%s on Twitter"), $fuser->nickname),
+                             "image" => $this->path("icons/twitter-bird-white-on-blue.png"));
+        } catch (NoResultException $e) {
+            // no foreign link and/or user for Twitter on this profile ID
+        }
+
+        return true;
+    }
+
+    public function onEndShowHeadElements(Action $action)
+    {
+        if($action instanceof ShowNoticeAction) { // Showing a notice
+            $notice = Notice::getKV('id', $action->arg('notice'));
+
+            try {
+                $flink = Foreign_link::getByUserID($notice->profile_id, TWITTER_SERVICE);
+                $fuser = Foreign_user::getForeignUser($flink->foreign_id, TWITTER_SERVICE);
+            } catch (NoResultException $e) {
+                return true;
+            }
+
+            $statusId = twitter_status_id($notice);
+            if($notice instanceof Notice && $notice->isLocal() && $statusId) {
+                $tweetUrl = 'https://twitter.com/' . $fuser->nickname . '/status/' . $statusId;
+                $action->element('link', array('rel' => 'syndication', 'href' => $tweetUrl));
+            }
+        }
+
+        if (!($action instanceof AttachmentAction)) {
+            return true;
+        }
+
+        /* Twitter card support. See https://dev.twitter.com/docs/cards */
+        /* @fixme: should we display twitter cards only for attachments posted
+         *         by local users ? Seems mandatory to display twitter:creator
+         *
+         * Author: jbfavre
+         */
+        switch ($action->attachment->mimetype) {
+            case 'image/pjpeg':
+            case 'image/jpeg':
+            case 'image/jpg':
+            case 'image/png':
+            case 'image/gif':
+                $action->element('meta', array('name'    => 'twitter:card',
+                                             'content' => 'photo'),
+                                       null);
+                $action->element('meta', array('name'    => 'twitter:url',
+                                             'content' => common_local_url('attachment',
+                                                              array('attachment' => $action->attachment->id))),
+                                       null );
+                $action->element('meta', array('name'    => 'twitter:image',
+                                             'content' => $action->attachment->url));
+                $action->element('meta', array('name'    => 'twitter:title',
+                                             'content' => $action->attachment->title));
+
+                $ns = new AttachmentNoticeSection($action);
+                $notices = $ns->getNotices();
+                $noticeArray = $notices->fetchAll();
+
+                // Should not have more than 1 notice for this attachment.
+                if( count($noticeArray) != 1 ) { break; }
+                $post = $noticeArray[0];
+
+                try {
+                    $flink = Foreign_link::getByUserID($post->profile_id, TWITTER_SERVICE);
+                    $fuser = Foreign_user::getForeignUser($flink->foreign_id, TWITTER_SERVICE);
+                    $action->element('meta', array('name'    => 'twitter:creator',
+                                                   'content' => '@'.$fuser->nickname));
+                } catch (NoResultException $e) {
+                    // no foreign link and/or user for Twitter on this profile ID
+                }
+                break;
+            default:
+                break;
+        }
+
+        return true;
+    }
+}