Add XML

api.php

@@ -7347,7 +7347,6 @@ namespace Tqdev\PhpCrudApi\Middleware {
     use Psr\Http\Message\ResponseInterface;
     use Psr\Http\Message\ServerRequestInterface;
     use Psr\Http\Server\RequestHandlerInterface;
-    use Tqdev\PhpCrudApi\Controller\Responder;
     use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
     use Tqdev\PhpCrudApi\Record\ErrorCode;
     use Tqdev\PhpCrudApi\ResponseFactory;
@@ -8517,6 +8516,122 @@ namespace Tqdev\PhpCrudApi\Middleware {
     }
 }
 
+// file: src/Tqdev/PhpCrudApi/Middleware/XmlMiddleware.php
+namespace Tqdev\PhpCrudApi\Middleware {
+
+    use Psr\Http\Message\ResponseInterface;
+    use Psr\Http\Message\ServerRequestInterface;
+    use Psr\Http\Server\RequestHandlerInterface;
+    use Tqdev\PhpCrudApi\Column\ReflectionService;
+    use Tqdev\PhpCrudApi\Controller\Responder;
+    use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
+    use Tqdev\PhpCrudApi\Middleware\Router\Router;
+    use Tqdev\PhpCrudApi\RequestUtils;
+    use Tqdev\PhpCrudApi\ResponseFactory;
+
+    class XmlMiddleware extends Middleware
+    {
+        private $reflection;
+
+        public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
+        {
+            parent::__construct($router, $responder, $properties);
+            $this->reflection = $reflection;
+        }
+
+        private function convertFromJsonToXml(string $body): string
+        {
+            $objectElement = $this->getProperty('objectElement', 'object');
+            $prolog = '<?xml version="1.0" encoding="UTF-8"?>' . "\n";
+            $xml = new \SimpleXMLElement($prolog . '<root></root>');
+            $object = json_decode($body);
+            if (is_scalar($object)) {
+                $xml = $xml->addChild($objectElement, $object);
+            } else {
+                $xml = $xml->addChild($objectElement);
+                $this->convertFromObjectToXml($object, $xml, $objectElement);
+            }
+            return $prolog . $xml->asXML();
+        }
+
+        private function convertFromObjectToXml($object, $xml, string $objectElement): void
+        {
+            if (is_array($object)) {
+                $xml->addAttribute('type', 'list');
+            }
+            foreach ($object as $key => $value) {
+                if (!is_array($value) && !is_object($value)) {
+                    if (is_object($object)) {
+                        $xml->addChild($key, (string) $value);
+                    } else {
+                        $xml->addChild($objectElement, (string) $value);
+                    }
+                    continue;
+                }
+                $node = $xml;
+                if (is_object($object)) {
+                    $node = $node->addChild($key);
+                } elseif (is_object($value)) {
+                    $node = $node->addChild($objectElement);
+                }
+                $this->convertFromObjectToXml($value, $node, $objectElement);
+            }
+        }
+
+        private function convertFromXmlToJson(string $body)/*: object */
+        {
+            $objectElement = $this->getProperty('objectElement', 'object');
+            $prolog = '<?xml version="1.0" encoding="UTF-8"?>' . "\n";
+            $xml = new \SimpleXMLElement($prolog . $body);
+            $object = $this->convertFromXmlToObject($xml, $objectElement);
+            return json_decode(json_encode($object));
+        }
+
+        private function convertFromXmlToObject($xml): array
+        {
+            $result = [];
+            foreach ($xml->children() as $nodeName => $nodeValue) {
+                if (count($nodeValue->children()) == 0) {
+                    $object = strVal($nodeValue);
+                } else {
+                    $object = $this->convertFromXmlToObject($nodeValue);
+                }
+                $attributes = $xml->attributes();
+                if ($attributes['type'] == 'list') {
+                    $result[] = $object;
+                } else {
+                    $result[$nodeName] = $object;
+                }
+            }
+            return $result;
+        }
+
+        public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
+        {
+            $operation = RequestUtils::getOperation($request);
+
+            parse_str($request->getUri()->getQuery(), $params);
+            $isXml = isset($params['format']) && $params['format'] == 'xml';
+            if ($isXml) {
+                $body = $request->getBody()->getContents();
+                if ($body) {
+                    $json = $this->convertFromXmlToJson($body);
+                    $request = $request->withParsedBody($json);
+                }
+            }
+            $response = $next->handle($request);
+            if ($isXml) {
+                $body = $response->getBody()->getContents();
+                if ($body) {
+                    $xml = $this->convertFromJsonToXml($body);
+                    $response = ResponseFactory::fromXml(ResponseFactory::OK, $xml);
+                }
+            }
+            return $response;
+        }
+    }
+}
+
 // file: src/Tqdev/PhpCrudApi/Middleware/XsrfMiddleware.php
 namespace Tqdev\PhpCrudApi\Middleware {
 
@@ -10386,6 +10501,7 @@ namespace Tqdev\PhpCrudApi {
     use Tqdev\PhpCrudApi\Middleware\IpAddressMiddleware;
     use Tqdev\PhpCrudApi\Middleware\JoinLimitsMiddleware;
     use Tqdev\PhpCrudApi\Middleware\JwtAuthMiddleware;
+    use Tqdev\PhpCrudApi\Middleware\XmlMiddleware;
     use Tqdev\PhpCrudApi\Middleware\MultiTenancyMiddleware;
     use Tqdev\PhpCrudApi\Middleware\PageLimitsMiddleware;
     use Tqdev\PhpCrudApi\Middleware\ReconnectMiddleware;
@@ -10467,6 +10583,9 @@ namespace Tqdev\PhpCrudApi {
                     case 'customization':
                         new CustomizationMiddleware($router, $responder, $properties, $reflection);
                         break;
+                    case 'xml':
+                        new XmlMiddleware($router, $responder, $properties, $reflection);
+                        break;
                 }
             }
             foreach ($config->getControllers() as $controller) {
@@ -10934,6 +11053,11 @@ namespace Tqdev\PhpCrudApi {
         const UNPROCESSABLE_ENTITY = 422;
         const INTERNAL_SERVER_ERROR = 500;
 
+        public static function fromXml(int $status, string $xml): ResponseInterface
+        {
+            return self::from($status, 'text/xml', $xml);
+        }
+
         public static function fromCsv(int $status, string $csv): ResponseInterface
         {
             $response = self::from($status, 'text/csv', $csv);

src/Tqdev/PhpCrudApi/Api.php

@@ -25,6 +25,7 @@ use Tqdev\PhpCrudApi\Middleware\FirewallMiddleware;
 use Tqdev\PhpCrudApi\Middleware\IpAddressMiddleware;
 use Tqdev\PhpCrudApi\Middleware\JoinLimitsMiddleware;
 use Tqdev\PhpCrudApi\Middleware\JwtAuthMiddleware;
+use Tqdev\PhpCrudApi\Middleware\XmlMiddleware;
 use Tqdev\PhpCrudApi\Middleware\MultiTenancyMiddleware;
 use Tqdev\PhpCrudApi\Middleware\PageLimitsMiddleware;
 use Tqdev\PhpCrudApi\Middleware\ReconnectMiddleware;
@@ -106,6 +107,9 @@ class Api implements RequestHandlerInterface
                 case 'customization':
                     new CustomizationMiddleware($router, $responder, $properties, $reflection);
                     break;
+                case 'xml':
+                    new XmlMiddleware($router, $responder, $properties, $reflection);
+                    break;
             }
         }
         foreach ($config->getControllers() as $controller) {

src/Tqdev/PhpCrudApi/Middleware/CorsMiddleware.php

@@ -5,7 +5,6 @@ namespace Tqdev\PhpCrudApi\Middleware;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\RequestHandlerInterface;
-use Tqdev\PhpCrudApi\Controller\Responder;
 use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
 use Tqdev\PhpCrudApi\Record\ErrorCode;
 use Tqdev\PhpCrudApi\ResponseFactory;

src/Tqdev/PhpCrudApi/Middleware/XmlMiddleware.php

@@ -0,0 +1,115 @@
+<?php
+
+namespace Tqdev\PhpCrudApi\Middleware;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+use Tqdev\PhpCrudApi\Column\ReflectionService;
+use Tqdev\PhpCrudApi\Controller\Responder;
+use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
+use Tqdev\PhpCrudApi\Middleware\Router\Router;
+use Tqdev\PhpCrudApi\RequestUtils;
+use Tqdev\PhpCrudApi\ResponseFactory;
+
+class XmlMiddleware extends Middleware
+{
+    private $reflection;
+
+    public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
+    {
+        parent::__construct($router, $responder, $properties);
+        $this->reflection = $reflection;
+    }
+
+    private function convertFromJsonToXml(string $body): string
+    {
+        $objectElement = $this->getProperty('objectElement', 'object');
+        $prolog = '<?xml version="1.0" encoding="UTF-8"?>' . "\n";
+        $xml = new \SimpleXMLElement($prolog . '<root></root>');
+        $object = json_decode($body);
+        if (is_scalar($object)) {
+            $xml = $xml->addChild($objectElement, $object);
+        } else {
+            $xml = $xml->addChild($objectElement);
+            $this->convertFromObjectToXml($object, $xml, $objectElement);
+        }
+        return $prolog . $xml->asXML();
+    }
+
+    private function convertFromObjectToXml($object, $xml, string $objectElement): void
+    {
+        if (is_array($object)) {
+            $xml->addAttribute('type', 'list');
+        }
+        foreach ($object as $key => $value) {
+            if (!is_array($value) && !is_object($value)) {
+                if (is_object($object)) {
+                    $xml->addChild($key, (string) $value);
+                } else {
+                    $xml->addChild($objectElement, (string) $value);
+                }
+                continue;
+            }
+            $node = $xml;
+            if (is_object($object)) {
+                $node = $node->addChild($key);
+            } elseif (is_object($value)) {
+                $node = $node->addChild($objectElement);
+            }
+            $this->convertFromObjectToXml($value, $node, $objectElement);
+        }
+    }
+
+    private function convertFromXmlToJson(string $body)/*: object */
+    {
+        $objectElement = $this->getProperty('objectElement', 'object');
+        $prolog = '<?xml version="1.0" encoding="UTF-8"?>' . "\n";
+        $xml = new \SimpleXMLElement($prolog . $body);
+        $object = $this->convertFromXmlToObject($xml, $objectElement);
+        return json_decode(json_encode($object));
+    }
+
+    private function convertFromXmlToObject($xml): array
+    {
+        $result = [];
+        foreach ($xml->children() as $nodeName => $nodeValue) {
+            if (count($nodeValue->children()) == 0) {
+                $object = strVal($nodeValue);
+            } else {
+                $object = $this->convertFromXmlToObject($nodeValue);
+            }
+            $attributes = $xml->attributes();
+            if ($attributes['type'] == 'list') {
+                $result[] = $object;
+            } else {
+                $result[$nodeName] = $object;
+            }
+        }
+        return $result;
+    }
+
+    public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
+    {
+        $operation = RequestUtils::getOperation($request);
+
+        parse_str($request->getUri()->getQuery(), $params);
+        $isXml = isset($params['format']) && $params['format'] == 'xml';
+        if ($isXml) {
+            $body = $request->getBody()->getContents();
+            if ($body) {
+                $json = $this->convertFromXmlToJson($body);
+                $request = $request->withParsedBody($json);
+            }
+        }
+        $response = $next->handle($request);
+        if ($isXml) {
+            $body = $response->getBody()->getContents();
+            if ($body) {
+                $xml = $this->convertFromJsonToXml($body);
+                $response = ResponseFactory::fromXml(ResponseFactory::OK, $xml);
+            }
+        }
+        return $response;
+    }
+}

src/Tqdev/PhpCrudApi/ResponseFactory.php

@@ -16,6 +16,11 @@ class ResponseFactory
     const UNPROCESSABLE_ENTITY = 422;
     const INTERNAL_SERVER_ERROR = 500;
 
+    public static function fromXml(int $status, string $xml): ResponseInterface
+    {
+        return self::from($status, 'text/xml', $xml);
+    }
+
     public static function fromCsv(int $status, string $csv): ResponseInterface
     {
         $response = self::from($status, 'text/csv', $csv);

tests/config/base.php

@@ -4,7 +4,7 @@ $settings = [
     'username' => 'incorrect_username',
     'password' => 'incorrect_password',
     'controllers' => 'records,columns,cache,openapi,geojson',
-    'middlewares' => 'cors,reconnect,dbAuth,jwtAuth,basicAuth,authorization,sanitation,validation,ipAddress,multiTenancy,pageLimits,joinLimits,customization',
+    'middlewares' => 'xml,cors,reconnect,dbAuth,jwtAuth,basicAuth,authorization,sanitation,validation,ipAddress,multiTenancy,pageLimits,joinLimits,customization',
     'dbAuth.mode' => 'optional',
     'dbAuth.returnedColumns' => 'id,username,password',
     'jwtAuth.mode' => 'optional',

tests/functional/001_records/087_read_and_write_posts_as_xml.log

@@ -0,0 +1,93 @@
+===
+GET /records/posts/1?format=xml
+===
+200
+Content-Type: text/xml
+Content-Length: 145
+
+<?xml version="1.0" encoding="UTF-8"?>
+<object><id>1</id><user_id>1</user_id><category_id>1</category_id><content>blog started</content></object>
+===
+GET /records/posts?limit=2
+===
+200
+Content-Type: application/json
+Content-Length: 134
+
+{"records":[{"id":1,"user_id":1,"category_id":1,"content":"blog started"},{"id":2,"user_id":1,"category_id":2,"content":"It works!"}]}
+===
+GET /records/posts?limit=2&format=xml
+===
+200
+Content-Type: text/xml
+Content-Length: 296
+
+<?xml version="1.0" encoding="UTF-8"?>
+<object><records type="list"><object><id>1</id><user_id>1</user_id><category_id>1</category_id><content>blog started</content></object><object><id>2</id><user_id>1</user_id><category_id>2</category_id><content>It works!</content></object></records></object>
+===
+GET /records/posts/1?join=users&format=xml
+===
+200
+Content-Type: text/xml
+Content-Length: 217
+
+<?xml version="1.0" encoding="UTF-8"?>
+<object><id>1</id><user_id><id>1</id><username>user1</username><password>pass1</password><location/></user_id><category_id>1</category_id><content>blog started</content></object>
+===
+GET /records/posts/1?join=users&join=comments,categories
+===
+200
+Content-Type: application/json
+Content-Length: 321
+
+{"id":1,"user_id":{"id":1,"username":"user1","password":"pass1","location":null},"category_id":1,"content":"blog started","comments":[{"id":1,"post_id":1,"message":"great","category_id":{"id":3,"name":"comment","icon":null}},{"id":2,"post_id":1,"message":"fantastic","category_id":{"id":3,"name":"comment","icon":null}}]}
+===
+GET /records/posts/1?join=users&join=comments,categories&format=xml
+===
+200
+Content-Type: text/xml
+Content-Length: 524
+
+<?xml version="1.0" encoding="UTF-8"?>
+<object><id>1</id><user_id><id>1</id><username>user1</username><password>pass1</password><location/></user_id><category_id>1</category_id><content>blog started</content><comments type="list"><object><id>1</id><post_id>1</post_id><message>great</message><category_id><id>3</id><name>comment</name><icon/></category_id></object><object><id>2</id><post_id>1</post_id><message>fantastic</message><category_id><id>3</id><name>comment</name><icon/></category_id></object></comments></object>
+===
+GET /records/posts?page=2,1
+===
+200
+Content-Type: application/json
+Content-Length: 84
+
+{"records":[{"id":2,"user_id":1,"category_id":2,"content":"It works!"}],"results":2}
+===
+GET /records/posts?page=2,1&format=xml
+===
+200
+Content-Type: text/xml
+Content-Length: 210
+
+<?xml version="1.0" encoding="UTF-8"?>
+<object><records type="list"><object><id>2</id><user_id>1</user_id><category_id>2</category_id><content>It works!</content></object></records><results>2</results></object>
+===
+POST /records/posts?format=xml
+Content-Type: application/xml
+
+<object><id>1</id><user_id>1</user_id><category_id>1</category_id><content>blog started</content></object>
+===
+200
+Content-Type: text/xml
+Content-Length: 115
+
+<?xml version="1.0" encoding="UTF-8"?>
+<object><code>1009</code><message>Duplicate key exception</message></object>
+===
+PUT /records/posts/1?format=xml
+Content-Type: application/xml
+
+<object><user_id>1</user_id><category_id>1</category_id><content>blog started</content></object>
+===
+200
+Content-Type: text/xml
+Content-Length: 57
+
+<?xml version="1.0" encoding="UTF-8"?>
+<object>1</object>

tests/functional/001_records/088_read_and_write_multiple_posts_as_xml.log

@@ -0,0 +1,28 @@
+===
+GET /records/posts/1,2
+===
+200
+Content-Type: application/json
+Content-Length: 122
+
+[{"id":1,"user_id":1,"category_id":1,"content":"blog started"},{"id":2,"user_id":1,"category_id":2,"content":"It works!"}]
+===
+GET /records/posts/1,2?format=xml
+===
+200
+Content-Type: text/xml
+Content-Length: 277
+
+<?xml version="1.0" encoding="UTF-8"?>
+<object type="list"><object><id>1</id><user_id>1</user_id><category_id>1</category_id><content>blog started</content></object><object><id>2</id><user_id>1</user_id><category_id>2</category_id><content>It works!</content></object></object>
+===
+PUT /records/posts/1,2?format=xml
+
+<object type="list"><object><user_id>1</user_id></object><object><user_id>2</user_id></object></object>
+===
+200
+Content-Type: text/xml
+Content-Length: 104
+
+<?xml version="1.0" encoding="UTF-8"?>
+<object type="list"><object>1</object><object>1</object></object>

tests/functional/003_columns/017_get_barcodes_table_as_xml.log

@@ -0,0 +1,9 @@
+===
+GET /columns/barcodes?format=xml
+===
+200
+Content-Type: text/xml
+Content-Length: 489
+
+<?xml version="1.0" encoding="UTF-8"?>
+<object><name>barcodes</name><type>table</type><columns type="list"><object><name>id</name><type>integer</type><pk>1</pk></object><object><name>product_id</name><type>integer</type><fk>products</fk></object><object><name>hex</name><type>varchar</type><length>255</length></object><object><name>bin</name><type>blob</type></object><object><name>ip_address</name><type>varchar</type><length>15</length><nullable>1</nullable></object></columns></object>