summaryrefslogtreecommitdiff
path: root/plugins/SubMirror/actions
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/SubMirror/actions')
-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
4 files changed, 464 insertions, 0 deletions
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()
+ {
+ }
+}
generated by cgit v1.2.3-54-g00ecf (git 2.45.2) at 2025-08-09 11:00:53 +0000