1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Code\Generator;
use Magento\Framework\Exception\FileSystemException;
/**
* Manages generated code.
*/
class Io
{
/**
* Default code generation directory
* Should correspond the value from \Magento\Framework\Filesystem
*/
const DEFAULT_DIRECTORY = 'generated/code';
/**
* Path to directory where new file must be created
*
* @var string
*/
private $_generationDirectory;
/**
* @var \Magento\Framework\Filesystem\Driver\File
*/
private $filesystemDriver;
/**
* @param \Magento\Framework\Filesystem\Driver\File $filesystemDriver
* @param null|string $generationDirectory
*/
public function __construct(
\Magento\Framework\Filesystem\Driver\File $filesystemDriver,
$generationDirectory = null
) {
$this->filesystemDriver = $filesystemDriver;
$this->initGeneratorDirectory($generationDirectory);
}
/**
* Get path to generation directory
*
* @param null|string $directory
* @return string
*/
protected function initGeneratorDirectory($directory = null)
{
if ($directory) {
$this->_generationDirectory = rtrim($directory, '/') . '/';
} else {
$this->_generationDirectory = realpath(__DIR__ . '/../../../../') . '/' . self::DEFAULT_DIRECTORY . '/';
}
}
/**
* @param string $className
* @return string
*/
public function getResultFileDirectory($className)
{
$fileName = $this->generateResultFileName($className);
$pathParts = explode('/', $fileName);
unset($pathParts[count($pathParts) - 1]);
return implode('/', $pathParts) . '/';
}
/**
* @param string $className
* @return string
*/
public function generateResultFileName($className)
{
return $this->_generationDirectory . ltrim(str_replace(['\\', '_'], '/', $className), '/') . '.php';
}
/**
* @param string $fileName
* @param string $content
* @throws FileSystemException
* @return bool
*/
public function writeResultFile($fileName, $content)
{
/**
* Rename is atomic on *nix systems, while file_put_contents is not. Writing to a
* temporary file whose name is process-unique and renaming to the real location helps
* avoid race conditions. Race condition can occur if the compiler has not been run, when
* multiple processes are attempting to access the generated file simultaneously.
*/
$content = "<?php\n" . $content;
$tmpFile = $fileName . "." . getmypid();
$this->filesystemDriver->filePutContents($tmpFile, $content);
try {
$success = $this->filesystemDriver->rename($tmpFile, $fileName);
} catch (FileSystemException $e) {
if (!$this->fileExists($fileName)) {
throw $e;
} else {
/**
* Due to race conditions, file may have already been written, causing rename to fail. As long as
* the file exists, everything is okay.
*/
$success = true;
}
}
return $success;
}
/**
* @return bool
*/
public function makeGenerationDirectory()
{
return $this->_makeDirectory($this->_generationDirectory);
}
/**
* @param string $className
* @return bool
*/
public function makeResultFileDirectory($className)
{
return $this->_makeDirectory($this->getResultFileDirectory($className));
}
/**
* @return string
*/
public function getGenerationDirectory()
{
return $this->_generationDirectory;
}
/**
* @param string $fileName
* @return bool
*/
public function fileExists($fileName)
{
return $this->filesystemDriver->isExists($fileName);
}
/**
* Wrapper for include
*
* @param string $fileName
* @return mixed
* @codeCoverageIgnore
*/
public function includeFile($fileName)
{
return include $fileName;
}
/**
* @param string $directory
* @return bool
*/
private function _makeDirectory($directory)
{
if ($this->filesystemDriver->isWritable($directory)) {
return true;
}
try {
if (!$this->filesystemDriver->isDirectory($directory)) {
$this->filesystemDriver->createDirectory($directory);
}
return true;
} catch (FileSystemException $e) {
return false;
}
}
}