Deprecate backend.inc in favor of a new site-process library

.circleci/config.yml

@@ -59,4 +59,3 @@ workflows:
       - build
       - build_highest
       - build_56
-

composer.json

@@ -39,7 +39,8 @@
     "consolidation/filter-via-dot-access-data": "^0.4",
     "consolidation/output-formatters": "^3.3.1",
     "consolidation/robo": "^1.1.5",
-    "consolidation/site-alias": "^1.1.5",
+    "consolidation/site-alias": "^1.1.6|^2",
+    "consolidation/site-process": "^0.1.13",
     "grasmash/yaml-expander": "^1.1.1",
     "league/container": "~2",
     "psr/log": "~1.0",
@@ -107,7 +108,7 @@
     "sami-install": "mkdir -p $HOME/bin && curl --output $HOME/bin/sami.phar http://get.sensiolabs.org/sami.phar && chmod +x $HOME/bin/sami.phar",
     "scenario": "scenarios/install",
     "sut": "./drush --uri=dev",
-    "sut:si": "./drush site:install testing --uri=dev --sites-subdir=dev --db-url=mysql://root:password@mariadb/unish_dev -v",
+    "sut:si": "./drush site:install testing --uri=dev --sites-subdir=dev --db-url=${UNISH_DB_URL:-mysql://root:password@mariadb}/unish_dev -v",
     "unit": "phpunit --colors=always",
     "functional": "phpunit --colors=always --configuration tests",
     "post-update-cmd": [

examples/Commands/SyncViaHttpCommands.php

@@ -60,23 +60,28 @@ protected function downloadFile($url, $user = false, $password = false, $destina
     {
         static $use_wget;
         if ($use_wget === null) {
-            $use_wget = drush_shell_exec('which wget');
+            $use_wget = drush_which('wget');
         }
 
         $destination_tmp = drush_tempnam('download_file');
         if ($use_wget) {
+            $args = ['wget', '-q', '--timeout=30'];
             if ($user && $password) {
-                drush_shell_exec("wget -q --timeout=30 --user=%s --password=%s -O %s %s", $user, $password, $destination_tmp, $url);
+                $args = array_merge($args, ["--user=$user", "--password=$password", '-O', $destination_tmp, $url]);
             } else {
-                drush_shell_exec("wget -q --timeout=30 -O %s %s", $destination_tmp, $url);
+                $args = array_merge($args, ['-O', $destination_tmp, $url]);
             }
         } else {
+            $args = ['curl', '-s', '-L', '--connect-timeout 30'];
             if ($user && $password) {
-                drush_shell_exec("curl -s -L --connect-timeout 30 --user %s:%s -o %s %s", $user, $password, $destination_tmp, $url);
+                $args = array_merge($args, ['--user', "$user:$password", '-o', $destination_tmp, $url]);
             } else {
-                drush_shell_exec("curl -s -L --connect-timeout 30 -o %s %s", $destination_tmp, $url);
+                $args = array_merge($args, ['-o', $destination_tmp, $url]);
             }
         }
+        $process = Drush::process($args);
+        $process->mustRun();
+
         if (!Drush::simulate()) {
             if (!drush_file_not_empty($destination_tmp) && $file = @file_get_contents($url)) {
                 @file_put_contents($destination_tmp, $file);

examples/helloworld.script

@@ -18,7 +18,7 @@ $this->output()->writeln(print_r($extra, true));
 // there is a bootstrapped site.
 //
 $self = Drush::aliasManager()->getSelf();;
-if (empty($self->root())) {
+if (!$self->hasRoot()) {
   $this->output()->writeln('No bootstrapped site.');
 }
 else {

includes/backend.inc

@@ -622,7 +622,7 @@ function _drush_backend_adjust_options($site_record, $command, $command_options,
  * Execute a new local or remote command in a new process.
  *
  * @deprecated as of Drush 9.4.0 and will be removed in Drush 10. Instead, use
- *   drush_invoke_process().
+ *   Drush::drush().
  *
  * @param invocations
  *   An array of command records to execute. Each record should contain:

includes/batch.inc

@@ -24,6 +24,7 @@
  * implementations.
  */
 
+use Drush\Drush;
 use Drush\Log\LogLevel;
 
 /**
@@ -89,6 +90,9 @@ function drush_backend_batch_process($command = 'batch-process', $args = [], $op
  *
  * @param int $id
  *   The batch ID of the batch being processed.
+ *
+ * @return bool|array
+ *   A results array.
  */
 function drush_batch_command($id) {
   include_once(DRUSH_DRUPAL_CORE . '/includes/batch.inc');
@@ -104,6 +108,9 @@ function drush_batch_command($id) {
  * @param command
  *    The command to call to process the batch.
  *
+ * @return array
+ *   A return array. The callers only care about the finished marker and an #abort on an operation.
+ *
  */
 function _drush_backend_batch_process($command = 'batch-process', $args, $options) {
   $result = NULL;
@@ -141,8 +148,11 @@ function _drush_backend_batch_process($command = 'batch-process', $args, $option
     $finished = FALSE;
 
     while (!$finished) {
-      $result = drush_invoke_process('@self', $command, $args);
-      $finished = drush_get_error() || !$result || (isset($result['context']['drush_batch_process_finished']) && $result['context']['drush_batch_process_finished'] == TRUE);
+      $process = Drush::drush(Drush::aliasManager()->getSelf(), $command, $args);
+      // Suppress printing stdout since we return a JSON array to the caller there.
+      $process->run($process->showRealtime()->hideStdout());
+      $result = $process->getOutputAsJson();
+      $finished = drush_get_error() || !$process->isSuccessful() || (isset($result['drush_batch_process_finished']) && $result['drush_batch_process_finished'] === TRUE);
     }
   }
 
@@ -158,6 +168,9 @@ function _drush_backend_batch_process($command = 'batch-process', $args, $option
  *
  * @param id
  *   The batch id of the batch being processed.
+ *
+ * @return bool|array
+ *   A results array.
  */
 function _drush_batch_command($id) {
   $batch =& batch_get();
@@ -234,7 +247,7 @@ function _drush_batch_worker() {
       \Drush\Drush::config()->set('runtime.php.halt-on-error', FALSE);
       $message = call_user_func_array($function, array_merge($args, [&$batch_context]));
       if (!empty($message)) {
-        drush_print(strip_tags($message), 2);
+        Drush::logger()->notice($message);
       }
       \Drush\Drush::config()->set('runtime.php.halt-on-error', $halt_on_error);
 
@@ -302,6 +315,8 @@ function _drush_batch_worker() {
  * End the batch processing:
  * Call the 'finished' callbacks to allow custom handling of results,
  * and resolve page redirection.
+ *
+ * @return array
  */
 function _drush_batch_finished() {
   $results = [];
@@ -319,7 +334,7 @@ function _drush_batch_finished() {
         $queue = _batch_queue($batch_set);
         $operations = $queue->getAllItems();
         $elapsed = $batch_set['elapsed'] / 1000;
-        $elapsed = drush_drupal_major_version() >=8 ? \Drupal::service('date.formatter')->formatInterval($elapsed) : format_interval($elapsed);
+        $elapsed = \Drupal::service('date.formatter')->formatInterval($elapsed);
         call_user_func_array($batch_set['finished'], [$batch_set['success'], $batch_set['results'], $operations, $elapsed]);
         $results[$id] = $batch_set['results'];
       }
@@ -346,6 +361,7 @@ function _drush_batch_finished() {
   $_batch = $batch;
   $batch = NULL;
   drush_set_option('drush_batch_process_finished', TRUE);
+  $results['drush_batch_process_finished'] = TRUE;
 
   return $results;
 }

includes/command.inc

@@ -64,7 +64,9 @@ use Symfony\Component\Console\Output\ConsoleOutput;
  *   @see drush_backend_get_result()
  *
  * Do not change the signature of this function!  drush_invoke_process
- * is one of the key Drush APIs.  See http://drupal.org/node/1152908
+ * was one of the key Drush APIs.  See http://drupal.org/node/1152908
+ *
+ * @deprecated See Drush::drush().
  */
 function drush_invoke_process($site_alias_record, $command_name, $commandline_args = [], $commandline_options = [], $backend_options = TRUE) {
   if ($site_alias_record instanceof AliasRecord) {

includes/context.inc

@@ -528,4 +528,4 @@ function drush_unset_option($option, $context = NULL) {
       drush_unset_option($option, $context);
     }
   }
-}
+}

includes/drupal.inc

@@ -30,8 +30,12 @@ function drush_drupal_version($drupal_root = NULL) {
   return $version;
 }
 
+/**
+ * @deprecated @see Drush::drush()
+ */
 function drush_drupal_cache_clear_all() {
-  drush_invoke_process('@self', 'cache-rebuild');
+    $process = Drush::drush(Drush::aliasManager()->getSelf(), 'cache-rebuild');
+    $process->mustrun();
 }
 
 /**

includes/drush.inc

@@ -177,10 +177,6 @@ function drush_get_global_options($brief = FALSE) {
  * (e.g. unlink() and other file system functions) so that can be suppressed
  * if the simulation mode is enabled.
  *
- * Important:  Call @see drush_op_system() to execute a shell command,
- * or @see drush_shell_exec() to execute a shell command and capture the
- * shell output.
- *
  * @param $callable
  *   The name of the function. Any additional arguments are passed along.
  * @return

includes/exec.inc

@@ -102,9 +102,6 @@ function drush_always_exec($cmd) {
 /**
  * Returns executable code for invoking preferred test editor.
  *
- * The next line after calling this function is usually
- *   @code drush_shell_exec_interactive($exec, $filepath, $filepath) @endcode
- *
  * @see drush_config_edit()
  */
 function drush_get_editor() {
@@ -118,6 +115,8 @@ function drush_get_editor() {
  * Executes a command in interactive mode.
  *
  * @see drush_shell_exec.
+ *
+ * @deprecated See Drush::process().
  */
 function drush_shell_exec_interactive($cmd) {
   return _drush_shell_exec(func_get_args(), TRUE, Drush::simulate());
@@ -186,10 +185,13 @@ function _drush_shell_exec($args, $interactive = FALSE, $simulate = false) {
 /**
  * Determine whether 'which $command' can find
  * a command on this system.
+ *
+ * @return bool
  */
 function drush_which($command) {
-  exec("which $command 2>&1", $output, $result);
-  return ($result == 0);
+  $process = Drush::process(['which', $command]);
+  $process->run();
+  return $process->isSuccessful();
 }
 
 /**
@@ -209,6 +211,8 @@ function drush_which($command) {
  * @return string
  *   A string suitable for execution with drush_shell_remote_exec().
  *
+ * @deprecated See Drush::process and Drush::siteProcess().
+ *
  */
 function drush_shell_proc_build(AliasRecord $site, $command = '', $cd = NULL, $interactive = FALSE) {
   // Build up the command. TODO: We maybe refactor this soon.
@@ -248,6 +252,8 @@ function drush_shell_proc_build(AliasRecord $site, $command = '', $cd = NULL, $i
  *     0 no error
  *     1 general error
  *     127 command not found
+ *
+ * @deprecated See Drush::process().
  */
 function drush_shell_proc_open($cmd) {
   if (Drush::verbose() || Drush::simulate()) {
@@ -268,6 +274,8 @@ function drush_shell_proc_open($cmd) {
  *
  * @returns
  *   NULL for 'same as local machine', 'Windows' or 'Linux'.
+ *
+ * @deprecated. See \Consolidation\SiteAlias\AliasRecord::os
  */
 function drush_os($site_record = NULL) {
   if (!$site_record instanceof AliasRecord) {
@@ -297,6 +305,8 @@ function legacy_drush_os($site_record = NULL) {
  * Make an attempt to simply wrap the arg with the
  * kind of quote characters it does not already contain.
  * If it contains both kinds, then this function reverts to drush_escapeshellarg.
+ *
+ * @deprecated. Quoting performed by Drush::process() and friends.
  */
 function drush_wrap_with_quotes($arg) {
   $has_double = strpos($arg, '"') !== FALSE;
@@ -337,81 +347,13 @@ function _drush_shell_exec_output_set($output = FALSE) {
 
 /**
  * Returns the output of the most recent shell command as an array of lines.
+ *
+ * @deprecated Use Drush:process() and Drush::drush. Output is retried via $process->getOutput().
  */
 function drush_shell_exec_output() {
   return _drush_shell_exec_output_set();
 }
 
-/**
- * Starts a background browser/tab for the current site or a specified URL.
- *
- * Uses a non-blocking proc_open call, so Drush execution will continue.
- *
- * @param $uri
- *   Optional URI or site path to open in browser. If omitted, or if a site path
- *   is specified, the current site home page uri will be prepended if the sites
- *   hostname resolves.
- * @return
- *   TRUE if browser was opened, FALSE if browser was disabled by the user or a,
- *   default browser could not be found.
- */
-function drush_start_browser($uri = NULL, $sleep = FALSE, $port = FALSE, $browser = true) {
-  if ($browser) {
-    // We can only open a browser if we have a DISPLAY environment variable on
-    // POSIX or are running Windows or OS X.
-    if (!Drush::simulate() && !getenv('DISPLAY') && !drush_is_windows() && !drush_is_osx()) {
-      drush_log(dt('No graphical display appears to be available, not starting browser.'), LogLevel::INFO);
-      return FALSE;
-    }
-    $host = parse_url($uri, PHP_URL_HOST);
-    if (!$host) {
-      // Build a URI for the current site, if we were passed a path.
-      $site = drush_get_context('DRUSH_URI');
-      $host = parse_url($site, PHP_URL_HOST);
-      $uri = $site . '/' . ltrim($uri, '/');
-    }
-    // Validate that the host part of the URL resolves, so we don't attempt to
-    // open the browser for http://default or similar invalid hosts.
-    $hosterror = (gethostbynamel($host) === FALSE);
-    $iperror = (ip2long($host) && gethostbyaddr($host) == $host);
-    if (!Drush::simulate() && ($hosterror || $iperror)) {
-      drush_log(dt('!host does not appear to be a resolvable hostname or IP, not starting browser. You may need to use the --uri option in your command or site alias to indicate the correct URL of this site.', ['!host' => $host]), LogLevel::WARNING);
-      return FALSE;
-    }
-    if ($port) {
-      $uri = str_replace($host, "localhost:$port", $uri);
-    }
-    if ($browser === TRUE) {
-      // See if we can find an OS helper to open URLs in default browser.
-      if (drush_shell_exec('which xdg-open')) {
-        $browser = 'xdg-open';
-      }
-      else if (drush_shell_exec('which open')) {
-        $browser = 'open';
-      }
-      else if (!drush_has_bash()) {
-        $browser = 'start';
-      }
-      else {
-        // Can't find a valid browser.
-        $browser = FALSE;
-      }
-    }
-    $prefix = '';
-    if ($sleep) {
-      $prefix = 'sleep ' . $sleep . ' && ';
-    }
-    if ($browser) {
-      drush_log(dt('Opening browser !browser at !uri', ['!browser' => $browser, '!uri' => $uri]));
-      if (!Drush::simulate()) {
-        $pipes = [];
-        proc_close(proc_open($prefix . $browser . ' ' . drush_escapeshellarg($uri) . ' 2> ' . drush_bit_bucket() . ' &', [], $pipes));
-      }
-      return TRUE;
-    }
-  }
-  return FALSE;
-}
 
 /**
  * @} End of "defgroup commandwrappers".

scenarios/isolation-phpunit4/composer.json

@@ -33,7 +33,7 @@
     "php": ">=5.6.0",
     "ext-dom": "*",
     "consolidation/config": "^1.1.0",
-    "consolidation/site-alias": "^1.1.5",
+    "consolidation/site-alias": "^1.1.6|^2",
     "psr/log": "~1.0",
     "symfony/finder": "^3.4",
     "symfony/var-dumper": "^3.4 || ^4.0",
@@ -86,7 +86,7 @@
     "sami-install": "mkdir -p $HOME/bin && curl --output $HOME/bin/sami.phar http://get.sensiolabs.org/sami.phar && chmod +x $HOME/bin/sami.phar",
     "scenario": "scenarios/install",
     "sut": "./drush --uri=dev",
-    "sut:si": "./drush site:install testing --uri=dev --sites-subdir=dev --db-url=mysql://root:password@mariadb/unish_dev -v",
+    "sut:si": "./drush site:install testing --uri=dev --sites-subdir=dev --db-url=${UNISH_DB_URL:-mysql://root:password@mariadb}/unish_dev -v",
     "unit": "phpunit --colors=always",
     "functional": "phpunit --colors=always --configuration tests",
     "post-update-cmd": [

scenarios/isolation/composer.json

@@ -33,7 +33,7 @@
     "php": ">=5.6.0",
     "ext-dom": "*",
     "consolidation/config": "^1.1.0",
-    "consolidation/site-alias": "^1.1.5",
+    "consolidation/site-alias": "^1.1.6|^2",
     "psr/log": "~1.0",
     "symfony/finder": "^3.4",
     "symfony/var-dumper": "^3.4 || ^4.0",
@@ -86,7 +86,7 @@
     "sami-install": "mkdir -p $HOME/bin && curl --output $HOME/bin/sami.phar http://get.sensiolabs.org/sami.phar && chmod +x $HOME/bin/sami.phar",
     "scenario": "scenarios/install",
     "sut": "./drush --uri=dev",
-    "sut:si": "./drush site:install testing --uri=dev --sites-subdir=dev --db-url=mysql://root:password@mariadb/unish_dev -v",
+    "sut:si": "./drush site:install testing --uri=dev --sites-subdir=dev --db-url=${UNISH_DB_URL:-mysql://root:password@mariadb}/unish_dev -v",
     "unit": "phpunit --colors=always",
     "functional": "phpunit --colors=always --configuration tests",
     "post-update-cmd": [