122 lines
3.7 KiB
PHP
122 lines
3.7 KiB
PHP
<?php
|
|
/**
|
|
* StatusNet, the distributed open-source microblogging tool
|
|
*
|
|
* Dummy action that emulates Twitter's rate limit status API resource
|
|
*
|
|
* PHP version 5
|
|
*
|
|
* LICENCE: This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* @category API
|
|
* @package StatusNet
|
|
* @author Brion Vibber <brion@pobox.com>
|
|
* @author Evan Prodromou <evan@status.net>
|
|
* @author Robin Millette <robin@millette.info>
|
|
* @author Siebrand Mazeland <s.mazeland@xs4all.nl>
|
|
* @author Zach Copley <zach@status.net>
|
|
* @copyright 2009 StatusNet, Inc.
|
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
|
* @link http://status.net/
|
|
*/
|
|
|
|
if (!defined('GNUSOCIAL')) {
|
|
exit(1);
|
|
}
|
|
|
|
/**
|
|
* We don't have a rate limit, but some clients check this method.
|
|
* It always returns the same thing: 150 hits left.
|
|
*
|
|
* @category API
|
|
* @package StatusNet
|
|
* @author Evan Prodromou <evan@status.net>
|
|
* @author Robin Millette <robin@millette.info>
|
|
* @author Zach Copley <zach@status.net>
|
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
|
* @link http://status.net/
|
|
*/
|
|
class ApiAccountRateLimitStatusAction extends ApiBareAuthAction
|
|
{
|
|
/**
|
|
* Return true if read only.
|
|
*
|
|
* MAY override
|
|
*
|
|
* @param array $args other arguments
|
|
*
|
|
* @return boolean is read only action?
|
|
*/
|
|
public function isReadOnly($args)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Handle the request
|
|
*
|
|
* Return some Twitter-ish data about API limits
|
|
*
|
|
* @return void
|
|
* @throws ClientException
|
|
*/
|
|
protected function handle()
|
|
{
|
|
parent::handle();
|
|
|
|
if (!in_array($this->format, ['xml', 'json'])) {
|
|
$this->clientError(
|
|
// TRANS: Client error displayed when coming across a non-supported API method.
|
|
_('API method not found.'),
|
|
404,
|
|
$this->format
|
|
);
|
|
}
|
|
|
|
$reset = new DateTime();
|
|
$reset->modify('+1 hour');
|
|
|
|
$this->initDocument($this->format);
|
|
|
|
if ($this->format == 'xml') {
|
|
$this->elementStart('hash');
|
|
$this->element('remaining-hits', ['type' => 'integer'], "150");
|
|
$this->element('hourly-limit', ['type' => 'integer'], "150");
|
|
$this->element(
|
|
'reset-time',
|
|
['type' => 'datetime'],
|
|
common_date_iso8601($reset->format('r'))
|
|
);
|
|
$this->element(
|
|
'reset_time_in_seconds',
|
|
['type' => 'integer'],
|
|
strtotime('+1 hour')
|
|
);
|
|
$this->elementEnd('hash');
|
|
} elseif ($this->format == 'json') {
|
|
$out = [
|
|
'reset_time_in_seconds' => strtotime('+1 hour'),
|
|
'remaining_hits' => 150,
|
|
'hourly_limit' => 150,
|
|
'reset_time' => common_date_rfc2822(
|
|
$reset->format('r')
|
|
)
|
|
];
|
|
print json_encode($out);
|
|
}
|
|
|
|
$this->endDocument($this->format);
|
|
}
|
|
}
|