Merge pull request #9997 from piwik/9354

Merge user and admin menu to one single menu

CHANGELOG.md

@@ -19,6 +19,8 @@ This is a changelog for Piwik platform developers. All changes for our HTTP API'
 * The `core:plugin` console command has been removed in favor of the new `plugin:list`, `plugin:activate` and `plugin:deactivate` commands as anounced in Piwik 2.11
 * The visibility of private properties and methods in `Piwik\Plugins\Login\Controller` were changed to `protected`
 * Controller actions are now case sensitive. This means the URL and events have to use the same case as the name of the action defined in a controller. 
+* The "User Menu" was removed and should be replaced by "Admin Menu". Change `configureUserMenu(MenuUser $menu)` to `configureAdminMenu(MenuAdmin $menu)` in your `Menu.php`.
+* The method `Piwik\Menu\MenuAdmin::addSettingsItem()` was removed, use  `Piwik\Menu\MenuAdmin::addManageItem()` instead.
 
 ### New APIs
 * Multiple widgets for one report can now be created via the `Report::configureWidgets()` method via the new classes `Piwik\Widget\ReportWidgetFactory` and `Piwik\Widget\ReportWidgetConfig`

core/Menu/MenuAdmin.php

@@ -8,6 +8,7 @@
  */
 namespace Piwik\Menu;
 
+use Piwik\Development;
 use Piwik\Piwik;
 
 /**
@@ -33,7 +34,7 @@ use Piwik\Piwik;
 class MenuAdmin extends MenuAbstract
 {
     /**
-     * See {@link add()}. Adds a new menu item to the development section of the admin menu.
+     * See {@link add()}. Adds a new menu item to the manage section of the user menu.
      * @param string $menuName
      * @param array $url
      * @param int $order
@@ -41,13 +42,13 @@ class MenuAdmin extends MenuAbstract
      * @api
      * @since 2.5.0
      */
-    public function addDevelopmentItem($menuName, $url, $order = 50, $tooltip = false)
+    public function addPersonalItem($menuName, $url, $order = 50, $tooltip = false)
     {
-        $this->addItem('CoreAdminHome_MenuDevelopment', $menuName, $url, $order, $tooltip);
+        $this->addItem('UsersManager_MenuPersonal', $menuName, $url, $order, $tooltip);
     }
 
     /**
-     * See {@link add()}. Adds a new menu item to the diagnostic section of the admin menu.
+     * See {@link add()}. Adds a new menu item to the development section of the admin menu.
      * @param string $menuName
      * @param array $url
      * @param int $order
@@ -55,13 +56,15 @@ class MenuAdmin extends MenuAbstract
      * @api
      * @since 2.5.0
      */
-    public function addDiagnosticItem($menuName, $url, $order = 50, $tooltip = false)
+    public function addDevelopmentItem($menuName, $url, $order = 50, $tooltip = false)
     {
-        $this->addItem('CoreAdminHome_MenuDiagnostic', $menuName, $url, $order, $tooltip);
+        if (Development::isEnabled()) {
+            $this->addItem('CoreAdminHome_MenuDevelopment', $menuName, $url, $order, $tooltip);
+        }
     }
 
     /**
-     * See {@link add()}. Adds a new menu item to the platform section of the admin menu.
+     * See {@link add()}. Adds a new menu item to the diagnostic section of the admin menu.
      * @param string $menuName
      * @param array $url
      * @param int $order
@@ -69,13 +72,13 @@ class MenuAdmin extends MenuAbstract
      * @api
      * @since 2.5.0
      */
-    public function addPlatformItem($menuName, $url, $order = 50, $tooltip = false)
+    public function addDiagnosticItem($menuName, $url, $order = 50, $tooltip = false)
     {
-        $this->addItem('CorePluginsAdmin_MenuPlatform', $menuName, $url, $order, $tooltip);
+        $this->addItem('CoreAdminHome_MenuDiagnostic', $menuName, $url, $order, $tooltip);
     }
 
     /**
-     * See {@link add()}. Adds a new menu item to the settings section of the admin menu.
+     * See {@link add()}. Adds a new menu item to the platform section of the admin menu.
      * @param string $menuName
      * @param array $url
      * @param int $order
@@ -83,9 +86,9 @@ class MenuAdmin extends MenuAbstract
      * @api
      * @since 2.5.0
      */
-    public function addSettingsItem($menuName, $url, $order = 50, $tooltip = false)
+    public function addPlatformItem($menuName, $url, $order = 50, $tooltip = false)
     {
-        $this->addItem('General_Settings', $menuName, $url, $order, $tooltip);
+        $this->addItem('CorePluginsAdmin_MenuPlatform', $menuName, $url, $order, $tooltip);
     }
 
     /**
@@ -99,7 +102,7 @@ class MenuAdmin extends MenuAbstract
      */
     public function addManageItem($menuName, $url, $order = 50, $tooltip = false)
     {
-        $this->addItem('CoreAdminHome_Administration', $menuName, $url, $order, $tooltip);
+        $this->addItem('CoreAdminHome_MenuManage', $menuName, $url, $order, $tooltip);
     }
 
     /**

core/Menu/MenuUser.php

-<?php
-/**
- * Piwik - free/libre analytics platform
- *
- * @link http://piwik.org
- * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
- *
- */
-namespace Piwik\Menu;
-
-/**
- * Contains menu entries for the User menu (the menu at the very top of the page).
- * Plugins can implement the `configureUserMenu()` method of the `Menu` plugin class to add, rename of remove
- * items. If your plugin does not have a `Menu` class yet you can create one using `./console generate:menu`.
- *
- * **Example**
- *
- *     public function configureUserMenu(MenuUser $menu)
- *     {
- *         $menu->add(
- *             'MyPlugin_MyTranslatedMenuCategory',
- *             'MyPlugin_MyTranslatedMenuName',
- *             array('module' => 'MyPlugin', 'action' => 'index'),
- *             Piwik::isUserHasSomeAdminAccess(),
- *             $order = 2
- *         );
- *     }
- *
- * @method static MenuUser getInstance()
- */
-class MenuUser extends MenuAbstract
-{
-
-    /**
-     * See {@link add()}. Adds a new menu item to the manage section of the user menu.
-     * @param string $menuName
-     * @param array $url
-     * @param int $order
-     * @param bool|string $tooltip
-     * @api
-     * @since 2.5.0
-     */
-    public function addPersonalItem($menuName, $url, $order = 50, $tooltip = false)
-    {
-        $this->addItem('UsersManager_MenuPersonal', $menuName, $url, $order, $tooltip);
-    }
-
-    /**
-     * See {@link add()}. Adds a new menu item to the manage section of the user menu.
-     * @param string $menuName
-     * @param array $url
-     * @param int $order
-     * @param bool|string $tooltip
-     * @api
-     * @since 2.5.0
-     */
-    public function addManageItem($menuName, $url, $order = 50, $tooltip = false)
-    {
-        $this->addItem('CoreAdminHome_MenuManage', $menuName, $url, $order, $tooltip);
-    }
-
-    /**
-     * See {@link add()}. Adds a new menu item to the platform section of the user menu.
-     * @param string $menuName
-     * @param array $url
-     * @param int $order
-     * @param bool|string $tooltip
-     * @api
-     * @since 2.5.0
-     */
-    public function addPlatformItem($menuName, $url, $order = 50, $tooltip = false)
-    {
-        $this->addItem('CorePluginsAdmin_MenuPlatform', $menuName, $url, $order, $tooltip);
-    }
-
-    /**
-     * Triggers the Menu.User.addItems hook and returns the menu.
-     *
-     * @return Array
-     */
-    public function getMenu()
-    {
-        if (!$this->menu) {
-            foreach ($this->getAllMenus() as $menu) {
-                $menu->configureUserMenu($this);
-            }
-        }
-
-        return parent::getMenu();
-    }
-}

core/Plugin/Controller.php

@@ -20,8 +20,8 @@ use Piwik\Date;
 use Piwik\Exception\NoPrivilegesException;
 use Piwik\Exception\NoWebsiteFoundException;
 use Piwik\FrontController;
+use Piwik\Menu\MenuAdmin;
 use Piwik\Menu\MenuTop;
-use Piwik\Menu\MenuUser;
 use Piwik\NoAccessException;
 use Piwik\Notification\Manager as NotificationManager;
 use Piwik\NumberFormatter;
@@ -640,8 +640,8 @@ abstract class Controller
 
         $this->setBasicVariablesView($view);
 
-        $view->topMenu  = MenuTop::getInstance()->getMenu();
-        $view->userMenu = MenuUser::getInstance()->getMenu();
+        $view->topMenu = MenuTop::getInstance()->getMenu();
+        $view->adminMenu = MenuAdmin::getInstance()->getMenu();
 
         $notifications = $view->notifications;
         if (empty($notifications)) {

core/Plugin/ControllerAdmin.php

@@ -13,7 +13,6 @@ use Piwik\Config;
 use Piwik\Development;
 use Piwik\Menu\MenuAdmin;
 use Piwik\Menu\MenuTop;
-use Piwik\Menu\MenuUser;
 use Piwik\Notification;
 use Piwik\Notification\Manager as NotificationManager;
 use Piwik\Piwik;
@@ -218,8 +217,7 @@ abstract class ControllerAdmin extends Controller
         self::notifyIfEAcceleratorIsUsed();
         self::notifyIfURLIsNotSecure();
 
-        $view->topMenu  = MenuTop::getInstance()->getMenu();
-        $view->userMenu = MenuUser::getInstance()->getMenu();
+        $view->topMenu = MenuTop::getInstance()->getMenu();
 
         $view->isDataPurgeSettingsEnabled = self::isDataPurgeSettingsEnabled();
         $enableFrames = PiwikConfig::getInstance()->General['enable_framed_settings'];
@@ -239,8 +237,7 @@ abstract class ControllerAdmin extends Controller
         self::notifyWhenDebugOnDemandIsEnabled('debug');
         self::notifyWhenDebugOnDemandIsEnabled('debug_on_demand');
 
-        $adminMenu = MenuAdmin::getInstance()->getMenu();
-        $view->adminMenu = $adminMenu;
+        $view->adminMenu = MenuAdmin::getInstance()->getMenu();
 
         $notifications = $view->notifications;
 

core/Plugin/Menu.php

@@ -12,10 +12,8 @@ use Piwik\Common;
 use Piwik\Development;
 use Piwik\Menu\MenuAdmin;
 use Piwik\Menu\MenuTop;
-use Piwik\Menu\MenuUser;
 use Piwik\Plugin\Manager as PluginManager;
 use Piwik\Plugins\UsersManager\UserPreferences;
-use Piwik\Plugin\Reports;
 
 /**
  * Base class of all plugin menu providers. Plugins that define their own menu items can extend this class to easily
@@ -217,17 +215,9 @@ class Menu
     {
     }
 
-    /**
-     * Configures the user menu which is supposed to contain user and help related items such as
-     * "User settings", "Alerts" or "Email Reports".
-     */
-    public function configureUserMenu(MenuUser $menu)
-    {
-    }
-
     /**
      * Configures the admin menu which is supposed to contain only administration related items such as
-     * "Websites", "Users" or "Plugin settings".
+     * "Websites", "Users" or "Settings".
      */
     public function configureAdminMenu(MenuAdmin $menu)
     {

lang/en.json

@@ -182,7 +182,7 @@
         "Forums": "Forums",
         "FromReferrer": "from",
         "GeneralInformation": "General Information",
-        "General": "General",
+        "GeneralSettings": "General settings",
         "GetStarted": "Get started",
         "GiveUsYourFeedback": "Give us Feedback!",
         "Goal": "Goal",

plugins/API/Menu.php

@@ -9,8 +9,8 @@
 namespace Piwik\Plugins\API;
 
 use Piwik\DeviceDetectorCache;
+use Piwik\Menu\MenuAdmin;
 use Piwik\Menu\MenuTop;
-use Piwik\Menu\MenuUser;
 use Piwik\Piwik;
 use DeviceDetector\Parser\OperatingSystem;
 
@@ -24,7 +24,7 @@ class Menu extends \Piwik\Plugin\Menu
         $this->addTopMenuMobileApp($menu);
     }
 
-    public function configureUserMenu(MenuUser $menu)
+    public function configureAdminMenu(MenuAdmin $menu)
     {
         $menu->addPlatformItem('General_API',
             $this->urlForAction('listAllAPI', array('segment' => false)),

plugins/API/templates/glossary.twig

-{% extends isWidget ? 'empty.twig' : 'user.twig' %}
+{% extends isWidget ? 'empty.twig' : 'admin.twig' %}
 
 {% set title %}{{ 'API_Glossary'|translate }}{% endset %}
 

plugins/API/templates/listAllAPI.twig

-{% extends 'user.twig' %}
+{% extends 'admin.twig' %}
 
 {% set title %}{{ 'API_ReportingApiReference'|translate }}{% endset %}
 

plugins/CoreAdminHome/Controller.php

@@ -16,7 +16,6 @@ use Piwik\Config;
 use Piwik\Container\StaticContainer;
 use Piwik\DataTable\Renderer\Json;
 use Piwik\Menu\MenuTop;
-use Piwik\Menu\MenuUser;
 use Piwik\Nonce;
 use Piwik\Piwik;
 use Piwik\Plugin\ControllerAdmin;
@@ -287,7 +286,6 @@ class Controller extends ControllerAdmin
         $view = new View('@CoreAdminHome/trackingCodeGenerator');
         $this->setBasicVariablesView($view);
         $view->topMenu  = MenuTop::getInstance()->getMenu();
-        $view->userMenu = MenuUser::getInstance()->getMenu();
 
         $viewableIdSites = APISitesManager::getInstance()->getSitesIdWithAtLeastViewAccess();
 

plugins/CoreAdminHome/Menu.php

@@ -11,57 +11,50 @@ namespace Piwik\Plugins\CoreAdminHome;
 use Piwik\Db;
 use Piwik\Menu\MenuAdmin;
 use Piwik\Menu\MenuTop;
-use Piwik\Menu\MenuUser;
 use Piwik\Piwik;
+use Piwik\Plugin;
 use Piwik\Settings\Manager as SettingsManager;
 
 class Menu extends \Piwik\Plugin\Menu
 {
-
-    public function configureAdminMenu(MenuAdmin $menu)
+    public function configureTopMenu(MenuTop $menu)
     {
-        $hasAdminAccess = Piwik::isUserHasSomeAdminAccess();
-
-        if ($hasAdminAccess) {
-            $menu->addManageItem(null, array(), $order = 1);
-            $menu->addSettingsItem(null, array(), $order = 5);
-            $menu->addDiagnosticItem(null, array(), $order = 10);
-            $menu->addDevelopmentItem(null, array(), $order = 15);
-
-            if (Piwik::hasUserSuperUserAccess()) {
-                $menu->addSettingsItem('General_General',
-                    $this->urlForAction('generalSettings'),
-                    $order = 6);
+        if (Piwik::isUserIsAnonymous()) {
+            if (Plugin\Manager::getInstance()->isPluginActivated('ScheduledReports')) {
+                $url = $this->urlForModuleAction('ScheduledReports', 'index');
+            } else {
+                $url = $this->urlForModuleAction('API', 'listAllAPI');
             }
+        } else {
+            $url = $this->urlForModuleAction('UsersManager', 'userSettings');
         }
 
-        if (Piwik::hasUserSuperUserAccess() && SettingsManager::hasSystemPluginsSettingsForCurrentUser()) {
-            $menu->addSettingsItem('CoreAdminHome_PluginSettings',
-                                   $this->urlForAction('adminPluginSettings'),
-                                   $order = 7);
-        }
+        $menu->registerMenuIcon('CoreAdminHome_Administration', 'icon-configure');
+        $menu->addItem('CoreAdminHome_Administration', null, $url, 980, Piwik::translate('CoreAdminHome_Administration'));
     }
 
-    public function configureTopMenu(MenuTop $menu)
+    public function configureAdminMenu(MenuAdmin $menu)
     {
-        if (Piwik::isUserHasSomeAdminAccess()) {
-            $url = $this->urlForModuleAction('SitesManager', 'index');
+        $menu->addDevelopmentItem(null, array(), $order = 40);
+        $menu->addManageItem(null, array(), $order = 1);
+        $menu->addDiagnosticItem(null, array(), $order = 5);
 
-            if (Piwik::hasUserSuperUserAccess()) {
-                $url = $this->urlForAction('generalSettings');
-            }
+        if (Piwik::hasUserSuperUserAccess()) {
+            $menu->addManageItem('General_GeneralSettings',
+                $this->urlForAction('generalSettings'),
+                $order = 6);
 
-            $menu->registerMenuIcon('CoreAdminHome_Administration', 'icon-configure');
-            $menu->addItem('CoreAdminHome_Administration', null, $url, 980, Piwik::translate('CoreAdminHome_Administration'));
+            if (SettingsManager::hasSystemPluginsSettingsForCurrentUser()) {
+                $menu->addManageItem('CoreAdminHome_PluginSettings',
+                    $this->urlForAction('adminPluginSettings'),
+                    $order = 7);
+            }
         }
-    }
 
-    public function configureUserMenu(MenuUser $menu)
-    {
         if (!Piwik::isUserIsAnonymous()) {
             $menu->addManageItem('CoreAdminHome_TrackingCode',
                 $this->urlForAction('trackingCodeGenerator'),
-                $order = 20);
+                $order = 25);
 
             if (SettingsManager::hasUserPluginsSettingsForCurrentUser()) {
                 $menu->addPersonalItem('CoreAdminHome_PluginSettings',

plugins/CoreAdminHome/templates/pluginSettings.twig

 
-{% extends mode == 'user' ? "user.twig" : "admin.twig" %}
+{% extends "admin.twig" %}
 
 {% set title %}
 {% if mode == 'user' -%}

plugins/CoreAdminHome/templates/trackingCodeGenerator.twig

-{% extends 'user.twig' %}
+{% extends 'admin.twig' %}
 
 {% block head %}
     {{ parent() }}

plugins/CoreHome/Menu.php

@@ -9,41 +9,15 @@
 namespace Piwik\Plugins\CoreHome;
 
 use Piwik\Db;
+use Piwik\Menu\MenuAdmin;
 use Piwik\Menu\MenuTop;
-use Piwik\Menu\MenuUser;
 use Piwik\Piwik;
 use Piwik\Plugin;
-use Piwik\Plugins\UsersManager\API as APIUsersManager;
 
 class Menu extends \Piwik\Plugin\Menu
 {
     public function configureTopMenu(MenuTop $menu)
     {
-        $login = Piwik::getCurrentUserLogin();
-        $user  = APIUsersManager::getInstance()->getUser($login);
-
-        if (!empty($user['alias'])) {
-            $login = $user['alias'];
-        }
-
-        if (Plugin\Manager::getInstance()->isPluginActivated('Feedback')) {
-            $menu->registerMenuIcon('General_Help', 'icon-help');
-            $menu->addItem('General_Help', null, array('module' => 'Feedback', 'action' => 'index'), $order = 990, Piwik::translate('General_Help'));
-        }
-
-        $menu->registerMenuIcon($login, 'icon-user');
-
-        if (Piwik::isUserIsAnonymous()) {
-            if (Plugin\Manager::getInstance()->isPluginActivated('ScheduledReports')) {
-                $menu->addItem($login, null, array('module' => 'ScheduledReports', 'action' => 'index'), 970, Piwik::translate('UsersManager_PersonalSettings'));
-            } else {
-                $menu->addItem($login, null, array('module' => 'API', 'action' => 'listAllAPI'), 970, Piwik::translate('API_ReportingApiReference'));
-            }
-        } else {
-            $tooltip = sprintf('%s: %s', Piwik::translate('UsersManager_PersonalSettings'), $login);
-            $menu->addItem($login, null, array('module' => 'UsersManager', 'action' => 'userSettings'), 970, $tooltip);
-        }
-
         $module = $this->getLoginModule();
         if (Piwik::isUserIsAnonymous()) {
             $menu->registerMenuIcon('Login_LogIn', 'icon-sign-in');
@@ -54,7 +28,7 @@ class Menu extends \Piwik\Plugin\Menu
         }
     }
 
-    public function configureUserMenu(MenuUser $menu)
+    public function configureAdminMenu(MenuAdmin $menu)
     {
         $menu->addPersonalItem(null, array(), 1, false);
         $menu->addManageItem(null, array(), 2, false);

plugins/CoreHome/angularjs/quick-access/quick-access.directive.js

@@ -74,11 +74,6 @@
                     $rootElement.find('#topRightBar .navbar-right li > a').each(function (index, element) {
                         var $element = $(element);
 
-                        if ($element.is('#topmenu-usersmanager')) {
-                            // ignore languages manager
-                            return;
-                        }
-
                         var text = trim($element.text());
 
                         if (!text) {

plugins/CoreHome/stylesheets/coreHome.less

@@ -212,11 +212,6 @@ a.Piwik_Popover_Error_Back {
   }
 }
 
-#userMenu .items {
-  margin-left: -117px;
-  width: 160px;
-}
-
 /* Used to link within content text, without adding visual clutter */
 .linkContent { color:#333; text-decoration:none}
 .linkContent:hover { text-decoration:underline;}

plugins/CoreHome/templates/_headerMessage.twig

@@ -10,7 +10,7 @@
     </span>
 {% endset %}
 
-{% if isPiwikDemo or (latest_version_available and hasSomeViewAccess and not isUserIsAnonymous) or (isSuperUser and adminMenu is defined and adminMenu) %}
+{% if isPiwikDemo or (latest_version_available and hasSomeViewAccess and not isUserIsAnonymous) or (isSuperUser and isAdminArea is defined and isAdminArea) %}
 <div piwik-expand-on-hover
      id="header_message"
      class="piwikSelector borderedControl {% if isPiwikDemo or not latest_version_available %}header_info{% else %}{% endif %} {% if isPiwikDemo %}isPiwikDemo{% else %}piwikTopControl{% endif %} {% if latest_version_available %}update_available{% endif %}"
@@ -22,7 +22,7 @@
         {% elseif latest_version_available %}
             {{ 'General_NewUpdatePiwikX'|translate(latest_version_available) }}
             <span class="icon-warning"></span>
-        {% elseif isSuperUser and adminMenu is defined and adminMenu %}
+        {% elseif isSuperUser and isAdminArea is defined and isAdminArea %}
             {{ updateCheck|raw }}
         {% endif %}
     </a>
@@ -31,7 +31,7 @@
         {% if isPiwikDemo %}
             {{ 'General_DownloadFullVersion'|translate("<a href='http://piwik.org/'>","</a>","<a href='http://piwik.org'>piwik.org</a>")|raw }}
             <br/>
-            {% if isSuperUser and adminMenu is defined and adminMenu %}
+            {% if isSuperUser and isAdminArea is defined and isAdminArea %}
                 <br/>
             {% endif %}
         {% endif %}
@@ -44,7 +44,7 @@
             <br />
         {% endif %}
 
-        {% if isPiwikDemo and isSuperUser and adminMenu is defined and adminMenu %}
+        {% if isPiwikDemo and isSuperUser and isAdminArea is defined and isAdminArea %}
             <br/>
             {{ updateCheck|raw }}
             <br/>

plugins/CoreHome/templates/_topBar.twig

-{{ postEvent("Template.beforeTopBar", userAlias, userLogin, topMenu, userMenu) }}
+{{ postEvent("Template.beforeTopBar", userAlias, userLogin, topMenu) }}
 <ul role="menubar" class="navbar-right">
 
     {% macro menuItemLabel(label, icon) %}

plugins/CorePluginsAdmin/Controller.php

@@ -57,10 +57,6 @@ class Controller extends Plugin\ControllerAdmin
         if (!in_array($sort, $this->validSortMethods)) {
             $sort = $this->defaultSortMethod;
         }
-        $mode = Common::getRequestVar('mode', 'admin', 'string');
-        if (!in_array($mode, array('user', 'admin'))) {
-            $mode = 'admin';
-        }
 
         $view = $this->configureView('@CorePluginsAdmin/marketplace');
 
@@ -69,7 +65,6 @@ class Controller extends Plugin\ControllerAdmin
         $showThemes = ($show === 'themes');
         $view->plugins = $marketplace->searchPlugins($query, $sort, $showThemes);
         $view->showThemes = $showThemes;
-        $view->mode = $mode;
         $view->query = $query;
         $view->sort = $sort;
         $view->installNonce = Nonce::getNonce(static::INSTALL_NONCE);