class-core.php
17 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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
<?php
/**
* Core class: Core class.
*
* @since 2.9.0
* @package Smush\Core
*/
namespace Smush\Core;
use WP_Smush;
if ( ! defined( 'WPINC' ) ) {
die;
}
/**
* Class Core
*/
class Core extends Stats {
/**
* Animated status.
*
* @var int
*/
const STATUS_ANIMATED = 2;
/**
* S3 module
*
* @var Integrations\S3
*/
public $s3;
/**
* NextGen module.
*
* @var Integrations\Nextgen
*/
public $nextgen;
/**
* Modules array.
*
* @var Modules
*/
public $mod;
/**
* Allowed mime types of image.
*
* @var array $mime_types
*/
public static $mime_types = array(
'image/jpg',
'image/jpeg',
'image/x-citrix-jpeg',
'image/gif',
'image/png',
'image/x-png',
);
/**
* List of external pages where smush needs to be loaded.
*
* @var array $pages
*/
public static $external_pages = array(
'nggallery-manage-images',
'gallery_page_nggallery-manage-gallery',
'gallery_page_wp-smush-nextgen-bulk',
'nextgen-gallery_page_nggallery-manage-gallery', // Different since NextGen 3.3.6.
'nextgen-gallery_page_wp-smush-nextgen-bulk', // Different since NextGen 3.3.6.
'post',
'post-new',
'page',
'edit-page',
'upload',
);
/**
* Attachment IDs which are smushed.
*
* @var array $smushed_attachments
*/
public $smushed_attachments = array();
/**
* Unsmushed image IDs.
*
* @var array $unsmushed_attachments
*/
public $unsmushed_attachments = array();
/**
* Skipped attachment IDs.
*
* @since 3.0
*
* @var array $skipped_attachments
*/
public $skipped_attachments = array();
/**
* Smushed attachments out of total attachments.
*
* @var int $smushed_count
*/
public $smushed_count = 0;
/**
* Smushed attachments out of total attachments.
*
* @var int $remaining_count
*/
public $remaining_count = 0;
/**
* Images with errors that have been skipped from bulk smushing.
*
* @since 3.0
* @var int $skipped_count
*/
public $skipped_count = 0;
/**
* Super Smushed attachments count.
*
* @var int $super_smushed
*/
public $super_smushed = 0;
/**
* Total count of attachments for smushing.
*
* @var int $total_count
*/
public $total_count = 0;
/**
* Limit for allowed number of images per bulk request.
*
* This is enforced at api level too.
*
* @var int
*/
const MAX_FREE_BULK = 50;
/**
* Initialize modules.
*
* @since 2.9.0
*/
protected function init() {
$this->mod = new Modules();
// Enqueue scripts and initialize variables.
add_action( 'admin_init', array( $this, 'init_settings' ) );
// Load integrations.
add_action( 'init', array( $this, 'load_integrations' ) );
// Big image size threshold (WordPress 5.3+).
add_filter( 'big_image_size_threshold', array( $this, 'big_image_size_threshold' ), 10 );
/**
* Load NextGen Gallery, instantiate the Async class. if hooked too late or early, auto Smush doesn't
* work, also load after settings have been saved on init action.
*/
add_action( 'plugins_loaded', array( $this, 'load_libs' ), 90 );
/**
* Maybe need to load some modules in REST API mode.
* E.g. S3.
*/
add_action( 'rest_api_init', array( $this, 'load_libs_for_rest_api' ), 99 );
}
/**
* Load integrations class.
*
* @since 2.8.0
*/
public function load_integrations() {
new Integrations\Common();
}
/**
* Load plugin modules.
*/
public function load_libs() {
$this->wp_smush_async();
if ( is_admin() ) {
$this->s3 = new Integrations\S3();
}
/**
* Load NextGen integration on admin or custom ajax request.
*
* @since 3.10.0
*/
if ( is_admin() || defined( 'NGG_AJAX_SLUG' ) && ! empty( $_REQUEST[ NGG_AJAX_SLUG ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
$this->nextgen = new Integrations\Nextgen();
}
new Integrations\Gutenberg();
new Integrations\Composer();
new Integrations\Gravity_Forms();
new Integrations\Envira( $this->mod->cdn );
new Integrations\Avada( $this->mod->cdn );
// Register logger to schedule cronjob.
Helper::logger();
}
/**
* Load lib for REST API.
*/
public function load_libs_for_rest_api() {
// Load S3 if there is media REST API.
if ( ! Helper::is_non_rest_media() && ! $this->s3 ) {
$this->s3 = new Integrations\S3();
}
}
/**
* Initialize the Smush Async class.
*/
private function wp_smush_async() {
// Check if Async is disabled.
if ( defined( 'WP_SMUSH_ASYNC' ) && ! WP_SMUSH_ASYNC ) {
return;
}
// Instantiate class.
new Modules\Async\Async();
// Load the Editor Async task only if user logged in or in backend.
if ( is_admin() && is_user_logged_in() ) {
new Modules\Async\Editor();
}
}
/**
* Init settings.
*/
public function init_settings() {
// Initialize Image dimensions.
$this->mod->smush->image_sizes = $this->image_dimensions();
}
/**
* Localize translations.
*/
public function localize() {
global $current_screen;
$handle = 'smush-admin';
$upgrade_url = add_query_arg(
array(
'coupon' => 'SMUSH30OFF',
'utm_source' => 'smush',
'utm_medium' => 'plugin',
'utm_campaign' => 'smush_bulksmush_inline_filesizelimit',
),
'https://wpmudev.com/project/wp-smush-pro/'
);
$wp_smush_msgs = array(
'nonce' => wp_create_nonce( 'wp-smush-ajax' ),
'webp_nonce' => wp_create_nonce( 'wp-smush-webp-nonce' ),
'settingsUpdated' => esc_html__( 'Your settings have been updated', 'wp-smushit' ),
'resmush' => esc_html__( 'Super-Smush', 'wp-smushit' ),
'smush_now' => esc_html__( 'Smush Now', 'wp-smushit' ),
'error_in_bulk' => esc_html__( '{{smushed}}/{{total}} images smushed successfully, {{errors}} images were not optimized, find out why and how to resolve the issue(s) below.', 'wp-smushit' ),
'all_failed' => esc_html__( 'All of your images failed to smush. Find out why and how to resolve the issue(s) below.', 'wp-smushit' ),
'all_resmushed' => esc_html__( 'All images are fully optimized.', 'wp-smushit' ),
'all_smushed' => esc_html__( 'All attachments have been smushed. Awesome!', 'wp-smushit' ),
'error_size_limit' => WP_Smush::is_pro() ? '' : sprintf(
/* translators: %1$s - opening a link <a>, %2$s - Close the link </a> */
esc_html__( 'Are you hitting the 5MB "size limit exceeded" warning? %1$sUpgrade to Smush Pro%2$s to optimize unlimited image files up to 32Mb each.', 'wp-smushit' ),
'<a href="' . esc_url( $upgrade_url ) . '" target="_blank">',
'</a>'
),
'processing_cdn_for_free' => esc_html__( 'Want to serve images even faster? Get up to 2x more speed with Smush Pro’s CDN, which spans 114 servers worldwide.', 'wp-smushit' ),
'processed_cdn_for_free' => esc_html__( 'Let images reach your audience faster no matter where your hosting servers are. Smush Pro’s global CDN serves images closer to site visitors via 114 worldwide server locations.', 'wp-smushit' ),
'restore' => esc_html__( 'Restoring image...', 'wp-smushit' ),
'smushing' => esc_html__( 'Smushing image...', 'wp-smushit' ),
'btn_ignore' => esc_html__( 'Ignore', 'wp-smushit' ),
'view_detail' => esc_html__( 'View Details', 'wp-smushit' ),
'membership_valid' => esc_html__( 'We successfully verified your membership, all the Pro features should work completely. ', 'wp-smushit' ),
'membership_invalid' => esc_html__( "Your membership couldn't be verified.", 'wp-smushit' ),
'missing_path' => esc_html__( 'Missing file path.', 'wp-smushit' ),
'failed_item_smushed' => esc_html__( 'Images smushed successfully, No further action required', 'wp-smushit' ),
// Used by Directory Smush.
'unfinished_smush_single' => esc_html__( 'image could not be smushed.', 'wp-smushit' ),
'unfinished_smush' => esc_html__( 'images could not be smushed.', 'wp-smushit' ),
'already_optimised' => esc_html__( 'Already Optimized', 'wp-smushit' ),
'ajax_error' => esc_html__( 'Ajax Error', 'wp-smushit' ),
'generic_ajax_error' => esc_html__( 'Something went wrong with the request. Please reload the page and try again.', 'wp-smushit' ),
'all_done' => esc_html__( 'All Done!', 'wp-smushit' ),
'sync_stats' => esc_html__( 'Give us a moment while we sync the stats.', 'wp-smushit' ),
// Progress bar text.
'progress_smushed' => esc_html__( 'images optimized', 'wp-smushit' ),
'bulk_resume' => esc_html__( 'Resume scan', 'wp-smushit' ),
'bulk_stop' => esc_html__( 'Stop current bulk smush process.', 'wp-smushit' ),
// Errors.
'error_ignore' => esc_html__( 'Ignore this image from bulk smushing', 'wp-smushit' ),
// Ignore text.
'ignored' => esc_html__( 'Ignored', 'wp-smushit' ),
'not_processed' => esc_html__( 'Not processed', 'wp-smushit' ),
// Notices.
'noticeDismiss' => esc_html__( 'Dismiss', 'wp-smushit' ),
'noticeDismissTooltip' => esc_html__( 'Dismiss notice', 'wp-smushit' ),
'tutorialsRemoved' => sprintf( /* translators: %1$s - opening a tag, %2$s - closing a tag */
esc_html__( 'The widget has been removed. Smush tutorials can still be found in the %1$sTutorials tab%2$s any time.', 'wp-smushit' ),
'<a href=' . esc_url( menu_page_url( 'smush-tutorials', false ) ) . '>',
'</a>'
),
'smush_cdn_activation_notice' => WP_Smush::is_pro() && ! $this->mod->cdn->is_active() ?
sprintf(
/* translators: %1$s - opening a tag, %2$s - closing a tag */
esc_html__( 'Activate Smush CDN to bulk smush and serve animated GIF’s via 114 worldwide locations. %1$sActivate CDN%2$s', 'wp-smushit' ),
'<a href="'. esc_url( network_admin_url( 'admin.php?page=smush-cdn' ) ) .'" />',
'</a>'
) :
''
,
// URLs.
'smush_url' => network_admin_url( 'admin.php?page=smush' ),
'bulk_smush_url' => network_admin_url( 'admin.php?page=smush-bulk' ),
'directory_url' => network_admin_url( 'admin.php?page=smush-directory' ),
'localWebpURL' => network_admin_url( 'admin.php?page=smush-webp' ),
'edit_link' => Helper::get_image_media_link( '{{id}}', null, true ),
'debug_mode' => defined( 'WP_DEBUG' ) && WP_DEBUG,
'cancel' => esc_html__( 'Cancel', 'wp-smushit' ),
'cancelling' => esc_html__( 'Cancelling ...', 'wp-smushit' ),
'recheck_images_link' => Helper::get_recheck_images_link(),
);
wp_localize_script( $handle, 'wp_smush_msgs', $wp_smush_msgs );
$product_analytics = WP_Smush::get_instance()->core()->mod->product_analytics;
wp_localize_script(
$handle,
'wp_smush_mixpanel',
array(
'opt_in' => Settings::get_instance()->get( 'usage' ),
'token' => $product_analytics->get_token(),
'unique_id' => $product_analytics->get_unique_id(),
'super_properties' => $product_analytics->get_super_properties(),
)
);
if ( 'toplevel_page_smush' === $current_screen->id ) {
$slug = 'dashboard';
} else {
$slug = explode( 'page_smush-', $current_screen->id );
$slug = isset( $slug[1] ) ? $slug[1] : false;
}
// Load the stats on selected screens only.
if ( $slug && isset( WP_Smush::get_instance()->admin()->pages[ $slug ] ) && method_exists( WP_Smush::get_instance()->admin()->pages[ $slug ], 'dashboard_summary_meta_box' ) ) {
// Get resmush list, If we have a resmush list already, localize those IDs.
$resmush_ids = $this->get_resmush_ids();
if ( $resmush_ids ) {
// Get the attachments, and get lossless count.
$this->resmush_ids = $resmush_ids;
}
// Get attachments if all the images are not smushed.
$this->unsmushed_attachments = $this->remaining_count > 0 ? $this->get_unsmushed_attachments() : array();
$this->unsmushed_attachments = ! empty( $this->unsmushed_attachments ) && is_array( $this->unsmushed_attachments ) ? array_values( $this->unsmushed_attachments ) : $this->unsmushed_attachments;
$data = $this->get_global_stats();
} else {
$data = array(
'count_supersmushed' => '',
'count_smushed' => '',
'count_total' => '',
'count_images' => '',
'unsmushed' => '',
'resmush' => '',
'savings_bytes' => '',
'savings_resize' => '',
'savings_conversion' => '',
'savings_supersmush' => '',
'savings_percent' => '',
'percent_grade' => '',
'percent_metric' => '',
'percent_optimized' => '',
);
}
// Check if scanner class is available.
$scanner_ready = isset( $this->mod->dir->scanner );
$data['dir_smush'] = array(
'currentScanStep' => $scanner_ready ? $this->mod->dir->scanner->get_current_scan_step() : 0,
'totalSteps' => $scanner_ready ? $this->mod->dir->scanner->get_scan_steps() : 0,
);
$data['resize_sizes'] = $this->get_max_image_dimensions();
// Convert it into ms.
$data['timeout'] = WP_SMUSH_TIMEOUT * 1000;
wp_localize_script( $handle, 'wp_smushit_data', apply_filters( 'wp_smush_script_data', $data ) );
}
/**
* Check bulk sent count, whether to allow further smushing or not
*
* @param bool $reset To hard reset the transient.
* @param string $key Transient Key - bulk_sent_count/dir_sent_count.
*
* TODO: remove this (and all related code) because the limit has been lifted in 3.12.0
*
* @return bool
*/
public static function check_bulk_limit( $reset = false, $key = 'bulk_sent_count' ) {
$is_pre_3_12_6_site = get_site_option( 'wp_smush_pre_3_12_6_site' );
if ( $is_pre_3_12_6_site ) {
return true;
}
$transient_name = 'wp-smush-' . $key;
// If we JUST need to reset the transient.
if ( $reset ) {
set_transient( $transient_name, 0, 60 );
return false;
}
$bulk_sent_count = (int) get_transient( $transient_name );
// Check if bulk smush limit is less than limit.
if ( ! $bulk_sent_count || $bulk_sent_count < self::MAX_FREE_BULK ) {
$continue = true;
} elseif ( $bulk_sent_count === self::MAX_FREE_BULK ) {
// If user has reached the limit, reset the transient.
$continue = false;
$reset = true;
} else {
$continue = false;
}
// If we need to reset the transient.
if ( $reset ) {
set_transient( $transient_name, 0, 60 );
}
return $continue;
}
/**
* Get registered image sizes with dimension
*
* @return array
*/
public function image_dimensions() {
return Helper::get_image_sizes();
}
/**
* Get the Maximum Width and Height settings for WrodPress
*
* @return array, Array of Max. Width and Height for image.
*/
public function get_max_image_dimensions() {
global $_wp_additional_image_sizes;
$width = 0;
$height = 0;
$limit = 9999; // Post-thumbnail.
$image_sizes = get_intermediate_image_sizes();
// If image sizes are filtered and no image size list is returned.
if ( empty( $image_sizes ) ) {
return array(
'width' => $width,
'height' => $height,
);
}
// Create the full array with sizes and crop info.
foreach ( $image_sizes as $size ) {
if ( in_array( $size, array( 'thumbnail', 'medium', 'medium_large', 'large' ), true ) ) {
$size_width = get_option( "{$size}_size_w" );
$size_height = get_option( "{$size}_size_h" );
} elseif ( isset( $_wp_additional_image_sizes[ $size ] ) ) {
$size_width = $_wp_additional_image_sizes[ $size ]['width'];
$size_height = $_wp_additional_image_sizes[ $size ]['height'];
}
// Skip if no width and height.
if ( ! isset( $size_width, $size_height ) ) {
continue;
}
// If within te limit, check for a max value.
if ( $size_width <= $limit ) {
$width = max( $width, $size_width );
}
if ( $size_height <= $limit ) {
$height = max( $height, $size_height );
}
}
return array(
'width' => $width,
'height' => $height,
);
}
/**
* Update the image smushed count in transient
*
* @param string $key Database key.
*/
public static function update_smush_count( $key = 'bulk_sent_count' ) {
$transient_name = 'wp-smush-' . $key;
$bulk_sent_count = get_transient( $transient_name );
// If bulk sent count is not set.
if ( false === $bulk_sent_count ) {
// Start transient at 0.
set_transient( $transient_name, 1, 200 );
} elseif ( $bulk_sent_count < self::MAX_FREE_BULK ) {
// If lte MAX_FREE_BULK images are sent, increment.
set_transient( $transient_name, $bulk_sent_count + 1, 200 );
}
}
/**
* Set the big image threshold.
*
* @param int $threshold The threshold value in pixels. Default 2560.
*
* @return int|bool New threshold. False if scaling is disabled.
* @since 3.3.2
*
*/
public function big_image_size_threshold( $threshold ) {
if ( Settings::get_instance()->get( 'no_scale' ) ) {
return false;
}
if ( ! $this->mod->resize->is_active() ) {
return $threshold;
}
$resize_sizes = Settings::get_instance()->get_setting( 'wp-smush-resize_sizes' );
if ( ! $resize_sizes || ! is_array( $resize_sizes ) ) {
return $threshold;
}
return $resize_sizes['width'] > $resize_sizes['height'] ? $resize_sizes['width'] : $resize_sizes['height'];
}
}