updated OrbitedPlugin to use RealtimePlugin

diff --git a/plugins/Orbited/OrbitedPlugin.php b/plugins/Orbited/OrbitedPlugin.php
index 45251c66f04c5384127329352aa9f6fe67e52723..cf6e5de1392dfe5d01c773c51be5b0acd19cdd91 100644 (file)
--- a/plugins/Orbited/OrbitedPlugin.php
+++ b/plugins/Orbited/OrbitedPlugin.php
@@ -2,7 +2,7 @@
 /**
  * Laconica, the distributed open-source microblogging tool
  *
- * Plugin to do "real time" updates using Comet/Bayeux
+ * Plugin to do "real time" updates using Orbited + STOMP
  *
  * PHP version 5
  *
@@ -31,8 +31,13 @@ if (!defined('LACONICA')) {
     exit(1);
 }
 
+require_once INSTALLDIR.'/plugins/Realtime/RealtimePlugin.php';
+
 /**
- * Plugin to do realtime updates using Comet
+ * Plugin to do realtime updates using Orbited + STOMP
+ *
+ * This plugin pushes data to a STOMP server which is then served to the
+ * browser by the Orbited server.
  *
  * @category Plugin
  * @package  Laconica
@@ -41,165 +46,68 @@ if (!defined('LACONICA')) {
  * @link     http://laconi.ca/
  */
 
-class CometPlugin extends Plugin
+class OrbitedPlugin extends RealtimePlugin
 {
-    var $server = null;
+    public $webserver   = null;
+    public $webport     = null;
+    public $channelbase = null;
+    public $stompserver = null;
+    public $username    = null;
+    public $password    = null;
 
-    function __construct($server=null, $username=null, $password=null)
-    {
-        $this->server   = $server;
-        $this->username = $username;
-        $this->password = $password;
+    protected $con      = null;
 
-        parent::__construct();
+    function _getScripts()
+    {
+        $scripts = parent::_getScripts();
+        $root = 'http://'.$this->webserver.(($this->webport == 80) ? '':':'.$this->webport);
+        $scripts[] = $root.'/static/Orbited.js';
+        $scripts[] = $root.'/static/protocols/stomp/stomp.js';
+        $scripts[] = common_path('plugins/Orbited/orbitedupdater.js');
+        return $scripts;
     }
 
-    function onEndShowScripts($action)
+    function _updateInitialize($timeline, $user_id)
     {
-        $timeline = null;
-
-        $this->log(LOG_DEBUG, 'got action ' . $action->trimmed('action'));
-
-        switch ($action->trimmed('action')) {
-         case 'public':
-            $timeline = '/timelines/public';
-            break;
-         case 'tag':
-            $tag = $action->trimmed('tag');
-            if (!empty($tag)) {
-                $timeline = '/timelines/tag/'.$tag;
-            } else {
-                return true;
-            }
-            break;
-         default:
-            return true;
-        }
-
-        $scripts = array('jquery.comet.js', 'json2.js', 'updatetimeline.js');
-
-        foreach ($scripts as $script) {
-            $action->element('script', array('type' => 'text/javascript',
-                                             'src' => common_path('plugins/Comet/'.$script)),
-                         ' ');
-        }
-
-        $user = common_current_user();
-
-        if (!empty($user->id)) {
-            $user_id = $user->id;
-        } else {
-            $user_id = 0;
-        }
-
-        $replyurl = common_local_url('newnotice');
-        $favorurl = common_local_url('favor');
-        // FIXME: need to find a better way to pass this pattern in
-        $deleteurl = common_local_url('deletenotice',
-                                      array('notice' => '0000000000'));
-
-        $action->elementStart('script', array('type' => 'text/javascript'));
-        $action->raw("$(document).ready(function() { updater.init(\"$this->server\", \"$timeline\", $user_id, \"$replyurl\", \"$favorurl\", \"$deleteurl\"); });");
-        $action->elementEnd('script');
-
-        return true;
+        $script = parent::_updateInitialize($timeline, $user_id);
+        return $script." OrbitedUpdater.init(\"$this->stompserver\", $this->stompport, \"{$timeline}\");";
     }
 
-    function onEndNoticeSave($notice)
+    function _connect()
     {
-        $this->log(LOG_INFO, "Called for save notice.");
-
-        $timelines = array();
+        require_once(INSTALLDIR.'/extlibs/Stomp.php');
 
-        // XXX: Add other timelines; this is just for the public one
+        $stompserver = (empty($this->stompserver)) ? "tcp://{$this->webserver}:61613/" : $this->stompserver;
 
-        if ($notice->is_local ||
-            ($notice->is_local == 0 && !common_config('public', 'localonly'))) {
-            $timelines[] = '/timelines/public';
-        }
+        $this->con = new Stomp($stompserver);
 
-        $tags = $this->getNoticeTags($notice);
-
-        if (!empty($tags)) {
-            foreach ($tags as $tag) {
-                $timelines[] = '/timelines/tag/' . $tag;
-            }
-        }
-
-        if (count($timelines) > 0) {
-            // Require this, since we need it
-            require_once(INSTALLDIR.'/plugins/Comet/bayeux.class.inc.php');
-
-            $json = $this->noticeAsJson($notice);
-
-            // Bayeux? Comet? Huh? These terms confuse me
-            $bay = new Bayeux($this->server, $this->user, $this->password);
-
-            foreach ($timelines as $timeline) {
-                $this->log(LOG_INFO, "Posting notice $notice->id to '$timeline'.");
-                $bay->publish($timeline, $json);
-            }
-
-            $bay = NULL;
+        if ($this->con->connect($this->username, $this->password)) {
+            $this->_log(LOG_INFO, "Connected.");
+        } else {
+            $this->_log(LOG_ERR, 'Failed to connect to queue server');
+            throw new ServerException('Failed to connect to queue server');
         }
-
-        return true;
     }
 
-    function noticeAsJson($notice)
+    function _publish($channel, $message)
     {
-        // FIXME: this code should be abstracted to a neutral third
-        // party, like Notice::asJson(). I'm not sure of the ethics
-        // of refactoring from within a plugin, so I'm just abusing
-        // the TwitterApiAction method. Don't do this unless you're me!
-
-        require_once(INSTALLDIR.'/lib/twitterapi.php');
-
-        $act = new TwitterApiAction('/dev/null');
-
-        $arr = $act->twitter_status_array($notice, true);
-        $arr['url'] = $notice->bestUrl();
-        $arr['html'] = htmlspecialchars($notice->rendered);
-        $arr['source'] = htmlspecialchars($arr['source']);
+        $result = $this->con->send($channel,
+                                   json_encode($message));
 
-        if (!empty($notice->reply_to)) {
-            $reply_to = Notice::staticGet('id', $notice->reply_to);
-            if (!empty($reply_to)) {
-                $arr['in_reply_to_status_url'] = $reply_to->bestUrl();
-            }
-            $reply_to = null;
-        }
-
-        $profile = $notice->getProfile();
-        $arr['user']['profile_url'] = $profile->profileurl;
-
-        return $arr;
+        return $result;
+        // TODO: parse and deal with result
     }
 
-    function getNoticeTags($notice)
+    function _disconnect()
     {
-        $tags = null;
-
-        $nt = new Notice_tag();
-        $nt->notice_id = $notice->id;
-
-        if ($nt->find()) {
-            $tags = array();
-            while ($nt->fetch()) {
-                $tags[] = $nt->tag;
-            }
-        }
-
-        $nt->free();
-        $nt = null;
-
-        return $tags;
+        $this->con->disconnect();
     }
 
-    // Push this up to Plugin
-
-    function log($level, $msg)
+    function _pathToChannel($path)
     {
-        common_log($level, get_class($this) . ': '.$msg);
+        if (!empty($this->channelbase)) {
+            array_unshift($path, $this->channelbase);
+        }
+        return '/' . implode('/', $path);
     }
 }