summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
Diffstat (limited to 'plugins')
-rw-r--r--plugins/OStatus/OStatusPlugin.php18
-rw-r--r--plugins/OStatus/classes/FeedSub.php30
-rw-r--r--plugins/OStatus/classes/Ostatus_profile.php45
-rw-r--r--plugins/OStatus/lib/magicenvelope.php6
-rw-r--r--plugins/SubMirror/SubMirrorPlugin.php165
-rw-r--r--plugins/SubMirror/actions/addmirror.php77
-rw-r--r--plugins/SubMirror/actions/basemirror.php169
-rw-r--r--plugins/SubMirror/actions/editmirror.php112
-rw-r--r--plugins/SubMirror/actions/mirrorsettings.php106
-rw-r--r--plugins/SubMirror/classes/SubMirror.php213
-rw-r--r--plugins/SubMirror/lib/addmirrorform.php141
-rw-r--r--plugins/SubMirror/lib/editmirrorform.php189
-rw-r--r--plugins/SubMirror/lib/mirrorqueuehandler.php45
13 files changed, 1294 insertions, 22 deletions
diff --git a/plugins/OStatus/OStatusPlugin.php b/plugins/OStatus/OStatusPlugin.php
index 70971c5b3..3b073a5d1 100644
--- a/plugins/OStatus/OStatusPlugin.php
+++ b/plugins/OStatus/OStatusPlugin.php
@@ -480,6 +480,24 @@ class OStatusPlugin extends Plugin
}
/**
+ * Tell the FeedSub infrastructure whether we have any active OStatus
+ * usage for the feed; if not it'll be able to garbage-collect the
+ * feed subscription.
+ *
+ * @param FeedSub $feedsub
+ * @param integer $count in/out
+ * @return mixed hook return code
+ */
+ function onFeedSubSubscriberCount($feedsub, &$count)
+ {
+ $oprofile = Ostatus_profile::staticGet('feeduri', $feedsub->uri);
+ if ($oprofile) {
+ $count += $oprofile->subscriberCount();
+ }
+ return true;
+ }
+
+ /**
* When about to subscribe to a remote user, start a server-to-server
* PuSH subscription if needed. If we can't establish that, abort.
*
diff --git a/plugins/OStatus/classes/FeedSub.php b/plugins/OStatus/classes/FeedSub.php
index b10509dae..9cd35e29c 100644
--- a/plugins/OStatus/classes/FeedSub.php
+++ b/plugins/OStatus/classes/FeedSub.php
@@ -255,6 +255,9 @@ class FeedSub extends Memcached_DataObject
/**
* Send a PuSH unsubscription request to the hub for this feed.
* The hub will later send us a confirmation POST to /main/push/callback.
+ * Warning: this will cancel the subscription even if someone else in
+ * the system is using it. Most callers will want garbageCollect() instead,
+ * which confirms there's no uses left.
*
* @return bool true on success, false on failure
* @throws ServerException if feed state is not valid
@@ -275,6 +278,33 @@ class FeedSub extends Memcached_DataObject
return $this->doSubscribe('unsubscribe');
}
+ /**
+ * Check if there are any active local uses of this feed, and if not then
+ * make sure it's inactive, unsubscribing if necessary.
+ *
+ * @return boolean true if the subscription is now inactive, false if still active.
+ */
+ public function garbageCollect()
+ {
+ if ($this->sub_state == '' || $this->sub_state == 'inactive') {
+ // No active PuSH subscription, we can just leave it be.
+ return true;
+ } else {
+ // PuSH subscription is either active or in an indeterminate state.
+ // Check if we're out of subscribers, and if so send an unsubscribe.
+ $count = 0;
+ Event::handle('FeedSubSubscriberCount', array($this, &$count));
+
+ if ($count) {
+ common_log(LOG_INFO, __METHOD__ . ': ok, ' . $count . ' user(s) left for ' . $this->uri);
+ return false;
+ } else {
+ common_log(LOG_INFO, __METHOD__ . ': unsubscribing, no users left for ' . $this->uri);
+ return $this->unsubscribe();
+ }
+ }
+ }
+
protected function doSubscribe($mode)
{
$orig = clone($this);
diff --git a/plugins/OStatus/classes/Ostatus_profile.php b/plugins/OStatus/classes/Ostatus_profile.php
index 5d3f37cd0..2d7c632e6 100644
--- a/plugins/OStatus/classes/Ostatus_profile.php
+++ b/plugins/OStatus/classes/Ostatus_profile.php
@@ -215,22 +215,13 @@ class Ostatus_profile extends Memcached_DataObject
}
/**
- * Send a PuSH unsubscription request to the hub for this feed.
- * The hub will later send us a confirmation POST to /main/push/callback.
+ * Check if this remote profile has any active local subscriptions, and
+ * if not drop the PuSH subscription feed.
*
* @return bool true on success, false on failure
- * @throws ServerException if feed state is not valid
*/
public function unsubscribe() {
- $feedsub = FeedSub::staticGet('uri', $this->feeduri);
- if (!$feedsub || $feedsub->sub_state == '' || $feedsub->sub_state == 'inactive') {
- // No active PuSH subscription, we can just leave it be.
- return true;
- } else {
- // PuSH subscription is either active or in an indeterminate state.
- // Send an unsubscribe.
- return $feedsub->unsubscribe();
- }
+ $this->garbageCollect();
}
/**
@@ -241,19 +232,35 @@ class Ostatus_profile extends Memcached_DataObject
*/
public function garbageCollect()
{
+ $feedsub = FeedSub::staticGet('uri', $this->feeduri);
+ return $feedsub->garbageCollect();
+ }
+
+ /**
+ * Check if this remote profile has any active local subscriptions, so the
+ * PuSH subscription layer can decide if it can drop the feed.
+ *
+ * This gets called via the FeedSubSubscriberCount event when running
+ * FeedSub::garbageCollect().
+ *
+ * @return int
+ */
+ public function subscriberCount()
+ {
if ($this->isGroup()) {
$members = $this->localGroup()->getMembers(0, 1);
$count = $members->N;
} else {
$count = $this->localProfile()->subscriberCount();
}
- if ($count == 0) {
- common_log(LOG_INFO, "Unsubscribing from now-unused remote feed $this->feeduri");
- $this->unsubscribe();
- return true;
- } else {
- return false;
- }
+ common_log(LOG_INFO, __METHOD__ . " SUB COUNT BEFORE: $count");
+
+ // Other plugins may be piggybacking on OStatus without having
+ // an active group or user-to-user subscription we know about.
+ Event::handle('Ostatus_profileSubscriberCount', array($this, &$count));
+ common_log(LOG_INFO, __METHOD__ . " SUB COUNT AFTER: $count");
+
+ return $count;
}
/**
diff --git a/plugins/OStatus/lib/magicenvelope.php b/plugins/OStatus/lib/magicenvelope.php
index 3bdf24b31..967e5f6d1 100644
--- a/plugins/OStatus/lib/magicenvelope.php
+++ b/plugins/OStatus/lib/magicenvelope.php
@@ -210,13 +210,13 @@ class MagicEnvelope
}
$data_element = $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'data')->item(0);
-
+ $sig_element = $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'sig')->item(0);
return array(
- 'data' => trim($data_element->nodeValue),
+ 'data' => preg_replace('/\s/', '', $data_element->nodeValue),
'data_type' => $data_element->getAttribute('type'),
'encoding' => $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'encoding')->item(0)->nodeValue,
'alg' => $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'alg')->item(0)->nodeValue,
- 'sig' => $env_element->getElementsByTagNameNS(MagicEnvelope::NS, 'sig')->item(0)->nodeValue,
+ 'sig' => preg_replace('/\s/', '', $sig_element->nodeValue),
);
}
diff --git a/plugins/SubMirror/SubMirrorPlugin.php b/plugins/SubMirror/SubMirrorPlugin.php
new file mode 100644
index 000000000..7289e7793
--- /dev/null
+++ b/plugins/SubMirror/SubMirrorPlugin.php
@@ -0,0 +1,165 @@
+<?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/>.
+ */
+
+/**
+ * @package SubMirrorPlugin
+ * @maintainer Brion Vibber <brion@status.net>
+ */
+
+if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
+
+
+class SubMirrorPlugin extends Plugin
+{
+ /**
+ * Hook for RouterInitialized event.
+ *
+ * @param Net_URL_Mapper $m path-to-action mapper
+ * @return boolean hook return
+ */
+ function onRouterInitialized($m)
+ {
+ $m->connect('settings/mirror',
+ array('action' => 'mirrorsettings'));
+ $m->connect('settings/mirror/add',
+ array('action' => 'addmirror'));
+ $m->connect('settings/mirror/edit',
+ array('action' => 'editmirror'));
+ return true;
+ }
+
+ /**
+ * Automatically load the actions and libraries used by the plugin
+ *
+ * @param Class $cls the class
+ *
+ * @return boolean hook return
+ *
+ */
+ function onAutoload($cls)
+ {
+ $base = dirname(__FILE__);
+ $lower = strtolower($cls);
+ $files = array("$base/lib/$lower.php",
+ "$base/classes/$cls.php");
+ if (substr($lower, -6) == 'action') {
+ $files[] = "$base/actions/" . substr($lower, 0, -6) . ".php";
+ }
+ foreach ($files as $file) {
+ if (file_exists($file)) {
+ include_once $file;
+ return false;
+ }
+ }
+ return true;
+ }
+
+ function handle($notice)
+ {
+ // Is anybody mirroring?
+ $mirror = new SubMirror();
+ $mirror->subscribed = $notice->profile_id;
+ if ($mirror->find()) {
+ while ($mirror->fetch()) {
+ $mirror->repeat($notice);
+ }
+ }
+ }
+
+ function onPluginVersion(&$versions)
+ {
+ $versions[] = array('name' => 'SubMirror',
+ 'version' => STATUSNET_VERSION,
+ 'author' => 'Brion Vibber',
+ 'homepage' => 'http://status.net/wiki/Plugin:SubMirror',
+ 'rawdescription' =>
+ _m('Pull feeds into your timeline!'));
+
+ return true;
+ }
+
+ /**
+ * Menu item for settings
+ *
+ * @param Action &$action Action being executed
+ *
+ * @return boolean hook return
+ */
+
+ function onEndAccountSettingsNav(&$action)
+ {
+ $action_name = $action->trimmed('action');
+
+ $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());
+ 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($oprofile, &$count)
+ {
+ if ($oprofile->profile_id) {
+ $mirror = new SubMirror();
+ $mirror->subscribed = $oprofile->profile_id;
+ if ($mirror->find()) {
+ while ($mirror->fetch()) {
+ $count++;
+ }
+ }
+ }
+ return true;
+ }
+}
diff --git a/plugins/SubMirror/actions/addmirror.php b/plugins/SubMirror/actions/addmirror.php
new file mode 100644
index 000000000..5acdf1dfe
--- /dev/null
+++ b/plugins/SubMirror/actions/addmirror.php
@@ -0,0 +1,77 @@
+<?php
+/**
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 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/>.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package StatusNet
+ * @author Brion Vibber <brion@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
+ * @link http://status.net/
+ */
+
+if (!defined('STATUSNET')) {
+ exit(1);
+}
+
+/**
+ * Takes parameters:
+ *
+ * - feed: a profile ID
+ * - token: session token to prevent CSRF attacks
+ * - ajax: boolean; whether to return Ajax or full-browser results
+ *
+ * Only works if the current user is logged in.
+ *
+ * @category Action
+ * @package StatusNet
+ * @copyright 2010 StatusNet, Inc.
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
+ * @link http://status.net/
+ */
+
+class AddMirrorAction extends BaseMirrorAction
+{
+ var $feedurl;
+
+ /**
+ * Check pre-requisites and instantiate attributes
+ *
+ * @param Array $args array of arguments (URL, GET, POST)
+ *
+ * @return boolean success flag
+ */
+
+ function prepare($args)
+ {
+ parent::prepare($args);
+ $this->feedurl = $this->validateFeedUrl($this->trimmed('feedurl'));
+ $this->profile = $this->profileForFeed($this->feedurl);
+ return true;
+ }
+
+ function saveMirror()
+ {
+ if ($this->oprofile->subscribe()) {
+ SubMirror::saveMirror($this->user, $this->profile);
+ } else {
+ $this->serverError(_m("Could not subscribe to feed."));
+ }
+ }
+}
diff --git a/plugins/SubMirror/actions/basemirror.php b/plugins/SubMirror/actions/basemirror.php
new file mode 100644
index 000000000..5be0699f0
--- /dev/null
+++ b/plugins/SubMirror/actions/basemirror.php
@@ -0,0 +1,169 @@
+<?php
+/**
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 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/>.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package StatusNet
+ * @author Brion Vibber <brion@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
+ * @link http://status.net/
+ */
+
+if (!defined('STATUSNET')) {
+ exit(1);
+}
+
+/**
+ * Takes parameters:
+ *
+ * - feed: a profile ID
+ * - token: session token to prevent CSRF attacks
+ * - ajax: boolean; whether to return Ajax or full-browser results
+ *
+ * Only works if the current user is logged in.
+ *
+ * @category Action
+ * @package StatusNet
+ * @copyright 2010 StatusNet, Inc.
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
+ * @link http://status.net/
+ */
+
+abstract class BaseMirrorAction extends Action
+{
+ var $user;
+ var $profile;
+
+ /**
+ * Check pre-requisites and instantiate attributes
+ *
+ * @param Array $args array of arguments (URL, GET, POST)
+ *
+ * @return boolean success flag
+ */
+
+ function prepare($args)
+ {
+ parent::prepare($args);
+ return $this->sharedBoilerplate();
+ }
+
+ protected function validateFeedUrl($url)
+ {
+ if (common_valid_http_url($url)) {
+ return $url;
+ } else {
+ $this->clientError(_m("Invalid feed URL."));
+ }
+ }
+
+ protected function validateProfile($id)
+ {
+ $id = intval($id);
+ $profile = Profile::staticGet('id', $id);
+ if ($profile && $profile->id != $this->user->id) {
+ return $profile;
+ }
+ // TRANS: Error message returned to user when setting up feed mirroring, but we were unable to resolve the given URL to a working feed.
+ $this->clientError(_m("Invalid profile for mirroring."));
+ }
+
+ /**
+ *
+ * @param string $url
+ * @return Profile
+ */
+ protected function profileForFeed($url)
+ {
+ $oprofile = Ostatus_profile::ensureProfileURL($url);
+ if ($oprofile->isGroup()) {
+ $this->clientError(_m("Can't mirror a StatusNet group at this time."));
+ }
+ $this->oprofile = $oprofile; // @fixme ugly side effect :D
+ return $oprofile->localProfile();
+ }
+
+ /**
+ * @fixme none of this belongs in end classes
+ * this stuff belongs in shared code!
+ */
+ function sharedBoilerplate()
+ {
+ // Only allow POST requests
+
+ if ($_SERVER['REQUEST_METHOD'] != 'POST') {
+ $this->clientError(_('This action only accepts POST requests.'));
+ return false;
+ }
+
+ // CSRF protection
+
+ $token = $this->trimmed('token');
+
+ if (!$token || $token != common_session_token()) {
+ $this->clientError(_('There was a problem with your session token.'.
+ ' Try again, please.'));
+ return false;
+ }
+
+ // Only for logged-in users
+
+ $this->user = common_current_user();
+
+ if (empty($this->user)) {
+ $this->clientError(_('Not logged in.'));
+ return false;
+ }
+ return true;
+ }
+
+ /**
+ * Handle request
+ *
+ * Does the subscription and returns results.
+ *
+ * @param Array $args unused.
+ *
+ * @return void
+ */
+
+ function handle($args)
+ {
+ // Throws exception on error
+ $this->saveMirror();
+
+ if ($this->boolean('ajax')) {
+ $this->startHTML('text/xml;charset=utf-8');
+ $this->elementStart('head');
+ $this->element('title', null, _('Subscribed'));
+ $this->elementEnd('head');
+ $this->elementStart('body');
+ $unsubscribe = new EditMirrorForm($this, $this->profile);
+ $unsubscribe->show();
+ $this->elementEnd('body');
+ $this->elementEnd('html');
+ } else {
+ $url = common_local_url('mirrorsettings');
+ common_redirect($url, 303);
+ }
+ }
+
+ abstract function saveMirror();
+}
diff --git a/plugins/SubMirror/actions/editmirror.php b/plugins/SubMirror/actions/editmirror.php
new file mode 100644
index 000000000..c7fdab0d6
--- /dev/null
+++ b/plugins/SubMirror/actions/editmirror.php
@@ -0,0 +1,112 @@
+<?php
+/**
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 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/>.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package StatusNet
+ * @author Brion Vibber <brion@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
+ * @link http://status.net/
+ */
+
+if (!defined('STATUSNET')) {
+ exit(1);
+}
+
+/**
+ * Takes parameters:
+ *
+ * - feed: a profile ID
+ * - token: session token to prevent CSRF attacks
+ * - ajax: boolean; whether to return Ajax or full-browser results
+ *
+ * Only works if the current user is logged in.
+ *
+ * @category Action
+ * @package StatusNet
+ * @copyright 2010 StatusNet, Inc.
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
+ * @link http://status.net/
+ */
+
+class EditMirrorAction extends BaseMirrorAction
+{
+
+ /**
+ * Check pre-requisites and instantiate attributes
+ *
+ * @param Array $args array of arguments (URL, GET, POST)
+ *
+ * @return boolean success flag
+ */
+
+ function prepare($args)
+ {
+ parent::prepare($args);
+
+ $this->profile = $this->validateProfile($this->trimmed('profile'));
+
+ $this->mirror = SubMirror::pkeyGet(array('subscriber' => $this->user->id,
+ 'subscribed' => $this->profile->id));
+
+ if (!$this->mirror) {
+ $this->clientError(_m("Requested invalid profile to edit."));
+ }
+
+ $this->style = $this->validateStyle($this->trimmed('style'));
+
+ // DO NOT change to $this->boolean(), it will be wrong.
+ // We're checking for the presence of the setting, not its value.
+ $this->delete = (bool)$this->arg('delete');
+
+ return true;
+ }
+
+ protected function validateStyle($style)
+ {
+ $allowed = array('repeat', 'copy');
+ if (in_array($style, $allowed)) {
+ return $style;
+ } else {
+ $this->clientError(_m("Bad form data."));
+ }
+ }
+
+ function saveMirror()
+ {
+ $mirror = SubMirror::getMirror($this->user, $this->profile);
+ if (!$mirror) {
+ $this->clientError(_m('Requested edit of missing mirror'));
+ }
+
+ if ($this->delete) {
+ $mirror->delete();
+ $oprofile = Ostatus_profile::staticGet('profile_id', $this->profile->id);
+ if ($oprofile) {
+ $oprofile->garbageCollect();
+ }
+ } else if ($this->style != $mirror->style) {
+ $orig = clone($mirror);
+ $mirror->style = $this->style;
+ $mirror->modified = common_sql_now();
+ $mirror->update($orig);
+ }
+ }
+}
diff --git a/plugins/SubMirror/actions/mirrorsettings.php b/plugins/SubMirror/actions/mirrorsettings.php
new file mode 100644
index 000000000..5463a8dc0
--- /dev/null
+++ b/plugins/SubMirror/actions/mirrorsettings.php
@@ -0,0 +1,106 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * 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 Plugins
+ * @package StatusNet
+ * @author Brion Vibber <brion@status.net>
+ * @copyright 2010 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') && !defined('LACONICA')) {
+ exit(1);
+}
+
+class MirrorSettingsAction extends AccountSettingsAction
+{
+ /**
+ * Title of the page
+ *
+ * @return string Page title
+ */
+
+ function title()
+ {
+ return _m('Feed mirror settings');
+ }
+
+ /**
+ * Instructions for use
+ *
+ * @return string Instructions for use
+ */
+
+ function getInstructions()
+ {
+ return _m('You can mirror updates from many RSS and Atom feeds ' .
+ 'into your StatusNet timeline!');
+ }
+
+ /**
+ * Show the form for OpenID management
+ *
+ * We have one form with a few different submit buttons to do different things.
+ *
+ * @return void
+ */
+
+ function showContent()
+ {
+ $user = common_current_user();
+
+ $this->showAddFeedForm();
+
+ $mirror = new SubMirror();
+ $mirror->subscriber = $user->id;
+ if ($mirror->find()) {
+ while ($mirror->fetch()) {
+ $this->showFeedForm($mirror);
+ }
+ }
+ }
+
+ function showFeedForm($mirror)
+ {
+ $profile = Profile::staticGet('id', $mirror->subscribed);
+ if ($profile) {
+ $form = new EditMirrorForm($this, $profile);
+ $form->show();
+ }
+ }
+
+ function showAddFeedForm()
+ {
+ $form = new AddMirrorForm($this);
+ $form->show();
+ }
+
+ /**
+ * Handle a POST request
+ *
+ * Muxes to different sub-functions based on which button was pushed
+ *
+ * @return void
+ */
+
+ function handlePost()
+ {
+ }
+}
diff --git a/plugins/SubMirror/classes/SubMirror.php b/plugins/SubMirror/classes/SubMirror.php
new file mode 100644
index 000000000..4e7e005db
--- /dev/null
+++ b/plugins/SubMirror/classes/SubMirror.php
@@ -0,0 +1,213 @@
+<?php
+/*
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 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/>.
+ */
+
+/**
+ * @package SubMirrorPlugin
+ * @maintainer Brion Vibber <brion@status.net>
+ */
+
+class SubMirror extends Memcached_DataObject
+{
+ public $__table = 'submirror';
+
+ public $subscriber;
+ public $subscribed;
+
+ public $style;
+
+ public $created;
+ public $modified;
+
+ public /*static*/ function staticGet($k, $v=null)
+ {
+ return parent::staticGet(__CLASS__, $k, $v);
+ }
+
+ /**
+ * return table definition for DB_DataObject
+ *
+ * DB_DataObject needs to know something about the table to manipulate
+ * instances. This method provides all the DB_DataObject needs to know.
+ *
+ * @return array array of column definitions
+ */
+
+ function table()
+ {
+ return array('subscriber' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
+ 'subscribed' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
+
+ 'style' => DB_DATAOBJECT_STR,
+
+ 'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
+ 'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
+ }
+
+ static function schemaDef()
+ {
+ // @fixme need a reverse key on (subscribed, subscriber) as well
+ return array(new ColumnDef('subscriber', 'integer',
+ null, false, 'PRI'),
+ new ColumnDef('subscribed', 'integer',
+ null, false, 'PRI'),
+
+ new ColumnDef('style', 'varchar',
+ 16, true),
+
+ new ColumnDef('created', 'datetime',
+ null, false),
+ new ColumnDef('modified', 'datetime',
+ null, false));
+ }
+
+ /**
+ * return key definitions for DB_DataObject
+ *
+ * DB_DataObject needs to know about keys that the table has; this function
+ * defines them.
+ *
+ * @return array key definitions
+ */
+
+ function keys()
+ {
+ return array_keys($this->keyTypes());
+ }
+
+ /**
+ * return key definitions for Memcached_DataObject
+ *
+ * Our caching system uses the same key definitions, but uses a different
+ * method to get them.
+ *
+ * @return array key definitions
+ */
+
+ function keyTypes()
+ {
+ // @fixme keys
+ // need a sane key for reverse lookup too
+ return array('subscriber' => 'K', 'subscribed' => 'K');
+ }
+
+ function sequenceKey()
+ {
+ return array(false, false, false);
+ }
+
+ /**
+ * @param Profile $subscribed
+ * @param Profile $subscribed
+ * @return SubMirror
+ * @throws ServerException
+ */
+ public static function saveMirror($subscriber, $subscribed, $style='repeat')
+ {
+ // @fixme make sure they're subscribed!
+ $mirror = new SubMirror();
+
+ $mirror->subscriber = $subscriber->id;
+ $mirror->subscribed = $subscribed->id;
+ $mirror->style = $style;
+
+ $mirror->created = common_sql_now();
+ $mirror->modified = common_sql_now();
+ $mirror->insert();
+
+ return $mirror;
+ }
+
+ /**
+ * @param Notice $notice
+ * @return mixed Notice on successful mirroring, boolean if not
+ */
+ public function mirrorNotice($notice)
+ {
+ $profile = Profile::staticGet('id', $this->subscriber);
+ if (!$profile) {
+ common_log(LOG_ERROR, "SubMirror plugin skipping auto-repeat of notice $notice->id for missing user $profile->id");
+ return false;
+ }
+
+ if ($this->style == 'copy') {
+ return $this->copyNotice($profile, $notice);
+ } else { // default to repeat mode
+ return $this->repeatNotice($profile, $notice);
+ }
+ }
+
+ /**
+ * Mirror a notice using StatusNet's repeat functionality.
+ * This retains attribution within the site, and other nice things,
+ * but currently ends up looking like 'RT @foobar bla bla' when
+ * bridged out over OStatus or TwitterBridge.
+ *
+ * @param Notice $notice
+ * @return mixed Notice on successful repeat, true if already repeated, false on failure
+ */
+ protected function repeatNotice($profile, $notice)
+ {
+ if($profile->hasRepeated($notice->id)) {
+ common_log(LOG_INFO, "SubMirror plugin skipping auto-repeat of notice $notice->id for user $profile->id; already repeated.");
+ return true;
+ } else {
+ common_log(LOG_INFO, "SubMirror plugin auto-repeating notice $notice->id for $profile->id");
+ return $notice->repeat($profile->id, 'mirror');
+ }
+ }
+
+ /**
+ * Mirror a notice by emitting a new notice with the same contents.
+ * Kind of dirty, but if pulling an external data feed into an account
+ * that may be what you want.
+ *
+ * @param Notice $notice
+ * @return mixed Notice on successful repeat, true if already repeated, false on failure
+ */
+ protected function copyNotice($profile, $notice)
+ {
+ $options = array('is_local' => Notice::LOCAL_PUBLIC,
+ 'url' => $notice->bestUrl(), // pass through the foreign link...
+ 'rendered' => $notice->rendered);
+
+ $saved = Notice::saveNew($profile->id,
+ $notice->content,
+ 'feed',
+ $options);
+ return $saved;
+ }
+
+ public /*static*/ function pkeyGet($v)
+ {
+ return parent::pkeyGet(__CLASS__, $v);
+ }
+
+ /**
+ * Get the mirroring setting for a pair of profiles, if existing.
+ *
+ * @param Profile $subscriber
+ * @param Profile $subscribed
+ * @return mixed Profile or empty
+ */
+ public static function getMirror($subscriber, $subscribed)
+ {
+ return self::pkeyGet(array('subscriber' => $subscriber->id,
+ 'subscribed' => $subscribed->id));
+ }
+}
diff --git a/plugins/SubMirror/lib/addmirrorform.php b/plugins/SubMirror/lib/addmirrorform.php
new file mode 100644
index 000000000..0a798c9ea
--- /dev/null
+++ b/plugins/SubMirror/lib/addmirrorform.php
@@ -0,0 +1,141 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ * 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/>.
+ *
+ * @package StatusNet
+ * @copyright 2010 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') && !defined('LACONICA')) {
+ exit(1);
+}
+
+class AddMirrorForm extends Form
+{
+
+ /**
+ * Name of the form
+ *
+ * Sub-classes should overload this with the name of their form.
+ *
+ * @return void
+ */
+
+ function formLegend()
+ {
+ }
+
+ /**
+ * Visible or invisible data elements
+ *
+ * Display the form fields that make up the data of the form.
+ * Sub-classes should overload this to show their data.
+ *
+ * @return void
+ */
+
+ function formData()
+ {
+ $this->out->elementStart('fieldset');
+
+ $this->out->elementStart('ul');
+
+ $this->li();
+ $this->doInput('addmirror-feedurl',
+ 'feedurl',
+ _m('Web page or feed URL:'),
+ $this->out->trimmed('feedurl'));
+ $this->unli();
+
+ $this->li();
+ $this->out->submit('addmirror-save', _m('Add feed'));
+ $this->unli();
+ $this->out->elementEnd('ul');
+ $this->out->elementEnd('fieldset');
+ }
+
+ private function doInput($id, $name, $label, $value=null, $instructions=null)
+ {
+ $this->out->element('label', array('for' => $id), $label);
+ $attrs = array('name' => $name,
+ 'type' => 'text',
+ 'id' => $id,
+ 'style' => 'width: 80%');
+ if ($value) {
+ $attrs['value'] = $value;
+ }
+ $this->out->element('input', $attrs);
+ if ($instructions) {
+ $this->out->element('p', 'form_guide', $instructions);
+ }
+ }
+
+ /**
+ * Buttons for form actions
+ *
+ * Submit and cancel buttons (or whatever)
+ * Sub-classes should overload this to show their own buttons.
+ *
+ * @return void
+ */
+
+ function formActions()
+ {
+ }
+
+ /**
+ * ID of the form
+ *
+ * Should be unique on the page. Sub-classes should overload this
+ * to show their own IDs.
+ *
+ * @return string ID of the form
+ */
+
+ function id()
+ {
+ return 'add-mirror-form';
+ }
+
+ /**
+ * Action of the form.
+ *
+ * URL to post to. Should be overloaded by subclasses to give
+ * somewhere to post to.
+ *
+ * @return string URL to post to
+ */
+
+ function action()
+ {
+ return common_local_url('addmirror');
+ }
+
+ /**
+ * Class of the form.
+ *
+ * @return string the form's class
+ */
+
+ function formClass()
+ {
+ return 'form_settings';
+ }
+
+}
diff --git a/plugins/SubMirror/lib/editmirrorform.php b/plugins/SubMirror/lib/editmirrorform.php
new file mode 100644
index 000000000..8236da389
--- /dev/null
+++ b/plugins/SubMirror/lib/editmirrorform.php
@@ -0,0 +1,189 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ * 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/>.
+ *
+ * @package StatusNet
+ * @copyright 2010 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') && !defined('LACONICA')) {
+ exit(1);
+}
+
+class EditMirrorForm extends Form
+{
+ function __construct($action, $profile)
+ {
+ parent::__construct($action);
+
+ $this->profile = clone($profile);
+ $this->user = common_current_user();
+ $this->mirror = SubMirror::pkeyGet(array('subscriber' => $this->user->id,
+ 'subscribed' => $this->profile->id));
+ }
+
+ /**
+ * Name of the form
+ *
+ * Sub-classes should overload this with the name of their form.
+ *
+ * @return void
+ */
+
+ function formLegend()
+ {
+ }
+
+ /**
+ * Visible or invisible data elements
+ *
+ * Display the form fields that make up the data of the form.
+ * Sub-classes should overload this to show their data.
+ *
+ * @return void
+ */
+
+ function formData()
+ {
+ $this->out->elementStart('fieldset');
+
+ $this->out->hidden('profile', $this->profile->id);
+
+ $this->out->elementStart('div', array('style' => 'float: left; width: 80px;'));
+ $img = $this->getAvatar($this->profile);
+ $feed = $this->getFeed($this->profile);
+ $this->out->elementStart('a', array('href' => $this->profile->profileurl));
+ $this->out->element('img', array('src' => $img, 'style' => 'float: left'));
+ $this->out->elementEnd('a');
+ $this->out->elementEnd('div');
+
+
+ $this->out->elementStart('div', array('style' => 'margin-left: 80px; margin-right: 20px'));
+ $this->out->elementStart('p');
+ $this->out->elementStart('div');
+ $this->out->element('a', array('href' => $this->profile->profileurl), $this->profile->getBestName());
+ $this->out->elementEnd('div');
+ $this->out->elementStart('div');
+ if ($feed) {
+ $this->out->text(_m('LABEL', 'Remote feed:') . ' ');
+ //$this->out->element('a', array('href' => $feed), $feed);
+ $this->out->element('input', array('value' => $feed, 'readonly' => 'readonly', 'style' => 'width: 100%'));
+ } else {
+ $this->out->text(_m('LABEL', 'Local user'));
+ }
+ $this->out->elementEnd('div');
+ $this->out->elementEnd('p');
+
+ $this->out->elementStart('fieldset', array('style' => 'margin-top: 20px'));
+ $this->out->element('legend', false, _m("Mirroring style"));
+
+ $styles = array('repeat' => _m("Repeat: reference the original user's post (sometimes shows as 'RT @blah')"),
+ 'copy' => _m("Repost the content under my account"));
+ foreach ($styles as $key => $label) {
+ $this->out->elementStart('div');
+ $attribs = array('type' => 'radio',
+ 'value' => $key,
+ 'name' => 'style',
+ 'id' => $this->id() . '-style');
+ if ($key == $this->mirror->style || ($key == 'repeat' && empty($this->mirror->style))) {
+ $attribs['checked'] = 'checked';
+ }
+ $this->out->element('input', $attribs);
+ $this->out->element('span', false, $label); // @fixme should be label, but the styles muck it up for now
+ $this->out->elementEnd('div');
+
+ }
+ $this->out->elementEnd('fieldset');
+
+
+ $this->out->elementStart('div');
+ $this->out->submit($this->id() . '-save', _m('Save'));
+ $this->out->element('input', array('type' => 'submit',
+ 'value' => _m('Stop mirroring'),
+ 'name' => 'delete',
+ 'class' => 'submit'));
+ $this->out->elementEnd('div');
+
+ $this->out->elementEnd('div');
+ $this->out->elementEnd('fieldset');
+ }
+
+ private function getAvatar($profile)
+ {
+ $avatar = $this->profile->getAvatar(48);
+ if ($avatar) {
+ return $avatar->displayUrl();
+ } else {
+ return Avatar::defaultImage(48);
+ }
+ }
+
+ private function getFeed($profile)
+ {
+ // Ok this is a bit of a hack. ;)
+ if (class_exists('Ostatus_profile')) {
+ $oprofile = Ostatus_profile::staticGet('profile_id', $profile->id);
+ if ($oprofile) {
+ return $oprofile->feeduri;
+ }
+ }
+ var_dump('wtf');
+ return false;
+ }
+
+ /**
+ * ID of the form
+ *
+ * Should be unique on the page. Sub-classes should overload this
+ * to show their own IDs.
+ *
+ * @return string ID of the form
+ */
+
+ function id()
+ {
+ return 'edit-mirror-form-' . $this->profile->id;
+ }
+
+ /**
+ * Action of the form.
+ *
+ * URL to post to. Should be overloaded by subclasses to give
+ * somewhere to post to.
+ *
+ * @return string URL to post to
+ */
+
+ function action()
+ {
+ return common_local_url('editmirror');
+ }
+
+ /**
+ * Class of the form.
+ *
+ * @return string the form's class
+ */
+
+ function formClass()
+ {
+ return 'form_settings';
+ }
+
+}
diff --git a/plugins/SubMirror/lib/mirrorqueuehandler.php b/plugins/SubMirror/lib/mirrorqueuehandler.php
new file mode 100644
index 000000000..92b36b5eb
--- /dev/null
+++ b/plugins/SubMirror/lib/mirrorqueuehandler.php
@@ -0,0 +1,45 @@
+<?php
+/*
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 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/>.
+ */
+
+/**
+ * Check for subscription mirroring options on each newly seen post!
+ *
+ * @package SubMirror
+ * @author Brion Vibber <brion@status.net>
+ */
+
+class MirrorQueueHandler extends QueueHandler
+{
+ function transport()
+ {
+ return 'mirror';
+ }
+
+ function handle($notice)
+ {
+ $mirror = new SubMirror();
+ $mirror->subscribed = $notice->profile_id;
+ if ($mirror->find()) {
+ while ($mirror->fetch()) {
+ $mirror->mirrorNotice($notice);
+ }
+ }
+ return true;
+ }
+}
generated by cgit v1.2.3-54-g00ecf (git 2.45.2) at 2024-11-24 20:40:19 +0000