FileMock.php

<?php

/**
 * This file is part of the Nette Tester.
 * Copyright (c) 2009 David Grudl (https://davidgrudl.com)
 */

namespace Tester;


/**
 * Mock files.
 */
class FileMock
{
	const PROTOCOL = 'mock';

	/** @var string[] */
	public static $files = array();

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

	/** @var int */
	private $pos;

	/** @var bool */
	private $isReadable;

	/** @var bool */
	private $isWritable;


	/**
	 * @return string  file name
	 */
	public static function create($content, $extension = NULL)
	{
		self::register();

		static $id;
		$name = self::PROTOCOL . '://' . (++$id) . '.' . $extension;
		self::$files[$name] = $content;
		return $name;
	}


	public static function register()
	{
		if (!in_array(self::PROTOCOL, stream_get_wrappers(), TRUE)) {
			stream_wrapper_register(self::PROTOCOL, __CLASS__);
		}
	}


	public function stream_open($path, $mode)
	{
		if (!preg_match('#^([rwaxc]).*?(\+)?#', $mode, $m)) {
			// Windows: failed to open stream: Bad file descriptor
			// Linux: failed to open stream: Illegal seek
			$this->warning("failed to open stream: Invalid mode '$mode'");
			return FALSE;

		} elseif ($m[1] === 'x' && isset(self::$files[$path])) {
			$this->warning('failed to open stream: File exists');
			return FALSE;

		} elseif ($m[1] === 'r' && !isset(self::$files[$path])) {
			$this->warning('failed to open stream: No such file or directory');
			return FALSE;

		} elseif ($m[1] === 'w' || $m[1] === 'x') {
			self::$files[$path] = '';
		}

		$this->content = & self::$files[$path];
		$this->pos = $m[1] === 'a' ? strlen($this->content) : 0;

		$this->isReadable = isset($m[2]) || $m[1] === 'r';
		$this->isWritable = isset($m[2]) || $m[1] !== 'r';

		return TRUE;
	}


	public function stream_read($len)
	{
		if (!$this->isReadable) {
			return '';
		}

		$res = substr($this->content, $this->pos, $len);
		$this->pos += strlen($res);
		return $res;
	}


	public function stream_write($data)
	{
		if (!$this->isWritable) {
			return 0;
		}

		$this->content = substr($this->content, 0, $this->pos)
			. str_repeat("\x00", max(0, $this->pos - strlen($this->content)))
			. $data
			. substr($this->content, $this->pos + strlen($data));
		$this->pos += strlen($data);
		return strlen($data);
	}


	public function stream_tell()
	{
		return $this->pos;
	}


	public function stream_eof()
	{
		return $this->pos >= strlen($this->content);
	}


	public function stream_seek($offset, $whence)
	{
		if ($whence === SEEK_CUR) {
			$offset += $this->pos;
		} elseif ($whence === SEEK_END) {
			$offset += strlen($this->content);
		}
		if ($offset >= 0) {
			$this->pos = $offset;
			return TRUE;
		} else {
			return FALSE;
		}
	}


	public function stream_truncate($size)
	{
		$this->content = (string) substr($this->content, 0, $size)
			. str_repeat("\x00", max(0, $size - strlen($this->content)));
		return TRUE;
	}


	public function stream_stat()
	{
		return array('mode' => 0100666, 'size' => strlen($this->content));
	}


	public function url_stat($path, $flags)
	{
		return isset(self::$files[$path])
			? array('mode' => 0100666, 'size' => strlen(self::$files[$path]))
			: FALSE;
	}


	public function stream_lock($operation)
	{
		return FALSE;
	}


	public function unlink($path)
	{
		if (isset(self::$files[$path])) {
			unset(self::$files[$path]);
			return TRUE;
		}

		$this->warning('No such file');
		return FALSE;
	}


	private function warning($message)
	{
		$bt = PHP_VERSION_ID < 50400 ? debug_backtrace(FALSE) : debug_backtrace(0, 3);
		if (isset($bt[2]['function'])) {
			$message = $bt[2]['function'] . '(' . @$bt[2]['args'][0] . '): ' . $message;
		}

		trigger_error($message, E_USER_WARNING);
	}

}