fix Base64 but breaks compat
[nikiroo-utils.git] / src / be / nikiroo / utils / StringUtils.java
index 994522970af119ebd8c929e318df3849c452ad67..82bdcd2f99a6e868bc249c4e1e37eb0ca2333a56 100644 (file)
@@ -1,5 +1,7 @@
 package be.nikiroo.utils;
 
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
@@ -16,11 +18,15 @@ import java.util.Date;
 import java.util.List;
 import java.util.Map.Entry;
 import java.util.regex.Pattern;
+import java.util.zip.GZIPInputStream;
+import java.util.zip.GZIPOutputStream;
 
 import org.unbescape.html.HtmlEscape;
 import org.unbescape.html.HtmlEscapeLevel;
 import org.unbescape.html.HtmlEscapeType;
 
+import be.nikiroo.utils.streams.Base64InputStream;
+
 /**
  * This class offer some utilities based around {@link String}s.
  * 
@@ -512,79 +518,96 @@ public class StringUtils {
        /**
         * Zip the data and then encode it into Base64.
         * 
-        * @deprecated use {@link StringUtils#base64(byte[], boolean)} with the
-        *             correct parameter instead
-        * 
         * @param data
         *            the data
         * 
         * @return the Base64 zipped version
+        * 
+        * @throws IOException
+        *             in case of I/O error
         */
-       @Deprecated
-       public static String zip64(String data) {
+       public static String zip64s(String data) throws IOException {
                try {
-                       return Base64.encodeBytes(data.getBytes("UTF-8"), Base64.GZIP);
-               } catch (IOException e) {
+                       return zip64(data.getBytes("UTF-8"));
+               } catch (UnsupportedEncodingException e) {
+                       // All conforming JVM are required to support UTF-8
                        e.printStackTrace();
                        return null;
                }
        }
 
        /**
-        * Unconvert from Base64 then unzip the content.
-        * 
-        * @deprecated use {@link StringUtils#unbase64s(String, boolean)} with the
-        *             correct parameter instead
+        * Zip the data and then encode it into Base64.
         * 
         * @param data
-        *            the data in Base64 format
+        *            the data
         * 
-        * @return the raw data
+        * @return the Base64 zipped version
         * 
         * @throws IOException
         *             in case of I/O error
         */
-       @Deprecated
-       public static String unzip64(String data) throws IOException {
-               return new String(Base64.decode(data, Base64.GZIP), "UTF-8");
+       public static String zip64(byte[] data) throws IOException {
+               // 1. compress
+               ByteArrayOutputStream bout = new ByteArrayOutputStream();
+               try {
+                       OutputStream out = new GZIPOutputStream(bout);
+                       try {
+                               out.write(data);
+                       } finally {
+                               out.close();
+                       }
+               } finally {
+                       data = bout.toByteArray();
+                       bout.close();
+               }
+
+               // 2. base64
+               InputStream in = new ByteArrayInputStream(data);
+               try {
+                       in = new Base64InputStream(in, true);
+                       return new String(IOUtils.toByteArray(in), "UTF-8");
+               } finally {
+                       in.close();
+               }
        }
 
        /**
-        * Convert the given data to Base64 format.
+        * Unconvert from Base64 then unzip the content, which is assumed to be a
+        * String.
         * 
         * @param data
-        *            the data to convert
-        * @param zip
-        *            TRUE to also compress the data in GZIP format; remember that
-        *            compressed and not-compressed content are different; you need
-        *            to know which is which when decoding
+        *            the data in Base64 format
         * 
-        * @return the Base64 {@link String} representation of the data
+        * @return the raw data
         * 
         * @throws IOException
-        *             in case of I/O errors
+        *             in case of I/O error
         */
-       public static String base64(String data, boolean zip) throws IOException {
-               return base64(data.getBytes("UTF-8"), zip);
+       public static String unzip64s(String data) throws IOException {
+               return new String(unzip64(data), "UTF-8");
        }
 
        /**
-        * Convert the given data to Base64 format.
+        * Unconvert from Base64 then unzip the content.
         * 
         * @param data
-        *            the data to convert
-        * @param zip
-        *            TRUE to also compress the data in GZIP format; remember that
-        *            compressed and not-compressed content are different; you need
-        *            to know which is which when decoding
+        *            the data in Base64 format
         * 
-        * @return the Base64 {@link String} representation of the data
+        * @return the raw data
         * 
         * @throws IOException
-        *             in case of I/O errors
+        *             in case of I/O error
         */
-       public static String base64(byte[] data, boolean zip) throws IOException {
-               return Base64.encodeBytes(data, zip ? Base64.GZIP : Base64.NO_OPTIONS);
+       public static byte[] unzip64(String data) throws IOException {
+               InputStream in = new Base64InputStream(new ByteArrayInputStream(
+                               data.getBytes("UTF-8")), false);
+               try {
+                       in = new GZIPInputStream(in);
+                       return IOUtils.toByteArray(in);
+               } finally {
+                       in.close();
+               }
        }
 
        /**
@@ -592,29 +615,14 @@ public class StringUtils {
         * 
         * @param data
         *            the data to convert
-        * @param zip
-        *            TRUE to also uncompress the data from a GZIP format; take care
-        *            about this flag, as it could easily cause errors in the
-        *            returned content or an {@link IOException}
-        * @param breakLines
-        *            TRUE to break lines on every 76th character
         * 
         * @return the Base64 {@link String} representation of the data
         * 
         * @throws IOException
         *             in case of I/O errors
         */
-       public static OutputStream base64(OutputStream data, boolean zip,
-                       boolean breakLines) throws IOException {
-               OutputStream out = new Base64.OutputStream(data,
-                               breakLines ? Base64.DO_BREAK_LINES & Base64.ENCODE
-                                               : Base64.ENCODE);
-
-               if (zip) {
-                       out = new java.util.zip.GZIPOutputStream(out);
-               }
-
-               return out;
+       public static String base64(String data) throws IOException {
+               return base64(data.getBytes("UTF-8"));
        }
 
        /**
@@ -622,188 +630,69 @@ public class StringUtils {
         * 
         * @param data
         *            the data to convert
-        * @param zip
-        *            TRUE to also uncompress the data from a GZIP format; take care
-        *            about this flag, as it could easily cause errors in the
-        *            returned content or an {@link IOException}
-        * @param breakLines
-        *            TRUE to break lines on every 76th character
         * 
         * @return the Base64 {@link String} representation of the data
         * 
         * @throws IOException
         *             in case of I/O errors
         */
-       public static InputStream base64(InputStream data, boolean zip,
-                       boolean breakLines) throws IOException {
-               if (zip) {
-                       data = new java.util.zip.GZIPInputStream(data);
+       public static String base64(byte[] data) throws IOException {
+               Base64InputStream in = new Base64InputStream(new ByteArrayInputStream(
+                               data), true);
+               try {
+                       return new String(IOUtils.toByteArray(in), "UTF-8");
+               } finally {
+                       in.close();
                }
-
-               return new Base64.InputStream(data, breakLines ? Base64.DO_BREAK_LINES
-                               & Base64.ENCODE : Base64.ENCODE);
        }
 
        /**
         * Unconvert the given data from Base64 format back to a raw array of bytes.
-        * <p>
-        * Will automatically detect zipped data and also uncompress it before
-        * returning, unless ZIP is false.
         * 
         * @param data
         *            the data to unconvert
-        * @param zip
-        *            TRUE to also uncompress the data from a GZIP format
-        *            automatically; if set to FALSE, zipped data can be returned
         * 
         * @return the raw data represented by the given Base64 {@link String},
-        *         optionally compressed with GZIP
-        * 
-        * @throws IOException
-        *             in case of I/O errors
-        */
-       public static byte[] unbase64(String data, boolean zip) throws IOException {
-               return Base64
-                               .decode(data, zip ? Base64.NO_OPTIONS : Base64.DONT_GUNZIP);
-       }
-
-       /**
-        * Unconvert the given data from Base64 format back to a raw array of bytes.
-        * 
-        * @param data
-        *            the data to unconvert
-        * @param zip
-        *            TRUE to also uncompress the data from a GZIP format; take care
-        *            about this flag, as it could easily cause errors in the
-        *            returned content or an {@link IOException}
-        * 
-        * @return the raw data represented by the given Base64 {@link String}
-        * 
-        * @throws IOException
-        *             in case of I/O errors
-        */
-       public static OutputStream unbase64(OutputStream data, boolean zip)
-                       throws IOException {
-               OutputStream out = new Base64.OutputStream(data, Base64.DECODE);
-
-               if (zip) {
-                       out = new java.util.zip.GZIPOutputStream(out);
-               }
-
-               return out;
-       }
-
-       /**
-        * Unconvert the given data from Base64 format back to a raw array of bytes.
-        * 
-        * @param data
-        *            the data to unconvert
-        * @param zip
-        *            TRUE to also uncompress the data from a GZIP format; take care
-        *            about this flag, as it could easily cause errors in the
-        *            returned content or an {@link IOException}
-        * 
-        * @return the raw data represented by the given Base64 {@link String}
         * 
         * @throws IOException
         *             in case of I/O errors
         */
-       public static InputStream unbase64(InputStream data, boolean zip)
-                       throws IOException {
-               if (zip) {
-                       data = new java.util.zip.GZIPInputStream(data);
+       public static byte[] unbase64(String data) throws IOException {
+               Base64InputStream in = new Base64InputStream(new ByteArrayInputStream(
+                               data.getBytes("UTF-8")), false);
+               try {
+                       return IOUtils.toByteArray(in);
+               } finally {
+                       in.close();
                }
-
-               return new Base64.InputStream(data, Base64.DECODE);
-       }
-
-       /**
-        * Unconvert the given data from Base64 format back to a raw array of bytes.
-        * <p>
-        * Will automatically detect zipped data and also uncompress it before
-        * returning, unless ZIP is false.
-        * 
-        * @param data
-        *            the data to unconvert
-        * @param offset
-        *            the offset at which to start taking the data (do not take the
-        *            data before it into account)
-        * @param count
-        *            the number of bytes to take into account (do not process after
-        *            this number of bytes has been processed)
-        * @param zip
-        *            TRUE to also uncompress the data from a GZIP format
-        *            automatically; if set to FALSE, zipped data can be returned
-        * 
-        * @return the raw data represented by the given Base64 {@link String}
-        * 
-        * @throws IOException
-        *             in case of I/O errors
-        */
-       public static byte[] unbase64(byte[] data, int offset, int count,
-                       boolean zip) throws IOException {
-               return Base64.niki_decode(data, offset, count, zip ? Base64.NO_OPTIONS
-                               : Base64.DONT_GUNZIP);
        }
 
        /**
         * Unonvert the given data from Base64 format back to a {@link String}.
-        * <p>
-        * Will automatically detect zipped data and also uncompress it before
-        * returning, unless ZIP is false.
         * 
         * @param data
         *            the data to unconvert
-        * @param zip
-        *            TRUE to also uncompress the data from a GZIP format
-        *            automatically; if set to FALSE, zipped data can be returned
         * 
         * @return the {@link String} represented by the given Base64 {@link String}
-        *         , optionally compressed with GZIP
         * 
         * @throws IOException
         *             in case of I/O errors
         */
-       public static String unbase64s(String data, boolean zip) throws IOException {
-               return new String(unbase64(data, zip), "UTF-8");
-       }
-
-       /**
-        * Unconvert the given data from Base64 format back into a {@link String}.
-        * 
-        * @param data
-        *            the data to unconvert
-        * @param offset
-        *            the offset at which to start taking the data (do not take the
-        *            data before it into account)
-        * @param count
-        *            the number of bytes to take into account (do not process after
-        *            this number of bytes has been processed)
-        * @param zip
-        *            TRUE to also uncompress the data from a GZIP format; take care
-        *            about this flag, as it could easily cause errors in the
-        *            returned content or an {@link IOException}
-        * 
-        * @return the {@link String} represented by the given Base64 {@link String}
-        *         , optionally compressed with GZIP
-        * 
-        * @throws IOException
-        *             in case of I/O errors
-        */
-       public static String unbase64s(byte[] data, int offset, int count,
-                       boolean zip) throws IOException {
-               return new String(unbase64(data, offset, count, zip), "UTF-8");
+       public static String unbase64s(String data) throws IOException {
+               return new String(unbase64(data), "UTF-8");
        }
 
        /**
         * Return a display {@link String} for the given value, which can be
         * suffixed with "k" or "M" depending upon the number, if it is big enough.
         * <p>
-        * Example:
+        * <p>
+        * Examples:
         * <ul>
-        * <li><tt>8765</tt> becomes "8k"</li>
-        * <li><tt>998765</tt> becomes "998k"</li>
-        * <li><tt>12987364</tt> becomes "12M"</li>
+        * <li><tt>8 765</tt> becomes "8k"</li>
+        * <li><tt>998 765</tt> becomes "998k"</li>
+        * <li><tt>12 987 364</tt> becomes "12M"</li>
+        * <li><tt>5 534 333 221</tt> becomes "5G"</li>
         * </ul>
         * 
         * @param value
@@ -812,39 +701,135 @@ public class StringUtils {
         * @return the display value
         */
        public static String formatNumber(long value) {
-               return formatNumber(value, true);
+               return formatNumber(value, 0);
        }
 
        /**
         * Return a display {@link String} for the given value, which can be
         * suffixed with "k" or "M" depending upon the number, if it is big enough.
         * <p>
-        * Example:
+        * Examples (assuming decimalPositions = 1):
         * <ul>
-        * <li><tt>8765</tt> becomes "8k"</li>
-        * <li><tt>998765</tt> becomes "998k"</li>
-        * <li><tt>12987364</tt> becomes "12M"</li>
+        * <li><tt>8 765</tt> becomes "8.7k"</li>
+        * <li><tt>998 765</tt> becomes "998.7k"</li>
+        * <li><tt>12 987 364</tt> becomes "12.9M"</li>
+        * <li><tt>5 534 333 221</tt> becomes "5.5G"</li>
         * </ul>
         * 
         * @param value
         *            the value to convert
-        * @param strict
-        *            TRUE if you want any value equals or greater than 1000 to use
-        *            the "k" suffix; FALSE if you want to go a bit higher and only
-        *            use "k" for values equal or greater than 4000
+        * @param decimalPositions
+        *            the number of decimal positions to keep
         * 
         * @return the display value
         */
-       public static String formatNumber(long value, boolean strict) {
-               if (value >= 1000000l) {
-                       return Long.toString(value / 1000000l) + "M";
+       public static String formatNumber(long value, int decimalPositions) {
+               long userValue = value;
+               String suffix = "";
+               long mult = 1;
+
+               if (value >= 1000000000l) {
+                       mult = 1000000000l;
+                       userValue = value / 1000000000l;
+                       suffix = " G";
+               } else if (value >= 1000000l) {
+                       mult = 1000000l;
+                       userValue = value / 1000000l;
+                       suffix = " M";
+               } else if (value >= 1000l) {
+                       mult = 1000l;
+                       userValue = value / 1000l;
+                       suffix = " k";
                }
 
-               if ((strict && value >= 1000l) || (!strict && value >= 4000l)) {
-                       return Long.toString(value / 1000l) + "k";
+               String deci = "";
+               if (decimalPositions > 0) {
+                       deci = Long.toString(value % mult);
+                       int size = Long.toString(mult).length() - 1;
+                       while (deci.length() < size) {
+                               deci = "0" + deci;
+                       }
+
+                       deci = deci.substring(0, Math.min(decimalPositions, deci.length()));
+                       while (deci.length() < decimalPositions) {
+                               deci += "0";
+                       }
+
+                       deci = "." + deci;
+               }
+
+               return Long.toString(userValue) + deci + suffix;
+       }
+
+       /**
+        * The reverse operation to {@link StringUtils#formatNumber(long)}: it will
+        * read a "display" number that can contain a "M" or "k" suffix and return
+        * the full value.
+        * <p>
+        * Of course, the conversion to and from display form is lossy (example:
+        * <tt>6870</tt> to "6.5k" to <tt>6500</tt>).
+        * 
+        * @param value
+        *            the value in display form with possible "M" and "k" suffixes,
+        *            can be NULL
+        * 
+        * @return the value as a number, or 0 if not possible to convert
+        */
+       public static long toNumber(String value) {
+               return toNumber(value, 0l);
+       }
+
+       /**
+        * The reverse operation to {@link StringUtils#formatNumber(long)}: it will
+        * read a "display" number that can contain a "M" or "k" suffix and return
+        * the full value.
+        * <p>
+        * Of course, the conversion to and from display form is lossy (example:
+        * <tt>6870</tt> to "6.5k" to <tt>6500</tt>).
+        * 
+        * @param value
+        *            the value in display form with possible "M" and "k" suffixes,
+        *            can be NULL
+        * @param def
+        *            the default value if it is not possible to convert the given
+        *            value to a number
+        * 
+        * @return the value as a number, or 0 if not possible to convert
+        */
+       public static long toNumber(String value, long def) {
+               long count = def;
+               if (value != null) {
+                       value = value.trim().toLowerCase();
+                       try {
+                               long mult = 1;
+                               if (value.endsWith("g")) {
+                                       value = value.substring(0, value.length() - 1).trim();
+                                       mult = 1000000000;
+                               } else if (value.endsWith("m")) {
+                                       value = value.substring(0, value.length() - 1).trim();
+                                       mult = 1000000;
+                               } else if (value.endsWith("k")) {
+                                       value = value.substring(0, value.length() - 1).trim();
+                                       mult = 1000;
+                               }
+
+                               long deci = 0;
+                               if (value.contains(".")) {
+                                       String[] tab = value.split("\\.");
+                                       if (tab.length != 2) {
+                                               throw new NumberFormatException(value);
+                                       }
+                                       double decimal = Double.parseDouble("0."
+                                                       + tab[tab.length - 1]);
+                                       deci = ((long) (mult * decimal));
+                                       value = tab[0];
+                               }
+                               count = mult * Long.parseLong(value) + deci;
+                       } catch (Exception e) {
+                       }
                }
 
-               return Long.toString(value);
+               return count;
        }
 
        /**