class-abstract-migration.php
2 years ago
class-date-time-utils.php
2 years ago
class-debugging.php
2 years ago
class-generate-modal.php
2 years ago
class-migration.php
2 years ago
class-request-utils.php
2 years ago
class-settings-utils.php
2 years ago
class-user-utils.php
2 years ago
index.php
2 years ago
class-debugging.php
177 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Responsible for logging. |
| 4 | * |
| 5 | * @package wp2fa |
| 6 | * @subpackage utils |
| 7 | * @copyright 2024 Melapress |
| 8 | * @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0 |
| 9 | * @link https://wordpress.org/plugins/wp-2fa/ |
| 10 | * @since 1.4.2 |
| 11 | */ |
| 12 | |
| 13 | declare(strict_types=1); |
| 14 | |
| 15 | namespace WP2FA\Utils; |
| 16 | |
| 17 | if ( ! class_exists( '\WP2FA\Utils\Debugging' ) ) { |
| 18 | /** |
| 19 | * Utility class for creating modal popup markup. |
| 20 | * |
| 21 | * @package WP2FA\Utils |
| 22 | * |
| 23 | * @since 1.4.2 |
| 24 | */ |
| 25 | class Debugging { |
| 26 | |
| 27 | /** |
| 28 | * Local cache for the logging dir so that it doesn't need to be repopulated each time get_logging_dir_path is called. |
| 29 | * |
| 30 | * @var string |
| 31 | * |
| 32 | * @since 1.4.2 |
| 33 | */ |
| 34 | private static $logging_dir_path = ''; |
| 35 | |
| 36 | /** |
| 37 | * Retrieve the logging status |
| 38 | * |
| 39 | * @return boolean |
| 40 | * |
| 41 | * @since 1.4.2 |
| 42 | */ |
| 43 | private static function is_logging_enabled() { |
| 44 | /** |
| 45 | * Enables / Disables the logging for the plugin. |
| 46 | * |
| 47 | * @param bool $disabled - Default logging for the plugin. |
| 48 | */ |
| 49 | return apply_filters( WP_2FA_PREFIX . 'logging_enabled', false ); |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * Logs the given message |
| 54 | * |
| 55 | * @param string $message - The message to log. |
| 56 | * |
| 57 | * @return void |
| 58 | * |
| 59 | * @since 1.4.2 |
| 60 | */ |
| 61 | public static function log( $message ) { |
| 62 | if ( self::is_logging_enabled() ) { |
| 63 | self::write_to_log( self::get_log_timestamp() . "\n" . $message . "\n" . __( 'Current memory usage: ', 'wp-2fa' ) . memory_get_usage( true ) . "\n" ); |
| 64 | } |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * Retrieves the path to the log file |
| 69 | * |
| 70 | * @return string |
| 71 | * |
| 72 | * @since 1.4.2 |
| 73 | */ |
| 74 | private static function get_logging_dir_path() { |
| 75 | if ( strlen( self::$logging_dir_path ) === 0 ) { |
| 76 | $uploads_dir = wp_upload_dir( null, false ); |
| 77 | self::$logging_dir_path = trailingslashit( trailingslashit( $uploads_dir['basedir'] ) . WP_2FA_LOGS_DIR ); |
| 78 | } |
| 79 | |
| 80 | return self::$logging_dir_path; |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * Write data to log file. |
| 85 | * |
| 86 | * @param string $data - Data to write to file. |
| 87 | * @param bool $override - Set to true if overriding the file. |
| 88 | * |
| 89 | * @return bool |
| 90 | * |
| 91 | * @since 1.4.2 |
| 92 | */ |
| 93 | private static function write_to_log( $data, $override = false ) { |
| 94 | $logging_dir_path = self::get_logging_dir_path(); |
| 95 | if ( ! is_dir( $logging_dir_path ) ) { |
| 96 | self::create_index_file(); |
| 97 | self::create_htaccess_file(); |
| 98 | } |
| 99 | |
| 100 | $log_file_name = gmdate( 'Y-m-d' ); |
| 101 | return self::write_to_file( 'wp-2fa-debug-' . $log_file_name . '.log', $data, $override ); |
| 102 | } |
| 103 | |
| 104 | /** |
| 105 | * Create an index.php file, if none exists, in order to |
| 106 | * avoid directory listing in the specified directory. |
| 107 | * |
| 108 | * @return bool |
| 109 | * |
| 110 | * @since 1.4.2 |
| 111 | */ |
| 112 | private static function create_index_file() { |
| 113 | return self::write_to_file( 'index.php', '<?php // Silence is golden' ); |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Create an .htaccess file, if none exists, in order to |
| 118 | * block access to directory listing in the specified directory. |
| 119 | * |
| 120 | * @return bool |
| 121 | * |
| 122 | * @since 1.4.2 |
| 123 | */ |
| 124 | private static function create_htaccess_file() { |
| 125 | return self::write_to_file( '.htaccess', 'Deny from all' ); |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * Write data to log file in the uploads directory. |
| 130 | * |
| 131 | * @param string $filename - File name. |
| 132 | * @param string $content - Contents of the file. |
| 133 | * @param bool $override - (Optional) True if overriding file contents. |
| 134 | * |
| 135 | * @return bool |
| 136 | * |
| 137 | * @since 1.4.2 |
| 138 | */ |
| 139 | private static function write_to_file( $filename, $content, $override = false ) { |
| 140 | global $wp_filesystem; |
| 141 | require_once ABSPATH . 'wp-admin/includes/file.php'; |
| 142 | WP_Filesystem(); |
| 143 | |
| 144 | $logging_dir = self::get_logging_dir_path(); |
| 145 | |
| 146 | $result = false; |
| 147 | |
| 148 | if ( ! is_dir( $logging_dir ) ) { |
| 149 | if ( false === wp_mkdir_p( $logging_dir ) ) { |
| 150 | return false; |
| 151 | } |
| 152 | } |
| 153 | |
| 154 | $filepath = $logging_dir . $filename; |
| 155 | if ( ! $wp_filesystem->exists( $filepath ) || $override ) { |
| 156 | $result = $wp_filesystem->put_contents( $filepath, $content ); |
| 157 | } else { |
| 158 | $existing_content = $wp_filesystem->get_contents( $filepath ); |
| 159 | $result = $wp_filesystem->put_contents( $filepath, $existing_content . $content ); |
| 160 | } |
| 161 | |
| 162 | return $result; |
| 163 | } |
| 164 | |
| 165 | /** |
| 166 | * Returns the timestamp for log files. |
| 167 | * |
| 168 | * @return string |
| 169 | * |
| 170 | * @since 1.4.2 |
| 171 | */ |
| 172 | private static function get_log_timestamp() { |
| 173 | return '[' . gmdate( 'd-M-Y H:i:s' ) . ' UTC]'; |
| 174 | } |
| 175 | } |
| 176 | } |
| 177 |