[3.x-migration] Cerebrates (#9507)

* new: [Cerebrates] pullOrgs, pullSgs test

* fix: [AppController] fix bug in harvestParameters()

* fix: [Cerebrate] follow codingstyle

* fix: [Cerebrate] more codingstyle

* fix: [Cerebrates] strict types fixes

* fix: [composer] slevomat coding-standard

* fix: [Cerebrates] minor codestyle fix

* fix: [codingstyle]

src/Controller/AppController.php

@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 /**
@@ -51,7 +50,9 @@ class AppController extends Controller
     public $MetaTemplates = null;
     public $Users = null;
 
-    /** @var AuditLog|null */
+    /**
+     * @var \Model\Entity\AuditLog|null
+     */
     protected $AuditLogs = null;
 
     /**
@@ -73,7 +74,7 @@ class AppController extends Controller
         $this->loadComponent(
             'ParamHandler',
             [
-                'request' => $this->request
+                'request' => $this->request,
             ]
         );
         $this->loadModel('MetaFields');
@@ -85,7 +86,7 @@ class AppController extends Controller
                 'request' => $this->request,
                 'table' => $table,
                 'MetaFields' => $this->MetaFields,
-                'MetaTemplates' => $this->MetaTemplates
+                'MetaTemplates' => $this->MetaTemplates,
             ]
         );
         $this->loadComponent('Authentication.Authentication');
@@ -93,7 +94,7 @@ class AppController extends Controller
             'ACL',
             [
                 'request' => $this->request,
-                'Authentication' => $this->Authentication
+                'Authentication' => $this->Authentication,
             ]
         );
         $this->loadComponent(
@@ -123,6 +124,12 @@ class AppController extends Controller
         //$this->loadComponent('FormProtection');
     }
 
+    /**
+     * beforeFilter
+     *
+     * @param  \Cake\Event\EventInterface $event the event
+     * @return void
+     */
     public function beforeFilter(EventInterface $event)
     {
         $this->loadModel('Users');
@@ -137,13 +144,14 @@ class AppController extends Controller
             $user = $this->Users->get(
                 $this->request->getAttribute('identity')->getIdentifier(),
                 [
-                    'contain' => ['Roles', 'Organisations' /*'UserSettings'*/]
+                    'contain' => ['Roles', 'Organisations' /*'UserSettings'*/],
                 ]
             );
             $this->__accessMonitor($user->toArray());
             if (!empty($user['disabled'])) {
                 $this->Authentication->logout();
                 $this->Flash->error(__('The user account is disabled.'));
+
                 return $this->redirect(\Cake\Routing\Router::url('/users/login'));
             }
             unset($user['password']);
@@ -157,7 +165,7 @@ class AppController extends Controller
                 $this->set('loggedUser', $this->ACL->getUser());
                 $this->set('roleAccess', $this->ACL->getRoleAccess(false, false));
             }
-        } else if ($this->ParamHandler->isRest()) {
+        } elseif ($this->ParamHandler->isRest()) {
             throw new MethodNotAllowedException(__('Invalid user credentials.'));
         }
 
@@ -199,6 +207,12 @@ class AppController extends Controller
         }
     }
 
+    /**
+     * beforeRender
+     *
+     * @param  \Cake\Event\EventInterface $event the event
+     * @return void
+     */
     public function beforeRender(EventInterface $event)
     {
         if (!empty($this->request->getAttribute('identity'))) {
@@ -210,6 +224,11 @@ class AppController extends Controller
         }
     }
 
+    /**
+     * authApiUser
+     *
+     * @return void
+     */
     private function authApiUser(): void
     {
         if (!empty($_SERVER['HTTP_AUTHORIZATION']) && strlen($_SERVER['HTTP_AUTHORIZATION'])) {
@@ -225,7 +244,7 @@ class AppController extends Controller
                         'model' => 'Users',
                         'model_id' => $user['id'],
                         'model_title' => $user['username'],
-                        'changed' => []
+                        'changed' => [],
                     ]
                 );
                 if (!empty($user)) {
@@ -239,31 +258,50 @@ class AppController extends Controller
                         'model' => 'Users',
                         'model_id' => $user['id'],
                         'model_title' => $user['name'],
-                        'changed' => []
+                        'changed' => [],
                     ]
                 );
             }
         }
     }
 
+    /**
+     * generateUUID
+     *
+     * @return void
+     */
     public function generateUUID()
     {
         $uuid = Text::uuid();
+
         return $this->RestResponse->viewData(['uuid' => $uuid], 'json');
     }
 
+    /**
+     * queryACL
+     *
+     * @return void
+     */
     public function queryACL()
     {
         return $this->RestResponse->viewData($this->ACL->findMissingFunctionNames());
     }
 
+    /**
+     * getRoleAccess
+     *
+     * @return void
+     */
     public function getRoleAccess()
     {
         return $this->RestResponse->viewData($this->ACL->getRoleAccess(false, false));
     }
 
     /**
-     * Convert an array to the same array but with the values also as index instead of an interface_exists
+     * arrayToValuesIndexArray - Convert an array to the same array but with the values also as index instead of an interface_exists
+     *
+     * @param  array $oldArray the original array
+     * @return array
      */
     protected function arrayToValuesIndexArray(array $oldArray): array
     {
@@ -271,10 +309,16 @@ class AppController extends Controller
         foreach ($oldArray as $value) {
             $newArray[$value] = $value;
         }
+
         return $newArray;
     }
 
-    // checks if the currently logged user is a site administrator (an admin that can manage any user or event on the instance and create / edit the roles).
+    /**
+     * isSiteAdmin
+     * checks if the currently logged user is a site administrator (an admin that can manage any user or event on the instance and create / edit the roles).
+     *
+     * @return void
+     */
     protected function isSiteAdmin()
     {
         return $this->ACL->getUser()->Role->perm_site_admin;
@@ -282,34 +326,30 @@ class AppController extends Controller
 
     /**
      * Close session without writing changes to them and return current user.
+     *
      * @return array
      */
     protected function closeSession()
     {
         $user = $this->ACL->getUser();
         session_abort();
+
         return $user->toArray();
     }
 
     /**
      * generic function to standardise on the collection of parameters. Accepts posted request objects, url params, named url params
-     * @param array $options
+     *
-     * @param CakeResponse $exception
+     * @param array $options options
-     * @param array $data
+     * @param mixed $exception exception
+     * @param array $data data
      * @return array|false
      */
     protected function harvestParameters($options, &$exception = null, $data = [])
     {
         $request = $options['request'] ?? $this->request;
         if ($request->is('post')) {
-            if (empty($request->data)) {
+            if (!empty($request->data)) {
-                $exception = $this->RestResponse->throwException(
-                    400,
-                    __('Either specify the search terms in the url, or POST a json with the filter parameters.'),
-                    '/' . $request->params['controller'] . '/' . $request->action
-                );
-                return false;
-            } else {
                 if (isset($request->data['request'])) {
                     $temp = $request->data['request'];
                 } else {
@@ -327,6 +367,14 @@ class AppController extends Controller
                         }
                     }
                 }
+            } elseif (empty($request->data) && !$this->ParamHandler->isRest()) {
+                $exception = $this->RestResponse->throwException(
+                    400,
+                    __('Either specify the search terms in the url, or POST a json with the filter parameters.'),
+                    '/' . $request->params['controller'] . '/' . $request->action
+                );
+
+                return false;
             }
         }
         /*
@@ -385,21 +433,32 @@ class AppController extends Controller
                 }
             }
         }
+
         return $data;
     }
 
+    /**
+     * captureParam
+     *
+     * @param  mixed $data data
+     * @param  mixed $param param
+     * @param  mixed $value value
+     * @return mixed
+     */
     private function captureParam($data, $param, $value)
     {
         $table = $this->getTableLocator()->get($this->defaultModel);
         if ($table->checkParam($param)) {
             $data[$param] = $value;
         }
+
         return $data;
     }
 
     /**
      * Decode JSON with proper error handling.
-     * @param string $dataToDecode
+     *
+     * @param string $dataToDecode data to decode
      * @return mixed
      */
     protected function _jsonDecode($dataToDecode)
@@ -411,6 +470,11 @@ class AppController extends Controller
         }
     }
 
+    /**
+     * setResponseType
+     *
+     * @return static|void
+     */
     private function setResponseType()
     {
         foreach ($this->request->getHeader('Accept') as $accept) {
@@ -426,12 +490,13 @@ class AppController extends Controller
     protected function _remoteIp()
     {
         $ipHeader = Configure::read('MISP.log_client_ip_header') ?: 'REMOTE_ADDR';
+
         return isset($_SERVER[$ipHeader]) ? trim($_SERVER[$ipHeader]) : $_SERVER['REMOTE_ADDR'];
     }
 
     /**
-     * @param array $user
+     * @param array $user affected user
-     * @throws Exception
+     * @throws \Exception
      */
     private function __accessMonitor(array $user)
     {
@@ -450,7 +515,7 @@ class AppController extends Controller
 
         if ($shouldBeLogged) {
             $includeRequestBody = !empty(Configure::read('MISP.log_paranoid_include_post_body')) || $userMonitoringEnabled;
-            /** @var AccessLog $accessLog */
+            /** @var \App\Model\Entity\AccessLog $accessLog */
             $accessLogsTable = $this->fetchTable('AccessLogs');
             $accessLogsTable->logRequest($user, $this->_remoteIp(), $this->request, $includeRequestBody);
         }
@@ -460,7 +525,7 @@ class AppController extends Controller
             $shouldBeLogged
         ) {
             $change = 'HTTP method: ' . $_SERVER['REQUEST_METHOD'] . PHP_EOL . 'Target: ' . $this->request->getAttribute('here');
-            ;
+
             if (
                 (
                     $this->request->is('post') ||

src/Controller/CerebratesController.php

@@ -1,12 +1,10 @@
 <?php
+declare(strict_types=1);
 
 namespace App\Controller;
 
-use App\Controller\AppController;
-use Cake\Core\Configure;
-use Cake\Core\Exception\CakeException;
-use Cake\Http\Exception\NotFoundException;
 use App\Lib\Tools\CustomPaginationTool;
+use Cake\Http\Exception\NotFoundException;
 
 /**
  * Cerebrates Controller
@@ -26,7 +24,7 @@ class CerebratesController extends AppController
         $params = [
             'contain' => ['Organisations'],
             'filters' => ['name', 'url', 'uuid'],
-            'quickFilters' => ['name']
+            'quickFilters' => ['name'],
         ];
         $this->CRUD->index($params);
 
@@ -39,13 +37,14 @@ class CerebratesController extends AppController
     /**
      * View method
      *
-     * @param string|null $id Cerebrate id.
+     * @param int|null $id Cerebrate id.
      * @return \Cake\Http\Response|null|void Renders view
      * @throws \Cake\Datasource\Exception\RecordNotFoundException When record not found.
      */
-    public function view($id = null)
+    public function view(int|null $id = null)
     {
-        $this->CRUD->view($id, 
+        $this->CRUD->view(
+            $id,
             ['contain' => ['Organisations']]
         );
         $responsePayload = $this->CRUD->getResponsePayload();
@@ -70,13 +69,16 @@ class CerebratesController extends AppController
             return $responsePayload;
         }
 
-        $orgs = $this->Cerebrates->Organisations->find('list', [
+        $orgs = $this->Cerebrates->Organisations->find(
-            'recursive' => -1,
+            'list',
-            'fields' => ['id', 'name'],
+            [
-            'order' => ['lower(name)' => 'ASC']
+                'recursive' => -1,
-        ]);
+                'fields' => ['id', 'name'],
+                'order' => ['lower(name)' => 'ASC'],
+            ]
+        );
         $dropdownData = [
-            'org_id' => $orgs
+            'org_id' => $orgs,
         ];
         $this->set(compact('dropdownData'));
     }
@@ -84,11 +86,11 @@ class CerebratesController extends AppController
     /**
      * Edit method
      *
-     * @param string|null $id Cerebrate id.
+     * @param int|null $id Cerebrate id.
      * @return \Cake\Http\Response|null|void Redirects on successful edit, renders view otherwise.
      * @throws \Cake\Datasource\Exception\RecordNotFoundException When record not found.
      */
-    public function edit($id = null)
+    public function edit(int|null $id = null)
     {
         $params = [];
         $this->CRUD->edit($id, $params);
@@ -97,13 +99,16 @@ class CerebratesController extends AppController
             return $responsePayload;
         }
 
-        $orgs = $this->Cerebrates->Organisations->find('list', [
+        $orgs = $this->Cerebrates->Organisations->find(
-            'recursive' => -1,
+            'list',
-            'fields' => ['id', 'name'],
+            [
-            'order' => ['lower(name)' => 'ASC']
+                'recursive' => -1,
-        ]);
+                'fields' => ['id', 'name'],
+                'order' => ['lower(name)' => 'ASC'],
+            ]
+        );
         $dropdownData = [
-            'org_id' => $orgs
+            'org_id' => $orgs,
         ];
         $this->set(compact('dropdownData'));
         $this->render('add');
@@ -112,11 +117,11 @@ class CerebratesController extends AppController
     /**
      * Delete method
      *
-     * @param string|null $id Cerebrate id.
+     * @param int|null $id Cerebrate id.
      * @return \Cake\Http\Response|null|void Redirects to index.
      * @throws \Cake\Datasource\Exception\RecordNotFoundException When record not found.
      */
-    public function delete($id = null)
+    public function delete(int|null $id = null)
     {
         $this->CRUD->delete($id);
         $responsePayload = $this->CRUD->getResponsePayload();
@@ -125,9 +130,13 @@ class CerebratesController extends AppController
         }
     }
 
-
+    /**
-
+     * pullOrgs
-    public function pullOrgs($id)
+     *
+     * @param  int $id of the org
+     * @return void
+     */
+    public function pullOrgs(int $id)
     {
         // FIXME chri - $this->set('menuData', ['menuList' => 'sync', 'menuItem' => 'previewCerebrateOrgs']);
         /** @var \App\Model\Entity\Cerebrate $cerebrate */
@@ -135,17 +144,21 @@ class CerebratesController extends AppController
         if (empty($cerebrate)) {
             throw new NotFoundException(__('Invalid Cerebrate instance ID provided.'));
         }
-        
+
         if ($this->request->is('post')) {
-            $orgs = $cerebrate->queryInstance([
+            $orgs = $cerebrate->queryInstance(
-                'path' => '/organisations/index',
+                [
-                'params' => $this->harvestParameters([
+                    'path' => '/organisations/index',
-                    'name',
+                    'params' => $this->harvestParameters(
-                    'uuid',
+                        [
-                    'quickFilter'
+                            'name',
-                ]),
+                            'uuid',
-                'type' => 'GET'
+                            'quickFilter',
-            ]);
+                        ]
+                    ),
+                    'type' => 'GET',
+                ]
+            );
             $result = $cerebrate->saveRemoteOrgs($orgs);
             $message = __('Added {0} new organisations, updated {1} existing organisations, {2} failures.', $result['add'], $result['edit'], $result['fails']);
             if ($this->ParamHandler->isRest()) {
@@ -165,7 +178,13 @@ class CerebratesController extends AppController
         }
     }
 
-    public function pullSgs($id)
+    /**
+     * pullSgs
+     *
+     * @param  int $id id of the Sharing Group
+     * @return void
+     */
+    public function pullSgs(int $id)
     {
         // $this->set('menuData', ['menuList' => 'sync', 'menuItem' => 'previewCerebrateSgs']);
         /** @var \App\Model\Entity\Cerebrate $cerebrate */
@@ -175,15 +194,19 @@ class CerebratesController extends AppController
         }
 
         if ($this->request->is('post')) {
-            $sgs = $cerebrate->queryInstance([
+            $sgs = $cerebrate->queryInstance(
-                'path' => '/sharingGroups/index',
+                [
-                'params' => $this->harvestParameters([
+                    'path' => '/sharingGroups/index',
-                    'name',
+                    'params' => $this->harvestParameters(
-                    'uuid',
+                        [
-                    'quickFilter'
+                            'name',
-                ]),
+                            'uuid',
-                'type' => 'GET'
+                            'quickFilter',
-            ]);
+                        ]
+                    ),
+                    'type' => 'GET',
+                ]
+            );
             $result = $cerebrate->saveRemoteSgs($sgs, $this->ACL->getUser());
             $message = __('Added {0} new sharing groups, updated {1} existing sharing groups, {2} failures.', $result['add'], $result['edit'], $result['fails']);
             if ($this->ParamHandler->isRest()) {
@@ -203,7 +226,13 @@ class CerebratesController extends AppController
         }
     }
 
-    public function previewOrgs($id = null)
+    /**
+     * previewOrgs
+     *
+     * @param  int $id id of the org
+     * @return void
+     */
+    public function previewOrgs(int|null $id = null)
     {
         // FIXME chri - $this->set('menuData', ['menuList' => 'sync', 'menuItem' => 'previewCerebrateOrgs']);
         /** @var \App\Model\Entity\Cerebrate $cerebrate */
@@ -212,15 +241,19 @@ class CerebratesController extends AppController
             throw new NotFoundException(__('Invalid Cerebrate instance ID provided.'));
         }
 
-        $orgs = $cerebrate->queryInstance([
+        $orgs = $cerebrate->queryInstance(
-            'path' => '/organisations/index',
+            [
-            'params' => $this->harvestParameters([
+                'path' => '/organisations/index',
-                'name',
+                'params' => $this->harvestParameters(
-                'uuid',
+                    [
-                'quickFilter'
+                        'name',
-            ]),
+                        'uuid',
-            'type' => 'GET'
+                        'quickFilter',
-        ]);
+                    ]
+                ),
+                'type' => 'GET',
+            ]
+        );
         $result = $cerebrate->checkRemoteOrgs($orgs);
         if ($this->ParamHandler->isRest()) {
             return $this->RestResponse->viewData($result, $this->response->getType());
@@ -234,7 +267,14 @@ class CerebratesController extends AppController
         }
     }
 
-    public function downloadOrg($cerebrate_id, $org_id)
+    /**
+     * downloadOrg
+     *
+     * @param  int $cerebrate_id id of the cerebrate instance
+     * @param  int $org_id id of the org
+     * @return void
+     */
+    public function downloadOrg(int $cerebrate_id, int $org_id)
     {
         if ($this->request->is('post')) {
             /** @var \App\Model\Entity\Cerebrate $cerebrate */
@@ -242,10 +282,12 @@ class CerebratesController extends AppController
             if (empty($cerebrate)) {
                 throw new NotFoundException(__('Invalid Cerebrate instance ID provided.'));
             }
-            $result = $cerebrate->queryInstance([
+            $result = $cerebrate->queryInstance(
-                'path' => '/organisations/view/' . $org_id,
+                [
-                'type' => 'GET'
+                    'path' => '/organisations/view/' . $org_id,
-            ]);
+                    'type' => 'GET',
+                ]
+            );
             $saveResult = $cerebrate->captureOrg($result);
             if ($this->ParamHandler->isRest()) {
                 if (is_array($saveResult)) {
@@ -272,7 +314,13 @@ class CerebratesController extends AppController
         }
     }
 
-    public function previewSharingGroups($id)
+    /**
+     * previewSharingGroups
+     *
+     * @param  int $id id of the Sharing Group
+     * @return void
+     */
+    public function previewSharingGroups(int $id)
     {
         // $this->set('menuData', ['menuList' => 'sync', 'menuItem' => 'previewCerebrateSGs']);
         /** @var \App\Model\Entity\Cerebrate $cerebrate */
@@ -280,18 +328,24 @@ class CerebratesController extends AppController
         if (empty($cerebrate)) {
             throw new NotFoundException(__('Invalid Cerebrate instance ID provided.'));
         }
-        $sgs = $cerebrate->queryInstance([
+        $sgs = $cerebrate->queryInstance(
-            'path' => '/sharingGroups/index',
+            [
-            'params' => $this->harvestParameters([
+                'path' => '/sharingGroups/index',
-                'name',
+                'params' => $this->harvestParameters(
-                'uuid',
+                    [
-                'quickFilter'
+                        'name',
-            ]),
+                        'uuid',
-            'type' => 'GET'
+                        'quickFilter',
-        ]);
+                    ]
-        if (!empty($sgs))
+                ),
+                'type' => 'GET',
+            ]
+        );
+        if (!empty($sgs)) {
             $result = $cerebrate->checkRemoteSharingGroups($sgs);
-        else $result = [];
+        } else {
+            $result = [];
+        }
         if ($this->ParamHandler->isRest()) {
             return $this->RestResponse->viewData($result, $this->response->getType());
         } else {
@@ -304,7 +358,14 @@ class CerebratesController extends AppController
         }
     }
 
-    public function downloadSg($cerebrate_id, $sg_id)
+    /**
+     * downloadSg
+     *
+     * @param  int $cerebrate_id id of the cerebrate instance
+     * @param  int $sg_id id of the Sharing Group
+     * @return void
+     */
+    public function downloadSg(int $cerebrate_id, int $sg_id)
     {
         if ($this->request->is('post')) {
             /** @var \App\Model\Entity\Cerebrate $cerebrate */
@@ -312,10 +373,12 @@ class CerebratesController extends AppController
             if (empty($cerebrate)) {
                 throw new NotFoundException(__('Invalid Cerebrate instance ID provided.'));
             }
-            $result = $cerebrate->queryInstance([
+            $result = $cerebrate->queryInstance(
-                'path' => '/sharingGroups/view/' . $sg_id,
+                [
-                'type' => 'GET'
+                    'path' => '/sharingGroups/view/' . $sg_id,
-            ]);
+                    'type' => 'GET',
+                ]
+            );
             $saveResult = $cerebrate->captureSg($result, $this->ACL->getUser());
             if ($this->ParamHandler->isRest()) {
                 if (is_array($saveResult)) {

src/Lib/Tools/CurlAdvanced.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 namespace App\Lib\Tools;
 
@@ -8,14 +9,13 @@ use Cake\Http\Client\Exception\NetworkException;
 use Cake\Http\Client\Exception\RequestException;
 use Psr\Http\Message\RequestInterface;
 
-class CurlAdvanced extends Curl 
+class CurlAdvanced extends Curl
 {
-
     /**
      * getCertificateChain - returns the list of certificates offered by the server
      *
-     * @param  mixed $request
+     * @param  \Psr\Http\Message\RequestInterface $request the request interface
-     * @param  mixed $options
+     * @param  array $options options of curl
      * @return array
      */
     public function getCertificateChain(RequestInterface $request, array $options): array
@@ -26,11 +26,11 @@ class CurlAdvanced extends Curl
 
         $ch = curl_init();
         $options['curl'] = [
-            CURLOPT_CERTINFO => true,    // ask curl for the certificate information
+            CURLOPT_CERTINFO => true, // ask curl for the certificate information
             // CURLOPT_VERBOSE => true,
-            CURLOPT_NOBODY => true,      // no need for the body
+            CURLOPT_NOBODY => true, // no need for the body
         ];
-     
+
         $options = $this->buildOptions($request, $options);
         curl_setopt_array($ch, $options);
 

src/Model/Entity/Cerebrate.php

@@ -1,19 +1,16 @@
 <?php
+declare(strict_types=1);
 
 namespace App\Model\Entity;
 
 use App\Lib\Tools\HttpTool;
-use App\Model\Entity\AppModel;
+use Cake\Database\Expression\QueryExpression;
-use Cake\Core\Exception\CakeException;
+use Cake\Database\Query;
 use Cake\Http\Client\Exception\NetworkException;
 use Cake\Http\Exception\BadRequestException;
 use Cake\Http\Exception\ForbiddenException;
 use Cake\ORM\TableRegistry;
 use Cake\Utility\Hash;
-use Cake\Database\Expression\QueryExpression;
-use Cake\Database\Query;
-
-
 
 /**
  * Cerebrate Entity
@@ -60,7 +57,6 @@ class Cerebrate extends AppModel
         'description' => true,
     ];
 
-    
     /**
      * queryInstance - Query a remote Cerebrate instance for a specific path
      *
@@ -79,10 +75,11 @@ class Cerebrate extends AppModel
                 $response = $httpTool->get(
                     $url,
                     [],
-                    (isset($options['params']) ? $options['params'] : []));
+                    ($options['params'] ?? [])
+                );
             }
             if ($response->isOk()) {
-                return json_decode($response->getBody(), true);
+                return json_decode($response->getBody()->__toString(), true);
             }
         } catch (NetworkException $e) {
             throw new BadRequestException(__('Something went wrong. Error returned: {0}', $e->getMessage()));
@@ -93,26 +90,32 @@ class Cerebrate extends AppModel
         throw new BadRequestException(__('Something went wrong with the request or the remote side is having issues.'));
     }
 
-    public function convertOrg($org_data) 
+    /**
+     * convertOrg
+     *
+     * @param  mixed $org_data organisation data
+     * @return array
+     */
+    public function convertOrg($org_data)
     {
         $mapping = [
             'name' => [
                 'field' => 'name',
-                'required' => 1
+                'required' => 1,
             ],
             'uuid' => [
                 'field' => 'uuid',
-                'required' => 1
+                'required' => 1,
             ],
             'nationality' => [
-                'field' => 'nationality'
+                'field' => 'nationality',
             ],
             'sector' => [
-                'field' => 'sector'
+                'field' => 'sector',
             ],
             'type' => [
-                'field' => 'type'
+                'field' => 'type',
-            ]
+            ],
         ];
         $org = [];
         foreach ($mapping as $cerebrate_field => $field_data) {
@@ -125,12 +128,12 @@ class Cerebrate extends AppModel
             }
             $org[$field_data['field']] = $org_data[$cerebrate_field];
         }
+
         return $org;
     }
 
-        
     /**
-     * saveRemoteOrgs - 
+     * saveRemoteOrgs -
      *
      * @param  array $orgs An array of organisations with name, uuid, sector, nationality, type
      * @return array {'add': int, 'edit': int, 'fails': int}
@@ -140,7 +143,7 @@ class Cerebrate extends AppModel
         $outcome = [
             'add' => 0,
             'edit' => 0,
-            'fails' => 0
+            'fails' => 0,
         ];
         foreach ($orgs as $org) {
             $isEdit = false;
@@ -158,14 +161,15 @@ class Cerebrate extends AppModel
                 }
             }
         }
+
         return $outcome;
     }
-    
+
     /**
      * saveRemoteSgs
      *
-     * @param  mixed $sgs
+     * @param  mixed $sgs SharingGroups
-     * @param  mixed $user
+     * @param  mixed $user user
      * @return array ['add'=> 0, 'edit' => 0, 'fails' => 0]
      */
     public function saveRemoteSgs($sgs, $user)
@@ -173,7 +177,7 @@ class Cerebrate extends AppModel
         $outcome = [
             'add' => 0,
             'edit' => 0,
-            'fails' => 0
+            'fails' => 0,
         ];
         foreach ($sgs as $sg) {
             $isEdit = false;
@@ -191,27 +195,31 @@ class Cerebrate extends AppModel
                 }
             }
         }
+
         return $outcome;
     }
-    
+
     /**
      * captureOrg - save or update an Org locally that comes from a Remote Cerebrate server
      *
      * @param  array $org_data The Org array from the remote Cerebrate server
      * @param  bool $edit Returns if the org was edited or not
-     * @param  bool $noChange Returns 
+     * @param  bool $noChange Returns
      * @return string|array Error message or Organisation array
      */
-    public function captureOrg($org_data, &$edit=false, &$noChange=false) 
+    public function captureOrg($org_data, &$edit = false, &$noChange = false)
     {
         $org = $this->convertOrg($org_data);
         if ($org) {
             /** @var \App\Model\Table\OrganisationsTable $organisationTable */
             $organisationTable = TableRegistry::getTableLocator()->get('Organisations');
-            $existingOrg = $organisationTable->find('all', [
+            $existingOrg = $organisationTable->find(
-                'recursive' => -1,
+                'all',
-                'conditions' => ['uuid' => $org['uuid']]
+                [
-            ])->first();
+                    'recursive' => -1,
+                    'conditions' => ['uuid' => $org['uuid']],
+                ]
+            )->first();
             if (!empty($existingOrg)) {
                 $fieldsToSave = ['name', 'sector', 'nationality', 'type'];
                 unset($org['uuid']);
@@ -243,36 +251,48 @@ class Cerebrate extends AppModel
             }
             if ($dirty) {
                 // verify if the name exists, if so generate a new name
-                $nameCheck = $organisationTable->find('all', [
+                $nameCheck = $organisationTable->find(
-                    'recursive' => -1,
+                    'all',
-                    'conditions' => ['name' => $orgToSave->name],
+                    [
-                    'fields' => ['id']
+                        'recursive' => -1,
-                ])->first();
+                        'conditions' => ['name' => $orgToSave->name],
+                        'fields' => ['id'],
+                    ]
+                )->first();
                 if (!empty($nameCheck)) {
                     $orgToSave['name'] = $orgToSave['name'] . '_' . mt_rand(0, 9999);
                 }
                 // save the organisation
                 $savedOrganisation = $organisationTable->save($orgToSave);
                 if ($savedOrganisation) {
-                    return $organisationTable->find('all', [
+                    return $organisationTable->find(
-                        'recursive' => -1,
+                        'all',
-                        'conditions' => ['id' => $savedOrganisation->id]
+                        [
-                    ])->first()->toArray();
+                            'recursive' => -1,
+                            'conditions' => ['id' => $savedOrganisation->id],
+                        ]
+                    )->first()->toArray();
                 } else {
                     return __('The organisation could not be saved.');
                 }
             } else {
                 $noChange = true;
+
                 return $existingOrg->toArray();
             }
         }
+
         return __('The retrieved data isn\'t a valid organisation.');
     }
 
-    /*
+    /**
+     * checkRemoteOrgs
      *  Checks remote for the current status of each organisation
      *  Adds the exists_locally field with a boolean status
      *  If exists_loally is true, adds a list with the differences (keynames)
+     *
+     * @param  array $orgs orgs
+     * @return array
      */
     public function checkRemoteOrgs($orgs)
     {
@@ -281,9 +301,11 @@ class Cerebrate extends AppModel
         $organisationTable = TableRegistry::getTableLocator()->get('Organisations');
         $existingOrgs = $organisationTable->find('all')
         ->where(['uuid'])
-        ->where(function (QueryExpression $exp, Query $q) use ($uuids) {
+        ->where(
-            return $exp->in('uuid', array_values($uuids));
+            function (QueryExpression $exp, Query $q) use ($uuids) {
-        });
+                return $exp->in('uuid', array_values($uuids));
+            }
+        );
         $rearranged = [];
         foreach ($existingOrgs as $existingOrg) {
             $rearranged[$existingOrg->uuid] = $existingOrg->toArray();
@@ -310,9 +332,17 @@ class Cerebrate extends AppModel
                 }
             }
         }
+
         return $orgs;
     }
 
+    /**
+     * __compareNames
+     *
+     * @param  string $name1 orgname
+     * @param  string $name2 orgname
+     * @return bool
+     */
     private function __compareNames($name1, $name2)
     {
         if (preg_match('/\_[0-9]{4}$/i', $name1)) {
@@ -322,9 +352,17 @@ class Cerebrate extends AppModel
                 return false;
             }
         }
+
         return false;
     }
 
+    /**
+     * __compareMembers
+     *
+     * @param  array $existingMembers members
+     * @param  array $remoteMembers members
+     * @return bool
+     */
     private function __compareMembers($existingMembers, $remoteMembers)
     {
         $memberFound = [];
@@ -342,13 +380,18 @@ class Cerebrate extends AppModel
                 $memberNotFound[] = $remoteMember['uuid'];
             }
         }
+
         return empty($memberNotFound);
     }
 
-    /*
+    /**
-     *  Checks remote for the current status of each sharing groups
+     * checkRemoteSharingGroups
-     *  Adds the exists_locally field with a boolean status
+     * Checks remote for the current status of each sharing groups
-     *  If exists_loally is true, adds a list with the differences (keynames)
+     * Adds the exists_locally field with a boolean status
+     * If exists_loally is true, adds a list with the differences (keynames)
+     *
+     * @param  array $sgs SharingGroups
+     * @return array
      */
     public function checkRemoteSharingGroups($sgs)
     {
@@ -356,11 +399,13 @@ class Cerebrate extends AppModel
         $sharingGroupTable = TableRegistry::getTableLocator()->get('SharingGroups');
         $uuids = Hash::extract($sgs, '{n}.uuid');
         $existingSgs = $sharingGroupTable->find('all')
-        ->contain(['SharingGroupOrgs'=> 'Organisations', 'Organisations'])
+        ->contain(['SharingGroupOrgs' => 'Organisations', 'Organisations'])
         ->where(['SharingGroups.uuid'])
-        ->where(function (QueryExpression $exp, Query $q) use ($uuids) {
+        ->where(
-            return $exp->in('SharingGroups.uuid', array_values($uuids));
+            function (QueryExpression $exp, Query $q) use ($uuids) {
-        });
+                return $exp->in('SharingGroups.uuid', array_values($uuids));
+            }
+        );
         $rearranged = [];
         foreach ($existingSgs as $existingSg) {
             $existingSg = $existingSg->toArray();
@@ -375,9 +420,17 @@ class Cerebrate extends AppModel
                 $sgs[$k]['differences'] = $this->compareSgs($rearranged[$sg['uuid']], $sgs[$k]);
             }
         }
+
         return $sgs;
     }
 
+    /**
+     * compareSgs
+     *
+     * @param  array $existingSg existing SharingGroup
+     * @param  array $remoteSg remote Sharing Group
+     * @return array
+     */
     private function compareSgs($existingSg, $remoteSg)
     {
         $differences = [];
@@ -399,25 +452,32 @@ class Cerebrate extends AppModel
         if (!$this->__compareMembers(Hash::extract($existingSg['SharingGroupOrg'], '{n}.Organisation'), $remoteSg['sharing_group_orgs'])) {
             $differences[] = 'members';
         }
+
         return $differences;
     }
 
+    /**
+     * convertSg
+     *
+     * @param  array $sg_data Sharing Group data
+     * @return array
+     */
     private function convertSg($sg_data)
     {
         $mapping = [
             'name' => [
                 'field' => 'name',
-                'required' => 1
+                'required' => 1,
             ],
             'uuid' => [
                 'field' => 'uuid',
-                'required' => 1
+                'required' => 1,
             ],
             'releasability' => [
-                'field' => 'releasability'
+                'field' => 'releasability',
             ],
             'description' => [
-                'field' => 'description'
+                'field' => 'description',
             ],
         ];
         $sg = [];
@@ -442,24 +502,26 @@ class Cerebrate extends AppModel
                     $sg['SharingGroupOrg'][$k]['extend'] = false;
                 }
                 foreach ($org as $ok => $ov) {
-                    if ($ov === null) unset($sg['SharingGroupOrg'][$k][$ok]);
+                    if ($ov === null) {
+                        unset($sg['SharingGroupOrg'][$k][$ok]);
+                    }
                 }
             }
         }
+
         return $sg;
     }
 
-        
     /**
      * captureSg
      *
-     * @param  array $sg_data
+     * @param  array $sg_data Sharing Group data
-     * @param  App\Model\Entity\User $user
+     * @param  \App\Model\Entity\User $user user
-     * @param  bool $edit
+     * @param  bool $edit data was changed or not
-     * @param  bool $noChange
+     * @param  bool $noChange noChange
-     * @return mixed
+     * @return string|array
      */
-    public function captureSg($sg_data, $user, &$edit=false, &$noChange=false) 
+    public function captureSg($sg_data, $user, &$edit = false, &$noChange = false)
     {
         /** @var \App\Model\Table\SharingGroupsTable $sharingGroupTable */
         $sharingGroupTable = TableRegistry::getTableLocator()->get('SharingGroups');
@@ -472,12 +534,15 @@ class Cerebrate extends AppModel
             $captureResult = $sharingGroupTable->captureSG($sg, $user->toArray(), false);
             if (!empty($captureResult)) {
                 $savedSg = $sharingGroupTable->findById($captureResult)
-                ->contain(['SharingGroupOrgs'=> 'Organisations', 'Organisations'])
+                ->contain(['SharingGroupOrgs' => 'Organisations', 'Organisations'])
                 ->first();
+
                 return $savedSg->toArray();
             }
+
             return __('The organisation could not be saved.');
         }
+
         return __('The retrieved data isn\'t a valid sharing group.');
     }
 }

src/Model/Table/CerebratesTable.php

@@ -1,13 +1,8 @@
 <?php
+declare(strict_types=1);
+
 namespace App\Model\Table;
 
-use App\Model\Table\AppTable;
-use ArrayObject;
-use Cake\Datasource\EntityInterface;
-use Cake\Event\Event;
-use Cake\Event\EventInterface;
-use Cake\ORM\Query;
-use Cake\ORM\RulesChecker;
 use Cake\Validation\Validator;
 
 /**
@@ -48,7 +43,7 @@ class CerebratesTable extends AppTable
                 'dependent' => false,
                 'cascadeCallbacks' => false,
                 'foreignKey' => 'org_id',
-                'propertyName' => 'Organisation'
+                'propertyName' => 'Organisation',
             ]
         );
 

templates/Cerebrates/add.php

@@ -4,29 +4,29 @@ $edit = $this->request->getParam('action') === 'edit' ? true : false;
 $fields = [
     [
         'field' => 'name',
-        'class' => 'span6'
+        'class' => 'span6',
     ],
     [
         'field' => 'url',
-        'class' => 'span6'
+        'class' => 'span6',
     ],
     [
         'field' => 'authkey',
         'class' => 'span6',
         'autocomplete' => 'off',
-        'type' => 'text'
+        'type' => 'text',
     ],
     [
         'field' => 'org_id',
         'label' => 'Owner Organisation',
         'options' => $dropdownData['org_id'],
         'class' => 'span6',
-        'type' => 'dropdown'
+        'type' => 'dropdown',
     ],
     [
         'field' => 'description',
         'type' => 'textarea',
-        'class' => 'input span6'
+        'class' => 'input span6',
     ],
     [
         'field' => 'pull_orgs',
@@ -37,17 +37,20 @@ $fields = [
         'field' => 'pull_sharing_groups',
         'label' => __('Pull Sharing Groups'),
         'type' => 'checkbox',
-    ]
+    ],
 ];
-echo $this->element('genericElements/Form/genericForm', [
+echo $this->element(
-    'data' => [
+    'genericElements/Form/genericForm',
-        'description' => false,
+    [
-        'model' => 'Cerebrate',
+        'data' => [
-        'title' => $edit ? __('Edit Cerebrate connection') : __('Add Cerebrate connection'),
+            'description' => false,
-        'fields' => $fields,
+            'model' => 'Cerebrate',
-        'submit' => [
+            'title' => $edit ? __('Edit Cerebrate connection') : __('Add Cerebrate connection'),
-            'action' => $this->request->getParam('action'),
+            'fields' => $fields,
-            'ajaxSubmit' => 'submitGenericFormInPlace();'
+            'submit' => [
-        ]
+                'action' => $this->request->getParam('action'),
+                'ajaxSubmit' => 'submitGenericFormInPlace();',
+            ],
+        ],
     ]
-]);
+);

templates/Cerebrates/index.php

@@ -1,111 +1,113 @@
 <?php
-    $fields = [
+$fields = [
-        [
+    [
-            'name' => __('ID'),
+        'name' => __('ID'),
-            'sort' => 'id',
+        'sort' => 'id',
-            'class' => 'short',
+        'class' => 'short',
-            'data_path' => 'id'
+        'data_path' => 'id',
-        ],
+    ],
-        [
+    [
-            'name' => __('Owner Org'),
+        'name' => __('Owner Org'),
-            'sort' => 'Organisation',
+        'sort' => 'Organisation',
-            'data_path' => 'Organisation',
+        'data_path' => 'Organisation',
-            'element' => 'org'
+        'element' => 'org',
-        ],
+    ],
-        [
+    [
-            'name' => __('Name'),
+        'name' => __('Name'),
-            'sort' => 'name',
+        'sort' => 'name',
-            'data_path' => 'name'
+        'data_path' => 'name',
-        ],
+    ],
-        [
+    [
-            'name' => __('URL'),
+        'name' => __('URL'),
-            'sort' => 'url',
+        'sort' => 'url',
-            'data_path' => 'url'
+        'data_path' => 'url',
-        ],
+    ],
-        [
+    [
-            'name' => __('Description'),
+        'name' => __('Description'),
-            'sort' => 'description',
+        'sort' => 'description',
-            'data_path' => 'description'
+        'data_path' => 'description',
-        ],
+    ],
-        [
+    [
-            'name' => __('Pull Orgs'),
+        'name' => __('Pull Orgs'),
-            'sort' => 'pull_orgs',
+        'sort' => 'pull_orgs',
-            'data_path' => 'pull_orgs',
+        'data_path' => 'pull_orgs',
-            'element' => 'boolean'
+        'element' => 'boolean',
-        ],
+    ],
-        [
+    [
-            'name' => __('Pull SGs'),
+        'name' => __('Pull SGs'),
-            'sort' => 'pull_sharing_groups',
+        'sort' => 'pull_sharing_groups',
-            'data_path' => 'pull_sharing_groups',
+        'data_path' => 'pull_sharing_groups',
-            'element' => 'boolean'
+        'element' => 'boolean',
-        ]
+    ],
-    ];
+];
 
-echo $this->element('genericElements/IndexTable/index_table', [
+echo $this->element(
-    'data' => [
+    'genericElements/IndexTable/index_table',
-        'data' => $data,
+    [
-        'top_bar' => [
+        'data' => [
-            'children' => [
+            'data' => $data,
-                [
+            'top_bar' => [
-                    'type' => 'simple',
+                'children' => [
-                    'children' => [
+                    [
-                        'data' => [
+                        'type' => 'simple',
-                            'type' => 'simple',
+                        'children' => [
-                            'icon' => 'plus',
+                            'data' => [
-                            'text' => __('Add Cerebrate'),
+                                'type' => 'simple',
-                            'class' => 'btn btn-primary',
-                            'popover_url' => '/cerebrates/add',
-                            'button' => [
                                 'icon' => 'plus',
-                            ]
+                                'text' => __('Add Cerebrate'),
-                        ]
+                                'class' => 'btn btn-primary',
-                    ]
+                                'popover_url' => '/cerebrates/add',
+                                'button' => [
+                                    'icon' => 'plus',
+                                ],
+                            ],
+                        ],
+                    ],
+                    [
+                        'type' => 'search',
+                        'button' => __('Search'),
+                        'placeholder' => __('Enter value to search'),
+                        'data' => '',
+                        'searchKey' => 'value',
+                        'allowFilering' => true,
+                    ],
+                    [
+                        'type' => 'table_action',
+                    ],
+                ],
+            ],
+            'fields' => $fields,
+            'title' => __('Linked Cerebrates'),
+            'description' => __('You can connect your MISP to one or several Cerebrate instances to act as lookup directories for organisation and sharing group information.'),
+            'actions' => [
+                [
+                    'url' => '/cerebrates/view',
+                    'url_params_data_paths' => ['id'],
+                    'icon' => 'eye',
                 ],
                 [
-                    'type' => 'search',
+                    'open_modal' => '/cerebrates/pull_orgs/[onclick_params_data_path]',
-                    'button' => __('Search'),
+                    'onclick_params_data_path' => 'id',
-                    'placeholder' => __('Enter value to search'),
+                    'title' => __('Pull all organisations'),
-                    'data' => '',
+                    'icon' => 'arrow-circle-down',
-                    'searchKey' => 'value',
-                    'allowFilering' => true
                 ],
                 [
-                    'type' => 'table_action',
+                    'open_modal' => '/cerebrates/pull_sgs/[onclick_params_data_path]',
+                    'onclick_params_data_path' => 'id',
+                    'title' => __('Pull all sharing groups'),
+                    'icon' => 'arrow-circle-down',
                 ],
-            ]
+                [
+                    'open_modal' => '/cerebrates/edit/[onclick_params_data_path]',
+                    'modal_params_data_path' => 'id',
+                    'icon' => 'edit',
+                ],
+                [
+                    'open_modal' => '/cerebrates/delete/[onclick_params_data_path]',
+                    'modal_params_data_path' => 'id',
+                    'icon' => 'trash',
+                ],
+            ],
         ],
-        'fields' => $fields,
-        'title' => __('Linked Cerebrates'),
-        'description' => __('You can connect your MISP to one or several Cerebrate instances to act as lookup directories for organisation and sharing group information.'),
-        'actions' => [
-            [
-                'url' => '/cerebrates/view',
-                'url_params_data_paths' => ['id'],
-                'icon' => 'eye'
-            ],
-            [
-                'open_modal' => '/cerebrates/pull_orgs/[onclick_params_data_path]',
-                'onclick_params_data_path' => 'id',
-                'title' => __('Pull all organisations'),
-                'icon' => 'arrow-circle-down'
-            ],
-            [
-                'open_modal' => '/cerebrates/pull_sgs/[onclick_params_data_path]',
-                'onclick_params_data_path' => 'id',
-                'title' => __('Pull all sharing groups'),
-                'icon' => 'arrow-circle-down'
-            ],
-            [
-                'open_modal' => '/cerebrates/edit/[onclick_params_data_path]',
-                'modal_params_data_path' => 'id',
-                'icon' => 'edit'
-            ],
-            [
-                'open_modal' => '/cerebrates/delete/[onclick_params_data_path]',
-                'modal_params_data_path' => 'id',
-                'icon' => 'trash'
-            ]
-        ]
     ]
-]);
+);
-

templates/Cerebrates/preview_orgs.php

@@ -1,38 +1,40 @@
 <?php
-    $fields = [
+$fields = [
-        [
+    [
-            'name' => __('Id'),
+        'name' => __('Id'),
-            'sort' => 'id',
+        'sort' => 'id',
-            'data_path' => 'id'
+        'data_path' => 'id',
-        ],
+    ],
-        [
+    [
-            'name' => __('Known locally'),
+        'name' => __('Known locally'),
-            'sort' => 'exists_locally',
+        'sort' => 'exists_locally',
-            'element' => 'remote_status',
+        'element' => 'remote_status',
-        ],
+    ],
-        [
+    [
-            'name' => __('UUID'),
+        'name' => __('UUID'),
-            'sort' => 'uuid',
+        'sort' => 'uuid',
-            'data_path' => 'uuid'
+        'data_path' => 'uuid',
-        ],
+    ],
-        [
+    [
-            'name' => __('Name'),
+        'name' => __('Name'),
-            'sort' => 'name',
+        'sort' => 'name',
-            'data_path' => 'name'
+        'data_path' => 'name',
-        ],
+    ],
-        [
+    [
-            'name' => __('Sector'),
+        'name' => __('Sector'),
-            'sort' => 'sector',
+        'sort' => 'sector',
-            'data_path' => 'sector'
+        'data_path' => 'sector',
-        ],
+    ],
-        [
+    [
-            'name' => __('Nationality'),
+        'name' => __('Nationality'),
-            'sort' => 'nationality',
+        'sort' => 'nationality',
-            'data_path' => 'nationality'
+        'data_path' => 'nationality',
-        ]
+    ],
-    ];
+];
 
-    echo $this->element('genericElements/IndexTable/index_table', [
+echo $this->element(
+    'genericElements/IndexTable/index_table',
+    [
         'data' => [
             'data' => $data,
             'top_bar' => [
@@ -44,37 +46,38 @@
                         'placeholder' => __('Enter value to search'),
                         'data' => '',
                         'preserve_url_params' => [$cerebrate['id']],
-                        'searchKey' => 'quickFilter'
+                        'searchKey' => 'quickFilter',
-                    ]
+                    ],
-                ]
+                ],
             ],
             'fields' => $fields,
             'title' => empty($ajax) ? __(
-                    'Organisations list via Cerebrate {0} ({1})',
+                'Organisations list via Cerebrate {0} ({1})',
-                    h($cerebrate['id']),
+                h($cerebrate['id']),
-                    h($cerebrate['name'])
+                h($cerebrate['name'])
-                ) : false,
+            ) : false,
             'description' => empty($ajax) ? __('Preview of the organisations known to the remote Cerebrate instance.') : false,
             'actions' => [
                 [
                     'onclick' => sprintf(
-                        'openGenericModal(\'{0}/cerebrates/download_org/{1}/[onclick_params_data_path]\');',
+                        'openGenericModal(\'%s/cerebrates/download_org/%d/[onclick_params_data_path]\');',
                         $baseurl,
                         h($cerebrate['id'])
                     ),
                     'onclick_params_data_path' => 'id',
                     'icon' => 'download',
-                    'title' => __('Fetch organisation object')
+                    'title' => __('Fetch organisation object'),
-                ]
+                ],
             ],
             'paginatorOptions' => array_merge(
                 ['url' => [$cerebrate['id']]],
                 $passedParams
             ),
-            'persistUrlParams' => [0, 'quickFilter']
+            'persistUrlParams' => [0, 'quickFilter'],
         ],
-        'containerId' => 'preview_orgs_container'
+        'containerId' => 'preview_orgs_container',
-    ]);
+    ]
+);
 ?>
 <script type="text/javascript">
     var passedArgsArray = <?= json_encode([h($cerebrate['id'])]) ?>;

templates/Cerebrates/preview_sharing_groups.php

@@ -1,46 +1,48 @@
 <?php
-    $fields = [
+$fields = [
-        [
+    [
-            'name' => __('Id'),
+        'name' => __('Id'),
-            'sort' => 'id',
+        'sort' => 'id',
-            'data_path' => 'id'
+        'data_path' => 'id',
-        ],
+    ],
-        [
+    [
-            'name' => __('Status'),
+        'name' => __('Status'),
-            'sort' => 'exists_locally',
+        'sort' => 'exists_locally',
-            'element' => 'remote_status',
+        'element' => 'remote_status',
-            'data_path' => ''
+        'data_path' => '',
-        ],
+    ],
-        [
+    [
-            'name' => __('UUID'),
+        'name' => __('UUID'),
-            'sort' => 'uuid',
+        'sort' => 'uuid',
-            'data_path' => 'uuid'
+        'data_path' => 'uuid',
-        ],
+    ],
-        [
+    [
-            'name' => __('Name'),
+        'name' => __('Name'),
-            'sort' => 'name',
+        'sort' => 'name',
-            'data_path' => 'name'
+        'data_path' => 'name',
-        ],
+    ],
-        [
+    [
-            'name' => __('Releasability'),
+        'name' => __('Releasability'),
-            'sort' => 'releasability',
+        'sort' => 'releasability',
-            'data_path' => 'releasability'
+        'data_path' => 'releasability',
-        ],
+    ],
-        [
+    [
-            'name' => __('Description'),
+        'name' => __('Description'),
-            'sort' => 'description',
+        'sort' => 'description',
-            'data_path' => 'description'
+        'data_path' => 'description',
-        ],
+    ],
-        [
+    [
-            'name' => __('# Member'),
+        'name' => __('# Member'),
-            'element' => 'custom',
+        'element' => 'custom',
-            'function' => function($row) {
+        'function' => function ($row) {
-                return count($row['sharing_group_orgs']);
+            return count($row['sharing_group_orgs']);
-            }
+        },
-        ],
+    ],
-    ];
+];
 
-    echo $this->element('genericElements/IndexTable/index_table', [
+echo $this->element(
+    'genericElements/IndexTable/index_table',
+    [
         'data' => [
             'data' => $data,
             'top_bar' => [
@@ -52,37 +54,38 @@
                         'placeholder' => __('Enter value to search'),
                         'data' => '',
                         'preserve_url_params' => [$cerebrate['id']],
-                        'searchKey' => 'quickFilter'
+                        'searchKey' => 'quickFilter',
-                    ]
+                    ],
-                ]
+                ],
             ],
             'fields' => $fields,
             'title' => empty($ajax) ? __(
-                    'Sharing group list via Cerebrate {0} ({1})',
+                'Sharing group list via Cerebrate {0} ({1})',
-                    h($cerebrate['id']),
+                h($cerebrate['id']),
-                    h($cerebrate['name'])
+                h($cerebrate['name'])
-                ) : false,
+            ) : false,
             'description' => empty($ajax) ? __('Preview of the sharing group known to the remote Cerebrate instance.') : false,
             'actions' => [
                 [
                     'onclick' => sprintf(
-                        'openGenericModal(\'{0}/cerebrates/download_sg/{1}/[onclick_params_data_path]\');',
+                        'openGenericModal(\'%s/cerebrates/download_sg/%d/[onclick_params_data_path]\');',
                         $baseurl,
                         h($cerebrate['id'])
                     ),
                     'onclick_params_data_path' => 'id',
                     'icon' => 'download',
-                    'title' => __('Fetch sharing group object')
+                    'title' => __('Fetch sharing group object'),
-                ]
+                ],
             ],
             'paginatorOptions' => array_merge(
                 ['url' => [$cerebrate['id']]],
                 $passedParams
             ),
-            'persistUrlParams' => [0, 'quickFilter']
+            'persistUrlParams' => [0, 'quickFilter'],
         ],
-        'containerId' => 'preview_sgs_container'
+        'containerId' => 'preview_sgs_container',
-    ]);
+    ]
+);
 ?>
 <script type="text/javascript">
     var passedArgsArray = <?= json_encode([h($cerebrate['id'])]) ?>;

templates/Cerebrates/view.php

@@ -7,28 +7,28 @@ echo $this->element(
         'fields' => [
             [
                 'key' => __('Id'),
-                'path' => 'id'
+                'path' => 'id',
             ],
             [
                 'key' => __('Name'),
-                'path' => 'name'
+                'path' => 'name',
             ],
             [
                 'key' => __('URL'),
                 'path' => 'url',
                 'url' => '{{0}}',
-                'url_vars' => ['url']
+                'url_vars' => ['url'],
             ],
             [
                 'key' => __('Owner Organisation'),
                 'path' => 'org_id',
                 'pathName' => 'Organisation.name',
                 'type' => 'model',
-                'model' => 'organisations'
+                'model' => 'organisations',
             ],
             [
                 'key' => __('Description'),
-                'path' => 'description'
+                'path' => 'description',
             ],
         ],
         // 'side_panels' => [  // FIXME chri missing side-panel
@@ -63,6 +63,6 @@ echo $this->element(
                 'title' => __('Sharing Groups'),
                 // FIXME chri - 'elementId' => 'preview_sgs_container' FIXME chri
             ],
-        ]
+        ],
-    ]
+    ],
 );

tests/TestCase/Api/Cerebrates/AddCerebrateApiTest.php

@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace App\Test\TestCase\Api\Cerebrates;
@@ -19,7 +18,7 @@ class AddCerebrateApiTest extends TestCase
         'app.Cerebrates',
         'app.Roles',
         'app.Users',
-        'app.AuthKeys'
+        'app.AuthKeys',
     ];
 
     public function testAddCerebrate(): void
@@ -43,7 +42,7 @@ class AddCerebrateApiTest extends TestCase
                 'client_cert_file' => false,
                 // 'internal' => 1,
                 'skip_proxy' => false,
-                'description' => $faker->sentence()
+                'description' => $faker->sentence(),
             ]
         );
 
@@ -73,7 +72,7 @@ class AddCerebrateApiTest extends TestCase
                 'client_cert_file' => false,
                 // 'internal' => 1,
                 'skip_proxy' => false,
-                'description' => $faker->sentence()
+                'description' => $faker->sentence(),
             ]
         );
         $this->assertResponseCode(405);

tests/TestCase/Api/Cerebrates/DeleteCerebrateApiTest.php

@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace App\Test\TestCase\Api\Cerebrates;
@@ -20,7 +19,7 @@ class DeleteCerebrateApiTest extends TestCase
         'app.Cerebrates',
         'app.Roles',
         'app.Users',
-        'app.AuthKeys'
+        'app.AuthKeys',
     ];
 
     public function testDeleteCerebrate(): void

tests/TestCase/Api/Cerebrates/DownloadOrgCerebrateApiTest.php

@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace App\Test\TestCase\Api\Cerebrates;
@@ -10,7 +9,6 @@ use App\Test\Helper\ApiTestTrait;
 use Cake\Http\TestSuite\HttpClientTrait;
 use Cake\TestSuite\TestCase;
 
-
 class DownloadOrgCerebrateApiTest extends TestCase
 {
     use ApiTestTrait;
@@ -23,7 +21,7 @@ class DownloadOrgCerebrateApiTest extends TestCase
         'app.Cerebrates',
         'app.Roles',
         'app.Users',
-        'app.AuthKeys'
+        'app.AuthKeys',
     ];
 
     public function testDownloadOrg(): void
@@ -36,20 +34,20 @@ class DownloadOrgCerebrateApiTest extends TestCase
         ];
         $response = json_encode(CerebratesFixture::CEREBRATE_ORG_LIST[0]);
         $this->mockClientGet(
-            CerebratesFixture::SERVER_A_URL.'/organisations/view/'.CerebratesFixture::CEREBRATE_ORG_LIST[0]['id'],
+            CerebratesFixture::SERVER_A_URL . '/organisations/view/' . CerebratesFixture::CEREBRATE_ORG_LIST[0]['id'],
             $this->newClientResponse(200, $headers, $response)
         );
         $url = sprintf('%s/%d/%d', self::ENDPOINT, CerebratesFixture::SERVER_A_ID, CerebratesFixture::CEREBRATE_ORG_LIST[0]['id']);
         $this->post($url);
         $this->assertResponseOk();
-        $this->assertResponseContains('"name": "'.CerebratesFixture::CEREBRATE_ORG_LIST[0]['name'].'"');
+        $this->assertResponseContains('"name": "' . CerebratesFixture::CEREBRATE_ORG_LIST[0]['name'] . '"');
         $this->assertDbRecordExists('Organisations', ['name' => CerebratesFixture::CEREBRATE_ORG_LIST[0]['name']]);
     }
 
     // TODO add a test to add new data to an existing organisation
     // public function testDownloadOrgUpdateExisting(): void
     // {
-        
+
     // }
 
     public function testDownloadOrgNotAllowedAsRegularUser(): void

tests/TestCase/Api/Cerebrates/DownloadSharingGroupCerebrateApiTest.php

@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace App\Test\TestCase\Api\Cerebrates;
@@ -10,7 +9,6 @@ use App\Test\Helper\ApiTestTrait;
 use Cake\Http\TestSuite\HttpClientTrait;
 use Cake\TestSuite\TestCase;
 
-
 class DownloadSharingGroupCerebrateApiTest extends TestCase
 {
     use ApiTestTrait;
@@ -24,10 +22,9 @@ class DownloadSharingGroupCerebrateApiTest extends TestCase
         'app.Roles',
         'app.Users',
         'app.AuthKeys',
-        'app.SharingGroups'
+        'app.SharingGroups',
     ];
 
-    
     public function testDownloadSharingGroup(): void
     {
         $this->skipOpenApiValidations();
@@ -38,21 +35,20 @@ class DownloadSharingGroupCerebrateApiTest extends TestCase
         ];
         $response = json_encode(CerebratesFixture::CEREBRATE_SG_LIST[0]);
         $this->mockClientGet(
-            CerebratesFixture::SERVER_A_URL.'/sharingGroups/view/'.CerebratesFixture::CEREBRATE_SG_LIST[0]['id'],
+            CerebratesFixture::SERVER_A_URL . '/sharingGroups/view/' . CerebratesFixture::CEREBRATE_SG_LIST[0]['id'],
             $this->newClientResponse(200, $headers, $response)
         );
         $url = sprintf('%s/%d/%d', self::ENDPOINT, CerebratesFixture::SERVER_A_ID, CerebratesFixture::CEREBRATE_SG_LIST[0]['id']);
         $this->post($url);
         $this->assertResponseOk();
-        $this->assertResponseContains('"name": "'.CerebratesFixture::CEREBRATE_SG_LIST[0]['name'].'"');
+        $this->assertResponseContains('"name": "' . CerebratesFixture::CEREBRATE_SG_LIST[0]['name'] . '"');
         $this->assertDbRecordExists('SharingGroups', ['name' => CerebratesFixture::CEREBRATE_SG_LIST[0]['name'], 'uuid' => CerebratesFixture::CEREBRATE_SG_LIST[0]['uuid']]);
-
     }
 
         // TODO add multiple tests to add new data to an existing SG (new metadata, new existing org, new new org, ...)
     // public function testDownloadSharingGroupUpdateExisting(): void
     // {
-        
+
     // }
 
     public function testDownloadSharingGroupNotAllowedAsRegularUser(): void

tests/TestCase/Api/Cerebrates/EditCerebrateApiTest.php

@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace App\Test\TestCase\Api\Cerebrates;
@@ -20,7 +19,7 @@ class EditCerebrateApiTest extends TestCase
         'app.Cerebrates',
         'app.Roles',
         'app.Users',
-        'app.AuthKeys'
+        'app.AuthKeys',
     ];
 
     public function testEditCerebrate(): void
@@ -32,7 +31,7 @@ class EditCerebrateApiTest extends TestCase
             $url,
             [
                 'id' => CerebratesFixture::SERVER_A_ID,
-                'description' => 'new description'
+                'description' => 'new description',
             ]
         );
 
@@ -41,7 +40,7 @@ class EditCerebrateApiTest extends TestCase
             'Cerebrates',
             [
                 'id' => CerebratesFixture::SERVER_A_ID,
-                'description' => 'new description'
+                'description' => 'new description',
             ]
         );
     }
@@ -55,7 +54,7 @@ class EditCerebrateApiTest extends TestCase
             $url,
             [
                 'id' => CerebratesFixture::SERVER_A_ID,
-                'description' => 'new description'
+                'description' => 'new description',
             ]
         );
         $this->assertResponseCode(405);
@@ -63,7 +62,7 @@ class EditCerebrateApiTest extends TestCase
             'Cerebrates',
             [
                 'id' => CerebratesFixture::SERVER_A_ID,
-                'description' => 'new description'
+                'description' => 'new description',
             ]
         );
     }

tests/TestCase/Api/Cerebrates/IndexCerebratesApiTest.php

@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace App\Test\TestCase\Api\Cerebrates;
@@ -20,7 +19,7 @@ class IndexCerebratesApiTest extends TestCase
         'app.Cerebrates',
         'app.Roles',
         'app.Users',
-        'app.AuthKeys'
+        'app.AuthKeys',
     ];
 
     public function testIndexCerebrates(): void

tests/TestCase/Api/Cerebrates/PreviewOrgsCerebrateApiTest.php

@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace App\Test\TestCase\Api\Cerebrates;
@@ -10,7 +9,6 @@ use App\Test\Helper\ApiTestTrait;
 use Cake\Http\TestSuite\HttpClientTrait;
 use Cake\TestSuite\TestCase;
 
-
 class PreviewOrgsCerebrateApiTest extends TestCase
 {
     use ApiTestTrait;
@@ -23,10 +21,9 @@ class PreviewOrgsCerebrateApiTest extends TestCase
         'app.Cerebrates',
         'app.Roles',
         'app.Users',
-        'app.AuthKeys'
+        'app.AuthKeys',
     ];
 
-    
     public function testPreviewOrgs(): void
     {
         $this->skipOpenApiValidations();
@@ -37,13 +34,13 @@ class PreviewOrgsCerebrateApiTest extends TestCase
         ];
         $response = json_encode(CerebratesFixture::CEREBRATE_ORG_LIST);
         $this->mockClientGet(
-            CerebratesFixture::SERVER_A_URL.'/organisations/index',
+            CerebratesFixture::SERVER_A_URL . '/organisations/index',
             $this->newClientResponse(200, $headers, $response)
         );
         $url = sprintf('%s/%d', self::ENDPOINT, CerebratesFixture::SERVER_A_ID);
         $this->get($url);
         $this->assertResponseOk();
-        $this->assertResponseContains('"name": "'.CerebratesFixture::CEREBRATE_ORG_LIST[0]['name'].'"');
+        $this->assertResponseContains('"name": "' . CerebratesFixture::CEREBRATE_ORG_LIST[0]['name'] . '"');
     }
 
     public function testPreviewOrgsNotAllowedAsRegularUser(): void

tests/TestCase/Api/Cerebrates/PreviewSharingGroupsCerebrateApiTest.php

@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace App\Test\TestCase\Api\Cerebrates;
@@ -10,7 +9,6 @@ use App\Test\Helper\ApiTestTrait;
 use Cake\Http\TestSuite\HttpClientTrait;
 use Cake\TestSuite\TestCase;
 
-
 class PreviewSharingGroupsCerebrateApiTest extends TestCase
 {
     use ApiTestTrait;
@@ -23,10 +21,9 @@ class PreviewSharingGroupsCerebrateApiTest extends TestCase
         'app.Cerebrates',
         'app.Roles',
         'app.Users',
-        'app.AuthKeys'
+        'app.AuthKeys',
     ];
 
-    
     public function testPreviewSharingGroups(): void
     {
         $this->skipOpenApiValidations();
@@ -37,13 +34,13 @@ class PreviewSharingGroupsCerebrateApiTest extends TestCase
         ];
         $response = json_encode(CerebratesFixture::CEREBRATE_SG_LIST);
         $this->mockClientGet(
-            CerebratesFixture::SERVER_A_URL.'/sharingGroups/index',
+            CerebratesFixture::SERVER_A_URL . '/sharingGroups/index',
             $this->newClientResponse(200, $headers, $response)
         );
         $url = sprintf('%s/%d', self::ENDPOINT, CerebratesFixture::SERVER_A_ID);
         $this->get($url);
         $this->assertResponseOk();
-        $this->assertResponseContains('"name": "'.CerebratesFixture::CEREBRATE_SG_LIST[0]['name'].'"');
+        $this->assertResponseContains('"name": "' . CerebratesFixture::CEREBRATE_SG_LIST[0]['name'] . '"');
     }
 
     public function testPreviewSharingGroupsNotAllowedAsRegularUser(): void

tests/TestCase/Api/Cerebrates/PullOrgsCerebrateApiTest.php

@@ -0,0 +1,60 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Test\TestCase\Api\Cerebrates;
+
+use App\Test\Fixture\AuthKeysFixture;
+use App\Test\Fixture\CerebratesFixture;
+use App\Test\Helper\ApiTestTrait;
+use Cake\Http\TestSuite\HttpClientTrait;
+use Cake\TestSuite\TestCase;
+
+class PullOrgsCerebrateApiTest extends TestCase
+{
+    use ApiTestTrait;
+    use HttpClientTrait;
+
+    protected const ENDPOINT = '/cerebrates/pull_orgs';
+
+    protected $fixtures = [
+        'app.Organisations',
+        'app.Cerebrates',
+        'app.Roles',
+        'app.Users',
+        'app.AuthKeys',
+    ];
+
+    public function testPullOrgs(): void
+    {
+        $this->skipOpenApiValidations();
+        $this->setAuthToken(AuthKeysFixture::ADMIN_API_KEY);
+        $headers = [
+            'Content-Type: application/json',
+            'Connection: close',
+        ];
+        $response = json_encode(CerebratesFixture::CEREBRATE_ORG_LIST);
+        $this->mockClientGet(
+            CerebratesFixture::SERVER_A_URL . '/organisations/index',
+            $this->newClientResponse(200, $headers, $response)
+        );
+        $url = sprintf('%s/%d', self::ENDPOINT, CerebratesFixture::SERVER_A_ID);
+        $this->post($url);
+        $this->assertResponseOk();
+        $this->assertResponseContains(' 0 failures');
+        foreach (CerebratesFixture::CEREBRATE_ORG_LIST as $org) {
+            $this->assertDbRecordExists('Organisations', ['name' => $org['name'], 'uuid' => $org['uuid']]);
+        }
+    }
+
+    // TODO add more test cases where existing orgs are being pulled
+
+    public function testPullOrgsNotAllowedAsRegularUser(): void
+    {
+        $this->skipOpenApiValidations();
+        $this->setAuthToken(AuthKeysFixture::REGULAR_USER_API_KEY);
+        $url = sprintf('%s/%d', self::ENDPOINT, CerebratesFixture::SERVER_A_ID);
+        $this->get($url);
+
+        $this->assertResponseCode(405);
+    }
+}

tests/TestCase/Api/Cerebrates/PullSgsCerebrateApiTest.php

@@ -0,0 +1,61 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Test\TestCase\Api\Cerebrates;
+
+use App\Test\Fixture\AuthKeysFixture;
+use App\Test\Fixture\CerebratesFixture;
+use App\Test\Helper\ApiTestTrait;
+use Cake\Http\TestSuite\HttpClientTrait;
+use Cake\TestSuite\TestCase;
+
+class PullSgsCerebrateApiTest extends TestCase
+{
+    use ApiTestTrait;
+    use HttpClientTrait;
+
+    protected const ENDPOINT = '/cerebrates/pull_sgs';
+
+    protected $fixtures = [
+        'app.Organisations',
+        'app.Cerebrates',
+        'app.Roles',
+        'app.Users',
+        'app.AuthKeys',
+        'app.SharingGroups',
+    ];
+
+    public function testPullSharingGroups(): void
+    {
+        $this->skipOpenApiValidations();
+        $this->setAuthToken(AuthKeysFixture::ADMIN_API_KEY);
+        $headers = [
+            'Content-Type: application/json',
+            'Connection: close',
+        ];
+        $response = json_encode(CerebratesFixture::CEREBRATE_SG_LIST);
+        $this->mockClientGet(
+            CerebratesFixture::SERVER_A_URL . '/sharingGroups/index',
+            $this->newClientResponse(200, $headers, $response)
+        );
+        $url = sprintf('%s/%d', self::ENDPOINT, CerebratesFixture::SERVER_A_ID);
+        $this->post($url);
+        $this->assertResponseOk();
+        $this->assertResponseContains(' 0 failures');
+        foreach (CerebratesFixture::CEREBRATE_SG_LIST as $sg) {
+            $this->assertDbRecordExists('SharingGroups', ['name' => $sg['name'], 'uuid' => $sg['uuid']]);
+        }
+    }
+
+    // TODO add more use-cases where SGs already exist, contain new metadata and contain new orgs
+
+    public function testPullSharingGroupsNotAllowedAsRegularUser(): void
+    {
+        $this->skipOpenApiValidations();
+        $this->setAuthToken(AuthKeysFixture::REGULAR_USER_API_KEY);
+        $url = sprintf('%s/%d', self::ENDPOINT, CerebratesFixture::SERVER_A_ID);
+        $this->get($url);
+
+        $this->assertResponseCode(405);
+    }
+}

tests/TestCase/Api/Cerebrates/ViewCerebrateApiTest.php

@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace App\Test\TestCase\Api\Cerebrates;
@@ -20,7 +19,7 @@ class ViewCerebrateApiTest extends TestCase
         'app.Cerebrates',
         'app.Roles',
         'app.Users',
-        'app.AuthKeys'
+        'app.AuthKeys',
     ];
 
     public function testViewCerebrateById(): void