HOME

<?php

/**
 * @file classes/security/AccessKeyDAO.inc.php
 *
 * Copyright (c) 2014-2021 Simon Fraser University
 * Copyright (c) 2000-2021 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class AccessKeyDAO
 * @ingroup security
 * @see AccessKey
 *
 * @brief Operations for retrieving and modifying AccessKey objects.
 */


import('lib.pkp.classes.security.AccessKey');

class AccessKeyDAO extends DAO {

	/**
	 * Retrieve an accessKey by ID.
	 * @param $accessKeyId int
	 * @return AccessKey
	 */
	function &getAccessKey($accessKeyId) {
		$result = $this->retrieve(
			sprintf(
				'SELECT * FROM access_keys WHERE access_key_id = ? AND expiry_date > %s',
				$this->datetimeToDB(Core::getCurrentDate())
			),
			[(int) $accessKeyId]
		);
		$row = $result->current();
		return $row ? $this->_returnAccessKeyFromRow((array) $row) : null;
	}

	/**
	 * Retrieve a accessKey object user ID.
	 * @param $context string
	 * @param $userId int
	 * @return AccessKey
	 */
	function &getAccessKeyByUserId($context, $userId) {
		$result = $this->retrieve(
			sprintf(
				'SELECT * FROM access_keys WHERE context = ? AND user_id = ? AND expiry_date > %s',
				$this->datetimeToDB(Core::getCurrentDate())
			),
			[$context, $userId]
		);
		$row = $result->current();
		return $row ? $this->_returnAccessKeyFromRow((array) $row) : null;
	}

	/**
	 * Retrieve a accessKey object by key.
	 * @param $context string
	 * @param $userId int
	 * @param $keyHash string
	 * @param $assocId int
	 * @return AccessKey
	 */
	function &getAccessKeyByKeyHash($context, $userId, $keyHash, $assocId = null) {
		$paramArray = array($context, $keyHash, (int) $userId);
		if (isset($assocId)) $paramArray[] = (int) $assocId;
		$result = $this->retrieve(
			sprintf(
				'SELECT * FROM access_keys WHERE context = ? AND key_hash = ? AND user_id = ? AND expiry_date > %s' . (isset($assocId)?' AND assoc_id = ?':''),
				$this->datetimeToDB(Core::getCurrentDate())
			),
			$paramArray
		);
		$row = $result->current();
		return $row ? $this->_returnAccessKeyFromRow((array) $row) : null;
	}

	/**
	 * Instantiate and return a new data object.
	 * @return AccessKey
	 */
	function newDataObject() {
		return new AccessKey();
	}

	/**
	 * Internal function to return an AccessKey object from a row.
	 * @param $row array
	 * @return AccessKey
	 */
	function &_returnAccessKeyFromRow($row) {
		$accessKey = $this->newDataObject();
		$accessKey->setId($row['access_key_id']);
		$accessKey->setKeyHash($row['key_hash']);
		$accessKey->setExpiryDate($this->datetimeFromDB($row['expiry_date']));
		$accessKey->setContext($row['context']);
		$accessKey->setAssocId($row['assoc_id']);
		$accessKey->setUserId($row['user_id']);

		HookRegistry::call('AccessKeyDAO::_returnAccessKeyFromRow', array(&$accessKey, &$row));

		return $accessKey;
	}

	/**
	 * Insert a new accessKey.
	 * @param $accessKey AccessKey
	 */
	function insertObject($accessKey) {
		$this->update(
			sprintf('INSERT INTO access_keys
				(key_hash, expiry_date, context, assoc_id, user_id)
				VALUES
				(?, %s, ?, ?, ?)',
				$this->datetimeToDB($accessKey->getExpiryDate())),
			[
				$accessKey->getKeyHash(),
				$accessKey->getContext(),
				$accessKey->getAssocId()==''?null:(int) $accessKey->getAssocId(),
				(int) $accessKey->getUserId()
			]
		);

		$accessKey->setId($this->getInsertId());
		return $accessKey->getId();
	}

	/**
	 * Update an existing accessKey.
	 * @param $accessKey AccessKey
	 */
	function updateObject($accessKey) {
		return $this->update(
			sprintf('UPDATE access_keys
				SET
					key_hash = ?,
					expiry_date = %s,
					context = ?,
					assoc_id = ?,
					user_id = ?
				WHERE access_key_id = ?',
				$this->datetimeToDB($accessKey->getExpiryDate())),
			[
				$accessKey->getKeyHash(),
				$accessKey->getContext(),
				$accessKey->getAssocId()==''?null:(int) $accessKey->getAssocId(),
				(int) $accessKey->getUserId(),
				(int) $accessKey->getId()
			]
		);
	}

	/**
	 * Delete an accessKey.
	 * @param $accessKey AccessKey
	 */
	function deleteObject($accessKey) {
		return $this->deleteAccessKeyById($accessKey->getId());
	}

	/**
	 * Delete an accessKey by ID.
	 * @param $accessKeyId int
	 */
	function deleteAccessKeyById($accessKeyId) {
		return $this->update('DELETE FROM access_keys WHERE access_key_id = ?', [(int) $accessKeyId]);
	}

	/**
	 * Transfer access keys to another user ID.
	 * @param $oldUserId int
	 * @param $newUserId int
	 */
	function transferAccessKeys($oldUserId, $newUserId) {
		return $this->update(
			'UPDATE access_keys SET user_id = ? WHERE user_id = ?',
			[(int) $newUserId, (int) $oldUserId]
		);
	}

	/**
	 * Delete expired access keys.
	 */
	function deleteExpiredKeys() {
		return $this->update(
			sprintf(
				'DELETE FROM access_keys WHERE expiry_date <= %s',
				$this->datetimeToDB(Core::getCurrentDate())
			)
		);
	}

	/**
	 * Get the ID of the last inserted accessKey.
	 * @return int
	 */
	function getInsertId() {
		return $this->_getInsertId('access_keys', 'access_key_id');
	}
}