2018-01-29 12:04:45 +01:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* @copyright Copyright (c) 2018 Julius Härtl <jus@bitgrid.net>
|
|
|
|
*
|
|
|
|
* @author Julius Härtl <jus@bitgrid.net>
|
|
|
|
*
|
|
|
|
* @license GNU AGPL version 3 or any later version
|
|
|
|
*
|
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Affero General Public License as
|
|
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
|
|
* License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* 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
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
namespace OC\Core\Controller;
|
|
|
|
|
2018-03-05 12:19:20 +01:00
|
|
|
use OCP\AppFramework\Http;
|
2018-02-01 12:18:24 +01:00
|
|
|
use OCP\AppFramework\Http\DataResponse;
|
|
|
|
use OCP\AppFramework\OCSController;
|
2018-01-29 12:04:45 +01:00
|
|
|
use OCP\INavigationManager;
|
|
|
|
use OCP\IRequest;
|
2018-01-29 12:52:40 +01:00
|
|
|
use OCP\IURLGenerator;
|
2018-01-29 12:04:45 +01:00
|
|
|
|
2018-02-01 12:18:24 +01:00
|
|
|
class NavigationController extends OCSController {
|
2018-01-29 12:04:45 +01:00
|
|
|
|
|
|
|
/** @var INavigationManager */
|
|
|
|
private $navigationManager;
|
|
|
|
|
2018-01-29 12:52:40 +01:00
|
|
|
/** @var IURLGenerator */
|
|
|
|
private $urlGenerator;
|
|
|
|
|
|
|
|
public function __construct(string $appName, IRequest $request, INavigationManager $navigationManager, IURLGenerator $urlGenerator) {
|
2018-01-29 12:18:11 +01:00
|
|
|
parent::__construct($appName, $request);
|
2018-01-29 12:04:45 +01:00
|
|
|
$this->navigationManager = $navigationManager;
|
2018-01-29 12:52:40 +01:00
|
|
|
$this->urlGenerator = $urlGenerator;
|
2018-01-29 12:04:45 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @NoAdminRequired
|
|
|
|
* @NoCSRFRequired
|
|
|
|
*
|
2018-01-29 12:52:40 +01:00
|
|
|
* @param bool $absolute
|
2018-02-01 12:18:24 +01:00
|
|
|
* @return DataResponse
|
2018-01-29 12:04:45 +01:00
|
|
|
*/
|
2018-02-01 12:18:24 +01:00
|
|
|
public function getAppsNavigation(bool $absolute = false): DataResponse {
|
|
|
|
$navigation = $this->navigationManager->getAll();
|
2018-01-29 12:52:40 +01:00
|
|
|
if ($absolute) {
|
2018-02-01 12:18:24 +01:00
|
|
|
$navigation = $this->rewriteToAbsoluteUrls($navigation);
|
2018-01-29 12:52:40 +01:00
|
|
|
}
|
2018-03-05 12:19:20 +01:00
|
|
|
|
2018-03-05 16:22:18 +01:00
|
|
|
$etag = $this->generateETag($navigation);
|
2018-03-05 12:19:20 +01:00
|
|
|
if ($this->request->getHeader('If-None-Match') === $etag) {
|
|
|
|
return new DataResponse([], Http::STATUS_NOT_MODIFIED);
|
|
|
|
}
|
|
|
|
$response = new DataResponse($navigation);
|
2018-03-05 16:22:18 +01:00
|
|
|
$response->setETag($etag);
|
2018-03-05 12:19:20 +01:00
|
|
|
return $response;
|
2018-01-29 12:04:45 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @NoAdminRequired
|
|
|
|
* @NoCSRFRequired
|
|
|
|
*
|
2018-01-29 12:52:40 +01:00
|
|
|
* @param bool $absolute
|
2018-02-01 12:18:24 +01:00
|
|
|
* @return DataResponse
|
2018-01-29 12:04:45 +01:00
|
|
|
*/
|
2018-02-01 12:18:24 +01:00
|
|
|
public function getSettingsNavigation(bool $absolute = false): DataResponse {
|
2018-01-29 12:52:40 +01:00
|
|
|
$navigation = $this->navigationManager->getAll('settings');
|
|
|
|
if ($absolute) {
|
2018-02-01 12:18:24 +01:00
|
|
|
$navigation = $this->rewriteToAbsoluteUrls($navigation);
|
2018-01-29 12:52:40 +01:00
|
|
|
}
|
2018-03-05 16:22:18 +01:00
|
|
|
$etag = $this->generateETag($navigation);
|
2018-03-05 12:19:20 +01:00
|
|
|
if ($this->request->getHeader('If-None-Match') === $etag) {
|
|
|
|
return new DataResponse([], Http::STATUS_NOT_MODIFIED);
|
|
|
|
}
|
|
|
|
$response = new DataResponse($navigation);
|
2018-03-05 16:22:18 +01:00
|
|
|
$response->setETag($etag);
|
2018-03-05 12:19:20 +01:00
|
|
|
return $response;
|
2018-01-29 12:52:40 +01:00
|
|
|
}
|
|
|
|
|
2018-03-05 16:22:18 +01:00
|
|
|
/**
|
|
|
|
* Generate an ETag for a list of navigation entries
|
|
|
|
*
|
|
|
|
* @param array $navigation
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
private function generateETag(array $navigation): string {
|
|
|
|
foreach ($navigation as &$nav) {
|
|
|
|
if ($nav['id'] === 'logout') {
|
|
|
|
$nav['href'] = 'logout';
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return md5(json_encode($navigation));
|
|
|
|
}
|
|
|
|
|
2018-01-29 12:52:40 +01:00
|
|
|
/**
|
|
|
|
* Rewrite href attribute of navigation entries to an absolute URL
|
|
|
|
*
|
|
|
|
* @param array $navigation
|
2018-02-01 12:18:24 +01:00
|
|
|
* @return array
|
2018-01-29 12:52:40 +01:00
|
|
|
*/
|
2018-02-01 12:18:24 +01:00
|
|
|
private function rewriteToAbsoluteUrls(array $navigation): array {
|
2018-01-29 12:52:40 +01:00
|
|
|
foreach ($navigation as &$entry) {
|
2018-02-01 12:18:24 +01:00
|
|
|
if (0 !== strpos($entry['href'], $this->urlGenerator->getBaseUrl())) {
|
2018-01-29 12:52:40 +01:00
|
|
|
$entry['href'] = $this->urlGenerator->getAbsoluteURL($entry['href']);
|
|
|
|
}
|
2018-02-12 17:30:08 +01:00
|
|
|
if (0 !== strpos($entry['icon'], $this->urlGenerator->getBaseUrl())) {
|
|
|
|
$entry['icon'] = $this->urlGenerator->getAbsoluteURL($entry['icon']);
|
|
|
|
}
|
2018-01-29 12:52:40 +01:00
|
|
|
}
|
2018-02-01 12:18:24 +01:00
|
|
|
return $navigation;
|
2018-01-29 12:04:45 +01:00
|
|
|
}
|
|
|
|
}
|