Merge branch '10-ajouter-l-operateur-pour-gerer-le-format-json' into 'develop'

Resolve "Ajouter l'opérateur pour gérer le format json"

Closes #10

See merge request !29

Makefile

@@ -54,7 +54,7 @@ phpunit:
 phpcs:
 	@docker run --init -it --rm --user $(UID):$(GID) \
 	-v $(CURDIR):/project \
-	-w /project jakzal/phpqa phpcs --standard=PSR2 --extensions=php -n --colors src
+	-w /project jakzal/phpqa phpcs --standard=PSR2 --extensions=php --colors src
 
 init-db:
 	@docker-compose exec php sh ./conf-dev/metamodel_init.sh

docker-compose.yml

@@ -10,11 +10,15 @@ services:
             METADATA_DOCTRINE_PATH_PROXY: "/tmp/doctrine_proxy"
             METADATA_DOCTRINE_DEV_MODE: "true"
             METADATA_DB_DRIVER: "pdo_pgsql"
-            METADATA_DB_HOST: "db"
+            #METADATA_DB_HOST: "db"
+            METADATA_DB_HOST: "cesamsidb.lam.fr"
             METADATA_DB_PORT: 5432
-            METADATA_DB_DBNAME: "anis_metamodel"
-            METADATA_DB_USER: "anis"
-            METADATA_DB_PASSWORD: "anis"
+            #METADATA_DB_DBNAME: "anis_metamodel"
+            METADATA_DB_DBNAME: "svom_sdb_dc1_metamodel"
+            #METADATA_DB_USER: "anis"
+            #METADATA_DB_PASSWORD: "anis"
+            METADATA_DB_USER: "svom"
+            METADATA_DB_PASSWORD: "svom#$$"
             MAILER_HOST: "mailer"
             MAILER_PORT: 25
             LOGGER_NAME: "anis-v3-server"

src/Action/Login/TokenAction.php

@@ -66,8 +66,12 @@ final class TokenAction
      * @param Lcobucci\JWT\Builder   $jwtBuilder
      * @param Lcobucci\JWT\Signer    $jwtSigner
      */
-    public function __construct(LoggerInterface $logger, EntityManagerInterface $em, JwtBuilder $jwtBuilder, JwtSigner $jwtSigner)
-    {
+    public function __construct(
+        LoggerInterface $logger,
+        EntityManagerInterface $em,
+        JwtBuilder $jwtBuilder,
+        JwtSigner $jwtSigner
+    ) {
         $this->logger = $logger;
         $this->em = $em;
         $this->jwtBuilder = $jwtBuilder;

src/Action/Meta/AttributeAction.php

@@ -42,7 +42,10 @@ final class AttributeAction
             return $response->withHeader('Access-Control-Allow-Methods', 'GET, PUT, OPTIONS');
         }
 
-        $attribute = $this->em->getRepository('App\Entity\Attribute')->findOneBy(array('dataset' => $args['name'], 'id' => $args['id']));
+        $attribute = $this->em->getRepository('App\Entity\Attribute')->findOneBy(array(
+            'dataset' => $args['name'],
+            'id' => $args['id']
+        ));
 
         if (is_null($attribute)) {
             return $this->dispatchHttpError(
@@ -58,8 +61,18 @@ final class AttributeAction
 
         if ($request->isPut()) {
             $parsedBody = $request->getParsedBody();
-            $criteriaFamily = is_null($parsedBody['id_criteria_family']) ? null : $this->em->find('App\Entity\CriteriaFamily', $parsedBody['id_criteria_family']);
-            $outputCategory = is_null($parsedBody['id_output_category']) ? null : $this->em->find('App\Entity\OutputCategory', $parsedBody['id_output_category']);
+
+            if (is_null($parsedBody['id_criteria_family'])) {
+                $criteriaFamily = null;
+            } else {
+                $criteriaFamily = $this->em->find('App\Entity\CriteriaFamily', $parsedBody['id_criteria_family']);
+            }
+
+            if (is_null($parsedBody['id_output_category'])) {
+                $outputCategory = null;
+            } else {
+                $outputCategory = $this->em->find('App\Entity\OutputCategory', $parsedBody['id_output_category']);
+            }
 
             $this->editAttribute($attribute, $parsedBody, $criteriaFamily, $outputCategory);
             $this->em->flush();
@@ -70,8 +83,12 @@ final class AttributeAction
         return $newResponse;
     }
 
-    private function editAttribute(Attribute $attribute, array $parsedBody, CriteriaFamily $criteriaFamily = null, OutputCategory $outputCategory = null): void
-    {
+    private function editAttribute(
+        Attribute $attribute,
+        array $parsedBody,
+        CriteriaFamily $criteriaFamily = null,
+        OutputCategory $outputCategory = null
+    ): void {
         $attribute->setLabel($parsedBody['label']);
         $attribute->setFormLabel($parsedBody['form_label']);
         $attribute->setDescription($parsedBody['description']);

src/Action/Meta/DatasetListAction.php

@@ -37,8 +37,12 @@ final class DatasetListAction
      */
     private $encryptionKey;
     
-    public function __construct(LoggerInterface $logger, EntityManagerInterface $em, DBALConnectionFactory $dcf, string $encryptionKey)
-    {
+    public function __construct(
+        LoggerInterface $logger,
+        EntityManagerInterface $em,
+        DBALConnectionFactory $dcf,
+        string $encryptionKey
+    ) {
         $this->logger = $logger;
         $this->em = $em;
         $this->dcf = $dcf;
@@ -62,7 +66,19 @@ final class DatasetListAction
             $parsedBody = $request->getParsedBody();
 
             // Vérification des champs vides
-            foreach (array('name', 'table_ref', 'label', 'description', 'display', 'count', 'vo', 'data_path', 'project_name', 'id_dataset_family') as $a) {
+            $fields = array(
+                'name',
+                'table_ref',
+                'label',
+                'description',
+                'display',
+                'count',
+                'vo',
+                'data_path',
+                'project_name',
+                'id_dataset_family'
+            );
+            foreach ($fields as $a) {
                 if ($this->isEmptyField($a, $parsedBody)) {
                     return $this->dispatchHttpError(
                         $response,

src/Action/Meta/FamilyAction.php

@@ -98,7 +98,7 @@ final class FamilyAction
     {
         if ($family instanceof \App\Entity\DatasetFamily) {
             return 'dataset';
-        } else if ($family instanceof \App\Entity\CriteriaFamily) {
+        } elseif ($family instanceof \App\Entity\CriteriaFamily) {
             return 'criteria';
         } else {
             return 'output';

src/Action/Meta/OutputCategoryAction.php

@@ -92,8 +92,11 @@ final class OutputCategoryAction
         return $newResponse;
     }
 
-    private function editOutputCategory(OutputCategory $outputCategory, array $parsedBody, OutputFamily $outputFamily): void
-    {
+    private function editOutputCategory(
+        OutputCategory $outputCategory,
+        array $parsedBody,
+        OutputFamily $outputFamily
+    ): void {
         $outputCategory->setLabel($parsedBody['label']);
         $outputCategory->setDisplay($parsedBody['display']);
         $outputCategory->setOutputFamily($outputFamily);

src/Action/Meta/TableListAction.php

@@ -34,8 +34,12 @@ final class TableListAction
      */
     private $encryptionKey;
     
-    public function __construct(LoggerInterface $logger, EntityManagerInterface $em, DBALConnectionFactory $dcf, string $encryptionKey)
-    {
+    public function __construct(
+        LoggerInterface $logger,
+        EntityManagerInterface $em,
+        DBALConnectionFactory $dcf,
+        string $encryptionKey
+    ) {
         $this->logger = $logger;
         $this->em = $em;
         $this->dcf = $dcf;

src/Action/Search/SearchAction.php

@@ -12,6 +12,7 @@ namespace App\Action\Search;
 
 use Psr\Log\LoggerInterface;
 use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\DBAL\Platforms\PostgreSQL94Platform;
 use Doctrine\DBAL\Query\QueryBuilder;
 use Doctrine\DBAL\Query\Expression\CompositeExpression;
 use Psr\Http\Message\ServerRequestInterface as Request;
@@ -131,8 +132,9 @@ final class SearchAction
         $database = $dataset->getProject()->getDatabase();
         $decryptedPassword = $this->decryptData($database->getPassword());
         $connection = $this->dcf->create($database, $decryptedPassword);
+        $this->operatorFactory->setDatabasePlatform($connection->getDatabasePlatform());
+        
         $queryBuilder = $connection->createQueryBuilder();
-
         $queryBuilder->from($dataset->getTableRef());
 
         try {
@@ -156,7 +158,7 @@ final class SearchAction
                 }
     
                 $result = $this->fetchAll($queryBuilder, $attributes);
-            } else if ($searchType === 'meta') {
+            } elseif ($searchType === 'meta') {
                 $queryBuilder->select('COUNT(*) as nb');
                 $stmt = $queryBuilder->execute();
                 $count = $stmt->fetchAll();
@@ -183,7 +185,7 @@ final class SearchAction
 
         $this->logger->info('SQL: ' . $queryBuilder->getSQL());
 
-        return $response->withJson($result, 200, JSON_NUMERIC_CHECK);
+        return $response->withJson($result, 200, JSON_NUMERIC_CHECK | JSON_UNESCAPED_SLASHES);
     }
 
     private function getAndVerifySearchType(string $type)
@@ -221,7 +223,13 @@ final class SearchAction
             } else {
                 $values = array();
             }
-            $operator = $this->operatorFactory->create($params[1], $queryBuilder->expr(), $column, $columnType, $values);
+            $operator = $this->operatorFactory->create(
+                $params[1],
+                $queryBuilder->expr(),
+                $column,
+                $columnType,
+                $values
+            );
             $expressions[] = $operator->getExpression();
         }
         $queryBuilder->where(new CompositeExpression(CompositeExpression::TYPE_AND, $expressions));
@@ -237,7 +245,7 @@ final class SearchAction
             $attribute = $this->getAttribute($dataset, (int) $o[0]);
             if ($o[1] === 'a') {
                 $aord = 'ASC';
-            } else if ($o[1] === 'd') {
+            } elseif ($o[1] === 'd') {
                 $aord = 'DESC';
             } else {
                 throw SearchException::typeOfOrderDoesNotExist($o[1]);
@@ -278,9 +286,9 @@ final class SearchAction
 
     private function getAttributesOfTypeJson(array $attributes): array
     {
-        return array_map(function($attribute) {
+        return array_map(function ($attribute) {
             return $attribute->getLabel();
-        }, array_filter($attributes, function($attribute) {
+        }, array_filter($attributes, function ($attribute) {
             return $attribute->getType() === 'json';
         }));
     }

src/Middleware/CorsMiddleware.php

@@ -19,9 +19,10 @@ class CorsMiddleware
     public function __invoke(Request $req, Response $res, $next)
     {
         if ($req->isOptions()) {
+            $acah = 'X-Requested-With, Content-Type, Accept, Origin, Authorization';
             $response = $res
                 ->withHeader('Access-Control-Allow-Origin', '*')
-                ->withHeader('Access-Control-Allow-Headers', 'X-Requested-With, Content-Type, Accept, Origin, Authorization');
+                ->withHeader('Access-Control-Allow-Headers', $acah);
         } else {
             $response = $res
                 ->withHeader('Access-Control-Allow-Origin', '*')

src/Utils/ActionTrait.php

@@ -39,7 +39,8 @@ trait ActionTrait
         $iv = openssl_random_pseudo_bytes(openssl_cipher_iv_length('aes-256-cbc'));
         // Encrypt the data using AES 256 encryption in CBC mode using our encryption key and initialization vector.
         $encrypted = openssl_encrypt($data, 'aes-256-cbc', $this->encryptionKey, 0, $iv);
-        // The $iv is just as important as the key for decrypting, so save it with our encrypted data using a unique separator (::)
+        // The $iv is just as important as the key for decrypting
+        // So save it with our encrypted data using a unique separator (::)
         return base64_encode($encrypted . '::' . $iv);
     }
 

src/Utils/Operator/Between.php

@@ -18,8 +18,13 @@ class Between extends Operator
     private $value1;
     private $value2;
 
-    public function __construct(ExpressionBuilder $expr, string $column, string $columnType, string $value1, string $value2)
-    {
+    public function __construct(
+        ExpressionBuilder $expr,
+        string $column,
+        string $columnType,
+        string $value1,
+        string $value2
+    ) {
         parent::__construct($expr, $column, $columnType);
         $this->verifyTypeCompatibility($value1);
         $this->verifyTypeCompatibility($value2);

src/Utils/Operator/IOperatorFactory.php

@@ -14,5 +14,11 @@ use Doctrine\DBAL\Query\Expression\ExpressionBuilder;
 
 interface IOperatorFactory
 {
-    public function create(string $type, ExpressionBuilder $expr, string $column, string $columnType, array $parameters): IOperator;
+    public function create(
+        string $type,
+        ExpressionBuilder $expr,
+        string $column,
+        string $columnType,
+        array $parameters
+    ): IOperator;
 }

src/Utils/Operator/JsonPostgres.php

+<?php declare(strict_types=1);
+/*
+ * This file is part of ANIS SERVER API.
+ *
+ * (c) François Agneray <francois.agneray@lam.fr>
+ * (c) Chrystel Moreau <chrystel.moreau@lam.fr>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace App\Utils\Operator;
+
+use Doctrine\DBAL\Query\Expression\ExpressionBuilder;
+use Doctrine\DBAL\Query\Expression\CompositeExpression;
+
+class JsonPostgres extends Operator
+{
+    private $path;
+    private $operator;
+    private $value;
+
+    public function __construct(
+        ExpressionBuilder $expr,
+        string $column,
+        string $columnType,
+        string $path,
+        string $operator,
+        string $value
+    ) {
+        parent::__construct($expr, $column, $columnType);
+        $this->path = explode(',', $path);
+        $this->operator = $operator;
+        $this->value = $value;
+    }
+
+    public function getExpression(): string
+    {
+        switch ($this->operator) {
+            case 'eq':
+                return $this->expr->eq($this->getColumn(), $this->getValue());
+                break;
+            case 'gt':
+                return $this->expr->gt($this->getColumn(), $this->getValue());
+                break;
+            case 'gte':
+                return $this->expr->gte($this->getColumn(), $this->getValue());
+                break;
+            case 'lt':
+                return $this->expr->lt($this->getColumn(), $this->getValue());
+                break;
+            case 'lte':
+                return $this->expr->lte($this->getColumn(), $this->getValue());
+                break;
+        }
+    }
+
+    private function getColumn(): string
+    {
+        return $this->column . '->' . implode('->', array_map(array($this, 'getSqlValue'), $this->path));
+    }
+
+    private function getValue()
+    {
+        if (is_numeric($this->value)) {
+            $newValue = 1 * $this->value;
+        } elseif ($this->value === 'true') {
+            $newValue = true;
+        } elseif ($this->value === 'false') {
+            $newValue = false;
+        } else {
+            $newValue = $this->value;
+        }
+        
+        return $this->getSqlValue(json_encode($newValue));
+    }
+}

src/Utils/Operator/OperatorException.php

@@ -38,4 +38,14 @@ class OperatorException extends SearchException
     {
         return new self("You passed a string value '" . $value . "' or the criterion value required a numeric value");
     }
+
+    public static function operatorJsonNotSupported()
+    {
+        return new self("Operator json is not supported by the database platform used");
+    }
+
+    public static function operatorJsonNeedColumnTypeJson()
+    {
+        return new self("Operator js need a json attribute type");
+    }
 }

src/Utils/Operator/OperatorFactory.php

@@ -10,12 +10,26 @@
  */
 namespace App\Utils\Operator;
 
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Platforms\PostgreSQL94Platform;
 use Doctrine\DBAL\Query\Expression\ExpressionBuilder;
 
 class OperatorFactory implements IOperatorFactory
 {
-    public function create(string $type, ExpressionBuilder $expr, string $column, string $columnType, array $parameters): IOperator
+    private $databasePlatform;
+    
+    public function setDatabasePlatform(AbstractPlatform $databasePlatform)
     {
+        $this->databasePlatform = $databasePlatform;
+    }
+
+    public function create(
+        string $type,
+        ExpressionBuilder $expr,
+        string $column,
+        string $columnType,
+        array $parameters
+    ): IOperator {
         switch ($type) {
             case 'bw':
                 if (count($parameters) != 2) {
@@ -85,18 +99,30 @@ class OperatorFactory implements IOperatorFactory
 
             case 'nl':
                 if (count($parameters) != 0) {
-                    throw OperatorException::operatorBadNumberOfParameters($type, 1);
+                    throw OperatorException::operatorBadNumberOfParameters($type, 0);
                 }
                 return new OperatorNull($expr, $column, $columnType);
 
             case 'nnl':
                 if (count($parameters) != 0) {
-                    throw OperatorException::operatorBadNumberOfParameters($type, 1);
+                    throw OperatorException::operatorBadNumberOfParameters($type, 0);
                 }
                 return new OperatorNotNull($expr, $column, $columnType);
 
+            case 'js':
+                if (!($this->databasePlatform instanceof PostgreSQL94Platform)) {
+                    throw OperatorException::operatorJsonNotSupported();
+                }
+                if ($columnType !== 'json') {
+                    throw OperatorException::operatorJsonNeedColumnTypeJson();
+                }
+                if (count($parameters) != 3) {
+                    throw OperatorException::operatorBadNumberOfParameters($type, 3);
+                }
+                return new JsonPostgres($expr, $column, $columnType, $parameters[0], $parameters[1], $parameters[2]);
+
             default:
-                throw OperatorException::unknownOperator($type);
+                throw OperatorException::unknownOperator();
         }
     }
 }

src/dependencies.php

@@ -14,7 +14,11 @@ $container = $app->getContainer();
 
 // Anis Error Handler
 $container['errorHandler'] = function ($c) {
-    return new App\Utils\AnisErrorHandler($c->get('logger'), $c->get('mailer'), (bool) $c->get('settings')['displayErrorDetails']);
+    return new App\Utils\AnisErrorHandler(
+        $c->get('logger'),
+        $c->get('mailer'),
+        (bool) $c->get('settings')['displayErrorDetails']
+    );
 };
 
 // Metamodel database Doctrine 2 Entity Manager
@@ -136,7 +140,12 @@ $container['App\Action\Meta\DatabaseAction'] = function ($c) {
 
 $container['App\Action\Meta\TableListAction'] = function ($c) {
     $settings = $c->get('settings');
-    return new App\Action\Meta\TableListAction($c->get('logger'), $c->get('em'), $c->get('dcf'), $settings['encryption_key']);
+    return new App\Action\Meta\TableListAction(
+        $c->get('logger'),
+        $c->get('em'),
+        $c->get('dcf'),
+        $settings['encryption_key']
+    );
 };
 
 $container['App\Action\Meta\ProjectListAction'] = function ($c) {
@@ -165,7 +174,12 @@ $container['App\Action\Meta\OutputCategoryAction'] = function ($c) {
 
 $container['App\Action\Meta\DatasetListAction'] = function ($c) {
     $settings = $c->get('settings');
-    return new App\Action\Meta\DatasetListAction($c->get('logger'), $c->get('em'), $c->get('dcf'), $settings['encryption_key']);
+    return new App\Action\Meta\DatasetListAction(
+        $c->get('logger'),
+        $c->get('em'),
+        $c->get('dcf'),
+        $settings['encryption_key']
+    );
 };
 
 $container['App\Action\Meta\DatasetAction'] = function ($c) {
@@ -215,5 +229,11 @@ $container['App\Action\Meta\UserAction'] = function ($c) {
 // Search actions
 $container['App\Action\Search\SearchAction'] = function ($c) {
     $settings = $c->get('settings');
-    return new App\Action\Search\SearchAction($c->get('logger'), $c->get('em'), $c->get('dcf'), $c->get('of'), $settings['encryption_key']);
+    return new App\Action\Search\SearchAction(
+        $c->get('logger'),
+        $c->get('em'),
+        $c->get('dcf'),
+        $c->get('of'),
+        $settings['encryption_key']
+    );
 };

src/routes.php

@@ -32,7 +32,11 @@ $app->map(['OPTIONS', 'GET', 'PUT', 'DELETE'], '/metadata/project/{name}', App\A
 $app->map(['OPTIONS', 'GET', 'POST'], '/metadata/family/{type}', App\Action\Meta\FamilyListAction::class);
 $app->map(['OPTIONS', 'GET', 'PUT', 'DELETE'], '/metadata/family/{type}/{id}', App\Action\Meta\FamilyAction::class);
 $app->map(['OPTIONS', 'GET', 'POST'], '/metadata/output-category', App\Action\Meta\OutputCategoryListAction::class);
-$app->map(['OPTIONS', 'GET', 'PUT', 'DELETE'], '/metadata/output-category/{id}', App\Action\Meta\OutputCategoryAction::class);
+$app->map(
+    ['OPTIONS', 'GET', 'PUT', 'DELETE'],
+    '/metadata/output-category/{id}',
+    App\Action\Meta\OutputCategoryAction::class
+);
 $app->map(['OPTIONS', 'GET', 'POST'], '/metadata/dataset', App\Action\Meta\DatasetListAction::class);
 $app->map(['OPTIONS', 'GET', 'PUT', 'DELETE'], '/metadata/dataset/{name}', App\Action\Meta\DatasetAction::class);
 $app->map(['OPTIONS', 'GET'], '/metadata/dataset/{name}/attribute', App\Action\Meta\AttributeListAction::class);