Changeset 3273

Timestamp:

05/30/2016 06:15:50 PM (9 years ago)

Author:

iandunn

Message:

WordCamp WP-CLI: Add a command to format our custom log entries.

Location:

sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins

Files:

• 0-logger.php (modified) (3 diffs)
• wp-cli-commands/miscellaneous.php (modified) (1 diff)

sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/0-logger.php

@@ -25 +25 @@
         $data = (array) $data;
         redact_keys( $data );
-        $data = str_replace( "\n", '[newline]', serialize( $data ) );
+        $data = str_replace( "\n", '[newline]', wp_json_encode( $data ) );
     }
 
@@ -34 +34 @@
         $backtrace[1]['function'],
         $error_code,
-        $data ? ' - ' . $data : ''
+        $data ? ' -- ' . $data : ''
     );
 
@@ -67 +67 @@
     return $data;
 }
+
+/**
+ * Format entries created with log()
+ *
+ * See WordCamp_CLI_Miscellaneous::format_log() for usage instructions.
+ *
+ * @param string $raw_log
+ * @param string $foreign_entries `ignore` or `include` entries that weren't created with log()
+ *
+ * @return string
+ */
+function format_log( $raw_log, $foreign_entries = 'include' ) {
+    $formatted_log        = '';
+    $raw_entries          = explode( "\n", $raw_log );
+    $native_entry_pattern = '/(\[.*?\]) (.*?:.*?) - (.*?) -- (\{.*\})/';
+
+    foreach ( $raw_entries as $entry ) {
+        $is_native_entry = 1 === preg_match( $native_entry_pattern, $entry, $entry_parts );
+
+        if ( $is_native_entry ) {
+            $formatted_log .= sprintf(
+                "\n%s %s - %s\n%s",
+                $entry_parts[1],
+                $entry_parts[2],
+                $entry_parts[3],
+                print_r( json_decode( $entry_parts[4] ), true )
+            );
+        } else {
+            if ( 'ignore' !== $foreign_entries ) {
+                $formatted_log .= $entry . "\n";
+            }
+        }
+    }
+
+    return $formatted_log;
+}

sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/wp-cli-commands/miscellaneous.php

@@ -90 +90 @@
         }
     }
+
+    /**
+     * Print a log with our custom entries formatted for humans
+     *
+     * ## OPTIONS
+     *
+     * <raw_log>
+     * : The raw log contents, or the filename of the raw log
+     *
+     * [--foreign=<action>]
+     * : Include foreign log entries from the output, or ignore them
+     * ---
+     * default: include
+     * options:
+     *   - include
+     *   - ignore
+     * ---
+     *
+     * ## EXAMPLES
+     *
+     * wp wc-misc format-log /var/log/php-errors.log
+     * wp wc-misc format-log "$(grep 'foo' /var/log/php-errors.log -A 10 -B 10)" |less -S
+     * wp wc-misc format-log "$(grep 'bar' /var/log/php-errors.log)" --foreign=ignore
+     *
+     * @subcommand format-log
+     *
+     * @param array $args
+     * @param array $assoc_args
+     */
+    public function format_log( $args, $assoc_args ) {
+        list( $raw_log ) = $args;
+
+        if ( is_file( $raw_log ) ) {
+            $raw_log = file_get_contents( $raw_log );
+        }
+
+        $formatted_log = \WordCamp\Logger\format_log( $raw_log, $assoc_args['foreign'] );
+
+        WP_CLI::line( "\n" . $formatted_log );
+    }
 }