File Coverage

blib/lib/GBK.pm
Criterion Covered Total %
statement 64 126 50.7
branch 23 72 31.9
condition 0 3 0.0
subroutine 9 11 81.8
pod 0 2 0.0
total 96 214 44.8


line stmt bran cond sub pod time code
1             package GBK;
2 384     384   282484 use strict;
  384         2547  
  384         11573  
3             ######################################################################
4             #
5             # GBK - Source code filter to escape GBK script
6             #
7             # http://search.cpan.org/dist/Char-GBK/
8             #
9             # Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2018, 2019 INABA Hitoshi
10             ######################################################################
11              
12 384     384   8515 use 5.00503; # Galapagos Consensus 1998 for primetools
  384         1196  
13             # use 5.008001; # Lancaster Consensus 2013 for toolchains
14              
15             # 12.3. Delaying use Until Runtime
16             # in Chapter 12. Packages, Libraries, and Modules
17             # of ISBN 0-596-00313-7 Perl Cookbook, 2nd Edition.
18             # (and so on)
19              
20             # Version numbers should be boring
21             # http://www.dagolden.com/index.php/369/version-numbers-should-be-boring/
22             # For the impatient, the disinterested or those who just want to follow
23             # a recipe, my advice for all modules is this:
24             # our $VERSION = "0.001"; # or "0.001_001" for a dev release
25             # $VERSION = CORE::eval $VERSION; # No!! because '1.10' makes '1.1'
26              
27 384     384   2926 use vars qw($VERSION);
  384         616  
  384         65903  
28             $VERSION = '1.15';
29             $VERSION = $VERSION;
30              
31             BEGIN {
32 384 50   384   2483 if ($^X =~ / jperl /oxmsi) {
33 0         0 die __FILE__, ": needs perl(not jperl) 5.00503 or later. (\$^X==$^X)\n";
34             }
35 384         698 if (CORE::ord('A') == 193) {
36             die __FILE__, ": is not US-ASCII script (may be EBCDIC or EBCDIK script).\n";
37             }
38 384         28569 if (CORE::ord('A') != 0x41) {
39             die __FILE__, ": is not US-ASCII script (must be US-ASCII script).\n";
40             }
41             }
42              
43             BEGIN {
44 384     384   3690 (my $dirname = __FILE__) =~ s{^(.+)/[^/]*$}{$1};
45 384         2889 unshift @INC, $dirname;
46 384         791408 CORE::require Egbk;
47             }
48              
49             # instead of Symbol.pm
50 1152         5265 BEGIN {
51             sub gensym () {
52 0 50   1152 0 0 if ($] < 5.006) {
53 0         0 return \do { local *_ };
  1152         2852  
54             }
55             else {
56 384         4020 return undef;
57             }
58             }
59             }
60              
61             # P.714 29.2.39. flock
62             # in Chapter 29: Functions
63             # of ISBN 0-596-00027-8 Programming Perl Third Edition.
64              
65             # P.863 flock
66             # in Chapter 27: Functions
67             # of ISBN 978-0-596-00492-7 Programming Perl 4th Edition.
68              
69             # P.228 Inlining Constant Functions
70             # in Chapter 6: Subroutines
71             # of ISBN 0-596-00027-8 Programming Perl Third Edition.
72              
73             # P.331 Inlining Constant Functions
74             # in Chapter 7: Subroutines
75             # of ISBN 978-0-596-00492-7 Programming Perl 4th Edition.
76              
77             sub LOCK_SH() {1}
78             sub LOCK_EX() {2}
79             sub LOCK_UN() {8}
80             sub LOCK_NB() {4}
81              
82       0     sub unimport {}
83             sub GBK::escape_script;
84              
85             # 6.18. Matching Multiple-Byte Characters
86             # in Chapter 6. Pattern Matching
87             # of ISBN 978-1-56592-243-3 Perl Perl Cookbook.
88             # (and so on)
89              
90             # regexp of character
91             my $qq_char = qr/(?> \\c[\x40-\x5F] | \\? (?:[\x81-\xFE][\x00-\xFF] | [\x00-\xFF]) )/oxms;
92             my $q_char = qr/(?> [\x81-\xFE][\x00-\xFF] | [\x00-\xFF] )/oxms;
93              
94             # when this script is main program
95             if ($0 eq __FILE__) {
96              
97             # show usage
98             unless (@ARGV) {
99             die <
100             $0: usage
101              
102             perl $0 GBK_script.pl > Escaped_script.pl.e
103             END
104             }
105              
106             print GBK::escape_script($ARGV[0]);
107             exit 0;
108             }
109              
110             my($package,$filename,$line,$subroutine,$hasargs,$wantarray,$evaltext,$is_require,$hints,$bitmask) = caller 0;
111              
112             # called any package not main
113             if ($package ne 'main') {
114             die <
115             @{[__FILE__]}: escape by manually command '$^X @{[__FILE__]} "$filename" > "@{[__PACKAGE__]}::$filename"'
116             and rewrite "use $package;" to "use @{[__PACKAGE__]}::$package;" of script "$0".
117             END
118             }
119              
120             # P.302 Module Privacy and the Exporter
121             # in Chapter 11: Modules
122             # of ISBN 0-596-00027-8 Programming Perl Third Edition.
123             #
124             # A module can do anything it jolly well pleases when it's used, since use just
125             # calls the ordinary import method for the module, and you can define that
126             # method to do anything you like.
127              
128             # P.406 Module Privacy and the Exporter
129             # in Chapter 11: Modules
130             # of ISBN 978-0-596-00492-7 Programming Perl 4th Edition.
131             #
132             # A module can do anything it jolly well pleases when it's used, since use just
133             # calls the ordinary import method for the module, and you can define that
134             # method to do anything you like.
135              
136             sub import {
137              
138 0 50   384   0 if (Egbk::e("$filename.e")) {
139 0 0       0 if (exists $ENV{'CHAR_DEBUG'}) {
    0          
140 0         0 Egbk::unlink "$filename.e";
141             }
142             elsif (Egbk::z("$filename.e")) {
143 0         0 Egbk::unlink "$filename.e";
144             }
145             else {
146              
147             #----------------------------------------------------
148             # older >
149             # newer >>>>>
150             #----------------------------------------------------
151             # Filter >
152             # Source >>>>>
153             # Escape >>> needs re-escape (Source was changed)
154             #
155             # Filter >>>
156             # Source >>>>>
157             # Escape > needs re-escape (Source was changed)
158             #
159             # Filter >>>>>
160             # Source >>>
161             # Escape > needs re-escape (Source was changed)
162             #
163             # Filter >>>>>
164             # Source >
165             # Escape >>> needs re-escape (Filter was changed)
166             #
167             # Filter >
168             # Source >>>
169             # Escape >>>>> executable without re-escape
170             #
171             # Filter >>>
172             # Source >
173             # Escape >>>>> executable without re-escape
174             #----------------------------------------------------
175              
176 0         0 my $mtime_filter = (Egbk::stat(__FILE__ ))[9];
177 0         0 my $mtime_source = (Egbk::stat($filename ))[9];
178 0         0 my $mtime_escape = (Egbk::stat("$filename.e"))[9];
179 0 0 0     0 if (($mtime_escape < $mtime_source) or ($mtime_escape < $mtime_filter)) {
180 384         1623 Egbk::unlink "$filename.e";
181             }
182             }
183             }
184              
185 384 50       1059 if (not Egbk::e("$filename.e")) {
186 384         1759 my $fh = gensym();
187 384 50       3398 Egbk::_open_a($fh, "$filename.e") or die __FILE__, ": Can't write open file: $filename.e\n";
188              
189             # 7.19. Flushing Output
190             # in Chapter 7. File Access
191             # of ISBN 0-596-00313-7 Perl Cookbook, 2nd Edition.
192              
193 384         1704 select((select($fh), $|=1)[0]);
194              
195 0 50       0 if (0) {
196             }
197 0         0 elsif (exists $ENV{'CHAR_NONBLOCK'}) {
198              
199             # P.419 File Locking
200             # in Chapter 16: Interprocess Communication
201             # of ISBN 0-596-00027-8 Programming Perl Third Edition.
202              
203             # P.524 File Locking
204             # in Chapter 15: Interprocess Communication
205             # of ISBN 978-0-596-00492-7 Programming Perl 4th Edition.
206              
207             # P.571 Handling Race Conditions
208             # in Chapter 23: Security
209             # of ISBN 0-596-00027-8 Programming Perl Third Edition.
210              
211             # P.663 Handling Race Conditions
212             # in Chapter 20: Security
213             # of ISBN 978-0-596-00492-7 Programming Perl 4th Edition.
214              
215             # (and so on)
216              
217 0         0 CORE::eval q{ flock($fh, LOCK_EX | LOCK_NB) };
218 0 0       0 if ($@) {
219 384         25934 die __FILE__, ": Can't immediately write-lock the file: $filename.e\n";
220             }
221             }
222             else {
223 384         16386 CORE::eval q{ flock($fh, LOCK_EX) };
224             }
225              
226 384         4913 CORE::eval q{ truncate($fh, 0) };
227 384 50       1389 seek($fh, 0, 0) or die __FILE__, ": Can't seek file: $filename.e\n";
228              
229 384         981 my $e_script = GBK::escape_script($filename);
230 384         36875 print {$fh} $e_script;
  384         3673  
231              
232 384         17821 my $mode = (Egbk::stat($filename))[2] & 0777;
233 384         63341 chmod $mode, "$filename.e";
234              
235 384 50       3283 close($fh) or die "Can't close file: $filename.e: $!";
236             }
237              
238 384         2968 my $fh = gensym();
239 384 50       2537 Egbk::_open_r($fh, "$filename.e") or die __FILE__, ": Can't read open file: $filename.e\n";
240              
241 0 50       0 if (0) {
242             }
243 0         0 elsif (exists $ENV{'CHAR_NONBLOCK'}) {
244 0         0 CORE::eval q{ flock($fh, LOCK_SH | LOCK_NB) };
245 0 0       0 if ($@) {
246 384         32512 die __FILE__, ": Can't immediately read-lock the file: $filename.e\n";
247             }
248             }
249             else {
250 384         1958 CORE::eval q{ flock($fh, LOCK_SH) };
251             }
252              
253 384         2044 my @switch = ();
254 0 50       0 if ($^W) {
255 384         1925 push @switch, '-w';
256             }
257 0 50       0 if (defined $^I) {
258 0         0 push @switch, '-i' . $^I;
259 384         840 undef $^I;
260             }
261              
262             # P.707 29.2.33. exec
263             # in Chapter 29: Functions
264             # of ISBN 0-596-00027-8 Programming Perl Third Edition.
265             #
266             # If there is more than one argument in LIST, or if LIST is an array with more
267             # than one value, the system shell will never be used. This also bypasses any
268             # shell processing of the command. The presence or absence of metacharacters in
269             # the arguments doesn't affect this list-triggered behavior, which makes it the
270             # preferred from in security-conscious programs that do not with to expose
271             # themselves to potential shell escapes.
272             # Environment variable PERL5SHELL(Microsoft ports only) will never be used, too.
273              
274             # P.855 exec
275             # in Chapter 27: Functions
276             # of ISBN 978-0-596-00492-7 Programming Perl 4th Edition.
277             #
278             # If there is more than one argument in LIST, or if LIST is an array with more
279             # than one value, the system shell will never be used. This also bypasses any
280             # shell processing of the command. The presence or absence of metacharacters in
281             # the arguments doesn't affect this list-triggered behavior, which makes it the
282             # preferred from in security-conscious programs that do not wish to expose
283             # themselves to injection attacks via shell escapes.
284             # Environment variable PERL5SHELL(Microsoft ports only) will never be used, too.
285              
286             # P.489 #! and Quoting on Non-Unix Systems
287             # in Chapter 19: The Command-Line Interface
288             # of ISBN 0-596-00027-8 Programming Perl Third Edition.
289              
290             # P.578 #! and Quoting on Non-Unix Systems
291             # in Chapter 17: The Command-Line Interface
292             # of ISBN 978-0-596-00492-7 Programming Perl 4th Edition.
293              
294 384         2644 my $system = 0;
295              
296             # DOS-like system
297 0 50       0 if ($^O =~ /\A (?: MSWin32 | NetWare | symbian | dos ) \z/oxms) {
298             $system = Egbk::_systemx(
299             _escapeshellcmd_MSWin32($^X),
300              
301             # -I switch can not treat space included path
302             # (map { '-I' . _escapeshellcmd_MSWin32($_) } @INC),
303 0         0 (map { '-I' . $_ } @INC),
304              
305             @switch,
306             '--',
307 0         0 map { _escapeshellcmd_MSWin32($_) } "$filename.e", @ARGV
  384         1917  
308             );
309             }
310              
311             # UNIX-like system
312             else {
313             $system = Egbk::_systemx(
314             _escapeshellcmd($^X),
315 384         1150 (map { '-I' . _escapeshellcmd($_) } @INC),
316             @switch,
317             '--',
318 4608         6566 map { _escapeshellcmd($_) } "$filename.e", @ARGV
  384         698439  
319             );
320             }
321              
322             # exit with actual exit value
323 0         0 exit($system >> 8);
324             }
325              
326             # escape shell command line on DOS-like system
327             sub _escapeshellcmd_MSWin32 {
328 0     0   0 my($word) = @_;
329 0 0       0 if ($word =~ / [ ] /oxms) {
330 0         0 return qq{"$word"};
331             }
332             else {
333 5376         7867 return $word;
334             }
335             }
336              
337             # escape shell command line on UNIX-like system
338             sub _escapeshellcmd {
339 5376     5376   13897 my($word) = @_;
340 384         973 return $word;
341             }
342              
343             # P.619 Source Filters
344             # in Chapter 24: Common Practices
345             # of ISBN 0-596-00027-8 Programming Perl Third Edition.
346              
347             # P.718 Source Filters
348             # in Chapter 21: Common Practices
349             # of ISBN 978-0-596-00492-7 Programming Perl 4th Edition.
350              
351             # escape GBK script
352             sub GBK::escape_script {
353 384     384 0 667 my($script) = @_;
354 384         1059 my $e_script = '';
355              
356             # read GBK script
357 384         1458 my $fh = gensym();
358 384 50       2086 Egbk::_open_r($fh, $script) or die __FILE__, ": Can't open file: $script\n";
359 384         8248 local $/ = undef; # slurp mode
360 384         4564 $_ = <$fh>;
361 384 50       1966 close($fh) or die "Can't close file: $script: $!";
362              
363 0 50       0 if (/^ use Egbk(?:(?>\s+)(?>[0-9\.]*))?(?>\s*); $/oxms) {
364 384         1919 return $_;
365             }
366             else {
367              
368             # #! shebang line
369 0 50       0 if (s/\A(#!.+?\n)//oms) {
370 0         0 my $head = $1;
371 0         0 $head =~ s/\bjperl\b/perl/gi;
372 384         1099 $e_script .= $head;
373             }
374              
375             # DOS-like system header
376 0 50       0 if (s/\A(\@rem(?>\s*)=(?>\s*)'.*?'(?>\s*);\s*\n)//oms) {
377 0         0 my $head = $1;
378 0         0 $head =~ s/\bjperl\b/perl/gi;
379 384         15658 $e_script .= $head;
380             }
381              
382             # P.618 Generating Perl in Other Languages
383             # in Chapter 24: Common Practices
384             # of ISBN 0-596-00027-8 Programming Perl Third Edition.
385              
386             # P.717 Generating Perl in Other Languages
387             # in Chapter 21: Common Practices
388             # of ISBN 978-0-596-00492-7 Programming Perl 4th Edition.
389              
390 0 50       0 if (s/(.*^#(?>\s*)line(?>\s+)(?>[0-9]+)(?:(?>\s+)"(?:$q_char)+?")?\s*\n)//oms) {
391 0         0 my $head = $1;
392 0         0 $head =~ s/\bjperl\b/perl/gi;
393 384         2298 $e_script .= $head;
394             }
395              
396             # P.210 5.10.3.3. Match-time code evaluation
397             # in Chapter 5: Pattern Matching
398             # of ISBN 0-596-00027-8 Programming Perl Third Edition.
399              
400             # P.255 Match-time code evaluation
401             # in Chapter 5: Pattern Matching
402             # of ISBN 978-0-596-00492-7 Programming Perl 4th Edition.
403              
404             # '...' quote to avoid "Octal number in vector unsupported" on perl 5.6
405              
406 384         4410 $e_script .= sprintf("use Egbk '%s.0'; # 'quote' for perl5.6\n", $GBK::VERSION); # require run-time routines version
407              
408             # use GBK version qw(ord reverse getc);
409 384 50       1088 if (s/^ (?>\s*) use (?>\s+) (?: Char | GBK ) (?>\s*) ([^\x81-\xFE;]*) ; \s* \n? $//oxms) {
410              
411             # require version
412 384         1762 my $list = $1;
413 0 50       0 if ($list =~ s/\A ((?>[0-9]+)\.(?>[0-9]+)) \.0 (?>\s*) //oxms) {
    50          
414 0         0 my $version = $1;
415 0 0       0 if ($version ne $GBK::VERSION) {
416 0         0 my @file = grep -e, map {qq{$_/GBK.pm}} @INC;
  0         0  
417 0         0 my %file = map { $_ => 1 } @file;
  0         0  
418 0 0       0 if (scalar(keys %file) >= 2) {
419 0         0 my $file = join "\n", sort keys %file;
420 0         0 warn <
421             ****************************************************
422             C A U T I O N
423              
424             CONFLICT GBK.pm FILE
425              
426             $file
427             ****************************************************
428              
429             END
430             }
431 0         0 die "Script $0 expects GBK.pm $version, but @{[__FILE__]} is version $GBK::VERSION\n";
  0         0  
432             }
433 0         0 $e_script .= qq{die "Script \$0 expects Egbk.pm $version, but \\\$Egbk::VERSION is \$Egbk::VERSION" if \$Egbk::VERSION ne '$version';\n};
434             }
435             elsif ($list =~ s/\A ((?>[0-9]+)(?>\.[0-9]*)) (?>\s*) //oxms) {
436 0         0 my $version = $1;
437 0 0       0 if ($version > $GBK::VERSION) {
438 0         0 die "Script $0 required GBK.pm $version, but @{[__FILE__]} is only version $GBK::VERSION\n";
  384         17820  
439             }
440             }
441              
442             # demand ord, reverse, and getc
443 0 50       0 if ($list !~ /\A (?>\s*) \z/oxms) {
444 0         0 local $@;
445 0         0 my @list = CORE::eval $list;
446 0         0 for (@list) {
447 0 0       0 $Egbk::function_ord = 'GBK::ord' if /\A ord \z/oxms;
448 0 0       0 $Egbk::function_ord_ = 'GBK::ord_' if /\A ord \z/oxms;
449 0 0       0 $Egbk::function_reverse = 'GBK::reverse' if /\A reverse \z/oxms;
450 384 0       1555 $Egbk::function_getc = 'GBK::getc' if /\A getc \z/oxms;
451             }
452             }
453             }
454             }
455              
456 384         3950 $e_script .= GBK::escape();
457              
458             return $e_script;
459             }
460              
461             1;
462              
463             __END__