lib/apioauth.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Base action for OAuth API endpoints
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  API
  23  * @package   StatusNet
  24  * @author    Zach Copley <zach@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33 require_once INSTALLDIR . '/lib/apiaction.php';
  34 require_once INSTALLDIR . '/lib/apioauthstore.php';
  35
  36 /**
  37  * Base action for API OAuth enpoints.  Clean up the
  38  * the request, and possibly some other common things
  39  * here.
  40  *
  41  * @category API
  42  * @package  StatusNet
  43  * @author   Zach Copley <zach@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  */
  47 class ApiOauthAction extends ApiAction
  48 {
  49     /**
  50      * Is this a read-only action?
  51      *
  52      * @return boolean false
  53      */
  54     function isReadOnly($args)
  55     {
  56         return false;
  57     }
  58
  59     function prepare($args)
  60     {
  61         parent::prepare($args);
  62         return true;
  63     }
  64
  65     /**
  66      * Handle input, produce output
  67      *
  68      * Switches on request method; either shows the form or handles its input.
  69      *
  70      * @param array $args $_REQUEST data
  71      *
  72      * @return void
  73      */
  74     function handle($args)
  75     {
  76         parent::handle($args);
  77         self::cleanRequest();
  78     }
  79
  80     /*
  81      * Clean up the request so the OAuth library doesn't find
  82      * any extra parameters or anything else it's not expecting.
  83      * I'm looking at you, p parameter.
  84      */
  85     static function cleanRequest()
  86     {
  87         // kill evil effects of magical slashing
  88         if (get_magic_quotes_gpc() == 1) {
  89             $_POST = array_map('stripslashes', $_POST);
  90             $_GET = array_map('stripslashes', $_GET);
  91         }
  92
  93         // strip out the p param added in index.php
  94         unset($_GET['p']);
  95         unset($_POST['p']);
  96         unset($_REQUEST['p']);
  97
  98         $queryArray = explode('&', $_SERVER['QUERY_STRING']);
  99
 100         for ($i = 0; $i < sizeof($queryArray); $i++) {
 101             if (substr($queryArray[$i], 0, 2) == 'p=') {
 102                 unset($queryArray[$i]);
 103             }
 104         }
 105
 106         $_SERVER['QUERY_STRING'] = implode('&', $queryArray);
 107     }
 108
 109     function getCallback($url, $params)
 110     {
 111         foreach ($params as $k => $v) {
 112             $url = $this->appendQueryVar($url,
 113                                          OAuthUtil::urlencode_rfc3986($k),
 114                                          OAuthUtil::urlencode_rfc3986($v));
 115         }
 116
 117         return $url;
 118     }
 119
 120     function appendQueryVar($url, $k, $v) {
 121         $url = preg_replace('/(.*)(\?|&)' . $k . '=[^&]+?(&)(.*)/i', '$1$2$4', $url . '&');
 122         $url = substr($url, 0, -1);
 123         if (strpos($url, '?') === false) {
 124             return ($url . '?' . $k . '=' . $v);
 125         } else {
 126             return ($url . '&' . $k . '=' . $v);
 127         }
 128     }
 129
 130 }