336 lines
8.7 KiB
PHP
336 lines
8.7 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2016, ownCloud GmbH
|
|
*
|
|
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
|
|
* @author Bart Visscher <bartv@thisnet.nl>
|
|
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
|
|
* @author Daniel Kesselberg <mail@danielkesselberg.de>
|
|
* @author Joas Schilling <coding@schilljs.com>
|
|
* @author John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
|
|
* @author Julius Härtl <jus@bitgrid.net>
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
*
|
|
* @license AGPL-3.0
|
|
*
|
|
* This code is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License, version 3,
|
|
* as published by the Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License, version 3,
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
|
*
|
|
*/
|
|
|
|
namespace OC;
|
|
|
|
use OC\App\AppManager;
|
|
use OC\Group\Manager;
|
|
use OCP\App\IAppManager;
|
|
use OCP\IConfig;
|
|
use OCP\IGroupManager;
|
|
use OCP\INavigationManager;
|
|
use OCP\IURLGenerator;
|
|
use OCP\IUserSession;
|
|
use OCP\L10N\IFactory;
|
|
|
|
/**
|
|
* Manages the ownCloud navigation
|
|
*/
|
|
|
|
class NavigationManager implements INavigationManager {
|
|
protected $entries = [];
|
|
protected $closureEntries = [];
|
|
protected $activeEntry;
|
|
/** @var bool */
|
|
protected $init = false;
|
|
/** @var IAppManager|AppManager */
|
|
protected $appManager;
|
|
/** @var IURLGenerator */
|
|
private $urlGenerator;
|
|
/** @var IFactory */
|
|
private $l10nFac;
|
|
/** @var IUserSession */
|
|
private $userSession;
|
|
/** @var IGroupManager|Manager */
|
|
private $groupManager;
|
|
/** @var IConfig */
|
|
private $config;
|
|
|
|
public function __construct(IAppManager $appManager,
|
|
IURLGenerator $urlGenerator,
|
|
IFactory $l10nFac,
|
|
IUserSession $userSession,
|
|
IGroupManager $groupManager,
|
|
IConfig $config) {
|
|
$this->appManager = $appManager;
|
|
$this->urlGenerator = $urlGenerator;
|
|
$this->l10nFac = $l10nFac;
|
|
$this->userSession = $userSession;
|
|
$this->groupManager = $groupManager;
|
|
$this->config = $config;
|
|
}
|
|
|
|
/**
|
|
* Creates a new navigation entry
|
|
*
|
|
* @param array|\Closure $entry Array containing: id, name, order, icon and href key
|
|
* The use of a closure is preferred, because it will avoid
|
|
* loading the routing of your app, unless required.
|
|
* @return void
|
|
*/
|
|
public function add($entry) {
|
|
if ($entry instanceof \Closure) {
|
|
$this->closureEntries[] = $entry;
|
|
return;
|
|
}
|
|
|
|
$entry['active'] = false;
|
|
if (!isset($entry['icon'])) {
|
|
$entry['icon'] = '';
|
|
}
|
|
if (!isset($entry['classes'])) {
|
|
$entry['classes'] = '';
|
|
}
|
|
if (!isset($entry['type'])) {
|
|
$entry['type'] = 'link';
|
|
}
|
|
$this->entries[$entry['id']] = $entry;
|
|
}
|
|
|
|
/**
|
|
* Get a list of navigation entries
|
|
*
|
|
* @param string $type type of the navigation entries
|
|
* @return array
|
|
*/
|
|
public function getAll(string $type = 'link'): array {
|
|
$this->init();
|
|
foreach ($this->closureEntries as $c) {
|
|
$this->add($c());
|
|
}
|
|
$this->closureEntries = [];
|
|
|
|
$result = $this->entries;
|
|
if ($type !== 'all') {
|
|
$result = array_filter($this->entries, function ($entry) use ($type) {
|
|
return $entry['type'] === $type;
|
|
});
|
|
}
|
|
|
|
return $this->proceedNavigation($result);
|
|
}
|
|
|
|
/**
|
|
* Sort navigation entries by order, name and set active flag
|
|
*
|
|
* @param array $list
|
|
* @return array
|
|
*/
|
|
private function proceedNavigation(array $list): array {
|
|
uasort($list, function ($a, $b) {
|
|
if (isset($a['order']) && isset($b['order'])) {
|
|
return ($a['order'] < $b['order']) ? -1 : 1;
|
|
} elseif (isset($a['order']) || isset($b['order'])) {
|
|
return isset($a['order']) ? -1 : 1;
|
|
} else {
|
|
return ($a['name'] < $b['name']) ? -1 : 1;
|
|
}
|
|
});
|
|
|
|
$activeApp = $this->getActiveEntry();
|
|
if ($activeApp !== null) {
|
|
foreach ($list as $index => &$navEntry) {
|
|
if ($navEntry['id'] == $activeApp) {
|
|
$navEntry['active'] = true;
|
|
} else {
|
|
$navEntry['active'] = false;
|
|
}
|
|
}
|
|
unset($navEntry);
|
|
}
|
|
|
|
return $list;
|
|
}
|
|
|
|
|
|
/**
|
|
* removes all the entries
|
|
*/
|
|
public function clear($loadDefaultLinks = true) {
|
|
$this->entries = [];
|
|
$this->closureEntries = [];
|
|
$this->init = !$loadDefaultLinks;
|
|
}
|
|
|
|
/**
|
|
* Sets the current navigation entry of the currently running app
|
|
* @param string $id of the app entry to activate (from added $entry)
|
|
*/
|
|
public function setActiveEntry($id) {
|
|
$this->activeEntry = $id;
|
|
}
|
|
|
|
/**
|
|
* gets the active Menu entry
|
|
* @return string id or empty string
|
|
*
|
|
* This function returns the id of the active navigation entry (set by
|
|
* setActiveEntry
|
|
*/
|
|
public function getActiveEntry() {
|
|
return $this->activeEntry;
|
|
}
|
|
|
|
private function init() {
|
|
if ($this->init) {
|
|
return;
|
|
}
|
|
$this->init = true;
|
|
|
|
$l = $this->l10nFac->get('lib');
|
|
if ($this->config->getSystemValue('knowledgebaseenabled', true)) {
|
|
$this->add([
|
|
'type' => 'settings',
|
|
'id' => 'help',
|
|
'order' => 6,
|
|
'href' => $this->urlGenerator->linkToRoute('settings.Help.help'),
|
|
'name' => $l->t('Help'),
|
|
'icon' => $this->urlGenerator->imagePath('settings', 'help.svg'),
|
|
]);
|
|
}
|
|
|
|
if ($this->userSession->isLoggedIn()) {
|
|
if ($this->isAdmin()) {
|
|
// App management
|
|
$this->add([
|
|
'type' => 'settings',
|
|
'id' => 'core_apps',
|
|
'order' => 4,
|
|
'href' => $this->urlGenerator->linkToRoute('settings.AppSettings.viewApps'),
|
|
'icon' => $this->urlGenerator->imagePath('settings', 'apps.svg'),
|
|
'name' => $l->t('Apps'),
|
|
]);
|
|
}
|
|
|
|
// Personal and (if applicable) admin settings
|
|
$this->add([
|
|
'type' => 'settings',
|
|
'id' => 'settings',
|
|
'order' => 2,
|
|
'href' => $this->urlGenerator->linkToRoute('settings.PersonalSettings.index'),
|
|
'name' => $l->t('Settings'),
|
|
'icon' => $this->urlGenerator->imagePath('settings', 'admin.svg'),
|
|
]);
|
|
|
|
$logoutUrl = \OC_User::getLogoutUrl($this->urlGenerator);
|
|
if ($logoutUrl !== '') {
|
|
// Logout
|
|
$this->add([
|
|
'type' => 'settings',
|
|
'id' => 'logout',
|
|
'order' => 99999,
|
|
'href' => $logoutUrl,
|
|
'name' => $l->t('Log out'),
|
|
'icon' => $this->urlGenerator->imagePath('core', 'actions/logout.svg'),
|
|
]);
|
|
}
|
|
|
|
if ($this->isSubadmin()) {
|
|
// User management
|
|
$this->add([
|
|
'type' => 'settings',
|
|
'id' => 'core_users',
|
|
'order' => 5,
|
|
'href' => $this->urlGenerator->linkToRoute('settings.Users.usersList'),
|
|
'name' => $l->t('Users'),
|
|
'icon' => $this->urlGenerator->imagePath('settings', 'users.svg'),
|
|
]);
|
|
}
|
|
}
|
|
|
|
if ($this->appManager === 'null') {
|
|
return;
|
|
}
|
|
|
|
if ($this->userSession->isLoggedIn()) {
|
|
$apps = $this->appManager->getEnabledAppsForUser($this->userSession->getUser());
|
|
} else {
|
|
$apps = $this->appManager->getInstalledApps();
|
|
}
|
|
|
|
foreach ($apps as $app) {
|
|
if (!$this->userSession->isLoggedIn() && !$this->appManager->isEnabledForUser($app, $this->userSession->getUser())) {
|
|
continue;
|
|
}
|
|
|
|
// load plugins and collections from info.xml
|
|
$info = $this->appManager->getAppInfo($app);
|
|
if (!isset($info['navigations']['navigation'])) {
|
|
continue;
|
|
}
|
|
foreach ($info['navigations']['navigation'] as $key => $nav) {
|
|
if (!isset($nav['name'])) {
|
|
continue;
|
|
}
|
|
if (!isset($nav['route'])) {
|
|
continue;
|
|
}
|
|
$role = isset($nav['@attributes']['role']) ? $nav['@attributes']['role'] : 'all';
|
|
if ($role === 'admin' && !$this->isAdmin()) {
|
|
continue;
|
|
}
|
|
$l = $this->l10nFac->get($app);
|
|
$id = $nav['id'] ?? $app . ($key === 0 ? '' : $key);
|
|
$order = isset($nav['order']) ? $nav['order'] : 100;
|
|
$type = isset($nav['type']) ? $nav['type'] : 'link';
|
|
$route = $nav['route'] !== '' ? $this->urlGenerator->linkToRoute($nav['route']) : '';
|
|
$icon = isset($nav['icon']) ? $nav['icon'] : 'app.svg';
|
|
foreach ([$icon, "$app.svg"] as $i) {
|
|
try {
|
|
$icon = $this->urlGenerator->imagePath($app, $i);
|
|
break;
|
|
} catch (\RuntimeException $ex) {
|
|
// no icon? - ignore it then
|
|
}
|
|
}
|
|
if ($icon === null) {
|
|
$icon = $this->urlGenerator->imagePath('core', 'default-app-icon');
|
|
}
|
|
|
|
$this->add([
|
|
'id' => $id,
|
|
'order' => $order,
|
|
'href' => $route,
|
|
'icon' => $icon,
|
|
'type' => $type,
|
|
'name' => $l->t($nav['name']),
|
|
]);
|
|
}
|
|
}
|
|
}
|
|
|
|
private function isAdmin() {
|
|
$user = $this->userSession->getUser();
|
|
if ($user !== null) {
|
|
return $this->groupManager->isAdmin($user->getUID());
|
|
}
|
|
return false;
|
|
}
|
|
|
|
private function isSubadmin() {
|
|
$user = $this->userSession->getUser();
|
|
if ($user !== null) {
|
|
return $this->groupManager->getSubAdmin()->isSubAdmin($user);
|
|
}
|
|
return false;
|
|
}
|
|
}
|