gnu-social/plugins/RSSCloud/RSSCloudPlugin.php

231 lines
6.3 KiB
PHP
Raw Normal View History

2009-09-12 06:28:22 +09:00
<?php
2020-08-12 00:23:45 +09:00
// 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/>.
2009-09-12 06:28:22 +09:00
/**
* Plugin to support RSSCloud
*
* @category Plugin
2020-08-12 00:23:45 +09:00
* @package GNUsocial
2009-09-12 06:28:22 +09:00
* @author Zach Copley <zach@status.net>
* @copyright 2009 StatusNet, Inc.
2020-08-12 00:23:45 +09:00
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
2009-09-12 06:28:22 +09:00
*/
2020-08-12 00:23:45 +09:00
defined('GNUSOCIAL') || die();
2009-09-12 06:28:22 +09:00
define('RSSCLOUDPLUGIN_VERSION', '0.1.0');
/**
* Plugin class for adding RSSCloud capabilities to StatusNet
*
* @category Plugin
* @package StatusNet
* @author Zach Copley <zach@status.net>
2020-08-12 00:23:45 +09:00
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
class RSSCloudPlugin extends Plugin
2009-09-12 06:28:22 +09:00
{
/**
* Our friend, the constructor
*
* @return void
*/
2020-08-12 00:23:45 +09:00
public function __construct()
2009-09-12 06:28:22 +09:00
{
parent::__construct();
}
/**
* Setup the info for the subscription handler. Allow overriding
* to point at another cloud hub (not currently used).
*
* @return void
*/
2020-08-12 00:23:45 +09:00
public function onInitializePlugin(): void
{
2009-09-12 06:28:22 +09:00
$this->domain = common_config('rsscloud', 'domain');
$this->port = common_config('rsscloud', 'port');
$this->path = common_config('rsscloud', 'path');
$this->funct = common_config('rsscloud', 'function');
$this->protocol = common_config('rsscloud', 'protocol');
2009-09-12 06:28:22 +09:00
// set defaults
2009-12-29 12:52:02 +09:00
$local_server = parse_url(common_path('main/rsscloud/request_notify'));
2009-09-12 06:28:22 +09:00
if (empty($this->domain)) {
$this->domain = $local_server['host'];
2009-09-12 06:28:22 +09:00
}
2009-09-12 06:28:22 +09:00
if (empty($this->port)) {
$this->port = '80';
2009-09-12 06:28:22 +09:00
}
2009-09-12 06:28:22 +09:00
if (empty($this->path)) {
2009-12-29 12:52:02 +09:00
$this->path = $local_server['path'];
2009-09-12 06:28:22 +09:00
}
if (empty($this->funct)) {
$this->funct = '';
}
if (empty($this->protocol)) {
$this->protocol = 'http-post';
}
}
/**
* Add RSSCloud-related paths to the router table
*
* Hook for RouterInitialized event.
*
2020-08-12 00:23:45 +09:00
* @param URLMapper $m URL parser and mapper
* @return bool hook return
*/
2020-08-12 00:23:45 +09:00
public function onRouterInitialized(URLMapper $m): bool
{
2020-08-12 00:23:45 +09:00
$m->connect(
'main/rsscloud/request_notify',
['action' => 'RSSCloudRequestNotify']
);
// XXX: This is just for end-to-end testing. Uncomment if you need to pretend
// to be a cloud hub for some reason.
2020-08-12 00:23:45 +09:00
//$m->connect(
// 'main/rsscloud/notify',
// ['action' => 'LoggingAggregator']
//);
return true;
}
/**
* Add a <cloud> element to the RSS feed (after the rss <channel>
* element is started).
*
2009-12-15 06:24:49 +09:00
* @param Action $action the ApiAction
* @return void
*/
2020-08-12 00:23:45 +09:00
public function onStartApiRss(Action $action): void
2009-12-01 10:24:39 +09:00
{
if (get_class($action) == 'ApiTimelineUserAction') {
2020-08-12 00:23:45 +09:00
$attrs = [
'domain' => $this->domain,
'port' => $this->port,
'path' => $this->path,
'registerProcedure' => $this->funct,
'protocol' => $this->protocol,
];
// Dipping into XMLWriter to avoid a full end element (</cloud>).
$action->xw->startElement('cloud');
foreach ($attrs as $name => $value) {
$action->xw->writeAttribute($name, $value);
}
2009-12-01 10:24:39 +09:00
$action->xw->endElement();
}
2009-09-12 06:28:22 +09:00
}
2009-11-04 10:53:17 +09:00
/**
* Add an RSSCloud queue item for each notice
*
* @param Notice $notice the notice
* @param array &$transports the list of transports (queues)
2020-08-12 00:23:45 +09:00
* @return bool hook return
2009-11-04 10:53:17 +09:00
*/
2020-08-12 00:23:45 +09:00
public function onStartEnqueueNotice(
Notice $notice,
array &$transports
): bool {
if ($notice->isLocal()) {
array_push($transports, 'rsscloud');
}
2009-11-04 10:53:17 +09:00
return true;
}
2009-09-12 06:28:22 +09:00
/**
* Create the rsscloud_subscription table if it's not
* already in the DB
*
2020-08-12 00:23:45 +09:00
* @return bool hook return
*/
2020-08-12 00:23:45 +09:00
public function onCheckSchema(): bool
2009-12-15 06:24:49 +09:00
{
$schema = Schema::get();
2020-08-12 00:23:45 +09:00
$schema->ensureTable(
'rsscloud_subscription',
RSSCloudSubscription::schemaDef()
);
return true;
}
/**
XMPP queued output & initial retooling of DB queue manager to support non-Notice objects. Queue handlers for XMPP individual & firehose output now send their XML stanzas to another output queue instead of connecting directly to the chat server. This lets us have as many general processing threads as we need, while all actual XMPP input and output go through a single daemon with a single connection open. This avoids problems with multiple connected resources: * multiple windows shown in some chat clients (psi, gajim, kopete) * extra load on server * incoming message delivery forwarding issues Database changes: * queue_item drops 'notice_id' in favor of a 'frame' blob. This is based on Craig Andrews' work branch to generalize queues to take any object, but conservatively leaving out the serialization for now. Table updater (preserves any existing queued items) in db/rc3to09.sql Code changes to watch out for: * Queue handlers should now define a handle() method instead of handle_notice() * QueueDaemon and XmppDaemon now share common i/o (IoMaster) and respawning thread management (RespawningDaemon) infrastructure. * The polling XmppConfirmManager has been dropped, as the message is queued directly when saving IM settings. * Enable $config['queue']['debug_memory'] to output current memory usage at each run through the event loop to watch for memory leaks To do: * Adapt XMPP i/o to component connection mode for multi-site support. * XMPP input can also be broken out to a queue, which would allow the actual notice save etc to be handled by general queue threads. * Make sure there are no problems with simply pushing serialized Notice objects to queues. * Find a way to improve interactive performance of the database-backed queue handler; polling is pretty painful to XMPP. * Possibly redo the way QueueHandlers are injected into a QueueManager. The grouping used to split out the XMPP output queue is a bit awkward. Conflicts: scripts/xmppdaemon.php
2010-01-23 05:52:36 +09:00
* Register RSSCloud notice queue handler
*
XMPP queued output & initial retooling of DB queue manager to support non-Notice objects. Queue handlers for XMPP individual & firehose output now send their XML stanzas to another output queue instead of connecting directly to the chat server. This lets us have as many general processing threads as we need, while all actual XMPP input and output go through a single daemon with a single connection open. This avoids problems with multiple connected resources: * multiple windows shown in some chat clients (psi, gajim, kopete) * extra load on server * incoming message delivery forwarding issues Database changes: * queue_item drops 'notice_id' in favor of a 'frame' blob. This is based on Craig Andrews' work branch to generalize queues to take any object, but conservatively leaving out the serialization for now. Table updater (preserves any existing queued items) in db/rc3to09.sql Code changes to watch out for: * Queue handlers should now define a handle() method instead of handle_notice() * QueueDaemon and XmppDaemon now share common i/o (IoMaster) and respawning thread management (RespawningDaemon) infrastructure. * The polling XmppConfirmManager has been dropped, as the message is queued directly when saving IM settings. * Enable $config['queue']['debug_memory'] to output current memory usage at each run through the event loop to watch for memory leaks To do: * Adapt XMPP i/o to component connection mode for multi-site support. * XMPP input can also be broken out to a queue, which would allow the actual notice save etc to be handled by general queue threads. * Make sure there are no problems with simply pushing serialized Notice objects to queues. * Find a way to improve interactive performance of the database-backed queue handler; polling is pretty painful to XMPP. * Possibly redo the way QueueHandlers are injected into a QueueManager. The grouping used to split out the XMPP output queue is a bit awkward. Conflicts: scripts/xmppdaemon.php
2010-01-23 05:52:36 +09:00
* @param QueueManager $manager
2020-08-12 00:23:45 +09:00
* @return bool hook return
*/
2020-08-12 00:23:45 +09:00
public function onEndInitializeQueueManager(QueueManager $manager): bool
2009-12-09 06:04:26 +09:00
{
XMPP queued output & initial retooling of DB queue manager to support non-Notice objects. Queue handlers for XMPP individual & firehose output now send their XML stanzas to another output queue instead of connecting directly to the chat server. This lets us have as many general processing threads as we need, while all actual XMPP input and output go through a single daemon with a single connection open. This avoids problems with multiple connected resources: * multiple windows shown in some chat clients (psi, gajim, kopete) * extra load on server * incoming message delivery forwarding issues Database changes: * queue_item drops 'notice_id' in favor of a 'frame' blob. This is based on Craig Andrews' work branch to generalize queues to take any object, but conservatively leaving out the serialization for now. Table updater (preserves any existing queued items) in db/rc3to09.sql Code changes to watch out for: * Queue handlers should now define a handle() method instead of handle_notice() * QueueDaemon and XmppDaemon now share common i/o (IoMaster) and respawning thread management (RespawningDaemon) infrastructure. * The polling XmppConfirmManager has been dropped, as the message is queued directly when saving IM settings. * Enable $config['queue']['debug_memory'] to output current memory usage at each run through the event loop to watch for memory leaks To do: * Adapt XMPP i/o to component connection mode for multi-site support. * XMPP input can also be broken out to a queue, which would allow the actual notice save etc to be handled by general queue threads. * Make sure there are no problems with simply pushing serialized Notice objects to queues. * Find a way to improve interactive performance of the database-backed queue handler; polling is pretty painful to XMPP. * Possibly redo the way QueueHandlers are injected into a QueueManager. The grouping used to split out the XMPP output queue is a bit awkward. Conflicts: scripts/xmppdaemon.php
2010-01-23 05:52:36 +09:00
$manager->connect('rsscloud', 'RSSCloudQueueHandler');
2009-12-09 06:04:26 +09:00
return true;
}
2020-08-12 00:23:45 +09:00
/**
* Ensure that subscriptions for a user are deleted
* when that user gets deleted.
*
* @param User $user
* @param array &$related list of related tables
*
* @return bool hook result
*/
public function onUserDeleteRelated(User $user, array &$related): bool
{
$sub = new RSSCloudSubscription();
$sub->subscribed = $user->id;
if ($sub->find()) {
while ($sub->fetch()) {
$sub->delete();
}
}
$sub->free();
return true;
}
public function onPluginVersion(array &$versions): bool
{
2020-08-12 00:23:45 +09:00
$versions[] = [
'name' => 'RSSCloud',
'version' => RSSCLOUDPLUGIN_VERSION,
'author' => 'Zach Copley',
'homepage' => GNUSOCIAL_ENGINE_REPO_URL . 'tree/master/plugins/RSSCloud',
'rawdescription' =>
// TRANS: Plugin description.
_m('The RSSCloud plugin enables your GNU social instance to '
. 'publish real-time updates for profile RSS feeds using the '
. '<a href="http://rsscloud.co/">rssCloud protocol</a>.'),
];
return true;
}
}