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

Delete action/api.php and rename lib/twitterapi.php to lib/api.php

Browse Source
This commit is contained in:
Zach Copley 2009-10-09 14:22:18 -07:00
parent 09f4d1ef23
commit bb08611def
20 changed files with 54 additions and 380 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

306
actions/api.php
View File

@ -1,306 +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/>.
*
* @category Actions
* @package Actions
* @author Evan Prodromou <evan@status.net>
* @author Brenda Wallace <shiny@cpan.org>
* @author Jeffery To <jeffery.to@gmail.com>
* @author Robin Millette <millette@controlyourself.ca>
* @author Tom Adams <tom@holizz.com>
* @author Christopher Vollick <psycotica0@gmail.com>
* @author CiaranG <ciaran@ciarang.com>
* @author Craig Andrews <candrews@integralblue.com>
* @author Gina Haeussge <osd@foosel.net>
* @author Mike Cochrane <mikec@mikenz.geek.nz>
* @author Sarven Capadisli <csarven@status.net>
* @license GNU Affero General Public License http://www.gnu.org/licenses/
* @link http://status.net
*/
if (!defined('STATUSNET') && !defined('LACONICA')) {
exit(1);
}
class ApiAction extends Action
{
var $user;
var $content_type;
var $api_arg;
var $api_method;
var $api_action;
var $auth_user;
var $auth_pw;
function handle($args)
{
parent::handle($args);
$this->api_action = $this->arg('apiaction');
$method = $this->arg('method');
$argument = $this->arg('argument');
$this->basic_auth_process_header();
if (isset($argument)) {
$cmdext = explode('.', $argument);
$this->api_arg = $cmdext[0];
$this->api_method = $method;
$this->content_type = strtolower($cmdext[1]);
} else {
//Requested format / content-type will be an extension on the method
$cmdext = explode('.', $method);
$this->api_method = $cmdext[0];
$this->content_type = strtolower($cmdext[1]);
}
if ($this->requires_auth()) {
if (!isset($this->auth_user)) {
//This header makes basic auth go
header('WWW-Authenticate: Basic realm="StatusNet API"');
//If the user hits cancel -- bam!
$this->show_basic_auth_error();
} else {
$nickname = $this->auth_user;
$password = $this->auth_pw;
$user = common_check_user($nickname, $password);
if ($user) {
$this->user = $user;
$this->process_command();
} else {
//basic authentication failed
list($proxy, $ip) = common_client_ip();
common_log(LOG_WARNING, "Failed API auth attempt, nickname = $nickname, proxy = $proxy, ip = $ip.");
$this->show_basic_auth_error();
}
}
} else {
// Caller might give us a username even if not required
if (isset($this->auth_user)) {
$user = User::staticGet('nickname', $this->auth_user);
if ($user) {
$this->user = $user;
}
//Twitter doesn't throw an error if the user isn't found
}
$this->process_command();
}
}
function process_command()
{
$action = "twitapi$this->api_action";
$actionfile = INSTALLDIR."/actions/$action.php";
if (file_exists($actionfile)) {
include_once $actionfile;
$action_class = ucfirst($action)."Action";
$action_obj = new $action_class();
if (!$action_obj->prepare($this->args)) {
return;
}
if (method_exists($action_obj, $this->api_method)) {
$apidata = array( 'content-type' => $this->content_type,
'api_method' => $this->api_method,
'api_arg' => $this->api_arg,
'user' => $this->user);
call_user_func(array($action_obj, $this->api_method), $_REQUEST, $apidata);
} else {
$this->clientError("API method not found!", $code = 404);
}
} else {
$this->clientError("API method not found!", $code = 404);
}
}
// Whitelist of API methods that don't need authentication
function requires_auth()
{
static $noauth = array( 'statuses/public_timeline',
'statuses/show',
'users/show',
'help/test',
'help/downtime_schedule',
'statusnet/version',
'statusnet/config',
'statusnet/wadl',
'tags/timeline',
'oembed/oembed',
'groups/show',
'groups/timeline',
'groups/list_all',
'groups/membership',
'groups/is_member',
'groups/timeline');
static $bareauth = array('statuses/user_timeline',
'statuses/friends_timeline',
'statuses/home_timeline',
'statuses/friends',
'statuses/replies',
'statuses/mentions',
'statuses/followers',
'favorites/favorites',
'friendships/show',
'groups/list_groups');
$fullname = "$this->api_action/$this->api_method";
// If the site is "private", all API methods except statusnet/config
// need authentication
if (common_config('site', 'private')) {
return $fullname != 'statusnet/config' || false;
}
// bareauth: only needs auth if without an argument or query param specifying user
if (in_array($fullname, $bareauth)) {
// Special case: friendships/show only needs auth if source_id or
// source_screen_name is not specified as a param
if ($fullname == 'friendships/show') {
$source_id = $this->arg('source_id');
$source_screen_name = $this->arg('source_screen_name');
if (empty($source_id) && empty($source_screen_name)) {
return true;
}
return false;
}
// if all of these are empty, auth is required
$id = $this->arg('id');
$user_id = $this->arg('user_id');
$screen_name = $this->arg('screen_name');
if (empty($this->api_arg)
&& empty($id)
&& empty($user_id)
&& empty($screen_name)
) {
return true;
} else {
return false;
}
} else if (in_array($fullname, $noauth)) {
// noauth: never needs auth
return false;
} else {
// everybody else needs auth
return true;
}
}
function basic_auth_process_header()
{
if (isset($_SERVER['AUTHORIZATION']) || isset($_SERVER['HTTP_AUTHORIZATION'])) {
$authorization_header = isset($_SERVER['HTTP_AUTHORIZATION'])? $_SERVER['HTTP_AUTHORIZATION'] : $_SERVER['AUTHORIZATION'];
}
if (isset($_SERVER['PHP_AUTH_USER'])) {
$this->auth_user = $_SERVER['PHP_AUTH_USER'];
$this->auth_pw = $_SERVER['PHP_AUTH_PW'];
} elseif (isset($authorization_header) && strstr(substr($authorization_header, 0, 5), 'Basic')) {
// decode the HTTP_AUTHORIZATION header on php-cgi server self
// on fcgid server the header name is AUTHORIZATION
$auth_hash = base64_decode(substr($authorization_header, 6));
list($this->auth_user, $this->auth_pw) = explode(':', $auth_hash);
// set all to null on a empty basic auth request
if ($this->auth_user == "") {
$this->auth_user = null;
$this->auth_pw = null;
}
} else {
$this->auth_user = null;
$this->auth_pw = null;
}
}
function show_basic_auth_error()
{
header('HTTP/1.1 401 Unauthorized');
$msg = 'Could not authenticate you.';
if ($this->content_type == 'xml') {
header('Content-Type: application/xml; charset=utf-8');
$this->startXML();
$this->elementStart('hash');
$this->element('error', null, $msg);
$this->element('request', null, $_SERVER['REQUEST_URI']);
$this->elementEnd('hash');
$this->endXML();
} else if ($this->content_type == 'json') {
header('Content-Type: application/json; charset=utf-8');
$error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
print(json_encode($error_array));
} else {
header('Content-type: text/plain');
print "$msg\n";
}
}
function isReadOnly($args)
{
$apiaction = $args['apiaction'];
$method = $args['method'];
list($cmdtext, $fmt) = explode('.', $method);
static $write_methods = array(
'account' => array('update_location', 'update_delivery_device', 'end_session'),
'blocks' => array('create', 'destroy'),
'direct_messages' => array('create', 'destroy'),
'favorites' => array('create', 'destroy'),
'friendships' => array('create', 'destroy'),
'help' => array(),
'notifications' => array('follow', 'leave'),
'statuses' => array('update', 'destroy'),
'users' => array()
);
if (array_key_exists($apiaction, $write_methods)) {
if (!in_array($cmdtext, $write_methods[$apiaction])) {
return true;
}
}
return false;
}
}

2
actions/apifriendshipsexists.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR.'/lib/twitterapi.php';
require_once INSTALLDIR.'/lib/api.php';
/**
* Tests for the existence of friendship between two users. Will return true if

2
actions/apigrouplistall.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR . '/lib/twitterapi.php';
require_once INSTALLDIR . '/lib/api.php';
/**
* Returns of the lastest 20 groups for the site

2
actions/apigroupmembership.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR . '/lib/twitterapi.php';
require_once INSTALLDIR . '/lib/api.php';
/**
* List 20 newest members of the group specified by name or ID.

2
actions/apigroupshow.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR.'/lib/twitterapi.php';
require_once INSTALLDIR.'/lib/api.php';
/**
* Outputs detailed information about the group specified by ID

2
actions/apihelptest.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR . '/lib/twitterapi.php';
require_once INSTALLDIR . '/lib/api.php';
/**
* Returns the string "ok" in the requested format with a 200 OK HTTP status code.

4
actions/apistatusesshow.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR.'/lib/twitterapi.php';
require_once INSTALLDIR.'/lib/api.php';
/**
* Returns the notice specified by id as a Twitter-style status and inline user
@ -43,7 +43,7 @@ require_once INSTALLDIR.'/lib/twitterapi.php';
* @link http://status.net/
*/
class ApiStatusesShowAction extends TwitterapiAction
class ApiStatusesShowAction extends ApiAction
{
var $notice_id = null;

2
actions/apistatusnetconfig.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR . '/lib/twitterapi.php';
require_once INSTALLDIR . '/lib/api.php';
/**
* Gives a full dump of configuration variables for this instance

2
actions/apistatusnetversion.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR . '/lib/twitterapi.php';
require_once INSTALLDIR . '/lib/api.php';
/**
* Returns a version number for this version of StatusNet, which

4
actions/apitimelinegroup.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR . '/lib/twitterapi.php';
require_once INSTALLDIR . '/lib/api.php';
/**
* Returns the most recent notices (default 20) posted to the group specified by ID
@ -43,7 +43,7 @@ require_once INSTALLDIR . '/lib/twitterapi.php';
* @link http://status.net/
*/
class ApiTimelineGroupAction extends TwitterapiAction
class ApiTimelineGroupAction extends ApiAction
{
var $group = null;

4
actions/apitimelinepublic.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR.'/lib/twitterapi.php';
require_once INSTALLDIR.'/lib/api.php';
/**
* Returns the most recent notices (default 20) posted by everybody
@ -43,7 +43,7 @@ require_once INSTALLDIR.'/lib/twitterapi.php';
* @link http://status.net/
*/
class ApiTimelinePublicAction extends TwitterapiAction
class ApiTimelinePublicAction extends ApiAction
{
var $notices = null;

4
actions/apitimelinetag.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR.'/lib/twitterapi.php';
require_once INSTALLDIR.'/lib/api.php';
/**
* Returns the 20 most recent notices tagged by a given tag
@ -43,7 +43,7 @@ require_once INSTALLDIR.'/lib/twitterapi.php';
* @link http://status.net/
*/
class ApiTimelineTagAction extends TwitterapiAction
class ApiTimelineTagAction extends ApiAction
{
var $notices = null;

2
actions/apiusershow.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR.'/lib/twitterapi.php';
require_once INSTALLDIR.'/lib/api.php';
/**
* Ouputs information for a user, specified by ID or screen name.

40
actions/twitapinotifications.php
View File

@ -1,40 +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');
# This naming convention looks real sick
class TwitapinotificationsAction extends TwitterapiAction
{
function follow($args, $apidata)
{
parent::handle($args);
$this->serverError(_('API method under construction.'), $code=501);
}
function leave($args, $apidata)
{
parent::handle($args);
$this->serverError(_('API method under construction.'), $code=501);
}
}

6
actions/twitapisearchatom.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
exit(1);
}
require_once INSTALLDIR.'/lib/twitterapi.php';
require_once INSTALLDIR.'/lib/api.php';
/**
* Action for outputting search results in Twitter compatible Atom
@ -46,10 +46,10 @@ require_once INSTALLDIR.'/lib/twitterapi.php';
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*
* @see TwitterapiAction
* @see ApiAction
*/
class TwitapisearchatomAction extends TwitterapiAction
class TwitapisearchatomAction extends ApiAction
{
var $cnt;

6
actions/twitapisearchjson.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
exit(1);
}
require_once INSTALLDIR.'/lib/twitterapi.php';
require_once INSTALLDIR.'/lib/api.php';
require_once INSTALLDIR.'/lib/jsonsearchresultslist.php';
/**
@ -42,10 +42,10 @@ require_once INSTALLDIR.'/lib/jsonsearchresultslist.php';
* @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/
* @see TwitterapiAction
* @see ApiAction
*/
class TwitapisearchjsonAction extends TwitterapiAction
class TwitapisearchjsonAction extends ApiAction
{
var $query;
var $lang;

6
actions/twitapitrends.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
exit(1);
}
require_once INSTALLDIR.'/lib/twitterapi.php';
require_once INSTALLDIR.'/lib/api.php';
/**
* Returns the top ten queries that are currently trending
@ -42,10 +42,10 @@ require_once INSTALLDIR.'/lib/twitterapi.php';
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*
* @see TwitterapiAction
* @see ApiAction
*/
class TwitapitrendsAction extends TwitterapiAction
class TwitapitrendsAction extends ApiAction
{
var $callback;

32
lib/twitterapi.php → lib/api.php
View File

@ -1,9 +1,12 @@
<?php
/*
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2008, 2009, StatusNet, Inc.
/**
* StatusNet, the distributed open-source microblogging tool
*
* This program is free software: you can redistribute it and/or modify
* Base API action
*
* 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.
@ -15,13 +18,30 @@
*
* 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') && !defined('LACONICA')) {
if (!defined('STATUSNET')) {
exit(1);
}
class TwitterapiAction extends Action
/**
* Contains most of the Twitter-compatible API output functions.
*
* @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 ApiAction extends Action
{
/**

4
lib/apiauth.php
View File

@ -31,7 +31,7 @@ if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR.'/lib/twitterapi.php';
require_once INSTALLDIR.'/lib/api.php';
/**
* Actions extending this class will require auth
@ -43,7 +43,7 @@ require_once INSTALLDIR.'/lib/twitterapi.php';
* @link http://status.net/
*/
class ApiAuthAction extends TwitterapiAction
class ApiAuthAction extends ApiAction
{
var $auth_user = null;

2
plugins/Realtime/RealtimePlugin.php
View File

@ -242,7 +242,7 @@ class RealtimePlugin extends Plugin
// of refactoring from within a plugin, so I'm just abusing
// the TwitterApiAction method. Don't do this unless you're me!
require_once(INSTALLDIR.'/lib/twitterapi.php');
require_once(INSTALLDIR.'/lib/api.php');
$act = new TwitterApiAction('/dev/null');