1package File::Spec::VMS; 2 3use strict; 4use vars qw(@ISA $VERSION); 5require File::Spec::Unix; 6 7$VERSION = '1.4'; 8 9@ISA = qw(File::Spec::Unix); 10 11use File::Basename; 12use VMS::Filespec; 13 14=head1 NAME 15 16File::Spec::VMS - methods for VMS file specs 17 18=head1 SYNOPSIS 19 20 require File::Spec::VMS; # Done internally by File::Spec if needed 21 22=head1 DESCRIPTION 23 24See File::Spec::Unix for a documentation of the methods provided 25there. This package overrides the implementation of these methods, not 26the semantics. 27 28=over 4 29 30=item eliminate_macros 31 32Expands MM[KS]/Make macros in a text string, using the contents of 33identically named elements of C<%$self>, and returns the result 34as a file specification in Unix syntax. 35 36=cut 37 38sub eliminate_macros { 39 my($self,$path) = @_; 40 return '' unless $path; 41 $self = {} unless ref $self; 42 43 if ($path =~ /\s/) { 44 return join ' ', map { $self->eliminate_macros($_) } split /\s+/, $path; 45 } 46 47 my($npath) = unixify($path); 48 my($complex) = 0; 49 my($head,$macro,$tail); 50 51 # perform m##g in scalar context so it acts as an iterator 52 while ($npath =~ m#(.*?)\$\((\S+?)\)(.*)#gs) { 53 if ($self->{$2}) { 54 ($head,$macro,$tail) = ($1,$2,$3); 55 if (ref $self->{$macro}) { 56 if (ref $self->{$macro} eq 'ARRAY') { 57 $macro = join ' ', @{$self->{$macro}}; 58 } 59 else { 60 print "Note: can't expand macro \$($macro) containing ",ref($self->{$macro}), 61 "\n\t(using MMK-specific deferred substitutuon; MMS will break)\n"; 62 $macro = "\cB$macro\cB"; 63 $complex = 1; 64 } 65 } 66 else { ($macro = unixify($self->{$macro})) =~ s#/\Z(?!\n)##; } 67 $npath = "$head$macro$tail"; 68 } 69 } 70 if ($complex) { $npath =~ s#\cB(.*?)\cB#\${$1}#gs; } 71 $npath; 72} 73 74=item fixpath 75 76Catchall routine to clean up problem MM[SK]/Make macros. Expands macros 77in any directory specification, in order to avoid juxtaposing two 78VMS-syntax directories when MM[SK] is run. Also expands expressions which 79are all macro, so that we can tell how long the expansion is, and avoid 80overrunning DCL's command buffer when MM[KS] is running. 81 82If optional second argument has a TRUE value, then the return string is 83a VMS-syntax directory specification, if it is FALSE, the return string 84is a VMS-syntax file specification, and if it is not specified, fixpath() 85checks to see whether it matches the name of a directory in the current 86default directory, and returns a directory or file specification accordingly. 87 88=cut 89 90sub fixpath { 91 my($self,$path,$force_path) = @_; 92 return '' unless $path; 93 $self = bless {} unless ref $self; 94 my($fixedpath,$prefix,$name); 95 96 if ($path =~ /\s/) { 97 return join ' ', 98 map { $self->fixpath($_,$force_path) } 99 split /\s+/, $path; 100 } 101 102 if ($path =~ m#^\$\([^\)]+\)\Z(?!\n)#s || $path =~ m#[/:>\]]#) { 103 if ($force_path or $path =~ /(?:DIR\)|\])\Z(?!\n)/) { 104 $fixedpath = vmspath($self->eliminate_macros($path)); 105 } 106 else { 107 $fixedpath = vmsify($self->eliminate_macros($path)); 108 } 109 } 110 elsif ((($prefix,$name) = ($path =~ m#^\$\(([^\)]+)\)(.+)#s)) && $self->{$prefix}) { 111 my($vmspre) = $self->eliminate_macros("\$($prefix)"); 112 # is it a dir or just a name? 113 $vmspre = ($vmspre =~ m|/| or $prefix =~ /DIR\Z(?!\n)/) ? vmspath($vmspre) : ''; 114 $fixedpath = ($vmspre ? $vmspre : $self->{$prefix}) . $name; 115 $fixedpath = vmspath($fixedpath) if $force_path; 116 } 117 else { 118 $fixedpath = $path; 119 $fixedpath = vmspath($fixedpath) if $force_path; 120 } 121 # No hints, so we try to guess 122 if (!defined($force_path) and $fixedpath !~ /[:>(.\]]/) { 123 $fixedpath = vmspath($fixedpath) if -d $fixedpath; 124 } 125 126 # Trim off root dirname if it's had other dirs inserted in front of it. 127 $fixedpath =~ s/\.000000([\]>])/$1/; 128 # Special case for VMS absolute directory specs: these will have had device 129 # prepended during trip through Unix syntax in eliminate_macros(), since 130 # Unix syntax has no way to express "absolute from the top of this device's 131 # directory tree". 132 if ($path =~ /^[\[>][^.\-]/) { $fixedpath =~ s/^[^\[<]+//; } 133 $fixedpath; 134} 135 136=back 137 138=head2 Methods always loaded 139 140=over 4 141 142=item canonpath (override) 143 144Removes redundant portions of file specifications according to VMS syntax. 145 146=cut 147 148sub canonpath { 149 my($self,$path) = @_; 150 151 if ($path =~ m|/|) { # Fake Unix 152 my $pathify = $path =~ m|/\Z(?!\n)|; 153 $path = $self->SUPER::canonpath($path); 154 if ($pathify) { return vmspath($path); } 155 else { return vmsify($path); } 156 } 157 else { 158 $path =~ s/([\[<])000000\./$1/g; # [000000.foo ==> [foo 159 $path =~ s/([^-]+)\.(\]\[|><)?000000([\]\>])/$1$3/g; # foo.000000] ==> foo] 160 $path =~ s-\]\[--g; $path =~ s/><//g; # foo.][bar ==> foo.bar 161 1 while $path =~ s{([\[<-])\.-}{$1-}; # [.-.- ==> [-- 162 $path =~ s/\.[^\[<\.]+\.-([\]\>])/$1/; # bar.foo.-] ==> bar] 163 $path =~ s/([\[<])(-+)/$1 . "\cx" x length($2)/e; # encode leading '-'s 164 $path =~ s/([\[<\.])([^\[<\.\cx]+)\.-\.?/$1/g; # bar.-.foo ==> foo 165 $path =~ s/([\[<])(\cx+)/$1 . '-' x length($2)/e; # then decode 166 $path =~ s/^[\[<\]>]{2}//; # []foo ==> foo 167 return $path; 168 } 169} 170 171=item catdir 172 173Concatenates a list of file specifications, and returns the result as a 174VMS-syntax directory specification. No check is made for "impossible" 175cases (e.g. elements other than the first being absolute filespecs). 176 177=cut 178 179sub catdir { 180 my ($self,@dirs) = @_; 181 my $dir = pop @dirs; 182 @dirs = grep($_,@dirs); 183 my $rslt; 184 if (@dirs) { 185 my $path = (@dirs == 1 ? $dirs[0] : $self->catdir(@dirs)); 186 my ($spath,$sdir) = ($path,$dir); 187 $spath =~ s/\.dir\Z(?!\n)//; $sdir =~ s/\.dir\Z(?!\n)//; 188 $sdir = $self->eliminate_macros($sdir) unless $sdir =~ /^[\w\-]+\Z(?!\n)/s; 189 $rslt = $self->fixpath($self->eliminate_macros($spath)."/$sdir",1); 190 191 # Special case for VMS absolute directory specs: these will have had device 192 # prepended during trip through Unix syntax in eliminate_macros(), since 193 # Unix syntax has no way to express "absolute from the top of this device's 194 # directory tree". 195 if ($spath =~ /^[\[<][^.\-]/s) { $rslt =~ s/^[^\[<]+//s; } 196 } 197 else { 198 if (not defined $dir or not length $dir) { $rslt = ''; } 199 elsif ($dir =~ /^\$\([^\)]+\)\Z(?!\n)/s) { $rslt = $dir; } 200 else { $rslt = vmspath($dir); } 201 } 202 return $self->canonpath($rslt); 203} 204 205=item catfile 206 207Concatenates a list of file specifications, and returns the result as a 208VMS-syntax file specification. 209 210=cut 211 212sub catfile { 213 my ($self,@files) = @_; 214 my $file = $self->canonpath(pop @files); 215 @files = grep($_,@files); 216 my $rslt; 217 if (@files) { 218 my $path = (@files == 1 ? $files[0] : $self->catdir(@files)); 219 my $spath = $path; 220 $spath =~ s/\.dir\Z(?!\n)//; 221 if ($spath =~ /^[^\)\]\/:>]+\)\Z(?!\n)/s && basename($file) eq $file) { 222 $rslt = "$spath$file"; 223 } 224 else { 225 $rslt = $self->eliminate_macros($spath); 226 $rslt = vmsify($rslt.($rslt ? '/' : '').unixify($file)); 227 } 228 } 229 else { $rslt = (defined($file) && length($file)) ? vmsify($file) : ''; } 230 return $self->canonpath($rslt); 231} 232 233 234=item curdir (override) 235 236Returns a string representation of the current directory: '[]' 237 238=cut 239 240sub curdir { 241 return '[]'; 242} 243 244=item devnull (override) 245 246Returns a string representation of the null device: '_NLA0:' 247 248=cut 249 250sub devnull { 251 return "_NLA0:"; 252} 253 254=item rootdir (override) 255 256Returns a string representation of the root directory: 'SYS$DISK:[000000]' 257 258=cut 259 260sub rootdir { 261 return 'SYS$DISK:[000000]'; 262} 263 264=item tmpdir (override) 265 266Returns a string representation of the first writable directory 267from the following list or '' if none are writable: 268 269 sys$scratch: 270 $ENV{TMPDIR} 271 272Since perl 5.8.0, if running under taint mode, and if $ENV{TMPDIR} 273is tainted, it is not used. 274 275=cut 276 277my $tmpdir; 278sub tmpdir { 279 return $tmpdir if defined $tmpdir; 280 my $self = shift; 281 $tmpdir = $self->_tmpdir( 'sys$scratch:', $ENV{TMPDIR} ); 282} 283 284=item updir (override) 285 286Returns a string representation of the parent directory: '[-]' 287 288=cut 289 290sub updir { 291 return '[-]'; 292} 293 294=item case_tolerant (override) 295 296VMS file specification syntax is case-tolerant. 297 298=cut 299 300sub case_tolerant { 301 return 1; 302} 303 304=item path (override) 305 306Translate logical name DCL$PATH as a searchlist, rather than trying 307to C<split> string value of C<$ENV{'PATH'}>. 308 309=cut 310 311sub path { 312 my (@dirs,$dir,$i); 313 while ($dir = $ENV{'DCL$PATH;' . $i++}) { push(@dirs,$dir); } 314 return @dirs; 315} 316 317=item file_name_is_absolute (override) 318 319Checks for VMS directory spec as well as Unix separators. 320 321=cut 322 323sub file_name_is_absolute { 324 my ($self,$file) = @_; 325 # If it's a logical name, expand it. 326 $file = $ENV{$file} while $file =~ /^[\w\$\-]+\Z(?!\n)/s && $ENV{$file}; 327 return scalar($file =~ m!^/!s || 328 $file =~ m![<\[][^.\-\]>]! || 329 $file =~ /:[^<\[]/); 330} 331 332=item splitpath (override) 333 334Splits using VMS syntax. 335 336=cut 337 338sub splitpath { 339 my($self,$path) = @_; 340 my($dev,$dir,$file) = ('','',''); 341 342 vmsify($path) =~ /(.+:)?([\[<].*[\]>])?(.*)/s; 343 return ($1 || '',$2 || '',$3); 344} 345 346=item splitdir (override) 347 348Split dirspec using VMS syntax. 349 350=cut 351 352sub splitdir { 353 my($self,$dirspec) = @_; 354 $dirspec =~ s/\]\[//g; $dirspec =~ s/\-\-/-.-/g; 355 $dirspec = "[$dirspec]" unless $dirspec =~ /[\[<]/; # make legal 356 my(@dirs) = split('\.', vmspath($dirspec)); 357 $dirs[0] =~ s/^[\[<]//s; $dirs[-1] =~ s/[\]>]\Z(?!\n)//s; 358 @dirs; 359} 360 361 362=item catpath (override) 363 364Construct a complete filespec using VMS syntax 365 366=cut 367 368sub catpath { 369 my($self,$dev,$dir,$file) = @_; 370 371 # We look for a volume in $dev, then in $dir, but not both 372 my ($dir_volume, $dir_dir, $dir_file) = $self->splitpath($dir); 373 $dev = $dir_volume unless length $dev; 374 $dir = length $dir_file ? $self->catfile($dir_dir, $dir_file) : $dir_dir; 375 376 if ($dev =~ m|^/+([^/]+)|) { $dev = "$1:"; } 377 else { $dev .= ':' unless $dev eq '' or $dev =~ /:\Z(?!\n)/; } 378 if (length($dev) or length($dir)) { 379 $dir = "[$dir]" unless $dir =~ /[\[<\/]/; 380 $dir = vmspath($dir); 381 } 382 "$dev$dir$file"; 383} 384 385=item abs2rel (override) 386 387Use VMS syntax when converting filespecs. 388 389=cut 390 391sub abs2rel { 392 my $self = shift; 393 return vmspath(File::Spec::Unix::abs2rel( $self, @_ )) 394 if grep m{/}, @_; 395 396 my($path,$base) = @_; 397 $base = $self->_cwd() unless defined $base and length $base; 398 399 for ($path, $base) { $_ = $self->canonpath($_) } 400 401 # Are we even starting $path on the same (node::)device as $base? Note that 402 # logical paths or nodename differences may be on the "same device" 403 # but the comparison that ignores device differences so as to concatenate 404 # [---] up directory specs is not even a good idea in cases where there is 405 # a logical path difference between $path and $base nodename and/or device. 406 # Hence we fall back to returning the absolute $path spec 407 # if there is a case blind device (or node) difference of any sort 408 # and we do not even try to call $parse() or consult %ENV for $trnlnm() 409 # (this module needs to run on non VMS platforms after all). 410 411 my ($path_volume, $path_directories, $path_file) = $self->splitpath($path); 412 my ($base_volume, $base_directories, $base_file) = $self->splitpath($base); 413 return $path unless lc($path_volume) eq lc($base_volume); 414 415 for ($path, $base) { $_ = $self->rel2abs($_) } 416 417 # Now, remove all leading components that are the same 418 my @pathchunks = $self->splitdir( $path_directories ); 419 unshift(@pathchunks,'000000') unless $pathchunks[0] eq '000000'; 420 my @basechunks = $self->splitdir( $base_directories ); 421 unshift(@basechunks,'000000') unless $basechunks[0] eq '000000'; 422 423 while ( @pathchunks && 424 @basechunks && 425 lc( $pathchunks[0] ) eq lc( $basechunks[0] ) 426 ) { 427 shift @pathchunks ; 428 shift @basechunks ; 429 } 430 431 # @basechunks now contains the directories to climb out of, 432 # @pathchunks now has the directories to descend in to. 433 $path_directories = join '.', ('-' x @basechunks, @pathchunks) ; 434 return $self->canonpath( $self->catpath( '', $path_directories, $path_file ) ) ; 435} 436 437 438=item rel2abs (override) 439 440Use VMS syntax when converting filespecs. 441 442=cut 443 444sub rel2abs { 445 my $self = shift ; 446 return vmspath(File::Spec::Unix::rel2abs( $self, @_ )) 447 if ( join( '', @_ ) =~ m{/} ) ; 448 449 my ($path,$base ) = @_; 450 # Clean up and split up $path 451 if ( ! $self->file_name_is_absolute( $path ) ) { 452 # Figure out the effective $base and clean it up. 453 if ( !defined( $base ) || $base eq '' ) { 454 $base = $self->_cwd; 455 } 456 elsif ( ! $self->file_name_is_absolute( $base ) ) { 457 $base = $self->rel2abs( $base ) ; 458 } 459 else { 460 $base = $self->canonpath( $base ) ; 461 } 462 463 # Split up paths 464 my ( $path_directories, $path_file ) = 465 ($self->splitpath( $path ))[1,2] ; 466 467 my ( $base_volume, $base_directories ) = 468 $self->splitpath( $base ) ; 469 470 $path_directories = '' if $path_directories eq '[]' || 471 $path_directories eq '<>'; 472 my $sep = '' ; 473 $sep = '.' 474 if ( $base_directories =~ m{[^.\]>]\Z(?!\n)} && 475 $path_directories =~ m{^[^.\[<]}s 476 ) ; 477 $base_directories = "$base_directories$sep$path_directories"; 478 $base_directories =~ s{\.?[\]>][\[<]\.?}{.}; 479 480 $path = $self->catpath( $base_volume, $base_directories, $path_file ); 481 } 482 483 return $self->canonpath( $path ) ; 484} 485 486 487=back 488 489=head1 SEE ALSO 490 491See L<File::Spec> and L<File::Spec::Unix>. This package overrides the 492implementation of these methods, not the semantics. 493 494An explanation of VMS file specs can be found at 495L<"http://h71000.www7.hp.com/doc/731FINAL/4506/4506pro_014.html#apps_locating_naming_files">. 496 497=cut 498 4991; 500