Load files navigation elements from info.xml

Author: DeepDiver1975

apps/files/appinfo/app.php

@@ -27,18 +27,8 @@
  */
 \OCP\App::registerAdmin('files', 'admin');
 
-
-\OC::$server->getNavigationManager()->add(function () {
-	$urlGenerator = \OC::$server->getURLGenerator();
-	$l = \OC::$server->getL10N('files');
-	return [
-		'id' => 'files_index',
-		'order' => 0,
-		'href' => $urlGenerator->linkToRoute('files.view.index'),
-		'icon' => $urlGenerator->imagePath('core', 'places/files.svg'),
-		'name' => $l->t('Files'),
-	];
-});
+// required for translation purpose
+// t('Files')
 
 \OC::$server->getSearch()->registerProvider('OC\Search\Provider\File', ['apps' => ['files']]);
 

apps/files/appinfo/info.xml

@@ -28,4 +28,10 @@
 		<command>OCA\Files\Command\DeleteOrphanedFiles</command>
 		<command>OCA\Files\Command\TransferOwnership</command>
 	</commands>
+
+	<navigation>
+		<route>files.view.index</route>
+		<order>0</order>
+	</navigation>
+
 </info>

apps/files/img/app.svg

@@ -26,8 +26,10 @@
 namespace OC;
 
 use OCP\App\IAppManager;
+use OCP\IGroupManager;
 use OCP\INavigationManager;
 use OCP\IURLGenerator;
+use OCP\IUserSession;
 use OCP\L10N\IFactory;
 
 /**
@@ -37,19 +39,29 @@ class NavigationManager implements INavigationManager {
 	protected $entries = [];
 	protected $closureEntries = [];
 	protected $activeEntry;
+	/** @var bool */
 	protected $init = false;
 	/** @var IAppManager */
 	protected $appManager;
 	/** @var IURLGenerator */
 	private $urlGenerator;
 	/** @var IFactory */
 	private $l10nFac;
+	/** @var IUserSession */
+	private $userSession;
+	/** @var IGroupManager */
+	private $groupManager;
 
-	function __construct(IAppManager $appManager = null, $urlGenerator = null, $l10nFac = null) {
+	function __construct(IAppManager $appManager = null,
+						 IURLGenerator $urlGenerator = null,
+						 IFactory $l10nFac = null,
+						 IUserSession $userSession = null,
+						 IGroupManager$groupManager = null) {
 		$this->appManager = $appManager;
 		$this->urlGenerator = $urlGenerator;
 		$this->l10nFac = $l10nFac;
-
+		$this->userSession = $userSession;
+		$this->groupManager = $groupManager;
 	}
 
 	/**
@@ -132,15 +144,16 @@ private function init() {
 			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);
 			$order = isset($nav['order']) ? $nav['order'] : 100;
 			$route = $this->urlGenerator->linkToRoute($nav['route']);
 			$name = isset($nav['name']) ? $nav['name'] : ucfirst($app);
-			$icon = null;
-			foreach ([$nav['icon'], 'app.svg', "$app.svg"] as $i) {
-				if (is_null($i)) {
-					continue;
-				}
+			$icon = isset($nav['icon']) ? $nav['icon'] : 'app.svg';
+			foreach ([$icon, "$app.svg"] as $i) {
 				try {
 					$icon = $this->urlGenerator->imagePath($app, $i);
 					break;
@@ -160,4 +173,13 @@ private function init() {
 			]);
 		}
 	}
+
+	private function isAdmin() {
+		$user = $this->userSession->getUser();
+		if ($user !== null) {
+			return $this->groupManager->isAdmin($user->getUID());
+		}
+		return false;
+	}
+
 }

lib/private/NavigationManager.php

@@ -292,7 +292,9 @@ public function __construct($webRoot, \OC\Config $config) {
 		$this->registerService('NavigationManager', function (Server $c) {
 			return new \OC\NavigationManager($c->getAppManager(),
 				$c->getURLGenerator(),
-				$c->getL10NFactory());
+				$c->getL10NFactory(),
+				$c->getUserSession(),
+				$c->getGroupManager());
 		});
 		$this->registerService('AllConfig', function (Server $c) {
 			return new \OC\AllConfig(

lib/private/Server.php

@@ -13,6 +13,13 @@
 namespace Test;
 
 use OC\NavigationManager;
+use OCP\App\IAppManager;
+use OCP\IGroupManager;
+use OCP\IL10N;
+use OCP\IURLGenerator;
+use OCP\IUser;
+use OCP\IUserSession;
+use OCP\L10N\IFactory;
 
 class NavigationManagerTest extends TestCase {
 	/** @var \OC\NavigationManager */
@@ -157,4 +164,61 @@ public function testAddClosureClearGetAll() {
 		$this->assertEmpty($this->navigationManager->getAll(), 'Expected no navigation entry exists after clear()');
 		$this->assertEquals(0, $testAddClosureNumberOfCalls, 'Expected that the closure is not called by getAll()');
 	}
+
+	/**
+	 * @dataProvider providesNavigationConfig
+	 */
+	public function testWithAppManager($expected, $config, $isAdmin = false) {
+
+		$appManager = $this->createMock(IAppManager::class);
+		$urlGenerator = $this->createMock(IURLGenerator::class);
+		$l10nFac = $this->createMock(IFactory::class);
+		$userSession = $this->createMock(IUserSession::class);
+		$groupManager = $this->createMock(IGroupManager::class);
+		$l = $this->createMock(IL10N::class);
+		$l->expects($this->any())->method('t')->willReturnCallback(function($text, $parameters = []) {
+			return vsprintf($text, $parameters);
+		});
+
+		$appManager->expects($this->once())->method('getInstalledApps')->willReturn(['test']);
+		$appManager->expects($this->once())->method('getAppInfo')->with('test')->willReturn($config);
+		$l10nFac->expects($this->exactly(count($expected)))->method('get')->with('test')->willReturn($l);
+		$urlGenerator->expects($this->any())->method('imagePath')->willReturnCallback(function($appName, $file) {
+			return "/apps/$appName/img/$file";
+		});
+		$urlGenerator->expects($this->exactly(count($expected)))->method('linkToRoute')->willReturnCallback(function($route) {
+			return "/apps/test/";
+		});
+		$user = $this->createMock(IUser::class);
+		$user->expects($this->any())->method('getUID')->willReturn('user001');
+		$userSession->expects($this->any())->method('getUser')->willReturn($user);
+		$groupManager->expects($this->any())->method('isAdmin')->willReturn($isAdmin);
+
+		$navigationManager = new NavigationManager($appManager, $urlGenerator, $l10nFac, $userSession, $groupManager);
+
+		$entries = $navigationManager->getAll();
+		$this->assertEquals($expected, $entries);
+	}
+
+	public function providesNavigationConfig() {
+		return [
+			'minimalistic' => [[[
+				'id' => 'test',
+				'order' => 100,
+				'href' => '/apps/test/',
+				'icon' => '/apps/test/img/app.svg',
+				'name' => 'Test',
+				'active' => false
+			]], ['navigation' => ['route' => 'test.page.index']]],
+			'no admin' => [[[
+				'id' => 'test',
+				'order' => 100,
+				'href' => '/apps/test/',
+				'icon' => '/apps/test/img/app.svg',
+				'name' => 'Test',
+				'active' => false
+			]], ['navigation' => ['@attributes' => ['role' => 'admin'], 'route' => 'test.page.index']], true],
+			'admin' => [[], ['navigation' => ['@attributes' => ['role' => 'admin'], 'route' => 'test.page.index']]]
+		];
+	}
 }