PHP 8 compatibility (curly brace string access)
[pharext/pharext] / src / pharext / Installer.php
index 7ff112a38c391ae65bd0d36b46a7d176d910c9e6..7cbe5e921b99f7854215f05bcb4d2b2464e1f5d5 100644 (file)
 namespace pharext;
 
 use Phar;
+use SplObjectStorage;
 
 /**
  * The extension install command executed by the extension phar
  */
 class Installer implements Command
 {
-       use CliCommand;
-       
-       /**
-        * The temporary directory we should operate in
-        * @var string
-        */
-       private $tmp;
+       use Cli\Command;
 
        /**
-        * The directory we came from
-        * @var string
+        * Cleanups
+        * @var array
         */
-       private $cwd;
+       private $cleanup = [];
 
        /**
         * Create the command
         */
        public function __construct() {
-               $this->args = new CliArgs([
-                       ["h", "help", "Display help", 
-                               CliArgs::OPTIONAL|CliArgs::SINGLE|CliArgs::NOARG|CliArgs::HALT],
+               $this->args = new Cli\Args([
+                       ["h", "help", "Display help",
+                               Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG|Cli\Args::HALT],
                        ["v", "verbose", "More output",
-                               CliArgs::OPTIONAL|CliArgs::SINGLE|CliArgs::NOARG],
+                               Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG],
                        ["q", "quiet", "Less output",
-                               CliArgs::OPTIONAL|CliArgs::SINGLE|CliArgs::NOARG],
+                               Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG],
                        ["p", "prefix", "PHP installation prefix if phpize is not in \$PATH, e.g. /opt/php7",
-                               CliArgs::OPTIONAL|CliArgs::SINGLE|CliArgs::REQARG],
+                               Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::REQARG],
                        ["n", "common-name", "PHP common program name, e.g. php5 or zts-php",
-                               CliArgs::OPTIONAL|CliArgs::SINGLE|CliArgs::REQARG, 
+                               Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::REQARG,
                                "php"],
                        ["c", "configure", "Additional extension configure flags, e.g. -c --with-flag",
-                               CliArgs::OPTIONAL|CliArgs::MULTI|CliArgs::REQARG],
+                               Cli\Args::OPTIONAL|Cli\Args::MULTI|Cli\Args::REQARG],
                        ["s", "sudo", "Installation might need increased privileges",
-                               CliArgs::OPTIONAL|CliArgs::SINGLE|CliArgs::OPTARG,
-                               "sudo -S %s"]
+                               Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::OPTARG,
+                               "sudo -S %s"],
+                       ["i", "ini", "Activate in this php.ini instead of loaded default php.ini",
+                               Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::REQARG],
+                       [null, "signature", "Show package signature",
+                               Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG|Cli\Args::HALT],
+                       [null, "license", "Show package license",
+                               Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG|Cli\Args::HALT],
+                       [null, "name", "Show package name",
+                               Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG|Cli\Args::HALT],
+                       [null, "date", "Show package release date",
+                               Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG|Cli\Args::HALT],
+                       [null, "release", "Show package release version",
+                               Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG|Cli\Args::HALT],
+                       [null, "version", "Show pharext version",
+                               Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG|Cli\Args::HALT],
                ]);
        }
-       
+
        /**
-        * Cleanup temp directory
+        * Perform cleaniup
         */
-       public function __destruct() {
-               $this->cleanup();
+       function __destruct() {
+               foreach ($this->cleanup as $cleanup) {
+                       $cleanup->run();
+               }
+       }
+
+       private function extract($phar) {
+               $temp = (new Task\Extract($phar))->run($this->verbosity());
+               $this->cleanup[] = new Task\Cleanup($temp);
+               return $temp;
+       }
+
+       private function hooks(SplObjectStorage $phars) {
+               $hook = [];
+               foreach ($phars as $phar) {
+                       if (isset($phar["pharext_package.php"])) {
+                               $sdir = include $phar["pharext_package.php"];
+                               if ($sdir instanceof SourceDir) {
+                                       $this->args->compile($sdir->getArgs());
+                                       $hook[] = $sdir;
+                               }
+                       }
+               }
+               return $hook;
+       }
+
+       private function load() {
+               $list = new SplObjectStorage();
+               $phar = extension_loaded("Phar")
+                       ? new Phar(Phar::running(false))
+                       : new Archive(PHAREXT_PHAR);
+               $temp = $this->extract($phar);
+
+               foreach ($phar as $entry) {
+                       $dep_file = $entry->getBaseName();
+                       if (fnmatch("*.ext.phar*", $dep_file)) {
+                               $dep_phar = extension_loaded("Phar")
+                                       ? new Phar("$temp/$dep_file")
+                                       : new Archive("$temp/$dep_file");
+                               $list[$dep_phar] = $this->extract($dep_phar);
+                       }
+               }
+
+               /* the actual ext.phar at last */
+               $list[$phar] = $temp;
+               return $list;
        }
 
        /**
@@ -59,208 +112,117 @@ class Installer implements Command
         * @see \pharext\Command::run()
         */
        public function run($argc, array $argv) {
-               $this->cwd = getcwd();
-               $this->tmp = $this->tempname(basename(Phar::running(false)));
-
-               $phar = new Phar(Phar::running(false));
-               foreach ($phar as $entry) {
-                       if (fnmatch("*.ext.phar*", $entry->getBaseName())) {
-                               $temp = $this->newtemp($entry->getBaseName());
-                               $phar->extractTo($temp, $entry->getFilename(), true);
-                               $phars[$temp] = new Phar($temp."/".$entry->getFilename());
-                       }
+               try {
+                       /* load the phar(s) */
+                       $list = $this->load();
+                       /* installer hooks */
+                       $hook = $this->hooks($list);
+               } catch (\Exception $e) {
+                       $this->error("%s\n", $e->getMessage());
+                       exit(self::EEXTRACT);
                }
-               $phars[$this->tmp] = $phar;
 
-               foreach ($phars as $phar) {
-                       if (($hook = $phar["pharext_install.php"])) {
-                               $callable = include $phar["pharext_install.php"];
-                               if (is_callable($callable)) {
-                                       $recv[] = $callable($this);
-                               }
-                       }
-               }
-               
+               /* standard arg stuff */
                $errs = [];
                $prog = array_shift($argv);
                foreach ($this->args->parse(--$argc, $argv) as $error) {
                        $errs[] = $error;
                }
-               
+
                if ($this->args["help"]) {
                        $this->header();
                        $this->help($prog);
                        exit;
                }
-               
+               try {
+                       foreach (["signature", "name", "date", "license", "release", "version"] as $opt) {
+                               if ($this->args[$opt]) {
+                                       printf("%s\n", $this->metadata($opt));
+                                       exit;
+                               }
+                       }
+               } catch (\Exception $e) {
+                       $this->error("%s\n", $e->getMessage());
+                       exit(self::EARGS);
+               }
+
                foreach ($this->args->validate() as $error) {
                        $errs[] = $error;
                }
-               
+
                if ($errs) {
                        if (!$this->args["quiet"]) {
                                $this->header();
                        }
                        foreach ($errs as $err) {
                                $this->error("%s\n", $err);
-                       } 
+                       }
                        if (!$this->args["quiet"]) {
                                $this->help($prog);
                        }
-                       exit(1);
-               }
-               
-               if (isset($recv)) {
-                       foreach ($recv as $r) {
-                               $r($this);
-                       }
+                       exit(self::EARGS);
                }
-               foreach ($phars as $temp => $phar) {
-                       $this->installPackage($phar, $temp);
-               }
-       }
 
-       /**
-        * Create a new temp directory
-        * @param string $prefix
-        * @return string
-        */
-       private function newtemp($prefix) {
-               $temp = $this->tempname($prefix);
-               if (!is_dir($temp)) {
-                       if (!mkdir($temp, 0750, true)) {
-                               $this->error(null);
-                               exit(3);
-                       }
-               }
-               return $temp;
-       }
-       
-       /**
-        * Prepares, configures, builds and installs the extension
-        */
-       private function installPackage(Phar $phar, $temp) {
-               $this->info("Installing %s ... \n", basename($phar->getAlias()));
                try {
-                       $phar->extractTo($temp, null, true);
+                       /* post process hooks */
+                       foreach ($hook as $sdir) {
+                               $sdir->setArgs($this->args);
+                       }
                } catch (\Exception $e) {
                        $this->error("%s\n", $e->getMessage());
-                       exit(3);
+                       exit(self::EARGS);
                }
 
-               if (!chdir($temp)) {
-                       $this->error(null);
-                       exit(4);
+               /* install packages */
+               try {
+                       foreach ($list as $phar) {
+                               $this->info("Installing %s ...\n", basename($phar->getPath()));
+                               $this->install($list[$phar]);
+                               $this->activate($list[$phar]);
+                               $this->info("Successfully installed %s!\n", basename($phar->getPath()));
+                       }
+               } catch (\Exception $e) {
+                       $this->error("%s\n", $e->getMessage());
+                       exit(self::EINSTALL);
                }
-
-               $this->exec("phpize", $this->php("ize"));
-               $this->exec("configure", "./configure --with-php-config=". $this->php("-config") . " ". 
-                       implode(" ", (array) $this->args->configure));
-               $this->exec("make", $this->args->verbose ? "make -j3" : "make -sj3");
-               $this->exec("install", $this->args->verbose ? "make install" : "make -s install", true);
-
-               $this->cleanup($temp);
-
-               $this->info("Don't forget to activiate the extension in your php.ini!\n\n");
        }
 
        /**
-        * Perform any cleanups
+        * Phpize + trinity
         */
-       private function cleanup($temp = null) {
-               if (!isset($temp)) {
-                       $temp = $this->tmp;
-               }
-               if (is_dir($temp)) {
-                       chdir($this->cwd);
-                       $this->info("Cleaning up %s ...\n", $temp);
-                       $this->rm($temp);
-               }
-       }
+       private function install($temp) {
+               // phpize
+               $phpize = new Task\Phpize($temp, $this->args->prefix, $this->args->{"common-name"});
+               $phpize->run($this->verbosity());
 
-       /**
-        * rm -r
-        * @param string $dir
-        */
-       private function rm($dir) {
-               foreach (scandir($dir) as $entry) {
-                       if ($entry === "." || $entry === "..") {
-                               continue;
-                       } elseif (is_dir("$dir/$entry")) {
-                               $this->rm("$dir/$entry");
-                       } elseif (!unlink("$dir/$entry")) {
-                               $this->error(null);
-                       }
-               }
-               if (!rmdir($dir)) {
-                       $this->error(null);
-               }
-       }
-       
-       /**
-        * Execute a program with escalated privileges handling interactive password prompt
-        * @param string $command
-        * @param string $output
-        * @return int
-        */
-       private function sudo($command, &$output) {
-               if (!($proc = proc_open($command, [STDIN,["pipe","w"],["pipe","w"]], $pipes))) {
-                       return -1;
-               }
-               $stdout = $pipes[1];
-               $passwd = 0;
-               while (!feof($stdout)) {
-                       $R = [$stdout]; $W = []; $E = [];
-                       if (!stream_select($R, $W, $E, null)) {
-                               continue;
-                       }
-                       $data = fread($stdout, 0x1000);
-                       /* only check a few times */
-                       if ($passwd++ < 10) {
-                               if (stristr($data, "password")) {
-                                       printf("\n%s", $data);
-                               }
-                       }
-                       $output .= $data;
-               }
-               return proc_close($proc);
+               // configure
+               $configure = new Task\Configure($temp, $this->args->configure, $this->args->prefix, $this->args->{"common-name"});
+               $configure->run($this->verbosity());
+
+               // make
+               $make = new Task\Make($temp);
+               $make->run($this->verbosity());
+
+               // install
+               $sudo = isset($this->args->sudo) ? $this->args->sudo : null;
+               $install = new Task\Make($temp, ["install"], $sudo);
+               $install->run($this->verbosity());
        }
-       /**
-        * Execute a system command
-        * @param string $name pretty name
-        * @param string $command full command
-        * @param bool $sudo whether the command may need escalated privileges
-        */
-       private function exec($name, $command, $sudo = false) {
-               $this->info("Running %s ...%s", $this->args->verbose ? $command : $name, $this->args->verbose ? "\n" : " ");
-               if ($sudo && isset($this->args->sudo)) {
-                       $retval = $this->sudo(sprintf($this->args->sudo." 2>&1", $command), $output);
-               } elseif ($this->args->verbose) {
-                       passthru($command ." 2>&1", $retval);
+
+       private function activate($temp) {
+               if ($this->args->ini) {
+                       $files = [$this->args->ini];
                } else {
-                       exec($command ." 2>&1", $output, $retval);
-                       $output = implode("\n", $output);
-               }
-               if ($retval) {
-                       $this->error("Command %s failed with (%s)\n", $command, $retval);
-                       if (isset($output) && !$this->args->quiet) {
-                               printf("%s\n", $output);
-                       }
-                       exit(2);
+                       $files = array_filter(array_map("trim", explode(",", php_ini_scanned_files())));
+                       $files[] = php_ini_loaded_file();
                }
-               $this->info("OK\n");
-       }
-       
-       /**
-        * Construct a command from prefix common-name and suffix
-        * @param type $suffix
-        * @return string
-        */
-       private function php($suffix) {
-               $cmd = $this->args["common-name"] . $suffix;
-               if (isset($this->args->prefix)) {
-                       $cmd = $this->args->prefix . "/bin/" . $cmd;
+
+               $sudo = isset($this->args->sudo) ? $this->args->sudo : null;
+               $type = $this->metadata("type") ?: "extension";
+
+               $activate = new Task\Activate($temp, $files, $type, $this->args->prefix, $this->args["common-name"], $sudo);
+               if (!$activate->run($this->verbosity())) {
+                       $this->info("Extension already activated ...\n");
                }
-               return $cmd;
        }
 }