release v1.15.0

- add a controller to retrieve most of the configuration

ISSUE_TEMPLATE.md

@@ -15,8 +15,10 @@
 ### Environment
 
 * Side menu version: ...
+* Nextcloud version: ...
 * PHP version: ...
 * Web server (Nginx, Apache2): ...
+* Web browser and version (Firefox 80, Google Chrome 74, etc): ...
 
 ### Steps to reproduce
 

README.md

@@ -1,7 +1,7 @@
-🤙 Nextcloud app / Side menu 🎨
+🤙 Nextcloud app / Custom menu 🎨
 ===============================
 
-Side menu allows you to modify the position of the main menu by creating a panel on the left of the interface or with a big menu on the top.
+Allows you to modify the position of the main menu by creating a panel on the left of the interface or with a big menu on the top.
 You can also define apps that must be displayed in the top menu. Fully customisable.
 
 This application is rather suitable for instances that activate a lot of applications.
@@ -17,7 +17,7 @@ You like this app and you want to support me? [Buy me a coffee](https://www.buym
 Installation and upgrade
 ------------------------
 
-Side menu is availabe from the app store. If you want to install it from source: go to https://gitnet.fr/deblan/side_menu/releases and download the last release (side_menu_vX.Y.Z.zip). Copy the content into `apps`.
+Custom menu is available from the app store. If you want to install it from source: go to https://gitnet.fr/deblan/side_menu/releases and download the last release (side_menu_vX.Y.Z.zip). Copy the content into `apps`.
 
 ```
 $ cd /path/to/nextcloud/apps

appinfo/info.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <info>
     <id>side_menu</id>
-    <name>Side menu</name>
+    <name>Custom menu</name>
     <summary>Modify the display of the menu.</summary>
     <description><![CDATA[Side menu allows you to modify the position of the main menu by creating a panel on the left of the interface or with a big menu on the top.
 You can also define apps that must be displayed in the top menu. Fully customisable.
@@ -14,10 +14,14 @@ Comptatible with AppOrder.
 
 You can report a bug or request a feature by opening an issue.
 
+You like this app and you want to support me?
+
+* ☕ [Buy me a coffee](https://www.buymeacoffee.com/deblan)
+* 😃 [Leave a comment](https://apps.nextcloud.com/apps/side_menu#comments)
 ]]></description>
     <licence>agpl</licence>
     <author mail="contact@deblan.fr" homepage="https://www.deblan.io/">Simon Vieille</author>
-    <version>1.12.2</version>
+    <version>1.15.0</version>
     <namespace>SideMenu</namespace>
     <category>customization</category>
     <website>https://gitnet.fr/deblan/side_menu</website>

appinfo/routes.php

@@ -21,6 +21,7 @@ return [
     'routes' => [
 		['name' => 'Css#stylesheet', 'url' => '/css/stylesheet', 'verb' => 'GET'],
 		['name' => 'Js#script', 'url' => '/js/script', 'verb' => 'GET'],
+		['name' => 'Js#config', 'url' => '/js/config', 'verb' => 'GET'],
 		['name' => 'Nav#items', 'url' => '/nav/items', 'verb' => 'GET'],
 		['name' => 'PersonalSetting#valueSet', 'url' => '/personalSetting/valueSet', 'verb' => 'POST'],
     ],

img/icon.svg

@@ -0,0 +1,113 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="37.099998mm"
+   height="37.099998mm"
+   viewBox="0 0 37.099998 37.099998"
+   version="1.1"
+   id="svg8"
+   inkscape:version="0.92.4 (5da689c313, 2019-01-14)"
+   sodipodi:docname="icon.svg">
+  <defs
+     id="defs2" />
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="2.8"
+     inkscape:cx="242.1839"
+     inkscape:cy="32.026866"
+     inkscape:document-units="mm"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     fit-margin-top="0"
+     fit-margin-left="0"
+     fit-margin-right="0"
+     fit-margin-bottom="0"
+     inkscape:window-width="1918"
+     inkscape:window-height="1027"
+     inkscape:window-x="1920"
+     inkscape:window-y="21"
+     inkscape:window-maximized="0"
+     inkscape:snap-nodes="false" />
+  <metadata
+     id="metadata5">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="Calque 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-59.922223,-92.669069)">
+    <rect
+       style="color:#000000;display:inline;overflow:visible;visibility:visible;opacity:1;vector-effect:none;fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:#1a1a1a;stroke-width:1.46500015;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;paint-order:fill markers stroke;enable-background:accumulate"
+       id="rect815-6-2-7"
+       width="34.535"
+       height="34.535"
+       x="61.204723"
+       y="93.951569"
+       rx="5.4806547"
+       ry="5.4806547" />
+    <rect
+       style="color:#000000;display:inline;overflow:visible;visibility:visible;opacity:1;vector-effect:none;fill:#ececec;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:1.46500015;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;paint-order:fill markers stroke;enable-background:accumulate"
+       id="rect815-6-7"
+       width="20.357224"
+       height="33.40107"
+       x="61.677193"
+       y="94.518532"
+       rx="0"
+       ry="0" />
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#333333;stroke-width:3.16499996;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       d="m 66.59458,111.16177 h 9.997359"
+       id="path873-5"
+       inkscape:connector-curvature="0" />
+    <g
+       id="g1018"
+       transform="translate(2.6458333)"
+       style="stroke:#333333;stroke-opacity:1">
+      <g
+         id="g1013"
+         style="stroke:#333333;stroke-opacity:1">
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#333333;stroke-width:3.16499996;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="M 63.948747,103.80467 H 75.349244"
+           id="path873"
+           inkscape:connector-curvature="0" />
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#333333;stroke-width:3.16499996;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="M 63.948747,118.51887 H 75.349244"
+           id="path873-5-3"
+           inkscape:connector-curvature="0" />
+      </g>
+    </g>
+    <rect
+       style="color:#000000;display:inline;overflow:visible;visibility:visible;opacity:1;vector-effect:none;fill:none;fill-opacity:1;fill-rule:nonzero;stroke:#333333;stroke-width:2.56500006;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker:none;paint-order:fill markers stroke;enable-background:accumulate"
+       id="rect815-6-2"
+       width="34.535"
+       height="34.535"
+       x="61.204723"
+       y="93.951569"
+       rx="5.4806547"
+       ry="5.4806547" />
+  </g>
+</svg>

lib/AppInfo/Application.php

@@ -6,6 +6,7 @@ use OC;
 use OC\Security\CSP\ContentSecurityPolicyNonceManager;
 use OC\User\User;
 use OCA\SideMenu\Service\AppRepository;
+use OCA\SideMenu\Service\ConfigProxy;
 use OCP\AppFramework\App;
 use OCP\IUserSession;
 use OCP\Util;
@@ -18,6 +19,9 @@ use Psr\Container\ContainerInterface;
  */
 class Application extends App
 {
+    public const APP_ID = 'side_menu';
+
+    public const APP_NAME = 'Custom menu';
     /**
      * @var OC\AllConfig
      */
@@ -38,7 +42,7 @@ class Application extends App
      */
     public function __construct(array $urlParams = [])
     {
-        parent::__construct('side_menu', $urlParams);
+        parent::__construct(self::APP_ID, $urlParams);
 
         $this->config = OC::$server->getConfig();
         $this->cspnm = OC::$server->getContentSecurityPolicyNonceManager();
@@ -53,7 +57,7 @@ class Application extends App
         $enabled = true;
 
         if (null !== $this->user) {
-            $enabled = (bool) $this->config->getUserValue($this->user->getUid(), 'side_menu', 'enabled', '1');
+            $enabled = (bool) $this->config->getUserValue($this->user->getUid(), self::APP_ID, 'enabled', '1');
         }
 
         return $enabled;
@@ -69,6 +73,10 @@ class Application extends App
         $container->registerService('AppRepository', function (ContainerInterface $c) {
             return new AppRepository(new OC_App());
         });
+
+        $container->registerService('ConfigProxy', function (ContainerInterface $c) {
+            return new ConfigProxy($this->config);
+        });
     }
 
     /**
@@ -76,20 +84,20 @@ class Application extends App
      */
     public function registerAssets()
     {
-        Util::addScript('side_menu', 'sideMenu');
+        Util::addScript(self::APP_ID, 'sideMenu');
-        Util::addStyle('side_menu', 'sideMenu');
+        Util::addStyle(self::APP_ID, 'sideMenu');
 
         $stylesheet = OC::$server->getURLGenerator()->linkToRoute(
             'side_menu.Css.stylesheet',
             [
-                'v' => $this->config->getAppValue('side_menu', 'cache', '0'),
+                'v' => $this->config->getAppValue(self::APP_ID, 'cache', '0'),
             ]
         );
 
         $script = OC::$server->getURLGenerator()->linkToRoute(
             'side_menu.Js.script',
             [
-                'v' => $this->config->getAppValue('side_menu', 'cache', '0'),
+                'v' => $this->config->getAppValue(self::APP_ID, 'cache', '0'),
             ]
         );
 

lib/Controller/CssController.php

@@ -19,27 +19,32 @@
 namespace OCA\SideMenu\Controller;
 
 use OC;
+use OC\User\User;
+use OCA\SideMenu\AppInfo\Application;
+use OCA\SideMenu\Service\ConfigProxy;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http\Response;
 use OCP\AppFramework\Http\TemplateResponse;
-use OCP\IConfig;
 use OCP\IRequest;
 use OCP\IUserSession;
 
 class CssController extends Controller
 {
     /**
-     * @var \OCP\IConfig
+     * @var ConfigProxy
      */
     protected $config;
 
     /**
-     * @param string $appName
+     * @var User
      */
-    public function __construct($appName, IRequest $request, IConfig $config)
+    protected $user;
+
+    public function __construct(string $appName, IRequest $request, ConfigProxy $config)
     {
         parent::__construct($appName, $request);
 
+        $this->user = OC::$server[IUserSession::class]->getUser();
         $this->config = $config;
     }
 
@@ -52,44 +57,46 @@ class CssController extends Controller
      */
     public function stylesheet()
     {
-        $backgroundColor = $this->config->getAppValue('side_menu', 'background-color', '#333333');
+        $response = new TemplateResponse(Application::APP_ID, 'css/stylesheet', $this->getConfig(), 'blank');
-        $backgroundColorTo = $this->config->getAppValue('side_menu', 'background-color-to', $backgroundColor);
+        $response->addHeader('Content-Type', 'text/css');
 
-        $user = OC::$server[IUserSession::class]->getUser();
+        return $response;
-        $topMenuApps = (array) json_decode($this->config->getAppValue('side_menu', 'top-menu-apps', '[]'), true);
+    }
 
-        if ($user) {
+    protected function getConfig(): array
-            $userTopMenuApps = (array) json_decode($this->config->getUserValue($user->getUid(), 'side_menu', 'top-menu-apps', '[]'), true);
+    {
+        $backgroundColor = $this->config->getAppValue('background-color', '#333333');
+        $backgroundColorTo = $this->config->getAppValue('background-color-to', $backgroundColor);
+
+        $topMenuApps = $this->config->getAppValueArray('top-menu-apps', '[]');
+
+        if ($this->user) {
+            $userTopMenuApps = $this->config->getUserValueArray($this->user, 'top-menu-apps', '[]');
 
             if (!empty($userTopMenuApps)) {
                 $topMenuApps = $userTopMenuApps;
             }
         }
 
-        $parameters = [
+        return [
             'vars' => [
                 'background-color' => $backgroundColor,
                 'background-color-to' => $backgroundColorTo,
-                'current-app-background-color' => $this->config->getAppValue('side_menu', 'current-app-background-color', '#444444'),
+                'current-app-background-color' => $this->config->getAppValue('current-app-background-color', '#444444'),
-                'loader-color' => $this->config->getAppValue('side_menu', 'loader-color', '#0e75ac'),
+                'loader-color' => $this->config->getAppValue('loader-color', '#0e75ac'),
-                'text-color' => $this->config->getAppValue('side_menu', 'text-color', '#FFFFFF'),
+                'text-color' => $this->config->getAppValue('text-color', '#FFFFFF'),
-                'opener' => $this->config->getAppValue('side_menu', 'opener', 'side-menu-opener'),
+                'opener' => $this->config->getAppValue('opener', 'side-menu-opener'),
-                'icon-invert-filter' => abs((int) $this->config->getAppValue('side_menu', 'icon-invert-filter', '0')).'%',
+                'icon-invert-filter' => abs($this->config->getAppValueInt('icon-invert-filter', '0')).'%',
-                'icon-opacity' => abs((int) $this->config->getAppValue('side_menu', 'icon-opacity', '100') / 100),
+                'icon-opacity' => abs($this->config->getAppValueInt('icon-opacity', '100') / 100),
             ],
-            'display-logo' => (bool) $this->config->getAppValue('side_menu', 'display-logo', 1),
+            'display-logo' => $this->config->getAppValueBool('display-logo', '1'),
-            'opener-only' => (bool) $this->config->getAppValue('side_menu', 'opener-only', 0),
+            'opener-only' => $this->config->getAppValueBool('opener-only', '0'),
-            'external-sites-in-top-menu' => (bool) $this->config->getAppValue('side_menu', 'external-sites-in-top-menu', 0),
+            'external-sites-in-top-menu' => $this->config->getAppValueBool('external-sites-in-top-menu', '0'),
-            'size-icon' => $this->config->getAppValue('side_menu', 'size-icon', 'normal'),
+            'size-icon' => $this->config->getAppValue('size-icon', 'normal'),
-            'size-text' => $this->config->getAppValue('side_menu', 'size-text', 'normal'),
+            'size-text' => $this->config->getAppValue('size-text', 'normal'),
-            'always-displayed' => (bool) $this->config->getAppValue('side_menu', 'always-displayed', '0'),
+            'always-displayed' => $this->config->getAppValueBool('always-displayed', '0'),
-            'big-menu' => (bool) $this->config->getAppValue('side_menu', 'big-menu', '0'),
+            'big-menu' => $this->config->getAppValueBool('big-menu', '0'),
             'top-menu-apps' => $topMenuApps,
         ];
-
-        $response = new TemplateResponse('side_menu', 'css/stylesheet', $parameters, 'blank');
-        $response->addHeader('Content-Type', 'text/css');
-
-        return $response;
     }
 }

lib/Controller/JsController.php

@@ -19,27 +19,40 @@
 namespace OCA\SideMenu\Controller;
 
 use OC;
+use OC\User\User;
+use OCA\SideMenu\AppInfo\Application;
+use OCA\SideMenu\Service\ConfigProxy;
+use OCA\Theming\ThemingDefaults;
 use OCP\AppFramework\Controller;
-use OCP\AppFramework\Http\Response;
+use OCP\AppFramework\Http\JSONResponse;
 use OCP\AppFramework\Http\TemplateResponse;
-use OCP\IConfig;
 use OCP\IRequest;
 use OCP\IUserSession;
 
 class JsController extends Controller
 {
     /**
-     * @var \OCP\IConfig
+     * @var ConfigProxy
      */
     protected $config;
 
     /**
-     * @param string $appName
+     * @var User
      */
-    public function __construct($appName, IRequest $request, IConfig $config)
+    protected $user;
+
+    /**
+     * @var ThemingDefaults
+     */
+    protected $themingDefaults;
+
+    public function __construct(string $appName, IRequest $request, ConfigProxy $config, ThemingDefaults $themingDefaults)
     {
         parent::__construct($appName, $request);
 
+        $this->themingDefaults = $themingDefaults;
+
+        $this->user = OC::$server[IUserSession::class]->getUser();
         $this->config = $config;
     }
 
@@ -47,47 +60,72 @@ class JsController extends Controller
      * @NoAdminRequired
      * @NoCSRFRequired
      * @PublicPage
-     *
-     * @return Response
      */
-    public function script()
+    public function script(): TemplateResponse
     {
-        $user = OC::$server[IUserSession::class]->getUser();
+        $response = new TemplateResponse(Application::APP_ID, 'js/script', $this->getConfig(), 'blank');
-        $topMenuApps = (array) json_decode($this->config->getAppValue('side_menu', 'top-menu-apps', '[]'), true);
+        $response->addHeader('Content-Type', 'text/javascript');
-        $targetBlankApps = (array) json_decode($this->config->getAppValue('side_menu', 'target-blank-apps', '[]'), true);
 
-        if ($user) {
+        return $response;
-            $userTopMenuApps = (array) json_decode($this->config->getUserValue($user->getUid(), 'side_menu', 'top-menu-apps', '[]'), true);
+    }
+
+    /**
+     * @NoAdminRequired
+     * @NoCSRFRequired
+     * @PublicPage
+     */
+    public function config(): JSONResponse
+    {
+        return new JSONResponse($this->getConfig());
+    }
+
+    protected function getConfig(): array
+    {
+        $topMenuApps = $this->config->getAppValueArray('top-menu-apps', '[]');
+        $targetBlankApps = $this->config->getAppValueArray('target-blank-apps', '[]');
+        $useAvatar = $this->config->getAppValueBool('use-avatar', '0');
+        $avatar = null;
+
+        if ($this->user) {
+            $userTopMenuApps = $this->config->getUserValueArray($this->user, 'top-menu-apps', '[]');
 
             if (!empty($userTopMenuApps)) {
                 $topMenuApps = $userTopMenuApps;
             }
 
-            $userTargetBlankMode = (int) $this->config->getUserValue($user->getUid(), 'side_menu', 'target-blank-mode', '1');
+            $userTargetBlankMode = $this->config->getUserValueInt($this->user, 'target-blank-mode', '1');
-            $userTargetBlankApps = (array) json_decode($this->config->getUserValue($user->getUid(), 'side_menu', 'target-blank-apps', '[]'), true);
+            $userTargetBlankApps = $this->config->getUserValueArray($this->user, 'target-blank-apps', '[]');
 
-            if ($userTargetBlankMode === 2) {
+            if (2 === $userTargetBlankMode) {
                 $targetBlankApps = $userTargetBlankApps;
             }
+
+            $isAvatarSet = OC::$server->getAvatarManager()->getAvatar($this->user->getUid())->exists();
+
+            if ($useAvatar && $isAvatarSet) {
+                $avatar = OC::$server->getURLGenerator()->linkToRoute(
+                    'core.avatar.getAvatar', [
+                        'userId' => $this->user->getUid(),
+                        'size' => 128,
+                        'v' => $this->config->getUserValueInt($this->user, 'avatar', 'version', 0),
+                    ]
+                );
+            }
         }
 
-
+        return [
-        $parameters = [
+            'opener-position' => $this->config->getAppValue('opener-position', 'before'),
-            'opener-position' => $this->config->getAppValue('side_menu', 'opener-position', 'before'),
+            'opener-hover' => $this->config->getAppValueBool('opener-hover', '0'),
-            'opener-hover' => (bool) $this->config->getAppValue('side_menu', 'opener-hover', '0'),
+            'external-sites-in-top-menu' => $this->config->getAppValueBool('external-sites-in-top-menu', '0'),
-            'external-sites-in-top-menu' => (bool) $this->config->getAppValue('side_menu', 'external-sites-in-top-menu', 0),
+            'force-light-icon' => $this->config->getAppValueBool('force-light-icon', '0'),
-            'force-light-icon' => (bool) $this->config->getAppValue('side_menu', 'force-light-icon', '0'),
+            'hide-when-no-apps' => $this->config->getAppValueBool('hide-when-no-apps', '0'),
-            'hide-when-no-apps' => (bool) $this->config->getAppValue('side_menu', 'hide-when-no-apps', '0'),
+            'loader-enabled' => $this->config->getAppValueBool('loader-enabled', '1'),
-            'loader-enabled' => (bool) $this->config->getAppValue('side_menu', 'loader-enabled', '1'),
+            'always-displayed' => $this->config->getAppValueBool('always-displayed', '0'),
-            'always-displayed' => (bool) $this->config->getAppValue('side_menu', 'always-displayed', '0'),
+            'big-menu' => $this->config->getAppValueBool('big-menu', '0'),
-            'big-menu' => (bool) $this->config->getAppValue('side_menu', 'big-menu', '0'),
+            'avatar' => $avatar,
             'top-menu-apps' => $topMenuApps,
             'target-blank-apps' => $targetBlankApps,
+            'logo' => $this->themingDefaults->getLogo(),
         ];
-
-        $response = new TemplateResponse('side_menu', 'js/script', $parameters, 'blank');
-        $response->addHeader('Content-Type', 'text/javascript');
-
-        return $response;
     }
 }

lib/Controller/NavController.php

@@ -22,9 +22,9 @@ use OC;
 use OC\App\AppStore\Fetcher\CategoryFetcher;
 use OC\URLGenerator;
 use OCA\SideMenu\Service\AppRepository;
+use OCA\SideMenu\Service\ConfigProxy;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http\JSONResponse;
-use OCP\IConfig;
 use OCP\IL10N;
 use OCP\IRequest;
 use OCP\IUserSession;
@@ -33,7 +33,7 @@ use OCP\L10N\IFactory;
 class NavController extends Controller
 {
     /**
-     * @var IConfig
+     * @var ConfigProxy
      */
     protected $config;
 
@@ -57,13 +57,10 @@ class NavController extends Controller
      */
     protected $router;
 
-    /**
-     * @param string $appName
-     */
     public function __construct(
-        $appName,
+        string $appName,
         IRequest $request,
-        IConfig $config,
+        ConfigProxy $config,
         AppRepository $appRepository,
         CategoryFetcher $categoryFetcher,
         URLGenerator $router,
@@ -91,7 +88,7 @@ class NavController extends Controller
         $apps = $this->appRepository->getVisibleApps();
         $currentLanguage = substr($this->l10nFactory->findLanguage(), 0, 2);
         $categoriesLabels = $this->categoryFetcher->get();
-        $externalSitesInTopMenu = (bool) $this->config->getAppValue('side_menu', 'external-sites-in-top-menu', 0);
+        $externalSitesInTopMenu = $this->config->getAppValueBool('external-sites-in-top-menu', '0');
         $user = OC::$server[IUserSession::class]->getUser();
         $appsCategories = [];
         $categoriesAppsCount = [];
@@ -103,8 +100,8 @@ class NavController extends Controller
             ]);
         }
 
-        $topMenuApps = (array) json_decode($this->config->getAppValue('side_menu', 'top-menu-apps', '[]'), true);
+        $topMenuApps = $this->config->getAppValueArray('top-menu-apps', '[]');
-        $userTopMenuApps = (array) json_decode($this->config->getUserValue($user->getUid(), 'side_menu', 'top-menu-apps', '[]'), true);
+        $userTopMenuApps = $this->config->getUserValueArray($user, 'top-menu-apps', '[]');
 
         if (!empty($userTopMenuApps)) {
             $topMenuApps = $userTopMenuApps;

lib/Controller/PersonalSettingController.php

@@ -23,6 +23,7 @@ use OCP\AppFramework\Http\Response;
 use OCP\IConfig;
 use OCP\IRequest;
 use OCP\IUserSession;
+use OCA\SideMenu\AppInfo\Application;
 
 class PersonalSettingController extends Controller
 {
@@ -104,7 +105,7 @@ class PersonalSettingController extends Controller
         }
 
         if ($doSave) {
-            $this->config->setUserValue($user->getUid(), 'side_menu', $name, $value);
+            $this->config->setUserValue($user->getUid(), Application::APP_ID, $name, $value);
 
             return [
                 'name' => $name,

lib/Service/ConfigProxy.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace OCA\SideMenu\Service;
+
+use OC\User\User;
+use OCA\SideMenu\AppInfo\Application;
+use OCP\IConfig;
+
+/**
+ * class Config.
+ *
+ * @author Simon Vieille <simon@deblan.fr>
+ */
+class ConfigProxy
+{
+    /**
+     * @var IConfig
+     */
+    protected $config;
+
+    public function __construct(IConfig $config)
+    {
+        $this->config = $config;
+    }
+
+    public function getAppValue(string $name, string $default): string
+    {
+        return (string) $this->config->getAppValue(Application::APP_ID, $name, $default);
+    }
+
+    public function getUserValue(User $user, string $name, string $default): string
+    {
+        return (string) $this->config->getUserValue($user->getUid(), Application::APP_ID, $name, $default);
+    }
+
+    public function getAppValueBool(string $name, string $default): bool
+    {
+        return (bool) $this->getAppValue($name, $default);
+    }
+
+    public function getAppValueArray(string $name, string $default): array
+    {
+        return (array) json_decode($this->getAppValue($name, $default), true);
+    }
+
+    public function getAppValueInt(string $name, string $default): int
+    {
+        return (int) $this->getAppValue($name, $default);
+    }
+
+    public function getUserValueBool(User $user, string $name, string $default): bool
+    {
+        return (bool) $this->getUserValue($user, $name, $default);
+    }
+
+    public function getUserValueArray(User $user, string $name, string $default): array
+    {
+        return (array) json_decode($this->getUserValue($user, $name, $default), true);
+    }
+
+    public function getUserValueInt(User $user, string $name, string $default): int
+    {
+        return (int) $this->getUserValue($user, $name, $default);
+    }
+}

lib/Settings/Admin.php

@@ -24,6 +24,7 @@ use OCP\IConfig;
 use OCP\IL10N;
 use OCP\ILogger;
 use OCP\Settings\ISettings;
+use OCA\SideMenu\AppInfo\Application;
 
 class Admin implements ISettings
 {
@@ -60,35 +61,36 @@ class Admin implements ISettings
      */
     public function getForm()
     {
-        $backgroundColor = $this->config->getAppValue('side_menu', 'background-color', '#333333');
+        $backgroundColor = $this->config->getAppValue(Application::APP_ID, 'background-color', '#333333');
-        $backgroundColorTo = $this->config->getAppValue('side_menu', 'background-color-to', $backgroundColor);
+        $backgroundColorTo = $this->config->getAppValue(Application::APP_ID, 'background-color-to', $backgroundColor);
 
         $parameters = [
             'background-color' => $backgroundColor,
             'background-color-to' => $backgroundColorTo,
-            'current-app-background-color' => $this->config->getAppValue('side_menu', 'current-app-background-color', '#444444'),
+            'current-app-background-color' => $this->config->getAppValue(Application::APP_ID, 'current-app-background-color', '#444444'),
-            'loader-color' => $this->config->getAppValue('side_menu', 'loader-color', '#0e75ac'),
+            'loader-color' => $this->config->getAppValue(Application::APP_ID, 'loader-color', '#0e75ac'),
-            'icon-invert-filter' => (int) $this->config->getAppValue('side_menu', 'icon-invert-filter', '0'),
+            'icon-invert-filter' => (int) $this->config->getAppValue(Application::APP_ID, 'icon-invert-filter', '0'),
-            'icon-opacity' => (int) $this->config->getAppValue('side_menu', 'icon-opacity', '100'),
+            'icon-opacity' => (int) $this->config->getAppValue(Application::APP_ID, 'icon-opacity', '100'),
-            'loader-enabled' => $this->config->getAppValue('side_menu', 'loader-enabled', '1'),
+            'loader-enabled' => $this->config->getAppValue(Application::APP_ID, 'loader-enabled', '1'),
-            'text-color' => $this->config->getAppValue('side_menu', 'text-color', '#FFFFFF'),
+            'text-color' => $this->config->getAppValue(Application::APP_ID, 'text-color', '#FFFFFF'),
-            'cache' => $this->config->getAppValue('side_menu', 'cache', '0'),
+            'cache' => $this->config->getAppValue(Application::APP_ID, 'cache', '0'),
-            'opener' => $this->config->getAppValue('side_menu', 'opener', 'side-menu-opener'),
+            'opener' => $this->config->getAppValue(Application::APP_ID, 'opener', 'side-menu-opener'),
-            'always-displayed' => $this->config->getAppValue('side_menu', 'always-displayed', '0'),
+            'always-displayed' => $this->config->getAppValue(Application::APP_ID, 'always-displayed', '0'),
-            'big-menu' => $this->config->getAppValue('side_menu', 'big-menu', '0'),
+            'big-menu' => $this->config->getAppValue(Application::APP_ID, 'big-menu', '0'),
-            'display-logo' => $this->config->getAppValue('side_menu', 'display-logo', '1'),
+            'display-logo' => $this->config->getAppValue(Application::APP_ID, 'display-logo', '1'),
-            'opener-position' => $this->config->getAppValue('side_menu', 'opener-position', 'before'),
+            'use-avatar' => $this->config->getAppValue(Application::APP_ID, 'use-avatar', '0'),
-            'opener-hover' => $this->config->getAppValue('side_menu', 'opener-hover', '0'),
+            'opener-position' => $this->config->getAppValue(Application::APP_ID, 'opener-position', 'before'),
-            'opener-only' => $this->config->getAppValue('side_menu', 'opener-only', '0'),
+            'opener-hover' => $this->config->getAppValue(Application::APP_ID, 'opener-hover', '0'),
-            'hide-when-no-apps' => $this->config->getAppValue('side_menu', 'hide-when-no-apps', '0'),
+            'opener-only' => $this->config->getAppValue(Application::APP_ID, 'opener-only', '0'),
-            'size-icon' => $this->config->getAppValue('side_menu', 'size-icon', 'normal'),
+            'hide-when-no-apps' => $this->config->getAppValue(Application::APP_ID, 'hide-when-no-apps', '0'),
-            'size-text' => $this->config->getAppValue('side_menu', 'size-text', 'normal'),
+            'size-icon' => $this->config->getAppValue(Application::APP_ID, 'size-icon', 'normal'),
-            'target-blank-apps' => (array) json_decode($this->config->getAppValue('side_menu', 'target-blank-apps', '[]'), true),
+            'size-text' => $this->config->getAppValue(Application::APP_ID, 'size-text', 'normal'),
-            'top-menu-apps' => (array) json_decode($this->config->getAppValue('side_menu', 'top-menu-apps', '[]'), true),
+            'target-blank-apps' => (array) json_decode($this->config->getAppValue(Application::APP_ID, 'target-blank-apps', '[]'), true),
+            'top-menu-apps' => (array) json_decode($this->config->getAppValue(Application::APP_ID, 'top-menu-apps', '[]'), true),
             'apps' => $this->appRepository->getVisibleApps(),
         ];
 
-        return new TemplateResponse('side_menu', 'settings/admin-form', $parameters, '');
+        return new TemplateResponse(Application::APP_ID, 'settings/admin-form', $parameters, '');
     }
 
     /**
@@ -96,7 +98,7 @@ class Admin implements ISettings
      */
     public function getSection()
     {
-        return 'side_menu';
+        return Application::APP_ID;
     }
 
     /**

lib/Settings/AdminSection.php

@@ -21,6 +21,7 @@ namespace OCA\SideMenu\Settings;
 use OCP\IL10N;
 use OCP\IURLGenerator;
 use OCP\Settings\IIconSection;
+use OCA\SideMenu\AppInfo\Application;
 
 class AdminSection implements IIconSection
 {
@@ -52,7 +53,7 @@ class AdminSection implements IIconSection
      */
     public function getID()
     {
-        return 'side_menu';
+        return Application::APP_ID;
     }
 
     /**
@@ -63,7 +64,7 @@ class AdminSection implements IIconSection
      */
     public function getName()
     {
-        return $this->l->t('Side menu');
+        return $this->l->t(Application::APP_NAME);
     }
 
     /**
@@ -83,6 +84,6 @@ class AdminSection implements IIconSection
      */
     public function getIcon()
     {
-        return $this->url->imagePath('theming', 'app-dark.svg');
+        return $this->url->imagePath(Application::APP_ID, 'icon.svg');
     }
 }

lib/Settings/Personal.php

@@ -25,6 +25,7 @@ use OCP\Settings\ISettings;
 use OCP\IConfig;
 use OCP\IUserSession;
 use OCA\SideMenu\Service\AppRepository;
+use OCA\SideMenu\AppInfo\Application;
 
 class Personal implements ISettings
 {
@@ -70,14 +71,14 @@ class Personal implements ISettings
         $user = $this->userSession->getUser();
 
         $parameters = [
-            'enabled' => $this->config->getUserValue($user->getUid(), 'side_menu', 'enabled', '1'),
+            'enabled' => $this->config->getUserValue($user->getUid(), Application::APP_ID, 'enabled', '1'),
-            'top-menu-apps' => (array) json_decode($this->config->getUserValue($user->getUid(), 'side_menu', 'top-menu-apps', '[]'), true),
+            'top-menu-apps' => (array) json_decode($this->config->getUserValue($user->getUid(), Application::APP_ID, 'top-menu-apps', '[]'), true),
-            'target-blank-mode' => $this->config->getUserValue($user->getUid(), 'side_menu', 'target-blank-mode', '1'),
+            'target-blank-mode' => $this->config->getUserValue($user->getUid(), Application::APP_ID, 'target-blank-mode', '1'),
-            'target-blank-apps' => (array) json_decode($this->config->getUserValue($user->getUid(), 'side_menu', 'target-blank-apps', '[]'), true),
+            'target-blank-apps' => (array) json_decode($this->config->getUserValue($user->getUid(), Application::APP_ID, 'target-blank-apps', '[]'), true),
             'apps' => $this->appRepository->getVisibleApps(),
         ];
 
-        return new TemplateResponse('side_menu', 'settings/personal-form', $parameters, '');
+        return new TemplateResponse(Application::APP_ID, 'settings/personal-form', $parameters, '');
     }
 
     /**
@@ -85,7 +86,7 @@ class Personal implements ISettings
      */
     public function getSection()
     {
-        return 'side_menu';
+        return Application::APP_ID;
     }
 
     /**

lib/Settings/PersonalSection.php

@@ -21,6 +21,7 @@ namespace OCA\SideMenu\Settings;
 use OCP\IL10N;
 use OCP\IURLGenerator;
 use OCP\Settings\IIconSection;
+use OCA\SideMenu\AppInfo\Application;
 
 class PersonalSection implements IIconSection
 {
@@ -52,7 +53,7 @@ class PersonalSection implements IIconSection
      */
     public function getID()
     {
-        return 'side_menu';
+        return Application::APP_ID;
     }
 
     /**
@@ -63,7 +64,7 @@ class PersonalSection implements IIconSection
      */
     public function getName()
     {
-        return $this->l->t('Side menu');
+        return $this->l->t(Application::APP_NAME);
     }
 
     /**
@@ -83,6 +84,6 @@ class PersonalSection implements IIconSection
      */
     public function getIcon()
     {
-        return $this->url->imagePath('theming', 'app-dark.svg');
+        return $this->url->imagePath(Application::APP_ID, 'icon.svg');
     }
 }

src/SideMenu.vue

@@ -19,9 +19,12 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
         <div class="side-menu-header">
             <button class="side-menu-opener"></button>
 
-            <div v-if="logo" class="side-menu-logo">
+            <div v-if="!avatar && logo" v-bind:class="{'side-menu-logo': true, 'avatardiv': false}">
                 <img v-bind:src="logo">
             </div>
+            <div v-if="avatar" v-bind:class="{'side-menu-logo': true, 'avatardiv': true}">
+                <img v-bind:src="avatar">
+            </div>
         </div>
 
         <ul class="side-menu-apps-list">
@@ -37,6 +40,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 <script>
 import trim from 'trim'
+import axios from 'axios'
 
 export default {
     name: 'SideMenu',
@@ -44,8 +48,9 @@ export default {
         return {
             apps: [],
             logo: null,
+            avatar: null,
             forceLightIcon: false,
-			targetBlank: false,
+            targetBlankApps: [],
         }
     },
     methods: {
@@ -87,7 +92,7 @@ export default {
                     }
 
                     this.apps.push({
-						id: dataId,
+                        id: dataId,
                         href: href,
                         name: trim(element.querySelector('span').innerHTML),
                         icon: svg,
@@ -102,26 +107,25 @@ export default {
                 }, 1000)
             })(this.apps)
         },
-        retrieveLogo() {
-            const ncLogo = document.querySelector('#nextcloud .logo')
 
-            if (ncLogo) {
+        retrieveConfig() {
-                const url = window.getComputedStyle(ncLogo, null)
+            let that = this
-                    .getPropertyValue('background-image')
-                    .replace('url("', '')
-                    .replace('")', '')
 
-                if (url && url !== 'none') {
+            axios
-                    this.logo = url
+                .get(OC.generateUrl('/apps/side_menu/js/config'))
-                }
+                .then(function(response) {
-            }
+                    const config = response.data
+
+                    that.targetBlankApps = config['target-blank-apps']
+                    that.forceLightIcon = config['force-light-icon']
+                    that.avatar = config['avatar']
+                    that.logo = config['logo']
+                });
         },
     },
     mounted() {
+        this.retrieveConfig()
         this.retrieveApps()
-        this.retrieveLogo()
-        this.forceLightIcon = document.querySelector('#side-menu-container').getAttribute('data-forcelighticon') == 1;
-        this.targetBlankApps = document.querySelector('#side-menu-container').getAttribute('data-targetblankapps').split(',');
 
         const menu = document.querySelector('#appmenu')
 

src/SideMenuBig.vue

@@ -18,7 +18,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
     <div id="side-menu" class="side-menu-big">
         <div class="side-menu-header">
             <button class="side-menu-opener side-menu-closer"></button>
-			<button class="side-menu-opener"></button>
+            <button class="side-menu-opener"></button>
         </div>
 
         <div class="side-menu-categories-wrapper">
@@ -50,7 +50,8 @@ export default {
         return {
             items: [],
             activeApp: null,
-			targetBlank: false,
+            targetBlank: false,
+            targetBlankApps: [],
         }
     },
     methods: {
@@ -74,14 +75,26 @@ export default {
                     jQuery('body').trigger('side-menu.apps', [apps])
                 });
         },
+
         retrieveActiveApp() {
             let activeAppLink = document.querySelector('#appmenu a.active')
             this.activeApp = activeAppLink ? activeAppLink.parentNode.getAttribute('data-id') : null
         },
+
+        retrieveConfig() {
+            let that = this
+
+            axios
+                .get(OC.generateUrl('/apps/side_menu/js/config'))
+                .then(function(response) {
+                    const config = response.data
+
+                    that.targetBlankApps = config['target-blank-apps']
+                });
+        },
     },
     mounted() {
-        this.targetBlankApps = document.querySelector('#side-menu-container').getAttribute('data-targetblankapps').split(',');
+        this.retrieveConfig()
-
         this.retrieveApps()
         this.retrieveActiveApp()
     }

src/l10n/fixtures/de.yaml

@@ -1,5 +1,5 @@
-"Side menu": "Seitenmenü"
+"Custom menu": "Benutzerdefiniertes Menü"
-"Enable the side menu": "Aktiviere das Seitenmenü"
+"Enable the custom menu": "Aktiviere das Benutzerdefiniertes Menü"
 "No": "Nein"
 "Yes": "Ja"
 "Menu": "Menü"
@@ -56,3 +56,4 @@
 "Use the global setting": "Verwende die globale Einstellung"
 "Use my selection": "Verwende meine Auswahl"
 "Show and hide the list of applications": "Ein- und Ausblenden der Anwendungsliste"
+"Use the avatar instead of the logo": "Verwenden Sie den Avatar anstelle des Logos"

src/l10n/fixtures/fr.yaml

@@ -1,5 +1,5 @@
-"Side menu": "Menu latéral"
+"Custom menu": "Menu personnalisé"
-"Enable the side menu": "Activer le menu latéral"
+"Enable the custom menu": "Activer le menu personnalisé"
 "No": "Non"
 "Yes": "Oui"
 "Menu": "Menu"
@@ -56,3 +56,4 @@
 "Use the global setting": "Utiliser la configuration globale"
 "Use my selection": "Utiliser ma sélection"
 "Show and hide the list of applications": "Afficher et masquer la liste des applications"
+"Use the avatar instead of the logo": "Utiliser l'avatar à la place du logo"

templates/js/script.php

@@ -10,12 +10,6 @@
         sideMenu.attr('data-bigmenu', '1')
     <?php endif; ?>
 
-    <?php if ($_['force-light-icon']): ?>
-        sideMenuContainer.attr('data-forcelighticon', '1')
-    <?php endif; ?>
-
-    sideMenuContainer.attr('data-targetblankapps', '<?php p(implode(',', $_['target-blank-apps'])) ?>')
-
     var targetBlankApps = <?php echo json_encode($_['target-blank-apps']) ?>;
 
     body.on('side-menu.apps', function(e, apps) {
@@ -91,10 +85,10 @@
                     headerMenuOpener.on('mouseenter', sideMenuOpenerMouseEnter)
 
                     sideMenu.addClass('hide-opener')
-                <?php else: ?>
-                    sideMenu.on('mouseleave', sideMenuMouseLeave)
-                    sideMenu.on('mouseenter', sideMenuOpenerMouseEnter)
                 <?php endif ?>
+
+                sideMenu.on('mouseleave', sideMenuMouseLeave)
+                sideMenu.on('mouseenter', sideMenuOpenerMouseEnter)
             }
         <?php endif; ?>
 

templates/settings/admin-form.php

@@ -342,6 +342,18 @@ $choicesSizes = [
             </select>
         </div>
 
+        <p><em><?php p($l->t('Use the avatar instead of the logo')); ?></em></p>
+
+        <div>
+            <select id="side-menu-use-avatar" name="use-avatar" class="side-menu-setting">
+                <?php foreach ($choicesYesNo as $label => $value): ?>
+                    <option value="<?php echo $value ?>" <?php if ($value === $_['use-avatar']): ?>selected<?php endif; ?>>
+                        <?php echo $l->t($label);  ?>
+                    </option>
+                <?php endforeach; ?>
+            </select>
+        </div>
+
         <div>
             <label>
                 <?php p($l->t('Icons and texts')); ?>

templates/settings/personal-form.php

@@ -35,7 +35,7 @@ $choicesYesNo = [
 
         <div>
             <label for="side-menu-enabled">
-                <?php p($l->t('Enable the side menu')); ?>
+                <?php p($l->t('Enable the custom menu')); ?>
             </label>
         </div>