commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r761492 - in /commons/proper/compress/trunk/src: main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java test/java/org/apache/commons/compress/compressors/GzipUtilsTestCase.java
Date Fri, 03 Apr 2009 00:35:43 GMT
Author: sebb
Date: Fri Apr  3 00:35:43 2009
New Revision: 761492

URL: http://svn.apache.org/viewvc?rev=761492&view=rev
Log:
COMPRESS-68 Filename suffix mappings for compression formats

Added:
    commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java
  (with props)
    commons/proper/compress/trunk/src/test/java/org/apache/commons/compress/compressors/GzipUtilsTestCase.java
  (with props)

Added: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java?rev=761492&view=auto
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java
(added)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java
Fri Apr  3 00:35:43 2009
@@ -0,0 +1,140 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.commons.compress.compressors.gzip;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Utility code for the gzip compression format.
+ */
+public class GzipUtils {
+
+    /**
+     * Map from common filename suffixes to the suffixes that identify gzipped
+     * versions of those file types. For example: from ".tar" to ".tgz".
+     */
+    private static final Map compressSuffix = new HashMap();
+
+    /**
+     * Map from common filename suffixes of gzipped files to the corresponding
+     * suffixes of uncompressed files. For example: from ".tgz" to ".tar".
+     * <p>
+     * This map also contains gzip-specific suffixes like ".gz" and "-z".
+     * These suffixes are mapped to the empty string, as they should simply
+     * be removed from the filename when the file is uncompressed.
+     */
+    private static final Map uncompressSuffix = new HashMap();
+
+    static {
+        compressSuffix.put(".tar", ".tgz");
+        compressSuffix.put(".svg", ".svgz");
+        compressSuffix.put(".cpio", ".cpgz");
+        compressSuffix.put(".wmf", ".wmz");
+        compressSuffix.put(".emf", ".emz");
+
+        uncompressSuffix.put(".tgz", ".tar");
+        uncompressSuffix.put(".taz", ".tar");
+        uncompressSuffix.put(".svgz", ".svg");
+        uncompressSuffix.put(".cpgz", ".cpio");
+        uncompressSuffix.put(".wmz", ".wmf");
+        uncompressSuffix.put(".emz", ".emf");
+        uncompressSuffix.put(".gz", "");
+        uncompressSuffix.put(".z", "");
+        uncompressSuffix.put("-gz", "");
+        uncompressSuffix.put("-z", "");
+        uncompressSuffix.put("_z", "");
+    }
+    // N.B. if any shorter or longer keys are added, ensure the for loop limits are changed
+
+    /** Private constructor to prevent instantiation of this utility class. */
+    private GzipUtils() {
+    }
+
+    /**
+     * Detects common gzip suffixes in the given filename.
+     *
+     * @param filename name of a file
+     * @return <code>true</code> if the filename has a common gzip suffix,
+     *         <code>false</code> otherwise
+     */
+    public static boolean isCompressedFilename(String filename) {
+        String lower = filename.toLowerCase();
+        int n = lower.length();
+        // Shortest suffix is two letters (_z), longest is five (.svgz)
+        for (int i = 2; i <= 5 && i < n; i++) {
+            if (uncompressSuffix.containsKey(lower.substring(n - i))) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Maps the given name of a gzip-compressed file to the name that the
+     * file should have after uncompression. Commonly used file type specific
+     * suffixes like ".tgz" or ".svgz" are automatically detected and
+     * correctly mapped. For example the name "package.tgz" is mapped to
+     * "package.tar". And any filenames with the generic ".gz" suffix
+     * (or any other generic gzip suffix) is mapped to a name without that
+     * suffix. If no gzip suffix is detected, then the filename is returned
+     * unmapped.
+     *
+     * @param filename name of a file
+     * @return name of the corresponding uncompressed file
+     */
+    public static String getUncompressedFilename(String filename) {
+        String lower = filename.toLowerCase();
+        int n = lower.length();
+        // Shortest suffix is two letters (_z), longest is five (.svgz)
+        for (int i = 2; i <= 5 && i < n; i++) {
+            Object suffix = uncompressSuffix.get(lower.substring(n - i));
+            if (suffix != null) {
+                return filename.substring(0, n - i) + suffix;
+            }
+        }
+        return filename;
+    }
+
+    /**
+     * Maps the given filename to the name that the file should have after
+     * compression with gzip. Common file types with custom suffixes for
+     * compressed versions are automatically detected and correctly mapped.
+     * For example the name "package.tar" is mapped to "package.tgz". If no
+     * custom mapping is applicable, then the default ".gz" suffix is appended
+     * to the filename.
+     *
+     * @param filename name of a file
+     * @return name of the corresponding compressed file
+     */
+    public static String getCompressedFilename(String filename) {
+        String lower = filename.toLowerCase();
+        int n = lower.length();
+        // Shortest suffix is four letters (.svg), longest is five (.cpio)
+        for (int i = 4; i <= 5 && i < n; i++) {
+            Object suffix = compressSuffix.get(lower.substring(n - i));
+            if (suffix != null) {
+                return filename.substring(0, n - i) + suffix;
+            }
+        }
+        // No custom suffix found, just append the default .gz
+        return filename + ".gz";
+    }
+
+}

Propchange: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Added: commons/proper/compress/trunk/src/test/java/org/apache/commons/compress/compressors/GzipUtilsTestCase.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/test/java/org/apache/commons/compress/compressors/GzipUtilsTestCase.java?rev=761492&view=auto
==============================================================================
--- commons/proper/compress/trunk/src/test/java/org/apache/commons/compress/compressors/GzipUtilsTestCase.java
(added)
+++ commons/proper/compress/trunk/src/test/java/org/apache/commons/compress/compressors/GzipUtilsTestCase.java
Fri Apr  3 00:35:43 2009
@@ -0,0 +1,100 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.commons.compress.compressors;
+
+import org.apache.commons.compress.compressors.gzip.GzipUtils;
+
+import junit.framework.TestCase;
+
+public class GzipUtilsTestCase extends TestCase {
+
+    public void testIsCompressedFilename() {
+        assertFalse(GzipUtils.isCompressedFilename(""));
+        assertFalse(GzipUtils.isCompressedFilename(".gz"));
+
+        assertTrue(GzipUtils.isCompressedFilename("x.tgz"));
+        assertTrue(GzipUtils.isCompressedFilename("x.taz"));
+        assertTrue(GzipUtils.isCompressedFilename("x.svgz"));
+        assertTrue(GzipUtils.isCompressedFilename("x.cpgz"));
+        assertTrue(GzipUtils.isCompressedFilename("x.wmz"));
+        assertTrue(GzipUtils.isCompressedFilename("x.emz"));
+        assertTrue(GzipUtils.isCompressedFilename("x.gz"));
+        assertTrue(GzipUtils.isCompressedFilename("x.z"));
+        assertTrue(GzipUtils.isCompressedFilename("x-gz"));
+        assertTrue(GzipUtils.isCompressedFilename("x-z"));
+        assertTrue(GzipUtils.isCompressedFilename("x_z"));
+
+        assertFalse(GzipUtils.isCompressedFilename("xxgz"));
+        assertFalse(GzipUtils.isCompressedFilename("xzz"));
+        assertFalse(GzipUtils.isCompressedFilename("xaz"));
+
+        assertTrue(GzipUtils.isCompressedFilename("x.SVGZ"));
+        assertTrue(GzipUtils.isCompressedFilename("x.Svgz"));
+        assertTrue(GzipUtils.isCompressedFilename("x.svGZ"));
+
+        assertFalse(GzipUtils.isCompressedFilename("x.wmz "));
+        assertFalse(GzipUtils.isCompressedFilename("x.wmz\n"));
+        assertFalse(GzipUtils.isCompressedFilename("x.wmz.y"));
+    }
+
+    public void testGetUncompressedFilename() {
+        assertEquals("", GzipUtils.getUncompressedFilename(""));
+        assertEquals(".gz", GzipUtils.getUncompressedFilename(".gz"));
+
+        assertEquals("x.tar", GzipUtils.getUncompressedFilename("x.tgz"));
+        assertEquals("x.tar", GzipUtils.getUncompressedFilename("x.taz"));
+        assertEquals("x.svg", GzipUtils.getUncompressedFilename("x.svgz"));
+        assertEquals("x.cpio", GzipUtils.getUncompressedFilename("x.cpgz"));
+        assertEquals("x.wmf", GzipUtils.getUncompressedFilename("x.wmz"));
+        assertEquals("x.emf", GzipUtils.getUncompressedFilename("x.emz"));
+        assertEquals("x", GzipUtils.getUncompressedFilename("x.gz"));
+        assertEquals("x", GzipUtils.getUncompressedFilename("x.z"));
+        assertEquals("x", GzipUtils.getUncompressedFilename("x-gz"));
+        assertEquals("x", GzipUtils.getUncompressedFilename("x-z"));
+        assertEquals("x", GzipUtils.getUncompressedFilename("x_z"));
+
+        assertEquals("x.svg", GzipUtils.getUncompressedFilename("x.SVGZ"));
+        assertEquals("X.svg", GzipUtils.getUncompressedFilename("X.SVGZ"));
+        assertEquals("X.svg", GzipUtils.getUncompressedFilename("X.svGZ"));
+
+        assertEquals("x.wmz ", GzipUtils.getUncompressedFilename("x.wmz "));
+        assertEquals("x.wmz\n", GzipUtils.getUncompressedFilename("x.wmz\n"));
+        assertEquals("x.wmz.y", GzipUtils.getUncompressedFilename("x.wmz.y"));
+    }
+
+    public void testGetCompressedFilename() {
+        assertEquals(".gz", GzipUtils.getCompressedFilename(""));
+        assertEquals("x.gz", GzipUtils.getCompressedFilename("x"));
+
+        assertEquals("x.tgz", GzipUtils.getCompressedFilename("x.tar"));
+        assertEquals("x.svgz", GzipUtils.getCompressedFilename("x.svg"));
+        assertEquals("x.cpgz", GzipUtils.getCompressedFilename("x.cpio"));
+        assertEquals("x.wmz", GzipUtils.getCompressedFilename("x.wmf"));
+        assertEquals("x.emz", GzipUtils.getCompressedFilename("x.emf"));
+
+        assertEquals("x.svgz", GzipUtils.getCompressedFilename("x.SVG"));
+        assertEquals("X.svgz", GzipUtils.getCompressedFilename("X.SVG"));
+        assertEquals("X.svgz", GzipUtils.getCompressedFilename("X.svG"));
+
+        assertEquals("x.wmf .gz", GzipUtils.getCompressedFilename("x.wmf "));
+        assertEquals("x.wmf\n.gz", GzipUtils.getCompressedFilename("x.wmf\n"));
+        assertEquals("x.wmf.y.gz", GzipUtils.getCompressedFilename("x.wmf.y"));
+    }
+
+}

Propchange: commons/proper/compress/trunk/src/test/java/org/apache/commons/compress/compressors/GzipUtilsTestCase.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: commons/proper/compress/trunk/src/test/java/org/apache/commons/compress/compressors/GzipUtilsTestCase.java
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision



Mime
View raw message