gnu-social/plugins/SubMirror/SubMirrorPlugin.php

187 lines
5.9 KiB
PHP
Raw Permalink Normal View History

<?php
/*
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2009-2010, StatusNet, Inc.
*
* 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/>.
*/
if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
/**
* @package SubMirrorPlugin
* @maintainer Brion Vibber <brion@status.net>
*/
class SubMirrorPlugin extends Plugin
{
const PLUGIN_VERSION = '2.0.0';
/**
* Hook for RouterInitialized event.
*
* @param URLMapper $m path-to-action mapper
* @return boolean hook return
*/
public function onRouterInitialized(URLMapper $m)
{
$m->connect('settings/mirror',
['action' => 'mirrorsettings']);
$m->connect('settings/mirror/add/:provider',
['action' => 'mirrorsettings'],
['provider' => '[A-Za-z0-9_-]+']);
$m->connect('settings/mirror/add',
['action' => 'addmirror']);
$m->connect('settings/mirror/edit',
['action' => 'editmirror']);
return true;
}
function handle($notice) : bool
{
// Is anybody mirroring?
$mirror = new SubMirror();
$mirror->subscribed = $notice->profile_id;
if ($mirror->find()) {
while ($mirror->fetch()) {
$mirror->repeat($notice);
}
}
}
public function onPluginVersion(array &$versions): bool
{
$versions[] = array('name' => 'SubMirror',
'version' => self::PLUGIN_VERSION,
'author' => 'Brion Vibber',
'homepage' => GNUSOCIAL_ENGINE_REPO_URL . 'tree/master/plugins/SubMirror',
'rawdescription' =>
// TRANS: Plugin description.
_m('Pull feeds into your timeline!'));
return true;
}
/**
* Menu item for personal subscriptions/groups area
*
2011-09-29 08:58:52 +01:00
* @param Action $action action being executed
*
* @return boolean hook return
*/
2011-09-29 08:58:52 +01:00
function onEndAccountSettingsNav($action)
{
$action_name = $action->trimmed('action');
2011-09-29 08:58:52 +01:00
common_debug("ACTION NAME = " . $action_name);
$action->menuItem(common_local_url('mirrorsettings'),
// TRANS: SubMirror plugin menu item on user settings page.
_m('MENU', 'Mirroring'),
// TRANS: SubMirror plugin tooltip for user settings menu item.
_m('Configure mirroring of posts from other feeds'),
$action_name === 'mirrorsettings');
return true;
}
function onCheckSchema()
{
$schema = Schema::get();
$schema->ensureTable('submirror', SubMirror::schemaDef());
// @hack until key definition support is merged
SubMirror::fixIndexes($schema);
return true;
}
/**
* Set up queue handlers for outgoing hub pushes
* @param QueueManager $qm
* @return boolean hook return
*/
function onEndInitializeQueueManager(QueueManager $qm)
{
// After each notice save, check if there's any repeat mirrors.
$qm->connect('mirror', 'MirrorQueueHandler');
return true;
}
function onStartEnqueueNotice($notice, &$transports)
{
$transports[] = 'mirror';
}
/**
* Let the OStatus subscription garbage collection know if we're
* making use of a remote feed, so it doesn't get dropped out
* from under us.
*
* @param Ostatus_profile $oprofile
* @param int $count in/out
* @return mixed hook return value
*/
function onOstatus_profileSubscriberCount(Ostatus_profile $oprofile, &$count)
{
try {
$profile = $oprofile->localProfile();
$mirror = new SubMirror();
$mirror->subscribed = $profile->id;
if ($mirror->find()) {
while ($mirror->fetch()) {
$count++;
}
}
} catch (NoProfileException $e) {
// We can't handle this kind of Ostatus_profile since it has no
// local profile
}
2012-01-27 20:27:46 +00:00
return true;
}
/**
* Add a count of mirrored feeds into a user's profile sidebar stats.
*
* @param Profile $profile
* @param array $stats
* @return boolean hook return value
*/
function onProfileStats($profile, &$stats)
{
$cur = common_current_user();
if (!empty($cur) && $cur->id == $profile->id) {
$mirror = new SubMirror();
$mirror->subscriber = $profile->id;
$entry = array(
'id' => 'mirrors',
// TRANS: Label in profile statistics section, followed by a count.
'label' => _m('Mirrored feeds'),
'link' => common_local_url('mirrorsettings'),
'value' => $mirror->count(),
);
$insertAt = count($stats);
foreach ($stats as $i => $row) {
if ($row['id'] == 'groups') {
// Slip us in after them.
$insertAt = $i + 1;
break;
}
}
array_splice($stats, $insertAt, 0, array($entry));
}
return true;
}
}