NAME

Win32::UTCFileTime - Get/set UTC file times with stat/utime on Win32

SYNOPSIS

# Override built-in stat()/lstat()/utime() within current package only:
use Win32::UTCFileTime qw(:DEFAULT $ErrStr);
@stats = stat $file or die "stat() failed: $ErrStr\n";
$now = time;
utime $now, $now, $file;

# Or, override built-in stat()/lstat()/utime() within all packages:
use Win32::UTCFileTime qw(:globally);
...

# Use an alternative implementation of stat() instead:
use Win32::UTCFileTime qw(alt_stat $ErrStr);
@stats = alt_stat($file) or die "alt_stat() failed: $ErrStr\n";

DESCRIPTION

This module provides replacements for Perl's built-in stat() and utime() functions which respctively get and set "correct" UTC file times, instead of the erroneous values read and written by Microsoft's implementation of stat(2) and utime(2) which Perl's built-in functions inherit on Win32 when built with the Microsoft C library.

For completeness, a replacement for Perl's built-in lstat() function is also provided, although in practice that is unimplemented on Win32 and just calls stat() anyway. (Note, however, that it calls the original stat(), not the override provided by this module, so you must use the lstat() override provided by this module if you want "correct" UTC file times from lstat().)

The problem with Microsoft's stat(2) and utime(2), and hence Perl's built-in stat(), lstat() and utime() when built with the Microsoft C library, is basically this: file times reported by stat(2) or stored by utime(2) may change by an hour as we move into or out of daylight saving time (DST) if the computer is set to "Automatically adjust clock for daylight saving changes" (which is the default setting) and the file is stored on an NTFS volume (which is the preferred filesystem used by Windows NT/2000/XP/2003).

It seems particularly ironic that the problem should afflict the NTFS filesystem because the time_t values used by both stat(2) and utime(2) express UTC-based times, and NTFS stores file times in UTC. However, Microsoft's implementation of both of these functions use a variety of Win32 API calls that mangle the numbers in ways that don't quite turn out right when a DST season change is involved. On FAT volumes, the filesystem used by Windows 95/98/ME, file times are stored in local time and are put through even more contortions by these functions, but actually emerge correctly, so file times are stable across DST seasons on FAT volumes. The NTFS/FAT difference is taken into account by this module's repacement stat(), lstat() and utime() functions so that corrections are not erroneously applied when they shouldn't be.

The problems that arise when mangling time values between UTC and local time are due to the fact that the mapping from UTC to local time is not one-to-one. It is straightforward to convert UTC to local time, but there is an ambiguity when converting back from local time to UTC involving DST. The Win32 API provides two documented functions (FileTimeToLocalFileTime() and LocalFileTimeToFileTime()) for these conversions which resolve the ambiguity by, arguably "wrongly", using an algorithm involving the current system time rather than the file time being converted to decide whether or not to apply a DST correction; the advantage of this scheme is that these functions are exact inverses. Another, undocumented, function is also used internally by stat(2) for the tricky local time to UTC conversion which, "correctly", uses the file time being converted to decide whether or not to apply a DST correction. The Win32 API also provides a GetTimeZoneInformation() function that can be used to determine whether or not the file time being converted is in daylight saving time, which forms the basis of the solution provided by this module. The standard C library provides localtime(3) for UTC to local time conversion, albeit from time_t format to struct tm format, (and also gmtime(3) for the same structure-conversion without converting to local time), and mktime(3) for local time to UTC conversion, applying a DST correction or not as instructed by one of the fields in its struct tm argument.

See "BACKGROUND REFERENCE" for more details.

The replacement stat() and lstat() functions provided by this module behave identically to Perl's built-in functions of the same name, except that:

the last access time, last modification time and creation time return values are all "correct" UTC-based values, stable across DST seasons;
the argument (or $_ if no argument is given) must be a file (path or name), not a filehandle (and not the special filehandle consisting of an underscore character either).

In fact, both of these replacement functions work by calling Perl's corresponding built-in function first and then overwriting the file time fields in the lists thus obtained with the corrected values. In this way, all of the extra things done by Perl's built-in functions besides simply calling the underlying C stat(2) function are inherited by this module.

In obtaining these file time fields, these replacement functions actually incorporate one slight improvement over the built-in functions (as of Perl 5.8.0): They work better on directories specified with trailing slashes or backslashes under Windows NT platforms.

(As described in the "BACKGROUND REFERENCE" section, the Microsoft C library stat(2) function, and hence Perl's built-in stat() function, calls the Win32 API function FindFirstFile(). That function is documented to fail on directories specified with a trailing slash or backslash, hence the built-in function will not succeed. It fact, it falls back on another Win32 API function, GetFileAttributes(), to set up the st_mode field and then returns success in such cases, but leaving the other fields set to zero.

The replacement functions also call FindFirstFile() when calculating the correct UTC file times, but have a different fall-back function, namely CreateFile(), if that fails. CreateFile() can open directories specified with a trailing slash or backslash, but only under Windows NT platforms. The file time fields will thus be set correctly by these replacement functions on Windows NT platforms. (Under Windows 95 platforms, they are set to zero and the functions succeed, as per the Perl built-ins.) Note, however, that the other fields, left over from the original call to Perl's built-in stat() or lstat() function, will still be zero. For a complete alternative stat() function that only uses CreateFile(), and will thus set all fields correctly even for directories specified with a trailing slash or backslash, albeit only under Windows NT platforms, use the alt_stat() function.)

The replacement utime() function provided by this module behaves identically to Perl's built-in function of the same name, except that:

the last access time and last modification time arguments are both "correctly" interpreted as UTC-based values, stable across DST seasons;
no warnings about "Use of uninitialized value in utime" are produced when either file time argument is specified as undef.

In particular, the one extra thing done by Perl's built-in function besides simply calling the underlying C utime(2) function (namely, providing a fix so that it works on directories as well as files) is also incorporated into this module's replacement function.

All three replacement functions are exported to the caller's package by default. A special :globally export pseudo-symbol is also provided that will export all three functions to the CORE::GLOBAL package, which effectively overrides the Perl built-in functions in all packages, not just the caller's. The alt_stat() function is only exported when explicitly requested.

Functions

stat([$file])

Gets the status information for the file $file. If $file is omitted then $_ is used instead.

In list context, returns the same 13-element list as Perl's built-in stat() function on success, or returns an empty list and sets $ErrStr on failure.

For convenience, here are the members of that 13-element list and their meanings on Win32:

 0  dev      drive number of the disk containing the file (same as rdev)
 1  ino      not meaningful on Win32; always returned as 0
 2  mode     file mode (type and permissions)
 3  nlink    number of (hard) links to the file; always 1 on non-NTFS drives
 4  uid      numeric user ID of file's owner; always 0 on Win32
 5  gid      numeric group ID of file's owner; always 0 on Win32
 6  rdev     drive number of the disk containing the file (same as dev)
 7  size     total size of file, in bytes
 8  atime    last access time in seconds since the epoch
 9  mtime    last modification time in seconds since the epoch
10  ctime    creation time in seconds since the epoch
11  blksize  not implemented on Win32; returned as ''
12  blocks   not implemented on Win32; returned as ''

where the epoch was at 00:00:00 Jan 01 1970 UTC and the drive number of the disk is 0 for A:, 1 for B:, 2 for C: and so on.

Because the mode contains both the file type (the S_IFDIR bit is set if $file specifies a directory; the S_IFREG bit is set if the $file specifies a regular file) and its permissions (the user read/write bits are set according to the file's permission mode; the user execute bits are set according to the filename extension), you should mask off the file type portion and printf() using a "%04o" if you want to see the real permissions:

$mode = (stat($filename))[2];
printf "Permissions are %04o\n", $mode & 07777;

You can also import symbolic mode constants (S_IF*) and functions (S_IS*()) from the Fcntl module to assist in examining the mode. See "stat" in perlfunc for more details.

Note that you cannot use this module in conjunction with the File::stat module (which provides a convenient, by-name, access mechanism to the fields of the 13-element list) because both modules operate by overriding Perl's built-in stat() function. Only the second override to be applied would have effect.

In scalar context, returns a boolean value indicating success or failure (and sets $ErrStr on failure).

lstat([$link])

Gets the status information for the symbolic link $link. If $file is omitted then $_ is used instead. This is the same as stat() on Win32, which doesn't implement symbolic links.

alt_stat([$file])

Gets the status information for the file $file. If $file is omitted then $_ is used instead.

Behaves almost identically to stat() above, but uses this module's own implementation of the standard C library stat(2) function that can succeed in some cases where Microsoft's implementation fails.

As mentioned in the main "DESCRIPTION" above, Microsoft's stat(2), and hence Perl's built-in stat() and the replacement stat() function above, calls the Win32 API function FindFirstFile(). That function is used to search a directory for a file, and thus requires the process to have "List Folder Contents" permission on the directory containing the $file in question. If that permission is denied then stat() will fail. It also has the disadvantage mentioned above that it will fail on directories specified with a trailing slash or backslash.

alt_stat() avoids both of these problems by using a different Win32 API function, CreateFile(), instead. That function opens a file directly and hence doesn't require the process to have "List Folder Contents" permission on the parent directory. It can also open directories specified with trailing slash or backslash, but only under Windows NT platforms. In fact, under Windows 95 platforms, it can't open directories at all and will only set the st_mode field correctly; the other fields will be set to zero, like the Perl built-in stat() and lstat() functions do for directories specified with a trailing slash or backslash.

The main disadvantage with using this function is that the entire struct stat has to be built by hand by it, rather than simply inheriting most of it from the Microsoft stat(2) call and then overwriting the file time fields. Thus, some of the fields, notably the st_mode field which is somewhat ambiguous on Win32, may have different values to those that would have been set by the other stat() functions.

utime($atime, $mtime, @files)

Sets the last access time and last modification time to the values specified by $atime and $mtime respectively for each of the files in @files. The process must have write access to each of the files concerned in order to change these file times.

Returns the number of files successfully changed and sets $ErrStr if one or more files could not be changed.

The times should both be specified as the number of seconds since the epoch, where the epoch was at 00:00:00 Jan 01 1970 UTC. If the undefined value is used for either file time argument then the current time will be used for that value.

Note that the 11th element of the 13-element list returned by stat() is the creation time on Win32, not the inode change time as it is on many other operating systems. Therefore, neither Perl's built-in utime() function nor this replacement function set that value to the current time as would happen on other operating systems.

Variables

$ErrStr

Last error message.

If any function fails then a description of the last error will be set in this variable for use in reporting the cause of the failure, much like the use of the Perl Special Variables $! and $^E after failed system calls and Win32 API calls. Note that $! and/or $^E may also be set on failure, but this is not always the case so it is better to check $ErrStr instead. Any relevant messages from $! or $^E will form part of the message in $ErrStr anyway. See "Error Values" for a listing of the possible values of $ErrStr.

If a function succeeds then this variable will be set to the null string.

$Try_Alt_Stat

Control whether or not to try alt_stat() if CORE::stat() or CORE::lstat() fails.

Boolean value.

As documented in the "DESCRIPTION" section above, the replacement stat() and lstat() functions each call their built-in counterparts first and then overwrite the file time fields in the lists thus obtained with the corrected values. Setting this variable to a true value will cause the replacement functions to switch to alt_stat() (via a goto &NAME call) if the CORE::stat() or CORE::lstat() call fails.

The default value is 0, i.e. the alt_stat() function is not tried.

DIAGNOSTICS

Warnings and Error Messages

The following diagnostic messages may be produced by this module. They are classified as follows (a la perldiag):

(W) A warning (optional).
(F) A fatal error (trappable).
(I) An internal error that you should never see (trappable).

Can't close file descriptor '%d' for file '%s': %s: (W) The specified file descriptor for the specified file could not be closed after failing to obtain the associated operating-system file handle from it. The system error message corresponding to the standard C library errno variable is also given.
Can't close file object handle '%lu' for file '%s' after reading: %s: (W) The specified file object handle for the specified file could not be closed after reading file information from it. The system error message corresponding to the Win32 API last error code is also given.
Can't close file object handle '%lu' for file '%s' after updating: %s: (W) The specified file object handle for the specified file could not be closed after updating the file times using it. The system error message corresponding to the Win32 API last error code is also given.
Can't close file search handle '%lu' for file '%s' after reading: %s: (W) The specified file search handle for the specified file could not be closed after reading file information from it. The system error message corresponding to the Win32 API last error code is also given.
Can't convert base SYSTEMTIME to FILETIME: %s: (I) The SYSTEMTIME representation of the epoch of time_t values (namely, 00:00:00 Jan 01 1970 UTC) could not be converted to its FILETIME representation. The system error message corresponding to the Win32 API last error code is also given.
Can't determine name of filesystem: %s. Assuming file times are stored as UTC-based values: (W) The name of the filesystem that the file concerned is on could not be determined. This information is required because different filesystems store file times in different formats (in particular, NTFS stores UTC-based values, whereas FAT stores local time-based value). A filesystem that stores UTC-based values is assumed in this case. The system error message corresponding to the Win32 API last error code is also given.
Can't determine operating system platform: %s. Assuming the platform is Windows NT: (W) The operating system platform (i.e. Win32s, Windows (95/98/ME), Windows NT or Windows CE) could not be determined. This information is used by the alt_stat() function to decide whether or not a ".cmd" file extension represents an "executable file" when setting up the st_mode field of the struct stat. A Windows NT platform is assumed in this case. The system error message corresponding to the Win32 API last error code is also given.
Can't get time zone information: %s: (F) The current time zone parameters controlling the translations between UTC and local time could not be retrieved. The system error message corresponding to the Win32 API last error code is also given.
Can't handle year-specific DST clues in time zone information: (F) The current time zone parameters controlling the translations between UTC and local time are represented as a TIME_ZONE_INFORMATION stucture in which one or both of the transition dates between standard time and daylight time are given in "absolute" format rather than "day-in-month" format. Transition dates in this format are not currently supported by this module.
%s is not a valid Win32::UTCFileTime macro: (F) You attempted to lookup the value of the specified constant in the Win32::UTCFileTime module, but that constant is unknown to this module.
Overflow: Too many links (%lu) to file '%s': (W) The number of hard links to the specified file is greater than the largest short int, and therefore cannot be assigned to the st_nlink field of the struct stat setup by alt_stat(). The largest short int itself is used instead in this case.
The test date used in a date comparison is not in the required "absolute" format: (I) The file time being tested against the transition dates between standard time and daylight time is given in "day-in-month" format rather than "absolute" format.
The target date used in a date comparison is not in the required "day-in-month" format: (I) One of the transition dates between standard time and daylight time, being used to test a file time against, is given in "absolute" format rather than "day-in-month" format.
Unexpected error in AUTOLOAD(): constant() is not defined: (I) There was an unexpected error looking up the value of the specified constant: the constant-lookup function itself is apparently not defined.
Unexpected return type %d while processing Win32::UTCFileTime macro %s: (I) There was an unexpected error looking up the value of the specified constant: the C component of the constant-lookup function returned an unknown type.
Your vendor has not defined Win32::UTCFileTime macro %s: (I) You attempted to lookup the value of the specified constant in the Win32::UTCFileTime module, but that constant is apparently not defined.

Error Values

Each function sets $ErrStr to a value indicating the cause of the error when they fail. The possible values are as follows:

Can't convert FILETIME to SYSTEMTIME: %s: The FILETIME representation of a time could not be converted to its SYSTEMTIME representation. The system error message corresponding to the Win32 API last error code is also given.
Can't get file information for file '%s': %s: File information could not be read from an open file handle on the specified file. The system error message corresponding to the Win32 API last error code is also given.
Can't open file '%s' for reading: %s: The specified file could not be opened for reading file information from. The system error message corresponding to the Win32 API last error code is also given.
Can't open file '%s' for updating: %s: The specified file could not be opened for updating the file times. The system error message corresponding to the Win32 API last error code is also given.
Can't set file times for file '%s': %s: The file times could not be updated on an open file handle on the specified file. The system error message corresponding to the Win32 API last error code is also given.
Can't stat %s '%s': %s: The CORE::stat() or CORE::lstat() function failed for the specified file or link. (The replacement stat() and lstat() functions call their CORE counterparts prior to getting the "correct" UTC file times.) The system error message corresponding to the standard C library errno variable is also given.
Wildcard in filename '%s': The specified filename passed to the alt_stat() function contains a DOS-style wildcard character, namely "?" or "*". The function is not able to handle filenames of this format.

In some cases, the functions may also leave the Perl Special Variables $! and/or $^E set to values indicating the cause of the error when they fail; one or the other of these will be incorporated into the $ErrStr message in such cases, as indicated above. The possible values of each are as follows ($! shown first, $^E underneath):

EACCES (Permission denied)
ERROR_ACCESS_DENIED (Access is denied): [utime() only.] One or more of the @files is read-only. (The process must have write access to each file to be able to update its file times.)
EMFILE (Too many open files)
ERROR_TOO_MANY_OPEN_FILES (The system cannot open the file): The maximum number of file descriptors has been reached. (Each file must be opened in order to read file information from it or to update its file times.)
ENOENT (No such file or directory)
ERROR_FILE_NOT_FOUND (The system cannot find the file specified): The filename or path in $file was not found.

Note that since each function uses Win32 API functions rather than standard C library functions, they will probably only set $^E (which represents the Win32 API last error code, as returned by GetLastError()), not $! (which represents the standard C library errno variable).

Other values may also be produced by various functions that are used within this module whose possible error codes are not documented.

See $!, %!, $^E and Error Indicators in perlvar, Win32::GetLastError() and Win32::FormatMessage() in Win32, and Errno and Win32::WinError for details on how to check these values.

BACKGROUND REFERENCE

A number of Microsoft Knowledge Base articles refer to the odd characteristics of the Win32 API functions and the Microsoft C library functions involved, in particular see:

128126: FileTimeToLocalFileTime() Adjusts for Daylight Saving Time
129574: Time Stamp Changes with Daylight Savings
158588: Obtaining Universal Coordinated Time (UTC) from NTFS Files
190315: Some CRT File Functions Adjust For Daylight Savings Time

As these articles themselves emphasise, the behaviour in question is by design, not a bug. As an aside, another Microsoft Knowledge Base article (214661: FIX: Daylight Savings Time Bug in C Run-Time Library) refers to a different problem involving the Microsoft C library that was confirmed as a bug and was fixed in Visual Studio 6.0 Service Pack 3, so it is worth ensuring that your edition of Visual Studio is upgraded to at least that Service Pack level when you build Perl and this module. (At the time of writing, Service Pack 5 is the latest available for Visual Studio 6.0.)

An excellent overview of the problem with Microsoft's stat(2) was written by Jonathan M Gilligan and posted on the Code Project website (http://www.codeproject.com/). He has kindly granted permission to use his article here to describe the problem more fully. A slightly edited version of it now follows; the original article can be found at the URL http://www.codeproject.com/datetime/dstbugs.asp.

(The article was accompanied by a C library, adapted from code written for CVSNT (http://www.cvsnt.org/) by Jonathan and Tony M Hoyle, which implemented the solution outlined at the end of his article. The solution provided by this module is based on that library and the original CVSNT code itself (version 2.0.4), which both authors kindly granted permission to use under the terms of the Perl Artistic License as well as the GNU GPL.)

Introduction

Not many Windows developers seem aware of it, but Microsoft deliberately designed Windows NT to report incorrect file creation, modification, and access times. This decision is documented in the Knowledge Base in articles Q128126 and Q158588. For most purposes, this behavior is innocuous, but as Microsoft writes in Q158588,

After the automatic correction for Daylight Savings Time, monitoring
programs comparing current time/date stamps to reference data that were not
written using Win32 API calls which directly obtain/adjust to Universal
Coordinated Time (UTC) will erroneously report time/date changes on files.
Programs affected by this issue may include version-control software,
database-synchronisation software, software-distribution packages, backup
software...

This behavior is responsible for a flood of questions to the various support lists for CVS, following the first Sunday in April and the last Sunday in October, with scores of people complaining that CVS now reports erroneously that their files have been modified. This is commonly known as the "red file bug" because the WinCVS shell uses red icons to indicate modified files.

Over the past two years, several people have made concerted efforts to fix this bug and determine the correct file modification times for files both on NTFS and FAT volumes. It has proved surprisingly difficult to solve this problem correctly. I believe that I have finally gotten everything right and would like to share my solution with anyone else who cares about this issue.

An example of the problem

Run the following batch file on a computer where C: is an NTFS volume and A: is a FAT-formatted floppy disk. You will need write access to C:\ and A:\. This script will change your system time and date, so be prepared to manually restore them afterwards.

REM Test_DST_Bug.bat
REM File Modification Time Test
Date /T
Time /T
Date 10/27/2001
Time 10:00 AM
Echo Foo > A:\Foo.txt
Time 10:30 AM
Echo Foo > C:\Bar.txt
dir A:\Foo.txt C:\Bar.txt
Date 10/28/2001
dir A:\Foo.txt C:\Bar.txt
REM Prompt the user to reset the date and time.
date
time

The result looks something like this (abridged to save space)

C:\>Date 10/27/2001
C:\>dir A:\Foo.txt C:\Bar.txt

  Directory of A:\
10/27/01  10:00a                     6 Foo.txt
  Directory of C:\
10/27/01  10:30a                     6 Bar.txt

C:\>Date 10/28/2001
C:\>dir A:\Foo.txt C:\Bar.txt

  Directory of A:\
10/27/01  10:00a                     6 Foo.txt
  Directory of C:\
10/27/01  09:30a                     6 Bar.txt

On 27 October, Windows correctly reports that Bar.txt was modified half an hour after Foo.txt, but the next day, Windows has changed its mind and decided that actually, Bar.txt was modified half an hour before Foo.txt. A naive programmer might think this was a bug, but as Microsoft emphasised, this is how they want Windows to behave.

Why Windows has this problem

The origin of this file time problem lies in the early days of MS-DOS and PC-DOS. Unix and other operating systems designed for continuous use and network communications have long tended to store times in GMT (later UTC) format so computers in different time zones can accurately determine the order of different events. However, when Microsoft adapted DOS for the IBM PC, the personal computer was not envisioned in the context of wide-area networks, where it would be important to compare the modification times of files on the PC with those on another computer in another time zone.

In the interest of efficiently using the very limited resources of the computer, Microsoft wisely decided not to waste bits or processor cycles worrying about time zones. To put this decision in context, recall that the first two generations of PCs did not have battery-backed real-time clocks, so you would generally put DATE and TIME commands into your AUTOEXEC.BAT file to prompt you to enter the date and time manually when the computer booted.

Digression on systems of measuring time

By the time of WinNT, wide-area networks and had become sufficiently common that Microsoft realised that the OS should measure time in some universal format that would allow different computers to compare the order (and separation) of events irrespective of their particular time zones. Although the details vary (different time structures measure time relative to different events), the net effect is that all times used internally in Win32 measure time with respect to UTC (what used to be called GMT).

Having once worked down the hall from the master atomic clock array for the United States at the National Institute of Standards and Technology in Boulder, I feel obligated to add a few words about time and systems for reporting time. Long ago, we used to refer time to GMT, or Greenwich Mean Time, which was kept by the Royal Observatory in Greenwich, England and was ultimately referred to the position of the sun as measured by the observatory. When atomic clocks became the standard for timekeeping, a new standard, called UTC emerged. UTC is a bastard acronym. In English, it stands for "Coordinated Universal Time," while in French it stands for "le temps universel coordonne." Rather than using either CUT or TUC, the nonsense compromise acronym UTC was adopted.

To understand UTC, we must first understand the more abstract International Atomic Time (TAI, le temps atomique international), which measures the number of seconds that have elapsed since approximately 1 Jan 1958, as measured by caesium atomic clocks. The second is defined to be the amount of time required for 9 192 631 770 cycles of the caesium hyperfine frequency. However, neither the day nor the year are exact multiples of this number, so we take TAI and correct it so that it corresponds to the actual motion of the earth by adding corrections such as "leap seconds." TAI measures raw atomic time. UTC measures time coordinated to the motion of the earth (i.e., so we don't end up having midnight while the sun is shining or January in midsummer). Details of what UTC really means, together with a more detailed history of timekeeping, can be found at http://ecco.bsee.swin.edu.au/chronos/GMT-explained.html.

UTC, time zones, and Windows file times

So what does this all have to do with file modification times on Windows computers? Windows is stuck with some serious problems integrating FAT and NTFS files compatibly. FAT records file modification times with respect to the local time zone, while NTFS records file modification (as well as creation and access times, which FAT does not record) in UTC. The first question you may want to ask is, "How should Windows report these file times?" Clearly it would be stupid for dir and Windows Explorer to report FAT file times in the local time zone and NTFS file times in UTC. If inconsistent formats were used, users would have great difficulty determining which of two files was more recent. We must thus choose to translate one of the two file time formats when we report to the user. Most users are likely to want to know the file modification time in their local time zone. This keeps things consistent with what people learned to expect under DOS and Win16. It also is more useful to most users, who may want to know how long ago they modified a file without looking up the offset of their local time zone from UTC.

It is straightforward to translate UTC to local time. You look up the offset, in minutes, between the local time zone and UTC, determine whether daylight savings is in effect and add either the standard or the daylight offset to the UTC time. However, daylight time throws a subtle wrench in the works if we try to go backwards...

The problem with daylight time

If you want to translate a time in your local time zone into UTC, it seems a straightforward matter of determining whether daylight time is in effect locally and then subtracting either the standard or the daylight offset from the local time to arrive at UTC. A subtle problem emerges due to the fact that the mapping from UTC to local time is not one-to-one. Specifically, when we leave daylight savings time and set our clocks back, there are two distinct hour-long intervals of UTC time that map onto the same hour-long interval of local time. Consider the concrete case of 01:30 on the last Sunday in October. Let's suppose the local time zone is US Central Time (-6 hours offset from UTC when daylight time is not in effect, -5 hours when it is). At 06:00 UTC on Sunday 28 October 2001, the time in the US Central zone will be 01:00 and daylight time will be in effect. At 06:30 UTC, it will be 01:30 local. At 07:00 UTC, it will be 01:00 local and daylight time will not be in effect. At 07:30 UTC, it will be 01:30 local. Thus, for all times 01:00 <= t < 02:00 local, there will be two distinct UTC times that correspond to the given local time. This degenerate mapping means that we can't be sure which UTC time corresponds to 01:30 local time. If a FAT file is marked as having been modified at 01:30 on Oct 28 2001, we can't determine the UTC time.

When translating local file times to UTC and vice-versa, Microsoft made a strange decision. We would like to have the following code procduce out_time equal to in_time

FILETIME in_time, local_time, out_time;

// Assign in_time, then do this...

FileTimeToLocalFileTime(&in_time,    &local_time);
LocalFileTimeToFileTime(&local_time, &out_time  );

The problem is that if the local time zone is US Central (UTC-6 hours for standard time, UTC-5 hours for daylight time) then in_time = 06:30 Oct 28 2001 and in_time = 07:30 Oct 28 2001 both map onto the same local time, 01:30 Oct 28 2001 and we don't know which branch to choose when we execute LocalFileTimeToFileTime(). Microsoft picked an incorrect, but unambiguously invertable algorithm: move all times up an hour when daylight time is in effect on the local computer, irrespective of the DST state of the time being converted. Thus, if DST is in effect on my local computer, FileTimeToLocalFileTime() converts 06:30 Oct 28 2001 UTC to 01:30 CDT and 07:30 Oct 28 2001 UTC to 02:30 CDT. If I call the same function with the same arguments, but when DST is not in effect on my local computer, FileTimeToLocalFileTime() will convert 06:30 UTC to 00:30 CDT and 07:30 UTC to 01:30 CDT.

It may seem strange that this would affect the C library call stat(2), which allegedly returns the UTC modification time of a file. If you examine the source code for Microsoft's C library, you find that it gets the modification time thus:

// Pseudo-code listing

WIN32_FIND_DATA find_buf;
HANDLE hFile;
FILETIME local_ft;
time_t mod_time;

// FindFirstFile() returns times in UTC.
// For NTFS files, it just returns the modification time stored on the disk.
// For FAT files, it converts the modification time from local (which is
// stored on the disk) to UTC using LocalFileTimeToFileTime().
hFile = FindFirstFile(file_name, &find_buf);

// Convert UTC time to local time.
FileTimeToLocalFileTime(&find_buf.ftLastWriteTime, &local_ft);

// Now use a private, undocumented function to convert local time to UTC
// time according to the DST settings appropriate to the time being
// converted!
mod_time = __loctotime_t(local_ft);

For a FAT file, the conversions work like this:

Raw file modification time (stored as local time) is converted to UTC by LocalFileTimeToFileTime().
UTC is converted back to local time by FileTimeToLocalFileTime(). Note that this exactly reverses the effect of the previous step, so we are left with the correct local modification time.
Local time is converted to "correct" UTC by private function.

For an NTFS file, the conversions work like this:

Raw file modification time is already stored in UTC, so we don't need to convert it.
UTC is converted to local time by FileTimeToLocalFileTime(). This applies a DST correction according to the DST setting of the current system time, irrespective of the DST setting at the file modification time.
Local time is converted to "correct" UTC by private function. Note that this does not necessarily reverse the effect of the previous step because in this step we use the DST setting of the file modification time, not the current system time.

This explains the problem I showed at the top of this article: The time reported by dir for a file on an NTFS volume changes by an hour as we move into or out of daylight savings time, despite the fact that the file hasn't been touched. FAT modification times are stable across DST seasons.

Categorising the problem

There are 3 possible ways I can think of where this inconsistency in reporting file times may cause problems:

You may be comparing a file on an NTFS volume with a time_t value stored in a file (or memory). This is frequently seen in CVS and leads to the infamous "red file bug" on the first Sunday of April and the last Sunday of October.
You may be comparing a file on a FAT volume with a time_t value.
You may be comparing a file on a FAT volume with a file on an NTFS volume.

Solutions

For the first case, it's simple. Get the file times using the Win32 API call GetFileTime() instead of using the C library stat(2), and convert the FILETIME to time_t by subtracting the origin (00:00:00 Jan 01 1970 UTC) and dividing by 10,000,000 to convert "clunks" (100-nanosecond intervals) to seconds.
For the second case, stat(2) will work and return a time_t that you can compare to the stored one. If you must use GetFileTime() do not use LocalFileTimeToFileTime(). This function will apply the the daylight status of the current system time, not the daylight status of the file time in the argument. Fortunately, the C library mktime(3) function will correctly convert the time if you correctly set the tm_isdst field of the struct tm.

There is a bit of a chicken-and-egg problem here. Windows does not supply a good API call to let you determine whether DST was in effect at a given time. Fortunately for residents of the US and other countries that use the same logic (Daylight time starts at 2:00 AM on the first Sunday of April and ends at 2:00 AM on the last Sunday in October), you can set tm_isdst to a negative number and mktime(3) will automatically determine whether daylight time applies or not. If the file was modified in the window 1:00-2:00 AM on the last Sunday in October, it's ambiguous how mktime(3) computes the modification time.

People in time zones that do not follow the usual US daylight rule must brute-force the daylight time problem by retrieving the applicable TIME_ZONE_INFORMATION structure with GetTimeZoneInformation() and manually calculating whether daylight time applies.
For the third case, the best bet is to follow the instructions for the second case above and compare the resultant UTC time_t with the time for the NTFS file determined in the first case above.

The library implements this solution with checking for the filesystem the file is stored under.

Summary of stat() problems

That's the end of Jonathan M Gilligan's article. It should be noted that although the last section, "Solutions", refers to the Win32 API function GetFileTime(), his library, the CVSNT code that it was adapted from, and this module (which also adapts that code), all use a different Win32 API function instead, namely, FindFirstFile(). As seen in the pseudo-code listing above, that is the function used in Microsoft's implementation of stat(2) itself, and evidently has one advantage over GetFileTime() which is documented in the Microsoft Knowledge Base article 128126 cited above: GetFileTime() gets cached UTC times from FAT, whereas FindFirstFile() always reads the time from the file. This means that the value returned by GetFileTime() may be incorrect under FAT after a DST season change.

Another look at the source for Microsoft's C library shows that everything written above regarding the last modification time of a file is also true of the last access time and creation time. This module therefore applies the same corrections to those values as well, as does the CVSNT code.

(Incidentally, the source code of Microsoft's implementation of stat(2) can be found in C:\Program Files\Microsoft Visual Studio\VC98\CRT\SRC\STAT.C if you installed Microsoft Visual C++ 6.0 in its default location and selected the "VC++ Runtime Libraries -> CRT Source Code" option when installing.)

Another enhancement to Jonathan's library incorporated into this module, taken from the CVSNT code, is the use of the Win32 API function GetTimeZoneInformation() to apply the correct daylight saving time rule, rather than assuming the United States' rule, as hinted at in the "Solutions" section above.

To summarise the quirks of the various file time functions involved, the situation is as follows. Here, "correctly converts" and "incorrectly converts" mean "applies a DST correction with respect to the file time being converted" and "applies a DST correction with respect to the current system time" respectively.

stat(2)

Returns UTC file times, incorrectly under NTFS.

For NTFS files, it incorrectly converts the UTC file time stored on the disk to local time, and then correctly (but too late - the damage is already done!) converts that back to UTC.

For FAT files, it incorrectly converts the local file time stored on the disk to UTC, then incorrectly converts that back to local time (exactly undoing the effect of the first conversion), and finally correctly converts that to UTC.

FindFirstFile()

Returns UTC file times, incorrectly under FAT.

For NTFS files, it just returns the UTC file time stored on the disk.

For FAT files, it incorrectly converts the local file time stored on the disk to UTC.

GetFileTime()

Returns UTC file times, incorrectly under FAT.

For NTFS files, it just returns the UTC file time stored on the disk.

For FAT files, it correctly converts the local file time stored on the disk to UTC, but then caches that value until the computer is rebooted.

mktime(3)

Converts a local time to UTC.

Whether or not a DST correction is applied depends on the value of the tm_isdst field of the struct tm argument: 0 means the local time being converted is in standard time so don't apply a correction, >0 means means it is in daylight time so apply a correction, <0 means have mktime(3) itself compute whether or not daylight savings time is in effect (using the United States' rule to decide).

GetTimeZoneInformation()

Returns information about the current time zone that can be used to determine whether or not a given time is in daylight saving time and hence requires a DST correction to be applied when converting.

FileTimeToLocalFileTime()

Incorrectly converts a UTC file time to local time.

This is the inverse of LocalFileTimeToFileTime().

LocalFileTimeToFileTime()

Incorrectly converts a local file time to UTC.

This is the inverse of FileTimeToLocalFileTime().

__loctotime_t()

Private, undocumented function that correctly converts a local file time to UTC.

This is not the inverse of FileTimeToLocalFileTime().

Microsoft's implementation of stat(2), as shown in the pseudo-code listing above, is basically:

FindFirstFile() // calls LocalFileTimeToFileTime() on FAT

FileTimeToLocalFileTime()

__loctotime_t()

The solution implemented in the library used by this module is essentially a combination of the "Solutions" of the various cases outlined above, but using FindFirstFile() rather than GetFileTime() to avoid the caching problem under FAT and incorporating the use of GetTimeZoneInformation():

FindFirstFile() // calls LocalFileTimeToFileTime() on FAT

if (IsFATVolume) {
    FileTimeToLocalFileTime()

    // Now correctly convert local time to UTC using
    // GetTimeZoneInformation()
}

EXPORTS

The following symbols are, or can be, exported by this module:

Default Exports: stat, lstat, utime.
Optional Exports: alt_stat, $ErrStr, :globally.
Export Tags: None.

KNOWN BUGS

None.

CAVEATS

Any of the Win32 API functions involved here, or indeed Microsoft's implementation of stat(2) and utime(2) themselves, could, of course, change in future Windows operating systems. Such changes could render inappropriate the corrections being applied by this module. (In fact, the Microsoft Knowledge Base article Q158588 cited above specifically mentions that the behaviour of GetFileTime() under FAT may be changed to match the behaviour under NTFS in a future version of Windows NT. That particular change, however, would have no effect on this module because, as mentioned above, GetFileTime() isn't used by it.)

Likewise, if corrections such as those applied by this module are ever incorporated into the Perl core (so that Perl's built-in stat(), lstat() and utime() functions get/set correct UTC values themselves, even when built on the faulty Microsoft C library functions) then again, the corrections applied by this module would not be appropriate.

In either case, this module would either need updating appropriately, or may even become redundant.

LIMITATIONS

As seen from the pseudo-code above, when handling files on FAT volumes, this module's replacement functions all use the Win32 API function GetTimeZoneInformation() to figure out what the appropriate DST rule is. The information returned by that function can either be in "absolute" format (in which the transition dates between standard time and daylight time are given by exact dates and times, including the year) or in "day-in-month" format (in which those transition dates are given in such a way that clues like "the last Sunday in April" can be expressed, and no specific year is mentioned). Only the "day-in-month" format is handled by this module; the functions throw exceptions if the transition dates are returned in "absolute" format.

TODO

The code that determines what filesystem a given path is on doesn't currently handle volume mount points that are supported by NTFS 5.0 (Windows 2000) and later. A volume mount point is a directory on one volume in which a different volume is mounted. For example, it is possible to mount the D: drive in the directory C:\mnt\d-drive and thereafter refer to files on the D: drive as being in the C:\mnt\d-drive directory.

The code will presently determine the filesystem of paths in that location according to the filesystem of the C: drive, but that may not be correct: The D: drive could be a different filesystem. Instead, the code should retrieve the volume mount point (in this case, C:\mnt\d-drive) using GetVolumePathName(), then get the name of the corresponding volume (in this case, D:) using GetVolumeNameForVolumeMountPoint(), and finally determine the filesystem from that (using GetVolumeInformation() as it currently does).

Such an improvement will need to contend with the fact that GetVolumePathName() and GetVolumeNameForVolumeMountPoint() are only supported on Windows 2000 and later, and require the _WIN32_WINNT macro to be defined as 0x0500 or later when building, but we would, of course, not want to remove backwards compatibility with earlier OS's.

FEEDBACK

Patches, bug reports, suggestions or any other feedback are welcome.

Bugs can be reported on the CPAN Request Tracker at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Win32-UTCFileTime.

Open bugs on the CPAN Request Tracker can be viewed at http://rt.cpan.org/NoAuth/Bugs.html?Dist=Win32-UTCFileTime.

Please test this distribution. See CPAN Testers at http://testers.cpan.org/ for details of how to get involved.

Previous test results on CPAN Testers can be viewed at http://testers.cpan.org/search?request=dist&dist=Win32-UTCFileTime.

Please rate this distribution on CPAN Ratings at http://cpanratings.perl.org/rate/?distribution=Win32-UTCFileTime.

ACKNOWLEDGEMENTS

Many thanks to Jonathan M Gilligan <jonathan.gilligan@vanderbilt.edu> and Tony M Hoyle <tmh@nodomain.org> who wrote much of the C code that this module is based on and granted permission to use it under the terms of the Perl Artistic License as well as the GNU GPL. Extra thanks to Jonathan for also granting permission to use his article describing the problem and his solution to it in the "BACKGROUND REFERENCE" section of this manpage.

Credit is also due to Slaven Rezic for finding Jonathan's work on the Code Project website (http://www.codeproject.com/) in response to my bug report (ticket #18513 on the Perl Bugs website, http://bugs.perl.org/).

The custom import() method is based on that in the standard library module File::Glob (version 1.01), written by Nathan Torkington and others.

The alt_stat() function is based on code taken from the wnt_stat() function in CVSNT (version 2.0.4) and the win32_stat() and pp_stat() functions in Perl (version 5.8.0).

The _StrWinError() function used by the XS code is based on the win32_str_os_error() function in Perl (version 5.8.5).

AVAILABILITY

The latest version of this module is available from CPAN (see "CPAN" in perlmodlib for details) at

http://www.cpan.org/authors/id/S/SH/SHAY/ or

http://www.cpan.org/modules/by-module/Win32/.

INSTALLATION

See the INSTALL file.

AUTHOR

Steve Hay <shay@cpan.org>

COPYRIGHT

LICENCE

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself, i.e. under the terms of either the GNU General Public License or the Artistic License, as specified in the LICENCE file.

VERSION

Version 1.41

DATE

12 Dec 2004

HISTORY

See the Changes file.

To install Win32::UTCFileTime, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Win32::UTCFileTime

CPAN shell

perl -MCPAN -e shell
install Win32::UTCFileTime

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

DESCRIPTION

Functions

Variables

DIAGNOSTICS

Warnings and Error Messages

Error Values

BACKGROUND REFERENCE

Introduction

An example of the problem

Why Windows has this problem

Digression on systems of measuring time

UTC, time zones, and Windows file times

The problem with daylight time

Categorising the problem

Solutions

Summary of stat() problems

More problems: utime()

EXPORTS

KNOWN BUGS

CAVEATS

LIMITATIONS

TODO

FEEDBACK

SEE ALSO

ACKNOWLEDGEMENTS

AVAILABILITY

INSTALLATION

AUTHOR

COPYRIGHT

LICENCE

VERSION

DATE

HISTORY

NAME

SYNOPSIS

DESCRIPTION

Functions

Variables

DIAGNOSTICS

Warnings and Error Messages

Error Values

BACKGROUND REFERENCE

Introduction

An example of the problem

Why Windows has this problem

Digression on systems of measuring time

UTC, time zones, and Windows file times

The problem with daylight time

Categorising the problem

Solutions

Summary of stat() problems

More problems: utime()

EXPORTS

KNOWN BUGS

CAVEATS

LIMITATIONS

TODO

FEEDBACK

SEE ALSO

ACKNOWLEDGEMENTS

AVAILABILITY

INSTALLATION

AUTHOR

COPYRIGHT

LICENCE

VERSION

DATE

HISTORY

Module Install Instructions