home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _8a7e3dcb5530901862e1c82a9d3a4cff < prev    next >
Text File  |  2000-03-15  |  8KB  |  266 lines
  1. package URI::file;
  2.  
  3. use strict;
  4. use vars qw(@ISA);
  5.  
  6. require URI::_generic;
  7. @ISA = qw(URI::_generic);
  8.  
  9. # Map from $^O values to implementation classes.  The Unix
  10. # class is the default.
  11. my %os_class = (
  12.      os2     => "OS2",
  13.      mac     => "Mac",
  14.      MacOS   => "Mac",
  15.      MSWin32 => "Win32",
  16.      win32   => "Win32",
  17.      msdos   => "FAT",
  18.      dos     => "FAT",
  19. );
  20.  
  21. sub os_class
  22. {
  23.     my($OS) = shift || $^O;
  24.  
  25.     my $class = "URI::file::" . ($os_class{$OS} || "Unix");
  26.     no strict 'refs';
  27.     unless (%{"$class\::"}) {
  28.     eval "require $class";
  29.     die $@ if $@;
  30.     }
  31.     $class;
  32. }
  33.  
  34. sub path { shift->path_query(@_) }
  35. sub host { shift->authority(@_)  }
  36.  
  37. sub new
  38. {
  39.     my($class, $path, $os) = @_;
  40.     os_class($os)->new($path);
  41. }
  42.  
  43. sub new_abs
  44. {
  45.     my $class = shift;
  46.     my $file = $class->new(shift);
  47.     return $file->abs($class->cwd) unless $$file =~ /^file:/;
  48.     $file;
  49. }
  50.  
  51. sub cwd
  52. {
  53.     my $class = shift;
  54.     require Cwd;
  55.     my $cwd = $class->new(Cwd::cwd());
  56.     $cwd .= "/" unless substr($cwd, -1, 1) eq "/";
  57.     $cwd;
  58. }
  59.  
  60. sub file
  61. {
  62.     my($self, $os) = @_;
  63.     os_class($os)->file($self);
  64. }
  65.  
  66. sub dir
  67. {
  68.     my($self, $os) = @_;
  69.     os_class($os)->dir($self);
  70. }
  71.  
  72. 1;
  73.  
  74. __END__
  75.  
  76. =head1 NAME
  77.  
  78. URI::file - URI that map to local file names
  79.  
  80. =head1 SYNOPSIS
  81.  
  82.  use URI::file;
  83.  
  84.  $u1 = URI->new("file:/foo/bar");
  85.  $u2 = URI->new("foo/bar", "file");
  86.  
  87.  $u3 = URI::file->new($path);
  88.  $u4 = URI::file->new("c:\\windows\\", "win32");
  89.  
  90.  $u1->file;
  91.  $u1->file("mac");
  92.  
  93. =head1 DESCRIPTION
  94.  
  95. The C<URI::file> class supports C<URI> objects belonging to the I<file>
  96. URI scheme.  This scheme allows us to map the conventional file names
  97. found on various computer systems to the URI name space.  An old
  98. specification of the I<file> URI scheme is found in RFC 1738.  Some
  99. older background information is also in RFC 1630. There are no newer
  100. specifications as far as I know.
  101.  
  102. If you want simply to construct I<file> URI objects from URI strings,
  103. use the normal C<URI> constructor.  If you want to construct I<file>
  104. URI objects from the actual file names used by various systems, then
  105. use one of the following C<URI::file> constructors:
  106.  
  107. =over 4
  108.  
  109. =item $u = URI::file->new( $filename, [$os] )
  110.  
  111. Maps a file name to the I<file:> URI name space, creates an URI object
  112. and returns it.  The $filename is interpreted as one belonging to the
  113. indicated operating system ($os), which defaults to the value of the
  114. $^O variable.  The $filename can be either absolute or relative, and
  115. the corresponding type of URI object for $os is returned.
  116.  
  117. =item $u = URI::file->new_abs( $filename, [$os] )
  118.  
  119. Same as URI::file->new, but will make sure that the URI returned
  120. represents an absolute file name.  If the $filename argument is
  121. relative, then the name is resolved relative to the current directory,
  122. i.e. this constructor is really the same as:
  123.  
  124.   URI::file->new($filename)->abs(URI::file->cwd);
  125.  
  126. =item $u = URI::file->cwd
  127.  
  128. Returns a I<file> URI that represents the current working directory.
  129. See L<Cwd>.
  130.  
  131. =back
  132.  
  133. The following methods are supported for I<file> URI (in addition to
  134. the common and generic methods described in L<URI>):
  135.  
  136. =over 4
  137.  
  138. =item $u->file( [$os] )
  139.  
  140. This method return a file name.  It maps from the URI name space
  141. to the file name space of the indicated operating system.
  142.  
  143. It might return U<undef> if the name can not be represented in the
  144. indicated file system.
  145.  
  146. =item $u->dir( [$os] )
  147.  
  148. Some systems use a different form for names of directories than for plain
  149. files.  Use this method if you know you want to use the name for
  150. a directory.
  151.  
  152. =back
  153.  
  154. The C<URI::file> module can be used to map generic file names to names
  155. suitable for the current system.  As such, it can work as a nice
  156. replacement for the C<File::Spec> module.  For instance the following
  157. code will translate the Unix style file name F<Foo/Bar.pm> to a name
  158. suitable for the local system.
  159.  
  160.   $file = URI::file->new("Foo/Bar.pm", "unix")->file;
  161.   die "Can't map filename Foo/Bar.pm for $^O" unless defined $file;
  162.   open(FILE, $file) || die "Can't open '$file': $!";
  163.   # do something with FILE
  164.  
  165. =head1 MAPPING NOTES
  166.  
  167. Most computer systems today have hierarchically organized file systems.
  168. Mapping the names used in these systems to the generic URI syntax
  169. allows us to work with relative file URIs that behave as they should
  170. when resolved using the generic algorithm for URIs (specified in RFC
  171. 2396).  Mapping a file name to the generic URI syntax involves mapping
  172. the path separator character to "/" and encoding of any reserved
  173. characters that appear in the path segments of the file names.  If
  174. path segments consisting of the strings "." or ".." have a
  175. different meaning than what is specified for generic URIs, then these
  176. must be encoded as well.
  177.  
  178. If the file system has device, volume or drive specifications as
  179. the root of the name space, then it makes sense to map them to the
  180. authority field of the generic URI syntax.  This makes sure that
  181. relative URI can not be resolved "above" them , i.e. generally how
  182. relative file names work in those systems.
  183.  
  184. Another common use of the authority field is to encode the host that
  185. this file name is valid on.  The host name "localhost" is special and
  186. generally have the same meaning as an missing or empty authority
  187. field.  This use will be in conflict with using it as a device
  188. specification, but can often be resolved for device specifications
  189. having characters not legal in plain host names.
  190.  
  191. File name to URI mapping in normally not one-to-one.  There are
  192. usually many URI that map to the same file name.  For instance an
  193. authority of "localhost" maps the same as a URI with a missing or empty
  194. authority.
  195.  
  196. Example 1: The Mac use ":" as path separator, but not in the same way
  197. as generic URI. ":foo" is a relative name.  "foo:bar" is an absolute
  198. name.  Also path segments can contain the "/" character as well as be
  199. literal "." or "..".  It means that we will map like this:
  200.  
  201.   Mac                   URI
  202.   ----------            -------------------
  203.   :foo:bar     <==>     foo/bar
  204.   :            <==>     ./
  205.   ::foo:bar    <==>     ../foo/bar
  206.   :::          <==>     ../../
  207.   foo:bar      <==>     file:/foo/bar
  208.   foo:bar:     <==>     file:/foo/bar/
  209.   ..           <==>     %2E%2E
  210.   <undef>      <==      /
  211.   foo/         <==      file:/foo%2F
  212.   ./foo.txt    <==      file:/.%2Ffoo.txt
  213.   
  214. Note that if you want a relative URL, you *must* begin the path with a :.  Any
  215. path that begins with [^:] will be treated as absolute.
  216.  
  217. Example 2: The Unix file system is easy to map as it use the same path
  218. separator as URIs, have a single root, and segments of "." and ".."
  219. have the same meaning.  URIs that have the character "\0" or "/" as
  220. part of any path segment can not be turned into valid Unix file names.
  221.  
  222.   Unix                  URI
  223.   ----------            ------------------
  224.   foo/bar      <==>     foo/bar
  225.   /foo/bar     <==>     file:/foo/bar
  226.   /foo/bar     <==      file://localhost/foo/bar
  227.   file:         ==>     ./file:
  228.   <undef>      <==      file:/fo%00/bar
  229.   /            <==>     file:/
  230.  
  231. =cut
  232.  
  233.  
  234. RFC 1630
  235.  
  236.    [...]
  237.  
  238.    There is clearly a danger of confusion that a link made to a local
  239.    file should be followed by someone on a different system, with
  240.    unexpected and possibly harmful results.  Therefore, the convention
  241.    is that even a "file" URL is provided with a host part.  This allows
  242.    a client on another system to know that it cannot access the file
  243.    system, or perhaps to use some other local mechanism to access the
  244.    file.
  245.  
  246.    The special value "localhost" is used in the host field to indicate
  247.    that the filename should really be used on whatever host one is.
  248.    This for example allows links to be made to files which are
  249.    distribted on many machines, or to "your unix local password file"
  250.    subject of course to consistency across the users of the data.
  251.  
  252.    A void host field is equivalent to "localhost".
  253.  
  254. =head1 SEE ALSO
  255.  
  256. L<URI>, L<File::Spec>, L<perlport>
  257.  
  258. =head1 COPYRIGHT
  259.  
  260. Copyright 1995-1998 Gisle Aas.
  261.  
  262. This library is free software; you can redistribute it and/or
  263. modify it under the same terms as Perl itself.
  264.  
  265. =cut
  266.