nextcloud / server

core/Data/LoginFlowV2Credentials.php

Indentation +36 added lines, -36 removed lines

@@ -25,47 +25,47 @@
 namespace OC\Core\Data;
 
 class LoginFlowV2Credentials implements \JsonSerializable {
-	/** @var string */
-	private $server;
-	/** @var string */
-	private $loginName;
-	/** @var string */
-	private $appPassword;
+    /** @var string */
+    private $server;
+    /** @var string */
+    private $loginName;
+    /** @var string */
+    private $appPassword;
 
-	public function __construct(string $server, string $loginName, string $appPassword) {
-		$this->server = $server;
-		$this->loginName = $loginName;
-		$this->appPassword = $appPassword;
-	}
+    public function __construct(string $server, string $loginName, string $appPassword) {
+        $this->server = $server;
+        $this->loginName = $loginName;
+        $this->appPassword = $appPassword;
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getServer(): string {
-		return $this->server;
-	}
+    /**
+     * @return string
+     */
+    public function getServer(): string {
+        return $this->server;
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getLoginName(): string {
-		return $this->loginName;
-	}
+    /**
+     * @return string
+     */
+    public function getLoginName(): string {
+        return $this->loginName;
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getAppPassword(): string {
-		return $this->appPassword;
-	}
+    /**
+     * @return string
+     */
+    public function getAppPassword(): string {
+        return $this->appPassword;
+    }
 
-	public function jsonSerialize(): array {
-		return [
-			'server' => $this->server,
-			'loginName' => $this->loginName,
-			'appPassword' => $this->appPassword,
-		];
-	}
+    public function jsonSerialize(): array {
+        return [
+            'server' => $this->server,
+            'loginName' => $this->loginName,
+            'appPassword' => $this->appPassword,
+        ];
+    }
 
 
 }

core/Service/LoginFlowV2Service.php

Spacing +2 added lines, -2 removed lines

@@ -211,7 +211,7 @@ 
 
 	private function hashToken(string $token): string {
 		$secret = $this->config->getSystemValue('secret');
-		return hash('sha512', $token . $secret);
+		return hash('sha512', $token.$secret);
 	}
 
 	private function getKeyPair(): array {
@@ -241,7 +241,7 @@ 
 		while ($error = openssl_error_string()) {
 			$errors[] = $error;
 		}
-		$this->logger->critical('Something is wrong with your openssl setup: ' . implode(', ', $errors));
+		$this->logger->critical('Something is wrong with your openssl setup: '.implode(', ', $errors));
 	}
 
 	private function encryptPassword(string $password, string $publicKey): string {

Indentation +224 added lines, -224 removed lines

@@ -43,228 +43,228 @@
 use Psr\Log\LoggerInterface;
 
 class LoginFlowV2Service {
-	private LoginFlowV2Mapper $mapper;
-	private ISecureRandom $random;
-	private ITimeFactory $time;
-	private IConfig $config;
-	private ICrypto $crypto;
-	private LoggerInterface $logger;
-	private IProvider $tokenProvider;
-
-	public function __construct(LoginFlowV2Mapper $mapper,
-								ISecureRandom $random,
-								ITimeFactory $time,
-								IConfig $config,
-								ICrypto $crypto,
-								LoggerInterface $logger,
-								IProvider $tokenProvider) {
-		$this->mapper = $mapper;
-		$this->random = $random;
-		$this->time = $time;
-		$this->config = $config;
-		$this->crypto = $crypto;
-		$this->logger = $logger;
-		$this->tokenProvider = $tokenProvider;
-	}
-
-	/**
-	 * @param string $pollToken
-	 * @return LoginFlowV2Credentials
-	 * @throws LoginFlowV2NotFoundException
-	 */
-	public function poll(string $pollToken): LoginFlowV2Credentials {
-		try {
-			$data = $this->mapper->getByPollToken($this->hashToken($pollToken));
-		} catch (DoesNotExistException $e) {
-			throw new LoginFlowV2NotFoundException('Invalid token');
-		}
-
-		$loginName = $data->getLoginName();
-		$server = $data->getServer();
-		$appPassword = $data->getAppPassword();
-
-		if ($loginName === null || $server === null || $appPassword === null) {
-			throw new LoginFlowV2NotFoundException('Token not yet ready');
-		}
-
-		// Remove the data from the DB
-		$this->mapper->delete($data);
-
-		try {
-			// Decrypt the apptoken
-			$privateKey = $this->crypto->decrypt($data->getPrivateKey(), $pollToken);
-			$appPassword = $this->decryptPassword($data->getAppPassword(), $privateKey);
-		} catch (\Exception $e) {
-			throw new LoginFlowV2NotFoundException('Apptoken could not be decrypted');
-		}
-
-		return new LoginFlowV2Credentials($server, $loginName, $appPassword);
-	}
-
-	/**
-	 * @param string $loginToken
-	 * @return LoginFlowV2
-	 * @throws LoginFlowV2NotFoundException
-	 */
-	public function getByLoginToken(string $loginToken): LoginFlowV2 {
-		try {
-			return $this->mapper->getByLoginToken($loginToken);
-		} catch (DoesNotExistException $e) {
-			throw new LoginFlowV2NotFoundException('Login token invalid');
-		}
-	}
-
-	/**
-	 * @param string $loginToken
-	 * @return bool returns true if the start was successfull. False if not.
-	 */
-	public function startLoginFlow(string $loginToken): bool {
-		try {
-			$data = $this->mapper->getByLoginToken($loginToken);
-		} catch (DoesNotExistException $e) {
-			return false;
-		}
-
-		$data->setStarted(1);
-		$this->mapper->update($data);
-
-		return true;
-	}
-
-	/**
-	 * @param string $loginToken
-	 * @param string $sessionId
-	 * @param string $server
-	 * @param string $userId
-	 * @return bool true if the flow was successfully completed false otherwise
-	 */
-	public function flowDone(string $loginToken, string $sessionId, string $server, string $userId): bool {
-		try {
-			$data = $this->mapper->getByLoginToken($loginToken);
-		} catch (DoesNotExistException $e) {
-			return false;
-		}
-
-		try {
-			$sessionToken = $this->tokenProvider->getToken($sessionId);
-			$loginName = $sessionToken->getLoginName();
-			try {
-				$password = $this->tokenProvider->getPassword($sessionToken, $sessionId);
-			} catch (PasswordlessTokenException $ex) {
-				$password = null;
-			}
-		} catch (InvalidTokenException $ex) {
-			return false;
-		}
-
-		$appPassword = $this->random->generate(72, ISecureRandom::CHAR_UPPER.ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_DIGITS);
-		$this->tokenProvider->generateToken(
-			$appPassword,
-			$userId,
-			$loginName,
-			$password,
-			$data->getClientName(),
-			IToken::PERMANENT_TOKEN,
-			IToken::DO_NOT_REMEMBER
-		);
-
-		$data->setLoginName($loginName);
-		$data->setServer($server);
-
-		// Properly encrypt
-		$data->setAppPassword($this->encryptPassword($appPassword, $data->getPublicKey()));
-
-		$this->mapper->update($data);
-		return true;
-	}
-
-	public function flowDoneWithAppPassword(string $loginToken, string $server, string $loginName, string $appPassword): bool {
-		try {
-			$data = $this->mapper->getByLoginToken($loginToken);
-		} catch (DoesNotExistException $e) {
-			return false;
-		}
-
-		$data->setLoginName($loginName);
-		$data->setServer($server);
-
-		// Properly encrypt
-		$data->setAppPassword($this->encryptPassword($appPassword, $data->getPublicKey()));
-
-		$this->mapper->update($data);
-		return true;
-	}
-
-	public function createTokens(string $userAgent): LoginFlowV2Tokens {
-		$flow = new LoginFlowV2();
-		$pollToken = $this->random->generate(128, ISecureRandom::CHAR_DIGITS.ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_UPPER);
-		$loginToken = $this->random->generate(128, ISecureRandom::CHAR_DIGITS.ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_UPPER);
-		$flow->setPollToken($this->hashToken($pollToken));
-		$flow->setLoginToken($loginToken);
-		$flow->setStarted(0);
-		$flow->setTimestamp($this->time->getTime());
-		$flow->setClientName($userAgent);
-
-		[$publicKey, $privateKey] = $this->getKeyPair();
-		$privateKey = $this->crypto->encrypt($privateKey, $pollToken);
-
-		$flow->setPublicKey($publicKey);
-		$flow->setPrivateKey($privateKey);
-
-		$this->mapper->insert($flow);
-
-		return new LoginFlowV2Tokens($loginToken, $pollToken);
-	}
-
-	private function hashToken(string $token): string {
-		$secret = $this->config->getSystemValue('secret');
-		return hash('sha512', $token . $secret);
-	}
-
-	private function getKeyPair(): array {
-		$config = array_merge([
-			'digest_alg' => 'sha512',
-			'private_key_bits' => 2048,
-		], $this->config->getSystemValue('openssl', []));
-
-		// Generate new key
-		$res = openssl_pkey_new($config);
-		if ($res === false) {
-			$this->logOpensslError();
-			throw new \RuntimeException('Could not initialize keys');
-		}
-
-		if (openssl_pkey_export($res, $privateKey, null, $config) === false) {
-			$this->logOpensslError();
-			throw new \RuntimeException('OpenSSL reported a problem');
-		}
-
-		// Extract the public key from $res to $pubKey
-		$publicKey = openssl_pkey_get_details($res);
-		$publicKey = $publicKey['key'];
-
-		return [$publicKey, $privateKey];
-	}
-
-	private function logOpensslError(): void {
-		$errors = [];
-		while ($error = openssl_error_string()) {
-			$errors[] = $error;
-		}
-		$this->logger->critical('Something is wrong with your openssl setup: ' . implode(', ', $errors));
-	}
-
-	private function encryptPassword(string $password, string $publicKey): string {
-		openssl_public_encrypt($password, $encryptedPassword, $publicKey, OPENSSL_PKCS1_OAEP_PADDING);
-		$encryptedPassword = base64_encode($encryptedPassword);
-
-		return $encryptedPassword;
-	}
-
-	private function decryptPassword(string $encryptedPassword, string $privateKey): string {
-		$encryptedPassword = base64_decode($encryptedPassword);
-		openssl_private_decrypt($encryptedPassword, $password, $privateKey, OPENSSL_PKCS1_OAEP_PADDING);
-
-		return $password;
-	}
+    private LoginFlowV2Mapper $mapper;
+    private ISecureRandom $random;
+    private ITimeFactory $time;
+    private IConfig $config;
+    private ICrypto $crypto;
+    private LoggerInterface $logger;
+    private IProvider $tokenProvider;
+
+    public function __construct(LoginFlowV2Mapper $mapper,
+                                ISecureRandom $random,
+                                ITimeFactory $time,
+                                IConfig $config,
+                                ICrypto $crypto,
+                                LoggerInterface $logger,
+                                IProvider $tokenProvider) {
+        $this->mapper = $mapper;
+        $this->random = $random;
+        $this->time = $time;
+        $this->config = $config;
+        $this->crypto = $crypto;
+        $this->logger = $logger;
+        $this->tokenProvider = $tokenProvider;
+    }
+
+    /**
+     * @param string $pollToken
+     * @return LoginFlowV2Credentials
+     * @throws LoginFlowV2NotFoundException
+     */
+    public function poll(string $pollToken): LoginFlowV2Credentials {
+        try {
+            $data = $this->mapper->getByPollToken($this->hashToken($pollToken));
+        } catch (DoesNotExistException $e) {
+            throw new LoginFlowV2NotFoundException('Invalid token');
+        }
+
+        $loginName = $data->getLoginName();
+        $server = $data->getServer();
+        $appPassword = $data->getAppPassword();
+
+        if ($loginName === null || $server === null || $appPassword === null) {
+            throw new LoginFlowV2NotFoundException('Token not yet ready');
+        }
+
+        // Remove the data from the DB
+        $this->mapper->delete($data);
+
+        try {
+            // Decrypt the apptoken
+            $privateKey = $this->crypto->decrypt($data->getPrivateKey(), $pollToken);
+            $appPassword = $this->decryptPassword($data->getAppPassword(), $privateKey);
+        } catch (\Exception $e) {
+            throw new LoginFlowV2NotFoundException('Apptoken could not be decrypted');
+        }
+
+        return new LoginFlowV2Credentials($server, $loginName, $appPassword);
+    }
+
+    /**
+     * @param string $loginToken
+     * @return LoginFlowV2
+     * @throws LoginFlowV2NotFoundException
+     */
+    public function getByLoginToken(string $loginToken): LoginFlowV2 {
+        try {
+            return $this->mapper->getByLoginToken($loginToken);
+        } catch (DoesNotExistException $e) {
+            throw new LoginFlowV2NotFoundException('Login token invalid');
+        }
+    }
+
+    /**
+     * @param string $loginToken
+     * @return bool returns true if the start was successfull. False if not.
+     */
+    public function startLoginFlow(string $loginToken): bool {
+        try {
+            $data = $this->mapper->getByLoginToken($loginToken);
+        } catch (DoesNotExistException $e) {
+            return false;
+        }
+
+        $data->setStarted(1);
+        $this->mapper->update($data);
+
+        return true;
+    }
+
+    /**
+     * @param string $loginToken
+     * @param string $sessionId
+     * @param string $server
+     * @param string $userId
+     * @return bool true if the flow was successfully completed false otherwise
+     */
+    public function flowDone(string $loginToken, string $sessionId, string $server, string $userId): bool {
+        try {
+            $data = $this->mapper->getByLoginToken($loginToken);
+        } catch (DoesNotExistException $e) {
+            return false;
+        }
+
+        try {
+            $sessionToken = $this->tokenProvider->getToken($sessionId);
+            $loginName = $sessionToken->getLoginName();
+            try {
+                $password = $this->tokenProvider->getPassword($sessionToken, $sessionId);
+            } catch (PasswordlessTokenException $ex) {
+                $password = null;
+            }
+        } catch (InvalidTokenException $ex) {
+            return false;
+        }
+
+        $appPassword = $this->random->generate(72, ISecureRandom::CHAR_UPPER.ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_DIGITS);
+        $this->tokenProvider->generateToken(
+            $appPassword,
+            $userId,
+            $loginName,
+            $password,
+            $data->getClientName(),
+            IToken::PERMANENT_TOKEN,
+            IToken::DO_NOT_REMEMBER
+        );
+
+        $data->setLoginName($loginName);
+        $data->setServer($server);
+
+        // Properly encrypt
+        $data->setAppPassword($this->encryptPassword($appPassword, $data->getPublicKey()));
+
+        $this->mapper->update($data);
+        return true;
+    }
+
+    public function flowDoneWithAppPassword(string $loginToken, string $server, string $loginName, string $appPassword): bool {
+        try {
+            $data = $this->mapper->getByLoginToken($loginToken);
+        } catch (DoesNotExistException $e) {
+            return false;
+        }
+
+        $data->setLoginName($loginName);
+        $data->setServer($server);
+
+        // Properly encrypt
+        $data->setAppPassword($this->encryptPassword($appPassword, $data->getPublicKey()));
+
+        $this->mapper->update($data);
+        return true;
+    }
+
+    public function createTokens(string $userAgent): LoginFlowV2Tokens {
+        $flow = new LoginFlowV2();
+        $pollToken = $this->random->generate(128, ISecureRandom::CHAR_DIGITS.ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_UPPER);
+        $loginToken = $this->random->generate(128, ISecureRandom::CHAR_DIGITS.ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_UPPER);
+        $flow->setPollToken($this->hashToken($pollToken));
+        $flow->setLoginToken($loginToken);
+        $flow->setStarted(0);
+        $flow->setTimestamp($this->time->getTime());
+        $flow->setClientName($userAgent);
+
+        [$publicKey, $privateKey] = $this->getKeyPair();
+        $privateKey = $this->crypto->encrypt($privateKey, $pollToken);
+
+        $flow->setPublicKey($publicKey);
+        $flow->setPrivateKey($privateKey);
+
+        $this->mapper->insert($flow);
+
+        return new LoginFlowV2Tokens($loginToken, $pollToken);
+    }
+
+    private function hashToken(string $token): string {
+        $secret = $this->config->getSystemValue('secret');
+        return hash('sha512', $token . $secret);
+    }
+
+    private function getKeyPair(): array {
+        $config = array_merge([
+            'digest_alg' => 'sha512',
+            'private_key_bits' => 2048,
+        ], $this->config->getSystemValue('openssl', []));
+
+        // Generate new key
+        $res = openssl_pkey_new($config);
+        if ($res === false) {
+            $this->logOpensslError();
+            throw new \RuntimeException('Could not initialize keys');
+        }
+
+        if (openssl_pkey_export($res, $privateKey, null, $config) === false) {
+            $this->logOpensslError();
+            throw new \RuntimeException('OpenSSL reported a problem');
+        }
+
+        // Extract the public key from $res to $pubKey
+        $publicKey = openssl_pkey_get_details($res);
+        $publicKey = $publicKey['key'];
+
+        return [$publicKey, $privateKey];
+    }
+
+    private function logOpensslError(): void {
+        $errors = [];
+        while ($error = openssl_error_string()) {
+            $errors[] = $error;
+        }
+        $this->logger->critical('Something is wrong with your openssl setup: ' . implode(', ', $errors));
+    }
+
+    private function encryptPassword(string $password, string $publicKey): string {
+        openssl_public_encrypt($password, $encryptedPassword, $publicKey, OPENSSL_PKCS1_OAEP_PADDING);
+        $encryptedPassword = base64_encode($encryptedPassword);
+
+        return $encryptedPassword;
+    }
+
+    private function decryptPassword(string $encryptedPassword, string $privateKey): string {
+        $encryptedPassword = base64_decode($encryptedPassword);
+        openssl_private_decrypt($encryptedPassword, $password, $privateKey, OPENSSL_PKCS1_OAEP_PADDING);
+
+        return $password;
+    }
 }

core/Db/LoginFlowV2.php

Indentation +32 added lines, -32 removed lines

@@ -49,37 +49,37 @@
  * @method void setAppPassword(string $appPassword)
  */
 class LoginFlowV2 extends Entity {
-	/** @var int */
-	protected $timestamp;
-	/** @var int */
-	protected $started;
-	/** @var string */
-	protected $pollToken;
-	/** @var string */
-	protected $loginToken;
-	/** @var string */
-	protected $publicKey;
-	/** @var string */
-	protected $privateKey;
-	/** @var string */
-	protected $clientName;
-	/** @var string */
-	protected $loginName;
-	/** @var string */
-	protected $server;
-	/** @var string */
-	protected $appPassword;
+    /** @var int */
+    protected $timestamp;
+    /** @var int */
+    protected $started;
+    /** @var string */
+    protected $pollToken;
+    /** @var string */
+    protected $loginToken;
+    /** @var string */
+    protected $publicKey;
+    /** @var string */
+    protected $privateKey;
+    /** @var string */
+    protected $clientName;
+    /** @var string */
+    protected $loginName;
+    /** @var string */
+    protected $server;
+    /** @var string */
+    protected $appPassword;
 
-	public function __construct() {
-		$this->addType('timestamp', 'int');
-		$this->addType('started', 'int');
-		$this->addType('pollToken', 'string');
-		$this->addType('loginToken', 'string');
-		$this->addType('publicKey', 'string');
-		$this->addType('privateKey', 'string');
-		$this->addType('clientName', 'string');
-		$this->addType('loginName', 'string');
-		$this->addType('server', 'string');
-		$this->addType('appPassword', 'string');
-	}
+    public function __construct() {
+        $this->addType('timestamp', 'int');
+        $this->addType('started', 'int');
+        $this->addType('pollToken', 'string');
+        $this->addType('loginToken', 'string');
+        $this->addType('publicKey', 'string');
+        $this->addType('privateKey', 'string');
+        $this->addType('clientName', 'string');
+        $this->addType('loginName', 'string');
+        $this->addType('server', 'string');
+        $this->addType('appPassword', 'string');
+    }
 }

lib/public/Group/Backend/IHideFromCollaborationBackend.php

Indentation +8 added lines, -8 removed lines

@@ -27,12 +27,12 @@
  * Allow the backend to mark groups to be excluded from being shown in search dialogs
  */
 interface IHideFromCollaborationBackend {
-	/**
-	 * Check if a group should be hidden from search dialogs
-	 *
-	 * @param string $groupId
-	 * @return bool
-	 * @since 16.0.0
-	 */
-	public function hideGroup(string $groupId): bool;
+    /**
+     * Check if a group should be hidden from search dialogs
+     *
+     * @param string $groupId
+     * @return bool
+     * @since 16.0.0
+     */
+    public function hideGroup(string $groupId): bool;
 }

lib/private/FullTextSearch/Model/IndexDocument.php

Spacing +1 added lines, -1 removed lines

@@ -389,7 +389,7 @@
 		foreach ($ak as $source) {
 			$tags = $this->subTags[$source];
 			foreach ($tags as $tag) {
-				$subTags[] = $source . '_' . $tag;
+				$subTags[] = $source.'_'.$tag;
 			}
 		}
 

Indentation +934 added lines, -934 removed lines

@@ -47,940 +47,940 @@
  * @package OC\FullTextSearch\Model
  */
 class IndexDocument implements IIndexDocument, JsonSerializable {
-	/** @var string */
-	protected $id = '';
+    /** @var string */
+    protected $id = '';
 
-	/** @var string */
-	protected $providerId = '';
+    /** @var string */
+    protected $providerId = '';
 
-	/** @var DocumentAccess */
-	protected $access;
-
-	/** @var IIndex */
-	protected $index;
-
-	/** @var int */
-	protected $modifiedTime = 0;
-
-	/** @var string */
-	protected $source = '';
-
-	/** @var array */
-	protected $tags = [];
-
-	/** @var array */
-	protected $metaTags = [];
-
-	/** @var array */
-	protected $subTags = [];
-
-	/** @var string */
-	protected $title = '';
-
-	/** @var string */
-	protected $content = '';
-
-	/** @var string */
-	protected $hash = '';
-
-	/** @var array */
-	protected $parts = [];
-
-	/** @var string */
-	protected $link = '';
-
-	/** @var array */
-	protected $more = [];
-
-	/** @var array */
-	protected $excerpts = [];
-
-	/** @var string */
-	protected $score = '';
-
-	/** @var array */
-	protected $info = [];
-
-	/** @var int */
-	protected $contentEncoded = 0;
-
-
-	/**
-	 * IIndexDocument constructor.
-	 *
-	 * On creation, we assure the uniqueness of the object using the providerId
-	 * and the Id of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param string $documentId
-	 */
-	public function __construct(string $providerId, string $documentId) {
-		$this->providerId = $providerId;
-		$this->id = $documentId;
-	}
-
-
-	/**
-	 * Returns the Id of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getId(): string {
-		return $this->id;
-	}
-
-
-	/**
-	 * Returns the Id of the provider.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getProviderId(): string {
-		return $this->providerId;
-	}
-
-
-	/**
-	 * Set the Index related to the IIndexDocument.
-	 *
-	 * @see IIndex
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndex $index
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setIndex(IIndex $index): IIndexDocument {
-		$this->index = $index;
-
-		return $this;
-	}
-
-	/**
-	 * Get the Index.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IIndex
-	 */
-	final public function getIndex(): IIndex {
-		return $this->index;
-	}
-
-	/**
-	 * return if Index is defined.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return bool
-	 */
-	final public function hasIndex(): bool {
-		return ($this->index !== null);
-	}
-
-
-	/**
-	 * Set the modified time of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $modifiedTime
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setModifiedTime(int $modifiedTime): IIndexDocument {
-		$this->modifiedTime = $modifiedTime;
-
-		return $this;
-	}
-
-	/**
-	 * Get the modified time of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	final public function getModifiedTime(): int {
-		return $this->modifiedTime;
-	}
-
-	/**
-	 * Check if the original document of the IIndexDocument is older than $time.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $time
-	 *
-	 * @return bool
-	 */
-	final public function isOlderThan(int $time): bool {
-		return ($this->modifiedTime < $time);
-	}
-
-
-	/**
-	 * Set the read rights of the original document using a IDocumentAccess.
-	 *
-	 * @see IDocumentAccess
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IDocumentAccess $access
-	 *
-	 * @return $this
-	 */
-	final public function setAccess(IDocumentAccess $access): IIndexDocument {
-		$this->access = $access;
-
-		return $this;
-	}
-
-	/**
-	 * Get the IDocumentAccess related to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IDocumentAccess
-	 */
-	final public function getAccess(): IDocumentAccess {
-		return $this->access;
-	}
-
-
-	/**
-	 * Add a tag to the list.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $tag
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addTag(string $tag): IIndexDocument {
-		$this->tags[] = $tag;
-
-		return $this;
-	}
-
-	/**
-	 * Set the list of tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setTags(array $tags): IIndexDocument {
-		$this->tags = $tags;
-
-		return $this;
-	}
-
-	/**
-	 * Get the list of tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getTags(): array {
-		return $this->tags;
-	}
-
-
-	/**
-	 * Add a meta tag to the list.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $tag
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addMetaTag(string $tag): IIndexDocument {
-		$this->metaTags[] = $tag;
-
-		return $this;
-	}
-
-	/**
-	 * Set the list of meta tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setMetaTags(array $tags): IIndexDocument {
-		$this->metaTags = $tags;
-
-		return $this;
-	}
-
-	/**
-	 * Get the list of meta tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getMetaTags(): array {
-		return $this->metaTags;
-	}
-
-
-	/**
-	 * Add a sub tag to the list.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $sub
-	 * @param string $tag
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addSubTag(string $sub, string $tag): IIndexDocument {
-		if (!array_key_exists($sub, $this->subTags)) {
-			$this->subTags[$sub] = [];
-		}
-
-		$this->subTags[$sub][] = $tag;
-
-		return $this;
-	}
-
-
-	/**
-	 * Set the list of sub tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setSubTags(array $tags): IIndexDocument {
-		$this->subTags = $tags;
-
-		return $this;
-	}
-
-	/**
-	 * Get the list of sub tags assigned to the original document.
-	 * If $formatted is true, the result will be formatted in a one
-	 * dimensional array.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param bool $formatted
-	 *
-	 * @return array
-	 */
-	final public function getSubTags(bool $formatted = false): array {
-		if ($formatted === false) {
-			return $this->subTags;
-		}
-
-		$subTags = [];
-		$ak = array_keys($this->subTags);
-		foreach ($ak as $source) {
-			$tags = $this->subTags[$source];
-			foreach ($tags as $tag) {
-				$subTags[] = $source . '_' . $tag;
-			}
-		}
-
-		return $subTags;
-	}
-
-
-	/**
-	 * Set the source of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $source
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setSource(string $source): IIndexDocument {
-		$this->source = $source;
-
-		return $this;
-	}
-
-	/**
-	 * Get the source of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getSource(): string {
-		return $this->source;
-	}
-
-
-	/**
-	 * Set the title of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $title
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setTitle(string $title): IIndexDocument {
-		$this->title = $title;
-
-		return $this;
-	}
-
-	/**
-	 * Get the title of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getTitle(): string {
-		return $this->title;
-	}
-
-
-	/**
-	 * Set the content of the document.
-	 * $encoded can be NOT_ENCODED or ENCODED_BASE64 if the content is raw or
-	 * encoded in base64.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $content
-	 * @param int $encoded
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setContent(string $content, int $encoded = 0): IIndexDocument {
-		$this->content = $content;
-		$this->contentEncoded = $encoded;
-
-		return $this;
-	}
-
-	/**
-	 * Get the content of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getContent(): string {
-		return $this->content;
-	}
-
-	/**
-	 * Returns the type of the encoding on the content.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	final public function isContentEncoded(): int {
-		return $this->contentEncoded;
-	}
-
-	/**
-	 * Return the size of the content.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	final public function getContentSize(): int {
-		return strlen($this->getContent());
-	}
-
-
-	/**
-	 * Generate an hash, based on the content of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function initHash(): IIndexDocument {
-		if ($this->getContent() === '' || is_null($this->getContent())) {
-			return $this;
-		}
-
-		$this->hash = hash("md5", $this->getContent());
-
-		return $this;
-	}
-
-	/**
-	 * Set the hash of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $hash
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setHash(string $hash): IIndexDocument {
-		$this->hash = $hash;
-
-		return $this;
-	}
-
-	/**
-	 * Get the hash of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getHash(): string {
-		return $this->hash;
-	}
-
-
-	/**
-	 * Add a part, identified by a string, and its content.
-	 *
-	 * It is strongly advised to use alphanumerical chars with no space in the
-	 * $part string.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $part
-	 * @param string $content
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addPart(string $part, string $content): IIndexDocument {
-		$this->parts[$part] = $content;
-
-		return $this;
-	}
-
-	/**
-	 * Set all parts and their content.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $parts
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setParts(array $parts): IIndexDocument {
-		$this->parts = $parts;
-
-		return $this;
-	}
-
-	/**
-	 * Get all parts of the IIndexDocument.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getParts(): array {
-		return $this->parts;
-	}
-
-
-	/**
-	 * Add a link, usable by the frontend.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $link
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setLink(string $link): IIndexDocument {
-		$this->link = $link;
-
-		return $this;
-	}
-
-	/**
-	 * Get the link.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getLink(): string {
-		return $this->link;
-	}
-
-
-	/**
-	 * Set more information that couldn't be set using other method.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $more
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setMore(array $more): IIndexDocument {
-		$this->more = $more;
-
-		return $this;
-	}
-
-	/**
-	 * Get more information.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getMore(): array {
-		return $this->more;
-	}
-
-
-	/**
-	 * Add some excerpt of the content of the original document, usually based
-	 * on the search request.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $source
-	 * @param string $excerpt
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addExcerpt(string $source, string $excerpt): IIndexDocument {
-		$this->excerpts[] =
-			[
-				'source' => $source,
-				'excerpt' => $this->cleanExcerpt($excerpt)
-			];
-
-		return $this;
-	}
-
-
-	/**
-	 * Set all excerpts of the content of the original document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $excerpts
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setExcerpts(array $excerpts): IIndexDocument {
-		$new = [];
-		foreach ($excerpts as $entry) {
-			$new[] = [
-				'source' => $entry['source'],
-				'excerpt' => $this->cleanExcerpt($entry['excerpt'])
-			];
-		}
-
-		$this->excerpts = $new;
-
-		return $this;
-	}
-
-	/**
-	 * Get all excerpts of the content of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getExcerpts(): array {
-		return $this->excerpts;
-	}
-
-	/**
-	 * Clean excerpt.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $excerpt
-	 * @return string
-	 */
-	private function cleanExcerpt(string $excerpt): string {
-		$excerpt = str_replace("\\n", ' ', $excerpt);
-		$excerpt = str_replace("\\r", ' ', $excerpt);
-		$excerpt = str_replace("\\t", ' ', $excerpt);
-		$excerpt = str_replace("\n", ' ', $excerpt);
-		$excerpt = str_replace("\r", ' ', $excerpt);
-		$excerpt = str_replace("\t", ' ', $excerpt);
-
-		return $excerpt;
-	}
-
-
-	/**
-	 * Set the score to the result assigned to this document during a search
-	 * request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $score
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setScore(string $score): IIndexDocument {
-		$this->score = $score;
-
-		return $this;
-	}
-
-	/**
-	 * Get the score.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getScore(): string {
-		return $this->score;
-	}
-
-
-	/**
-	 * Set some information about the original document that will be available
-	 * to the front-end when displaying search result. (as string)
-	 * Because this information will not be indexed, this method can also be
-	 * used to manage some data while filling the IIndexDocument before its
-	 * indexing.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param string $value
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setInfo(string $info, string $value): IIndexDocument {
-		$this->info[$info] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Get an information about a document. (string)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param string $default
-	 *
-	 * @return string
-	 */
-	final public function getInfo(string $info, string $default = ''): string {
-		if (!key_exists($info, $this->info)) {
-			return $default;
-		}
-
-		return $this->info[$info];
-	}
-
-	/**
-	 * Set some information about the original document that will be available
-	 * to the front-end when displaying search result. (as array)
-	 * Because this information will not be indexed, this method can also be
-	 * used to manage some data while filling the IIndexDocument before its
-	 * indexing.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param array $value
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setInfoArray(string $info, array $value): IIndexDocument {
-		$this->info[$info] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Get an information about a document. (array)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param array $default
-	 *
-	 * @return array
-	 */
-	final public function getInfoArray(string $info, array $default = []): array {
-		if (!key_exists($info, $this->info)) {
-			return $default;
-		}
-
-		return $this->info[$info];
-	}
-
-	/**
-	 * Set some information about the original document that will be available
-	 * to the front-end when displaying search result. (as int)
-	 * Because this information will not be indexed, this method can also be
-	 * used to manage some data while filling the IIndexDocument before its
-	 * indexing.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param int $value
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setInfoInt(string $info, int $value): IIndexDocument {
-		$this->info[$info] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Get an information about a document. (int)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param int $default
-	 *
-	 * @return int
-	 */
-	final public function getInfoInt(string $info, int $default = 0): int {
-		if (!key_exists($info, $this->info)) {
-			return $default;
-		}
-
-		return $this->info[$info];
-	}
-
-	/**
-	 * Set some information about the original document that will be available
-	 * to the front-end when displaying search result. (as bool)
-	 * Because this information will not be indexed, this method can also be
-	 * used to manage some data while filling the IIndexDocument before its
-	 * indexing.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param bool $value
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setInfoBool(string $info, bool $value): IIndexDocument {
-		$this->info[$info] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Get an information about a document. (bool)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param bool $default
-	 *
-	 * @return bool
-	 */
-	final public function getInfoBool(string $info, bool $default = false): bool {
-		if (!key_exists($info, $this->info)) {
-			return $default;
-		}
-
-		return $this->info[$info];
-	}
-
-	/**
-	 * Get all info.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getInfoAll(): array {
-		$info = [];
-		foreach ($this->info as $k => $v) {
-			if (substr($k, 0, 1) === '_') {
-				continue;
-			}
-
-			$info[$k] = $v;
-		}
-
-		return $info;
-	}
-
-
-	/**
-	 * @since 15.0.0
-	 *
-	 * On some version of PHP, it is better to force destruct the object.
-	 * And during the index, the number of generated IIndexDocument can be
-	 * _huge_.
-	 */
-	public function __destruct() {
-		unset($this->id);
-		unset($this->providerId);
-		unset($this->access);
-		unset($this->modifiedTime);
-		unset($this->title);
-		unset($this->content);
-		unset($this->hash);
-		unset($this->link);
-		unset($this->source);
-		unset($this->tags);
-		unset($this->metaTags);
-		unset($this->subTags);
-		unset($this->more);
-		unset($this->excerpts);
-		unset($this->score);
-		unset($this->info);
-		unset($this->contentEncoded);
-	}
-
-	/**
-	 * @since 15.0.0
-	 */
-	public function jsonSerialize(): array {
-		return [
-			'id' => $this->getId(),
-			'providerId' => $this->getProviderId(),
-			'access' => $this->access,
-			'modifiedTime' => $this->getModifiedTime(),
-			'title' => $this->getTitle(),
-			'link' => $this->getLink(),
-			'index' => $this->index,
-			'source' => $this->getSource(),
-			'info' => $this->getInfoAll(),
-			'hash' => $this->getHash(),
-			'contentSize' => $this->getContentSize(),
-			'tags' => $this->getTags(),
-			'metatags' => $this->getMetaTags(),
-			'subtags' => $this->getSubTags(),
-			'more' => $this->getMore(),
-			'excerpts' => $this->getExcerpts(),
-			'score' => $this->getScore()
-		];
-	}
+    /** @var DocumentAccess */
+    protected $access;
+
+    /** @var IIndex */
+    protected $index;
+
+    /** @var int */
+    protected $modifiedTime = 0;
+
+    /** @var string */
+    protected $source = '';
+
+    /** @var array */
+    protected $tags = [];
+
+    /** @var array */
+    protected $metaTags = [];
+
+    /** @var array */
+    protected $subTags = [];
+
+    /** @var string */
+    protected $title = '';
+
+    /** @var string */
+    protected $content = '';
+
+    /** @var string */
+    protected $hash = '';
+
+    /** @var array */
+    protected $parts = [];
+
+    /** @var string */
+    protected $link = '';
+
+    /** @var array */
+    protected $more = [];
+
+    /** @var array */
+    protected $excerpts = [];
+
+    /** @var string */
+    protected $score = '';
+
+    /** @var array */
+    protected $info = [];
+
+    /** @var int */
+    protected $contentEncoded = 0;
+
+
+    /**
+     * IIndexDocument constructor.
+     *
+     * On creation, we assure the uniqueness of the object using the providerId
+     * and the Id of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param string $documentId
+     */
+    public function __construct(string $providerId, string $documentId) {
+        $this->providerId = $providerId;
+        $this->id = $documentId;
+    }
+
+
+    /**
+     * Returns the Id of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getId(): string {
+        return $this->id;
+    }
+
+
+    /**
+     * Returns the Id of the provider.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getProviderId(): string {
+        return $this->providerId;
+    }
+
+
+    /**
+     * Set the Index related to the IIndexDocument.
+     *
+     * @see IIndex
+     *
+     * @since 15.0.0
+     *
+     * @param IIndex $index
+     *
+     * @return IIndexDocument
+     */
+    final public function setIndex(IIndex $index): IIndexDocument {
+        $this->index = $index;
+
+        return $this;
+    }
+
+    /**
+     * Get the Index.
+     *
+     * @since 15.0.0
+     *
+     * @return IIndex
+     */
+    final public function getIndex(): IIndex {
+        return $this->index;
+    }
+
+    /**
+     * return if Index is defined.
+     *
+     * @since 16.0.0
+     *
+     * @return bool
+     */
+    final public function hasIndex(): bool {
+        return ($this->index !== null);
+    }
+
+
+    /**
+     * Set the modified time of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param int $modifiedTime
+     *
+     * @return IIndexDocument
+     */
+    final public function setModifiedTime(int $modifiedTime): IIndexDocument {
+        $this->modifiedTime = $modifiedTime;
+
+        return $this;
+    }
+
+    /**
+     * Get the modified time of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    final public function getModifiedTime(): int {
+        return $this->modifiedTime;
+    }
+
+    /**
+     * Check if the original document of the IIndexDocument is older than $time.
+     *
+     * @since 15.0.0
+     *
+     * @param int $time
+     *
+     * @return bool
+     */
+    final public function isOlderThan(int $time): bool {
+        return ($this->modifiedTime < $time);
+    }
+
+
+    /**
+     * Set the read rights of the original document using a IDocumentAccess.
+     *
+     * @see IDocumentAccess
+     *
+     * @since 15.0.0
+     *
+     * @param IDocumentAccess $access
+     *
+     * @return $this
+     */
+    final public function setAccess(IDocumentAccess $access): IIndexDocument {
+        $this->access = $access;
+
+        return $this;
+    }
+
+    /**
+     * Get the IDocumentAccess related to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return IDocumentAccess
+     */
+    final public function getAccess(): IDocumentAccess {
+        return $this->access;
+    }
+
+
+    /**
+     * Add a tag to the list.
+     *
+     * @since 15.0.0
+     *
+     * @param string $tag
+     *
+     * @return IIndexDocument
+     */
+    final public function addTag(string $tag): IIndexDocument {
+        $this->tags[] = $tag;
+
+        return $this;
+    }
+
+    /**
+     * Set the list of tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return IIndexDocument
+     */
+    final public function setTags(array $tags): IIndexDocument {
+        $this->tags = $tags;
+
+        return $this;
+    }
+
+    /**
+     * Get the list of tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getTags(): array {
+        return $this->tags;
+    }
+
+
+    /**
+     * Add a meta tag to the list.
+     *
+     * @since 15.0.0
+     *
+     * @param string $tag
+     *
+     * @return IIndexDocument
+     */
+    final public function addMetaTag(string $tag): IIndexDocument {
+        $this->metaTags[] = $tag;
+
+        return $this;
+    }
+
+    /**
+     * Set the list of meta tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return IIndexDocument
+     */
+    final public function setMetaTags(array $tags): IIndexDocument {
+        $this->metaTags = $tags;
+
+        return $this;
+    }
+
+    /**
+     * Get the list of meta tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getMetaTags(): array {
+        return $this->metaTags;
+    }
+
+
+    /**
+     * Add a sub tag to the list.
+     *
+     * @since 15.0.0
+     *
+     * @param string $sub
+     * @param string $tag
+     *
+     * @return IIndexDocument
+     */
+    final public function addSubTag(string $sub, string $tag): IIndexDocument {
+        if (!array_key_exists($sub, $this->subTags)) {
+            $this->subTags[$sub] = [];
+        }
+
+        $this->subTags[$sub][] = $tag;
+
+        return $this;
+    }
+
+
+    /**
+     * Set the list of sub tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return IIndexDocument
+     */
+    final public function setSubTags(array $tags): IIndexDocument {
+        $this->subTags = $tags;
+
+        return $this;
+    }
+
+    /**
+     * Get the list of sub tags assigned to the original document.
+     * If $formatted is true, the result will be formatted in a one
+     * dimensional array.
+     *
+     * @since 15.0.0
+     *
+     * @param bool $formatted
+     *
+     * @return array
+     */
+    final public function getSubTags(bool $formatted = false): array {
+        if ($formatted === false) {
+            return $this->subTags;
+        }
+
+        $subTags = [];
+        $ak = array_keys($this->subTags);
+        foreach ($ak as $source) {
+            $tags = $this->subTags[$source];
+            foreach ($tags as $tag) {
+                $subTags[] = $source . '_' . $tag;
+            }
+        }
+
+        return $subTags;
+    }
+
+
+    /**
+     * Set the source of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $source
+     *
+     * @return IIndexDocument
+     */
+    final public function setSource(string $source): IIndexDocument {
+        $this->source = $source;
+
+        return $this;
+    }
+
+    /**
+     * Get the source of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getSource(): string {
+        return $this->source;
+    }
+
+
+    /**
+     * Set the title of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $title
+     *
+     * @return IIndexDocument
+     */
+    final public function setTitle(string $title): IIndexDocument {
+        $this->title = $title;
+
+        return $this;
+    }
+
+    /**
+     * Get the title of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getTitle(): string {
+        return $this->title;
+    }
+
+
+    /**
+     * Set the content of the document.
+     * $encoded can be NOT_ENCODED or ENCODED_BASE64 if the content is raw or
+     * encoded in base64.
+     *
+     * @since 15.0.0
+     *
+     * @param string $content
+     * @param int $encoded
+     *
+     * @return IIndexDocument
+     */
+    final public function setContent(string $content, int $encoded = 0): IIndexDocument {
+        $this->content = $content;
+        $this->contentEncoded = $encoded;
+
+        return $this;
+    }
+
+    /**
+     * Get the content of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getContent(): string {
+        return $this->content;
+    }
+
+    /**
+     * Returns the type of the encoding on the content.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    final public function isContentEncoded(): int {
+        return $this->contentEncoded;
+    }
+
+    /**
+     * Return the size of the content.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    final public function getContentSize(): int {
+        return strlen($this->getContent());
+    }
+
+
+    /**
+     * Generate an hash, based on the content of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return IIndexDocument
+     */
+    final public function initHash(): IIndexDocument {
+        if ($this->getContent() === '' || is_null($this->getContent())) {
+            return $this;
+        }
+
+        $this->hash = hash("md5", $this->getContent());
+
+        return $this;
+    }
+
+    /**
+     * Set the hash of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $hash
+     *
+     * @return IIndexDocument
+     */
+    final public function setHash(string $hash): IIndexDocument {
+        $this->hash = $hash;
+
+        return $this;
+    }
+
+    /**
+     * Get the hash of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getHash(): string {
+        return $this->hash;
+    }
+
+
+    /**
+     * Add a part, identified by a string, and its content.
+     *
+     * It is strongly advised to use alphanumerical chars with no space in the
+     * $part string.
+     *
+     * @since 15.0.0
+     *
+     * @param string $part
+     * @param string $content
+     *
+     * @return IIndexDocument
+     */
+    final public function addPart(string $part, string $content): IIndexDocument {
+        $this->parts[$part] = $content;
+
+        return $this;
+    }
+
+    /**
+     * Set all parts and their content.
+     *
+     * @since 15.0.0
+     *
+     * @param array $parts
+     *
+     * @return IIndexDocument
+     */
+    final public function setParts(array $parts): IIndexDocument {
+        $this->parts = $parts;
+
+        return $this;
+    }
+
+    /**
+     * Get all parts of the IIndexDocument.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getParts(): array {
+        return $this->parts;
+    }
+
+
+    /**
+     * Add a link, usable by the frontend.
+     *
+     * @since 15.0.0
+     *
+     * @param string $link
+     *
+     * @return IIndexDocument
+     */
+    final public function setLink(string $link): IIndexDocument {
+        $this->link = $link;
+
+        return $this;
+    }
+
+    /**
+     * Get the link.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getLink(): string {
+        return $this->link;
+    }
+
+
+    /**
+     * Set more information that couldn't be set using other method.
+     *
+     * @since 15.0.0
+     *
+     * @param array $more
+     *
+     * @return IIndexDocument
+     */
+    final public function setMore(array $more): IIndexDocument {
+        $this->more = $more;
+
+        return $this;
+    }
+
+    /**
+     * Get more information.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getMore(): array {
+        return $this->more;
+    }
+
+
+    /**
+     * Add some excerpt of the content of the original document, usually based
+     * on the search request.
+     *
+     * @since 16.0.0
+     *
+     * @param string $source
+     * @param string $excerpt
+     *
+     * @return IIndexDocument
+     */
+    final public function addExcerpt(string $source, string $excerpt): IIndexDocument {
+        $this->excerpts[] =
+            [
+                'source' => $source,
+                'excerpt' => $this->cleanExcerpt($excerpt)
+            ];
+
+        return $this;
+    }
+
+
+    /**
+     * Set all excerpts of the content of the original document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $excerpts
+     *
+     * @return IIndexDocument
+     */
+    final public function setExcerpts(array $excerpts): IIndexDocument {
+        $new = [];
+        foreach ($excerpts as $entry) {
+            $new[] = [
+                'source' => $entry['source'],
+                'excerpt' => $this->cleanExcerpt($entry['excerpt'])
+            ];
+        }
+
+        $this->excerpts = $new;
+
+        return $this;
+    }
+
+    /**
+     * Get all excerpts of the content of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getExcerpts(): array {
+        return $this->excerpts;
+    }
+
+    /**
+     * Clean excerpt.
+     *
+     * @since 16.0.0
+     *
+     * @param string $excerpt
+     * @return string
+     */
+    private function cleanExcerpt(string $excerpt): string {
+        $excerpt = str_replace("\\n", ' ', $excerpt);
+        $excerpt = str_replace("\\r", ' ', $excerpt);
+        $excerpt = str_replace("\\t", ' ', $excerpt);
+        $excerpt = str_replace("\n", ' ', $excerpt);
+        $excerpt = str_replace("\r", ' ', $excerpt);
+        $excerpt = str_replace("\t", ' ', $excerpt);
+
+        return $excerpt;
+    }
+
+
+    /**
+     * Set the score to the result assigned to this document during a search
+     * request.
+     *
+     * @since 15.0.0
+     *
+     * @param string $score
+     *
+     * @return IIndexDocument
+     */
+    final public function setScore(string $score): IIndexDocument {
+        $this->score = $score;
+
+        return $this;
+    }
+
+    /**
+     * Get the score.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getScore(): string {
+        return $this->score;
+    }
+
+
+    /**
+     * Set some information about the original document that will be available
+     * to the front-end when displaying search result. (as string)
+     * Because this information will not be indexed, this method can also be
+     * used to manage some data while filling the IIndexDocument before its
+     * indexing.
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param string $value
+     *
+     * @return IIndexDocument
+     */
+    final public function setInfo(string $info, string $value): IIndexDocument {
+        $this->info[$info] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get an information about a document. (string)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param string $default
+     *
+     * @return string
+     */
+    final public function getInfo(string $info, string $default = ''): string {
+        if (!key_exists($info, $this->info)) {
+            return $default;
+        }
+
+        return $this->info[$info];
+    }
+
+    /**
+     * Set some information about the original document that will be available
+     * to the front-end when displaying search result. (as array)
+     * Because this information will not be indexed, this method can also be
+     * used to manage some data while filling the IIndexDocument before its
+     * indexing.
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param array $value
+     *
+     * @return IIndexDocument
+     */
+    final public function setInfoArray(string $info, array $value): IIndexDocument {
+        $this->info[$info] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get an information about a document. (array)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param array $default
+     *
+     * @return array
+     */
+    final public function getInfoArray(string $info, array $default = []): array {
+        if (!key_exists($info, $this->info)) {
+            return $default;
+        }
+
+        return $this->info[$info];
+    }
+
+    /**
+     * Set some information about the original document that will be available
+     * to the front-end when displaying search result. (as int)
+     * Because this information will not be indexed, this method can also be
+     * used to manage some data while filling the IIndexDocument before its
+     * indexing.
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param int $value
+     *
+     * @return IIndexDocument
+     */
+    final public function setInfoInt(string $info, int $value): IIndexDocument {
+        $this->info[$info] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get an information about a document. (int)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param int $default
+     *
+     * @return int
+     */
+    final public function getInfoInt(string $info, int $default = 0): int {
+        if (!key_exists($info, $this->info)) {
+            return $default;
+        }
+
+        return $this->info[$info];
+    }
+
+    /**
+     * Set some information about the original document that will be available
+     * to the front-end when displaying search result. (as bool)
+     * Because this information will not be indexed, this method can also be
+     * used to manage some data while filling the IIndexDocument before its
+     * indexing.
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param bool $value
+     *
+     * @return IIndexDocument
+     */
+    final public function setInfoBool(string $info, bool $value): IIndexDocument {
+        $this->info[$info] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get an information about a document. (bool)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param bool $default
+     *
+     * @return bool
+     */
+    final public function getInfoBool(string $info, bool $default = false): bool {
+        if (!key_exists($info, $this->info)) {
+            return $default;
+        }
+
+        return $this->info[$info];
+    }
+
+    /**
+     * Get all info.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getInfoAll(): array {
+        $info = [];
+        foreach ($this->info as $k => $v) {
+            if (substr($k, 0, 1) === '_') {
+                continue;
+            }
+
+            $info[$k] = $v;
+        }
+
+        return $info;
+    }
+
+
+    /**
+     * @since 15.0.0
+     *
+     * On some version of PHP, it is better to force destruct the object.
+     * And during the index, the number of generated IIndexDocument can be
+     * _huge_.
+     */
+    public function __destruct() {
+        unset($this->id);
+        unset($this->providerId);
+        unset($this->access);
+        unset($this->modifiedTime);
+        unset($this->title);
+        unset($this->content);
+        unset($this->hash);
+        unset($this->link);
+        unset($this->source);
+        unset($this->tags);
+        unset($this->metaTags);
+        unset($this->subTags);
+        unset($this->more);
+        unset($this->excerpts);
+        unset($this->score);
+        unset($this->info);
+        unset($this->contentEncoded);
+    }
+
+    /**
+     * @since 15.0.0
+     */
+    public function jsonSerialize(): array {
+        return [
+            'id' => $this->getId(),
+            'providerId' => $this->getProviderId(),
+            'access' => $this->access,
+            'modifiedTime' => $this->getModifiedTime(),
+            'title' => $this->getTitle(),
+            'link' => $this->getLink(),
+            'index' => $this->index,
+            'source' => $this->getSource(),
+            'info' => $this->getInfoAll(),
+            'hash' => $this->getHash(),
+            'contentSize' => $this->getContentSize(),
+            'tags' => $this->getTags(),
+            'metatags' => $this->getMetaTags(),
+            'subtags' => $this->getSubTags(),
+            'more' => $this->getMore(),
+            'excerpts' => $this->getExcerpts(),
+            'score' => $this->getScore()
+        ];
+    }
 }

apps/twofactor_backupcodes/lib/Listener/ProviderDisabled.php

Spacing +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
 		$providers = $this->registry->getProviderStates($event->getUser());
 
 		// Loop over all providers. If all are disabled we remove the job
-		$state = array_reduce($providers, function (bool $carry, bool $enabled) {
+		$state = array_reduce($providers, function(bool $carry, bool $enabled) {
 			return $carry || $enabled;
 		}, false);
 

Indentation +22 added lines, -22 removed lines

@@ -35,33 +35,33 @@
 
 class ProviderDisabled implements IEventListener {
 
-	/** @var IRegistry */
-	private $registry;
+    /** @var IRegistry */
+    private $registry;
 
-	/** @var IJobList */
-	private $jobList;
+    /** @var IJobList */
+    private $jobList;
 
-	public function __construct(IRegistry $registry,
-								IJobList $jobList) {
-		$this->registry = $registry;
-		$this->jobList = $jobList;
-	}
+    public function __construct(IRegistry $registry,
+                                IJobList $jobList) {
+        $this->registry = $registry;
+        $this->jobList = $jobList;
+    }
 
-	public function handle(Event $event): void {
-		if (!($event instanceof RegistryEvent)) {
-			return;
-		}
+    public function handle(Event $event): void {
+        if (!($event instanceof RegistryEvent)) {
+            return;
+        }
 
-		$providers = $this->registry->getProviderStates($event->getUser());
+        $providers = $this->registry->getProviderStates($event->getUser());
 
-		// Loop over all providers. If all are disabled we remove the job
-		$state = array_reduce($providers, function (bool $carry, bool $enabled) {
-			return $carry || $enabled;
-		}, false);
+        // Loop over all providers. If all are disabled we remove the job
+        $state = array_reduce($providers, function (bool $carry, bool $enabled) {
+            return $carry || $enabled;
+        }, false);
 
-		if ($state === false) {
-			$this->jobList->remove(RememberBackupCodesJob::class, ['uid' => $event->getUser()->getUID()]);
-		}
-	}
+        if ($state === false) {
+            $this->jobList->remove(RememberBackupCodesJob::class, ['uid' => $event->getUser()->getUID()]);
+        }
+    }
 
 }

apps/oauth2/lib/Db/AccessToken.php

Indentation +15 added lines, -15 removed lines

@@ -34,20 +34,20 @@
  * @method void setHashedCode(string $token)
  */
 class AccessToken extends Entity {
-	/** @var int */
-	protected $tokenId;
-	/** @var int */
-	protected $clientId;
-	/** @var string */
-	protected $hashedCode;
-	/** @var string */
-	protected $encryptedToken;
+    /** @var int */
+    protected $tokenId;
+    /** @var int */
+    protected $clientId;
+    /** @var string */
+    protected $hashedCode;
+    /** @var string */
+    protected $encryptedToken;
 
-	public function __construct() {
-		$this->addType('id', 'int');
-		$this->addType('tokenId', 'int');
-		$this->addType('clientId', 'int');
-		$this->addType('hashedCode', 'string');
-		$this->addType('encryptedToken', 'string');
-	}
+    public function __construct() {
+        $this->addType('id', 'int');
+        $this->addType('tokenId', 'int');
+        $this->addType('clientId', 'int');
+        $this->addType('hashedCode', 'string');
+        $this->addType('encryptedToken', 'string');
+    }
 }

lib/private/Authentication/Exceptions/WipeTokenException.php

Indentation +9 added lines, -9 removed lines

@@ -26,16 +26,16 @@
 use OC\Authentication\Token\IToken;
 
 class WipeTokenException extends InvalidTokenException {
-	/** @var IToken */
-	private $token;
+    /** @var IToken */
+    private $token;
 
-	public function __construct(IToken $token) {
-		parent::__construct();
+    public function __construct(IToken $token) {
+        parent::__construct();
 
-		$this->token = $token;
-	}
+        $this->token = $token;
+    }
 
-	public function getToken(): IToken {
-		return $this->token;
-	}
+    public function getToken(): IToken {
+        return $this->token;
+    }
 }

apps/dav/lib/Migration/RegenerateBirthdayCalendars.php

Indentation +33 added lines, -33 removed lines

@@ -30,43 +30,43 @@
 
 class RegenerateBirthdayCalendars implements IRepairStep {
 
-	/** @var IJobList */
-	private $jobList;
+    /** @var IJobList */
+    private $jobList;
 
-	/** @var IConfig */
-	private $config;
+    /** @var IConfig */
+    private $config;
 
-	/**
-	 * @param IJobList $jobList
-	 * @param IConfig $config
-	 */
-	public function __construct(IJobList $jobList,
-								IConfig $config) {
-		$this->jobList = $jobList;
-		$this->config = $config;
-	}
+    /**
+     * @param IJobList $jobList
+     * @param IConfig $config
+     */
+    public function __construct(IJobList $jobList,
+                                IConfig $config) {
+        $this->jobList = $jobList;
+        $this->config = $config;
+    }
 
-	/**
-	 * @return string
-	 */
-	public function getName() {
-		return 'Regenerating birthday calendars to use new icons and fix old birthday events without year';
-	}
+    /**
+     * @return string
+     */
+    public function getName() {
+        return 'Regenerating birthday calendars to use new icons and fix old birthday events without year';
+    }
 
-	/**
-	 * @param IOutput $output
-	 */
-	public function run(IOutput $output) {
-		// only run once
-		if ($this->config->getAppValue('dav', 'regeneratedBirthdayCalendarsForYearFix') === 'yes') {
-			$output->info('Repair step already executed');
-			return;
-		}
+    /**
+     * @param IOutput $output
+     */
+    public function run(IOutput $output) {
+        // only run once
+        if ($this->config->getAppValue('dav', 'regeneratedBirthdayCalendarsForYearFix') === 'yes') {
+            $output->info('Repair step already executed');
+            return;
+        }
 
-		$output->info('Adding background jobs to regenerate birthday calendar');
-		$this->jobList->add(RegisterRegenerateBirthdayCalendars::class);
+        $output->info('Adding background jobs to regenerate birthday calendar');
+        $this->jobList->add(RegisterRegenerateBirthdayCalendars::class);
 
-		// if all were done, no need to redo the repair during next upgrade
-		$this->config->setAppValue('dav', 'regeneratedBirthdayCalendarsForYearFix', 'yes');
-	}
+        // if all were done, no need to redo the repair during next upgrade
+        $this->config->setAppValue('dav', 'regeneratedBirthdayCalendarsForYearFix', 'yes');
+    }
 }