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...

1 files changed, 149 insertions, 0 deletions

diff --git a/plugins/SubMirror/SubMirrorPlugin.php b/plugins/SubMirror/SubMirrorPlugin.php
new file mode 100644
index 000000000..8678cc3dd
--- /dev/null
+++ b/plugins/SubMirror/SubMirrorPlugin.php
@@ -0,0 +1,149 @@
+<?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';
+    }
+
+    function onStartShowSubscriptionsContent($action)
+    {
+        $action->element('a',
+                         array('href' => common_local_url('mirrorsettings')),
+                         _m('Set up mirroring options...'));
+    }
+}