nextcloud / server

lib/private/Files/Cache/Wrapper/CachePermissionsMask.php

Indentation +19 added lines, -19 removed lines

@@ -24,25 +24,25 @@
 namespace OC\Files\Cache\Wrapper;
 
 class CachePermissionsMask extends CacheWrapper {
-	/**
-	 * @var int
-	 */
-	protected $mask;
+    /**
+     * @var int
+     */
+    protected $mask;
 
-	/**
-	 * @param \OCP\Files\Cache\ICache $cache
-	 * @param int $mask
-	 */
-	public function __construct($cache, $mask) {
-		parent::__construct($cache);
-		$this->mask = $mask;
-	}
+    /**
+     * @param \OCP\Files\Cache\ICache $cache
+     * @param int $mask
+     */
+    public function __construct($cache, $mask) {
+        parent::__construct($cache);
+        $this->mask = $mask;
+    }
 
-	protected function formatCacheEntry($entry) {
-		if (isset($entry['permissions'])) {
-			$entry['scan_permissions'] = $entry['permissions'];
-			$entry['permissions'] &= $this->mask;
-		}
-		return $entry;
-	}
+    protected function formatCacheEntry($entry) {
+        if (isset($entry['permissions'])) {
+            $entry['scan_permissions'] = $entry['permissions'];
+            $entry['permissions'] &= $this->mask;
+        }
+        return $entry;
+    }
 }

apps/oauth2/lib/Db/ClientMapper.php

Indentation +54 added lines, -54 removed lines

@@ -28,62 +28,62 @@
 
 class ClientMapper extends Mapper {
 
-	/**
-	 * @param IDBConnection $db
-	 */
-	public function __construct(IDBConnection $db) {
-		parent::__construct($db, 'oauth2_clients');
-	}
+    /**
+     * @param IDBConnection $db
+     */
+    public function __construct(IDBConnection $db) {
+        parent::__construct($db, 'oauth2_clients');
+    }
 
-	/**
-	 * @param string $clientIdentifier
-	 * @return Client
-	 * @throws ClientNotFoundException
-	 */
-	public function getByIdentifier($clientIdentifier) {
-		$qb = $this->db->getQueryBuilder();
-		$qb
-			->select('*')
-			->from($this->tableName)
-			->where($qb->expr()->eq('client_identifier', $qb->createNamedParameter($clientIdentifier)));
-		$result = $qb->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-		if($row === false) {
-			throw new ClientNotFoundException();
-		}
-		return Client::fromRow($row);
-	}
+    /**
+     * @param string $clientIdentifier
+     * @return Client
+     * @throws ClientNotFoundException
+     */
+    public function getByIdentifier($clientIdentifier) {
+        $qb = $this->db->getQueryBuilder();
+        $qb
+            ->select('*')
+            ->from($this->tableName)
+            ->where($qb->expr()->eq('client_identifier', $qb->createNamedParameter($clientIdentifier)));
+        $result = $qb->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+        if($row === false) {
+            throw new ClientNotFoundException();
+        }
+        return Client::fromRow($row);
+    }
 
-	/**
-	 * @param string $uid internal uid of the client
-	 * @return Client
-	 * @throws ClientNotFoundException
-	 */
-	public function getByUid($uid) {
-		$qb = $this->db->getQueryBuilder();
-		$qb
-			->select('*')
-			->from($this->tableName)
-			->where($qb->expr()->eq('id', $qb->createNamedParameter($uid, IQueryBuilder::PARAM_INT)));
-		$result = $qb->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-		if($row === false) {
-			throw new ClientNotFoundException();
-		}
-		return Client::fromRow($row);
-	}
+    /**
+     * @param string $uid internal uid of the client
+     * @return Client
+     * @throws ClientNotFoundException
+     */
+    public function getByUid($uid) {
+        $qb = $this->db->getQueryBuilder();
+        $qb
+            ->select('*')
+            ->from($this->tableName)
+            ->where($qb->expr()->eq('id', $qb->createNamedParameter($uid, IQueryBuilder::PARAM_INT)));
+        $result = $qb->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+        if($row === false) {
+            throw new ClientNotFoundException();
+        }
+        return Client::fromRow($row);
+    }
 
-	/**
-	 * @return Client[]
-	 */
-	public function getClients() {
-		$qb = $this->db->getQueryBuilder();
-		$qb
-			->select('*')
-			->from($this->tableName);
+    /**
+     * @return Client[]
+     */
+    public function getClients() {
+        $qb = $this->db->getQueryBuilder();
+        $qb
+            ->select('*')
+            ->from($this->tableName);
 
-		return $this->findEntities($qb->getSQL());
-	}
+        return $this->findEntities($qb->getSQL());
+    }
 }

apps/oauth2/lib/Db/AccessTokenMapper.php

Indentation +37 added lines, -37 removed lines

@@ -28,43 +28,43 @@
 
 class AccessTokenMapper extends Mapper {
 
-	/**
-	 * @param IDBConnection $db
-	 */
-	public function __construct(IDBConnection $db) {
-		parent::__construct($db, 'oauth2_access_tokens');
-	}
+    /**
+     * @param IDBConnection $db
+     */
+    public function __construct(IDBConnection $db) {
+        parent::__construct($db, 'oauth2_access_tokens');
+    }
 
-	/**
-	 * @param string $code
-	 * @return AccessToken
-	 * @throws AccessTokenNotFoundException
-	 */
-	public function getByCode($code) {
-		$qb = $this->db->getQueryBuilder();
-		$qb
-			->select('*')
-			->from($this->tableName)
-			->where($qb->expr()->eq('hashed_code', $qb->createNamedParameter(hash('sha512', $code))));
-		$result = $qb->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-		if($row === false) {
-			throw new AccessTokenNotFoundException();
-		}
-		return AccessToken::fromRow($row);
-	}
+    /**
+     * @param string $code
+     * @return AccessToken
+     * @throws AccessTokenNotFoundException
+     */
+    public function getByCode($code) {
+        $qb = $this->db->getQueryBuilder();
+        $qb
+            ->select('*')
+            ->from($this->tableName)
+            ->where($qb->expr()->eq('hashed_code', $qb->createNamedParameter(hash('sha512', $code))));
+        $result = $qb->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+        if($row === false) {
+            throw new AccessTokenNotFoundException();
+        }
+        return AccessToken::fromRow($row);
+    }
 
-	/**
-	 * delete all access token from a given client
-	 *
-	 * @param int $id
-	 */
-	public function deleteByClientId($id) {
-		$qb = $this->db->getQueryBuilder();
-		$qb
-			->delete($this->tableName)
-			->where($qb->expr()->eq('client_id', $qb->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
-		$qb->execute();
-	}
+    /**
+     * delete all access token from a given client
+     *
+     * @param int $id
+     */
+    public function deleteByClientId($id) {
+        $qb = $this->db->getQueryBuilder();
+        $qb
+            ->delete($this->tableName)
+            ->where($qb->expr()->eq('client_id', $qb->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
+        $qb->execute();
+    }
 }

lib/private/Settings/Personal/Additional.php

Indentation +25 added lines, -25 removed lines

@@ -29,31 +29,31 @@
 
 class Additional implements ISettings {
 
-	/**
-	 * @return TemplateResponse returns the instance with all parameters set, ready to be rendered
-	 * @since 9.1
-	 */
-	public function getForm() {
-		return new TemplateResponse('settings', 'settings/empty');
-	}
+    /**
+     * @return TemplateResponse returns the instance with all parameters set, ready to be rendered
+     * @since 9.1
+     */
+    public function getForm() {
+        return new TemplateResponse('settings', 'settings/empty');
+    }
 
-	/**
-	 * @return string the section ID, e.g. 'sharing'
-	 * @since 9.1
-	 */
-	public function getSection() {
-		return 'additional';
-	}
+    /**
+     * @return string the section ID, e.g. 'sharing'
+     * @since 9.1
+     */
+    public function getSection() {
+        return 'additional';
+    }
 
-	/**
-	 * @return int whether the form should be rather on the top or bottom of
-	 * the admin section. The forms are arranged in ascending order of the
-	 * priority values. It is required to return a value between 0 and 100.
-	 *
-	 * E.g.: 70
-	 * @since 9.1
-	 */
-	public function getPriority() {
-		return '5';
-	}
+    /**
+     * @return int whether the form should be rather on the top or bottom of
+     * the admin section. The forms are arranged in ascending order of the
+     * priority values. It is required to return a value between 0 and 100.
+     *
+     * E.g.: 70
+     * @since 9.1
+     */
+    public function getPriority() {
+        return '5';
+    }
 }

lib/private/ServerContainer.php

Indentation +86 added lines, -86 removed lines

@@ -34,101 +34,101 @@
  * @package OC
  */
 class ServerContainer extends SimpleContainer {
-	/** @var DIContainer[] */
-	protected $appContainers;
+    /** @var DIContainer[] */
+    protected $appContainers;
 
-	/** @var string[] */
-	protected $hasNoAppContainer;
+    /** @var string[] */
+    protected $hasNoAppContainer;
 
-	/** @var string[] */
-	protected $namespaces;
+    /** @var string[] */
+    protected $namespaces;
 
-	/**
-	 * ServerContainer constructor.
-	 */
-	public function __construct() {
-		parent::__construct();
-		$this->appContainers = [];
-		$this->namespaces = [];
-		$this->hasNoAppContainer = [];
-	}
+    /**
+     * ServerContainer constructor.
+     */
+    public function __construct() {
+        parent::__construct();
+        $this->appContainers = [];
+        $this->namespaces = [];
+        $this->hasNoAppContainer = [];
+    }
 
-	/**
-	 * @param string $appName
-	 * @param string $appNamespace
-	 */
-	public function registerNamespace($appName, $appNamespace) {
-		// Cut of OCA\ and lowercase
-		$appNamespace = strtolower(substr($appNamespace, strrpos($appNamespace, '\\') + 1));
-		$this->namespaces[$appNamespace] = $appName;
-	}
+    /**
+     * @param string $appName
+     * @param string $appNamespace
+     */
+    public function registerNamespace($appName, $appNamespace) {
+        // Cut of OCA\ and lowercase
+        $appNamespace = strtolower(substr($appNamespace, strrpos($appNamespace, '\\') + 1));
+        $this->namespaces[$appNamespace] = $appName;
+    }
 
-	/**
-	 * @param string $appName
-	 * @param DIContainer $container
-	 */
-	public function registerAppContainer($appName, DIContainer $container) {
-		$this->appContainers[strtolower(App::buildAppNamespace($appName, ''))] = $container;
-	}
+    /**
+     * @param string $appName
+     * @param DIContainer $container
+     */
+    public function registerAppContainer($appName, DIContainer $container) {
+        $this->appContainers[strtolower(App::buildAppNamespace($appName, ''))] = $container;
+    }
 
-	/**
-	 * @param string $namespace
-	 * @param string $sensitiveNamespace
-	 * @return DIContainer
-	 * @throws QueryException
-	 */
-	protected function getAppContainer($namespace, $sensitiveNamespace) {
-		if (isset($this->appContainers[$namespace])) {
-			return $this->appContainers[$namespace];
-		}
+    /**
+     * @param string $namespace
+     * @param string $sensitiveNamespace
+     * @return DIContainer
+     * @throws QueryException
+     */
+    protected function getAppContainer($namespace, $sensitiveNamespace) {
+        if (isset($this->appContainers[$namespace])) {
+            return $this->appContainers[$namespace];
+        }
 
-		if (isset($this->namespaces[$namespace])) {
-			if (!isset($this->hasNoAppContainer[$namespace])) {
-				$applicationClassName = 'OCA\\' . $sensitiveNamespace . '\\AppInfo\\Application';
-				if (class_exists($applicationClassName)) {
-					new $applicationClassName();
-					if (isset($this->appContainers[$namespace])) {
-						return $this->appContainers[$namespace];
-					}
-				}
-				$this->hasNoAppContainer[$namespace] = true;
-			}
+        if (isset($this->namespaces[$namespace])) {
+            if (!isset($this->hasNoAppContainer[$namespace])) {
+                $applicationClassName = 'OCA\\' . $sensitiveNamespace . '\\AppInfo\\Application';
+                if (class_exists($applicationClassName)) {
+                    new $applicationClassName();
+                    if (isset($this->appContainers[$namespace])) {
+                        return $this->appContainers[$namespace];
+                    }
+                }
+                $this->hasNoAppContainer[$namespace] = true;
+            }
 
-			return new DIContainer($this->namespaces[$namespace]);
-		}
-		throw new QueryException();
-	}
+            return new DIContainer($this->namespaces[$namespace]);
+        }
+        throw new QueryException();
+    }
 
-	/**
-	 * @param string $name name of the service to query for
-	 * @return mixed registered service for the given $name
-	 * @throws QueryException if the query could not be resolved
-	 */
-	public function query($name) {
-		$name = $this->sanitizeName($name);
+    /**
+     * @param string $name name of the service to query for
+     * @return mixed registered service for the given $name
+     * @throws QueryException if the query could not be resolved
+     */
+    public function query($name) {
+        $name = $this->sanitizeName($name);
 
-		// In case the service starts with OCA\ we try to find the service in
-		// the apps container first.
-		if (strpos($name, 'OCA\\') === 0 && substr_count($name, '\\') >= 2) {
-			$segments = explode('\\', $name);
-			try {
-				$appContainer = $this->getAppContainer(strtolower($segments[1]), $segments[1]);
-				return $appContainer->queryNoFallback($name);
-			} catch (QueryException $e) {
-				// Didn't find the service or the respective app container,
-				// ignore it and fall back to the core container.
-			}
-		} else if (strpos($name, 'OC\\Settings\\') === 0 && substr_count($name, '\\') >= 3) {
-			$segments = explode('\\', $name);
-			try {
-				$appContainer = $this->getAppContainer(strtolower($segments[1]), $segments[1]);
-				return $appContainer->queryNoFallback($name);
-			} catch (QueryException $e) {
-				// Didn't find the service or the respective app container,
-				// ignore it and fall back to the core container.
-			}
-		}
+        // In case the service starts with OCA\ we try to find the service in
+        // the apps container first.
+        if (strpos($name, 'OCA\\') === 0 && substr_count($name, '\\') >= 2) {
+            $segments = explode('\\', $name);
+            try {
+                $appContainer = $this->getAppContainer(strtolower($segments[1]), $segments[1]);
+                return $appContainer->queryNoFallback($name);
+            } catch (QueryException $e) {
+                // Didn't find the service or the respective app container,
+                // ignore it and fall back to the core container.
+            }
+        } else if (strpos($name, 'OC\\Settings\\') === 0 && substr_count($name, '\\') >= 3) {
+            $segments = explode('\\', $name);
+            try {
+                $appContainer = $this->getAppContainer(strtolower($segments[1]), $segments[1]);
+                return $appContainer->queryNoFallback($name);
+            } catch (QueryException $e) {
+                // Didn't find the service or the respective app container,
+                // ignore it and fall back to the core container.
+            }
+        }
 
-		return parent::query($name);
-	}
+        return parent::query($name);
+    }
 }

lib/private/GlobalScale/Config.php

Indentation +35 added lines, -35 removed lines

@@ -27,45 +27,45 @@
 
 class Config implements \OCP\GlobalScale\IConfig {
 
-	/** @var IConfig */
-	private $config;
+    /** @var IConfig */
+    private $config;
 
-	/**
-	 * Config constructor.
-	 *
-	 * @param IConfig $config
-	 */
-	public function __construct(IConfig $config) {
-		$this->config = $config;
-	}
+    /**
+     * Config constructor.
+     *
+     * @param IConfig $config
+     */
+    public function __construct(IConfig $config) {
+        $this->config = $config;
+    }
 
-	/**
-	 * check if global scale is enabled
-	 *
-	 * @since 12.0.1
-	 * @return bool
-	 */
-	public function isGlobalScaleEnabled() {
-		$enabled = $this->config->getSystemValue('gs.enabled', false);
-		return $enabled !== false;
-	}
+    /**
+     * check if global scale is enabled
+     *
+     * @since 12.0.1
+     * @return bool
+     */
+    public function isGlobalScaleEnabled() {
+        $enabled = $this->config->getSystemValue('gs.enabled', false);
+        return $enabled !== false;
+    }
 
-	/**
-	 * check if federation should only be used internally in a global scale setup
-	 *
-	 * @since 12.0.1
-	 * @return bool
-	 */
-	public function onlyInternalFederation() {
-		// if global scale is disabled federation works always globally
-		$gsEnabled = $this->isGlobalScaleEnabled();
-		if ($gsEnabled === false) {
-			return false;
-		}
+    /**
+     * check if federation should only be used internally in a global scale setup
+     *
+     * @since 12.0.1
+     * @return bool
+     */
+    public function onlyInternalFederation() {
+        // if global scale is disabled federation works always globally
+        $gsEnabled = $this->isGlobalScaleEnabled();
+        if ($gsEnabled === false) {
+            return false;
+        }
 
-		$enabled = $this->config->getSystemValue('gs.federation', 'internal');
+        $enabled = $this->config->getSystemValue('gs.federation', 'internal');
 
-		return $enabled === 'internal';
-	}
+        return $enabled === 'internal';
+    }
 
 }

lib/public/GlobalScale/IConfig.php

Indentation +14 added lines, -14 removed lines

@@ -32,20 +32,20 @@
  */
 interface IConfig {
 
-	/**
-	 * check if global scale is enabled
-	 *
-	 * @since 12.0.1
-	 * @return bool
-	 */
-	public function isGlobalScaleEnabled();
+    /**
+     * check if global scale is enabled
+     *
+     * @since 12.0.1
+     * @return bool
+     */
+    public function isGlobalScaleEnabled();
 
-	/**
-	 * check if federation should only be used internally in a global scale setup
-	 *
-	 * @since 12.0.1
-	 * @return bool
-	 */
-	public function onlyInternalFederation();
+    /**
+     * check if federation should only be used internally in a global scale setup
+     *
+     * @since 12.0.1
+     * @return bool
+     */
+    public function onlyInternalFederation();
 
 }

lib/public/Encryption/IEncryptionModule.php

Indentation +156 added lines, -156 removed lines

@@ -35,161 +35,161 @@
  */
 interface IEncryptionModule {
 
-	/**
-	 * @return string defining the technical unique id
-	 * @since 8.1.0
-	 */
-	public function getId();
-
-	/**
-	 * In comparison to getKey() this function returns a human readable (maybe translated) name
-	 *
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function getDisplayName();
-
-	/**
-	 * start receiving chunks from a file. This is the place where you can
-	 * perform some initial step before starting encrypting/decrypting the
-	 * chunks
-	 *
-	 * @param string $path to the file
-	 * @param string $user who read/write the file (null for public access)
-	 * @param string $mode php stream open mode
-	 * @param array $header contains the header data read from the file
-	 * @param array $accessList who has access to the file contains the key 'users' and 'public'
-	 *
-	 * $return array $header contain data as key-value pairs which should be
-	 *                       written to the header, in case of a write operation
-	 *                       or if no additional data is needed return a empty array
-	 * @since 8.1.0
-	 */
-	public function begin($path, $user, $mode, array $header, array $accessList);
-
-	/**
-	 * last chunk received. This is the place where you can perform some final
-	 * operation and return some remaining data if something is left in your
-	 * buffer.
-	 *
-	 * @param string $path to the file
-	 * @param string $position id of the last block (looks like "<Number>end")
-	 *
-	 * @return string remained data which should be written to the file in case
-	 *                of a write operation
-	 *
-	 * @since 8.1.0
-	 * @since 9.0.0 parameter $position added
-	 */
-	public function end($path, $position);
-
-	/**
-	 * encrypt data
-	 *
-	 * @param string $data you want to encrypt
-	 * @param string $position position of the block we want to encrypt (starts with '0')
-	 *
-	 * @return mixed encrypted data
-	 *
-	 * @since 8.1.0
-	 * @since 9.0.0 parameter $position added
-	 */
-	public function encrypt($data, $position);
-
-	/**
-	 * decrypt data
-	 *
-	 * @param string $data you want to decrypt
-	 * @param string $position position of the block we want to decrypt
-	 *
-	 * @return mixed decrypted data
-	 *
-	 * @since 8.1.0
-	 * @since 9.0.0 parameter $position added
-	 */
-	public function decrypt($data, $position);
-
-	/**
-	 * update encrypted file, e.g. give additional users access to the file
-	 *
-	 * @param string $path path to the file which should be updated
-	 * @param string $uid of the user who performs the operation
-	 * @param array $accessList who has access to the file contains the key 'users' and 'public'
-	 * @return boolean
-	 * @since 8.1.0
-	 */
-	public function update($path, $uid, array $accessList);
-
-	/**
-	 * should the file be encrypted or not
-	 *
-	 * @param string $path
-	 * @return boolean
-	 * @since 8.1.0
-	 */
-	public function shouldEncrypt($path);
-
-	/**
-	 * get size of the unencrypted payload per block.
-	 * ownCloud read/write files with a block size of 8192 byte
-	 *
-	 * @param bool $signed
-	 * @return int
-	 * @since 8.1.0 optional parameter $signed was added in 9.0.0
-	 */
-	public function getUnencryptedBlockSize($signed = false);
-
-	/**
-	 * check if the encryption module is able to read the file,
-	 * e.g. if all encryption keys exists
-	 *
-	 * @param string $path
-	 * @param string $uid user for whom we want to check if he can read the file
-	 * @return boolean
-	 * @since 8.1.0
-	 */
-	public function isReadable($path, $uid);
-
-	/**
-	 * Initial encryption of all files
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output write some status information to the terminal during encryption
-	 * @since 8.2.0
-	 */
-	public function encryptAll(InputInterface $input, OutputInterface $output);
-
-	/**
-	 * prepare encryption module to decrypt all files
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output write some status information to the terminal during encryption
-	 * @param $user (optional) for which the files should be decrypted, default = all users
-	 * @return bool return false on failure or if it isn't supported by the module
-	 * @since 8.2.0
-	 */
-	public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = '');
-
-	/**
-	 * Check if the module is ready to be used by that specific user.
-	 * In case a module is not ready - because e.g. key pairs have not been generated
-	 * upon login this method can return false before any operation starts and might
-	 * cause issues during operations.
-	 *
-	 * @param string $user
-	 * @return boolean
-	 * @since 9.1.0
-	 */
-	public function isReadyForUser($user);
-
-	/**
-	 * Does the encryption module needs a detailed list of users with access to the file?
-	 * For example if the encryption module uses per-user encryption keys and needs to know
-	 * the users with access to the file to encrypt/decrypt it.
-	 *
-	 * @since 13.0.0
-	 * @return bool
-	 */
-	public function needDetailedAccessList();
+    /**
+     * @return string defining the technical unique id
+     * @since 8.1.0
+     */
+    public function getId();
+
+    /**
+     * In comparison to getKey() this function returns a human readable (maybe translated) name
+     *
+     * @return string
+     * @since 8.1.0
+     */
+    public function getDisplayName();
+
+    /**
+     * start receiving chunks from a file. This is the place where you can
+     * perform some initial step before starting encrypting/decrypting the
+     * chunks
+     *
+     * @param string $path to the file
+     * @param string $user who read/write the file (null for public access)
+     * @param string $mode php stream open mode
+     * @param array $header contains the header data read from the file
+     * @param array $accessList who has access to the file contains the key 'users' and 'public'
+     *
+     * $return array $header contain data as key-value pairs which should be
+     *                       written to the header, in case of a write operation
+     *                       or if no additional data is needed return a empty array
+     * @since 8.1.0
+     */
+    public function begin($path, $user, $mode, array $header, array $accessList);
+
+    /**
+     * last chunk received. This is the place where you can perform some final
+     * operation and return some remaining data if something is left in your
+     * buffer.
+     *
+     * @param string $path to the file
+     * @param string $position id of the last block (looks like "<Number>end")
+     *
+     * @return string remained data which should be written to the file in case
+     *                of a write operation
+     *
+     * @since 8.1.0
+     * @since 9.0.0 parameter $position added
+     */
+    public function end($path, $position);
+
+    /**
+     * encrypt data
+     *
+     * @param string $data you want to encrypt
+     * @param string $position position of the block we want to encrypt (starts with '0')
+     *
+     * @return mixed encrypted data
+     *
+     * @since 8.1.0
+     * @since 9.0.0 parameter $position added
+     */
+    public function encrypt($data, $position);
+
+    /**
+     * decrypt data
+     *
+     * @param string $data you want to decrypt
+     * @param string $position position of the block we want to decrypt
+     *
+     * @return mixed decrypted data
+     *
+     * @since 8.1.0
+     * @since 9.0.0 parameter $position added
+     */
+    public function decrypt($data, $position);
+
+    /**
+     * update encrypted file, e.g. give additional users access to the file
+     *
+     * @param string $path path to the file which should be updated
+     * @param string $uid of the user who performs the operation
+     * @param array $accessList who has access to the file contains the key 'users' and 'public'
+     * @return boolean
+     * @since 8.1.0
+     */
+    public function update($path, $uid, array $accessList);
+
+    /**
+     * should the file be encrypted or not
+     *
+     * @param string $path
+     * @return boolean
+     * @since 8.1.0
+     */
+    public function shouldEncrypt($path);
+
+    /**
+     * get size of the unencrypted payload per block.
+     * ownCloud read/write files with a block size of 8192 byte
+     *
+     * @param bool $signed
+     * @return int
+     * @since 8.1.0 optional parameter $signed was added in 9.0.0
+     */
+    public function getUnencryptedBlockSize($signed = false);
+
+    /**
+     * check if the encryption module is able to read the file,
+     * e.g. if all encryption keys exists
+     *
+     * @param string $path
+     * @param string $uid user for whom we want to check if he can read the file
+     * @return boolean
+     * @since 8.1.0
+     */
+    public function isReadable($path, $uid);
+
+    /**
+     * Initial encryption of all files
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output write some status information to the terminal during encryption
+     * @since 8.2.0
+     */
+    public function encryptAll(InputInterface $input, OutputInterface $output);
+
+    /**
+     * prepare encryption module to decrypt all files
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output write some status information to the terminal during encryption
+     * @param $user (optional) for which the files should be decrypted, default = all users
+     * @return bool return false on failure or if it isn't supported by the module
+     * @since 8.2.0
+     */
+    public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = '');
+
+    /**
+     * Check if the module is ready to be used by that specific user.
+     * In case a module is not ready - because e.g. key pairs have not been generated
+     * upon login this method can return false before any operation starts and might
+     * cause issues during operations.
+     *
+     * @param string $user
+     * @return boolean
+     * @since 9.1.0
+     */
+    public function isReadyForUser($user);
+
+    /**
+     * Does the encryption module needs a detailed list of users with access to the file?
+     * For example if the encryption module uses per-user encryption keys and needs to know
+     * the users with access to the file to encrypt/decrypt it.
+     *
+     * @since 13.0.0
+     * @return bool
+     */
+    public function needDetailedAccessList();
 
 }

lib/private/Encryption/Update.php

Indentation +157 added lines, -157 removed lines

@@ -33,162 +33,162 @@
  */
 class Update {
 
-	/** @var \OC\Files\View */
-	protected $view;
-
-	/** @var \OC\Encryption\Util */
-	protected $util;
-
-	 /** @var \OC\Files\Mount\Manager */
-	protected $mountManager;
-
-	/** @var \OC\Encryption\Manager */
-	protected $encryptionManager;
-
-	/** @var string */
-	protected $uid;
-
-	/** @var \OC\Encryption\File */
-	protected $file;
-
-	/**
-	 *
-	 * @param \OC\Files\View $view
-	 * @param \OC\Encryption\Util $util
-	 * @param \OC\Files\Mount\Manager $mountManager
-	 * @param \OC\Encryption\Manager $encryptionManager
-	 * @param \OC\Encryption\File $file
-	 * @param string $uid
-	 */
-	public function __construct(
-			View $view,
-			Util $util,
-			Mount\Manager $mountManager,
-			Manager $encryptionManager,
-			File $file,
-			$uid
-		) {
-
-		$this->view = $view;
-		$this->util = $util;
-		$this->mountManager = $mountManager;
-		$this->encryptionManager = $encryptionManager;
-		$this->file = $file;
-		$this->uid = $uid;
-	}
-
-	/**
-	 * hook after file was shared
-	 *
-	 * @param array $params
-	 */
-	public function postShared($params) {
-		if ($this->encryptionManager->isEnabled()) {
-			if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') {
-				$path = Filesystem::getPath($params['fileSource']);
-				list($owner, $ownerPath) = $this->getOwnerPath($path);
-				$absPath = '/' . $owner . '/files/' . $ownerPath;
-				$this->update($absPath);
-			}
-		}
-	}
-
-	/**
-	 * hook after file was unshared
-	 *
-	 * @param array $params
-	 */
-	public function postUnshared($params) {
-		if ($this->encryptionManager->isEnabled()) {
-			if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') {
-				$path = Filesystem::getPath($params['fileSource']);
-				list($owner, $ownerPath) = $this->getOwnerPath($path);
-				$absPath = '/' . $owner . '/files/' . $ownerPath;
-				$this->update($absPath);
-			}
-		}
-	}
-
-	/**
-	 * inform encryption module that a file was restored from the trash bin,
-	 * e.g. to update the encryption keys
-	 *
-	 * @param array $params
-	 */
-	public function postRestore($params) {
-		if ($this->encryptionManager->isEnabled()) {
-			$path = Filesystem::normalizePath('/' . $this->uid . '/files/' . $params['filePath']);
-			$this->update($path);
-		}
-	}
-
-	/**
-	 * inform encryption module that a file was renamed,
-	 * e.g. to update the encryption keys
-	 *
-	 * @param array $params
-	 */
-	public function postRename($params) {
-		$source = $params['oldpath'];
-		$target = $params['newpath'];
-		if(
-			$this->encryptionManager->isEnabled() &&
-			dirname($source) !== dirname($target)
-		) {
-				list($owner, $ownerPath) = $this->getOwnerPath($target);
-				$absPath = '/' . $owner . '/files/' . $ownerPath;
-				$this->update($absPath);
-		}
-	}
-
-	/**
-	 * get owner and path relative to data/<owner>/files
-	 *
-	 * @param string $path path to file for current user
-	 * @return array ['owner' => $owner, 'path' => $path]
-	 * @throw \InvalidArgumentException
-	 */
-	protected function getOwnerPath($path) {
-		$info = Filesystem::getFileInfo($path);
-		$owner = Filesystem::getOwner($path);
-		$view = new View('/' . $owner . '/files');
-		$path = $view->getPath($info->getId());
-		if ($path === null) {
-			throw new \InvalidArgumentException('No file found for ' . $info->getId());
-		}
-
-		return array($owner, $path);
-	}
-
-	/**
-	 * notify encryption module about added/removed users from a file/folder
-	 *
-	 * @param string $path relative to data/
-	 * @throws Exceptions\ModuleDoesNotExistsException
-	 */
-	public function update($path) {
-
-		$encryptionModule = $this->encryptionManager->getEncryptionModule();
-
-		// if the encryption module doesn't encrypt the files on a per-user basis
-		// we have nothing to do here.
-		if ($encryptionModule->needDetailedAccessList() === false) {
-			return;
-		}
-
-		// if a folder was shared, get a list of all (sub-)folders
-		if ($this->view->is_dir($path)) {
-			$allFiles = $this->util->getAllFiles($path);
-		} else {
-			$allFiles = array($path);
-		}
-
-
-
-		foreach ($allFiles as $file) {
-			$usersSharing = $this->file->getAccessList($file);
-			$encryptionModule->update($file, $this->uid, $usersSharing);
-		}
-	}
+    /** @var \OC\Files\View */
+    protected $view;
+
+    /** @var \OC\Encryption\Util */
+    protected $util;
+
+        /** @var \OC\Files\Mount\Manager */
+    protected $mountManager;
+
+    /** @var \OC\Encryption\Manager */
+    protected $encryptionManager;
+
+    /** @var string */
+    protected $uid;
+
+    /** @var \OC\Encryption\File */
+    protected $file;
+
+    /**
+     *
+     * @param \OC\Files\View $view
+     * @param \OC\Encryption\Util $util
+     * @param \OC\Files\Mount\Manager $mountManager
+     * @param \OC\Encryption\Manager $encryptionManager
+     * @param \OC\Encryption\File $file
+     * @param string $uid
+     */
+    public function __construct(
+            View $view,
+            Util $util,
+            Mount\Manager $mountManager,
+            Manager $encryptionManager,
+            File $file,
+            $uid
+        ) {
+
+        $this->view = $view;
+        $this->util = $util;
+        $this->mountManager = $mountManager;
+        $this->encryptionManager = $encryptionManager;
+        $this->file = $file;
+        $this->uid = $uid;
+    }
+
+    /**
+     * hook after file was shared
+     *
+     * @param array $params
+     */
+    public function postShared($params) {
+        if ($this->encryptionManager->isEnabled()) {
+            if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') {
+                $path = Filesystem::getPath($params['fileSource']);
+                list($owner, $ownerPath) = $this->getOwnerPath($path);
+                $absPath = '/' . $owner . '/files/' . $ownerPath;
+                $this->update($absPath);
+            }
+        }
+    }
+
+    /**
+     * hook after file was unshared
+     *
+     * @param array $params
+     */
+    public function postUnshared($params) {
+        if ($this->encryptionManager->isEnabled()) {
+            if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') {
+                $path = Filesystem::getPath($params['fileSource']);
+                list($owner, $ownerPath) = $this->getOwnerPath($path);
+                $absPath = '/' . $owner . '/files/' . $ownerPath;
+                $this->update($absPath);
+            }
+        }
+    }
+
+    /**
+     * inform encryption module that a file was restored from the trash bin,
+     * e.g. to update the encryption keys
+     *
+     * @param array $params
+     */
+    public function postRestore($params) {
+        if ($this->encryptionManager->isEnabled()) {
+            $path = Filesystem::normalizePath('/' . $this->uid . '/files/' . $params['filePath']);
+            $this->update($path);
+        }
+    }
+
+    /**
+     * inform encryption module that a file was renamed,
+     * e.g. to update the encryption keys
+     *
+     * @param array $params
+     */
+    public function postRename($params) {
+        $source = $params['oldpath'];
+        $target = $params['newpath'];
+        if(
+            $this->encryptionManager->isEnabled() &&
+            dirname($source) !== dirname($target)
+        ) {
+                list($owner, $ownerPath) = $this->getOwnerPath($target);
+                $absPath = '/' . $owner . '/files/' . $ownerPath;
+                $this->update($absPath);
+        }
+    }
+
+    /**
+     * get owner and path relative to data/<owner>/files
+     *
+     * @param string $path path to file for current user
+     * @return array ['owner' => $owner, 'path' => $path]
+     * @throw \InvalidArgumentException
+     */
+    protected function getOwnerPath($path) {
+        $info = Filesystem::getFileInfo($path);
+        $owner = Filesystem::getOwner($path);
+        $view = new View('/' . $owner . '/files');
+        $path = $view->getPath($info->getId());
+        if ($path === null) {
+            throw new \InvalidArgumentException('No file found for ' . $info->getId());
+        }
+
+        return array($owner, $path);
+    }
+
+    /**
+     * notify encryption module about added/removed users from a file/folder
+     *
+     * @param string $path relative to data/
+     * @throws Exceptions\ModuleDoesNotExistsException
+     */
+    public function update($path) {
+
+        $encryptionModule = $this->encryptionManager->getEncryptionModule();
+
+        // if the encryption module doesn't encrypt the files on a per-user basis
+        // we have nothing to do here.
+        if ($encryptionModule->needDetailedAccessList() === false) {
+            return;
+        }
+
+        // if a folder was shared, get a list of all (sub-)folders
+        if ($this->view->is_dir($path)) {
+            $allFiles = $this->util->getAllFiles($path);
+        } else {
+            $allFiles = array($path);
+        }
+
+
+
+        foreach ($allFiles as $file) {
+            $usersSharing = $this->file->getAccessList($file);
+            $encryptionModule->update($file, $this->uid, $usersSharing);
+        }
+    }
 
 }