]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apiaccountratelimitstatus.php
Merge branch 'subscribers_as_addressees' into 'nightly'
[quix0rs-gnu-social.git] / actions / apiaccountratelimitstatus.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Dummy action that emulates Twitter's rate limit status API resource
6  *
7  * PHP version 5
8  *
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.
13  *
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.
18  *
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/>.
21  *
22  * @category  API
23  * @package   StatusNet
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/
32  */
33
34 if (!defined('STATUSNET')) {
35     exit(1);
36 }
37
38 /**
39  * We don't have a rate limit, but some clients check this method.
40  * It always returns the same thing: 150 hits left.
41  *
42  * @category API
43  * @package  StatusNet
44  * @author   Evan Prodromou <evan@status.net>
45  * @author   Robin Millette <robin@millette.info>
46  * @author   Zach Copley <zach@status.net>
47  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
48  * @link     http://status.net/
49  */
50 class ApiAccountRateLimitStatusAction extends ApiBareAuthAction
51 {
52     /**
53      * Handle the request
54      *
55      * Return some Twitter-ish data about API limits
56      *
57      * @param array $args $_REQUEST data (unused)
58      *
59      * @return void
60      */
61     function handle($args)
62     {
63         parent::handle($args);
64
65         if (!in_array($this->format, array('xml', 'json'))) {
66             $this->clientError(
67                 // TRANS: Client error displayed when coming across a non-supported API method.
68                 _('API method not found.'),
69                 404,
70                 $this->format
71             );
72             return;
73         }
74
75         $reset   = new DateTime();
76         $reset->modify('+1 hour');
77
78         $this->initDocument($this->format);
79
80          if ($this->format == 'xml') {
81              $this->elementStart('hash');
82              $this->element('remaining-hits', array('type' => 'integer'), 150);
83              $this->element('hourly-limit', array('type' => 'integer'), 150);
84              $this->element(
85                  'reset-time', array('type' => 'datetime'),
86                  common_date_iso8601($reset->format('r'))
87              );
88              $this->element(
89                  'reset_time_in_seconds',
90                  array('type' => 'integer'),
91                  strtotime('+1 hour')
92              );
93              $this->elementEnd('hash');
94          } elseif ($this->format == 'json') {
95              $out = array(
96                  'reset_time_in_seconds' => strtotime('+1 hour'),
97                  'remaining_hits' => 150,
98                  'hourly_limit' => 150,
99                  'reset_time' => common_date_rfc2822(
100                      $reset->format('r')
101                   )
102              );
103              print json_encode($out);
104          }
105
106         $this->endDocument($this->format);
107     }
108
109     /**
110      * Return true if read only.
111      *
112      * MAY override
113      *
114      * @param array $args other arguments
115      *
116      * @return boolean is read only action?
117      */
118     function isReadOnly($args)
119     {
120         return true;
121     }
122 }