Add overview settings section

Signed-off-by: Julius Härtl <jus@bitgrid.net>

lib/private/Settings/Admin/Additional.php

@@ -70,7 +70,7 @@ class Additional implements ISettings {
 	 * @return string the section ID, e.g. 'sharing'
 	 */
 	public function getSection() {
-		return 'additional';
+		return 'server';
 	}
 
 	/**

lib/private/Settings/Admin/Overview.php

@@ -0,0 +1,159 @@
+<?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\Settings\Admin;
+
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Platforms\SqlitePlatform;
+use OC\Lock\DBLockingProvider;
+use OC\Lock\NoopLockingProvider;
+use OCP\AppFramework\Http\TemplateResponse;
+use OCP\IConfig;
+use OCP\IDBConnection;
+use OCP\IL10N;
+use OCP\IRequest;
+use OCP\Lock\ILockingProvider;
+use OCP\Settings\ISettings;
+
+class Overview implements ISettings {
+	/** @var IDBConnection|Connection */
+	private $db;
+	/** @var IRequest */
+	private $request;
+	/** @var IConfig */
+	private $config;
+	/** @var ILockingProvider */
+	private $lockingProvider;
+	/** @var IL10N */
+	private $l;
+
+	/**
+	 * @param IDBConnection $db
+	 * @param IRequest $request
+	 * @param IConfig $config
+	 * @param ILockingProvider $lockingProvider
+	 * @param IL10N $l
+	 */
+	public function __construct(IDBConnection $db,
+								IRequest $request,
+								IConfig $config,
+								ILockingProvider $lockingProvider,
+								IL10N $l) {
+		$this->db = $db;
+		$this->request = $request;
+		$this->config = $config;
+		$this->lockingProvider = $lockingProvider;
+		$this->l = $l;
+	}
+
+	/**
+	 * @return TemplateResponse
+	 */
+	public function getForm() {
+		try {
+			if ($this->db->getDatabasePlatform() instanceof SqlitePlatform) {
+				$invalidTransactionIsolationLevel = false;
+			} else {
+				$invalidTransactionIsolationLevel = $this->db->getTransactionIsolation() !== Connection::TRANSACTION_READ_COMMITTED;
+			}
+		} catch (DBALException $e) {
+			// ignore
+			$invalidTransactionIsolationLevel = false;
+		}
+
+		$envPath = getenv('PATH');
+
+		// warn if outdated version of a memcache module is used
+		$caches = [
+			'apcu'	=> ['name' => $this->l->t('APCu'), 'version' => '4.0.6'],
+			'redis'	=> ['name' => $this->l->t('Redis'), 'version' => '2.2.5'],
+		];
+		$outdatedCaches = [];
+		foreach ($caches as $php_module => $data) {
+			$isOutdated = extension_loaded($php_module) && version_compare(phpversion($php_module), $data['version'], '<');
+			if ($isOutdated) {
+				$outdatedCaches[$php_module] = $data;
+			}
+		}
+
+		if ($this->lockingProvider instanceof NoopLockingProvider) {
+			$fileLockingType = 'none';
+		} else if ($this->lockingProvider instanceof DBLockingProvider) {
+			$fileLockingType = 'db';
+		} else {
+			$fileLockingType = 'cache';
+		}
+
+		$suggestedOverwriteCliUrl = '';
+		if ($this->config->getSystemValue('overwrite.cli.url', '') === '') {
+			$suggestedOverwriteCliUrl = $this->request->getServerProtocol() . '://' . $this->request->getInsecureServerHost() . \OC::$WEBROOT;
+			if (!$this->config->getSystemValue('config_is_read_only', false)) {
+				// Set the overwrite URL when it was not set yet.
+				$this->config->setSystemValue('overwrite.cli.url', $suggestedOverwriteCliUrl);
+				$suggestedOverwriteCliUrl = '';
+			}
+		}
+
+		$parameters = [
+			// Diagnosis
+			'readOnlyConfigEnabled'            => \OC_Helper::isReadOnlyConfigEnabled(),
+			'isLocaleWorking'                  => \OC_Util::isSetLocaleWorking(),
+			'isAnnotationsWorking'             => \OC_Util::isAnnotationsWorking(),
+			'checkForWorkingWellKnownSetup'    => $this->config->getSystemValue('check_for_working_wellknown_setup', true),
+			'has_fileinfo'                     => \OC_Util::fileInfoLoaded(),
+			'invalidTransactionIsolationLevel' => $invalidTransactionIsolationLevel,
+			'getenvServerNotWorking'           => empty($envPath),
+			'OutdatedCacheWarning'             => $outdatedCaches,
+			'fileLockingType'                  => $fileLockingType,
+			'suggestedOverwriteCliUrl'         => $suggestedOverwriteCliUrl,
+
+			// Background jobs
+			'backgroundjobs_mode' => $this->config->getAppValue('core', 'backgroundjobs_mode', 'ajax'),
+			'lastcron'            => $this->config->getAppValue('core', 'lastcron', false),
+			'cronErrors'		  => $this->config->getAppValue('core', 'cronErrors'),
+			'cli_based_cron_possible' => function_exists('posix_getpwuid'),
+			'cli_based_cron_user' => function_exists('posix_getpwuid') ? posix_getpwuid(fileowner(\OC::$configDir . 'config.php'))['name'] : '',
+		];
+
+		return new TemplateResponse('settings', 'settings/admin/overview', $parameters, '');
+	}
+
+	/**
+	 * @return string the section ID, e.g. 'sharing'
+	 */
+	public function getSection() {
+		return 'overview';
+	}
+
+	/**
+	 * @return int whether the form should be rather on the top or bottom of
+	 * the admin section. The forms are arranged in ascending order of the
+	 * priority values. It is required to return a value between 0 and 100.
+	 *
+	 * E.g.: 70
+	 */
+	public function getPriority() {
+		return 10;
+	}
+}

lib/private/Settings/Manager.php

@@ -226,7 +226,8 @@ class Manager implements IManager {
 	public function getAdminSections(): array {
 		// built-in sections
 		$sections = [
-			0 => [new Section('server', $this->l->t('Basic settings'), 0, $this->url->imagePath('settings', 'admin.svg'))],
+			0 => [new Section('overview', $this->l->t('Overview'), 0, $this->url->imagePath('settings', 'admin.svg'))],
+			1 => [new Section('server', $this->l->t('Basic settings'), 0, $this->url->imagePath('settings', 'admin.svg'))],
 			5 => [new Section('sharing', $this->l->t('Sharing'), 0, $this->url->imagePath('core', 'actions/share.svg'))],
 			10 => [new Section('security', $this->l->t('Security'), 0, $this->url->imagePath('core', 'actions/password.svg'))],
 			45 => [new Section('encryption', $this->l->t('Encryption'), 0, $this->url->imagePath('core', 'actions/password.svg'))],
@@ -257,12 +258,17 @@ class Manager implements IManager {
 	private function getBuiltInAdminSettings($section): array {
 		$forms = [];
 
+		if ($section === 'overview') {
+			/** @var ISettings $form */
+			$form = new Admin\Overview($this->dbc, $this->request, $this->config, $this->lockingProvider, $this->l);
+			$forms[$form->getPriority()] = [$form];
+			$form = new Admin\ServerDevNotice();
+			$forms[$form->getPriority()] = [$form];
+		}
 		if ($section === 'server') {
 			/** @var ISettings $form */
 			$form = new Admin\Server($this->dbc, $this->request, $this->config, $this->lockingProvider, $this->l);
 			$forms[$form->getPriority()] = [$form];
-			$form = new Admin\ServerDevNotice();
-			$forms[$form->getPriority()] = [$form];
 		}
 		if ($section === 'encryption') {
 			/** @var ISettings $form */

settings/templates/settings/admin/overview.php

@@ -0,0 +1,172 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @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/>.
+ *
+ */
+
+/** @var \OCP\IL10N $l */
+/** @var array $_ */
+
+?>
+
+<div id="security-warning" class="section">
+	<h2><?php p($l->t('Security & setup warnings'));?></h2>
+	<p class="settings-hint"><?php p($l->t('It\'s important for the security and performance of your instance that everything is configured correctly. To help you with that we are doing some automatic checks. Please see the Tips & Tricks section and the documentation for more information.'));?></p>
+	<ul>
+		<?php
+		// is php setup properly to query system environment variables like getenv('PATH')
+		if ($_['getenvServerNotWorking']) {
+			?>
+			<li>
+				<?php p($l->t('PHP does not seem to be setup properly to query system environment variables. The test with getenv("PATH") only returns an empty response.')); ?><br>
+				<?php print_unescaped($l->t('Please check the <a target="_blank" rel="noreferrer noopener" href="%s">installation documentation ↗</a> for PHP configuration notes and the PHP configuration of your server, especially when using php-fpm.', link_to_docs('admin-php-fpm'))); ?>
+			</li>
+			<?php
+		}
+
+		// is read only config enabled
+		if ($_['readOnlyConfigEnabled']) {
+			?>
+			<li>
+				<?php p($l->t('The Read-Only config has been enabled. This prevents setting some configurations via the web-interface. Furthermore, the file needs to be made writable manually for every update.')); ?>
+			</li>
+			<?php
+		}
+
+		// Are doc blocks accessible?
+		if (!$_['isAnnotationsWorking']) {
+			?>
+			<li>
+				<?php p($l->t('PHP is apparently set up to strip inline doc blocks. This will make several core apps inaccessible.')); ?><br>
+				<?php p($l->t('This is probably caused by a cache/accelerator such as Zend OPcache or eAccelerator.')); ?>
+			</li>
+			<?php
+		}
+
+		// Is the Transaction isolation level READ_COMMITTED?
+		if ($_['invalidTransactionIsolationLevel']) {
+			?>
+			<li>
+				<?php p($l->t('Your database does not run with "READ COMMITTED" transaction isolation level. This can cause problems when multiple actions are executed in parallel.')); ?>
+			</li>
+			<?php
+		}
+
+		// Warning if memcache is outdated
+		foreach ($_['OutdatedCacheWarning'] as $php_module => $data) {
+			?>
+			<li>
+				<?php p($l->t('%1$s below version %2$s is installed, for stability and performance reasons it is recommended to update to a newer %1$s version.', $data)); ?>
+			</li>
+			<?php
+		}
+
+		// if module fileinfo available?
+		if (!$_['has_fileinfo']) {
+			?>
+			<li>
+				<?php p($l->t('The PHP module \'fileinfo\' is missing. It is strongly recommended to enable this module to get the best results with MIME type detection.')); ?>
+			</li>
+			<?php
+		}
+
+		// locking configured optimally?
+		if ($_['fileLockingType'] === 'none') {
+			?>
+			<li>
+				<?php print_unescaped($l->t('Transactional file locking is disabled, this might lead to issues with race conditions. Enable \'filelocking.enabled\' in config.php to avoid these problems. See the <a target="_blank" rel="noreferrer noopener" href="%s">documentation ↗</a> for more information.', link_to_docs('admin-transactional-locking'))); ?>
+			</li>
+			<?php
+		}
+
+		// is locale working ?
+		if (!$_['isLocaleWorking']) {
+			?>
+			<li>
+				<?php
+				$locales = 'en_US.UTF-8/fr_FR.UTF-8/es_ES.UTF-8/de_DE.UTF-8/ru_RU.UTF-8/pt_BR.UTF-8/it_IT.UTF-8/ja_JP.UTF-8/zh_CN.UTF-8';
+				p($l->t('System locale can not be set to a one which supports UTF-8.'));
+				?>
+				<br>
+				<?php
+				p($l->t('This means that there might be problems with certain characters in filenames.'));
+				?>
+				<br>
+				<?php
+				p($l->t('It is strongly proposed to install the required packages on your system to support one of the following locales: %s.', [$locales]));
+				?>
+			</li>
+			<?php
+		}
+
+		if ($_['suggestedOverwriteCliUrl']) {
+			?>
+			<li>
+				<?php p($l->t('If your installation is not installed at the root of the domain and uses system Cron, there can be issues with the URL generation. To avoid these problems, please set the "overwrite.cli.url" option in your config.php file to the webroot path of your installation (Suggested: "%s")', $_['suggestedOverwriteCliUrl'])); ?>
+			</li>
+			<?php
+		}
+
+		if ($_['cronErrors']) {
+			?>
+			<li>
+				<?php p($l->t('It was not possible to execute the cron job via CLI. The following technical errors have appeared:')); ?>
+				<br>
+				<ol>
+					<?php foreach(json_decode($_['cronErrors']) as $error) { if(isset($error->error)) {?>
+						<li><?php p($error->error) ?> <?php p($error->hint) ?></li>
+					<?php }} ?>
+				</ol>
+			</li>
+			<?php
+		}
+		?>
+		<?php if ($_['lastcron'] !== false):
+				$relative_time = relative_modified_date($_['lastcron']);
+				$formatter = \OC::$server->getDateTimeFormatter();
+				$absolute_time = $formatter->formatDateTime($_['lastcron'], 'long', 'long');
+				if (time() - $_['lastcron'] > 3600): ?>
+					<li class="crondate" title="<?php p($absolute_time);?>">
+						<?php p($l->t("Last background job execution ran %s. Something seems wrong.", [$relative_time]));?>
+						<a href="<?php p(\OC::$server->getURLGenerator()->linkToRoute('settings.AdminSettings.index', ['section' => 'server'])); ?>#backgroundjobs"><?php p($l->t('Check the background job settings')); ?></a>
+					</li>
+				<?php endif; ?>
+			<?php endif; ?>
+	</ul>
+
+	<div id="postsetupchecks" data-check-wellknown="<?php if($_['checkForWorkingWellKnownSetup']) { p('true'); } else { p('false'); } ?>">
+		<div class="loading"></div>
+		<ul class="errors hidden"></ul>
+		<ul class="warnings hidden"></ul>
+		<ul class="info hidden"></ul>
+		<p class="hint hidden">
+			<?php print_unescaped($l->t('Please double check the <a target="_blank" rel="noreferrer noopener" href="%s">installation guides ↗</a>, and check for any errors or warnings in the <a href="%s">log</a>.', [link_to_docs('admin-install'), \OC::$server->getURLGenerator()->linkToRoute('settings.AdminSettings.index', ['section' => 'logging'])] )); ?>
+		</p>
+	</div>
+	<div id="security-warning-state">
+		<span class="hidden icon-checkmark"><?php p($l->t('All checks passed.'));?></span>
+	</div>
+</div>
+
+<div class="section">
+	<!-- should be the last part, so Updater can follow if enabled (it has no heading therefore). -->
+	<h2><?php p($l->t('Version'));?></h2>
+	<p><strong><a href="<?php print_unescaped($theme->getBaseUrl()); ?>" rel="noreferrer noopener" target="_blank"><?php p($theme->getTitle()); ?></a> <?php p(OC_Util::getHumanVersion()) ?></strong></p>
+</div>

settings/templates/settings/admin/server.php

@@ -26,134 +26,6 @@
 
 ?>
 
-<div id="security-warning" class="section">
-	<h2><?php p($l->t('Security & setup warnings'));?></h2>
-	<p class="settings-hint"><?php p($l->t('It\'s important for the security and performance of your instance that everything is configured correctly. To help you with that we are doing some automatic checks. Please see the Tips & Tricks section and the documentation for more information.'));?></p>
-	<ul>
-		<?php
-		// is php setup properly to query system environment variables like getenv('PATH')
-		if ($_['getenvServerNotWorking']) {
-			?>
-			<li>
-				<?php p($l->t('PHP does not seem to be setup properly to query system environment variables. The test with getenv("PATH") only returns an empty response.')); ?><br>
-				<?php print_unescaped($l->t('Please check the <a target="_blank" rel="noreferrer noopener" href="%s">installation documentation ↗</a> for PHP configuration notes and the PHP configuration of your server, especially when using php-fpm.', link_to_docs('admin-php-fpm'))); ?>
-			</li>
-			<?php
-		}
-
-		// is read only config enabled
-		if ($_['readOnlyConfigEnabled']) {
-			?>
-			<li>
-				<?php p($l->t('The Read-Only config has been enabled. This prevents setting some configurations via the web-interface. Furthermore, the file needs to be made writable manually for every update.')); ?>
-			</li>
-			<?php
-		}
-
-		// Are doc blocks accessible?
-		if (!$_['isAnnotationsWorking']) {
-			?>
-			<li>
-				<?php p($l->t('PHP is apparently set up to strip inline doc blocks. This will make several core apps inaccessible.')); ?><br>
-				<?php p($l->t('This is probably caused by a cache/accelerator such as Zend OPcache or eAccelerator.')); ?>
-			</li>
-			<?php
-		}
-
-		// Is the Transaction isolation level READ_COMMITTED?
-		if ($_['invalidTransactionIsolationLevel']) {
-			?>
-			<li>
-				<?php p($l->t('Your database does not run with "READ COMMITTED" transaction isolation level. This can cause problems when multiple actions are executed in parallel.')); ?>
-			</li>
-			<?php
-		}
-
-		// Warning if memcache is outdated
-		foreach ($_['OutdatedCacheWarning'] as $php_module => $data) {
-			?>
-			<li>
-				<?php p($l->t('%1$s below version %2$s is installed, for stability and performance reasons it is recommended to update to a newer %1$s version.', $data)); ?>
-			</li>
-			<?php
-		}
-
-		// if module fileinfo available?
-		if (!$_['has_fileinfo']) {
-			?>
-			<li>
-				<?php p($l->t('The PHP module \'fileinfo\' is missing. It is strongly recommended to enable this module to get the best results with MIME type detection.')); ?>
-			</li>
-			<?php
-		}
-
-		// locking configured optimally?
-		if ($_['fileLockingType'] === 'none') {
-			?>
-			<li>
-				<?php print_unescaped($l->t('Transactional file locking is disabled, this might lead to issues with race conditions. Enable \'filelocking.enabled\' in config.php to avoid these problems. See the <a target="_blank" rel="noreferrer noopener" href="%s">documentation ↗</a> for more information.', link_to_docs('admin-transactional-locking'))); ?>
-			</li>
-			<?php
-		}
-
-		// is locale working ?
-		if (!$_['isLocaleWorking']) {
-			?>
-			<li>
-				<?php
-				$locales = 'en_US.UTF-8/fr_FR.UTF-8/es_ES.UTF-8/de_DE.UTF-8/ru_RU.UTF-8/pt_BR.UTF-8/it_IT.UTF-8/ja_JP.UTF-8/zh_CN.UTF-8';
-				p($l->t('System locale can not be set to a one which supports UTF-8.'));
-				?>
-				<br>
-				<?php
-				p($l->t('This means that there might be problems with certain characters in filenames.'));
-				?>
-				<br>
-				<?php
-				p($l->t('It is strongly proposed to install the required packages on your system to support one of the following locales: %s.', [$locales]));
-				?>
-			</li>
-			<?php
-		}
-
-		if ($_['suggestedOverwriteCliUrl']) {
-			?>
-			<li>
-				<?php p($l->t('If your installation is not installed at the root of the domain and uses system Cron, there can be issues with the URL generation. To avoid these problems, please set the "overwrite.cli.url" option in your config.php file to the webroot path of your installation (Suggested: "%s")', $_['suggestedOverwriteCliUrl'])); ?>
-			</li>
-			<?php
-		}
-
-		if ($_['cronErrors']) {
-			?>
-			<li>
-				<?php p($l->t('It was not possible to execute the cron job via CLI. The following technical errors have appeared:')); ?>
-				<br>
-				<ol>
-					<?php foreach(json_decode($_['cronErrors']) as $error) { if(isset($error->error)) {?>
-						<li><?php p($error->error) ?> <?php p($error->hint) ?></li>
-					<?php }} ?>
-				</ol>
-			</li>
-			<?php
-		}
-		?>
-	</ul>
-
-	<div id="postsetupchecks" data-check-wellknown="<?php if($_['checkForWorkingWellKnownSetup']) { p('true'); } else { p('false'); } ?>">
-		<div class="loading"></div>
-		<ul class="errors hidden"></ul>
-		<ul class="warnings hidden"></ul>
-		<ul class="info hidden"></ul>
-		<p class="hint hidden">
-			<?php print_unescaped($l->t('Please double check the <a target="_blank" rel="noreferrer noopener" href="%s">installation guides ↗</a>, and check for any errors or warnings in the <a href="%s">log</a>.', [link_to_docs('admin-install'), \OC::$server->getURLGenerator()->linkToRoute('settings.AdminSettings.index', ['section' => 'logging'])] )); ?>
-		</p>
-	</div>
-	<div id="security-warning-state">
-		<span class="hidden icon-checkmark"><?php p($l->t('All checks passed.'));?></span>
-	</div>
-</div>
-
 <div class="section" id="backgroundjobs">
 	<h2 class="inlineblock"><?php p($l->t('Background jobs'));?></h2>
 	<p class="cronlog inlineblock">
@@ -221,9 +93,3 @@
 
 	</p>
 </div>
-
-<div class="section">
-	<!-- should be the last part, so Updater can follow if enabled (it has no heading therefore). -->
-	<h2><?php p($l->t('Version'));?></h2>
-	<p><strong><a href="<?php print_unescaped($theme->getBaseUrl()); ?>" rel="noreferrer noopener" target="_blank"><?php p($theme->getTitle()); ?></a> <?php p(OC_Util::getHumanVersion()) ?></strong></p>
-</div>