1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
| #!/usr/bin/php
<?php
/**
* type: cli
* title: Version Get/Write
* description: Commandline tool to read and update source code version numbers
* version: 3.2.3
* category: tools
*
*
* This tool reads various formats of "Version: x.y*" from and to source code
* or distribution files. It's useful for keeping them synced or prepared without
* further packaging tool scripting.
*
* It's indifferent to versioning schemes, understands various source and target
* syntax variations:
*
* PHP plugins # version: 1.2.3 RPM/EPM spec %version 7.1
* PHP docblock * @version: 0.41 Debian control Version: 2.0-3
* Python/INI version = 5.3 Constants const VERSION = '2.0'
* Script vars $version = "1.0"; JSON { "version": "0.2.2" }
*
* Multiple commands are supported and can be chained often quite readibly to
* move version numbers across files:
*
* version get file.php
*
* version read file.c bump show
*
* version --get file.php --incr --write package.list
*
* version read script.py incr and bump then write DEBIAN/control
*
* version read:php file.php bump write:spec package.spec
*
* version 1.2.3-dev write source.php
*
* version get phar://project.phar/.phar/stub.php write project.phar
*
* Everything that's not a valid filename is presumed to be an action command,
* and can also be prefixed with a - single or -- double dash, as in --get.
* The order of filenames and actions is often irrelevant.
*
* --get Loads and shows version from file.
* --read Just loads version, does not display it.
* --show Just prints out current or increased/bumped version number.
*
* --write Update version field in the destination source code file.
*
* --incr Increment patch ver number (last colon-separated 0.0.x decimal)
* --bump Add/count up packaging/suffix (first num after dash 0.0.0-x)
* You can also bump in bigger spans using --bump::2 or --incr::3
*
* --format:ini Explicit file format
* --format:php:2 Also specify how many occurences to replace.
*
* You can add the :format:count extras to any command actually, so `-fmt:py:2`
* is used in `-write:py:2` implicitly.
* More aliases exist for actions, for example ++ for -increment.
* For format types you can specify both file extension and internal rx format
* monikers (ini, var, const, ... or `_raw_` for any versiony-looking string).
*
* Often you may wish to split up invocations from the shell, as in:
*
* VERSION=$(version get orig.c ++)
* version write $VERSION dest.cpp
*
* There's no commandline option for custom regexen, to eschew code duplication
* in said shell scripts.
*
*@version 3.2.2-0
*/
// Tool-specific data
class cfg {
#-- Regular expressions
// Generic version matching with (?&ver)
static $rx_ver = "( (?<epoch>\d+:)? (?<major>\d+) \.(?<minor>\d+) (?:\.(?<patch>\d+))? (?<suffix>[\d\w-+.~_]*) )";
// Whitespace without linebreaks,
// will be applied in place of `\s` in the following rx_format list
static $rx_ws = "[^\S\R]";
// Default regex end match (?&end)
static $rx_end = " \s* $";
// Filetype/language-specific context matching
static $rx_format = array(
// Debian package description
"debian" => "^ Version: \s+ ",
// RPM package description
"rpmspec" => "^ % version \s+",
// Generic meta data comment block
"plugin" => "^ \s* (?:\*|\#|\/\/) \s* (?i) version: \s* ",
// Documentation
"docblock" => "^ \s* [*] \s? @version \s+",
// Constant declarations
"const" => array("^ \s* const \s+ \w*VERSION \s+ = \s+ [\'\"]", '(?&ver)', "[\'\"]; (?&end)"),
// PHP constant declarations
"define" => array("^ \s* define \( [\'\"] \w*VERSION [\'\"], \s* [\'\"]", '(?&ver)', "[\'\"]\); (?&end)"),
// Scripting language variable or property assignments
"var" => array("^ \s* (?:var|public|private|protected|static|global)? \s* \$\w*version \s* = \s* [\'\"]", '(?&ver)', "[\'\"]; (?&end)"),
// Wordpress plugin meta data
"wordpress"=> "^ \s* Version: \s* ",
// Config.ini files
"ini" => array("^ \s* version \s* = \s* [\'\"]?", '(?&ver)', "[\'\"]? (?&end)"),
// Python module versions
"python" => array("^ \s* __version__ \s* = \s* [\'\"]", '(?&ver)', "[\'\"] (?&end)"),
// JSON dict as used by PHP composer
"composer" => array("[{,] \s* \"version\" \s* : \s* \" ", '(?&ver)', " \" \s* [,}] "),
// Single XML tag
"xmltag" => array("<version>\s*", '(?&ver)', "\s*<\/version>"),
// Would match ANYTHING in a text file that looks like a version number.
"_raw_" => array("", '(?&ver)', "")
);
// Map file extensions to regex format names
static $ext_to_rxformat = array(
"php" => array("plugin", "docblock", "define", "const", "var", "wordpress"),
"control" => array("debian"),
"py" => array("python", "plugin", "ini"),
"cpp" => array("plugin", "const"),
"c" => array("plugin", "ini"),
"json" => array("composer"),
"sh" => array("plugin", "ini"),
"xml" => array("xmltag"),
"spec" => array("rpmspec"),
"list" => array("rpmspec"),
#"txt" => array("_raw_"), // e.g. distutils2 version.txt
"any" => array("debian","rpmspec","plugin","docblock","const","define","var","wordpress","ini","python","composer","xmltag"),
);
// Binary file format handlers (see action:: class)
static $bin_handlers = array(
"phar" => "bin_phar",
"deb" => "bin_deb",
);
// Command line aliases
static $action_aliases = array (
"write" => "write", "save" => "write", "update" => "write",
"get" => "get", "from" => "get",
"read" => "read", "fetch" => "read",
"show" => "show", "echo" => "show", "print" => "show",
"increment" => "increment", "++" => "increment", "add" => "increment", "inc" => "increment", "incr" => "increment",
"bump" => "bump", "suffix" => "bump", "release" => "bump",
"format" => "format", "fmt" => "format", "and" => "format", "then" => "format", "set" => "format",
"last" => "last", "lastfn" => "last",
"help" => "help",
"dry" => "dry", "nowrite" => "dry", "dryrun" => "dry",
);
}//cfg
#-- Most commands require a pair of $action + $file to be run
$version = "";
class command {
var $action = "";
var $file = "";
var $ext = "";
var $format = "";
var $count = 1;
function __construct() { $this->version = & $GLOBALS["version"]; }
var $version;
}
$cmd = new command();
$last = new command();
#-- Init argument list
$argv0 = basename($_SERVER["argv"][0]);
$argv = array_slice($_SERVER["argv"], 1);
// no args = help
if (empty($argv)) {
$argv[] = "help";
}
// Use get_ or write_ prefix from invocation basename as first action
elseif (strpos($argv0, "_")) {
$cmd->action = key(array_intersect_key(array_flip(explode("_", $argv0)), cfg::$action_aliases));
}
// Just one filename arg = use default action 'get'
elseif (count($argv) == 1) {
$cmd->action = "get";
}
#-- Iterate over argument list
foreach ($argv as $arg) {
#-- Categorize current argument
// It's a filename
if (file_exists($arg)) {
$cmd->file = $arg;
$cmd->ext = basename(trim(substr($arg, strrpos($arg, ".")), ".")); // extension or basename (e.g. for DEBIAN/control file)
}
// STDIN
elseif ($arg == "-") {
$cmd->file = "php://stdin";
}
// Reuse previous filename and options (but retain current action)
elseif (ltrim($arg, "-") == "last") {
$last->action = $cmd->action;
$cmd = $last;
}
// Input version number
elseif (preg_match("/^".cfg::$rx_ver."$/x", $arg)) {
if (!rx::is_valid_ver($arg)) { error("Invalid version string supplied '$arg'", 33 /*EDOM*/); }
$cmd->version = $arg;
}
// Action/command name
else {
// extra flags
if (strpos($arg, ":")) {
list($arg, $cmd->format, $cmd->count) = explode(":", "$arg:1");
}
// normalize
$cmd->action = cfg::$action_aliases[ltrim($arg, "-")]
or error("Unknown action command or non-existant file '$arg'\n", 2 /*ENOENT*/);
}
#-- Processing/behaviour
switch ($cmd->action) {
// Output current $cmd->version
case "show":
print $version;
break;
// Read and print from file
case "get":
if ($cmd->file) {
action::read($cmd);
if (!rx::is_valid_ver($cmd->version)) {
// return 0.0-0error on failure
fwrite(STDOUT, "0.0-0error");
error("No version number found in file '$cmd->file'", 61/*ENODATA*/);
// (while --read should not not)
}
print $cmd->version;
$last=$cmd and $cmd=new command();
}
break;
// Silent reading from file
case "read":
if ($cmd->file) {
action::read($cmd);
$last=$cmd and $cmd=new command();
}
break;
// Update current $version string into target source code
case "write":
if ($cmd->file) {
if (!rx::is_valid_ver($version)) {
// fail
error("No valid version number to write. Aborting.", 33 /*EDOM*/);
}
action::write($cmd);
$last=$cmd and $cmd=new command();
}
break;
// Increment patch version number 0.0.x or 0.0.0.x
case "increment":
action::increment($cmd);
break;
// Increment or add release suffix 0.0-1
case "bump":
action::bump($cmd);
break;
// Make 'write' command non-writey
case "dry":
$cmd->dry = 1;
break;
// NOP
case "":
case "format":
// do nothing (--format:TYPE:N params can be attached to any other command, --format itself incurs no action)
break;
// Show top level documentation as help
case "help":
action::help();
break;
// Should've been catched earlier (= an assert() would do here)
default:
error("Unimplemented action '$cmd->action'\n", 24 /*EINVAL*/);
}
}
/**
* Action implementation
*
*
*/
class action {
/**
* Read file, and preg_match() for version number.
*
*/
function read($cmd) {
#-- binary
if (self::bin_read($cmd)) {
return;
}
#-- text, read src
$src = file_get_contents($cmd->file);
// match
foreach (rx::get($cmd) as $rx) {
if (preg_match($rx, $src, $match)) {
$cmd->version = $match["version"];
return;
}
}
//ooops
}
/**
* Read file, and preg_match() for version number.
*
*/
function write($cmd) {
#-- binary
if (self::bin_write($cmd)) {
return;
}
#-- text, read src
$src = file_get_contents($cmd->file);
// replacement limit
$limit = $cmd->count ? (int)$cmd->count : 1;
//@bug: PHP applies the limit to each regex in the list, not as overall
// replace
$src = preg_replace_callback
(
rx::get($cmd),
function($m) use ($cmd, &$limit) {
// apply application stop here, because preg_replace() only does for *each* rx[] list entry
if ($limit-- <= 0) {
return $m[0];
}
// replace
return( $m["begin"] . $cmd->version . $m["end"] );
},
$src,
$limit
);
// dry run?
if (isset($cmd->dry)) {
die("$src");
}
else {
file_put_contents($cmd->file, $src);
}
}
/**
* Increment patch 0.0.x or minor version number 0.y
*
*/
function increment($cmd) {
$cmd->version = preg_replace_callback("/(?<=\.) (\d+) (?=[^.]*$)/x", function($m) use ($cmd) {
return $m[1] + $cmd->count;
}, $cmd->version);
}
/**
* Increment -1 release suffix, or add one.
*
* @todo: support $cmd->dist for e.g. -0vendor2
*/
function bump($cmd) {
if (preg_match("/-\d+/", $cmd->version)) {
$cmd->version = preg_replace_callback("/(?<=-) (\d+)/x", function($m) use ($cmd) {
return $m[1] + $cmd->count;
}, $cmd->version);
}
else {
$cmd->version .= "-0";
}
}
/**
* Print out file comment as --help
*
*/
function help() {
$src = file_get_contents(__FILE__) and preg_match("#/\*\*.+?\*/#s", $src, $m) and $src = $m[0];
$src = preg_replace("#^/\*+\s*$|^\s*\*/$|^ \*(@version.+)? ?#m", "", $src);
$src = preg_replace(
array("/^\w+:|--/m", "/version/", "/get|show|read|write|incr|bump|format/", "/[a-z]\w+\.\w+/", "/:/"),
array("\33[30;1m$0\33[0m", "\33[32m$0\33[0m", "\33[31m$0\33[0m", "\33[36m$0\33[0m", "\33[33;1m$0\33[0m"),
$src
);
die($src);
}
#-- binary handlers
// read "version" meta field via binary helpers
function bin_read($cmd) {
if (isset(cfg::$bin_handlers[$cmd->ext])) {
$cmd->version = ""; // unset ->version so it becomes a read action
return self::bin_write($cmd);
}
}
// write "version" meta field to binary
function bin_write($cmd) {
if (isset(cfg::$bin_handlers[$cmd->ext])) {
$h = cfg::$bin_handlers[$cmd->ext];
if (method_exists("action", $h)) {
call_user_func(array("action",$h), $cmd);
return TRUE;
}
}
}
// .phar files
function bin_phar($cmd) {
// open and get old meta block
$p = new Phar($cmd->file);
$m = $p->getMetadata();
// read
if (empty($cmd->version)) {
$cmd->version = $m["version"];
}
// update
else {
$m["version"] = $cmd->version;
$p->setMetadata($m);
}
// same as:
// phar meta-get -f filename.phar -k version
}
// .deb archives (read-only)
function bin_deb($cmd) {
// read
if (empty($cmd->version)) {
$fn = escapeshellarg($cmd->file);
$src = `ar p {$fn} control.tar.gz | tar xOz ./control`;
$rx = rx::combine(array(cfg::$rx_format["debian"]));
if (preg_match($rx[0], $src, $m)) {
$cmd->version = $m["version"];
}
}
else {
error("Cannot update .deb archives.", 1 /*EPERM*/);
}
}
}
/**
* Regex lookup and preparation
* *
*/
class rx {
// Turn list of formats or ext specifiers into regex list
function get($cmd) {
return rx::combine( rx::formats($cmd) );
}
/**
* Return ordered list of regular expression to try.
* A specific ->type overrides the ->ext defaults.
*
*/
function formats($cmd) {
// request a specific rx_format or file extension
if ($cmd->format) {
$search = explode(",", $cmd->format);
}
// base on file extensions
elseif ($cmd->ext) {
$search = array($cmd->ext);
}
// use anything
else {
$search = array("any");
}
// unpack remaining file extensions into rx_format names
$rx = array();
foreach ($search as $s) {
if (isset(cfg::$rx_format[$s])) {
$rx[] = cfg::$rx_format[$s];
}
elseif (isset(cfg::$ext_to_rxformat[$s])) {
foreach (cfg::$ext_to_rxformat[$s] as $s2) {
$rx[] = cfg::$rx_format[$s2];
}
}
else {
error("Unkown file extension or rx_format '$s' name", 65 /*ENOPKG*/);
}
}
return $rx;
}
/**
* Combine a list of regex parts with $rx_ver, $rx_end
*
* / ($BEGIN) ($rx_ver) ($END | $rx_end) /mx
*
* Return list, to be readily used in preg_match or _replace.
*
*/
function combine($prefixes) {
// patch together
foreach ($prefixes as $i=>$parts) {
// parts
list($begin, $ver, $end) = is_array($parts)
? $parts
: array($parts, cfg::$rx_ver, cfg::$rx_end);
// wrap
$prefixes[$i] = str_replace(
array( "\\s", "(?&ver)", "(?&end)"),
array(cfg::$rx_ws, cfg::$rx_ver, cfg::$rx_end),
"/ (?<begin>$begin) (?<version>$ver) (?<end>$end) /mx"
);
}
return array_unique($prefixes);
}
/**
* Version string conformance testing.
*
* Applies $rx_ver obviously,
* but also checks for `0.0-0error` specials (which --get may have returned on previous runs).
*
*/
function is_valid_ver($version) {
return preg_match("/^(".cfg::$rx_ver.")$/x", $version)
and !preg_match("/^0\.0([0.-]*|[12]?error)+$/", $version);
}
}
/**
* Abort.
*
*
*/
function error($msg="aborted", $errno=-1) {
fwrite(STDERR, basename($_SERVER['argv'][0]) . ": " . $msg . "\n");
if ($errno > 0) {
exit($errno );
}
}
?>
|