-
Notifications
You must be signed in to change notification settings - Fork 0
/
OrphanCleaner.php
335 lines (317 loc) · 14.9 KB
/
OrphanCleaner.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
<?php
declare(strict_types=1);
/***************************************************************
*
* Copyright notice
*
* (c) 2021 Dr. Dieter Porth <info@mobger.de> (PHP-Programming)
* (c) 2021 Bartosz Skowronek (Design/Frontend)
*
* All rights reserved
*
* This script is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* The GNU General Public License can be found at
* http://www.gnu.org/copyleft/gpl.html.
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
/**
* Before using the script on the command line, you have to change the name of the PHP file.
* If you can change the name, then you probably also have the rights to access the files in the folder.
*
* Call up in the console after renaming to OrphanCleanerNeu.php
* php <path-to-file> / NeuOrphanCleaner --start =. / --linker = css, txt, html, sass, less, php, js, md --marker = png, gif, tif, tiff, jpeg, webp, bmp, svg --orphans = <name-of-orphans-folder-without-timestamp>
*
* all required
*
* --start = start directory of search.
* --linker = list of file extension, which contain links to files via the name of the file plus its extension. No whitespace allowed. (default = 'css, txt, html, sass, less, php, js, md'
* --marker = list of file extensions. The extension marks the files as orphans, which should be removed, if the are not used by the resources. No whitespace allowed.
* --orphans = start name of orphans file with moved files (optional; default =)
*/
define('CLEANER_DEFAULT_MOD_DIR', 0775); // 0775(octal) = 509(decimal) :-( what the hell
define('CLEANER_DEFAULT_LINKER_LIST', ['css', 'txt', 'html', 'sass', 'less', 'php', 'js', 'md', 'yaml', 'yml']);
define('CLEANER_DEFAULT_MAPPER_LIST', [
'm4p',
'mp3',
'ogg',
'wav',
'wmv',
'mov',
'avi',
'png',
'gif',
'tif',
'tiff',
'jpg',
'jpeg',
'webp',
'bmp',
'svg',
'pdf',
'ppt',
'docx',
'xls',
'xlsx',
'doc',
'ots',
'ods',
'txt',
]);
define('CLEANER_DEFAULT_ORPHANS_NAME', 'orphan');
call_user_func(
function ($myArgv) {
function myEcho($message): void
{
echo $message;
}
function killProcessIfParameterFails(array $arguments): array
{
if (count($arguments) > 5) {
die('Wrong count of parameters: There must between one and five parameters. ');
}
$startName = getcwd();
$linkerList = CLEANER_DEFAULT_LINKER_LIST;
$markerList = CLEANER_DEFAULT_MAPPER_LIST;
$orphansName = CLEANER_DEFAULT_ORPHANS_NAME;
$flagStart = false;
$flagLinker = false;
$flagMarker = false;
$flagOrphans = false;
unset($arguments[0]);
foreach ($arguments as $value) {
$parts = explode('=', $value, 2);
if (count($parts) == 2) {
switch ($parts[0]) {
case '--start' :
if ($flagStart) {
myEcho('Warning: The start-name `' . $startName . '` will be overridden, because it is doubled.' . "\n");
}
$check = trim($parts[1]);
$flagStart = $flagStart || (!empty($check));
$startName = ((!empty($check)) ?
$check :
$startName);
break;
case '--linker' :
if ($flagLinker) {
myEcho('Warning: The linkerlist `' . print_r($linkerList) . '` will be overridden, because it is doubled.' . "\n");
}
$checkRaw = trim($parts[1]);
$check = preg_replace('/\s+/', '', $checkRaw);
$check = str_replace('.', '', $check);
$flagLinker = $flagLinker || ((!empty($check)) && ($check === $checkRaw));
if (!$flagLinker) {
die('The parameter for linkerlist `' . $checkRaw . '` failed. Whitespaces and dots are not allowed in the comma-separeted list. A space after `=` will turn to an empty list, which is not allowed.' . "\n");
}
$linkerList = explode(',', $check);
break;
case '--marker' :
if ($flagMarker) {
myEcho('Warning: The markerlist `' . print_r($markerList) . '` will be overridden, because it is doubled.' . "\n");
}
$checkRaw = trim($parts[1]);
$check = preg_replace('/\s+/', '', $checkRaw);
$check = str_replace('.', '', $check);
$flagMarker = $flagMarker || ((!empty($check)) && ($check === $checkRaw));
if (!$flagMarker) {
die('The parameter for markerlist `' . $checkRaw . '` failed. Whitespaces and dots are not allowed in the comma-separeted list. A space after `=` will turn to an empty list, which is not allowed.' . "\n");
}
$markerList = explode(',', $check);
break;
case '--orphans' :
if ($flagOrphans) {
myEcho('Warning: The orphan-name `' . $orphansName . '` will be overridden, because it is doubled.' . "\n");
}
$check = trim($parts[1]);
$flagOrphans = $flagOrphans || (!empty($check));
$orphansName = ((!empty($check)) ?
$check :
$orphansName);
break;
default:
myEcho('Warning: The value `` is not used. Please remove it.' . "\n");
break;
}
} else {
myEcho('Warning: The value `' . $value . '` did not contain an equual-sign `=`.' . "\n");
}
}
return [$startName, $linkerList, $markerList, $orphansName];
}
function transformToAbsPathOrKillOnError($startName, $orphansName)
{
if (strpos($startName, DIRECTORY_SEPARATOR) === 0) {
if (!is_dir($startName)) {
die('The folder defined in `start` (' . $startName . ') starts with `' . DIRECTORY_SEPARATOR .
'` and seems to be an absolute path (. The directory dont exist. ');
}
$absStartPath = $startName;
} else {
$absStartPath = $startName . DIRECTORY_SEPARATOR;
if (!is_dir($absStartPath)) {
die('The folder defined in `start` (' . $startName . ') must be defined relatively ' .
'to the work-folder `' . getcwd() . '`. That folder `' . $absStartPath .
'` does not exist. Check the spellings and your userrights.');
}
$absStartPath = realpath($absStartPath);
}
// generade a readable and sortable timestamp for the prefix
$prefixStamp = (new DateTime('now'))->format('Ymd-His-');
$count = '';
$rawOrphansPath = $absStartPath . DIRECTORY_SEPARATOR . $prefixStamp . $orphansName;
do {
$absOrphansPath = $rawOrphansPath . $count;
$count++;
} while (is_dir($absOrphansPath));
if (!is_dir($absOrphansPath)) {
if (!mkdir($absOrphansPath, CLEANER_DEFAULT_MOD_DIR, true) &&
!is_dir($absOrphansPath)
) {
die('The orphans-folder `' . $absOrphansPath . '` could not be created. Check the user-rights.');
}
}
return [$absStartPath, $absOrphansPath];
}
function findRecursiveAllFileByExt(
$folder,
&$orphanExt,
&$files
): void
{
if ((is_dir($folder)) && ($handle = opendir($folder))) {
while (($name = readdir($handle)) !== false) {
if (($name !== '.') &&
($name !== '..')
) {
if (is_dir($folder . DIRECTORY_SEPARATOR . $name)) {
findRecursiveAllFileByExt(
$folder . DIRECTORY_SEPARATOR . $name,
$orphanExt,
$files
);
} else {
$ext = strtolower(pathinfo($name, PATHINFO_EXTENSION));
if (in_array($ext, $orphanExt)) {
$files[] = $folder . DIRECTORY_SEPARATOR . $name;
}
}
}
}
closedir($handle);
}
}
function reduceToFileName($listOfFilePath = [])
{
$result = [];
if (!empty($listOfFilePath)) {
foreach ($listOfFilePath as $filePath) {
$info = pathinfo($filePath);
if (isset($result[$info['basename']])) {
// different pathes but same filename
$result[$info['basename']][] = $filePath;
} else {
$result[$info['basename']] = [$filePath];
}
}
}
return $result;
}
function parseFilesForNames($listOfLinkerFile, $listOfResonrceNames)
{
if (empty($listOfLinkerFile)) {
die('There is no file, which will check the orphans. The orphan-files are move into `' .
CLEANER_DEFAULT_ORPHANS_NAME . '`');
}
foreach ($listOfLinkerFile as $fileName) {
$test = file_get_contents($fileName);
// reduce the list, if one value of the list is contained in the testStream
$listOfResonrceNames = array_filter(
$listOfResonrceNames,
function ($v) use ($test) {
return (strpos($test, $v) === false);
}
);
unset($test);
}
return $listOfResonrceNames;
}
function moveFileToOrphans(
string $startFolder,
string $orphansFolder,
array $reduceNameList,
array $listResource
)
{
$startFolderLength = strlen($startFolder);
foreach ($reduceNameList as $key) {
if (!empty($listResource[$key])) {
foreach ($listResource[$key] as $filePath) {
$sourcePath = $filePath;
if (!file_exists($sourcePath)) {
myEcho('WARNING-WARNING: There file `' . $filePath . '` is no longer available in the folder `' . $startFolder .
'`. There may work other processes, which have removed the file.`');
} else {
$reducedFilePath = substr($filePath, $startFolderLength);
$pathInfo = pathinfo($reducedFilePath);
$destPath = $orphansFolder . $pathInfo['dirname'] . DIRECTORY_SEPARATOR;
if (!is_dir($destPath)) {
$list = explode(DIRECTORY_SEPARATOR, $destPath);
$fullPath = '';
foreach ($list as $partPath) {
$fullPath .= DIRECTORY_SEPARATOR . $partPath;
if ((!empty($partPath)) && (!is_dir($fullPath))) {
// only make the dir, if it not exist
if ((!mkdir($fullPath, CLEANER_DEFAULT_MOD_DIR, true)) &&
(!is_dir($fullPath))
) {
die('The creation of the folder `' . $startFolder . $fullPath . '` failed. A file with the same name exists.');
}
}
}
}
$destPathFile = $destPath . $pathInfo['basename'];
if (!rename($sourcePath, $destPathFile)) {
myEcho('WARNING-WARNING: There file `' . $sourcePath . '` could not renamed to `' . $destPathFile .
'`. Check the rights of the source-file. Perhaps there are parallel processes, which disturb the current process.');
}
}
}
}
}
}
function parseOrphanFilesinCode(
string $startFolder,
array $linkerList,
array $orphanExtList,
string $orphansFolder
)
{
$listResourceRaw = [];
findRecursiveAllFileByExt($startFolder, $orphanExtList, $listResourceRaw);
$listResource = reduceToFileName($listResourceRaw);
$resourceFileList = array_keys($listResource);
$linkerFileList = [];
findRecursiveAllFileByExt($startFolder, $linkerList, $linkerFileList);
$reduceNameList = parseFilesForNames($linkerFileList, $resourceFileList);
moveFileToOrphans($startFolder, $orphansFolder, $reduceNameList, $listResource);
}
// Parse
try {
[$startName, $linkerList, $markerList, $orphansName] = killProcessIfParameterFails(
$myArgv
);
[$absStartPath, $absOrphansPath] = transformToAbsPathOrKillOnError($startName, $orphansName);
parseOrphanFilesinCode($absStartPath, $linkerList, $markerList, $absOrphansPath);
} catch (\Exception $e) {
die('The removing of orphan-files could not successfully solved. An exception was thrown. ' .
'The message was:' . $e->getMessage());
}
die('Your cleanup was successful. The orphan-file are move into `' . $orphansName . '`');
},
$argv // not options, only use the raw Arguments
);