CodeFile.php 3.53 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10 11
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\gii;

use Yii;
use yii\base\Object;
Qiang Xue committed
12 13
use yii\gii\components\TextDiff;
use yii\helpers\Html;
Qiang Xue committed
14
use yii\helpers\StringHelper;
Qiang Xue committed
15 16

/**
17
 * CodeFile represents a code file to be generated.
Qiang Xue committed
18 19 20 21 22 23
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class CodeFile extends Object
{
24 25 26
	/**
	 * The code file is new.
	 */
Qiang Xue committed
27
	const OP_NEW = 'new';
28 29 30
	/**
	 * The code file already exists, and the new one may need to overwrite it.
	 */
Qiang Xue committed
31
	const OP_OVERWRITE = 'overwrite';
32 33 34
	/**
	 * The new code file and the existing one are identical.
	 */
Qiang Xue committed
35 36
	const OP_SKIP = 'skip';

37 38 39
	/**
	 * @var string an ID that uniquely identifies this code file.
	 */
Qiang Xue committed
40
	public $id;
Qiang Xue committed
41 42 43 44 45
	/**
	 * @var string the file path that the new code should be saved to.
	 */
	public $path;
	/**
46
	 * @var string the newly generated code content
Qiang Xue committed
47 48 49
	 */
	public $content;
	/**
50
	 * @var string the operation to be performed. This can be [[OP_NEW]], [[OP_OVERWRITE]] or [[OP_SKIP]].
Qiang Xue committed
51 52 53 54 55 56
	 */
	public $operation;

	/**
	 * Constructor.
	 * @param string $path the file path that the new code should be saved to.
57
	 * @param string $content the newly generated code content.
Qiang Xue committed
58 59 60 61 62
	 */
	public function __construct($path, $content)
	{
		$this->path = strtr($path, array('/' => DIRECTORY_SEPARATOR, '\\' => DIRECTORY_SEPARATOR));
		$this->content = $content;
Qiang Xue committed
63
		$this->id = md5($this->path);
Qiang Xue committed
64 65 66 67 68 69 70 71
		if (is_file($path)) {
			$this->operation = file_get_contents($path) === $content ? self::OP_SKIP : self::OP_OVERWRITE;
		} else {
			$this->operation = self::OP_NEW;
		}
	}

	/**
72 73
	 * Saves the code into the file specified by [[path]].
	 * @return string|boolean the error occurred while saving the code file, or true if no error.
Qiang Xue committed
74 75 76 77 78 79 80
	 */
	public function save()
	{
		$module = Yii::$app->controller->module;
		if ($this->operation === self::OP_NEW) {
			$dir = dirname($this->path);
			if (!is_dir($dir)) {
81
				$mask = @umask(0);
Qiang Xue committed
82
				$result = @mkdir($dir, $module->newDirMode, true);
83
				@umask($mask);
Qiang Xue committed
84
				if (!$result) {
Qiang Xue committed
85
					return "Unable to create the directory '$dir'.";
Qiang Xue committed
86 87 88 89
				}
			}
		}
		if (@file_put_contents($this->path, $this->content) === false) {
Qiang Xue committed
90
			return "Unable to write the file '{$this->path}'.";
Qiang Xue committed
91
		} else {
92
			$mask = @umask(0);
Qiang Xue committed
93
			@chmod($this->path, $module->newFileMode);
94
			@umask($mask);
Qiang Xue committed
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
		}
		return true;
	}

	/**
	 * @return string the code file path relative to the application base path.
	 */
	public function getRelativePath()
	{
		if (strpos($this->path, Yii::$app->basePath) === 0) {
			return substr($this->path, strlen(Yii::$app->basePath) + 1);
		} else {
			return $this->path;
		}
	}

	/**
	 * @return string the code file extension (e.g. php, txt)
	 */
	public function getType()
	{
		if (($pos = strrpos($this->path, '.')) !== false) {
			return substr($this->path, $pos + 1);
		} else {
			return 'unknown';
		}
	}
Qiang Xue committed
122 123 124 125 126 127 128 129 130 131

	public function preview()
	{
		if (($pos = strrpos($this->path, '.')) !== false) {
			$type = substr($this->path, $pos + 1);
		} else {
			$type = 'unknown';
		}

		if ($type === 'php') {
132 133 134
			return highlight_string($this->content, true);
		} elseif (!in_array($type, array('jpg', 'gif', 'png', 'exe'))) {
			return nl2br(Html::encode($this->content));
Qiang Xue committed
135
		} else {
136
			return false;
Qiang Xue committed
137 138 139 140 141
		}
	}

	public function diff()
	{
142 143
		$type = strtolower($this->getType());
		if (in_array($type, array('jpg', 'gif', 'png', 'exe'))) {
Qiang Xue committed
144 145
			return false;
		} elseif ($this->operation === self::OP_OVERWRITE) {
Qiang Xue committed
146
			return StringHelper::diff(file($this->path), $this->content);
Qiang Xue committed
147 148 149 150
		} else {
			return '';
		}
	}
Qiang Xue committed
151
}