gnu-social/plugins/RSSCloud/RSSCloudPlugin.php

296 lines
8.5 KiB
PHP
Raw Normal View History

2009-09-12 06:28:22 +09:00
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Plugin to support RSSCloud
*
* 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
* @author Zach Copley <zach@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/
*/
if (!defined('STATUSNET')) {
exit(1);
}
define('RSSCLOUDPLUGIN_VERSION', '0.1');
/**
* Plugin class for adding RSSCloud capabilities to StatusNet
*
* @category Plugin
* @package StatusNet
* @author Zach Copley <zach@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/
**/
2009-09-12 06:28:22 +09:00
class RSSCloudPlugin extends Plugin
2009-09-12 06:28:22 +09:00
{
/**
* Our friend, the constructor
*
* @return void
*/
2009-09-12 06:28:22 +09:00
function __construct()
{
parent::__construct();
}
/**
* Setup the info for the subscription handler. Allow overriding
* to point at another cloud hub (not currently used).
*
* @return void
*/
function onInitializePlugin()
{
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.
*
2009-12-15 06:24:49 +09:00
* @param Mapper &$m URL parser and mapper
*
* @return boolean hook return
*/
function onRouterInitialized(&$m)
{
2009-12-15 06:24:49 +09:00
$m->connect('/main/rsscloud/request_notify',
array('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.
2009-12-15 06:24:49 +09:00
//$m->connect('/main/rsscloud/notify',
// array('action' => 'LoggingAggregator'));
return true;
}
/**
* Automatically load the actions and libraries used by
* the RSSCloud plugin
*
* @param Class $cls the class
*
* @return boolean hook return
*
*/
function onAutoload($cls)
{
switch ($cls)
{
2009-12-15 06:24:49 +09:00
case 'RSSCloudSubscription':
include_once INSTALLDIR . '/plugins/RSSCloud/RSSCloudSubscription.php';
return false;
2009-12-15 06:24:49 +09:00
case 'RSSCloudNotifier':
include_once INSTALLDIR . '/plugins/RSSCloud/RSSCloudNotifier.php';
return false;
2009-12-15 06:24:49 +09:00
case 'RSSCloudRequestNotifyAction':
case 'LoggingAggregatorAction':
include_once INSTALLDIR . '/plugins/RSSCloud/' .
mb_substr($cls, 0, -6) . '.php';
return false;
2009-12-15 06:24:49 +09:00
default:
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
*/
2009-12-01 10:24:39 +09:00
function onStartApiRss($action)
{
if (get_class($action) == 'ApiTimelineUserAction') {
2009-09-12 06:28:22 +09:00
$attrs = array('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)
*
* @return boolean hook return
*/
2009-11-04 10:53:17 +09:00
function onStartEnqueueNotice($notice, &$transports)
{
array_push($transports, 'rsscloud');
return true;
}
2009-09-12 06:28:22 +09:00
2009-11-04 10:53:17 +09:00
/**
* broadcast the message when not using queuehandler
*
* @param Notice &$notice the notice
* @param array $queue destination queue
*
* @return boolean hook return
*/
2009-11-04 10:53:17 +09:00
function onUnqueueHandleNotice(&$notice, $queue)
{
if (($queue == 'rsscloud') && ($this->_isLocal($notice))) {
2009-11-04 10:53:17 +09:00
common_debug('broadcasting rssCloud bound notice ' . $notice->id);
$profile = $notice->getProfile();
$notifier = new RSSCloudNotifier();
$notifier->notify($profile);
2009-11-04 10:53:17 +09:00
return false;
}
2009-11-04 10:53:17 +09:00
return true;
2009-09-12 06:28:22 +09:00
}
2009-11-04 10:53:17 +09:00
/**
* Determine whether the notice was locally created
*
2009-12-15 06:24:49 +09:00
* @param Notice $notice the notice in question
2009-11-04 10:53:17 +09:00
*
* @return boolean locality
*/
2009-11-04 10:53:17 +09:00
function _isLocal($notice)
{
return ($notice->is_local == Notice::LOCAL_PUBLIC ||
$notice->is_local == Notice::LOCAL_NONPUBLIC);
}
/**
* Create the rsscloud_subscription table if it's not
* already in the DB
*
* @return boolean hook return
*/
2009-12-15 06:24:49 +09:00
function onCheckSchema()
{
$schema = Schema::get();
$schema->ensureTable('rsscloud_subscription',
array(new ColumnDef('subscribed', 'integer',
null, false, 'PRI'),
new ColumnDef('url', 'varchar',
'255', false, 'PRI'),
new ColumnDef('failures', 'integer',
2009-12-01 10:24:39 +09:00
null, false, null, 0),
new ColumnDef('created', 'datetime',
null, false),
2009-12-01 10:24:39 +09:00
new ColumnDef('modified', 'timestamp',
null, false, null,
'CURRENT_TIMESTAMP',
'on update CURRENT_TIMESTAMP')
2009-12-15 06:24:49 +09:00
));
return true;
}
/**
* Add RSSCloudQueueHandler to the list of valid daemons to
* start
*
* @param array $daemons the list of daemons to run
*
* @return boolean hook return
*
*/
2009-12-09 06:04:26 +09:00
function onGetValidDaemons($daemons)
{
array_push($daemons, INSTALLDIR .
'/plugins/RSSCloud/RSSCloudQueueHandler.php');
return true;
}
function onPluginVersion(&$versions)
{
$versions[] = array('name' => 'RSSCloud',
'version' => RSSCLOUDPLUGIN_VERSION,
'author' => 'Zach Copley',
'homepage' => 'http://status.net/wiki/Plugin:RSSCloud',
'rawdescription' =>
_m('The RSSCloud plugin enables your StatusNet instance to publish ' .
'real-time updates for profile RSS feeds using the ' .
'<a href="http://rsscloud.org/">RSSCloud protocol</a>".'));
return true;
}
}