class-wc-log-handler-db.php
1 year ago
class-wc-log-handler-email.php
5 years ago
class-wc-log-handler-file.php
2 years ago
class-wc-log-handler-db.php
219 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Class WC_Log_Handler_DB file. |
| 4 | * |
| 5 | * @package WooCommerce\Log Handlers |
| 6 | */ |
| 7 | |
| 8 | use Automattic\Jetpack\Constants; |
| 9 | |
| 10 | if ( ! defined( 'ABSPATH' ) ) { |
| 11 | exit; // Exit if accessed directly. |
| 12 | } |
| 13 | |
| 14 | /** |
| 15 | * Handles log entries by writing to database. |
| 16 | * |
| 17 | * @class WC_Log_Handler_DB |
| 18 | * @version 1.0.0 |
| 19 | * @package WooCommerce\Classes\Log_Handlers |
| 20 | */ |
| 21 | class WC_Log_Handler_DB extends WC_Log_Handler { |
| 22 | |
| 23 | /** |
| 24 | * Handle a log entry. |
| 25 | * |
| 26 | * @param int $timestamp Log timestamp. |
| 27 | * @param string $level emergency|alert|critical|error|warning|notice|info|debug. |
| 28 | * @param string $message Log message. |
| 29 | * @param array $context { |
| 30 | * Additional information for log handlers. |
| 31 | * |
| 32 | * @type string $source Optional. Source will be available in log table. |
| 33 | * If no source is provided, attempt to provide sensible default. |
| 34 | * } |
| 35 | * |
| 36 | * @see WC_Log_Handler_DB::get_log_source() for default source. |
| 37 | * |
| 38 | * @return bool False if value was not handled and true if value was handled. |
| 39 | */ |
| 40 | public function handle( $timestamp, $level, $message, $context ) { |
| 41 | if ( isset( $context['source'] ) && $context['source'] ) { |
| 42 | $source = $context['source']; |
| 43 | } else { |
| 44 | $source = $this->get_log_source(); |
| 45 | } |
| 46 | |
| 47 | // Clear the source cache if this is a new source. |
| 48 | $cached_sources = get_option( WC_Admin_Log_Table_List::SOURCE_CACHE_OPTION_KEY, array() ); |
| 49 | if ( ! in_array( $source, $cached_sources, true ) ) { |
| 50 | delete_option( WC_Admin_Log_Table_List::SOURCE_CACHE_OPTION_KEY ); |
| 51 | } |
| 52 | |
| 53 | return $this->add( $timestamp, $level, $message, $source, $context ); |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * Add a log entry to chosen file. |
| 58 | * |
| 59 | * @param int $timestamp Log timestamp. |
| 60 | * @param string $level emergency|alert|critical|error|warning|notice|info|debug. |
| 61 | * @param string $message Log message. |
| 62 | * @param string $source Log source. Useful for filtering and sorting. |
| 63 | * @param array $context Context will be serialized and stored in database. |
| 64 | * |
| 65 | * @return bool True if write was successful. |
| 66 | */ |
| 67 | protected static function add( $timestamp, $level, $message, $source, $context ) { |
| 68 | global $wpdb; |
| 69 | |
| 70 | $insert = array( |
| 71 | 'timestamp' => date( 'Y-m-d H:i:s', $timestamp ), |
| 72 | 'level' => WC_Log_Levels::get_level_severity( $level ), |
| 73 | 'message' => $message, |
| 74 | 'source' => $source, |
| 75 | ); |
| 76 | |
| 77 | $format = array( |
| 78 | '%s', |
| 79 | '%d', |
| 80 | '%s', |
| 81 | '%s', |
| 82 | '%s', // possible serialized context. |
| 83 | ); |
| 84 | |
| 85 | unset( $context['source'] ); |
| 86 | if ( ! empty( $context ) ) { |
| 87 | if ( isset( $context['backtrace'] ) && true === filter_var( $context['backtrace'], FILTER_VALIDATE_BOOLEAN ) ) { |
| 88 | $context['backtrace'] = self::get_backtrace(); |
| 89 | } |
| 90 | |
| 91 | $insert['context'] = wp_json_encode( $context, JSON_PRETTY_PRINT ); |
| 92 | } |
| 93 | |
| 94 | return false !== $wpdb->insert( "{$wpdb->prefix}woocommerce_log", $insert, $format ); |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Clear all logs from the DB. |
| 99 | * |
| 100 | * @return bool True if flush was successful. |
| 101 | */ |
| 102 | public static function flush() { |
| 103 | global $wpdb; |
| 104 | |
| 105 | return $wpdb->query( "TRUNCATE TABLE {$wpdb->prefix}woocommerce_log" ); |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * Clear entries for a chosen handle/source. |
| 110 | * |
| 111 | * @param string $source Log source. |
| 112 | * @return bool |
| 113 | */ |
| 114 | public function clear( $source ) { |
| 115 | global $wpdb; |
| 116 | |
| 117 | return $wpdb->query( |
| 118 | $wpdb->prepare( |
| 119 | "DELETE FROM {$wpdb->prefix}woocommerce_log WHERE source = %s", |
| 120 | $source |
| 121 | ) |
| 122 | ); |
| 123 | } |
| 124 | |
| 125 | /** |
| 126 | * Delete selected logs from DB. |
| 127 | * |
| 128 | * @param int|string|array $log_ids Log ID or array of Log IDs to be deleted. |
| 129 | * |
| 130 | * @return bool |
| 131 | */ |
| 132 | public static function delete( $log_ids ) { |
| 133 | global $wpdb; |
| 134 | |
| 135 | if ( ! is_array( $log_ids ) ) { |
| 136 | $log_ids = array( $log_ids ); |
| 137 | } |
| 138 | |
| 139 | $format = array_fill( 0, count( $log_ids ), '%d' ); |
| 140 | $query_in = '(' . implode( ',', $format ) . ')'; |
| 141 | |
| 142 | $result = $wpdb->query( |
| 143 | // phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared |
| 144 | $wpdb->prepare( |
| 145 | " |
| 146 | DELETE FROM {$wpdb->prefix}woocommerce_log |
| 147 | WHERE log_id IN {$query_in} |
| 148 | ", |
| 149 | $log_ids |
| 150 | ) |
| 151 | // phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared |
| 152 | ); |
| 153 | |
| 154 | if ( false !== $result ) { |
| 155 | \WC_Cache_Helper::get_transient_version( 'logs-db', true ); |
| 156 | } |
| 157 | |
| 158 | return $result; |
| 159 | } |
| 160 | |
| 161 | /** |
| 162 | * Delete all logs older than a defined timestamp. |
| 163 | * |
| 164 | * @since 3.4.0 |
| 165 | * @param integer $timestamp Timestamp to delete logs before. |
| 166 | */ |
| 167 | public static function delete_logs_before_timestamp( $timestamp = 0 ) { |
| 168 | if ( ! $timestamp ) { |
| 169 | return; |
| 170 | } |
| 171 | |
| 172 | global $wpdb; |
| 173 | |
| 174 | $wpdb->query( |
| 175 | $wpdb->prepare( |
| 176 | "DELETE FROM {$wpdb->prefix}woocommerce_log WHERE timestamp < %s", |
| 177 | date( 'Y-m-d H:i:s', $timestamp ) |
| 178 | ) |
| 179 | ); |
| 180 | |
| 181 | \WC_Cache_Helper::get_transient_version( 'logs-db', true ); |
| 182 | } |
| 183 | |
| 184 | /** |
| 185 | * Get appropriate source based on file name. |
| 186 | * |
| 187 | * Try to provide an appropriate source in case none is provided. |
| 188 | * |
| 189 | * @return string Text to use as log source. "" (empty string) if none is found. |
| 190 | */ |
| 191 | protected static function get_log_source() { |
| 192 | static $ignore_files = array( 'class-wc-log-handler-db', 'class-wc-logger' ); |
| 193 | |
| 194 | /** |
| 195 | * PHP < 5.3.6 correct behavior |
| 196 | * |
| 197 | * @see http://php.net/manual/en/function.debug-backtrace.php#refsect1-function.debug-backtrace-parameters |
| 198 | */ |
| 199 | if ( Constants::is_defined( 'DEBUG_BACKTRACE_IGNORE_ARGS' ) ) { |
| 200 | $debug_backtrace_arg = DEBUG_BACKTRACE_IGNORE_ARGS; // phpcs:ignore PHPCompatibility.Constants.NewConstants.debug_backtrace_ignore_argsFound |
| 201 | } else { |
| 202 | $debug_backtrace_arg = false; |
| 203 | } |
| 204 | |
| 205 | $trace = debug_backtrace( $debug_backtrace_arg ); // @codingStandardsIgnoreLine. |
| 206 | foreach ( $trace as $t ) { |
| 207 | if ( isset( $t['file'] ) ) { |
| 208 | $filename = pathinfo( $t['file'], PATHINFO_FILENAME ); |
| 209 | if ( ! in_array( $filename, $ignore_files, true ) ) { |
| 210 | return $filename; |
| 211 | } |
| 212 | } |
| 213 | } |
| 214 | |
| 215 | return ''; |
| 216 | } |
| 217 | |
| 218 | } |
| 219 |