]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/atompubmembershipfeed.php
Merge branch 'activityatompub' into 0.9.x
[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 require_once INSTALLDIR . '/lib/apiauth.php';
38
39 /**
40  * Feed of group memberships for a user, in ActivityStreams format
41  *
42  * @category  Action
43  * @package   StatusNet
44  * @author    Evan Prodromou <evan@status.net>
45  * @copyright 2010 StatusNet, Inc.
46  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
47  * @link      http://status.net/
48  */
49
50 class AtompubmembershipfeedAction extends ApiAuthAction
51 {
52     private $_profile     = null;
53     private $_memberships = null;
54
55     /**
56      * For initializing members of the class.
57      *
58      * @param array $argarray misc. arguments
59      *
60      * @return boolean true
61      */
62
63     function prepare($argarray)
64     {
65         parent::prepare($argarray);
66
67         $profileId = $this->trimmed('profile');
68
69         $this->_profile = Profile::staticGet('id', $profileId);
70         
71         if (empty($this->_profile)) {
72             throw new ClientException(_('No such profile.'), 404);
73         }
74
75         $offset = ($this->page-1) * $this->count;
76         $limit  = $this->count + 1;
77
78         $this->_memberships = Group_member::byMember($this->_profile->id,
79                                                      $offset,
80                                                      $limit);
81         
82         return true;
83     }
84
85     /**
86      * Handler method
87      *
88      * @param array $argarray is ignored since it's now passed in in prepare()
89      *
90      * @return void
91      */
92
93     function handle($argarray=null)
94     {
95         parent::handle($argarray);
96
97         switch ($_SERVER['REQUEST_METHOD']) {
98         case 'HEAD':
99         case 'GET':
100             $this->showFeed();
101             break;
102         case 'POST':
103             $this->addMembership();
104             break;
105         default:
106             throw new ClientException(_('HTTP method not supported.'), 405);
107             return;
108         }
109
110         return;
111     }
112
113     /**
114      * Show a feed of favorite activity streams objects
115      *
116      * @return void
117      */
118
119     function showFeed()
120     {
121         header('Content-Type: application/atom+xml; charset=utf-8');
122
123         $url = common_local_url('AtomPubMembershipFeed',
124                                 array('profile' => $this->_profile->id));
125
126         $feed = new Atom10Feed(true);
127
128         $feed->addNamespace('activity',
129                             'http://activitystrea.ms/spec/1.0/');
130
131         $feed->addNamespace('poco',
132                             'http://portablecontacts.net/spec/1.0');
133
134         $feed->addNamespace('media',
135                             'http://purl.org/syndication/atommedia');
136
137         $feed->id = $url;
138
139         $feed->setUpdated('now');
140
141         $feed->addAuthor($this->_profile->getBestName(),
142                          $this->_profile->getURI());
143
144         $feed->setTitle(sprintf(_("%s group memberships"),
145                                 $this->_profile->getBestName()));
146
147         $feed->setSubtitle(sprintf(_("Groups %s is a member of on %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
211     function addMembership()
212     {
213         // XXX: Refactor this; all the same for atompub
214
215         if (empty($this->auth_user) ||
216             $this->auth_user->id != $this->_profile->id) {
217             throw new ClientException(_("Can't 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
238             if ($activity->verb != ActivityVerb::JOIN) {
239                 // TRANS: Client error displayed when not using the POST verb.
240                 // TRANS: Do not translate POST.
241                 throw new ClientException(_('Can only handle Join activities.'));
242                 return;
243             }
244
245             $groupObj = $activity->objects[0];
246
247             if ($groupObj->type != ActivityObject::GROUP) {
248                 throw new ClientException(_('Can only fave notices.'));
249                 return;
250             }
251
252             $group = User_group::staticGet('uri', $groupObj->id);
253             
254             if (empty($group)) {
255                 // XXX: import from listed URL or something
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                 throw new ClientException(_('Already a member.'));
264             }
265
266             $profile = $this->auth_user->getProfile();
267
268             if (Group_block::isBlocked($group, $profile)) {
269                 // XXX: import from listed URL or something
270                 throw new ClientException(_('Blocked by admin.'));
271             }
272
273             if (Event::handle('StartJoinGroup', array($group, $this->auth_user))) {
274                 $membership = Group_member::join($group->id, $this->auth_user->id);
275                 Event::handle('EndJoinGroup', array($group, $this->auth_user));
276             }
277
278             Event::handle('EndAtomPubNewActivity', array($activity, $membership));
279         }
280
281         if (!empty($membership)) {
282             $act = $membership->asActivity();
283
284             header('Content-Type: application/atom+xml; charset=utf-8');
285             header('Content-Location: ' . $act->selfLink);
286
287             $this->startXML();
288             $this->raw($act->asString(true, true, true));
289             $this->endXML();
290         }
291     }
292
293     /**
294      * Return true if read only.
295      *
296      * MAY override
297      *
298      * @param array $args other arguments
299      *
300      * @return boolean is read only action?
301      */
302
303     function isReadOnly($args)
304     {
305         if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
306             $_SERVER['REQUEST_METHOD'] == 'HEAD') {
307             return true;
308         } else {
309             return false;
310         }
311     }
312
313     /**
314      * Return last modified, if applicable.
315      *
316      * MAY override
317      *
318      * @return string last modified http header
319      */
320     function lastModified()
321     {
322         // For comparison with If-Last-Modified
323         // If not applicable, return null
324         return null;
325     }
326
327     /**
328      * Return etag, if applicable.
329      *
330      * MAY override
331      *
332      * @return string etag http header
333      */
334
335     function etag()
336     {
337         return null;
338     }
339
340     /**
341      * Does this require authentication?
342      *
343      * @return boolean true if delete, else false
344      */
345
346     function requiresAuth()
347     {
348         if ($_SERVER['REQUEST_METHOD'] == 'GET' ||
349             $_SERVER['REQUEST_METHOD'] == 'HEAD') {
350             return false;
351         } else {
352             return true;
353         }
354     }
355 }