actions/atompubsubscriptionfeed.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * AtomPub subscription feed
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Cache
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Subscription feed class for AtomPub
  39  *
  40  * Generates a list of the user's subscriptions
  41  *
  42  * @category  AtomPub
  43  * @package   StatusNet
  44  * @author    Evan Prodromou <evan@status.net>
  45  * @copyright 2010 StatusNet, Inc.
  46  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  47  * @link      http://status.net/
  48  */
  49 class AtompubsubscriptionfeedAction extends ApiAuthAction
  50 {
  51     private $_profile       = null;
  52     private $_subscriptions = null;
  53
  54     /**
  55      * For initializing members of the class.
  56      *
  57      * @param array $argarray misc. arguments
  58      *
  59      * @return boolean true
  60      */
  61     function prepare($argarray)
  62     {
  63         parent::prepare($argarray);
  64
  65         $subscriber = $this->trimmed('subscriber');
  66
  67         $this->_profile = Profile::getKV('id', $subscriber);
  68
  69         if (empty($this->_profile)) {
  70             // TRANS: Client exception thrown when trying to display a subscription for a non-existing profile ID.
  71             // TRANS: %d is the non-existing profile ID number.
  72             throw new ClientException(sprintf(_('No such profile id: %d.'),
  73                                               $subscriber), 404);
  74         }
  75
  76         // page and count from ApiAction
  77
  78         $offset = ($this->page-1) * $this->count;
  79
  80         $this->_subscriptions = Subscription::bySubscriber($subscriber,
  81                                                            $offset,
  82                                                            $this->count + 1);
  83
  84         return true;
  85     }
  86
  87     /**
  88      * Handler method
  89      *
  90      * @param array $argarray is ignored since it's now passed in in prepare()
  91      *
  92      * @return void
  93      */
  94     function handle($argarray=null)
  95     {
  96         parent::handle($argarray);
  97         switch ($_SERVER['REQUEST_METHOD']) {
  98         case 'HEAD':
  99         case 'GET':
 100             $this->showFeed();
 101             break;
 102         case 'POST':
 103             $this->addSubscription();
 104             break;
 105         default:
 106             // TRANS: Client exception thrown when using an unsupported HTTP method.
 107             $this->clientError(_('HTTP method not supported.'), 405);
 108         }
 109
 110         return;
 111     }
 112
 113     /**
 114      * Show the feed of subscriptions
 115      *
 116      * @return void
 117      */
 118     function showFeed()
 119     {
 120         header('Content-Type: application/atom+xml; charset=utf-8');
 121
 122         $url = common_local_url('AtomPubSubscriptionFeed',
 123                                 array('subscriber' => $this->_profile->id));
 124
 125         $feed = new Atom10Feed(true);
 126
 127         $feed->addNamespace('activity',
 128                             'http://activitystrea.ms/spec/1.0/');
 129
 130         $feed->addNamespace('poco',
 131                             'http://portablecontacts.net/spec/1.0');
 132
 133         $feed->addNamespace('media',
 134                             'http://purl.org/syndication/atommedia');
 135
 136         $feed->id = $url;
 137
 138         $feed->setUpdated('now');
 139
 140         $feed->addAuthor($this->_profile->getBestName(),
 141                          $this->_profile->getURI());
 142
 143         // TRANS: Title for Atom subscription feed.
 144         // TRANS: %s is a user nickname.
 145         $feed->setTitle(sprintf(_("%s subscriptions"),
 146                                 $this->_profile->getBestName()));
 147
 148         // TRANS: Subtitle for Atom subscription feed.
 149         // TRANS: %1$s is a user nickname, %s$s is the StatusNet sitename.
 150         $feed->setSubtitle(sprintf(_("People %1\$s has subscribed to on %2\$s"),
 151                                    $this->_profile->getBestName(),
 152                                    common_config('site', 'name')));
 153
 154         $feed->addLink(common_local_url('subscriptions',
 155                                         array('nickname' =>
 156                                               $this->_profile->nickname)));
 157
 158         $feed->addLink($url,
 159                        array('rel' => 'self',
 160                              'type' => 'application/atom+xml'));
 161
 162         // If there's more...
 163
 164         if ($this->page > 1) {
 165             $feed->addLink($url,
 166                            array('rel' => 'first',
 167                                  'type' => 'application/atom+xml'));
 168
 169             $feed->addLink(common_local_url('AtomPubSubscriptionFeed',
 170                                             array('subscriber' =>
 171                                                   $this->_profile->id),
 172                                             array('page' =>
 173                                                   $this->page - 1)),
 174                            array('rel' => 'prev',
 175                                  'type' => 'application/atom+xml'));
 176         }
 177
 178         if ($this->_subscriptions->N > $this->count) {
 179
 180             $feed->addLink(common_local_url('AtomPubSubscriptionFeed',
 181                                             array('subscriber' =>
 182                                                   $this->_profile->id),
 183                                             array('page' =>
 184                                                   $this->page + 1)),
 185                            array('rel' => 'next',
 186                                  'type' => 'application/atom+xml'));
 187         }
 188
 189         $i = 0;
 190
 191         // XXX: This is kind of inefficient
 192
 193         while ($this->_subscriptions->fetch()) {
 194
 195             // We get one more than needed; skip that one
 196
 197             $i++;
 198
 199             if ($i > $this->count) {
 200                 break;
 201             }
 202
 203             $act = $this->_subscriptions->asActivity();
 204             $feed->addEntryRaw($act->asString(false, false, false));
 205         }
 206
 207         $this->raw($feed->getString());
 208     }
 209
 210     /**
 211      * Add a new subscription
 212      *
 213      * Handling the POST method for AtomPub
 214      *
 215      * @return void
 216      */
 217     function addSubscription()
 218     {
 219         if (empty($this->auth_user) ||
 220             $this->auth_user->id != $this->_profile->id) {
 221             // TRANS: Client exception thrown when trying to subscribe another user.
 222             throw new ClientException(_("Cannot add someone else's".
 223                                         " subscription."), 403);
 224         }
 225
 226         $xml = file_get_contents('php://input');
 227
 228         $dom = DOMDocument::loadXML($xml);
 229
 230         if ($dom->documentElement->namespaceURI != Activity::ATOM ||
 231             $dom->documentElement->localName != 'entry') {
 232             // TRANS: Client error displayed when not using an Atom entry.
 233             $this->clientError(_('Atom post must be an Atom entry.'));
 234         }
 235
 236         $activity = new Activity($dom->documentElement);
 237
 238         $sub = null;
 239
 240         if (Event::handle('StartAtomPubNewActivity', array(&$activity))) {
 241
 242             if ($activity->verb != ActivityVerb::FOLLOW) {
 243                 // TRANS: Client error displayed when not using the follow verb.
 244                 $this->clientError(_('Can only handle Follow activities.'));
 245             }
 246
 247             $person = $activity->objects[0];
 248
 249             if ($person->type != ActivityObject::PERSON) {
 250                 // TRANS: Client exception thrown when subscribing to an object that is not a person.
 251                 $this->clientError(_('Can only follow people.'));
 252             }
 253
 254             // XXX: OStatus discovery (maybe)
 255
 256             $profile = Profile::fromURI($person->id);
 257
 258             if (empty($profile)) {
 259                 // TRANS: Client exception thrown when subscribing to a non-existing profile.
 260                 // TRANS: %s is the unknown profile ID.
 261                 $this->clientError(sprintf(_('Unknown profile %s.'), $person->id));
 262             }
 263
 264             if (Subscription::exists($this->_profile, $profile)) {
 265                 // 409 Conflict
 266                 // TRANS: Client error displayed trying to subscribe to an already subscribed profile.
 267                 // TRANS: %s is the profile the user already has a subscription on.
 268                 $this->clientError(sprintf(_('Already subscribed to %s.'),
 269                                            $person->id),
 270                                    409);
 271             }
 272
 273             if (Subscription::start($this->_profile, $profile)) {
 274                 $sub = Subscription::pkeyGet(array('subscriber' => $this->_profile->id,
 275                                                    'subscribed' => $profile->id));
 276             }
 277
 278             Event::handle('EndAtomPubNewActivity', array($activity, $sub));
 279         }
 280
 281         if (!empty($sub)) {
 282             $act = $sub->asActivity();
 283
 284             header('Content-Type: application/atom+xml; charset=utf-8');
 285             header('Content-Location: ' . $act->selfLink);
 286
 287             $this->startXML();
 288             $this->raw($act->asString(true, true, true));
 289             $this->endXML();
 290         }
 291     }
 292
 293     /**
 294      * Return true if read only.
 295      *
 296      * @param array $args other arguments
 297      *
 298      * @return boolean is read only action?
 299      */
 300     function isReadOnly($args)
 301     {
 302         return $_SERVER['REQUEST_METHOD'] != 'POST';
 303     }
 304
 305     /**
 306      * Return last modified, if applicable.
 307      *
 308      * @return string last modified http header
 309      */
 310     function lastModified()
 311     {
 312         return null;
 313     }
 314
 315     /**
 316      * Return etag, if applicable.
 317      *
 318      * @return string etag http header
 319      */
 320     function etag()
 321     {
 322         return null;
 323     }
 324
 325     /**
 326      * Does this require authentication?
 327      *
 328      * @return boolean true if delete, else false
 329      */
 330     function requiresAuth()
 331     {
 332         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
 333             return true;
 334         } else {
 335             return false;
 336         }
 337     }
 338 }