gnu-social/plugins/Comet/CometPlugin.php

128 lines
3.9 KiB
PHP
Raw Normal View History

<?php
/**
2009-08-25 23:29:56 +01:00
* StatusNet, the distributed open-source microblogging tool
*
* Plugin to do "real time" updates using Comet/Bayeux
*
* 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
2009-08-25 23:29:56 +01:00
* @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
2009-08-25 23:29:56 +01:00
* @link http://status.net/
*/
if (!defined('GNUSOCIAL') && !defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR . DIRECTORY_SEPARATOR . 'lib/modules/Realtime/RealtimePlugin.php';
/**
* Plugin to do realtime updates using Comet
*
* @category Plugin
2009-08-25 23:29:56 +01:00
* @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
2009-08-25 23:29:56 +01:00
* @link http://status.net/
*/
class CometPlugin extends RealtimePlugin
{
const PLUGIN_VERSION = '2.0.0';
public $server = null;
public $username = null;
public $password = null;
2009-07-15 20:31:42 +01:00
public $prefix = null;
protected $bay = null;
public function __construct(
?string $server = null,
?string $username = null,
?string $password = null,
?string $prefix = null
) {
$this->server = $server;
$this->username = $username;
$this->password = $password;
2009-07-15 20:31:42 +01:00
$this->prefix = $prefix;
parent::__construct();
}
public function _getScripts(): array
{
$scripts = parent::_getScripts();
$ours = ['js/jquery.comet.js', 'js/cometupdate.js'];
foreach ($ours as $script) {
$scripts[] = $this->path($script);
}
return $scripts;
}
public function _updateInitialize($timeline, int $user_id)
{
2009-07-15 20:31:42 +01:00
$script = parent::_updateInitialize($timeline, $user_id);
return $script." CometUpdate.init(\"$this->server\", \"$timeline\", $user_id, \"$this->replyurl\", \"$this->favorurl\", \"$this->deleteurl\");";
}
public function _connect(): void
{
require_once __DIR__. DIRECTORY_SEPARATOR . 'extlib/Bayeux/Bayeux.class.php';
// Bayeux? Comet? Huh? These terms confuse me
$this->bay = new Bayeux($this->server, $this->user, $this->password);
}
public function _publish($timeline, $json): void
2009-04-26 23:00:06 +01:00
{
$this->bay->publish($timeline, $json);
2009-04-26 23:00:06 +01:00
}
public function _disconnect(): void
{
unset($this->bay);
}
2009-07-15 20:31:42 +01:00
public function _pathToChannel(array $path): string
2009-07-15 20:31:42 +01:00
{
if (!empty($this->prefix)) {
array_unshift($path, $this->prefix);
}
return '/' . implode('/', $path);
}
2010-09-20 18:45:43 +01:00
public function onPluginVersion(array &$versions): bool
2010-09-20 18:45:43 +01:00
{
$versions[] = [
'name' => 'Comet',
'version' => self::PLUGIN_VERSION,
'author' => 'Evan Prodromou',
'homepage' => GNUSOCIAL_ENGINE_REPO_URL . 'tree/master/plugins/Comet',
'rawdescription' =>
// TRANS: Plugin description message. Bayeux is a protocol for transporting asynchronous messages
// TRANS: and Comet is a web application model.
_m('Plugin to make updates using Comet and Bayeux.')
];
2010-09-20 18:45:43 +01:00
return true;
}
}