Threema\MsgApi\PublicKeyStores\PhpFile

Complexity

Total Complexity

18

Size/Duplication

Total Lines	163
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	3
A	findPublicKey()	0	26	3
A	savePublicKey()	0	22	3
B	initFile()	0	41	7
A	create()	0	8	2

<?php
/**
 * @author Threema GmbH
 * @copyright Copyright (c) 2015-2016 Threema GmbH
 */


namespace Threema\MsgApi\PublicKeyStores;

use Threema\Core\Exception;
use Threema\MsgApi\PublicKeyStore;

/**
 * Store the PublicKeys in a PHP file
 *
 * @package Threema\MsgApi\PublicKeyStores
 */
class PhpFile extends PublicKeyStore
{
	/**
	 * PHP code used to prevent unauthorized access
	 *
	 * @var string
	 */
	private $fileBlocker = '<?php if (!isset($isMsgApiKeystore) || !$isMsgApiKeystore) die(\'Unauthorized access\');';

	/**
	 * @var string
	 */
	private $file;

	/**
	 * cache of array
	 *
	 * @var array
	 */
	private $keystore = array();

	/**
	 * @param string $file path to a read and writable (empty) PHP file
	 * @throws Exception if the file does not exist, is not writable or no valid PHP file
	 */
	public function __construct($file)
	{
		if (false === is_writable($file)) {
			throw new Exception('file ' . $file . ' does not exist or is not writable');
		}
		if (pathinfo($file, PATHINFO_EXTENSION) != 'php') {
			throw new Exception('file ' . $file . ' is not a valid PHP file');
		}
		$this->file = $file;
	}

	/**
	 * return null if the public key not found in the store
	 *
	 * @param string $threemaId
	 * @return null|string
	 */
	public function findPublicKey($threemaId)
	{
		$threemaId = strtoupper($threemaId);
		$publicKey = null;

		//Pre-check loaded array
		if (array_key_exists($threemaId, $this->keystore)) {
			$publicKey = $this->keystore[$threemaId];
			return $publicKey;
		}

		//Parse file
		$keystore = array();
		$isMsgApiKeystore = true;
		require $this->file;

		//Update cache
		$this->keystore = $keystore;

		//Check file content
		if (array_key_exists($threemaId, $keystore)) {
			$publicKey = $keystore[$threemaId];
		}

		return $publicKey;
	}

	/**
	 * save a public key
	 *
	 * @param string $threemaId
	 * @param string $publicKey
	 * @throws Exception
	 * @return bool
	 */
	public function savePublicKey($threemaId, $publicKey)
	{
		//create file if needed
		$this->initFile();

		//check for key
		if (array_key_exists($threemaId, $this->keystore)) {
			return false;
		}

		//add key
		$this->keystore[$threemaId] = $publicKey;
		$content = '$keystore[\'' . $threemaId . '\'] = \'' . $publicKey . '\';' . PHP_EOL;

		//write content
		$fileadd = file_put_contents($this->file, $content, FILE_APPEND);
		if (!$fileadd) {
			throw new Exception('could not write to file ' . $this->file);
		}

		return true;
	}

	/**
	 * initiate a php file
	 *
	 * @param null|resource file handle for file opened in r+ mode
	 * @return bool
	 * @throws Exception
	 */
	private function initFile($fileHandle = null)
	{
		//check if file does already contain content
		if (filesize($this->file) != 0) {
			return true;
		}

		//manually open file if no file handle is given
		$fileopened = null;
		if (null === $fileHandle) {
			$fileHandle = fopen($this->file, 'r+');
			$fileopened = true;

			//check for success
			if (null === $fileHandle) {
				throw new Exception('could not open file ' . $this->file);
			}
		}

		//create content
		$content = $this->fileBlocker . PHP_EOL;
		$content .= PHP_EOL;
		$content .= '//Threema MsgApi phpfile keystore' . PHP_EOL;
		$content .= '//DO NOT EDIT THIS FILE!' . PHP_EOL;
		$content .= PHP_EOL;

		//write file
		$fwrite = fwrite($fileHandle, $content);
		if (!$fwrite) {
			throw new Exception('could not write to file ' . $this->file);
		}

		//close file if necessary
		if ($fileopened) {
			$fclose = fclose($fileHandle);
			if (!$fclose) {
				throw new Exception('error while processing file ' . $this->file);
			}
		}
		return true;
	}

	/**
	 * Initialize a new PhpFile Public Key Store
	 * @param string $path the file will be created if it does not exist
	 * @return PhpFile
	 */
	public static function create($path) {
		if(false === file_exists($path)) {
			//touch
			touch($path);
		}

		return new PhpFile($path);
	}
}