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('GNUSOCIAL')) { exit(1); }
  35
  36 /**
  37  * We don't have a rate limit, but some clients check this method.
  38  * It always returns the same thing: 150 hits left.
  39  *
  40  * @category API
  41  * @package  StatusNet
  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/
  47  */
  48 class ApiAccountRateLimitStatusAction extends ApiBareAuthAction
  49 {
  50     /**
  51      * Handle the request
  52      *
  53      * Return some Twitter-ish data about API limits
  54      *
  55      * @param array $args $_REQUEST data (unused)
  56      *
  57      * @return void
  58      */
  59     protected function handle()
  60     {
  61         parent::handle();
  62
  63         if (!in_array($this->format, array('xml', 'json'))) {
  64             $this->clientError(
  65                 // TRANS: Client error displayed when coming across a non-supported API method.
  66                 _('API method not found.'),
  67                 404,
  68                 $this->format
  69             );
  70         }
  71
  72         $reset   = new DateTime();
  73         $reset->modify('+1 hour');
  74
  75         $this->initDocument($this->format);
  76
  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);
  81              $this->element(
  82                  'reset-time', array('type' => 'datetime'),
  83                  common_date_iso8601($reset->format('r'))
  84              );
  85              $this->element(
  86                  'reset_time_in_seconds',
  87                  array('type' => 'integer'),
  88                  strtotime('+1 hour')
  89              );
  90              $this->elementEnd('hash');
  91          } elseif ($this->format == 'json') {
  92              $out = array(
  93                  'reset_time_in_seconds' => strtotime('+1 hour'),
  94                  'remaining_hits' => 150,
  95                  'hourly_limit' => 150,
  96                  'reset_time' => common_date_rfc2822(
  97                      $reset->format('r')
  98                   )
  99              );
 100              print json_encode($out);
 101          }
 102
 103         $this->endDocument($this->format);
 104     }
 105
 106     /**
 107      * Return true if read only.
 108      *
 109      * MAY override
 110      *
 111      * @param array $args other arguments
 112      *
 113      * @return boolean is read only action?
 114      */
 115     function isReadOnly(array $args=array())
 116     {
 117         return true;
 118     }
 119 }