Implement Required (CO-2134) and Crosscheck (CO-1763) on RuleAttribute

app/config/schema/schema.json

@@ -142,7 +142,6 @@
         "case_sensitive": { "type": "boolean" },
         "invalidates": { "type": "boolean" },
         "null_equivalents": { "type": "boolean" },
-        "required": { "type": "boolean" },
         "search_distance": { "type": "integer" },
         "search_exact": { "type": "boolean" },
         "search_substr_from": { "type": "integer" },
@@ -183,7 +182,9 @@
         "id": {},
         "rule_id": { "type": "integer", "foreignkey": { "table": "rules", "column": "id" } },
         "attribute_id": { "type": "integer", "foreignkey": { "table": "attributes", "column": "id" } },
-        "search_type": { "type": "string", "size": 2 }
+        "crosscheck_attribute_id": { "type": "integer", "foreignkey": { "table": "attributes", "column": "id" } },
+        "search_type": { "type": "string", "size": 2 },
+        "required": { "type": "boolean" }
       },
       "indexes": {
         "rule_attributes_i1": {
@@ -192,6 +193,10 @@
         "rule_attributes_i2": {
           "comment": "We don't really need this index but DBAL will create it anyway, with a random name",
           "columns": [ "attribute_id" ]
+        },
+        "rule_attributes_i3": {
+          "comment": "We don't really need this index but DBAL will create it anyway, with a random name",
+          "columns": [ "crosscheck_attribute_id" ]
         }
       },
       "changelog": false

app/src/Controller/ApiUsersController.php

@@ -19,7 +19,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * @link          http://www.internet2.edu/comanage COmanage Project
+ * @link          https://www.internet2.edu/comanage COmanage Project
  * @package       match
  * @since         COmanage Match v1.0.0
  * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
@@ -32,7 +32,7 @@
 use Cake\Routing\Router;
 
 class ApiUsersController extends StandardController {
-  public $paginate = [
+  public $pagination = [
     'order' => [
       'ApiUsers.username' => 'asc'
     ]

app/src/Controller/AttributeGroupsController.php

@@ -19,7 +19,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * @link          http://www.internet2.edu/comanage COmanage Project
+ * @link          https://www.internet2.edu/comanage COmanage Project
  * @package       match
  * @since         COmanage Match v1.0.0
  * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
@@ -30,7 +30,7 @@
 namespace App\Controller;
 
 class AttributeGroupsController extends StandardController {
-  public $paginate = [
+  public $pagination = [
     'order' => [
       'AttributeGroups.name' => 'asc'
     ]

app/src/Controller/AttributeMappingsController.php

@@ -19,7 +19,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * @link          http://www.internet2.edu/comanage COmanage Project
+ * @link          https://www.internet2.edu/comanage COmanage Project
  * @package       match
  * @since         COmanage Match v1.0.0
  * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
@@ -30,7 +30,7 @@
 namespace App\Controller;
 
 class AttributeMappingsController extends StandardController {
-  public $paginate = [
+  public $pagination = [
     'order' => [
       'AttributeMappings.query' => 'asc',
       'AttributeMappings.value' => 'asc'

app/src/Controller/AttributeMapsController.php

@@ -19,7 +19,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * @link          http://www.internet2.edu/comanage COmanage Project
+ * @link          https://www.internet2.edu/comanage COmanage Project
  * @package       match
  * @since         COmanage Match v1.0.0
  * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
@@ -30,7 +30,7 @@
 namespace App\Controller;
 
 class AttributeMapsController extends StandardController {
-  public $paginate = [
+  public $pagination = [
     'order' => [
       'AttributeMaps.name' => 'asc'
     ]

app/src/Controller/AttributesController.php

@@ -19,7 +19,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * @link          http://www.internet2.edu/comanage COmanage Project
+ * @link          https://www.internet2.edu/comanage COmanage Project
  * @package       match
  * @since         COmanage Match v1.0.0
  * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
@@ -30,7 +30,7 @@
 namespace App\Controller;
 
 class AttributesController extends StandardController {
-  public $paginate = [
+  public $pagination = [
     'order' => [
       'Attributes.name' => 'asc'
     ]

app/src/Controller/MatchgridRecordsController.php

@@ -19,7 +19,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * @link          http://www.internet2.edu/comanage COmanage Project
+ * @link          https://www.internet2.edu/comanage COmanage Project
  * @package       match
  * @since         COmanage Match v1.0.0
  * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
@@ -38,7 +38,7 @@
 use \App\Lib\Match\MatchService;
 
 class MatchgridRecordsController extends StandardController {
-  public $paginate = [
+  public $pagination = [
     'order' => [
       'sor' => 'asc',
       'sorid' => 'asc',

app/src/Controller/MatchgridSettingsController.php

@@ -19,7 +19,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * @link          http://www.internet2.edu/comanage COmanage Project
+ * @link          https://www.internet2.edu/comanage COmanage Project
  * @package       match
  * @since         COmanage Match v1.0.0
  * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
@@ -30,7 +30,7 @@
 namespace App\Controller;
 
 class MatchgridSettingsController extends StandardController {
-  public $paginate = [
+  public $pagination = [
     'order' => [
       'MatchgridSetting.matchgrid_id' => 'asc'
     ]

app/src/Controller/MatchgridsController.php

@@ -19,7 +19,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * @link          http://www.internet2.edu/comanage COmanage Project
+ * @link          https://www.internet2.edu/comanage COmanage Project
  * @package       match
  * @since         COmanage Match v1.0.0
  * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
@@ -33,7 +33,7 @@
 use \App\Lib\Enum\PermissionEnum;
 
 class MatchgridsController extends StandardController {
-  public $paginate = [
+  public $pagination = [
     'order' => [
       'Matchgrids.table_name' => 'asc'
     ]

app/src/Controller/PermissionsController.php

@@ -19,7 +19,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * @link          http://www.internet2.edu/comanage COmanage Project
+ * @link          https://www.internet2.edu/comanage COmanage Project
  * @package       match
  * @since         COmanage Match v1.0.0
  * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
@@ -30,10 +30,15 @@
 namespace App\Controller;
 
 class PermissionsController extends StandardController {
-  public $paginate = [
+  public $pagination = [
     'order' => [
       'Matchgrids.table_name' => 'asc',
       'Permissions.name' => 'asc'
+    ],
+// 'sortWhitelist' is renamed 'sortableFields' in Cake 4.1
+//    'sortableFields' => [
+    'sortWhitelist' => [
+      'Matchgrids.table_name'
     ]
   ];
 

app/src/Controller/RuleAttributesController.php

@@ -0,0 +1,69 @@
+<?php
+/**
+ * COmanage Match Rule Attributes Mappings Controller
+ *
+ * Portions licensed to the University Corporation for Advanced Internet
+ * Development, Inc. ("UCAID") under one or more contributor license agreements.
+ * See the NOTICE file distributed with this work for additional information
+ * regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with the
+ * License. You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @link          https://www.internet2.edu/comanage COmanage Project
+ * @package       match
+ * @since         COmanage Match v1.0.0
+ * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
+ */
+
+declare(strict_types = 1);
+
+namespace App\Controller;
+
+class RuleAttributesController extends StandardController {
+  public $pagination = [
+    'order' => [
+      'Attributes.name' => 'asc'
+    ],
+// 'sortWhitelist' is renamed 'sortableFields' in Cake 4.1
+//    'sortableFields' => [
+    'sortWhitelist' => [
+      'Attributes.name'
+    ]
+  ];
+
+  /**
+   * Authorization for this Controller, called by Auth component
+   * - postcondition: $vv_permissions set with calculated permissions for this Controller
+   *
+   * @since  COmanage Match v1.0.0
+   * @param  Array   $user Array of user data
+   * @return Boolean True if authorized for the current action, false otherwise
+   */
+
+  public function isAuthorized(Array $user) {
+    $platformAdmin = $this->Authorization->isPlatformAdmin($user['username']);
+
+    $mgAdmin = $this->Authorization->isMatchAdmin($user['username'], $this->cur_mg->id);
+
+    $p = [
+      'add'       => $platformAdmin || $mgAdmin,
+      'delete'    => $platformAdmin || $mgAdmin,
+      'edit'      => $platformAdmin || $mgAdmin,
+      'index'     => $platformAdmin || $mgAdmin,
+      'view'      => false
+    ];
+
+    $this->set('vv_permissions', $p);
+    return $p[$this->request->getParam('action')];
+  }
+}

app/src/Controller/RulesController.php

@@ -19,7 +19,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * @link          http://www.internet2.edu/comanage COmanage Project
+ * @link          https://www.internet2.edu/comanage COmanage Project
  * @package       match
  * @since         COmanage Match v1.0.0
  * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
@@ -30,7 +30,7 @@
 namespace App\Controller;
 
 class RulesController extends StandardController {
-  public $paginate = [
+  public $pagination = [
     'order' => [
       'Rules.confidence_mode' => 'asc',
       'Rules.ordr' => 'asc'

app/src/Controller/StandardController.php

@@ -32,6 +32,9 @@
 use InvalidArgumentException;
 
 class StandardController extends AppController {
+  // Pagination defaults should be set in each controller
+  public $pagination = [];
+
   /**
    * Handle an add action for a Standard object.
    *
@@ -223,8 +226,10 @@ public function generateRedirect() {
   public function index() {
     // $this->name = Models
     $modelsName = $this->name;
+    // $table = the actual table object
+    $table = $this->$modelsName;
     // $tableName = models
-    $tableName = $this->$modelsName->getTable();
+    $tableName = $table->getTable();
 
     $query = null;
 
@@ -239,10 +244,10 @@ public function index() {
     if(!empty($link['linkattr']) && $modelsName != 'MatchgridRecords') {
       // If a link attribute is defined but no value is provided, then query
       // where the link attribute is NULL
-      $query = $this->$modelsName->find()->where([$link['linkattr'].' IS' => $this->request->getQuery($link['linkattr'])]);
+      $query = $table->find()->where([$link['linkattr'].' IS' => $this->request->getQuery($link['linkattr'])]);
     } else {
       try {
-        $query = $this->$modelsName->find();
+        $query = $table->find();
       }
       catch(\Cake\Database\Exception $e) {
         if($modelsName == 'MatchgridRecords' && $e->getCode() == 500) {
@@ -257,7 +262,17 @@ public function index() {
       }
     }
 
-    $this->set($tableName, $this->Paginator->paginate($query, $this->paginate));
+    // QueryModificationTrait
+    if(method_exists($table, "getIndexContains")
+       && $table->getIndexContains()) {
+      $query->contain($table->getIndexContains());
+    }
+
+    // The Cake documents describe $this->paginate (which worked in Cake 2),
+    // but it doesn't seem to work in Cake 3/4. So we just use $this->pagination
+    // ourselves here.
+
+    $this->set($tableName, $this->Paginator->paginate($query, $this->pagination));
     $this->set('vv_tablename', $tableName);
     $this->set('vv_modelname', $modelsName);
 
@@ -333,9 +348,16 @@ protected function populateAutoViewVars(object $obj=null) {
 // XXX also need to check getData()?
                   
                   if($v) {
-                    $query = $query->find($avv['find'], [$linkFilter => $v]);
+                    $query = $query->where([$linkFilter => $v]);
                   }
                 }
+              } elseif($avv['find'] == 'filterMatchgrid') {
+                // In many/most cases, filterPrimaryLink is also filterMatchgrid,
+                // but for indirect models this will force the filter to be on
+                // the matchgrid instead of the primary link
+
+                // For now we only support direct relations to matchgrid
+                $query->where(['matchgrid_id' => $this->cur_mg->id]);
               } else {
                 // Use the specified finder, if configured
                 $query = $query->find($avv['find']);

app/src/Controller/SystemsOfRecordController.php

@@ -19,7 +19,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * @link          http://www.internet2.edu/comanage COmanage Project
+ * @link          https://www.internet2.edu/comanage COmanage Project
  * @package       match
  * @since         COmanage Match v1.0.0
  * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
@@ -30,7 +30,7 @@
 namespace App\Controller;
 
 class SystemsOfRecordController extends StandardController {
-  public $paginate = [
+  public $pagination = [
     'order' => [
       'SystemsOfRecord.label' => 'asc'
     ]