File URI scheme


The file URI scheme is a URI scheme defined in, typically used to retrieve files from within one's own computer.
Previously the file URI scheme was specified in and. The Internet Engineering Task Force published RFC 8089, updating the latter RFC, with "a syntax based on the generic syntax of that is compatible with most existing usages."

Format

A file URI takes the form of
file://host/path
, where
host is the fully qualified domain name of the system on which the
path is accessible, and path
is a hierarchical directory path of the form directory/directory/.../name. If host is omitted, it is taken to be "localhost", the machine from which the URL is being interpreted. Note that when omitting host, the slash is not omitted.
RFC 3986 includes additional information about the treatment of ".." and "." segments in URIs.

How many slashes?

There are two ways that Windows UNC filenames can be represented. These are both described in as "non-standard". The first way is to represent the server name using the Authority part of the URI, which then becomes file://server/folder/data.xml. The second way is to represent the server name as part of the Path component, so the URI becomes file:////server/folder/data.xml. Both forms are actively used. Microsoft.NET generally uses the 2-slash form; Java generally uses the 4-slash form. Either form allows the most common operations on URIs to be used successfully. However, because these URIs are non-standard, some less common operations fail: an example is the normalize operation which reduces file:////server/folder/data.xml to the unusable form file:/server/folder/data.xml.

Examples

Unix

Here are two Unix examples pointing to the same /etc/fstab file:
file://localhost/etc/fstab
file:///etc/fstab

Windows

Here are some examples which may be accepted by some applications on Windows systems, referring to the same, local file c:\WINDOWS\clock.avi
file://localhost/c$/WINDOWS/clock.avi
file:///c:/WINDOWS/clock.avi
Here is the URI as understood by the Windows Shell API:
file:///c:/WINDOWS/clock.avi
Note that the drive letter followed by a colon and slash is part of the acceptable file URI.

Implementations

Windows

On Microsoft Windows systems, the normal colon after a device letter has sometimes been replaced by a vertical bar in file URLs. This reflected the original URL syntax, which made the colon a reserved character in a path part.
Since Internet Explorer 4, file URIs have been standardized on Windows, and should follow the following scheme. This applies to all applications which use URLMON or SHLWAPI for parsing, fetching or binding to URIs. To convert a path to a URL, use UrlCreateFromPath, and to convert a URL to a path, use PathCreateFromUrl.
To access a file "the file.txt", the following might be used.
For a network location:
file://hostname/path/to/the%20file.txt
Or for a local file, the hostname is omitted, but the slash is not :
file:///c:/path/to/the%20file.txt
This is not the same as providing the string "localhost" or the dot "." in place of the hostname. The string "localhost" will attempt to access the file as UNC path \\localhost\c:\path\to\the file.txt, which will not work since the colon is not allowed in a share name. The dot "." results in the string being passed as \\.\c:\path\to\the file.txt, which will work for local files, but not shares on the local system. For example file://./sharename/path/to/the%20file.txt will not work, because it will result in sharename being interpreted as part of the DOSDEVICES namespace, not as a network share.
The following outline roughly describes the requirements.
Use the provided functions if possible. If you must create a URL programmatically and cannot access SHLWAPI.dll the above outline will help.

Legacy URLs

To aid the installed base of legacy applications on Win32 PathCreateFromUrl recognizes certain URLs which do not meet these criteria, and treats them uniformly. These are called "legacy" file URLs as opposed to "healthy" file URLs.
In the past, a variety of other applications have used other systems. Some added an additional two slashes. For example, UNC path \\remotehost\share\dir\file.txt would become file:////remotehost/share/dir/file.txt instead of the "healthy" file://remotehost/share/dir/file.txt.

Web pages

File URLs are rarely used in Web pages on the public Internet, since they imply that a file exists on the designated host. The host specifier can be used to retrieve a file from an external source, although no specific file-retrieval protocol is specified; and using it should result in a message that informs the user that no mechanism to access that machine is available.