3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * Feed of group memberships for a user, in ActivityStreams format
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 * Feed of group memberships for a user, in ActivityStreams format
42 * @author Evan Prodromou <evan@status.net>
43 * @copyright 2010 StatusNet, Inc.
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
45 * @link http://status.net/
47 class AtompubmembershipfeedAction extends ApiAuthAction
49 private $_profile = null;
50 private $_memberships = null;
53 * For initializing members of the class.
55 * @param array $argarray misc. arguments
57 * @return boolean true
59 function prepare($argarray)
61 parent::prepare($argarray);
63 $profileId = $this->trimmed('profile');
65 $this->_profile = Profile::getKV('id', $profileId);
67 if (empty($this->_profile)) {
68 // TRANS: Client exception.
69 throw new ClientException(_('No such profile.'), 404);
72 $offset = ($this->page-1) * $this->count;
73 $limit = $this->count + 1;
75 $this->_memberships = Group_member::byMember($this->_profile->id,
85 * @param array $argarray is ignored since it's now passed in in prepare()
89 function handle($argarray=null)
91 parent::handle($argarray);
93 switch ($_SERVER['REQUEST_METHOD']) {
99 $this->addMembership();
102 // TRANS: Client exception thrown when using an unsupported HTTP method.
103 throw new ClientException(_('HTTP method not supported.'), 405);
111 * Show a feed of favorite activity streams objects
117 header('Content-Type: application/atom+xml; charset=utf-8');
119 $url = common_local_url('AtomPubMembershipFeed',
120 array('profile' => $this->_profile->id));
122 $feed = new Atom10Feed(true);
124 $feed->addNamespace('activity',
125 'http://activitystrea.ms/spec/1.0/');
127 $feed->addNamespace('poco',
128 'http://portablecontacts.net/spec/1.0');
130 $feed->addNamespace('media',
131 'http://purl.org/syndication/atommedia');
135 $feed->setUpdated('now');
137 $feed->addAuthor($this->_profile->getBestName(),
138 $this->_profile->getURI());
140 // TRANS: Title for group membership feed.
141 // TRANS: %s is a username.
142 $feed->setTitle(sprintf(_('Group memberships of %s'),
143 $this->_profile->getBestName()));
145 // TRANS: Subtitle for group membership feed.
146 // TRANS: %1$s is a username, %2$s is the StatusNet sitename.
147 $feed->setSubtitle(sprintf(_('Groups %1$s is a member of on %2$s'),
148 $this->_profile->getBestName(),
149 common_config('site', 'name')));
151 $feed->addLink(common_local_url('usergroups',
153 $this->_profile->nickname)));
156 array('rel' => 'self',
157 'type' => 'application/atom+xml'));
159 // If there's more...
161 if ($this->page > 1) {
163 array('rel' => 'first',
164 'type' => 'application/atom+xml'));
166 $feed->addLink(common_local_url('AtomPubMembershipFeed',
168 $this->_profile->id),
171 array('rel' => 'prev',
172 'type' => 'application/atom+xml'));
175 if ($this->_memberships->N > $this->count) {
177 $feed->addLink(common_local_url('AtomPubMembershipFeed',
179 $this->_profile->id),
182 array('rel' => 'next',
183 'type' => 'application/atom+xml'));
188 while ($this->_memberships->fetch()) {
190 // We get one more than needed; skip that one
194 if ($i > $this->count) {
198 $act = $this->_memberships->asActivity();
199 $feed->addEntryRaw($act->asString(false, false, false));
202 $this->raw($feed->getString());
210 function addMembership()
212 // XXX: Refactor this; all the same for atompub
214 if (empty($this->auth_user) ||
215 $this->auth_user->id != $this->_profile->id) {
216 // TRANS: Client exception thrown when trying subscribe someone else to a group.
217 throw new ClientException(_("Cannot add someone else's".
218 " membership."), 403);
221 $xml = file_get_contents('php://input');
223 $dom = DOMDocument::loadXML($xml);
225 if ($dom->documentElement->namespaceURI != Activity::ATOM ||
226 $dom->documentElement->localName != 'entry') {
227 // TRANS: Client error displayed when not using an Atom entry.
228 throw new ClientException(_('Atom post must be an Atom entry.'));
232 $activity = new Activity($dom->documentElement);
236 if (Event::handle('StartAtomPubNewActivity', array(&$activity))) {
237 if ($activity->verb != ActivityVerb::JOIN) {
238 // TRANS: Client error displayed when not using the join verb.
239 throw new ClientException(_('Can only handle join activities.'));
243 $groupObj = $activity->objects[0];
245 if ($groupObj->type != ActivityObject::GROUP) {
246 // TRANS: Client exception thrown when trying favorite an object that is not a notice.
247 throw new ClientException(_('Can only fave notices.'));
251 $group = User_group::getKV('uri', $groupObj->id);
254 // XXX: import from listed URL or something
255 // TRANS: Client exception thrown when trying to subscribe to a non-existing group.
256 throw new ClientException(_('Unknown group.'));
259 $old = Group_member::pkeyGet(array('profile_id' => $this->auth_user->id,
260 'group_id' => $group->id));
263 // TRANS: Client exception thrown when trying to subscribe to an already subscribed group.
264 throw new ClientException(_('Already a member.'));
267 $profile = $this->auth_user->getProfile();
269 if (Group_block::isBlocked($group, $profile)) {
270 // XXX: import from listed URL or something
271 // TRANS: Client exception thrown when trying to subscribe to group while blocked from that group.
272 throw new ClientException(_('Blocked by admin.'));
275 $this->auth_user->joinGroup($group);
277 Event::handle('EndAtomPubNewActivity', array($activity, $membership));
280 if (!empty($membership)) {
281 $act = $membership->asActivity();
283 header('Content-Type: application/atom+xml; charset=utf-8');
284 header('Content-Location: ' . $act->selfLink);
287 $this->raw($act->asString(true, true, true));
293 * Return true if read only.
297 * @param array $args other arguments
299 * @return boolean is read only action?
301 function isReadOnly($args)
303 if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
304 $_SERVER['REQUEST_METHOD'] == 'HEAD') {
312 * Return last modified, if applicable.
316 * @return string last modified http header
318 function lastModified()
320 // For comparison with If-Last-Modified
321 // If not applicable, return null
326 * Return etag, if applicable.
330 * @return string etag http header
338 * Does this require authentication?
340 * @return boolean true if delete, else false
342 function requiresAuth()
344 if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
345 $_SERVER['REQUEST_METHOD'] == 'HEAD') {