Skip to content

Refactor to use FileTime API #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 45 additions & 13 deletions src/main/java/org/codehaus/plexus/archiver/AbstractArchiver.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import java.lang.reflect.UndeclaredThrowableException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.attribute.FileTime;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.Date;
Expand Down Expand Up @@ -107,10 +108,7 @@ public abstract class AbstractArchiver
*/
private boolean useJvmChmod = true;

/**
* @since 4.2.0
*/
private Date lastModifiedDate;
private FileTime lastModifiedTime;

/**
* @since 4.2.0
Expand Down Expand Up @@ -1208,16 +1206,36 @@ public void setIgnorePermissions( final boolean ignorePermissions )
this.ignorePermissions = ignorePermissions;
}

/**
* @deprecated Use {@link #setLastModifiedTime(FileTime)} instead.
*/
@Override
@Deprecated
public void setLastModifiedDate( Date lastModifiedDate )
{
this.lastModifiedDate = lastModifiedDate;
this.lastModifiedTime = lastModifiedDate != null ? FileTime.fromMillis( lastModifiedDate.getTime() ) : null;
}

/**
* @deprecated Use {@link #getLastModifiedTime()} instead.
*/
@Override
@Deprecated
public Date getLastModifiedDate()
{
return lastModifiedDate;
return lastModifiedTime != null ? new Date( lastModifiedTime.toMillis() ) : null;
}

@Override
public void setLastModifiedTime( FileTime lastModifiedTime )
{
this.lastModifiedTime = lastModifiedTime;
}

@Override
public FileTime getLastModifiedTime()
{
return lastModifiedTime;
}

@Override
Expand Down Expand Up @@ -1279,11 +1297,21 @@ public String getOverrideGroupName()
return overrideGroupName;
}

/**
* @deprecated Use {@link #configureReproducibleBuild(FileTime)} instead.
*/
@Override
@Deprecated
public void configureReproducible( Date lastModifiedDate )
{
configureReproducibleBuild( FileTime.fromMillis( lastModifiedDate.getTime() ) );
}

@Override
public void configureReproducibleBuild( FileTime lastModifiedTime )
{
// 1. force last modified date
setLastModifiedDate( normalizeLastModifiedDate( lastModifiedDate ) );
setLastModifiedTime( normalizeLastModifiedTime ( lastModifiedTime ) );

// 2. sort filenames in each directory when scanning filesystem
setFilenameComparator( new Comparator<String>()
Expand All @@ -1309,14 +1337,18 @@ public int compare( String s1, String s2 )

/**
* Normalize last modified time value to get reproducible archive entries, based on
* archive binary format (tar uses UTC timestamp but zip uses local time then requires
* tweaks to make the value reproducible whatever the current timezone is).
* archive binary format.
*
* <p>tar uses UTC timestamp, but zip uses local time then requires
* tweaks to make the value reproducible whatever the current timezone is.
*
* @param lastModifiedTime The last modification time
* @return The normalized last modification time
*
* @param lastModifiedDate
* @return
* @see #configureReproducibleBuild(FileTime)
*/
protected Date normalizeLastModifiedDate( Date lastModifiedDate )
protected FileTime normalizeLastModifiedTime( FileTime lastModifiedTime )
{
return lastModifiedDate;
return lastModifiedTime;
}
}
47 changes: 43 additions & 4 deletions src/main/java/org/codehaus/plexus/archiver/Archiver.java
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@
import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.attribute.FileTime;
import java.util.Comparator;
import java.util.Date;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import javax.annotation.Nonnull;
import org.codehaus.plexus.components.io.resources.PlexusIoResource;
import org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection;
Expand Down Expand Up @@ -390,14 +392,38 @@ ResourceIterator getResources()
*
* @param lastModifiedDate
* @since 4.2.0
* @deprecated Use {@link #setLastModifiedTime(FileTime)} instead
*/
@Deprecated
void setLastModifiedDate( final Date lastModifiedDate );

/**
* @since 4.2.0
* @deprecated Use {@link #getLastModifiedTime()} instead
*/
@Deprecated
Date getLastModifiedDate();

/**
* Sets the last modification time of the entries (if non null).
*
* @param lastModifiedTime to set in the archive entries
*
* @see #getLastModifiedTime()
* @since 4.3.0
*/
void setLastModifiedTime( final FileTime lastModifiedTime );

/**
* Returns the last modification time of the archiver.
*
* @return The last modification time of the archiver, null if not specified
*
* @see #setLastModifiedTime(FileTime)
* @since 4.3.0
*/
FileTime getLastModifiedTime();

/**
* Set filename comparator, used to sort file entries when scanning directories since File.list() does not
* guarantee any order.
Expand Down Expand Up @@ -446,6 +472,17 @@ ResourceIterator getResources()
*/
String getOverrideGroupName();

/**
* This method is obsolete and will just call {@link #configureReproducibleBuild(FileTime)}
* with the Date transformed into FileTime.
*
* @param lastModifiedDate the date to use for archive entries last modified time
* @since 4.2.0
* @deprecated Use {@link #configureReproducibleBuild(FileTime)} instead.
*/
@Deprecated
void configureReproducible( Date lastModifiedDate );

/**
* Configure the archiver to create archives in a reproducible way (see
* <a href="https://reproducible-builds.org/">Reproducible Builds</a>).
Expand All @@ -455,9 +492,11 @@ ResourceIterator getResources()
* <li>defined entries timestamp</li>
* <li>and reproducible entries Unix mode.</li>
* </ul>
*
* @param lastModifiedDate the date to use for archive entries last modified time
* @since 4.2.0
*
* @param lastModifiedTime The last modification time of the entries
*
* @see <a href="https://reproducible-builds.org/">Reproducible Builds</a>
* @since 4.3.0
*/
void configureReproducible( Date lastModifiedDate );
void configureReproducibleBuild( FileTime lastModifiedTime );
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.attribute.FileTime;
import java.util.Comparator;
import java.util.Date;
import java.util.Map;
Expand Down Expand Up @@ -333,18 +334,38 @@ public void setIgnorePermissions( boolean ignorePermissions )
target.setIgnorePermissions( ignorePermissions );
}

/**
* @deprecated Use {@link #setLastModifiedTime(FileTime)} instead.
*/
@Override
@Deprecated
public void setLastModifiedDate( final Date lastModifiedDate )
{
target.setLastModifiedDate( lastModifiedDate );
}

/**
* @deprecated Use {@link #getLastModifiedTime()} instead.
*/
@Override
@Deprecated
public Date getLastModifiedDate()
{
return target.getLastModifiedDate();
}

@Override
public void setLastModifiedTime( final FileTime lastModifiedTime )
{
target.setLastModifiedTime( lastModifiedTime );
}

@Override
public FileTime getLastModifiedTime()
{
return target.getLastModifiedTime();
}

@Override
public void setFilenameComparator( final Comparator<String> filenameComparator )
{
Expand Down Expand Up @@ -399,10 +420,20 @@ public String getOverrideGroupName()
return target.getOverrideGroupName();
}

/**
* @deprecated Use {@link #configureReproducibleBuild(FileTime)} instead.
*/
@Override
@Deprecated
public void configureReproducible( Date lastModifiedDate )
{
target.configureReproducible( lastModifiedDate );
}

@Override
public void configureReproducibleBuild( FileTime lastModifiedTime )
{
target.configureReproducibleBuild( lastModifiedTime );
}

}
31 changes: 31 additions & 0 deletions src/main/java/org/codehaus/plexus/archiver/diags/NoOpArchiver.java
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.attribute.FileTime;
import java.util.Collections;
import java.util.Comparator;
import java.util.Date;
Expand Down Expand Up @@ -348,18 +349,38 @@ public void setIgnorePermissions( boolean ignorePermissions )
this.ignorePermissions = ignorePermissions;
}

/**
* @deprecated Use {@link #setLastModifiedTime(FileTime)} instead.
*/
@Override
@Deprecated
public void setLastModifiedDate( final Date lastModifiedDate )
{

}

/**
* @deprecated Use {@link #getLastModifiedTime()} instead.
*/
@Override
@Deprecated
public Date getLastModifiedDate()
{
return null;
}

@Override
public void setLastModifiedTime( final FileTime lastModifiedTime )
{

}

@Override
public FileTime getLastModifiedTime()
{
return null;
}

@Override
public void setFilenameComparator( final Comparator<String> filenameComparator )
{
Expand Down Expand Up @@ -414,10 +435,20 @@ public String getOverrideGroupName()
return null;
}

/**
* @deprecated Use {@link #configureReproducibleBuild(FileTime)} instead.
*/
@Override
@Deprecated
public void configureReproducible( Date lastModifiedDate )
{

}

@Override
public void configureReproducibleBuild( FileTime lastModifiedTime )
{

}

}
Loading