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 Zach Copley <zach@status.net>
25 * @copyright 2009 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET')) {
34 require_once INSTALLDIR.'/lib/apibareauth.php';
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 Zach Copley <zach@status.net>
44 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
45 * @link http://status.net/
48 class ApiSubscriptionsAction extends ApiBareAuthAction
61 * Take arguments for running
63 * @param array $args $_REQUEST args
65 * @return boolean success flag
69 function prepare($args)
71 parent::prepare($args);
73 $this->page = (int)$this->arg('page', 1);
74 $this->tag = $this->arg('tag');
75 $this->format = $this->arg('format');
77 // Note: Twitter no longer supports 'lite'
78 $this->lite = $this->arg('lite');
80 $this->ids_only = $this->arg('ids_only');
82 // If called as a social graph method, show 5000 per page, otherwise 100
84 $this->count = isset($this->ids_only) ?
85 5000 : (int)$this->arg('count', 100);
87 if ($this->requiresAuth()) {
88 if ($this->checkBasicAuthUser() == false) {
93 $this->user = $this->getTargetUser($this->arg('id'));
95 if (empty($this->user)) {
96 $this->clientError(_('No such user!'), 404, $this->format);
100 $this->profiles = $this->getProfiles();
110 * @param array $args $_REQUEST data (unused)
115 function handle($args)
117 parent::handle($args);
119 if (!in_array($this->format, array('xml', 'json'))) {
120 $this->clientError(_('API method not found!'), $code = 404);
124 $this->init_document($this->format);
126 if (isset($this->ids_only)) {
129 $this->showProfiles(isset($this->lite) ? false : true);
132 $this->end_document($this->format);
136 * Get profiles - should get overrrided
138 * @return array Profiles
141 function getProfiles()
146 * Is this action read only?
148 * @param array $args other arguments
150 * @return boolean true
153 function isReadOnly($args)
159 * When was this feed last modified?
161 * @return string datestamp of the latest profile in the stream
164 function lastModified()
166 if (!empty($this->profiles) && (count($this->profiles) > 0)) {
167 return strtotime($this->profiles[0]->created);
174 * An entity tag for this action
176 * Returns an Etag based on the action name, language, user ID, and
177 * timestamps of the first and last profiles in the subscriptions list
178 * There's also an indicator to show whether this action is being called
179 * as /api/statuses/(friends|followers) or /api/(friends|followers)/ids
181 * @return string etag
186 if (!empty($this->profiles) && (count($this->profiles) > 0)) {
188 $last = count($this->profiles) - 1;
190 return '"' . implode(
192 array($this->arg('action'),
195 isset($this->ids_only) ? 'IDs' : 'Profiles',
196 strtotime($this->profiles[0]->created),
197 strtotime($this->profiles[$last]->created))
206 * Show the profiles as Twitter-style useres and statuses
208 * @param boolean $include_statuses Whether to include the latest status
209 * with each user. Default true.
214 function showProfiles($include_statuses = true)
216 switch ($this->format) {
218 $this->elementStart('users', array('type' => 'array'));
219 foreach ($this->profiles as $profile) {
227 $this->elementEnd('users');
231 foreach ($this->profiles as $profile) {
232 $arrays[] = $this->twitter_user_array(
237 print json_encode($arrays);
240 $this->clientError(_('Unsupported format.'));
246 * Show the IDs of the profiles only. 5000 per page. To support
247 * the 'social graph' methods: /api/(friends|followers)/ids
254 switch ($this->format) {
256 $this->elementStart('ids');
257 foreach ($this->profiles as $profile) {
258 $this->element('id', null, $profile->id);
260 $this->elementEnd('ids');
264 foreach ($this->profiles as $profile) {
265 $ids[] = (int)$profile->id;
267 print json_encode($ids);
270 $this->clientError(_('Unsupported format.'));