]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/atompubmembershipfeed.php
Merge commit 'refs/merge-requests/199' of git://gitorious.org/statusnet/mainline...
[quix0rs-gnu-social.git] / actions / atompubmembershipfeed.php
1 <?php
2 /**
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2010, StatusNet, Inc.
5  *
6  * Feed of group memberships for a user, in ActivityStreams format
7  *
8  * PHP version 5
9  *
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.
14  *
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.
19  *
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/>.
22  *
23  * @category  AtomPub
24  * @package   StatusNet
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/
29  */
30
31 if (!defined('STATUSNET')) {
32     // This check helps protect against security problems;
33     // your code file can't be executed directly from the web.
34     exit(1);
35 }
36
37 /**
38  * Feed of group memberships for a user, in ActivityStreams format
39  *
40  * @category  Action
41  * @package   StatusNet
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/
46  */
47 class AtompubmembershipfeedAction extends ApiAuthAction
48 {
49     private $_profile     = null;
50     private $_memberships = null;
51
52     /**
53      * For initializing members of the class.
54      *
55      * @param array $argarray misc. arguments
56      *
57      * @return boolean true
58      */
59     function prepare($argarray)
60     {
61         parent::prepare($argarray);
62
63         $profileId = $this->trimmed('profile');
64
65         $this->_profile = Profile::getKV('id', $profileId);
66
67         if (empty($this->_profile)) {
68             // TRANS: Client exception.
69             throw new ClientException(_('No such profile.'), 404);
70         }
71
72         $offset = ($this->page-1) * $this->count;
73         $limit  = $this->count + 1;
74
75         $this->_memberships = Group_member::byMember($this->_profile->id,
76                                                      $offset,
77                                                      $limit);
78
79         return true;
80     }
81
82     /**
83      * Handler method
84      *
85      * @param array $argarray is ignored since it's now passed in in prepare()
86      *
87      * @return void
88      */
89     function handle($argarray=null)
90     {
91         parent::handle($argarray);
92
93         switch ($_SERVER['REQUEST_METHOD']) {
94         case 'HEAD':
95         case 'GET':
96             $this->showFeed();
97             break;
98         case 'POST':
99             $this->addMembership();
100             break;
101         default:
102             // TRANS: Client exception thrown when using an unsupported HTTP method.
103             throw new ClientException(_('HTTP method not supported.'), 405);
104             return;
105         }
106
107         return;
108     }
109
110     /**
111      * Show a feed of favorite activity streams objects
112      *
113      * @return void
114      */
115     function showFeed()
116     {
117         header('Content-Type: application/atom+xml; charset=utf-8');
118
119         $url = common_local_url('AtomPubMembershipFeed',
120                                 array('profile' => $this->_profile->id));
121
122         $feed = new Atom10Feed(true);
123
124         $feed->addNamespace('activity',
125                             'http://activitystrea.ms/spec/1.0/');
126
127         $feed->addNamespace('poco',
128                             'http://portablecontacts.net/spec/1.0');
129
130         $feed->addNamespace('media',
131                             'http://purl.org/syndication/atommedia');
132
133         $feed->id = $url;
134
135         $feed->setUpdated('now');
136
137         $feed->addAuthor($this->_profile->getBestName(),
138                          $this->_profile->getURI());
139
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()));
144
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')));
150
151         $feed->addLink(common_local_url('usergroups',
152                                         array('nickname' =>
153                                               $this->_profile->nickname)));
154
155         $feed->addLink($url,
156                        array('rel' => 'self',
157                              'type' => 'application/atom+xml'));
158
159         // If there's more...
160
161         if ($this->page > 1) {
162             $feed->addLink($url,
163                            array('rel' => 'first',
164                                  'type' => 'application/atom+xml'));
165
166             $feed->addLink(common_local_url('AtomPubMembershipFeed',
167                                             array('profile' =>
168                                                   $this->_profile->id),
169                                             array('page' =>
170                                                   $this->page - 1)),
171                            array('rel' => 'prev',
172                                  'type' => 'application/atom+xml'));
173         }
174
175         if ($this->_memberships->N > $this->count) {
176
177             $feed->addLink(common_local_url('AtomPubMembershipFeed',
178                                             array('profile' =>
179                                                   $this->_profile->id),
180                                             array('page' =>
181                                                   $this->page + 1)),
182                            array('rel' => 'next',
183                                  'type' => 'application/atom+xml'));
184         }
185
186         $i = 0;
187
188         while ($this->_memberships->fetch()) {
189
190             // We get one more than needed; skip that one
191
192             $i++;
193
194             if ($i > $this->count) {
195                 break;
196             }
197
198             $act = $this->_memberships->asActivity();
199             $feed->addEntryRaw($act->asString(false, false, false));
200         }
201
202         $this->raw($feed->getString());
203     }
204
205     /**
206      * add a new favorite
207      *
208      * @return void
209      */
210     function addMembership()
211     {
212         // XXX: Refactor this; all the same for atompub
213
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);
219         }
220
221         $xml = file_get_contents('php://input');
222
223         $dom = DOMDocument::loadXML($xml);
224
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.'));
229             return;
230         }
231
232         $activity = new Activity($dom->documentElement);
233
234         $membership = null;
235
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.'));
240                 return;
241             }
242
243             $groupObj = $activity->objects[0];
244
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.'));
248                 return;
249             }
250
251             $group = User_group::getKV('uri', $groupObj->id);
252
253             if (empty($group)) {
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.'));
257             }
258
259             $old = Group_member::pkeyGet(array('profile_id' => $this->auth_user->id,
260                                                'group_id' => $group->id));
261
262             if (!empty($old)) {
263                 // TRANS: Client exception thrown when trying to subscribe to an already subscribed group.
264                 throw new ClientException(_('Already a member.'));
265             }
266
267             $profile = $this->auth_user->getProfile();
268
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.'));
273             }
274
275             $this->auth_user->joinGroup($group);
276
277             Event::handle('EndAtomPubNewActivity', array($activity, $membership));
278         }
279
280         if (!empty($membership)) {
281             $act = $membership->asActivity();
282
283             header('Content-Type: application/atom+xml; charset=utf-8');
284             header('Content-Location: ' . $act->selfLink);
285
286             $this->startXML();
287             $this->raw($act->asString(true, true, true));
288             $this->endXML();
289         }
290     }
291
292     /**
293      * Return true if read only.
294      *
295      * MAY override
296      *
297      * @param array $args other arguments
298      *
299      * @return boolean is read only action?
300      */
301     function isReadOnly($args)
302     {
303         if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
304             $_SERVER['REQUEST_METHOD'] == 'HEAD') {
305             return true;
306         } else {
307             return false;
308         }
309     }
310
311     /**
312      * Return last modified, if applicable.
313      *
314      * MAY override
315      *
316      * @return string last modified http header
317      */
318     function lastModified()
319     {
320         // For comparison with If-Last-Modified
321         // If not applicable, return null
322         return null;
323     }
324
325     /**
326      * Return etag, if applicable.
327      *
328      * MAY override
329      *
330      * @return string etag http header
331      */
332     function etag()
333     {
334         return null;
335     }
336
337     /**
338      * Does this require authentication?
339      *
340      * @return boolean true if delete, else false
341      */
342     function requiresAuth()
343     {
344         if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
345             $_SERVER['REQUEST_METHOD'] == 'HEAD') {
346             return false;
347         } else {
348             return true;
349         }
350     }
351 }