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
|
<?php
namespace Imagify\Optimization\Data;
defined( 'ABSPATH' ) || die( 'Cheatin’ uh?' );
/**
* Optimization data class for the custom folders.
* This class constructor accepts:
* - A media ID (int).
* - An array of data coming from the files DB table /!\
* - An object of data coming from the files DB table /!\
* - A \Imagify\Media\MediaInterface object.
*
* @since 1.9
* @see Imagify\Media\CustomFolders
* @author Grégory Viguier
*/
class CustomFolders extends AbstractData {
use \Imagify\Traits\MediaRowTrait;
/**
* The attachment SQL DB class.
*
* @var string
* @since 1.9
* @access protected
* @author Grégory Viguier
*/
protected $db_class_name = 'Imagify_Files_DB';
/**
* The constructor.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @param mixed $id An ID, or whatever type the "Media" class constructor accepts.
*/
public function __construct( $id ) {
parent::__construct( $id );
if ( ! $this->is_valid() ) {
return;
}
// This is required by MediaRowTrait.
$this->id = $this->get_media()->get_id();
// In this context, the media data and the optimization data are stored in the same DB table, so, no need to request twice the DB.
$this->row = $this->get_media()->get_row();
}
/**
* Get the whole media optimization data.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return array The data. See parent method for details.
*/
public function get_optimization_data() {
if ( ! $this->is_valid() ) {
return $this->default_optimization_data;
}
$row = array_merge( $this->get_row_db_instance()->get_column_defaults(), $this->get_row() );
$data = $this->default_optimization_data;
$data['status'] = $row['status'];
$data['level'] = $row['optimization_level'];
$data['level'] = is_numeric( $data['level'] ) ? (int) $data['level'] : false;
if ( 'success' === $row['status'] ) {
/**
* Success.
*/
$data['sizes']['full'] = [
'success' => true,
'original_size' => $row['original_size'],
'optimized_size' => $row['optimized_size'],
'percent' => $row['percent'],
];
} elseif ( ! empty( $row['status'] ) ) {
/**
* Error.
*/
$data['sizes']['full'] = [
'success' => false,
'error' => $row['error'],
];
}
if ( ! empty( $row['data']['sizes'] ) && is_array( $row['data']['sizes'] ) ) {
unset( $row['data']['sizes']['full'] );
$data['sizes'] = array_merge( $data['sizes'], $row['data']['sizes'] );
$data['sizes'] = array_filter( $data['sizes'], 'is_array' );
}
if ( empty( $data['sizes'] ) ) {
return $data;
}
foreach ( $data['sizes'] as $size_data ) {
// Cast.
if ( isset( $size_data['original_size'] ) ) {
$size_data['original_size'] = (int) $size_data['original_size'];
}
if ( isset( $size_data['optimized_size'] ) ) {
$size_data['optimized_size'] = (int) $size_data['optimized_size'];
}
if ( isset( $size_data['percent'] ) ) {
$size_data['percent'] = round( $size_data['percent'], 2 );
}
// Stats.
if ( ! empty( $size_data['original_size'] ) && ! empty( $size_data['optimized_size'] ) ) {
$data['stats']['original_size'] += $size_data['original_size'];
$data['stats']['optimized_size'] += $size_data['optimized_size'];
}
}
if ( $data['stats']['original_size'] && $data['stats']['optimized_size'] ) {
$data['stats']['percent'] = $data['stats']['original_size'] - $data['stats']['optimized_size'];
$data['stats']['percent'] = round( $data['stats']['percent'] / $data['stats']['original_size'] * 100, 2 );
}
return $data;
}
/**
* Update the optimization data, level, and status for a size.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @param string $size The size name.
* @param array $data The optimization data. See parent method for details.
*/
public function update_size_optimization_data( $size, array $data ) {
if ( ! $this->is_valid() ) {
return;
}
$old_data = array_merge( $this->get_reset_data(), $this->get_row() );
if ( 'full' === $size ) {
/**
* Original file.
*/
$old_data['optimization_level'] = $data['level'];
$old_data['status'] = $data['status'];
$old_data['modified'] = 0;
$file_path = $this->get_media()->get_fullsize_path();
if ( $file_path ) {
$old_data['hash'] = md5_file( $file_path );
}
if ( ! $data['success'] ) {
/**
* Error.
*/
$old_data['error'] = $data['error'];
} else {
/**
* Success.
*/
$old_data['original_size'] = $data['original_size'];
$old_data['optimized_size'] = $data['optimized_size'];
$old_data['percent'] = $data['original_size'] - $data['optimized_size'];
$old_data['percent'] = round( ( $old_data['percent'] / $data['original_size'] ) * 100, 2 );
}
} else {
/**
* Webp version or any other size.
*/
$old_data['data'] = ! empty( $old_data['data'] ) && is_array( $old_data['data'] ) ? $old_data['data'] : [];
$old_data['data']['sizes'] = ! empty( $old_data['data']['sizes'] ) && is_array( $old_data['data']['sizes'] ) ? $old_data['data']['sizes'] : [];
if ( ! $data['success'] ) {
/**
* Error.
*/
$old_data['data']['sizes'][ $size ] = [
'success' => false,
'error' => $data['error'],
];
} else {
/**
* Success.
*/
$old_data['data']['sizes'][ $size ] = [
'success' => true,
'original_size' => $data['original_size'],
'optimized_size' => $data['optimized_size'],
'percent' => round( ( ( $data['original_size'] - $data['optimized_size'] ) / $data['original_size'] ) * 100, 2 ),
];
}
}
if ( isset( $old_data['data']['sizes'] ) && ( ! $old_data['data']['sizes'] || ! is_array( $old_data['data']['sizes'] ) ) ) {
unset( $old_data['data']['sizes'] );
}
$this->update_row( $old_data );
}
/**
* Delete the media optimization data, level, and status.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*/
public function delete_optimization_data() {
if ( ! $this->is_valid() ) {
return;
}
$this->update_row( $this->get_reset_data() );
}
/**
* Delete the optimization data for the given sizes.
* If all sizes are removed, all optimization data is deleted.
* Status and level are not modified nor removed if the "full" size is removed. This leaves the media in a Schrödinger state.
*
* @since 1.9.8
* @access public
* @author Grégory Viguier
*
* @param array $sizes A list of sizes to remove.
*/
public function delete_sizes_optimization_data( array $sizes ) {
if ( ! $sizes || ! $this->is_valid() ) {
return;
}
$data = array_merge( $this->get_reset_data(), $this->get_row() );
$data['data']['sizes'] = ! empty( $data['data']['sizes'] ) && is_array( $data['data']['sizes'] ) ? $data['data']['sizes'] : [];
if ( ! $data['data']['sizes'] ) {
return;
}
$remaining_sizes_data = array_diff_key( $data['data']['sizes'], array_flip( $sizes ) );
if ( ! $remaining_sizes_data ) {
// All sizes have been removed: delete everything.
$this->delete_optimization_data();
return;
}
if ( count( $remaining_sizes_data ) === count( $data['data']['sizes'] ) ) {
// Nothing has been removed.
return;
}
$data['data']['sizes'] = $remaining_sizes_data;
$this->update_row( $data );
}
/**
* Get default values used to reset optimization data.
*
* @since 1.9
* @access protected
* @author Grégory Viguier
*
* @return array {
* The default values related to the optimization.
*
* @type string $hash The file hash.
* @type int $modified 0 to tell that the file has not been modified
* @type int $optimized_size File size after optimization.
* @type int $percent Saving optimized/original in percent.
* @type int $optimization_level The optimization level.
* @type string $status The status: success, already_optimized, error.
* @type string $error An error message.
* }
*/
protected function get_reset_data() {
static $column_defaults;
if ( ! isset( $column_defaults ) ) {
$column_defaults = $this->get_row_db_instance()->get_column_defaults();
// All DB columns that have `null` as default value, are Imagify data.
foreach ( $column_defaults as $column_name => $value ) {
if ( 'hash' === $column_name || 'modified' === $column_name || 'data' === $column_name ) {
continue;
}
if ( isset( $value ) ) {
unset( $column_defaults[ $column_name ] );
}
}
}
$imagify_columns = $column_defaults;
// Also set the new file hash.
$file_path = $this->get_media()->get_fullsize_path();
if ( $file_path ) {
$imagify_columns['hash'] = md5_file( $file_path );
}
return $imagify_columns;
}
}
|