nextcloud / server

core/Controller/SetupController.php

Indentation +113 added lines, -113 removed lines

@@ -36,117 +36,117 @@
 use OCP\ILogger;
 
 class SetupController {
-	/** @var Setup */
-	protected $setupHelper;
-	/** @var string */
-	private $autoConfigFile;
-
-	/**
-	 * @param Setup $setupHelper
-	 */
-	function __construct(Setup $setupHelper) {
-		$this->autoConfigFile = \OC::$configDir.'autoconfig.php';
-		$this->setupHelper = $setupHelper;
-	}
-
-	/**
-	 * @param $post
-	 */
-	public function run($post) {
-		// Check for autosetup:
-		$post = $this->loadAutoConfig($post);
-		$opts = $this->setupHelper->getSystemInfo();
-
-		// convert 'abcpassword' to 'abcpass'
-		if (isset($post['adminpassword'])) {
-			$post['adminpass'] = $post['adminpassword'];
-		}
-		if (isset($post['dbpassword'])) {
-			$post['dbpass'] = $post['dbpassword'];
-		}
-
-		if (!is_file(\OC::$configDir.'/CAN_INSTALL')) {
-			$this->displaySetupForbidden();
-			return;
-		}
-
-		if(isset($post['install']) and $post['install']=='true') {
-			// We have to launch the installation process :
-			$e = $this->setupHelper->install($post);
-			$errors = ['errors' => $e];
-
-			if(count($e) > 0) {
-				$options = array_merge($opts, $post, $errors);
-				$this->display($options);
-			} else {
-				$this->finishSetup(isset($post['install-recommended-apps']));
-			}
-		} else {
-			$options = array_merge($opts, $post);
-			$this->display($options);
-		}
-	}
-
-	private function displaySetupForbidden() {
-		\OC_Template::printGuestPage('', 'installation_forbidden');
-	}
-
-	public function display($post) {
-		$defaults = [
-			'adminlogin' => '',
-			'adminpass' => '',
-			'dbuser' => '',
-			'dbpass' => '',
-			'dbname' => '',
-			'dbtablespace' => '',
-			'dbhost' => 'localhost',
-			'dbtype' => '',
-		];
-		$parameters = array_merge($defaults, $post);
-
-		\OC_Util::addScript('setup');
-		\OC_Template::printGuestPage('', 'installation', $parameters);
-	}
-
-	private function finishSetup(bool $installRecommended) {
-		if( file_exists( $this->autoConfigFile )) {
-			unlink($this->autoConfigFile);
-		}
-		\OC::$server->getIntegrityCodeChecker()->runInstanceVerification();
-
-		if (\OC_Util::getChannel() !== 'git' && is_file(\OC::$configDir.'/CAN_INSTALL')) {
-			if (!unlink(\OC::$configDir.'/CAN_INSTALL')) {
-				\OC_Template::printGuestPage('', 'installation_incomplete');
-			}
-		}
-
-		if ($installRecommended) {
-			$urlGenerator = \OC::$server->getURLGenerator();
-			$location = $urlGenerator->getAbsoluteURL('index.php/core/apps/recommended');
-			header('Location: ' . $location);
-			exit();
-		}
-		\OC_Util::redirectToDefaultPage();
-	}
-
-	public function loadAutoConfig($post) {
-		if( file_exists($this->autoConfigFile)) {
-			\OCP\Util::writeLog('core', 'Autoconfig file found, setting up Nextcloud…', ILogger::INFO);
-			$AUTOCONFIG = [];
-			include $this->autoConfigFile;
-			$post = array_merge ($post, $AUTOCONFIG);
-		}
-
-		$dbIsSet = isset($post['dbtype']);
-		$directoryIsSet = isset($post['directory']);
-		$adminAccountIsSet = isset($post['adminlogin']);
-
-		if ($dbIsSet and $directoryIsSet and $adminAccountIsSet) {
-			$post['install'] = 'true';
-		}
-		$post['dbIsSet'] = $dbIsSet;
-		$post['directoryIsSet'] = $directoryIsSet;
-
-		return $post;
-	}
+    /** @var Setup */
+    protected $setupHelper;
+    /** @var string */
+    private $autoConfigFile;
+
+    /**
+     * @param Setup $setupHelper
+     */
+    function __construct(Setup $setupHelper) {
+        $this->autoConfigFile = \OC::$configDir.'autoconfig.php';
+        $this->setupHelper = $setupHelper;
+    }
+
+    /**
+     * @param $post
+     */
+    public function run($post) {
+        // Check for autosetup:
+        $post = $this->loadAutoConfig($post);
+        $opts = $this->setupHelper->getSystemInfo();
+
+        // convert 'abcpassword' to 'abcpass'
+        if (isset($post['adminpassword'])) {
+            $post['adminpass'] = $post['adminpassword'];
+        }
+        if (isset($post['dbpassword'])) {
+            $post['dbpass'] = $post['dbpassword'];
+        }
+
+        if (!is_file(\OC::$configDir.'/CAN_INSTALL')) {
+            $this->displaySetupForbidden();
+            return;
+        }
+
+        if(isset($post['install']) and $post['install']=='true') {
+            // We have to launch the installation process :
+            $e = $this->setupHelper->install($post);
+            $errors = ['errors' => $e];
+
+            if(count($e) > 0) {
+                $options = array_merge($opts, $post, $errors);
+                $this->display($options);
+            } else {
+                $this->finishSetup(isset($post['install-recommended-apps']));
+            }
+        } else {
+            $options = array_merge($opts, $post);
+            $this->display($options);
+        }
+    }
+
+    private function displaySetupForbidden() {
+        \OC_Template::printGuestPage('', 'installation_forbidden');
+    }
+
+    public function display($post) {
+        $defaults = [
+            'adminlogin' => '',
+            'adminpass' => '',
+            'dbuser' => '',
+            'dbpass' => '',
+            'dbname' => '',
+            'dbtablespace' => '',
+            'dbhost' => 'localhost',
+            'dbtype' => '',
+        ];
+        $parameters = array_merge($defaults, $post);
+
+        \OC_Util::addScript('setup');
+        \OC_Template::printGuestPage('', 'installation', $parameters);
+    }
+
+    private function finishSetup(bool $installRecommended) {
+        if( file_exists( $this->autoConfigFile )) {
+            unlink($this->autoConfigFile);
+        }
+        \OC::$server->getIntegrityCodeChecker()->runInstanceVerification();
+
+        if (\OC_Util::getChannel() !== 'git' && is_file(\OC::$configDir.'/CAN_INSTALL')) {
+            if (!unlink(\OC::$configDir.'/CAN_INSTALL')) {
+                \OC_Template::printGuestPage('', 'installation_incomplete');
+            }
+        }
+
+        if ($installRecommended) {
+            $urlGenerator = \OC::$server->getURLGenerator();
+            $location = $urlGenerator->getAbsoluteURL('index.php/core/apps/recommended');
+            header('Location: ' . $location);
+            exit();
+        }
+        \OC_Util::redirectToDefaultPage();
+    }
+
+    public function loadAutoConfig($post) {
+        if( file_exists($this->autoConfigFile)) {
+            \OCP\Util::writeLog('core', 'Autoconfig file found, setting up Nextcloud…', ILogger::INFO);
+            $AUTOCONFIG = [];
+            include $this->autoConfigFile;
+            $post = array_merge ($post, $AUTOCONFIG);
+        }
+
+        $dbIsSet = isset($post['dbtype']);
+        $directoryIsSet = isset($post['directory']);
+        $adminAccountIsSet = isset($post['adminlogin']);
+
+        if ($dbIsSet and $directoryIsSet and $adminAccountIsSet) {
+            $post['install'] = 'true';
+        }
+        $post['dbIsSet'] = $dbIsSet;
+        $post['directoryIsSet'] = $directoryIsSet;
+
+        return $post;
+    }
 }

Spacing +6 added lines, -6 removed lines

@@ -70,12 +70,12 @@ 
 			return;
 		}
 
-		if(isset($post['install']) and $post['install']=='true') {
+		if (isset($post['install']) and $post['install'] == 'true') {
 			// We have to launch the installation process :
 			$e = $this->setupHelper->install($post);
 			$errors = ['errors' => $e];
 
-			if(count($e) > 0) {
+			if (count($e) > 0) {
 				$options = array_merge($opts, $post, $errors);
 				$this->display($options);
 			} else {
@@ -109,7 +109,7 @@ 
 	}
 
 	private function finishSetup(bool $installRecommended) {
-		if( file_exists( $this->autoConfigFile )) {
+		if (file_exists($this->autoConfigFile)) {
 			unlink($this->autoConfigFile);
 		}
 		\OC::$server->getIntegrityCodeChecker()->runInstanceVerification();
@@ -123,18 +123,18 @@ 
 		if ($installRecommended) {
 			$urlGenerator = \OC::$server->getURLGenerator();
 			$location = $urlGenerator->getAbsoluteURL('index.php/core/apps/recommended');
-			header('Location: ' . $location);
+			header('Location: '.$location);
 			exit();
 		}
 		\OC_Util::redirectToDefaultPage();
 	}
 
 	public function loadAutoConfig($post) {
-		if( file_exists($this->autoConfigFile)) {
+		if (file_exists($this->autoConfigFile)) {
 			\OCP\Util::writeLog('core', 'Autoconfig file found, setting up Nextcloud…', ILogger::INFO);
 			$AUTOCONFIG = [];
 			include $this->autoConfigFile;
-			$post = array_merge ($post, $AUTOCONFIG);
+			$post = array_merge($post, $AUTOCONFIG);
 		}
 
 		$dbIsSet = isset($post['dbtype']);

core/templates/installation.php

Indentation +5 added lines, -5 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 script('core', [
-	'dist/install'
+    'dist/install'
 ]);
 ?>
 <input type='hidden' id='hasMySQL' value='<?php p($_['hasMySQL']) ?>'>
@@ -29,9 +29,9 @@ 
 		<legend><strong><?php p($l->t('Security warning'));?></strong></legend>
 		<p><?php p($l->t('Your data directory and files are probably accessible from the internet because the .htaccess file does not work.'));?><br>
 		<?php print_unescaped($l->t(
-			'For information how to properly configure your server, please see the <a href="%s" target="_blank" rel="noreferrer noopener">documentation</a>.',
-			[link_to_docs('admin-install')]
-		)); ?></p>
+            'For information how to properly configure your server, please see the <a href="%s" target="_blank" rel="noreferrer noopener">documentation</a>.',
+            [link_to_docs('admin-install')]
+        )); ?></p>
 	</fieldset>
 	<?php endif; ?>
 	<fieldset id="adminaccount">
@@ -75,7 +75,7 @@ 
 	<?php if(!$_['dbIsSet'] or count($_['errors']) > 0): ?>
 	<fieldset id='databaseBackend'>
 		<?php if($_['hasMySQL'] or $_['hasPostgreSQL'] or $_['hasOracle'])
-			$hasOtherDB = true; else $hasOtherDB =false; //other than SQLite ?>
+            $hasOtherDB = true; else $hasOtherDB =false; //other than SQLite ?>
 		<legend><?php p($l->t( 'Configure the database' )); ?></legend>
 		<div id="selectDbType">
 		<?php foreach($_['databases'] as $type => $label): ?>

Spacing +48 added lines, -48 removed lines

@@ -9,12 +9,12 @@ 
 <input type='hidden' id='hasOracle' value='<?php p($_['hasOracle']) ?>'>
 <form action="index.php" method="post">
 <input type="hidden" name="install" value="true">
-	<?php if(count($_['errors']) > 0): ?>
+	<?php if (count($_['errors']) > 0): ?>
 	<fieldset class="warning">
-		<legend><strong><?php p($l->t('Error'));?></strong></legend>
-		<?php foreach($_['errors'] as $err): ?>
+		<legend><strong><?php p($l->t('Error')); ?></strong></legend>
+		<?php foreach ($_['errors'] as $err): ?>
 		<p>
-			<?php if(is_array($err)):?>
+			<?php if (is_array($err)):?>
 				<?php p($err['error']); ?>
 				<span class='hint'><?php p($err['hint']); ?></span>
 			<?php else: ?>
@@ -24,10 +24,10 @@ 
 		<?php endforeach; ?>
 	</fieldset>
 	<?php endif; ?>
-	<?php if(!$_['htaccessWorking']): ?>
+	<?php if (!$_['htaccessWorking']): ?>
 	<fieldset class="warning">
-		<legend><strong><?php p($l->t('Security warning'));?></strong></legend>
-		<p><?php p($l->t('Your data directory and files are probably accessible from the internet because the .htaccess file does not work.'));?><br>
+		<legend><strong><?php p($l->t('Security warning')); ?></strong></legend>
+		<p><?php p($l->t('Your data directory and files are probably accessible from the internet because the .htaccess file does not work.')); ?><br>
 		<?php print_unescaped($l->t(
 			'For information how to properly configure your server, please see the <a href="%s" target="_blank" rel="noreferrer noopener">documentation</a>.',
 			[link_to_docs('admin-install')]
@@ -35,35 +35,35 @@ 
 	</fieldset>
 	<?php endif; ?>
 	<fieldset id="adminaccount">
-		<legend><?php print_unescaped($l->t( 'Create an <strong>admin account</strong>' )); ?></legend>
+		<legend><?php print_unescaped($l->t('Create an <strong>admin account</strong>')); ?></legend>
 		<p class="grouptop">
 			<input type="text" name="adminlogin" id="adminlogin"
-				placeholder="<?php p($l->t( 'Username' )); ?>"
+				placeholder="<?php p($l->t('Username')); ?>"
 				value="<?php p($_['adminlogin']); ?>"
 				autocomplete="off" autocapitalize="none" autocorrect="off" autofocus required>
-			<label for="adminlogin" class="infield"><?php p($l->t( 'Username' )); ?></label>
+			<label for="adminlogin" class="infield"><?php p($l->t('Username')); ?></label>
 		</p>
 		<p class="groupbottom">
 			<input type="password" name="adminpass" data-typetoggle="#show" id="adminpass"
-				placeholder="<?php p($l->t( 'Password' )); ?>"
+				placeholder="<?php p($l->t('Password')); ?>"
 				value="<?php p($_['adminpass']); ?>"
 				autocomplete="off" autocapitalize="none" autocorrect="off" required>
-			<label for="adminpass" class="infield"><?php p($l->t( 'Password' )); ?></label>
+			<label for="adminpass" class="infield"><?php p($l->t('Password')); ?></label>
 			<input type="checkbox" id="show" class="hidden-visually" name="show">
-			<label for="show" class="hidden-visually"><?php p($l->t( 'Show password')); ?></label>
+			<label for="show" class="hidden-visually"><?php p($l->t('Show password')); ?></label>
 		</p>
 	</fieldset>
 
-	<?php if(!$_['directoryIsSet'] or !$_['dbIsSet'] or count($_['errors']) > 0): ?>
+	<?php if (!$_['directoryIsSet'] or !$_['dbIsSet'] or count($_['errors']) > 0): ?>
 	<fieldset id="advancedHeader">
-		<legend><a id="showAdvanced" tabindex="0" href="#"><?php p($l->t( 'Storage & database' )); ?><img src="<?php print_unescaped(image_path('', 'actions/caret-white.svg')); ?>" /></a></legend>
+		<legend><a id="showAdvanced" tabindex="0" href="#"><?php p($l->t('Storage & database')); ?><img src="<?php print_unescaped(image_path('', 'actions/caret-white.svg')); ?>" /></a></legend>
 	</fieldset>
 	<?php endif; ?>
 
-	<?php if(!$_['directoryIsSet'] or count($_['errors']) > 0): ?>
+	<?php if (!$_['directoryIsSet'] or count($_['errors']) > 0): ?>
 	<fieldset id="datadirField">
 		<div id="datadirContent">
-			<label for="directory"><?php p($l->t( 'Data folder' )); ?></label>
+			<label for="directory"><?php p($l->t('Data folder')); ?></label>
 			<input type="text" name="directory" id="directory"
 				placeholder="<?php p(OC::$SERVERROOT.'/data'); ?>"
 				value="<?php p($_['directory']); ?>"
@@ -72,19 +72,19 @@ 
 	</fieldset>
 	<?php endif; ?>
 
-	<?php if(!$_['dbIsSet'] or count($_['errors']) > 0): ?>
+	<?php if (!$_['dbIsSet'] or count($_['errors']) > 0): ?>
 	<fieldset id='databaseBackend'>
-		<?php if($_['hasMySQL'] or $_['hasPostgreSQL'] or $_['hasOracle'])
-			$hasOtherDB = true; else $hasOtherDB =false; //other than SQLite ?>
-		<legend><?php p($l->t( 'Configure the database' )); ?></legend>
+		<?php if ($_['hasMySQL'] or $_['hasPostgreSQL'] or $_['hasOracle'])
+			$hasOtherDB = true; else $hasOtherDB = false; //other than SQLite ?>
+		<legend><?php p($l->t('Configure the database')); ?></legend>
 		<div id="selectDbType">
-		<?php foreach($_['databases'] as $type => $label): ?>
-		<?php if(count($_['databases']) === 1): ?>
+		<?php foreach ($_['databases'] as $type => $label): ?>
+		<?php if (count($_['databases']) === 1): ?>
 		<p class="info">
-			<?php p($l->t( 'Only %s is available.', [$label] )); ?>
-			<?php p($l->t( 'Install and activate additional PHP modules to choose other database types.' )); ?><br>
+			<?php p($l->t('Only %s is available.', [$label])); ?>
+			<?php p($l->t('Install and activate additional PHP modules to choose other database types.')); ?><br>
 			<a href="<?php print_unescaped(link_to_docs('admin-source_install')); ?>" target="_blank" rel="noreferrer noopener">
-				<?php p($l->t( 'For more details check out the documentation.' )); ?> ↗</a>
+				<?php p($l->t('For more details check out the documentation.')); ?> ↗</a>
 		</p>
 		<input type="hidden" id="dbtype" name="dbtype" value="<?php p($type) ?>">
 		<?php else: ?>
@@ -96,64 +96,64 @@ 
 		</div>
 	</fieldset>
 
-		<?php if($hasOtherDB): ?>
+		<?php if ($hasOtherDB): ?>
 		<fieldset id='databaseField'>
 		<div id="use_other_db">
 			<p class="grouptop">
-				<label for="dbuser" class="infield"><?php p($l->t( 'Database user' )); ?></label>
+				<label for="dbuser" class="infield"><?php p($l->t('Database user')); ?></label>
 				<input type="text" name="dbuser" id="dbuser"
-					placeholder="<?php p($l->t( 'Database user' )); ?>"
+					placeholder="<?php p($l->t('Database user')); ?>"
 					value="<?php p($_['dbuser']); ?>"
 					autocomplete="off" autocapitalize="none" autocorrect="off">
 			</p>
 			<p class="groupmiddle">
 				<input type="password" name="dbpass" id="dbpass" data-typetoggle="#dbpassword-toggle"
-					placeholder="<?php p($l->t( 'Database password' )); ?>"
+					placeholder="<?php p($l->t('Database password')); ?>"
 					value="<?php p($_['dbpass']); ?>"
 					autocomplete="off" autocapitalize="none" autocorrect="off">
-				<label for="dbpass" class="infield"><?php p($l->t( 'Database password' )); ?></label>
+				<label for="dbpass" class="infield"><?php p($l->t('Database password')); ?></label>
 				<input type="checkbox" id="dbpassword-toggle" class="hidden-visually" name="dbpassword-toggle">
 				<label for="dbpassword-toggle"></label>
 			</p>
 			<p class="groupmiddle">
-				<label for="dbname" class="infield"><?php p($l->t( 'Database name' )); ?></label>
+				<label for="dbname" class="infield"><?php p($l->t('Database name')); ?></label>
 				<input type="text" name="dbname" id="dbname"
-					placeholder="<?php p($l->t( 'Database name' )); ?>"
+					placeholder="<?php p($l->t('Database name')); ?>"
 					value="<?php p($_['dbname']); ?>"
 					autocomplete="off" autocapitalize="none" autocorrect="off"
 					pattern="[0-9a-zA-Z$_-]+">
 			</p>
-			<?php if($_['hasOracle']): ?>
+			<?php if ($_['hasOracle']): ?>
 			<div id="use_oracle_db">
 				<p class="groupmiddle">
-					<label for="dbtablespace" class="infield"><?php p($l->t( 'Database tablespace' )); ?></label>
+					<label for="dbtablespace" class="infield"><?php p($l->t('Database tablespace')); ?></label>
 					<input type="text" name="dbtablespace" id="dbtablespace"
-						placeholder="<?php p($l->t( 'Database tablespace' )); ?>"
+						placeholder="<?php p($l->t('Database tablespace')); ?>"
 						value="<?php p($_['dbtablespace']); ?>"
 						autocomplete="off" autocapitalize="none" autocorrect="off">
 				</p>
 			</div>
 			<?php endif; ?>
 			<p class="groupbottom">
-				<label for="dbhost" class="infield"><?php p($l->t( 'Database host' )); ?></label>
+				<label for="dbhost" class="infield"><?php p($l->t('Database host')); ?></label>
 				<input type="text" name="dbhost" id="dbhost"
-					placeholder="<?php p($l->t( 'Database host' )); ?>"
+					placeholder="<?php p($l->t('Database host')); ?>"
 					value="<?php p($_['dbhost']); ?>"
 					autocomplete="off" autocapitalize="none" autocorrect="off">
 			</p>
 			<p class="info">
-				<?php p($l->t( 'Please specify the port number along with the host name (e.g., localhost:5432).' )); ?>
+				<?php p($l->t('Please specify the port number along with the host name (e.g., localhost:5432).')); ?>
 			</p>
 		</div>
 		</fieldset>
 		<?php endif; ?>
 	<?php endif; ?>
 
-	<?php if(!$_['dbIsSet'] or count($_['errors']) > 0): ?>
+	<?php if (!$_['dbIsSet'] or count($_['errors']) > 0): ?>
 		<fieldset id="sqliteInformation" class="warning">
-			<legend><?php p($l->t('Performance warning'));?></legend>
-			<p><?php p($l->t('You chose SQLite as database.'));?></p>
-			<p><?php p($l->t('SQLite should only be used for minimal and development instances. For production we recommend a different database backend.'));?></p>
+			<legend><?php p($l->t('Performance warning')); ?></legend>
+			<p><?php p($l->t('You chose SQLite as database.')); ?></p>
+			<p><?php p($l->t('SQLite should only be used for minimal and development instances. For production we recommend a different database backend.')); ?></p>
 			<p><?php p($l->t('If you use clients for file syncing, the use of SQLite is highly discouraged.')); ?></p>
 		</fieldset>
 	<?php endif ?>
@@ -162,19 +162,19 @@ 
 		<p class="info">
 			<input type="checkbox" id="install-recommended-apps" name="install-recommended-apps" class="checkbox checkbox--white" checked>
 			<label for="install-recommended-apps">
-				<?php p($l->t( 'Install recommended apps' )); ?>
-				<span><?php p($l->t( 'Calendar, Contacts, Talk, Mail & OnlyOffice' )); ?></span>
+				<?php p($l->t('Install recommended apps')); ?>
+				<span><?php p($l->t('Calendar, Contacts, Talk, Mail & OnlyOffice')); ?></span>
 			</label>
 		</p>
 	</fieldset>
 
 	<div class="icon-loading-dark float-spinner">&nbsp;</div>
 
-	<div class="buttons"><input type="submit" class="primary" value="<?php p($l->t( 'Finish setup' )); ?>" data-finishing="<?php p($l->t( 'Finishing …' )); ?>"></div>
+	<div class="buttons"><input type="submit" class="primary" value="<?php p($l->t('Finish setup')); ?>" data-finishing="<?php p($l->t('Finishing …')); ?>"></div>
 
 	<p class="info">
 		<span class="icon-info-white"></span>
-		<?php p($l->t('Need help?'));?>
-		<a target="_blank" rel="noreferrer noopener" href="<?php p(link_to_docs('admin-install')); ?>"><?php p($l->t('See the documentation'));?> ↗</a>
+		<?php p($l->t('Need help?')); ?>
+		<a target="_blank" rel="noreferrer noopener" href="<?php p(link_to_docs('admin-install')); ?>"><?php p($l->t('See the documentation')); ?> ↗</a>
 	</p>
 </form>

Braces +16 added lines, -6 removed lines

@@ -17,8 +17,11 @@ 
 			<?php if(is_array($err)):?>
 				<?php p($err['error']); ?>
 				<span class='hint'><?php p($err['hint']); ?></span>
-			<?php else: ?>
-				<?php p($err); ?>
+			<?php else {
+    : ?>
+				<?php p($err);
+}
+?>
 			<?php endif; ?>
 		</p>
 		<?php endforeach; ?>
@@ -74,8 +77,12 @@ 
 
 	<?php if(!$_['dbIsSet'] or count($_['errors']) > 0): ?>
 	<fieldset id='databaseBackend'>
-		<?php if($_['hasMySQL'] or $_['hasPostgreSQL'] or $_['hasOracle'])
-			$hasOtherDB = true; else $hasOtherDB =false; //other than SQLite ?>
+		<?php if($_['hasMySQL'] or $_['hasPostgreSQL'] or $_['hasOracle']) {
+			$hasOtherDB = true;
+} else {
+			    $hasOtherDB =false;
+			}
+			//other than SQLite ?>
 		<legend><?php p($l->t( 'Configure the database' )); ?></legend>
 		<div id="selectDbType">
 		<?php foreach($_['databases'] as $type => $label): ?>
@@ -87,11 +94,14 @@ 
 				<?php p($l->t( 'For more details check out the documentation.' )); ?> ↗</a>
 		</p>
 		<input type="hidden" id="dbtype" name="dbtype" value="<?php p($type) ?>">
-		<?php else: ?>
+		<?php else {
+    : ?>
 		<input type="radio" name="dbtype" value="<?php p($type) ?>" id="<?php p($type) ?>"
 			<?php print_unescaped($_['dbtype'] === $type ? 'checked="checked" ' : '') ?>/>
 		<label class="<?php p($type) ?>" for="<?php p($type) ?>"><?php p($label) ?></label>
-		<?php endif; ?>
+		<?php endif;
+}
+?>
 		<?php endforeach; ?>
 		</div>
 	</fieldset>

apps/user_ldap/lib/Mapping/AbstractMapping.php

Indentation +239 added lines, -239 removed lines

@@ -31,293 +31,293 @@
  * @package OCA\User_LDAP\Mapping
  */
 abstract class AbstractMapping {
-	/**
-	 * @var \OCP\IDBConnection $dbc
-	 */
-	protected $dbc;
+    /**
+     * @var \OCP\IDBConnection $dbc
+     */
+    protected $dbc;
 
-	/**
-	 * returns the DB table name which holds the mappings
-	 * @return string
-	 */
-	abstract protected function getTableName();
+    /**
+     * returns the DB table name which holds the mappings
+     * @return string
+     */
+    abstract protected function getTableName();
 
-	/**
-	 * @param \OCP\IDBConnection $dbc
-	 */
-	public function __construct(\OCP\IDBConnection $dbc) {
-		$this->dbc = $dbc;
-	}
+    /**
+     * @param \OCP\IDBConnection $dbc
+     */
+    public function __construct(\OCP\IDBConnection $dbc) {
+        $this->dbc = $dbc;
+    }
 
-	/**
-	 * checks whether a provided string represents an existing table col
-	 * @param string $col
-	 * @return bool
-	 */
-	public function isColNameValid($col) {
-		switch($col) {
-			case 'ldap_dn':
-			case 'owncloud_name':
-			case 'directory_uuid':
-				return true;
-			default:
-				return false;
-		}
-	}
+    /**
+     * checks whether a provided string represents an existing table col
+     * @param string $col
+     * @return bool
+     */
+    public function isColNameValid($col) {
+        switch($col) {
+            case 'ldap_dn':
+            case 'owncloud_name':
+            case 'directory_uuid':
+                return true;
+            default:
+                return false;
+        }
+    }
 
-	/**
-	 * Gets the value of one column based on a provided value of another column
-	 * @param string $fetchCol
-	 * @param string $compareCol
-	 * @param string $search
-	 * @throws \Exception
-	 * @return string|false
-	 */
-	protected function getXbyY($fetchCol, $compareCol, $search) {
-		if(!$this->isColNameValid($fetchCol)) {
-			//this is used internally only, but we don't want to risk
-			//having SQL injection at all.
-			throw new \Exception('Invalid Column Name');
-		}
-		$query = $this->dbc->prepare('
+    /**
+     * Gets the value of one column based on a provided value of another column
+     * @param string $fetchCol
+     * @param string $compareCol
+     * @param string $search
+     * @throws \Exception
+     * @return string|false
+     */
+    protected function getXbyY($fetchCol, $compareCol, $search) {
+        if(!$this->isColNameValid($fetchCol)) {
+            //this is used internally only, but we don't want to risk
+            //having SQL injection at all.
+            throw new \Exception('Invalid Column Name');
+        }
+        $query = $this->dbc->prepare('
 			SELECT `' . $fetchCol . '`
 			FROM `'. $this->getTableName() .'`
 			WHERE `' . $compareCol . '` = ?
 		');
 
-		$res = $query->execute([$search]);
-		if($res !== false) {
-			return $query->fetchColumn();
-		}
+        $res = $query->execute([$search]);
+        if($res !== false) {
+            return $query->fetchColumn();
+        }
 
-		return false;
-	}
+        return false;
+    }
 
-	/**
-	 * Performs a DELETE or UPDATE query to the database.
-	 * @param \Doctrine\DBAL\Driver\Statement $query
-	 * @param array $parameters
-	 * @return bool true if at least one row was modified, false otherwise
-	 */
-	protected function modify($query, $parameters) {
-		$result = $query->execute($parameters);
-		return ($result === true && $query->rowCount() > 0);
-	}
+    /**
+     * Performs a DELETE or UPDATE query to the database.
+     * @param \Doctrine\DBAL\Driver\Statement $query
+     * @param array $parameters
+     * @return bool true if at least one row was modified, false otherwise
+     */
+    protected function modify($query, $parameters) {
+        $result = $query->execute($parameters);
+        return ($result === true && $query->rowCount() > 0);
+    }
 
-	/**
-	 * Gets the LDAP DN based on the provided name.
-	 * Replaces Access::ocname2dn
-	 * @param string $name
-	 * @return string|false
-	 */
-	public function getDNByName($name) {
-		return $this->getXbyY('ldap_dn', 'owncloud_name', $name);
-	}
+    /**
+     * Gets the LDAP DN based on the provided name.
+     * Replaces Access::ocname2dn
+     * @param string $name
+     * @return string|false
+     */
+    public function getDNByName($name) {
+        return $this->getXbyY('ldap_dn', 'owncloud_name', $name);
+    }
 
-	/**
-	 * Updates the DN based on the given UUID
-	 * @param string $fdn
-	 * @param string $uuid
-	 * @return bool
-	 */
-	public function setDNbyUUID($fdn, $uuid) {
-		$query = $this->dbc->prepare('
+    /**
+     * Updates the DN based on the given UUID
+     * @param string $fdn
+     * @param string $uuid
+     * @return bool
+     */
+    public function setDNbyUUID($fdn, $uuid) {
+        $query = $this->dbc->prepare('
 			UPDATE `' . $this->getTableName() . '`
 			SET `ldap_dn` = ?
 			WHERE `directory_uuid` = ?
 		');
 
-		return $this->modify($query, [$fdn, $uuid]);
-	}
+        return $this->modify($query, [$fdn, $uuid]);
+    }
 
-	/**
-	 * Updates the UUID based on the given DN
-	 *
-	 * required by Migration/UUIDFix
-	 *
-	 * @param $uuid
-	 * @param $fdn
-	 * @return bool
-	 */
-	public function setUUIDbyDN($uuid, $fdn) {
-		$query = $this->dbc->prepare('
+    /**
+     * Updates the UUID based on the given DN
+     *
+     * required by Migration/UUIDFix
+     *
+     * @param $uuid
+     * @param $fdn
+     * @return bool
+     */
+    public function setUUIDbyDN($uuid, $fdn) {
+        $query = $this->dbc->prepare('
 			UPDATE `' . $this->getTableName() . '`
 			SET `directory_uuid` = ?
 			WHERE `ldap_dn` = ?
 		');
 
-		return $this->modify($query, [$uuid, $fdn]);
-	}
+        return $this->modify($query, [$uuid, $fdn]);
+    }
 
-	/**
-	 * Gets the name based on the provided LDAP DN.
-	 * @param string $fdn
-	 * @return string|false
-	 */
-	public function getNameByDN($fdn) {
-		return $this->getXbyY('owncloud_name', 'ldap_dn', $fdn);
-	}
+    /**
+     * Gets the name based on the provided LDAP DN.
+     * @param string $fdn
+     * @return string|false
+     */
+    public function getNameByDN($fdn) {
+        return $this->getXbyY('owncloud_name', 'ldap_dn', $fdn);
+    }
 
-	/**
-	 * Searches mapped names by the giving string in the name column
-	 * @param string $search
-	 * @param string $prefixMatch
-	 * @param string $postfixMatch
-	 * @return string[]
-	 */
-	public function getNamesBySearch($search, $prefixMatch = "", $postfixMatch = "") {
-		$query = $this->dbc->prepare('
+    /**
+     * Searches mapped names by the giving string in the name column
+     * @param string $search
+     * @param string $prefixMatch
+     * @param string $postfixMatch
+     * @return string[]
+     */
+    public function getNamesBySearch($search, $prefixMatch = "", $postfixMatch = "") {
+        $query = $this->dbc->prepare('
 			SELECT `owncloud_name`
 			FROM `'. $this->getTableName() .'`
 			WHERE `owncloud_name` LIKE ?
 		');
 
-		$res = $query->execute([$prefixMatch.$this->dbc->escapeLikeParameter($search).$postfixMatch]);
-		$names = [];
-		if($res !== false) {
-			while($row = $query->fetch()) {
-				$names[] = $row['owncloud_name'];
-			}
-		}
-		return $names;
-	}
+        $res = $query->execute([$prefixMatch.$this->dbc->escapeLikeParameter($search).$postfixMatch]);
+        $names = [];
+        if($res !== false) {
+            while($row = $query->fetch()) {
+                $names[] = $row['owncloud_name'];
+            }
+        }
+        return $names;
+    }
 
-	/**
-	 * Gets the name based on the provided LDAP UUID.
-	 * @param string $uuid
-	 * @return string|false
-	 */
-	public function getNameByUUID($uuid) {
-		return $this->getXbyY('owncloud_name', 'directory_uuid', $uuid);
-	}
+    /**
+     * Gets the name based on the provided LDAP UUID.
+     * @param string $uuid
+     * @return string|false
+     */
+    public function getNameByUUID($uuid) {
+        return $this->getXbyY('owncloud_name', 'directory_uuid', $uuid);
+    }
 
-	/**
-	 * Gets the UUID based on the provided LDAP DN
-	 * @param string $dn
-	 * @return false|string
-	 * @throws \Exception
-	 */
-	public function getUUIDByDN($dn) {
-		return $this->getXbyY('directory_uuid', 'ldap_dn', $dn);
-	}
+    /**
+     * Gets the UUID based on the provided LDAP DN
+     * @param string $dn
+     * @return false|string
+     * @throws \Exception
+     */
+    public function getUUIDByDN($dn) {
+        return $this->getXbyY('directory_uuid', 'ldap_dn', $dn);
+    }
 
-	/**
-	 * gets a piece of the mapping list
-	 * @param int $offset
-	 * @param int $limit
-	 * @return array
-	 */
-	public function getList($offset = null, $limit = null) {
-		$query = $this->dbc->prepare('
+    /**
+     * gets a piece of the mapping list
+     * @param int $offset
+     * @param int $limit
+     * @return array
+     */
+    public function getList($offset = null, $limit = null) {
+        $query = $this->dbc->prepare('
 			SELECT
 				`ldap_dn` AS `dn`,
 				`owncloud_name` AS `name`,
 				`directory_uuid` AS `uuid`
 			FROM `' . $this->getTableName() . '`',
-			$limit,
-			$offset
-		);
+            $limit,
+            $offset
+        );
 
-		$query->execute();
-		return $query->fetchAll();
-	}
+        $query->execute();
+        return $query->fetchAll();
+    }
 
-	/**
-	 * attempts to map the given entry
-	 * @param string $fdn fully distinguished name (from LDAP)
-	 * @param string $name
-	 * @param string $uuid a unique identifier as used in LDAP
-	 * @return bool
-	 */
-	public function map($fdn, $name, $uuid) {
-		if(mb_strlen($fdn) > 255) {
-			\OC::$server->getLogger()->error(
-				'Cannot map, because the DN exceeds 255 characters: {dn}',
-				[
-					'app' => 'user_ldap',
-					'dn' => $fdn,
-				]
-			);
-			return false;
-		}
+    /**
+     * attempts to map the given entry
+     * @param string $fdn fully distinguished name (from LDAP)
+     * @param string $name
+     * @param string $uuid a unique identifier as used in LDAP
+     * @return bool
+     */
+    public function map($fdn, $name, $uuid) {
+        if(mb_strlen($fdn) > 255) {
+            \OC::$server->getLogger()->error(
+                'Cannot map, because the DN exceeds 255 characters: {dn}',
+                [
+                    'app' => 'user_ldap',
+                    'dn' => $fdn,
+                ]
+            );
+            return false;
+        }
 
-		$row = [
-			'ldap_dn'        => $fdn,
-			'owncloud_name'  => $name,
-			'directory_uuid' => $uuid
-		];
+        $row = [
+            'ldap_dn'        => $fdn,
+            'owncloud_name'  => $name,
+            'directory_uuid' => $uuid
+        ];
 
-		try {
-			$result = $this->dbc->insertIfNotExist($this->getTableName(), $row);
-			// insertIfNotExist returns values as int
-			return (bool)$result;
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
+        try {
+            $result = $this->dbc->insertIfNotExist($this->getTableName(), $row);
+            // insertIfNotExist returns values as int
+            return (bool)$result;
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
 
-	/**
-	 * removes a mapping based on the owncloud_name of the entry
-	 * @param string $name
-	 * @return bool
-	 */
-	public function unmap($name) {
-		$query = $this->dbc->prepare('
+    /**
+     * removes a mapping based on the owncloud_name of the entry
+     * @param string $name
+     * @return bool
+     */
+    public function unmap($name) {
+        $query = $this->dbc->prepare('
 			DELETE FROM `'. $this->getTableName() .'`
 			WHERE `owncloud_name` = ?');
 
-		return $this->modify($query, [$name]);
-	}
+        return $this->modify($query, [$name]);
+    }
 
-	/**
-	 * Truncate's the mapping table
-	 * @return bool
-	 */
-	public function clear() {
-		$sql = $this->dbc
-			->getDatabasePlatform()
-			->getTruncateTableSQL('`' . $this->getTableName() . '`');
-		return $this->dbc->prepare($sql)->execute();
-	}
+    /**
+     * Truncate's the mapping table
+     * @return bool
+     */
+    public function clear() {
+        $sql = $this->dbc
+            ->getDatabasePlatform()
+            ->getTruncateTableSQL('`' . $this->getTableName() . '`');
+        return $this->dbc->prepare($sql)->execute();
+    }
 
-	/**
-	 * clears the mapping table one by one and executing a callback with
-	 * each row's id (=owncloud_name col)
-	 *
-	 * @param callable $preCallback
-	 * @param callable $postCallback
-	 * @return bool true on success, false when at least one row was not
-	 * deleted
-	 */
-	public function clearCb(callable $preCallback, callable $postCallback): bool {
-		$picker = $this->dbc->getQueryBuilder();
-		$picker->select('owncloud_name')
-			->from($this->getTableName());
-		$cursor = $picker->execute();
-		$result = true;
-		while($id = $cursor->fetchColumn(0)) {
-			$preCallback($id);
-			if($isUnmapped = $this->unmap($id)) {
-				$postCallback($id);
-			}
-			$result &= $isUnmapped;
-		}
-		$cursor->closeCursor();
-		return $result;
-	}
+    /**
+     * clears the mapping table one by one and executing a callback with
+     * each row's id (=owncloud_name col)
+     *
+     * @param callable $preCallback
+     * @param callable $postCallback
+     * @return bool true on success, false when at least one row was not
+     * deleted
+     */
+    public function clearCb(callable $preCallback, callable $postCallback): bool {
+        $picker = $this->dbc->getQueryBuilder();
+        $picker->select('owncloud_name')
+            ->from($this->getTableName());
+        $cursor = $picker->execute();
+        $result = true;
+        while($id = $cursor->fetchColumn(0)) {
+            $preCallback($id);
+            if($isUnmapped = $this->unmap($id)) {
+                $postCallback($id);
+            }
+            $result &= $isUnmapped;
+        }
+        $cursor->closeCursor();
+        return $result;
+    }
 
-	/**
-	 * returns the number of entries in the mappings table
-	 *
-	 * @return int
-	 */
-	public function count() {
-		$qb = $this->dbc->getQueryBuilder();
-		$query = $qb->select($qb->func()->count('ldap_dn'))
-			->from($this->getTableName());
-		$res = $query->execute();
-		$count = $res->fetchColumn();
-		$res->closeCursor();
-		return (int)$count;
-	}
+    /**
+     * returns the number of entries in the mappings table
+     *
+     * @return int
+     */
+    public function count() {
+        $qb = $this->dbc->getQueryBuilder();
+        $query = $qb->select($qb->func()->count('ldap_dn'))
+            ->from($this->getTableName());
+        $res = $query->execute();
+        $count = $res->fetchColumn();
+        $res->closeCursor();
+        return (int)$count;
+    }
 }

apps/files_external/lib/Controller/UserStoragesController.php

Indentation +180 added lines, -180 removed lines

@@ -44,185 +44,185 @@
  * User storages controller
  */
 class UserStoragesController extends StoragesController {
-	/**
-	 * @var IUserSession
-	 */
-	private $userSession;
-
-	/**
-	 * Creates a new user storages controller.
-	 *
-	 * @param string $AppName application name
-	 * @param IRequest $request request object
-	 * @param IL10N $l10n l10n service
-	 * @param UserStoragesService $userStoragesService storage service
-	 * @param IUserSession $userSession
-	 * @param ILogger $logger
-	 */
-	public function __construct(
-		$AppName,
-		IRequest $request,
-		IL10N $l10n,
-		UserStoragesService $userStoragesService,
-		IUserSession $userSession,
-		ILogger $logger
-	) {
-		parent::__construct(
-			$AppName,
-			$request,
-			$l10n,
-			$userStoragesService,
-			$logger
-		);
-		$this->userSession = $userSession;
-	}
-
-	protected function manipulateStorageConfig(StorageConfig $storage) {
-		/** @var AuthMechanism */
-		$authMechanism = $storage->getAuthMechanism();
-		$authMechanism->manipulateStorageConfig($storage, $this->userSession->getUser());
-		/** @var Backend */
-		$backend = $storage->getBackend();
-		$backend->manipulateStorageConfig($storage, $this->userSession->getUser());
-	}
-
-	/**
-	 * Get all storage entries
-	 *
-	 * @NoAdminRequired
-	 *
-	 * @return DataResponse
-	 */
-	public function index() {
-		return parent::index();
-	}
-
-	/**
-	 * Return storage
-	 *
-	 * @NoAdminRequired
-	 *
-	 * {@inheritdoc}
-	 */
-	public function show($id, $testOnly = true) {
-		return parent::show($id, $testOnly);
-	}
-
-	/**
-	 * Create an external storage entry.
-	 *
-	 * @param string $mountPoint storage mount point
-	 * @param string $backend backend identifier
-	 * @param string $authMechanism authentication mechanism identifier
-	 * @param array $backendOptions backend-specific options
-	 * @param array $mountOptions backend-specific mount options
-	 *
-	 * @return DataResponse
-	 *
-	 * @NoAdminRequired
-	 */
-	public function create(
-		$mountPoint,
-		$backend,
-		$authMechanism,
-		$backendOptions,
-		$mountOptions
-	) {
-		$newStorage = $this->createStorage(
-			$mountPoint,
-			$backend,
-			$authMechanism,
-			$backendOptions,
-			$mountOptions
-		);
-		if ($newStorage instanceof DataResponse) {
-			return $newStorage;
-		}
-
-		$response = $this->validate($newStorage);
-		if (!empty($response)) {
-			return $response;
-		}
-
-		$newStorage = $this->service->addStorage($newStorage);
-		$this->updateStorageStatus($newStorage);
-
-		return new DataResponse(
-			$this->formatStorageForUI($newStorage),
-			Http::STATUS_CREATED
-		);
-	}
-
-	/**
-	 * Update an external storage entry.
-	 *
-	 * @param int $id storage id
-	 * @param string $mountPoint storage mount point
-	 * @param string $backend backend identifier
-	 * @param string $authMechanism authentication mechanism identifier
-	 * @param array $backendOptions backend-specific options
-	 * @param array $mountOptions backend-specific mount options
-	 * @param bool $testOnly whether to storage should only test the connection or do more things
-	 *
-	 * @return DataResponse
-	 *
-	 * @NoAdminRequired
-	 */
-	public function update(
-		$id,
-		$mountPoint,
-		$backend,
-		$authMechanism,
-		$backendOptions,
-		$mountOptions,
-		$testOnly = true
-	) {
-		$storage = $this->createStorage(
-			$mountPoint,
-			$backend,
-			$authMechanism,
-			$backendOptions,
-			$mountOptions
-		);
-		if ($storage instanceof DataResponse) {
-			return $storage;
-		}
-		$storage->setId($id);
-
-		$response = $this->validate($storage);
-		if (!empty($response)) {
-			return $response;
-		}
-
-		try {
-			$storage = $this->service->updateStorage($storage);
-		} catch (NotFoundException $e) {
-			return new DataResponse(
-				[
-					'message' => (string)$this->l10n->t('Storage with ID "%d" not found', [$id])
-				],
-				Http::STATUS_NOT_FOUND
-			);
-		}
-
-		$this->updateStorageStatus($storage, $testOnly);
-
-		return new DataResponse(
-			$this->formatStorageForUI($storage),
-			Http::STATUS_OK
-		);
-
-	}
-
-	/**
-	 * Delete storage
-	 *
-	 * @NoAdminRequired
-	 *
-	 * {@inheritdoc}
-	 */
-	public function destroy($id) {
-		return parent::destroy($id);
-	}
+    /**
+     * @var IUserSession
+     */
+    private $userSession;
+
+    /**
+     * Creates a new user storages controller.
+     *
+     * @param string $AppName application name
+     * @param IRequest $request request object
+     * @param IL10N $l10n l10n service
+     * @param UserStoragesService $userStoragesService storage service
+     * @param IUserSession $userSession
+     * @param ILogger $logger
+     */
+    public function __construct(
+        $AppName,
+        IRequest $request,
+        IL10N $l10n,
+        UserStoragesService $userStoragesService,
+        IUserSession $userSession,
+        ILogger $logger
+    ) {
+        parent::__construct(
+            $AppName,
+            $request,
+            $l10n,
+            $userStoragesService,
+            $logger
+        );
+        $this->userSession = $userSession;
+    }
+
+    protected function manipulateStorageConfig(StorageConfig $storage) {
+        /** @var AuthMechanism */
+        $authMechanism = $storage->getAuthMechanism();
+        $authMechanism->manipulateStorageConfig($storage, $this->userSession->getUser());
+        /** @var Backend */
+        $backend = $storage->getBackend();
+        $backend->manipulateStorageConfig($storage, $this->userSession->getUser());
+    }
+
+    /**
+     * Get all storage entries
+     *
+     * @NoAdminRequired
+     *
+     * @return DataResponse
+     */
+    public function index() {
+        return parent::index();
+    }
+
+    /**
+     * Return storage
+     *
+     * @NoAdminRequired
+     *
+     * {@inheritdoc}
+     */
+    public function show($id, $testOnly = true) {
+        return parent::show($id, $testOnly);
+    }
+
+    /**
+     * Create an external storage entry.
+     *
+     * @param string $mountPoint storage mount point
+     * @param string $backend backend identifier
+     * @param string $authMechanism authentication mechanism identifier
+     * @param array $backendOptions backend-specific options
+     * @param array $mountOptions backend-specific mount options
+     *
+     * @return DataResponse
+     *
+     * @NoAdminRequired
+     */
+    public function create(
+        $mountPoint,
+        $backend,
+        $authMechanism,
+        $backendOptions,
+        $mountOptions
+    ) {
+        $newStorage = $this->createStorage(
+            $mountPoint,
+            $backend,
+            $authMechanism,
+            $backendOptions,
+            $mountOptions
+        );
+        if ($newStorage instanceof DataResponse) {
+            return $newStorage;
+        }
+
+        $response = $this->validate($newStorage);
+        if (!empty($response)) {
+            return $response;
+        }
+
+        $newStorage = $this->service->addStorage($newStorage);
+        $this->updateStorageStatus($newStorage);
+
+        return new DataResponse(
+            $this->formatStorageForUI($newStorage),
+            Http::STATUS_CREATED
+        );
+    }
+
+    /**
+     * Update an external storage entry.
+     *
+     * @param int $id storage id
+     * @param string $mountPoint storage mount point
+     * @param string $backend backend identifier
+     * @param string $authMechanism authentication mechanism identifier
+     * @param array $backendOptions backend-specific options
+     * @param array $mountOptions backend-specific mount options
+     * @param bool $testOnly whether to storage should only test the connection or do more things
+     *
+     * @return DataResponse
+     *
+     * @NoAdminRequired
+     */
+    public function update(
+        $id,
+        $mountPoint,
+        $backend,
+        $authMechanism,
+        $backendOptions,
+        $mountOptions,
+        $testOnly = true
+    ) {
+        $storage = $this->createStorage(
+            $mountPoint,
+            $backend,
+            $authMechanism,
+            $backendOptions,
+            $mountOptions
+        );
+        if ($storage instanceof DataResponse) {
+            return $storage;
+        }
+        $storage->setId($id);
+
+        $response = $this->validate($storage);
+        if (!empty($response)) {
+            return $response;
+        }
+
+        try {
+            $storage = $this->service->updateStorage($storage);
+        } catch (NotFoundException $e) {
+            return new DataResponse(
+                [
+                    'message' => (string)$this->l10n->t('Storage with ID "%d" not found', [$id])
+                ],
+                Http::STATUS_NOT_FOUND
+            );
+        }
+
+        $this->updateStorageStatus($storage, $testOnly);
+
+        return new DataResponse(
+            $this->formatStorageForUI($storage),
+            Http::STATUS_OK
+        );
+
+    }
+
+    /**
+     * Delete storage
+     *
+     * @NoAdminRequired
+     *
+     * {@inheritdoc}
+     */
+    public function destroy($id) {
+        return parent::destroy($id);
+    }
 
 }

apps/files_sharing/lib/Controller/DeletedShareAPIController.php

Indentation +166 added lines, -166 removed lines

@@ -48,170 +48,170 @@
 
 class DeletedShareAPIController extends OCSController {
 
-	/** @var ShareManager */
-	private $shareManager;
-
-	/** @var string */
-	private $userId;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var IGroupManager */
-	private $groupManager;
-
-	/** @var IRootFolder */
-	private $rootFolder;
-
-	/** @var IAppManager */
-	private $appManager;
-
-	/** @var IServerContainer */
-	private $serverContainer;
-
-	public function __construct(string $appName,
-								IRequest $request,
-								ShareManager $shareManager,
-								string $UserId,
-								IUserManager $userManager,
-								IGroupManager $groupManager,
-								IRootFolder $rootFolder,
-								IAppManager $appManager,
-								IServerContainer $serverContainer) {
-		parent::__construct($appName, $request);
-
-		$this->shareManager = $shareManager;
-		$this->userId = $UserId;
-		$this->userManager = $userManager;
-		$this->groupManager = $groupManager;
-		$this->rootFolder = $rootFolder;
-		$this->appManager = $appManager;
-		$this->serverContainer = $serverContainer;
-	}
-
-	/**
-	 * @suppress PhanUndeclaredClassMethod
-	 */
-	private function formatShare(IShare $share): array {
-
-		$result = [
-			'id' => $share->getFullId(),
-			'share_type' => $share->getShareType(),
-			'uid_owner' => $share->getSharedBy(),
-			'displayname_owner' => $this->userManager->get($share->getSharedBy())->getDisplayName(),
-			'permissions' => 0,
-			'stime' => $share->getShareTime()->getTimestamp(),
-			'parent' => null,
-			'expiration' => null,
-			'token' => null,
-			'uid_file_owner' => $share->getShareOwner(),
-			'displayname_file_owner' => $this->userManager->get($share->getShareOwner())->getDisplayName(),
-			'path' => $share->getTarget(),
-		];
-		$userFolder = $this->rootFolder->getUserFolder($share->getSharedBy());
-		$nodes = $userFolder->getById($share->getNodeId());
-		if (empty($nodes)) {
-			// fallback to guessing the path
-			$node = $userFolder->get($share->getTarget());
-			if ($node === null || $share->getTarget() === '') {
-				throw new NotFoundException();
-			}
-		} else {
-			$node = $nodes[0];
-		}
-
-		$result['path'] = $userFolder->getRelativePath($node->getPath());
-		if ($node instanceof \OCP\Files\Folder) {
-			$result['item_type'] = 'folder';
-		} else {
-			$result['item_type'] = 'file';
-		}
-		$result['mimetype'] = $node->getMimetype();
-		$result['storage_id'] = $node->getStorage()->getId();
-		$result['storage'] = $node->getStorage()->getCache()->getNumericStorageId();
-		$result['item_source'] = $node->getId();
-		$result['file_source'] = $node->getId();
-		$result['file_parent'] = $node->getParent()->getId();
-		$result['file_target'] = $share->getTarget();
-
-		$expiration = $share->getExpirationDate();
-		if ($expiration !== null) {
-			$result['expiration'] = $expiration->format('Y-m-d 00:00:00');
-		}
-
-		if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) {
-			$group = $this->groupManager->get($share->getSharedWith());
-			$result['share_with'] = $share->getSharedWith();
-			$result['share_with_displayname'] = $group !== null ? $group->getDisplayName() : $share->getSharedWith();
-		} else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_ROOM) {
-			$result['share_with'] = $share->getSharedWith();
-			$result['share_with_displayname'] = '';
-
-			try {
-				$result = array_merge($result, $this->getRoomShareHelper()->formatShare($share));
-			} catch (QueryException $e) {
-			}
-		}
-
-		return $result;
-
-	}
-
-	/**
-	 * @NoAdminRequired
-	 */
-	public function index(): DataResponse {
-		$groupShares = $this->shareManager->getDeletedSharedWith($this->userId, \OCP\Share::SHARE_TYPE_GROUP, null, -1, 0);
-		$roomShares = $this->shareManager->getDeletedSharedWith($this->userId, \OCP\Share::SHARE_TYPE_ROOM, null, -1, 0);
-
-		$shares = array_merge($groupShares, $roomShares);
-
-		$shares = array_map(function (IShare $share) {
-			return $this->formatShare($share);
-		}, $shares);
-
-		return new DataResponse($shares);
-	}
-
-	/**
-	 * @NoAdminRequired
-	 *
-	 * @throws OCSException
-	 */
-	public function undelete(string $id): DataResponse {
-		try {
-			$share = $this->shareManager->getShareById($id, $this->userId);
-		} catch (ShareNotFound $e) {
-			throw new OCSNotFoundException('Share not found');
-		}
-
-		if ($share->getPermissions() !== 0) {
-			throw new OCSNotFoundException('No deleted share found');
-		}
-
-		try {
-			$this->shareManager->restoreShare($share, $this->userId);
-		} catch (GenericShareException $e) {
-			throw new OCSException('Something went wrong');
-		}
-
-		return new DataResponse([]);
-	}
-
-	/**
-	 * Returns the helper of DeletedShareAPIController for room shares.
-	 *
-	 * If the Talk application is not enabled or the helper is not available
-	 * a QueryException is thrown instead.
-	 *
-	 * @return \OCA\Talk\Share\Helper\DeletedShareAPIController
-	 * @throws QueryException
-	 */
-	private function getRoomShareHelper() {
-		if (!$this->appManager->isEnabledForUser('spreed')) {
-			throw new QueryException();
-		}
-
-		return $this->serverContainer->query('\OCA\Talk\Share\Helper\DeletedShareAPIController');
-	}
+    /** @var ShareManager */
+    private $shareManager;
+
+    /** @var string */
+    private $userId;
+
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var IGroupManager */
+    private $groupManager;
+
+    /** @var IRootFolder */
+    private $rootFolder;
+
+    /** @var IAppManager */
+    private $appManager;
+
+    /** @var IServerContainer */
+    private $serverContainer;
+
+    public function __construct(string $appName,
+                                IRequest $request,
+                                ShareManager $shareManager,
+                                string $UserId,
+                                IUserManager $userManager,
+                                IGroupManager $groupManager,
+                                IRootFolder $rootFolder,
+                                IAppManager $appManager,
+                                IServerContainer $serverContainer) {
+        parent::__construct($appName, $request);
+
+        $this->shareManager = $shareManager;
+        $this->userId = $UserId;
+        $this->userManager = $userManager;
+        $this->groupManager = $groupManager;
+        $this->rootFolder = $rootFolder;
+        $this->appManager = $appManager;
+        $this->serverContainer = $serverContainer;
+    }
+
+    /**
+     * @suppress PhanUndeclaredClassMethod
+     */
+    private function formatShare(IShare $share): array {
+
+        $result = [
+            'id' => $share->getFullId(),
+            'share_type' => $share->getShareType(),
+            'uid_owner' => $share->getSharedBy(),
+            'displayname_owner' => $this->userManager->get($share->getSharedBy())->getDisplayName(),
+            'permissions' => 0,
+            'stime' => $share->getShareTime()->getTimestamp(),
+            'parent' => null,
+            'expiration' => null,
+            'token' => null,
+            'uid_file_owner' => $share->getShareOwner(),
+            'displayname_file_owner' => $this->userManager->get($share->getShareOwner())->getDisplayName(),
+            'path' => $share->getTarget(),
+        ];
+        $userFolder = $this->rootFolder->getUserFolder($share->getSharedBy());
+        $nodes = $userFolder->getById($share->getNodeId());
+        if (empty($nodes)) {
+            // fallback to guessing the path
+            $node = $userFolder->get($share->getTarget());
+            if ($node === null || $share->getTarget() === '') {
+                throw new NotFoundException();
+            }
+        } else {
+            $node = $nodes[0];
+        }
+
+        $result['path'] = $userFolder->getRelativePath($node->getPath());
+        if ($node instanceof \OCP\Files\Folder) {
+            $result['item_type'] = 'folder';
+        } else {
+            $result['item_type'] = 'file';
+        }
+        $result['mimetype'] = $node->getMimetype();
+        $result['storage_id'] = $node->getStorage()->getId();
+        $result['storage'] = $node->getStorage()->getCache()->getNumericStorageId();
+        $result['item_source'] = $node->getId();
+        $result['file_source'] = $node->getId();
+        $result['file_parent'] = $node->getParent()->getId();
+        $result['file_target'] = $share->getTarget();
+
+        $expiration = $share->getExpirationDate();
+        if ($expiration !== null) {
+            $result['expiration'] = $expiration->format('Y-m-d 00:00:00');
+        }
+
+        if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) {
+            $group = $this->groupManager->get($share->getSharedWith());
+            $result['share_with'] = $share->getSharedWith();
+            $result['share_with_displayname'] = $group !== null ? $group->getDisplayName() : $share->getSharedWith();
+        } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_ROOM) {
+            $result['share_with'] = $share->getSharedWith();
+            $result['share_with_displayname'] = '';
+
+            try {
+                $result = array_merge($result, $this->getRoomShareHelper()->formatShare($share));
+            } catch (QueryException $e) {
+            }
+        }
+
+        return $result;
+
+    }
+
+    /**
+     * @NoAdminRequired
+     */
+    public function index(): DataResponse {
+        $groupShares = $this->shareManager->getDeletedSharedWith($this->userId, \OCP\Share::SHARE_TYPE_GROUP, null, -1, 0);
+        $roomShares = $this->shareManager->getDeletedSharedWith($this->userId, \OCP\Share::SHARE_TYPE_ROOM, null, -1, 0);
+
+        $shares = array_merge($groupShares, $roomShares);
+
+        $shares = array_map(function (IShare $share) {
+            return $this->formatShare($share);
+        }, $shares);
+
+        return new DataResponse($shares);
+    }
+
+    /**
+     * @NoAdminRequired
+     *
+     * @throws OCSException
+     */
+    public function undelete(string $id): DataResponse {
+        try {
+            $share = $this->shareManager->getShareById($id, $this->userId);
+        } catch (ShareNotFound $e) {
+            throw new OCSNotFoundException('Share not found');
+        }
+
+        if ($share->getPermissions() !== 0) {
+            throw new OCSNotFoundException('No deleted share found');
+        }
+
+        try {
+            $this->shareManager->restoreShare($share, $this->userId);
+        } catch (GenericShareException $e) {
+            throw new OCSException('Something went wrong');
+        }
+
+        return new DataResponse([]);
+    }
+
+    /**
+     * Returns the helper of DeletedShareAPIController for room shares.
+     *
+     * If the Talk application is not enabled or the helper is not available
+     * a QueryException is thrown instead.
+     *
+     * @return \OCA\Talk\Share\Helper\DeletedShareAPIController
+     * @throws QueryException
+     */
+    private function getRoomShareHelper() {
+        if (!$this->appManager->isEnabledForUser('spreed')) {
+            throw new QueryException();
+        }
+
+        return $this->serverContainer->query('\OCA\Talk\Share\Helper\DeletedShareAPIController');
+    }
 }

lib/private/User/Backend.php

Indentation +120 added lines, -120 removed lines

@@ -31,136 +31,136 @@
  * capabilities.
  */
 abstract class Backend implements UserInterface {
-	/**
-	 * error code for functions not provided by the user backend
-	 */
-	const NOT_IMPLEMENTED = -501;
+    /**
+     * error code for functions not provided by the user backend
+     */
+    const NOT_IMPLEMENTED = -501;
 
-	/**
-	 * actions that user backends can define
-	 */
-	const CREATE_USER		= 1;			// 1 << 0
-	const SET_PASSWORD		= 16;			// 1 << 4
-	const CHECK_PASSWORD	= 256;			// 1 << 8
-	const GET_HOME			= 4096;			// 1 << 12
-	const GET_DISPLAYNAME	= 65536;		// 1 << 16
-	const SET_DISPLAYNAME	= 1048576;		// 1 << 20
-	const PROVIDE_AVATAR	= 16777216;		// 1 << 24
-	const COUNT_USERS		= 268435456;	// 1 << 28
+    /**
+     * actions that user backends can define
+     */
+    const CREATE_USER		= 1;			// 1 << 0
+    const SET_PASSWORD		= 16;			// 1 << 4
+    const CHECK_PASSWORD	= 256;			// 1 << 8
+    const GET_HOME			= 4096;			// 1 << 12
+    const GET_DISPLAYNAME	= 65536;		// 1 << 16
+    const SET_DISPLAYNAME	= 1048576;		// 1 << 20
+    const PROVIDE_AVATAR	= 16777216;		// 1 << 24
+    const COUNT_USERS		= 268435456;	// 1 << 28
 
-	protected $possibleActions = [
-		self::CREATE_USER => 'createUser',
-		self::SET_PASSWORD => 'setPassword',
-		self::CHECK_PASSWORD => 'checkPassword',
-		self::GET_HOME => 'getHome',
-		self::GET_DISPLAYNAME => 'getDisplayName',
-		self::SET_DISPLAYNAME => 'setDisplayName',
-		self::PROVIDE_AVATAR => 'canChangeAvatar',
-		self::COUNT_USERS => 'countUsers',
-	];
+    protected $possibleActions = [
+        self::CREATE_USER => 'createUser',
+        self::SET_PASSWORD => 'setPassword',
+        self::CHECK_PASSWORD => 'checkPassword',
+        self::GET_HOME => 'getHome',
+        self::GET_DISPLAYNAME => 'getDisplayName',
+        self::SET_DISPLAYNAME => 'setDisplayName',
+        self::PROVIDE_AVATAR => 'canChangeAvatar',
+        self::COUNT_USERS => 'countUsers',
+    ];
 
-	/**
-	 * Get all supported actions
-	 * @return int bitwise-or'ed actions
-	 *
-	 * Returns the supported actions as int to be
-	 * compared with self::CREATE_USER etc.
-	 */
-	public function getSupportedActions() {
-		$actions = 0;
-		foreach($this->possibleActions as $action => $methodName) {
-			if(method_exists($this, $methodName)) {
-				$actions |= $action;
-			}
-		}
+    /**
+     * Get all supported actions
+     * @return int bitwise-or'ed actions
+     *
+     * Returns the supported actions as int to be
+     * compared with self::CREATE_USER etc.
+     */
+    public function getSupportedActions() {
+        $actions = 0;
+        foreach($this->possibleActions as $action => $methodName) {
+            if(method_exists($this, $methodName)) {
+                $actions |= $action;
+            }
+        }
 
-		return $actions;
-	}
+        return $actions;
+    }
 
-	/**
-	 * Check if backend implements actions
-	 * @param int $actions bitwise-or'ed actions
-	 * @return boolean
-	 *
-	 * Returns the supported actions as int to be
-	 * compared with self::CREATE_USER etc.
-	 */
-	public function implementsActions($actions) {
-		return (bool)($this->getSupportedActions() & $actions);
-	}
+    /**
+     * Check if backend implements actions
+     * @param int $actions bitwise-or'ed actions
+     * @return boolean
+     *
+     * Returns the supported actions as int to be
+     * compared with self::CREATE_USER etc.
+     */
+    public function implementsActions($actions) {
+        return (bool)($this->getSupportedActions() & $actions);
+    }
 
-	/**
-	 * delete a user
-	 * @param string $uid The username of the user to delete
-	 * @return bool
-	 *
-	 * Deletes a user
-	 */
-	public function deleteUser($uid) {
-		return false;
-	}
+    /**
+     * delete a user
+     * @param string $uid The username of the user to delete
+     * @return bool
+     *
+     * Deletes a user
+     */
+    public function deleteUser($uid) {
+        return false;
+    }
 
-	/**
-	 * Get a list of all users
-	 *
-	 * @param string $search
-	 * @param null|int $limit
-	 * @param null|int $offset
-	 * @return string[] an array of all uids
-	 */
-	public function getUsers($search = '', $limit = null, $offset = null) {
-		return [];
-	}
+    /**
+     * Get a list of all users
+     *
+     * @param string $search
+     * @param null|int $limit
+     * @param null|int $offset
+     * @return string[] an array of all uids
+     */
+    public function getUsers($search = '', $limit = null, $offset = null) {
+        return [];
+    }
 
-	/**
-	 * check if a user exists
-	 * @param string $uid the username
-	 * @return boolean
-	 */
-	public function userExists($uid) {
-		return false;
-	}
+    /**
+     * check if a user exists
+     * @param string $uid the username
+     * @return boolean
+     */
+    public function userExists($uid) {
+        return false;
+    }
 
-	/**
-	 * get the user's home directory
-	 * @param string $uid the username
-	 * @return boolean
-	 */
-	public function getHome($uid) {
-		return false;
-	}
+    /**
+     * get the user's home directory
+     * @param string $uid the username
+     * @return boolean
+     */
+    public function getHome($uid) {
+        return false;
+    }
 
-	/**
-	 * get display name of the user
-	 * @param string $uid user ID of the user
-	 * @return string display name
-	 */
-	public function getDisplayName($uid) {
-		return $uid;
-	}
+    /**
+     * get display name of the user
+     * @param string $uid user ID of the user
+     * @return string display name
+     */
+    public function getDisplayName($uid) {
+        return $uid;
+    }
 
-	/**
-	 * Get a list of all display names and user ids.
-	 *
-	 * @param string $search
-	 * @param string|null $limit
-	 * @param string|null $offset
-	 * @return array an array of all displayNames (value) and the corresponding uids (key)
-	 */
-	public function getDisplayNames($search = '', $limit = null, $offset = null) {
-		$displayNames = [];
-		$users = $this->getUsers($search, $limit, $offset);
-		foreach ( $users as $user) {
-			$displayNames[$user] = $user;
-		}
-		return $displayNames;
-	}
+    /**
+     * Get a list of all display names and user ids.
+     *
+     * @param string $search
+     * @param string|null $limit
+     * @param string|null $offset
+     * @return array an array of all displayNames (value) and the corresponding uids (key)
+     */
+    public function getDisplayNames($search = '', $limit = null, $offset = null) {
+        $displayNames = [];
+        $users = $this->getUsers($search, $limit, $offset);
+        foreach ( $users as $user) {
+            $displayNames[$user] = $user;
+        }
+        return $displayNames;
+    }
 
-	/**
-	 * Check if a user list is available or not
-	 * @return boolean if users can be listed or not
-	 */
-	public function hasUserListings() {
-		return false;
-	}
+    /**
+     * Check if a user list is available or not
+     * @return boolean if users can be listed or not
+     */
+    public function hasUserListings() {
+        return false;
+    }
 }

Spacing +12 added lines, -12 removed lines

@@ -39,14 +39,14 @@ 
 	/**
 	 * actions that user backends can define
 	 */
-	const CREATE_USER		= 1;			// 1 << 0
-	const SET_PASSWORD		= 16;			// 1 << 4
-	const CHECK_PASSWORD	= 256;			// 1 << 8
-	const GET_HOME			= 4096;			// 1 << 12
-	const GET_DISPLAYNAME	= 65536;		// 1 << 16
-	const SET_DISPLAYNAME	= 1048576;		// 1 << 20
-	const PROVIDE_AVATAR	= 16777216;		// 1 << 24
-	const COUNT_USERS		= 268435456;	// 1 << 28
+	const CREATE_USER = 1; // 1 << 0
+	const SET_PASSWORD = 16; // 1 << 4
+	const CHECK_PASSWORD = 256; // 1 << 8
+	const GET_HOME = 4096; // 1 << 12
+	const GET_DISPLAYNAME	= 65536; // 1 << 16
+	const SET_DISPLAYNAME	= 1048576; // 1 << 20
+	const PROVIDE_AVATAR = 16777216; // 1 << 24
+	const COUNT_USERS = 268435456; // 1 << 28
 
 	protected $possibleActions = [
 		self::CREATE_USER => 'createUser',
@@ -68,8 +68,8 @@ 
 	 */
 	public function getSupportedActions() {
 		$actions = 0;
-		foreach($this->possibleActions as $action => $methodName) {
-			if(method_exists($this, $methodName)) {
+		foreach ($this->possibleActions as $action => $methodName) {
+			if (method_exists($this, $methodName)) {
 				$actions |= $action;
 			}
 		}
@@ -86,7 +86,7 @@ 
 	 * compared with self::CREATE_USER etc.
 	 */
 	public function implementsActions($actions) {
-		return (bool)($this->getSupportedActions() & $actions);
+		return (bool) ($this->getSupportedActions() & $actions);
 	}
 
 	/**
@@ -150,7 +150,7 @@ 
 	public function getDisplayNames($search = '', $limit = null, $offset = null) {
 		$displayNames = [];
 		$users = $this->getUsers($search, $limit, $offset);
-		foreach ( $users as $user) {
+		foreach ($users as $user) {
 			$displayNames[$user] = $user;
 		}
 		return $displayNames;

lib/private/Session/CryptoSessionData.php

Indentation +173 added lines, -173 removed lines

@@ -40,177 +40,177 @@
  * @package OC\Session
  */
 class CryptoSessionData implements \ArrayAccess, ISession {
-	/** @var ISession */
-	protected $session;
-	/** @var \OCP\Security\ICrypto */
-	protected $crypto;
-	/** @var string */
-	protected $passphrase;
-	/** @var array */
-	protected $sessionValues;
-	/** @var bool */
-	protected $isModified = false;
-	const encryptedSessionName = 'encrypted_session_data';
-
-	/**
-	 * @param ISession $session
-	 * @param ICrypto $crypto
-	 * @param string $passphrase
-	 */
-	public function __construct(ISession $session,
-								ICrypto $crypto,
-								string $passphrase) {
-		$this->crypto = $crypto;
-		$this->session = $session;
-		$this->passphrase = $passphrase;
-		$this->initializeSession();
-	}
-
-	/**
-	 * Close session if class gets destructed
-	 */
-	public function __destruct() {
-		try {
-			$this->close();
-		} catch (SessionNotAvailableException $e){
-			// This exception can occur if session is already closed
-			// So it is safe to ignore it and let the garbage collector to proceed
-		}
-	}
-
-	protected function initializeSession() {
-		$encryptedSessionData = $this->session->get(self::encryptedSessionName) ?: '';
-		try {
-			$this->sessionValues = json_decode(
-				$this->crypto->decrypt($encryptedSessionData, $this->passphrase),
-				true
-			);
-		} catch (\Exception $e) {
-			$this->sessionValues = [];
-		}
-	}
-
-	/**
-	 * Set a value in the session
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 */
-	public function set(string $key, $value) {
-		$this->sessionValues[$key] = $value;
-		$this->isModified = true;
-	}
-
-	/**
-	 * Get a value from the session
-	 *
-	 * @param string $key
-	 * @return string|null Either the value or null
-	 */
-	public function get(string $key) {
-		if(isset($this->sessionValues[$key])) {
-			return $this->sessionValues[$key];
-		}
-
-		return null;
-	}
-
-	/**
-	 * Check if a named key exists in the session
-	 *
-	 * @param string $key
-	 * @return bool
-	 */
-	public function exists(string $key): bool {
-		return isset($this->sessionValues[$key]);
-	}
-
-	/**
-	 * Remove a $key/$value pair from the session
-	 *
-	 * @param string $key
-	 */
-	public function remove(string $key) {
-		$this->isModified = true;
-		unset($this->sessionValues[$key]);
-		$this->session->remove(self::encryptedSessionName);
-	}
-
-	/**
-	 * Reset and recreate the session
-	 */
-	public function clear() {
-		$requesttoken = $this->get('requesttoken');
-		$this->sessionValues = [];
-		if ($requesttoken !== null) {
-			$this->set('requesttoken', $requesttoken);
-		}
-		$this->isModified = true;
-		$this->session->clear();
-	}
-
-	/**
-	 * Wrapper around session_regenerate_id
-	 *
-	 * @param bool $deleteOldSession Whether to delete the old associated session file or not.
-	 * @param bool $updateToken Wheater to update the associated auth token
-	 * @return void
-	 */
-	public function regenerateId(bool $deleteOldSession = true, bool $updateToken = false) {
-		$this->session->regenerateId($deleteOldSession, $updateToken);
-	}
-
-	/**
-	 * Wrapper around session_id
-	 *
-	 * @return string
-	 * @throws SessionNotAvailableException
-	 * @since 9.1.0
-	 */
-	public function getId(): string {
-		return $this->session->getId();
-	}
-
-	/**
-	 * Close the session and release the lock, also writes all changed data in batch
-	 */
-	public function close() {
-		if($this->isModified) {
-			$encryptedValue = $this->crypto->encrypt(json_encode($this->sessionValues), $this->passphrase);
-			$this->session->set(self::encryptedSessionName, $encryptedValue);
-			$this->isModified = false;
-		}
-		$this->session->close();
-	}
-
-	/**
-	 * @param mixed $offset
-	 * @return bool
-	 */
-	public function offsetExists($offset): bool {
-		return $this->exists($offset);
-	}
-
-	/**
-	 * @param mixed $offset
-	 * @return mixed
-	 */
-	public function offsetGet($offset) {
-		return $this->get($offset);
-	}
-
-	/**
-	 * @param mixed $offset
-	 * @param mixed $value
-	 */
-	public function offsetSet($offset, $value) {
-		$this->set($offset, $value);
-	}
-
-	/**
-	 * @param mixed $offset
-	 */
-	public function offsetUnset($offset) {
-		$this->remove($offset);
-	}
+    /** @var ISession */
+    protected $session;
+    /** @var \OCP\Security\ICrypto */
+    protected $crypto;
+    /** @var string */
+    protected $passphrase;
+    /** @var array */
+    protected $sessionValues;
+    /** @var bool */
+    protected $isModified = false;
+    const encryptedSessionName = 'encrypted_session_data';
+
+    /**
+     * @param ISession $session
+     * @param ICrypto $crypto
+     * @param string $passphrase
+     */
+    public function __construct(ISession $session,
+                                ICrypto $crypto,
+                                string $passphrase) {
+        $this->crypto = $crypto;
+        $this->session = $session;
+        $this->passphrase = $passphrase;
+        $this->initializeSession();
+    }
+
+    /**
+     * Close session if class gets destructed
+     */
+    public function __destruct() {
+        try {
+            $this->close();
+        } catch (SessionNotAvailableException $e){
+            // This exception can occur if session is already closed
+            // So it is safe to ignore it and let the garbage collector to proceed
+        }
+    }
+
+    protected function initializeSession() {
+        $encryptedSessionData = $this->session->get(self::encryptedSessionName) ?: '';
+        try {
+            $this->sessionValues = json_decode(
+                $this->crypto->decrypt($encryptedSessionData, $this->passphrase),
+                true
+            );
+        } catch (\Exception $e) {
+            $this->sessionValues = [];
+        }
+    }
+
+    /**
+     * Set a value in the session
+     *
+     * @param string $key
+     * @param mixed $value
+     */
+    public function set(string $key, $value) {
+        $this->sessionValues[$key] = $value;
+        $this->isModified = true;
+    }
+
+    /**
+     * Get a value from the session
+     *
+     * @param string $key
+     * @return string|null Either the value or null
+     */
+    public function get(string $key) {
+        if(isset($this->sessionValues[$key])) {
+            return $this->sessionValues[$key];
+        }
+
+        return null;
+    }
+
+    /**
+     * Check if a named key exists in the session
+     *
+     * @param string $key
+     * @return bool
+     */
+    public function exists(string $key): bool {
+        return isset($this->sessionValues[$key]);
+    }
+
+    /**
+     * Remove a $key/$value pair from the session
+     *
+     * @param string $key
+     */
+    public function remove(string $key) {
+        $this->isModified = true;
+        unset($this->sessionValues[$key]);
+        $this->session->remove(self::encryptedSessionName);
+    }
+
+    /**
+     * Reset and recreate the session
+     */
+    public function clear() {
+        $requesttoken = $this->get('requesttoken');
+        $this->sessionValues = [];
+        if ($requesttoken !== null) {
+            $this->set('requesttoken', $requesttoken);
+        }
+        $this->isModified = true;
+        $this->session->clear();
+    }
+
+    /**
+     * Wrapper around session_regenerate_id
+     *
+     * @param bool $deleteOldSession Whether to delete the old associated session file or not.
+     * @param bool $updateToken Wheater to update the associated auth token
+     * @return void
+     */
+    public function regenerateId(bool $deleteOldSession = true, bool $updateToken = false) {
+        $this->session->regenerateId($deleteOldSession, $updateToken);
+    }
+
+    /**
+     * Wrapper around session_id
+     *
+     * @return string
+     * @throws SessionNotAvailableException
+     * @since 9.1.0
+     */
+    public function getId(): string {
+        return $this->session->getId();
+    }
+
+    /**
+     * Close the session and release the lock, also writes all changed data in batch
+     */
+    public function close() {
+        if($this->isModified) {
+            $encryptedValue = $this->crypto->encrypt(json_encode($this->sessionValues), $this->passphrase);
+            $this->session->set(self::encryptedSessionName, $encryptedValue);
+            $this->isModified = false;
+        }
+        $this->session->close();
+    }
+
+    /**
+     * @param mixed $offset
+     * @return bool
+     */
+    public function offsetExists($offset): bool {
+        return $this->exists($offset);
+    }
+
+    /**
+     * @param mixed $offset
+     * @return mixed
+     */
+    public function offsetGet($offset) {
+        return $this->get($offset);
+    }
+
+    /**
+     * @param mixed $offset
+     * @param mixed $value
+     */
+    public function offsetSet($offset, $value) {
+        $this->set($offset, $value);
+    }
+
+    /**
+     * @param mixed $offset
+     */
+    public function offsetUnset($offset) {
+        $this->remove($offset);
+    }
 }

lib/private/legacy/OC_Helper.php

Indentation +547 added lines, -547 removed lines

@@ -50,551 +50,551 @@
  * Collection of useful functions
  */
 class OC_Helper {
-	private static $templateManager;
-
-	/**
-	 * Make a human file size
-	 * @param int $bytes file size in bytes
-	 * @return string a human readable file size
-	 *
-	 * Makes 2048 to 2 kB.
-	 */
-	public static function humanFileSize($bytes) {
-		if ($bytes < 0) {
-			return "?";
-		}
-		if ($bytes < 1024) {
-			return "$bytes B";
-		}
-		$bytes = round($bytes / 1024, 0);
-		if ($bytes < 1024) {
-			return "$bytes KB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes MB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes GB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes TB";
-		}
-
-		$bytes = round($bytes / 1024, 1);
-		return "$bytes PB";
-	}
-
-	/**
-	 * Make a computer file size
-	 * @param string $str file size in human readable format
-	 * @return float|bool a file size in bytes
-	 *
-	 * Makes 2kB to 2048.
-	 *
-	 * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
-	 */
-	public static function computerFileSize($str) {
-		$str = strtolower($str);
-		if (is_numeric($str)) {
-			return (float)$str;
-		}
-
-		$bytes_array = [
-			'b' => 1,
-			'k' => 1024,
-			'kb' => 1024,
-			'mb' => 1024 * 1024,
-			'm' => 1024 * 1024,
-			'gb' => 1024 * 1024 * 1024,
-			'g' => 1024 * 1024 * 1024,
-			'tb' => 1024 * 1024 * 1024 * 1024,
-			't' => 1024 * 1024 * 1024 * 1024,
-			'pb' => 1024 * 1024 * 1024 * 1024 * 1024,
-			'p' => 1024 * 1024 * 1024 * 1024 * 1024,
-		];
-
-		$bytes = (float)$str;
-
-		if (preg_match('#([kmgtp]?b?)$#si', $str, $matches) && !empty($bytes_array[$matches[1]])) {
-			$bytes *= $bytes_array[$matches[1]];
-		} else {
-			return false;
-		}
-
-		$bytes = round($bytes);
-
-		return $bytes;
-	}
-
-	/**
-	 * Recursive copying of folders
-	 * @param string $src source folder
-	 * @param string $dest target folder
-	 *
-	 */
-	static function copyr($src, $dest) {
-		if (is_dir($src)) {
-			if (!is_dir($dest)) {
-				mkdir($dest);
-			}
-			$files = scandir($src);
-			foreach ($files as $file) {
-				if ($file != "." && $file != "..") {
-					self::copyr("$src/$file", "$dest/$file");
-				}
-			}
-		} elseif (file_exists($src) && !\OC\Files\Filesystem::isFileBlacklisted($src)) {
-			copy($src, $dest);
-		}
-	}
-
-	/**
-	 * Recursive deletion of folders
-	 * @param string $dir path to the folder
-	 * @param bool $deleteSelf if set to false only the content of the folder will be deleted
-	 * @return bool
-	 */
-	static function rmdirr($dir, $deleteSelf = true) {
-		if (is_dir($dir)) {
-			$files = new RecursiveIteratorIterator(
-				new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS),
-				RecursiveIteratorIterator::CHILD_FIRST
-			);
-
-			foreach ($files as $fileInfo) {
-				/** @var SplFileInfo $fileInfo */
-				if ($fileInfo->isLink()) {
-					unlink($fileInfo->getPathname());
-				} else if ($fileInfo->isDir()) {
-					rmdir($fileInfo->getRealPath());
-				} else {
-					unlink($fileInfo->getRealPath());
-				}
-			}
-			if ($deleteSelf) {
-				rmdir($dir);
-			}
-		} elseif (file_exists($dir)) {
-			if ($deleteSelf) {
-				unlink($dir);
-			}
-		}
-		if (!$deleteSelf) {
-			return true;
-		}
-
-		return !file_exists($dir);
-	}
-
-	/**
-	 * @deprecated 18.0.0
-	 * @return \OC\Files\Type\TemplateManager
-	 */
-	static public function getFileTemplateManager() {
-		if (!self::$templateManager) {
-			self::$templateManager = new \OC\Files\Type\TemplateManager();
-		}
-		return self::$templateManager;
-	}
-
-	/**
-	 * detect if a given program is found in the search PATH
-	 *
-	 * @param string $name
-	 * @param bool $path
-	 * @internal param string $program name
-	 * @internal param string $optional search path, defaults to $PATH
-	 * @return bool    true if executable program found in path
-	 */
-	public static function canExecute($name, $path = false) {
-		// path defaults to PATH from environment if not set
-		if ($path === false) {
-			$path = getenv("PATH");
-		}
-		// we look for an executable file of that name
-		$exts = [""];
-		$check_fn = "is_executable";
-		// Default check will be done with $path directories :
-		$dirs = explode(PATH_SEPARATOR, $path);
-		// WARNING : We have to check if open_basedir is enabled :
-		$obd = OC::$server->getIniWrapper()->getString('open_basedir');
-		if ($obd != "none") {
-			$obd_values = explode(PATH_SEPARATOR, $obd);
-			if (count($obd_values) > 0 and $obd_values[0]) {
-				// open_basedir is in effect !
-				// We need to check if the program is in one of these dirs :
-				$dirs = $obd_values;
-			}
-		}
-		foreach ($dirs as $dir) {
-			foreach ($exts as $ext) {
-				if ($check_fn("$dir/$name" . $ext))
-					return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * copy the contents of one stream to another
-	 *
-	 * @param resource $source
-	 * @param resource $target
-	 * @return array the number of bytes copied and result
-	 */
-	public static function streamCopy($source, $target) {
-		if (!$source or !$target) {
-			return [0, false];
-		}
-		$bufSize = 8192;
-		$result = true;
-		$count = 0;
-		while (!feof($source)) {
-			$buf = fread($source, $bufSize);
-			$bytesWritten = fwrite($target, $buf);
-			if ($bytesWritten !== false) {
-				$count += $bytesWritten;
-			}
-			// note: strlen is expensive so only use it when necessary,
-			// on the last block
-			if ($bytesWritten === false
-				|| ($bytesWritten < $bufSize && $bytesWritten < strlen($buf))
-			) {
-				// write error, could be disk full ?
-				$result = false;
-				break;
-			}
-		}
-		return [$count, $result];
-	}
-
-	/**
-	 * Adds a suffix to the name in case the file exists
-	 *
-	 * @param string $path
-	 * @param string $filename
-	 * @return string
-	 */
-	public static function buildNotExistingFileName($path, $filename) {
-		$view = \OC\Files\Filesystem::getView();
-		return self::buildNotExistingFileNameForView($path, $filename, $view);
-	}
-
-	/**
-	 * Adds a suffix to the name in case the file exists
-	 *
-	 * @param string $path
-	 * @param string $filename
-	 * @return string
-	 */
-	public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) {
-		if ($path === '/') {
-			$path = '';
-		}
-		if ($pos = strrpos($filename, '.')) {
-			$name = substr($filename, 0, $pos);
-			$ext = substr($filename, $pos);
-		} else {
-			$name = $filename;
-			$ext = '';
-		}
-
-		$newpath = $path . '/' . $filename;
-		if ($view->file_exists($newpath)) {
-			if (preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) {
-				//Replace the last "(number)" with "(number+1)"
-				$last_match = count($matches[0]) - 1;
-				$counter = $matches[1][$last_match][0] + 1;
-				$offset = $matches[0][$last_match][1];
-				$match_length = strlen($matches[0][$last_match][0]);
-			} else {
-				$counter = 2;
-				$match_length = 0;
-				$offset = false;
-			}
-			do {
-				if ($offset) {
-					//Replace the last "(number)" with "(number+1)"
-					$newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
-				} else {
-					$newname = $name . ' (' . $counter . ')';
-				}
-				$newpath = $path . '/' . $newname . $ext;
-				$counter++;
-			} while ($view->file_exists($newpath));
-		}
-
-		return $newpath;
-	}
-
-	/**
-	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
-	 *
-	 * @param array $input The array to work on
-	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @return array
-	 *
-	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
-	 * based on http://www.php.net/manual/en/function.array-change-key-case.php#107715
-	 *
-	 */
-	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
-		$case = ($case != MB_CASE_UPPER) ? MB_CASE_LOWER : MB_CASE_UPPER;
-		$ret = [];
-		foreach ($input as $k => $v) {
-			$ret[mb_convert_case($k, $case, $encoding)] = $v;
-		}
-		return $ret;
-	}
-
-	/**
-	 * performs a search in a nested array
-	 * @param array $haystack the array to be searched
-	 * @param string $needle the search string
-	 * @param mixed $index optional, only search this key name
-	 * @return mixed the key of the matching field, otherwise false
-	 *
-	 * performs a search in a nested array
-	 *
-	 * taken from http://www.php.net/manual/en/function.array-search.php#97645
-	 */
-	public static function recursiveArraySearch($haystack, $needle, $index = null) {
-		$aIt = new RecursiveArrayIterator($haystack);
-		$it = new RecursiveIteratorIterator($aIt);
-
-		while ($it->valid()) {
-			if (((isset($index) and ($it->key() == $index)) or !isset($index)) and ($it->current() == $needle)) {
-				return $aIt->key();
-			}
-
-			$it->next();
-		}
-
-		return false;
-	}
-
-	/**
-	 * calculates the maximum upload size respecting system settings, free space and user quota
-	 *
-	 * @param string $dir the current folder where the user currently operates
-	 * @param int $freeSpace the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
-	 * @return int number of bytes representing
-	 */
-	public static function maxUploadFilesize($dir, $freeSpace = null) {
-		if (is_null($freeSpace) || $freeSpace < 0){
-			$freeSpace = self::freeSpace($dir);
-		}
-		return min($freeSpace, self::uploadLimit());
-	}
-
-	/**
-	 * Calculate free space left within user quota
-	 *
-	 * @param string $dir the current folder where the user currently operates
-	 * @return int number of bytes representing
-	 */
-	public static function freeSpace($dir) {
-		$freeSpace = \OC\Files\Filesystem::free_space($dir);
-		if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-			$freeSpace = max($freeSpace, 0);
-			return $freeSpace;
-		} else {
-			return (INF > 0)? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
-		}
-	}
-
-	/**
-	 * Calculate PHP upload limit
-	 *
-	 * @return int PHP upload file size limit
-	 */
-	public static function uploadLimit() {
-		$ini = \OC::$server->getIniWrapper();
-		$upload_max_filesize = OCP\Util::computerFileSize($ini->get('upload_max_filesize'));
-		$post_max_size = OCP\Util::computerFileSize($ini->get('post_max_size'));
-		if ((int)$upload_max_filesize === 0 and (int)$post_max_size === 0) {
-			return INF;
-		} elseif ((int)$upload_max_filesize === 0 or (int)$post_max_size === 0) {
-			return max($upload_max_filesize, $post_max_size); //only the non 0 value counts
-		} else {
-			return min($upload_max_filesize, $post_max_size);
-		}
-	}
-
-	/**
-	 * Checks if a function is available
-	 *
-	 * @param string $function_name
-	 * @return bool
-	 */
-	public static function is_function_enabled($function_name) {
-		if (!function_exists($function_name)) {
-			return false;
-		}
-		$ini = \OC::$server->getIniWrapper();
-		$disabled = explode(',', $ini->get('disable_functions') ?: '');
-		$disabled = array_map('trim', $disabled);
-		if (in_array($function_name, $disabled)) {
-			return false;
-		}
-		$disabled = explode(',', $ini->get('suhosin.executor.func.blacklist') ?: '');
-		$disabled = array_map('trim', $disabled);
-		if (in_array($function_name, $disabled)) {
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * Try to find a program
-	 *
-	 * @param string $program
-	 * @return null|string
-	 */
-	public static function findBinaryPath($program) {
-		$memcache = \OC::$server->getMemCacheFactory()->createDistributed('findBinaryPath');
-		if ($memcache->hasKey($program)) {
-			return $memcache->get($program);
-		}
-		$result = null;
-		if (self::is_function_enabled('exec')) {
-			$exeSniffer = new ExecutableFinder();
-			// Returns null if nothing is found
-			$result = $exeSniffer->find($program, null, ['/usr/local/sbin', '/usr/local/bin', '/usr/sbin', '/usr/bin', '/sbin', '/bin', '/opt/bin']);
-		}
-		// store the value for 5 minutes
-		$memcache->set($program, $result, 300);
-		return $result;
-	}
-
-	/**
-	 * Calculate the disc space for the given path
-	 *
-	 * @param string $path
-	 * @param \OCP\Files\FileInfo $rootInfo (optional)
-	 * @return array
-	 * @throws \OCP\Files\NotFoundException
-	 */
-	public static function getStorageInfo($path, $rootInfo = null) {
-		// return storage info without adding mount points
-		$includeExtStorage = \OC::$server->getSystemConfig()->getValue('quota_include_external_storage', false);
-
-		if (!$rootInfo) {
-			$rootInfo = \OC\Files\Filesystem::getFileInfo($path, $includeExtStorage ? 'ext' : false);
-		}
-		if (!$rootInfo instanceof \OCP\Files\FileInfo) {
-			throw new \OCP\Files\NotFoundException();
-		}
-		$used = $rootInfo->getSize();
-		if ($used < 0) {
-			$used = 0;
-		}
-		$quota = \OCP\Files\FileInfo::SPACE_UNLIMITED;
-		$storage = $rootInfo->getStorage();
-		$sourceStorage = $storage;
-		if ($storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) {
-			$includeExtStorage = false;
-			$sourceStorage = $storage->getSourceStorage();
-		}
-		if ($includeExtStorage) {
-			if ($storage->instanceOfStorage('\OC\Files\Storage\Home')
-				|| $storage->instanceOfStorage('\OC\Files\ObjectStore\HomeObjectStoreStorage')
-			) {
-				/** @var \OC\Files\Storage\Home $storage */
-				$user = $storage->getUser();
-			} else {
-				$user = \OC::$server->getUserSession()->getUser();
-			}
-			$quota = OC_Util::getUserQuota($user);
-			if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-				// always get free space / total space from root + mount points
-				return self::getGlobalStorageInfo($quota);
-			}
-		}
-
-		// TODO: need a better way to get total space from storage
-		if ($sourceStorage->instanceOfStorage('\OC\Files\Storage\Wrapper\Quota')) {
-			/** @var \OC\Files\Storage\Wrapper\Quota $storage */
-			$quota = $sourceStorage->getQuota();
-		}
-		$free = $sourceStorage->free_space($rootInfo->getInternalPath());
-		if ($free >= 0) {
-			$total = $free + $used;
-		} else {
-			$total = $free; //either unknown or unlimited
-		}
-		if ($total > 0) {
-			if ($quota > 0 && $total > $quota) {
-				$total = $quota;
-			}
-			// prevent division by zero or error codes (negative values)
-			$relative = round(($used / $total) * 10000) / 100;
-		} else {
-			$relative = 0;
-		}
-
-		$ownerId = $storage->getOwner($path);
-		$ownerDisplayName = '';
-		$owner = \OC::$server->getUserManager()->get($ownerId);
-		if($owner) {
-			$ownerDisplayName = $owner->getDisplayName();
-		}
-
-		return [
-			'free' => $free,
-			'used' => $used,
-			'quota' => $quota,
-			'total' => $total,
-			'relative' => $relative,
-			'owner' => $ownerId,
-			'ownerDisplayName' => $ownerDisplayName,
-		];
-	}
-
-	/**
-	 * Get storage info including all mount points and quota
-	 *
-	 * @param int $quota
-	 * @return array
-	 */
-	private static function getGlobalStorageInfo($quota) {
-		$rootInfo = \OC\Files\Filesystem::getFileInfo('', 'ext');
-		$used = $rootInfo['size'];
-		if ($used < 0) {
-			$used = 0;
-		}
-
-		$total = $quota;
-		$free = $quota - $used;
-
-		if ($total > 0) {
-			if ($quota > 0 && $total > $quota) {
-				$total = $quota;
-			}
-			// prevent division by zero or error codes (negative values)
-			$relative = round(($used / $total) * 10000) / 100;
-		} else {
-			$relative = 0;
-		}
-
-		return [
-			'free' => $free,
-			'used' => $used,
-			'total' => $total,
-			'relative' => $relative,
-			'quota' => $quota
-		];
-	}
-
-	/**
-	 * Returns whether the config file is set manually to read-only
-	 * @return bool
-	 */
-	public static function isReadOnlyConfigEnabled() {
-		return \OC::$server->getConfig()->getSystemValue('config_is_read_only', false);
-	}
+    private static $templateManager;
+
+    /**
+     * Make a human file size
+     * @param int $bytes file size in bytes
+     * @return string a human readable file size
+     *
+     * Makes 2048 to 2 kB.
+     */
+    public static function humanFileSize($bytes) {
+        if ($bytes < 0) {
+            return "?";
+        }
+        if ($bytes < 1024) {
+            return "$bytes B";
+        }
+        $bytes = round($bytes / 1024, 0);
+        if ($bytes < 1024) {
+            return "$bytes KB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes MB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes GB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes TB";
+        }
+
+        $bytes = round($bytes / 1024, 1);
+        return "$bytes PB";
+    }
+
+    /**
+     * Make a computer file size
+     * @param string $str file size in human readable format
+     * @return float|bool a file size in bytes
+     *
+     * Makes 2kB to 2048.
+     *
+     * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
+     */
+    public static function computerFileSize($str) {
+        $str = strtolower($str);
+        if (is_numeric($str)) {
+            return (float)$str;
+        }
+
+        $bytes_array = [
+            'b' => 1,
+            'k' => 1024,
+            'kb' => 1024,
+            'mb' => 1024 * 1024,
+            'm' => 1024 * 1024,
+            'gb' => 1024 * 1024 * 1024,
+            'g' => 1024 * 1024 * 1024,
+            'tb' => 1024 * 1024 * 1024 * 1024,
+            't' => 1024 * 1024 * 1024 * 1024,
+            'pb' => 1024 * 1024 * 1024 * 1024 * 1024,
+            'p' => 1024 * 1024 * 1024 * 1024 * 1024,
+        ];
+
+        $bytes = (float)$str;
+
+        if (preg_match('#([kmgtp]?b?)$#si', $str, $matches) && !empty($bytes_array[$matches[1]])) {
+            $bytes *= $bytes_array[$matches[1]];
+        } else {
+            return false;
+        }
+
+        $bytes = round($bytes);
+
+        return $bytes;
+    }
+
+    /**
+     * Recursive copying of folders
+     * @param string $src source folder
+     * @param string $dest target folder
+     *
+     */
+    static function copyr($src, $dest) {
+        if (is_dir($src)) {
+            if (!is_dir($dest)) {
+                mkdir($dest);
+            }
+            $files = scandir($src);
+            foreach ($files as $file) {
+                if ($file != "." && $file != "..") {
+                    self::copyr("$src/$file", "$dest/$file");
+                }
+            }
+        } elseif (file_exists($src) && !\OC\Files\Filesystem::isFileBlacklisted($src)) {
+            copy($src, $dest);
+        }
+    }
+
+    /**
+     * Recursive deletion of folders
+     * @param string $dir path to the folder
+     * @param bool $deleteSelf if set to false only the content of the folder will be deleted
+     * @return bool
+     */
+    static function rmdirr($dir, $deleteSelf = true) {
+        if (is_dir($dir)) {
+            $files = new RecursiveIteratorIterator(
+                new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS),
+                RecursiveIteratorIterator::CHILD_FIRST
+            );
+
+            foreach ($files as $fileInfo) {
+                /** @var SplFileInfo $fileInfo */
+                if ($fileInfo->isLink()) {
+                    unlink($fileInfo->getPathname());
+                } else if ($fileInfo->isDir()) {
+                    rmdir($fileInfo->getRealPath());
+                } else {
+                    unlink($fileInfo->getRealPath());
+                }
+            }
+            if ($deleteSelf) {
+                rmdir($dir);
+            }
+        } elseif (file_exists($dir)) {
+            if ($deleteSelf) {
+                unlink($dir);
+            }
+        }
+        if (!$deleteSelf) {
+            return true;
+        }
+
+        return !file_exists($dir);
+    }
+
+    /**
+     * @deprecated 18.0.0
+     * @return \OC\Files\Type\TemplateManager
+     */
+    static public function getFileTemplateManager() {
+        if (!self::$templateManager) {
+            self::$templateManager = new \OC\Files\Type\TemplateManager();
+        }
+        return self::$templateManager;
+    }
+
+    /**
+     * detect if a given program is found in the search PATH
+     *
+     * @param string $name
+     * @param bool $path
+     * @internal param string $program name
+     * @internal param string $optional search path, defaults to $PATH
+     * @return bool    true if executable program found in path
+     */
+    public static function canExecute($name, $path = false) {
+        // path defaults to PATH from environment if not set
+        if ($path === false) {
+            $path = getenv("PATH");
+        }
+        // we look for an executable file of that name
+        $exts = [""];
+        $check_fn = "is_executable";
+        // Default check will be done with $path directories :
+        $dirs = explode(PATH_SEPARATOR, $path);
+        // WARNING : We have to check if open_basedir is enabled :
+        $obd = OC::$server->getIniWrapper()->getString('open_basedir');
+        if ($obd != "none") {
+            $obd_values = explode(PATH_SEPARATOR, $obd);
+            if (count($obd_values) > 0 and $obd_values[0]) {
+                // open_basedir is in effect !
+                // We need to check if the program is in one of these dirs :
+                $dirs = $obd_values;
+            }
+        }
+        foreach ($dirs as $dir) {
+            foreach ($exts as $ext) {
+                if ($check_fn("$dir/$name" . $ext))
+                    return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * copy the contents of one stream to another
+     *
+     * @param resource $source
+     * @param resource $target
+     * @return array the number of bytes copied and result
+     */
+    public static function streamCopy($source, $target) {
+        if (!$source or !$target) {
+            return [0, false];
+        }
+        $bufSize = 8192;
+        $result = true;
+        $count = 0;
+        while (!feof($source)) {
+            $buf = fread($source, $bufSize);
+            $bytesWritten = fwrite($target, $buf);
+            if ($bytesWritten !== false) {
+                $count += $bytesWritten;
+            }
+            // note: strlen is expensive so only use it when necessary,
+            // on the last block
+            if ($bytesWritten === false
+                || ($bytesWritten < $bufSize && $bytesWritten < strlen($buf))
+            ) {
+                // write error, could be disk full ?
+                $result = false;
+                break;
+            }
+        }
+        return [$count, $result];
+    }
+
+    /**
+     * Adds a suffix to the name in case the file exists
+     *
+     * @param string $path
+     * @param string $filename
+     * @return string
+     */
+    public static function buildNotExistingFileName($path, $filename) {
+        $view = \OC\Files\Filesystem::getView();
+        return self::buildNotExistingFileNameForView($path, $filename, $view);
+    }
+
+    /**
+     * Adds a suffix to the name in case the file exists
+     *
+     * @param string $path
+     * @param string $filename
+     * @return string
+     */
+    public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) {
+        if ($path === '/') {
+            $path = '';
+        }
+        if ($pos = strrpos($filename, '.')) {
+            $name = substr($filename, 0, $pos);
+            $ext = substr($filename, $pos);
+        } else {
+            $name = $filename;
+            $ext = '';
+        }
+
+        $newpath = $path . '/' . $filename;
+        if ($view->file_exists($newpath)) {
+            if (preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) {
+                //Replace the last "(number)" with "(number+1)"
+                $last_match = count($matches[0]) - 1;
+                $counter = $matches[1][$last_match][0] + 1;
+                $offset = $matches[0][$last_match][1];
+                $match_length = strlen($matches[0][$last_match][0]);
+            } else {
+                $counter = 2;
+                $match_length = 0;
+                $offset = false;
+            }
+            do {
+                if ($offset) {
+                    //Replace the last "(number)" with "(number+1)"
+                    $newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
+                } else {
+                    $newname = $name . ' (' . $counter . ')';
+                }
+                $newpath = $path . '/' . $newname . $ext;
+                $counter++;
+            } while ($view->file_exists($newpath));
+        }
+
+        return $newpath;
+    }
+
+    /**
+     * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+     *
+     * @param array $input The array to work on
+     * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+     * @return array
+     *
+     * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+     * based on http://www.php.net/manual/en/function.array-change-key-case.php#107715
+     *
+     */
+    public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
+        $case = ($case != MB_CASE_UPPER) ? MB_CASE_LOWER : MB_CASE_UPPER;
+        $ret = [];
+        foreach ($input as $k => $v) {
+            $ret[mb_convert_case($k, $case, $encoding)] = $v;
+        }
+        return $ret;
+    }
+
+    /**
+     * performs a search in a nested array
+     * @param array $haystack the array to be searched
+     * @param string $needle the search string
+     * @param mixed $index optional, only search this key name
+     * @return mixed the key of the matching field, otherwise false
+     *
+     * performs a search in a nested array
+     *
+     * taken from http://www.php.net/manual/en/function.array-search.php#97645
+     */
+    public static function recursiveArraySearch($haystack, $needle, $index = null) {
+        $aIt = new RecursiveArrayIterator($haystack);
+        $it = new RecursiveIteratorIterator($aIt);
+
+        while ($it->valid()) {
+            if (((isset($index) and ($it->key() == $index)) or !isset($index)) and ($it->current() == $needle)) {
+                return $aIt->key();
+            }
+
+            $it->next();
+        }
+
+        return false;
+    }
+
+    /**
+     * calculates the maximum upload size respecting system settings, free space and user quota
+     *
+     * @param string $dir the current folder where the user currently operates
+     * @param int $freeSpace the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
+     * @return int number of bytes representing
+     */
+    public static function maxUploadFilesize($dir, $freeSpace = null) {
+        if (is_null($freeSpace) || $freeSpace < 0){
+            $freeSpace = self::freeSpace($dir);
+        }
+        return min($freeSpace, self::uploadLimit());
+    }
+
+    /**
+     * Calculate free space left within user quota
+     *
+     * @param string $dir the current folder where the user currently operates
+     * @return int number of bytes representing
+     */
+    public static function freeSpace($dir) {
+        $freeSpace = \OC\Files\Filesystem::free_space($dir);
+        if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+            $freeSpace = max($freeSpace, 0);
+            return $freeSpace;
+        } else {
+            return (INF > 0)? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
+        }
+    }
+
+    /**
+     * Calculate PHP upload limit
+     *
+     * @return int PHP upload file size limit
+     */
+    public static function uploadLimit() {
+        $ini = \OC::$server->getIniWrapper();
+        $upload_max_filesize = OCP\Util::computerFileSize($ini->get('upload_max_filesize'));
+        $post_max_size = OCP\Util::computerFileSize($ini->get('post_max_size'));
+        if ((int)$upload_max_filesize === 0 and (int)$post_max_size === 0) {
+            return INF;
+        } elseif ((int)$upload_max_filesize === 0 or (int)$post_max_size === 0) {
+            return max($upload_max_filesize, $post_max_size); //only the non 0 value counts
+        } else {
+            return min($upload_max_filesize, $post_max_size);
+        }
+    }
+
+    /**
+     * Checks if a function is available
+     *
+     * @param string $function_name
+     * @return bool
+     */
+    public static function is_function_enabled($function_name) {
+        if (!function_exists($function_name)) {
+            return false;
+        }
+        $ini = \OC::$server->getIniWrapper();
+        $disabled = explode(',', $ini->get('disable_functions') ?: '');
+        $disabled = array_map('trim', $disabled);
+        if (in_array($function_name, $disabled)) {
+            return false;
+        }
+        $disabled = explode(',', $ini->get('suhosin.executor.func.blacklist') ?: '');
+        $disabled = array_map('trim', $disabled);
+        if (in_array($function_name, $disabled)) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Try to find a program
+     *
+     * @param string $program
+     * @return null|string
+     */
+    public static function findBinaryPath($program) {
+        $memcache = \OC::$server->getMemCacheFactory()->createDistributed('findBinaryPath');
+        if ($memcache->hasKey($program)) {
+            return $memcache->get($program);
+        }
+        $result = null;
+        if (self::is_function_enabled('exec')) {
+            $exeSniffer = new ExecutableFinder();
+            // Returns null if nothing is found
+            $result = $exeSniffer->find($program, null, ['/usr/local/sbin', '/usr/local/bin', '/usr/sbin', '/usr/bin', '/sbin', '/bin', '/opt/bin']);
+        }
+        // store the value for 5 minutes
+        $memcache->set($program, $result, 300);
+        return $result;
+    }
+
+    /**
+     * Calculate the disc space for the given path
+     *
+     * @param string $path
+     * @param \OCP\Files\FileInfo $rootInfo (optional)
+     * @return array
+     * @throws \OCP\Files\NotFoundException
+     */
+    public static function getStorageInfo($path, $rootInfo = null) {
+        // return storage info without adding mount points
+        $includeExtStorage = \OC::$server->getSystemConfig()->getValue('quota_include_external_storage', false);
+
+        if (!$rootInfo) {
+            $rootInfo = \OC\Files\Filesystem::getFileInfo($path, $includeExtStorage ? 'ext' : false);
+        }
+        if (!$rootInfo instanceof \OCP\Files\FileInfo) {
+            throw new \OCP\Files\NotFoundException();
+        }
+        $used = $rootInfo->getSize();
+        if ($used < 0) {
+            $used = 0;
+        }
+        $quota = \OCP\Files\FileInfo::SPACE_UNLIMITED;
+        $storage = $rootInfo->getStorage();
+        $sourceStorage = $storage;
+        if ($storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) {
+            $includeExtStorage = false;
+            $sourceStorage = $storage->getSourceStorage();
+        }
+        if ($includeExtStorage) {
+            if ($storage->instanceOfStorage('\OC\Files\Storage\Home')
+                || $storage->instanceOfStorage('\OC\Files\ObjectStore\HomeObjectStoreStorage')
+            ) {
+                /** @var \OC\Files\Storage\Home $storage */
+                $user = $storage->getUser();
+            } else {
+                $user = \OC::$server->getUserSession()->getUser();
+            }
+            $quota = OC_Util::getUserQuota($user);
+            if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+                // always get free space / total space from root + mount points
+                return self::getGlobalStorageInfo($quota);
+            }
+        }
+
+        // TODO: need a better way to get total space from storage
+        if ($sourceStorage->instanceOfStorage('\OC\Files\Storage\Wrapper\Quota')) {
+            /** @var \OC\Files\Storage\Wrapper\Quota $storage */
+            $quota = $sourceStorage->getQuota();
+        }
+        $free = $sourceStorage->free_space($rootInfo->getInternalPath());
+        if ($free >= 0) {
+            $total = $free + $used;
+        } else {
+            $total = $free; //either unknown or unlimited
+        }
+        if ($total > 0) {
+            if ($quota > 0 && $total > $quota) {
+                $total = $quota;
+            }
+            // prevent division by zero or error codes (negative values)
+            $relative = round(($used / $total) * 10000) / 100;
+        } else {
+            $relative = 0;
+        }
+
+        $ownerId = $storage->getOwner($path);
+        $ownerDisplayName = '';
+        $owner = \OC::$server->getUserManager()->get($ownerId);
+        if($owner) {
+            $ownerDisplayName = $owner->getDisplayName();
+        }
+
+        return [
+            'free' => $free,
+            'used' => $used,
+            'quota' => $quota,
+            'total' => $total,
+            'relative' => $relative,
+            'owner' => $ownerId,
+            'ownerDisplayName' => $ownerDisplayName,
+        ];
+    }
+
+    /**
+     * Get storage info including all mount points and quota
+     *
+     * @param int $quota
+     * @return array
+     */
+    private static function getGlobalStorageInfo($quota) {
+        $rootInfo = \OC\Files\Filesystem::getFileInfo('', 'ext');
+        $used = $rootInfo['size'];
+        if ($used < 0) {
+            $used = 0;
+        }
+
+        $total = $quota;
+        $free = $quota - $used;
+
+        if ($total > 0) {
+            if ($quota > 0 && $total > $quota) {
+                $total = $quota;
+            }
+            // prevent division by zero or error codes (negative values)
+            $relative = round(($used / $total) * 10000) / 100;
+        } else {
+            $relative = 0;
+        }
+
+        return [
+            'free' => $free,
+            'used' => $used,
+            'total' => $total,
+            'relative' => $relative,
+            'quota' => $quota
+        ];
+    }
+
+    /**
+     * Returns whether the config file is set manually to read-only
+     * @return bool
+     */
+    public static function isReadOnlyConfigEnabled() {
+        return \OC::$server->getConfig()->getSystemValue('config_is_read_only', false);
+    }
 }

lib/private/legacy/OC_User.php

Indentation +350 added lines, -350 removed lines

@@ -58,354 +58,354 @@
  */
 class OC_User {
 
-	private static $_usedBackends = [];
-
-	private static $_setupedBackends = [];
-
-	// bool, stores if a user want to access a resource anonymously, e.g if they open a public link
-	private static $incognitoMode = false;
-
-	/**
-	 * Adds the backend to the list of used backends
-	 *
-	 * @param string|\OCP\UserInterface $backend default: database The backend to use for user management
-	 * @return bool
-	 *
-	 * Set the User Authentication Module
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function useBackend($backend = 'database') {
-		if ($backend instanceof \OCP\UserInterface) {
-			self::$_usedBackends[get_class($backend)] = $backend;
-			\OC::$server->getUserManager()->registerBackend($backend);
-		} else {
-			// You'll never know what happens
-			if (null === $backend or !is_string($backend)) {
-				$backend = 'database';
-			}
-
-			// Load backend
-			switch ($backend) {
-				case 'database':
-				case 'mysql':
-				case 'sqlite':
-					\OCP\Util::writeLog('core', 'Adding user backend ' . $backend . '.', ILogger::DEBUG);
-					self::$_usedBackends[$backend] = new \OC\User\Database();
-					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
-					break;
-				case 'dummy':
-					self::$_usedBackends[$backend] = new \Test\Util\User\Dummy();
-					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
-					break;
-				default:
-					\OCP\Util::writeLog('core', 'Adding default user backend ' . $backend . '.', ILogger::DEBUG);
-					$className = 'OC_USER_' . strtoupper($backend);
-					self::$_usedBackends[$backend] = new $className();
-					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
-					break;
-			}
-		}
-		return true;
-	}
-
-	/**
-	 * remove all used backends
-	 */
-	public static function clearBackends() {
-		self::$_usedBackends = [];
-		\OC::$server->getUserManager()->clearBackends();
-	}
-
-	/**
-	 * setup the configured backends in config.php
-	 * @suppress PhanDeprecatedFunction
-	 */
-	public static function setupBackends() {
-		OC_App::loadApps(['prelogin']);
-		$backends = \OC::$server->getSystemConfig()->getValue('user_backends', []);
-		if (isset($backends['default']) && !$backends['default']) {
-			// clear default backends
-			self::clearBackends();
-		}
-		foreach ($backends as $i => $config) {
-			if (!is_array($config)) {
-				continue;
-			}
-			$class = $config['class'];
-			$arguments = $config['arguments'];
-			if (class_exists($class)) {
-				if (array_search($i, self::$_setupedBackends) === false) {
-					// make a reflection object
-					$reflectionObj = new ReflectionClass($class);
-
-					// use Reflection to create a new instance, using the $args
-					$backend = $reflectionObj->newInstanceArgs($arguments);
-					self::useBackend($backend);
-					self::$_setupedBackends[] = $i;
-				} else {
-					\OCP\Util::writeLog('core', 'User backend ' . $class . ' already initialized.', ILogger::DEBUG);
-				}
-			} else {
-				\OCP\Util::writeLog('core', 'User backend ' . $class . ' not found.', ILogger::ERROR);
-			}
-		}
-	}
-
-	/**
-	 * Try to login a user, assuming authentication
-	 * has already happened (e.g. via Single Sign On).
-	 *
-	 * Log in a user and regenerate a new session.
-	 *
-	 * @param \OCP\Authentication\IApacheBackend $backend
-	 * @return bool
-	 */
-	public static function loginWithApache(\OCP\Authentication\IApacheBackend $backend) {
-
-		$uid = $backend->getCurrentUserId();
-		$run = true;
-		OC_Hook::emit("OC_User", "pre_login", ["run" => &$run, "uid" => $uid, 'backend' => $backend]);
-
-		if ($uid) {
-			if (self::getUser() !== $uid) {
-				self::setUserId($uid);
-				$userSession = \OC::$server->getUserSession();
-				$userSession->setLoginName($uid);
-				$request = OC::$server->getRequest();
-				$userSession->createSessionToken($request, $uid, $uid);
-				// setup the filesystem
-				OC_Util::setupFS($uid);
-				// first call the post_login hooks, the login-process needs to be
-				// completed before we can safely create the users folder.
-				// For example encryption needs to initialize the users keys first
-				// before we can create the user folder with the skeleton files
-				OC_Hook::emit(
-					'OC_User',
-					'post_login',
-					[
-						'uid' => $uid,
-						'password' => '',
-						'isTokenLogin' => false,
-					]
-				);
-				//trigger creation of user home and /files folder
-				\OC::$server->getUserFolder($uid);
-			}
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * Verify with Apache whether user is authenticated.
-	 *
-	 * @return boolean|null
-	 *          true: authenticated
-	 *          false: not authenticated
-	 *          null: not handled / no backend available
-	 */
-	public static function handleApacheAuth() {
-		$backend = self::findFirstActiveUsedBackend();
-		if ($backend) {
-			OC_App::loadApps();
-
-			//setup extra user backends
-			self::setupBackends();
-			\OC::$server->getUserSession()->unsetMagicInCookie();
-
-			return self::loginWithApache($backend);
-		}
-
-		return null;
-	}
-
-
-	/**
-	 * Sets user id for session and triggers emit
-	 *
-	 * @param string $uid
-	 */
-	public static function setUserId($uid) {
-		$userSession = \OC::$server->getUserSession();
-		$userManager = \OC::$server->getUserManager();
-		if ($user = $userManager->get($uid)) {
-			$userSession->setUser($user);
-		} else {
-			\OC::$server->getSession()->set('user_id', $uid);
-		}
-	}
-
-	/**
-	 * Check if the user is logged in, considers also the HTTP basic credentials
-	 *
-	 * @deprecated use \OC::$server->getUserSession()->isLoggedIn()
-	 * @return bool
-	 */
-	public static function isLoggedIn() {
-		return \OC::$server->getUserSession()->isLoggedIn();
-	}
-
-	/**
-	 * set incognito mode, e.g. if a user wants to open a public link
-	 *
-	 * @param bool $status
-	 */
-	public static function setIncognitoMode($status) {
-		self::$incognitoMode = $status;
-	}
-
-	/**
-	 * get incognito mode status
-	 *
-	 * @return bool
-	 */
-	public static function isIncognitoMode() {
-		return self::$incognitoMode;
-	}
-
-	/**
-	 * Returns the current logout URL valid for the currently logged-in user
-	 *
-	 * @param \OCP\IURLGenerator $urlGenerator
-	 * @return string
-	 */
-	public static function getLogoutUrl(\OCP\IURLGenerator $urlGenerator) {
-		$backend = self::findFirstActiveUsedBackend();
-		if ($backend) {
-			return $backend->getLogoutUrl();
-		}
-
-		$logoutUrl = $urlGenerator->linkToRoute('core.login.logout');
-		$logoutUrl .= '?requesttoken=' . urlencode(\OCP\Util::callRegister());
-
-		return $logoutUrl;
-	}
-
-	/**
-	 * Check if the user is an admin user
-	 *
-	 * @param string $uid uid of the admin
-	 * @return bool
-	 */
-	public static function isAdminUser($uid) {
-		$group = \OC::$server->getGroupManager()->get('admin');
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($group && $user && $group->inGroup($user) && self::$incognitoMode === false) {
-			return true;
-		}
-		return false;
-	}
-
-
-	/**
-	 * get the user id of the user currently logged in.
-	 *
-	 * @return string|bool uid or false
-	 */
-	public static function getUser() {
-		$uid = \OC::$server->getSession() ? \OC::$server->getSession()->get('user_id') : null;
-		if (!is_null($uid) && self::$incognitoMode === false) {
-			return $uid;
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * get the display name of the user currently logged in.
-	 *
-	 * @param string $uid
-	 * @return string|bool uid or false
-	 * @deprecated 8.1.0 fetch \OCP\IUser (has getDisplayName()) by using method
-	 *                   get() of \OCP\IUserManager - \OC::$server->getUserManager()
-	 */
-	public static function getDisplayName($uid = null) {
-		if ($uid) {
-			$user = \OC::$server->getUserManager()->get($uid);
-			if ($user) {
-				return $user->getDisplayName();
-			} else {
-				return $uid;
-			}
-		} else {
-			$user = \OC::$server->getUserSession()->getUser();
-			if ($user) {
-				return $user->getDisplayName();
-			} else {
-				return false;
-			}
-		}
-	}
-
-	/**
-	 * Set password
-	 *
-	 * @param string $uid The username
-	 * @param string $password The new password
-	 * @param string $recoveryPassword for the encryption app to reset encryption keys
-	 * @return bool
-	 *
-	 * Change the password of a user
-	 */
-	public static function setPassword($uid, $password, $recoveryPassword = null) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->setPassword($password, $recoveryPassword);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * @param string $uid The username
-	 * @return string
-	 *
-	 * returns the path to the users home directory
-	 * @deprecated Use \OC::$server->getUserManager->getHome()
-	 */
-	public static function getHome($uid) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->getHome();
-		} else {
-			return \OC::$server->getSystemConfig()->getValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $uid;
-		}
-	}
-
-	/**
-	 * Get a list of all users display name
-	 *
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array associative array with all display names (value) and corresponding uids (key)
-	 *
-	 * Get a list of all display names and user ids.
-	 * @deprecated Use \OC::$server->getUserManager->searchDisplayName($search, $limit, $offset) instead.
-	 */
-	public static function getDisplayNames($search = '', $limit = null, $offset = null) {
-		$displayNames = [];
-		$users = \OC::$server->getUserManager()->searchDisplayName($search, $limit, $offset);
-		foreach ($users as $user) {
-			$displayNames[$user->getUID()] = $user->getDisplayName();
-		}
-		return $displayNames;
-	}
-
-	/**
-	 * Returns the first active backend from self::$_usedBackends.
-	 *
-	 * @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend
-	 */
-	private static function findFirstActiveUsedBackend() {
-		foreach (self::$_usedBackends as $backend) {
-			if ($backend instanceof OCP\Authentication\IApacheBackend) {
-				if ($backend->isSessionActive()) {
-					return $backend;
-				}
-			}
-		}
-
-		return null;
-	}
+    private static $_usedBackends = [];
+
+    private static $_setupedBackends = [];
+
+    // bool, stores if a user want to access a resource anonymously, e.g if they open a public link
+    private static $incognitoMode = false;
+
+    /**
+     * Adds the backend to the list of used backends
+     *
+     * @param string|\OCP\UserInterface $backend default: database The backend to use for user management
+     * @return bool
+     *
+     * Set the User Authentication Module
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function useBackend($backend = 'database') {
+        if ($backend instanceof \OCP\UserInterface) {
+            self::$_usedBackends[get_class($backend)] = $backend;
+            \OC::$server->getUserManager()->registerBackend($backend);
+        } else {
+            // You'll never know what happens
+            if (null === $backend or !is_string($backend)) {
+                $backend = 'database';
+            }
+
+            // Load backend
+            switch ($backend) {
+                case 'database':
+                case 'mysql':
+                case 'sqlite':
+                    \OCP\Util::writeLog('core', 'Adding user backend ' . $backend . '.', ILogger::DEBUG);
+                    self::$_usedBackends[$backend] = new \OC\User\Database();
+                    \OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
+                    break;
+                case 'dummy':
+                    self::$_usedBackends[$backend] = new \Test\Util\User\Dummy();
+                    \OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
+                    break;
+                default:
+                    \OCP\Util::writeLog('core', 'Adding default user backend ' . $backend . '.', ILogger::DEBUG);
+                    $className = 'OC_USER_' . strtoupper($backend);
+                    self::$_usedBackends[$backend] = new $className();
+                    \OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
+                    break;
+            }
+        }
+        return true;
+    }
+
+    /**
+     * remove all used backends
+     */
+    public static function clearBackends() {
+        self::$_usedBackends = [];
+        \OC::$server->getUserManager()->clearBackends();
+    }
+
+    /**
+     * setup the configured backends in config.php
+     * @suppress PhanDeprecatedFunction
+     */
+    public static function setupBackends() {
+        OC_App::loadApps(['prelogin']);
+        $backends = \OC::$server->getSystemConfig()->getValue('user_backends', []);
+        if (isset($backends['default']) && !$backends['default']) {
+            // clear default backends
+            self::clearBackends();
+        }
+        foreach ($backends as $i => $config) {
+            if (!is_array($config)) {
+                continue;
+            }
+            $class = $config['class'];
+            $arguments = $config['arguments'];
+            if (class_exists($class)) {
+                if (array_search($i, self::$_setupedBackends) === false) {
+                    // make a reflection object
+                    $reflectionObj = new ReflectionClass($class);
+
+                    // use Reflection to create a new instance, using the $args
+                    $backend = $reflectionObj->newInstanceArgs($arguments);
+                    self::useBackend($backend);
+                    self::$_setupedBackends[] = $i;
+                } else {
+                    \OCP\Util::writeLog('core', 'User backend ' . $class . ' already initialized.', ILogger::DEBUG);
+                }
+            } else {
+                \OCP\Util::writeLog('core', 'User backend ' . $class . ' not found.', ILogger::ERROR);
+            }
+        }
+    }
+
+    /**
+     * Try to login a user, assuming authentication
+     * has already happened (e.g. via Single Sign On).
+     *
+     * Log in a user and regenerate a new session.
+     *
+     * @param \OCP\Authentication\IApacheBackend $backend
+     * @return bool
+     */
+    public static function loginWithApache(\OCP\Authentication\IApacheBackend $backend) {
+
+        $uid = $backend->getCurrentUserId();
+        $run = true;
+        OC_Hook::emit("OC_User", "pre_login", ["run" => &$run, "uid" => $uid, 'backend' => $backend]);
+
+        if ($uid) {
+            if (self::getUser() !== $uid) {
+                self::setUserId($uid);
+                $userSession = \OC::$server->getUserSession();
+                $userSession->setLoginName($uid);
+                $request = OC::$server->getRequest();
+                $userSession->createSessionToken($request, $uid, $uid);
+                // setup the filesystem
+                OC_Util::setupFS($uid);
+                // first call the post_login hooks, the login-process needs to be
+                // completed before we can safely create the users folder.
+                // For example encryption needs to initialize the users keys first
+                // before we can create the user folder with the skeleton files
+                OC_Hook::emit(
+                    'OC_User',
+                    'post_login',
+                    [
+                        'uid' => $uid,
+                        'password' => '',
+                        'isTokenLogin' => false,
+                    ]
+                );
+                //trigger creation of user home and /files folder
+                \OC::$server->getUserFolder($uid);
+            }
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Verify with Apache whether user is authenticated.
+     *
+     * @return boolean|null
+     *          true: authenticated
+     *          false: not authenticated
+     *          null: not handled / no backend available
+     */
+    public static function handleApacheAuth() {
+        $backend = self::findFirstActiveUsedBackend();
+        if ($backend) {
+            OC_App::loadApps();
+
+            //setup extra user backends
+            self::setupBackends();
+            \OC::$server->getUserSession()->unsetMagicInCookie();
+
+            return self::loginWithApache($backend);
+        }
+
+        return null;
+    }
+
+
+    /**
+     * Sets user id for session and triggers emit
+     *
+     * @param string $uid
+     */
+    public static function setUserId($uid) {
+        $userSession = \OC::$server->getUserSession();
+        $userManager = \OC::$server->getUserManager();
+        if ($user = $userManager->get($uid)) {
+            $userSession->setUser($user);
+        } else {
+            \OC::$server->getSession()->set('user_id', $uid);
+        }
+    }
+
+    /**
+     * Check if the user is logged in, considers also the HTTP basic credentials
+     *
+     * @deprecated use \OC::$server->getUserSession()->isLoggedIn()
+     * @return bool
+     */
+    public static function isLoggedIn() {
+        return \OC::$server->getUserSession()->isLoggedIn();
+    }
+
+    /**
+     * set incognito mode, e.g. if a user wants to open a public link
+     *
+     * @param bool $status
+     */
+    public static function setIncognitoMode($status) {
+        self::$incognitoMode = $status;
+    }
+
+    /**
+     * get incognito mode status
+     *
+     * @return bool
+     */
+    public static function isIncognitoMode() {
+        return self::$incognitoMode;
+    }
+
+    /**
+     * Returns the current logout URL valid for the currently logged-in user
+     *
+     * @param \OCP\IURLGenerator $urlGenerator
+     * @return string
+     */
+    public static function getLogoutUrl(\OCP\IURLGenerator $urlGenerator) {
+        $backend = self::findFirstActiveUsedBackend();
+        if ($backend) {
+            return $backend->getLogoutUrl();
+        }
+
+        $logoutUrl = $urlGenerator->linkToRoute('core.login.logout');
+        $logoutUrl .= '?requesttoken=' . urlencode(\OCP\Util::callRegister());
+
+        return $logoutUrl;
+    }
+
+    /**
+     * Check if the user is an admin user
+     *
+     * @param string $uid uid of the admin
+     * @return bool
+     */
+    public static function isAdminUser($uid) {
+        $group = \OC::$server->getGroupManager()->get('admin');
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($group && $user && $group->inGroup($user) && self::$incognitoMode === false) {
+            return true;
+        }
+        return false;
+    }
+
+
+    /**
+     * get the user id of the user currently logged in.
+     *
+     * @return string|bool uid or false
+     */
+    public static function getUser() {
+        $uid = \OC::$server->getSession() ? \OC::$server->getSession()->get('user_id') : null;
+        if (!is_null($uid) && self::$incognitoMode === false) {
+            return $uid;
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * get the display name of the user currently logged in.
+     *
+     * @param string $uid
+     * @return string|bool uid or false
+     * @deprecated 8.1.0 fetch \OCP\IUser (has getDisplayName()) by using method
+     *                   get() of \OCP\IUserManager - \OC::$server->getUserManager()
+     */
+    public static function getDisplayName($uid = null) {
+        if ($uid) {
+            $user = \OC::$server->getUserManager()->get($uid);
+            if ($user) {
+                return $user->getDisplayName();
+            } else {
+                return $uid;
+            }
+        } else {
+            $user = \OC::$server->getUserSession()->getUser();
+            if ($user) {
+                return $user->getDisplayName();
+            } else {
+                return false;
+            }
+        }
+    }
+
+    /**
+     * Set password
+     *
+     * @param string $uid The username
+     * @param string $password The new password
+     * @param string $recoveryPassword for the encryption app to reset encryption keys
+     * @return bool
+     *
+     * Change the password of a user
+     */
+    public static function setPassword($uid, $password, $recoveryPassword = null) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->setPassword($password, $recoveryPassword);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * @param string $uid The username
+     * @return string
+     *
+     * returns the path to the users home directory
+     * @deprecated Use \OC::$server->getUserManager->getHome()
+     */
+    public static function getHome($uid) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->getHome();
+        } else {
+            return \OC::$server->getSystemConfig()->getValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $uid;
+        }
+    }
+
+    /**
+     * Get a list of all users display name
+     *
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array associative array with all display names (value) and corresponding uids (key)
+     *
+     * Get a list of all display names and user ids.
+     * @deprecated Use \OC::$server->getUserManager->searchDisplayName($search, $limit, $offset) instead.
+     */
+    public static function getDisplayNames($search = '', $limit = null, $offset = null) {
+        $displayNames = [];
+        $users = \OC::$server->getUserManager()->searchDisplayName($search, $limit, $offset);
+        foreach ($users as $user) {
+            $displayNames[$user->getUID()] = $user->getDisplayName();
+        }
+        return $displayNames;
+    }
+
+    /**
+     * Returns the first active backend from self::$_usedBackends.
+     *
+     * @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend
+     */
+    private static function findFirstActiveUsedBackend() {
+        foreach (self::$_usedBackends as $backend) {
+            if ($backend instanceof OCP\Authentication\IApacheBackend) {
+                if ($backend->isSessionActive()) {
+                    return $backend;
+                }
+            }
+        }
+
+        return null;
+    }
 }