/**
* 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
*
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
* @link http://laconi.ca/
*/
-class CometPlugin extends Plugin
+class OrbitedPlugin extends RealtimePlugin
{
- var $server = null;
-
- function __construct($server=null, $username=null, $password=null)
+ 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)
{
- $this->server = $server;
- $this->username = $username;
- $this->password = $password;
-
- parent::__construct();
+ // See http://orbited.org/wiki/Deployment#Cross-SubdomainDeployment
+ $action->element('script', null, ' document.domain = document.domain; ');
}
- function onEndShowScripts($action)
+ function _getScripts()
{
- $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 = parent::_getScripts();
- $scripts = array('jquery.comet.js', 'json2.js', 'updatetimeline.js');
+ $port = (is_null($this->webport)) ? 8000 : $this->webport;
- foreach ($scripts as $script) {
- $action->element('script', array('type' => 'text/javascript',
- 'src' => common_path('plugins/Comet/'.$script)),
- ' ');
- }
+ $server = (is_null($this->webserver)) ? common_config('site', 'server') : $this->webserver;
- $user = common_current_user();
+ $root = 'http://'.$server.(($port == 80) ? '':':'.$port);
- if (!empty($user->id)) {
- $user_id = $user->id;
- } else {
- $user_id = 0;
- }
+ $scripts[] = $root.'/static/Orbited.js';
+ $scripts[] = 'plugins/Orbited/orbitedextra.js';
+ $scripts[] = $root.'/static/protocols/stomp/stomp.js';
+ $scripts[] = 'plugins/Orbited/orbitedupdater.js';
- $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;
+ return $scripts;
}
- function onEndNoticeSave($notice)
+ function _updateInitialize($timeline, $user_id)
{
- $this->log(LOG_INFO, "Called for save notice.");
-
- $timelines = array();
-
- // XXX: Add other timelines; this is just for the public one
-
- if ($notice->is_local ||
- ($notice->is_local == 0 && !common_config('public', 'localonly'))) {
- $timelines[] = '/timelines/public';
- }
-
- $tags = $this->getNoticeTags($notice);
+ $script = parent::_updateInitialize($timeline, $user_id);
- if (!empty($tags)) {
- foreach ($tags as $tag) {
- $timelines[] = '/timelines/tag/' . $tag;
- }
- }
+ $server = $this->_getStompServer();
+ $port = $this->_getStompPort();
- if (count($timelines) > 0) {
- // Require this, since we need it
- require_once(INSTALLDIR.'/plugins/Comet/bayeux.class.inc.php');
+ return $script." OrbitedUpdater.init(\"$server\", $port, ".
+ "\"{$timeline}\", \"{$this->webuser}\", \"{$this->webpass}\");";
+ }
- $json = $this->noticeAsJson($notice);
+ function _connect()
+ {
+ require_once(INSTALLDIR.'/extlib/Stomp.php');
- // Bayeux? Comet? Huh? These terms confuse me
- $bay = new Bayeux($this->server, $this->user, $this->password);
+ $url = $this->_getStompUrl();
- foreach ($timelines as $timeline) {
- $this->log(LOG_INFO, "Posting notice $notice->id to '$timeline'.");
- $bay->publish($timeline, $json);
- }
+ $this->con = new Stomp($url);
- $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']);
-
- 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;
- }
+ $result = $this->con->send($channel,
+ json_encode($message));
- $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;
+ $this->con->disconnect();
+ }
- if ($nt->find()) {
- $tags = array();
- while ($nt->fetch()) {
- $tags[] = $nt->tag;
- }
+ function _pathToChannel($path)
+ {
+ if (!empty($this->channelbase)) {
+ array_unshift($path, $this->channelbase);
}
+ return '/' . implode('/', $path);
+ }
- $nt->free();
- $nt = null;
-
- return $tags;
+ function _getStompServer()
+ {
+ return (!is_null($this->stompserver)) ? $this->stompserver :
+ (!is_null($this->webserver)) ? $this->webserver :
+ common_config('site', 'server');
}
- // Push this up to Plugin
+ function _getStompPort()
+ {
+ return (!is_null($this->stompport)) ? $this->stompport : 61613;
+ }
- function log($level, $msg)
+ function _getStompUrl()
{
- common_log($level, get_class($this) . ': '.$msg);
+ $server = $this->_getStompServer();
+ $port = $this->_getStompPort();
+ return "tcp://$server:$port/";
}
}