3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * Show a single membership as an Activity Streams entry
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 * Show (or delete) a single membership event as an ActivityStreams entry
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 AtompubshowmembershipAction extends ApiAuthAction
49 private $_profile = null;
50 private $_group = null;
51 private $_membership = null;
54 * For initializing members of the class.
56 * @param array $argarray misc. arguments
58 * @return boolean true
60 function prepare($argarray)
62 parent::prepare($argarray);
64 $profileId = $this->trimmed('profile');
66 $this->_profile = Profile::getKV('id', $profileId);
68 if (empty($this->_profile)) {
69 // TRANS: Client exception.
70 throw new ClientException(_('No such profile.'), 404);
73 $groupId = $this->trimmed('group');
75 $this->_group = User_group::getKV('id', $groupId);
77 if (empty($this->_group)) {
78 // TRANS: Client exception thrown when referencing a non-existing group.
79 throw new ClientException(_('No such group.'), 404);
82 $kv = array('group_id' => $groupId,
83 'profile_id' => $profileId);
85 $this->_membership = Group_member::pkeyGet($kv);
87 if (empty($this->_membership)) {
88 // TRANS: Client exception thrown when trying to show membership of a non-subscribed group
89 throw new ClientException(_('Not a member.'), 404);
98 * @param array $argarray is ignored since it's now passed in in prepare()
102 function handle($argarray=null)
104 switch ($_SERVER['REQUEST_METHOD']) {
107 $this->showMembership();
110 $this->deleteMembership();
113 // TRANS: Client exception thrown when using an unsupported HTTP method.
114 throw new ClientException(_('HTTP method not supported.'), 405);
121 * show a single membership
125 function showMembership()
127 $activity = $this->_membership->asActivity();
129 header('Content-Type: application/atom+xml; charset=utf-8');
132 $this->raw($activity->asString(true, true, true));
139 * Delete the membership (leave the group)
143 function deleteMembership()
145 if (empty($this->auth_user) ||
146 $this->auth_user->id != $this->_profile->id) {
147 // TRANS: Client exception thrown when deleting someone else's membership.
148 throw new ClientException(_("Cannot delete someone else's".
149 " membership."), 403);
152 $this->auth_user->leaveGroup($this->_group);
158 * Return true if read only.
162 * @param array $args other arguments
164 * @return boolean is read only action?
166 function isReadOnly($args)
168 if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
169 $_SERVER['REQUEST_METHOD'] == 'HEAD') {
177 * Return last modified, if applicable.
179 * Because the representation depends on the profile and group,
180 * our last modified value is the maximum of their mod time
181 * with the actual membership's mod time.
183 * @return string last modified http header
185 function lastModified()
187 return max(strtotime($this->_profile->modified),
188 strtotime($this->_group->modified),
189 strtotime($this->_membership->modified));
193 * Return etag, if applicable.
195 * A "weak" Etag including the profile and group id as well as
196 * the admin flag and ctime of the membership.
198 * @return string etag http header
202 $ctime = strtotime($this->_membership->created);
204 $adminflag = ($this->_membership->is_admin) ? 't' : 'f';
206 return 'W/"' . implode(':', array('AtomPubShowMembership',
214 * Does this require authentication?
216 * @return boolean true if delete, else false
218 function requiresAuth()
220 if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
221 $_SERVER['REQUEST_METHOD'] == 'HEAD') {