add API to force uid/gid (in tar)

Author: hboutemy

src/main/java/org/codehaus/plexus/archiver/AbstractArchiver.java

@@ -38,6 +38,7 @@
 import org.codehaus.plexus.archiver.manager.NoSuchArchiverException;
 import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
 import org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributes;
+import org.codehaus.plexus.components.io.attributes.SimpleResourceAttributes;
 import org.codehaus.plexus.components.io.functions.ResourceAttributeSupplier;
 import org.codehaus.plexus.components.io.resources.AbstractPlexusIoResourceCollection;
 import org.codehaus.plexus.components.io.resources.EncodingSupported;
@@ -115,6 +116,26 @@ public abstract class AbstractArchiver
      */
     private Comparator<String> filenameComparator;
 
+    /**
+     * @sine 4.2.0
+     */
+    private int overrideUid = -1;
+
+    /**
+     * @sine 4.2.0
+     */
+    private String overrideUserName;
+
+    /**
+     * @sine 4.2.0
+     */
+    private int overrideGid = -1;
+
+    /**
+     * @sine 4.2.0
+     */
+    private String overrideGroupName;
+
     // contextualized.
     private ArchiverManager archiverManager;
 
@@ -360,9 +381,12 @@ public void addFileSet( @Nonnull final FileSet fileSet )
         collection.setFileMappers( fileSet.getFileMappers() );
         collection.setFilenameComparator( getFilenameComparator() );
 
-        if ( getOverrideDirectoryMode() > -1 || getOverrideFileMode() > -1 )
+        if ( getOverrideDirectoryMode() > -1 || getOverrideFileMode() > -1 || getOverrideUid() > -1
+            || getOverrideGid() > -1 || getOverrideUserName() != null || getOverrideGroupName() != null )
         {
-            collection.setOverrideAttributes( -1, null, -1, null, getOverrideFileMode(), getOverrideDirectoryMode() );
+            collection.setOverrideAttributes( getOverrideUid(), getOverrideUserName(), getOverrideGid(),
+                                              getOverrideGroupName(), getOverrideFileMode(),
+                                              getOverrideDirectoryMode() );
         }
 
         if ( getDefaultDirectoryMode() > -1 || getDefaultFileMode() > -1 )
@@ -399,6 +423,18 @@ public void addSymlink( String symlinkName, int permissions, String symlinkDesti
             ArchiveEntry.createSymlinkEntry( symlinkName, permissions, symlinkDestination, getDirectoryMode() ) );
     }
 
+    private ArchiveEntry updateArchiveEntryAttributes( ArchiveEntry entry )
+    {
+        if ( getOverrideUid() > -1 || getOverrideGid() > -1 || getOverrideUserName() != null
+            || getOverrideGroupName() != null )
+        {
+            entry.setResourceAttributes( new SimpleResourceAttributes( getOverrideUid(), getOverrideUserName(),
+                                                                       getOverrideGid(), getOverrideGroupName(),
+                                                                       entry.getMode() ) );
+        }
+        return entry;
+    }
+
     protected ArchiveEntry asArchiveEntry( @Nonnull final PlexusIoResource resource, final String destFileName,
                                            final int permissions, PlexusIoResourceCollection collection )
         throws ArchiverException
@@ -408,14 +444,17 @@ protected ArchiveEntry asArchiveEntry( @Nonnull final PlexusIoResource resource,
             throw new ArchiverException( resource.getName() + " not found." );
         }
 
+        ArchiveEntry entry;
         if ( resource.isFile() )
         {
-            return ArchiveEntry.createFileEntry( destFileName, resource, permissions, collection, getDirectoryMode() );
+            entry = ArchiveEntry.createFileEntry( destFileName, resource, permissions, collection, getDirectoryMode() );
         }
         else
         {
-            return ArchiveEntry.createDirectoryEntry( destFileName, resource, permissions, getDirectoryMode() );
+            entry = ArchiveEntry.createDirectoryEntry( destFileName, resource, permissions, getDirectoryMode() );
         }
+
+        return updateArchiveEntryAttributes( entry );
     }
 
     private ArchiveEntry asArchiveEntry( final AddedResourceCollection collection, final PlexusIoResource resource )
@@ -468,7 +507,9 @@ public void addFile( @Nonnull final File inputFile, @Nonnull String destFileName
         try
         {
             // do a null check here, to avoid creating a file stream if there are no filters...
-            doAddResource( ArchiveEntry.createFileEntry( destFileName, inputFile, permissions, getDirectoryMode() ) );
+            ArchiveEntry entry =
+                ArchiveEntry.createFileEntry( destFileName, inputFile, permissions, getDirectoryMode() );
+            doAddResource( updateArchiveEntryAttributes( entry ) );
         }
         catch ( final IOException e )
         {
@@ -1168,4 +1209,52 @@ public Comparator<String> getFilenameComparator()
     {
         return filenameComparator;
     }
+
+    @Override
+    public void setOverrideUid( int uid )
+    {
+        overrideUid = uid;
+    }
+
+    @Override
+    public void setOverrideUserName( String userName )
+    {
+        overrideUserName = userName;
+    }
+
+    @Override
+    public int getOverrideUid()
+    {
+        return overrideUid;
+    }
+
+    @Override
+    public String getOverrideUserName()
+    {
+        return overrideUserName;
+    }
+
+    @Override
+    public void setOverrideGid( int gid )
+    {
+        overrideGid = gid;
+    }
+
+    @Override
+    public void setOverrideGroupName( String groupName )
+    {
+        overrideGroupName = groupName;
+    }
+
+    @Override
+    public int getOverrideGid()
+    {
+        return overrideGid;
+    }
+
+    @Override
+    public String getOverrideGroupName()
+    {
+        return overrideGroupName;
+    }
 }

src/main/java/org/codehaus/plexus/archiver/Archiver.java

@@ -418,4 +418,44 @@ ResourceIterator getResources()
      * @since 4.2.0
      */
     void setFilenameComparator( Comparator<String> filenameComparator );
+
+    /**
+     * @since 4.2.0
+     */
+    void setOverrideUid( int uid );
+
+    /**
+     * @since 4.2.0
+     */
+    void setOverrideUserName( String userName );
+
+    /**
+     * @since 4.2.0
+     */
+    int getOverrideUid();
+
+    /**
+     * @since 4.2.0
+     */
+    String getOverrideUserName();
+
+    /**
+     * @since 4.2.0
+     */
+    void setOverrideGid( int gid );
+
+    /**
+     * @since 4.2.0
+     */
+    void setOverrideGroupName( String groupName );
+
+    /**
+     * @since 4.2.0
+     */
+    int getOverrideGid();
+
+    /**
+     * @since 4.2.0
+     */
+    String getOverrideGroupName();
 }

src/main/java/org/codehaus/plexus/archiver/diags/DelgatingArchiver.java

@@ -350,4 +350,52 @@ public void setFilenameComparator( final Comparator<String> filenameComparator )
     {
         target.setFilenameComparator( filenameComparator );
     }
+
+    @Override
+    public void setOverrideUid( int uid )
+    {
+        target.setOverrideUid( uid );
+    }
+
+    @Override
+    public void setOverrideUserName( String userName )
+    {
+        target.setOverrideUserName( userName );
+    }
+
+    @Override
+    public int getOverrideUid()
+    {
+        return target.getOverrideUid();
+    }
+
+    @Override
+    public String getOverrideUserName()
+    {
+        return target.getOverrideUserName();
+    }
+
+    @Override
+    public void setOverrideGid( int gid )
+    {
+        target.setOverrideGid( gid );
+    }
+
+    @Override
+    public void setOverrideGroupName( String groupName )
+    {
+        target.setOverrideGroupName( groupName );
+    }
+
+    @Override
+    public int getOverrideGid()
+    {
+        return target.getOverrideGid();
+    }
+
+    @Override
+    public String getOverrideGroupName()
+    {
+        return target.getOverrideGroupName();
+    }
 }

src/main/java/org/codehaus/plexus/archiver/diags/NoOpArchiver.java

@@ -366,4 +366,52 @@ public void setFilenameComparator( final Comparator<String> filenameComparator )
 
     }
 
+    @Override
+    public void setOverrideUid( int uid )
+    {
+
+    }
+
+    @Override
+    public void setOverrideUserName( String userName )
+    {
+
+    }
+
+    @Override
+    public int getOverrideUid()
+    {
+        return 0;
+    }
+
+    @Override
+    public String getOverrideUserName()
+    {
+        return null;
+    }
+
+    @Override
+    public void setOverrideGid( int gid )
+    {
+
+    }
+
+    @Override
+    public void setOverrideGroupName( String groupName )
+    {
+
+    }
+
+    @Override
+    public int getOverrideGid()
+    {
+        return 0;
+    }
+
+    @Override
+    public String getOverrideGroupName()
+    {
+        return null;
+    }
+
 }

src/main/java/org/codehaus/plexus/archiver/diags/TrackingArchiver.java

@@ -424,4 +424,48 @@ public void setFilenameComparator( final Comparator<String> filenameComparator )
     {
         this.filenameComparator = filenameComparator;
     }
+
+    @Override
+    public void setOverrideUid( int uid )
+    {
+    }
+
+    @Override
+    public void setOverrideUserName( String userName )
+    {
+    }
+
+    @Override
+    public int getOverrideUid()
+    {
+        return 0;
+    }
+
+    @Override
+    public String getOverrideUserName()
+    {
+        return null;
+    }
+
+    @Override
+    public void setOverrideGid( int gid )
+    {
+    }
+
+    @Override
+    public void setOverrideGroupName( String groupName )
+    {
+    }
+
+    @Override
+    public int getOverrideGid()
+    {
+        return 0;
+    }
+
+    @Override
+    public String getOverrideGroupName()
+    {
+        return null;
+    }
 }