Add IpAddress middleware for #519

README.md

@@ -195,7 +195,8 @@ You can tune the middleware behavior using middleware specific configuration par
 - "authorization.columnHandler": Handler to implement column authorization rules ("")
 - "authorization.recordHandler": Handler to implement record authorization filter rules ("")
 - "validation.handler": Handler to implement validation rules for input values ("")
-- "ipAddress.column": Column to protect and override with the IP address on create ("")
+- "ipAddress.tables": Tables to search for columns to override with IP address ("")
+- "ipAddress.columns": Columns to protect and override with the IP address on create ("")
 - "sanitation.handler": Handler to implement sanitation rules for input values ("")
 - "multiTenancy.handler": Handler to implement simple multi-tenancy rules ("")
 - "pageLimits.pages": The maximum page number that a list operation allows ("100")

api.php

@@ -3264,12 +3264,16 @@ class IpAddressMiddleware extends Middleware
     private function callHandler($record, String $operation, ReflectedTable $table) /*: object */
     {
         $context = (array) $record;
-        $columnName = $this->getProperty('column', '');
-        if ($table->hasColumn($columnName)) {
-            if ($operation == 'create') {
-                $context[$columnName] = $_SERVER['REMOTE_ADDR'];
-            } else {
-                unset($context[$columnName]);
+        $columnNames = $this->getProperty('columns', '');
+        if ($columnNames) {
+            foreach (explode(',', $columnNames) as $columnName) {
+                if ($table->hasColumn($columnName)) {
+                    if ($operation == 'create') {
+                        $context[$columnName] = $_SERVER['REMOTE_ADDR'];
+                    } else {
+                        unset($context[$columnName]);
+                    }
+                }
             }
         }
         return (object) $context;
@@ -3279,19 +3283,22 @@ class IpAddressMiddleware extends Middleware
     {
         $operation = $this->utils->getOperation($request);
         if (in_array($operation, ['create', 'update', 'increment'])) {
+            $tableNames = $this->getProperty('tables', '');
             $tableName = $request->getPathSegment(2);
-            if ($this->reflection->hasTable($tableName)) {
-                $record = $request->getBody();
-                if ($record !== null) {
-                    $table = $this->reflection->getTable($tableName);
-                    if (is_array($record)) {
-                        foreach ($record as &$r) {
-                            $r = $this->callHandler($r, $operation, $table);
+            if (!$tableNames || in_array($tableName, explode(',', $tableNames))) {
+                if ($this->reflection->hasTable($tableName)) {
+                    $record = $request->getBody();
+                    if ($record !== null) {
+                        $table = $this->reflection->getTable($tableName);
+                        if (is_array($record)) {
+                            foreach ($record as &$r) {
+                                $r = $this->callHandler($r, $operation, $table);
+                            }
+                        } else {
+                            $record = $this->callHandler($record, $operation, $table);
                         }
-                    } else {
-                        $record = $this->callHandler($record, $operation, $table);
+                        $request->setBody($record);
                     }
-                    $request->setBody($record);
                 }
             }
         }
@@ -3958,6 +3965,13 @@ class OpenApiBuilder
                 foreach ($properties as $key => $value) {
                     $this->openapi->set("$prefix|properties|$columnName|$key", $value);
                 }
+                if ($column->getPk()) {
+                    $this->openapi->set("$prefix|properties|$columnName|x-primary-key", true);
+                }
+                $fk = $column->getFk();
+                if ($fk) {
+                    $this->openapi->set("$prefix|properties|$columnName|x-references", $fk);
+                }
             }
         }
     }

src/Tqdev/PhpCrudApi/Middleware/IpAddressMiddleware.php

@@ -24,12 +24,16 @@ class IpAddressMiddleware extends Middleware
     private function callHandler($record, String $operation, ReflectedTable $table) /*: object */
     {
         $context = (array) $record;
-        $columnName = $this->getProperty('column', '');
-        if ($table->hasColumn($columnName)) {
-            if ($operation == 'create') {
-                $context[$columnName] = $_SERVER['REMOTE_ADDR'];
-            } else {
-                unset($context[$columnName]);
+        $columnNames = $this->getProperty('columns', '');
+        if ($columnNames) {
+            foreach (explode(',', $columnNames) as $columnName) {
+                if ($table->hasColumn($columnName)) {
+                    if ($operation == 'create') {
+                        $context[$columnName] = $_SERVER['REMOTE_ADDR'];
+                    } else {
+                        unset($context[$columnName]);
+                    }
+                }
             }
         }
         return (object) $context;
@@ -39,19 +43,22 @@ class IpAddressMiddleware extends Middleware
     {
         $operation = $this->utils->getOperation($request);
         if (in_array($operation, ['create', 'update', 'increment'])) {
+            $tableNames = $this->getProperty('tables', '');
             $tableName = $request->getPathSegment(2);
-            if ($this->reflection->hasTable($tableName)) {
-                $record = $request->getBody();
-                if ($record !== null) {
-                    $table = $this->reflection->getTable($tableName);
-                    if (is_array($record)) {
-                        foreach ($record as &$r) {
-                            $r = $this->callHandler($r, $operation, $table);
+            if (!$tableNames || in_array($tableName, explode(',', $tableNames))) {
+                if ($this->reflection->hasTable($tableName)) {
+                    $record = $request->getBody();
+                    if ($record !== null) {
+                        $table = $this->reflection->getTable($tableName);
+                        if (is_array($record)) {
+                            foreach ($record as &$r) {
+                                $r = $this->callHandler($r, $operation, $table);
+                            }
+                        } else {
+                            $record = $this->callHandler($record, $operation, $table);
                         }
-                    } else {
-                        $record = $this->callHandler($record, $operation, $table);
+                        $request->setBody($record);
                     }
-                    $request->setBody($record);
                 }
             }
         }

src/Tqdev/PhpCrudApi/OpenApi/OpenApiBuilder.php

@@ -198,6 +198,13 @@ class OpenApiBuilder
                 foreach ($properties as $key => $value) {
                     $this->openapi->set("$prefix|properties|$columnName|$key", $value);
                 }
+                if ($column->getPk()) {
+                    $this->openapi->set("$prefix|properties|$columnName|x-primary-key", true);
+                }
+                $fk = $column->getFk();
+                if ($fk) {
+                    $this->openapi->set("$prefix|properties|$columnName|x-references", $fk);
+                }
             }
         }
     }