X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FFile%2FFetch.pm;h=8c8b3f90a573a2fe9bfd6ab1bf2ab7ea901424f6;hb=8fda732ba35b09fe6fd97b1463e2008d5752e71d;hp=8798c57f4fadb88e774a710617ff37ac88cf7ae0;hpb=9e5ea59563e1b664c302aaefa75df482b47774f5;p=p5sagit%2Fp5-mst-13.2.git diff --git a/lib/File/Fetch.pm b/lib/File/Fetch.pm index 8798c57..8c8b3f9 100644 --- a/lib/File/Fetch.pm +++ b/lib/File/Fetch.pm @@ -23,8 +23,9 @@ use vars qw[ $VERBOSE $PREFER_BIN $FROM_EMAIL $USER_AGENT use constant QUOTE => do { $^O eq 'MSWin32' ? q["] : q['] }; -$VERSION = '0.13_02'; -$PREFER_BIN = 0; # XXX TODO implement +$VERSION = '0.14'; +$VERSION = eval $VERSION; # avoid warnings with development releases +$PREFER_BIN = 0; # XXX TODO implement $FROM_EMAIL = 'File-Fetch@example.com'; $USER_AGENT = 'File::Fetch/$VERSION'; $BLACKLIST = [qw|ftp|]; @@ -51,8 +52,9 @@ local $Module::Load::Conditional::VERBOSE = 0; ### see what OS we are on, important for file:// uris ### use constant ON_WIN => ($^O eq 'MSWin32'); use constant ON_VMS => ($^O eq 'VMS'); -use constant ON_UNIX => (!ON_WIN and !ON_VMS); - +use constant ON_UNIX => (!ON_WIN); +use constant HAS_VOL => (ON_WIN); +use constant HAS_SHARE => (ON_WIN); =pod =head1 NAME @@ -104,7 +106,28 @@ The scheme from the uri (like 'file', 'http', etc) =item $ff->host -The hostname in the uri, will be empty for a 'file' scheme. +The hostname in the uri. Will be empty if host was originally +'localhost' for a 'file://' url. + +=item $ff->vol + +On operating systems with the concept of a volume the second element +of a file:// is considered to the be volume specification for the file. +Thus on Win32 this routine returns the volume, on other operating +systems this returns nothing. + +On Windows this value may be empty if the uri is to a network share, in +which case the 'share' property will be defined. Additionally, volume +specifications that use '|' as ':' will be converted on read to use ':'. + +On VMS, which has a volume concept, this field will be empty because VMS +file specifications are converted to absolute UNIX format and the volume +information is transparently included. + +=item $ff->share + +On systems with the concept of a network share (currently only Windows) returns +the sharename from a file://// url. On other operating systems returns empty. =item $ff->path @@ -130,8 +153,8 @@ result of $ff->output_file will be used. path => { default => '/' }, file => { required => 1 }, uri => { required => 1 }, - vol => { }, # windows and vms for file:// uris - share => { }, # windows for file:// uris + vol => { default => '' }, # windows for file:// uris + share => { default => '' }, # windows for file:// uris _error_msg => { no_override => 1 }, _error_msg_long => { no_override => 1 }, }; @@ -276,14 +299,30 @@ sub new { ### ### In the case of file:// urls there maybe be additional fields ### +### For systems with volume specifications such as Win32 there will be +### a volume specifier provided in the 'vol' field. +### +### 'vol' => 'volumename' +### ### For windows file shares there may be a 'share' key specified ### ### 'share' => 'sharename' ### -### For systems with volume specifications such as VMS and Win32 there may be -### a volume specifier provided in the 'vol' field. +### Note that the rules of what a file:// url means vary by the operating system +### of the host being addressed. Thus file:///d|/foo/bar.txt means the obvious +### 'D:\foo\bar.txt' on windows, but on unix it means '/d|/foo/bar.txt' and +### not '/foo/bar.txt' ### -### 'vol' => 'volumename' +### Similarly if the host interpreting the url is VMS then +### file:///disk$user/my/notes/note12345.txt' means +### 'DISK$USER:[MY.NOTES]NOTE123456.TXT' but will be returned the same as +### if it is unix where it means /disk$user/my/notes/note12345.txt'. +### Except for some cases in the File::Spec methods, Perl on VMS will generally +### handle UNIX format file specifications. +### +### This means it is impossible to serve certain file:// urls on certain systems. +### +### Thus are the problems with a protocol-less specification. :-( ### sub _parse_uri { @@ -306,30 +345,36 @@ sub _parse_uri { ### file://hostname/... ### file://hostname/... + ### normalize file://localhost with file:/// $href->{host} = $parts[0] || ''; ### index in @parts where the path components begin; my $index = 1; - - ### file:///D|/blah.txt - ### file:///D:/blah.txt - ### file://hostname/D|/blah.txt - ### file://hostname/D:/blah.txt - if ($parts[1] =~ s/\A([A-Z])\|\z/$1:/i || # s/D|/D:/ - $parts[1] =~ m/\A[A-Z]:\z/i # m/D:/ - ) { - $href->{vol} = $parts[1]; - $index = 2; # index after the volume ### file:////hostname/sharename/blah.txt - } elsif ( not length $parts[0] and not length $parts[1] ) { + if ( HAS_SHARE and not length $parts[0] and not length $parts[1] ) { + $href->{host} = $parts[2] || ''; # avoid warnings $href->{share} = $parts[3] || ''; # avoid warnings $index = 4 # index after the share - } - ### rebuild the path from the leftover paths; + ### file:///D|/blah.txt + ### file:///D:/blah.txt + } elsif (HAS_VOL) { + + ### this code comes from dmq's patch, but: + ### XXX if volume is empty, wouldn't that be an error? --kane + ### if so, our file://localhost test needs to be fixed as wel + $href->{vol} = $parts[1] || ''; + + ### correct D| style colume descriptors + $href->{vol} =~ s/\A([A-Z])\|\z/$1:/i if ON_WIN; + + $index = 2; # index after the volume + } + + ### rebuild the path from the leftover parts; $href->{path} = join '/', '', splice( @parts, $index, $#parts ); } else { @@ -344,6 +389,10 @@ sub _parse_uri { $href->{file} = $parts[2]; } + ### host will be empty if the target was 'localhost' and the + ### scheme was 'file' + $href->{host} = '' if ($href->{host} eq 'localhost') and + ($href->{scheme} eq 'file'); return $href; } @@ -369,6 +418,9 @@ sub fetch { check( $tmpl, \%hash ) or return; + ### On VMS force to VMS format so File::Spec will work. + $to = VMS::Filespec::vmspath($to) if ON_VMS; + ### create the path if it doesn't exist yet ### unless( -d $to ) { eval { mkpath( $to ) }; @@ -379,8 +431,11 @@ sub fetch { ### set passive ftp if required ### local $ENV{FTP_PASSIVE} = $FTP_PASSIVE; - ### - my $out_to = File::Spec->catfile( $to, $self->output_file ); + ### we dont use catfile on win32 because if we are using a cygwin tool + ### under cmd.exe they wont understand windows style separators. + my $out_to = ON_WIN ? $to.'/'.$self->output_file + : File::Spec->catfile( $to, $self->output_file ); + for my $method ( @{ $METHODS->{$self->scheme} } ) { my $sub = '_'.$method.'_fetch'; @@ -812,11 +867,10 @@ sub _curl_fetch { ### use File::Copy for fetching file:// urls ### -### XXX file:// uri to local path conversion is just too weird... -### depend on LWP to do it for us ### ### See section 3.10 of RFC 1738 (http://www.faqs.org/rfcs/rfc1738.html) ### Also see wikipedia on file:// (http://en.wikipedia.org/wiki/File://) +### sub _file_fetch { my $self = shift; @@ -865,7 +919,12 @@ sub _file_fetch { $remote = "\\\\".$self->host."\\$share\\$path"; } else { - $remote = File::Spec->catfile( $path, $self->file ); + ### File::Spec on VMS can not currently handle UNIX syntax. + my $file_class = ON_VMS + ? 'File::Spec::Unix' + : 'File::Spec'; + + $remote = $file_class->catfile( $path, $self->file ); } ### File::Copy is littered with 'die' statements :( ### @@ -911,7 +970,8 @@ sub _rsync_fetch { verbose => $DEBUG ) ) { - return $self->_error(loc("Command failed: %1", $captured || '')); + return $self->_error(loc("Command %1 failed: %2", + "@$cmd" || '', $captured || '')); } return $to;