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

17 files changed, 25 insertions, 371 deletions

diff --git a/actions/api.php b/actions/api.php
deleted file mode 100644
index 1bc90de11..000000000
--- a/actions/api.php
+++ /dev/null
@@ -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;
-    }
-}
diff --git a/actions/apifriendshipsexists.php b/actions/apifriendshipsexists.php
index 3d6e7448d..d1d5d520f 100644
--- a/actions/apifriendshipsexists.php
+++ b/actions/apifriendshipsexists.php
@@ -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 
diff --git a/actions/apigrouplistall.php b/actions/apigrouplistall.php
index b1964d800..80dcad9dc 100644
--- a/actions/apigrouplistall.php
+++ b/actions/apigrouplistall.php
@@ -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
diff --git a/actions/apigroupmembership.php b/actions/apigroupmembership.php
index 0cd3ed290..872ee45ee 100644
--- a/actions/apigroupmembership.php
+++ b/actions/apigroupmembership.php
@@ -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. 
diff --git a/actions/apigroupshow.php b/actions/apigroupshow.php
index 733c9ccfe..a38d50afe 100644
--- a/actions/apigroupshow.php
+++ b/actions/apigroupshow.php
@@ -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
diff --git a/actions/apihelptest.php b/actions/apihelptest.php
index 5f32165cf..2cec46462 100644
--- a/actions/apihelptest.php
+++ b/actions/apihelptest.php
@@ -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.
diff --git a/actions/apistatusesshow.php b/actions/apistatusesshow.php
index 55eea2356..9e28fe2ab 100644
--- a/actions/apistatusesshow.php
+++ b/actions/apistatusesshow.php
@@ -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;
diff --git a/actions/apistatusnetconfig.php b/actions/apistatusnetconfig.php
index 94bd5b4b3..6847a48fe 100644
--- a/actions/apistatusnetconfig.php
+++ b/actions/apistatusnetconfig.php
@@ -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
diff --git a/actions/apistatusnetversion.php b/actions/apistatusnetversion.php
index 471297ad5..e6f35e7d2 100644
--- a/actions/apistatusnetversion.php
+++ b/actions/apistatusnetversion.php
@@ -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
diff --git a/actions/apitimelinegroup.php b/actions/apitimelinegroup.php
index 11f73eeed..9d6ac6ad1 100644
--- a/actions/apitimelinegroup.php
+++ b/actions/apitimelinegroup.php
@@ -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;
diff --git a/actions/apitimelinepublic.php b/actions/apitimelinepublic.php
index 10bde6f37..2638dd292 100644
--- a/actions/apitimelinepublic.php
+++ b/actions/apitimelinepublic.php
@@ -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;
diff --git a/actions/apitimelinetag.php b/actions/apitimelinetag.php
index 2a23bb72a..0efe8d244 100644
--- a/actions/apitimelinetag.php
+++ b/actions/apitimelinetag.php
@@ -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;
diff --git a/actions/apiusershow.php b/actions/apiusershow.php
index 2e2ceab41..afcbd3618 100644
--- a/actions/apiusershow.php
+++ b/actions/apiusershow.php
@@ -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.
diff --git a/actions/twitapinotifications.php b/actions/twitapinotifications.php
deleted file mode 100644
index 0653e69ab..000000000
--- a/actions/twitapinotifications.php
+++ /dev/null
@@ -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);
-    }
-
-}
\ No newline at end of file
diff --git a/actions/twitapisearchatom.php b/actions/twitapisearchatom.php
index 2f587d604..0ef9d2826 100644
--- a/actions/twitapisearchatom.php
+++ b/actions/twitapisearchatom.php
@@ -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;
diff --git a/actions/twitapisearchjson.php b/actions/twitapisearchjson.php
index c628ee624..5abff6496 100644
--- a/actions/twitapisearchjson.php
+++ b/actions/twitapisearchjson.php
@@ -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;
diff --git a/actions/twitapitrends.php b/actions/twitapitrends.php
index 83ab28f35..779405e6d 100644
--- a/actions/twitapitrends.php
+++ b/actions/twitapitrends.php
@@ -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;