Changeset 19056

Timestamp:

06/09/09 12:41:14 (1 year ago)

Author:

fabien

Message:

[1.3] added sfFilesystem::execute() and made project:deploy output real-time feedback

Files:

• branches/1.3/UPGRADE_TO_1_3 (modified) (1 diff)
• branches/1.3/WHATS_NEW (modified) (1 diff)
• branches/1.3/lib/task/project/sfProjectDeployTask.class.php (modified) (3 diffs)
• branches/1.3/lib/task/sfFilesystem.class.php (modified) (2 diffs)

branches/1.3/UPGRADE_TO_1_3

@@ -75 +75 @@
-    `checkResponseElement()`: These methods have been deprecated since 1.2,
-    and replaced with the tester classes.
+
+  * `sfFilesystem::sh()`: You can replace all occurrences of this method by
+    calls to the new `sfFilesystem::execute()` method. Be warned that the
+    returned value of this method is an array composed of the `stdout` output
+    and the `stderr` output.
-
-The following methods and functions have been removed in symfony 1.3:

branches/1.3/WHATS_NEW

@@ -229 +229 @@
-equivalent `php data/bin/symfony symfony:test` command.
-
+### `project:deploy`
+
+The `project:deploy` task has been slightly improved. It now displays the
+progress of the files transfer in real-time, but only if the `-t` option is
+passed. If not, the task is silent, except for errors of course. Speaking of
+errors, if one occurs, the output is on a red background to easy problem
+identification.
+
+### `sfFileSystem::execute()`
+
+The `sfFileSystem::execute()` methods replaces the `sfFileSystem::sh()` method
+with more powerful features. It takes callbacks for real-time processing of
+the `stdout` and `stderr` outputs. It also returns both outputs as an array.
+You can find one example of its usage in the `sfProjectDeployTask` class.
+
-Exceptions
-----------

branches/1.3/lib/task/project/sfProjectDeployTask.class.php

@@ -19 +19 @@
-class sfProjectDeployTask extends sfBaseTask
-{
+  protected
+    $outputBuffer = '',
+    $errorBuffer = '';
+
-  /**
-   * @see sfTask
@@ -31 +35 @@
-      new sfCommandOption('go', null, sfCommandOption::PARAMETER_NONE, 'Do the deployment'),
-      new sfCommandOption('rsync-dir', null, sfCommandOption::PARAMETER_REQUIRED, 'The directory where to look for rsync*.txt files', 'config'),
-
+ --progress
-    ));
-
@@ -157 +161 @@
-
-    $dryRun = $options['go'] ? '' : '--dry-run';
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  }
-}

branches/1.3/lib/task/sfFilesystem.class.php

@@ -274 +274 @@
-
-  /**
-
+
+
+
-   *
-   * @param string $cmd  The command to execute on the shell
@@ -293 +295 @@
-
-    return $content;
+  }
+
+  /**
+   * Executes a shell command.
+   *
+   * @param string $cmd            The command to execute on the shell
+   * @param array  $stdoutCallback A callback for stdout output
+   * @param array  $stderrCallback A callback for stderr output
+   *
+   * @return array An array composed of the content output and the error output
+   */
+  public function execute($cmd, $stdoutCallback = null, $stderrCallback = null)
+  {
+    $this->logSection('exec ', $cmd);
+
+    $descriptorspec = array(
+      1 => array('pipe', 'w'), // stdout
+      2 => array('pipe', 'w'), // stderr
+    );
+
+    $process = proc_open($cmd, $descriptorspec, $pipes);
+    if (!is_resource($process))
+    {
+      throw new RuntimeException('Unable to execute the command.');
+    }
+
+    stream_set_blocking($pipes[1], false);
+    stream_set_blocking($pipes[2], false);
+
+    $output = '';
+    $err = '';
+    while (!feof($pipes[1]))
+    {
+      foreach ($pipes as $key => $pipe)
+      {
+        if (!$line = fread($pipe, 128))
+        {
+          continue;
+        }
+
+        if (1 == $key)
+        {
+          // stdout
+          $output .= $line;
+          if ($stdoutCallback)
+          {
+            call_user_func($stdoutCallback, $line);
+          }
+        }
+        else
+        {
+          // stderr
+          $err .= $line;
+          if ($stderrCallback)
+          {
+            call_user_func($stderrCallback, $line);
+          }
+        }
+      }
+
+      sleep(0.1);
+    }
+
+    fclose($pipes[1]);
+    fclose($pipes[2]);
+
+    if (($return = proc_close($process)) > 0)
+    {
+      throw new RuntimeException('Problem executing command.', $return);
+    }
+
+    return array($output, $err);
-  }
-