SubMirror plugin initial checkin: allows setting up automatic mirroring of posts from any of your subscriptions into your own stream, either via repeat or by copying the text.

The UI for setup and editing is a bit nasty for now. Can be reached via 'Mirroring' tab in account settings, or from a link at top of subscriptions list.

Currently relies on the OStatus plugin to handle actual setup, parsing, and importing of feeds; to support more general feed formatting we may need some further work there to accept weird feeds.
Also requires an actual live subscription, but this could be changed in future. (Ensuring that PSHB feed subscriptions remain live even if nobody's directly subscribed might be tricky.)

The repeat style is our preferred method since it retains full attribution, but right now we don't handle repeats very well across site boundaries; when pushed out to Twitter or to other StatusNet instances via OStatus, currently we end up losing some of the data and can end up with the 'RT @blah' version.

WARNING: There's no loop detection yet; it's most likely possible to set up a fun loop of profiles repeating each others' stuff forever and ever and ever and ever...

3 files changed, 404 insertions, 0 deletions

diff --git a/plugins/SubMirror/lib/addmirrorform.php b/plugins/SubMirror/lib/addmirrorform.php
new file mode 100644
index 000000000..9ee59661a
--- /dev/null
+++ b/plugins/SubMirror/lib/addmirrorform.php
@@ -0,0 +1,171 @@
+<?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->out->element('label', array('for' => $this->id() . '-profile'),
+                            _m("Mirror one of your existing subscriptions:"));
+        $this->out->elementStart('select', array('name' => 'profile'));
+
+        $user = common_current_user();
+        $profile = $user->getSubscriptions();
+        while ($profile->fetch()) {
+            $mirror = SubMirror::pkeyGet(array('subscriber' => $user->id,
+                                               'subscribed' => $profile->id));
+            if (!$mirror) {
+                $this->out->element('option',
+                                    array('value' => $profile->id),
+                                    $profile->getBestName());
+            }
+        }
+        $this->out->elementEnd('select');
+        $this->out->submit($this->id() . '-save', _m('Save'));
+        $this->unli();
+
+
+        $this->li();
+
+        $this->out->elementStart('fieldset', array('style' => 'width: 360px; margin-left: auto; margin-right: auto'));
+        $this->out->element('p', false,
+                            _m("Not already subscribed to the feed you want? " .
+                               "Add a new remote subscription and paste in the URL!"));
+
+        $this->out->elementStart('div', 'entity_actions');
+        $this->out->elementStart('p', array('id' => 'entity_remote_subscribe',
+                                         'class' => 'entity_subscribe'));
+        $this->out->element('a', array('href' => common_local_url('ostatussub'),
+                                    'class' => 'entity_remote_subscribe')
+                            , _m('Remote'));
+        $this->out->elementEnd('p');
+        $this->out->elementEnd('div');
+
+        $this->out->element('div', array('style' => 'clear: both'));
+        $this->out->elementEnd('fieldset');
+        $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);
+        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..0306180ee
--- /dev/null
+++ b/plugins/SubMirror/lib/mirrorqueuehandler.php
@@ -0,0 +1,44 @@
+<?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);
+            }
+        }
+    }
+}