package be.nikiroo.utils;
-import java.awt.Image;
-import java.awt.image.BufferedImage;
import java.io.ByteArrayInputStream;
-import java.io.ByteArrayOutputStream;
-import java.io.File;
import java.io.IOException;
-import java.io.InputStream;
+import java.io.UnsupportedEncodingException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.text.Normalizer;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
+import java.util.List;
+import java.util.Scanner;
import java.util.regex.Pattern;
-import javax.imageio.ImageIO;
-
import org.unbescape.html.HtmlEscape;
import org.unbescape.html.HtmlEscapeLevel;
import org.unbescape.html.HtmlEscapeType;
public class StringUtils {
/**
* This enum type will decide the alignment of a {@link String} when padding
- * is applied or if there is enough horizontal space for it to be aligned.
+ * or justification is applied (if there is enough horizontal space for it
+ * to be aligned).
*/
public enum Alignment {
/** Aligned at left. */
- Beginning,
+ LEFT,
/** Centered. */
- Center,
+ CENTER,
/** Aligned at right. */
- End
+ RIGHT,
+ /** Full justified (to both left and right). */
+ JUSTIFY,
+
+ // Old Deprecated values:
+
+ /** DEPRECATED: please use LEFT. */
+ @Deprecated
+ Beginning,
+ /** DEPRECATED: please use CENTER. */
+ @Deprecated
+ Center,
+ /** DEPRECATED: please use RIGHT. */
+ @Deprecated
+ End;
+
+ /**
+ * Return the non-deprecated version of this enum if needed (or return
+ * self if not).
+ *
+ * @return the non-deprecated value
+ */
+ Alignment undeprecate() {
+ if (this == Beginning)
+ return LEFT;
+ if (this == Center)
+ return CENTER;
+ if (this == End)
+ return RIGHT;
+ return this;
+ }
}
- static private Pattern marks = Pattern
- .compile("[\\p{InCombiningDiacriticalMarks}\\p{IsLm}\\p{IsSk}]+");
+ static private Pattern marks = getMarks();
/**
* Fix the size of the given {@link String} either with space-padding or by
* @return the resulting {@link String} of size <i>size</i>
*/
static public String padString(String text, int width) {
- return padString(text, width, true, Alignment.Beginning);
+ return padString(text, width, true, null);
}
/**
* cut the {@link String} shorter if needed
* @param align
* align the {@link String} in this position if we have enough
- * space
+ * space (default is Alignment.Beginning)
*
* @return the resulting {@link String} of size <i>size</i> minimum
*/
static public String padString(String text, int width, boolean cut,
Alignment align) {
+ if (align == null) {
+ align = Alignment.LEFT;
+ }
+
+ align = align.undeprecate();
+
if (width >= 0) {
if (text == null)
text = "";
if (cut)
text = text.substring(0, width);
} else if (diff > 0) {
- if (diff < 2 && align != Alignment.End)
- align = Alignment.Beginning;
+ if (diff < 2 && align != Alignment.RIGHT)
+ align = Alignment.LEFT;
switch (align) {
- case Beginning:
- text = text + new String(new char[diff]).replace('\0', ' ');
- break;
- case End:
+ case RIGHT:
text = new String(new char[diff]).replace('\0', ' ') + text;
break;
- case Center:
- default:
+ case CENTER:
int pad1 = (diff) / 2;
int pad2 = (diff + 1) / 2;
text = new String(new char[pad1]).replace('\0', ' ') + text
+ new String(new char[pad2]).replace('\0', ' ');
break;
+ case LEFT:
+ default:
+ text = text + new String(new char[diff]).replace('\0', ' ');
+ break;
}
}
}
return text;
}
+ /**
+ * Justify a text into width-sized (at the maximum) lines.
+ *
+ * @param text
+ * the {@link String} to justify
+ * @param width
+ * the maximum size of the resulting lines
+ *
+ * @return a list of justified text lines
+ */
+ static public List<String> justifyText(String text, int width) {
+ return justifyText(text, width, null);
+ }
+
+ /**
+ * Justify a text into width-sized (at the maximum) lines.
+ *
+ * @param text
+ * the {@link String} to justify
+ * @param width
+ * the maximum size of the resulting lines
+ * @param align
+ * align the lines in this position (default is
+ * Alignment.Beginning)
+ *
+ * @return a list of justified text lines
+ */
+ static public List<String> justifyText(String text, int width,
+ Alignment align) {
+ if (align == null) {
+ align = Alignment.LEFT;
+ }
+
+ align = align.undeprecate();
+
+ switch (align) {
+ case CENTER:
+ return StringJustifier.center(text, width);
+ case RIGHT:
+ return StringJustifier.right(text, width);
+ case JUSTIFY:
+ return StringJustifier.full(text, width);
+ case LEFT:
+ default:
+ return StringJustifier.left(text, width);
+ }
+ }
+
/**
* Sanitise the given input to make it more Terminal-friendly by removing
* combining characters.
if (removeAllAccents) {
input = Normalizer.normalize(input, Form.NFKD);
- input = marks.matcher(input).replaceAll("");
+ if (marks != null) {
+ input = marks.matcher(input).replaceAll("");
+ }
}
input = Normalizer.normalize(input, Form.NFKC);
}
/**
- * Convert between time in milliseconds to {@link String} in a "static" way
- * (to exchange data over the wire, for instance).
+ * Convert between the time in milliseconds to a {@link String} in a "fixed"
+ * way (to exchange data over the wire, for instance).
+ * <p>
+ * Precise to the second.
*
* @param time
- * the time in milliseconds
+ * the specified number of milliseconds since the standard base
+ * time known as "the epoch", namely January 1, 1970, 00:00:00
+ * GMT
*
* @return the time as a {@link String}
*/
}
/**
- * Convert between time as a {@link String} to milliseconds in a "static"
+ * Convert between the time as a {@link String} to milliseconds in a "fixed"
* way (to exchange data over the wire, for instance).
+ * <p>
+ * Precise to the second.
*
- * @param time
+ * @param displayTime
* the time as a {@link String}
*
- * @return the time in milliseconds
- */
- static public long toTime(String display) {
- SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
- try {
- return sdf.parse(display).getTime();
- } catch (ParseException e) {
- return -1;
- }
- }
-
- /**
- * Convert the given {@link Image} object into a Base64 representation of
- * the same {@link Image}. object.
- *
- * @param image
- * the {@link Image} object to convert
- *
- * @return the Base64 representation
- *
- * @throws IOException
- * in case of IO error
- */
- static public String fromImage(BufferedImage image) throws IOException {
- String imageString = null;
- ByteArrayOutputStream out = new ByteArrayOutputStream();
-
- ImageIO.write(image, "jpeg", out);
- byte[] imageBytes = out.toByteArray();
-
- imageString = new String(Base64.encodeBytes(imageBytes));
-
- out.close();
-
- return imageString;
- }
-
- /**
- * Convert the given {@link File} image into a Base64 representation of the
- * same {@link File}.
- *
- * @param file
- * the {@link File} image to convert
- *
- * @return the Base64 representation
- *
- * @throws IOException
- * in case of IO error
- */
- static public String fromStream(InputStream in) throws IOException {
- String fileString = null;
- ByteArrayOutputStream out = new ByteArrayOutputStream();
-
- byte[] buf = new byte[8192];
-
- int c = 0;
- while ((c = in.read(buf, 0, buf.length)) > 0) {
- out.write(buf, 0, c);
- }
- out.flush();
- in.close();
-
- fileString = new String(Base64.encodeBytes(out.toByteArray()));
- out.close();
-
- return fileString;
- }
-
- /**
- * Convert the given Base64 representation of an image into an {@link Image}
- * object.
- *
- * @param b64data
- * the {@link Image} in Base64 format
- *
- * @return the {@link Image} object
+ * @return the number of milliseconds since the standard base time known as
+ * "the epoch", namely January 1, 1970, 00:00:00 GMT, or -1 in case
+ * of error
*
- * @throws IOException
- * in case of IO error
+ * @throws ParseException
+ * in case of parse error
*/
- static public BufferedImage toImage(String b64data) throws IOException {
- ByteArrayInputStream in = new ByteArrayInputStream(
- Base64.decode(b64data));
- return IOUtils.toImage(in);
+ static public long toTime(String displayTime) throws ParseException {
+ SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
+ return sdf.parse(displayTime).getTime();
}
/**
*
* @return the hash
*/
- static public String getHash(String input) {
+ static public String getMd5Hash(String input) {
try {
MessageDigest md = MessageDigest.getInstance("MD5");
- md.update(input.getBytes());
+ md.update(input.getBytes("UTF-8"));
byte byteData[] = md.digest();
StringBuffer hexString = new StringBuffer();
return hexString.toString();
} catch (NoSuchAlgorithmException e) {
return input;
+ } catch (UnsupportedEncodingException e) {
+ return input;
}
}
}
}
- return HtmlEscape.unescapeHtml(builder.toString());
+ char nbsp = ' '; // non-breakable space (a special char)
+ char space = ' ';
+ return HtmlEscape.unescapeHtml(builder.toString()).replace(nbsp, space);
}
/**
HtmlEscapeType.HTML4_NAMED_REFERENCES_DEFAULT_TO_HEXA,
HtmlEscapeLevel.LEVEL_1_ONLY_MARKUP_SIGNIFICANT);
}
+
+ /**
+ * Zip the data and then encode it into Base64.
+ *
+ * @param data
+ * the data
+ *
+ * @return the Base64 zipped version
+ */
+ public static String zip64(String data) {
+ try {
+ return Base64.encodeBytes(data.getBytes(), Base64.GZIP);
+ } catch (IOException e) {
+ e.printStackTrace();
+ return null;
+ }
+ }
+
+ /**
+ * Unconvert from Base64 then unzip the content.
+ *
+ * @param data
+ * the data in Base64 format
+ *
+ * @return the raw data
+ *
+ * @throws IOException
+ * in case of I/O error
+ */
+ public static String unzip64(String data) throws IOException {
+ ByteArrayInputStream in = new ByteArrayInputStream(Base64.decode(data,
+ Base64.GZIP));
+
+ Scanner scan = new Scanner(in);
+ scan.useDelimiter("\\A");
+ try {
+ return scan.next();
+ } finally {
+ scan.close();
+ }
+ }
+
+ /**
+ * The "remove accents" pattern.
+ *
+ * @return the pattern, or NULL if a problem happens
+ */
+ private static Pattern getMarks() {
+ try {
+ return Pattern
+ .compile("[\\p{InCombiningDiacriticalMarks}\\p{IsLm}\\p{IsSk}]+");
+ } catch (Exception e) {
+ // Can fail on Android...
+ return null;
+ }
+ }
}