This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-io.git
The following commit(s) were added to refs/heads/master by this push: new f360508db java.lang.ArithmeticException: long overflow java.lang.Math.addExact(Math.java:932) at org.apache.commons.io.file.attribute.FileTimes.ntfsTimeToFileTime(FileTimes.java:164). See also https://issues.apache.org/jira/browse/MDEP-978 f360508db is described below commit f360508db2e95fed6050cae71615cc5367647641 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Sun Mar 30 14:13:37 2025 -0400 java.lang.ArithmeticException: long overflow java.lang.Math.addExact(Math.java:932) at org.apache.commons.io.file.attribute.FileTimes.ntfsTimeToFileTime(FileTimes.java:164). See also https://issues.apache.org/jira/browse/MDEP-978 --- src/changes/changes.xml | 1 + .../commons/io/file/attribute/FileTimes.java | 69 ++++++++++++++-------- .../commons/io/file/attribute/FileTimesTest.java | 56 +++++++++++++----- 3 files changed, 86 insertions(+), 40 deletions(-) diff --git a/src/changes/changes.xml b/src/changes/changes.xml index ab198f7e9..2e4e49792 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -67,6 +67,7 @@ The <action> type attribute can be add,update,fix,remove. <action dev="ggregory" type="fix" due-to="Gary Gregory">Improve performance of IOUtils.contentEquals(InputStream, InputStream) by about 13%.</action> <action dev="ggregory" type="fix" issue="IO-870" due-to="Gary Gregory">PathUtils.copyFileToDirectory() across file systems #728.</action> <action dev="ggregory" type="fix" issue="IO-871" due-to="Éamonn McManus, Gary Gregory">IOUtils.contentEquals is incorrect when InputStream.available under-reports.</action> + <action dev="ggregory" type="fix" due-to="Gary Gregory">java.lang.ArithmeticException: long overflow java.lang.Math.addExact(Math.java:932) at org.apache.commons.io.file.attribute.FileTimes.ntfsTimeToFileTime(FileTimes.java:164). See also https://issues.apache.org/jira/browse/MDEP-978.</action> <!-- ADD --> <action dev="ggregory" type="add" issue="IO-860" due-to="Nico Strecker, Gary Gregory">Add ThrottledInputStream.Builder.setMaxBytes(long, ChronoUnit).</action> <action dev="ggregory" type="add" due-to="Gary Gregory">Add IOIterable.</action> diff --git a/src/main/java/org/apache/commons/io/file/attribute/FileTimes.java b/src/main/java/org/apache/commons/io/file/attribute/FileTimes.java index 25a064b93..4c4e9e272 100644 --- a/src/main/java/org/apache/commons/io/file/attribute/FileTimes.java +++ b/src/main/java/org/apache/commons/io/file/attribute/FileTimes.java @@ -18,6 +18,9 @@ package org.apache.commons.io.file.attribute; import java.io.IOException; +import java.math.BigDecimal; +import java.math.MathContext; +import java.math.RoundingMode; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.attribute.FileTime; @@ -32,6 +35,8 @@ */ public final class FileTimes { + private static final MathContext MATH_CONTEXT = new MathContext(0, RoundingMode.FLOOR); + /** * Constant for the {@code 1970-01-01T00:00:00Z} {@link Instant#EPOCH epoch} as a time stamp attribute. * @@ -44,23 +49,30 @@ public final class FileTimes { * * <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms724290%28v=vs.85%29.aspx">Windows File Times</a> * <p> - * A file time is a 64-bit value that represents the number of 100-nanosecond intervals that have elapsed since 12:00 - * A.M. January 1, 1601 Coordinated Universal Time (UTC). This is the offset of Windows time 0 to Unix epoch in - * 100-nanosecond intervals. + * A file time is a 64-bit value that represents the number of 100-nanosecond intervals that have elapsed since 12:00 A.M. January 1, 1601 Coordinated + * Universal Time (UTC). This is the offset of Windows time 0 to Unix epoch in 100-nanosecond intervals. * </p> */ - static final long WINDOWS_EPOCH_OFFSET = -116444736000000000L; + static final long UNIX_TO_NTFS_OFFSET = -116444736000000000L; + + private static final BigDecimal UNIX_TO_NTFS_OFFSET_BD = BigDecimal.valueOf(UNIX_TO_NTFS_OFFSET); /** * The amount of 100-nanosecond intervals in one second. */ private static final long HUNDRED_NANOS_PER_SECOND = TimeUnit.SECONDS.toNanos(1) / 100; + private static final BigDecimal HUNDRED_NANOS_PER_SECOND_BD = BigDecimal.valueOf(HUNDRED_NANOS_PER_SECOND); + /** * The amount of 100-nanosecond intervals in one millisecond. */ static final long HUNDRED_NANOS_PER_MILLISECOND = TimeUnit.MILLISECONDS.toNanos(1) / 100; + private static final long HUNDRED = 100L; + + private static final BigDecimal HUNDRED_BD = BigDecimal.valueOf(HUNDRED); + /** * Converts standard Unix time (in seconds, UTC/GMT) to {@link FileTime}. * @@ -100,7 +112,7 @@ public static boolean isUnixTime(final long seconds) { /** * Subtracts milliseconds from a source FileTime. * - * @param fileTime The source FileTime. + * @param fileTime The source FileTime. * @param millisToSubtract The milliseconds to subtract. * @return The resulting FileTime. */ @@ -111,7 +123,7 @@ public static FileTime minusMillis(final FileTime fileTime, final long millisToS /** * Subtracts nanoseconds from a source FileTime. * - * @param fileTime The source FileTime. + * @param fileTime The source FileTime. * @param nanosToSubtract The nanoseconds to subtract. * @return The resulting FileTime. */ @@ -122,7 +134,7 @@ public static FileTime minusNanos(final FileTime fileTime, final long nanosToSub /** * Subtracts seconds from a source FileTime. * - * @param fileTime The source FileTime. + * @param fileTime The source FileTime. * @param secondsToSubtract The seconds to subtract. * @return The resulting FileTime. */ @@ -150,7 +162,7 @@ public static FileTime now() { * @see <a href="https://learn.microsoft.com/en-us/windows/win32/sysinfo/file-times">NTFS File Times</a> */ public static Date ntfsTimeToDate(final long ntfsTime) { - final long javaHundredNanos = Math.addExact(ntfsTime, WINDOWS_EPOCH_OFFSET); + final long javaHundredNanos = Math.addExact(ntfsTime, UNIX_TO_NTFS_OFFSET); final long javaMillis = Math.floorDiv(javaHundredNanos, HUNDRED_NANOS_PER_MILLISECOND); return new Date(javaMillis); } @@ -167,16 +179,23 @@ public static Date ntfsTimeToDate(final long ntfsTime) { * @see <a href="https://learn.microsoft.com/en-us/windows/win32/sysinfo/file-times">NTFS File Times</a> */ public static FileTime ntfsTimeToFileTime(final long ntfsTime) { - final long javaHundredsNanos = Math.addExact(ntfsTime, WINDOWS_EPOCH_OFFSET); - final long javaSeconds = Math.floorDiv(javaHundredsNanos, HUNDRED_NANOS_PER_SECOND); - final long javaNanos = Math.floorMod(javaHundredsNanos, HUNDRED_NANOS_PER_SECOND) * 100; - return FileTime.from(Instant.ofEpochSecond(javaSeconds, javaNanos)); + return FileTime.from(ntfsTimeToInstant(ntfsTime)); + } + + static Instant ntfsTimeToInstant(final BigDecimal ntfsTime) { + final BigDecimal javaHundredsNanos = ntfsTime.add(UNIX_TO_NTFS_OFFSET_BD); + final BigDecimal[] dar = javaHundredsNanos.divideAndRemainder(HUNDRED_NANOS_PER_SECOND_BD, MATH_CONTEXT); + return Instant.ofEpochSecond(dar[0].longValueExact(), dar[1].multiply(HUNDRED_BD).longValueExact()); + } + + static Instant ntfsTimeToInstant(final long ntfsTime) { + return ntfsTimeToInstant(BigDecimal.valueOf(ntfsTime)); } /** * Adds milliseconds to a source FileTime. * - * @param fileTime The source FileTime. + * @param fileTime The source FileTime. * @param millisToAdd The milliseconds to add. * @return The resulting FileTime. */ @@ -187,7 +206,7 @@ public static FileTime plusMillis(final FileTime fileTime, final long millisToAd /** * Adds nanoseconds from a source FileTime. * - * @param fileTime The source FileTime. + * @param fileTime The source FileTime. * @param nanosToSubtract The nanoseconds to subtract. * @return The resulting FileTime. */ @@ -198,7 +217,7 @@ public static FileTime plusNanos(final FileTime fileTime, final long nanosToSubt /** * Adds seconds to a source FileTime. * - * @param fileTime The source FileTime. + * @param fileTime The source FileTime. * @param secondsToAdd The seconds to add. * @return The resulting FileTime. */ @@ -217,8 +236,7 @@ public static void setLastModifiedTime(final Path path) throws IOException { } /** - * Converts {@link FileTime} to a {@link Date}. If the provided FileTime is {@code null}, the returned Date is also - * {@code null}. + * Converts {@link FileTime} to a {@link Date}. If the provided FileTime is {@code null}, the returned Date is also {@code null}. * * @param fileTime the file time to be converted. * @return a {@link Date} which corresponds to the supplied time, or {@code null} if the time is {@code null}. @@ -229,8 +247,7 @@ public static Date toDate(final FileTime fileTime) { } /** - * Converts {@link Date} to a {@link FileTime}. If the provided Date is {@code null}, the returned FileTime is also - * {@code null}. + * Converts {@link Date} to a {@link FileTime}. If the provided Date is {@code null}, the returned FileTime is also {@code null}. * * @param date the date to be converted. * @return a {@link FileTime} which corresponds to the supplied date, or {@code null} if the date is {@code null}. @@ -251,7 +268,7 @@ public static FileTime toFileTime(final Date date) { */ public static long toNtfsTime(final Date date) { final long javaHundredNanos = date.getTime() * HUNDRED_NANOS_PER_MILLISECOND; - return Math.subtractExact(javaHundredNanos, WINDOWS_EPOCH_OFFSET); + return Math.subtractExact(javaHundredNanos, UNIX_TO_NTFS_OFFSET); } /** @@ -264,9 +281,13 @@ public static long toNtfsTime(final Date date) { * @return the NTFS time, 100-nanosecond units since 1 January 1601. */ public static long toNtfsTime(final FileTime fileTime) { - final Instant instant = fileTime.toInstant(); - final long javaHundredNanos = instant.getEpochSecond() * HUNDRED_NANOS_PER_SECOND + instant.getNano() / 100; - return Math.subtractExact(javaHundredNanos, WINDOWS_EPOCH_OFFSET); + return toNtfsTime(fileTime.toInstant()); + } + + static long toNtfsTime(final Instant instant) { + final BigDecimal javaHundredNanos = BigDecimal.valueOf(instant.getEpochSecond()).multiply(HUNDRED_NANOS_PER_SECOND_BD) + .add(BigDecimal.valueOf(instant.getNano() / 100)); + return javaHundredNanos.subtract(UNIX_TO_NTFS_OFFSET_BD).longValueExact(); } /** @@ -281,7 +302,7 @@ public static long toNtfsTime(final FileTime fileTime) { */ public static long toNtfsTime(final long javaTime) { final long javaHundredNanos = javaTime * HUNDRED_NANOS_PER_MILLISECOND; - return Math.subtractExact(javaHundredNanos, WINDOWS_EPOCH_OFFSET); + return Math.subtractExact(javaHundredNanos, UNIX_TO_NTFS_OFFSET); } /** diff --git a/src/test/java/org/apache/commons/io/file/attribute/FileTimesTest.java b/src/test/java/org/apache/commons/io/file/attribute/FileTimesTest.java index d2ef1638b..fd4d447d7 100644 --- a/src/test/java/org/apache/commons/io/file/attribute/FileTimesTest.java +++ b/src/test/java/org/apache/commons/io/file/attribute/FileTimesTest.java @@ -49,31 +49,42 @@ public static Stream<Arguments> dateToNtfsProvider() { Arguments.of("1600-12-31T23:59:59.999Z", -FileTimes.HUNDRED_NANOS_PER_MILLISECOND), Arguments.of("1600-12-31T23:59:59.999Z", -FileTimes.HUNDRED_NANOS_PER_MILLISECOND + 1), Arguments.of("1600-12-31T23:59:59.998Z", -FileTimes.HUNDRED_NANOS_PER_MILLISECOND - 1), - Arguments.of("1970-01-01T00:00:00.000Z", -FileTimes.WINDOWS_EPOCH_OFFSET), - Arguments.of("1970-01-01T00:00:00.000Z", -FileTimes.WINDOWS_EPOCH_OFFSET + 1), - Arguments.of("1970-01-01T00:00:00.001Z", -FileTimes.WINDOWS_EPOCH_OFFSET + FileTimes.HUNDRED_NANOS_PER_MILLISECOND), - Arguments.of("1969-12-31T23:59:59.999Z", -FileTimes.WINDOWS_EPOCH_OFFSET - 1), - Arguments.of("1969-12-31T23:59:59.999Z", -FileTimes.WINDOWS_EPOCH_OFFSET - FileTimes.HUNDRED_NANOS_PER_MILLISECOND)); + Arguments.of("1970-01-01T00:00:00.000Z", -FileTimes.UNIX_TO_NTFS_OFFSET), + Arguments.of("1970-01-01T00:00:00.000Z", -FileTimes.UNIX_TO_NTFS_OFFSET + 1), + Arguments.of("1970-01-01T00:00:00.001Z", -FileTimes.UNIX_TO_NTFS_OFFSET + FileTimes.HUNDRED_NANOS_PER_MILLISECOND), + Arguments.of("1969-12-31T23:59:59.999Z", -FileTimes.UNIX_TO_NTFS_OFFSET - 1), + Arguments.of("1969-12-31T23:59:59.999Z", -FileTimes.UNIX_TO_NTFS_OFFSET - FileTimes.HUNDRED_NANOS_PER_MILLISECOND)); // @formatter:on } - public static Stream<Arguments> fileTimeToNtfsProvider() { + public static Stream<Arguments> fileTimeNanoUnitsToNtfsProvider() { // @formatter:off return Stream.of( Arguments.of("1601-01-01T00:00:00.0000000Z", 0), Arguments.of("1601-01-01T00:00:00.0000001Z", 1), Arguments.of("1600-12-31T23:59:59.9999999Z", -1), + Arguments.of("+30828-09-14T02:48:05.477580700Z", Long.MAX_VALUE), + Arguments.of("-27627-04-19T21:11:54.522419200Z", Long.MIN_VALUE), Arguments.of("1601-01-01T00:00:00.0010000Z", FileTimes.HUNDRED_NANOS_PER_MILLISECOND), Arguments.of("1601-01-01T00:00:00.0010001Z", FileTimes.HUNDRED_NANOS_PER_MILLISECOND + 1), Arguments.of("1601-01-01T00:00:00.0009999Z", FileTimes.HUNDRED_NANOS_PER_MILLISECOND - 1), Arguments.of("1600-12-31T23:59:59.9990000Z", -FileTimes.HUNDRED_NANOS_PER_MILLISECOND), Arguments.of("1600-12-31T23:59:59.9990001Z", -FileTimes.HUNDRED_NANOS_PER_MILLISECOND + 1), Arguments.of("1600-12-31T23:59:59.9989999Z", -FileTimes.HUNDRED_NANOS_PER_MILLISECOND - 1), - Arguments.of("1970-01-01T00:00:00.0000000Z", -FileTimes.WINDOWS_EPOCH_OFFSET), - Arguments.of("1970-01-01T00:00:00.0000001Z", -FileTimes.WINDOWS_EPOCH_OFFSET + 1), - Arguments.of("1970-01-01T00:00:00.0010000Z", -FileTimes.WINDOWS_EPOCH_OFFSET + FileTimes.HUNDRED_NANOS_PER_MILLISECOND), - Arguments.of("1969-12-31T23:59:59.9999999Z", -FileTimes.WINDOWS_EPOCH_OFFSET - 1), - Arguments.of("1969-12-31T23:59:59.9990000Z", -FileTimes.WINDOWS_EPOCH_OFFSET - FileTimes.HUNDRED_NANOS_PER_MILLISECOND)); + Arguments.of("1970-01-01T00:00:00.0000000Z", -FileTimes.UNIX_TO_NTFS_OFFSET), + Arguments.of("1970-01-01T00:00:00.0000001Z", -FileTimes.UNIX_TO_NTFS_OFFSET + 1), + Arguments.of("1970-01-01T00:00:00.0010000Z", -FileTimes.UNIX_TO_NTFS_OFFSET + FileTimes.HUNDRED_NANOS_PER_MILLISECOND), + Arguments.of("1969-12-31T23:59:59.9999999Z", -FileTimes.UNIX_TO_NTFS_OFFSET - 1), + Arguments.of("1969-12-31T23:59:59.9990000Z", -FileTimes.UNIX_TO_NTFS_OFFSET - FileTimes.HUNDRED_NANOS_PER_MILLISECOND)); + // @formatter:on + } + + public static Stream<Arguments> fileTimeToNtfsProvider() { + // @formatter:off + return Stream.of( + Arguments.of("1970-01-01T00:00:00Z", FileTime.from(Instant.EPOCH)), + Arguments.of("1969-12-31T23:59:00Z", FileTime.from(Instant.EPOCH.minusSeconds(60))), + Arguments.of("1970-01-01T00:01:00Z", FileTime.from(Instant.EPOCH.plusSeconds(60)))); // @formatter:on } @@ -113,7 +124,7 @@ public void testEpoch() { } @ParameterizedTest - @MethodSource("fileTimeToNtfsProvider") + @MethodSource("fileTimeNanoUnitsToNtfsProvider") public void testFileTimeToDate(final String instant, final long ignored) { final Instant parsedInstant = Instant.parse(instant); final FileTime parsedFileTime = FileTime.from(parsedInstant); @@ -121,8 +132,18 @@ public void testFileTimeToDate(final String instant, final long ignored) { assertEquals(parsedDate, FileTimes.toDate(parsedFileTime)); } + //@Disabled @ParameterizedTest @MethodSource("fileTimeToNtfsProvider") + public void testFileTimeToNtfsTime(final String instantStr, final FileTime fileTime) { + final Instant instant = Instant.parse(instantStr); + final FileTime parsed = FileTime.from(instant); + assertEquals(instant, parsed.toInstant()); + assertEquals(fileTime, FileTimes.ntfsTimeToFileTime(FileTimes.toNtfsTime(parsed))); + } + + @ParameterizedTest + @MethodSource("fileTimeNanoUnitsToNtfsProvider") public void testFileTimeToNtfsTime(final String instant, final long ntfsTime) { final FileTime parsed = FileTime.from(Instant.parse(instant)); assertEquals(ntfsTime, FileTimes.toNtfsTime(parsed)); @@ -179,10 +200,13 @@ public void testNtfsTimeToDate(final String instant, final long ntfsTime) { } @ParameterizedTest - @MethodSource("fileTimeToNtfsProvider") - public void testNtfsTimeToFileTime(final String instant, final long ntfsTime) { - final FileTime parsed = FileTime.from(Instant.parse(instant)); - assertEquals(parsed, FileTimes.ntfsTimeToFileTime(ntfsTime)); + @MethodSource("fileTimeNanoUnitsToNtfsProvider") + public void testNtfsTimeToFileTime(final String instantStr, final long ntfsTime) { + final Instant instant = Instant.parse(instantStr); + final FileTime fileTime = FileTime.from(instant); + assertEquals(instant, fileTime.toInstant()); // sanity check + assertEquals(instant, FileTimes.ntfsTimeToInstant(ntfsTime)); + assertEquals(fileTime, FileTimes.ntfsTimeToFileTime(ntfsTime)); } @Test