9 * The extension packaging command executed by bin/pharext
11 class Packager
implements Command
16 * Extension source directory
17 * @var pharext\SourceDir
25 private $cleanup = [];
30 public function __construct() {
31 $this->args
= new Cli\
Args([
32 ["h", "help", "Display this help",
33 Cli\Args
::OPTIONAL|Cli\Args
::SINGLE|Cli\Args
::NOARG|Cli\Args
::HALT
],
34 ["v", "verbose", "More output",
35 Cli\Args
::OPTIONAL|Cli\Args
::SINGLE|Cli\Args
::NOARG
],
36 ["q", "quiet", "Less output",
37 Cli\Args
::OPTIONAL|Cli\Args
::SINGLE|Cli\Args
::NOARG
],
38 ["n", "name", "Extension name",
39 Cli\Args
::REQUIRED|Cli\Args
::SINGLE|Cli\Args
::REQARG
],
40 ["r", "release", "Extension release version",
41 Cli\Args
::REQUIRED|Cli\Args
::SINGLE|Cli\Args
::REQARG
],
42 ["s", "source", "Extension source directory",
43 Cli\Args
::REQUIRED|Cli\Args
::SINGLE|Cli\Args
::REQARG
],
44 ["g", "git", "Use `git ls-tree` to determine file list",
45 Cli\Args
::OPTIONAL|Cli\Args
::SINGLE|Cli\Args
::NOARG
],
46 ["b", "branch", "Checkout this tag/branch",
47 Cli\Args
::OPTIONAL|Cli\Args
::SINGLE|Cli\Args
::REQARG
],
48 ["p", "pecl", "Use PECL package.xml to determine file list, name and release",
49 Cli\Args
::OPTIONAL|Cli\Args
::SINGLE|Cli\Args
::NOARG
],
50 ["d", "dest", "Destination directory",
51 Cli\Args
::OPTIONAL|Cli\Args
::SINGLE|Cli\Args
::REQARG
,
53 ["z", "gzip", "Create additional PHAR compressed with gzip",
54 Cli\Args
::OPTIONAL|Cli\Args
::SINGLE|Cli\Args
::NOARG
],
55 ["Z", "bzip", "Create additional PHAR compressed with bzip",
56 Cli\Args
::OPTIONAL|Cli\Args
::SINGLE|Cli\Args
::NOARG
],
57 ["S", "sign", "Sign the PHAR with a private key",
58 Cli\Args
::OPTIONAL|Cli\Args
::SINGLE|Cli\Args
::REQARG
],
59 ["E", "zend", "Mark as Zend Extension",
60 Cli\Args
::OPTIONAL|Cli\Args
::SINGLE|Cli\Args
::NOARG
],
61 [null, "signature", "Show pharext signature",
62 Cli\Args
::OPTIONAL|Cli\Args
::SINGLE|Cli\Args
::NOARG|Cli\Args
::HALT
],
63 [null, "license", "Show pharext license",
64 Cli\Args
::OPTIONAL|Cli\Args
::SINGLE|Cli\Args
::NOARG|Cli\Args
::HALT
],
65 [null, "version", "Show pharext version",
66 Cli\Args
::OPTIONAL|Cli\Args
::SINGLE|Cli\Args
::NOARG|Cli\Args
::HALT
],
73 function __destruct() {
74 foreach ($this->cleanup
as $cleanup) {
81 * @see \pharext\Command::run()
83 public function run($argc, array $argv) {
85 $prog = array_shift($argv);
86 foreach ($this->args
->parse(--$argc, $argv) as $error) {
90 if ($this->args
["help"]) {
96 foreach (["signature", "license", "version"] as $opt) {
97 if ($this->args
[$opt]) {
98 printf("%s\n", $this->metadata($opt));
102 } catch (\Exception
$e) {
103 $this->error("%s\n", $e->getMessage());
108 /* source needs to be evaluated before Cli\Args validation,
109 * so Cli\Args does not complain about missing arguments,
110 * which come from SourceDir::getPackageInfo()
113 } catch (\Exception
$e) {
114 $errs[] = $e->getMessage();
117 foreach ($this->args
->validate() as $error) {
122 if (!$this->args
["quiet"]) {
125 foreach ($errs as $err) {
126 $this->error("%s\n", $err);
129 if (!$this->args
["quiet"]) {
135 $this->createPackage();
139 * Download remote source
140 * @param string $source
141 * @return string local source
143 private function download($source) {
144 if ($this->args
->git
) {
145 $task = new Task\
GitClone($source, $this->args
->branch
);
147 /* print newline only once */
149 $task = new Task\
StreamFetch($source, function($bytes_pct) use(&$done) {
151 $this->info(" %3d%% [%s>%s] \r",
152 floor($bytes_pct*100),
153 str_repeat("=", round(50*$bytes_pct)),
154 str_repeat(" ", round(50*(1-$bytes_pct)))
156 if ($bytes_pct == 1) {
163 $local = $task->run($this->verbosity());
165 $this->cleanup
[] = new Task\
Cleanup($local);
170 * Extract local archive
171 * @param stirng $source
172 * @return string extracted directory
174 private function extract($source) {
176 $task = new Task\
Extract($source);
177 $dest = $task->run($this->verbosity());
178 } catch (\Exception
$e) {
179 if (false === strpos($e->getMessage(), "checksum mismatch")) {
182 $dest = (new Task\
PaxFixup($source))->run($this->verbosity());
185 $this->cleanup
[] = new Task\
Cleanup($dest);
190 * Localize a possibly remote source
191 * @param string $source
192 * @return string local source directory
194 private function localize($source) {
195 if (!stream_is_local($source) ||
($this->args
->git
&& isset($this->args
->branch
))) {
196 $source = $this->download($source);
197 $this->cleanup
[] = new Task\
Cleanup($source);
199 $source = realpath($source);
200 if (!is_dir($source)) {
201 $source = $this->extract($source);
202 $this->cleanup
[] = new Task\
Cleanup($source);
204 if (!$this->args
->git
) {
205 $source = (new Task\
PeclFixup($source))->run($this->verbosity());
212 * Load the source dir
213 * @throws \pharext\Exception
215 private function loadSource(){
216 if ($this->args
["source"]) {
217 $source = $this->localize($this->args
["source"]);
219 if ($this->args
["pecl"]) {
220 $this->source
= new SourceDir\
Pecl($source);
221 } elseif ($this->args
["git"]) {
222 $this->source
= new SourceDir\
Git($source);
223 } elseif (is_file("$source/pharext_package.php")) {
224 $this->source
= include "$source/pharext_package.php";
226 $this->source
= new SourceDir\
Basic($source);
229 if (!$this->source
instanceof SourceDir
) {
230 throw new Exception("Unknown source dir $source");
233 foreach ($this->source
->getPackageInfo() as $key => $val) {
234 /* do not override command line arguments */
235 if (!isset($this->args
->$key)) {
236 $this->args
->$key = $val;
243 * Creates the extension phar
245 private function createPackage() {
247 $meta = array_merge(Metadata
::all(), [
248 "name" => $this->args
->name
,
249 "release" => $this->args
->release
,
250 "license" => $this->source
->getLicense(),
251 "type" => $this->args
->zend ?
"zend_extension" : "extension",
253 $file = (new Task\
PharBuild($this->source
, __DIR__
."/../pharext_installer.php", $meta))->run($this->verbosity());
254 } catch (\Exception
$e) {
255 $this->error("%s\n", $e->getMessage());
260 if ($this->args
->sign
) {
261 $this->info("Using private key to sign phar ...\n");
262 $pass = (new Task\Askpass
)->run($this->verbosity());
263 $sign = new Task\
PharSign($file, $this->args
->sign
, $pass);
264 $pkey = $sign->run($this->verbosity());
267 } catch (\Exception
$e) {
268 $this->error("%s\n", $e->getMessage());
272 if ($this->args
->gzip
) {
274 $gzip = (new Task\
PharCompress($file, Phar
::GZ
))->run();
275 $move = new Task\
PharRename($gzip, $this->args
->dest
, $this->args
->name
."-". $this->args
->release
);
276 $name = $move->run($this->verbosity());
278 $this->info("Created gzipped phar %s\n", $name);
280 if ($this->args
->sign
) {
281 $sign = new Task\
PharSign($name, $this->args
->sign
, $pass);
282 $sign->run($this->verbosity())->exportPublicKey($name.".pubkey");
285 } catch (\Exception
$e) {
286 $this->warn("%s\n", $e->getMessage());
290 if ($this->args
->bzip
) {
292 $bzip = (new Task\
PharCompress($file, Phar
::BZ2
))->run();
293 $move = new Task\
PharRename($bzip, $this->args
->dest
, $this->args
->name
."-". $this->args
->release
);
294 $name = $move->run($this->verbosity());
296 $this->info("Created bzipped phar %s\n", $name);
298 if ($this->args
->sign
) {
299 $sign = new Task\
PharSign($name, $this->args
->sign
, $pass);
300 $sign->run($this->verbosity())->exportPublicKey($name.".pubkey");
303 } catch (\Exception
$e) {
304 $this->warn("%s\n", $e->getMessage());
309 $move = new Task\
PharRename($file, $this->args
->dest
, $this->args
->name
."-". $this->args
->release
);
310 $name = $move->run($this->verbosity());
312 $this->info("Created executable phar %s\n", $name);
315 $pkey->exportPublicKey($name.".pubkey");
318 } catch (\Exception
$e) {
319 $this->error("%s\n", $e->getMessage());