GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

[REALTIME] Reviewed both the superclass and its dist plugins

Browse Source
This commit is contained in:
Diogo Cordeiro
2019-11-03 15:37:49 +00:00
committed by Diogo Peralta Cordeiro
parent aab3584f93
commit 3b01aa31d3
80 changed files with 349 additions and 315 deletions
Download Patch File Download Diff File Expand all files Collapse all files

144
plugins/Meteor/MeteorPlugin.php
View File

@@ -1,46 +1,40 @@
<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
/**
* StatusNet, the distributed open-source microblogging tool
*
* Plugin to do "real time" updates using Meteor
*
* 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 StatusNet
* @package GNUsocial
* @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://status.net/
* @copyright 2010-2019 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
if (!defined('GNUSOCIAL') && !defined('STATUSNET')) {
exit(1);
}
defined('GNUSOCIAL') || die();
require_once INSTALLDIR.'/plugins/Realtime/RealtimePlugin.php';
require_once INSTALLDIR . DIRECTORY_SEPARATOR . 'lib/modules/Realtime/RealtimePlugin.php';
/**
* Plugin to do realtime updates using Meteor
*
* @category Plugin
* @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://status.net/
* @category Plugin
* @package GNUsocial
* @author Evan Prodromou <evan@status.net>
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
class MeteorPlugin extends RealtimePlugin
{
@@ -55,8 +49,14 @@ class MeteorPlugin extends RealtimePlugin
public $persistent = true;
protected $_socket = null;
function __construct($webserver=null, $webport=4670, $controlport=4671, $controlserver=null, $channelbase='', $protocol='http')
{
public function __construct(
?string $webserver = null,
int $webport = 4670,
int $controlport = 4671,
?string $controlserver = null,
string $channelbase = '',
string $protocol = 'http'
) {
global $config;
$this->webserver = (empty($webserver)) ? $config['site']['server'] : $webserver;
@@ -64,22 +64,24 @@ class MeteorPlugin extends RealtimePlugin
$this->controlport = $controlport;
$this->controlserver = (empty($controlserver)) ? $webserver : $controlserver;
$this->channelbase = $channelbase;
$this->protocol = $protocol;
$this->protocol = $protocol;
parent::__construct();
}
/**
* Pull settings from config file/database if set.
*/
function initialize()
public function initialize()
{
$settings = array('webserver',
'webport',
'controlport',
'controlserver',
'channelbase',
'protocol');
$settings = [
'webserver',
'webport',
'controlport',
'controlserver',
'channelbase',
'protocol',
];
foreach ($settings as $name) {
$val = common_config('meteor', $name);
if ($val !== false) {
@@ -90,47 +92,57 @@ class MeteorPlugin extends RealtimePlugin
return parent::initialize();
}
function _getScripts()
public function _getScripts()
{
$scripts = parent::_getScripts();
if ($this->protocol == 'https') {
$scripts[] = 'https://'.$this->webserver.(($this->webport == 443) ? '':':'.$this->webport).'/meteor.js';
$scripts[] = 'https://' . $this->webserver . (($this->webport == 443) ? '' : ':' . $this->webport) . '/meteor.js';
} else {
$scripts[] = 'http://'.$this->webserver.(($this->webport == 80) ? '':':'.$this->webport).'/meteor.js';
$scripts[] = 'http://' . $this->webserver . (($this->webport == 80) ? '' : ':' . $this->webport) . '/meteor.js';
}
$scripts[] = $this->path('js/meteorupdater.js');
return $scripts;
}
function _updateInitialize($timeline, $user_id)
public function _updateInitialize($timeline, int $user_id)
{
$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));
$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;
}
function _connect()
public 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;
if ($this->persistent) {
$flags |= STREAM_CLIENT_PERSISTENT;
}
// May throw an exception.
$this->_socket = stream_socket_client("tcp://{$controlserver}:{$this->controlport}", $errno, $errstr, $timeout, $flags);
$this->_socket = stream_socket_client(
"tcp://{$controlserver}:{$this->controlport}",
$errno,
$errstr,
$timeout,
$flags
);
if (!$this->_socket) {
// 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));
throw new Exception(sprintf(_m('Could not connect to %1$s on %2$s.'), $controlserver, $this->controlport));
}
}
function _publish($channel, $message)
public function _publish($channel, $message)
{
$message = json_encode($message);
$message = addslashes($message);
@@ -139,12 +151,12 @@ class MeteorPlugin extends RealtimePlugin
$result = fgets($this->_socket);
if (preg_match('/^ERR (.*)$/', $result, $matches)) {
// TRANS: Exception. %s is the Meteor message that could not be added.
throw new Exception(sprintf(_m('Error adding meteor message "%s".'),$matches[1]));
throw new Exception(sprintf(_m('Error adding meteor message "%s".'), $matches[1]));
}
// TODO: parse and deal with result
}
function _disconnect()
public function _disconnect()
{
if (!$this->persistent) {
$cnt = fwrite($this->_socket, "QUIT\n");
@@ -154,7 +166,7 @@ class MeteorPlugin extends RealtimePlugin
// Meteord flips out with default '/' separator
function _pathToChannel($path)
public function _pathToChannel(array $path): string
{
if (!empty($this->channelbase)) {
array_unshift($path, $this->channelbase);
@@ -164,13 +176,15 @@ class MeteorPlugin extends RealtimePlugin
public function onPluginVersion(array &$versions): bool
{
$versions[] = array('name' => 'Meteor',
'version' => self::PLUGIN_VERSION,
'author' => 'Evan Prodromou',
'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/Meteor',
'rawdescription' =>
// TRANS: Plugin description.
_m('Plugin to do "real time" updates using Meteor.'));
$versions[] = [
'name' => 'Meteor',
'version' => self::PLUGIN_VERSION,
'author' => 'Evan Prodromou',
'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/Meteor',
'rawdescription' =>
// TRANS: Plugin description.
_m('Plugin to do "real time" updates using Meteor.')
];
return true;
}
}

4
plugins/Meteor/README → plugins/Meteor/README.md
View File

@@ -4,7 +4,7 @@ FriendFeed's "real time" news.
It requires a meteor server.
http://meteorserver.org/
https://github.com/visitsb/meteorserver/
Note that the controller interface needs to be accessible by the Web server, and
the subscriber interface needs to be accessible by your Web users. You MUST
@@ -13,7 +13,7 @@ push any message to your subscribers. Not good!
You can enable the plugin with this line in config.php:
addPlugin('Meteor', array('webserver' => 'meteor server address'));
addPlugin('Meteor', ['webserver' => 'meteor server address']);
Available parameters:
* webserver: Web server address. Defaults to site server.