mirror of
https://github.com/VTECRM/vtenext.git
synced 2026-02-26 16:18:47 +00:00
442 lines
11 KiB
PHP
442 lines
11 KiB
PHP
<?php
|
|
/*************************************
|
|
* SPDX-FileCopyrightText: 2009-2020 Vtenext S.r.l. <info@vtenext.com>
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
************************************/
|
|
/* crmv@170283 */
|
|
namespace RestService;
|
|
|
|
class Client
|
|
{
|
|
/**
|
|
* Current output format.
|
|
*
|
|
* @var string
|
|
*/
|
|
private $outputFormat = 'json';
|
|
|
|
/**
|
|
* List of possible output formats.
|
|
*
|
|
* @var array
|
|
*/
|
|
private $outputFormats = array(
|
|
'json' => 'asJSON',
|
|
'xml' => 'asXML'
|
|
);
|
|
|
|
/**
|
|
* List of possible methods.
|
|
* @var array
|
|
*/
|
|
public $methods = array('get', 'post', 'put', 'delete', 'head', 'options', 'patch');
|
|
|
|
/**
|
|
* Current URL.
|
|
*
|
|
* @var string
|
|
*/
|
|
private $url;
|
|
|
|
/**
|
|
* @var Server
|
|
*
|
|
*/
|
|
private $controller;
|
|
|
|
/**
|
|
* Custom set http method.
|
|
*
|
|
* @var string
|
|
*/
|
|
private $method;
|
|
|
|
|
|
private static $statusCodes = array(
|
|
100 => 'Continue',
|
|
101 => 'Switching Protocols',
|
|
200 => 'OK',
|
|
201 => 'Created',
|
|
202 => 'Accepted',
|
|
203 => 'Non-Authoritative Information',
|
|
204 => 'No Content',
|
|
205 => 'Reset Content',
|
|
206 => 'Partial Content',
|
|
300 => 'Multiple Choices',
|
|
301 => 'Moved Permanently',
|
|
302 => 'Found', // 1.1
|
|
303 => 'See Other',
|
|
304 => 'Not Modified',
|
|
305 => 'Use Proxy',
|
|
307 => 'Temporary Redirect',
|
|
400 => 'Bad Request',
|
|
401 => 'Unauthorized',
|
|
402 => 'Payment Required',
|
|
403 => 'Forbidden',
|
|
404 => 'Not Found',
|
|
405 => 'Method Not Allowed',
|
|
406 => 'Not Acceptable',
|
|
407 => 'Proxy Authentication Required',
|
|
408 => 'Request Timeout',
|
|
409 => 'Conflict',
|
|
410 => 'Gone',
|
|
411 => 'Length Required',
|
|
412 => 'Precondition Failed',
|
|
413 => 'Request Entity Too Large',
|
|
414 => 'Request-URI Too Long',
|
|
415 => 'Unsupported Media Type',
|
|
416 => 'Requested Range Not Satisfiable',
|
|
417 => 'Expectation Failed',
|
|
500 => 'Internal Server Error',
|
|
501 => 'Not Implemented',
|
|
502 => 'Bad Gateway',
|
|
503 => 'Service Unavailable',
|
|
504 => 'Gateway Timeout',
|
|
505 => 'HTTP Version Not Supported',
|
|
509 => 'Bandwidth Limit Exceeded'
|
|
);
|
|
|
|
/**
|
|
* @param Server $pServerController
|
|
*/
|
|
public function __construct($pServerController)
|
|
{
|
|
$this->controller = $pServerController;
|
|
if (isset($_SERVER['PATH_INFO']))
|
|
$this->setUrl($_SERVER['PATH_INFO']);
|
|
|
|
$this->setupFormats();
|
|
}
|
|
|
|
/**
|
|
* @param \RestService\Server $controller
|
|
*/
|
|
public function setController($controller)
|
|
{
|
|
$this->controller = $controller;
|
|
}
|
|
|
|
/**
|
|
* @return \RestService\Server
|
|
*/
|
|
public function getController()
|
|
{
|
|
return $this->controller;
|
|
}
|
|
|
|
/**
|
|
* Sends the actual response.
|
|
*
|
|
* @param string $pHttpCode
|
|
* @param $pMessage
|
|
*/
|
|
public function sendResponse($pHttpCode = '200', $pMessage)
|
|
{
|
|
$suppressStatusCode = isset($_GET['_suppress_status_code']) ? $_GET['_suppress_status_code'] : false;
|
|
if ($this->controller->getHttpStatusCodes() &&
|
|
!$suppressStatusCode &&
|
|
php_sapi_name() !== 'cli'
|
|
) {
|
|
|
|
$status = self::$statusCodes[intval($pHttpCode)];
|
|
header('HTTP/1.0 ' . ($status ? $pHttpCode . ' ' . $status : $pHttpCode), true, $pHttpCode);
|
|
} elseif (php_sapi_name() !== 'cli') {
|
|
header('HTTP/1.0 200 OK');
|
|
}
|
|
|
|
$pMessage = array_reverse($pMessage, true);
|
|
$pMessage['status'] = intval($pHttpCode);
|
|
$pMessage = array_reverse($pMessage, true);
|
|
|
|
$method = $this->getOutputFormatMethod($this->getOutputFormat());
|
|
//crmv@170283
|
|
$response = $this->$method($pMessage);
|
|
$this->controller->getController()->log('output',$response);
|
|
echo $response;
|
|
//crmv@170283e
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* @param string $pFormat
|
|
* @return string
|
|
*/
|
|
public function getOutputFormatMethod($pFormat)
|
|
{
|
|
return $this->outputFormats[$pFormat];
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getOutputFormat()
|
|
{
|
|
return $this->outputFormat;
|
|
}
|
|
|
|
/**
|
|
* Detect the method.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getMethod()
|
|
{
|
|
if ($this->method) {
|
|
return $this->method;
|
|
}
|
|
|
|
$method = @$_SERVER['REQUEST_METHOD'];
|
|
if (isset($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']))
|
|
$method = $_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'];
|
|
|
|
if (isset($_GET['_method']))
|
|
$method = $_GET['_method'];
|
|
else if (isset($_POST['_method']))
|
|
$method = $_POST['_method'];
|
|
|
|
$method = strtolower($method);
|
|
|
|
if (!in_array($method, $this->methods))
|
|
$method = 'get';
|
|
|
|
return $method;
|
|
|
|
}
|
|
|
|
/**
|
|
* Sets a custom http method. It does then not check against
|
|
* SERVER['REQUEST_METHOD'], $_GET['_method'] etc anymore.
|
|
*
|
|
* @param string $pMethod
|
|
* @return Client
|
|
*/
|
|
public function setMethod($pMethod)
|
|
{
|
|
$this->method = $pMethod;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set header Content-Length $pMessage.
|
|
*
|
|
* @param $pMessage
|
|
*/
|
|
public function setContentLength($pMessage)
|
|
{
|
|
if (php_sapi_name() !== 'cli')
|
|
header('Content-Length: ' . strlen($pMessage));
|
|
}
|
|
|
|
/**
|
|
* Converts $pMessage to pretty json.
|
|
*
|
|
* @param $pMessage
|
|
* @return string
|
|
*/
|
|
public function asJSON($pMessage)
|
|
{
|
|
if (php_sapi_name() !== 'cli')
|
|
header('Content-Type: application/json; charset=utf-8');
|
|
|
|
$result = $this->jsonFormat($pMessage);
|
|
$this->setContentLength($result);
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Indents a flat JSON string to make it more human-readable.
|
|
*
|
|
* Original at http://recursive-design.com/blog/2008/03/11/format-json-with-php/
|
|
*
|
|
* @param string $json The original JSON string to process.
|
|
*
|
|
* @return string Indented version of the original JSON string.
|
|
*/
|
|
public function jsonFormat($json)
|
|
{
|
|
if (!is_string($json)) $json = json_encode($json);
|
|
|
|
$result = '';
|
|
$pos = 0;
|
|
$strLen = strlen($json);
|
|
$indentStr = ' ';
|
|
$newLine = "\n";
|
|
$inEscapeMode = false; //if the last char is a valid \ char.
|
|
$outOfQuotes = true;
|
|
|
|
for ($i = 0; $i <= $strLen; $i++) {
|
|
|
|
// Grab the next character in the string.
|
|
$char = substr($json, $i, 1);
|
|
|
|
// Are we inside a quoted string?
|
|
if ($char == '"' && !$inEscapeMode) {
|
|
$outOfQuotes = !$outOfQuotes;
|
|
|
|
// If this character is the end of an element,
|
|
// output a new line and indent the next line.
|
|
} elseif (($char == '}' || $char == ']') && $outOfQuotes) {
|
|
$result .= $newLine;
|
|
$pos--;
|
|
for ($j = 0; $j < $pos; $j++) {
|
|
$result .= $indentStr;
|
|
}
|
|
} elseif ($char == ':' && $outOfQuotes) {
|
|
$char .= ' ';
|
|
}
|
|
|
|
// Add the character to the result string.
|
|
$result .= $char;
|
|
|
|
// If the last character was the beginning of an element,
|
|
// output a new line and indent the next line.
|
|
if (($char == ',' || $char == '{' || $char == '[') && $outOfQuotes) {
|
|
$result .= $newLine;
|
|
if ($char == '{' || $char == '[') {
|
|
$pos++;
|
|
}
|
|
|
|
for ($j = 0; $j < $pos; $j++) {
|
|
$result .= $indentStr;
|
|
}
|
|
}
|
|
|
|
if ($char == '\\' && !$inEscapeMode)
|
|
$inEscapeMode = true;
|
|
else
|
|
$inEscapeMode = false;
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Converts $pMessage to xml.
|
|
*
|
|
* @param $pMessage
|
|
* @return string
|
|
*/
|
|
public function asXML($pMessage)
|
|
{
|
|
$xml = $this->toXml($pMessage);
|
|
$xml = "<?xml version=\"1.0\"?>\n<response>\n$xml</response>\n";
|
|
|
|
$this->setContentLength($xml);
|
|
return $xml;
|
|
|
|
}
|
|
|
|
/**
|
|
* @param mixed $pData
|
|
* @param string $pParentTagName
|
|
* @param int $pDepth
|
|
* @return string XML
|
|
*/
|
|
public function toXml($pData, $pParentTagName = '', $pDepth = 1)
|
|
{
|
|
if (is_array($pData)) {
|
|
$content = '';
|
|
|
|
foreach ($pData as $key => $data) {
|
|
$key = is_numeric($key) ? $pParentTagName . '-item' : $key;
|
|
$content .= str_repeat(' ', $pDepth)
|
|
. '<' . htmlspecialchars($key) . '>' .
|
|
$this->toXml($data, $key, $pDepth + 1)
|
|
. '</' . htmlspecialchars($key) . ">\n";
|
|
}
|
|
|
|
return $content;
|
|
} else {
|
|
return htmlspecialchars($pData);
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Add a additional output format.
|
|
*
|
|
* @param string $pCode
|
|
* @param string $pMethod
|
|
* @return Client $this
|
|
*/
|
|
public function addOutputFormat($pCode, $pMethod)
|
|
{
|
|
$this->outputFormats[$pCode] = $pMethod;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set the current output format.
|
|
*
|
|
* @param string $pFormat a key of $outputForms
|
|
* @return Client
|
|
*/
|
|
public function setFormat($pFormat)
|
|
{
|
|
$this->outputFormat = $pFormat;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Returns the url.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getUrl()
|
|
{
|
|
return $this->url;
|
|
}
|
|
|
|
/**
|
|
* Set the url.
|
|
*
|
|
* @param string $pUrl
|
|
* @return Client $this
|
|
*/
|
|
public function setUrl($pUrl)
|
|
{
|
|
$this->url = $pUrl;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Setup formats.
|
|
*
|
|
* @return Client
|
|
*/
|
|
public function setupFormats()
|
|
{
|
|
//through HTTP_ACCEPT
|
|
if (isset($_SERVER['HTTP_ACCEPT']) && strpos($_SERVER['HTTP_ACCEPT'], '*/*') === false) {
|
|
foreach ($this->outputFormats as $formatCode => $formatMethod) {
|
|
if (strpos($_SERVER['HTTP_ACCEPT'], $formatCode) !== false) {
|
|
$this->outputFormat = $formatCode;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
//through uri suffix
|
|
if (preg_match('/\.(\w+)$/i', $this->getUrl(), $matches)) {
|
|
if (isset($this->outputFormats[$matches[1]])) {
|
|
$this->outputFormat = $matches[1];
|
|
$url = $this->getUrl();
|
|
$this->setUrl(substr($url, 0, (strlen($this->outputFormat) * -1) - 1));
|
|
}
|
|
}
|
|
|
|
//through _format parametr
|
|
if (isset($_GET['_format'])) {
|
|
if (isset($this->outputFormats[$_GET['_format']])) {
|
|
$this->outputFormat = $_GET['_format'];
|
|
}
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
} |