Merge branch 'inblob' of git@gitorious.org:~evan/statusnet/evans-mainline into inblob

[quix0rs-gnu-social.git] / plugins / TwitterBridge / TwitterBridgePlugin.php

diff --git a/plugins/TwitterBridge/TwitterBridgePlugin.php b/plugins/TwitterBridge/TwitterBridgePlugin.php
index 69bec06511524a027e8fcb86edb6ccc26fffd318..a87ee2894a77c443e0b9496f26270d963d7be188 100644 (file)
--- a/plugins/TwitterBridge/TwitterBridgePlugin.php
+++ b/plugins/TwitterBridge/TwitterBridgePlugin.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Laconica, the distributed open-source microblogging tool
+ * StatusNet, the distributed open-source microblogging tool
  *
  * PHP version 5
  *
@@ -18,25 +18,29 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  * @category  Plugin
- * @package   Laconica
- * @author    Zach Copley <zach@controlyourself.ca>
+ * @package   StatusNet
+ * @author    Zach Copley <zach@status.net>
  * @copyright 2009 Control Yourself, Inc.
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link      http://laconi.ca/
  */
 
-if (!defined('LACONICA')) {
+if (!defined('STATUSNET')) {
     exit(1);
 }
 
+require_once INSTALLDIR . '/plugins/TwitterBridge/twitter.php';
+
+define('TWITTERBRIDGEPLUGIN_VERSION', '0.9');
+
 /**
  * Plugin for sending and importing Twitter statuses
  *
  * This class allows users to link their Twitter accounts
  *
  * @category Plugin
- * @package  Laconica
- * @author   Zach Copley <zach@controlyourself.ca>
+ * @package  StatusNet
+ * @author   Zach Copley <zach@status.net>
  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link     http://laconi.ca/
  * @link     http://twitter.com/
@@ -58,61 +62,146 @@ class TwitterBridgePlugin extends Plugin
      *
      * Hook for RouterInitialized event.
      *
+     * @param Net_URL_Mapper $m path-to-action mapper
+     *
      * @return boolean hook return
      */
 
-    function onRouterInitialized(&$m)
+    function onRouterInitialized($m)
     {
-        $m->connect('twitter/authorization', array('action' => 'twitterauthorization'));
+        $m->connect('twitter/authorization',
+                    array('action' => 'twitterauthorization'));
         $m->connect('settings/twitter', array('action' => 'twittersettings'));
 
         return true;
     }
 
+    /**
+     * Add the Twitter Settings page to the Connect Settings menu
+     *
+     * @param Action &$action The calling page
+     *
+     * @return boolean hook return
+     */
     function onEndConnectSettingsNav(&$action)
     {
         $action_name = $action->trimmed('action');
 
         $action->menuItem(common_local_url('twittersettings'),
-                          _('Twitter'),
-                          _('Twitter integration options'),
+                          _m('Twitter'),
+                          _m('Twitter integration options'),
                           $action_name === 'twittersettings');
 
         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':
-            require_once(INSTALLDIR.'/plugins/TwitterBridge/' . strtolower(mb_substr($cls, 0, -6)) . '.php');
+        switch ($cls) {
+        case 'TwittersettingsAction':
+        case 'TwitterauthorizationAction':
+            include_once INSTALLDIR . '/plugins/TwitterBridge/' .
+              strtolower(mb_substr($cls, 0, -6)) . '.php';
             return false;
-         case 'TwitterOAuthClient':
-            require_once(INSTALLDIR.'/plugins/TwitterBridge/twitteroauthclient.php');
+        case 'TwitterOAuthClient':
+            include_once INSTALLDIR . '/plugins/TwitterBridge/twitteroauthclient.php';
             return false;
-         default:
+        default:
             return true;
         }
     }
 
-    function onStartEnqueueNotice($notice, $transports)
+    /**
+     * Add a Twitter queue item for each notice
+     *
+     * @param Notice $notice      the notice
+     * @param array  &$transports the list of transports (queues)
+     *
+     * @return boolean hook return
+     */
+    function onStartEnqueueNotice($notice, &$transports)
     {
-        array_push($transports, 'twitter');
+        // Avoid a possible loop
+
+        if ($notice->source != 'twitter') {
+            array_push($transports, 'twitter');
+        }
+
         return true;
     }
 
-    function onGetValidDaemons($daemons)
+    /**
+     * broadcast the message when not using queuehandler
+     *
+     * @param Notice &$notice the notice
+     * @param array  $queue   destination queue
+     *
+     * @return boolean hook return
+     */
+    function onUnqueueHandleNotice(&$notice, $queue)
     {
-        array_push($daemons, INSTALLDIR . '/plugins/TwitterBridge/daemons/twitterqueuehandler.php');
-        array_push($daemons, INSTALLDIR . '/plugins/TwitterBridge/daemons/synctwitterfriends.php');
+        if (($queue == 'twitter') && ($this->_isLocal($notice))) {
+            broadcast_twitter($notice);
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Determine whether the notice was locally created
+     *
+     * @param Notice $notice
+     *
+     * @return boolean locality
+     */
+    function _isLocal($notice)
+    {
+        return ($notice->is_local == Notice::LOCAL_PUBLIC ||
+                $notice->is_local == Notice::LOCAL_NONPUBLIC);
+    }
 
-        if (common_config('twitterbridge', 'enabled')) {
-            array_push($daemons, INSTALLDIR . '/plugins/TwitterBridge/daemons/twitterstatusfetcher.php');
+    /**
+     * Add Twitter bridge daemons to the list of daemons to start
+     *
+     * @param array $daemons the list fo daemons to run
+     *
+     * @return boolean hook return
+     *
+     */
+    function onGetValidDaemons($daemons)
+    {
+        array_push($daemons, INSTALLDIR .
+                   '/plugins/TwitterBridge/daemons/twitterqueuehandler.php');
+        array_push($daemons, INSTALLDIR .
+                   '/plugins/TwitterBridge/daemons/synctwitterfriends.php');
+
+        if (common_config('twitterimport', 'enabled')) {
+            array_push($daemons, INSTALLDIR
+                . '/plugins/TwitterBridge/daemons/twitterstatusfetcher.php');
         }
 
         return true;
     }
 
-}
\ No newline at end of file
+    function onPluginVersion(&$versions)
+    {
+        $versions[] = array('name' => 'TwitterBridge',
+                            'version' => TWITTERBRIDGEPLUGIN_VERSION,
+                            'author' => 'Zach Copley',
+                            'homepage' => 'http://status.net/wiki/Plugin:TwitterBridge',
+                            'rawdescription' =>
+                            _m('The Twitter "bridge" plugin allows you to integrate ' .
+                               'your StatusNet instance with ' .
+                               '<a href="http://twitter.com/">Twitter</a>.'));
+        return true;
+    }
+
+}