/
AssetsTask.php
339 lines (288 loc) · 8.95 KB
/
AssetsTask.php
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Shell\Task;
use Cake\Console\Shell;
use Cake\Core\Plugin;
use Cake\Filesystem\Folder;
use Cake\Utility\Inflector;
/**
* Task for symlinking / copying plugin assets to app's webroot.
*/
class AssetsTask extends Shell
{
/**
* Attempt to symlink plugin assets to app's webroot. If symlinking fails it
* fallbacks to copying the assets. For vendor namespaced plugin, parent folder
* for vendor name are created if required.
*
* @param string|null $name Name of plugin for which to symlink assets.
* If null all plugins will be processed.
* @return void
*/
public function symlink($name = null)
{
$this->_process($this->_list($name));
}
/**
* Copying plugin assets to app's webroot. For vendor namespaced plugin,
* parent folder for vendor name are created if required.
*
* @param string|null $name Name of plugin for which to symlink assets.
* If null all plugins will be processed.
* @return void
*/
public function copy($name = null)
{
$this->_process($this->_list($name), true);
}
/**
* Remove plugin assets from app's webroot.
*
* @param string|null $name Name of plugin for which to remove assets.
* If null all plugins will be processed.
* @return void
* @since 3.5.12
*/
public function remove($name = null)
{
$plugins = $this->_list($name);
foreach ($plugins as $plugin => $config) {
$this->out();
$this->out('For plugin: ' . $plugin);
$this->hr();
$this->_remove($config);
}
$this->out();
$this->out('Done');
}
/**
* Get list of plugins to process. Plugins without a webroot directory are skipped.
*
* @param string|null $name Name of plugin for which to symlink assets.
* If null all plugins will be processed.
* @return array List of plugins with meta data.
*/
protected function _list($name = null)
{
if ($name === null) {
$pluginsList = Plugin::loaded();
} else {
if (!Plugin::loaded($name)) {
$this->err(sprintf('Plugin %s is not loaded.', $name));
return [];
}
$pluginsList = [$name];
}
$plugins = [];
foreach ($pluginsList as $plugin) {
$path = Plugin::path($plugin) . 'webroot';
if (!is_dir($path)) {
$this->verbose('', 1);
$this->verbose(
sprintf('Skipping plugin %s. It does not have webroot folder.', $plugin),
2
);
continue;
}
$link = Inflector::underscore($plugin);
$dir = WWW_ROOT;
$namespaced = false;
if (strpos($link, '/') !== false) {
$namespaced = true;
$parts = explode('/', $link);
$link = array_pop($parts);
$dir = WWW_ROOT . implode(DIRECTORY_SEPARATOR, $parts) . DIRECTORY_SEPARATOR;
}
$plugins[$plugin] = [
'srcPath' => Plugin::path($plugin) . 'webroot',
'destDir' => $dir,
'link' => $link,
'namespaced' => $namespaced
];
}
return $plugins;
}
/**
* Process plugins
*
* @param array $plugins List of plugins to process
* @param bool $copy Force copy mode. Default false.
* @return void
*/
protected function _process($plugins, $copy = false)
{
$overwrite = (bool)$this->param('overwrite');
foreach ($plugins as $plugin => $config) {
$this->out();
$this->out('For plugin: ' . $plugin);
$this->hr();
if ($config['namespaced'] &&
!is_dir($config['destDir']) &&
!$this->_createDirectory($config['destDir'])
) {
continue;
}
$dest = $config['destDir'] . $config['link'];
if (file_exists($dest)) {
if ($overwrite && !$this->_remove($config)) {
continue;
} elseif (!$overwrite) {
$this->verbose(
$dest . ' already exists',
1
);
continue;
}
}
if (!$copy) {
$result = $this->_createSymlink(
$config['srcPath'],
$dest
);
if ($result) {
continue;
}
}
$this->_copyDirectory(
$config['srcPath'],
$dest
);
}
$this->out();
$this->out('Done');
}
/**
* Remove folder/symlink.
*
* @param array $config Plugin config.
* @return bool
*/
protected function _remove($config)
{
if ($config['namespaced'] && !is_dir($config['destDir'])) {
$this->verbose(
$config['destDir'] . $config['link'] . ' does not exist',
1
);
return false;
}
$dest = $config['destDir'] . $config['link'];
if (!file_exists($dest)) {
$this->verbose(
$dest . ' does not exist',
1
);
return false;
}
if (is_link($dest)) {
// @codingStandardsIgnoreLine
if (@unlink($dest)) {
$this->out('Unlinked ' . $dest);
return true;
} else {
$this->err('Failed to unlink ' . $dest);
return false;
}
}
$folder = new Folder($dest);
if ($folder->delete()) {
$this->out('Deleted ' . $dest);
return true;
} else {
$this->err('Failed to delete ' . $dest);
return false;
}
}
/**
* Create directory
*
* @param string $dir Directory name
* @return bool
*/
protected function _createDirectory($dir)
{
$old = umask(0);
// @codingStandardsIgnoreStart
$result = @mkdir($dir, 0755, true);
// @codingStandardsIgnoreEnd
umask($old);
if ($result) {
$this->out('Created directory ' . $dir);
return true;
}
$this->err('Failed creating directory ' . $dir);
return false;
}
/**
* Create symlink
*
* @param string $target Target directory
* @param string $link Link name
* @return bool
*/
protected function _createSymlink($target, $link)
{
// @codingStandardsIgnoreStart
$result = @symlink($target, $link);
// @codingStandardsIgnoreEnd
if ($result) {
$this->out('Created symlink ' . $link);
return true;
}
return false;
}
/**
* Copy directory
*
* @param string $source Source directory
* @param string $destination Destination directory
* @return bool
*/
protected function _copyDirectory($source, $destination)
{
$folder = new Folder($source);
if ($folder->copy(['to' => $destination])) {
$this->out('Copied assets to directory ' . $destination);
return true;
}
$this->err('Error copying assets to directory ' . $destination);
return false;
}
/**
* Gets the option parser instance and configures it.
*
* @return \Cake\Console\ConsoleOptionParser
*/
public function getOptionParser()
{
$parser = parent::getOptionParser();
$parser->addSubcommand('symlink', [
'help' => 'Symlink (copy as fallback) plugin assets to app\'s webroot.'
])->addSubcommand('copy', [
'help' => 'Copy plugin assets to app\'s webroot.'
])->addSubcommand('remove', [
'help' => 'Remove plugin assets from app\'s webroot.'
])->addArgument('name', [
'help' => 'A specific plugin you want to symlink assets for.',
'optional' => true,
])
->addOption('overwrite', [
'boolean' => true,
'default' => false,
'help' => 'Overwrite existing symlink / folder.'
]);
return $parser;
}
}