home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _025c7bb85b022b8c07f09ad5c26a7cea < prev    next >
Text File  |  2000-03-23  |  9KB  |  202 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>URI::file - URI that map to local file names</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> URI::file - URI that map to local file names</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#mapping notes">MAPPING NOTES</A></LI>
  26.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  27.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  28. </UL>
  29. <!-- INDEX END -->
  30.  
  31. <HR>
  32. <P>
  33. <H1><A NAME="name">NAME</A></H1>
  34. <P>URI::file - URI that map to local file names</P>
  35. <P>
  36. <HR>
  37. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  38. <UL>
  39. <LI>Linux</LI>
  40. <LI>Solaris</LI>
  41. <LI>Windows</LI>
  42. </UL>
  43. <HR>
  44. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  45. <PRE>
  46.  use URI::file;</PRE>
  47. <PRE>
  48.  $u1 = URI->new("<A HREF="file:/foo/bar"">file:/foo/bar"</A>;);
  49.  $u2 = URI->new("foo/bar", "file");</PRE>
  50. <PRE>
  51.  $u3 = URI::file->new($path);
  52.  $u4 = URI::file->new("c:\\windows\\", "win32");
  53. </PRE>
  54. <PRE>
  55.  
  56.  $u1->file;
  57.  $u1->file("mac");</PRE>
  58. <P>
  59. <HR>
  60. <H1><A NAME="description">DESCRIPTION</A></H1>
  61. <P>The <CODE>URI::file</CODE> class supports <CODE>URI</CODE> objects belonging to the <EM>file</EM>
  62. URI scheme.  This scheme allows us to map the conventional file names
  63. found on various computer systems to the URI name space.  An old
  64. specification of the <EM>file</EM> URI scheme is found in RFC 1738.  Some
  65. older background information is also in RFC 1630. There are no newer
  66. specifications as far as I know.</P>
  67. <P>If you want simply to construct <EM>file</EM> URI objects from URI strings,
  68. use the normal <CODE>URI</CODE> constructor.  If you want to construct <EM>file</EM>
  69. URI objects from the actual file names used by various systems, then
  70. use one of the following <CODE>URI::file</CODE> constructors:</P>
  71. <DL>
  72. <DT><STRONG><A NAME="item_new">$u = URI::file->new( $filename, [$os] )</A></STRONG><BR>
  73. <DD>
  74. Maps a file name to the <EM>file:</EM> URI name space, creates an URI object
  75. and returns it.  The $filename is interpreted as one belonging to the
  76. indicated operating system ($os), which defaults to the value of the
  77. $^O variable.  The $filename can be either absolute or relative, and
  78. the corresponding type of URI object for $os is returned.
  79. <P></P>
  80. <DT><STRONG><A NAME="item_new_abs">$u = URI::file->new_abs( $filename, [$os] )</A></STRONG><BR>
  81. <DD>
  82. Same as URI::file->new, but will make sure that the URI returned
  83. represents an absolute file name.  If the $filename argument is
  84. relative, then the name is resolved relative to the current directory,
  85. i.e. this constructor is really the same as:
  86. <PRE>
  87.   URI::file->new($filename)->abs(URI::file->cwd);</PRE>
  88. <P></P>
  89. <DT><STRONG><A NAME="item_cwd">$u = URI::file->cwd</A></STRONG><BR>
  90. <DD>
  91. Returns a <EM>file</EM> URI that represents the current working directory.
  92. See <A HREF="../../../lib/Cwd.html">the Cwd manpage</A>.
  93. <P></P></DL>
  94. <P>The following methods are supported for <EM>file</EM> URI (in addition to
  95. the common and generic methods described in <A HREF="../../../site/lib/URI.html">the URI manpage</A>):</P>
  96. <DL>
  97. <DT><STRONG><A NAME="item_file">$u->file( [$os] )</A></STRONG><BR>
  98. <DD>
  99. This method return a file name.  It maps from the URI name space
  100. to the file name space of the indicated operating system.
  101. <P>It might return U<undef> if the name can not be represented in the
  102. indicated file system.</P>
  103. <P></P>
  104. <DT><STRONG><A NAME="item_dir">$u->dir( [$os] )</A></STRONG><BR>
  105. <DD>
  106. Some systems use a different form for names of directories than for plain
  107. files.  Use this method if you know you want to use the name for
  108. a directory.
  109. <P></P></DL>
  110. <P>The <CODE>URI::file</CODE> module can be used to map generic file names to names
  111. suitable for the current system.  As such, it can work as a nice
  112. replacement for the <CODE>File::Spec</CODE> module.  For instance the following
  113. code will translate the Unix style file name <EM>Foo/Bar.pm</EM> to a name
  114. suitable for the local system.</P>
  115. <PRE>
  116.   $file = URI::file->new("Foo/Bar.pm", "unix")->file;
  117.   die "Can't map filename Foo/Bar.pm for $^O" unless defined $file;
  118.   open(FILE, $file) || die "Can't open '$file': $!";
  119.   # do something with FILE</PRE>
  120. <P>
  121. <HR>
  122. <H1><A NAME="mapping notes">MAPPING NOTES</A></H1>
  123. <P>Most computer systems today have hierarchically organized file systems.
  124. Mapping the names used in these systems to the generic URI syntax
  125. allows us to work with relative file URIs that behave as they should
  126. when resolved using the generic algorithm for URIs (specified in RFC
  127. 2396).  Mapping a file name to the generic URI syntax involves mapping
  128. the path separator character to ``/'' and encoding of any reserved
  129. characters that appear in the path segments of the file names.  If
  130. path segments consisting of the strings ``.'' or ``..'' have a
  131. different meaning than what is specified for generic URIs, then these
  132. must be encoded as well.</P>
  133. <P>If the file system has device, volume or drive specifications as
  134. the root of the name space, then it makes sense to map them to the
  135. authority field of the generic URI syntax.  This makes sure that
  136. relative URI can not be resolved ``above'' them , i.e. generally how
  137. relative file names work in those systems.</P>
  138. <P>Another common use of the authority field is to encode the host that
  139. this file name is valid on.  The host name ``localhost'' is special and
  140. generally have the same meaning as an missing or empty authority
  141. field.  This use will be in conflict with using it as a device
  142. specification, but can often be resolved for device specifications
  143. having characters not legal in plain host names.</P>
  144. <P>File name to URI mapping in normally not one-to-one.  There are
  145. usually many URI that map to the same file name.  For instance an
  146. authority of ``localhost'' maps the same as a URI with a missing or empty
  147. authority.</P>
  148. <P>Example 1: The Mac use ``:'' as path separator, but not in the same way
  149. as generic URI. ``:foo'' is a relative name.  ``foo:bar'' is an absolute
  150. name.  Also path segments can contain the ``/'' character as well as be
  151. literal ``.'' or ``..''.  It means that we will map like this:</P>
  152. <PRE>
  153.   Mac                   URI
  154.   ----------            -------------------
  155.   :foo:bar     <==>     foo/bar
  156.   :            <==>     ./
  157.   ::foo:bar    <==>     ../foo/bar
  158.   :::          <==>     ../../
  159.   foo:bar      <==>     <A HREF="file:/foo/bar">file:/foo/bar</A>
  160.   foo:bar:     <==>     <A HREF="file:/foo/bar/">file:/foo/bar/</A>
  161.   ..           <==>     %2E%2E
  162.   <undef>      <==      /
  163.   foo/         <==      <A HREF="file:/foo%2F">file:/foo%2F</A>
  164.   ./foo.txt    <==      <A HREF="file:/.%2Ffoo.txt">file:/.%2Ffoo.txt</A>
  165. </PRE>
  166. <PRE>
  167.  
  168. Note that if you want a relative URL, you *must* begin the path with a :.  Any
  169. path that begins with [^:] will be treated as absolute.</PRE>
  170. <P>Example 2: The Unix file system is easy to map as it use the same path
  171. separator as URIs, have a single root, and segments of ``.'' and ``..''
  172. have the same meaning.  URIs that have the character ``\0'' or ``/'' as
  173. part of any path segment can not be turned into valid Unix file names.</P>
  174. <PRE>
  175.   Unix                  URI
  176.   ----------            ------------------
  177.   foo/bar      <==>     foo/bar
  178.   /foo/bar     <==>     <A HREF="file:/foo/bar">file:/foo/bar</A>
  179.   /foo/bar     <==      <A HREF="file://localhost/foo/bar">file://localhost/foo/bar</A>
  180.   file:         ==>     ./file:
  181.   <undef>      <==      <A HREF="file:/fo%00/bar">file:/fo%00/bar</A>
  182.   /            <==>     <A HREF="file:/">file:/</A></PRE>
  183. <P>
  184. <HR>
  185. <H1><A NAME="see also">SEE ALSO</A></H1>
  186. <P><A HREF="../../../site/lib/URI.html">the URI manpage</A>, <A HREF="../../../lib/File/Spec.html">the File::Spec manpage</A>, <A HREF="../../../lib/Pod/perlport.html">the perlport manpage</A></P>
  187. <P>
  188. <HR>
  189. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  190. <P>Copyright 1995-1998 Gisle Aas.</P>
  191. <P>This library is free software; you can redistribute it and/or
  192. modify it under the same terms as Perl itself.</P>
  193. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  194. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  195. <STRONG><P CLASS=block> URI::file - URI that map to local file names</P></STRONG>
  196. </TD></TR>
  197. </TABLE>
  198.  
  199. </BODY>
  200.  
  201. </HTML>
  202.