3 * StatusNet, the distributed open-source microblogging tool
5 * Base class for showing subscription information in the API
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Dan Moore <dan@moore.cx>
25 * @author Evan Prodromou <evan@status.net>
26 * @author Zach Copley <zach@status.net>
27 * @copyright 2009 StatusNet, Inc.
28 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
29 * @link http://status.net/
32 if (!defined('STATUSNET')) {
37 * This class outputs a list of profiles as Twitter-style user and status objects.
38 * It is used by the API methods /api/statuses/(friends|followers). To support the
39 * social graph methods it also can output a simple list of IDs.
43 * @author Dan Moore <dan@moore.cx>
44 * @author Evan Prodromou <evan@status.net>
45 * @author Zach Copley <zach@status.net>
46 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47 * @link http://status.net/
49 class ApiSubscriptionsAction extends ApiBareAuthAction
57 * Take arguments for running
59 * @param array $args $_REQUEST args
61 * @return boolean success flag
63 function prepare($args)
65 parent::prepare($args);
67 $this->tag = $this->arg('tag');
69 // Note: Twitter no longer supports 'lite'
70 $this->lite = $this->arg('lite');
72 $this->ids_only = $this->arg('ids_only');
74 // If called as a social graph method, show 5000 per page, otherwise 100
76 $this->count = isset($this->ids_only) ?
77 5000 : (int)$this->arg('count', 100);
79 $this->user = $this->getTargetUser($this->arg('id'));
81 if (empty($this->user)) {
82 // TRANS: Client error displayed when requesting a list of followers for a non-existing user.
83 $this->clientError(_('No such user.'), 404, $this->format);
87 $this->profiles = $this->getProfiles();
97 * @param array $args $_REQUEST data (unused)
101 function handle($args)
103 parent::handle($args);
105 if (!in_array($this->format, array('xml', 'json'))) {
106 // TRANS: Client error displayed when coming across a non-supported API method.
107 $this->clientError(_('API method not found.'), $code = 404);
111 $this->initDocument($this->format);
113 if (isset($this->ids_only)) {
116 $this->showProfiles(isset($this->lite) ? false : true);
119 $this->endDocument($this->format);
123 * Get profiles - should get overrrided
125 * @return array Profiles
127 function getProfiles()
132 * Is this action read only?
134 * @param array $args other arguments
136 * @return boolean true
138 function isReadOnly($args)
144 * When was this feed last modified?
146 * @return string datestamp of the latest profile in the stream
148 function lastModified()
150 if (!empty($this->profiles) && (count($this->profiles) > 0)) {
151 return strtotime($this->profiles[0]->created);
158 * An entity tag for this action
160 * Returns an Etag based on the action name, language, user ID, and
161 * timestamps of the first and last profiles in the subscriptions list
162 * There's also an indicator to show whether this action is being called
163 * as /api/statuses/(friends|followers) or /api/(friends|followers)/ids
165 * @return string etag
169 if (!empty($this->profiles) && (count($this->profiles) > 0)) {
171 $last = count($this->profiles) - 1;
173 return '"' . implode(
175 array($this->arg('action'),
176 common_user_cache_hash($this->auth_user),
180 isset($this->ids_only) ? 'IDs' : 'Profiles',
181 strtotime($this->profiles[0]->created),
182 strtotime($this->profiles[$last]->created))
191 * Show the profiles as Twitter-style useres and statuses
193 * @param boolean $include_statuses Whether to include the latest status
194 * with each user. Default true.
198 function showProfiles($include_statuses = true)
200 switch ($this->format) {
202 $this->elementStart('users', array('type' => 'array',
203 'xmlns:statusnet' => 'http://status.net/schema/api/1/'));
204 foreach ($this->profiles as $profile) {
212 $this->elementEnd('users');
216 foreach ($this->profiles as $profile) {
217 $arrays[] = $this->twitterUserArray(
222 print json_encode($arrays);
225 // TRANS: Client error displayed when requesting profiles of followers in an unsupported format.
226 $this->clientError(_('Unsupported format.'));
232 * Show the IDs of the profiles only. 5000 per page. To support
233 * the 'social graph' methods: /api/(friends|followers)/ids
239 switch ($this->format) {
241 $this->elementStart('ids');
242 foreach ($this->profiles as $profile) {
243 $this->element('id', null, $profile->id);
245 $this->elementEnd('ids');
249 foreach ($this->profiles as $profile) {
250 $ids[] = (int)$profile->id;
252 print json_encode($ids);
255 // TRANS: Client error displayed when requesting IDs of followers in an unsupported format.
256 $this->clientError(_('Unsupported format.'));