apiServiceResource.php
6.77 KB
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
<?php
/*
* Copyright 2010 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Implements the actual methods/resources of the discovered Google API using magic function
* calling overloading (__call()), which on call will see if the method name (buzz.activities.list)
* is available in this service, and if so construct an apiServiceRequest representing it.
*
* @author Chris Chabot <chabotc@google.com>
*
*/
class apiServiceResource {
// Valid query parameters that work, but don't appear in discovery.
private $stackParameters = array(
'trace' => array('type' => 'string', 'location' => 'query'),
'userIp' => array('type' => 'string', 'location' => 'query'),
'userip' => array('type' => 'string', 'location' => 'query')
);
private $service;
private $serviceName;
private $resourceName;
private $methods;
public function __construct($service, $serviceName, $resourceName, $resource) {
$this->service = $service;
$this->serviceName = $serviceName;
$this->resourceName = $resourceName;
$this->methods = $resource['methods'];
}
public function __call($name, $arguments) {
if (count($arguments) != 1 && count($arguments) != 2) {
//throw new apiException("apiClient method calls expect one or two parameter (for example: \$apiClient->buzz->activities->list( array('userId' => '@me')) or when executing a batch request: \$apiClient->buzz->activities->list( array('userId' => '@me'), 'batchKey')");
}
echo "TEST-1<br/>";
if (! is_array($arguments[0])) {
//throw new apiException("apiClient method parameter should be an array (for example: \$apiClient->buzz->activities->list( array('userId' => '@me'))");
}
$batchKey = false;
if (isset($arguments[1])) {
if (! is_string($arguments[1])) {
//throw new apiException("The batch key parameter should be a string, for example: \$apiClient->buzz->activities->list( array('userId' => '@me'), 'batchKey')");
}
$batchKey = $arguments[1];
}
echo "TEST-2<br/>";
if (! isset($this->methods[$name])) {
//throw new apiException("Unknown function: {$this->serviceName}->{$this->resourceName}->{$name}()");
}
$method = $this->methods[$name];
$parameters = $arguments[0];
// postBody is a special case since it's not defined in the discovery document as parameter, but we abuse the param entry for storing it
$postBody = null;
echo "TEST-3<br/>";
//print_r($parameters);
if (isset($parameters['postBody'])) {
if (is_object($parameters['postBody'])) {
$this->stripNull($parameters['postBody']);
}
echo "TEST-4<br/>";
// Some APIs require the postBody to be set under the data key.
if (is_array($parameters['postBody']) && 'buzz' == $this->serviceName) {
if (!isset($parameters['postBody']['data'])) {
$rawBody = $parameters['postBody'];
unset($parameters['postBody']);
$parameters['postBody']['data'] = $rawBody;
}
}
echo "TEST-5<br/>";
$postBody = is_array($parameters['postBody']) || is_object($parameters['postBody']) ? json_encode($parameters['postBody']) : $parameters['postBody'];
// remove from the parameter list so not to trip up the param entry checking & make sure it doesn't end up on the query
unset($parameters['postBody']);
if (isset($parameters['optParams'])) {
$optParams = $parameters['optParams'];
unset($parameters['optParams']);
$parameters = array_merge($parameters, $optParams);
}
}
echo "TEST-6<br/>";
if (!isset($method['parameters'])) {
$method['parameters'] = array();
}
echo "TEST-7<br/>";
$method['parameters'] = array_merge($method['parameters'], $this->stackParameters);
foreach ($parameters as $key => $val) {
if ($key != 'postBody' && ! isset($method['parameters'][$key])) {
//throw new apiException("($name) unknown parameter: '$key'");
}
}
echo "TEST-8<br/>";
if (isset($method['parameters'])) {
foreach ($method['parameters'] as $paramName => $paramSpec) {
if (isset($paramSpec['required']) && $paramSpec['required'] && ! isset($parameters[$paramName])) {
// throw new apiException("($name) missing required param: '$paramName'");
}
if (isset($parameters[$paramName])) {
$value = $parameters[$paramName];
// check to see if the param value matches the required pattern
if (isset($parameters[$paramName]['pattern']) && ! empty($parameters[$paramName]['pattern'])) {
if (preg_match('|' . $parameters[$paramName]['pattern'] . '|', $value) == 0) {
//throw new apiException("($name) invalid parameter format for $paramName: $value doesn't match \"{$parameters[$paramName]['pattern']}\"");
}
}
$parameters[$paramName] = $paramSpec;
$parameters[$paramName]['value'] = $value;
// remove all the bits that were already validated in this function & are no longer relevant within the execution chain
unset($parameters[$paramName]['pattern']);
unset($parameters[$paramName]['required']);
} else {
unset($parameters[$paramName]);
}
}
}
echo "TEST-9<br/>";
// Discovery v1.0 puts the canonical method id under the 'id' field.
if (! isset($method['id'])) {
$method['id'] = $method['rpcMethod'];
}
// Discovery v1.0 puts the canonical path under the 'path' field.
if (! isset($method['path'])) {
$method['path'] = $method['restPath'];
}
echo "TEST-10<br/>";
$request = new apiServiceRequest($this->service->getIo(), $this->service->getRestBasePath(), $this->service->getRpcPath(), $method['path'], $method['id'], $method['httpMethod'], $parameters, $postBody);
if ($batchKey) {
echo "TEST-11";
$request->setBatchKey($batchKey);
return $request;
} else {
echo "TEST-12";
return apiREST::execute($request);
}
}
protected function useObjects() {
global $apiConfig;
return (isset($apiConfig['use_objects']) && $apiConfig['use_objects']);
}
private function stripNull(&$o) {
$o = (array) $o;
foreach ($o as $k => $v) {
if ($v === null) {
unset($o[$k]);
}
elseif ('object' == gettype($v) || 'array' == gettype($v)) {
$this->stripNull($o[$k]);
}
}
}
}