<?php
/**
- * Laconica, the distributed open-source microblogging tool
+ * StatusNet, the distributed open-source microblogging tool
*
- * Plugin to do "real time" updates using Comet/Bayeux
+ * Plugin to do "real time" updates using Meteor
*
* PHP version 5
*
* 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.
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @copyright 2009 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link http://laconi.ca/
+ * @link http://status.net/
*/
-if (!defined('LACONICA')) {
+if (!defined('GNUSOCIAL') && !defined('STATUSNET')) {
exit(1);
}
+require_once INSTALLDIR.'/plugins/Realtime/RealtimePlugin.php';
+
/**
- * Plugin to do realtime updates using Comet
+ * Plugin to do realtime updates using Meteor
*
* @category Plugin
- * @package Laconica
- * @author Evan Prodromou <evan@controlyourself.ca>
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
- * @link http://laconi.ca/
+ * @link http://status.net/
*/
-
-class MeteorPlugin extends Plugin
+class MeteorPlugin extends RealtimePlugin
{
public $webserver = null;
public $webport = null;
public $controlport = null;
public $controlserver = null;
public $channelbase = null;
+ public $protocol = null;
+ public $persistent = true;
protected $_socket = null;
- function __construct($webserver=null, $webport=4670, $controlport=4671, $controlserver=null, $channelbase='')
+ function __construct($webserver=null, $webport=4670, $controlport=4671, $controlserver=null, $channelbase='', $protocol='http')
{
global $config;
$this->controlport = $controlport;
$this->controlserver = (empty($controlserver)) ? $webserver : $controlserver;
$this->channelbase = $channelbase;
-
+ $this->protocol = $protocol;
+
parent::__construct();
}
- function onEndShowScripts($action)
+ /**
+ * Pull settings from config file/database if set.
+ */
+ function initialize()
{
- $timeline = null;
-
- 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;
+ $settings = array('webserver',
+ 'webport',
+ 'controlport',
+ 'controlserver',
+ 'channelbase',
+ 'protocol');
+ foreach ($settings as $name) {
+ $val = common_config('meteor', $name);
+ if ($val !== false) {
+ $this->$name = $val;
}
- break;
- default:
- return true;
- }
-
- $action->element('script', array('type' => 'text/javascript',
- 'src' => 'http://'.$this->webserver.(($this->webport == 80) ? '':':'.$this->webport).'/meteor.js'),
- ' ');
-
- foreach (array('meteorupdater.js', 'json2.js') as $script) {
- $action->element('script', array('type' => 'text/javascript',
- 'src' => common_path('plugins/Meteor/'.$script)),
- ' ');
}
- $user = common_current_user();
+ return parent::initialize();
+ }
- if (!empty($user->id)) {
- $user_id = $user->id;
+ function _getScripts()
+ {
+ $scripts = parent::_getScripts();
+ if ($this->protocol == 'https') {
+ $scripts[] = 'https://'.$this->webserver.(($this->webport == 443) ? '':':'.$this->webport).'/meteor.js';
} else {
- $user_id = 0;
+ $scripts[] = 'http://'.$this->webserver.(($this->webport == 80) ? '':':'.$this->webport).'/meteor.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() { MeteorUpdater.init(\"$this->webserver\", $this->webport, \"{$this->channelbase}{$timeline}\", $user_id, \"$replyurl\", \"$favorurl\", \"$deleteurl\"); });");
- $action->elementEnd('script');
-
- return true;
+ $scripts[] = $this->path('js/meteorupdater.js');
+ return $scripts;
}
- function onEndNoticeSave($notice)
+ function _updateInitialize($timeline, $user_id)
{
- $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);
-
- if (!empty($tags)) {
- foreach ($tags as $tag) {
- $timelines[] = 'timelines-tag-' . $tag;
- }
- }
-
- if (count($timelines) > 0) {
-
- $json = json_encode($this->noticeAsJson($notice));
-
- $this->_connect();
-
- foreach ($timelines as $timeline) {
- $this->_addMessage($timeline, $json);
- }
-
- $this->_disconnect();
- }
-
- return true;
+ $script = parent::_updateInitialize($timeline, $user_id);
+ $ours = sprintf("MeteorUpdater.init(%s, %s, %s, %s);",
+ json_encode($this->webserver),
+ json_encode($this->webport),
+ json_encode($this->protocol),
+ json_encode($timeline));
+ return $script." ".$ours;
}
- protected function _connect()
+ function _connect()
{
$controlserver = (empty($this->controlserver)) ? $this->webserver : $this->controlserver;
+
+ $errno = $errstr = null;
+ $timeout = 5;
+ $flags = STREAM_CLIENT_CONNECT;
+ if ($this->persistent) $flags |= STREAM_CLIENT_PERSISTENT;
+
// May throw an exception.
- $this->_socket = stream_socket_client("tcp://{$controlserver}:{$this->controlport}");
+ $this->_socket = stream_socket_client("tcp://{$controlserver}:{$this->controlport}", $errno, $errstr, $timeout, $flags);
if (!$this->_socket) {
- throw new Exception("Couldn't connect to {$controlserver} on {$this->controlport}");
+ // TRANS: Exception. %1$s is the control server, %2$s is the control port.
+ throw new Exception(sprintf(_m('Could not connect to %1$s on %2$s.'),$controlserver,$this->controlport));
}
}
- protected function _addMessage($channel, $message)
+ function _publish($channel, $message)
{
+ $message = json_encode($message);
$message = addslashes($message);
- $cmd = "ADDMESSAGE {$this->channelbase}{$channel} $message\n";
+ $cmd = "ADDMESSAGE $channel $message\n";
$cnt = fwrite($this->_socket, $cmd);
$result = fgets($this->_socket);
if (preg_match('/^ERR (.*)$/', $result, $matches)) {
- throw new Exception('Error adding meteor message "'.$matches[1].'"');
+ // TRANS: Exception. %s is the Meteor message that could not be added.
+ throw new Exception(sprintf(_m('Error adding meteor message "%s".'),$matches[1]));
}
// TODO: parse and deal with result
}
- protected function _disconnect()
+ function _disconnect()
{
- $cnt = fwrite($this->_socket, "QUIT\n");
- @fclose($this->_socket);
- }
-
- function noticeAsJson($notice)
- {
- // 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;
+ if (!$this->persistent) {
+ $cnt = fwrite($this->_socket, "QUIT\n");
+ @fclose($this->_socket);
}
-
- $profile = $notice->getProfile();
- $arr['user']['profile_url'] = $profile->profileurl;
-
- return $arr;
}
- function getNoticeTags($notice)
- {
- $tags = null;
-
- $nt = new Notice_tag();
- $nt->notice_id = $notice->id;
+ // Meteord flips out with default '/' separator
- if ($nt->find()) {
- $tags = array();
- while ($nt->fetch()) {
- $tags[] = $nt->tag;
- }
+ function _pathToChannel($path)
+ {
+ if (!empty($this->channelbase)) {
+ array_unshift($path, $this->channelbase);
}
-
- $nt->free();
- $nt = null;
-
- return $tags;
+ return implode('-', $path);
}
- // Push this up to Plugin
-
- function log($level, $msg)
+ function onPluginVersion(array &$versions)
{
- common_log($level, get_class($this) . ': '.$msg);
+ $versions[] = array('name' => 'Meteor',
+ 'version' => GNUSOCIAL_VERSION,
+ 'author' => 'Evan Prodromou',
+ 'homepage' => 'http://status.net/wiki/Plugin:Meteor',
+ 'rawdescription' =>
+ // TRANS: Plugin description.
+ _m('Plugin to do "real time" updates using Meteor.'));
+ return true;
}
}
projects / quix0rs-gnu-social.git / blobdiff