nextcloud / server

lib/private/Log/ExceptionSerializer.php

Spacing +8 added lines, -8 removed lines

@@ -188,7 +188,7 @@ 
 
 	private function filterTrace(array $trace) {
 		$sensitiveValues = [];
-		$trace = array_map(function (array $traceLine) use (&$sensitiveValues) {
+		$trace = array_map(function(array $traceLine) use (&$sensitiveValues) {
 			$className = $traceLine['class'] ?? '';
 			if ($className && isset($this->methodsWithSensitiveParametersByClass[$className])
 				&& in_array($traceLine['function'], $this->methodsWithSensitiveParametersByClass[$className], true)) {
@@ -201,7 +201,7 @@ 
 			}
 			return $traceLine;
 		}, $trace);
-		return array_map(function (array $traceLine) use ($sensitiveValues) {
+		return array_map(function(array $traceLine) use ($sensitiveValues) {
 			if (isset($traceLine['args'])) {
 				$traceLine['args'] = $this->removeValuesFromArgs($traceLine['args'], $sensitiveValues);
 			}
@@ -223,7 +223,7 @@ 
 	}
 
 	private function encodeTrace($trace) {
-		$trace = array_map(function (array $line) {
+		$trace = array_map(function(array $line) {
 			if (isset($line['args'])) {
 				$line['args'] = array_map([$this, 'encodeArg'], $line['args']);
 			}
@@ -241,9 +241,9 @@ 
 				];
 			}
 
-			$objectInfo = [ '__class__' => get_class($arg) ];
+			$objectInfo = ['__class__' => get_class($arg)];
 			$objectVars = get_object_vars($arg);
-			return array_map(function ($arg) use ($nestingLevel) {
+			return array_map(function($arg) use ($nestingLevel) {
 				return $this->encodeArg($arg, $nestingLevel - 1);
 			}, array_merge($objectInfo, $objectVars));
 		}
@@ -254,14 +254,14 @@ 
 			}
 
 			// Only log the first 5 elements of an array unless we are on debug
-			if ((int)$this->systemConfig->getValue('loglevel', 2) !== 0) {
+			if ((int) $this->systemConfig->getValue('loglevel', 2) !== 0) {
 				$elemCount = count($arg);
 				if ($elemCount > 5) {
 					$arg = array_slice($arg, 0, 5);
-					$arg[] = 'And ' . ($elemCount - 5) . ' more entries, set log level to debug to see all entries';
+					$arg[] = 'And '.($elemCount - 5).' more entries, set log level to debug to see all entries';
 				}
 			}
-			return array_map(function ($e) use ($nestingLevel) {
+			return array_map(function($e) use ($nestingLevel) {
 				return $this->encodeArg($e, $nestingLevel - 1);
 			}, $arg);
 		}

Indentation +283 added lines, -283 removed lines

@@ -22,287 +22,287 @@
 use OCP\HintException;
 
 class ExceptionSerializer {
-	public const SENSITIVE_VALUE_PLACEHOLDER = '*** sensitive parameters replaced ***';
-
-	public const methodsWithSensitiveParameters = [
-		// Session/User
-		'completeLogin',
-		'login',
-		'checkPassword',
-		'checkPasswordNoLogging',
-		'loginWithPassword',
-		'updatePrivateKeyPassword',
-		'validateUserPass',
-		'loginWithToken',
-		'{closure}',
-		'{closure:*',
-		'createSessionToken',
-
-		// Provisioning
-		'addUser',
-
-		// TokenProvider
-		'getToken',
-		'isTokenPassword',
-		'getPassword',
-		'decryptPassword',
-		'logClientIn',
-		'generateToken',
-		'validateToken',
-
-		// TwoFactorAuth
-		'solveChallenge',
-		'verifyChallenge',
-
-		// ICrypto
-		'calculateHMAC',
-		'encrypt',
-		'decrypt',
-
-		// LoginController
-		'tryLogin',
-		'confirmPassword',
-
-		// LDAP
-		'bind',
-		'areCredentialsValid',
-		'invokeLDAPMethod',
-
-		// Encryption
-		'storeKeyPair',
-		'setupUser',
-		'checkSignature',
-
-		// files_external: OCA\Files_External\MountConfig
-		'getBackendStatus',
-
-		// files_external: UserStoragesController
-		'update',
-
-		// Preview providers, don't log big data strings
-		'imagecreatefromstring',
-
-		// text: PublicSessionController, SessionController and ApiService
-		'create',
-		'close',
-		'push',
-		'sync',
-		'updateSession',
-		'mention',
-		'loginSessionUser',
-
-	];
-
-	public function __construct(
-		private SystemConfig $systemConfig,
-	) {
-	}
-
-	protected array $methodsWithSensitiveParametersByClass = [
-		SetupController::class => [
-			'run',
-			'display',
-			'loadAutoConfig',
-		],
-		Setup::class => [
-			'install'
-		],
-		Key::class => [
-			'__construct'
-		],
-		Client::class => [
-			'request',
-			'delete',
-			'deleteAsync',
-			'get',
-			'getAsync',
-			'head',
-			'headAsync',
-			'options',
-			'optionsAsync',
-			'patch',
-			'post',
-			'postAsync',
-			'put',
-			'putAsync',
-		],
-		\Redis::class => [
-			'auth'
-		],
-		\RedisCluster::class => [
-			'__construct'
-		],
-		Crypt::class => [
-			'symmetricEncryptFileContent',
-			'encrypt',
-			'generatePasswordHash',
-			'encryptPrivateKey',
-			'decryptPrivateKey',
-			'isValidPrivateKey',
-			'symmetricDecryptFileContent',
-			'checkSignature',
-			'createSignature',
-			'decrypt',
-			'multiKeyDecrypt',
-			'multiKeyEncrypt',
-		],
-		RecoveryController::class => [
-			'adminRecovery',
-			'changeRecoveryPassword'
-		],
-		SettingsController::class => [
-			'updatePrivateKeyPassword',
-		],
-		Encryption::class => [
-			'encrypt',
-			'decrypt',
-		],
-		KeyManager::class => [
-			'checkRecoveryPassword',
-			'storeKeyPair',
-			'setRecoveryKey',
-			'setPrivateKey',
-			'setFileKey',
-			'setAllFileKeys',
-		],
-		Session::class => [
-			'setPrivateKey',
-			'prepareDecryptAll',
-		],
-		\OCA\Encryption\Users\Setup::class => [
-			'setupUser',
-		],
-		UserEventsListener::class => [
-			'handle',
-			'onUserCreated',
-			'onUserLogin',
-			'onBeforePasswordUpdated',
-			'onPasswordUpdated',
-			'onPasswordReset',
-		],
-		PassphraseService::class => [
-			'setPassphraseForUser',
-		],
-	];
-
-	private function editTrace(array &$sensitiveValues, array $traceLine): array {
-		if (isset($traceLine['args'])) {
-			$sensitiveValues = array_merge($sensitiveValues, $traceLine['args']);
-		}
-		$traceLine['args'] = [self::SENSITIVE_VALUE_PLACEHOLDER];
-		return $traceLine;
-	}
-
-	private function filterTrace(array $trace) {
-		$sensitiveValues = [];
-		$trace = array_map(function (array $traceLine) use (&$sensitiveValues) {
-			$className = $traceLine['class'] ?? '';
-			if ($className && isset($this->methodsWithSensitiveParametersByClass[$className])
-				&& in_array($traceLine['function'], $this->methodsWithSensitiveParametersByClass[$className], true)) {
-				return $this->editTrace($sensitiveValues, $traceLine);
-			}
-			foreach (self::methodsWithSensitiveParameters as $sensitiveMethod) {
-				if (str_contains($traceLine['function'], $sensitiveMethod)
-					|| (str_ends_with($sensitiveMethod, '*')
-						&& str_starts_with($traceLine['function'], substr($sensitiveMethod, 0, -1)))) {
-					return $this->editTrace($sensitiveValues, $traceLine);
-				}
-			}
-			return $traceLine;
-		}, $trace);
-		return array_map(function (array $traceLine) use ($sensitiveValues) {
-			if (isset($traceLine['args'])) {
-				$traceLine['args'] = $this->removeValuesFromArgs($traceLine['args'], $sensitiveValues);
-			}
-			return $traceLine;
-		}, $trace);
-	}
-
-	private function removeValuesFromArgs($args, $values): array {
-		$workArgs = [];
-		foreach ($args as $key => $arg) {
-			if (in_array($arg, $values, true)) {
-				$arg = self::SENSITIVE_VALUE_PLACEHOLDER;
-			} elseif (is_array($arg)) {
-				$arg = $this->removeValuesFromArgs($arg, $values);
-			}
-			$workArgs[$key] = $arg;
-		}
-		return $workArgs;
-	}
-
-	private function encodeTrace($trace) {
-		$trace = array_map(function (array $line) {
-			if (isset($line['args'])) {
-				$line['args'] = array_map([$this, 'encodeArg'], $line['args']);
-			}
-			return $line;
-		}, $trace);
-		return $this->filterTrace($trace);
-	}
-
-	private function encodeArg($arg, $nestingLevel = 5) {
-		if (is_object($arg)) {
-			if ($nestingLevel === 0) {
-				return [
-					'__class__' => get_class($arg),
-					'__properties__' => 'Encoding skipped as the maximum nesting level was reached',
-				];
-			}
-
-			$objectInfo = [ '__class__' => get_class($arg) ];
-			$objectVars = get_object_vars($arg);
-			return array_map(function ($arg) use ($nestingLevel) {
-				return $this->encodeArg($arg, $nestingLevel - 1);
-			}, array_merge($objectInfo, $objectVars));
-		}
-
-		if (is_array($arg)) {
-			if ($nestingLevel === 0) {
-				return ['Encoding skipped as the maximum nesting level was reached'];
-			}
-
-			// Only log the first 5 elements of an array unless we are on debug
-			if ((int)$this->systemConfig->getValue('loglevel', 2) !== 0) {
-				$elemCount = count($arg);
-				if ($elemCount > 5) {
-					$arg = array_slice($arg, 0, 5);
-					$arg[] = 'And ' . ($elemCount - 5) . ' more entries, set log level to debug to see all entries';
-				}
-			}
-			return array_map(function ($e) use ($nestingLevel) {
-				return $this->encodeArg($e, $nestingLevel - 1);
-			}, $arg);
-		}
-
-		return $arg;
-	}
-
-	public function serializeException(\Throwable $exception): array {
-		$data = [
-			'Exception' => get_class($exception),
-			'Message' => $exception->getMessage(),
-			'Code' => $exception->getCode(),
-			'Trace' => $this->encodeTrace($exception->getTrace()),
-			'File' => $exception->getFile(),
-			'Line' => $exception->getLine(),
-		];
-
-		if ($exception instanceof HintException) {
-			$data['Hint'] = $exception->getHint();
-		}
-
-		if ($exception->getPrevious()) {
-			$data['Previous'] = $this->serializeException($exception->getPrevious());
-		}
-
-		return $data;
-	}
-
-	public function enlistSensitiveMethods(string $class, array $methods): void {
-		if (!isset($this->methodsWithSensitiveParametersByClass[$class])) {
-			$this->methodsWithSensitiveParametersByClass[$class] = [];
-		}
-		$this->methodsWithSensitiveParametersByClass[$class] = array_merge($this->methodsWithSensitiveParametersByClass[$class], $methods);
-	}
+    public const SENSITIVE_VALUE_PLACEHOLDER = '*** sensitive parameters replaced ***';
+
+    public const methodsWithSensitiveParameters = [
+        // Session/User
+        'completeLogin',
+        'login',
+        'checkPassword',
+        'checkPasswordNoLogging',
+        'loginWithPassword',
+        'updatePrivateKeyPassword',
+        'validateUserPass',
+        'loginWithToken',
+        '{closure}',
+        '{closure:*',
+        'createSessionToken',
+
+        // Provisioning
+        'addUser',
+
+        // TokenProvider
+        'getToken',
+        'isTokenPassword',
+        'getPassword',
+        'decryptPassword',
+        'logClientIn',
+        'generateToken',
+        'validateToken',
+
+        // TwoFactorAuth
+        'solveChallenge',
+        'verifyChallenge',
+
+        // ICrypto
+        'calculateHMAC',
+        'encrypt',
+        'decrypt',
+
+        // LoginController
+        'tryLogin',
+        'confirmPassword',
+
+        // LDAP
+        'bind',
+        'areCredentialsValid',
+        'invokeLDAPMethod',
+
+        // Encryption
+        'storeKeyPair',
+        'setupUser',
+        'checkSignature',
+
+        // files_external: OCA\Files_External\MountConfig
+        'getBackendStatus',
+
+        // files_external: UserStoragesController
+        'update',
+
+        // Preview providers, don't log big data strings
+        'imagecreatefromstring',
+
+        // text: PublicSessionController, SessionController and ApiService
+        'create',
+        'close',
+        'push',
+        'sync',
+        'updateSession',
+        'mention',
+        'loginSessionUser',
+
+    ];
+
+    public function __construct(
+        private SystemConfig $systemConfig,
+    ) {
+    }
+
+    protected array $methodsWithSensitiveParametersByClass = [
+        SetupController::class => [
+            'run',
+            'display',
+            'loadAutoConfig',
+        ],
+        Setup::class => [
+            'install'
+        ],
+        Key::class => [
+            '__construct'
+        ],
+        Client::class => [
+            'request',
+            'delete',
+            'deleteAsync',
+            'get',
+            'getAsync',
+            'head',
+            'headAsync',
+            'options',
+            'optionsAsync',
+            'patch',
+            'post',
+            'postAsync',
+            'put',
+            'putAsync',
+        ],
+        \Redis::class => [
+            'auth'
+        ],
+        \RedisCluster::class => [
+            '__construct'
+        ],
+        Crypt::class => [
+            'symmetricEncryptFileContent',
+            'encrypt',
+            'generatePasswordHash',
+            'encryptPrivateKey',
+            'decryptPrivateKey',
+            'isValidPrivateKey',
+            'symmetricDecryptFileContent',
+            'checkSignature',
+            'createSignature',
+            'decrypt',
+            'multiKeyDecrypt',
+            'multiKeyEncrypt',
+        ],
+        RecoveryController::class => [
+            'adminRecovery',
+            'changeRecoveryPassword'
+        ],
+        SettingsController::class => [
+            'updatePrivateKeyPassword',
+        ],
+        Encryption::class => [
+            'encrypt',
+            'decrypt',
+        ],
+        KeyManager::class => [
+            'checkRecoveryPassword',
+            'storeKeyPair',
+            'setRecoveryKey',
+            'setPrivateKey',
+            'setFileKey',
+            'setAllFileKeys',
+        ],
+        Session::class => [
+            'setPrivateKey',
+            'prepareDecryptAll',
+        ],
+        \OCA\Encryption\Users\Setup::class => [
+            'setupUser',
+        ],
+        UserEventsListener::class => [
+            'handle',
+            'onUserCreated',
+            'onUserLogin',
+            'onBeforePasswordUpdated',
+            'onPasswordUpdated',
+            'onPasswordReset',
+        ],
+        PassphraseService::class => [
+            'setPassphraseForUser',
+        ],
+    ];
+
+    private function editTrace(array &$sensitiveValues, array $traceLine): array {
+        if (isset($traceLine['args'])) {
+            $sensitiveValues = array_merge($sensitiveValues, $traceLine['args']);
+        }
+        $traceLine['args'] = [self::SENSITIVE_VALUE_PLACEHOLDER];
+        return $traceLine;
+    }
+
+    private function filterTrace(array $trace) {
+        $sensitiveValues = [];
+        $trace = array_map(function (array $traceLine) use (&$sensitiveValues) {
+            $className = $traceLine['class'] ?? '';
+            if ($className && isset($this->methodsWithSensitiveParametersByClass[$className])
+                && in_array($traceLine['function'], $this->methodsWithSensitiveParametersByClass[$className], true)) {
+                return $this->editTrace($sensitiveValues, $traceLine);
+            }
+            foreach (self::methodsWithSensitiveParameters as $sensitiveMethod) {
+                if (str_contains($traceLine['function'], $sensitiveMethod)
+                    || (str_ends_with($sensitiveMethod, '*')
+                        && str_starts_with($traceLine['function'], substr($sensitiveMethod, 0, -1)))) {
+                    return $this->editTrace($sensitiveValues, $traceLine);
+                }
+            }
+            return $traceLine;
+        }, $trace);
+        return array_map(function (array $traceLine) use ($sensitiveValues) {
+            if (isset($traceLine['args'])) {
+                $traceLine['args'] = $this->removeValuesFromArgs($traceLine['args'], $sensitiveValues);
+            }
+            return $traceLine;
+        }, $trace);
+    }
+
+    private function removeValuesFromArgs($args, $values): array {
+        $workArgs = [];
+        foreach ($args as $key => $arg) {
+            if (in_array($arg, $values, true)) {
+                $arg = self::SENSITIVE_VALUE_PLACEHOLDER;
+            } elseif (is_array($arg)) {
+                $arg = $this->removeValuesFromArgs($arg, $values);
+            }
+            $workArgs[$key] = $arg;
+        }
+        return $workArgs;
+    }
+
+    private function encodeTrace($trace) {
+        $trace = array_map(function (array $line) {
+            if (isset($line['args'])) {
+                $line['args'] = array_map([$this, 'encodeArg'], $line['args']);
+            }
+            return $line;
+        }, $trace);
+        return $this->filterTrace($trace);
+    }
+
+    private function encodeArg($arg, $nestingLevel = 5) {
+        if (is_object($arg)) {
+            if ($nestingLevel === 0) {
+                return [
+                    '__class__' => get_class($arg),
+                    '__properties__' => 'Encoding skipped as the maximum nesting level was reached',
+                ];
+            }
+
+            $objectInfo = [ '__class__' => get_class($arg) ];
+            $objectVars = get_object_vars($arg);
+            return array_map(function ($arg) use ($nestingLevel) {
+                return $this->encodeArg($arg, $nestingLevel - 1);
+            }, array_merge($objectInfo, $objectVars));
+        }
+
+        if (is_array($arg)) {
+            if ($nestingLevel === 0) {
+                return ['Encoding skipped as the maximum nesting level was reached'];
+            }
+
+            // Only log the first 5 elements of an array unless we are on debug
+            if ((int)$this->systemConfig->getValue('loglevel', 2) !== 0) {
+                $elemCount = count($arg);
+                if ($elemCount > 5) {
+                    $arg = array_slice($arg, 0, 5);
+                    $arg[] = 'And ' . ($elemCount - 5) . ' more entries, set log level to debug to see all entries';
+                }
+            }
+            return array_map(function ($e) use ($nestingLevel) {
+                return $this->encodeArg($e, $nestingLevel - 1);
+            }, $arg);
+        }
+
+        return $arg;
+    }
+
+    public function serializeException(\Throwable $exception): array {
+        $data = [
+            'Exception' => get_class($exception),
+            'Message' => $exception->getMessage(),
+            'Code' => $exception->getCode(),
+            'Trace' => $this->encodeTrace($exception->getTrace()),
+            'File' => $exception->getFile(),
+            'Line' => $exception->getLine(),
+        ];
+
+        if ($exception instanceof HintException) {
+            $data['Hint'] = $exception->getHint();
+        }
+
+        if ($exception->getPrevious()) {
+            $data['Previous'] = $this->serializeException($exception->getPrevious());
+        }
+
+        return $data;
+    }
+
+    public function enlistSensitiveMethods(string $class, array $methods): void {
+        if (!isset($this->methodsWithSensitiveParametersByClass[$class])) {
+            $this->methodsWithSensitiveParametersByClass[$class] = [];
+        }
+        $this->methodsWithSensitiveParametersByClass[$class] = array_merge($this->methodsWithSensitiveParametersByClass[$class], $methods);
+    }
 }

apps/files_external/lib/Lib/DefinitionParameter.php

Spacing +1 added lines, -1 removed lines

@@ -167,7 +167,7 @@
 	 * @return bool
 	 */
 	public function isFlagSet(int $flag): bool {
-		return (bool)($this->flags & $flag);
+		return (bool) ($this->flags & $flag);
 	}
 
 	/**

Indentation +203 added lines, -203 removed lines

@@ -10,207 +10,207 @@
  * Parameter for an external storage definition
  */
 class DefinitionParameter implements \JsonSerializable {
-	// placeholder value for password fields, when the client updates a storage configuration
-	// placeholder values are ignored and the field is left unmodified
-	public const UNMODIFIED_PLACEHOLDER = '__unmodified__';
-
-	/** Value constants */
-	public const VALUE_TEXT = 0;
-	public const VALUE_BOOLEAN = 1;
-	public const VALUE_PASSWORD = 2;
-
-	/** Flag constants */
-	public const FLAG_NONE = 0;
-	public const FLAG_OPTIONAL = 1;
-	public const FLAG_USER_PROVIDED = 2;
-	public const FLAG_HIDDEN = 4;
-
-	/** @var string human-readable parameter tooltip */
-	private string $tooltip = '';
-
-	/** @var int value type, see self::VALUE_* constants */
-	private int $type = self::VALUE_TEXT;
-
-	/** @var int flags, see self::FLAG_* constants */
-	private int $flags = self::FLAG_NONE;
-
-	/**
-	 * @param string $name parameter name
-	 * @param string $text parameter description
-	 * @param mixed $defaultValue default value
-	 */
-	public function __construct(
-		private string $name,
-		private string $text,
-		private $defaultValue = null,
-	) {
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getName(): string {
-		return $this->name;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getText(): string {
-		return $this->text;
-	}
-
-	/**
-	 * Get value type
-	 *
-	 * @return int
-	 */
-	public function getType(): int {
-		return $this->type;
-	}
-
-	/**
-	 * Set value type
-	 *
-	 * @param int $type
-	 * @return self
-	 */
-	public function setType(int $type) {
-		$this->type = $type;
-		return $this;
-	}
-
-	/**
-	 * @return mixed default value
-	 */
-	public function getDefaultValue() {
-		return $this->defaultValue;
-	}
-
-	/**
-	 * @param mixed $defaultValue default value
-	 * @return self
-	 */
-	public function setDefaultValue($defaultValue) {
-		$this->defaultValue = $defaultValue;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getTypeName(): string {
-		switch ($this->type) {
-			case self::VALUE_BOOLEAN:
-				return 'boolean';
-			case self::VALUE_TEXT:
-				return 'text';
-			case self::VALUE_PASSWORD:
-				return 'password';
-			default:
-				return 'unknown';
-		}
-	}
-
-	/**
-	 * @return int
-	 */
-	public function getFlags(): int {
-		return $this->flags;
-	}
-
-	/**
-	 * @param int $flags
-	 * @return self
-	 */
-	public function setFlags(int $flags) {
-		$this->flags = $flags;
-		return $this;
-	}
-
-	/**
-	 * @param int $flag
-	 * @return self
-	 */
-	public function setFlag(int $flag) {
-		$this->flags |= $flag;
-		return $this;
-	}
-
-	/**
-	 * @param int $flag
-	 * @return bool
-	 */
-	public function isFlagSet(int $flag): bool {
-		return (bool)($this->flags & $flag);
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getTooltip(): string {
-		return $this->tooltip;
-	}
-
-	/**
-	 * @param string $tooltip
-	 * @return self
-	 */
-	public function setTooltip(string $tooltip) {
-		$this->tooltip = $tooltip;
-		return $this;
-	}
-
-	/**
-	 * Serialize into JSON for client-side JS
-	 */
-	public function jsonSerialize(): array {
-		$result = [
-			'value' => $this->getText(),
-			'flags' => $this->getFlags(),
-			'type' => $this->getType(),
-			'tooltip' => $this->getTooltip(),
-		];
-		$defaultValue = $this->getDefaultValue();
-		if ($defaultValue) {
-			$result['defaultValue'] = $defaultValue;
-		}
-		return $result;
-	}
-
-	public function isOptional(): bool {
-		return $this->isFlagSet(self::FLAG_OPTIONAL) || $this->isFlagSet(self::FLAG_USER_PROVIDED);
-	}
-
-	/**
-	 * Validate a parameter value against this
-	 * Convert type as necessary
-	 *
-	 * @param mixed $value Value to check
-	 * @return bool success
-	 */
-	public function validateValue(&$value): bool {
-		switch ($this->getType()) {
-			case self::VALUE_BOOLEAN:
-				if (!is_bool($value)) {
-					switch ($value) {
-						case 'true':
-							$value = true;
-							break;
-						case 'false':
-							$value = false;
-							break;
-						default:
-							return false;
-					}
-				}
-				break;
-			default:
-				if (!$value && !$this->isOptional()) {
-					return false;
-				}
-				break;
-		}
-		return true;
-	}
+    // placeholder value for password fields, when the client updates a storage configuration
+    // placeholder values are ignored and the field is left unmodified
+    public const UNMODIFIED_PLACEHOLDER = '__unmodified__';
+
+    /** Value constants */
+    public const VALUE_TEXT = 0;
+    public const VALUE_BOOLEAN = 1;
+    public const VALUE_PASSWORD = 2;
+
+    /** Flag constants */
+    public const FLAG_NONE = 0;
+    public const FLAG_OPTIONAL = 1;
+    public const FLAG_USER_PROVIDED = 2;
+    public const FLAG_HIDDEN = 4;
+
+    /** @var string human-readable parameter tooltip */
+    private string $tooltip = '';
+
+    /** @var int value type, see self::VALUE_* constants */
+    private int $type = self::VALUE_TEXT;
+
+    /** @var int flags, see self::FLAG_* constants */
+    private int $flags = self::FLAG_NONE;
+
+    /**
+     * @param string $name parameter name
+     * @param string $text parameter description
+     * @param mixed $defaultValue default value
+     */
+    public function __construct(
+        private string $name,
+        private string $text,
+        private $defaultValue = null,
+    ) {
+    }
+
+    /**
+     * @return string
+     */
+    public function getName(): string {
+        return $this->name;
+    }
+
+    /**
+     * @return string
+     */
+    public function getText(): string {
+        return $this->text;
+    }
+
+    /**
+     * Get value type
+     *
+     * @return int
+     */
+    public function getType(): int {
+        return $this->type;
+    }
+
+    /**
+     * Set value type
+     *
+     * @param int $type
+     * @return self
+     */
+    public function setType(int $type) {
+        $this->type = $type;
+        return $this;
+    }
+
+    /**
+     * @return mixed default value
+     */
+    public function getDefaultValue() {
+        return $this->defaultValue;
+    }
+
+    /**
+     * @param mixed $defaultValue default value
+     * @return self
+     */
+    public function setDefaultValue($defaultValue) {
+        $this->defaultValue = $defaultValue;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getTypeName(): string {
+        switch ($this->type) {
+            case self::VALUE_BOOLEAN:
+                return 'boolean';
+            case self::VALUE_TEXT:
+                return 'text';
+            case self::VALUE_PASSWORD:
+                return 'password';
+            default:
+                return 'unknown';
+        }
+    }
+
+    /**
+     * @return int
+     */
+    public function getFlags(): int {
+        return $this->flags;
+    }
+
+    /**
+     * @param int $flags
+     * @return self
+     */
+    public function setFlags(int $flags) {
+        $this->flags = $flags;
+        return $this;
+    }
+
+    /**
+     * @param int $flag
+     * @return self
+     */
+    public function setFlag(int $flag) {
+        $this->flags |= $flag;
+        return $this;
+    }
+
+    /**
+     * @param int $flag
+     * @return bool
+     */
+    public function isFlagSet(int $flag): bool {
+        return (bool)($this->flags & $flag);
+    }
+
+    /**
+     * @return string
+     */
+    public function getTooltip(): string {
+        return $this->tooltip;
+    }
+
+    /**
+     * @param string $tooltip
+     * @return self
+     */
+    public function setTooltip(string $tooltip) {
+        $this->tooltip = $tooltip;
+        return $this;
+    }
+
+    /**
+     * Serialize into JSON for client-side JS
+     */
+    public function jsonSerialize(): array {
+        $result = [
+            'value' => $this->getText(),
+            'flags' => $this->getFlags(),
+            'type' => $this->getType(),
+            'tooltip' => $this->getTooltip(),
+        ];
+        $defaultValue = $this->getDefaultValue();
+        if ($defaultValue) {
+            $result['defaultValue'] = $defaultValue;
+        }
+        return $result;
+    }
+
+    public function isOptional(): bool {
+        return $this->isFlagSet(self::FLAG_OPTIONAL) || $this->isFlagSet(self::FLAG_USER_PROVIDED);
+    }
+
+    /**
+     * Validate a parameter value against this
+     * Convert type as necessary
+     *
+     * @param mixed $value Value to check
+     * @return bool success
+     */
+    public function validateValue(&$value): bool {
+        switch ($this->getType()) {
+            case self::VALUE_BOOLEAN:
+                if (!is_bool($value)) {
+                    switch ($value) {
+                        case 'true':
+                            $value = true;
+                            break;
+                        case 'false':
+                            $value = false;
+                            break;
+                        default:
+                            return false;
+                    }
+                }
+                break;
+            default:
+                if (!$value && !$this->isOptional()) {
+                    return false;
+                }
+                break;
+        }
+        return true;
+    }
 }

apps/files_external/lib/Lib/Backend/DAV.php

Indentation +19 added lines, -19 removed lines

@@ -30,24 +30,24 @@
 use OCP\IL10N;
 
 class DAV extends Backend {
-	use LegacyDependencyCheckPolyfill;
+    use LegacyDependencyCheckPolyfill;
 
-	public function __construct(IL10N $l, Password $legacyAuth) {
-		$this
-			->setIdentifier('dav')
-			->addIdentifierAlias('\OC\Files\Storage\DAV') // legacy compat
-			->setStorageClass('\OC\Files\Storage\DAV')
-			->setText($l->t('WebDAV'))
-			->addParameters([
-				new DefinitionParameter('host', $l->t('URL')),
-				(new DefinitionParameter('root', $l->t('Remote subfolder')))
-					->setFlag(DefinitionParameter::FLAG_OPTIONAL),
-				(new DefinitionParameter('secure', $l->t('Secure https://')))
-					->setType(DefinitionParameter::VALUE_BOOLEAN)
-					->setDefaultValue(true),
-			])
-			->addAuthScheme(AuthMechanism::SCHEME_PASSWORD)
-			->setLegacyAuthMechanism($legacyAuth)
-		;
-	}
+    public function __construct(IL10N $l, Password $legacyAuth) {
+        $this
+            ->setIdentifier('dav')
+            ->addIdentifierAlias('\OC\Files\Storage\DAV') // legacy compat
+            ->setStorageClass('\OC\Files\Storage\DAV')
+            ->setText($l->t('WebDAV'))
+            ->addParameters([
+                new DefinitionParameter('host', $l->t('URL')),
+                (new DefinitionParameter('root', $l->t('Remote subfolder')))
+                    ->setFlag(DefinitionParameter::FLAG_OPTIONAL),
+                (new DefinitionParameter('secure', $l->t('Secure https://')))
+                    ->setType(DefinitionParameter::VALUE_BOOLEAN)
+                    ->setDefaultValue(true),
+            ])
+            ->addAuthScheme(AuthMechanism::SCHEME_PASSWORD)
+            ->setLegacyAuthMechanism($legacyAuth)
+        ;
+    }
 }

apps/files_external/lib/Lib/Backend/OwnCloud.php

Indentation +18 added lines, -18 removed lines

@@ -30,22 +30,22 @@
 use OCP\IL10N;
 
 class OwnCloud extends Backend {
-	public function __construct(IL10N $l, Password $legacyAuth) {
-		$this
-			->setIdentifier('owncloud')
-			->addIdentifierAlias('\OC\Files\Storage\OwnCloud') // legacy compat
-			->setStorageClass('\OCA\Files_External\Lib\Storage\OwnCloud')
-			->setText($l->t('Nextcloud'))
-			->addParameters([
-				new DefinitionParameter('host', $l->t('URL')),
-				(new DefinitionParameter('root', $l->t('Remote subfolder')))
-					->setFlag(DefinitionParameter::FLAG_OPTIONAL),
-				(new DefinitionParameter('secure', $l->t('Secure https://')))
-					->setType(DefinitionParameter::VALUE_BOOLEAN)
-					->setDefaultValue(true),
-			])
-			->addAuthScheme(AuthMechanism::SCHEME_PASSWORD)
-			->setLegacyAuthMechanism($legacyAuth)
-		;
-	}
+    public function __construct(IL10N $l, Password $legacyAuth) {
+        $this
+            ->setIdentifier('owncloud')
+            ->addIdentifierAlias('\OC\Files\Storage\OwnCloud') // legacy compat
+            ->setStorageClass('\OCA\Files_External\Lib\Storage\OwnCloud')
+            ->setText($l->t('Nextcloud'))
+            ->addParameters([
+                new DefinitionParameter('host', $l->t('URL')),
+                (new DefinitionParameter('root', $l->t('Remote subfolder')))
+                    ->setFlag(DefinitionParameter::FLAG_OPTIONAL),
+                (new DefinitionParameter('secure', $l->t('Secure https://')))
+                    ->setType(DefinitionParameter::VALUE_BOOLEAN)
+                    ->setDefaultValue(true),
+            ])
+            ->addAuthScheme(AuthMechanism::SCHEME_PASSWORD)
+            ->setLegacyAuthMechanism($legacyAuth)
+        ;
+    }
 }

core/Command/User/Setting.php

Spacing +5 added lines, -5 removed lines

@@ -117,7 +117,7 @@ 
 			$uid = $input->getArgument('uid');
 			$user = $this->userManager->get($uid);
 			if (!$user) {
-				throw new \InvalidArgumentException('The user "' . $uid . '" does not exist.');
+				throw new \InvalidArgumentException('The user "'.$uid.'" does not exist.');
 			}
 			// normalize uid
 			$input->setArgument('uid', $user->getUID());
@@ -155,7 +155,7 @@ 
 		try {
 			$this->checkInput($input);
 		} catch (\InvalidArgumentException $e) {
-			$output->writeln('<error>' . $e->getMessage() . '</error>');
+			$output->writeln('<error>'.$e->getMessage().'</error>');
 			return 1;
 		}
 
@@ -167,7 +167,7 @@ 
 			$value = $this->config->getUserValue($uid, $app, $key, null);
 			if ($input->getArgument('value') !== null) {
 				if ($input->hasParameterOption('--update-only') && $value === null) {
-					$output->writeln('<error>The setting does not exist for user "' . $uid . '".</error>');
+					$output->writeln('<error>The setting does not exist for user "'.$uid.'".</error>');
 					return 1;
 				}
 
@@ -197,7 +197,7 @@ 
 				return 0;
 			} elseif ($input->hasParameterOption('--delete')) {
 				if ($input->hasParameterOption('--error-if-not-exists') && $value === null) {
-					$output->writeln('<error>The setting does not exist for user "' . $uid . '".</error>');
+					$output->writeln('<error>The setting does not exist for user "'.$uid.'".</error>');
 					return 1;
 				}
 
@@ -229,7 +229,7 @@ 
 					$output->writeln($user->getDisplayName());
 					return 0;
 				}
-				$output->writeln('<error>The setting does not exist for user "' . $uid . '".</error>');
+				$output->writeln('<error>The setting does not exist for user "'.$uid.'".</error>');
 				return 1;
 			}
 		} else {

Indentation +224 added lines, -224 removed lines

@@ -18,247 +18,247 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class Setting extends Base {
-	public function __construct(
-		protected IUserManager $userManager,
-		protected IConfig $config,
-	) {
-		parent::__construct();
-	}
+    public function __construct(
+        protected IUserManager $userManager,
+        protected IConfig $config,
+    ) {
+        parent::__construct();
+    }
 
-	protected function configure() {
-		parent::configure();
-		$this
-			->setName('user:setting')
-			->setDescription('Read and modify user settings')
-			->addArgument(
-				'uid',
-				InputArgument::REQUIRED,
-				'Account ID used to login'
-			)
-			->addArgument(
-				'app',
-				InputArgument::OPTIONAL,
-				'Restrict the settings to a given app',
-				''
-			)
-			->addArgument(
-				'key',
-				InputArgument::OPTIONAL,
-				'Setting key to set, get or delete',
-				''
-			)
-			->addOption(
-				'ignore-missing-user',
-				null,
-				InputOption::VALUE_NONE,
-				'Use this option to ignore errors when the user does not exist'
-			)
+    protected function configure() {
+        parent::configure();
+        $this
+            ->setName('user:setting')
+            ->setDescription('Read and modify user settings')
+            ->addArgument(
+                'uid',
+                InputArgument::REQUIRED,
+                'Account ID used to login'
+            )
+            ->addArgument(
+                'app',
+                InputArgument::OPTIONAL,
+                'Restrict the settings to a given app',
+                ''
+            )
+            ->addArgument(
+                'key',
+                InputArgument::OPTIONAL,
+                'Setting key to set, get or delete',
+                ''
+            )
+            ->addOption(
+                'ignore-missing-user',
+                null,
+                InputOption::VALUE_NONE,
+                'Use this option to ignore errors when the user does not exist'
+            )
 
-			// Get
-			->addOption(
-				'default-value',
-				null,
-				InputOption::VALUE_REQUIRED,
-				'(Only applicable on get) If no default value is set and the config does not exist, the command will exit with 1'
-			)
+            // Get
+            ->addOption(
+                'default-value',
+                null,
+                InputOption::VALUE_REQUIRED,
+                '(Only applicable on get) If no default value is set and the config does not exist, the command will exit with 1'
+            )
 
-			// Set
-			->addArgument(
-				'value',
-				InputArgument::OPTIONAL,
-				'The new value of the setting',
-				null
-			)
-			->addOption(
-				'update-only',
-				null,
-				InputOption::VALUE_NONE,
-				'Only updates the value, if it is not set before, it is not being added'
-			)
+            // Set
+            ->addArgument(
+                'value',
+                InputArgument::OPTIONAL,
+                'The new value of the setting',
+                null
+            )
+            ->addOption(
+                'update-only',
+                null,
+                InputOption::VALUE_NONE,
+                'Only updates the value, if it is not set before, it is not being added'
+            )
 
-			// Delete
-			->addOption(
-				'delete',
-				null,
-				InputOption::VALUE_NONE,
-				'Specify this option to delete the config'
-			)
-			->addOption(
-				'error-if-not-exists',
-				null,
-				InputOption::VALUE_NONE,
-				'Checks whether the setting exists before deleting it'
-			)
-		;
-	}
+            // Delete
+            ->addOption(
+                'delete',
+                null,
+                InputOption::VALUE_NONE,
+                'Specify this option to delete the config'
+            )
+            ->addOption(
+                'error-if-not-exists',
+                null,
+                InputOption::VALUE_NONE,
+                'Checks whether the setting exists before deleting it'
+            )
+        ;
+    }
 
-	protected function checkInput(InputInterface $input) {
-		if (!$input->getOption('ignore-missing-user')) {
-			$uid = $input->getArgument('uid');
-			$user = $this->userManager->get($uid);
-			if (!$user) {
-				throw new \InvalidArgumentException('The user "' . $uid . '" does not exist.');
-			}
-			// normalize uid
-			$input->setArgument('uid', $user->getUID());
-		}
+    protected function checkInput(InputInterface $input) {
+        if (!$input->getOption('ignore-missing-user')) {
+            $uid = $input->getArgument('uid');
+            $user = $this->userManager->get($uid);
+            if (!$user) {
+                throw new \InvalidArgumentException('The user "' . $uid . '" does not exist.');
+            }
+            // normalize uid
+            $input->setArgument('uid', $user->getUID());
+        }
 
-		if ($input->getArgument('key') === '' && $input->hasParameterOption('--default-value')) {
-			throw new \InvalidArgumentException('The "default-value" option can only be used when specifying a key.');
-		}
+        if ($input->getArgument('key') === '' && $input->hasParameterOption('--default-value')) {
+            throw new \InvalidArgumentException('The "default-value" option can only be used when specifying a key.');
+        }
 
-		if ($input->getArgument('key') === '' && $input->getArgument('value') !== null) {
-			throw new \InvalidArgumentException('The value argument can only be used when specifying a key.');
-		}
-		if ($input->getArgument('value') !== null && $input->hasParameterOption('--default-value')) {
-			throw new \InvalidArgumentException('The value argument can not be used together with "default-value".');
-		}
-		if ($input->getOption('update-only') && $input->getArgument('value') === null) {
-			throw new \InvalidArgumentException('The "update-only" option can only be used together with "value".');
-		}
+        if ($input->getArgument('key') === '' && $input->getArgument('value') !== null) {
+            throw new \InvalidArgumentException('The value argument can only be used when specifying a key.');
+        }
+        if ($input->getArgument('value') !== null && $input->hasParameterOption('--default-value')) {
+            throw new \InvalidArgumentException('The value argument can not be used together with "default-value".');
+        }
+        if ($input->getOption('update-only') && $input->getArgument('value') === null) {
+            throw new \InvalidArgumentException('The "update-only" option can only be used together with "value".');
+        }
 
-		if ($input->getArgument('key') === '' && $input->getOption('delete')) {
-			throw new \InvalidArgumentException('The "delete" option can only be used when specifying a key.');
-		}
-		if ($input->getOption('delete') && $input->hasParameterOption('--default-value')) {
-			throw new \InvalidArgumentException('The "delete" option can not be used together with "default-value".');
-		}
-		if ($input->getOption('delete') && $input->getArgument('value') !== null) {
-			throw new \InvalidArgumentException('The "delete" option can not be used together with "value".');
-		}
-		if ($input->getOption('error-if-not-exists') && !$input->getOption('delete')) {
-			throw new \InvalidArgumentException('The "error-if-not-exists" option can only be used together with "delete".');
-		}
-	}
+        if ($input->getArgument('key') === '' && $input->getOption('delete')) {
+            throw new \InvalidArgumentException('The "delete" option can only be used when specifying a key.');
+        }
+        if ($input->getOption('delete') && $input->hasParameterOption('--default-value')) {
+            throw new \InvalidArgumentException('The "delete" option can not be used together with "default-value".');
+        }
+        if ($input->getOption('delete') && $input->getArgument('value') !== null) {
+            throw new \InvalidArgumentException('The "delete" option can not be used together with "value".');
+        }
+        if ($input->getOption('error-if-not-exists') && !$input->getOption('delete')) {
+            throw new \InvalidArgumentException('The "error-if-not-exists" option can only be used together with "delete".');
+        }
+    }
 
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		try {
-			$this->checkInput($input);
-		} catch (\InvalidArgumentException $e) {
-			$output->writeln('<error>' . $e->getMessage() . '</error>');
-			return 1;
-		}
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        try {
+            $this->checkInput($input);
+        } catch (\InvalidArgumentException $e) {
+            $output->writeln('<error>' . $e->getMessage() . '</error>');
+            return 1;
+        }
 
-		$uid = $input->getArgument('uid');
-		$app = $input->getArgument('app');
-		$key = $input->getArgument('key');
+        $uid = $input->getArgument('uid');
+        $app = $input->getArgument('app');
+        $key = $input->getArgument('key');
 
-		if ($key !== '') {
-			$value = $this->config->getUserValue($uid, $app, $key, null);
-			if ($input->getArgument('value') !== null) {
-				if ($input->hasParameterOption('--update-only') && $value === null) {
-					$output->writeln('<error>The setting does not exist for user "' . $uid . '".</error>');
-					return 1;
-				}
+        if ($key !== '') {
+            $value = $this->config->getUserValue($uid, $app, $key, null);
+            if ($input->getArgument('value') !== null) {
+                if ($input->hasParameterOption('--update-only') && $value === null) {
+                    $output->writeln('<error>The setting does not exist for user "' . $uid . '".</error>');
+                    return 1;
+                }
 
-				if ($app === 'settings' && in_array($key, ['email', 'display_name'])) {
-					$user = $this->userManager->get($uid);
-					if ($user instanceof IUser) {
-						if ($key === 'email') {
-							$email = $input->getArgument('value');
-							$user->setSystemEMailAddress(mb_strtolower(trim($email)));
-						} elseif ($key === 'display_name') {
-							if (!$user->setDisplayName($input->getArgument('value'))) {
-								if ($user->getDisplayName() === $input->getArgument('value')) {
-									$output->writeln('<error>New and old display name are the same</error>');
-								} elseif ($input->getArgument('value') === '') {
-									$output->writeln('<error>New display name can\'t be empty</error>');
-								} else {
-									$output->writeln('<error>Could not set display name</error>');
-								}
-								return 1;
-							}
-						}
-						// setEmailAddress and setDisplayName both internally set the value
-						return 0;
-					}
-				}
+                if ($app === 'settings' && in_array($key, ['email', 'display_name'])) {
+                    $user = $this->userManager->get($uid);
+                    if ($user instanceof IUser) {
+                        if ($key === 'email') {
+                            $email = $input->getArgument('value');
+                            $user->setSystemEMailAddress(mb_strtolower(trim($email)));
+                        } elseif ($key === 'display_name') {
+                            if (!$user->setDisplayName($input->getArgument('value'))) {
+                                if ($user->getDisplayName() === $input->getArgument('value')) {
+                                    $output->writeln('<error>New and old display name are the same</error>');
+                                } elseif ($input->getArgument('value') === '') {
+                                    $output->writeln('<error>New display name can\'t be empty</error>');
+                                } else {
+                                    $output->writeln('<error>Could not set display name</error>');
+                                }
+                                return 1;
+                            }
+                        }
+                        // setEmailAddress and setDisplayName both internally set the value
+                        return 0;
+                    }
+                }
 
-				$this->config->setUserValue($uid, $app, $key, $input->getArgument('value'));
-				return 0;
-			} elseif ($input->hasParameterOption('--delete')) {
-				if ($input->hasParameterOption('--error-if-not-exists') && $value === null) {
-					$output->writeln('<error>The setting does not exist for user "' . $uid . '".</error>');
-					return 1;
-				}
+                $this->config->setUserValue($uid, $app, $key, $input->getArgument('value'));
+                return 0;
+            } elseif ($input->hasParameterOption('--delete')) {
+                if ($input->hasParameterOption('--error-if-not-exists') && $value === null) {
+                    $output->writeln('<error>The setting does not exist for user "' . $uid . '".</error>');
+                    return 1;
+                }
 
-				if ($app === 'settings' && in_array($key, ['email', 'display_name'])) {
-					$user = $this->userManager->get($uid);
-					if ($user instanceof IUser) {
-						if ($key === 'email') {
-							$user->setEMailAddress('');
-							// setEmailAddress already deletes the value
-							return 0;
-						} elseif ($key === 'display_name') {
-							$output->writeln('<error>Display name can\'t be deleted.</error>');
-							return 1;
-						}
-					}
-				}
+                if ($app === 'settings' && in_array($key, ['email', 'display_name'])) {
+                    $user = $this->userManager->get($uid);
+                    if ($user instanceof IUser) {
+                        if ($key === 'email') {
+                            $user->setEMailAddress('');
+                            // setEmailAddress already deletes the value
+                            return 0;
+                        } elseif ($key === 'display_name') {
+                            $output->writeln('<error>Display name can\'t be deleted.</error>');
+                            return 1;
+                        }
+                    }
+                }
 
-				$this->config->deleteUserValue($uid, $app, $key);
-				return 0;
-			} elseif ($value !== null) {
-				$output->writeln($value);
-				return 0;
-			} elseif ($input->hasParameterOption('--default-value')) {
-				$output->writeln($input->getOption('default-value'));
-				return 0;
-			} else {
-				if ($app === 'settings' && $key === 'display_name') {
-					$user = $this->userManager->get($uid);
-					$output->writeln($user->getDisplayName());
-					return 0;
-				}
-				$output->writeln('<error>The setting does not exist for user "' . $uid . '".</error>');
-				return 1;
-			}
-		} else {
-			$settings = $this->getUserSettings($uid, $app);
-			$this->writeArrayInOutputFormat($input, $output, $settings);
-			return 0;
-		}
-	}
+                $this->config->deleteUserValue($uid, $app, $key);
+                return 0;
+            } elseif ($value !== null) {
+                $output->writeln($value);
+                return 0;
+            } elseif ($input->hasParameterOption('--default-value')) {
+                $output->writeln($input->getOption('default-value'));
+                return 0;
+            } else {
+                if ($app === 'settings' && $key === 'display_name') {
+                    $user = $this->userManager->get($uid);
+                    $output->writeln($user->getDisplayName());
+                    return 0;
+                }
+                $output->writeln('<error>The setting does not exist for user "' . $uid . '".</error>');
+                return 1;
+            }
+        } else {
+            $settings = $this->getUserSettings($uid, $app);
+            $this->writeArrayInOutputFormat($input, $output, $settings);
+            return 0;
+        }
+    }
 
-	protected function getUserSettings(string $uid, string $app): array {
-		$settings = $this->config->getAllUserValues($uid);
-		if ($app !== '') {
-			if (isset($settings[$app])) {
-				$settings = [$app => $settings[$app]];
-			} else {
-				$settings = [];
-			}
-		}
+    protected function getUserSettings(string $uid, string $app): array {
+        $settings = $this->config->getAllUserValues($uid);
+        if ($app !== '') {
+            if (isset($settings[$app])) {
+                $settings = [$app => $settings[$app]];
+            } else {
+                $settings = [];
+            }
+        }
 
-		$user = $this->userManager->get($uid);
-		if ($user !== null) {
-			// Only add the display name if the user exists
-			$settings['settings']['display_name'] = $user->getDisplayName();
-		}
+        $user = $this->userManager->get($uid);
+        if ($user !== null) {
+            // Only add the display name if the user exists
+            $settings['settings']['display_name'] = $user->getDisplayName();
+        }
 
-		return $settings;
-	}
+        return $settings;
+    }
 
-	/**
-	 * @param string $argumentName
-	 * @param CompletionContext $context
-	 * @return string[]
-	 */
-	public function completeArgumentValues($argumentName, CompletionContext $context) {
-		if ($argumentName === 'uid') {
-			return array_map(static fn (IUser $user) => $user->getUID(), $this->userManager->search($context->getCurrentWord()));
-		}
-		if ($argumentName === 'app') {
-			$userId = $context->getWordAtIndex($context->getWordIndex() - 1);
-			$settings = $this->getUserSettings($userId, '');
-			return array_keys($settings);
-		}
-		if ($argumentName === 'key') {
-			$userId = $context->getWordAtIndex($context->getWordIndex() - 2);
-			$app = $context->getWordAtIndex($context->getWordIndex() - 1);
-			$settings = $this->getUserSettings($userId, $app);
-			return array_keys($settings[$app]);
-		}
-		return [];
-	}
+    /**
+     * @param string $argumentName
+     * @param CompletionContext $context
+     * @return string[]
+     */
+    public function completeArgumentValues($argumentName, CompletionContext $context) {
+        if ($argumentName === 'uid') {
+            return array_map(static fn (IUser $user) => $user->getUID(), $this->userManager->search($context->getCurrentWord()));
+        }
+        if ($argumentName === 'app') {
+            $userId = $context->getWordAtIndex($context->getWordIndex() - 1);
+            $settings = $this->getUserSettings($userId, '');
+            return array_keys($settings);
+        }
+        if ($argumentName === 'key') {
+            $userId = $context->getWordAtIndex($context->getWordIndex() - 2);
+            $app = $context->getWordAtIndex($context->getWordIndex() - 1);
+            $settings = $this->getUserSettings($userId, $app);
+            return array_keys($settings[$app]);
+        }
+        return [];
+    }
 }

lib/private/AppFramework/OCS/V1Response.php

Spacing +2 added lines, -2 removed lines

@@ -69,8 +69,8 @@
 			'status' => $this->getOCSStatus() === 100 ? 'ok' : 'failure',
 			'statuscode' => $this->getOCSStatus(),
 			'message' => $this->getOCSStatus() === 100 ? 'OK' : $this->statusMessage ?? '',
-			'totalitems' => (string)($this->itemsCount ?? ''),
-			'itemsperpage' => (string)($this->itemsPerPage ?? ''),
+			'totalitems' => (string) ($this->itemsCount ?? ''),
+			'itemsperpage' => (string) ($this->itemsPerPage ?? ''),
 		];
 
 		return $this->renderResult($meta);

Indentation +41 added lines, -41 removed lines

@@ -17,51 +17,51 @@
  * @template-extends BaseResponse<Http::STATUS_*, DataResponseType, array<string, mixed>>
  */
 class V1Response extends BaseResponse {
-	/**
-	 * The V1 endpoint has very limited http status codes basically everything
-	 * is status 200 except 401
-	 *
-	 * @return Http::STATUS_*
-	 */
-	public function getStatus() {
-		$status = parent::getStatus();
-		if ($status === OCSController::RESPOND_UNAUTHORISED) {
-			return Http::STATUS_UNAUTHORIZED;
-		}
+    /**
+     * The V1 endpoint has very limited http status codes basically everything
+     * is status 200 except 401
+     *
+     * @return Http::STATUS_*
+     */
+    public function getStatus() {
+        $status = parent::getStatus();
+        if ($status === OCSController::RESPOND_UNAUTHORISED) {
+            return Http::STATUS_UNAUTHORIZED;
+        }
 
-		return Http::STATUS_OK;
-	}
+        return Http::STATUS_OK;
+    }
 
-	/**
-	 * In v1 all OK is 100
-	 *
-	 * @return int
-	 */
-	public function getOCSStatus() {
-		$status = parent::getOCSStatus();
+    /**
+     * In v1 all OK is 100
+     *
+     * @return int
+     */
+    public function getOCSStatus() {
+        $status = parent::getOCSStatus();
 
-		if ($status === Http::STATUS_OK) {
-			return 100;
-		}
+        if ($status === Http::STATUS_OK) {
+            return 100;
+        }
 
-		return $status;
-	}
+        return $status;
+    }
 
-	/**
-	 * Construct the meta part of the response
-	 * And then late the base class render
-	 *
-	 * @return string
-	 */
-	public function render() {
-		$meta = [
-			'status' => $this->getOCSStatus() === 100 ? 'ok' : 'failure',
-			'statuscode' => $this->getOCSStatus(),
-			'message' => $this->getOCSStatus() === 100 ? 'OK' : $this->statusMessage ?? '',
-			'totalitems' => (string)($this->itemsCount ?? ''),
-			'itemsperpage' => (string)($this->itemsPerPage ?? ''),
-		];
+    /**
+     * Construct the meta part of the response
+     * And then late the base class render
+     *
+     * @return string
+     */
+    public function render() {
+        $meta = [
+            'status' => $this->getOCSStatus() === 100 ? 'ok' : 'failure',
+            'statuscode' => $this->getOCSStatus(),
+            'message' => $this->getOCSStatus() === 100 ? 'OK' : $this->statusMessage ?? '',
+            'totalitems' => (string)($this->itemsCount ?? ''),
+            'itemsperpage' => (string)($this->itemsPerPage ?? ''),
+        ];
 
-		return $this->renderResult($meta);
-	}
+        return $this->renderResult($meta);
+    }
 }

lib/private/KnownUser/KnownUser.php

Indentation +8 added lines, -8 removed lines

@@ -34,14 +34,14 @@
  * @method string getKnownUser()
  */
 class KnownUser extends Entity {
-	/** @var string */
-	protected $knownTo;
+    /** @var string */
+    protected $knownTo;
 
-	/** @var string */
-	protected $knownUser;
+    /** @var string */
+    protected $knownUser;
 
-	public function __construct() {
-		$this->addType('knownTo', 'string');
-		$this->addType('knownUser', 'string');
-	}
+    public function __construct() {
+        $this->addType('knownTo', 'string');
+        $this->addType('knownUser', 'string');
+    }
 }

lib/private/AppFramework/Middleware/OCSMiddleware.php

Indentation +116 added lines, -116 removed lines

@@ -39,123 +39,123 @@
 use OCP\IRequest;
 
 class OCSMiddleware extends Middleware {
-	/** @var IRequest */
-	private $request;
-
-	/** @var int */
-	private $ocsVersion;
-
-	/**
-	 * @param IRequest $request
-	 */
-	public function __construct(IRequest $request) {
-		$this->request = $request;
-	}
-
-	/**
-	 * @param Controller $controller
-	 * @param string $methodName
-	 */
-	public function beforeController($controller, $methodName) {
-		if ($controller instanceof OCSController) {
-			if (substr_compare($this->request->getScriptName(), '/ocs/v2.php', -strlen('/ocs/v2.php')) === 0) {
-				$this->ocsVersion = 2;
-			} else {
-				$this->ocsVersion = 1;
-			}
-			$controller->setOCSVersion($this->ocsVersion);
-		}
-	}
-
-	/**
-	 * @param Controller $controller
-	 * @param string $methodName
-	 * @param \Exception $exception
-	 * @throws \Exception
-	 * @return BaseResponse
-	 */
-	public function afterException($controller, $methodName, \Exception $exception) {
-		if ($controller instanceof OCSController && $exception instanceof OCSException) {
-			$code = $exception->getCode();
-			if ($code === 0) {
-				$code = \OCP\AppFramework\OCSController::RESPOND_UNKNOWN_ERROR;
-			}
-
-			return $this->buildNewResponse($controller, $code, $exception->getMessage());
-		}
-
-		throw $exception;
-	}
-
-	/**
-	 * @param Controller $controller
-	 * @param string $methodName
-	 * @param Response $response
-	 * @return \OCP\AppFramework\Http\Response
-	 */
-	public function afterController($controller, $methodName, Response $response) {
-		/*
+    /** @var IRequest */
+    private $request;
+
+    /** @var int */
+    private $ocsVersion;
+
+    /**
+     * @param IRequest $request
+     */
+    public function __construct(IRequest $request) {
+        $this->request = $request;
+    }
+
+    /**
+     * @param Controller $controller
+     * @param string $methodName
+     */
+    public function beforeController($controller, $methodName) {
+        if ($controller instanceof OCSController) {
+            if (substr_compare($this->request->getScriptName(), '/ocs/v2.php', -strlen('/ocs/v2.php')) === 0) {
+                $this->ocsVersion = 2;
+            } else {
+                $this->ocsVersion = 1;
+            }
+            $controller->setOCSVersion($this->ocsVersion);
+        }
+    }
+
+    /**
+     * @param Controller $controller
+     * @param string $methodName
+     * @param \Exception $exception
+     * @throws \Exception
+     * @return BaseResponse
+     */
+    public function afterException($controller, $methodName, \Exception $exception) {
+        if ($controller instanceof OCSController && $exception instanceof OCSException) {
+            $code = $exception->getCode();
+            if ($code === 0) {
+                $code = \OCP\AppFramework\OCSController::RESPOND_UNKNOWN_ERROR;
+            }
+
+            return $this->buildNewResponse($controller, $code, $exception->getMessage());
+        }
+
+        throw $exception;
+    }
+
+    /**
+     * @param Controller $controller
+     * @param string $methodName
+     * @param Response $response
+     * @return \OCP\AppFramework\Http\Response
+     */
+    public function afterController($controller, $methodName, Response $response) {
+        /*
 		 * If a different middleware has detected that a request unauthorized or forbidden
 		 * we need to catch the response and convert it to a proper OCS response.
 		 */
-		if ($controller instanceof OCSController && !($response instanceof BaseResponse)) {
-			if ($response->getStatus() === Http::STATUS_UNAUTHORIZED) {
-				$message = '';
-				if ($response instanceof JSONResponse) {
-					/** @var DataResponse $response */
-					$message = $response->getData()['message'];
-				}
-
-				return $this->buildNewResponse($controller, OCSController::RESPOND_UNAUTHORISED, $message);
-			}
-			if ($response->getStatus() === Http::STATUS_FORBIDDEN) {
-				$message = '';
-				if ($response instanceof JSONResponse) {
-					/** @var DataResponse $response */
-					$message = $response->getData()['message'];
-				}
-
-				return $this->buildNewResponse($controller, Http::STATUS_FORBIDDEN, $message);
-			}
-		}
-
-		return $response;
-	}
-
-	/**
-	 * @param Controller $controller
-	 * @param int $code
-	 * @param string $message
-	 * @return V1Response|V2Response
-	 */
-	private function buildNewResponse(Controller $controller, $code, $message) {
-		$format = $this->getFormat($controller);
-
-		$data = new DataResponse();
-		$data->setStatus($code);
-		if ($this->ocsVersion === 1) {
-			$response = new V1Response($data, $format, $message);
-		} else {
-			$response = new V2Response($data, $format, $message);
-		}
-
-		return $response;
-	}
-
-	/**
-	 * @param Controller $controller
-	 * @return string
-	 */
-	private function getFormat(Controller $controller) {
-		// get format from the url format or request format parameter
-		$format = $this->request->getParam('format');
-
-		// if none is given try the first Accept header
-		if ($format === null) {
-			$headers = $this->request->getHeader('Accept');
-			$format = $controller->getResponderByHTTPHeader($headers, 'xml');
-		}
-
-		return $format;
-	}
+        if ($controller instanceof OCSController && !($response instanceof BaseResponse)) {
+            if ($response->getStatus() === Http::STATUS_UNAUTHORIZED) {
+                $message = '';
+                if ($response instanceof JSONResponse) {
+                    /** @var DataResponse $response */
+                    $message = $response->getData()['message'];
+                }
+
+                return $this->buildNewResponse($controller, OCSController::RESPOND_UNAUTHORISED, $message);
+            }
+            if ($response->getStatus() === Http::STATUS_FORBIDDEN) {
+                $message = '';
+                if ($response instanceof JSONResponse) {
+                    /** @var DataResponse $response */
+                    $message = $response->getData()['message'];
+                }
+
+                return $this->buildNewResponse($controller, Http::STATUS_FORBIDDEN, $message);
+            }
+        }
+
+        return $response;
+    }
+
+    /**
+     * @param Controller $controller
+     * @param int $code
+     * @param string $message
+     * @return V1Response|V2Response
+     */
+    private function buildNewResponse(Controller $controller, $code, $message) {
+        $format = $this->getFormat($controller);
+
+        $data = new DataResponse();
+        $data->setStatus($code);
+        if ($this->ocsVersion === 1) {
+            $response = new V1Response($data, $format, $message);
+        } else {
+            $response = new V2Response($data, $format, $message);
+        }
+
+        return $response;
+    }
+
+    /**
+     * @param Controller $controller
+     * @return string
+     */
+    private function getFormat(Controller $controller) {
+        // get format from the url format or request format parameter
+        $format = $this->request->getParam('format');
+
+        // if none is given try the first Accept header
+        if ($format === null) {
+            $headers = $this->request->getHeader('Accept');
+            $format = $controller->getResponderByHTTPHeader($headers, 'xml');
+        }
+
+        return $format;
+    }
 }

lib/private/AppFramework/Bootstrap/BootContext.php

Indentation +14 added lines, -14 removed lines

@@ -31,22 +31,22 @@
 use OCP\IServerContainer;
 
 class BootContext implements IBootContext {
-	/** @var IAppContainer */
-	private $appContainer;
+    /** @var IAppContainer */
+    private $appContainer;
 
-	public function __construct(IAppContainer $appContainer) {
-		$this->appContainer = $appContainer;
-	}
+    public function __construct(IAppContainer $appContainer) {
+        $this->appContainer = $appContainer;
+    }
 
-	public function getAppContainer(): IAppContainer {
-		return $this->appContainer;
-	}
+    public function getAppContainer(): IAppContainer {
+        return $this->appContainer;
+    }
 
-	public function getServerContainer(): IServerContainer {
-		return $this->appContainer->get(IServerContainer::class);
-	}
+    public function getServerContainer(): IServerContainer {
+        return $this->appContainer->get(IServerContainer::class);
+    }
 
-	public function injectFn(callable $fn) {
-		return (new FunctionInjector($this->appContainer))->injectFn($fn);
-	}
+    public function injectFn(callable $fn) {
+        return (new FunctionInjector($this->appContainer))->injectFn($fn);
+    }
 }