VPN: IPsec: Security Policy Database - extend ModelRelationField so it can optionally disable caching. closes #9365

In some cases caching can be problematic, for example when rows are dynamically generated or when the cache is persisted while the model hasn't reached it final state yet.
The latter seems to be the case here. When referring connection, we actually mean the description of the related field, which may not be persisted in the model yet as an earlier field triggered the data to be stored (locals.local.connection for example).

This commit adds "DisableCache" as ModelRelationField option and uses it in SPDs.SPD.connection_child

Author: AdSchellevis

src/opnsense/mvc/app/models/OPNsense/Base/FieldTypes/ModelRelationField.php

@@ -51,6 +51,8 @@ class ModelRelationField extends BaseListField
       */
     private $internalOptionsFromThisModel = false;
 
+    private $internalDisableCache = false;
+
     /**
      * @var string cache relations
      */
@@ -76,7 +78,7 @@ public function getCachedData($classname, $path, $force = false)
         if (!class_exists($classname)) {
             return []; /* not found */
         }
-        if (!isset(self::$internalCacheModelStruct[$classname]) || $force) {
+        if ($this->internalDisableCache || !isset(self::$internalCacheModelStruct[$classname]) || $force) {
             $pmodel = $this->getParentModel();
             if ($pmodel !== null && strcasecmp(get_class($pmodel), $classname) === 0) {
                 // model options from the same model, use this model instead of creating something new
@@ -165,6 +167,20 @@ public function setModel($mdlStructure)
         }
     }
 
+    /**
+     * Disable caching and force a model reload, this can be useful in cases where multiple layers of generated
+     * fields stack on each other which are dependent or if the related model has dynamically generated items.
+     * (in which case the persisted_at attribute doesn't tell the full story)
+     *
+     * @param $value boolean value Y/N
+     */
+    public function setDisableCache($value)
+    {
+        $this->internalDisableCache = trim(strtoupper($value)) == "Y";
+    }
+
+
+
     /**
      * load model options when initialized
      */

src/opnsense/mvc/app/models/OPNsense/IPsec/Swanctl.xml

@@ -418,6 +418,7 @@
                     <MaximumValue>65535</MaximumValue>
                 </reqid>
                 <connection_child type="ModelRelationField">
+                    <DisableCache>Y</DisableCache>
                     <Model>
                         <host>
                             <source>OPNsense.IPsec.Swanctl</source>