From 7ab8a93fbd73ad9054bedeb35dbae1e9d077a776 Mon Sep 17 00:00:00 2001 From: Sami Mokaddem Date: Fri, 8 Oct 2021 10:08:02 +0200 Subject: [PATCH] chg: [navigation] regrouped navigation related data into files --- .../Component/Navigation/Broods.php | 13 + .../Component/Navigation/EncryptionKeys.php | 8 + src/Controller/Component/Navigation/Inbox.php | 44 ++ .../Component/Navigation/Individuals.php | 8 + .../Component/Navigation/Instance.php | 26 + .../Component/Navigation/LocalTools.php | 49 ++ .../Component/Navigation/MetaTemplates.php | 42 ++ .../Component/Navigation/Organisations.php | 8 + .../Component/Navigation/Outbox.php | 43 ++ src/Controller/Component/Navigation/Roles.php | 8 + .../Component/Navigation/SharingGroups.php | 8 + src/Controller/Component/Navigation/Tags.php | 8 + src/Controller/Component/Navigation/base.php | 19 + .../Component/Navigation/sidemenu.php | 147 ++++ .../Component/NavigationComponent.php | 652 ++++++++---------- src/Controller/LocalToolsController.php | 2 + .../layouts/header/header-breadcrumb.php | 171 ++--- webroot/css/layout.css | 7 + 18 files changed, 820 insertions(+), 443 deletions(-) create mode 100644 src/Controller/Component/Navigation/Broods.php create mode 100644 src/Controller/Component/Navigation/EncryptionKeys.php create mode 100644 src/Controller/Component/Navigation/Inbox.php create mode 100644 src/Controller/Component/Navigation/Individuals.php create mode 100644 src/Controller/Component/Navigation/Instance.php create mode 100644 src/Controller/Component/Navigation/LocalTools.php create mode 100644 src/Controller/Component/Navigation/MetaTemplates.php create mode 100644 src/Controller/Component/Navigation/Organisations.php create mode 100644 src/Controller/Component/Navigation/Outbox.php create mode 100644 src/Controller/Component/Navigation/Roles.php create mode 100644 src/Controller/Component/Navigation/SharingGroups.php create mode 100644 src/Controller/Component/Navigation/Tags.php create mode 100644 src/Controller/Component/Navigation/base.php create mode 100644 src/Controller/Component/Navigation/sidemenu.php diff --git a/src/Controller/Component/Navigation/Broods.php b/src/Controller/Component/Navigation/Broods.php new file mode 100644 index 0000000..105c34a --- /dev/null +++ b/src/Controller/Component/Navigation/Broods.php @@ -0,0 +1,13 @@ +bcf->addLink('Broods', 'view', 'LocalTools', 'broodTools'); + $this->bcf->addLink('Broods', 'edit', 'LocalTools', 'broodTools'); + } +} diff --git a/src/Controller/Component/Navigation/EncryptionKeys.php b/src/Controller/Component/Navigation/EncryptionKeys.php new file mode 100644 index 0000000..e11c137 --- /dev/null +++ b/src/Controller/Component/Navigation/EncryptionKeys.php @@ -0,0 +1,8 @@ +bcf->addRoute('Inbox', 'index', $this->bcf->defaultCRUD('Inbox', 'index')); + $this->bcf->addRoute('Inbox', 'view', $this->bcf->defaultCRUD('Inbox', 'view')); + $this->bcf->addRoute('Inbox', 'discard', [ + 'label' => __('Discard request'), + 'icon' => 'trash', + 'url' => '/inbox/discard/{{id}}', + 'url_vars' => ['id' => 'id'], + ]); + $this->bcf->addRoute('Inbox', 'process', [ + 'label' => __('Process request'), + 'icon' => 'cogs', + 'url' => '/inbox/process/{{id}}', + 'url_vars' => ['id' => 'id'], + ]); + } + + public function addParents() + { + $this->bcf->addParent('Inbox', 'view', 'Inbox', 'index'); + $this->bcf->addParent('Inbox', 'discard', 'Inbox', 'index'); + $this->bcf->addParent('Inbox', 'process', 'Inbox', 'index'); + } + + public function addLinks() + { + $this->bcf->addSelfLink('Inbox', 'view'); + } + + public function addActions() + { + $this->bcf->addAction('Inbox', 'view', 'Inbox', 'process'); + $this->bcf->addAction('Inbox', 'view', 'Inbox', 'discard'); + + } +} diff --git a/src/Controller/Component/Navigation/Individuals.php b/src/Controller/Component/Navigation/Individuals.php new file mode 100644 index 0000000..e592e13 --- /dev/null +++ b/src/Controller/Component/Navigation/Individuals.php @@ -0,0 +1,8 @@ +bcf->addRoute('Instance', 'home', [ + 'label' => __('Home'), + 'url' => '/', + 'icon' => 'home' + ]); + $this->bcf->addRoute('Instance', 'settings', [ + 'label' => __('Settings'), + 'url' => '/instance/settings', + 'icon' => 'cogs' + ]); + $this->bcf->addRoute('Instance', 'migrationIndex', [ + 'label' => __('Database Migration'), + 'url' => '/instance/migrationIndex', + 'icon' => 'database' + ]); + } +} diff --git a/src/Controller/Component/Navigation/LocalTools.php b/src/Controller/Component/Navigation/LocalTools.php new file mode 100644 index 0000000..7ab2e72 --- /dev/null +++ b/src/Controller/Component/Navigation/LocalTools.php @@ -0,0 +1,49 @@ +bcf->addRoute('LocalTools', 'viewConnector', [ + 'label' => __('View'), + 'textGetter' => 'connector', + 'url' => '/localTools/viewConnector/{{connector}}', + 'url_vars' => ['connector' => 'connector'], + ]); + $this->bcf->addRoute('LocalTools', 'broodTools', [ + 'label' => __('Brood Tools'), + 'url' => '/localTools/broodTools/{{id}}', + 'url_vars' => ['id' => 'id'], + ]); + } + + public function addParents() + { + $this->bcf->addParent('LocalTools', 'viewConnector', 'LocalTools', 'index'); + } + + public function addLinks() + { + $passedData = $this->request->getParam('pass'); + if (!empty($passedData[0])) { + $brood_id = $passedData[0]; + $this->bcf->addParent('LocalTools', 'broodTools', 'Broods', 'view', [ + 'textGetter' => [ + 'path' => 'name', + 'varname' => 'broodEntity', + ], + 'url' => "/broods/view/{$brood_id}", + ]); + $this->bcf->addLink('LocalTools', 'broodTools', 'Broods', 'view', [ + 'url' => "/broods/view/{$brood_id}", + ]); + $this->bcf->addLink('LocalTools', 'broodTools', 'Broods', 'edit', [ + 'url' => "/broods/view/{$brood_id}", + ]); + } + $this->bcf->addSelfLink('LocalTools', 'broodTools'); + } +} diff --git a/src/Controller/Component/Navigation/MetaTemplates.php b/src/Controller/Component/Navigation/MetaTemplates.php new file mode 100644 index 0000000..91ba4eb --- /dev/null +++ b/src/Controller/Component/Navigation/MetaTemplates.php @@ -0,0 +1,42 @@ +bcf->addRoute('MetaTemplates', 'index', $this->bcf->defaultCRUD('MetaTemplates', 'index')); + $this->bcf->addRoute('MetaTemplates', 'view', $this->bcf->defaultCRUD('MetaTemplates', 'view')); + $this->bcf->addRoute('MetaTemplates', 'enable', [ + 'label' => __('Enable'), + 'icon' => 'check', + 'url' => '/metaTemplates/enable/{{id}}/enabled', + 'url_vars' => ['id' => 'id'], + ]); + $this->bcf->addRoute('MetaTemplates', 'set_default', [ + 'label' => __('Set as default'), + 'icon' => 'check', + 'url' => '/metaTemplates/toggle/{{id}}/default', + 'url_vars' => ['id' => 'id'], + ]); + } + + public function addParents() + { + $this->bcf->addParent('MetaTemplates', 'view', 'MetaTemplates', 'index'); + } + + public function addLinks() + { + $this->bcf->addSelfLink('MetaTemplates', 'view'); + } + + public function addActions() + { + $this->bcf->addAction('MetaTemplates', 'view', 'MetaTemplates', 'enable'); + $this->bcf->addAction('MetaTemplates', 'view', 'MetaTemplates', 'set_default'); + } +} diff --git a/src/Controller/Component/Navigation/Organisations.php b/src/Controller/Component/Navigation/Organisations.php new file mode 100644 index 0000000..3df07c1 --- /dev/null +++ b/src/Controller/Component/Navigation/Organisations.php @@ -0,0 +1,8 @@ +bcf->addRoute('Outbox', 'index', $this->bcf->defaultCRUD('Outbox', 'index')); + $this->bcf->addRoute('Outbox', 'view', $this->bcf->defaultCRUD('Outbox', 'view')); + $this->bcf->addRoute('Outbox', 'discard', [ + 'label' => __('Discard request'), + 'icon' => 'trash', + 'url' => '/outbox/discard/{{id}}', + 'url_vars' => ['id' => 'id'], + ]); + $this->bcf->addRoute('Outbox', 'process', [ + 'label' => __('Process request'), + 'icon' => 'cogs', + 'url' => '/outbox/process/{{id}}', + 'url_vars' => ['id' => 'id'], + ]); + } + + public function addParents() + { + $this->bcf->addParent('Outbox', 'view', 'Outbox', 'index'); + $this->bcf->addParent('Outbox', 'discard', 'Outbox', 'index'); + $this->bcf->addParent('Outbox', 'process', 'Outbox', 'index'); + } + + public function addLinks() + { + $this->bcf->addSelfLink('Outbox', 'view'); + } + + public function addActions() + { + $this->bcf->addAction('Outbox', 'view', 'Outbox', 'process'); + $this->bcf->addAction('Outbox', 'view', 'Outbox', 'discard'); + } +} diff --git a/src/Controller/Component/Navigation/Roles.php b/src/Controller/Component/Navigation/Roles.php new file mode 100644 index 0000000..b0501cb --- /dev/null +++ b/src/Controller/Component/Navigation/Roles.php @@ -0,0 +1,8 @@ +bcf = $bcf; + $this->request = $request; + } + + public function addRoutes() {} + public function addParents() {} + public function addLinks() {} + public function addActions() {} +} \ No newline at end of file diff --git a/src/Controller/Component/Navigation/sidemenu.php b/src/Controller/Component/Navigation/sidemenu.php new file mode 100644 index 0000000..fde9e92 --- /dev/null +++ b/src/Controller/Component/Navigation/sidemenu.php @@ -0,0 +1,147 @@ +iconTable = $iconTable; + $this->request = $request; + } + + public function get(): array + { + return [ + 'ContactDB' => [ + 'Individuals' => [ + 'label' => __('Individuals'), + 'icon' => $this->iconTable['Individuals'], + 'url' => '/individuals/index', + ], + 'Organisations' => [ + 'label' => __('Organisations'), + 'icon' => $this->iconTable['Organisations'], + 'url' => '/organisations/index', + ], + 'EncryptionKeys' => [ + 'label' => __('Encryption keys'), + 'icon' => $this->iconTable['EncryptionKeys'], + 'url' => '/encryptionKeys/index', + ] + ], + 'Trust Circles' => [ + 'SharingGroups' => [ + 'label' => __('Sharing Groups'), + 'icon' => $this->iconTable['SharingGroups'], + 'url' => '/sharingGroups/index', + ] + ], + 'Sync' => [ + 'Broods' => [ + 'label' => __('Broods'), + 'icon' => $this->iconTable['Broods'], + 'url' => '/broods/index', + ] + ], + 'Administration' => [ + 'Roles' => [ + 'label' => __('Roles'), + 'icon' => $this->iconTable['Roles'], + 'url' => '/roles/index', + ], + 'Users' => [ + 'label' => __('Users'), + 'icon' => $this->iconTable['Users'], + 'url' => '/users/index', + ], + 'UserSettings' => [ + 'label' => __('Users Settings'), + 'icon' => $this->iconTable['UserSettings'], + 'url' => '/user-settings/index', + ], + 'Messages' => [ + 'label' => __('Messages'), + 'icon' => $this->iconTable['Inbox'], + 'url' => '/inbox/index', + 'children' => [ + 'index' => [ + 'url' => '/inbox/index', + 'label' => __('Inbox') + ], + 'outbox' => [ + 'url' => '/outbox/index', + 'label' => __('Outbox') + ], + ] + ], + 'Add-ons' => [ + 'label' => __('Add-ons'), + 'icon' => 'puzzle-piece', + 'children' => [ + 'MetaTemplates.index' => [ + 'label' => __('Meta Field Templates'), + 'icon' => $this->iconTable['MetaTemplates'], + 'url' => '/metaTemplates/index', + ], + 'LocalTools.index' => [ + 'label' => __('Local Tools'), + 'icon' => $this->iconTable['LocalTools'], + 'url' => '/localTools/index', + ], + 'Tags.index' => [ + 'label' => __('Tags'), + 'icon' => $this->iconTable['Tags'], + 'url' => '/tags/index', + ], + ] + ], + 'Instance' => [ + 'label' => __('Instance'), + 'icon' => $this->iconTable['Instance'], + 'children' => [ + 'Settings' => [ + 'label' => __('Settings'), + 'url' => '/instance/settings', + 'icon' => 'cogs', + ], + 'Database' => [ + 'label' => __('Database'), + 'url' => '/instance/migrationIndex', + 'icon' => 'database', + ], + ] + ], + ], + 'Open' => [ + 'Organisations' => [ + 'label' => __('Organisations'), + 'icon' => $this->iconTable['Organisations'], + 'url' => '/open/organisations/index', + 'children' => [ + 'index' => [ + 'url' => '/open/organisations/index', + 'label' => __('List organisations') + ], + ], + 'open' => in_array('organisations', Configure::read('Cerebrate.open')) + ], + 'Individuals' => [ + 'label' => __('Individuals'), + 'icon' => $this->iconTable['Individuals'], + 'url' => '/open/individuals/index', + 'children' => [ + 'index' => [ + 'url' => '/open/individuals/index', + 'label' => __('List individuals') + ], + ], + 'open' => in_array('individuals', Configure::read('Cerebrate.open')) + ] + ] + ]; + } +} \ No newline at end of file diff --git a/src/Controller/Component/NavigationComponent.php b/src/Controller/Component/NavigationComponent.php index a183b7e..3fcde32 100644 --- a/src/Controller/Component/NavigationComponent.php +++ b/src/Controller/Component/NavigationComponent.php @@ -4,10 +4,16 @@ namespace App\Controller\Component; use Cake\Controller\Component; use Cake\Core\Configure; +use Cake\Core\App; use Cake\Utility\Inflector; use Cake\Utility\Hash; +use Cake\Filesystem\Folder; use Cake\Routing\Router; use Cake\ORM\TableRegistry; +use Exception; + +use SidemenuNavigation\Sidemenu; +require_once(APP . 'Controller' . DS . 'Component' . DS . 'Navigation' . DS . 'sidemenu.php'); class NavigationComponent extends Component { @@ -42,389 +48,311 @@ class NavigationComponent extends Component public function getSideMenu(): array { - return [ - 'ContactDB' => [ - 'Individuals' => [ - 'label' => __('Individuals'), - 'icon' => $this->iconToTableMapping['Individuals'], - 'url' => '/individuals/index', - ], - 'Organisations' => [ - 'label' => __('Organisations'), - 'icon' => $this->iconToTableMapping['Organisations'], - 'url' => '/organisations/index', - ], - 'EncryptionKeys' => [ - 'label' => __('Encryption keys'), - 'icon' => $this->iconToTableMapping['EncryptionKeys'], - 'url' => '/encryptionKeys/index', - ] - ], - 'Trust Circles' => [ - 'SharingGroups' => [ - 'label' => __('Sharing Groups'), - 'icon' => $this->iconToTableMapping['SharingGroups'], - 'url' => '/sharingGroups/index', - ] - ], - 'Sync' => [ - 'Broods' => [ - 'label' => __('Broods'), - 'icon' => $this->iconToTableMapping['Broods'], - 'url' => '/broods/index', - ] - ], - 'Administration' => [ - 'Roles' => [ - 'label' => __('Roles'), - 'icon' => $this->iconToTableMapping['Roles'], - 'url' => '/roles/index', - ], - 'Users' => [ - 'label' => __('Users'), - 'icon' => $this->iconToTableMapping['Users'], - 'url' => '/users/index', - ], - 'Messages' => [ - 'label' => __('Messages'), - 'icon' => $this->iconToTableMapping['Inbox'], - 'url' => '/inbox/index', - 'children' => [ - 'index' => [ - 'url' => '/inbox/index', - 'label' => __('Inbox') - ], - 'outbox' => [ - 'url' => '/outbox/index', - 'label' => __('Outbox') - ], - ] - ], - 'Add-ons' => [ - 'label' => __('Add-ons'), - 'icon' => 'puzzle-piece', - 'children' => [ - 'MetaTemplates.index' => [ - 'label' => __('Meta Field Templates'), - 'icon' => $this->iconToTableMapping['MetaTemplates'], - 'url' => '/metaTemplates/index', - ], - 'LocalTools.index' => [ - 'label' => __('Local Tools'), - 'icon' => $this->iconToTableMapping['LocalTools'], - 'url' => '/localTools/index', - ], - 'Tags.index' => [ - 'label' => __('Tags'), - 'icon' => $this->iconToTableMapping['Tags'], - 'url' => '/tags/index', - ], - ] - ], - 'Instance' => [ - 'label' => __('Instance'), - 'icon' => $this->iconToTableMapping['Instance'], - 'children' => [ - 'Settings' => [ - 'label' => __('Settings'), - 'url' => '/instance/settings', - 'icon' => 'cogs', - ], - 'Database' => [ - 'label' => __('Database'), - 'url' => '/instance/migrationIndex', - 'icon' => 'database', - ], - ] - ], - ], - 'Open' => [ - 'Organisations' => [ - 'label' => __('Organisations'), - 'icon' => $this->iconToTableMapping['Organisations'], - 'url' => '/open/organisations/index', - 'children' => [ - 'index' => [ - 'url' => '/open/organisations/index', - 'label' => __('List organisations') - ], - ], - 'open' => in_array('organisations', Configure::read('Cerebrate.open')) - ], - 'Individuals' => [ - 'label' => __('Individuals'), - 'icon' => $this->iconToTableMapping['Individuals'], - 'url' => '/open/individuals/index', - 'children' => [ - 'index' => [ - 'url' => '/open/individuals/index', - 'label' => __('List individuals') - ], - ], - 'open' => in_array('individuals', Configure::read('Cerebrate.open')) - ] - ] - ]; + $sidemenu = new Sidemenu($this->iconToTableMapping, $this->request); + return $sidemenu->get(); } public function getBreadcrumb(): array { $controller = $this->request->getParam('controller'); $action = $this->request->getParam('action'); - if (empty($this->fullBreadcrumb[$controller]['routes']["{$controller}:{$action}"])) { + if (empty($this->fullBreadcrumb[$controller][$action])) { return [[ 'label' => $controller, 'url' => Router::url(['controller' => $controller, 'action' => $action]), ]]; // no breadcrumb defined for this endpoint } - $currentRoute = $this->fullBreadcrumb[$controller]['routes']["{$controller}:{$action}"]; - $breadcrumbPath = $this->getBreadcrumbPath("{$controller}:{$action}", $currentRoute); - return $breadcrumbPath['objects']; + $currentRoute = $this->fullBreadcrumb[$controller][$action]; + $breadcrumbPath = $this->getBreadcrumbPath($currentRoute); + return $breadcrumbPath; } - public function getBreadcrumbPath(string $startRoute, array $currentRoute): array + public function getBreadcrumbPath(array $currentRoute): array { - $route = $startRoute; - $path = [ - 'routes' => [], - 'objects' => [], - ]; - $visited = []; - while (empty($visited[$route])) { - $visited[$route] = true; - $path['routes'][] = $route; - $path['objects'][] = $currentRoute; + $path = []; + $visitedURL = []; + while (empty($visitedURL[$currentRoute['url']])) { + $visitedURL[$currentRoute['url']] = true; + $path[] = $currentRoute; if (!empty($currentRoute['after'])) { - $route = $currentRoute['after']; - $split = explode(':', $currentRoute['after']); - $currentRoute = $this->fullBreadcrumb[$split[0]]['routes'][$currentRoute['after']]; + if (is_callable($currentRoute['after'])) { + $route = $currentRoute['after'](); + } else { + $route = $currentRoute['after']; + } + if (empty($route)) { + continue; + } + $currentRoute = $route; } } - $path['routes'] = array_reverse($path['routes']); - $path['objects'] = array_reverse($path['objects']); + $path = array_reverse($path); return $path; } - private function insertInheritance(array $config, array $fullConfig): array - { - if (!empty($config['routes'])) { - foreach ($config['routes'] as $routeName => $value) { - $config['routes'][$routeName]['route_path'] = $routeName; - if (!empty($value['inherit'])) { - $default = $config['defaults'][$value['inherit']] ?? []; - $config['routes'][$routeName] = array_merge($config['routes'][$routeName], $default); - unset($config['routes'][$routeName]['inherit']); - } - } - } - return $config; - } - - private function insertRelated(array $config, array $fullConfig): array - { - if (!empty($config['routes'])) { - foreach ($config['routes'] as $routeName => $value) { - if (!empty($value['links'])) { - foreach ($value['links'] as $i => $linkedRoute) { - $split = explode(':', $linkedRoute); - if (!empty($fullConfig[$split[0]]['routes'][$linkedRoute])) { - $linkedRouteObject = $fullConfig[$split[0]]['routes'][$linkedRoute]; - if (!empty($linkedRouteObject)) { - $config['routes'][$routeName]['links'][$i] = $linkedRouteObject; - continue; - } - } - unset($config['routes'][$routeName]['links'][$i]); - } - } - if (!empty($value['actions'])) { - foreach ($value['actions'] as $i => $linkedRoute) { - $split = explode(':', $linkedRoute); - if (!empty($fullConfig[$split[0]]['routes'][$linkedRoute])) { - $linkedRouteObject = $fullConfig[$split[0]]['routes'][$linkedRoute]; - if (!empty($linkedRouteObject)) { - $config['routes'][$routeName]['actions'][$i] = $linkedRouteObject; - continue; - } - } - unset($config['routes'][$routeName]['actions'][$i]); - } - } - } - } - return $config; - } - - public function getDefaultCRUDConfig(string $controller, array $overrides=[], array $merges=[]): array - { - $table = TableRegistry::getTableLocator()->get($controller); - $default = [ - 'defaults' => [ - 'depth-1' => [ - 'after' => "{$controller}:index", - 'textGetter' => !empty($table->getDisplayField()) ? $table->getDisplayField() : 'id', - 'links' => [ - "{$controller}:view", - "{$controller}:edit", - ], - 'actions' => [ - "{$controller}:delete", - ], - ] - ], - 'routes' => [ - "{$controller}:index" => [ - 'label' => Inflector::humanize($controller), - 'url' => "/{$controller}/index", - 'icon' => $this->iconToTableMapping[$controller] - ], - "{$controller}:view" => [ - 'label' => __('View'), - 'icon' => 'eye', - 'inherit' => 'depth-1', - 'url' => "/{$controller}/view/{{id}}", - 'url_vars' => ['id' => 'id'], - ], - "{$controller}:edit" => [ - 'label' => __('Edit'), - 'icon' => 'edit', - 'inherit' => 'depth-1', - 'url' => "/{$controller}/edit/{{id}}", - 'url_vars' => ['id' => 'id'], - ], - "{$controller}:delete" => [ - 'label' => __('Delete'), - 'icon' => 'trash', - 'inherit' => 'depth-1', - 'url' => "/{$controller}/delete/{{id}}", - 'url_vars' => ['id' => 'id'], - ], - ] - ]; - $merged = array_merge_recursive($default, $merges); - $overridden = array_replace_recursive($merged, $overrides); - return $overridden; - } - public function genBreadcrumb(): array { - $fullConfig = [ - 'Individuals' => $this->getDefaultCRUDConfig('Individuals'), - 'Organisations' => $this->getDefaultCRUDConfig('Organisations'), - 'EncryptionKeys' => $this->getDefaultCRUDConfig('EncryptionKeys'), - 'SharingGroups' => $this->getDefaultCRUDConfig('SharingGroups'), - 'Broods' => $this->getDefaultCRUDConfig('Broods', [], [ - 'defaults' => ['depth-1' => ['links' => 'LocalTools:brood_tools']] - ]), - 'Roles' => $this->getDefaultCRUDConfig('Roles'), - 'Users' => $this->getDefaultCRUDConfig('Users'), - 'Inbox' => $this->getDefaultCRUDConfig('Inbox', [ - 'defaults' => ['depth-1' => [ - 'links' => ['Inbox:view', 'Inbox:process'], - 'actions' => ['Inbox:process', 'Inbox:delete'], - ]] - ], [ - 'routes' => [ - 'Inbox:discard' => [ - 'label' => __('Discard request'), - 'inherit' => 'depth-1', - 'url' => '/inbox/discard/{{id}}', - 'url_vars' => ['id' => 'id'], - ], - 'Inbox:process' => [ - 'label' => __('Process request'), - 'inherit' => 'depth-1', - 'url' => '/inbox/process/{{id}}', - 'url_vars' => ['id' => 'id'], - ], - ] - ]), - 'Outbox' => $this->getDefaultCRUDConfig('Outbox', [ - 'defaults' => ['depth-1' => [ - 'links' => ['Outbox:view', 'Outbox:process'], - 'actions' => ['Outbox:process', 'Outbox:delete'], - ]] - ], [ - 'routes' => [ - 'Outbox:discard' => [ - 'label' => __('Discard request'), - 'inherit' => 'depth-1', - 'url' => '/outbox/discard/{{id}}', - 'url_vars' => ['id' => 'id'], - ], - 'Outbox:process' => [ - 'label' => __('Process request'), - 'inherit' => 'depth-1', - 'url' => '/outbox/process/{{id}}', - 'url_vars' => ['id' => 'id'], - ], - ] - ]), - 'MetaTemplates' => $this->getDefaultCRUDConfig('MetaTemplates', [ - 'defaults' => ['depth-1' => [ - 'links' => ['MetaTemplates:view', ''], // '' to remove leftovers. Related to https://www.php.net/manual/en/function.array-replace-recursive.php#124705 - 'actions' => ['MetaTemplates:toggle'], - ]] - ], [ - 'routes' => [ - 'MetaTemplates:toggle' => [ - 'label' => __('Toggle Meta-template'), - 'inherit' => 'depth-1', - 'url' => '/MetaTemplates/toggle/{{id}}', - 'url_vars' => ['id' => 'id'], - ], - ] - ]), - 'Tags' => $this->getDefaultCRUDConfig('Tags', [ - 'defaults' => ['depth-1' => ['textGetter' => 'name']] - ]), - 'LocalTools' => [ - 'routes' => [ - 'LocalTools:index' => [ - 'label' => __('Local Tools'), - 'url' => '/localTools/index', - 'icon' => $this->iconToTableMapping['LocalTools'], - ], - 'LocalTools:viewConnector' => [ - 'label' => __('View'), - 'textGetter' => 'name', - 'url' => '/localTools/viewConnector/{{connector}}', - 'url_vars' => ['connector' => 'connector'], - 'after' => 'LocalTools:index', - ], - 'LocalTools:broodTools' => [ - 'label' => __('Brood Tools'), - 'url' => '/localTools/broodTools/{{id}}', - 'url_vars' => ['id' => 'id'], - ], - ] - ], - 'Instance' => [ - 'routes' => [ - 'Instance:home' => [ - 'label' => __('Home'), - 'url' => '/', - 'icon' => 'home' - ], - 'Instance:settings' => [ - 'label' => __('Settings'), - 'url' => '/instance/settings', - 'icon' => 'cogs' - ], - 'Instance:migrationIndex' => [ - 'label' => __('Database Migration'), - 'url' => '/instance/migrationIndex', - 'icon' => 'database' - ], - ] - ] - ]; - foreach ($fullConfig as $controller => $config) { - $fullConfig[$controller] = $this->insertInheritance($config, $fullConfig); - } - foreach ($fullConfig as $controller => $config) { - $fullConfig[$controller] = $this->insertRelated($config, $fullConfig); - } + $request = $this->request; + $bcf = new BreadcrumbFactory($this->iconToTableMapping); + $fullConfig = $this->getFullConfig($bcf, $this->request); return $fullConfig; } -} \ No newline at end of file + + private function loadNavigationClasses($bcf, $request) + { + $navigationClasses = []; + $navigationDir = new Folder(APP . DS . 'Controller' . DS . 'Component' . DS . 'Navigation'); + $navigationFiles = $navigationDir->find('.*\.php', true); + foreach ($navigationFiles as $navigationFile) { + if ($navigationFile == 'base.php' || $navigationFile == 'sidemenu.php') { + continue; + } + $navigationClassname = str_replace('.php', '', $navigationFile); + require_once(APP . 'Controller' . DS . 'Component' . DS . 'Navigation' . DS . $navigationFile); + $reflection = new \ReflectionClass("BreadcrumbNavigation\\{$navigationClassname}Navigation"); + $navigationClasses[$navigationClassname] = $reflection->newInstance($bcf, $request); + } + return $navigationClasses; + } + + public function getFullConfig($bcf, $request) + { + $navigationClasses = $this->loadNavigationClasses($bcf, $request); + $CRUDControllers = [ + 'Individuals', + 'Organisations', + 'EncryptionKeys', + 'SharingGroups', + 'Broods', + 'Roles', + 'Users', + 'Tags', + 'LocalTools', + ]; + foreach ($CRUDControllers as $controller) { + $bcf->setDefaultCRUDForModel($controller); + } + + foreach ($navigationClasses as $className => $class) { + $class->addRoutes(); + } + foreach ($navigationClasses as $className => $class) { + $class->addParents(); + } + foreach ($navigationClasses as $className => $class) { + $class->addLinks(); + } + foreach ($navigationClasses as $className => $class) { + $class->addActions(); + } + return $bcf->getEndpoints(); + } +} + +class BreadcrumbFactory +{ + private $endpoints = []; + private $iconToTableMapping = []; + + public function __construct($iconToTableMapping) + { + $this->iconToTableMapping = $iconToTableMapping; + } + + public function defaultCRUD(string $controller, string $action, array $overrides = []): array + { + $table = TableRegistry::getTableLocator()->get($controller); + $item = []; + if ($action === 'index') { + $item = $this->genRouteConfig($controller, $action, [ + 'label' => __('{0} index', Inflector::humanize($controller)), + 'url' => "/{$controller}/index", + 'icon' => $this->iconToTableMapping[$controller] + ]); + } else if ($action === 'view') { + $item = $this->genRouteConfig($controller, $action, [ + 'label' => __('View'), + 'icon' => 'eye', + 'url' => "/{$controller}/view/{{id}}", + 'url_vars' => ['id' => 'id'], + 'textGetter' => !empty($table->getDisplayField()) ? $table->getDisplayField() : 'id', + ]); + } else if ($action === 'add') { + $item = $this->genRouteConfig($controller, $action, [ + 'label' => __('[new {0}]', $controller), + 'icon' => 'plus', + 'url' => "/{$controller}/add", + ]); + } else if ($action === 'edit') { + $item = $this->genRouteConfig($controller, $action, [ + 'label' => __('Edit'), + 'icon' => 'edit', + 'url' => "/{$controller}/edit/{{id}}", + 'url_vars' => ['id' => 'id'], + 'textGetter' => !empty($table->getDisplayField()) ? $table->getDisplayField() : 'id', + ]); + } else if ($action === 'delete') { + $item = $this->genRouteConfig($controller, $action, [ + 'label' => __('Delete'), + 'icon' => 'trash', + 'url' => "/{$controller}/delete/{{id}}", + 'url_vars' => ['id' => 'id'], + 'textGetter' => !empty($table->getDisplayField()) ? $table->getDisplayField() : 'id', + ]); + } + $item['route_path'] = "{$controller}:{$action}"; + $item = array_merge($item, $overrides); + return $item; + } + + public function genRouteConfig($controller, $action, $config = []) + { + $routeConfig = [ + 'controller' => $controller, + 'action' => $action, + 'route_path' => "{$controller}:{$action}", + ]; + $routeConfig = $this->addIfNotEmpty($routeConfig, $config, 'url'); + $routeConfig = $this->addIfNotEmpty($routeConfig, $config, 'url_vars'); + $routeConfig = $this->addIfNotEmpty($routeConfig, $config, 'icon'); + $routeConfig = $this->addIfNotEmpty($routeConfig, $config, 'label'); + $routeConfig = $this->addIfNotEmpty($routeConfig, $config, 'textGetter'); + return $routeConfig; + } + + private function addIfNotEmpty($arr, $data, $key, $default = null) + { + if (!empty($data[$key])) { + $arr[$key] = $data[$key]; + } else { + if (!is_null($default)) { + $arr[$key] = $default; + } + } + return $arr; + } + + public function addRoute($controller, $action, $config = []) { + $this->endpoints[$controller][$action] = $this->genRouteConfig($controller, $action, $config); + } + + public function setDefaultCRUDForModel($controller) + { + $this->addRoute($controller, 'index', $this->defaultCRUD($controller, 'index')); + $this->addRoute($controller, 'view', $this->defaultCRUD($controller, 'view')); + $this->addRoute($controller, 'add', $this->defaultCRUD($controller, 'add')); + $this->addRoute($controller, 'edit', $this->defaultCRUD($controller, 'edit')); + $this->addRoute($controller, 'delete', $this->defaultCRUD($controller, 'delete')); + + $this->addParent($controller, 'view', $controller, 'index'); + $this->addParent($controller, 'add', $controller, 'index'); + $this->addParent($controller, 'edit', $controller, 'index'); + $this->addParent($controller, 'delete', $controller, 'index'); + + $this->addSelfLink($controller, 'view'); + $this->addLink($controller, 'view', $controller, 'edit'); + $this->addLink($controller, 'edit', $controller, 'view'); + $this->addSelfLink($controller, 'edit'); + + $this->addAction($controller, 'view', $controller, 'add'); + $this->addAction($controller, 'view', $controller, 'delete'); + $this->addAction($controller, 'edit', $controller, 'add'); + $this->addAction($controller, 'edit', $controller, 'delete'); + } + + public function get($controller, $action) + { + if (empty($this->endpoints[$controller]) || empty($this->endpoints[$controller][$action])) { + throw new \Exception(sprintf("Tried to add a reference to %s:%s which does not exists", $controller, $action), 1); + } + return $this->endpoints[$controller][$action]; + } + + public function getEndpoints() + { + return $this->endpoints; + } + + public function addParent(string $sourceController, string $sourceAction, string $targetController, string $targetAction, $overrides = []) + { + $routeSourceConfig = $this->get($sourceController, $sourceAction); + $routeTargetConfig = $this->get($targetController, $targetAction); + $overrides = $this->execClosureIfNeeded($overrides, $routeSourceConfig); + if (!is_array($overrides)) { + throw new \Exception(sprintf("Override closure for %s:%s -> %s:%s must return an array", $sourceController, $sourceAction, $targetController, $targetAction), 1); + } + $routeTargetConfig = array_merge($routeTargetConfig, $overrides); + $parents = array_merge($routeSourceConfig['after'] ?? [], $routeTargetConfig); + $this->endpoints[$sourceController][$sourceAction]['after'] = $parents; + } + + public function addSelfLink(string $controller, string $action) + { + $this->addLink($controller, $action, $controller, $action, [ + 'selfLink' => true + ]); + } + + public function addLink(string $sourceController, string $sourceAction, string $targetController, string $targetAction, $overrides = []) + { + $routeSourceConfig = $this->getRouteConfig($sourceController, $sourceAction, true); + $routeTargetConfig = $this->getRouteConfig($targetController, $targetAction); + $overrides = $this->execClosureIfNeeded($overrides, $routeSourceConfig); + if (is_null($overrides)) { + // Overrides is null, the link should not be added + return; + } + if (!is_array($overrides)) { + throw new \Exception(sprintf("Override closure for %s:%s -> %s:%s must return an array", $sourceController, $sourceAction, $targetController, $targetAction), 1); + } + $routeTargetConfig = array_merge($routeTargetConfig, $overrides); + $links = array_merge($routeSourceConfig['links'] ?? [], [$routeTargetConfig]); + $this->endpoints[$sourceController][$sourceAction]['links'] = $links; + } + + public function addAction(string $sourceController, string $sourceAction, string $targetController, string $targetAction, $overrides = []) + { + $routeSourceConfig = $this->getRouteConfig($sourceController, $sourceAction, true); + $routeTargetConfig = $this->getRouteConfig($targetController, $targetAction); + $overrides = $this->execClosureIfNeeded($overrides, $routeSourceConfig); + if (!is_array($overrides)) { + throw new \Exception(sprintf("Override closure for %s:%s -> %s:%s must return an array", $sourceController, $sourceAction, $targetController, $targetAction), 1); + } + $routeTargetConfig = array_merge($routeTargetConfig, $overrides); + $links = array_merge($routeSourceConfig['actions'] ?? [], [$routeTargetConfig]); + $this->endpoints[$sourceController][$sourceAction]['actions'] = $links; + } + + public function removeLink(string $sourceController, string $sourceAction, string $targetController, string $targetAction) + { + $routeSourceConfig = $this->getRouteConfig($sourceController, $sourceAction, true); + if (!empty($routeSourceConfig['links'])) { + foreach ($routeSourceConfig['links'] as $i => $routeConfig) { + if ($routeConfig['controller'] == $targetController && $routeConfig['action'] == $targetAction) { + unset($routeSourceConfig['links'][$i]); + $this->endpoints[$sourceController][$sourceAction]['links'] = $routeSourceConfig['links']; + break; + } + } + } + } + + public function getRouteConfig($controller, $action, $fullRoute = false) + { + $routeConfig = $this->get($controller, $action); + if (empty($fullRoute)) { + unset($routeConfig['after']); + unset($routeConfig['links']); + unset($routeConfig['actions']); + } + return $routeConfig; + } + + private function execClosureIfNeeded($closure, $routeConfig=[]) + { + if (is_callable($closure)) { + return $closure($routeConfig); + } + return $closure; + } +} diff --git a/src/Controller/LocalToolsController.php b/src/Controller/LocalToolsController.php index 901407a..55340f4 100644 --- a/src/Controller/LocalToolsController.php +++ b/src/Controller/LocalToolsController.php @@ -280,6 +280,8 @@ class LocalToolsController extends AppController return $this->RestResponse->viewData($tools, 'json'); } $this->set('id', $id); + $brood = $this->Broods->get($id); + $this->set('broodEntity', $brood); $this->set('data', $tools); $this->set('metaGroup', 'Administration'); } diff --git a/templates/element/layouts/header/header-breadcrumb.php b/templates/element/layouts/header/header-breadcrumb.php index 5c4c619..bd72eba 100644 --- a/templates/element/layouts/header/header-breadcrumb.php +++ b/templates/element/layouts/header/header-breadcrumb.php @@ -1,104 +1,113 @@ request->getParam('controller'); - $action = $this->request->getParam('action'); - $curentPath = "{$controller}{$action}"; +use Cake\Core\Configure; +use Cake\Routing\Router; - $breadcrumbLinks = ''; - $breadcrumbAction = ''; - $this->Breadcrumbs->setTemplates([ - 'wrapper' => sprintf( - '' - ), - 'item' => '
  • {{title}}
    • {{separator}}', - 'itemWithoutLink' => '
  • {{title}}
    • {{separator}}', - 'separator' => '
    • ' - ]); +$controller = $this->request->getParam('controller'); +$action = $this->request->getParam('action'); +$curentPath = "{$controller}{$action}"; +$entity = !empty($entity) ? $entity : []; - if (!empty($breadcrumb)) { - foreach ($breadcrumb as $i => $entry) { - if (!empty($entry['textGetter'])) { +$breadcrumbLinks = ''; +$breadcrumbAction = ''; +$this->Breadcrumbs->setTemplates([ + 'wrapper' => sprintf( + '' + ), + 'item' => '
  • {{title}}
    • {{separator}}', + 'itemWithoutLink' => '
  • {{title}}
    • {{separator}}', + 'separator' => '
    • ' +]); + +if (!empty($breadcrumb)) { + foreach ($breadcrumb as $i => $entry) { + if (!empty($entry['textGetter'])) { + if (is_array($entry['textGetter']) && !empty($entry['textGetter']['path'])) { + $data = !empty(${$entry['textGetter']['varname']}) ? ${$entry['textGetter']['varname']} : $entity; + $entry['label'] = Cake\Utility\Hash::get($data, $entry['textGetter']['path']); + } else { $entry['label'] = Cake\Utility\Hash::get($entity, $entry['textGetter']); } - if (!empty($entry['url_vars'])) { - $entry['url'] = $this->DataFromPath->buildStringFromDataPath($entry['url'], $entity, $entry['url_vars']); - } - $this->Breadcrumbs->add(h($entry['label']), Router::url($entry['url']), [ - 'title' => h($entry['label']), - 'templateVars' => [ - 'linkClass' => $i == 0 ? 'fw-light' : '', - 'icon' => ($i == 0 && !empty($entry['icon'])) ? $this->FontAwesome->getClass(h($entry['icon'])) : '' - ] - ]); } - - $lastCrumb = $breadcrumb[count($breadcrumb)-1]; + if (empty($entry['label'])) { + $entry['label'] = "[{$entry['textGetter']}]"; + } + if (!empty($entry['url_vars'])) { + $entry['url'] = $this->DataFromPath->buildStringFromDataPath($entry['url'], $entity, $entry['url_vars']); + } + $this->Breadcrumbs->add(h($entry['label']), Router::url($entry['url']), [ + 'title' => h($entry['label']), + 'templateVars' => [ + 'linkClass' => $i == 0 ? 'fw-light' : '', + 'icon' => ($i == 0 && !empty($entry['icon'])) ? $this->FontAwesome->getClass(h($entry['icon'])) : '' + ] + ]); + } - if (!empty($lastCrumb['links'])) { - foreach ($lastCrumb['links'] as $i => $linkEntry) { - $active = $linkEntry['route_path'] == $lastCrumb['route_path']; - if (!empty($linkEntry['url_vars'])) { - $linkEntry['url'] = $this->DataFromPath->buildStringFromDataPath($linkEntry['url'], $entity, $linkEntry['url_vars']); - } - $breadcrumbLinks .= sprintf('%s', - $active ? 'secondary' : 'outline-secondary', - Router::url($linkEntry['url']), - h($linkEntry['label']) - ); + $lastCrumb = $breadcrumb[count($breadcrumb) - 1]; + + if (!empty($lastCrumb['links'])) { + // dd($lastCrumb['links']); + foreach ($lastCrumb['links'] as $i => $linkEntry) { + $active = $linkEntry['route_path'] == $lastCrumb['route_path']; + if (!empty($linkEntry['url_vars'])) { + $linkEntry['url'] = $this->DataFromPath->buildStringFromDataPath($linkEntry['url'], $entity, $linkEntry['url_vars']); } - } - if (!empty($lastCrumb['actions'])) { - foreach ($lastCrumb['actions'] as $i => $actionEntry) { - if (!empty($actionEntry['url_vars'])) { - $actionEntry['url'] = $this->DataFromPath->buildStringFromDataPath($actionEntry['url'], $entity, $actionEntry['url_vars']); - } - $breadcrumbAction .= sprintf('%s', - Router::url($actionEntry['url']), - !empty($entry['icon']) ? $this->FontAwesome->getClass(h($actionEntry['icon'])) : '', - h($actionEntry['label']) - ); + if (!empty($linkEntry['selfLink'])) { + $url = Router::url(null); + } else { + $url = Router::url($linkEntry['url']); } + $breadcrumbLinks .= sprintf( + '%s', + $active ? 'secondary' : 'outline-secondary', + $url, + h($linkEntry['label']) + ); } } + if (!empty($lastCrumb['actions'])) { + foreach ($lastCrumb['actions'] as $i => $actionEntry) { + if (!empty($actionEntry['url_vars'])) { + $actionEntry['url'] = $this->DataFromPath->buildStringFromDataPath($actionEntry['url'], $entity, $actionEntry['url_vars']); + } + $breadcrumbAction .= sprintf( + '%s', + Router::url($actionEntry['url']), + !empty($actionEntry['icon']) ? $this->FontAwesome->getClass(h($actionEntry['icon'])) : '', + h($actionEntry['label']) + ); + } + } +} ?> Breadcrumbs->render( - [], - ['separator' => ''] - ); +echo $this->Breadcrumbs->render( + [], + ['separator' => ''] +); ?> - -
    - + +
    + - -
    - - -
    - + +
    + + + +
    + +
    +
    -
    - + - -
    - -
    - +
    -
    - - - -
    \ No newline at end of file diff --git a/webroot/css/layout.css b/webroot/css/layout.css index 8016e00..bd7e88d 100644 --- a/webroot/css/layout.css +++ b/webroot/css/layout.css @@ -184,6 +184,13 @@ main.content { .global-search-container #globalSearch { padding-right: 26px; + width: 280px; + transition: border-color 0.15s ease-in-out, box-shadow 0.15s ease-in-out, width 0.3s; + -webkit-transition: border-color 0.15s ease-in-out, box-shadow 0.15s ease-in-out, width 0.3s; +} + +.global-search-container #globalSearch:focus { + width: 380px !important; } .top-navbar .global-search-container .search-input-container > i.icon {