GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

New actions for the account methods we have implemented

Browse Source
This commit is contained in:
Zach Copley 2009-10-05 17:10:30 -07:00
parent dd0d907231
commit 475bdf6fba
4 changed files with 246 additions and 130 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

132
actions/apiaccountratelimitstatus.php Normal file
View File

@ -0,0 +1,132 @@
<?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 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('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR.'/lib/apibareauth.php';
/**
* We don't have a rate limit, but some clients check this method.
* It always returns the same thing: 100 hits left.
*
* @category API
* @package StatusNet
* @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
{
var $format = null;
/**
* Take arguments for running
*
* @param array $args $_REQUEST args
*
* @return boolean success flag
*
*/
function prepare($args)
{
parent::prepare($args);
if ($this->requiresAuth()) {
if ($this->checkBasicAuthUser() == false) {
return false;
}
}
$this->format = $this->arg('format');
return true;
}
/**
* Handle the request
*
* Return some Twitter-ish data about API limits
*
* @param array $args $_REQUEST data (unused)
*
* @return void
*/
function handle($args)
{
parent::handle($args);
if (!in_array($this->format, array('xml', 'json'))) {
$this->clientError(
_('API method not found!'),
404,
$this->format
);
return;
}
$reset = new DateTime();
$reset->modify('+1 hour');
$this->init_document($this->format);
if ($this->format == 'xml') {
$this->elementStart('hash');
$this->element('remaining-hits', array('type' => 'integer'), 150);
$this->element('hourly-limit', array('type' => 'integer'), 150);
$this->element(
'reset-time', array('type' => 'datetime'),
common_date_iso8601($reset->format('r'))
);
$this->element(
'reset_time_in_seconds',
array('type' => 'integer'),
strtotime('+1 hour')
);
$this->elementEnd('hash');
} elseif ($this->format == 'json') {
$out = array(
'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->end_document($this->format);
}
}

104
actions/apiaccountverifycredentials.php Normal file
View File

@ -0,0 +1,104 @@
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Test if supplied user credentials are valid.
*
* 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 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('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR.'/lib/apiauth.php';
/**
* Check a user's credentials. Returns an HTTP 200 OK response code and a
* representation of the requesting user if authentication was successful;
* returns a 401 status code and an error message if not.
*
* @category API
* @package StatusNet
* @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 ApiAccountVerifyCredentialsAction extends ApiAuthAction
{
var $format = null;
/**
* Take arguments for running
*
* @param array $args $_REQUEST args
*
* @return boolean success flag
*
*/
function prepare($args)
{
parent::prepare($args);
if ($this->requiresAuth()) {
if ($this->checkBasicAuthUser() == false) {
return false;
}
}
$this->format = $this->arg('format');
return true;
}
/**
* Handle the request
*
* Check whether the credentials are valid and output the result
*
* @param array $args $_REQUEST data (unused)
*
* @return void
*/
function handle($args)
{
parent::handle($args);
switch ($this->format) {
case 'xml':
case 'json':
$args['id'] = $this->auth_user->id;
$action_obj = new ApiUserShowAction();
$action_obj->prepare($args);
$action_obj->handle($args);
break;
default:
header('Content-Type: text/html; charset=utf-8');
print 'Authorized';
}
}
}

127
actions/twitapiaccount.php
View File

@ -1,127 +0,0 @@
<?php
/*
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2008, 2009, StatusNet, Inc.
*
* 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/>.
*/
if (!defined('STATUSNET') && !defined('LACONICA')) {
exit(1);
}
require_once(INSTALLDIR.'/lib/twitterapi.php');
class TwitapiaccountAction extends TwitterapiAction
{
function verify_credentials($args, $apidata)
{
parent::handle($args);
switch ($apidata['content-type']) {
case 'xml':
case 'json':
$action_obj = new TwitapiusersAction();
$action_obj->prepare($args);
call_user_func(array($action_obj, 'show'), $args, $apidata);
break;
default:
header('Content-Type: text/html; charset=utf-8');
print 'Authorized';
}
}
function end_session($args, $apidata)
{
parent::handle($args);
$this->serverError(_('API method under construction.'), $code=501);
}
function update_location($args, $apidata)
{
parent::handle($args);
if ($_SERVER['REQUEST_METHOD'] != 'POST') {
$this->clientError(_('This method requires a POST.'),
400, $apidata['content-type']);
return;
}
$location = trim($this->arg('location'));
if (!is_null($location) && mb_strlen($location) > 255) {
// XXX: But Twitter just truncates and runs with it. -- Zach
$this->clientError(_('That\'s too long. Max notice size is 255 chars.'),
406, $apidate['content-type']);
return;
}
$user = $apidata['user']; // Always the auth user
$profile = $user->getProfile();
$orig_profile = clone($profile);
$profile->location = $location;
$result = $profile->update($orig_profile);
if (empty($result)) {
common_log_db_error($profile, 'UPDATE', __FILE__);
$this->serverError(_('Couldn\'t save profile.'));
return;
}
common_broadcast_profile($profile);
$type = $apidata['content-type'];
$this->init_document($type);
$this->show_profile($profile, $type);
$this->end_document($type);
}
function update_delivery_device($args, $apidata)
{
parent::handle($args);
$this->serverError(_('API method under construction.'), $code=501);
}
// We don't have a rate limit, but some clients check this method.
// It always returns the same thing: 100 hit left.
function rate_limit_status($args, $apidata)
{
parent::handle($args);
$type = $apidata['content-type'];
$this->init_document($type);
if ($apidata['content-type'] == 'xml') {
$this->elementStart('hash');
$this->element('remaining-hits', array('type' => 'integer'), 100);
$this->element('hourly-limit', array('type' => 'integer'), 100);
$this->element('reset-time', array('type' => 'datetime'), null);
$this->element('reset_time_in_seconds', array('type' => 'integer'), 0);
$this->elementEnd('hash');
} elseif ($apidata['content-type'] == 'json') {
$out = array('reset_time_in_seconds' => 0,
'remaining_hits' => 100,
'hourly_limit' => 100,
'reset_time' => '');
print json_encode($out);
}
$this->end_document($type);
}
}

13
lib/router.php
View File

@ -434,9 +434,16 @@ class Router
// account
$m->connect('api/account/:method',
array('action' => 'api',
'apiaction' => 'account'));
$m->connect('api/account/verify_credentials.:format',
array('action' => 'ApiAccountVerifyCredentials'));
// special case where verify_credentials is called w/out a format
$m->connect('api/account/verify_credentials',
array('action' => 'ApiAccountVerifyCredentials'));
$m->connect('api/account/rate_limit_status.:format',
array('action' => 'ApiAccountRateLimitStatus'));
// favorites