* Copyright (C) 2010, StatusNet, Inc.
*
* AtomPub subscription feed
- *
+ *
* PHP version 5
*
* This program is free software: you can redistribute it and/or modify
* @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';
+if (!defined('GNUSOCIAL') && !defined('STATUSNET')) { exit(1); }
/**
* Subscription feed class for AtomPub
*
* Generates a list of the user's subscriptions
- *
+ *
* @category AtomPub
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
-
-class AtompubsubscriptionfeedAction extends ApiAuthAction
+class AtompubsubscriptionfeedAction extends AtompubAction
{
- private $_profile = null;
- private $_subscribed = null;
+ private $_profile = null;
+ private $_subscriptions = null;
- /**
- * For initializing members of the class.
- *
- * @param array $argarray misc. arguments
- *
- * @return boolean true
- */
-
- function prepare($argarray)
+ protected function atompubPrepare()
{
- parent::prepare($argarray);
-
$subscriber = $this->trimmed('subscriber');
- $this->_profile = Profile::staticGet('id', $subscriber);
+ $this->_profile = Profile::getKV('id', $subscriber);
- if (empty($this->_profile)) {
- throw new ClientException(sprintf(_('No such profile id: %d'),
+ if (!$this->_profile instanceof Profile) {
+ // TRANS: Client exception thrown when trying to display a subscription for a non-existing profile ID.
+ // TRANS: %d is the non-existing profile ID number.
+ 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);
+ $this->_subscriptions = Subscription::bySubscriber($this->_profile->id,
+ $this->offset,
+ $this->limit);
return true;
}
- /**
- * Handler method
- *
- * @param array $argarray is ignored since it's now passed in in prepare()
- *
- * @return void
- */
-
- function handle($argarray=null)
+ protected function handleGet()
{
- 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;
- }
+ $this->showFeed();
+ }
- return;
+ protected function handlePost()
+ {
+ $this->addSubscription();
}
/**
*
* @return void
*/
-
function showFeed()
{
header('Content-Type: application/atom+xml; charset=utf-8');
$feed->addNamespace('media',
'http://purl.org/syndication/atommedia');
+ $feed->addNamespace('georss',
+ 'http://www.georss.org/georss');
+
$feed->id = $url;
$feed->setUpdated('now');
$feed->addAuthor($this->_profile->getBestName(),
$this->_profile->getURI());
+ // TRANS: Title for Atom subscription feed.
+ // TRANS: %s is a user nickname.
$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'));
+ // TRANS: Subtitle for Atom subscription feed.
+ // TRANS: %1$s is a user nickname, %s$s is the StatusNet sitename.
+ $feed->setSubtitle(sprintf(_("People %1\$s has subscribed to on %2\$s"),
+ $this->_profile->getBestName(),
+ common_config('site', 'name')));
$feed->addLink(common_local_url('subscriptions',
- array('nickname' =>
+ array('nickname' =>
$this->_profile->nickname)));
$feed->addLink($url,
array('rel' => 'self',
'type' => 'application/atom+xml'));
-
+
// If there's more...
if ($this->page > 1) {
'type' => 'application/atom+xml'));
$feed->addLink(common_local_url('AtomPubSubscriptionFeed',
- array('subscriber' =>
- $this->_profile->id,
- 'page' =>
+ array('subscriber' =>
+ $this->_profile->id),
+ array('page' =>
$this->page - 1)),
array('rel' => 'prev',
'type' => 'application/atom+xml'));
}
- if ($this->_subscribed->N > $this->count) {
+ if ($this->_subscriptions->N > $this->count) {
$feed->addLink(common_local_url('AtomPubSubscriptionFeed',
array('subscriber' =>
- $this->_profile->id,
- 'page' =>
+ $this->_profile->id),
+ array('page' =>
$this->page + 1)),
array('rel' => 'next',
'type' => 'application/atom+xml'));
// XXX: This is kind of inefficient
- while ($this->_subscribed->fetch()) {
+ while ($this->_subscriptions->fetch()) {
// We get one more than needed; skip that one
break;
}
- $sub = Subscription::pkeyGet(array('subscriber' =>
- $this->_profile->id,
- 'subscribed' =>
- $this->_subscribed->id));
- $act = $sub->asActivity();
+ $act = $this->_subscriptions->asActivity();
$feed->addEntryRaw($act->asString(false, false, false));
}
}
/**
- * Return true if read only.
+ * Add a new subscription
*
- * @param array $args other arguments
+ * Handling the POST method for AtomPub
*
- * @return boolean is read only action?
+ * @return void
*/
-
- function isReadOnly($args)
+ function addSubscription()
{
- return $_SERVER['REQUEST_METHOD'] != 'POST';
- }
+ if (empty($this->auth_user) ||
+ $this->auth_user->id != $this->_profile->id) {
+ // TRANS: Client exception thrown when trying to subscribe another user.
+ throw new ClientException(_("Cannot add someone else's".
+ " subscription."), 403);
+ }
- /**
- * Return last modified, if applicable.
- *
- * @return string last modified http header
- */
+ $xml = file_get_contents('php://input');
- function lastModified()
- {
- return null;
- }
+ $dom = DOMDocument::loadXML($xml);
- /**
- * Return etag, if applicable.
- *
- * @return string etag http header
- */
+ if ($dom->documentElement->namespaceURI != Activity::ATOM ||
+ $dom->documentElement->localName != 'entry') {
+ // TRANS: Client error displayed when not using an Atom entry.
+ $this->clientError(_('Atom post must be an Atom entry.'));
+ }
- function etag()
- {
- return null;
- }
+ $activity = new Activity($dom->documentElement);
- /**
- * Does this require authentication?
- *
- * @return boolean true if delete, else false
- */
+ $sub = null;
- function requiresAuth()
- {
- if ($_SERVER['REQUEST_METHOD'] == 'DELETE') {
- return true;
- } else {
- return false;
+ if (Event::handle('StartAtomPubNewActivity', array(&$activity))) {
+
+ if ($activity->verb != ActivityVerb::FOLLOW) {
+ // TRANS: Client error displayed when not using the follow verb.
+ $this->clientError(_('Can only handle Follow activities.'));
+ }
+
+ $person = $activity->objects[0];
+
+ if ($person->type != ActivityObject::PERSON) {
+ // TRANS: Client exception thrown when subscribing to an object that is not a person.
+ $this->clientError(_('Can only follow people.'));
+ }
+
+ // XXX: OStatus discovery (maybe)
+ try {
+ $profile = Profile::fromUri($person->id);
+ } catch (UnknownUriException $e) {
+ // TRANS: Client exception thrown when subscribing to a non-existing profile.
+ // TRANS: %s is the unknown profile ID.
+ $this->clientError(sprintf(_('Unknown profile %s.'), $person->id));
+ }
+
+ try {
+ $sub = Subscription::start($this->_profile, $profile);
+ } catch (AlreadyFulfilledException $e) {
+ // 409 Conflict
+ $this->clientError($e->getMessage(), 409);
+ }
+
+ Event::handle('EndAtomPubNewActivity', array($activity, $sub));
+ }
+
+ if (!empty($sub)) {
+ $act = $sub->asActivity();
+
+ header('Content-Type: application/atom+xml; charset=utf-8');
+ header('Content-Location: ' . $act->selfLink);
+
+ $this->startXML();
+ $this->raw($act->asString(true, true, true));
+ $this->endXML();
}
}
}
projects / quix0rs-gnu-social.git / blobdiff