3 * StatusNet, the distributed open-source microblogging tool
5 * Dummy action that emulates Twitter's rate limit status API resource
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 Brion Vibber <brion@pobox.com>
25 * @author Evan Prodromou <evan@status.net>
26 * @author Robin Millette <robin@millette.info>
27 * @author Siebrand Mazeland <s.mazeland@xs4all.nl>
28 * @author Zach Copley <zach@status.net>
29 * @copyright 2009 StatusNet, Inc.
30 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
31 * @link http://status.net/
34 if (!defined('GNUSOCIAL')) { exit(1); }
37 * We don't have a rate limit, but some clients check this method.
38 * It always returns the same thing: 150 hits left.
42 * @author Evan Prodromou <evan@status.net>
43 * @author Robin Millette <robin@millette.info>
44 * @author Zach Copley <zach@status.net>
45 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
46 * @link http://status.net/
48 class ApiAccountRateLimitStatusAction extends ApiBareAuthAction
53 * Return some Twitter-ish data about API limits
55 * @param array $args $_REQUEST data (unused)
59 protected function handle()
63 if (!in_array($this->format, array('xml', 'json'))) {
65 // TRANS: Client error displayed when coming across a non-supported API method.
66 _('API method not found.'),
72 $reset = new DateTime();
73 $reset->modify('+1 hour');
75 $this->initDocument($this->format);
77 if ($this->format == 'xml') {
78 $this->elementStart('hash');
79 $this->element('remaining-hits', array('type' => 'integer'), 150);
80 $this->element('hourly-limit', array('type' => 'integer'), 150);
82 'reset-time', array('type' => 'datetime'),
83 common_date_iso8601($reset->format('r'))
86 'reset_time_in_seconds',
87 array('type' => 'integer'),
90 $this->elementEnd('hash');
91 } elseif ($this->format == 'json') {
93 'reset_time_in_seconds' => strtotime('+1 hour'),
94 'remaining_hits' => 150,
95 'hourly_limit' => 150,
96 'reset_time' => common_date_rfc2822(
100 print json_encode($out);
103 $this->endDocument($this->format);
107 * Return true if read only.
111 * @param array $args other arguments
113 * @return boolean is read only action?
115 function isReadOnly($args)