Merge branch '0.9.x' into refactor-api

* 0.9.x: (23 commits) Added hook to wrap the notice form data block Unnecessary selector bit Removed obsolete iphone theme (pre v0.7) remove spurious readme from Orbited need to show scripts at end of body in RealtimePlugin Some changes required from Orbited debugging Update OrbitedPlugin to work with RealtimePlugin framework updated OrbitedPlugin to use RealtimePlugin remove unused files for OrbitedPlugin rename plugin copy Comet plugin to Orbited move scripts to just before </body>, add event for scripts that need to be in <head> reformat Notice.php added all them doxygens Using CDATA for autofocus script more doxygen added doxygen indent fix better handling of y response in deleteuser.php script to permanently delete a user ...
author: Zach Copley <zach@status.net> 2009-10-05 10:05:43 -0700
committer: Zach Copley <zach@status.net> 2009-10-05 10:05:43 -0700
commit: 2b7d8d0c29a9b28700828db5184ed6d1dc7b1922 (patch)
tree: 3dd0b4bdbbc421b155750fa77ddd38edd058d136 /plugins/Orbited
parent: ee207ffd8be4a7178d06ff7c6928dba3714146ec (diff)
parent: 7a33125a6c05a885a7e4c6d80be4e0fe26499565 (diff)
3 files changed, 180 insertions, 0 deletions
diff --git a/plugins/Orbited/OrbitedPlugin.php b/plugins/Orbited/OrbitedPlugin.php
new file mode 100644
index 000000000..ba87b266a
--- /dev/null
+++ b/plugins/Orbited/OrbitedPlugin.php
@@ -0,0 +1,154 @@
+<?php
+/**
+ * Laconica, the distributed open-source microblogging tool
+ *
+ * Plugin to do "real time" updates using Orbited + STOMP
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Plugin
+ * @package   Laconica
+ * @author    Evan Prodromou <evan@controlyourself.ca>
+ * @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')) {
+    exit(1);
+}
+
+require_once INSTALLDIR.'/plugins/Realtime/RealtimePlugin.php';
+
+/**
+ * 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
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://laconi.ca/
+ */
+
+class OrbitedPlugin extends RealtimePlugin
+{
+    public $webserver   = null;
+    public $webport     = null;
+    public $channelbase = null;
+    public $stompserver = null;
+    public $stompport   = null;
+    public $username    = null;
+    public $password    = null;
+    public $webuser     = null;
+    public $webpass     = null;
+
+    protected $con      = null;
+
+    function onStartShowHeadElements($action)
+    {
+        // See http://orbited.org/wiki/Deployment#Cross-SubdomainDeployment
+        $action->element('script', null, ' document.domain = document.domain; ');
+    }
+
+    function _getScripts()
+    {
+        $scripts = parent::_getScripts();
+
+        $port = (is_null($this->webport)) ? 8000 : $this->webport;
+
+        $server = (is_null($this->webserver)) ? common_config('site', 'server') : $this->webserver;
+
+        $root = 'http://'.$server.(($port == 80) ? '':':'.$port);
+
+        $scripts[] = $root.'/static/Orbited.js';
+        $scripts[] = common_path('plugins/Orbited/orbitedextra.js');
+        $scripts[] = $root.'/static/protocols/stomp/stomp.js';
+        $scripts[] = common_path('plugins/Orbited/orbitedupdater.js');
+
+        return $scripts;
+    }
+
+    function _updateInitialize($timeline, $user_id)
+    {
+        $script = parent::_updateInitialize($timeline, $user_id);
+
+        $server = $this->_getStompServer();
+        $port   = $this->_getStompPort();
+
+        return $script." OrbitedUpdater.init(\"$server\", $port, ".
+          "\"{$timeline}\", \"{$this->webuser}\", \"{$this->webpass}\");";
+    }
+
+    function _connect()
+    {
+        require_once(INSTALLDIR.'/extlib/Stomp.php');
+
+        $url = $this->_getStompUrl();
+
+        $this->con = new Stomp($url);
+
+        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');
+        }
+    }
+
+    function _publish($channel, $message)
+    {
+        $result = $this->con->send($channel,
+                                   json_encode($message));
+
+        return $result;
+        // TODO: parse and deal with result
+    }
+
+    function _disconnect()
+    {
+        $this->con->disconnect();
+    }
+
+    function _pathToChannel($path)
+    {
+        if (!empty($this->channelbase)) {
+            array_unshift($path, $this->channelbase);
+        }
+        return '/' . implode('/', $path);
+    }
+
+    function _getStompServer()
+    {
+        return (!is_null($this->stompserver)) ? $this->stompserver :
+        (!is_null($this->webserver)) ? $this->webserver :
+        common_config('site', 'server');
+    }
+
+    function _getStompPort()
+    {
+        return (!is_null($this->stompport)) ? $this->stompport : 61613;
+    }
+
+    function _getStompUrl()
+    {
+        $server = $this->_getStompServer();
+        $port   = $this->_getStompPort();
+        return "tcp://$server:$port/";
+    }
+}
diff --git a/plugins/Orbited/orbitedextra.js b/plugins/Orbited/orbitedextra.js
new file mode 100644
index 000000000..47e5c0c80
--- /dev/null
+++ b/plugins/Orbited/orbitedextra.js
@@ -0,0 +1,2 @@
+TCPSocket = Orbited.TCPSocket;
+
diff --git a/plugins/Orbited/orbitedupdater.js b/plugins/Orbited/orbitedupdater.js
new file mode 100644
index 000000000..8c5ab3b73
--- /dev/null
+++ b/plugins/Orbited/orbitedupdater.js
@@ -0,0 +1,24 @@
+// Update the local timeline from a Orbited server
+
+var OrbitedUpdater = function()
+{
+     return {
+
+          init: function(server, port, timeline, username, password)
+          {
+               // set up stomp client.
+               stomp = new STOMPClient();
+
+               stomp.onmessageframe = function(frame) {
+                    RealtimeUpdate.receive(JSON.parse(frame.body));
+               };
+
+               stomp.onconnectedframe = function() {
+                    stomp.subscribe(timeline);
+               }
+
+               stomp.connect(server, port, username, password);
+          }
+     }
+}();
+
author	Zach Copley <zach@status.net>	2009-10-05 10:05:43 -0700
committer	Zach Copley <zach@status.net>	2009-10-05 10:05:43 -0700
commit	2b7d8d0c29a9b28700828db5184ed6d1dc7b1922 (patch)
tree	3dd0b4bdbbc421b155750fa77ddd38edd058d136 /plugins/Orbited
parent	ee207ffd8be4a7178d06ff7c6928dba3714146ec (diff)
parent	7a33125a6c05a885a7e4c6d80be4e0fe26499565 (diff)