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 +369 -111 3.4.0 → 4.7.0 View file →
@@ -1,55 +1,215 @@
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 /**
22 + * The logger for this instance
23 + *
24 + * @var Updraft_File_Logger
25 + */
26 + private $logger;
27 +
28 + /**
19 29 * Constructor
20 30 */
21 31 private function __construct() {
22 32 $this->_should_use_webp = (bool) WP_Optimize()->get_options()->get_option('webp_conversion');
23 33
24 - if ($this->_should_use_webp && $this->get_webp_conversion_test_result()) {
25 - if (!is_admin()) {
34 + $this->logger = new Updraft_File_Logger($this->get_logfile_path());
26 35
27 - // Allow filters added in theme files to run
28 - add_action('after_setup_theme', array($this, 'maybe_decide_webp_serve_method'));
29 - }
30 - }
31 -
32 36 add_action('wpo_reset_webp_conversion_test_result', array($this, 'reset_webp_serving_method'));
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'));
33 40 }
34 41
35 42 /**
36 43 * Returns singleton instance
37 44 *
38 - * @return WP_Optimize_WebP
45 + * @return self
39 46 */
40 - public static function get_instance() {
47 + public static function get_instance(): self {
41 48 static $instance = null;
42 49 if (null === $instance) {
43 - $instance = new WP_Optimize_WebP();
50 + $instance = new self();
44 51 }
45 52 return $instance;
46 53 }
47 54
48 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 + /**
176 + * Returns the path to the logfile
177 + *
178 + * @return string - file path
179 + */
180 + private function get_logfile_path(): string {
181 + return WP_Optimize_Utils::get_log_file_path('webp');
182 + }
183 +
184 + /**
185 + * Logging of interesting messages related to WebP.
186 + *
187 + * @param string $message Log message
188 + * @param string $level Log level (e.g., 'info', 'warning', 'error')
189 + *
190 + * @return void
191 + */
192 + public function log(string $message, string $level = 'info'): void {
193 + $this->logger->log($message, $level);
194 + }
195 +
196 + /**
197 + * Prunes the log file
198 + *
199 + * @return void
200 + */
201 + public function prune_webp_logs(): void {
202 + $this->log("Pruning the WebP log file");
203 + $this->logger->prune_logs();
204 + }
205 +
206 + /**
49 207 * Test Run and find converter status
208 + *
209 + * @return void
50 210 */
51 - private function set_converter_status() {
211 + private function set_converter_status(): void {
52 212 $converter_status = WPO_WebP_Test_Run::get_converter_status();
53 213 if ($this->is_webp_conversion_successful()) {
54 214 WP_Optimize()->get_options()->update_option('webp_conversion_test', true);
55 215 WP_Optimize()->get_options()->update_option('webp_converters', $converter_status['working_converters']);
@@ -56,51 +216,59 @@
56 216 }
57 217 }
58 218
59 219 /**
60 - * 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
61 225 */
62 - public function maybe_decide_webp_serve_method() {
226 + public function maybe_decide_webp_serve_method(string $buffer): string {
63 227 if (!$this->is_webp_redirection_possible()) {
64 - $this->maybe_use_alter_html();
228 + $buffer = $this->maybe_use_alter_html($buffer);
65 229 }
230 + return $buffer;
66 231 }
67 232
68 233 /**
69 - * 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
70 239 */
71 - private function maybe_use_alter_html() {
240 + private function maybe_use_alter_html(string $buffer): string {
72 241 if ($this->is_alter_html_possible()) {
73 242 $this->empty_htaccess_file();
74 - $this->use_alter_html();
243 + $buffer = WPO_WebP_Alter_HTML::get_instance()->alter_html($buffer);
75 244 }
245 + return $buffer;
76 246 }
77 247
78 248 /**
79 - * Even if server support .htaccess rewrite, sometimes it is not possible
80 - * 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 + *
81 252 * Also applies `wpo_force_webp_serve_using_altered_html` filter for users to be able to
82 - * force Altered HTML method
253 + * force the Altered HTML method.
83 254 *
84 255 * @return bool
85 256 */
86 - public function is_webp_redirection_possible() {
257 + public function is_webp_redirection_possible(): bool {
87 258 if (apply_filters('wpo_force_webp_serve_using_altered_html', false)) {
88 259 return false;
89 260 }
261 +
90 262 $redirection_possible = WP_Optimize()->get_options()->get_option('redirection_possible');
91 - 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 +
92 269 return $this->run_webp_serving_self_test();
93 270 }
94 -
95 - /**
96 - * Decide whether the browser requesting the URL can accept webp images or not
97 - *
98 - * @return bool
99 - */
100 - private function is_browser_accepting_webp() {
101 - return (isset($_SERVER['HTTP_ACCEPT']) && false !== strpos($_SERVER['HTTP_ACCEPT'], 'image/webp'));
102 - }
103 271
104 272 /**
105 273 * Detect whether using alter HTML method is possible or not
106 274 *
@@ -105,26 +273,18 @@
105 273 * Detect whether using alter HTML method is possible or not
106 274 *
107 275 * @return bool
108 276 */
109 - private function is_alter_html_possible() {
110 - if ($this->is_browser_accepting_webp()) {
111 - return true;
112 - }
113 - return false;
277 + private function is_alter_html_possible(): bool {
278 + return WPO_WebP_Utils::is_browser_accepting_webp();
114 279 }
115 280
116 281 /**
117 - * Setup alter html method
118 - */
119 - private function use_alter_html() {
120 - WPO_WebP_Alter_HTML::get_instance();
121 - }
122 -
123 - /**
124 282 * Initialize .htaccess
283 + *
284 + * @return void
125 285 */
126 - private function setup_htaccess_file() {
286 + private function setup_htaccess_file(): void {
127 287 if (null !== $this->_htaccess) return;
128 288 $wp_uploads = wp_get_upload_dir();
129 289 $htaccess_file = $wp_uploads['basedir'] . '/.htaccess';
130 290 if (!file_exists($htaccess_file)) {
@@ -137,9 +297,9 @@
137 297 * Save .htaccess rules
138 298 *
139 299 * @return void
140 300 */
141 - public function save_htaccess_rules() {
301 + private function save_htaccess_rules(): void {
142 302 $this->setup_htaccess_file();
143 303 $this->add_webp_mime_type();
144 304 $htaccess_comment_section = 'WP-Optimize WebP Rules';
145 305 if ($this->_htaccess->is_commented_section_exists($htaccess_comment_section)) return;
@@ -149,10 +309,12 @@
149 309 }
150 310
151 311 /**
152 312 * Empty .htaccess file
313 + *
314 + * @return void
153 315 */
154 - public function empty_htaccess_file() {
316 + private function empty_htaccess_file(): void {
155 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
156 318 if (!WP_Optimize()->get_options()->get_option('htaccess_has_webp_rules', true)) return;
157 319 $this->setup_htaccess_file();
158 320 $htaccess_comment_sections = array(
@@ -169,9 +331,9 @@
169 331
170 332 /**
171 333 * Prepare array of htaccess rules to use webp images.
172 334 *
173 - * @return array
335 + * @return array<int, array<array<array<string>|string>|string>>
174 336 */
175 337 private function prepare_webp_htaccess_rules() {
176 338 return array(
177 339 array(
@@ -225,10 +387,12 @@
225 387 }
226 388
227 389 /**
228 390 * Add webp mime type to htaccess rules.
391 + *
392 + * @return void
229 393 */
230 - private function add_webp_mime_type() {
394 + private function add_webp_mime_type(): void {
231 395 $htaccess_comment_section = 'Register webp mime type';
232 396 if ($this->_htaccess->is_exists() && !$this->_htaccess->is_commented_section_exists($htaccess_comment_section)) {
233 397 $webp_mime_type = array(
234 398 array(
@@ -242,34 +406,41 @@
242 406 }
243 407 }
244 408
245 409 /**
246 - * Checks whether webp conversion test is successful or not
410 + * Returns the path to the WebP test image file.
247 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 + *
248 422 * @return bool
249 423 */
250 - public function is_webp_conversion_successful() {
251 - $upload_dir = wp_upload_dir();
252 - $destination = $upload_dir['basedir']. '/wpo/images/wpo_logo_small.png.webp';
253 - return file_exists($destination);
424 + private function is_webp_conversion_successful(): bool {
425 + return file_exists($this->get_webp_test_image_path());
254 426 }
255 427
256 428 /**
257 - * Checks whether sample webp conversion test should be run or not
429 + * Checks whether a sample webp conversion test should be run or not
258 430 *
259 - * @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
260 432 */
261 - public function should_run_webp_conversion_test() {
262 - $webp_conversion_test = $this->get_webp_conversion_test_result();
263 - return (true !== $webp_conversion_test);
433 + private function should_run_webp_conversion_test(): bool {
434 + return !$this->get_webp_conversion_test_result();
264 435 }
265 436
266 437 /**
267 438 * Returns webp conversion test result
268 439 *
269 - * @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
270 441 */
271 - private function get_webp_conversion_test_result() {
442 + public function get_webp_conversion_test_result(): bool {
272 443 return (bool) WP_Optimize()->get_options()->get_option('webp_conversion_test');
273 444 }
274 445
275 446 /**
@@ -276,9 +447,9 @@
276 447 * Checks whether the webp redirection is possible or not and sets flag
277 448 *
278 449 * @return bool Returns true if webp is served successfully, false otherwise
279 450 */
280 - private function run_webp_serving_self_test() {
451 + private function run_webp_serving_self_test(): bool {
281 452 $self_test = WPO_WebP_Self_Test::get_instance();
282 453
283 454 if ($self_test->is_webp_served()) {
284 455 WP_Optimize()->get_options()->update_option('redirection_possible', 'true');
@@ -290,25 +461,27 @@
290 461 }
291 462
292 463 /**
293 464 * Resets webp serving method by running self test, if needed purges cache and empties `uploads/.htaccess` file
465 + *
466 + * @return void
294 467 */
295 - public function reset_webp_serving_method() {
296 - if (self::is_shell_functions_available() && $this->_should_use_webp) {
468 + public function reset_webp_serving_method(): void {
469 + if ($this->_should_use_webp) {
297 470 $this->reset_webp_options();
298 471 $this->run_self_test();
299 472 list($old_redirection_possible, $new_redirection_possible) = $this->get_old_and_new_redirection_possibility();
300 473 $this->maybe_purge_cache($old_redirection_possible, $new_redirection_possible);
301 474 $this->maybe_empty_htaccess_file($new_redirection_possible);
302 - } else {
303 - $this->disable_webp_conversion();
304 475 }
305 476 }
306 477
307 478 /**
308 479 * Resets WebP related options
480 + *
481 + * @return void
309 482 */
310 - private function reset_webp_options() {
483 + private function reset_webp_options(): void {
311 484 $options = WP_Optimize()->get_options();
312 485 $options->update_option('old_redirection_possible', $options->get_option('redirection_possible'));
313 486 $options->update_option('webp_conversion_test', false);
314 487 $options->update_option('webp_converters', false);
@@ -317,10 +490,12 @@
317 490 }
318 491
319 492 /**
320 493 * Running self test to find available converters and possibility of serving webp using redirection method
494 + *
495 + * @return void
321 496 */
322 - private function run_self_test() {
497 + private function run_self_test(): void {
323 498 $this->set_converter_status();
324 499 if ($this->get_webp_conversion_test_result()) {
325 500 $this->save_htaccess_rules();
326 501 $this->run_webp_serving_self_test();
@@ -325,8 +500,9 @@
325 500 $this->save_htaccess_rules();
326 501 $this->run_webp_serving_self_test();
327 502 } else {
328 503 $this->disable_webp_conversion();
504 + $this->log("No working WebP converter was found on the server when running self-test, disabling WebP conversion");
329 505 }
330 506 }
331 507
332 508 /**
@@ -331,9 +507,9 @@
331 507
332 508 /**
333 509 * Gets old and new redirection possibility values
334 510 *
335 - * @return array
511 + * @return array<string>
336 512 */
337 513 private function get_old_and_new_redirection_possibility() {
338 514 $options = WP_Optimize()->get_options();
339 515 return array(
@@ -344,15 +520,25 @@
344 520
345 521 /**
346 522 * Cache is cleared when there is a change in the potential for serving WebP using redirection.
347 523 *
348 - * @param string $old_redirection_possible
349 - * @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
350 527 */
351 - private function maybe_purge_cache($old_redirection_possible, $new_redirection_possible) {
352 - if ($old_redirection_possible !== $new_redirection_possible) {
353 - WP_Optimize()->get_page_cache()->purge();
528 + private function maybe_purge_cache($old_redirection_possible, $new_redirection_possible): void {
529 + if ($old_redirection_possible === $new_redirection_possible) {
530 + return;
354 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 + }
355 541 }
356 542
357 543 /**
358 544 * Remove redirection rules from `uploads/.htaccess` file if redirection is not possible
@@ -357,10 +543,11 @@
357 543 /**
358 544 * Remove redirection rules from `uploads/.htaccess` file if redirection is not possible
359 545 *
360 546 * @param string $new_redirection_possible
547 + * @return void
361 548 */
362 - private function maybe_empty_htaccess_file($new_redirection_possible) {
549 + private function maybe_empty_htaccess_file($new_redirection_possible): void {
363 550 if ('false' === $new_redirection_possible) {
364 551 $this->empty_htaccess_file();
365 552 }
366 553 }
@@ -366,91 +553,162 @@
366 553 }
367 554
368 555 /**
369 556 * Initialize cron scheduler
557 + *
558 + * @return void
370 559 */
371 - public function init_webp_cron_scheduler() {
560 + public function init_webp_cron_scheduler(): void {
372 561 if (!wp_next_scheduled('wpo_reset_webp_conversion_test_result')) {
373 562 wp_schedule_event(time(), 'wpo_daily', 'wpo_reset_webp_conversion_test_result');
374 563 }
564 + if (!wp_next_scheduled('wpo_prune_webp_logs')) {
565 + wp_schedule_event(time(), 'weekly', 'wpo_prune_webp_logs');
566 + }
567 + if (!wp_next_scheduled('wpo_webp_convert_compressed_images')) {
568 + wp_schedule_event(strtotime('midnight'), 'daily', 'wpo_webp_convert_compressed_images');
569 + }
375 570 }
376 571
377 572 /**
378 573 * Remove all cron schedules
574 + *
575 + * @return void
379 576 */
380 - public function remove_webp_cron_schedules() {
577 + public function remove_webp_cron_schedules(): void {
381 578 wp_clear_scheduled_hook('wpo_reset_webp_conversion_test_result');
579 + wp_clear_scheduled_hook('wpo_prune_webp_logs');
580 + wp_clear_scheduled_hook('wpo_webp_convert_compressed_images');
382 581 }
383 582
384 583 /**
385 - * Return the true if webp conversion is enabled and vice-versa
584 + * Return the true if webp conversion is enabled and vice versa
386 585 *
387 586 * @return bool
388 587 */
389 - public function is_webp_conversion_enabled() {
588 + public function is_webp_conversion_enabled(): bool {
390 589 return $this->_should_use_webp;
391 590 }
392 591
393 592 /**
394 593 * Set the webp_conversion option value to false and remove webp cron schedules
594 + *
595 + * @return void
395 596 */
396 - public function disable_webp_conversion() {
597 + public function disable_webp_conversion(): void {
397 598 $this->empty_htaccess_file();
398 599 WP_Optimize()->get_options()->update_option("webp_conversion", false);
399 600 $this->remove_webp_cron_schedules();
601 + $message = __('Disabling the webp conversion.', 'wp-optimize');
602 + $this->log($message);
400 603 }
401 604
402 605 /**
403 606 * Remove webp converted test image file
607 + *
608 + * @return void
404 609 */
405 - private function remove_webp_test_image_file() {
406 - $upload_dir = wp_upload_dir();
407 - $destination = $upload_dir['basedir']. '/wpo/images/wpo_logo_small.png.webp';
408 - if (@file_exists($destination)) { // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- suppress PHP warning in case of failure
409 - @unlink($destination); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged -- suppress PHP warning in case of failure
410 - }
610 + private function remove_webp_test_image_file(): void {
611 + $destination = $this->get_webp_test_image_path();
612 + wp_delete_file($destination);
411 613 }
412 614
413 615 /**
414 616 * Run during plugin deactivation
617 + *
618 + * @return void
415 619 */
416 - public function plugin_deactivate() {
620 + public function plugin_deactivate(): void {
417 621 $this->empty_htaccess_file();
418 622 $this->remove_webp_test_image_file();
419 623 }
420 624
421 625 /**
422 - * 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.
423 627 *
424 628 * @return bool
425 629 */
426 - public static function is_shell_functions_available() {
427 - $shell_functions = self::get_shell_functions();
428 - foreach ($shell_functions as $shell_function) {
429 - 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;
430 674 }
431 675 return true;
432 676 }
433 677
434 678 /**
435 - * List of php shell function names
679 + * Check if one of the functions from the list is available.
436 680 *
437 - * @return string[]
681 + * @param array<string> $functions
682 + * @return bool
438 683 */
439 - private static function get_shell_functions() {
440 - return array(
441 - 'escapeshellarg',
442 - 'escapeshellcmd',
443 - 'exec',
444 - 'passthru',
445 - 'proc_close',
446 - 'proc_get_status',
447 - 'proc_nice',
448 - 'proc_open',
449 - 'proc_terminate',
450 - 'shell_exec',
451 - 'system',
452 - );
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 + }
453 711 }
454 712 }
455 713
456 714 endif;