3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * AtomPub subscription feed
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.
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.
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/>.
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/
31 if (!defined('STATUSNET')) {
32 // This check helps protect against security problems;
33 // your code file can't be executed directly from the web.
38 * Subscription feed class for AtomPub
40 * Generates a list of the user's subscriptions
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/
49 class AtompubsubscriptionfeedAction extends ApiAuthAction
51 private $_profile = null;
52 private $_subscriptions = null;
55 * For initializing members of the class.
57 * @param array $argarray misc. arguments
59 * @return boolean true
61 function prepare($argarray)
63 parent::prepare($argarray);
65 $subscriber = $this->trimmed('subscriber');
67 $this->_profile = Profile::getKV('id', $subscriber);
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.'),
76 // page and count from ApiAction
78 $offset = ($this->page-1) * $this->count;
80 $this->_subscriptions = Subscription::bySubscriber($subscriber,
90 * @param array $argarray is ignored since it's now passed in in prepare()
94 function handle($argarray=null)
96 parent::handle($argarray);
97 switch ($_SERVER['REQUEST_METHOD']) {
103 $this->addSubscription();
106 // TRANS: Client exception thrown when using an unsupported HTTP method.
107 $this->clientError(_('HTTP method not supported.'), 405);
115 * Show the feed of subscriptions
121 header('Content-Type: application/atom+xml; charset=utf-8');
123 $url = common_local_url('AtomPubSubscriptionFeed',
124 array('subscriber' => $this->_profile->id));
126 $feed = new Atom10Feed(true);
128 $feed->addNamespace('activity',
129 'http://activitystrea.ms/spec/1.0/');
131 $feed->addNamespace('poco',
132 'http://portablecontacts.net/spec/1.0');
134 $feed->addNamespace('media',
135 'http://purl.org/syndication/atommedia');
139 $feed->setUpdated('now');
141 $feed->addAuthor($this->_profile->getBestName(),
142 $this->_profile->getURI());
144 // TRANS: Title for Atom subscription feed.
145 // TRANS: %s is a user nickname.
146 $feed->setTitle(sprintf(_("%s subscriptions"),
147 $this->_profile->getBestName()));
149 // TRANS: Subtitle for Atom subscription feed.
150 // TRANS: %1$s is a user nickname, %s$s is the StatusNet sitename.
151 $feed->setSubtitle(sprintf(_("People %1\$s has subscribed to on %2\$s"),
152 $this->_profile->getBestName(),
153 common_config('site', 'name')));
155 $feed->addLink(common_local_url('subscriptions',
157 $this->_profile->nickname)));
160 array('rel' => 'self',
161 'type' => 'application/atom+xml'));
163 // If there's more...
165 if ($this->page > 1) {
167 array('rel' => 'first',
168 'type' => 'application/atom+xml'));
170 $feed->addLink(common_local_url('AtomPubSubscriptionFeed',
171 array('subscriber' =>
172 $this->_profile->id),
175 array('rel' => 'prev',
176 'type' => 'application/atom+xml'));
179 if ($this->_subscriptions->N > $this->count) {
181 $feed->addLink(common_local_url('AtomPubSubscriptionFeed',
182 array('subscriber' =>
183 $this->_profile->id),
186 array('rel' => 'next',
187 'type' => 'application/atom+xml'));
192 // XXX: This is kind of inefficient
194 while ($this->_subscriptions->fetch()) {
196 // We get one more than needed; skip that one
200 if ($i > $this->count) {
204 $act = $this->_subscriptions->asActivity();
205 $feed->addEntryRaw($act->asString(false, false, false));
208 $this->raw($feed->getString());
212 * Add a new subscription
214 * Handling the POST method for AtomPub
218 function addSubscription()
220 if (empty($this->auth_user) ||
221 $this->auth_user->id != $this->_profile->id) {
222 // TRANS: Client exception thrown when trying to subscribe another user.
223 throw new ClientException(_("Cannot add someone else's".
224 " subscription."), 403);
227 $xml = file_get_contents('php://input');
229 $dom = DOMDocument::loadXML($xml);
231 if ($dom->documentElement->namespaceURI != Activity::ATOM ||
232 $dom->documentElement->localName != 'entry') {
233 // TRANS: Client error displayed when not using an Atom entry.
234 $this->clientError(_('Atom post must be an Atom entry.'));
238 $activity = new Activity($dom->documentElement);
242 if (Event::handle('StartAtomPubNewActivity', array(&$activity))) {
244 if ($activity->verb != ActivityVerb::FOLLOW) {
245 // TRANS: Client error displayed when not using the follow verb.
246 $this->clientError(_('Can only handle Follow activities.'));
250 $person = $activity->objects[0];
252 if ($person->type != ActivityObject::PERSON) {
253 // TRANS: Client exception thrown when subscribing to an object that is not a person.
254 $this->clientError(_('Can only follow people.'));
258 // XXX: OStatus discovery (maybe)
260 $profile = Profile::fromURI($person->id);
262 if (empty($profile)) {
263 // TRANS: Client exception thrown when subscribing to a non-existing profile.
264 // TRANS: %s is the unknown profile ID.
265 $this->clientError(sprintf(_('Unknown profile %s.'), $person->id));
269 if (Subscription::exists($this->_profile, $profile)) {
271 // TRANS: Client error displayed trying to subscribe to an already subscribed profile.
272 // TRANS: %s is the profile the user already has a subscription on.
273 $this->clientError(sprintf(_('Already subscribed to %s.'),
279 if (Subscription::start($this->_profile, $profile)) {
280 $sub = Subscription::pkeyGet(array('subscriber' => $this->_profile->id,
281 'subscribed' => $profile->id));
284 Event::handle('EndAtomPubNewActivity', array($activity, $sub));
288 $act = $sub->asActivity();
290 header('Content-Type: application/atom+xml; charset=utf-8');
291 header('Content-Location: ' . $act->selfLink);
294 $this->raw($act->asString(true, true, true));
300 * Return true if read only.
302 * @param array $args other arguments
304 * @return boolean is read only action?
306 function isReadOnly($args)
308 return $_SERVER['REQUEST_METHOD'] != 'POST';
312 * Return last modified, if applicable.
314 * @return string last modified http header
316 function lastModified()
322 * Return etag, if applicable.
324 * @return string etag http header
332 * Does this require authentication?
334 * @return boolean true if delete, else false
336 function requiresAuth()
338 if ($_SERVER['REQUEST_METHOD'] == 'POST') {