Changeset 5758

Timestamp:

Sep 23, 2011, 9:05:23 AM (10 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #978: Unzipped files never inherit file type specified during upload

Added a parameter for specifying the source file to FileUnpacker.unpack(). The source file is always populated with the options from the form so the actual implementations can copy those values to the unpacked files.

Location:

trunk

Files:

• doc/src/docbook/developer/migrate_2_3.xml (modified) (1 diff)
• src/clients/web/net/sf/basedb/clients/web/servlet/Upload.java (modified) (2 diffs)
• src/core/net/sf/basedb/util/zip/AbstractFileUnpacker.java (modified) (2 diffs)
• src/core/net/sf/basedb/util/zip/FileUnpacker.java (modified) (3 diffs)
• src/core/net/sf/basedb/util/zip/PackUtil.java (added)
• src/core/net/sf/basedb/util/zip/ZipUnpacker.java (modified) (2 diffs)
• src/plugins/core/net/sf/basedb/plugins/TarFileUnpacker.java (modified) (3 diffs)
• src/plugins/core/net/sf/basedb/plugins/ZipFileUnpacker.java (modified) (2 diffs)
• src/test/TestFile.java (modified) (1 diff)

trunk/doc/src/docbook/developer/migrate_2_3.xml

@@ -160 +160 @@
       <listitem>
         <para>
+          Changes to the <interfacename docapi="net.sf.basedb.util.zip">FileUnpacker</interfacename> 
+          interface. The <methodname>unpack()</methodname> method signature has changed and
+          any plug-ins that implement this interface need to be updated. The changes
+          make it possible to get information about the main zip/tar file that is being
+          unpacked. See <ulink 
+          url="http://base.thep.lu.se/ticket/978">ticket #978 (Unzipped files never inherit 
+          file type specified during upload)</ulink> for more information.
+        </para>
+      </listitem>
+      
+      <listitem>
+        <para>
           TODO -- more will probably be added to this list
         </para>

trunk/src/clients/web/net/sf/basedb/clients/web/servlet/Upload.java

@@ -182 +182 @@
             throw new WebException("popup", "File already exists", "Another file with the same name already exists: {1}", uploadedFile.getFilename());
           }
-          
-          f.setName(uploadedFile.getFilename());
-          String serverMimeType = getServletContext().getMimeType(uploadedFile.getFilename());
-          String browserMimeType = uploadedFile.getMimeType();
-          f.setMimeTypeAuto(serverMimeType != null ? serverMimeType : browserMimeType, null);
-          if (subtypeId >= 0) // < 0 = denied or unchanged
-          {
-            ItemSubtype subtype = subtypeId == 0 ? null : ItemSubtype.getById(dc, subtypeId);
-            f.setItemSubtype(subtype);
-            if (subtype != null) cc.setRecent(subtype, maxRecent);
-          }
-          f.setDescription(description);
-          f.setCharacterSet(characterSet);
-          toFile = f.getUploadStream(checkMd5, compress);
-          f.setWriteProtected(writeProtected);
-        }
+        }
+        
+        if (f == null) 
+        {
+          // Create a dummy file that is not saved to the database
+          // We use this so that options from the form can be sent 
+          // to the unpacker.unpack() method
+          f = File.getNew(dc, directory);
+        }
+
+        // Set various properties from the form on the file object
+        f.setName(uploadedFile.getFilename());
+        String serverMimeType = getServletContext().getMimeType(uploadedFile.getFilename());
+        String browserMimeType = uploadedFile.getMimeType();
+        f.setMimeTypeAuto(serverMimeType != null ? serverMimeType : browserMimeType, null);
+        if (subtypeId >= 0) // < 0 = denied or unchanged
+        {
+          ItemSubtype subtype = subtypeId == 0 ? null : ItemSubtype.getById(dc, subtypeId);
+          f.setItemSubtype(subtype);
+          if (subtype != null) cc.setRecent(subtype, maxRecent);
+        }
+        f.setDescription(description);
+        f.setCharacterSet(characterSet);
+        if (!f.isDetached()) toFile = f.getUploadStream(checkMd5, compress);
+        f.setWriteProtected(writeProtected);
         
         // Load plug-in for for unpacking (must implement FileUnpacker)
@@ -230 +239 @@
           SimpleAbsoluteProgressReporter unpackProgress = new SimpleAbsoluteProgressReporter(null, fileSize);
           sc.setSessionSetting("UnpackProgress", unpackProgress);
-          numUnpackedFiles = unpacker.unpack(dc, directory, uploadStream, overwriteZip, unpackProgress);
+          numUnpackedFiles = unpacker.unpack(dc, directory, uploadStream, f, overwriteZip, unpackProgress);
         }
         uploadStream.close();

trunk/src/core/net/sf/basedb/util/zip/AbstractFileUnpacker.java

@@ -139 +139 @@
       permissions.add(new Permissions(Item.FILE, null, EnumSet.of(Permission.CREATE, Permission.WRITE)));
       permissions.add(new Permissions(Item.DIRECTORY, null, EnumSet.of(Permission.CREATE, Permission.WRITE)));
+      permissions.add(new Permissions(Item.ITEMSUBTYPE, EnumSet.of(Permission.USE), null));
     }
     return permissions;
@@ -159 +160 @@
       
       // Unpack the file
-      int numFiles = unpack(dc, dir, in, overwrite, absoluteProgress);
+      int numFiles = unpack(dc, dir, in, zipFile, overwrite, absoluteProgress);
       dc.commit();
       

trunk/src/core/net/sf/basedb/util/zip/FileUnpacker.java

@@ -30 +30 @@
 import net.sf.basedb.core.DbControl;
 import net.sf.basedb.core.Directory;
+import net.sf.basedb.core.File;
 import net.sf.basedb.core.plugin.Plugin;
 
@@ -74 +75 @@
   
   /**
-    Unpack the given input stream into a BASE directory.
+    Unpack the given input stream into a BASE directory. If a source
+    file is given it can be used as a template for setting certain
+    properties on the unpcked files. See {@link 
+    PackUtil#copyProperties(File, File)}.
     
     @param dc The DbControl to use for database access
     @param dir The directory to unpack the files to
     @param in The input stream containing the packed data
+    @param sourceFile The source packed file that the input stream is
+      coming from or null if not known
     @param overwrite If existing files should be overwritten or ignored
     @param progress A optional progress reporter which expects the number
@@ -85 +91 @@
     @throws IOException If there is an error reading the input stream
     @throws BaseException If there is another error
+    @since 3.0
   */
-  public int unpack(DbControl dc, Directory dir, InputStream in, boolean overwrite, 
+  public int unpack(DbControl dc, Directory dir, InputStream in, File sourceFile, boolean overwrite, 
     AbsoluteProgressReporter progress)
     throws IOException, BaseException;

trunk/src/core/net/sf/basedb/util/zip/ZipUnpacker.java

@@ -80 +80 @@
     @throws IOException If there is an error when unpacking the zip file
     @throws BaseException If there is a BASE error
+    @since 3.0
   */
-  public int unpackZipFile(Directory rootDir, ZipInputStream zip, boolean overwrite, 
+  public int unpackZipFile(Directory rootDir, ZipInputStream zip, File sourceFile, boolean overwrite, 
     AbsoluteProgressReporter progress)
     throws IOException, BaseException
@@ -119 +120 @@
           file.setMimeTypeAuto(null, null);
           OutputStream upload = file.getUploadStream(false);
+          PackUtil.copyProperties(sourceFile, file);
           try
           {

trunk/src/plugins/core/net/sf/basedb/plugins/TarFileUnpacker.java

@@ -51 +51 @@
 import net.sf.basedb.util.Values;
 import net.sf.basedb.util.zip.AbstractFileUnpacker;
+import net.sf.basedb.util.zip.PackUtil;
 import net.sf.basedb.util.zip.TarUtil;
 
@@ -97 +98 @@
     return mimeTypes;
   }
+  @Override
   public int unpack(DbControl dc, Directory rootDir, InputStream in,
-    boolean overwrite, AbsoluteProgressReporter progress)
+    File sourceFile, boolean overwrite, AbsoluteProgressReporter progress)
     throws IOException
   {
@@ -161 +163 @@
           file.setMimeTypeAuto(null, null);
           OutputStream upload = file.getUploadStream(false);
+          PackUtil.copyProperties(sourceFile, file);
           try
           {

trunk/src/plugins/core/net/sf/basedb/plugins/ZipFileUnpacker.java

@@ -32 +32 @@
 import net.sf.basedb.core.DbControl;
 import net.sf.basedb.core.Directory;
+import net.sf.basedb.core.File;
 import net.sf.basedb.util.zip.AbstractFileUnpacker;
 import net.sf.basedb.util.zip.ZipUnpacker;
@@ -77 +78 @@
     Use the {@link ZipUnpacker} to unpack the file.
   */
+  @Override
   public int unpack(DbControl dc, Directory dir, InputStream in,
-    boolean overwrite, AbsoluteProgressReporter progress)
+    File sourceFile, boolean overwrite, AbsoluteProgressReporter progress)
     throws IOException
   {
     ZipUnpacker unpacker = new ZipUnpacker(dc);
     ZipInputStream zipStream = new ZipInputStream(in);
-    return unpacker.unpackZipFile(dir, zipStream, overwrite, progress);
+    return unpacker.unpackZipFile(dir, zipStream, sourceFile, overwrite, progress);
   }
   // -------------------------------------------

trunk/src/test/TestFile.java

@@ -387 +387 @@
       AbsoluteProgressReporter progress = TestUtil.getSilent() ? 
         null : new SimpleAbsoluteProgressReporter(new ConsoleProgressReporter(true), fileToUpload.length());
-      unpacker.unpackZipFile(dir, zipFile, true, progress);
+      unpacker.unpackZipFile(dir, zipFile, keepZip, true, progress);
       if (progress != null) progress.append("\n");