Collect log messages in Logger instead of in context system. (#3811)

Author: weitzman

includes/backend.inc

@@ -155,10 +155,10 @@ function drush_backend_output() {
   }
 
   $data['error_status'] = Runtime::exitCode();
-  $data['log'] = drush_get_log(); // Append logging information
+  $data['log'] = Drush::logger()->getLogs(); // Append logging information
   // The error log is a more specific version of the log, and may be used by calling
   // scripts to check for specific errors that have occurred.
-  $data['error_log'] = drush_get_error_log();
+  $data['error_log'] = Drush::logger()->getErrorLogs();
   // If there is a @self record, then include it in the result
   $self_record = drush_sitealias_get_record('@self');
   if (!empty($self_record)) {

includes/drush.inc

@@ -493,6 +493,8 @@ function drush_backend_packet_log($entry, $backend_options) {
  *
  * @return
  *   Entire log history
+ *
+ * @deprecated
  */
 function drush_get_log() {
   return drush_get_context('DRUSH_LOG', []);
@@ -598,6 +600,8 @@ function drush_set_error($error, $message = null, $output_label = "") {
  *
  * @return
  *   The current aggregate error status
+ *
+ * @deprecated
  */
 function drush_get_error() {
   return drush_get_context('DRUSH_ERROR_CODE', DRUSH_SUCCESS);
@@ -608,6 +612,8 @@ function drush_get_error() {
  *
  * @return
  *   An associative array of error messages indexed by the type of message.
+ *
+ * @deprecated
  */
 function drush_get_error_log() {
   return drush_get_context('DRUSH_ERROR_LOG', []);

src/Log/Logger.php

@@ -33,28 +33,71 @@
 
 class Logger extends RoboLogger
 {
+    /**
+     * Array of logs. For use by backend responses.
+     *
+     * @var array
+     *
+     * @deprecated
+     */
+    protected $logs = [];
+
+    /**
+     * Array of error logs. For use by backend responses.
+     *
+     * @var array
+     *
+     * @deprecated
+     */
+    protected $logs_error = [];
 
     public function __construct(OutputInterface $output)
     {
         parent::__construct($output);
     }
 
+    /**
+     * Get an array of logs for the current request.
+     *
+     * @return array
+     *
+     * @deprecated Used by drush_backend_output().
+     */
+    public function getLogs()
+    {
+        return $this->logs;
+    }
+
+    /**
+     * Get an array of error logs for the current request.
+     *
+     * @return array
+     *
+     * @deprecated Used by drush_backend_output().
+     */
+    public function getErrorLogs()
+    {
+        return $this->logs_error;
+    }
+
+    /**
+     * Empty log collections.
+     *
+     * @deprecated
+     */
+    public function clearLogs()
+    {
+        $this->logs_error = $this->logs = [];
+    }
+
     public function log($level, $message, array $context = [])
     {
-        // Convert to old $entry array for b/c calls
-        $entry = $context + [
-            'type' => $level,
-            'message' => StringUtils::interpolate($message, $context),
-            'timestamp' => microtime(true),
-            'memory' => memory_get_usage(),
-        ];
+        $entry = $this->buildEntry($level, $message, $context);
+
+        if (Drush::backend()) {
+            $this->logs[] = $entry;
+        }
 
-        // Drush\Log\Logger should take over all of the responsibilities
-        // of drush_log, including caching the log messages and sending
-        // log messages along to backend invoke.
-        // TODO: move these implementations inside this class.
-        $log =& drush_get_context('DRUSH_LOG', []);
-        $log[] = $entry;
         if ($level != LogLevel::DEBUG_NOTIFY) {
             drush_backend_packet('log', $entry);
         }
@@ -151,33 +194,33 @@ public function log($level, $message, array $context = [])
             $message = $message . ' ' . $timer;
         }
 
-/*
-      // Drush-styled output
-
-      $message = $this->interpolate(
-          $message,
-          $this->getLogOutputStyler()->style($context)
-      );
-
-      $width[0] = ($columns - 11);
-
-      $format = sprintf("%%-%ds%%%ds", $width[0], $width[1]);
-
-      // Place the status message right aligned with the top line of the error message.
-      $message = wordwrap($message, $width[0]);
-      $lines = explode("\n", $message);
-      $lines[0] = sprintf($format, $lines[0], $type_msg);
-      $message = implode("\n", $lines);
-      $this->getErrorStreamWrapper()->writeln($message);
-*/
       // Robo-styled output
         parent::log($level, $message, $context);
     }
 
     public function error($message, array $context = [])
     {
-        $error_log =& drush_get_context('DRUSH_ERROR_LOG', []);
-        $error_log[$message][] = $message;
+        if (Drush::backend()) {
+            $this->logs_error[] = $this->buildEntry(LogLevel::ERROR, $message, $context);
+        }
         parent::error($message, $context);
     }
+
+    /**
+     * @param $level
+     * @param $message
+     * @param array $context
+     * @return array
+     */
+    protected function buildEntry($level, $message, array $context)
+    {
+        // Convert to old $entry array for b/c calls
+        $entry = $context + [
+            'type' => $level,
+            'message' => StringUtils::interpolate($message, $context),
+            'timestamp' => microtime(true),
+            'memory' => memory_get_usage(),
+        ];
+        return $entry;
+    }
 }