PluginProbe
WP-Optimize – Cache, Compress images, Minify & Clean database to boost page speed & performance / 4.7.0
WP-Optimize – Cache, Compress images, Minify & Clean database to boost page speed & performance v4.7.0
4.7.0 4.6.1 4.6.0 4.5.5 4.5.4 4.5.3 4.5.2 3.2.20 3.2.21 3.2.22 3.2.3 3.2.5 3.2.6 3.2.7 3.2.9 3.3.0 3.3.1 3.3.2 3.4.0 3.4.1 3.4.2 3.5.0 3.6.0 3.7.0 3.7.1 All 111 releases
← All changes | webp/class-wp-optimize-webp.php +336 -127 3.5.0 → 4.7.0 View file →
@@ -1,25 +1,28 @@
1 1 <?php
2 2
3 -if (!defined('WPO_VERSION')) die('No direct access allowed');
3 +if (!defined('ABSPATH')) die('No direct access allowed');
4 4
5 5 if (!class_exists('WP_Optimize_WebP')) :
6 6
7 7 class WP_Optimize_WebP {
8 8
9 - private $_htaccess = null;
9 + /**
10 + * @var WP_Optimize_Htaccess
11 + */
12 + private $_htaccess;
10 13
11 14 /**
12 - * Set to true when webp is enabled and vice-versa
15 + * Set to true when webp is enabled and vice versa
13 16 *
14 17 * @var boolean
15 18 */
16 - private $_should_use_webp = false;
19 + private $_should_use_webp;
17 20
18 21 /**
19 22 * The logger for this instance
20 23 *
21 - * @var mixed
24 + * @var Updraft_File_Logger
22 25 */
23 26 private $logger;
24 27
25 28 /**
@@ -27,57 +30,176 @@
27 30 */
28 31 private function __construct() {
29 32 $this->_should_use_webp = (bool) WP_Optimize()->get_options()->get_option('webp_conversion');
30 33
31 - if ($this->_should_use_webp && $this->get_webp_conversion_test_result()) {
32 - if (!is_admin()) {
33 -
34 - // Allow filters added in theme files to run
35 - add_action('after_setup_theme', array($this, 'maybe_decide_webp_serve_method'));
36 - }
37 - }
38 -
39 34 $this->logger = new Updraft_File_Logger($this->get_logfile_path());
40 35
41 36 add_action('wpo_reset_webp_conversion_test_result', array($this, 'reset_webp_serving_method'));
42 37 add_action('wpo_prune_webp_logs', array($this, 'prune_webp_logs'));
38 + $task_manager = WPO_Webp_Task_Manager::get_instance();
39 + add_action('wpo_webp_convert_compressed_images', array($task_manager, 'webp_convert_compressed_images'));
43 40 }
44 41
45 42 /**
46 43 * Returns singleton instance
47 44 *
48 - * @return WP_Optimize_WebP
45 + * @return self
49 46 */
50 - public static function get_instance() {
47 + public static function get_instance(): self {
51 48 static $instance = null;
52 49 if (null === $instance) {
53 - $instance = new WP_Optimize_WebP();
50 + $instance = new self();
54 51 }
55 52 return $instance;
56 53 }
57 54
58 55 /**
56 + * Evaluate WebP conversion capability.
57 + *
58 + * @return array{is_available: bool, reason: string, message: string, converter_status: array<string, array<string>>, test_ran: bool}
59 + */
60 + public function evaluate_webp_capability(): array {
61 + $converter_status = array();
62 + $test_ran = false;
63 + if ($this->is_only_shell_converters_available() && !$this->shell_functions_available()) {
64 + return array(
65 + 'is_available' => false,
66 + 'reason' => 'update_failed_no_shell_functions',
67 + 'message' => __('Required WebP shell functions are not available on the server.', 'wp-optimize'),
68 + 'converter_status' => $converter_status,
69 + 'test_ran' => $test_ran,
70 + );
71 + }
72 +
73 + if ($this->should_run_webp_conversion_test()) {
74 + $test_ran = true;
75 + $converter_status = WPO_WebP_Test_Run::get_converter_status();
76 + if (!$this->is_webp_conversion_successful()) {
77 + return array(
78 + 'is_available' => false,
79 + 'reason' => 'update_failed_no_working_webp_converter',
80 + 'message' => __('No working WebP converter was found on the server.', 'wp-optimize'),
81 + 'converter_status' => $converter_status,
82 + 'test_ran' => $test_ran,
83 + );
84 + }
85 + }
86 +
87 + return array(
88 + 'is_available' => true,
89 + 'reason' => '',
90 + 'message' => '',
91 + 'converter_status' => $converter_status,
92 + 'test_ran' => $test_ran,
93 + );
94 + }
95 +
96 + /**
97 + * Try to enable webp conversion, upon failure disable webp conversion
98 + *
99 + * @param array<string, string> $data - Data webp_conversion (true|false)
100 + * @return WP_Error|bool - information about the operation or WP_Error object on failure
101 + */
102 + private function configure_webp_conversion($data) {
103 +
104 + $options = array();
105 + $options['webp_conversion'] = isset($data['webp_conversion']) ? filter_var($data['webp_conversion'], FILTER_VALIDATE_BOOLEAN) : false;
106 +
107 + if ($options['webp_conversion']) {
108 + $capability = $this->evaluate_webp_capability();
109 +
110 + if (!$capability['is_available']) {
111 + $this->disable_webp_conversion();
112 + $message = $capability['message'];
113 + $reason = $capability['reason'];
114 + $this->log($message);
115 + return new WP_Error($reason, $message);
116 + }
117 +
118 + // Only update the test result and converters if the test actually ran
119 + if ($capability['test_ran']) {
120 + $options['webp_conversion_test'] = true;
121 + $options['webp_converters'] = $capability['converter_status']['working_converters'] ?? array();
122 + }
123 +
124 + // Run serving methods tests and set necessary option values
125 + // Not possible to test alter HTML since the test is browser-based
126 + $this->save_htaccess_rules();
127 + if (!$this->is_webp_redirection_possible()) {
128 + $this->empty_htaccess_file();
129 + $options['redirection_possible'] = 'false';
130 + } else {
131 + $options['redirection_possible'] = 'true';
132 + }
133 + }
134 + $smush_manager = Updraft_Smush_Manager::instance();
135 + $success = $smush_manager->update_smush_options($options);
136 +
137 + if (!$success) {
138 + $this->disable_webp_conversion();
139 + $message = __('WebP options could not be updated.', 'wp-optimize');
140 + $this->log($message);
141 + return new WP_Error('update_failed', $message);
142 + }
143 +
144 + // Set up daily CRON only when enabling WebP and Delete daily CRON when disabling WebP
145 + if ($options['webp_conversion']) {
146 + $this->init_webp_cron_scheduler();
147 + } else {
148 + $this->remove_webp_cron_schedules();
149 + $this->empty_htaccess_file();
150 + }
151 + return $success;
152 + }
153 +
154 + /**
155 + * Save WebP settings and trigger related actions.
156 + *
157 + * @param array<string, string> $data WebP settings (expects 'webp_conversion').
158 + * @return bool|WP_Error True on success, WP_Error on failure.
159 + */
160 + public function save_webp_settings($data) {
161 +
162 + if (!is_array($data)) {
163 + return new WP_Error('invalid_data', __('Invalid WebP settings data.', 'wp-optimize'));
164 + }
165 +
166 + $result = $this->configure_webp_conversion($data);
167 +
168 + if (!is_wp_error($result)) {
169 + do_action('wpo_save_images_settings');
170 + }
171 +
172 + return $result;
173 + }
174 +
175 + /**
59 176 * Returns the path to the logfile
60 177 *
61 178 * @return string - file path
62 179 */
63 - private function get_logfile_path() {
180 + private function get_logfile_path(): string {
64 181 return WP_Optimize_Utils::get_log_file_path('webp');
65 182 }
66 183
67 184 /**
68 - * Logging of interesting messages related to Webp
185 + * Logging of interesting messages related to WebP.
69 186 *
70 - * @param string $message
187 + * @param string $message Log message
188 + * @param string $level Log level (e.g., 'info', 'warning', 'error')
189 + *
190 + * @return void
71 191 */
72 - public function log($message) {
73 - $this->logger->info($message);
192 + public function log(string $message, string $level = 'info'): void {
193 + $this->logger->log($message, $level);
74 194 }
75 195
76 196 /**
77 197 * Prunes the log file
198 + *
199 + * @return void
78 200 */
79 - public function prune_webp_logs() {
201 + public function prune_webp_logs(): void {
80 202 $this->log("Pruning the WebP log file");
81 203 $this->logger->prune_logs();
82 204 }
83 205
@@ -82,10 +204,12 @@
82 204 }
83 205
84 206 /**
85 207 * Test Run and find converter status
208 + *
209 + * @return void
86 210 */
87 - private function set_converter_status() {
211 + private function set_converter_status(): void {
88 212 $converter_status = WPO_WebP_Test_Run::get_converter_status();
89 213 if ($this->is_webp_conversion_successful()) {
90 214 WP_Optimize()->get_options()->update_option('webp_conversion_test', true);
91 215 WP_Optimize()->get_options()->update_option('webp_converters', $converter_status['working_converters']);
@@ -92,51 +216,59 @@
92 216 }
93 217 }
94 218
95 219 /**
96 - * If .htaccess redirection is not possible, attempts to use the alter_html method
220 + * If .htaccess redirection is not possible, attempts to use the alter_html method.
221 + *
222 + * @param string $buffer Page HTML
223 + *
224 + * @return string
97 225 */
98 - public function maybe_decide_webp_serve_method() {
226 + public function maybe_decide_webp_serve_method(string $buffer): string {
99 227 if (!$this->is_webp_redirection_possible()) {
100 - $this->maybe_use_alter_html();
228 + $buffer = $this->maybe_use_alter_html($buffer);
101 229 }
230 + return $buffer;
102 231 }
103 232
104 233 /**
105 - * If alter html method is possible, then use it
234 + * If alter HTML method is possible, apply it to the buffer.
235 + *
236 + * @param string $buffer Page HTML
237 + *
238 + * @return string
106 239 */
107 - private function maybe_use_alter_html() {
240 + private function maybe_use_alter_html(string $buffer): string {
108 241 if ($this->is_alter_html_possible()) {
109 242 $this->empty_htaccess_file();
110 - $this->use_alter_html();
243 + $buffer = WPO_WebP_Alter_HTML::get_instance()->alter_html($buffer);
111 244 }
245 + return $buffer;
112 246 }
113 247
114 248 /**
115 - * Even if server support .htaccess rewrite, sometimes it is not possible
116 - * to serve webp images. So, find it webp redirection is possible or not
249 + * Even if the server supports .htaccess rewrite, sometimes it is not possible
250 + * to serve webp images. This method determines whether webp redirection is possible.
251 + *
117 252 * Also applies `wpo_force_webp_serve_using_altered_html` filter for users to be able to
118 - * force Altered HTML method
253 + * force the Altered HTML method.
119 254 *
120 255 * @return bool
121 256 */
122 - public function is_webp_redirection_possible() {
257 + public function is_webp_redirection_possible(): bool {
123 258 if (apply_filters('wpo_force_webp_serve_using_altered_html', false)) {
124 259 return false;
125 260 }
261 +
126 262 $redirection_possible = WP_Optimize()->get_options()->get_option('redirection_possible');
127 - if (!empty($redirection_possible)) return 'true' === $redirection_possible;
263 +
264 + // If a previous test result exists, use it; otherwise, run the self test
265 + if (!empty($redirection_possible)) {
266 + return 'true' === $redirection_possible;
267 + }
268 +
128 269 return $this->run_webp_serving_self_test();
129 270 }
130 -
131 - /**
132 - * Decide whether the browser requesting the URL can accept webp images or not
133 - *
134 - * @return bool
135 - */
136 - private function is_browser_accepting_webp() {
137 - return (isset($_SERVER['HTTP_ACCEPT']) && false !== strpos($_SERVER['HTTP_ACCEPT'], 'image/webp'));
138 - }
139 271
140 272 /**
141 273 * Detect whether using alter HTML method is possible or not
142 274 *
@@ -141,26 +273,18 @@
141 273 * Detect whether using alter HTML method is possible or not
142 274 *
143 275 * @return bool
144 276 */
145 - private function is_alter_html_possible() {
146 - if ($this->is_browser_accepting_webp()) {
147 - return true;
148 - }
149 - return false;
277 + private function is_alter_html_possible(): bool {
278 + return WPO_WebP_Utils::is_browser_accepting_webp();
150 279 }
151 280
152 281 /**
153 - * Setup alter html method
154 - */
155 - private function use_alter_html() {
156 - WPO_WebP_Alter_HTML::get_instance();
157 - }
158 -
159 - /**
160 282 * Initialize .htaccess
283 + *
284 + * @return void
161 285 */
162 - private function setup_htaccess_file() {
286 + private function setup_htaccess_file(): void {
163 287 if (null !== $this->_htaccess) return;
164 288 $wp_uploads = wp_get_upload_dir();
165 289 $htaccess_file = $wp_uploads['basedir'] . '/.htaccess';
166 290 if (!file_exists($htaccess_file)) {
@@ -173,9 +297,9 @@
173 297 * Save .htaccess rules
174 298 *
175 299 * @return void
176 300 */
177 - public function save_htaccess_rules() {
301 + private function save_htaccess_rules(): void {
178 302 $this->setup_htaccess_file();
179 303 $this->add_webp_mime_type();
180 304 $htaccess_comment_section = 'WP-Optimize WebP Rules';
181 305 if ($this->_htaccess->is_commented_section_exists($htaccess_comment_section)) return;
@@ -185,10 +309,12 @@
185 309 }
186 310
187 311 /**
188 312 * Empty .htaccess file
313 + *
314 + * @return void
189 315 */
190 - public function empty_htaccess_file() {
316 + private function empty_htaccess_file(): void {
191 317 // Setting default to true, so on initial run (when option is not yet present in the DB) we don't break the function here
192 318 if (!WP_Optimize()->get_options()->get_option('htaccess_has_webp_rules', true)) return;
193 319 $this->setup_htaccess_file();
194 320 $htaccess_comment_sections = array(
@@ -205,9 +331,9 @@
205 331
206 332 /**
207 333 * Prepare array of htaccess rules to use webp images.
208 334 *
209 - * @return array
335 + * @return array<int, array<array<array<string>|string>|string>>
210 336 */
211 337 private function prepare_webp_htaccess_rules() {
212 338 return array(
213 339 array(
@@ -261,10 +387,12 @@
261 387 }
262 388
263 389 /**
264 390 * Add webp mime type to htaccess rules.
391 + *
392 + * @return void
265 393 */
266 - private function add_webp_mime_type() {
394 + private function add_webp_mime_type(): void {
267 395 $htaccess_comment_section = 'Register webp mime type';
268 396 if ($this->_htaccess->is_exists() && !$this->_htaccess->is_commented_section_exists($htaccess_comment_section)) {
269 397 $webp_mime_type = array(
270 398 array(
@@ -278,34 +406,41 @@
278 406 }
279 407 }
280 408
281 409 /**
282 - * Checks whether webp conversion test is successful or not
410 + * Returns the path to the WebP test image file.
283 411 *
412 + * @return string
413 + */
414 + private function get_webp_test_image_path(): string {
415 + $upload_dir = wp_upload_dir();
416 + return $upload_dir['basedir'] . '/wpo/images/wpo_logo_small.png.webp';
417 + }
418 +
419 + /**
420 + * Checks whether a webp conversion test is successful or not
421 + *
284 422 * @return bool
285 423 */
286 - public function is_webp_conversion_successful() {
287 - $upload_dir = wp_upload_dir();
288 - $destination = $upload_dir['basedir']. '/wpo/images/wpo_logo_small.png.webp';
289 - return file_exists($destination);
424 + private function is_webp_conversion_successful(): bool {
425 + return file_exists($this->get_webp_test_image_path());
290 426 }
291 427
292 428 /**
293 - * Checks whether sample webp conversion test should be run or not
429 + * Checks whether a sample webp conversion test should be run or not
294 430 *
295 - * @return bool Returns true if sample test should be run, false otherwise
431 + * @return bool Returns true if the sample test should be run, false otherwise
296 432 */
297 - public function should_run_webp_conversion_test() {
298 - $webp_conversion_test = $this->get_webp_conversion_test_result();
299 - return (true !== $webp_conversion_test);
433 + private function should_run_webp_conversion_test(): bool {
434 + return !$this->get_webp_conversion_test_result();
300 435 }
301 436
302 437 /**
303 438 * Returns webp conversion test result
304 439 *
305 - * @return boolean Returns the value of the webp_conversion_test saved in the options table
440 + * @return bool Returns the value of the webp_conversion_test saved in the options table
306 441 */
307 - private function get_webp_conversion_test_result() {
442 + public function get_webp_conversion_test_result(): bool {
308 443 return (bool) WP_Optimize()->get_options()->get_option('webp_conversion_test');
309 444 }
310 445
311 446 /**
@@ -312,9 +447,9 @@
312 447 * Checks whether the webp redirection is possible or not and sets flag
313 448 *
314 449 * @return bool Returns true if webp is served successfully, false otherwise
315 450 */
316 - private function run_webp_serving_self_test() {
451 + private function run_webp_serving_self_test(): bool {
317 452 $self_test = WPO_WebP_Self_Test::get_instance();
318 453
319 454 if ($self_test->is_webp_served()) {
320 455 WP_Optimize()->get_options()->update_option('redirection_possible', 'true');
@@ -326,26 +461,27 @@
326 461 }
327 462
328 463 /**
329 464 * Resets webp serving method by running self test, if needed purges cache and empties `uploads/.htaccess` file
465 + *
466 + * @return void
330 467 */
331 - public function reset_webp_serving_method() {
332 - if (self::is_shell_functions_available() && $this->_should_use_webp) {
468 + public function reset_webp_serving_method(): void {
469 + if ($this->_should_use_webp) {
333 470 $this->reset_webp_options();
334 471 $this->run_self_test();
335 472 list($old_redirection_possible, $new_redirection_possible) = $this->get_old_and_new_redirection_possibility();
336 473 $this->maybe_purge_cache($old_redirection_possible, $new_redirection_possible);
337 474 $this->maybe_empty_htaccess_file($new_redirection_possible);
338 - } else {
339 - $this->disable_webp_conversion();
340 - $this->log("Reset WebP Serving method failed, disabling WebP conversion");
341 475 }
342 476 }
343 477
344 478 /**
345 479 * Resets WebP related options
480 + *
481 + * @return void
346 482 */
347 - private function reset_webp_options() {
483 + private function reset_webp_options(): void {
348 484 $options = WP_Optimize()->get_options();
349 485 $options->update_option('old_redirection_possible', $options->get_option('redirection_possible'));
350 486 $options->update_option('webp_conversion_test', false);
351 487 $options->update_option('webp_converters', false);
@@ -354,10 +490,12 @@
354 490 }
355 491
356 492 /**
357 493 * Running self test to find available converters and possibility of serving webp using redirection method
494 + *
495 + * @return void
358 496 */
359 - private function run_self_test() {
497 + private function run_self_test(): void {
360 498 $this->set_converter_status();
361 499 if ($this->get_webp_conversion_test_result()) {
362 500 $this->save_htaccess_rules();
363 501 $this->run_webp_serving_self_test();
@@ -369,9 +507,9 @@
369 507
370 508 /**
371 509 * Gets old and new redirection possibility values
372 510 *
373 - * @return array
511 + * @return array<string>
374 512 */
375 513 private function get_old_and_new_redirection_possibility() {
376 514 $options = WP_Optimize()->get_options();
377 515 return array(
@@ -382,22 +520,25 @@
382 520
383 521 /**
384 522 * Cache is cleared when there is a change in the potential for serving WebP using redirection.
385 523 *
386 - * @param string $old_redirection_possible
387 - * @param string $new_redirection_possible
524 + * @param string $old_redirection_possible Previous redirection possibility value
525 + * @param string $new_redirection_possible Current redirection possibility value
526 + * @return void
388 527 */
389 - private function maybe_purge_cache($old_redirection_possible, $new_redirection_possible) {
390 - if ($old_redirection_possible !== $new_redirection_possible) {
391 - WP_Optimize()->get_page_cache()->purge();
392 - $log_old_value = empty($old_redirection_possible) ? "null" : $old_redirection_possible;
393 - $log_new_value = empty($new_redirection_possible) ? "null" : $new_redirection_possible;
394 - $this->log("Purging cache because redirection_possible value changed from: " .
395 - $log_old_value .
396 - " to " .
397 - $log_new_value
398 - );
528 + private function maybe_purge_cache($old_redirection_possible, $new_redirection_possible): void {
529 + if ($old_redirection_possible === $new_redirection_possible) {
530 + return;
399 531 }
532 +
533 + $is_cache_purged = WP_Optimize()->get_page_cache()->purge();
534 + $log_old_value = empty($old_redirection_possible) ? 'null' : $old_redirection_possible;
535 + $log_new_value = empty($new_redirection_possible) ? 'null' : $new_redirection_possible;
536 + $this->log("Purging cache because redirection_possible value changed from: {$log_old_value} to {$log_new_value}");
537 +
538 + if ($is_cache_purged) {
539 + WP_Optimize()->get_page_cache()->file_log('Full Cache Purge due to change in the value of WebP redirection');
540 + }
400 541 }
401 542
402 543 /**
403 544 * Remove redirection rules from `uploads/.htaccess` file if redirection is not possible
@@ -402,10 +543,11 @@
402 543 /**
403 544 * Remove redirection rules from `uploads/.htaccess` file if redirection is not possible
404 545 *
405 546 * @param string $new_redirection_possible
547 + * @return void
406 548 */
407 - private function maybe_empty_htaccess_file($new_redirection_possible) {
549 + private function maybe_empty_htaccess_file($new_redirection_possible): void {
408 550 if ('false' === $new_redirection_possible) {
409 551 $this->empty_htaccess_file();
410 552 }
411 553 }
@@ -411,10 +553,12 @@
411 553 }
412 554
413 555 /**
414 556 * Initialize cron scheduler
557 + *
558 + * @return void
415 559 */
416 - public function init_webp_cron_scheduler() {
560 + public function init_webp_cron_scheduler(): void {
417 561 if (!wp_next_scheduled('wpo_reset_webp_conversion_test_result')) {
418 562 wp_schedule_event(time(), 'wpo_daily', 'wpo_reset_webp_conversion_test_result');
419 563 }
420 564 if (!wp_next_scheduled('wpo_prune_webp_logs')) {
@@ -419,87 +563,152 @@
419 563 }
420 564 if (!wp_next_scheduled('wpo_prune_webp_logs')) {
421 565 wp_schedule_event(time(), 'weekly', 'wpo_prune_webp_logs');
422 566 }
567 + if (!wp_next_scheduled('wpo_webp_convert_compressed_images')) {
568 + wp_schedule_event(strtotime('midnight'), 'daily', 'wpo_webp_convert_compressed_images');
569 + }
423 570 }
424 571
425 572 /**
426 573 * Remove all cron schedules
574 + *
575 + * @return void
427 576 */
428 - public function remove_webp_cron_schedules() {
577 + public function remove_webp_cron_schedules(): void {
429 578 wp_clear_scheduled_hook('wpo_reset_webp_conversion_test_result');
430 579 wp_clear_scheduled_hook('wpo_prune_webp_logs');
580 + wp_clear_scheduled_hook('wpo_webp_convert_compressed_images');
431 581 }
432 582
433 583 /**
434 - * Return the true if webp conversion is enabled and vice-versa
584 + * Return the true if webp conversion is enabled and vice versa
435 585 *
436 586 * @return bool
437 587 */
438 - public function is_webp_conversion_enabled() {
588 + public function is_webp_conversion_enabled(): bool {
439 589 return $this->_should_use_webp;
440 590 }
441 591
442 592 /**
443 593 * Set the webp_conversion option value to false and remove webp cron schedules
594 + *
595 + * @return void
444 596 */
445 - public function disable_webp_conversion() {
597 + public function disable_webp_conversion(): void {
446 598 $this->empty_htaccess_file();
447 599 WP_Optimize()->get_options()->update_option("webp_conversion", false);
448 600 $this->remove_webp_cron_schedules();
601 + $message = __('Disabling the webp conversion.', 'wp-optimize');
602 + $this->log($message);
449 603 }
450 604
451 605 /**
452 606 * Remove webp converted test image file
607 + *
608 + * @return void
453 609 */
454 - private function remove_webp_test_image_file() {
455 - $upload_dir = wp_upload_dir();
456 - $destination = $upload_dir['basedir']. '/wpo/images/wpo_logo_small.png.webp';
457 - if (@file_exists($destination)) { // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- suppress PHP warning in case of failure
458 - @unlink($destination); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- suppress PHP warning in case of failure
459 - }
610 + private function remove_webp_test_image_file(): void {
611 + $destination = $this->get_webp_test_image_path();
612 + wp_delete_file($destination);
460 613 }
461 614
462 615 /**
463 616 * Run during plugin deactivation
617 + *
618 + * @return void
464 619 */
465 - public function plugin_deactivate() {
620 + public function plugin_deactivate(): void {
466 621 $this->empty_htaccess_file();
467 622 $this->remove_webp_test_image_file();
468 623 }
469 624
470 625 /**
471 - * Determines whether the php shell functions are available or not
626 + * Determines whether one of the PHP shell functions required for WebP conversion is available or not.
472 627 *
473 628 * @return bool
474 629 */
475 - public static function is_shell_functions_available() {
476 - $shell_functions = self::get_shell_functions();
477 - foreach ($shell_functions as $shell_function) {
478 - if (!function_exists($shell_function)) return false;
630 + public function shell_functions_available(): bool {
631 + $has_escapeshellarg = function_exists('escapeshellarg');
632 + $has_exec_or_passthru = $this->any_function_exists(array('exec', 'passthru'));
633 + $has_proc_functions = $this->all_functions_exist(array('proc_open', 'proc_close'));
634 + $has_popen_functions = $this->all_functions_exist(array('popen', 'pclose'));
635 +
636 + return $has_escapeshellarg && ($has_exec_or_passthru || $has_proc_functions || $has_popen_functions);
637 + }
638 +
639 + /**
640 + * Checks if only shell converters available for WebP conversion.
641 + *
642 + * @return boolean
643 + */
644 + private function is_only_shell_converters_available(): bool {
645 + $available_converters = WP_Optimize()->get_options()->get_option('webp_converters');
646 + /** @var array<string> $available_converters */
647 + $available_converters = is_array($available_converters) ? $available_converters : array();
648 + $converters_with_shell = WPO_WebP_Test_Run::get_converters_with_shell();
649 + $available_with_shell = array_intersect($available_converters, $converters_with_shell);
650 +
651 + return count($available_converters) > 0 && count($available_converters) === count($available_with_shell);
652 + }
653 +
654 + /**
655 + * Determines whether one of the PHP shell functions required for WebP conversion is available or not.
656 + *
657 + * @deprecated 3.6.0
658 + * @return bool
659 + */
660 + public static function is_shell_functions_available(): bool {
661 + _deprecated_function(__METHOD__, '3.6.0', 'WP_Optimize_WebP::shell_functions_available');
662 + return WP_Optimize_WebP::get_instance()->shell_functions_available();
663 + }
664 +
665 + /**
666 + * Check if all the functions from the list is available.
667 + *
668 + * @param array<string> $functions
669 + * @return bool
670 + */
671 + private function all_functions_exist($functions): bool {
672 + foreach ($functions as $function) {
673 + if (!function_exists($function)) return false;
479 674 }
480 675 return true;
481 676 }
482 677
483 678 /**
484 - * List of php shell function names
679 + * Check if one of the functions from the list is available.
485 680 *
486 - * @return string[]
681 + * @param array<string> $functions
682 + * @return bool
487 683 */
488 - private static function get_shell_functions() {
489 - return array(
490 - 'escapeshellarg',
491 - 'escapeshellcmd',
492 - 'exec',
493 - 'passthru',
494 - 'proc_close',
495 - 'proc_get_status',
496 - 'proc_nice',
497 - 'proc_open',
498 - 'proc_terminate',
499 - 'shell_exec',
500 - 'system',
501 - );
684 + private function any_function_exists($functions): bool {
685 + foreach ($functions as $function) {
686 + if (function_exists($function)) return true;
687 + }
688 + return false;
689 + }
690 +
691 + /**
692 + * Return true if webp conversion is enabled and vice versa.
693 + *
694 + * @return bool
695 + */
696 + public function is_webp_enabled(): bool {
697 + _deprecated_function(__METHOD__, '4.5.4', 'WP_Optimize_WebP::is_webp_conversion_enabled');
698 + return $this->is_webp_conversion_enabled();
699 + }
700 +
701 + /**
702 + * Actions to be performed upon plugin activation
703 + *
704 + * @return void
705 + */
706 + public function plugin_activate(): void {
707 + if ($this->is_webp_conversion_enabled()) {
708 + $this->init_webp_cron_scheduler();
709 + $this->reset_webp_serving_method();
710 + }
502 711 }
503 712 }
504 713
505 714 endif;