silverstripe / sspak

src/Args.php

Indentation +78 added lines, -78 removed lines

@@ -9,94 +9,94 @@
  */
 class Args
 {
-    protected $namedArgs = array();
-    protected $unnamedArgs = array();
-    protected $action = null;
+	protected $namedArgs = array();
+	protected $unnamedArgs = array();
+	protected $action = null;
 
-    public function __construct($args)
-    {
-        array_shift($args);
+	public function __construct($args)
+	{
+		array_shift($args);
 
-        foreach ($args as $arg) {
-            if (preg_match('/^--([^=]+)=(.*)$/', $arg, $matches)) {
-                $this->namedArgs[$matches[1]] = $matches[2];
-            } elseif (preg_match('/^--([^=]+)$/', $arg, $matches)) {
-                $this->namedArgs[$matches[1]] = true;
-            } else {
-                $this->unnamedArgs[] = $arg;
-            }
-        }
+		foreach ($args as $arg) {
+			if (preg_match('/^--([^=]+)=(.*)$/', $arg, $matches)) {
+				$this->namedArgs[$matches[1]] = $matches[2];
+			} elseif (preg_match('/^--([^=]+)$/', $arg, $matches)) {
+				$this->namedArgs[$matches[1]] = true;
+			} else {
+				$this->unnamedArgs[] = $arg;
+			}
+		}
 
-        $this->action = array_shift($this->unnamedArgs);
-    }
+		$this->action = array_shift($this->unnamedArgs);
+	}
 
-    public function unshiftUnnamed($arg)
-    {
-        array_unshift($this->unnamedArgs, $arg);
-    }
+	public function unshiftUnnamed($arg)
+	{
+		array_unshift($this->unnamedArgs, $arg);
+	}
 
-    public function getNamedArgs()
-    {
-        return $this->namedArgs;
-    }
+	public function getNamedArgs()
+	{
+		return $this->namedArgs;
+	}
 
-    public function getUnnamedArgs()
-    {
-        return $this->unnamedArgs;
-    }
+	public function getUnnamedArgs()
+	{
+		return $this->unnamedArgs;
+	}
 
-    public function getAction()
-    {
-        return $this->action;
-    }
+	public function getAction()
+	{
+		return $this->action;
+	}
 
-    /**
-     * Return the unnamed arg of the given index (0 = first)
-     */
-    public function unnamed($idx)
-    {
-        return isset($this->unnamedArgs[$idx]) ? $this->unnamedArgs[$idx] : null;
-    }
+	/**
+	 * Return the unnamed arg of the given index (0 = first)
+	 */
+	public function unnamed($idx)
+	{
+		return isset($this->unnamedArgs[$idx]) ? $this->unnamedArgs[$idx] : null;
+	}
 
-    /**
-     * Return the sudo argument, preferring a more specific one with the given optional prefix
-     */
-    public function sudo($optionalPrefix)
-    {
-        if (!empty($this->namedArgs[$optionalPrefix . '-sudo'])) {
-            return $this->namedArgs[$optionalPrefix . '-sudo'];
-        } elseif (!empty($this->namedArgs['sudo'])) {
-            return $this->namedArgs['sudo'];
-        } else {
-            return null;
-        }
-    }
+	/**
+	 * Return the sudo argument, preferring a more specific one with the given optional prefix
+	 */
+	public function sudo($optionalPrefix)
+	{
+		if (!empty($this->namedArgs[$optionalPrefix . '-sudo'])) {
+			return $this->namedArgs[$optionalPrefix . '-sudo'];
+		} elseif (!empty($this->namedArgs['sudo'])) {
+			return $this->namedArgs['sudo'];
+		} else {
+			return null;
+		}
+	}
 
-    /**
-     * Return the pak-parks arguments, as a map of part => boolean
-     */
-    public function pakParts()
-    {
-        // Look up which parts of the sspak are going to be saved
-        $pakParks = array();
-        foreach (array('assets','db','git-remote') as $part) {
-            $pakParts[$part] = !empty($this->namedArgs[$part]);
-        }
+	/**
+	 * Return the pak-parks arguments, as a map of part => boolean
+	 */
+	public function pakParts()
+	{
+		// Look up which parts of the sspak are going to be saved
+		$pakParks = array();
+		foreach (array('assets','db','git-remote') as $part) {
+			$pakParts[$part] = !empty($this->namedArgs[$part]);
+		}
 
-        // Default to db and assets
-        if (!array_filter($pakParts)) {
-            $pakParts = array('db' => true, 'assets' => true, 'git-remote' => true);
-        }
-        return $pakParts;
-    }
+		// Default to db and assets
+		if (!array_filter($pakParts)) {
+			$pakParts = array('db' => true, 'assets' => true, 'git-remote' => true);
+		}
+		return $pakParts;
+	}
 
-    public function requireUnnamed($items)
-    {
-        if (sizeof($this->unnamedArgs) < sizeof($items)) {
-            echo "Usage: {$_SERVER['argv'][0]} " . $this->action . " (";
-            echo implode(") (", $items);
-            echo ")\n";
-            throw new Exception('Arguments missing.');
-        }
-    }
+	public function requireUnnamed($items)
+	{
+		if (sizeof($this->unnamedArgs) < sizeof($items)) {
+			echo "Usage: {$_SERVER['argv'][0]} " . $this->action . " (";
+			echo implode(") (", $items);
+			echo ")\n";
+			throw new Exception('Arguments missing.');
+		}
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -63,8 +63,8 @@ 
      */
     public function sudo($optionalPrefix)
     {
-        if (!empty($this->namedArgs[$optionalPrefix . '-sudo'])) {
-            return $this->namedArgs[$optionalPrefix . '-sudo'];
+        if (!empty($this->namedArgs[$optionalPrefix.'-sudo'])) {
+            return $this->namedArgs[$optionalPrefix.'-sudo'];
         } elseif (!empty($this->namedArgs['sudo'])) {
             return $this->namedArgs['sudo'];
         } else {
@@ -79,7 +79,7 @@ 
     {
         // Look up which parts of the sspak are going to be saved
         $pakParks = array();
-        foreach (array('assets','db','git-remote') as $part) {
+        foreach (array('assets', 'db', 'git-remote') as $part) {
             $pakParts[$part] = !empty($this->namedArgs[$part]);
         }
 
@@ -93,7 +93,7 @@ 
     public function requireUnnamed($items)
     {
         if (sizeof($this->unnamedArgs) < sizeof($items)) {
-            echo "Usage: {$_SERVER['argv'][0]} " . $this->action . " (";
+            echo "Usage: {$_SERVER['argv'][0]} ".$this->action." (";
             echo implode(") (", $items);
             echo ")\n";
             throw new Exception('Arguments missing.');

src/Webroot.php

Indentation +205 added lines, -205 removed lines

@@ -9,209 +9,209 @@
  */
 class Webroot extends FilesystemEntity
 {
-    protected $sudo = null;
-    protected $details = null;
-
-    public function setSudo($sudo)
-    {
-        $this->sudo = $sudo;
-    }
-
-    /**
-     * Return a map of the db & asset config details.
-     * Calls sniff once and then caches
-     */
-    public function details()
-    {
-        if (!$this->details) {
-            $this->details = $this->sniff();
-        }
-        return $this->details;
-    }
-
-    /**
-     * Return a map of the db & asset config details, acquired with ssnap-sniffer
-     */
-    public function sniff()
-    {
-        global $snifferFileContent;
-
-        if (!$snifferFileContent) {
-            $snifferFileContent = file_get_contents(PACKAGE_ROOT . 'src/sspak-sniffer.php');
-        }
-
-        $remoteSniffer = '/tmp/sspak-sniffer-' . rand(100000, 999999) . '.php';
-        $this->uploadContent($snifferFileContent, $remoteSniffer);
-
-        $result = $this->execSudo(array('/usr/bin/env', 'php', $remoteSniffer, $this->path));
-        $this->unlink($remoteSniffer);
-
-        $parsed = @unserialize($result['output']);
-        if (!$parsed) {
-            throw new Exception("Could not parse sspak-sniffer content:\n{$result['output']}\n");
-        }
-        return $parsed;
-    }
-
-    /**
-     * Execute a command on the relevant server, using the given sudo option
-     * @param string|array $command Shell command, either a fully escaped string or an array
-     * @see Process::exec @param $options (optional) Extra options
-     * @return array A map containing 'return', 'output', and 'error'
-     */
-    public function execSudo($command, $options = array())
-    {
-        if ($this->sudo) {
-            if (is_array($command)) {
-                $command = $this->executor->commandArrayToString($command);
-            }
-            // Try running sudo without asking for a password
-            try {
-                return $this->exec("sudo -n -u " . escapeshellarg($this->sudo) . " " . $command, $options);
-
-            // Otherwise capture SUDO password ourselves and pass it in through STDIN
-            } catch (Exception $e) {
-                echo "[sspak sudo] Enter your password: ";
-                $stdin = fopen('php://stdin', 'r');
-                $password = fgets($stdin);
-
-                return $this->exec(
-                    "sudo -S -p '' -u " . escapeshellarg($this->sudo) . " " . $command,
-                    array('inputContent' => $password)
-                );
-            }
-        } else {
-            return $this->exec($command, $options);
-        }
-    }
-
-    /**
-     * Put the database from the given sspak file into this webroot.
-     * @param array $details The previously sniffed details of this webroot
-     * @param bool $dropdb Drop the DB prior to install
-     * @param string $sspakFile Filename
-     */
-    public function putdb($sspak, $dropdb)
-    {
-        $details = $this->details();
-
-        // Check the database type
-        $dbFunction = 'putdb_'.$details['db_type'];
-        if (!method_exists($this, $dbFunction)) {
-            throw new Exception("Can't process database type '" . $details['db_type'] . "'");
-        }
-
-        // Extract DB direct from sspak file
-        return $this->$dbFunction($details, $sspak, $dropdb);
-    }
-
-    public function putdb_MySQLPDODatabase($conf, $sspak, $dropdb)
-    {
-        return $this->putdb_MySQLDatabase($conf, $sspak, $dropdb);
-    }
-
-    public function putdb_MySQLDatabase($conf, $sspak, $dropdb)
-    {
-        $usernameArg = escapeshellarg("--user=".$conf['db_username']);
-        $passwordArg = escapeshellarg("--password=".$conf['db_password']);
-        $databaseArg = escapeshellarg($conf['db_database']);
-
-        $hostArg = '';
-        $portArg = '';
-        if (!empty($conf['db_server']) && $conf['db_server'] != 'localhost') {
-            if (strpos($conf['db_server'], ':')!==false) {
-                // Handle "server:port" format.
-                $server = explode(':', $conf['db_server'], 2);
-                $hostArg = escapeshellarg("--host=".$server[0]);
-                $portArg = escapeshellarg("--port=".$server[1]);
-            } else {
-                $hostArg = escapeshellarg("--host=".$conf['db_server']);
-            }
-        }
-        $dbCommand = "create database if not exists `" . addslashes($conf['db_database']) . "`";
-        if ($dropdb) {
-            $dbCommand = "drop database if exists `" . addslashes($conf['db_database']) . "`; " . $dbCommand;
-        }
-
-        $this->exec("echo '$dbCommand' | mysql $usernameArg $passwordArg $hostArg $portArg");
-
-        $stream = $sspak->readStreamForFile('database.sql.gz');
-        $this->exec("gunzip -c | sed '/^CREATE DATABASE/d;/^USE/d' | mysql --default-character-set=utf8 " .
-        "$usernameArg $passwordArg $hostArg $portArg $databaseArg", array('inputStream' => $stream));
-        fclose($stream);
-        return true;
-    }
-
-    public function putdb_PostgreSQLDatabase($conf, $sspak, $dropdb)
-    {
-        // TODO: Support dropdb for postgresql
-        $usernameArg = escapeshellarg("--username=".$conf['db_username']);
-        $passwordArg = "PGPASSWORD=".escapeshellarg($conf['db_password']);
-        $databaseArg = escapeshellarg($conf['db_database']);
-        $hostArg = escapeshellarg("--host=".$conf['db_server']);
-
-        // Create database if needed
-        $result = $this->exec("echo \"select count(*) from pg_catalog.pg_database where datname = $databaseArg\" | " .
-        "$passwordArg psql $usernameArg $hostArg $databaseArg -qt");
-        if (trim($result['output']) == '0') {
-            $this->exec("$passwordArg createdb $usernameArg $hostArg $databaseArg");
-        }
-
-        $stream = $sspak->readStreamForFile('database.sql.gz');
-        return $this->exec(
-            "gunzip -c | $passwordArg psql $usernameArg $hostArg $databaseArg",
-            array('inputStream' => $stream)
-        );
-        fclose($stream);
-    }
-
-    /**
-     * @param $sspak SSPakFile SSPak file to extract assets from
-     * @todo There should be a return value or exception thrown to indicate success or failure to put assets
-     */
-    public function putassets($sspak)
-    {
-        $details = $this->details();
-        $assetsPath = $details['assets_path'];
-        $assetsPath = escapeshellarg($assetsPath);
-
-        // Check for symlink - this was more reliable than is_link
-        $assetsPathExec = $this->exec(
-            "if [ -L {$assetsPath} ]; then readlink -f {$assetsPath}; else echo {$assetsPath}; fi"
-        );
-        $assetsPath = trim($assetsPathExec["output"]);
-
-        $assetsOldPath = $assetsPath . '.old';
-        $assetsParentArg = escapeshellarg(dirname($assetsPath));
-
-        // Move existing assets to assets.old
-        $assetsExist = $this->execSudo("test -d '$assetsPath'", ['throwException' => false]);
-        if ($assetsExist['return'] == 0) {
-            $this->execSudo("mv {$assetsPath} {$assetsOldPath}");
-        }
-
-        // Extract assets
-        $stream = $sspak->readStreamForFile('assets.tar.gz');
-        $this->execSudo("tar xzf - -C {$assetsParentArg}", array('inputStream' => $stream));
-        fclose($stream);
-
-        // Remove assets.old
-        $oldAssetsExist = $this->execSudo("test -d '$assetsOldPath'", ['throwException' => false]);
-        if ($oldAssetsExist['return'] == 0) {
-            $this->execSudo("rm -rf {$assetsOldPath}");
-        }
-    }
-
-    /**
-     * Load a git remote into this webroot.
-     * It expects that this remote is an empty directory.
-     *
-     * @param array $details Map of git details
-     */
-    public function putgit($details)
-    {
-        $this->exec(array('git', 'clone', $details['remote'], $this->path));
-        $this->exec("cd $this->path && git checkout " . escapeshellarg($details['branch']));
-        return true;
-    }
+	protected $sudo = null;
+	protected $details = null;
+
+	public function setSudo($sudo)
+	{
+		$this->sudo = $sudo;
+	}
+
+	/**
+	 * Return a map of the db & asset config details.
+	 * Calls sniff once and then caches
+	 */
+	public function details()
+	{
+		if (!$this->details) {
+			$this->details = $this->sniff();
+		}
+		return $this->details;
+	}
+
+	/**
+	 * Return a map of the db & asset config details, acquired with ssnap-sniffer
+	 */
+	public function sniff()
+	{
+		global $snifferFileContent;
+
+		if (!$snifferFileContent) {
+			$snifferFileContent = file_get_contents(PACKAGE_ROOT . 'src/sspak-sniffer.php');
+		}
+
+		$remoteSniffer = '/tmp/sspak-sniffer-' . rand(100000, 999999) . '.php';
+		$this->uploadContent($snifferFileContent, $remoteSniffer);
+
+		$result = $this->execSudo(array('/usr/bin/env', 'php', $remoteSniffer, $this->path));
+		$this->unlink($remoteSniffer);
+
+		$parsed = @unserialize($result['output']);
+		if (!$parsed) {
+			throw new Exception("Could not parse sspak-sniffer content:\n{$result['output']}\n");
+		}
+		return $parsed;
+	}
+
+	/**
+	 * Execute a command on the relevant server, using the given sudo option
+	 * @param string|array $command Shell command, either a fully escaped string or an array
+	 * @see Process::exec @param $options (optional) Extra options
+	 * @return array A map containing 'return', 'output', and 'error'
+	 */
+	public function execSudo($command, $options = array())
+	{
+		if ($this->sudo) {
+			if (is_array($command)) {
+				$command = $this->executor->commandArrayToString($command);
+			}
+			// Try running sudo without asking for a password
+			try {
+				return $this->exec("sudo -n -u " . escapeshellarg($this->sudo) . " " . $command, $options);
+
+			// Otherwise capture SUDO password ourselves and pass it in through STDIN
+			} catch (Exception $e) {
+				echo "[sspak sudo] Enter your password: ";
+				$stdin = fopen('php://stdin', 'r');
+				$password = fgets($stdin);
+
+				return $this->exec(
+					"sudo -S -p '' -u " . escapeshellarg($this->sudo) . " " . $command,
+					array('inputContent' => $password)
+				);
+			}
+		} else {
+			return $this->exec($command, $options);
+		}
+	}
+
+	/**
+	 * Put the database from the given sspak file into this webroot.
+	 * @param array $details The previously sniffed details of this webroot
+	 * @param bool $dropdb Drop the DB prior to install
+	 * @param string $sspakFile Filename
+	 */
+	public function putdb($sspak, $dropdb)
+	{
+		$details = $this->details();
+
+		// Check the database type
+		$dbFunction = 'putdb_'.$details['db_type'];
+		if (!method_exists($this, $dbFunction)) {
+			throw new Exception("Can't process database type '" . $details['db_type'] . "'");
+		}
+
+		// Extract DB direct from sspak file
+		return $this->$dbFunction($details, $sspak, $dropdb);
+	}
+
+	public function putdb_MySQLPDODatabase($conf, $sspak, $dropdb)
+	{
+		return $this->putdb_MySQLDatabase($conf, $sspak, $dropdb);
+	}
+
+	public function putdb_MySQLDatabase($conf, $sspak, $dropdb)
+	{
+		$usernameArg = escapeshellarg("--user=".$conf['db_username']);
+		$passwordArg = escapeshellarg("--password=".$conf['db_password']);
+		$databaseArg = escapeshellarg($conf['db_database']);
+
+		$hostArg = '';
+		$portArg = '';
+		if (!empty($conf['db_server']) && $conf['db_server'] != 'localhost') {
+			if (strpos($conf['db_server'], ':')!==false) {
+				// Handle "server:port" format.
+				$server = explode(':', $conf['db_server'], 2);
+				$hostArg = escapeshellarg("--host=".$server[0]);
+				$portArg = escapeshellarg("--port=".$server[1]);
+			} else {
+				$hostArg = escapeshellarg("--host=".$conf['db_server']);
+			}
+		}
+		$dbCommand = "create database if not exists `" . addslashes($conf['db_database']) . "`";
+		if ($dropdb) {
+			$dbCommand = "drop database if exists `" . addslashes($conf['db_database']) . "`; " . $dbCommand;
+		}
+
+		$this->exec("echo '$dbCommand' | mysql $usernameArg $passwordArg $hostArg $portArg");
+
+		$stream = $sspak->readStreamForFile('database.sql.gz');
+		$this->exec("gunzip -c | sed '/^CREATE DATABASE/d;/^USE/d' | mysql --default-character-set=utf8 " .
+		"$usernameArg $passwordArg $hostArg $portArg $databaseArg", array('inputStream' => $stream));
+		fclose($stream);
+		return true;
+	}
+
+	public function putdb_PostgreSQLDatabase($conf, $sspak, $dropdb)
+	{
+		// TODO: Support dropdb for postgresql
+		$usernameArg = escapeshellarg("--username=".$conf['db_username']);
+		$passwordArg = "PGPASSWORD=".escapeshellarg($conf['db_password']);
+		$databaseArg = escapeshellarg($conf['db_database']);
+		$hostArg = escapeshellarg("--host=".$conf['db_server']);
+
+		// Create database if needed
+		$result = $this->exec("echo \"select count(*) from pg_catalog.pg_database where datname = $databaseArg\" | " .
+		"$passwordArg psql $usernameArg $hostArg $databaseArg -qt");
+		if (trim($result['output']) == '0') {
+			$this->exec("$passwordArg createdb $usernameArg $hostArg $databaseArg");
+		}
+
+		$stream = $sspak->readStreamForFile('database.sql.gz');
+		return $this->exec(
+			"gunzip -c | $passwordArg psql $usernameArg $hostArg $databaseArg",
+			array('inputStream' => $stream)
+		);
+		fclose($stream);
+	}
+
+	/**
+	 * @param $sspak SSPakFile SSPak file to extract assets from
+	 * @todo There should be a return value or exception thrown to indicate success or failure to put assets
+	 */
+	public function putassets($sspak)
+	{
+		$details = $this->details();
+		$assetsPath = $details['assets_path'];
+		$assetsPath = escapeshellarg($assetsPath);
+
+		// Check for symlink - this was more reliable than is_link
+		$assetsPathExec = $this->exec(
+			"if [ -L {$assetsPath} ]; then readlink -f {$assetsPath}; else echo {$assetsPath}; fi"
+		);
+		$assetsPath = trim($assetsPathExec["output"]);
+
+		$assetsOldPath = $assetsPath . '.old';
+		$assetsParentArg = escapeshellarg(dirname($assetsPath));
+
+		// Move existing assets to assets.old
+		$assetsExist = $this->execSudo("test -d '$assetsPath'", ['throwException' => false]);
+		if ($assetsExist['return'] == 0) {
+			$this->execSudo("mv {$assetsPath} {$assetsOldPath}");
+		}
+
+		// Extract assets
+		$stream = $sspak->readStreamForFile('assets.tar.gz');
+		$this->execSudo("tar xzf - -C {$assetsParentArg}", array('inputStream' => $stream));
+		fclose($stream);
+
+		// Remove assets.old
+		$oldAssetsExist = $this->execSudo("test -d '$assetsOldPath'", ['throwException' => false]);
+		if ($oldAssetsExist['return'] == 0) {
+			$this->execSudo("rm -rf {$assetsOldPath}");
+		}
+	}
+
+	/**
+	 * Load a git remote into this webroot.
+	 * It expects that this remote is an empty directory.
+	 *
+	 * @param array $details Map of git details
+	 */
+	public function putgit($details)
+	{
+		$this->exec(array('git', 'clone', $details['remote'], $this->path));
+		$this->exec("cd $this->path && git checkout " . escapeshellarg($details['branch']));
+		return true;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -37,10 +37,10 @@ 
         global $snifferFileContent;
 
         if (!$snifferFileContent) {
-            $snifferFileContent = file_get_contents(PACKAGE_ROOT . 'src/sspak-sniffer.php');
+            $snifferFileContent = file_get_contents(PACKAGE_ROOT.'src/sspak-sniffer.php');
         }
 
-        $remoteSniffer = '/tmp/sspak-sniffer-' . rand(100000, 999999) . '.php';
+        $remoteSniffer = '/tmp/sspak-sniffer-'.rand(100000, 999999).'.php';
         $this->uploadContent($snifferFileContent, $remoteSniffer);
 
         $result = $this->execSudo(array('/usr/bin/env', 'php', $remoteSniffer, $this->path));
@@ -67,7 +67,7 @@ 
             }
             // Try running sudo without asking for a password
             try {
-                return $this->exec("sudo -n -u " . escapeshellarg($this->sudo) . " " . $command, $options);
+                return $this->exec("sudo -n -u ".escapeshellarg($this->sudo)." ".$command, $options);
 
             // Otherwise capture SUDO password ourselves and pass it in through STDIN
             } catch (Exception $e) {
@@ -76,7 +76,7 @@ 
                 $password = fgets($stdin);
 
                 return $this->exec(
-                    "sudo -S -p '' -u " . escapeshellarg($this->sudo) . " " . $command,
+                    "sudo -S -p '' -u ".escapeshellarg($this->sudo)." ".$command,
                     array('inputContent' => $password)
                 );
             }
@@ -98,7 +98,7 @@ 
         // Check the database type
         $dbFunction = 'putdb_'.$details['db_type'];
         if (!method_exists($this, $dbFunction)) {
-            throw new Exception("Can't process database type '" . $details['db_type'] . "'");
+            throw new Exception("Can't process database type '".$details['db_type']."'");
         }
 
         // Extract DB direct from sspak file
@@ -119,7 +119,7 @@ 
         $hostArg = '';
         $portArg = '';
         if (!empty($conf['db_server']) && $conf['db_server'] != 'localhost') {
-            if (strpos($conf['db_server'], ':')!==false) {
+            if (strpos($conf['db_server'], ':') !== false) {
                 // Handle "server:port" format.
                 $server = explode(':', $conf['db_server'], 2);
                 $hostArg = escapeshellarg("--host=".$server[0]);
@@ -128,15 +128,15 @@ 
                 $hostArg = escapeshellarg("--host=".$conf['db_server']);
             }
         }
-        $dbCommand = "create database if not exists `" . addslashes($conf['db_database']) . "`";
+        $dbCommand = "create database if not exists `".addslashes($conf['db_database'])."`";
         if ($dropdb) {
-            $dbCommand = "drop database if exists `" . addslashes($conf['db_database']) . "`; " . $dbCommand;
+            $dbCommand = "drop database if exists `".addslashes($conf['db_database'])."`; ".$dbCommand;
         }
 
         $this->exec("echo '$dbCommand' | mysql $usernameArg $passwordArg $hostArg $portArg");
 
         $stream = $sspak->readStreamForFile('database.sql.gz');
-        $this->exec("gunzip -c | sed '/^CREATE DATABASE/d;/^USE/d' | mysql --default-character-set=utf8 " .
+        $this->exec("gunzip -c | sed '/^CREATE DATABASE/d;/^USE/d' | mysql --default-character-set=utf8 ".
         "$usernameArg $passwordArg $hostArg $portArg $databaseArg", array('inputStream' => $stream));
         fclose($stream);
         return true;
@@ -151,7 +151,7 @@ 
         $hostArg = escapeshellarg("--host=".$conf['db_server']);
 
         // Create database if needed
-        $result = $this->exec("echo \"select count(*) from pg_catalog.pg_database where datname = $databaseArg\" | " .
+        $result = $this->exec("echo \"select count(*) from pg_catalog.pg_database where datname = $databaseArg\" | ".
         "$passwordArg psql $usernameArg $hostArg $databaseArg -qt");
         if (trim($result['output']) == '0') {
             $this->exec("$passwordArg createdb $usernameArg $hostArg $databaseArg");
@@ -181,7 +181,7 @@ 
         );
         $assetsPath = trim($assetsPathExec["output"]);
 
-        $assetsOldPath = $assetsPath . '.old';
+        $assetsOldPath = $assetsPath.'.old';
         $assetsParentArg = escapeshellarg(dirname($assetsPath));
 
         // Move existing assets to assets.old
@@ -211,7 +211,7 @@ 
     public function putgit($details)
     {
         $this->exec(array('git', 'clone', $details['remote'], $this->path));
-        $this->exec("cd $this->path && git checkout " . escapeshellarg($details['branch']));
+        $this->exec("cd $this->path && git checkout ".escapeshellarg($details['branch']));
         return true;
     }
 }

src/SSPak.php

Indentation +529 added lines, -529 removed lines

@@ -13,68 +13,68 @@ 
  */
 class SSPak
 {
-    protected $executor;
-
-    /**
-     * Create a new handler
-     * @param Executor $executor The Executor object to handle command execution
-     */
-    public function __construct($executor)
-    {
-        $this->executor = $executor;
-    }
-
-    public function getActions()
-    {
-        return array(
-            "help" => array(
-                "description" => "Show this help message.",
-                "method" => "help",
-            ),
-            "save" => array(
-                "description" => "Save an .sspak file from a SilverStripe site.",
-                "unnamedArgs" => array("webroot", "sspak file"),
-                "namedArgs" => array("identity"),
-                "method" => "save",
-            ),
-            "load" => array(
-                "description" => "Load an .sspak file into a SilverStripe site. Does not backup - be careful!",
-                "unnamedArgs" => array("sspak file", "[webroot]"),
-                "namedArgs" => array("identity"),
-                "namedFlags" => array("drop-db"),
-                "method" => "load",
-            ),
-            "saveexisting" => array(
-                "description" => "Create an .sspak file from database SQL dump and/or assets. " .
-                "Does not require a SilverStripe site.",
-                "unnamedArgs" => array("sspak file"),
-                "namedArgs" => array("db", "assets"),
-                "method" => "saveexisting"
-            ),
-            "extract" => array(
-                "description" => "Extract an .sspak file into the current working directory. Does not require a " .
-                 "SilverStripe site.",
-                "unnamedArgs" => array("sspak file", "destination path"),
-                "method" => "extract"
-            ),
-            "listtables" => array(
-                "description" => "List tables in the database",
-                "unnamedArgs" => array("webroot"),
-                "method" => "listTables"
-            ),
-
-            "savecsv" => array(
-                "description" => "Save tables in the database to a collection of CSV files",
-                "unnamedArgs" => array("webroot", "output-path"),
-                "method" => "saveCsv"
-            ),
-
-            "loadcsv" => array(
-                "description" => "Load tables from collection of CSV files to a webroot",
-                "unnamedArgs" => array("input-path", "webroot"),
-                "method" => "loadCsv"
-            ),
-            /*
+	protected $executor;
+
+	/**
+	 * Create a new handler
+	 * @param Executor $executor The Executor object to handle command execution
+	 */
+	public function __construct($executor)
+	{
+		$this->executor = $executor;
+	}
+
+	public function getActions()
+	{
+		return array(
+			"help" => array(
+				"description" => "Show this help message.",
+				"method" => "help",
+			),
+			"save" => array(
+				"description" => "Save an .sspak file from a SilverStripe site.",
+				"unnamedArgs" => array("webroot", "sspak file"),
+				"namedArgs" => array("identity"),
+				"method" => "save",
+			),
+			"load" => array(
+				"description" => "Load an .sspak file into a SilverStripe site. Does not backup - be careful!",
+				"unnamedArgs" => array("sspak file", "[webroot]"),
+				"namedArgs" => array("identity"),
+				"namedFlags" => array("drop-db"),
+				"method" => "load",
+			),
+			"saveexisting" => array(
+				"description" => "Create an .sspak file from database SQL dump and/or assets. " .
+				"Does not require a SilverStripe site.",
+				"unnamedArgs" => array("sspak file"),
+				"namedArgs" => array("db", "assets"),
+				"method" => "saveexisting"
+			),
+			"extract" => array(
+				"description" => "Extract an .sspak file into the current working directory. Does not require a " .
+				 "SilverStripe site.",
+				"unnamedArgs" => array("sspak file", "destination path"),
+				"method" => "extract"
+			),
+			"listtables" => array(
+				"description" => "List tables in the database",
+				"unnamedArgs" => array("webroot"),
+				"method" => "listTables"
+			),
+
+			"savecsv" => array(
+				"description" => "Save tables in the database to a collection of CSV files",
+				"unnamedArgs" => array("webroot", "output-path"),
+				"method" => "saveCsv"
+			),
+
+			"loadcsv" => array(
+				"description" => "Load tables from collection of CSV files to a webroot",
+				"unnamedArgs" => array("input-path", "webroot"),
+				"method" => "loadCsv"
+			),
+			/*
 
             "install" => array(
                 "description" => "Install a .sspak file into a new environment.",
@@ -92,89 +92,89 @@ 
                 "method" => "transfer",
             ),
             */
-        );
-    }
-
-    public function help($args)
-    {
-        echo "SSPak: manage SilverStripe .sspak archives.\n\nUsage:\n";
-        foreach ($this->getActions() as $action => $info) {
-            echo "sspak $action";
-            if (!empty($info['unnamedArgs'])) {
-                foreach ($info['unnamedArgs'] as $arg) {
-                    echo " ($arg)";
-                }
-            }
-            if (!empty($info['namedFlags'])) {
-                foreach ($info['namedFlags'] as $arg) {
-                    echo " (--$arg)";
-                }
-            }
-            if (!empty($info['namedArgs'])) {
-                foreach ($info['namedArgs'] as $arg) {
-                    echo " --$arg=\"$arg value\"";
-                }
-            }
-            echo "\n  {$info['description']}\n\n";
-        }
-    }
-
-    /**
-     * Save an existing database and/or assets into an .sspak.phar file.
-     * Does the same as {@link save()} but doesn't require an existing site.
-     */
-    public function saveexisting($args)
-    {
-        $executor = $this->executor;
-
-        $args->requireUnnamed(array('sspak file'));
-        $unnamedArgs = $args->getUnnamedArgs();
-        $namedArgs = $args->getNamedArgs();
-
-        $sspak = new SSPakFile($unnamedArgs[0], $executor);
-
-        // Look up which parts of the sspak are going to be saved
-        $pakParts = $args->pakParts();
-
-        $filesystem = new FilesystemEntity(null, $executor);
-
-        if ($pakParts['db']) {
-            $dbPath = escapeshellarg($namedArgs['db']);
-            $process = $filesystem->createProcess("cat $dbPath | gzip -c");
-            $sspak->writeFileFromProcess('database.sql.gz', $process);
-        }
-
-        if ($pakParts['assets']) {
-            $assetsParentArg = escapeshellarg(dirname($namedArgs['assets']));
-            $assetsBaseArg = escapeshellarg(basename($namedArgs['assets']));
-            $process = $filesystem->createProcess("cd $assetsParentArg && tar cfh - $assetsBaseArg | gzip -c");
-            $sspak->writeFileFromProcess('assets.tar.gz', $process);
-        }
-    }
-
-    /**
-     * Extracts an existing database and/or assets from a sspak into the given directory,
-     * defaulting the current working directory if the destination is not given.
-     */
-    public function extract($args)
-    {
-        $executor = $this->executor;
-
-        $args->requireUnnamed(array('source sspak file'));
-        $unnamedArgs = $args->getUnnamedArgs();
-        $file = $unnamedArgs[0];
-        $dest = !empty($unnamedArgs[1]) ? $unnamedArgs[1] : getcwd();
-
-        // Phar and PharData use "ustar" format for tar archives (http://php.net/manual/pl/phar.fileformat.tar.php).
-        // Ustar does not support files larger than 8 GB.
-        // If the sspak has been created through tar and gz directly, it will probably be in POSIX, PAX or GNU formats,
-        // which do support >8 GB files. Such archive cannot be accessed by Phar/PharData, and needs to be handled
-        // manually - it will just spew checksum errors where PHP expects to see ustar headers, but finds garbage
-        // from other formats.
-        // There is no cross-platform way of checking the assets.tar.gz size without unpacking, so we assume the size
-        // of database is negligible which lets us approximate the size of assets.
-        if (filesize($file) > 8*1024*1024*1024) {
-            $msg = <<<EOM
+		);
+	}
+
+	public function help($args)
+	{
+		echo "SSPak: manage SilverStripe .sspak archives.\n\nUsage:\n";
+		foreach ($this->getActions() as $action => $info) {
+			echo "sspak $action";
+			if (!empty($info['unnamedArgs'])) {
+				foreach ($info['unnamedArgs'] as $arg) {
+					echo " ($arg)";
+				}
+			}
+			if (!empty($info['namedFlags'])) {
+				foreach ($info['namedFlags'] as $arg) {
+					echo " (--$arg)";
+				}
+			}
+			if (!empty($info['namedArgs'])) {
+				foreach ($info['namedArgs'] as $arg) {
+					echo " --$arg=\"$arg value\"";
+				}
+			}
+			echo "\n  {$info['description']}\n\n";
+		}
+	}
+
+	/**
+	 * Save an existing database and/or assets into an .sspak.phar file.
+	 * Does the same as {@link save()} but doesn't require an existing site.
+	 */
+	public function saveexisting($args)
+	{
+		$executor = $this->executor;
+
+		$args->requireUnnamed(array('sspak file'));
+		$unnamedArgs = $args->getUnnamedArgs();
+		$namedArgs = $args->getNamedArgs();
+
+		$sspak = new SSPakFile($unnamedArgs[0], $executor);
+
+		// Look up which parts of the sspak are going to be saved
+		$pakParts = $args->pakParts();
+
+		$filesystem = new FilesystemEntity(null, $executor);
+
+		if ($pakParts['db']) {
+			$dbPath = escapeshellarg($namedArgs['db']);
+			$process = $filesystem->createProcess("cat $dbPath | gzip -c");
+			$sspak->writeFileFromProcess('database.sql.gz', $process);
+		}
+
+		if ($pakParts['assets']) {
+			$assetsParentArg = escapeshellarg(dirname($namedArgs['assets']));
+			$assetsBaseArg = escapeshellarg(basename($namedArgs['assets']));
+			$process = $filesystem->createProcess("cd $assetsParentArg && tar cfh - $assetsBaseArg | gzip -c");
+			$sspak->writeFileFromProcess('assets.tar.gz', $process);
+		}
+	}
+
+	/**
+	 * Extracts an existing database and/or assets from a sspak into the given directory,
+	 * defaulting the current working directory if the destination is not given.
+	 */
+	public function extract($args)
+	{
+		$executor = $this->executor;
+
+		$args->requireUnnamed(array('source sspak file'));
+		$unnamedArgs = $args->getUnnamedArgs();
+		$file = $unnamedArgs[0];
+		$dest = !empty($unnamedArgs[1]) ? $unnamedArgs[1] : getcwd();
+
+		// Phar and PharData use "ustar" format for tar archives (http://php.net/manual/pl/phar.fileformat.tar.php).
+		// Ustar does not support files larger than 8 GB.
+		// If the sspak has been created through tar and gz directly, it will probably be in POSIX, PAX or GNU formats,
+		// which do support >8 GB files. Such archive cannot be accessed by Phar/PharData, and needs to be handled
+		// manually - it will just spew checksum errors where PHP expects to see ustar headers, but finds garbage
+		// from other formats.
+		// There is no cross-platform way of checking the assets.tar.gz size without unpacking, so we assume the size
+		// of database is negligible which lets us approximate the size of assets.
+		if (filesize($file) > 8*1024*1024*1024) {
+			$msg = <<<EOM
 
 ERROR: SSPak is unable to extract archives over 8 GB.
 
@@ -187,388 +187,388 @@ 
 See http://silverstripe.github.io/sspak/, "Manual access" for more information.
 
 EOM;
-            printf($msg, $file);
-            die(1);
-        }
-
-        $sspak = new SSPakFile($file, $executor);
-
-        // Validation
-        if (!$sspak->exists()) {
-            throw new Exception("File '$file' doesn't exist.");
-        }
-
-        $phar = $sspak->getPhar();
-        $phar->extractTo($dest);
-    }
-
-    public function listTables($args)
-    {
-        $args->requireUnnamed(array('webroot'));
-        $unnamedArgs = $args->getUnnamedArgs();
-        $webroot = $unnamedArgs[0];
-
-        $db = new DatabaseConnector($webroot);
-
-        print_r($db->getTables());
-    }
-
-    public function saveCsv($args)
-    {
-        $args->requireUnnamed(array('webroot', 'path'));
-        $unnamedArgs = $args->getUnnamedArgs();
-        $webroot = $unnamedArgs[0];
-        $destPath = $unnamedArgs[1];
-
-        if (!file_exists($destPath)) {
-            mkdir($destPath) || die("Can't create $destPath");
-        }
-        if (!is_dir($destPath)) {
-            die("$destPath isn't a directory");
-        }
-
-        $db = new DatabaseConnector($webroot);
-
-        foreach ($db->getTables() as $table) {
-            $filename = $destPath . '/' . $table . '.csv';
-            echo $filename . "...\n";
-            touch($filename);
-            $writer = new CsvTableWriter($filename);
-            $db->saveTable($table, $writer);
-        }
-        echo "Done!";
-    }
-
-    public function loadCsv($args)
-    {
-        $args->requireUnnamed(array('input-path', 'webroot'));
-        $unnamedArgs = $args->getUnnamedArgs();
-
-        $srcPath = $unnamedArgs[0];
-        $webroot = $unnamedArgs[1];
-
-        if (!is_dir($srcPath)) {
-            die("$srcPath isn't a directory");
-        }
-
-        $db = new DatabaseConnector($webroot);
-
-        foreach ($db->getTables() as $table) {
-            $filename = $srcPath . '/' . $table . '.csv';
-            if (file_exists($filename)) {
-                echo $filename . "...\n";
-                $reader = new CsvTableReader($filename);
-                $db->loadTable($table, $reader);
-            } else {
-                echo "$filename doesn't exist; skipping.\n";
-            }
-        }
-        echo "Done!";
-    }
-    /**
-     * Save a .sspak.phar file
-     */
-    public function save($args)
-    {
-        $executor = $this->executor;
-
-        $args->requireUnnamed(array('source webroot', 'dest sspak file'));
-
-        $unnamedArgs = $args->getUnnamedArgs();
-        $namedArgs = $args->getNamedArgs();
-
-        $webroot = new Webroot($unnamedArgs[0], $executor);
-        $file = $unnamedArgs[1];
-        if (file_exists($file)) {
-            throw new Exception("File '$file' already exists.");
-        }
-
-        $sspak = new SSPakFile($file, $executor);
-
-        if (!empty($namedArgs['identity'])) {
-            // SSH private key
-            $webroot->setSSHItentityFile($namedArgs['identity']);
-        }
-        if (!empty($namedArgs['from-sudo'])) {
-            $webroot->setSudo($namedArgs['from-sudo']);
-        } elseif (!empty($namedArgs['sudo'])) {
-            $webroot->setSudo($namedArgs['sudo']);
-        }
-
-        // Look up which parts of the sspak are going to be saved
-        $pakParts = $args->pakParts();
-
-        // Get the environment details
-        $details = $webroot->sniff();
-
-        // Create a build folder for the sspak file
-        $buildFolder = sprintf("%s/sspak-%d", sys_get_temp_dir(), rand(100000, 999999));
-        $webroot->exec(array('mkdir', $buildFolder));
-
-        $dbFile = "$buildFolder/database.sql.gz";
-        $assetsFile = "$buildFolder/assets.tar.gz";
-        $gitRemoteFile = "$buildFolder/git-remote";
-
-        // Files to include in the .sspak.phar file
-        $fileList = array();
-
-        // Save DB
-        if ($pakParts['db']) {
-            // Check the database type
-            $dbFunction = 'getdb_'.$details['db_type'];
-            if (!method_exists($this, $dbFunction)) {
-                throw new Exception("Can't process database type '" . $details['db_type'] . "'");
-            }
-            $this->$dbFunction($webroot, $details, $sspak, basename($dbFile));
-        }
-
-        // Save Assets
-        if ($pakParts['assets']) {
-            $this->getassets($webroot, $details['assets_path'], $sspak, basename($assetsFile));
-        }
-
-        // Save git-remote
-        if ($pakParts['git-remote']) {
-            $this->getgitremote($webroot, $sspak, basename($gitRemoteFile));
-        }
-
-        // Remove the build folder
-        $webroot->unlink($buildFolder);
-    }
-
-    public function getdb_MySQLPDODatabase($webroot, $conf, $sspak, $filename)
-    {
-        return $this->getdb_MySQLDatabase($webroot, $conf, $sspak, $filename);
-    }
-
-    public function getdb_MySQLDatabase($webroot, $conf, $sspak, $filename)
-    {
-        $usernameArg = escapeshellarg("--user=".$conf['db_username']);
-        $passwordArg = escapeshellarg("--password=".$conf['db_password']);
-        $databaseArg = escapeshellarg($conf['db_database']);
-
-        $hostArg = '';
-        $portArg = '';
-        if (!empty($conf['db_server']) && $conf['db_server'] != 'localhost') {
-            if (strpos($conf['db_server'], ':')!==false) {
-                // Handle "server:port" format.
-                $server = explode(':', $conf['db_server'], 2);
-                $hostArg = escapeshellarg("--host=".$server[0]);
-                $portArg = escapeshellarg("--port=".$server[1]);
-            } else {
-                $hostArg = escapeshellarg("--host=".$conf['db_server']);
-            }
-        }
-
-        $filenameArg = escapeshellarg($filename);
-
-        $process = $webroot->createProcess(
-            "mysqldump --no-tablespaces --skip-opt --add-drop-table --extended-insert --create-options --quick " .
-            "--set-charset --default-character-set=utf8 --column-statistics=0 $usernameArg $passwordArg $hostArg " .
-            "$portArg $databaseArg | gzip -c"
-        );
-        $sspak->writeFileFromProcess($filename, $process);
-        return true;
-    }
-
-    public function getdb_PostgreSQLDatabase($webroot, $conf, $sspak, $filename)
-    {
-        $usernameArg = escapeshellarg("--username=".$conf['db_username']);
-        $passwordArg = "PGPASSWORD=".escapeshellarg($conf['db_password']);
-        $databaseArg = escapeshellarg($conf['db_database']);
-        $hostArg = escapeshellarg("--host=".$conf['db_server']);
-        $filenameArg = escapeshellarg($filename);
-
-        $process = $webroot->createProcess(
-            "$passwordArg pg_dump --clean --no-owner --no-tablespaces $usernameArg $hostArg $databaseArg | gzip -c"
-        );
-        $sspak->writeFileFromProcess($filename, $process);
-        return true;
-    }
-
-    public function getassets($webroot, $assetsPath, $sspak, $filename)
-    {
-        $assetsParentArg = escapeshellarg(dirname($assetsPath));
-        $assetsBaseArg = escapeshellarg(basename($assetsPath));
-
-        $process = $webroot->createProcess("cd $assetsParentArg && tar cfh - $assetsBaseArg | gzip -c");
-        $sspak->writeFileFromProcess($filename, $process);
-    }
-
-    public function getgitremote($webroot, $sspak, $gitRemoteFile)
-    {
-        // Only do anything if we're copying from a git checkout
-        $gitRepo = $webroot->getPath() .'/.git';
-        if ($webroot->exists($gitRepo)) {
-            // Identify current branch
-            $output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'branch'));
-            if (preg_match("/\* ([^ \n]*)/", $output['output'], $matches) &&
-                strpos("(no branch)", $matches[1])===false
-            ) {
-                // If there is a current branch, use that branch's remove
-                $currentBranch = trim($matches[1]);
-                $output = $webroot->exec(
-                    array('git', '--git-dir='.$gitRepo, 'config','--get',"branch.$currentBranch.remote")
-                );
-                $remoteName = trim($output['output']);
-                if (!$remoteName) {
-                    $remoteName = 'origin';
-                }
-
-            // Default to origin
-            } else {
-                $currentBranch = null;
-                $remoteName = 'origin';
-            }
-
-            // Determine the URL of that remote
-            $output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'config','--get',"remote.$remoteName.url"));
-            $remoteURL = trim($output['output']);
-
-            // Determine the current SHA
-            $output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'log','-1','--format=%H'));
-            $sha = trim($output['output']);
-
-            $content = "remote = $remoteURL\nbranch = $currentBranch\nsha = $sha\n";
-
-            $sspak->writeFile($gitRemoteFile, $content);
-
-            return true;
-        }
-        return false;
-    }
-
-    /**
-     * Load an .sspak into an environment.
-     * Does not backup - be careful! */
-    public function load($args)
-    {
-        $executor = $this->executor;
-
-        $args->requireUnnamed(array('source sspak file'));
-
-        // Set-up
-        $file = $args->unnamed(0);
-        $sspak = new SSPakFile($file, $executor);
-        $webroot = new Webroot(($args->unnamed(1) ?: '.'), $executor);
-        $webroot->setSudo($args->sudo('to'));
-        $pakParts = $args->pakParts();
-
-        $namedArgs = $args->getNamedArgs();
-        if (!empty($namedArgs['identity'])) {
-            // SSH private key
-            $webroot->setSSHItentityFile($namedArgs['identity']);
-        }
-
-        // Validation
-        if (!$sspak->exists()) {
-            throw new Exception("File '$file' doesn't exist.");
-        }
-
-        // Push database, if necessary
-        $namedArgs = $args->getNamedArgs();
-        if ($pakParts['db'] && $sspak->contains('database.sql.gz')) {
-            $webroot->putdb($sspak, isset($namedArgs['drop-db']));
-        }
-
-        // Push assets, if neccessary
-        if ($pakParts['assets'] && $sspak->contains('assets.tar.gz')) {
-            $webroot->putassets($sspak);
-        }
-    }
-
-    /**
-     * Install an .sspak into a new environment.
-     */
-    public function install($args)
-    {
-        $executor = $this->executor;
-
-        $args->requireUnnamed(array('source sspak file', 'dest new webroot'));
-
-        // Set-up
-        $file = $args->unnamed(0);
-        $webrootDir = $args->unnamed(1);
-        $sspak = new SSPakFile($file, $executor);
-        $webroot = new Webroot($webrootDir, $executor);
-        $webroot->setSudo($args->sudo('to'));
-        $pakParts = $args->pakParts();
-
-        // Validation
-        if ($webroot->exists($webroot->getPath())) {
-            throw new Exception("Webroot '$webrootDir' already exists.");
-        }
-        if (!$sspak->exists()) {
-            throw new Exception("File '$file' doesn't exist.");
-        }
-
-        // Create new dir
-        $webroot->exec(array('mkdir', $webroot->getPath()));
-
-        if ($sspak->contains('git-remote')) {
-            $details = $sspak->gitRemoteDetails();
-            $webroot->putgit($details);
-        }
-
-        // TODO: composer install needed.
-
-        // Push database, if necessary
-        $namedArgs = $args->getNamedArgs();
-        if ($pakParts['db'] && $sspak->contains('database.sql.gz')) {
-            $webroot->putdb($sspak, isset($namedArgs['drop-db']));
-        }
-
-        // Push assets, if neccessary
-        if ($pakParts['assets'] && $sspak->contains('assets.tar.gz')) {
-            $webroot->putassets($sspak);
-        }
-    }
-
-    /**
-     * Bundle a .sspak into a self-extracting executable installer.
-     */
-    public function bundle($args)
-    {
-        // TODO: throws require_once errors, fix before re-enabling.
-
-        $executor = $this->executor;
-
-        $args->requireUnnamed(array('source sspak file', 'dest executable file'));
-
-        // Set-up
-        $sourceFile = $args->unnamed(0);
-        $destFile = $args->unnamed(1);
-
-        $sspakScript = file_get_contents($_SERVER['argv'][0]);
-        // Broken up to not get detected by our sed command
-        $sspakScript .= "\n__halt_compiler();\n"."//"." TAR START?>\n";
-
-        // Mark as self-extracting
-        $sspakScript = str_replace('$isSelfExtracting = false;', '$isSelfExtracting = true;', $sspakScript);
-
-        // Load the sniffer file
-        $snifferFile = dirname(__FILE__) . '/sspak-sniffer.php';
-        $sspakScript = str_replace(
-            "\$snifferFileContent = '';\n",
-            "\$snifferFileContent = '"
-            . str_replace(array("\\","'"), array("\\\\", "\\'"), file_get_contents($snifferFile)) . "';\n",
-            $sspakScript
-        );
-
-        file_put_contents($destFile, $sspakScript);
-        chmod($destFile, 0775);
-
-        $executor->execLocal(array('cat', $sourceFile), array(
-            'outputFile' => $destFile,
-            'outputFileAppend' => true
-        ));
-    }
-
-    /**
-     * Transfer between environments without creating an sspak file
-     */
-    public function transfer($args)
-    {
-        echo "Not implemented yet.\n";
-    }
+			printf($msg, $file);
+			die(1);
+		}
+
+		$sspak = new SSPakFile($file, $executor);
+
+		// Validation
+		if (!$sspak->exists()) {
+			throw new Exception("File '$file' doesn't exist.");
+		}
+
+		$phar = $sspak->getPhar();
+		$phar->extractTo($dest);
+	}
+
+	public function listTables($args)
+	{
+		$args->requireUnnamed(array('webroot'));
+		$unnamedArgs = $args->getUnnamedArgs();
+		$webroot = $unnamedArgs[0];
+
+		$db = new DatabaseConnector($webroot);
+
+		print_r($db->getTables());
+	}
+
+	public function saveCsv($args)
+	{
+		$args->requireUnnamed(array('webroot', 'path'));
+		$unnamedArgs = $args->getUnnamedArgs();
+		$webroot = $unnamedArgs[0];
+		$destPath = $unnamedArgs[1];
+
+		if (!file_exists($destPath)) {
+			mkdir($destPath) || die("Can't create $destPath");
+		}
+		if (!is_dir($destPath)) {
+			die("$destPath isn't a directory");
+		}
+
+		$db = new DatabaseConnector($webroot);
+
+		foreach ($db->getTables() as $table) {
+			$filename = $destPath . '/' . $table . '.csv';
+			echo $filename . "...\n";
+			touch($filename);
+			$writer = new CsvTableWriter($filename);
+			$db->saveTable($table, $writer);
+		}
+		echo "Done!";
+	}
+
+	public function loadCsv($args)
+	{
+		$args->requireUnnamed(array('input-path', 'webroot'));
+		$unnamedArgs = $args->getUnnamedArgs();
+
+		$srcPath = $unnamedArgs[0];
+		$webroot = $unnamedArgs[1];
+
+		if (!is_dir($srcPath)) {
+			die("$srcPath isn't a directory");
+		}
+
+		$db = new DatabaseConnector($webroot);
+
+		foreach ($db->getTables() as $table) {
+			$filename = $srcPath . '/' . $table . '.csv';
+			if (file_exists($filename)) {
+				echo $filename . "...\n";
+				$reader = new CsvTableReader($filename);
+				$db->loadTable($table, $reader);
+			} else {
+				echo "$filename doesn't exist; skipping.\n";
+			}
+		}
+		echo "Done!";
+	}
+	/**
+	 * Save a .sspak.phar file
+	 */
+	public function save($args)
+	{
+		$executor = $this->executor;
+
+		$args->requireUnnamed(array('source webroot', 'dest sspak file'));
+
+		$unnamedArgs = $args->getUnnamedArgs();
+		$namedArgs = $args->getNamedArgs();
+
+		$webroot = new Webroot($unnamedArgs[0], $executor);
+		$file = $unnamedArgs[1];
+		if (file_exists($file)) {
+			throw new Exception("File '$file' already exists.");
+		}
+
+		$sspak = new SSPakFile($file, $executor);
+
+		if (!empty($namedArgs['identity'])) {
+			// SSH private key
+			$webroot->setSSHItentityFile($namedArgs['identity']);
+		}
+		if (!empty($namedArgs['from-sudo'])) {
+			$webroot->setSudo($namedArgs['from-sudo']);
+		} elseif (!empty($namedArgs['sudo'])) {
+			$webroot->setSudo($namedArgs['sudo']);
+		}
+
+		// Look up which parts of the sspak are going to be saved
+		$pakParts = $args->pakParts();
+
+		// Get the environment details
+		$details = $webroot->sniff();
+
+		// Create a build folder for the sspak file
+		$buildFolder = sprintf("%s/sspak-%d", sys_get_temp_dir(), rand(100000, 999999));
+		$webroot->exec(array('mkdir', $buildFolder));
+
+		$dbFile = "$buildFolder/database.sql.gz";
+		$assetsFile = "$buildFolder/assets.tar.gz";
+		$gitRemoteFile = "$buildFolder/git-remote";
+
+		// Files to include in the .sspak.phar file
+		$fileList = array();
+
+		// Save DB
+		if ($pakParts['db']) {
+			// Check the database type
+			$dbFunction = 'getdb_'.$details['db_type'];
+			if (!method_exists($this, $dbFunction)) {
+				throw new Exception("Can't process database type '" . $details['db_type'] . "'");
+			}
+			$this->$dbFunction($webroot, $details, $sspak, basename($dbFile));
+		}
+
+		// Save Assets
+		if ($pakParts['assets']) {
+			$this->getassets($webroot, $details['assets_path'], $sspak, basename($assetsFile));
+		}
+
+		// Save git-remote
+		if ($pakParts['git-remote']) {
+			$this->getgitremote($webroot, $sspak, basename($gitRemoteFile));
+		}
+
+		// Remove the build folder
+		$webroot->unlink($buildFolder);
+	}
+
+	public function getdb_MySQLPDODatabase($webroot, $conf, $sspak, $filename)
+	{
+		return $this->getdb_MySQLDatabase($webroot, $conf, $sspak, $filename);
+	}
+
+	public function getdb_MySQLDatabase($webroot, $conf, $sspak, $filename)
+	{
+		$usernameArg = escapeshellarg("--user=".$conf['db_username']);
+		$passwordArg = escapeshellarg("--password=".$conf['db_password']);
+		$databaseArg = escapeshellarg($conf['db_database']);
+
+		$hostArg = '';
+		$portArg = '';
+		if (!empty($conf['db_server']) && $conf['db_server'] != 'localhost') {
+			if (strpos($conf['db_server'], ':')!==false) {
+				// Handle "server:port" format.
+				$server = explode(':', $conf['db_server'], 2);
+				$hostArg = escapeshellarg("--host=".$server[0]);
+				$portArg = escapeshellarg("--port=".$server[1]);
+			} else {
+				$hostArg = escapeshellarg("--host=".$conf['db_server']);
+			}
+		}
+
+		$filenameArg = escapeshellarg($filename);
+
+		$process = $webroot->createProcess(
+			"mysqldump --no-tablespaces --skip-opt --add-drop-table --extended-insert --create-options --quick " .
+			"--set-charset --default-character-set=utf8 --column-statistics=0 $usernameArg $passwordArg $hostArg " .
+			"$portArg $databaseArg | gzip -c"
+		);
+		$sspak->writeFileFromProcess($filename, $process);
+		return true;
+	}
+
+	public function getdb_PostgreSQLDatabase($webroot, $conf, $sspak, $filename)
+	{
+		$usernameArg = escapeshellarg("--username=".$conf['db_username']);
+		$passwordArg = "PGPASSWORD=".escapeshellarg($conf['db_password']);
+		$databaseArg = escapeshellarg($conf['db_database']);
+		$hostArg = escapeshellarg("--host=".$conf['db_server']);
+		$filenameArg = escapeshellarg($filename);
+
+		$process = $webroot->createProcess(
+			"$passwordArg pg_dump --clean --no-owner --no-tablespaces $usernameArg $hostArg $databaseArg | gzip -c"
+		);
+		$sspak->writeFileFromProcess($filename, $process);
+		return true;
+	}
+
+	public function getassets($webroot, $assetsPath, $sspak, $filename)
+	{
+		$assetsParentArg = escapeshellarg(dirname($assetsPath));
+		$assetsBaseArg = escapeshellarg(basename($assetsPath));
+
+		$process = $webroot->createProcess("cd $assetsParentArg && tar cfh - $assetsBaseArg | gzip -c");
+		$sspak->writeFileFromProcess($filename, $process);
+	}
+
+	public function getgitremote($webroot, $sspak, $gitRemoteFile)
+	{
+		// Only do anything if we're copying from a git checkout
+		$gitRepo = $webroot->getPath() .'/.git';
+		if ($webroot->exists($gitRepo)) {
+			// Identify current branch
+			$output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'branch'));
+			if (preg_match("/\* ([^ \n]*)/", $output['output'], $matches) &&
+				strpos("(no branch)", $matches[1])===false
+			) {
+				// If there is a current branch, use that branch's remove
+				$currentBranch = trim($matches[1]);
+				$output = $webroot->exec(
+					array('git', '--git-dir='.$gitRepo, 'config','--get',"branch.$currentBranch.remote")
+				);
+				$remoteName = trim($output['output']);
+				if (!$remoteName) {
+					$remoteName = 'origin';
+				}
+
+			// Default to origin
+			} else {
+				$currentBranch = null;
+				$remoteName = 'origin';
+			}
+
+			// Determine the URL of that remote
+			$output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'config','--get',"remote.$remoteName.url"));
+			$remoteURL = trim($output['output']);
+
+			// Determine the current SHA
+			$output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'log','-1','--format=%H'));
+			$sha = trim($output['output']);
+
+			$content = "remote = $remoteURL\nbranch = $currentBranch\nsha = $sha\n";
+
+			$sspak->writeFile($gitRemoteFile, $content);
+
+			return true;
+		}
+		return false;
+	}
+
+	/**
+	 * Load an .sspak into an environment.
+	 * Does not backup - be careful! */
+	public function load($args)
+	{
+		$executor = $this->executor;
+
+		$args->requireUnnamed(array('source sspak file'));
+
+		// Set-up
+		$file = $args->unnamed(0);
+		$sspak = new SSPakFile($file, $executor);
+		$webroot = new Webroot(($args->unnamed(1) ?: '.'), $executor);
+		$webroot->setSudo($args->sudo('to'));
+		$pakParts = $args->pakParts();
+
+		$namedArgs = $args->getNamedArgs();
+		if (!empty($namedArgs['identity'])) {
+			// SSH private key
+			$webroot->setSSHItentityFile($namedArgs['identity']);
+		}
+
+		// Validation
+		if (!$sspak->exists()) {
+			throw new Exception("File '$file' doesn't exist.");
+		}
+
+		// Push database, if necessary
+		$namedArgs = $args->getNamedArgs();
+		if ($pakParts['db'] && $sspak->contains('database.sql.gz')) {
+			$webroot->putdb($sspak, isset($namedArgs['drop-db']));
+		}
+
+		// Push assets, if neccessary
+		if ($pakParts['assets'] && $sspak->contains('assets.tar.gz')) {
+			$webroot->putassets($sspak);
+		}
+	}
+
+	/**
+	 * Install an .sspak into a new environment.
+	 */
+	public function install($args)
+	{
+		$executor = $this->executor;
+
+		$args->requireUnnamed(array('source sspak file', 'dest new webroot'));
+
+		// Set-up
+		$file = $args->unnamed(0);
+		$webrootDir = $args->unnamed(1);
+		$sspak = new SSPakFile($file, $executor);
+		$webroot = new Webroot($webrootDir, $executor);
+		$webroot->setSudo($args->sudo('to'));
+		$pakParts = $args->pakParts();
+
+		// Validation
+		if ($webroot->exists($webroot->getPath())) {
+			throw new Exception("Webroot '$webrootDir' already exists.");
+		}
+		if (!$sspak->exists()) {
+			throw new Exception("File '$file' doesn't exist.");
+		}
+
+		// Create new dir
+		$webroot->exec(array('mkdir', $webroot->getPath()));
+
+		if ($sspak->contains('git-remote')) {
+			$details = $sspak->gitRemoteDetails();
+			$webroot->putgit($details);
+		}
+
+		// TODO: composer install needed.
+
+		// Push database, if necessary
+		$namedArgs = $args->getNamedArgs();
+		if ($pakParts['db'] && $sspak->contains('database.sql.gz')) {
+			$webroot->putdb($sspak, isset($namedArgs['drop-db']));
+		}
+
+		// Push assets, if neccessary
+		if ($pakParts['assets'] && $sspak->contains('assets.tar.gz')) {
+			$webroot->putassets($sspak);
+		}
+	}
+
+	/**
+	 * Bundle a .sspak into a self-extracting executable installer.
+	 */
+	public function bundle($args)
+	{
+		// TODO: throws require_once errors, fix before re-enabling.
+
+		$executor = $this->executor;
+
+		$args->requireUnnamed(array('source sspak file', 'dest executable file'));
+
+		// Set-up
+		$sourceFile = $args->unnamed(0);
+		$destFile = $args->unnamed(1);
+
+		$sspakScript = file_get_contents($_SERVER['argv'][0]);
+		// Broken up to not get detected by our sed command
+		$sspakScript .= "\n__halt_compiler();\n"."//"." TAR START?>\n";
+
+		// Mark as self-extracting
+		$sspakScript = str_replace('$isSelfExtracting = false;', '$isSelfExtracting = true;', $sspakScript);
+
+		// Load the sniffer file
+		$snifferFile = dirname(__FILE__) . '/sspak-sniffer.php';
+		$sspakScript = str_replace(
+			"\$snifferFileContent = '';\n",
+			"\$snifferFileContent = '"
+			. str_replace(array("\\","'"), array("\\\\", "\\'"), file_get_contents($snifferFile)) . "';\n",
+			$sspakScript
+		);
+
+		file_put_contents($destFile, $sspakScript);
+		chmod($destFile, 0775);
+
+		$executor->execLocal(array('cat', $sourceFile), array(
+			'outputFile' => $destFile,
+			'outputFileAppend' => true
+		));
+	}
+
+	/**
+	 * Transfer between environments without creating an sspak file
+	 */
+	public function transfer($args)
+	{
+		echo "Not implemented yet.\n";
+	}
 }

Spacing +18 added lines, -18 removed lines

@@ -45,14 +45,14 @@ 
                 "method" => "load",
             ),
             "saveexisting" => array(
-                "description" => "Create an .sspak file from database SQL dump and/or assets. " .
+                "description" => "Create an .sspak file from database SQL dump and/or assets. ".
                 "Does not require a SilverStripe site.",
                 "unnamedArgs" => array("sspak file"),
                 "namedArgs" => array("db", "assets"),
                 "method" => "saveexisting"
             ),
             "extract" => array(
-                "description" => "Extract an .sspak file into the current working directory. Does not require a " .
+                "description" => "Extract an .sspak file into the current working directory. Does not require a ".
                  "SilverStripe site.",
                 "unnamedArgs" => array("sspak file", "destination path"),
                 "method" => "extract"
@@ -173,7 +173,7 @@ 
         // from other formats.
         // There is no cross-platform way of checking the assets.tar.gz size without unpacking, so we assume the size
         // of database is negligible which lets us approximate the size of assets.
-        if (filesize($file) > 8*1024*1024*1024) {
+        if (filesize($file) > 8 * 1024 * 1024 * 1024) {
             $msg = <<<EOM
 
 ERROR: SSPak is unable to extract archives over 8 GB.
@@ -230,8 +230,8 @@ 
         $db = new DatabaseConnector($webroot);
 
         foreach ($db->getTables() as $table) {
-            $filename = $destPath . '/' . $table . '.csv';
-            echo $filename . "...\n";
+            $filename = $destPath.'/'.$table.'.csv';
+            echo $filename."...\n";
             touch($filename);
             $writer = new CsvTableWriter($filename);
             $db->saveTable($table, $writer);
@@ -254,9 +254,9 @@ 
         $db = new DatabaseConnector($webroot);
 
         foreach ($db->getTables() as $table) {
-            $filename = $srcPath . '/' . $table . '.csv';
+            $filename = $srcPath.'/'.$table.'.csv';
             if (file_exists($filename)) {
-                echo $filename . "...\n";
+                echo $filename."...\n";
                 $reader = new CsvTableReader($filename);
                 $db->loadTable($table, $reader);
             } else {
@@ -317,7 +317,7 @@ 
             // Check the database type
             $dbFunction = 'getdb_'.$details['db_type'];
             if (!method_exists($this, $dbFunction)) {
-                throw new Exception("Can't process database type '" . $details['db_type'] . "'");
+                throw new Exception("Can't process database type '".$details['db_type']."'");
             }
             $this->$dbFunction($webroot, $details, $sspak, basename($dbFile));
         }
@@ -350,7 +350,7 @@ 
         $hostArg = '';
         $portArg = '';
         if (!empty($conf['db_server']) && $conf['db_server'] != 'localhost') {
-            if (strpos($conf['db_server'], ':')!==false) {
+            if (strpos($conf['db_server'], ':') !== false) {
                 // Handle "server:port" format.
                 $server = explode(':', $conf['db_server'], 2);
                 $hostArg = escapeshellarg("--host=".$server[0]);
@@ -363,8 +363,8 @@ 
         $filenameArg = escapeshellarg($filename);
 
         $process = $webroot->createProcess(
-            "mysqldump --no-tablespaces --skip-opt --add-drop-table --extended-insert --create-options --quick " .
-            "--set-charset --default-character-set=utf8 --column-statistics=0 $usernameArg $passwordArg $hostArg " .
+            "mysqldump --no-tablespaces --skip-opt --add-drop-table --extended-insert --create-options --quick ".
+            "--set-charset --default-character-set=utf8 --column-statistics=0 $usernameArg $passwordArg $hostArg ".
             "$portArg $databaseArg | gzip -c"
         );
         $sspak->writeFileFromProcess($filename, $process);
@@ -398,17 +398,17 @@ 
     public function getgitremote($webroot, $sspak, $gitRemoteFile)
     {
         // Only do anything if we're copying from a git checkout
-        $gitRepo = $webroot->getPath() .'/.git';
+        $gitRepo = $webroot->getPath().'/.git';
         if ($webroot->exists($gitRepo)) {
             // Identify current branch
             $output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'branch'));
             if (preg_match("/\* ([^ \n]*)/", $output['output'], $matches) &&
-                strpos("(no branch)", $matches[1])===false
+                strpos("(no branch)", $matches[1]) === false
             ) {
                 // If there is a current branch, use that branch's remove
                 $currentBranch = trim($matches[1]);
                 $output = $webroot->exec(
-                    array('git', '--git-dir='.$gitRepo, 'config','--get',"branch.$currentBranch.remote")
+                    array('git', '--git-dir='.$gitRepo, 'config', '--get', "branch.$currentBranch.remote")
                 );
                 $remoteName = trim($output['output']);
                 if (!$remoteName) {
@@ -422,11 +422,11 @@ 
             }
 
             // Determine the URL of that remote
-            $output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'config','--get',"remote.$remoteName.url"));
+            $output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'config', '--get', "remote.$remoteName.url"));
             $remoteURL = trim($output['output']);
 
             // Determine the current SHA
-            $output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'log','-1','--format=%H'));
+            $output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'log', '-1', '--format=%H'));
             $sha = trim($output['output']);
 
             $content = "remote = $remoteURL\nbranch = $currentBranch\nsha = $sha\n";
@@ -547,11 +547,11 @@ 
         $sspakScript = str_replace('$isSelfExtracting = false;', '$isSelfExtracting = true;', $sspakScript);
 
         // Load the sniffer file
-        $snifferFile = dirname(__FILE__) . '/sspak-sniffer.php';
+        $snifferFile = dirname(__FILE__).'/sspak-sniffer.php';
         $sspakScript = str_replace(
             "\$snifferFileContent = '';\n",
             "\$snifferFileContent = '"
-            . str_replace(array("\\","'"), array("\\\\", "\\'"), file_get_contents($snifferFile)) . "';\n",
+            . str_replace(array("\\", "'"), array("\\\\", "\\'"), file_get_contents($snifferFile))."';\n",
             $sspakScript
         );
 

src/SSPakFile.php

Indentation +180 added lines, -180 removed lines

@@ -12,84 +12,84 @@ 
 
 class SSPakFile extends FilesystemEntity
 {
-    protected $phar;
-    protected $pharAlias;
-    protected $pharPath;
-
-    public function __construct($path, $executor, $pharAlias = 'sspak.phar')
-    {
-        parent::__construct($path, $executor);
-        if (!$this->isLocal()) {
-            throw new LogicException("Can't manipulate remote .sspak.phar files, only remote webroots.");
-        }
-
-        $this->pharAlias = $pharAlias;
-        $this->pharPath = $path;
-
-        // Executable Phar version
-        if (substr($path, -5) === '.phar') {
-            $this->phar = new Phar(
-                $path,
-                FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::KEY_AS_FILENAME,
-                $this->pharAlias
-            );
-            if (!file_exists($this->path)) {
-                $this->makeExecutable();
-            }
-
-        // Non-executable Tar version
-        } else {
-            $this->phar = new PharData(
-                $path,
-                FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::KEY_AS_FILENAME,
-                $this->pharAlias
-            );
-        }
-    }
-
-    public function getPhar()
-    {
-        return $this->phar;
-    }
-
-    /**
-     * Add the SSPak executable information into this SSPak file
-     */
-    public function makeExecutable()
-    {
-        if (ini_get('phar.readonly')) {
-            throw new Exception("Please set phar.readonly to false in your php.ini.");
-        }
-
-        passthru("composer install -d " . escapeshellarg(PACKAGE_ROOT) . " --no-dev");
-
-        $root = PACKAGE_ROOT;
-        $srcRoots = [
-            'src/',
-            'vendor/',
-        ];
-
-        // Add the bin file, but strip of the #! exec header.
-        $this->phar['bin/sspak'] = preg_replace(
-            "/^#!\/usr\/bin\/env php\n/",
-            '',
-            file_get_contents($root . "bin/sspak")
-        );
-
-        foreach ($srcRoots as $srcRoot) {
-            foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator($root . $srcRoot)) as $fileObj) {
-                if ($fileObj->isFile()) {
-                    $file = $fileObj->getRealPath();
-
-                    $relativeFile = str_replace($root, '', $file);
-
-                    echo "Adding $relativeFile\n";
-                    $this->phar[$relativeFile] = file_get_contents($file);
-                }
-            }
-        }
-
-        $stub = <<<STUB
+	protected $phar;
+	protected $pharAlias;
+	protected $pharPath;
+
+	public function __construct($path, $executor, $pharAlias = 'sspak.phar')
+	{
+		parent::__construct($path, $executor);
+		if (!$this->isLocal()) {
+			throw new LogicException("Can't manipulate remote .sspak.phar files, only remote webroots.");
+		}
+
+		$this->pharAlias = $pharAlias;
+		$this->pharPath = $path;
+
+		// Executable Phar version
+		if (substr($path, -5) === '.phar') {
+			$this->phar = new Phar(
+				$path,
+				FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::KEY_AS_FILENAME,
+				$this->pharAlias
+			);
+			if (!file_exists($this->path)) {
+				$this->makeExecutable();
+			}
+
+		// Non-executable Tar version
+		} else {
+			$this->phar = new PharData(
+				$path,
+				FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::KEY_AS_FILENAME,
+				$this->pharAlias
+			);
+		}
+	}
+
+	public function getPhar()
+	{
+		return $this->phar;
+	}
+
+	/**
+	 * Add the SSPak executable information into this SSPak file
+	 */
+	public function makeExecutable()
+	{
+		if (ini_get('phar.readonly')) {
+			throw new Exception("Please set phar.readonly to false in your php.ini.");
+		}
+
+		passthru("composer install -d " . escapeshellarg(PACKAGE_ROOT) . " --no-dev");
+
+		$root = PACKAGE_ROOT;
+		$srcRoots = [
+			'src/',
+			'vendor/',
+		];
+
+		// Add the bin file, but strip of the #! exec header.
+		$this->phar['bin/sspak'] = preg_replace(
+			"/^#!\/usr\/bin\/env php\n/",
+			'',
+			file_get_contents($root . "bin/sspak")
+		);
+
+		foreach ($srcRoots as $srcRoot) {
+			foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator($root . $srcRoot)) as $fileObj) {
+				if ($fileObj->isFile()) {
+					$file = $fileObj->getRealPath();
+
+					$relativeFile = str_replace($root, '', $file);
+
+					echo "Adding $relativeFile\n";
+					$this->phar[$relativeFile] = file_get_contents($file);
+				}
+			}
+		}
+
+		$stub = <<<STUB
 #!/usr/bin/env php
 <?php
 define('PACKAGE_ROOT', 'phar://$this->pharAlias/');
@@ -98,106 +98,106 @@ 
 __HALT_COMPILER();
 STUB;
 
-        $this->phar->setStub($stub);
-        chmod($this->path, 0775);
-
-        passthru("composer install -d " . escapeshellarg(PACKAGE_ROOT));
-    }
-
-    /**
-     * Returns true if this sspak file contains the given file.
-     * @param string $file The filename to look for
-     * @return boolean
-     */
-    public function contains($file)
-    {
-        return $this->phar->offsetExists($file);
-    }
-
-    /**
-     * Returns the content of a file from this sspak
-     */
-    public function content($file)
-    {
-        return file_get_contents($this->phar[$file]);
-    }
-
-    /**
-     * Pipe the output of the given process into a file within this SSPak
-     * @param  string $filename The file to create within the SSPak
-     * @param  Process $process  The process to execute and take the output from
-     * @return null
-     */
-    public function writeFileFromProcess($filename, Process $process)
-    {
-        // Non-executable Phars can't have content streamed into them
-        // This means that we need to create a temp file, which is a pain, if that file happens to be a 3GB
-        // asset dump. :-/
-        if ($this->phar instanceof PharData) {
-            $tmpFile = '/tmp/sspak-content-' .rand(100000, 999999);
-            $process->exec(array('outputFile' => $tmpFile));
-            $this->phar->addFile($tmpFile, $filename);
-            unlink($tmpFile);
-
-        // So, where we *can* use write streams, we do so.
-        } else {
-            $stream = $this->writeStreamForFile($filename);
-            $process->exec(array('outputStream' => $stream));
-            fclose($stream);
-        }
-    }
-
-    /**
-     * Return a writeable stream corresponding to the given file within the .sspak
-     * @param  string $filename The name of the file within the .sspak
-     * @return Stream context
-     */
-    public function writeStreamForFile($filename)
-    {
-        return fopen('phar://' . $this->pharAlias . '/' . $filename, 'w');
-    }
-
-    /**
-     * Return a readable stream corresponding to the given file within the .sspak
-     * @param  string $filename The name of the file within the .sspak
-     * @return Stream context
-     */
-    public function readStreamForFile($filename)
-    {
-        // Note: using pharAlias here doesn't work on Debian Wheezy (nor on Windows for that matter).
-        //return fopen('phar://' . $this->pharAlias . '/' . $filename, 'r');
-        return fopen('phar://' . $this->pharPath . '/' . $filename, 'r');
-    }
-
-    /**
-     * Create a file in the .sspak with the given content
-     * @param  string $filename The name of the file within the .sspak
-     * @param  string $content The content of the file
-     * @return null
-     */
-    public function writeFile($filename, $content)
-    {
-        $this->phar[$filename] = $content;
-    }
-
-    /**
-     * Extracts the git remote details and reutrns them as a map
-     */
-    public function gitRemoteDetails()
-    {
-        $content = $this->content('git-remote');
-        $details = array();
-        foreach (explode("\n", trim($content)) as $line) {
-            if (!$line) {
-                continue;
-            }
-
-            if (preg_match('/^([^ ]+) *= *(.*)$/', $line, $matches)) {
-                $details[$matches[1]] = $matches[2];
-            } else {
-                throw new Exception("Bad line '$line'");
-            }
-        }
-        return $details;
-    }
+		$this->phar->setStub($stub);
+		chmod($this->path, 0775);
+
+		passthru("composer install -d " . escapeshellarg(PACKAGE_ROOT));
+	}
+
+	/**
+	 * Returns true if this sspak file contains the given file.
+	 * @param string $file The filename to look for
+	 * @return boolean
+	 */
+	public function contains($file)
+	{
+		return $this->phar->offsetExists($file);
+	}
+
+	/**
+	 * Returns the content of a file from this sspak
+	 */
+	public function content($file)
+	{
+		return file_get_contents($this->phar[$file]);
+	}
+
+	/**
+	 * Pipe the output of the given process into a file within this SSPak
+	 * @param  string $filename The file to create within the SSPak
+	 * @param  Process $process  The process to execute and take the output from
+	 * @return null
+	 */
+	public function writeFileFromProcess($filename, Process $process)
+	{
+		// Non-executable Phars can't have content streamed into them
+		// This means that we need to create a temp file, which is a pain, if that file happens to be a 3GB
+		// asset dump. :-/
+		if ($this->phar instanceof PharData) {
+			$tmpFile = '/tmp/sspak-content-' .rand(100000, 999999);
+			$process->exec(array('outputFile' => $tmpFile));
+			$this->phar->addFile($tmpFile, $filename);
+			unlink($tmpFile);
+
+		// So, where we *can* use write streams, we do so.
+		} else {
+			$stream = $this->writeStreamForFile($filename);
+			$process->exec(array('outputStream' => $stream));
+			fclose($stream);
+		}
+	}
+
+	/**
+	 * Return a writeable stream corresponding to the given file within the .sspak
+	 * @param  string $filename The name of the file within the .sspak
+	 * @return Stream context
+	 */
+	public function writeStreamForFile($filename)
+	{
+		return fopen('phar://' . $this->pharAlias . '/' . $filename, 'w');
+	}
+
+	/**
+	 * Return a readable stream corresponding to the given file within the .sspak
+	 * @param  string $filename The name of the file within the .sspak
+	 * @return Stream context
+	 */
+	public function readStreamForFile($filename)
+	{
+		// Note: using pharAlias here doesn't work on Debian Wheezy (nor on Windows for that matter).
+		//return fopen('phar://' . $this->pharAlias . '/' . $filename, 'r');
+		return fopen('phar://' . $this->pharPath . '/' . $filename, 'r');
+	}
+
+	/**
+	 * Create a file in the .sspak with the given content
+	 * @param  string $filename The name of the file within the .sspak
+	 * @param  string $content The content of the file
+	 * @return null
+	 */
+	public function writeFile($filename, $content)
+	{
+		$this->phar[$filename] = $content;
+	}
+
+	/**
+	 * Extracts the git remote details and reutrns them as a map
+	 */
+	public function gitRemoteDetails()
+	{
+		$content = $this->content('git-remote');
+		$details = array();
+		foreach (explode("\n", trim($content)) as $line) {
+			if (!$line) {
+				continue;
+			}
+
+			if (preg_match('/^([^ ]+) *= *(.*)$/', $line, $matches)) {
+				$details[$matches[1]] = $matches[2];
+			} else {
+				throw new Exception("Bad line '$line'");
+			}
+		}
+		return $details;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -61,7 +61,7 @@ 
             throw new Exception("Please set phar.readonly to false in your php.ini.");
         }
 
-        passthru("composer install -d " . escapeshellarg(PACKAGE_ROOT) . " --no-dev");
+        passthru("composer install -d ".escapeshellarg(PACKAGE_ROOT)." --no-dev");
 
         $root = PACKAGE_ROOT;
         $srcRoots = [
@@ -73,11 +73,11 @@ 
         $this->phar['bin/sspak'] = preg_replace(
             "/^#!\/usr\/bin\/env php\n/",
             '',
-            file_get_contents($root . "bin/sspak")
+            file_get_contents($root."bin/sspak")
         );
 
         foreach ($srcRoots as $srcRoot) {
-            foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator($root . $srcRoot)) as $fileObj) {
+            foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator($root.$srcRoot)) as $fileObj) {
                 if ($fileObj->isFile()) {
                     $file = $fileObj->getRealPath();
 
@@ -101,7 +101,7 @@ 
         $this->phar->setStub($stub);
         chmod($this->path, 0775);
 
-        passthru("composer install -d " . escapeshellarg(PACKAGE_ROOT));
+        passthru("composer install -d ".escapeshellarg(PACKAGE_ROOT));
     }
 
     /**
@@ -134,7 +134,7 @@ 
         // This means that we need to create a temp file, which is a pain, if that file happens to be a 3GB
         // asset dump. :-/
         if ($this->phar instanceof PharData) {
-            $tmpFile = '/tmp/sspak-content-' .rand(100000, 999999);
+            $tmpFile = '/tmp/sspak-content-'.rand(100000, 999999);
             $process->exec(array('outputFile' => $tmpFile));
             $this->phar->addFile($tmpFile, $filename);
             unlink($tmpFile);
@@ -154,7 +154,7 @@ 
      */
     public function writeStreamForFile($filename)
     {
-        return fopen('phar://' . $this->pharAlias . '/' . $filename, 'w');
+        return fopen('phar://'.$this->pharAlias.'/'.$filename, 'w');
     }
 
     /**
@@ -166,7 +166,7 @@ 
     {
         // Note: using pharAlias here doesn't work on Debian Wheezy (nor on Windows for that matter).
         //return fopen('phar://' . $this->pharAlias . '/' . $filename, 'r');
-        return fopen('phar://' . $this->pharPath . '/' . $filename, 'r');
+        return fopen('phar://'.$this->pharPath.'/'.$filename, 'r');
     }
 
     /**

src/Executor.php

Indentation +53 added lines, -53 removed lines

@@ -9,63 +9,63 @@
  */
 class Executor
 {
-    protected $defaultOptions = array(
-        'throwException' => true,
-        'inputContent' => null,
-        'inputFile' => null,
-        'inputStream' => null,
-        'outputFile' => null,
-        'outputFileAppend' => false,
-        'outputStream' => null,
-    );
+	protected $defaultOptions = array(
+		'throwException' => true,
+		'inputContent' => null,
+		'inputFile' => null,
+		'inputStream' => null,
+		'outputFile' => null,
+		'outputFileAppend' => false,
+		'outputStream' => null,
+	);
 
-    /**
-     * @param string $command The command
-     * @param boolean $throwException If true, an Exception will be thrown on a nonzero error code
-     * @param boolean $returnOutput If true, output will be captured
-     * @param boolean $inputContent Content for STDIN. Otherwise the parent script's STDIN is used
-     * @return A map containing 'return', 'output', and 'error'
-     */
-    public function execLocal($command, $options = array())
-    {
-        $process = $this->createLocal($command, $options);
-        return $process->exec();
-    }
+	/**
+	 * @param string $command The command
+	 * @param boolean $throwException If true, an Exception will be thrown on a nonzero error code
+	 * @param boolean $returnOutput If true, output will be captured
+	 * @param boolean $inputContent Content for STDIN. Otherwise the parent script's STDIN is used
+	 * @return A map containing 'return', 'output', and 'error'
+	 */
+	public function execLocal($command, $options = array())
+	{
+		$process = $this->createLocal($command, $options);
+		return $process->exec();
+	}
 
-    public function execRemote($command, $options = array())
-    {
-        $process = $this->createRemote($command, $options);
-        return $process->exec();
-    }
+	public function execRemote($command, $options = array())
+	{
+		$process = $this->createRemote($command, $options);
+		return $process->exec();
+	}
 
-    public function createLocal($command, $options)
-    {
-        $options = array_merge($this->defaultOptions, $options);
-        if (is_array($command)) {
-            $command = $this->commandArrayToString($command);
-        }
+	public function createLocal($command, $options)
+	{
+		$options = array_merge($this->defaultOptions, $options);
+		if (is_array($command)) {
+			$command = $this->commandArrayToString($command);
+		}
 
-        return new Process($command, $options);
-    }
+		return new Process($command, $options);
+	}
 
-    public function createRemote($server, $command, $options = array())
-    {
-        $process = $this->createLocal($command, $options);
-        $process->setRemoteServer($server);
-        return $process;
-    }
+	public function createRemote($server, $command, $options = array())
+	{
+		$process = $this->createLocal($command, $options);
+		$process->setRemoteServer($server);
+		return $process;
+	}
 
-    /**
-     * Turn an array command in a string, escaping and concatenating each item
-     * @param array $command Command array. First element is the command and all remaining are the arguments.
-     * @return string String command
-     */
-    public function commandArrayToString($command)
-    {
-        $string = escapeshellcmd(array_shift($command));
-        foreach ($command as $arg) {
-            $string .= ' ' . escapeshellarg($arg);
-        }
-        return $string;
-    }
+	/**
+	 * Turn an array command in a string, escaping and concatenating each item
+	 * @param array $command Command array. First element is the command and all remaining are the arguments.
+	 * @return string String command
+	 */
+	public function commandArrayToString($command)
+	{
+		$string = escapeshellcmd(array_shift($command));
+		foreach ($command as $arg) {
+			$string .= ' ' . escapeshellarg($arg);
+		}
+		return $string;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
     {
         $string = escapeshellcmd(array_shift($command));
         foreach ($command as $arg) {
-            $string .= ' ' . escapeshellarg($arg);
+            $string .= ' '.escapeshellarg($arg);
         }
         return $string;
     }

src/sspak-sniffer.php

Indentation +21 added lines, -21 removed lines

@@ -8,48 +8,48 @@
 
 // Argument parsing
 if (empty($_SERVER['argv'][1])) {
-    echo "Usage: {$_SERVER['argv'][0]} (site-docroot)\n";
-    exit(1);
+	echo "Usage: {$_SERVER['argv'][0]} (site-docroot)\n";
+	exit(1);
 }
 
 $basePath = $_SERVER['argv'][1];
 if ($basePath[0] != '/') {
-    $basePath = getcwd() . '/' . $basePath;
+	$basePath = getcwd() . '/' . $basePath;
 }
 
 // SilverStripe bootstrap
 define('BASE_PATH', realpath($basePath));
 if (!defined('BASE_URL')) {
-    define('BASE_URL', '/');
+	define('BASE_URL', '/');
 }
 $_SERVER['HTTP_HOST'] = 'localhost';
 chdir(BASE_PATH);
 
 if (file_exists(BASE_PATH.'/sapphire/core/Core.php')) {
-    //SS 2.x
-    require_once(BASE_PATH . '/sapphire/core/Core.php');
+	//SS 2.x
+	require_once(BASE_PATH . '/sapphire/core/Core.php');
 } elseif (file_exists(BASE_PATH.'/framework/core/Core.php')) {
-    //SS 3.x
-    require_once(BASE_PATH. '/framework/core/Core.php');
+	//SS 3.x
+	require_once(BASE_PATH. '/framework/core/Core.php');
 } elseif (file_exists(BASE_PATH.'/vendor/silverstripe/framework')) {
-    //SS 4.x
-    require_once(BASE_PATH. '/vendor/autoload.php');
-    $kernel = new SilverStripe\Core\CoreKernel(BASE_PATH);
-    //boot the parts of the kernel to populate the DB config
-    foreach (array('bootDatabaseEnvVars', 'bootDatabaseGlobals') as $bootMethod) {
-        $reflectedBootMethod = new ReflectionMethod($kernel, $bootMethod);
-        $reflectedBootMethod->setAccessible(true);
-        $reflectedBootMethod->invoke($kernel);
-    }
-    $databaseConfig = SilverStripe\ORM\DB::getConfig();
+	//SS 4.x
+	require_once(BASE_PATH. '/vendor/autoload.php');
+	$kernel = new SilverStripe\Core\CoreKernel(BASE_PATH);
+	//boot the parts of the kernel to populate the DB config
+	foreach (array('bootDatabaseEnvVars', 'bootDatabaseGlobals') as $bootMethod) {
+		$reflectedBootMethod = new ReflectionMethod($kernel, $bootMethod);
+		$reflectedBootMethod->setAccessible(true);
+		$reflectedBootMethod->invoke($kernel);
+	}
+	$databaseConfig = SilverStripe\ORM\DB::getConfig();
 } else {
-    echo "Couldn't locate framework's Core.php. Perhaps " . BASE_PATH . " is not a SilverStripe project?\n";
-    exit(2);
+	echo "Couldn't locate framework's Core.php. Perhaps " . BASE_PATH . " is not a SilverStripe project?\n";
+	exit(2);
 }
 
 $output = array();
 foreach ($databaseConfig as $k => $v) {
-    $output['db_' . $k] = $v;
+	$output['db_' . $k] = $v;
 }
 $output['assets_path'] = ASSETS_PATH;
 

Spacing +6 added lines, -6 removed lines

@@ -14,7 +14,7 @@ 
 
 $basePath = $_SERVER['argv'][1];
 if ($basePath[0] != '/') {
-    $basePath = getcwd() . '/' . $basePath;
+    $basePath = getcwd().'/'.$basePath;
 }
 
 // SilverStripe bootstrap
@@ -27,13 +27,13 @@ 
 
 if (file_exists(BASE_PATH.'/sapphire/core/Core.php')) {
     //SS 2.x
-    require_once(BASE_PATH . '/sapphire/core/Core.php');
+    require_once(BASE_PATH.'/sapphire/core/Core.php');
 } elseif (file_exists(BASE_PATH.'/framework/core/Core.php')) {
     //SS 3.x
-    require_once(BASE_PATH. '/framework/core/Core.php');
+    require_once(BASE_PATH.'/framework/core/Core.php');
 } elseif (file_exists(BASE_PATH.'/vendor/silverstripe/framework')) {
     //SS 4.x
-    require_once(BASE_PATH. '/vendor/autoload.php');
+    require_once(BASE_PATH.'/vendor/autoload.php');
     $kernel = new SilverStripe\Core\CoreKernel(BASE_PATH);
     //boot the parts of the kernel to populate the DB config
     foreach (array('bootDatabaseEnvVars', 'bootDatabaseGlobals') as $bootMethod) {
@@ -43,13 +43,13 @@ 
     }
     $databaseConfig = SilverStripe\ORM\DB::getConfig();
 } else {
-    echo "Couldn't locate framework's Core.php. Perhaps " . BASE_PATH . " is not a SilverStripe project?\n";
+    echo "Couldn't locate framework's Core.php. Perhaps ".BASE_PATH." is not a SilverStripe project?\n";
     exit(2);
 }
 
 $output = array();
 foreach ($databaseConfig as $k => $v) {
-    $output['db_' . $k] = $v;
+    $output['db_'.$k] = $v;
 }
 $output['assets_path'] = ASSETS_PATH;