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 abstract class ApiSubscriptionsAction extends ApiBareAuthAction
57 * Take arguments for running
59 * @param array $args $_REQUEST args
61 * @return boolean success flag
63 protected function prepare(array $args=array())
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->target = $this->getTargetProfile($this->arg('id'));
81 if (!($this->target instanceof Profile)) {
82 // TRANS: Client error displayed when requesting a list of followers for a non-existing user.
83 $this->clientError(_('No such user.'), 404);
86 $this->profiles = $this->getProfiles();
98 protected function handle()
102 if (!in_array($this->format, array('xml', 'json'))) {
103 // TRANS: Client error displayed when coming across a non-supported API method.
104 $this->clientError(_('API method not found.'), 404);
107 $this->initDocument($this->format);
109 if (isset($this->ids_only)) {
112 $this->showProfiles(isset($this->lite) ? false : true);
115 $this->endDocument($this->format);
119 * Get profiles related to the type of subscriber/subscription action
121 * @return array Profiles
123 abstract protected function getProfiles();
126 * Is this action read only?
128 * @param array $args other arguments
130 * @return boolean true
132 function isReadOnly($args)
138 * When was this feed last modified?
140 * @return string datestamp of the latest profile in the stream
142 function lastModified()
144 if (!empty($this->profiles) && (count($this->profiles) > 0)) {
145 return strtotime($this->profiles[0]->created);
152 * An entity tag for this action
154 * Returns an Etag based on the action name, language, user ID, and
155 * timestamps of the first and last profiles in the subscriptions list
156 * There's also an indicator to show whether this action is being called
157 * as /api/statuses/(friends|followers) or /api/(friends|followers)/ids
159 * @return string etag
163 if (!empty($this->profiles) && (count($this->profiles) > 0)) {
165 $last = count($this->profiles) - 1;
167 return '"' . implode(
169 array($this->arg('action'),
170 common_user_cache_hash($this->auth_user),
174 isset($this->ids_only) ? 'IDs' : 'Profiles',
175 strtotime($this->profiles[0]->created),
176 strtotime($this->profiles[$last]->created))
185 * Show the profiles as Twitter-style useres and statuses
187 * @param boolean $include_statuses Whether to include the latest status
188 * with each user. Default true.
192 function showProfiles($include_statuses = true)
194 switch ($this->format) {
196 $this->elementStart('users', array('type' => 'array',
197 'xmlns:statusnet' => 'http://status.net/schema/api/1/'));
198 foreach ($this->profiles as $profile) {
206 $this->elementEnd('users');
210 foreach ($this->profiles as $profile) {
211 $arrays[] = $this->twitterUserArray(
216 print json_encode($arrays);
219 // TRANS: Client error displayed when requesting profiles of followers in an unsupported format.
220 $this->clientError(_('Unsupported format.'));
226 * Show the IDs of the profiles only. 5000 per page. To support
227 * the 'social graph' methods: /api/(friends|followers)/ids
233 switch ($this->format) {
235 $this->elementStart('ids');
236 foreach ($this->profiles as $profile) {
237 $this->element('id', null, $profile->id);
239 $this->elementEnd('ids');
243 foreach ($this->profiles as $profile) {
244 $ids[] = (int)$profile->id;
246 print json_encode($ids);
249 // TRANS: Client error displayed when requesting IDs of followers in an unsupported format.
250 $this->clientError(_('Unsupported format.'));