From 29ca08ce608519f140e59ce0f4214c5f0893610f Mon Sep 17 00:00:00 2001
From: Sami Mokaddem <sami.mokaddem@circl.lu>
Date: Fri, 8 Oct 2021 16:57:38 +0200
Subject: [PATCH] new: [sidebar:bookmarks] Added early version of user-defined
 bookmarks

Bookmark configs are saved in their respective user setting for each users
---
 src/Controller/Component/ACLComponent.php     |  3 ++
 .../Component/NavigationComponent.php         | 30 +++++++++++++++++-
 src/Controller/UserSettingsController.php     | 16 ++++++++++
 src/Model/Table/UserSettingsTable.php         | 22 +++++++++++++
 templates/UserSettings/save_bookmark.php      | 30 ++++++++++++++++++
 templates/element/layouts/sidebar.php         | 31 +++++++++++++------
 .../element/layouts/sidebar/bookmark-add.php  | 11 +++++++
 .../layouts/sidebar/bookmark-entry.php        | 30 ++++++++++++++++++
 .../element/layouts/sidebar/category.php      |  2 +-
 webroot/css/layout.css                        | 19 ++++++++++++
 webroot/js/main.js                            |  9 ++++++
 11 files changed, 192 insertions(+), 11 deletions(-)
 create mode 100644 templates/UserSettings/save_bookmark.php
 create mode 100644 templates/element/layouts/sidebar/bookmark-add.php
 create mode 100644 templates/element/layouts/sidebar/bookmark-entry.php

diff --git a/src/Controller/Component/ACLComponent.php b/src/Controller/Component/ACLComponent.php
index 58c19fc..1376d96 100644
--- a/src/Controller/Component/ACLComponent.php
+++ b/src/Controller/Component/ACLComponent.php
@@ -457,6 +457,9 @@ class ACLComponent extends Component
     {
         $menu = $this->Navigation->getSideMenu();
         foreach ($menu as $group => $subMenu) {
+            if ($group == '__bookmarks') {
+                continue;
+            }
             foreach ($subMenu as $subMenuElementName => $subMenuElement) {
                 if (!empty($subMenuElement['url']) && !$this->checkAccessUrl($subMenuElement['url'], true) === true) {
                     unset($menu[$group][$subMenuElementName]);
diff --git a/src/Controller/Component/NavigationComponent.php b/src/Controller/Component/NavigationComponent.php
index b18a34b..f1ad538 100644
--- a/src/Controller/Component/NavigationComponent.php
+++ b/src/Controller/Component/NavigationComponent.php
@@ -50,9 +50,37 @@ class NavigationComponent extends Component
     public function getSideMenu(): array
     {
         $sidemenu = new Sidemenu($this->iconToTableMapping, $this->request);
-        return $sidemenu->get();
+        $sidemenu = $sidemenu->get();
+        $sidemenu = $this->addUserBookmarks($sidemenu);
+        return $sidemenu;
     }
 
+    
+    public function addUserBookmarks($sidemenu): array
+    {
+        $bookmarks = $this->getUserBookmarks();
+        $sidemenu = array_merge([
+            '__bookmarks' => $bookmarks
+        ], $sidemenu);
+        return $sidemenu;
+    }
+
+    public function getUserBookmarks(): array
+    {
+        $userSettingTable = TableRegistry::getTableLocator()->get('UserSettings');
+        $setting = $userSettingTable->getSettingByName($this->request->getAttribute('identity'), 'ui.sidebar.bookmarks');
+        $bookmarks = is_null($setting) ? [] : json_decode($setting->value, true);
+
+        $links = array_map(function($bookmark) {
+            return [
+                'name' => $bookmark['name'],
+                'label' => $bookmark['label'],
+                'url' => $bookmark['url'],
+            ];
+        }, $bookmarks);
+        return $links;
+    }
+    
     public function getBreadcrumb(): array
     {
         $controller = $this->request->getParam('controller');
diff --git a/src/Controller/UserSettingsController.php b/src/Controller/UserSettingsController.php
index 4da2ed4..99c212e 100644
--- a/src/Controller/UserSettingsController.php
+++ b/src/Controller/UserSettingsController.php
@@ -136,4 +136,20 @@ class UserSettingsController extends AppController
         }
         $this->set('settingName', $settingsName);
     }
+
+    public function saveBookmark()
+    {
+        if (!$this->request->is('get')) {
+            $result = $this->UserSettings->saveBookmark($this->ACL->getUser(), $this->request->getData());
+            $success = !empty($result);
+            $message = $success ? __('Bookmark saved') : __('Could not save bookmark');
+            $this->CRUD->setResponseForController('saveBookmark', $success, $message, $result);
+            $responsePayload = $this->CRUD->getResponsePayload();
+            if (!empty($responsePayload)) {
+                return $responsePayload;
+            }
+        }
+        $this->set('user_id', $this->ACL->getUser()->id);
+    }
+
 }
\ No newline at end of file
diff --git a/src/Model/Table/UserSettingsTable.php b/src/Model/Table/UserSettingsTable.php
index b4168f9..1e34b17 100644
--- a/src/Model/Table/UserSettingsTable.php
+++ b/src/Model/Table/UserSettingsTable.php
@@ -57,3 +57,25 @@ class UserSettingsTable extends AppTable
         $savedData = $this->save($setting);
         return $savedData;
     }
+
+    public function saveBookmark($user, $data)
+    {
+        $bookmarkSettingName = 'ui.sidebar.bookmarks';
+        $setting = $this->getSettingByName($user, $bookmarkSettingName);
+        $bookmarkData = [
+            'label' => $data['bookmark_label'],
+            'name' => $data['bookmark_name'],
+            'url' => $data['bookmark_url'],
+        ];
+        if (is_null($setting)) { // setting not found, create it
+            $bookmarksData = json_encode([$bookmarkData]);
+            $result = $this->createSetting($user, $bookmarkSettingName, $bookmarksData);
+        } else {
+            $bookmarksData = json_decode($setting->value);
+            $bookmarksData[] = $bookmarkData;
+            $bookmarksData = json_encode($bookmarksData);
+            $result = $this->editSetting($user, $bookmarkSettingName, $bookmarksData);
+        }
+        return $result;
+    }
+}
diff --git a/templates/UserSettings/save_bookmark.php b/templates/UserSettings/save_bookmark.php
new file mode 100644
index 0000000..e48626e
--- /dev/null
+++ b/templates/UserSettings/save_bookmark.php
@@ -0,0 +1,30 @@
+<?php
+    echo $this->element('genericElements/Form/genericForm', [
+        'data' => [
+            'title' => __('Add a bookmark'),
+            'description' => __('Specify the name and the URL of the bookmark which will be tied to your user profile.'),
+            'model' => 'UserSettings',
+            'fields' => [
+                [
+                    'field' => 'bookmark_name',
+                    'label' => __('Name'),
+                    'placeholder' => __('Home page'),
+                ],
+                [
+                    'field' => 'bookmark_label',
+                    'label' => __('Label'),
+                    'placeholder' => __('Home'),
+                ],
+                [
+                    'field' => 'bookmark_url',
+                    'label' => __('URL'),
+                    'placeholder' => '/instance/home',
+                ],
+            ],
+            'submit' => [
+                'action' => $this->request->getParam('action')
+            ]
+        ],
+    ]);
+?>
+</div>
diff --git a/templates/element/layouts/sidebar.php b/templates/element/layouts/sidebar.php
index 3c20ce7..4aeb15f 100644
--- a/templates/element/layouts/sidebar.php
+++ b/templates/element/layouts/sidebar.php
@@ -2,19 +2,32 @@
     <div class="sidebar-scroll">
         <div class="sidebar-content">
             <ul class="sidebar-elements">
-                <?php foreach ($menu as $category => $categorized): ?>
-                    <?= $this->element('layouts/sidebar/category', ['label' => $category]) ?>
-                    <?php foreach ($categorized as $parentName => $parent): ?>
-                        <?= $this->element('layouts/sidebar/entry', [
+                <?php foreach ($menu as $category => $categorized) : ?>
+                    <?php if ($category == '__bookmarks') : ?>
+                        <?= $this->element('layouts/sidebar/category', ['label' => __('Bookmarks'), 'class' => 'bookmark-categ']) ?>
+                        <li class="bookmarks">
+                            <?php foreach ($categorized as $parentName => $entry) : ?>
+                                <?= $this->element('layouts/sidebar/bookmark-entry', [
+                                    'entry' => $entry,
+                                ])
+                                ?>
+                            <?php endforeach; ?>
+                            <?= $this->element('layouts/sidebar/bookmark-add') ?>
+                        </li>
+                    <?php else : ?>
+                        <?= $this->element('layouts/sidebar/category', ['label' => $category]) ?>
+                        <?php foreach ($categorized as $parentName => $parent) : ?>
+                            <?= $this->element('layouts/sidebar/entry', [
                                 'parent' => $parent,
                             ])
-                        ?>
-                    <?php endforeach; ?>
+                            ?>
+                        <?php endforeach; ?>
+                    <?php endif; ?>
                 <?php endforeach; ?>
             </ul>
         </div>
     </div>
-    <span class="lock-sidebar align-self-center mt-auto w-100 d-none d-sm-block" onclick="$('.sidebar').toggleClass('expanded')">
-        <a type="button" class="btn btn-sm w-100"></a>
+    <span class="lock-sidebar align-self-center mt-auto w-100 d-none d-sm-block">
+        <a type="button" class="btn-lock-sidebar btn btn-sm w-100"></a>
     </span>
-</div>
+</div>
\ No newline at end of file
diff --git a/templates/element/layouts/sidebar/bookmark-add.php b/templates/element/layouts/sidebar/bookmark-add.php
new file mode 100644
index 0000000..8e906d2
--- /dev/null
+++ b/templates/element/layouts/sidebar/bookmark-add.php
@@ -0,0 +1,11 @@
+<?php
+echo $this->Bootstrap->button([
+    'nodeType' => 'a',
+    'icon' => 'plus',
+    'title' => __('Add new bookmark'),
+    'variant' => 'primary',
+    'size' => 'sm',
+    'params' => [
+        'id' => 'btn-add-bookmark',
+    ]
+]);
diff --git a/templates/element/layouts/sidebar/bookmark-entry.php b/templates/element/layouts/sidebar/bookmark-entry.php
new file mode 100644
index 0000000..f2d01c1
--- /dev/null
+++ b/templates/element/layouts/sidebar/bookmark-entry.php
@@ -0,0 +1,30 @@
+<?php
+    use Cake\Routing\Router;
+
+    $seed = 'sb-' . mt_rand();
+    $icon = $entry['icon'] ?? '';
+    $label = $entry['label'] ?? '';
+    $name = $entry['name'] ?? '';
+    $active = false;
+
+    $url = $entry['url'];
+
+    $currentURL = Router::url(null);
+    if ($url == $currentURL) {
+        $active = true;
+    }
+
+    echo $this->Bootstrap->button([
+        'nodeType' => 'a',
+        'text' => h($label),
+        'title' => h($name),
+        'variant' => 'dark',
+        'outline' => !$active,
+        'size' => 'sm',
+        'icon' => h($icon),
+        'class' => ['mb-1'],
+        'params' => [
+            'href' => h($url),
+        ]
+    ]);
+?>
diff --git a/templates/element/layouts/sidebar/category.php b/templates/element/layouts/sidebar/category.php
index 7c2be88..eaa4d00 100644
--- a/templates/element/layouts/sidebar/category.php
+++ b/templates/element/layouts/sidebar/category.php
@@ -1,4 +1,4 @@
-<li class="category text-muted">
+<li class="category text-muted <?= !empty($class) ? h($class) : '' ?>">
     <span class="category-label"><?= h($label) ?></span>
     <span class="category-divider"><hr /></span>
 </li>
diff --git a/webroot/css/layout.css b/webroot/css/layout.css
index bd7e88d..1e62241 100644
--- a/webroot/css/layout.css
+++ b/webroot/css/layout.css
@@ -243,11 +243,30 @@ ul.sidebar-elements > li {
     list-style: none;
 }
 
+ul.sidebar-elements li.bookmarks {
+    padding: 0 calc((var(--sidebar-width-collapsed) - 25px) / 2);
+}
+
 .sidebar.expanded ul.sidebar-elements li > a.sidebar-link,
 .sidebar:hover ul.sidebar-elements li > a.sidebar-link {
     text-overflow: ellipsis;
 }
 
+.sidebar ul.sidebar-elements li.bookmark-categ,
+.sidebar ul.sidebar-elements li.bookmarks {
+    display: none;
+}
+
+.sidebar.expanded ul.sidebar-elements li.bookmark-categ,
+.sidebar:hover ul.sidebar-elements li.bookmark-categ {
+    display: flex;
+}
+
+.sidebar.expanded ul.sidebar-elements li.bookmarks,
+.sidebar:hover ul.sidebar-elements li.bookmarks {
+    display: list-item;
+}
+
 ul.sidebar-elements li > a.sidebar-link {
     position: relative;
     display: block;
diff --git a/webroot/js/main.js b/webroot/js/main.js
index 4de4f5e..5f6bd46 100644
--- a/webroot/js/main.js
+++ b/webroot/js/main.js
@@ -177,3 +177,12 @@ $(document).ready(() => {
             value: expanded ? 0 : 1
         }, { provideFeedback: false})
     })
+
+    $('.sidebar #btn-add-bookmark').click(() => {
+        const url = '/user-settings/saveBookmark';
+        UI.submissionModal(url).then(([modalFactory, ajaxApi]) => {
+            const $input = modalFactory.$modal.find('input[name="bookmark_url"]')
+            $input.val(window.location.pathname)
+        })
+    })
+})