OrderLogsCleanupHelper.php
3 weeks ago
OrderLogsDeletionProcessor.php
3 months ago
RemoteLogger.php
10 months ago
SafeGlobalFunctionProxy.php
2 weeks ago
SafeGlobalFunctionProxy.php
119 lines
| 1 | <?php |
| 2 | |
| 3 | declare(strict_types=1); |
| 4 | |
| 5 | namespace Automattic\WooCommerce\Internal\Logging; |
| 6 | |
| 7 | /** |
| 8 | * SafeGlobalFunctionProxy Class |
| 9 | * |
| 10 | * This class creates a wrapper for non-built-in functions for safety. |
| 11 | * |
| 12 | * @since 9.4.0 |
| 13 | * @package Automattic\WooCommerce\Internal\Logging |
| 14 | * |
| 15 | * @method static \WC_Logger_Interface wc_get_logger() |
| 16 | */ |
| 17 | class SafeGlobalFunctionProxy { |
| 18 | |
| 19 | /** |
| 20 | * Load missing function if we know where to find it. |
| 21 | * Modify this file to add more functions to the map. |
| 22 | * |
| 23 | * @param string $name The name of the function to load. |
| 24 | * @return void |
| 25 | * @throws \Exception If the function is missing and could not be loaded. |
| 26 | */ |
| 27 | private static function maybe_load_missing_function( $name ) { |
| 28 | $function_map = array( |
| 29 | 'wp_parse_url' => ABSPATH . WPINC . '/http.php', |
| 30 | 'home_url' => ABSPATH . WPINC . '/link-template.php', |
| 31 | 'get_bloginfo' => ABSPATH . WPINC . '/general-template.php', |
| 32 | 'get_option' => ABSPATH . WPINC . '/option.php', |
| 33 | 'get_site_transient' => ABSPATH . WPINC . '/option.php', |
| 34 | 'set_site_transient' => ABSPATH . WPINC . '/option.php', |
| 35 | 'wp_safe_remote_post' => ABSPATH . WPINC . '/http.php', |
| 36 | 'is_wp_error' => ABSPATH . WPINC . '/load.php', |
| 37 | 'get_plugin_updates' => array( ABSPATH . 'wp-admin/includes/update.php', ABSPATH . 'wp-admin/includes/plugin.php' ), |
| 38 | 'wp_get_environment_type' => ABSPATH . WPINC . '/load.php', |
| 39 | 'wp_json_encode' => ABSPATH . WPINC . '/functions.php', |
| 40 | 'wc_get_logger' => WC_ABSPATH . 'includes/class-wc-logger.php', |
| 41 | 'wc_print_r' => WC_ABSPATH . 'includes/wc-core-functions.php', |
| 42 | ); |
| 43 | |
| 44 | if ( ! function_exists( $name ) ) { |
| 45 | if ( isset( $function_map[ $name ] ) ) { |
| 46 | $files = (array) $function_map[ $name ]; |
| 47 | foreach ( $files as $file ) { |
| 48 | require_once $file; |
| 49 | } |
| 50 | } else { |
| 51 | throw new \Exception( sprintf( 'Function %s does not exist and could not be loaded.', esc_html( $name ) ) ); |
| 52 | } |
| 53 | } |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * Proxy for trapping all calls on SafeGlobalFunctionProxy. |
| 58 | * Use this for calling WP and WC global functions safely. |
| 59 | * Example usage: |
| 60 | * |
| 61 | * SafeGlobalFunctionProxy::wp_parse_url('https://example.com', PHP_URL_PATH); |
| 62 | * |
| 63 | * @since 9.4.0 |
| 64 | * @param string $name The name of the function to call. |
| 65 | * @param array $arguments The arguments to pass to the function. |
| 66 | * @return mixed The result of the function call, or null if an error occurs. |
| 67 | */ |
| 68 | public static function __callStatic( $name, $arguments ) { |
| 69 | // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_set_error_handler -- Custom error handler is necessary to convert errors to exceptions |
| 70 | set_error_handler( |
| 71 | static function ( int $type, string $message, string $file, int $line ) { |
| 72 | if ( __FILE__ === $file ) { |
| 73 | // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_debug_backtrace -- Used to adjust file and line number for accurate error reporting |
| 74 | $trace = debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS, 3 ); |
| 75 | $file = $trace[2]['file'] ?? $file; |
| 76 | $line = $trace[2]['line'] ?? $line; |
| 77 | } |
| 78 | $sanitized_message = filter_var( $message, FILTER_SANITIZE_FULL_SPECIAL_CHARS ); |
| 79 | // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped -- $message sanitised above. we don't want to rely on esc_html since it's not a PHP built-in |
| 80 | throw new \ErrorException( $sanitized_message, 0, $type, $file, $line ); |
| 81 | } |
| 82 | ); |
| 83 | |
| 84 | try { |
| 85 | self::maybe_load_missing_function( $name ); |
| 86 | $results = call_user_func_array( $name, $arguments ); |
| 87 | } catch ( \Throwable $e ) { |
| 88 | self::log_wrapper_error( $name, $e->getMessage(), $arguments ); |
| 89 | $results = null; |
| 90 | } finally { |
| 91 | restore_error_handler(); |
| 92 | } |
| 93 | |
| 94 | return $results; |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Log wrapper function errors to "local logging" for debugging. |
| 99 | * |
| 100 | * @param string $function_name The name of the wrapped function. |
| 101 | * @param string $error_message The error message. |
| 102 | * @param array $context Additional context for the error. |
| 103 | */ |
| 104 | protected static function log_wrapper_error( $function_name, $error_message, $context = array() ) { |
| 105 | self::maybe_load_missing_function( 'wc_get_logger' ); |
| 106 | |
| 107 | wc_get_logger()->error( |
| 108 | '[Wrapper function error] ' . sprintf( 'Error in %s: %s', $function_name, $error_message ), |
| 109 | array_merge( |
| 110 | array( |
| 111 | 'function' => $function_name, |
| 112 | 'source' => 'remote-logging', |
| 113 | ), |
| 114 | $context |
| 115 | ) |
| 116 | ); |
| 117 | } |
| 118 | } |
| 119 |