updated OrbitedPlugin to use RealtimePlugin

This commit is contained in:
Evan Prodromou 2009-07-21 11:00:03 -07:00 committed by Evan Prodromou
parent 630dcda56f
commit 9c2d0879e9

View File

@ -2,7 +2,7 @@
/** /**
* Laconica, the distributed open-source microblogging tool * 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 * PHP version 5
* *
@ -31,8 +31,13 @@ if (!defined('LACONICA')) {
exit(1); 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 * @category Plugin
* @package Laconica * @package Laconica
@ -41,165 +46,68 @@ if (!defined('LACONICA')) {
* @link http://laconi.ca/ * @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) protected $con = null;
function _getScripts()
{ {
$this->server = $server; $scripts = parent::_getScripts();
$this->username = $username; $root = 'http://'.$this->webserver.(($this->webport == 80) ? '':':'.$this->webport);
$this->password = $password; $scripts[] = $root.'/static/Orbited.js';
$scripts[] = $root.'/static/protocols/stomp/stomp.js';
parent::__construct(); $scripts[] = common_path('plugins/Orbited/orbitedupdater.js');
return $scripts;
} }
function onEndShowScripts($action) function _updateInitialize($timeline, $user_id)
{ {
$timeline = null; $script = parent::_updateInitialize($timeline, $user_id);
return $script." OrbitedUpdater.init(\"$this->stompserver\", $this->stompport, \"{$timeline}\");";
}
$this->log(LOG_DEBUG, 'got action ' . $action->trimmed('action')); function _connect()
{
require_once(INSTALLDIR.'/extlibs/Stomp.php');
switch ($action->trimmed('action')) { $stompserver = (empty($this->stompserver)) ? "tcp://{$this->webserver}:61613/" : $this->stompserver;
case 'public':
$timeline = '/timelines/public'; $this->con = new Stomp($stompserver);
break;
case 'tag': if ($this->con->connect($this->username, $this->password)) {
$tag = $action->trimmed('tag'); $this->_log(LOG_INFO, "Connected.");
if (!empty($tag)) {
$timeline = '/timelines/tag/'.$tag;
} else { } else {
return true; $this->_log(LOG_ERR, 'Failed to connect to queue server');
throw new ServerException('Failed to connect to queue server');
} }
break;
default:
return true;
} }
$scripts = array('jquery.comet.js', 'json2.js', 'updatetimeline.js'); function _publish($channel, $message)
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;
}
function onEndNoticeSave($notice)
{ {
$this->log(LOG_INFO, "Called for save notice."); $result = $this->con->send($channel,
json_encode($message));
$timelines = array(); return $result;
// TODO: parse and deal with result
// 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); function _disconnect()
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;
}
return true;
}
function noticeAsJson($notice)
{ {
// FIXME: this code should be abstracted to a neutral third $this->con->disconnect();
// 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;
} }
$profile = $notice->getProfile(); function _pathToChannel($path)
$arr['user']['profile_url'] = $profile->profileurl;
return $arr;
}
function getNoticeTags($notice)
{ {
$tags = null; if (!empty($this->channelbase)) {
array_unshift($path, $this->channelbase);
$nt = new Notice_tag();
$nt->notice_id = $notice->id;
if ($nt->find()) {
$tags = array();
while ($nt->fetch()) {
$tags[] = $nt->tag;
} }
} return '/' . implode('/', $path);
$nt->free();
$nt = null;
return $tags;
}
// Push this up to Plugin
function log($level, $msg)
{
common_log($level, get_class($this) . ': '.$msg);
} }
} }