/**
* Executes a apiServiceRequest using a RESTful call by transforming it into a apiHttpRequest, execute it via apiIO::authenticatedRequest()
* and returning the json decoded result
*
* @param apiServiceRequest $request
* @return array decoded result
* @throws apiServiceException on server side error (ie: not authenticated, invalid or mallformed post body, invalid url, etc)
*/
public static function execute(apiServiceRequest $request)
{
global $apiTypeHandlers;
$result = null;
$requestUrl = $request->getBaseUrl() . $request->getPathUrl();
$uriTemplateVars = array();
$queryVars = array();
foreach ($request->getParameters() as $paramName => $paramSpec) {
if ($paramSpec['parameterType'] == 'path') {
$uriTemplateVars[$paramName] = $paramSpec['value'];
} else {
$queryVars[] = $paramName . '=' . rawurlencode($paramSpec['value']);
}
}
$queryVars[] = 'alt=json';
if (count($uriTemplateVars)) {
$uriTemplateParser = new URI_Template_Parser($requestUrl);
$requestUrl = $uriTemplateParser->expand($uriTemplateVars);
}
//FIXME work around for the the uri template lib which url encodes the @'s & confuses our servers
$requestUrl = str_replace('%40', '@', $requestUrl);
//EOFIX
//FIXME temp work around to make @groups/{@following,@followers} work (something which we should really be fixing in our API)
if (strpos($requestUrl, '/@groups') && (strpos($requestUrl, '/@following') || strpos($requestUrl, '/@followers'))) {
$requestUrl = str_replace('/@self', '', $requestUrl);
}
//EOFIX
if (count($queryVars)) {
$requestUrl .= '?' . implode($queryVars, '&');
}
$httpRequest = new apiHttpRequest($requestUrl, $request->getHttpMethod(), null, $request->getPostBody());
// Add a content-type: application/json header so the server knows how to interpret the post body
if ($request->getPostBody()) {
$contentTypeHeader = array('Content-Type: application/json; charset=UTF-8', 'Content-Length: ' . self::getStrLen($request->getPostBody()));
if ($httpRequest->getHeaders()) {
$contentTypeHeader = array_merge($httpRequest->getHeaders(), $contentTypeHeader);
}
$httpRequest->setHeaders($contentTypeHeader);
}
$httpRequest = $request->getIo()->authenticatedRequest($httpRequest);
if ($httpRequest->getResponseHttpCode() != '200' && $httpRequest->getResponseHttpCode() != '201' && $httpRequest->getResponseHttpCode() != '204') {
$responseBody = $httpRequest->getResponseBody();
if (($responseBody = json_decode($responseBody, true)) != null && isset($responseBody['error']['message']) && isset($responseBody['error']['code'])) {
// if we're getting a json encoded error defintion, use that instead of the raw response body for improved readability
$errorMessage = "Error calling " . (isset($httpRequest->originalUrl) ? $httpRequest->originalUrl : $httpRequest->getUrl()) . ": ({$responseBody['error']['code']}) {$responseBody['error']['message']}";
} else {
$errorMessage = "Error calling " . $httpRequest->getMethod() . " " . (isset($httpRequest->originalUrl) ? $httpRequest->originalUrl : $httpRequest->getUrl()) . ": (" . $httpRequest->getResponseHttpCode() . ") " . $httpRequest->getResponseBody();
}
throw new apiServiceException($errorMessage);
}
$decodedResponse = null;
if ($httpRequest->getResponseHttpCode() != '204') {
// Only attempt to decode the response, if the response code wasn't (204) 'no content'
if (($decodedResponse = json_decode($httpRequest->getResponseBody(), true)) == null) {
throw new apiServiceException("Invalid json in service response: " . $httpRequest->getResponseBody());
}
}
//FIXME currently everything is wrapped in a data enveloppe, but hopefully this might change some day
$ret = isset($decodedResponse['data']) ? $decodedResponse['data'] : $decodedResponse;
// Add a 'continuationToken' element to the response if the response contains a next link (so you can call it using the 'c' param)
$ret = self::checkNextLink($ret);
// if the response type has a registered type handler, call & return it instead of the raw response array
if (isset($ret['kind']) && isset($apiTypeHandlers[$ret['kind']])) {
$ret = new $apiTypeHandlers[$ret['kind']]($ret);
}
return $ret;
}
