001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.tools; 003 004import static org.openstreetmap.josm.tools.I18n.tr; 005import static org.openstreetmap.josm.tools.I18n.trn; 006 007import java.awt.Color; 008import java.awt.Toolkit; 009import java.awt.datatransfer.Clipboard; 010import java.awt.datatransfer.ClipboardOwner; 011import java.awt.datatransfer.DataFlavor; 012import java.awt.datatransfer.StringSelection; 013import java.awt.datatransfer.Transferable; 014import java.awt.datatransfer.UnsupportedFlavorException; 015import java.io.BufferedInputStream; 016import java.io.BufferedReader; 017import java.io.Closeable; 018import java.io.File; 019import java.io.IOException; 020import java.io.InputStream; 021import java.io.InputStreamReader; 022import java.io.OutputStream; 023import java.io.UnsupportedEncodingException; 024import java.net.HttpURLConnection; 025import java.net.MalformedURLException; 026import java.net.URL; 027import java.net.URLConnection; 028import java.net.URLEncoder; 029import java.nio.charset.StandardCharsets; 030import java.nio.file.Files; 031import java.nio.file.Path; 032import java.nio.file.StandardCopyOption; 033import java.security.MessageDigest; 034import java.security.NoSuchAlgorithmException; 035import java.text.MessageFormat; 036import java.util.AbstractCollection; 037import java.util.AbstractList; 038import java.util.ArrayList; 039import java.util.Arrays; 040import java.util.Collection; 041import java.util.Collections; 042import java.util.Iterator; 043import java.util.List; 044import java.util.concurrent.ExecutorService; 045import java.util.concurrent.Executors; 046import java.util.regex.Matcher; 047import java.util.regex.Pattern; 048import java.util.zip.GZIPInputStream; 049import java.util.zip.ZipEntry; 050import java.util.zip.ZipFile; 051import java.util.zip.ZipInputStream; 052 053import org.apache.tools.bzip2.CBZip2InputStream; 054import org.openstreetmap.josm.Main; 055import org.openstreetmap.josm.data.Version; 056 057/** 058 * Basic utils, that can be useful in different parts of the program. 059 */ 060public final class Utils { 061 062 public static final Pattern WHITE_SPACES_PATTERN = Pattern.compile("\\s+"); 063 064 private Utils() { 065 // Hide default constructor for utils classes 066 } 067 068 private static final int MILLIS_OF_SECOND = 1000; 069 private static final int MILLIS_OF_MINUTE = 60000; 070 private static final int MILLIS_OF_HOUR = 3600000; 071 private static final int MILLIS_OF_DAY = 86400000; 072 073 public static final String URL_CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~:/?#[]@!$&'()*+,;=%"; 074 075 /** 076 * Tests whether {@code predicate} applies to at least one elements from {@code collection}. 077 */ 078 public static <T> boolean exists(Iterable<? extends T> collection, Predicate<? super T> predicate) { 079 for (T item : collection) { 080 if (predicate.evaluate(item)) 081 return true; 082 } 083 return false; 084 } 085 086 /** 087 * Tests whether {@code predicate} applies to all elements from {@code collection}. 088 */ 089 public static <T> boolean forAll(Iterable<? extends T> collection, Predicate<? super T> predicate) { 090 return !exists(collection, Predicates.not(predicate)); 091 } 092 093 public static <T> boolean exists(Iterable<T> collection, Class<? extends T> klass) { 094 for (Object item : collection) { 095 if (klass.isInstance(item)) 096 return true; 097 } 098 return false; 099 } 100 101 public static <T> T find(Iterable<? extends T> collection, Predicate<? super T> predicate) { 102 for (T item : collection) { 103 if (predicate.evaluate(item)) 104 return item; 105 } 106 return null; 107 } 108 109 @SuppressWarnings("unchecked") 110 public static <T> T find(Iterable<? super T> collection, Class<? extends T> klass) { 111 for (Object item : collection) { 112 if (klass.isInstance(item)) 113 return (T) item; 114 } 115 return null; 116 } 117 118 public static <T> Collection<T> filter(Collection<? extends T> collection, Predicate<? super T> predicate) { 119 return new FilteredCollection<>(collection, predicate); 120 } 121 122 /** 123 * Returns the first element from {@code items} which is non-null, or null if all elements are null. 124 * @param items the items to look for 125 * @return first non-null item if there is one 126 */ 127 @SafeVarargs 128 public static <T> T firstNonNull(T... items) { 129 for (T i : items) { 130 if (i != null) { 131 return i; 132 } 133 } 134 return null; 135 } 136 137 /** 138 * Filter a collection by (sub)class. 139 * This is an efficient read-only implementation. 140 */ 141 public static <S, T extends S> SubclassFilteredCollection<S, T> filteredCollection(Collection<S> collection, final Class<T> klass) { 142 return new SubclassFilteredCollection<>(collection, new Predicate<S>() { 143 @Override 144 public boolean evaluate(S o) { 145 return klass.isInstance(o); 146 } 147 }); 148 } 149 150 public static <T> int indexOf(Iterable<? extends T> collection, Predicate<? super T> predicate) { 151 int i = 0; 152 for (T item : collection) { 153 if (predicate.evaluate(item)) 154 return i; 155 i++; 156 } 157 return -1; 158 } 159 160 /** 161 * Get minimum of 3 values 162 */ 163 public static int min(int a, int b, int c) { 164 if (b < c) { 165 if (a < b) 166 return a; 167 return b; 168 } else { 169 if (a < c) 170 return a; 171 return c; 172 } 173 } 174 175 public static int max(int a, int b, int c, int d) { 176 return Math.max(Math.max(a, b), Math.max(c, d)); 177 } 178 179 public static void ensure(boolean condition, String message, Object...data) { 180 if (!condition) 181 throw new AssertionError( 182 MessageFormat.format(message,data) 183 ); 184 } 185 186 /** 187 * return the modulus in the range [0, n) 188 */ 189 public static int mod(int a, int n) { 190 if (n <= 0) 191 throw new IllegalArgumentException(); 192 int res = a % n; 193 if (res < 0) { 194 res += n; 195 } 196 return res; 197 } 198 199 /** 200 * Joins a list of strings (or objects that can be converted to string via 201 * Object.toString()) into a single string with fields separated by sep. 202 * @param sep the separator 203 * @param values collection of objects, null is converted to the 204 * empty string 205 * @return null if values is null. The joined string otherwise. 206 */ 207 public static String join(String sep, Collection<?> values) { 208 if (sep == null) 209 throw new IllegalArgumentException(); 210 if (values == null) 211 return null; 212 if (values.isEmpty()) 213 return ""; 214 StringBuilder s = null; 215 for (Object a : values) { 216 if (a == null) { 217 a = ""; 218 } 219 if (s != null) { 220 s.append(sep).append(a.toString()); 221 } else { 222 s = new StringBuilder(a.toString()); 223 } 224 } 225 return s.toString(); 226 } 227 228 /** 229 * Converts the given iterable collection as an unordered HTML list. 230 * @param values The iterable collection 231 * @return An unordered HTML list 232 */ 233 public static String joinAsHtmlUnorderedList(Iterable<?> values) { 234 StringBuilder sb = new StringBuilder(1024); 235 sb.append("<ul>"); 236 for (Object i : values) { 237 sb.append("<li>").append(i).append("</li>"); 238 } 239 sb.append("</ul>"); 240 return sb.toString(); 241 } 242 243 /** 244 * convert Color to String 245 * (Color.toString() omits alpha value) 246 */ 247 public static String toString(Color c) { 248 if (c == null) 249 return "null"; 250 if (c.getAlpha() == 255) 251 return String.format("#%06x", c.getRGB() & 0x00ffffff); 252 else 253 return String.format("#%06x(alpha=%d)", c.getRGB() & 0x00ffffff, c.getAlpha()); 254 } 255 256 /** 257 * convert float range 0 <= x <= 1 to integer range 0..255 258 * when dealing with colors and color alpha value 259 * @return null if val is null, the corresponding int if val is in the 260 * range 0...1. If val is outside that range, return 255 261 */ 262 public static Integer color_float2int(Float val) { 263 if (val == null) 264 return null; 265 if (val < 0 || val > 1) 266 return 255; 267 return (int) (255f * val + 0.5f); 268 } 269 270 /** 271 * convert integer range 0..255 to float range 0 <= x <= 1 272 * when dealing with colors and color alpha value 273 */ 274 public static Float color_int2float(Integer val) { 275 if (val == null) 276 return null; 277 if (val < 0 || val > 255) 278 return 1f; 279 return ((float) val) / 255f; 280 } 281 282 public static Color complement(Color clr) { 283 return new Color(255 - clr.getRed(), 255 - clr.getGreen(), 255 - clr.getBlue(), clr.getAlpha()); 284 } 285 286 /** 287 * Copies the given array. Unlike {@link Arrays#copyOf}, this method is null-safe. 288 * @param array The array to copy 289 * @return A copy of the original array, or {@code null} if {@code array} is null 290 * @since 6221 291 */ 292 public static <T> T[] copyArray(T[] array) { 293 if (array != null) { 294 return Arrays.copyOf(array, array.length); 295 } 296 return null; 297 } 298 299 /** 300 * Copies the given array. Unlike {@link Arrays#copyOf}, this method is null-safe. 301 * @param array The array to copy 302 * @return A copy of the original array, or {@code null} if {@code array} is null 303 * @since 6222 304 */ 305 public static char[] copyArray(char[] array) { 306 if (array != null) { 307 return Arrays.copyOf(array, array.length); 308 } 309 return null; 310 } 311 312 /** 313 * Copies the given array. Unlike {@link Arrays#copyOf}, this method is null-safe. 314 * @param array The array to copy 315 * @return A copy of the original array, or {@code null} if {@code array} is null 316 * @since 7436 317 */ 318 public static int[] copyArray(int[] array) { 319 if (array != null) { 320 return Arrays.copyOf(array, array.length); 321 } 322 return null; 323 } 324 325 /** 326 * Simple file copy function that will overwrite the target file.<br> 327 * @param in The source file 328 * @param out The destination file 329 * @return the path to the target file 330 * @throws java.io.IOException If any I/O error occurs 331 * @throws IllegalArgumentException If {@code in} or {@code out} is {@code null} 332 * @since 7003 333 */ 334 public static Path copyFile(File in, File out) throws IOException, IllegalArgumentException { 335 CheckParameterUtil.ensureParameterNotNull(in, "in"); 336 CheckParameterUtil.ensureParameterNotNull(out, "out"); 337 return Files.copy(in.toPath(), out.toPath(), StandardCopyOption.REPLACE_EXISTING); 338 } 339 340 public static int copyStream(InputStream source, OutputStream destination) throws IOException { 341 int count = 0; 342 byte[] b = new byte[512]; 343 int read; 344 while ((read = source.read(b)) != -1) { 345 count += read; 346 destination.write(b, 0, read); 347 } 348 return count; 349 } 350 351 public static boolean deleteDirectory(File path) { 352 if( path.exists() ) { 353 File[] files = path.listFiles(); 354 for (File file : files) { 355 if (file.isDirectory()) { 356 deleteDirectory(file); 357 } else { 358 file.delete(); 359 } 360 } 361 } 362 return( path.delete() ); 363 } 364 365 /** 366 * <p>Utility method for closing a {@link java.io.Closeable} object.</p> 367 * 368 * @param c the closeable object. May be null. 369 */ 370 public static void close(Closeable c) { 371 if (c == null) return; 372 try { 373 c.close(); 374 } catch (IOException e) { 375 Main.warn(e); 376 } 377 } 378 379 /** 380 * <p>Utility method for closing a {@link java.util.zip.ZipFile}.</p> 381 * 382 * @param zip the zip file. May be null. 383 */ 384 public static void close(ZipFile zip) { 385 if (zip == null) return; 386 try { 387 zip.close(); 388 } catch (IOException e) { 389 Main.warn(e); 390 } 391 } 392 393 /** 394 * Converts the given file to its URL. 395 * @param f The file to get URL from 396 * @return The URL of the given file, or {@code null} if not possible. 397 * @since 6615 398 */ 399 public static URL fileToURL(File f) { 400 if (f != null) { 401 try { 402 return f.toURI().toURL(); 403 } catch (MalformedURLException ex) { 404 Main.error("Unable to convert filename " + f.getAbsolutePath() + " to URL"); 405 } 406 } 407 return null; 408 } 409 410 private static final double EPSILON = 1e-11; 411 412 /** 413 * Determines if the two given double values are equal (their delta being smaller than a fixed epsilon) 414 * @param a The first double value to compare 415 * @param b The second double value to compare 416 * @return {@code true} if {@code abs(a - b) <= 1e-11}, {@code false} otherwise 417 */ 418 public static boolean equalsEpsilon(double a, double b) { 419 return Math.abs(a - b) <= EPSILON; 420 } 421 422 /** 423 * Copies the string {@code s} to system clipboard. 424 * @param s string to be copied to clipboard. 425 * @return true if succeeded, false otherwise. 426 */ 427 public static boolean copyToClipboard(String s) { 428 try { 429 Toolkit.getDefaultToolkit().getSystemClipboard().setContents(new StringSelection(s), new ClipboardOwner() { 430 431 @Override 432 public void lostOwnership(Clipboard clpbrd, Transferable t) { 433 } 434 }); 435 return true; 436 } catch (IllegalStateException ex) { 437 Main.error(ex); 438 return false; 439 } 440 } 441 442 /** 443 * Extracts clipboard content as string. 444 * @return string clipboard contents if available, {@code null} otherwise. 445 */ 446 public static String getClipboardContent() { 447 Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard(); 448 Transferable t = null; 449 for (int tries = 0; t == null && tries < 10; tries++) { 450 try { 451 t = clipboard.getContents(null); 452 } catch (IllegalStateException e) { 453 // Clipboard currently unavailable. On some platforms, the system clipboard is unavailable while it is accessed by another application. 454 try { 455 Thread.sleep(1); 456 } catch (InterruptedException ex) { 457 Main.warn("InterruptedException in "+Utils.class.getSimpleName()+" while getting clipboard content"); 458 } 459 } 460 } 461 try { 462 if (t != null && t.isDataFlavorSupported(DataFlavor.stringFlavor)) { 463 return (String) t.getTransferData(DataFlavor.stringFlavor); 464 } 465 } catch (UnsupportedFlavorException | IOException ex) { 466 Main.error(ex); 467 return null; 468 } 469 return null; 470 } 471 472 /** 473 * Calculate MD5 hash of a string and output in hexadecimal format. 474 * @param data arbitrary String 475 * @return MD5 hash of data, string of length 32 with characters in range [0-9a-f] 476 */ 477 public static String md5Hex(String data) { 478 byte[] byteData = data.getBytes(StandardCharsets.UTF_8); 479 MessageDigest md = null; 480 try { 481 md = MessageDigest.getInstance("MD5"); 482 } catch (NoSuchAlgorithmException e) { 483 throw new RuntimeException(e); 484 } 485 byte[] byteDigest = md.digest(byteData); 486 return toHexString(byteDigest); 487 } 488 489 private static final char[] HEX_ARRAY = {'0','1','2','3','4','5','6','7','8','9','a','b','c','d','e','f'}; 490 491 /** 492 * Converts a byte array to a string of hexadecimal characters. 493 * Preserves leading zeros, so the size of the output string is always twice 494 * the number of input bytes. 495 * @param bytes the byte array 496 * @return hexadecimal representation 497 */ 498 public static String toHexString(byte[] bytes) { 499 500 if (bytes == null) { 501 return ""; 502 } 503 504 final int len = bytes.length; 505 if (len == 0) { 506 return ""; 507 } 508 509 char[] hexChars = new char[len * 2]; 510 for (int i = 0, j = 0; i < len; i++) { 511 final int v = bytes[i]; 512 hexChars[j++] = HEX_ARRAY[(v & 0xf0) >> 4]; 513 hexChars[j++] = HEX_ARRAY[v & 0xf]; 514 } 515 return new String(hexChars); 516 } 517 518 /** 519 * Topological sort. 520 * 521 * @param dependencies contains mappings (key -> value). In the final list of sorted objects, the key will come 522 * after the value. (In other words, the key depends on the value(s).) 523 * There must not be cyclic dependencies. 524 * @return the list of sorted objects 525 */ 526 public static <T> List<T> topologicalSort(final MultiMap<T,T> dependencies) { 527 MultiMap<T,T> deps = new MultiMap<>(); 528 for (T key : dependencies.keySet()) { 529 deps.putVoid(key); 530 for (T val : dependencies.get(key)) { 531 deps.putVoid(val); 532 deps.put(key, val); 533 } 534 } 535 536 int size = deps.size(); 537 List<T> sorted = new ArrayList<>(); 538 for (int i=0; i<size; ++i) { 539 T parentless = null; 540 for (T key : deps.keySet()) { 541 if (deps.get(key).isEmpty()) { 542 parentless = key; 543 break; 544 } 545 } 546 if (parentless == null) throw new RuntimeException(); 547 sorted.add(parentless); 548 deps.remove(parentless); 549 for (T key : deps.keySet()) { 550 deps.remove(key, parentless); 551 } 552 } 553 if (sorted.size() != size) throw new RuntimeException(); 554 return sorted; 555 } 556 557 /** 558 * Represents a function that can be applied to objects of {@code A} and 559 * returns objects of {@code B}. 560 * @param <A> class of input objects 561 * @param <B> class of transformed objects 562 */ 563 public static interface Function<A, B> { 564 565 /** 566 * Applies the function on {@code x}. 567 * @param x an object of 568 * @return the transformed object 569 */ 570 B apply(A x); 571 } 572 573 /** 574 * Transforms the collection {@code c} into an unmodifiable collection and 575 * applies the {@link org.openstreetmap.josm.tools.Utils.Function} {@code f} on each element upon access. 576 * @param <A> class of input collection 577 * @param <B> class of transformed collection 578 * @param c a collection 579 * @param f a function that transforms objects of {@code A} to objects of {@code B} 580 * @return the transformed unmodifiable collection 581 */ 582 public static <A, B> Collection<B> transform(final Collection<? extends A> c, final Function<A, B> f) { 583 return new AbstractCollection<B>() { 584 585 @Override 586 public int size() { 587 return c.size(); 588 } 589 590 @Override 591 public Iterator<B> iterator() { 592 return new Iterator<B>() { 593 594 private Iterator<? extends A> it = c.iterator(); 595 596 @Override 597 public boolean hasNext() { 598 return it.hasNext(); 599 } 600 601 @Override 602 public B next() { 603 return f.apply(it.next()); 604 } 605 606 @Override 607 public void remove() { 608 throw new UnsupportedOperationException(); 609 } 610 }; 611 } 612 }; 613 } 614 615 /** 616 * Transforms the list {@code l} into an unmodifiable list and 617 * applies the {@link org.openstreetmap.josm.tools.Utils.Function} {@code f} on each element upon access. 618 * @param <A> class of input collection 619 * @param <B> class of transformed collection 620 * @param l a collection 621 * @param f a function that transforms objects of {@code A} to objects of {@code B} 622 * @return the transformed unmodifiable list 623 */ 624 public static <A, B> List<B> transform(final List<? extends A> l, final Function<A, B> f) { 625 return new AbstractList<B>() { 626 627 @Override 628 public int size() { 629 return l.size(); 630 } 631 632 @Override 633 public B get(int index) { 634 return f.apply(l.get(index)); 635 } 636 }; 637 } 638 639 private static final Pattern HTTP_PREFFIX_PATTERN = Pattern.compile("https?"); 640 641 /** 642 * Opens a HTTP connection to the given URL and sets the User-Agent property to JOSM's one. 643 * @param httpURL The HTTP url to open (must use http:// or https://) 644 * @return An open HTTP connection to the given URL 645 * @throws java.io.IOException if an I/O exception occurs. 646 * @since 5587 647 */ 648 public static HttpURLConnection openHttpConnection(URL httpURL) throws IOException { 649 if (httpURL == null || !HTTP_PREFFIX_PATTERN.matcher(httpURL.getProtocol()).matches()) { 650 throw new IllegalArgumentException("Invalid HTTP url"); 651 } 652 if (Main.isDebugEnabled()) { 653 Main.debug("Opening HTTP connection to "+httpURL.toExternalForm()); 654 } 655 HttpURLConnection connection = (HttpURLConnection) httpURL.openConnection(); 656 connection.setRequestProperty("User-Agent", Version.getInstance().getFullAgentString()); 657 connection.setUseCaches(false); 658 return connection; 659 } 660 661 /** 662 * Opens a connection to the given URL and sets the User-Agent property to JOSM's one. 663 * @param url The url to open 664 * @return An stream for the given URL 665 * @throws java.io.IOException if an I/O exception occurs. 666 * @since 5867 667 */ 668 public static InputStream openURL(URL url) throws IOException { 669 return openURLAndDecompress(url, false); 670 } 671 672 /** 673 * Opens a connection to the given URL, sets the User-Agent property to JOSM's one, and decompresses stream if necessary. 674 * @param url The url to open 675 * @param decompress whether to wrap steam in a {@link GZIPInputStream} or {@link CBZip2InputStream} 676 * if the {@code Content-Type} header is set accordingly. 677 * @return An stream for the given URL 678 * @throws IOException if an I/O exception occurs. 679 * @since 6421 680 */ 681 public static InputStream openURLAndDecompress(final URL url, final boolean decompress) throws IOException { 682 final URLConnection connection = setupURLConnection(url.openConnection()); 683 final InputStream in = connection.getInputStream(); 684 if (decompress) { 685 switch (connection.getHeaderField("Content-Type")) { 686 case "application/zip": 687 return getZipInputStream(in); 688 case "application/x-gzip": 689 return getGZipInputStream(in); 690 case "application/x-bzip2": 691 return getBZip2InputStream(in); 692 } 693 } 694 return in; 695 } 696 697 /** 698 * Returns a Bzip2 input stream wrapping given input stream. 699 * @param in The raw input stream 700 * @return a Bzip2 input stream wrapping given input stream, or {@code null} if {@code in} is {@code null} 701 * @throws IOException if the given input stream does not contain valid BZ2 header 702 * @since 7119 703 */ 704 public static CBZip2InputStream getBZip2InputStream(InputStream in) throws IOException { 705 if (in == null) { 706 return null; 707 } 708 BufferedInputStream bis = new BufferedInputStream(in); 709 int b = bis.read(); 710 if (b != 'B') 711 throw new IOException(tr("Invalid bz2 file.")); 712 b = bis.read(); 713 if (b != 'Z') 714 throw new IOException(tr("Invalid bz2 file.")); 715 return new CBZip2InputStream(bis, /* see #9537 */ true); 716 } 717 718 /** 719 * Returns a Gzip input stream wrapping given input stream. 720 * @param in The raw input stream 721 * @return a Gzip input stream wrapping given input stream, or {@code null} if {@code in} is {@code null} 722 * @throws IOException if an I/O error has occurred 723 * @since 7119 724 */ 725 public static GZIPInputStream getGZipInputStream(InputStream in) throws IOException { 726 if (in == null) { 727 return null; 728 } 729 return new GZIPInputStream(in); 730 } 731 732 /** 733 * Returns a Zip input stream wrapping given input stream. 734 * @param in The raw input stream 735 * @return a Zip input stream wrapping given input stream, or {@code null} if {@code in} is {@code null} 736 * @throws IOException if an I/O error has occurred 737 * @since 7119 738 */ 739 public static ZipInputStream getZipInputStream(InputStream in) throws IOException { 740 if (in == null) { 741 return null; 742 } 743 ZipInputStream zis = new ZipInputStream(in, StandardCharsets.UTF_8); 744 // Positions the stream at the beginning of first entry 745 ZipEntry ze = zis.getNextEntry(); 746 if (ze != null && Main.isDebugEnabled()) { 747 Main.debug("Zip entry: "+ze.getName()); 748 } 749 return zis; 750 } 751 752 /*** 753 * Setups the given URL connection to match JOSM needs by setting its User-Agent and timeout properties. 754 * @param connection The connection to setup 755 * @return {@code connection}, with updated properties 756 * @since 5887 757 */ 758 public static URLConnection setupURLConnection(URLConnection connection) { 759 if (connection != null) { 760 connection.setRequestProperty("User-Agent", Version.getInstance().getFullAgentString()); 761 connection.setConnectTimeout(Main.pref.getInteger("socket.timeout.connect",15)*1000); 762 connection.setReadTimeout(Main.pref.getInteger("socket.timeout.read",30)*1000); 763 } 764 return connection; 765 } 766 767 /** 768 * Opens a connection to the given URL and sets the User-Agent property to JOSM's one. 769 * @param url The url to open 770 * @return An buffered stream reader for the given URL (using UTF-8) 771 * @throws java.io.IOException if an I/O exception occurs. 772 * @since 5868 773 */ 774 public static BufferedReader openURLReader(URL url) throws IOException { 775 return openURLReaderAndDecompress(url, false); 776 } 777 778 /** 779 * Opens a connection to the given URL and sets the User-Agent property to JOSM's one. 780 * @param url The url to open 781 * @param decompress whether to wrap steam in a {@link GZIPInputStream} or {@link CBZip2InputStream} 782 * if the {@code Content-Type} header is set accordingly. 783 * @return An buffered stream reader for the given URL (using UTF-8) 784 * @throws IOException if an I/O exception occurs. 785 * @since 6421 786 */ 787 public static BufferedReader openURLReaderAndDecompress(final URL url, final boolean decompress) throws IOException { 788 return new BufferedReader(new InputStreamReader(openURLAndDecompress(url, decompress), StandardCharsets.UTF_8)); 789 } 790 791 /** 792 * Opens a HTTP connection to the given URL, sets the User-Agent property to JOSM's one and optionnaly disables Keep-Alive. 793 * @param httpURL The HTTP url to open (must use http:// or https://) 794 * @param keepAlive whether not to set header {@code Connection=close} 795 * @return An open HTTP connection to the given URL 796 * @throws java.io.IOException if an I/O exception occurs. 797 * @since 5587 798 */ 799 public static HttpURLConnection openHttpConnection(URL httpURL, boolean keepAlive) throws IOException { 800 HttpURLConnection connection = openHttpConnection(httpURL); 801 if (!keepAlive) { 802 connection.setRequestProperty("Connection", "close"); 803 } 804 if (Main.isDebugEnabled()) { 805 try { 806 Main.debug("REQUEST: "+ connection.getRequestProperties()); 807 } catch (IllegalStateException e) { 808 Main.warn(e); 809 } 810 } 811 return connection; 812 } 813 814 /** 815 * An alternative to {@link String#trim()} to effectively remove all leading and trailing white characters, including Unicode ones. 816 * @see <a href="http://closingbraces.net/2008/11/11/javastringtrim/">Java’s String.trim has a strange idea of whitespace</a> 817 * @see <a href="https://bugs.openjdk.java.net/browse/JDK-4080617">JDK bug 4080617</a> 818 * @param str The string to strip 819 * @return <code>str</code>, without leading and trailing characters, according to 820 * {@link Character#isWhitespace(char)} and {@link Character#isSpaceChar(char)}. 821 * @since 5772 822 */ 823 public static String strip(String str) { 824 if (str == null || str.isEmpty()) { 825 return str; 826 } 827 int start = 0, end = str.length(); 828 boolean leadingWhite = true; 829 while (leadingWhite && start < end) { 830 char c = str.charAt(start); 831 // '\u200B' (ZERO WIDTH SPACE character) needs to be handled manually because of change in Unicode 6.0 (Java 7, see #8918) 832 // same for '\uFEFF' (ZERO WIDTH NO-BREAK SPACE) 833 leadingWhite = (Character.isWhitespace(c) || Character.isSpaceChar(c) || c == '\u200B' || c == '\uFEFF'); 834 if (leadingWhite) { 835 start++; 836 } 837 } 838 boolean trailingWhite = true; 839 while (trailingWhite && end > start+1) { 840 char c = str.charAt(end-1); 841 trailingWhite = (Character.isWhitespace(c) || Character.isSpaceChar(c) || c == '\u200B' || c == '\uFEFF'); 842 if (trailingWhite) { 843 end--; 844 } 845 } 846 return str.substring(start, end); 847 } 848 849 /** 850 * Runs an external command and returns the standard output. 851 * 852 * The program is expected to execute fast. 853 * 854 * @param command the command with arguments 855 * @return the output 856 * @throws IOException when there was an error, e.g. command does not exist 857 */ 858 public static String execOutput(List<String> command) throws IOException { 859 if (Main.isDebugEnabled()) { 860 Main.debug(join(" ", command)); 861 } 862 Process p = new ProcessBuilder(command).start(); 863 try (BufferedReader input = new BufferedReader(new InputStreamReader(p.getInputStream(), StandardCharsets.UTF_8))) { 864 StringBuilder all = null; 865 String line; 866 while ((line = input.readLine()) != null) { 867 if (all == null) { 868 all = new StringBuilder(line); 869 } else { 870 all.append("\n"); 871 all.append(line); 872 } 873 } 874 return all != null ? all.toString() : null; 875 } 876 } 877 878 /** 879 * Returns the JOSM temp directory. 880 * @return The JOSM temp directory ({@code <java.io.tmpdir>/JOSM}), or {@code null} if {@code java.io.tmpdir} is not defined 881 * @since 6245 882 */ 883 public static File getJosmTempDir() { 884 String tmpDir = System.getProperty("java.io.tmpdir"); 885 if (tmpDir == null) { 886 return null; 887 } 888 File josmTmpDir = new File(tmpDir, "JOSM"); 889 if (!josmTmpDir.exists() && !josmTmpDir.mkdirs()) { 890 Main.warn("Unable to create temp directory "+josmTmpDir); 891 } 892 return josmTmpDir; 893 } 894 895 /** 896 * Returns a simple human readable (hours, minutes, seconds) string for a given duration in milliseconds. 897 * @param elapsedTime The duration in milliseconds 898 * @return A human readable string for the given duration 899 * @throws IllegalArgumentException if elapsedTime is < 0 900 * @since 6354 901 */ 902 public static String getDurationString(long elapsedTime) throws IllegalArgumentException { 903 if (elapsedTime < 0) { 904 throw new IllegalArgumentException("elapsedTime must be >= 0"); 905 } 906 // Is it less than 1 second ? 907 if (elapsedTime < MILLIS_OF_SECOND) { 908 return String.format("%d %s", elapsedTime, tr("ms")); 909 } 910 // Is it less than 1 minute ? 911 if (elapsedTime < MILLIS_OF_MINUTE) { 912 return String.format("%.1f %s", elapsedTime / (float) MILLIS_OF_SECOND, tr("s")); 913 } 914 // Is it less than 1 hour ? 915 if (elapsedTime < MILLIS_OF_HOUR) { 916 final long min = elapsedTime / MILLIS_OF_MINUTE; 917 return String.format("%d %s %d %s", min, tr("min"), (elapsedTime - min * MILLIS_OF_MINUTE) / MILLIS_OF_SECOND, tr("s")); 918 } 919 // Is it less than 1 day ? 920 if (elapsedTime < MILLIS_OF_DAY) { 921 final long hour = elapsedTime / MILLIS_OF_HOUR; 922 return String.format("%d %s %d %s", hour, tr("h"), (elapsedTime - hour * MILLIS_OF_HOUR) / MILLIS_OF_MINUTE, tr("min")); 923 } 924 long days = elapsedTime / MILLIS_OF_DAY; 925 return String.format("%d %s %d %s", days, trn("day", "days", days), (elapsedTime - days * MILLIS_OF_DAY) / MILLIS_OF_HOUR, tr("h")); 926 } 927 928 /** 929 * Returns a human readable representation of a list of positions. 930 * <p> 931 * For instance, {@code [1,5,2,6,7} yields "1-2,5-7 932 * @param positionList a list of positions 933 * @return a human readable representation 934 */ 935 public static String getPositionListString(List<Integer> positionList) { 936 Collections.sort(positionList); 937 final StringBuilder sb = new StringBuilder(32); 938 sb.append(positionList.get(0)); 939 int cnt = 0; 940 int last = positionList.get(0); 941 for (int i = 1; i < positionList.size(); ++i) { 942 int cur = positionList.get(i); 943 if (cur == last + 1) { 944 ++cnt; 945 } else if (cnt == 0) { 946 sb.append(",").append(cur); 947 } else { 948 sb.append("-").append(last); 949 sb.append(",").append(cur); 950 cnt = 0; 951 } 952 last = cur; 953 } 954 if (cnt >= 1) { 955 sb.append("-").append(last); 956 } 957 return sb.toString(); 958 } 959 960 961 /** 962 * Returns a list of capture groups if {@link Matcher#matches()}, or {@code null}. 963 * The first element (index 0) is the complete match. 964 * Further elements correspond to the parts in parentheses of the regular expression. 965 * @param m the matcher 966 * @return a list of capture groups if {@link Matcher#matches()}, or {@code null}. 967 */ 968 public static List<String> getMatches(final Matcher m) { 969 if (m.matches()) { 970 List<String> result = new ArrayList<>(m.groupCount() + 1); 971 for (int i = 0; i <= m.groupCount(); i++) { 972 result.add(m.group(i)); 973 } 974 return result; 975 } else { 976 return null; 977 } 978 } 979 980 /** 981 * Cast an object savely. 982 * @param <T> the target type 983 * @param o the object to cast 984 * @param klass the target class (same as T) 985 * @return null if <code>o</code> is null or the type <code>o</code> is not 986 * a subclass of <code>klass</code>. The casted value otherwise. 987 */ 988 @SuppressWarnings("unchecked") 989 public static <T> T cast(Object o, Class<T> klass) { 990 if (klass.isInstance(o)) { 991 return (T) o; 992 } 993 return null; 994 } 995 996 /** 997 * Returns the root cause of a throwable object. 998 * @param t The object to get root cause for 999 * @return the root cause of {@code t} 1000 * @since 6639 1001 */ 1002 public static Throwable getRootCause(Throwable t) { 1003 Throwable result = t; 1004 if (result != null) { 1005 Throwable cause = result.getCause(); 1006 while (cause != null && cause != result) { 1007 result = cause; 1008 cause = result.getCause(); 1009 } 1010 } 1011 return result; 1012 } 1013 1014 /** 1015 * Adds the given item at the end of a new copy of given array. 1016 * @param array The source array 1017 * @param item The item to add 1018 * @return An extended copy of {@code array} containing {@code item} as additional last element 1019 * @since 6717 1020 */ 1021 public static <T> T[] addInArrayCopy(T[] array, T item) { 1022 T[] biggerCopy = Arrays.copyOf(array, array.length + 1); 1023 biggerCopy[array.length] = item; 1024 return biggerCopy; 1025 } 1026 1027 /** 1028 * If the string {@code s} is longer than {@code maxLength}, the string is cut and "..." is appended. 1029 */ 1030 public static String shortenString(String s, int maxLength) { 1031 if (s != null && s.length() > maxLength) { 1032 return s.substring(0, maxLength - 3) + "..."; 1033 } else { 1034 return s; 1035 } 1036 } 1037 1038 /** 1039 * Fixes URL with illegal characters in the query (and fragment) part by 1040 * percent encoding those characters. 1041 * 1042 * special characters like & and # are not encoded 1043 * 1044 * @param url the URL that should be fixed 1045 * @return the repaired URL 1046 */ 1047 public static String fixURLQuery(String url) { 1048 if (url.indexOf('?') == -1) 1049 return url; 1050 1051 String query = url.substring(url.indexOf('?') + 1); 1052 1053 StringBuilder sb = new StringBuilder(url.substring(0, url.indexOf('?') + 1)); 1054 1055 for (int i=0; i<query.length(); i++) { 1056 String c = query.substring(i, i+1); 1057 if (URL_CHARS.contains(c)) { 1058 sb.append(c); 1059 } else { 1060 try { 1061 sb.append(URLEncoder.encode(c, "UTF-8")); 1062 } catch (UnsupportedEncodingException ex) { 1063 throw new RuntimeException(ex); 1064 } 1065 } 1066 } 1067 return sb.toString(); 1068 } 1069 1070 /** 1071 * Determines if the given URL denotes a file on a local filesystem. 1072 * @param url The URL to test 1073 * @return {@code true} if the url points to a local file 1074 * @since 7356 1075 */ 1076 public static boolean isLocalUrl(String url) { 1077 if (url.startsWith("http://") || url.startsWith("https://") || url.startsWith("resource://")) 1078 return false; 1079 return true; 1080 } 1081 1082 /** 1083 * Returns a pair containing the number of threads (n), and a thread pool (if n > 1) to perform 1084 * multi-thread computation in the context of the given preference key. 1085 * @param pref The preference key 1086 * @return a pair containing the number of threads (n), and a thread pool (if n > 1, null otherwise) 1087 * @since 7423 1088 */ 1089 public static Pair<Integer, ExecutorService> newThreadPool(String pref) { 1090 int noThreads = Main.pref.getInteger(pref, Runtime.getRuntime().availableProcessors()); 1091 ExecutorService pool = noThreads <= 1 ? null : Executors.newFixedThreadPool(noThreads); 1092 return new Pair<>(noThreads, pool); 1093 } 1094}