-
-
Notifications
You must be signed in to change notification settings - Fork 167
/
FileActions.php
453 lines (375 loc) · 11.5 KB
/
FileActions.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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
<?php
namespace Kirby\Cms;
use Closure;
use Kirby\Exception\InvalidArgumentException;
use Kirby\Exception\LogicException;
use Kirby\Filesystem\F;
use Kirby\Form\Form;
use Kirby\Uuid\Uuid;
use Kirby\Uuid\Uuids;
/**
* FileActions
*
* @package Kirby Cms
* @author Bastian Allgeier <bastian@getkirby.com>
* @link https://getkirby.com
* @copyright Bastian Allgeier
* @license https://getkirby.com/license
*/
trait FileActions
{
protected function changeExtension(
File $file,
string|null $extension = null
): File {
if (
$extension === null ||
$extension === $file->extension()
) {
return $file;
}
return $file->changeName($file->name(), false, $extension);
}
/**
* Renames the file (optionally also the extension).
* The store is used to actually execute this.
*
* @throws \Kirby\Exception\LogicException
*/
public function changeName(
string $name,
bool $sanitize = true,
string|null $extension = null
): static {
if ($sanitize === true) {
// sanitize the basename part only
// as the extension isn't included in $name
$name = F::safeBasename($name, false);
}
// if no extension is passed, make sure to maintain current one
$extension ??= $this->extension();
// don't rename if not necessary
if (
$name === $this->name() &&
$extension === $this->extension()
) {
return $this;
}
return $this->commit('changeName', ['file' => $this, 'name' => $name, 'extension' => $extension], function ($oldFile, $name, $extension) {
$newFile = $oldFile->clone([
'filename' => $name . '.' . $extension,
]);
// remove all public versions, lock and clear UUID cache
$oldFile->unpublish();
if ($oldFile->exists() === false) {
return $newFile;
}
if ($newFile->exists() === true) {
throw new LogicException('The new file exists and cannot be overwritten');
}
// rename the main file
F::move($oldFile->root(), $newFile->root());
// move the content storage versions
foreach ($oldFile->storage()->all() as $version => $lang) {
$content = $oldFile->storage()->read($version, $lang);
$oldFile->storage()->delete($version, $lang);
$newFile->storage()->create($version, $lang, $content);
}
// update collections
$newFile->parent()->files()->remove($oldFile->id());
$newFile->parent()->files()->set($newFile->id(), $newFile);
return $newFile;
});
}
/**
* Changes the file's sorting number in the meta file
*/
public function changeSort(int $sort): static
{
// skip if the sort number stays the same
if ($this->sort()->value() === $sort) {
return $this;
}
return $this->commit(
'changeSort',
['file' => $this, 'position' => $sort],
fn ($file, $sort) => $file->save(['sort' => $sort])
);
}
/**
* @return $this|static
*/
public function changeTemplate(string|null $template): static
{
if ($template === $this->template()) {
return $this;
}
$arguments = [
'file' => $this,
'template' => $template ?? 'default'
];
return $this->commit('changeTemplate', $arguments, function ($oldFile, $template) {
// convert to new template/blueprint incl. content
$file = $oldFile->convertTo($template);
// update template, prefer unset over writing `default`
if ($template === 'default') {
$template = null;
}
$file = $file->update(['template' => $template]);
// rename and/or resize the file if configured by new blueprint
$create = $file->blueprint()->create();
$file = $file->manipulate($create);
$file = $file->changeExtension($file, $create['format'] ?? null);
return $file;
});
}
/**
* Commits a file action, by following these steps
*
* 1. checks the action rules
* 2. sends the before hook
* 3. commits the store action
* 4. sends the after hook
* 5. returns the result
*/
protected function commit(
string $action,
array $arguments,
Closure $callback
): mixed {
$old = $this->hardcopy();
$kirby = $this->kirby();
$argumentValues = array_values($arguments);
$this->rules()->$action(...$argumentValues);
$kirby->trigger('file.' . $action . ':before', $arguments);
$result = $callback(...$argumentValues);
$argumentsAfter = match ($action) {
'create' => ['file' => $result],
'delete' => ['status' => $result, 'file' => $old],
default => ['newFile' => $result, 'oldFile' => $old]
};
$kirby->trigger('file.' . $action . ':after', $argumentsAfter);
$kirby->cache('pages')->flush();
return $result;
}
/**
* Copy the file to the given page
*/
public function copy(Page $page): static
{
F::copy($this->root(), $page->root() . '/' . $this->filename());
$copy = $page->clone()->file($this->filename());
foreach ($this->storage()->all() as $version => $lang) {
$content = $this->storage()->read($version, $lang);
$copy->storage()->create($version, $lang, $content);
}
// ensure the content is re-read after copying it
// @todo find a more elegant way
$copy = $page->clone()->file($this->filename());
// overwrite with new UUID (remove old, add new)
if (Uuids::enabled() === true) {
$copy = $copy->save(['uuid' => Uuid::generate()]);
}
return $copy;
}
/**
* Creates a new file on disk and returns the
* File object. The store is used to handle file
* writing, so it can be replaced by any other
* way of generating files.
*
* @param bool $move If set to `true`, the source will be deleted
* @throws \Kirby\Exception\InvalidArgumentException
* @throws \Kirby\Exception\LogicException
*/
public static function create(array $props, bool $move = false): File
{
if (isset($props['source'], $props['parent']) === false) {
throw new InvalidArgumentException('Please provide the "source" and "parent" props for the File');
}
// prefer the filename from the props
$props['filename'] = F::safeName($props['filename'] ?? basename($props['source']));
$props['model'] = strtolower($props['template'] ?? 'default');
// create the basic file and a test upload object
$file = static::factory($props);
$upload = $file->asset($props['source']);
// gather content
$content = $props['content'] ?? [];
// make sure that a UUID gets generated
// and added to content right away
if (
Uuids::enabled() === true &&
empty($content['uuid']) === true
) {
// sets the current uuid if it is the exact same file
if ($file->exists() === true) {
$existing = $file->parent()->file($file->filename());
if (
$file->sha1() === $upload->sha1() &&
$file->template() === $existing->template()
) {
// use existing content data if it is the exact same file
$content = $existing->content()->toArray();
}
}
$content['uuid'] ??= Uuid::generate();
}
// create a form for the file
$form = Form::for($file, ['values' => $content]);
// inject the content
$file = $file->clone(['content' => $form->strings(true)]);
// if the format is different from the original,
// we need to already rename it so that the correct file rules
// are applied
$create = $file->blueprint()->create();
// run the hook
$arguments = compact('file', 'upload');
return $file->commit('create', $arguments, function ($file, $upload) use ($create, $move) {
// remove all public versions, lock and clear UUID cache
$file->unpublish();
// only move the original source if intended
$method = $move === true ? 'move' : 'copy';
// overwrite the original
if (F::$method($upload->root(), $file->root(), true) !== true) {
throw new LogicException('The file could not be created');
}
// resize the file on upload if configured
$file = $file->manipulate($create);
$file = $file->changeExtension($file, $create['format'] ?? null);
// store the content if necessary
// (always create files in the default language)
$file->save(
$file->content()->toArray(),
$file->kirby()->defaultLanguage()?->code()
);
// add the file to the list of siblings
$file->siblings()->append($file->id(), $file);
// return a fresh clone
return $file->clone();
});
}
/**
* Deletes the file. The store is used to
* manipulate the filesystem or whatever you prefer.
*/
public function delete(): bool
{
return $this->commit('delete', ['file' => $this], function ($file) {
// remove all public versions, lock and clear UUID cache
$file->unpublish();
foreach ($file->storage()->all() as $version => $lang) {
$file->storage()->delete($version, $lang);
}
F::remove($file->root());
// remove the file from the sibling collection
$file->parent()->files()->remove($file);
return true;
});
}
/**
* Resizes/crops the original file with Kirby's thumb handler
*/
public function manipulate(array|null $options = []): static
{
// nothing to process
if (empty($options) === true || $this->isResizable() === false) {
return $this;
}
// generate image file and overwrite it in place
$this->kirby()->thumb($this->root(), $this->root(), $options);
return $this->clone([]);
}
/**
* Move the file to the public media folder
* if it's not already there.
*
* @return $this
*/
public function publish(): static
{
Media::publish($this, $this->mediaRoot());
return $this;
}
/**
* Replaces the file. The source must
* be an absolute path to a file or a Url.
* The store handles the replacement so it
* finally decides what it will support as
* source.
*
* @param bool $move If set to `true`, the source will be deleted
* @throws \Kirby\Exception\LogicException
*/
public function replace(string $source, bool $move = false): static
{
$file = $this->clone();
$arguments = [
'file' => $file,
'upload' => $file->asset($source)
];
return $this->commit('replace', $arguments, function ($file, $upload) use ($move) {
// delete all public versions
$file->unpublish(true);
// only move the original source if intended
$method = $move === true ? 'move' : 'copy';
// overwrite the original
if (F::$method($upload->root(), $file->root(), true) !== true) {
throw new LogicException('The file could not be created');
}
// apply the resizing/crop options from the blueprint
$create = $file->blueprint()->create();
$file = $file->manipulate($create);
$file = $file->changeExtension($file, $create['format'] ?? null);
// return a fresh clone
return $file->clone();
});
}
/**
* Stores the content on disk
* @internal
*/
public function save(
array $data = null,
string $languageCode = null,
bool $overwrite = false
): static {
$file = parent::save($data, $languageCode, $overwrite);
// update model in siblings collection
$file->parent()->files()->set($file->id(), $file);
return $file;
}
/**
* Remove all public versions of this file
*
* @return $this
*/
public function unpublish(bool $onlyMedia = false): static
{
// unpublish media files
Media::unpublish($this->parent()->mediaRoot(), $this);
if ($onlyMedia !== true) {
// remove the lock
$this->lock()?->remove();
// clear UUID cache
$this->uuid()?->clear();
}
return $this;
}
/**
* Updates the file's data and ensures that
* media files get wiped if `focus` changed
*
* @throws \Kirby\Exception\InvalidArgumentException If the input array contains invalid values
*/
public function update(
array $input = null,
string $languageCode = null,
bool $validate = false
): static {
// delete all public media versions when focus field gets changed
if (($input['focus'] ?? null) !== $this->focus()->value()) {
$this->unpublish(true);
}
return parent::update($input, $languageCode, $validate);
}
}