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, 213 insertions, 0 deletions

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));
+    }
+}