class-media-item-optimizer.php
10.3 KB
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
<?php
namespace Smush\Core\Media;
use Smush\Core\Backups\Backups;
use Smush\Core\Helper;
use Smush\Core\Smush\Smush_Optimization;
use Smush\Core\Stats\Global_Stats;
use WDEV_Logger;
use WP_Error;
class Media_Item_Optimizer {
const ERROR_META_KEY = 'wp-smush-optimization-errors';
/**
* @var Media_Item_Optimization[]
*/
private $optimizations;
/**
* @var Media_Item
*/
private $media_item;
/**
* @var Backups
*/
private $backups;
/**
* @var WDEV_Logger
*/
private $logger;
/**
* @var Global_Stats
*/
private $global_stats;
/**
* @var WP_Error
*/
private $errors;
public function __construct( $media_item ) {
$this->media_item = $media_item;
$this->backups = new Backups();
$this->logger = Helper::logger();
$this->global_stats = Global_Stats::get();
}
/**
* @return Media_Item_Optimization[]
*/
public function get_optimizations() {
if ( is_null( $this->optimizations ) ) {
$this->optimizations = $this->initialize_optimizations();
}
return $this->optimizations;
}
public function set_optimizations( $optimizations ) {
$this->optimizations = $optimizations;
}
private function initialize_optimizations() {
return apply_filters( 'wp_smush_optimizations', array(), $this->media_item );
}
/**
* TODO: check the uses for this method to make sure they are prepared to receive null
*
* @param $key
*
* @return Media_Item_Optimization|null
*/
public function get_optimization( $key ) {
return $this->get_array_value( $this->get_optimizations(), $key );
}
/**
* @param $key
*
* @return Media_Item_Stats
*/
public function get_stats( $key ) {
$optimization = $this->get_optimization( $key );
if ( $optimization ) {
return $optimization->get_stats();
}
return new Media_Item_Stats();
}
public function get_total_stats() {
$total_stats = new Media_Item_Stats();
foreach ( $this->get_optimizations() as $optimization ) {
$total_stats->add( $optimization->get_stats() );
}
return $total_stats;
}
/**
* @param $optimization_key
* @param $size_key
*
* @return Media_Item_Stats
*/
public function get_size_stats( $optimization_key, $size_key ) {
$optimization = $this->get_optimization( $optimization_key );
if ( $optimization ) {
return $optimization->get_size_stats( $size_key );
}
return new Media_Item_Stats();
}
public function get_total_size_stats( $size_key ) {
$total_stats = new Media_Item_Stats();
foreach ( $this->get_optimizations() as $optimization ) {
$total_stats->add( $optimization->get_size_stats( $size_key ) );
}
return $total_stats;
}
public function get_optimized_sizes_count() {
$size_count = 0;
foreach ( $this->get_optimizations() as $optimization ) {
$optimized_sizes_count = $optimization->get_optimized_sizes_count();
if ( $optimized_sizes_count > $size_count ) {
$size_count = $optimized_sizes_count;
}
}
return $size_count;
}
/**
* Whether the media item was optimized at some point. It may need to be reoptimized.
*
* @return bool
*/
public function is_optimized() {
foreach ( $this->get_optimizations() as $optimization ) {
if ( $optimization->is_optimized() ) {
return true;
}
}
return false;
}
public function should_optimize() {
foreach ( $this->get_optimizations() as $optimization ) {
if ( $optimization->should_optimize() ) {
return true;
}
}
return false;
}
public function should_reoptimize() {
$should_reoptimize = false;
foreach ( $this->get_optimizations() as $optimization ) {
if ( $optimization->should_reoptimize() ) {
$should_reoptimize = true;
}
}
return apply_filters( 'wp_smush_should_resmush', $should_reoptimize, $this->media_item->get_id() );
}
public function optimize() {
if ( $this->restore_in_progress() ) {
$this->logger->log( 'Prevented auto-smush during restore.' );
return false;
}
if ( $this->in_progress() ) {
$this->handle_error( 'in_progress', 'Smush already in progress' );
return false;
}
$media_item = $this->media_item;
do_action(
'wp_smush_before_smush_file',
$media_item->get_id(),
$media_item->get_wp_metadata()
);
if ( $media_item->has_errors() || $media_item->is_skipped() ) {
$this->adjust_global_stats_lists();
return false;
}
$this->set_in_progress_transient();
$this->backups->maybe_create_backup( $media_item, $this );
$optimized = $this->run_optimizations();
do_action(
'wp_smush_after_smush_file',
$media_item->get_id(),
$media_item->get_wp_metadata(),
$optimized ? array() : $this->get_errors()
);
if ( $optimized ) {
do_action(
'wp_smush_after_smush_successful',
$media_item->get_id(),
$media_item->get_wp_metadata()
);
$this->delete_previous_optimization_errors();
} else {
$this->handle_optimization_errors();
}
$this->delete_in_progress_transient();
return $optimized;
}
public function restore() {
if ( $this->in_progress() || $this->restore_in_progress() ) {
return false;
}
$this->set_restore_in_progress_transient();
$restoration_attempted = false;
$restored = false;
// First, allow one of the optimizations to handle the restoration process
foreach ( $this->get_optimizations() as $optimization ) {
if ( $optimization->can_restore() ) {
$restoration_attempted = true;
$restored = $optimization->restore();
break;
}
}
if ( ! $restoration_attempted ) {
// Try the standard restoration
$restored = $this->backups->restore_backup( $this->media_item );
}
if ( $restored ) {
// Before deleting all data subtract the stats
$this->global_stats->subtract_item_stats( $this->media_item );
$this->global_stats->subtract_optimized_images_count( $this->get_optimized_sizes_count() );
// Delete all the optimization data
$this->delete_data();
// Delete optimization errors.
$this->delete_previous_optimization_errors();
// Once all data has been deleted, adjust the lists
$this->global_stats->adjust_lists_for_media_item( $this->media_item );
}
$this->delete_restore_in_progress_transient();
return $restored;
}
public function save() {
foreach ( $this->get_optimizations() as $optimization ) {
$optimization->save();
}
}
private function get_array_value( $array, $key ) {
return $array && isset( $array[ $key ] )
? $array[ $key ]
: null;
}
/**
* @param Media_Item_Size $full_size
*
* @return boolean
*/
public function should_optimize_size( $full_size ) {
$should_optimize_size = false;
foreach ( $this->get_optimizations() as $optimization ) {
if ( $optimization->should_optimize_size( $full_size ) ) {
$should_optimize_size = true;
break;
}
}
return $should_optimize_size;
}
public function delete_data() {
foreach ( $this->get_optimizations() as $optimization ) {
$optimization->delete_data();
}
}
/**
* @return bool
*/
private function run_optimizations() {
$all_optimized = true;
foreach ( $this->get_optimizations() as $optimization ) {
if ( $optimization->should_optimize() ) {
$current_optimized = $optimization->optimize();
$all_optimized = $all_optimized && $current_optimized;
}
}
return $all_optimized;
}
private function adjust_global_stats_lists() {
$this->global_stats->adjust_lists_for_media_item( $this->media_item );
}
private function set_in_progress_transient() {
set_transient( $this->in_progress_transient_key(), 1, HOUR_IN_SECONDS );
}
private function delete_in_progress_transient() {
delete_transient( $this->in_progress_transient_key() );
}
public function in_progress() {
return (bool) get_transient( $this->in_progress_transient_key() );
}
private function in_progress_transient_key() {
return 'smush-in-progress-' . $this->media_item->get_id();
}
private function set_restore_in_progress_transient() {
set_transient( $this->restore_in_progress_transient_key(), 1, HOUR_IN_SECONDS );
}
private function delete_restore_in_progress_transient() {
delete_transient( $this->restore_in_progress_transient_key() );
}
public function restore_in_progress() {
return (bool) get_transient( $this->restore_in_progress_transient_key() );
}
private function restore_in_progress_transient_key() {
return 'wp-smush-restore-' . $this->media_item->get_id();
}
/**
* @param $code
* @param $error_message
*
* @return void
*/
private function handle_error( $code, $error_message ) {
$this->logger->error( $error_message );
$this->set_errors( new WP_Error( $code, $error_message ) );
$this->update_errors_meta();
}
public function get_errors() {
if ( is_null( $this->errors ) ) {
$this->errors = $this->fetch_errors_from_meta();
}
return $this->errors;
}
private function set_errors( $errors ) {
$this->errors = $errors;
}
public function has_errors() {
return $this->get_errors()->has_errors();
}
private function set_optimization_errors() {
$errors = new WP_Error();
// Add optimization errors
foreach ( $this->get_optimizations() as $optimization ) {
if ( $optimization->has_errors() ) {
$errors->merge_from( $optimization->get_errors() );
}
}
$this->set_errors( $errors );
}
private function fetch_errors_from_meta() {
$wp_error = new WP_Error();
$errors = get_post_meta( $this->media_item->get_id(), self::ERROR_META_KEY, true );
if ( empty( $errors ) || ! is_array( $errors ) ) {
return $wp_error;
}
foreach ( $errors as $error_code => $error_message ) {
if ( empty( $error_message ) ) {
continue;
}
if ( is_array( $error_message ) ) {
foreach ( $error_message as $error ) {
$wp_error->add( $error_code, $error );
}
} else {
$wp_error->add( $error_code, $error_message );
}
}
return $wp_error;
}
private function update_errors_meta() {
$errors_array = array();
foreach ( $this->errors->get_error_codes() as $error_code ) {
$errors_array[ $error_code ] = $this->errors->get_error_messages( $error_code );
}
if ( ! empty( $errors_array ) ) {
update_post_meta( $this->media_item->get_id(), self::ERROR_META_KEY, $errors_array );
}
}
/**
* @return void
*/
private function handle_optimization_errors() {
$this->set_optimization_errors();
$this->update_errors_meta();
}
private function delete_previous_optimization_errors() {
if ( $this->has_errors() ) {
delete_post_meta( $this->media_item->get_id(), self::ERROR_META_KEY );
$this->set_errors( null );
}
}
}