Merge branch 'orbited' into 0.9.x

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/";
+    }
+}

plugins/Orbited/README

@@ -0,0 +1,26 @@
+This is a plugin to automatically load notices in the browser no
+matter who creates them -- the kind of thing we see with
+search.twitter.com, rejaw.com, or FriendFeed's "real time" news.
+
+NOTE: this is an insecure version; don't roll it out on a production
+server.
+
+It requires a cometd server. I've only had the cometd-java server work
+correctly; something's wiggy with the Twisted-based server.
+
+After you have a cometd server installed, just add this code to your
+config.php:
+
+    require_once(INSTALLDIR.'/plugins/Comet/CometPlugin.php');
+    $cp = new CometPlugin('http://example.com:8080/cometd/');
+
+Change 'example.com:8080' to the name and port of the server you
+installed cometd on.
+
+TODO:
+
+* Needs to be tested with Ajax submission. Probably messes everything
+  up.
+* Add more timelines: personal inbox and tags would be great.
+* Add security. In particular, only let the PHP code publish notices
+  to the cometd server. Currently, it doesn't try to authenticate.

plugins/Orbited/orbitedextra.js

@@ -0,0 +1,2 @@
+TCPSocket = Orbited.TCPSocket;
+

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);
+          }
+     }
+}();
+