1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
*
* @category Piwik
* @package Piwik
*/
/**
* An API request is the object used to make a call to the API and get the result.
* The request has the format of a normal GET request, ie. parameter_1=X¶meter_2=Y
*
* You can use this object from anywhere in piwik (inside plugins for example).
* You can even call it outside of piwik using the REST API over http
* or in a php script on the same server as piwik, by including piwik/index.php
* (see examples in the documentation http://dev.piwik.org/trac/wiki/API)
*
* Example:
* $request = new Piwik_API_Request('
* method=UserSettings.getWideScreen
* &idSite=1
* &date=yesterday
* &period=week
* &format=xml
* &filter_limit=5
* &filter_offset=0
* ');
* $result = $request->process();
* echo $result;
*
* @see http://dev.piwik.org/trac/wiki/API
* @package Piwik
* @subpackage Piwik_API
*/
class Piwik_API_Request
{
protected $request = null;
/**
* Constructs the request to the API, given the request url
*
* @param string GET request that defines the API call (must at least contain a "method" parameter)
* Example: method=UserSettings.getWideScreen&idSite=1&date=yesterday&period=week&format=xml
* If a request is not provided, then we use the $_GET and $_POST superglobal and fetch
* the values directly from the HTTP GET query.
*/
function __construct($request = null)
{
$defaultRequest = $_GET + $_POST;
$requestArray = $defaultRequest;
if(!is_null($request))
{
$request = trim($request);
$request = str_replace(array("\n","\t"),'', $request);
parse_str($request, $requestArray);
$requestArray = $requestArray + $defaultRequest;
}
foreach($requestArray as &$element)
{
if(!is_array($element))
{
$element = trim($element);
}
}
$this->request = $requestArray;
}
/**
* Handles the request to the API.
* It first checks that the method called (parameter 'method') is available in the module (it means that the method exists and is public)
* It then reads the parameters from the request string and throws an exception if there are missing parameters.
* It then calls the API Proxy which will call the requested method.
*
* @return mixed The data resulting from the API call
*/
public function process()
{
// read the format requested for the output data
$outputFormat = strtolower(Piwik_Common::getRequestVar('format', 'xml', 'string', $this->request));
// create the response
$response = new Piwik_API_ResponseBuilder($this->request, $outputFormat);
try {
// read parameters
$moduleMethod = Piwik_Common::getRequestVar('method', null, null, $this->request);
list($module, $method) = $this->extractModuleAndMethod($moduleMethod);
if(!Piwik_PluginsManager::getInstance()->isPluginActivated($module))
{
throw new Piwik_FrontController_PluginDeactivatedException($module);
}
$module = "Piwik_" . $module . "_API";
// if a token_auth is specified in the API request, we load the right permissions
$token_auth = Piwik_Common::getRequestVar('token_auth', '', 'string', $this->request);
if($token_auth)
{
Piwik_PostEvent('API.Request.authenticate', $token_auth);
Zend_Registry::get('access')->reloadAccess();
}
// call the method
$returnedValue = Piwik_API_Proxy::getInstance()->call($module, $method, $this->request);
$toReturn = $response->getResponse($returnedValue);
} catch(Exception $e ) {
$toReturn = $response->getResponseException( $e );
}
return $toReturn;
}
/**
* Returns array( $class, $method) from the given string $class.$method
*
* @return array
* @throws exception if the name is invalid
*/
private function extractModuleAndMethod($parameter)
{
$a = explode('.',$parameter);
if(count($a) != 2)
{
throw new Exception("The method name is invalid. Expected 'module.methodName'");
}
return $a;
}
}
|
