nextcloud / passman

lib/Service/CredentialService.php

Doc Comments +17 added lines

@@ -43,14 +43,24 @@ 
 	public function updateCredential($credential) {
 		return $this->credentialMapper->updateCredential($credential);
 	}
+
+	/**
+	 * @param Credential $credential
+	 */
 	public function upd($credential) {
 		return $this->credentialMapper->upd($credential);
 	}
 
+	/**
+	 * @param Credential $credential
+	 */
 	public function deleteCredential($credential){
 		return $this->credentialMapper->deleteCredential($credential);
 	}
 
+	/**
+	 * @param integer $vault_id
+	 */
 	public function getCredentialsByVaultId($vault_id, $user_id) {
 		return $this->credentialMapper->getCredentialsByVaultId($vault_id, $user_id);
 	}
@@ -60,6 +70,9 @@ 
 		return array_pop($credentials);
 	}
 
+	/**
+	 * @param integer $timestamp
+	 */
 	public function getExpiredCredentials($timestamp) {
 		return $this->credentialMapper->getExpiredCredentials($timestamp);
 	}
@@ -77,6 +90,10 @@ 
 
         throw new DoesNotExistException("Did expect one result but found none when executing");
 	}
+
+	/**
+	 * @param integer $credential_id
+	 */
 	public function getCredentialLabelById($credential_id){
 		return $this->credentialMapper->getCredentialLabelById($credential_id);
 	}

Indentation +15 added lines, -15 removed lines

@@ -23,11 +23,11 @@ 
 class CredentialService {
 
 	private $credentialMapper;
-    private $sharingACL;
+	private $sharingACL;
 
 	public function __construct(CredentialMapper $credentialMapper, SharingACLMapper $sharingACL) {
 		$this->credentialMapper = $credentialMapper;
-        $this->sharingACL = $sharingACL;
+		$this->sharingACL = $sharingACL;
 	}
 
 	/**
@@ -65,23 +65,23 @@ 
 	}
 
 	public function getCredentialById($credential_id, $user_id){
-        $credential = $this->credentialMapper->getCredentialById($credential_id);
-        if ($credential->getUserId() == $user_id){
-            return $credential;
-        }
-        else {
-            $acl = $this->sharingACL->getItemACL($user_id, $credential->getGuid());
-            if ($acl->hasPermission(SharingACL::READ));
-            return $credential;
-        }
-
-        throw new DoesNotExistException("Did expect one result but found none when executing");
+		$credential = $this->credentialMapper->getCredentialById($credential_id);
+		if ($credential->getUserId() == $user_id){
+			return $credential;
+		}
+		else {
+			$acl = $this->sharingACL->getItemACL($user_id, $credential->getGuid());
+			if ($acl->hasPermission(SharingACL::READ));
+			return $credential;
+		}
+
+		throw new DoesNotExistException("Did expect one result but found none when executing");
 	}
 	public function getCredentialLabelById($credential_id){
 		return $this->credentialMapper->getCredentialLabelById($credential_id);
 	}
 
 	public function getCredentialByGUID($credential_guid, $user_id = null){
-	    return $this->credentialMapper->getCredentialByGUID($credential_guid, $user_id);
-    }
+		return $this->credentialMapper->getCredentialByGUID($credential_guid, $user_id);
+	}
 }
\ No newline at end of file

lib/Service/ShareService.php

Doc Comments +1 added lines, -2 removed lines

@@ -49,6 +49,7 @@ 
 	 * @param $target_item_guid string      The shared item GUID
 	 * @param $request_array    array
 	 * @param $permissions      integer     Must be created with a bitmask from options on the ShareRequest class
+	 * @param string $credential_owner
 	 * @return array                        Array of sharing requests
 	 */
 	public function createBulkRequests($target_item_id, $target_item_guid, $request_array, $permissions, $credential_owner) {
@@ -253,7 +254,6 @@ 
 	/**
 	 * Delete ACL
 	 *
-	 * @param  ShareRequest $request
 	 * @return \OCA\Passman\Db\ShareRequest[]
 	 */
 	public function deleteShareACL(SharingACL $ACL) {
@@ -277,7 +277,6 @@ 
 	/**
 	 * Get pending share requests by guid and uid
 	 *
-	 * @param  ShareRequest $request
 	 * @return \OCA\Passman\Db\ShareRequest[]
 	 */
 	public function getPendingShareRequestsForCredential($item_guid, $user_id) {

Indentation +24 added lines, -24 removed lines

@@ -176,31 +176,31 @@ 
 	}
 
 
-    /**
-     * Deletes a share request by the item ID
-     * @param ShareRequest $request
-     * @return \PDOStatement
-     */
+	/**
+	 * Deletes a share request by the item ID
+	 * @param ShareRequest $request
+	 * @return \PDOStatement
+	 */
 	public function cleanItemRequestsForUser(ShareRequest $request) {
 		return $this->shareRequest->cleanItemRequestsForUser($request->getItemId(), $request->getTargetUserId());
 	}
 
-    /**
-     * Get an share request by id
-     * @param $id
-     * @return ShareRequest
-     */
+	/**
+	 * Get an share request by id
+	 * @param $id
+	 * @return ShareRequest
+	 */
 	public function getShareRequestById($id) {
 		return $this->shareRequest->getShareRequestById($id);
 	}
 
-    /**
-     * Get an share request by $item_guid and $target_vault_guid
-     *
-     * @param $item_guid
-     * @param $target_vault_guid
-     * @return ShareRequest
-     */
+	/**
+	 * Get an share request by $item_guid and $target_vault_guid
+	 *
+	 * @param $item_guid
+	 * @param $target_vault_guid
+	 * @return ShareRequest
+	 */
 	public function getRequestByGuid($item_guid, $target_vault_guid) {
 		return $this->shareRequest->getRequestByItemAndVaultGuid($item_guid, $target_vault_guid);
 	}
@@ -260,11 +260,11 @@ 
 		return $this->sharingACL->deleteShareACL($ACL);
 	}
 
-    /**
-     * Updates the given ACL entry
-     * @param SharingACL $sharingACL
-     * @return SharingACL
-     */
+	/**
+	 * Updates the given ACL entry
+	 * @param SharingACL $sharingACL
+	 * @return SharingACL
+	 */
 	public function updateCredentialACL(SharingACL $sharingACL) {
 		return $this->sharingACL->updateCredentialACL($sharingACL);
 	}
@@ -286,6 +286,6 @@ 
 
 
 	public function updatePendingShareRequestsForCredential($item_guid, $user_id, $permissions){
-	    return $this->shareRequest->updatePendinRequestPermissions($item_guid, $user_id, $permissions);
-    }
+		return $this->shareRequest->updatePendinRequestPermissions($item_guid, $user_id, $permissions);
+	}
 }
\ No newline at end of file

controller/credentialcontroller.php

Indentation +19 added lines, -19 removed lines

@@ -255,26 +255,26 @@
 	 * @NoAdminRequired
 	 */
 	public function getRevision($credential_guid) {
-	    try {
-            $credential = $this->credentialService->getCredentialByGUID($credential_guid);
-        }
-        catch (DoesNotExistException $ex){
-            return new NotFoundJSONResponse();
-        }
+		try {
+			$credential = $this->credentialService->getCredentialByGUID($credential_guid);
+		}
+		catch (DoesNotExistException $ex){
+			return new NotFoundJSONResponse();
+		}
 
-        // If the request was made by the owner of the credential
-        if ($this->userId == $credential->getUserId()) {
-            $result = $this->credentialRevisionService->getRevisions($credential->getId(), $this->userId);
-        }
-        else {
-            $acl = $this->sharingService->getACL($this->userId, $credential_guid);
-            if ($acl->hasPermission(SharingACL::HISTORY)){
-                $result = $this->credentialRevisionService->getRevisions($credential->getId());
-            }
-            else {
-                return new NotFoundJSONResponse();
-            }
-        }
+		// If the request was made by the owner of the credential
+		if ($this->userId == $credential->getUserId()) {
+			$result = $this->credentialRevisionService->getRevisions($credential->getId(), $this->userId);
+		}
+		else {
+			$acl = $this->sharingService->getACL($this->userId, $credential_guid);
+			if ($acl->hasPermission(SharingACL::HISTORY)){
+				$result = $this->credentialRevisionService->getRevisions($credential->getId());
+			}
+			else {
+				return new NotFoundJSONResponse();
+			}
+		}
 
 		return new JSONResponse($result);
 	}

controller/vaultcontroller.php

Indentation +1 added lines, -1 removed lines

@@ -79,7 +79,7 @@
 		try {
 			$vault = $this->vaultService->getByGuid($vault_guid, $this->userId);
 		} catch (DoesNotExistException $e) {
-            return new NotFoundJSONResponse();
+			return new NotFoundJSONResponse();
 		}
 		$result = array();
 		if ($vault) {

controller/sharecontroller.php

Indentation +2 added lines, -2 removed lines

@@ -409,11 +409,11 @@
 		//@TODO Check expire date
 		$acl = $this->shareService->getACL(null, $credential_guid);
 
-        if ($acl->getExpire() > 0 && Utils::getTime() > $acl->getExpire()) {
+		if ($acl->getExpire() > 0 && Utils::getTime() > $acl->getExpire()) {
 			return new NotFoundJSONResponse();
 		}
 
-        $views = $acl->getExpireViews();
+		$views = $acl->getExpireViews();
 		if ($views === 0) {
 			return new NotFoundJSONResponse();
 		} else if ($views != -1) {

lib/AppInfo/Application.php

Indentation +5 added lines, -5 removed lines

@@ -55,10 +55,10 @@ 
 				$server->getUserManager(),
  				$c->query('ActivityService'),
  				$c->query('VaultService'),
-                $c->query('ShareService'),
-                $c->query('CredentialService'),
-                $c->query('NotificationService'),
-                $c->query('FileService')
+				$c->query('ShareService'),
+				$c->query('CredentialService'),
+				$c->query('NotificationService'),
+				$c->query('FileService')
 			);
 		});
 
@@ -94,7 +94,7 @@ 
 		$container->registerAlias('ActivityService', ActivityService::class);
 		$container->registerAlias('VaultService', VaultService::class);
 		$container->registerAlias('FileService', FileService::class);
-        $container->registerAlias('ShareService', ShareService::class);
+		$container->registerAlias('ShareService', ShareService::class);
 		$container->registerAlias('Utils', Utils::class);
 	}
 

lib/Db/SharingACL.php

Indentation +42 added lines, -42 removed lines

@@ -38,50 +38,50 @@
 class SharingACL extends PermissionEntity implements \JsonSerializable
 {
 
-    protected
-        $itemId,
-        $itemGuid,
-        $userId,
-        $created,
-        $expire,
+	protected
+		$itemId,
+		$itemGuid,
+		$userId,
+		$created,
+		$expire,
 		$expireViews,
-        $permissions,
-        $vaultId,
-        $vaultGuid,
-        $sharedKey;
+		$permissions,
+		$vaultId,
+		$vaultGuid,
+		$sharedKey;
 
 
-    public function __construct() {
-        // add types in constructor
-        $this->addType('itemId', 'integer');
-        $this->addType('created', 'integer');
-        $this->addType('expire', 'integer');
-        $this->addType('expireViews', 'integer');
-        $this->addType('permissions', 'integer');
-    }
+	public function __construct() {
+		// add types in constructor
+		$this->addType('itemId', 'integer');
+		$this->addType('created', 'integer');
+		$this->addType('expire', 'integer');
+		$this->addType('expireViews', 'integer');
+		$this->addType('permissions', 'integer');
+	}
 
-    /**
-     * Specify data which should be serialized to JSON
-     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
-     * @return mixed data which can be serialized by <b>json_encode</b>,
-     * which is a value of any type other than a resource.
-     * @since 5.4.0
-     */
-    function jsonSerialize()
-    {
-        return [
-            'acl_id' => $this->getId(),
-            'item_id' => $this->getItemId(),
-            'item_guid' => $this->getItemGuid(),
-            'user_id' => $this->getUserId(),
-            'created' => $this->getCreated(),
-            'expire' => $this->getExpire(),
-            'expire_views' => $this->getExpireViews(),
-            'permissions' => $this->getPermissions(),
-            'vault_id' => $this->getVaultId(),
-            'vault_guid' => $this->getVaultGuid(),
-            'shared_key' => $this->getSharedKey(),
-            'pending' => false,
-        ];
-    }
+	/**
+	 * Specify data which should be serialized to JSON
+	 * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
+	 * @return mixed data which can be serialized by <b>json_encode</b>,
+	 * which is a value of any type other than a resource.
+	 * @since 5.4.0
+	 */
+	function jsonSerialize()
+	{
+		return [
+			'acl_id' => $this->getId(),
+			'item_id' => $this->getItemId(),
+			'item_guid' => $this->getItemGuid(),
+			'user_id' => $this->getUserId(),
+			'created' => $this->getCreated(),
+			'expire' => $this->getExpire(),
+			'expire_views' => $this->getExpireViews(),
+			'permissions' => $this->getPermissions(),
+			'vault_id' => $this->getVaultId(),
+			'vault_guid' => $this->getVaultGuid(),
+			'shared_key' => $this->getSharedKey(),
+			'pending' => false,
+		];
+	}
 }
\ No newline at end of file

lib/Db/CredentialMapper.php

Indentation +16 added lines, -16 removed lines

@@ -44,18 +44,18 @@ 
 		return $this->findEntities($sql, [$timestamp]);
 	}
 
-    /**
-     * @param $credential_id
-     * @param null $user_id
-     * @return Credential
-     */
+	/**
+	 * @param $credential_id
+	 * @param null $user_id
+	 * @return Credential
+	 */
 	public function getCredentialById($credential_id, $user_id = null){
 		$sql = 'SELECT * FROM `*PREFIX*passman_credentials` ' .
 			'WHERE `id` = ?';
-        // If we want to check the owner, add it to the query
+		// If we want to check the owner, add it to the query
 		$params = [$credential_id];
-        if ($user_id !== null){
-        	$sql .= ' and `user_id` = ? ';
+		if ($user_id !== null){
+			$sql .= ' and `user_id` = ? ';
 			array_push($params, $user_id);
 		}
 		return $this->findEntity($sql,$params);
@@ -135,18 +135,18 @@ 
 		$this->update($credential);
 	}
 
-    /**
-     * Finds a credential by the given guid
-     * @param $credential_guid
-     * @return Credential
-     */
+	/**
+	 * Finds a credential by the given guid
+	 * @param $credential_guid
+	 * @return Credential
+	 */
 	public function getCredentialByGUID($credential_guid, $user_id = null){
-	    $q = 'SELECT * FROM `*PREFIX*passman_credentials` WHERE guid = ? ';
+		$q = 'SELECT * FROM `*PREFIX*passman_credentials` WHERE guid = ? ';
 		$params = [$credential_guid];
 		if ($user_id !== null){
 			$q .= ' and `user_id` = ? ';
 			array_push($params, $user_id);
 		}
-        return $this->findEntity($q, $params);
-    }
+		return $this->findEntity($q, $params);
+	}
 }
\ No newline at end of file

lib/Db/SharingACLMapper.php

Indentation +67 added lines, -67 removed lines

@@ -16,81 +16,81 @@
 use OCA\Passman\Utility\Utils;
 
 class SharingACLMapper extends Mapper {
-    const TABLE_NAME = '*PREFIX*passman_sharing_acl';
+	const TABLE_NAME = '*PREFIX*passman_sharing_acl';
 
-    public function __construct(IDBConnection $db, Utils $utils) {
-        parent::__construct($db, 'passman_sharing_acl');
-        $this->utils = $utils;
-    }
+	public function __construct(IDBConnection $db, Utils $utils) {
+		parent::__construct($db, 'passman_sharing_acl');
+		$this->utils = $utils;
+	}
 
-    /**
-     * Gets all the credential data for the given user
-     * @param $userId
-     * @param $item_guid
-     * @return SharingACL[]
-     */
-    public function getCredentialPermissions(IUser $userId, $item_guid){
-        $sql = "SELECT * FROM ". self::TABLE_NAME ." WHERE user_id = ? AND item_guid = ?";
+	/**
+	 * Gets all the credential data for the given user
+	 * @param $userId
+	 * @param $item_guid
+	 * @return SharingACL[]
+	 */
+	public function getCredentialPermissions(IUser $userId, $item_guid){
+		$sql = "SELECT * FROM ". self::TABLE_NAME ." WHERE user_id = ? AND item_guid = ?";
 
-        return $this->findEntities($sql, [$userId, $item_guid]);
-    }
+		return $this->findEntities($sql, [$userId, $item_guid]);
+	}
 
-    public function createACLEntry(SharingACL $acl){
-        return $this->insert($acl);
-    }
+	public function createACLEntry(SharingACL $acl){
+		return $this->insert($acl);
+	}
 
-    /**
-     * Gets the currently accepted share requests from the given user for the given vault guid
-     * @param $user_id
-     * @param $vault_id
-     * @return SharingACL[]
-     */
-    public function getVaultEntries($user_id, $vault_id) {
-        $q = "SELECT * FROM ". self::TABLE_NAME ." WHERE user_id = ? AND vault_guid = ?";
-        return $this->findEntities($q, [$user_id, $vault_id]);
-    }
+	/**
+	 * Gets the currently accepted share requests from the given user for the given vault guid
+	 * @param $user_id
+	 * @param $vault_id
+	 * @return SharingACL[]
+	 */
+	public function getVaultEntries($user_id, $vault_id) {
+		$q = "SELECT * FROM ". self::TABLE_NAME ." WHERE user_id = ? AND vault_guid = ?";
+		return $this->findEntities($q, [$user_id, $vault_id]);
+	}
 
-    /**
-     * Gets the acl for a given item guid
-     * @param $user_id
-     * @param $item_guid
-     * @return SharingACL
-     */
-    public function getItemACL($user_id, $item_guid) {
-        $q = "SELECT * FROM " . self::TABLE_NAME . " WHERE item_guid = ? AND ";
-        $filter = [$item_guid];
-        if ($user_id == null){
-            $q .= 'user_id is null';
-        }
-        else {
-            $q .= 'user_id = ? ';
-            $filter[] = $user_id;
-        }
-        return $this->findEntity($q, $filter);
-    }
+	/**
+	 * Gets the acl for a given item guid
+	 * @param $user_id
+	 * @param $item_guid
+	 * @return SharingACL
+	 */
+	public function getItemACL($user_id, $item_guid) {
+		$q = "SELECT * FROM " . self::TABLE_NAME . " WHERE item_guid = ? AND ";
+		$filter = [$item_guid];
+		if ($user_id == null){
+			$q .= 'user_id is null';
+		}
+		else {
+			$q .= 'user_id = ? ';
+			$filter[] = $user_id;
+		}
+		return $this->findEntity($q, $filter);
+	}
 
-    /**
-     * Update the acl for a given item guid
-     * @param $user_id
-     * @param $item_guid
-     * @return SharingACL
-     */
-    public function updateCredentialACL(SharingACL $sharingACL) {
-        return $this->update($sharingACL);
-    }
+	/**
+	 * Update the acl for a given item guid
+	 * @param $user_id
+	 * @param $item_guid
+	 * @return SharingACL
+	 */
+	public function updateCredentialACL(SharingACL $sharingACL) {
+		return $this->update($sharingACL);
+	}
 
-    /**
-     * Gets the currently accepted share requests from the given user for the given vault guid
-     * @param $user_id
-     * @param $vault_id
-     * @return SharingACL[]
-     */
-    public function getCredentialAclList($item_guid) {
-        $q = "SELECT * FROM ". self::TABLE_NAME ." WHERE item_guid = ?";
-        return $this->findEntities($q, [$item_guid]);
-    }
+	/**
+	 * Gets the currently accepted share requests from the given user for the given vault guid
+	 * @param $user_id
+	 * @param $vault_id
+	 * @return SharingACL[]
+	 */
+	public function getCredentialAclList($item_guid) {
+		$q = "SELECT * FROM ". self::TABLE_NAME ." WHERE item_guid = ?";
+		return $this->findEntities($q, [$item_guid]);
+	}
 
-    public function deleteShareACL(SharingACL $ACL){
-    	return $this->delete($ACL);
+	public function deleteShareACL(SharingACL $ACL){
+		return $this->delete($ACL);
 	}
 }
\ No newline at end of file