Merge branch 'main' of github.com:mevdschee/php-crud-api into main

Author: mevdschee

README.md

@@ -57,6 +57,7 @@ These are all the configuration options and their default value between brackets
 - "username": Username of the user connecting to the database (no default)
 - "password": Password of the user connecting to the database (no default)
 - "database": Database the connecting is made to (no default)
+- "command": Extra SQL to initialize the database connection (none)
 - "tables": Comma separated list of tables to publish (defaults to 'all')
 - "mapping": Comma separated list of table/column mappings (no mappping)
 - "middlewares": List of middlewares to load (`cors`)
@@ -663,6 +664,7 @@ You can enable the following middleware using the "middlewares" config parameter
 - "multiTenancy": Restricts tenants access in a multi-tenant scenario
 - "pageLimits": Restricts list operations to prevent database scraping
 - "joinLimits": Restricts join parameters to prevent database scraping
+- "textSearch": Search in all text fields with a simple paramater
 - "customization": Provides handlers for request and response customization
 - "json": Support read/write of JSON strings as JSON objects/arrays
 - "xml": Translates all input and output from JSON to XML
@@ -741,6 +743,7 @@ You can tune the middleware behavior using middleware specific configuration par
 - "joinLimits.depth": The maximum depth (length) that is allowed in a join path ("3")
 - "joinLimits.tables": The maximum number of tables that you are allowed to join ("10")
 - "joinLimits.records": The maximum number of records returned for a joined entity ("1000")
+- "textSearch.parameter": The name of the parameter used for the search term ("search")
 - "customization.beforeHandler": Handler to implement request customization ("")
 - "customization.afterHandler": Handler to implement response customization ("")
 - "json.controllers": Controllers to process JSON strings for ("records,geojson")
@@ -1136,6 +1139,28 @@ If you want to allow no more than 10 pages with a maximum of 25 records each, yo
 
 NB: The maximum number of records is also applied when there is no page number specified in the request.
 
+### Search all text fields
+
+You may use the "textSearch" middleware to simplify (wildcard) text searches when listing records. 
+It allows you to specify a "search" parameter using:
+
+    GET /records/posts?search=Hello
+
+It will return all records from "posts" that contain "Hello" in one of their text (typed) fields:
+
+    {
+        "records":[
+            {
+                "id": 1,
+                "title": "Hello world!",
+                "content": "Welcome to the first post.",
+                "created": "2018-03-05T20:12:56Z"
+            }
+        ]
+    }
+
+The example searches the fields "title" or "content" for the substring "Hello".
+
 ### Customization handlers
 
 You may use the "customization" middleware to modify request and response and implement any other functionality.

api.include.php

@@ -3850,6 +3850,11 @@ public function isInteger(): bool
             return in_array($this->type, ['integer', 'bigint', 'smallint', 'tinyint']);
         }
 
+        public function isText(): bool
+        {
+            return in_array($this->type, ['varchar', 'clob']);
+        }
+
         public function setPk($value) /*: void*/
         {
             $this->pk = $value;
@@ -3874,7 +3879,7 @@ public function serialize()
         {
             $json = [
                 'name' => $this->realName,
-                'alias' => $this->name!=$this->realName?$this->name:null,
+                'alias' => $this->name != $this->realName ? $this->name : null,
                 'type' => $this->type,
                 'length' => $this->length,
                 'precision' => $this->precision,
@@ -5555,6 +5560,7 @@ class GenericDB
         private $address;
         private $port;
         private $database;
+        private $command;
         private $tables;
         private $mapping;
         private $username;
@@ -5585,22 +5591,30 @@ private function getCommands(): array
         {
             switch ($this->driver) {
                 case 'mysql':
-                    return [
+                    $commands = [
                         'SET SESSION sql_warnings=1;',
                         'SET NAMES utf8mb4;',
                         'SET SESSION sql_mode = "ANSI,TRADITIONAL";',
                     ];
+                    break;
                 case 'pgsql':
-                    return [
+                    $commands = [
                         "SET NAMES 'UTF8';",
                     ];
+                    break;
                 case 'sqlsrv':
-                    return [];
+                    $commands = [];
+                    break;
                 case 'sqlite':
-                    return [
+                    $commands = [
                         'PRAGMA foreign_keys = on;',
                     ];
+                    break;
+            }
+            if ($this->command != '') {
+                $commands[] = $this->command;
             }
+            return $commands;
         }
 
         private function getOptions(): array
@@ -5647,20 +5661,21 @@ private function initPdo(): bool
             return $result;
         }
 
-        public function __construct(string $driver, string $address, int $port, string $database, array $tables, array $mapping, string $username, string $password)
+        public function __construct(string $driver, string $address, int $port, string $database, string $command, array $tables, array $mapping, string $username, string $password)
         {
             $this->driver = $driver;
             $this->address = $address;
             $this->port = $port;
             $this->database = $database;
+            $this->command = $command;
             $this->tables = $tables;
             $this->mapping = $mapping;
             $this->username = $username;
             $this->password = $password;
             $this->initPdo();
         }
 
-        public function reconstruct(string $driver, string $address, int $port, string $database, array $tables, array $mapping, string $username, string $password): bool
+        public function reconstruct(string $driver, string $address, int $port, string $database, string $command, array $tables, array $mapping, string $username, string $password): bool
         {
             if ($driver) {
                 $this->driver = $driver;
@@ -5674,6 +5689,9 @@ public function reconstruct(string $driver, string $address, int $port, string $
             if ($database) {
                 $this->database = $database;
             }
+            if ($command) {
+                $this->command = $command;
+            }
             if ($tables) {
                 $this->tables = $tables;
             }
@@ -8845,6 +8863,15 @@ private function getDatabase(): string
             return '';
         }
 
+        private function getCommand(): string
+        {
+            $commandHandler = $this->getProperty('commandHandler', '');
+            if ($commandHandler) {
+                return call_user_func($commandHandler);
+            }
+            return '';
+        }
+
         private function getTables(): array
         {
             $tablesHandler = $this->getProperty('tablesHandler', '');
@@ -8887,12 +8914,13 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
             $address = $this->getAddress();
             $port = $this->getPort();
             $database = $this->getDatabase();
+            $command = $this->getCommand();
             $tables = $this->getTables();
             $mapping = $this->getMapping();
             $username = $this->getUsername();
             $password = $this->getPassword();
-            if ($driver || $address || $port || $database || $tables || $mapping || $username || $password) {
-                $this->db->reconstruct($driver, $address, $port, $database, $tables, $mapping, $username, $password);
+            if ($driver || $address || $port || $database || $command || $tables || $mapping || $username || $password) {
+                $this->db->reconstruct($driver, $address, $port, $database, $command, $tables, $mapping, $username, $password);
             }
             return $next->handle($request);
         }
@@ -9079,6 +9107,61 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
     }
 }
 
+// file: src/Tqdev/PhpCrudApi/Middleware/TextSearchMiddleware.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;
+
+    class TextSearchMiddleware extends Middleware
+    {
+        private $reflection;
+
+        public function __construct(Router $router, Responder $responder, array $properties, ReflectionService $reflection)
+        {
+            parent::__construct($router, $responder, $properties);
+            $this->reflection = $reflection;
+        }
+
+        public function process(ServerRequestInterface $request, RequestHandlerInterface $next): ResponseInterface
+        {
+            $operation = RequestUtils::getOperation($request);
+            if ($operation == 'list') {
+                $tableName = RequestUtils::getPathSegment($request, 2);
+                $params = RequestUtils::getParams($request);
+                $parameterName = $this->getProperty('parameter', 'search');
+                if (isset($params[$parameterName])) {
+                    $search = $params[$parameterName][0];
+                    unset($params[$parameterName]);
+                    $table = $this->reflection->getTable($tableName);
+                    $i = 0;
+                    foreach ($table->getColumnNames() as $columnName) {
+                        $column = $table->getColumn($columnName);
+                        while (isset($params["filter$i"])) {
+                            $i++;
+                        }
+                        if ($i >= 10) {
+                            break;
+                        }
+                        if ($column->isText()) {
+                            $params["filter$i"] = "$columnName,cs,$search";
+                            $i++;
+                        }
+                    }
+                }
+                $request = RequestUtils::setParams($request, $params);
+            }
+            return $next->handle($request);
+        }
+    }
+}
+
 // file: src/Tqdev/PhpCrudApi/Middleware/ValidationMiddleware.php
 namespace Tqdev\PhpCrudApi\Middleware {
 
@@ -11526,6 +11609,7 @@ private function setHabtmValues(ReflectedTable $t1, ReflectedTable $t2, array &$
     use Tqdev\PhpCrudApi\Middleware\Router\SimpleRouter;
     use Tqdev\PhpCrudApi\Middleware\SanitationMiddleware;
     use Tqdev\PhpCrudApi\Middleware\SslRedirectMiddleware;
+    use Tqdev\PhpCrudApi\Middleware\TextSearchMiddleware;
     use Tqdev\PhpCrudApi\Middleware\ValidationMiddleware;
     use Tqdev\PhpCrudApi\Middleware\XmlMiddleware;
     use Tqdev\PhpCrudApi\Middleware\XsrfMiddleware;
@@ -11545,6 +11629,7 @@ public function __construct(Config $config)
                 $config->getAddress(),
                 $config->getPort(),
                 $config->getDatabase(),
+                $config->getCommand(),
                 $config->getTables(),
                 $config->getMapping(),
                 $config->getUsername(),
@@ -11611,6 +11696,9 @@ public function __construct(Config $config)
                     case 'customization':
                         new CustomizationMiddleware($router, $responder, $config, $middleware, $reflection);
                         break;
+                    case 'textSearch':
+                        new TextSearchMiddleware($router, $responder, $properties, $reflection);
+                        break;
                     case 'xml':
                         new XmlMiddleware($router, $responder, $config, $middleware, $reflection);
                         break;
@@ -11730,6 +11818,7 @@ class Config
             'username' => '',
             'password' => '',
             'database' => '',
+            'command' => '',
             'tables' => '',
             'mapping' => '',
             'middlewares' => 'cors,errors',
@@ -11860,6 +11949,11 @@ public function getDatabase(): string
             return $this->values['database'];
         }
 
+        public function getCommand(): string
+        {
+            return $this->values['command'];
+        }
+
         public function getTables(): array
         {
             return array_filter(array_map('trim', explode(',', $this->values['tables'])));