actions/api.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, Controlez-Vous, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.     If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('LACONICA')) { exit(1); }
  21
  22 class ApiAction extends Action
  23 {
  24
  25     var $user;
  26     var $content_type;
  27     var $api_arg;
  28     var $api_method;
  29     var $api_action;
  30
  31     function handle($args)
  32     {
  33         parent::handle($args);
  34
  35         $this->api_action = $this->arg('apiaction');
  36         $method = $this->arg('method');
  37         $argument = $this->arg('argument');
  38
  39         if (isset($argument)) {
  40             $cmdext = explode('.', $argument);
  41             $this->api_arg =  $cmdext[0];
  42             $this->api_method = $method;
  43             $this->content_type = strtolower($cmdext[1]);
  44         } else {
  45
  46             # Requested format / content-type will be an extension on the method
  47             $cmdext = explode('.', $method);
  48             $this->api_method = $cmdext[0];
  49             $this->content_type = strtolower($cmdext[1]);
  50         }
  51
  52         if ($this->requires_auth()) {
  53             if (!isset($_SERVER['PHP_AUTH_USER'])) {
  54
  55                 # This header makes basic auth go
  56                 header('WWW-Authenticate: Basic realm="Laconica API"');
  57
  58                 # If the user hits cancel -- bam!
  59                 $this->show_basic_auth_error();
  60             } else {
  61                 $nickname = $_SERVER['PHP_AUTH_USER'];
  62                 $password = $_SERVER['PHP_AUTH_PW'];
  63                 $user = common_check_user($nickname, $password);
  64
  65                 if ($user) {
  66                     $this->user = $user;
  67                     $this->process_command();
  68                 } else {
  69                     # basic authentication failed
  70                     $this->show_basic_auth_error();
  71                 }
  72             }
  73         } else {
  74
  75             # Look for the user in the session
  76             if (common_logged_in()) {
  77                  $this->user = common_current_user();
  78             }
  79
  80             $this->process_command();
  81         }
  82     }
  83
  84     function process_command()
  85     {
  86         $action = "twitapi$this->api_action";
  87         $actionfile = INSTALLDIR."/actions/$action.php";
  88
  89         if (file_exists($actionfile)) {
  90             require_once($actionfile);
  91             $action_class = ucfirst($action)."Action";
  92             $action_obj = new $action_class();
  93
  94             if (!$action_obj->prepare($this->args)) {
  95                 return;
  96             }
  97
  98             if (method_exists($action_obj, $this->api_method)) {
  99                 $apidata = array(    'content-type' => $this->content_type,
 100                                     'api_method' => $this->api_method,
 101                                     'api_arg' => $this->api_arg,
 102                                     'user' => $this->user);
 103
 104                 call_user_func(array($action_obj, $this->api_method), $_REQUEST, $apidata);
 105             } else {
 106                 $this->clientError("API method not found!", $code=404);
 107             }
 108         } else {
 109             $this->clientError("API method not found!", $code=404);
 110         }
 111     }
 112
 113     # Whitelist of API methods that don't need authentication
 114     function requires_auth()
 115     {
 116         static $noauth = array( 'statuses/public_timeline',
 117                                 'statuses/show',
 118                                 'users/show',
 119                                 'help/test',
 120                                 'help/downtime_schedule',
 121                                 'laconica/version',
 122                                 'laconica/config',
 123                                 'laconica/wadl');
 124
 125         static $bareauth = array('statuses/user_timeline',
 126                                  'statuses/friends',
 127                                  'statuses/followers',
 128                                  'favorites/favorites');
 129
 130         # If the site is "private", all API methods need authentication
 131
 132         if (common_config('site', 'private')) {
 133             return true;
 134         }
 135
 136         $fullname = "$this->api_action/$this->api_method";
 137
 138         if (in_array($fullname, $bareauth)) {
 139             # bareauth: only needs auth if without an argument
 140             if ($this->api_arg) {
 141                 return false;
 142             } else {
 143                 return true;
 144             }
 145         } else if (in_array($fullname, $noauth)) {
 146             # noauth: never needs auth
 147             return false;
 148         } else {
 149             # everybody else needs auth
 150             return true;
 151         }
 152     }
 153
 154     function show_basic_auth_error()
 155     {
 156         header('HTTP/1.1 401 Unauthorized');
 157         $msg = 'Could not authenticate you.';
 158
 159         if ($this->content_type == 'xml') {
 160             header('Content-Type: application/xml; charset=utf-8');
 161             common_start_xml();
 162             $this->elementStart('hash');
 163             $this->element('error', null, $msg);
 164             $this->element('request', null, $_SERVER['REQUEST_URI']);
 165             $this->elementEnd('hash');
 166             common_end_xml();
 167         } else if ($this->content_type == 'json')  {
 168             header('Content-Type: application/json; charset=utf-8');
 169             $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
 170             print(json_encode($error_array));
 171         } else {
 172             header('Content-type: text/plain');
 173             print "$msg\n";
 174         }
 175     }
 176
 177     function isReadOnly()
 178     {
 179         # NOTE: before handle(), can't use $this->arg
 180         $apiaction = $_REQUEST['apiaction'];
 181         $method = $_REQUEST['method'];
 182         list($cmdtext, $fmt) = explode('.', $method);
 183
 184         static $write_methods = array(
 185             'account' => array('update_location', 'update_delivery_device', 'end_session'),
 186             'blocks' => array('create', 'destroy'),
 187             'direct_messages' => array('create', 'destroy'),
 188             'favorites' => array('create', 'destroy'),
 189             'friendships' => array('create', 'destroy'),
 190             'help' => array(),
 191             'notifications' => array('follow', 'leave'),
 192             'statuses' => array('update', 'destroy'),
 193             'users' => array()
 194         );
 195
 196         if (array_key_exists($apiaction, $write_methods)) {
 197             if (!in_array($cmdtext, $write_methods[$apiaction])) {
 198                 return true;
 199             }
 200         }
 201
 202         return false;
 203     }
 204
 205 }