engines
1 year ago
modules
1 year ago
queries
1 year ago
admin.php
1 year ago
api.php
1 year ago
core.php
1 year ago
discussion.php
1 year ago
init.php
1 year ago
logging.php
1 year ago
reply.php
1 year ago
rest.php
1 year ago
logging.php
279 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Class Meow_MWAI_Logging |
| 5 | * |
| 6 | * A logging utility that uses the WordPress Filesystem API for storage, |
| 7 | * with fallback to PHP error_log when necessary. |
| 8 | */ |
| 9 | class Meow_MWAI_Logging { |
| 10 | private static $plugin_name; |
| 11 | private static $option_name; |
| 12 | private static $log_file_path; |
| 13 | private static $fs; |
| 14 | private static $log_count = 0; |
| 15 | private static $rotate_check_frequency = 10; |
| 16 | private static $max_log_size = 5 * 1024 * 1024; // 5 MB |
| 17 | |
| 18 | /** |
| 19 | * Initialize the logger. |
| 20 | * |
| 21 | * @param string $option_name Option key for settings. |
| 22 | * @param string $plugin_name Plugin identifier for error log prefix. |
| 23 | */ |
| 24 | public static function init( $option_name, $plugin_name ) { |
| 25 | self::$plugin_name = $plugin_name; |
| 26 | self::$option_name = $option_name; |
| 27 | |
| 28 | // Attempt to use WP_Filesystem only if the 'direct' method is available. |
| 29 | if ( ! function_exists( 'WP_Filesystem' ) ) { |
| 30 | require_once ABSPATH . 'wp-admin/includes/file.php'; |
| 31 | } |
| 32 | |
| 33 | if ( function_exists( 'get_filesystem_method' ) && 'direct' === get_filesystem_method() ) { |
| 34 | // If 'direct' is allowed, try to initialize the filesystem (no credentials prompt). |
| 35 | if ( WP_Filesystem() ) { |
| 36 | global $wp_filesystem; |
| 37 | self::$fs = $wp_filesystem; |
| 38 | } else { |
| 39 | // Could not initialize |
| 40 | error_log( self::$plugin_name . " : Could not init direct WP_Filesystem. Falling back to error_log only." ); |
| 41 | self::$fs = null; |
| 42 | } |
| 43 | } else { |
| 44 | // Not 'direct' or not available; skip filesystem usage |
| 45 | self::$fs = null; |
| 46 | } |
| 47 | |
| 48 | // Attempt to determine or create the log file path |
| 49 | self::$log_file_path = self::get_logs_path( true ); |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * Determine or create the log file path using WP_Filesystem. |
| 54 | * |
| 55 | * @param bool $create Whether to generate a new file if none exists. |
| 56 | * @return string|false Path to log file or false if unavailable. |
| 57 | */ |
| 58 | private static function get_logs_path( $create = false ) { |
| 59 | $options = get_option( self::$option_name, null ); |
| 60 | if ( is_null( $options ) ) { |
| 61 | return null; |
| 62 | } |
| 63 | |
| 64 | // If we don't have a filesystem reference, we can't create or write a file |
| 65 | if ( empty( self::$fs ) ) { |
| 66 | return null; |
| 67 | } |
| 68 | |
| 69 | $path = empty( $options['logs_path'] ) ? '' : $options['logs_path']; |
| 70 | |
| 71 | if ( $path && self::$fs->exists( $path ) ) { |
| 72 | return $path; |
| 73 | } |
| 74 | |
| 75 | if ( ! $create ) { |
| 76 | return null; |
| 77 | } |
| 78 | |
| 79 | $uploads = wp_upload_dir(); |
| 80 | $base_dir = trailingslashit( $uploads['basedir'] ); |
| 81 | |
| 82 | if ( ! self::$fs->is_dir( $base_dir ) ) { |
| 83 | self::$fs->mkdir( $base_dir ); |
| 84 | } |
| 85 | |
| 86 | // Adjust MWAI_PREFIX to whatever your actual constant or value is |
| 87 | $filename = MWAI_PREFIX . '_' . self::random_ascii_chars() . '.log'; |
| 88 | $new_path = $base_dir . $filename; |
| 89 | |
| 90 | self::$fs->put_contents( $new_path, '', FS_CHMOD_FILE ); |
| 91 | |
| 92 | $options['logs_path'] = $new_path; |
| 93 | update_option( self::$option_name, $options ); |
| 94 | |
| 95 | return $new_path; |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Check if logging is enabled via plugin options and FS availability. |
| 100 | * |
| 101 | * @return bool |
| 102 | */ |
| 103 | private static function is_logging_enabled() { |
| 104 | $options = get_option( self::$option_name, null ); |
| 105 | if ( is_null( $options ) ) { |
| 106 | return false; |
| 107 | } |
| 108 | |
| 109 | $module_devtools = empty( $options['module_devtools'] ) ? false : $options['module_devtools']; |
| 110 | $server_debug_mode = empty( $options['server_debug_mode'] ) ? false : $options['server_debug_mode']; |
| 111 | |
| 112 | return ( $module_devtools && $server_debug_mode && ! empty( self::$fs ) ); |
| 113 | } |
| 114 | |
| 115 | /** |
| 116 | * Internal log writer. Appends to file and/or error_log. |
| 117 | */ |
| 118 | private static function add( $message = null, $icon = '', $error_log = false ) { |
| 119 | $date = date( 'Y-m-d H:i:s' ); |
| 120 | $message = is_string( $message ) ? strip_tags( $message ) : $message; |
| 121 | |
| 122 | if ( empty( $message ) ) { |
| 123 | $entry = "\n"; |
| 124 | } |
| 125 | else if ( ! empty( $icon ) ) { |
| 126 | $entry = "$date: $icon $message\n"; |
| 127 | } |
| 128 | else { |
| 129 | $entry = "$date: $message\n"; |
| 130 | } |
| 131 | |
| 132 | // Write to file if enabled and if a log file path exists |
| 133 | if ( self::is_logging_enabled() && self::$log_file_path ) { |
| 134 | if ( self::$fs->exists( self::$log_file_path ) ) { |
| 135 | $current = self::$fs->get_contents( self::$log_file_path ); |
| 136 | self::$fs->put_contents( self::$log_file_path, $current . $entry, FS_CHMOD_FILE ); |
| 137 | } |
| 138 | else { |
| 139 | self::$fs->put_contents( self::$log_file_path, $entry, FS_CHMOD_FILE ); |
| 140 | } |
| 141 | } |
| 142 | |
| 143 | // Always send to PHP error_log if $error_log is true |
| 144 | if ( $error_log && ! empty( $message ) ) { |
| 145 | \error_log( self::$plugin_name . " : $message" ); |
| 146 | } |
| 147 | |
| 148 | self::$log_count++; |
| 149 | |
| 150 | if ( self::$log_count >= self::$rotate_check_frequency ) { |
| 151 | self::maybe_rotate_log(); |
| 152 | self::$log_count = 0; |
| 153 | } |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * Logs a general message. |
| 158 | * |
| 159 | * @param string $message The message to log. |
| 160 | * @param string $icon Optional icon to prepend. |
| 161 | */ |
| 162 | public static function log( $message = null, $icon = '' ) { |
| 163 | self::add( $message, $icon ); |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * Logs a warning message. |
| 168 | * |
| 169 | * @param string $message The warning message to log. |
| 170 | * @param string $icon Optional icon to prepend (default ⚠️). |
| 171 | */ |
| 172 | public static function warn( $message = null, $icon = '⚠️' ) { |
| 173 | self::add( $message, $icon ); |
| 174 | } |
| 175 | |
| 176 | /** |
| 177 | * Logs an error message and sends to PHP error_log. |
| 178 | * |
| 179 | * @param string $message The error message to log. |
| 180 | * @param string $icon Optional icon to prepend (default ❌). |
| 181 | */ |
| 182 | public static function error( $message = null, $icon = '❌' ) { |
| 183 | self::add( $message, $icon, true ); |
| 184 | } |
| 185 | |
| 186 | /** |
| 187 | * Logs a deprecated feature notice. |
| 188 | * |
| 189 | * @param string $message The message to log. |
| 190 | */ |
| 191 | public static function deprecated( $message = null ) { |
| 192 | self::add( $message, '🚨', true ); |
| 193 | } |
| 194 | |
| 195 | /** |
| 196 | * Clears the log file and resets the option. |
| 197 | */ |
| 198 | public static function clear() { |
| 199 | if ( self::$fs && self::$log_file_path && self::$fs->exists( self::$log_file_path ) ) { |
| 200 | self::$fs->delete( self::$log_file_path ); |
| 201 | $options = get_option( self::$option_name, null ); |
| 202 | $options['logs_path'] = ''; |
| 203 | update_option( self::$option_name, $options ); |
| 204 | self::$log_file_path = ''; |
| 205 | } |
| 206 | } |
| 207 | |
| 208 | /** |
| 209 | * Retrieves the log contents in reverse order (newest first). |
| 210 | * |
| 211 | * @return string |
| 212 | */ |
| 213 | public static function get() { |
| 214 | if ( self::$fs && self::$log_file_path && self::$fs->exists( self::$log_file_path ) ) { |
| 215 | $content = self::$fs->get_contents( self::$log_file_path ); |
| 216 | $lines = explode( "\n", $content ); |
| 217 | $lines = array_filter( $lines ); |
| 218 | $lines = array_reverse( $lines ); |
| 219 | |
| 220 | return implode( "\n", $lines ); |
| 221 | } |
| 222 | |
| 223 | return 'Empty log file.'; |
| 224 | } |
| 225 | |
| 226 | /** |
| 227 | * Checks file size and rotates if exceeding maximum. |
| 228 | */ |
| 229 | private static function maybe_rotate_log() { |
| 230 | if ( empty( self::$fs ) || empty( self::$log_file_path ) ) { |
| 231 | return; |
| 232 | } |
| 233 | |
| 234 | if ( self::$fs->exists( self::$log_file_path ) ) { |
| 235 | $size = self::$fs->size( self::$log_file_path ); |
| 236 | |
| 237 | if ( $size > self::$max_log_size ) { |
| 238 | $info = pathinfo( self::$log_file_path ); |
| 239 | $archived = $info['dirname'] . '/' . $info['filename'] . '_' . date( 'Y-m-d_H-i-s' ) . '.' . $info['extension']; |
| 240 | |
| 241 | self::$fs->move( self::$log_file_path, $archived, true ); |
| 242 | self::$fs->put_contents( self::$log_file_path, '', FS_CHMOD_FILE ); |
| 243 | } |
| 244 | } |
| 245 | } |
| 246 | |
| 247 | /** |
| 248 | * Generates a random ASCII string. |
| 249 | * |
| 250 | * @param int $length String length. |
| 251 | * @return string |
| 252 | */ |
| 253 | private static function random_ascii_chars( $length = 8 ) { |
| 254 | $characters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'; |
| 255 | $result = ''; |
| 256 | |
| 257 | for ( $i = 0; $i < $length; $i++ ) { |
| 258 | $result .= $characters[ mt_rand( 0, strlen( $characters ) - 1 ) ]; |
| 259 | } |
| 260 | |
| 261 | return $result; |
| 262 | } |
| 263 | |
| 264 | /** |
| 265 | * Shortens a string to a specified length, adding ellipsis if needed. |
| 266 | * |
| 267 | * @param int $length String length. |
| 268 | * @return string |
| 269 | */ |
| 270 | public static function shorten( $string, $length = 50 ) { |
| 271 | if ( strlen( $string ) > $length ) { |
| 272 | $string = rtrim( $string, " \t\n\r\0\x0B,." ); |
| 273 | $string = substr( $string, 0, $length - 3 ) . '...'; |
| 274 | } |
| 275 | |
| 276 | return $string; |
| 277 | } |
| 278 | } |
| 279 |