X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=src%2Fpharext%2FPackager.php;h=4d70a0d6c5f748c68acb6179a4a3185823ee5e35;hb=223047dbd4ea2950f319179821b0bdb273c50a32;hp=d3e4000a3f45c505829b336c8528f8a40e531553;hpb=8b991a8b633610f7309d76f15b388bffd073d1f7;p=pharext%2Fpharext diff --git a/src/pharext/Packager.php b/src/pharext/Packager.php index d3e4000..4d70a0d 100644 --- a/src/pharext/Packager.php +++ b/src/pharext/Packager.php @@ -3,16 +3,14 @@ namespace pharext; use Phar; -use PharData; -use pharext\Cli\Args as CliArgs; -use pharext\Cli\Command as CliCommand; +use pharext\Exception; /** * The extension packaging command executed by bin/pharext */ class Packager implements Command { - use CliCommand; + use Cli\Command; /** * Extension source directory @@ -30,34 +28,42 @@ class Packager implements Command * Create the command */ public function __construct() { - $this->args = new CliArgs([ + $this->args = new Cli\Args([ ["h", "help", "Display this help", - CliArgs::OPTIONAL|CliArgs::SINGLE|CliArgs::NOARG|CliArgs::HALT], + 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], ["n", "name", "Extension name", - CliArgs::REQUIRED|CliArgs::SINGLE|CliArgs::REQARG], + Cli\Args::REQUIRED|Cli\Args::SINGLE|Cli\Args::REQARG], ["r", "release", "Extension release version", - CliArgs::REQUIRED|CliArgs::SINGLE|CliArgs::REQARG], + Cli\Args::REQUIRED|Cli\Args::SINGLE|Cli\Args::REQARG], ["s", "source", "Extension source directory", - CliArgs::REQUIRED|CliArgs::SINGLE|CliArgs::REQARG], + Cli\Args::REQUIRED|Cli\Args::SINGLE|Cli\Args::REQARG], ["g", "git", "Use `git ls-tree` to determine file list", - CliArgs::OPTIONAL|CliArgs::SINGLE|CliArgs::NOARG], + Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG], + ["b", "branch", "Checkout this tag/branch", + Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::REQARG], ["p", "pecl", "Use PECL package.xml to determine file list, name and release", - CliArgs::OPTIONAL|CliArgs::SINGLE|CliArgs::NOARG], + Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG], ["d", "dest", "Destination directory", - CliArgs::OPTIONAL|CliArgs::SINGLE|CliArgs::REQARG, + Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::REQARG, "."], ["z", "gzip", "Create additional PHAR compressed with gzip", - CliArgs::OPTIONAL|CliArgs::SINGLE|CliArgs::NOARG], + Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG], ["Z", "bzip", "Create additional PHAR compressed with bzip", - CliArgs::OPTIONAL|CliArgs::SINGLE|CliArgs::NOARG], + Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG], ["S", "sign", "Sign the PHAR with a private key", - CliArgs::OPTIONAL|CliArgs::SINGLE|CliArgs::REQARG], - [null, "signature", "Dump signature", - CliArgs::OPTIONAL|CliArgs::SINGLE|CliArgs::NOARG|CliArgs::HALT], + Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::REQARG], + ["E", "zend", "Mark as Zend Extension", + Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG], + [null, "signature", "Show pharext signature", + Cli\Args::OPTIONAL|Cli\Args::SINGLE|Cli\Args::NOARG|Cli\Args::HALT], + [null, "license", "Show pharext license", + 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], ]); } @@ -66,11 +72,7 @@ class Packager implements Command */ function __destruct() { foreach ($this->cleanup as $cleanup) { - if (is_dir($cleanup)) { - $this->rm($cleanup); - } else { - unlink($cleanup); - } + $cleanup->run(); } } @@ -90,25 +92,24 @@ class Packager implements Command $this->help($prog); exit; } - if ($this->args["signature"]) { - exit($this->signature($prog)); + try { + foreach (["signature", "license", "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); } try { - /* source needs to be evaluated before CliArgs validation, - * so e.g. name and version can be overriden and CliArgs + /* source needs to be evaluated before Cli\Args validation, + * so e.g. name and version can be overriden and Cli\Args * does not complain about missing arguments */ - if ($this->args["source"]) { - $source = $this->localize($this->args["source"]); - if ($this->args["pecl"]) { - $this->source = new SourceDir\Pecl($this, $source); - } elseif ($this->args["git"]) { - $this->source = new SourceDir\Git($this, $source); - } else { - $this->source = new SourceDir\Pharext($this, $source); - } - } + $this->loadSource(); } catch (\Exception $e) { $errs[] = $e->getMessage(); } @@ -119,10 +120,7 @@ class Packager implements Command if ($errs) { if (!$this->args["quiet"]) { - if (!headers_sent()) { - /* only display header, if we didn't generate any output yet */ - $this->header(); - } + $this->header(); } foreach ($errs as $err) { $this->error("%s\n", $err); @@ -131,78 +129,40 @@ class Packager implements Command if (!$this->args["quiet"]) { $this->help($prog); } - exit(1); + exit(self::EARGS); } $this->createPackage(); } - - /** - * Dump program signature - * @param string $prog - * @return int exit code - */ - function signature($prog) { - try { - $sig = (new Phar(Phar::running(false)))->getSignature(); - printf("%s signature of %s\n%s", $sig["hash_type"], $prog, - chunk_split($sig["hash"], 64, "\n")); - return 0; - } catch (\Exception $e) { - $this->error("%s\n", $e->getMessage()); - return 2; - } - } - + /** * Download remote source * @param string $source * @return string local source */ private function download($source) { - $this->info("Fetching remote source %s ... ", $source); - if ($this->args["git"]) { - $local = new Tempdir("gitclone"); - $cmd = new ExecCmd("git", $this->args->verbose); - $cmd->run(["clone", $source, $local]); - if (!$this->args->verbose) { - $this->info("OK\n"); - } + if ($this->args->git) { + $task = new Task\GitClone($source, $this->args->branch); } else { - $context = stream_context_create([],["notification" => function($notification, $severity, $message, $code, $bytes_cur, $bytes_max) { - switch ($notification) { - case STREAM_NOTIFY_CONNECT: - $this->debug("\n"); - break; - case STREAM_NOTIFY_PROGRESS: - if ($bytes_max) { - $bytes_pct = $bytes_cur/$bytes_max; - $this->debug("\r %3d%% [%s>%s] ", - $bytes_pct*100, - str_repeat("=", round(70*$bytes_pct)), - str_repeat(" ", round(70*(1-$bytes_pct))) - ); - } - break; - case STREAM_NOTIFY_COMPLETED: - /* this is not generated, why? */ - break; + /* print newline only once */ + $done = false; + $task = new Task\StreamFetch($source, function($bytes_pct) use(&$done) { + if (!$done) { + $this->info(" %3d%% [%s>%s] \r", + floor($bytes_pct*100), + str_repeat("=", round(50*$bytes_pct)), + str_repeat(" ", round(50*(1-$bytes_pct))) + ); + if ($bytes_pct == 1) { + $done = true; + $this->info("\n"); + } } - }]); - if (!$remote = fopen($source, "r", false, $context)) { - $this->error(null); - exit(2); - } - $local = new Tempfile("remote"); - if (!stream_copy_to_stream($remote, $local->getStream())) { - $this->error(null); - exit(2); - } - $local->closeStream(); - $this->info("OK\n"); + }); } - - $this->cleanup[] = $local; + $local = $task->run($this->verbosity()); + + $this->cleanup[] = new Task\Cleanup($local); return $local; } @@ -212,12 +172,17 @@ class Packager implements Command * @return string extracted directory */ private function extract($source) { - $dest = new Tempdir("local"); - $this->debug("Extracting %s to %s ... ", $source, $dest); - $archive = new PharData($source); - $archive->extractTo($dest); - $this->debug("OK\n"); - $this->cleanup[] = $dest; + try { + $task = new Task\Extract($source); + $dest = $task->run($this->verbosity()); + } catch (\Exception $e) { + if (false === strpos($e->getMessage(), "checksum mismatch")) { + throw $e; + } + $dest = (new Task\PaxFixup($source))->run($this->verbosity()); + } + + $this->cleanup[] = new Task\Cleanup($dest); return $dest; } @@ -227,136 +192,129 @@ class Packager implements Command * @return string local source directory */ private function localize($source) { - if (!stream_is_local($source)) { + if (!stream_is_local($source) || ($this->args->git && isset($this->args->branch))) { $source = $this->download($source); + $this->cleanup[] = new Task\Cleanup($source); } + $source = realpath($source); if (!is_dir($source)) { $source = $this->extract($source); - if ($this->args["pecl"]) { - $this->debug("Sanitizing PECL dir ... "); - $dirs = glob("$source/*", GLOB_ONLYDIR); - $files = array_diff(glob("$source/*"), $dirs); - $source = current($dirs); - foreach ($files as $file) { - rename($file, "$source/" . basename($file)); - } - $this->debug("OK\n"); + $this->cleanup[] = new Task\Cleanup($source); + + if (!$this->args->git) { + $source = (new Task\PeclFixup($source))->run($this->verbosity()); } } return $source; } /** - * Traverses all pharext source files to bundle - * @return Generator + * Load the source dir + * @throws \pharext\Exception */ - private function bundle() { - $rdi = new \RecursiveDirectoryIterator(__DIR__); - $rii = new \RecursiveIteratorIterator($rdi); - for ($rii->rewind(); $rii->valid(); $rii->next()) { - yield "pharext/". $rii->getSubPathname() => $rii->key(); - - } - } + private function loadSource(){ + if ($this->args["source"]) { + $source = $this->localize($this->args["source"]); - /** - * Ask for password on the console - * @param string $prompt - * @return string password - */ - private function askpass($prompt = "Password:") { - system("stty -echo", $retval); - if ($retval) { - $this->error("Could not disable echo on the terminal\n"); - } - printf("%s ", $prompt); - $pass = fgets(STDIN, 1024); - system("stty echo"); - if (substr($pass, -1) == "\n") { - $pass = substr($pass, 0, -1); + if ($this->args["pecl"]) { + $this->source = new SourceDir\Pecl($source); + } elseif ($this->args["git"]) { + $this->source = new SourceDir\Git($source); + } elseif (is_file("$source/pharext_package.php")) { + $this->source = include "$source/pharext_package.php"; + } else { + $this->source = new SourceDir\Basic($source); + } + + if (!$this->source instanceof SourceDir) { + throw new Exception("Unknown source dir $source"); + } + + foreach ($this->source->getPackageInfo() as $key => $val) { + $this->args->$key = $val; + } } - return $pass; } /** * Creates the extension phar */ private function createPackage() { - $pkguniq = uniqid(); - $pkgtemp = sprintf("%s/%s.phar", sys_get_temp_dir(), $pkguniq); - $pkgdesc = "{$this->args->name}-{$this->args->release}"; - - $this->info("Creating phar %s ...%s", $pkgtemp, $this->args->verbose ? "\n" : " "); try { - $package = new Phar($pkgtemp); + $meta = array_merge(Metadata::all(), [ + "name" => $this->args->name, + "release" => $this->args->release, + "license" => $this->source->getLicense(), + "type" => $this->args->zend ? "zend_extension" : "extension", + ]); + $file = (new Task\PharBuild($this->source, __DIR__."/../pharext_installer.php", $meta))->run($this->verbosity()); + } catch (\Exception $e) { + $this->error("%s\n", $e->getMessage()); + exit(self::EBUILD); + } + try { if ($this->args->sign) { - $this->info("\nUsing private key to sign phar ... \n"); - $privkey = new Openssl\PrivateKey(realpath($this->args->sign), $this->askpass()); - $privkey->sign($package); + $this->info("Using private key to sign phar ...\n"); + $pass = (new Task\Askpass)->run($this->verbosity()); + $sign = new Task\PharSign($file, $this->args->sign, $pass); + $pkey = $sign->run($this->verbosity()); } - $package->startBuffering(); - $package->buildFromIterator($this->source, $this->source->getBaseDir()); - $package->buildFromIterator($this->bundle(__DIR__)); - $package->addFile(__DIR__."/../pharext_installer.php", "pharext_installer.php"); - $package->setDefaultStub("pharext_installer.php"); - $package->setStub("#!/usr/bin/php -dphar.readonly=1\n".$package->getStub()); - $package->stopBuffering(); + } catch (\Exception $e) { + $this->error("%s\n", $e->getMessage()); + exit(self::ESIGN); + } - if (!chmod($pkgtemp, 0777)) { - $this->error(null); - } elseif ($this->args->verbose) { - $this->debug("Created executable phar %s\n", $pkgtemp); - } else { - $this->info("OK\n"); - } - if ($this->args->gzip) { - $this->info("Compressing with gzip ... "); - try { - $package->compress(Phar::GZ) - ->setDefaultStub("pharext_installer.php"); - $this->info("OK\n"); - } catch (\Exception $e) { - $this->error("%s\n", $e->getMessage()); + if ($this->args->gzip) { + try { + $gzip = (new Task\PharCompress($file, Phar::GZ))->run(); + $move = new Task\PharRename($gzip, $this->args->dest, $this->args->name ."-". $this->args->release); + $name = $move->run($this->verbosity()); + + $this->info("Created gzipped phar %s\n", $name); + + if ($this->args->sign) { + $sign = new Task\PharSign($name, $this->args->sign, $pass); + $sign->run($this->verbosity())->exportPublicKey($name.".pubkey"); } + + } catch (\Exception $e) { + $this->warn("%s\n", $e->getMessage()); } - if ($this->args->bzip) { - $this->info("Compressing with bzip ... "); - try { - $package->compress(Phar::BZ2) - ->setDefaultStub("pharext_installer.php"); - $this->info("OK\n"); - } catch (\Exception $e) { - $this->error("%s\n", $e->getMessage()); + } + + if ($this->args->bzip) { + try { + $bzip = (new Task\PharCompress($file, Phar::BZ2))->run(); + $move = new Task\PharRename($bzip, $this->args->dest, $this->args->name ."-". $this->args->release); + $name = $move->run($this->verbosity()); + + $this->info("Created bzipped phar %s\n", $name); + + if ($this->args->sign) { + $sign = new Task\PharSign($name, $this->args->sign, $pass); + $sign->run($this->verbosity())->exportPublicKey($name.".pubkey"); } + + } catch (\Exception $e) { + $this->warn("%s\n", $e->getMessage()); + } + } + + try { + $move = new Task\PharRename($file, $this->args->dest, $this->args->name ."-". $this->args->release); + $name = $move->run($this->verbosity()); + + $this->info("Created executable phar %s\n", $name); + + if (isset($pkey)) { + $pkey->exportPublicKey($name.".pubkey"); } - unset($package); } catch (\Exception $e) { $this->error("%s\n", $e->getMessage()); - exit(4); + exit(self::EBUILD); } - - foreach (glob($pkgtemp."*") as $pkgtemp) { - $pkgfile = str_replace($pkguniq, "{$pkgdesc}.ext", $pkgtemp); - $pkgname = $this->args->dest ."/". basename($pkgfile); - $this->info("Finalizing %s ... ", $pkgname); - if (!rename($pkgtemp, $pkgname)) { - $this->error(null); - exit(5); - } - $this->info("OK\n"); - if ($this->args->sign && isset($privkey)) { - $keyname = $this->args->dest ."/". basename($pkgfile) . ".pubkey"; - $this->info("Public Key %s ... ", $keyname); - try { - $privkey->exportPublicKey($keyname); - $this->info("OK\n"); - } catch (\Exception $e) { - $this->error("%s", $e->getMessage()); - } - } - } } }