From c619a257fe04a5ad4cc670c14cc1eab2042b71d8 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Thu, 9 Dec 2010 16:05:07 -0500 Subject: Add subscription feed for AtomPub --- actions/atompubsubscriptionfeed.php | 262 ++++++++++++++++++++++++++++++++++++ 1 file changed, 262 insertions(+) create mode 100644 actions/atompubsubscriptionfeed.php (limited to 'actions/atompubsubscriptionfeed.php') 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 @@ +. + * + * @category Cache + * @package StatusNet + * @author Evan Prodromou + * @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 + * @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; + } + } +} -- cgit v1.2.3-54-g00ecf From 5d56dba9046bd25e28918af443008bfe54a41db1 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Thu, 9 Dec 2010 16:25:47 -0500 Subject: add a new subscription using POST to APP --- actions/atompubsubscriptionfeed.php | 70 ++++++++++++++++++++++++++++++++++++- 1 file changed, 69 insertions(+), 1 deletion(-) (limited to 'actions/atompubsubscriptionfeed.php') diff --git a/actions/atompubsubscriptionfeed.php b/actions/atompubsubscriptionfeed.php index 5eddc4cdd..b5577b71a 100644 --- a/actions/atompubsubscriptionfeed.php +++ b/actions/atompubsubscriptionfeed.php @@ -210,6 +210,74 @@ class AtompubsubscriptionfeedAction extends ApiAuthAction $this->raw($feed->getString()); } + function addSubscription() + { + if (empty($this->auth_user) || + $this->auth_user->id != $this->_profile->id) { + throw new ClientException(_("Can't add someone else's". + " subscription"), 403); + } + + $xml = file_get_contents('php://input'); + + $dom = DOMDocument::loadXML($xml); + + 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.')); + return; + } + + $activity = new Activity($dom->documentElement); + + $sub = null; + + if (Event::handle('StartAtomPubNewActivity', array(&$activity))) { + + if ($activity->verb != ActivityVerb::FOLLOW) { + // TRANS: Client error displayed when not using the POST verb. + // TRANS: Do not translate POST. + $this->clientError(_('Can only handle Follow activities.')); + return; + } + + $person = $activity->objects[0]; + + if ($person->type != ActivityObject::PERSON) { + $this->clientError(_('Can only follow people.')); + return; + } + + // XXX: OStatus discovery (maybe) + + $profile = Profile::fromURI($person->id); + + if (empty($profile)) { + $this->clientError(sprintf(_('Unknown profile %s'), $person->id)); + return; + } + + if (Subscription::start($this->_profile, $profile)) { + $sub = Subscription::pkeyGet(array('subscriber' => $this->_profile->id, + 'subscribed' => $profile->id)); + } + + 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(); + } + } + /** * Return true if read only. * @@ -253,7 +321,7 @@ class AtompubsubscriptionfeedAction extends ApiAuthAction function requiresAuth() { - if ($_SERVER['REQUEST_METHOD'] == 'DELETE') { + if ($_SERVER['REQUEST_METHOD'] == 'POST') { return true; } else { return false; -- cgit v1.2.3-54-g00ecf From d9a614c57ec864fdb4e19e957cf50ac662a3679f Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Sat, 11 Dec 2010 11:24:07 -0500 Subject: use new Subscription stream methods for AtomPub --- actions/atompubsubscriptionfeed.php | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) (limited to 'actions/atompubsubscriptionfeed.php') diff --git a/actions/atompubsubscriptionfeed.php b/actions/atompubsubscriptionfeed.php index b5577b71a..065790c20 100644 --- a/actions/atompubsubscriptionfeed.php +++ b/actions/atompubsubscriptionfeed.php @@ -51,8 +51,8 @@ require_once INSTALLDIR . '/lib/apiauth.php'; class AtompubsubscriptionfeedAction extends ApiAuthAction { - private $_profile = null; - private $_subscribed = null; + private $_profile = null; + private $_subscriptions = null; /** * For initializing members of the class. @@ -76,11 +76,12 @@ class AtompubsubscriptionfeedAction extends ApiAuthAction } // 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); + $offset = ($this->page-1) * $this->count; + + $this->_subscriptions = Subscription::bySubscriber($subscriber, + $offset, + $this->count + 1); return true; } @@ -174,7 +175,7 @@ class AtompubsubscriptionfeedAction extends ApiAuthAction 'type' => 'application/atom+xml')); } - if ($this->_subscribed->N > $this->count) { + if ($this->_subscriptions->N > $this->count) { $feed->addLink(common_local_url('AtomPubSubscriptionFeed', array('subscriber' => @@ -189,7 +190,7 @@ class AtompubsubscriptionfeedAction extends ApiAuthAction // XXX: This is kind of inefficient - while ($this->_subscribed->fetch()) { + while ($this->_subscriptions->fetch()) { // We get one more than needed; skip that one @@ -199,17 +200,21 @@ class AtompubsubscriptionfeedAction extends ApiAuthAction 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)); } $this->raw($feed->getString()); } + /** + * Add a new subscription + * + * Handling the POST method for AtomPub + * + * @return void + */ + function addSubscription() { if (empty($this->auth_user) || -- cgit v1.2.3-54-g00ecf From 1817aedb5cf5c1cc7cfe1cb5146d087903b58e49 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Sun, 12 Dec 2010 12:13:54 -0500 Subject: fix subtitle in subscriptions feed --- actions/atompubsubscriptionfeed.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'actions/atompubsubscriptionfeed.php') diff --git a/actions/atompubsubscriptionfeed.php b/actions/atompubsubscriptionfeed.php index 065790c20..95a6fdd1a 100644 --- a/actions/atompubsubscriptionfeed.php +++ b/actions/atompubsubscriptionfeed.php @@ -148,8 +148,8 @@ class AtompubsubscriptionfeedAction extends ApiAuthAction $this->_profile->getBestName())); $feed->setSubtitle(sprintf(_("People %s has subscribed to on %s"), - $this->_profile->getBestName()), - common_config('site', 'name')); + $this->_profile->getBestName(), + common_config('site', 'name'))); $feed->addLink(common_local_url('subscriptions', array('nickname' => -- cgit v1.2.3-54-g00ecf From c5fee7573e486b572cb48d32f0286e76781775b6 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Mon, 13 Dec 2010 13:07:25 -0500 Subject: fix navigation links for subscriptions feed --- actions/atompubsubscriptionfeed.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'actions/atompubsubscriptionfeed.php') diff --git a/actions/atompubsubscriptionfeed.php b/actions/atompubsubscriptionfeed.php index 95a6fdd1a..15ae79f6a 100644 --- a/actions/atompubsubscriptionfeed.php +++ b/actions/atompubsubscriptionfeed.php @@ -168,8 +168,8 @@ class AtompubsubscriptionfeedAction extends ApiAuthAction $feed->addLink(common_local_url('AtomPubSubscriptionFeed', array('subscriber' => - $this->_profile->id, - 'page' => + $this->_profile->id), + array('page' => $this->page - 1)), array('rel' => 'prev', 'type' => 'application/atom+xml')); @@ -179,8 +179,8 @@ class AtompubsubscriptionfeedAction extends ApiAuthAction $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')); -- cgit v1.2.3-54-g00ecf