]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/apioauthaction.php
Same goes to onStartShowAside() which has 'Action' as type-hint.
[quix0rs-gnu-social.git] / lib / apioauthaction.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
35 /**
36  * Base action for API OAuth enpoints. Clean up the
37  * request. Some other common functions.
38  *
39  * @category API
40  * @package  StatusNet
41  * @author   Zach Copley <zach@status.net>
42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
43  * @link     http://status.net/
44  */
45 class ApiOAuthAction extends ApiAction
46 {
47     /**
48      * Is this a read-only action?
49      *
50      * @return boolean false
51      */
52     function isReadOnly(array $args=array())
53     {
54         return false;
55     }
56
57     function prepare(array $args=array())
58     {
59         parent::prepare($args);
60         return true;
61     }
62
63     /**
64      * Handle input, produce output
65      *
66      * Switches on request method; either shows the form or handles its input.
67      *
68      * @param array $args $_REQUEST data
69      *
70      * @return void
71      */
72     function handle(array $args=array())
73     {
74         parent::handle($args);
75         self::cleanRequest();
76     }
77
78     /*
79      * Clean up the request so the OAuth library doesn't find
80      * any extra parameters or anything else it's not expecting.
81      * I'm looking at you, p parameter.
82      */
83
84     static function cleanRequest()
85     {
86         // kill evil effects of magical slashing
87         if (get_magic_quotes_gpc() == 1) {
88             $_POST = array_map('stripslashes', $_POST);
89             $_GET = array_map('stripslashes', $_GET);
90         }
91
92         // strip out the p param added in index.php
93         unset($_GET['p']);
94         unset($_POST['p']);
95         unset($_REQUEST['p']);
96
97         $queryArray = explode('&', $_SERVER['QUERY_STRING']);
98
99         for ($i = 0; $i < sizeof($queryArray); $i++) {
100             if (substr($queryArray[$i], 0, 2) == 'p=') {
101                 unset($queryArray[$i]);
102             }
103         }
104
105         $_SERVER['QUERY_STRING'] = implode('&', $queryArray);
106     }
107
108 }