Add subscription feed for AtomPub

2 files changed, 279 insertions, 0 deletions

diff --git a/actions/atompubsubscriptionfeed.php b/actions/atompubsubscriptionfeed.php
new file mode 100644
index 000000000..5eddc4cdd
--- /dev/null
+++ b/actions/atompubsubscriptionfeed.php
@@ -0,0 +1,262 @@
+<?php
+/**
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, StatusNet, Inc.
+ *
+ * AtomPub subscription feed
+ * 
+ * PHP version 5
+ *
+ * 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  Cache
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ * @link      http://status.net/
+ */
+
+if (!defined('STATUSNET')) {
+    // This check helps protect against security problems;
+    // your code file can't be executed directly from the web.
+    exit(1);
+}
+
+require_once INSTALLDIR . '/lib/apiauth.php';
+
+/**
+ * Subscription feed class for AtomPub
+ *
+ * Generates a list of the user's subscriptions
+ * 
+ * @category  AtomPub
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ * @link      http://status.net/
+ */
+
+class AtompubsubscriptionfeedAction extends ApiAuthAction
+{
+    private $_profile    = null;
+    private $_subscribed = null;
+
+    /**
+     * For initializing members of the class.
+     *
+     * @param array $argarray misc. arguments
+     *
+     * @return boolean true
+     */
+
+    function prepare($argarray)
+    {
+        parent::prepare($argarray);
+        
+        $subscriber = $this->trimmed('subscriber');
+
+        $this->_profile = Profile::staticGet('id', $subscriber);
+
+        if (empty($this->_profile)) {
+            throw new ClientException(sprintf(_('No such profile id: %d'),
+                                              $subscriber), 404);
+        }
+
+        // page and count from ApiAction
+        // Note: this is a list of profiles, not subscriptions
+
+        $this->_subscribed = 
+            $this->_profile->getSubscriptions(($this->page-1) * $this->count, 
+                                              $this->count + 1);
+
+        return true;
+    }
+
+    /**
+     * Handler method
+     *
+     * @param array $argarray is ignored since it's now passed in in prepare()
+     *
+     * @return void
+     */
+
+    function handle($argarray=null)
+    {
+        parent::handle($argarray);
+        switch ($_SERVER['REQUEST_METHOD']) {
+        case 'HEAD':
+        case 'GET':
+            $this->showFeed();
+            break;
+        case 'POST':
+            $this->addSubscription();
+            break;
+        default:
+            $this->clientError(_('HTTP method not supported.'), 405);
+            return;
+        }
+
+        return;
+    }
+
+    /**
+     * Show the feed of subscriptions
+     *
+     * @return void
+     */
+
+    function showFeed()
+    {
+        header('Content-Type: application/atom+xml; charset=utf-8');
+
+        $url = common_local_url('AtomPubSubscriptionFeed',
+                                array('subscriber' => $this->_profile->id));
+
+        $feed = new Atom10Feed(true);
+
+        $feed->addNamespace('activity',
+                            'http://activitystrea.ms/spec/1.0/');
+
+        $feed->addNamespace('poco',
+                            'http://portablecontacts.net/spec/1.0');
+
+        $feed->addNamespace('media',
+                            'http://purl.org/syndication/atommedia');
+
+        $feed->id = $url;
+
+        $feed->setUpdated('now');
+
+        $feed->addAuthor($this->_profile->getBestName(),
+                         $this->_profile->getURI());
+
+        $feed->setTitle(sprintf(_("%s subscriptions"),
+                                $this->_profile->getBestName()));
+
+        $feed->setSubtitle(sprintf(_("People %s has subscribed to on %s"),
+                                   $this->_profile->getBestName()),
+                           common_config('site', 'name'));
+
+        $feed->addLink(common_local_url('subscriptions',
+                                        array('nickname' => 
+                                              $this->_profile->nickname)));
+
+        $feed->addLink($url,
+                       array('rel' => 'self',
+                             'type' => 'application/atom+xml'));
+                                        
+        // If there's more...
+
+        if ($this->page > 1) {
+            $feed->addLink($url,
+                           array('rel' => 'first',
+                                 'type' => 'application/atom+xml'));
+
+            $feed->addLink(common_local_url('AtomPubSubscriptionFeed',
+                                            array('subscriber' => 
+                                                  $this->_profile->id,
+                                                  'page' => 
+                                                  $this->page - 1)),
+                           array('rel' => 'prev',
+                                 'type' => 'application/atom+xml'));
+        }
+
+        if ($this->_subscribed->N > $this->count) {
+
+            $feed->addLink(common_local_url('AtomPubSubscriptionFeed',
+                                            array('subscriber' =>
+                                                  $this->_profile->id,
+                                                  'page' =>
+                                                  $this->page + 1)),
+                           array('rel' => 'next',
+                                 'type' => 'application/atom+xml'));
+        }
+
+        $i = 0;
+
+        // XXX: This is kind of inefficient
+
+        while ($this->_subscribed->fetch()) {
+
+            // We get one more than needed; skip that one
+
+            $i++;
+
+            if ($i > $this->count) {
+                break;
+            }
+
+            $sub = Subscription::pkeyGet(array('subscriber' =>
+                                               $this->_profile->id,
+                                               'subscribed' =>
+                                               $this->_subscribed->id));
+            $act = $sub->asActivity();
+            $feed->addEntryRaw($act->asString(false, false, false));
+        }
+
+        $this->raw($feed->getString());
+    }
+
+    /**
+     * Return true if read only.
+     *
+     * @param array $args other arguments
+     *
+     * @return boolean is read only action?
+     */
+
+    function isReadOnly($args)
+    {
+        return $_SERVER['REQUEST_METHOD'] != 'POST';
+    }
+
+    /**
+     * Return last modified, if applicable.
+     *
+     * @return string last modified http header
+     */
+
+    function lastModified()
+    {
+        return null;
+    }
+
+    /**
+     * Return etag, if applicable.
+     *
+     * @return string etag http header
+     */
+
+    function etag()
+    {
+        return null;
+    }
+
+    /**
+     * Does this require authentication?
+     *
+     * @return boolean true if delete, else false
+     */
+
+    function requiresAuth()
+    {
+        if ($_SERVER['REQUEST_METHOD'] == 'DELETE') {
+            return true;
+        } else {
+            return false;
+        }
+    }
+}
diff --git a/actions/subscriptions.php b/actions/subscriptions.php
index ba2f67f2d..a814a4f35 100644
--- a/actions/subscriptions.php
+++ b/actions/subscriptions.php
@@ -163,6 +163,22 @@ class SubscriptionsAction extends GalleryAction
         $cloud2 = new SubscriptionsPeopleSelfTagCloudSection($this);
         $cloud2->show();
     }
+
+    /**
+     * Link to feeds of subscriptions
+     *
+     * @return array of Feed objects
+     */
+
+    function getFeeds()
+    {
+        return array(new Feed(Feed::ATOM,
+                              common_local_url('AtomPubSubscriptionFeed',
+                                               array('subscriber' => $this->profile->id)),
+                              sprintf(_('Subscription feed for %s (Atom)'),
+                                      $this->profile->nickname)));
+
+    }
 }
 
 // XXX SubscriptionsList and SubscriptionList are dangerously close
@@ -247,4 +263,5 @@ class SubscriptionsListItem extends SubscriptionListItem
         $this->out->elementEnd('form');
         return;
     }
+
 }