001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.tools; 003 004import static org.openstreetmap.josm.tools.I18n.tr; 005 006import java.awt.Color; 007import java.awt.Cursor; 008import java.awt.Dimension; 009import java.awt.Graphics; 010import java.awt.Graphics2D; 011import java.awt.GraphicsEnvironment; 012import java.awt.Image; 013import java.awt.Point; 014import java.awt.RenderingHints; 015import java.awt.Toolkit; 016import java.awt.Transparency; 017import java.awt.image.BufferedImage; 018import java.awt.image.ColorModel; 019import java.awt.image.FilteredImageSource; 020import java.awt.image.ImageFilter; 021import java.awt.image.ImageProducer; 022import java.awt.image.RGBImageFilter; 023import java.awt.image.WritableRaster; 024import java.io.ByteArrayInputStream; 025import java.io.File; 026import java.io.IOException; 027import java.io.InputStream; 028import java.io.StringReader; 029import java.net.URI; 030import java.net.URL; 031import java.nio.charset.StandardCharsets; 032import java.util.ArrayList; 033import java.util.Arrays; 034import java.util.Base64; 035import java.util.Collection; 036import java.util.HashMap; 037import java.util.Hashtable; 038import java.util.Iterator; 039import java.util.LinkedList; 040import java.util.List; 041import java.util.Map; 042import java.util.TreeSet; 043import java.util.concurrent.CompletableFuture; 044import java.util.concurrent.ExecutorService; 045import java.util.concurrent.Executors; 046import java.util.regex.Matcher; 047import java.util.regex.Pattern; 048import java.util.zip.ZipEntry; 049import java.util.zip.ZipFile; 050 051import javax.imageio.IIOException; 052import javax.imageio.ImageIO; 053import javax.imageio.ImageReadParam; 054import javax.imageio.ImageReader; 055import javax.imageio.metadata.IIOMetadata; 056import javax.imageio.stream.ImageInputStream; 057import javax.swing.ImageIcon; 058import javax.xml.parsers.ParserConfigurationException; 059 060import org.openstreetmap.josm.Main; 061import org.openstreetmap.josm.data.osm.DataSet; 062import org.openstreetmap.josm.data.osm.OsmPrimitive; 063import org.openstreetmap.josm.data.osm.OsmPrimitiveType; 064import org.openstreetmap.josm.gui.mappaint.MapPaintStyles; 065import org.openstreetmap.josm.gui.mappaint.Range; 066import org.openstreetmap.josm.gui.mappaint.StyleElementList; 067import org.openstreetmap.josm.gui.mappaint.styleelement.MapImage; 068import org.openstreetmap.josm.gui.mappaint.styleelement.NodeElement; 069import org.openstreetmap.josm.gui.mappaint.styleelement.StyleElement; 070import org.openstreetmap.josm.gui.tagging.presets.TaggingPreset; 071import org.openstreetmap.josm.gui.tagging.presets.TaggingPresets; 072import org.openstreetmap.josm.gui.util.GuiSizesHelper; 073import org.openstreetmap.josm.io.CachedFile; 074import org.openstreetmap.josm.plugins.PluginHandler; 075import org.w3c.dom.Element; 076import org.w3c.dom.Node; 077import org.w3c.dom.NodeList; 078import org.xml.sax.Attributes; 079import org.xml.sax.InputSource; 080import org.xml.sax.SAXException; 081import org.xml.sax.XMLReader; 082import org.xml.sax.helpers.DefaultHandler; 083 084import com.kitfox.svg.SVGDiagram; 085import com.kitfox.svg.SVGException; 086import com.kitfox.svg.SVGUniverse; 087 088/** 089 * Helper class to support the application with images. 090 * 091 * How to use: 092 * 093 * <code>ImageIcon icon = new ImageProvider(name).setMaxSize(ImageSizes.MAP).get();</code> 094 * (there are more options, see below) 095 * 096 * short form: 097 * <code>ImageIcon icon = ImageProvider.get(name);</code> 098 * 099 * @author imi 100 */ 101public class ImageProvider { 102 103 // CHECKSTYLE.OFF: SingleSpaceSeparator 104 private static final String HTTP_PROTOCOL = "http://"; 105 private static final String HTTPS_PROTOCOL = "https://"; 106 private static final String WIKI_PROTOCOL = "wiki://"; 107 // CHECKSTYLE.ON: SingleSpaceSeparator 108 109 /** 110 * Supported image types 111 */ 112 public enum ImageType { 113 /** Scalable vector graphics */ 114 SVG, 115 /** Everything else, e.g. png, gif (must be supported by Java) */ 116 OTHER 117 } 118 119 /** 120 * Supported image sizes 121 * @since 7687 122 */ 123 public enum ImageSizes { 124 /** SMALL_ICON value of an Action */ 125 SMALLICON(Main.pref.getInteger("iconsize.smallicon", 16)), 126 /** LARGE_ICON_KEY value of an Action */ 127 LARGEICON(Main.pref.getInteger("iconsize.largeicon", 24)), 128 /** map icon */ 129 MAP(Main.pref.getInteger("iconsize.map", 16)), 130 /** map icon maximum size */ 131 MAPMAX(Main.pref.getInteger("iconsize.mapmax", 48)), 132 /** cursor icon size */ 133 CURSOR(Main.pref.getInteger("iconsize.cursor", 32)), 134 /** cursor overlay icon size */ 135 CURSOROVERLAY(CURSOR), 136 /** menu icon size */ 137 MENU(SMALLICON), 138 /** menu icon size in popup menus 139 * @since 8323 140 */ 141 POPUPMENU(LARGEICON), 142 /** Layer list icon size 143 * @since 8323 144 */ 145 LAYER(Main.pref.getInteger("iconsize.layer", 16)), 146 /** Toolbar button icon size 147 * @since 9253 148 */ 149 TOOLBAR(LARGEICON), 150 /** Side button maximum height 151 * @since 9253 152 */ 153 SIDEBUTTON(Main.pref.getInteger("iconsize.sidebutton", 20)), 154 /** Settings tab icon size 155 * @since 9253 156 */ 157 SETTINGS_TAB(Main.pref.getInteger("iconsize.settingstab", 48)), 158 /** 159 * The default image size 160 * @since 9705 161 */ 162 DEFAULT(Main.pref.getInteger("iconsize.default", 24)), 163 /** 164 * Splash dialog logo size 165 * @since 10358 166 */ 167 SPLASH_LOGO(128, 129), 168 /** 169 * About dialog logo size 170 * @since 10358 171 */ 172 ABOUT_LOGO(256, 258); 173 174 private final int virtualWidth; 175 private final int virtualHeight; 176 177 ImageSizes(int imageSize) { 178 this.virtualWidth = imageSize; 179 this.virtualHeight = imageSize; 180 } 181 182 ImageSizes(int width, int height) { 183 this.virtualWidth = width; 184 this.virtualHeight = height; 185 } 186 187 ImageSizes(ImageSizes that) { 188 this.virtualWidth = that.virtualWidth; 189 this.virtualHeight = that.virtualHeight; 190 } 191 192 /** 193 * Returns the image width in virtual pixels 194 * @return the image width in virtual pixels 195 * @since 9705 196 */ 197 public int getVirtualWidth() { 198 return virtualWidth; 199 } 200 201 /** 202 * Returns the image height in virtual pixels 203 * @return the image height in virtual pixels 204 * @since 9705 205 */ 206 public int getVirtualHeight() { 207 return virtualHeight; 208 } 209 210 /** 211 * Returns the image width in pixels to use for display 212 * @return the image width in pixels to use for display 213 * @since 10484 214 */ 215 public int getAdjustedWidth() { 216 return GuiSizesHelper.getSizeDpiAdjusted(virtualWidth); 217 } 218 219 /** 220 * Returns the image height in pixels to use for display 221 * @return the image height in pixels to use for display 222 * @since 10484 223 */ 224 public int getAdjustedHeight() { 225 return GuiSizesHelper.getSizeDpiAdjusted(virtualHeight); 226 } 227 228 /** 229 * Returns the image size as dimension 230 * @return the image size as dimension 231 * @since 9705 232 */ 233 public Dimension getImageDimension() { 234 return new Dimension(virtualWidth, virtualHeight); 235 } 236 } 237 238 /** 239 * Property set on {@code BufferedImage} returned by {@link #makeImageTransparent}. 240 * @since 7132 241 */ 242 public static final String PROP_TRANSPARENCY_FORCED = "josm.transparency.forced"; 243 244 /** 245 * Property set on {@code BufferedImage} returned by {@link #read} if metadata is required. 246 * @since 7132 247 */ 248 public static final String PROP_TRANSPARENCY_COLOR = "josm.transparency.color"; 249 250 /** directories in which images are searched */ 251 protected Collection<String> dirs; 252 /** caching identifier */ 253 protected String id; 254 /** sub directory the image can be found in */ 255 protected String subdir; 256 /** image file name */ 257 protected String name; 258 /** archive file to take image from */ 259 protected File archive; 260 /** directory inside the archive */ 261 protected String inArchiveDir; 262 /** virtual width of the resulting image, -1 when original image data should be used */ 263 protected int virtualWidth = -1; 264 /** virtual height of the resulting image, -1 when original image data should be used */ 265 protected int virtualHeight = -1; 266 /** virtual maximum width of the resulting image, -1 for no restriction */ 267 protected int virtualMaxWidth = -1; 268 /** virtual maximum height of the resulting image, -1 for no restriction */ 269 protected int virtualMaxHeight = -1; 270 /** In case of errors do not throw exception but return <code>null</code> for missing image */ 271 protected boolean optional; 272 /** <code>true</code> if warnings should be suppressed */ 273 protected boolean suppressWarnings; 274 /** list of class loaders to take images from */ 275 protected Collection<ClassLoader> additionalClassLoaders; 276 /** ordered list of overlay images */ 277 protected List<ImageOverlay> overlayInfo; 278 /** <code>true</code> if icon must be grayed out */ 279 protected boolean isDisabled; 280 281 private static SVGUniverse svgUniverse; 282 283 /** 284 * The icon cache 285 */ 286 private static final Map<String, ImageResource> cache = new HashMap<>(); 287 288 /** 289 * Caches the image data for rotated versions of the same image. 290 */ 291 private static final Map<Image, Map<Long, ImageResource>> ROTATE_CACHE = new HashMap<>(); 292 293 private static final ExecutorService IMAGE_FETCHER = 294 Executors.newSingleThreadExecutor(Utils.newThreadFactory("image-fetcher-%d", Thread.NORM_PRIORITY)); 295 296 /** 297 * Constructs a new {@code ImageProvider} from a filename in a given directory. 298 * @param subdir subdirectory the image lies in 299 * @param name the name of the image. If it does not end with '.png' or '.svg', 300 * both extensions are tried. 301 */ 302 public ImageProvider(String subdir, String name) { 303 this.subdir = subdir; 304 this.name = name; 305 } 306 307 /** 308 * Constructs a new {@code ImageProvider} from a filename. 309 * @param name the name of the image. If it does not end with '.png' or '.svg', 310 * both extensions are tried. 311 */ 312 public ImageProvider(String name) { 313 this.name = name; 314 } 315 316 /** 317 * Constructs a new {@code ImageProvider} from an existing one. 318 * @param image the existing image provider to be copied 319 * @since 8095 320 */ 321 public ImageProvider(ImageProvider image) { 322 this.dirs = image.dirs; 323 this.id = image.id; 324 this.subdir = image.subdir; 325 this.name = image.name; 326 this.archive = image.archive; 327 this.inArchiveDir = image.inArchiveDir; 328 this.virtualWidth = image.virtualWidth; 329 this.virtualHeight = image.virtualHeight; 330 this.virtualMaxWidth = image.virtualMaxWidth; 331 this.virtualMaxHeight = image.virtualMaxHeight; 332 this.optional = image.optional; 333 this.suppressWarnings = image.suppressWarnings; 334 this.additionalClassLoaders = image.additionalClassLoaders; 335 this.overlayInfo = image.overlayInfo; 336 this.isDisabled = image.isDisabled; 337 } 338 339 /** 340 * Directories to look for the image. 341 * @param dirs The directories to look for. 342 * @return the current object, for convenience 343 */ 344 public ImageProvider setDirs(Collection<String> dirs) { 345 this.dirs = dirs; 346 return this; 347 } 348 349 /** 350 * Set an id used for caching. 351 * If name starts with <tt>http://</tt> Id is not used for the cache. 352 * (A URL is unique anyway.) 353 * @param id the id for the cached image 354 * @return the current object, for convenience 355 */ 356 public ImageProvider setId(String id) { 357 this.id = id; 358 return this; 359 } 360 361 /** 362 * Specify a zip file where the image is located. 363 * 364 * (optional) 365 * @param archive zip file where the image is located 366 * @return the current object, for convenience 367 */ 368 public ImageProvider setArchive(File archive) { 369 this.archive = archive; 370 return this; 371 } 372 373 /** 374 * Specify a base path inside the zip file. 375 * 376 * The subdir and name will be relative to this path. 377 * 378 * (optional) 379 * @param inArchiveDir path inside the archive 380 * @return the current object, for convenience 381 */ 382 public ImageProvider setInArchiveDir(String inArchiveDir) { 383 this.inArchiveDir = inArchiveDir; 384 return this; 385 } 386 387 /** 388 * Add an overlay over the image. Multiple overlays are possible. 389 * 390 * @param overlay overlay image and placement specification 391 * @return the current object, for convenience 392 * @since 8095 393 */ 394 public ImageProvider addOverlay(ImageOverlay overlay) { 395 if (overlayInfo == null) { 396 overlayInfo = new LinkedList<>(); 397 } 398 overlayInfo.add(overlay); 399 return this; 400 } 401 402 /** 403 * Set the dimensions of the image. 404 * 405 * If not specified, the original size of the image is used. 406 * The width part of the dimension can be -1. Then it will only set the height but 407 * keep the aspect ratio. (And the other way around.) 408 * @param size final dimensions of the image 409 * @return the current object, for convenience 410 */ 411 public ImageProvider setSize(Dimension size) { 412 this.virtualWidth = size.width; 413 this.virtualHeight = size.height; 414 return this; 415 } 416 417 /** 418 * Set the dimensions of the image. 419 * 420 * If not specified, the original size of the image is used. 421 * @param size final dimensions of the image 422 * @return the current object, for convenience 423 * @since 7687 424 */ 425 public ImageProvider setSize(ImageSizes size) { 426 return setSize(size.getImageDimension()); 427 } 428 429 /** 430 * Set the dimensions of the image. 431 * 432 * @param width final width of the image 433 * @param height final height of the image 434 * @return the current object, for convenience 435 * @since 10358 436 */ 437 public ImageProvider setSize(int width, int height) { 438 this.virtualWidth = width; 439 this.virtualHeight = height; 440 return this; 441 } 442 443 /** 444 * Set image width 445 * @param width final width of the image 446 * @return the current object, for convenience 447 * @see #setSize 448 */ 449 public ImageProvider setWidth(int width) { 450 this.virtualWidth = width; 451 return this; 452 } 453 454 /** 455 * Set image height 456 * @param height final height of the image 457 * @return the current object, for convenience 458 * @see #setSize 459 */ 460 public ImageProvider setHeight(int height) { 461 this.virtualHeight = height; 462 return this; 463 } 464 465 /** 466 * Limit the maximum size of the image. 467 * 468 * It will shrink the image if necessary, but keep the aspect ratio. 469 * The given width or height can be -1 which means this direction is not bounded. 470 * 471 * 'size' and 'maxSize' are not compatible, you should set only one of them. 472 * @param maxSize maximum image size 473 * @return the current object, for convenience 474 */ 475 public ImageProvider setMaxSize(Dimension maxSize) { 476 this.virtualMaxWidth = maxSize.width; 477 this.virtualMaxHeight = maxSize.height; 478 return this; 479 } 480 481 /** 482 * Limit the maximum size of the image. 483 * 484 * It will shrink the image if necessary, but keep the aspect ratio. 485 * The given width or height can be -1 which means this direction is not bounded. 486 * 487 * This function sets value using the most restrictive of the new or existing set of 488 * values. 489 * 490 * @param maxSize maximum image size 491 * @return the current object, for convenience 492 * @see #setMaxSize(Dimension) 493 */ 494 public ImageProvider resetMaxSize(Dimension maxSize) { 495 if (this.virtualMaxWidth == -1 || maxSize.width < this.virtualMaxWidth) { 496 this.virtualMaxWidth = maxSize.width; 497 } 498 if (this.virtualMaxHeight == -1 || maxSize.height < this.virtualMaxHeight) { 499 this.virtualMaxHeight = maxSize.height; 500 } 501 return this; 502 } 503 504 /** 505 * Limit the maximum size of the image. 506 * 507 * It will shrink the image if necessary, but keep the aspect ratio. 508 * The given width or height can be -1 which means this direction is not bounded. 509 * 510 * 'size' and 'maxSize' are not compatible, you should set only one of them. 511 * @param size maximum image size 512 * @return the current object, for convenience 513 * @since 7687 514 */ 515 public ImageProvider setMaxSize(ImageSizes size) { 516 return setMaxSize(size.getImageDimension()); 517 } 518 519 /** 520 * Convenience method, see {@link #setMaxSize(Dimension)}. 521 * @param maxSize maximum image size 522 * @return the current object, for convenience 523 */ 524 public ImageProvider setMaxSize(int maxSize) { 525 return this.setMaxSize(new Dimension(maxSize, maxSize)); 526 } 527 528 /** 529 * Limit the maximum width of the image. 530 * @param maxWidth maximum image width 531 * @return the current object, for convenience 532 * @see #setMaxSize 533 */ 534 public ImageProvider setMaxWidth(int maxWidth) { 535 this.virtualMaxWidth = maxWidth; 536 return this; 537 } 538 539 /** 540 * Limit the maximum height of the image. 541 * @param maxHeight maximum image height 542 * @return the current object, for convenience 543 * @see #setMaxSize 544 */ 545 public ImageProvider setMaxHeight(int maxHeight) { 546 this.virtualMaxHeight = maxHeight; 547 return this; 548 } 549 550 /** 551 * Decide, if an exception should be thrown, when the image cannot be located. 552 * 553 * Set to true, when the image URL comes from user data and the image may be missing. 554 * 555 * @param optional true, if JOSM should <b>not</b> throw a RuntimeException 556 * in case the image cannot be located. 557 * @return the current object, for convenience 558 */ 559 public ImageProvider setOptional(boolean optional) { 560 this.optional = optional; 561 return this; 562 } 563 564 /** 565 * Suppresses warning on the command line in case the image cannot be found. 566 * 567 * In combination with setOptional(true); 568 * @param suppressWarnings if <code>true</code> warnings are suppressed 569 * @return the current object, for convenience 570 */ 571 public ImageProvider setSuppressWarnings(boolean suppressWarnings) { 572 this.suppressWarnings = suppressWarnings; 573 return this; 574 } 575 576 /** 577 * Add a collection of additional class loaders to search image for. 578 * @param additionalClassLoaders class loaders to add to the internal list 579 * @return the current object, for convenience 580 */ 581 public ImageProvider setAdditionalClassLoaders(Collection<ClassLoader> additionalClassLoaders) { 582 this.additionalClassLoaders = additionalClassLoaders; 583 return this; 584 } 585 586 /** 587 * Set, if image must be filtered to grayscale so it will look like disabled icon. 588 * 589 * @param disabled true, if image must be grayed out for disabled state 590 * @return the current object, for convenience 591 * @since 10428 592 */ 593 public ImageProvider setDisabled(boolean disabled) { 594 this.isDisabled = disabled; 595 return this; 596 } 597 598 /** 599 * Execute the image request and scale result. 600 * @return the requested image or null if the request failed 601 */ 602 public ImageIcon get() { 603 ImageResource ir = getResource(); 604 605 if (ir == null) { 606 return null; 607 } 608 if (virtualMaxWidth != -1 || virtualMaxHeight != -1) 609 return ir.getImageIconBounded(new Dimension(virtualMaxWidth, virtualMaxHeight)); 610 else 611 return ir.getImageIcon(new Dimension(virtualWidth, virtualHeight)); 612 } 613 614 /** 615 * Load the image in a background thread. 616 * 617 * This method returns immediately and runs the image request asynchronously. 618 * 619 * @return the future of the requested image 620 * @since 10714 621 */ 622 public CompletableFuture<ImageIcon> getAsync() { 623 return name.startsWith(HTTP_PROTOCOL) || name.startsWith(WIKI_PROTOCOL) 624 ? CompletableFuture.supplyAsync(this::get, IMAGE_FETCHER) 625 : CompletableFuture.completedFuture(get()); 626 } 627 628 /** 629 * Execute the image request. 630 * 631 * @return the requested image or null if the request failed 632 * @since 7693 633 */ 634 public ImageResource getResource() { 635 ImageResource ir = getIfAvailableImpl(additionalClassLoaders); 636 if (ir == null) { 637 if (!optional) { 638 String ext = name.indexOf('.') != -1 ? "" : ".???"; 639 throw new JosmRuntimeException( 640 tr("Fatal: failed to locate image ''{0}''. This is a serious configuration problem. JOSM will stop working.", 641 name + ext)); 642 } else { 643 if (!suppressWarnings) { 644 Main.error(tr("Failed to locate image ''{0}''", name)); 645 } 646 return null; 647 } 648 } 649 if (overlayInfo != null) { 650 ir = new ImageResource(ir, overlayInfo); 651 } 652 if (isDisabled) { 653 ir.setDisabled(true); 654 } 655 return ir; 656 } 657 658 /** 659 * Load the image in a background thread. 660 * 661 * This method returns immediately and runs the image request asynchronously. 662 * 663 * @return the future of the requested image 664 * @since 10714 665 */ 666 public CompletableFuture<ImageResource> getResourceAsync() { 667 return name.startsWith(HTTP_PROTOCOL) || name.startsWith(WIKI_PROTOCOL) 668 ? CompletableFuture.supplyAsync(this::getResource, IMAGE_FETCHER) 669 : CompletableFuture.completedFuture(getResource()); 670 } 671 672 /** 673 * Load an image with a given file name. 674 * 675 * @param subdir subdirectory the image lies in 676 * @param name The icon name (base name with or without '.png' or '.svg' extension) 677 * @return The requested Image. 678 * @throws RuntimeException if the image cannot be located 679 */ 680 public static ImageIcon get(String subdir, String name) { 681 return new ImageProvider(subdir, name).get(); 682 } 683 684 /** 685 * Load an image with a given file name. 686 * 687 * @param name The icon name (base name with or without '.png' or '.svg' extension) 688 * @return the requested image or null if the request failed 689 * @see #get(String, String) 690 */ 691 public static ImageIcon get(String name) { 692 return new ImageProvider(name).get(); 693 } 694 695 /** 696 * Load an image from directory with a given file name and size. 697 * 698 * @param subdir subdirectory the image lies in 699 * @param name The icon name (base name with or without '.png' or '.svg' extension) 700 * @param size Target icon size 701 * @return The requested Image. 702 * @throws RuntimeException if the image cannot be located 703 * @since 10428 704 */ 705 public static ImageIcon get(String subdir, String name, ImageSizes size) { 706 return new ImageProvider(subdir, name).setSize(size).get(); 707 } 708 709 /** 710 * Load an empty image with a given size. 711 * 712 * @param size Target icon size 713 * @return The requested Image. 714 * @since 10358 715 */ 716 public static ImageIcon getEmpty(ImageSizes size) { 717 Dimension iconRealSize = GuiSizesHelper.getDimensionDpiAdjusted(size.getImageDimension()); 718 return new ImageIcon(new BufferedImage(iconRealSize.width, iconRealSize.height, 719 BufferedImage.TYPE_INT_ARGB)); 720 } 721 722 /** 723 * Load an image with a given file name, but do not throw an exception 724 * when the image cannot be found. 725 * 726 * @param subdir subdirectory the image lies in 727 * @param name The icon name (base name with or without '.png' or '.svg' extension) 728 * @return the requested image or null if the request failed 729 * @see #get(String, String) 730 */ 731 public static ImageIcon getIfAvailable(String subdir, String name) { 732 return new ImageProvider(subdir, name).setOptional(true).get(); 733 } 734 735 /** 736 * Load an image with a given file name and size. 737 * 738 * @param name The icon name (base name with or without '.png' or '.svg' extension) 739 * @param size Target icon size 740 * @return the requested image or null if the request failed 741 * @see #get(String, String) 742 * @since 10428 743 */ 744 public static ImageIcon get(String name, ImageSizes size) { 745 return new ImageProvider(name).setSize(size).get(); 746 } 747 748 /** 749 * Load an image with a given file name, but do not throw an exception 750 * when the image cannot be found. 751 * 752 * @param name The icon name (base name with or without '.png' or '.svg' extension) 753 * @return the requested image or null if the request failed 754 * @see #getIfAvailable(String, String) 755 */ 756 public static ImageIcon getIfAvailable(String name) { 757 return new ImageProvider(name).setOptional(true).get(); 758 } 759 760 /** 761 * {@code data:[<mediatype>][;base64],<data>} 762 * @see <a href="http://tools.ietf.org/html/rfc2397">RFC2397</a> 763 */ 764 private static final Pattern dataUrlPattern = Pattern.compile( 765 "^data:([a-zA-Z]+/[a-zA-Z+]+)?(;base64)?,(.+)$"); 766 767 /** 768 * Clears the internal image cache. 769 * @since 11021 770 */ 771 public static void clearCache() { 772 synchronized (cache) { 773 cache.clear(); 774 } 775 } 776 777 /** 778 * Internal implementation of the image request. 779 * 780 * @param additionalClassLoaders the list of class loaders to use 781 * @return the requested image or null if the request failed 782 */ 783 private ImageResource getIfAvailableImpl(Collection<ClassLoader> additionalClassLoaders) { 784 synchronized (cache) { 785 // This method is called from different thread and modifying HashMap concurrently can result 786 // for example in loops in map entries (ie freeze when such entry is retrieved) 787 // Yes, it did happen to me :-) 788 if (name == null) 789 return null; 790 791 String prefix = ""; 792 if (isDisabled) 793 prefix = "dis:"+prefix; 794 if (name.startsWith("data:")) { 795 String url = name; 796 ImageResource ir = cache.get(prefix+url); 797 if (ir != null) return ir; 798 ir = getIfAvailableDataUrl(url); 799 if (ir != null) { 800 cache.put(prefix+url, ir); 801 } 802 return ir; 803 } 804 805 ImageType type = Utils.hasExtension(name, "svg") ? ImageType.SVG : ImageType.OTHER; 806 807 if (name.startsWith(HTTP_PROTOCOL) || name.startsWith(HTTPS_PROTOCOL)) { 808 String url = name; 809 ImageResource ir = cache.get(prefix+url); 810 if (ir != null) return ir; 811 ir = getIfAvailableHttp(url, type); 812 if (ir != null) { 813 cache.put(prefix+url, ir); 814 } 815 return ir; 816 } else if (name.startsWith(WIKI_PROTOCOL)) { 817 ImageResource ir = cache.get(prefix+name); 818 if (ir != null) return ir; 819 ir = getIfAvailableWiki(name, type); 820 if (ir != null) { 821 cache.put(prefix+name, ir); 822 } 823 return ir; 824 } 825 826 if (subdir == null) { 827 subdir = ""; 828 } else if (!subdir.isEmpty() && !subdir.endsWith("/")) { 829 subdir += '/'; 830 } 831 String[] extensions; 832 if (name.indexOf('.') != -1) { 833 extensions = new String[] {""}; 834 } else { 835 extensions = new String[] {".png", ".svg"}; 836 } 837 final int typeArchive = 0; 838 final int typeLocal = 1; 839 for (int place : new Integer[] {typeArchive, typeLocal}) { 840 for (String ext : extensions) { 841 842 if (".svg".equals(ext)) { 843 type = ImageType.SVG; 844 } else if (".png".equals(ext)) { 845 type = ImageType.OTHER; 846 } 847 848 String fullName = subdir + name + ext; 849 String cacheName = prefix + fullName; 850 /* cache separately */ 851 if (dirs != null && !dirs.isEmpty()) { 852 cacheName = "id:" + id + ':' + fullName; 853 if (archive != null) { 854 cacheName += ':' + archive.getName(); 855 } 856 } 857 858 switch (place) { 859 case typeArchive: 860 if (archive != null) { 861 cacheName = "zip:"+archive.hashCode()+':'+cacheName; 862 ImageResource ir = cache.get(cacheName); 863 if (ir != null) return ir; 864 865 ir = getIfAvailableZip(fullName, archive, inArchiveDir, type); 866 if (ir != null) { 867 cache.put(cacheName, ir); 868 return ir; 869 } 870 } 871 break; 872 case typeLocal: 873 ImageResource ir = cache.get(cacheName); 874 if (ir != null) return ir; 875 876 // getImageUrl() does a ton of "stat()" calls and gets expensive 877 // and redundant when you have a whole ton of objects. So, 878 // index the cache by the name of the icon we're looking for 879 // and don't bother to create a URL unless we're actually 880 // creating the image. 881 URL path = getImageUrl(fullName, dirs, additionalClassLoaders); 882 if (path == null) { 883 continue; 884 } 885 ir = getIfAvailableLocalURL(path, type); 886 if (ir != null) { 887 cache.put(cacheName, ir); 888 return ir; 889 } 890 break; 891 } 892 } 893 } 894 return null; 895 } 896 } 897 898 /** 899 * Internal implementation of the image request for URL's. 900 * 901 * @param url URL of the image 902 * @param type data type of the image 903 * @return the requested image or null if the request failed 904 */ 905 private static ImageResource getIfAvailableHttp(String url, ImageType type) { 906 try (CachedFile cf = new CachedFile(url).setDestDir(new File(Main.pref.getCacheDirectory(), "images").getPath()); 907 InputStream is = cf.getInputStream()) { 908 switch (type) { 909 case SVG: 910 SVGDiagram svg = null; 911 synchronized (getSvgUniverse()) { 912 URI uri = getSvgUniverse().loadSVG(is, Utils.fileToURL(cf.getFile()).toString()); 913 svg = getSvgUniverse().getDiagram(uri); 914 } 915 return svg == null ? null : new ImageResource(svg); 916 case OTHER: 917 BufferedImage img = null; 918 try { 919 img = read(Utils.fileToURL(cf.getFile()), false, false); 920 } catch (IOException e) { 921 Main.warn(e, "IOException while reading HTTP image:"); 922 } 923 return img == null ? null : new ImageResource(img); 924 default: 925 throw new AssertionError("Unsupported type: " + type); 926 } 927 } catch (IOException e) { 928 Main.debug(e); 929 return null; 930 } 931 } 932 933 /** 934 * Internal implementation of the image request for inline images (<b>data:</b> urls). 935 * 936 * @param url the data URL for image extraction 937 * @return the requested image or null if the request failed 938 */ 939 private static ImageResource getIfAvailableDataUrl(String url) { 940 Matcher m = dataUrlPattern.matcher(url); 941 if (m.matches()) { 942 String base64 = m.group(2); 943 String data = m.group(3); 944 byte[] bytes; 945 if (";base64".equals(base64)) { 946 bytes = Base64.getDecoder().decode(data); 947 } else { 948 try { 949 bytes = Utils.decodeUrl(data).getBytes(StandardCharsets.UTF_8); 950 } catch (IllegalArgumentException ex) { 951 Main.warn(ex, "Unable to decode URL data part: "+ex.getMessage() + " (" + data + ')'); 952 return null; 953 } 954 } 955 String mediatype = m.group(1); 956 if ("image/svg+xml".equals(mediatype)) { 957 String s = new String(bytes, StandardCharsets.UTF_8); 958 SVGDiagram svg; 959 synchronized (getSvgUniverse()) { 960 URI uri = getSvgUniverse().loadSVG(new StringReader(s), Utils.encodeUrl(s)); 961 svg = getSvgUniverse().getDiagram(uri); 962 } 963 if (svg == null) { 964 Main.warn("Unable to process svg: "+s); 965 return null; 966 } 967 return new ImageResource(svg); 968 } else { 969 try { 970 // See #10479: for PNG files, always enforce transparency to be sure tNRS chunk is used even not in paletted mode 971 // This can be removed if someday Oracle fixes https://bugs.openjdk.java.net/browse/JDK-6788458 972 // CHECKSTYLE.OFF: LineLength 973 // hg.openjdk.java.net/jdk8u/jdk8u/jdk/file/dc4322602480/src/share/classes/com/sun/imageio/plugins/png/PNGImageReader.java#l656 974 // CHECKSTYLE.ON: LineLength 975 Image img = read(new ByteArrayInputStream(bytes), false, true); 976 return img == null ? null : new ImageResource(img); 977 } catch (IOException e) { 978 Main.warn(e, "IOException while reading image:"); 979 } 980 } 981 } 982 return null; 983 } 984 985 /** 986 * Internal implementation of the image request for wiki images. 987 * 988 * @param name image file name 989 * @param type data type of the image 990 * @return the requested image or null if the request failed 991 */ 992 private static ImageResource getIfAvailableWiki(String name, ImageType type) { 993 final Collection<String> defaultBaseUrls = Arrays.asList( 994 "https://wiki.openstreetmap.org/w/images/", 995 "https://upload.wikimedia.org/wikipedia/commons/", 996 "https://wiki.openstreetmap.org/wiki/File:" 997 ); 998 final Collection<String> baseUrls = Main.pref.getCollection("image-provider.wiki.urls", defaultBaseUrls); 999 1000 final String fn = name.substring(name.lastIndexOf('/') + 1); 1001 1002 ImageResource result = null; 1003 for (String b : baseUrls) { 1004 String url; 1005 if (b.endsWith(":")) { 1006 url = getImgUrlFromWikiInfoPage(b, fn); 1007 if (url == null) { 1008 continue; 1009 } 1010 } else { 1011 final String fnMD5 = Utils.md5Hex(fn); 1012 url = b + fnMD5.substring(0, 1) + '/' + fnMD5.substring(0, 2) + '/' + fn; 1013 } 1014 result = getIfAvailableHttp(url, type); 1015 if (result != null) { 1016 break; 1017 } 1018 } 1019 return result; 1020 } 1021 1022 /** 1023 * Internal implementation of the image request for images in Zip archives. 1024 * 1025 * @param fullName image file name 1026 * @param archive the archive to get image from 1027 * @param inArchiveDir directory of the image inside the archive or <code>null</code> 1028 * @param type data type of the image 1029 * @return the requested image or null if the request failed 1030 */ 1031 private static ImageResource getIfAvailableZip(String fullName, File archive, String inArchiveDir, ImageType type) { 1032 try (ZipFile zipFile = new ZipFile(archive, StandardCharsets.UTF_8)) { 1033 if (inArchiveDir == null || ".".equals(inArchiveDir)) { 1034 inArchiveDir = ""; 1035 } else if (!inArchiveDir.isEmpty()) { 1036 inArchiveDir += '/'; 1037 } 1038 String entryName = inArchiveDir + fullName; 1039 ZipEntry entry = zipFile.getEntry(entryName); 1040 if (entry != null) { 1041 int size = (int) entry.getSize(); 1042 int offs = 0; 1043 byte[] buf = new byte[size]; 1044 try (InputStream is = zipFile.getInputStream(entry)) { 1045 switch (type) { 1046 case SVG: 1047 SVGDiagram svg = null; 1048 synchronized (getSvgUniverse()) { 1049 URI uri = getSvgUniverse().loadSVG(is, entryName); 1050 svg = getSvgUniverse().getDiagram(uri); 1051 } 1052 return svg == null ? null : new ImageResource(svg); 1053 case OTHER: 1054 while (size > 0) { 1055 int l = is.read(buf, offs, size); 1056 offs += l; 1057 size -= l; 1058 } 1059 BufferedImage img = null; 1060 try { 1061 img = read(new ByteArrayInputStream(buf), false, false); 1062 } catch (IOException e) { 1063 Main.warn(e); 1064 } 1065 return img == null ? null : new ImageResource(img); 1066 default: 1067 throw new AssertionError("Unknown ImageType: "+type); 1068 } 1069 } 1070 } 1071 } catch (IOException e) { 1072 Main.warn(e, tr("Failed to handle zip file ''{0}''. Exception was: {1}", archive.getName(), e.toString())); 1073 } 1074 return null; 1075 } 1076 1077 /** 1078 * Internal implementation of the image request for local images. 1079 * 1080 * @param path image file path 1081 * @param type data type of the image 1082 * @return the requested image or null if the request failed 1083 */ 1084 private static ImageResource getIfAvailableLocalURL(URL path, ImageType type) { 1085 switch (type) { 1086 case SVG: 1087 SVGDiagram svg; 1088 synchronized (getSvgUniverse()) { 1089 URI uri = getSvgUniverse().loadSVG(path); 1090 svg = getSvgUniverse().getDiagram(uri); 1091 } 1092 return svg == null ? null : new ImageResource(svg); 1093 case OTHER: 1094 BufferedImage img = null; 1095 try { 1096 // See #10479: for PNG files, always enforce transparency to be sure tNRS chunk is used even not in paletted mode 1097 // This can be removed if someday Oracle fixes https://bugs.openjdk.java.net/browse/JDK-6788458 1098 // hg.openjdk.java.net/jdk8u/jdk8u/jdk/file/dc4322602480/src/share/classes/com/sun/imageio/plugins/png/PNGImageReader.java#l656 1099 img = read(path, false, true); 1100 if (Main.isDebugEnabled() && isTransparencyForced(img)) { 1101 Main.debug("Transparency has been forced for image "+path.toExternalForm()); 1102 } 1103 } catch (IOException e) { 1104 Main.warn(e); 1105 } 1106 return img == null ? null : new ImageResource(img); 1107 default: 1108 throw new AssertionError(); 1109 } 1110 } 1111 1112 private static URL getImageUrl(String path, String name, Collection<ClassLoader> additionalClassLoaders) { 1113 if (path != null && path.startsWith("resource://")) { 1114 String p = path.substring("resource://".length()); 1115 Collection<ClassLoader> classLoaders = new ArrayList<>(PluginHandler.getResourceClassLoaders()); 1116 if (additionalClassLoaders != null) { 1117 classLoaders.addAll(additionalClassLoaders); 1118 } 1119 for (ClassLoader source : classLoaders) { 1120 URL res; 1121 if ((res = source.getResource(p + name)) != null) 1122 return res; 1123 } 1124 } else { 1125 File f = new File(path, name); 1126 if ((path != null || f.isAbsolute()) && f.exists()) 1127 return Utils.fileToURL(f); 1128 } 1129 return null; 1130 } 1131 1132 private static URL getImageUrl(String imageName, Collection<String> dirs, Collection<ClassLoader> additionalClassLoaders) { 1133 URL u; 1134 1135 // Try passed directories first 1136 if (dirs != null) { 1137 for (String name : dirs) { 1138 try { 1139 u = getImageUrl(name, imageName, additionalClassLoaders); 1140 if (u != null) 1141 return u; 1142 } catch (SecurityException e) { 1143 Main.warn(e, tr( 1144 "Failed to access directory ''{0}'' for security reasons. Exception was: {1}", 1145 name, e.toString())); 1146 } 1147 1148 } 1149 } 1150 // Try user-data directory 1151 if (Main.pref != null) { 1152 String dir = new File(Main.pref.getUserDataDirectory(), "images").getAbsolutePath(); 1153 try { 1154 u = getImageUrl(dir, imageName, additionalClassLoaders); 1155 if (u != null) 1156 return u; 1157 } catch (SecurityException e) { 1158 Main.warn(e, tr( 1159 "Failed to access directory ''{0}'' for security reasons. Exception was: {1}", dir, e 1160 .toString())); 1161 } 1162 } 1163 1164 // Absolute path? 1165 u = getImageUrl(null, imageName, additionalClassLoaders); 1166 if (u != null) 1167 return u; 1168 1169 // Try plugins and josm classloader 1170 u = getImageUrl("resource://images/", imageName, additionalClassLoaders); 1171 if (u != null) 1172 return u; 1173 1174 // Try all other resource directories 1175 if (Main.pref != null) { 1176 for (String location : Main.pref.getAllPossiblePreferenceDirs()) { 1177 u = getImageUrl(location + "images", imageName, additionalClassLoaders); 1178 if (u != null) 1179 return u; 1180 u = getImageUrl(location, imageName, additionalClassLoaders); 1181 if (u != null) 1182 return u; 1183 } 1184 } 1185 1186 return null; 1187 } 1188 1189 /** Quit parsing, when a certain condition is met */ 1190 private static class SAXReturnException extends SAXException { 1191 private final String result; 1192 1193 SAXReturnException(String result) { 1194 this.result = result; 1195 } 1196 1197 public String getResult() { 1198 return result; 1199 } 1200 } 1201 1202 /** 1203 * Reads the wiki page on a certain file in html format in order to find the real image URL. 1204 * 1205 * @param base base URL for Wiki image 1206 * @param fn filename of the Wiki image 1207 * @return image URL for a Wiki image or null in case of error 1208 */ 1209 private static String getImgUrlFromWikiInfoPage(final String base, final String fn) { 1210 try { 1211 final XMLReader parser = Utils.newSafeSAXParser().getXMLReader(); 1212 parser.setContentHandler(new DefaultHandler() { 1213 @Override 1214 public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException { 1215 if ("img".equalsIgnoreCase(localName)) { 1216 String val = atts.getValue("src"); 1217 if (val.endsWith(fn)) 1218 throw new SAXReturnException(val); // parsing done, quit early 1219 } 1220 } 1221 }); 1222 1223 parser.setEntityResolver((publicId, systemId) -> new InputSource(new ByteArrayInputStream(new byte[0]))); 1224 1225 try (CachedFile cf = new CachedFile(base + fn).setDestDir(new File(Main.pref.getUserDataDirectory(), "images").getPath()); 1226 InputStream is = cf.getInputStream()) { 1227 parser.parse(new InputSource(is)); 1228 } 1229 } catch (SAXReturnException r) { 1230 Main.trace(r); 1231 return r.getResult(); 1232 } catch (IOException | SAXException | ParserConfigurationException e) { 1233 Main.warn("Parsing " + base + fn + " failed:\n" + e); 1234 return null; 1235 } 1236 Main.warn("Parsing " + base + fn + " failed: Unexpected content."); 1237 return null; 1238 } 1239 1240 /** 1241 * Load a cursor with a given file name, optionally decorated with an overlay image. 1242 * 1243 * @param name the cursor image filename in "cursor" directory 1244 * @param overlay optional overlay image 1245 * @return cursor with a given file name, optionally decorated with an overlay image 1246 */ 1247 public static Cursor getCursor(String name, String overlay) { 1248 ImageIcon img = get("cursor", name); 1249 if (overlay != null) { 1250 img = new ImageProvider("cursor", name).setMaxSize(ImageSizes.CURSOR) 1251 .addOverlay(new ImageOverlay(new ImageProvider("cursor/modifier/" + overlay) 1252 .setMaxSize(ImageSizes.CURSOROVERLAY))).get(); 1253 } 1254 if (GraphicsEnvironment.isHeadless()) { 1255 if (Main.isDebugEnabled()) { 1256 Main.debug("Cursors are not available in headless mode. Returning null for '"+name+'\''); 1257 } 1258 return null; 1259 } 1260 return Toolkit.getDefaultToolkit().createCustomCursor(img.getImage(), 1261 "crosshair".equals(name) ? new Point(10, 10) : new Point(3, 2), "Cursor"); 1262 } 1263 1264 /** 90 degrees in radians units */ 1265 private static final double DEGREE_90 = 90.0 * Math.PI / 180.0; 1266 1267 /** 1268 * Creates a rotated version of the input image. 1269 * 1270 * @param img the image to be rotated. 1271 * @param rotatedAngle the rotated angle, in degree, clockwise. It could be any double but we 1272 * will mod it with 360 before using it. More over for caching performance, it will be rounded to 1273 * an entire value between 0 and 360. 1274 * 1275 * @return the image after rotating. 1276 * @since 6172 1277 */ 1278 public static Image createRotatedImage(Image img, double rotatedAngle) { 1279 return createRotatedImage(img, rotatedAngle, ImageResource.DEFAULT_DIMENSION); 1280 } 1281 1282 /** 1283 * Creates a rotated version of the input image, scaled to the given dimension. 1284 * 1285 * @param img the image to be rotated. 1286 * @param rotatedAngle the rotated angle, in degree, clockwise. It could be any double but we 1287 * will mod it with 360 before using it. More over for caching performance, it will be rounded to 1288 * an entire value between 0 and 360. 1289 * @param dimension The requested dimensions. Use (-1,-1) for the original size 1290 * and (width, -1) to set the width, but otherwise scale the image proportionally. 1291 * @return the image after rotating and scaling. 1292 * @since 6172 1293 */ 1294 public static Image createRotatedImage(Image img, double rotatedAngle, Dimension dimension) { 1295 CheckParameterUtil.ensureParameterNotNull(img, "img"); 1296 1297 // convert rotatedAngle to an integer value from 0 to 360 1298 Long originalAngle = Math.round(rotatedAngle % 360); 1299 if (rotatedAngle != 0 && originalAngle == 0) { 1300 originalAngle = 360L; 1301 } 1302 1303 ImageResource imageResource; 1304 1305 synchronized (ROTATE_CACHE) { 1306 Map<Long, ImageResource> cacheByAngle = ROTATE_CACHE.get(img); 1307 if (cacheByAngle == null) { 1308 cacheByAngle = new HashMap<>(); 1309 ROTATE_CACHE.put(img, cacheByAngle); 1310 } 1311 1312 imageResource = cacheByAngle.get(originalAngle); 1313 1314 if (imageResource == null) { 1315 // convert originalAngle to a value from 0 to 90 1316 double angle = originalAngle % 90; 1317 if (originalAngle != 0 && angle == 0) { 1318 angle = 90.0; 1319 } 1320 1321 double radian = Math.toRadians(angle); 1322 1323 new ImageIcon(img); // load completely 1324 int iw = img.getWidth(null); 1325 int ih = img.getHeight(null); 1326 int w; 1327 int h; 1328 1329 if ((originalAngle >= 0 && originalAngle <= 90) || (originalAngle > 180 && originalAngle <= 270)) { 1330 w = (int) (iw * Math.sin(DEGREE_90 - radian) + ih * Math.sin(radian)); 1331 h = (int) (iw * Math.sin(radian) + ih * Math.sin(DEGREE_90 - radian)); 1332 } else { 1333 w = (int) (ih * Math.sin(DEGREE_90 - radian) + iw * Math.sin(radian)); 1334 h = (int) (ih * Math.sin(radian) + iw * Math.sin(DEGREE_90 - radian)); 1335 } 1336 Image image = new BufferedImage(w, h, BufferedImage.TYPE_INT_ARGB); 1337 imageResource = new ImageResource(image); 1338 cacheByAngle.put(originalAngle, imageResource); 1339 Graphics g = image.getGraphics(); 1340 Graphics2D g2d = (Graphics2D) g.create(); 1341 1342 // calculate the center of the icon. 1343 int cx = iw / 2; 1344 int cy = ih / 2; 1345 1346 // move the graphics center point to the center of the icon. 1347 g2d.translate(w / 2, h / 2); 1348 1349 // rotate the graphics about the center point of the icon 1350 g2d.rotate(Math.toRadians(originalAngle)); 1351 1352 g2d.setRenderingHint(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BICUBIC); 1353 g2d.drawImage(img, -cx, -cy, null); 1354 1355 g2d.dispose(); 1356 new ImageIcon(image); // load completely 1357 } 1358 return imageResource.getImageIcon(dimension).getImage(); 1359 } 1360 } 1361 1362 /** 1363 * Creates a scaled down version of the input image to fit maximum dimensions. (Keeps aspect ratio) 1364 * 1365 * @param img the image to be scaled down. 1366 * @param maxSize the maximum size in pixels (both for width and height) 1367 * 1368 * @return the image after scaling. 1369 * @since 6172 1370 */ 1371 public static Image createBoundedImage(Image img, int maxSize) { 1372 return new ImageResource(img).getImageIconBounded(new Dimension(maxSize, maxSize)).getImage(); 1373 } 1374 1375 /** 1376 * Replies the icon for an OSM primitive type 1377 * @param type the type 1378 * @return the icon 1379 */ 1380 public static ImageIcon get(OsmPrimitiveType type) { 1381 CheckParameterUtil.ensureParameterNotNull(type, "type"); 1382 return get("data", type.getAPIName()); 1383 } 1384 1385 /** 1386 * @param primitive Object for which an icon shall be fetched. The icon is chosen based on tags. 1387 * @param iconSize Target size of icon. Icon is padded if required. 1388 * @return Icon for {@code primitive} that fits in cell. 1389 * @since 8903 1390 */ 1391 public static ImageIcon getPadded(OsmPrimitive primitive, Dimension iconSize) { 1392 // Check if the current styles have special icon for tagged nodes. 1393 if (primitive instanceof org.openstreetmap.josm.data.osm.Node) { 1394 Pair<StyleElementList, Range> nodeStyles; 1395 DataSet ds = primitive.getDataSet(); 1396 if (ds != null) { 1397 ds.getReadLock().lock(); 1398 } 1399 try { 1400 nodeStyles = MapPaintStyles.getStyles().generateStyles(primitive, 100, false); 1401 } finally { 1402 if (ds != null) { 1403 ds.getReadLock().unlock(); 1404 } 1405 } 1406 for (StyleElement style : nodeStyles.a) { 1407 if (style instanceof NodeElement) { 1408 NodeElement nodeStyle = (NodeElement) style; 1409 MapImage icon = nodeStyle.mapImage; 1410 if (icon != null) { 1411 int backgroundRealWidth = GuiSizesHelper.getSizeDpiAdjusted(iconSize.width); 1412 int backgroundRealHeight = GuiSizesHelper.getSizeDpiAdjusted(iconSize.height); 1413 int iconRealWidth = icon.getWidth(); 1414 int iconRealHeight = icon.getHeight(); 1415 BufferedImage image = new BufferedImage(backgroundRealWidth, backgroundRealHeight, 1416 BufferedImage.TYPE_INT_ARGB); 1417 double scaleFactor = Math.min(backgroundRealWidth / (double) iconRealWidth, backgroundRealHeight 1418 / (double) iconRealHeight); 1419 BufferedImage iconImage = icon.getImage(false); 1420 Image scaledIcon; 1421 final int scaledWidth; 1422 final int scaledHeight; 1423 if (scaleFactor < 1) { 1424 // Scale icon such that it fits on background. 1425 scaledWidth = (int) (iconRealWidth * scaleFactor); 1426 scaledHeight = (int) (iconRealHeight * scaleFactor); 1427 scaledIcon = iconImage.getScaledInstance(scaledWidth, scaledHeight, Image.SCALE_SMOOTH); 1428 } else { 1429 // Use original size, don't upscale. 1430 scaledWidth = iconRealWidth; 1431 scaledHeight = iconRealHeight; 1432 scaledIcon = iconImage; 1433 } 1434 image.getGraphics().drawImage(scaledIcon, (backgroundRealWidth - scaledWidth) / 2, 1435 (backgroundRealHeight - scaledHeight) / 2, null); 1436 1437 return new ImageIcon(image); 1438 } 1439 } 1440 } 1441 } 1442 1443 // Check if the presets have icons for nodes/relations. 1444 if (!OsmPrimitiveType.WAY.equals(primitive.getType())) { 1445 final Collection<TaggingPreset> presets = new TreeSet<>((o1, o2) -> { 1446 final int o1TypesSize = o1.types == null || o1.types.isEmpty() ? Integer.MAX_VALUE : o1.types.size(); 1447 final int o2TypesSize = o2.types == null || o2.types.isEmpty() ? Integer.MAX_VALUE : o2.types.size(); 1448 return Integer.compare(o1TypesSize, o2TypesSize); 1449 }); 1450 presets.addAll(TaggingPresets.getMatchingPresets(primitive)); 1451 for (final TaggingPreset preset : presets) { 1452 if (preset.getIcon() != null) { 1453 return preset.getIcon(); 1454 } 1455 } 1456 } 1457 1458 // Use generic default icon. 1459 return ImageProvider.get(primitive.getDisplayType()); 1460 } 1461 1462 /** 1463 * Constructs an image from the given SVG data. 1464 * @param svg the SVG data 1465 * @param dim the desired image dimension 1466 * @return an image from the given SVG data at the desired dimension. 1467 */ 1468 public static BufferedImage createImageFromSvg(SVGDiagram svg, Dimension dim) { 1469 if (Main.isTraceEnabled()) { 1470 Main.trace(String.format("createImageFromSvg: %s %s", svg.getXMLBase(), dim)); 1471 } 1472 float sourceWidth = svg.getWidth(); 1473 float sourceHeight = svg.getHeight(); 1474 int realWidth = Math.round(GuiSizesHelper.getSizeDpiAdjusted(sourceWidth)); 1475 int realHeight = Math.round(GuiSizesHelper.getSizeDpiAdjusted(sourceHeight)); 1476 Double scaleX, scaleY; 1477 if (dim.width != -1) { 1478 realWidth = dim.width; 1479 scaleX = (double) realWidth / sourceWidth; 1480 if (dim.height == -1) { 1481 scaleY = scaleX; 1482 realHeight = (int) Math.round(sourceHeight * scaleY); 1483 } else { 1484 realHeight = dim.height; 1485 scaleY = (double) realHeight / sourceHeight; 1486 } 1487 } else if (dim.height != -1) { 1488 realHeight = dim.height; 1489 scaleX = scaleY = (double) realHeight / sourceHeight; 1490 realWidth = (int) Math.round(sourceWidth * scaleX); 1491 } else { 1492 scaleX = scaleY = (double) realHeight / sourceHeight; 1493 } 1494 1495 if (realWidth == 0 || realHeight == 0) { 1496 return null; 1497 } 1498 BufferedImage img = new BufferedImage(realWidth, realHeight, BufferedImage.TYPE_INT_ARGB); 1499 Graphics2D g = img.createGraphics(); 1500 g.setClip(0, 0, realWidth, realHeight); 1501 g.scale(scaleX, scaleY); 1502 g.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON); 1503 try { 1504 synchronized (getSvgUniverse()) { 1505 svg.render(g); 1506 } 1507 } catch (SVGException ex) { 1508 Main.error(ex, "Unable to load svg:"); 1509 return null; 1510 } 1511 return img; 1512 } 1513 1514 private static synchronized SVGUniverse getSvgUniverse() { 1515 if (svgUniverse == null) { 1516 svgUniverse = new SVGUniverse(); 1517 } 1518 return svgUniverse; 1519 } 1520 1521 /** 1522 * Returns a <code>BufferedImage</code> as the result of decoding 1523 * a supplied <code>File</code> with an <code>ImageReader</code> 1524 * chosen automatically from among those currently registered. 1525 * The <code>File</code> is wrapped in an 1526 * <code>ImageInputStream</code>. If no registered 1527 * <code>ImageReader</code> claims to be able to read the 1528 * resulting stream, <code>null</code> is returned. 1529 * 1530 * <p> The current cache settings from <code>getUseCache</code>and 1531 * <code>getCacheDirectory</code> will be used to control caching in the 1532 * <code>ImageInputStream</code> that is created. 1533 * 1534 * <p> Note that there is no <code>read</code> method that takes a 1535 * filename as a <code>String</code>; use this method instead after 1536 * creating a <code>File</code> from the filename. 1537 * 1538 * <p> This method does not attempt to locate 1539 * <code>ImageReader</code>s that can read directly from a 1540 * <code>File</code>; that may be accomplished using 1541 * <code>IIORegistry</code> and <code>ImageReaderSpi</code>. 1542 * 1543 * @param input a <code>File</code> to read from. 1544 * @param readMetadata if {@code true}, makes sure to read image metadata to detect transparency color, if any. 1545 * In that case the color can be retrieved later through {@link #PROP_TRANSPARENCY_COLOR}. 1546 * Always considered {@code true} if {@code enforceTransparency} is also {@code true} 1547 * @param enforceTransparency if {@code true}, makes sure to read image metadata and, if the image does not 1548 * provide an alpha channel but defines a {@code TransparentColor} metadata node, that the resulting image 1549 * has a transparency set to {@code TRANSLUCENT} and uses the correct transparent color. 1550 * 1551 * @return a <code>BufferedImage</code> containing the decoded 1552 * contents of the input, or <code>null</code>. 1553 * 1554 * @throws IllegalArgumentException if <code>input</code> is <code>null</code>. 1555 * @throws IOException if an error occurs during reading. 1556 * @see BufferedImage#getProperty 1557 * @since 7132 1558 */ 1559 public static BufferedImage read(File input, boolean readMetadata, boolean enforceTransparency) throws IOException { 1560 CheckParameterUtil.ensureParameterNotNull(input, "input"); 1561 if (!input.canRead()) { 1562 throw new IIOException("Can't read input file!"); 1563 } 1564 1565 ImageInputStream stream = ImageIO.createImageInputStream(input); 1566 if (stream == null) { 1567 throw new IIOException("Can't create an ImageInputStream!"); 1568 } 1569 BufferedImage bi = read(stream, readMetadata, enforceTransparency); 1570 if (bi == null) { 1571 stream.close(); 1572 } 1573 return bi; 1574 } 1575 1576 /** 1577 * Returns a <code>BufferedImage</code> as the result of decoding 1578 * a supplied <code>InputStream</code> with an <code>ImageReader</code> 1579 * chosen automatically from among those currently registered. 1580 * The <code>InputStream</code> is wrapped in an 1581 * <code>ImageInputStream</code>. If no registered 1582 * <code>ImageReader</code> claims to be able to read the 1583 * resulting stream, <code>null</code> is returned. 1584 * 1585 * <p> The current cache settings from <code>getUseCache</code>and 1586 * <code>getCacheDirectory</code> will be used to control caching in the 1587 * <code>ImageInputStream</code> that is created. 1588 * 1589 * <p> This method does not attempt to locate 1590 * <code>ImageReader</code>s that can read directly from an 1591 * <code>InputStream</code>; that may be accomplished using 1592 * <code>IIORegistry</code> and <code>ImageReaderSpi</code>. 1593 * 1594 * <p> This method <em>does not</em> close the provided 1595 * <code>InputStream</code> after the read operation has completed; 1596 * it is the responsibility of the caller to close the stream, if desired. 1597 * 1598 * @param input an <code>InputStream</code> to read from. 1599 * @param readMetadata if {@code true}, makes sure to read image metadata to detect transparency color for non translucent images, if any. 1600 * In that case the color can be retrieved later through {@link #PROP_TRANSPARENCY_COLOR}. 1601 * Always considered {@code true} if {@code enforceTransparency} is also {@code true} 1602 * @param enforceTransparency if {@code true}, makes sure to read image metadata and, if the image does not 1603 * provide an alpha channel but defines a {@code TransparentColor} metadata node, that the resulting image 1604 * has a transparency set to {@code TRANSLUCENT} and uses the correct transparent color. 1605 * 1606 * @return a <code>BufferedImage</code> containing the decoded 1607 * contents of the input, or <code>null</code>. 1608 * 1609 * @throws IllegalArgumentException if <code>input</code> is <code>null</code>. 1610 * @throws IOException if an error occurs during reading. 1611 * @since 7132 1612 */ 1613 public static BufferedImage read(InputStream input, boolean readMetadata, boolean enforceTransparency) throws IOException { 1614 CheckParameterUtil.ensureParameterNotNull(input, "input"); 1615 1616 ImageInputStream stream = ImageIO.createImageInputStream(input); 1617 BufferedImage bi = read(stream, readMetadata, enforceTransparency); 1618 if (bi == null) { 1619 stream.close(); 1620 } 1621 return bi; 1622 } 1623 1624 /** 1625 * Returns a <code>BufferedImage</code> as the result of decoding 1626 * a supplied <code>URL</code> with an <code>ImageReader</code> 1627 * chosen automatically from among those currently registered. An 1628 * <code>InputStream</code> is obtained from the <code>URL</code>, 1629 * which is wrapped in an <code>ImageInputStream</code>. If no 1630 * registered <code>ImageReader</code> claims to be able to read 1631 * the resulting stream, <code>null</code> is returned. 1632 * 1633 * <p> The current cache settings from <code>getUseCache</code>and 1634 * <code>getCacheDirectory</code> will be used to control caching in the 1635 * <code>ImageInputStream</code> that is created. 1636 * 1637 * <p> This method does not attempt to locate 1638 * <code>ImageReader</code>s that can read directly from a 1639 * <code>URL</code>; that may be accomplished using 1640 * <code>IIORegistry</code> and <code>ImageReaderSpi</code>. 1641 * 1642 * @param input a <code>URL</code> to read from. 1643 * @param readMetadata if {@code true}, makes sure to read image metadata to detect transparency color for non translucent images, if any. 1644 * In that case the color can be retrieved later through {@link #PROP_TRANSPARENCY_COLOR}. 1645 * Always considered {@code true} if {@code enforceTransparency} is also {@code true} 1646 * @param enforceTransparency if {@code true}, makes sure to read image metadata and, if the image does not 1647 * provide an alpha channel but defines a {@code TransparentColor} metadata node, that the resulting image 1648 * has a transparency set to {@code TRANSLUCENT} and uses the correct transparent color. 1649 * 1650 * @return a <code>BufferedImage</code> containing the decoded 1651 * contents of the input, or <code>null</code>. 1652 * 1653 * @throws IllegalArgumentException if <code>input</code> is <code>null</code>. 1654 * @throws IOException if an error occurs during reading. 1655 * @since 7132 1656 */ 1657 public static BufferedImage read(URL input, boolean readMetadata, boolean enforceTransparency) throws IOException { 1658 CheckParameterUtil.ensureParameterNotNull(input, "input"); 1659 1660 InputStream istream = null; 1661 try { 1662 istream = input.openStream(); 1663 } catch (IOException e) { 1664 throw new IIOException("Can't get input stream from URL!", e); 1665 } 1666 ImageInputStream stream = ImageIO.createImageInputStream(istream); 1667 BufferedImage bi; 1668 try { 1669 bi = read(stream, readMetadata, enforceTransparency); 1670 if (bi == null) { 1671 stream.close(); 1672 } 1673 } finally { 1674 istream.close(); 1675 } 1676 return bi; 1677 } 1678 1679 /** 1680 * Returns a <code>BufferedImage</code> as the result of decoding 1681 * a supplied <code>ImageInputStream</code> with an 1682 * <code>ImageReader</code> chosen automatically from among those 1683 * currently registered. If no registered 1684 * <code>ImageReader</code> claims to be able to read the stream, 1685 * <code>null</code> is returned. 1686 * 1687 * <p> Unlike most other methods in this class, this method <em>does</em> 1688 * close the provided <code>ImageInputStream</code> after the read 1689 * operation has completed, unless <code>null</code> is returned, 1690 * in which case this method <em>does not</em> close the stream. 1691 * 1692 * @param stream an <code>ImageInputStream</code> to read from. 1693 * @param readMetadata if {@code true}, makes sure to read image metadata to detect transparency color for non translucent images, if any. 1694 * In that case the color can be retrieved later through {@link #PROP_TRANSPARENCY_COLOR}. 1695 * Always considered {@code true} if {@code enforceTransparency} is also {@code true} 1696 * @param enforceTransparency if {@code true}, makes sure to read image metadata and, if the image does not 1697 * provide an alpha channel but defines a {@code TransparentColor} metadata node, that the resulting image 1698 * has a transparency set to {@code TRANSLUCENT} and uses the correct transparent color. 1699 * 1700 * @return a <code>BufferedImage</code> containing the decoded 1701 * contents of the input, or <code>null</code>. 1702 * 1703 * @throws IllegalArgumentException if <code>stream</code> is <code>null</code>. 1704 * @throws IOException if an error occurs during reading. 1705 * @since 7132 1706 */ 1707 public static BufferedImage read(ImageInputStream stream, boolean readMetadata, boolean enforceTransparency) throws IOException { 1708 CheckParameterUtil.ensureParameterNotNull(stream, "stream"); 1709 1710 Iterator<ImageReader> iter = ImageIO.getImageReaders(stream); 1711 if (!iter.hasNext()) { 1712 return null; 1713 } 1714 1715 ImageReader reader = iter.next(); 1716 ImageReadParam param = reader.getDefaultReadParam(); 1717 reader.setInput(stream, true, !readMetadata && !enforceTransparency); 1718 BufferedImage bi; 1719 try { 1720 bi = reader.read(0, param); 1721 if (bi.getTransparency() != Transparency.TRANSLUCENT && (readMetadata || enforceTransparency)) { 1722 Color color = getTransparentColor(bi.getColorModel(), reader); 1723 if (color != null) { 1724 Hashtable<String, Object> properties = new Hashtable<>(1); 1725 properties.put(PROP_TRANSPARENCY_COLOR, color); 1726 bi = new BufferedImage(bi.getColorModel(), bi.getRaster(), bi.isAlphaPremultiplied(), properties); 1727 if (enforceTransparency) { 1728 if (Main.isTraceEnabled()) { 1729 Main.trace("Enforcing image transparency of "+stream+" for "+color); 1730 } 1731 bi = makeImageTransparent(bi, color); 1732 } 1733 } 1734 } 1735 } finally { 1736 reader.dispose(); 1737 stream.close(); 1738 } 1739 return bi; 1740 } 1741 1742 // CHECKSTYLE.OFF: LineLength 1743 1744 /** 1745 * Returns the {@code TransparentColor} defined in image reader metadata. 1746 * @param model The image color model 1747 * @param reader The image reader 1748 * @return the {@code TransparentColor} defined in image reader metadata, or {@code null} 1749 * @throws IOException if an error occurs during reading 1750 * @see <a href="http://docs.oracle.com/javase/8/docs/api/javax/imageio/metadata/doc-files/standard_metadata.html">javax_imageio_1.0 metadata</a> 1751 * @since 7499 1752 */ 1753 public static Color getTransparentColor(ColorModel model, ImageReader reader) throws IOException { 1754 // CHECKSTYLE.ON: LineLength 1755 try { 1756 IIOMetadata metadata = reader.getImageMetadata(0); 1757 if (metadata != null) { 1758 String[] formats = metadata.getMetadataFormatNames(); 1759 if (formats != null) { 1760 for (String f : formats) { 1761 if ("javax_imageio_1.0".equals(f)) { 1762 Node root = metadata.getAsTree(f); 1763 if (root instanceof Element) { 1764 NodeList list = ((Element) root).getElementsByTagName("TransparentColor"); 1765 if (list.getLength() > 0) { 1766 Node item = list.item(0); 1767 if (item instanceof Element) { 1768 // Handle different color spaces (tested with RGB and grayscale) 1769 String value = ((Element) item).getAttribute("value"); 1770 if (!value.isEmpty()) { 1771 String[] s = value.split(" "); 1772 if (s.length == 3) { 1773 return parseRGB(s); 1774 } else if (s.length == 1) { 1775 int pixel = Integer.parseInt(s[0]); 1776 int r = model.getRed(pixel); 1777 int g = model.getGreen(pixel); 1778 int b = model.getBlue(pixel); 1779 return new Color(r, g, b); 1780 } else { 1781 Main.warn("Unable to translate TransparentColor '"+value+"' with color model "+model); 1782 } 1783 } 1784 } 1785 } 1786 } 1787 break; 1788 } 1789 } 1790 } 1791 } 1792 } catch (IIOException | NumberFormatException e) { 1793 // JAI doesn't like some JPEG files with error "Inconsistent metadata read from stream" (see #10267) 1794 Main.warn(e); 1795 } 1796 return null; 1797 } 1798 1799 private static Color parseRGB(String ... s) { 1800 int[] rgb = new int[3]; 1801 try { 1802 for (int i = 0; i < 3; i++) { 1803 rgb[i] = Integer.parseInt(s[i]); 1804 } 1805 return new Color(rgb[0], rgb[1], rgb[2]); 1806 } catch (IllegalArgumentException e) { 1807 Main.error(e); 1808 return null; 1809 } 1810 } 1811 1812 /** 1813 * Returns a transparent version of the given image, based on the given transparent color. 1814 * @param bi The image to convert 1815 * @param color The transparent color 1816 * @return The same image as {@code bi} where all pixels of the given color are transparent. 1817 * This resulting image has also the special property {@link #PROP_TRANSPARENCY_FORCED} set to {@code color} 1818 * @see BufferedImage#getProperty 1819 * @see #isTransparencyForced 1820 * @since 7132 1821 */ 1822 public static BufferedImage makeImageTransparent(BufferedImage bi, Color color) { 1823 // the color we are looking for. Alpha bits are set to opaque 1824 final int markerRGB = color.getRGB() | 0xFF000000; 1825 ImageFilter filter = new RGBImageFilter() { 1826 @Override 1827 public int filterRGB(int x, int y, int rgb) { 1828 if ((rgb | 0xFF000000) == markerRGB) { 1829 // Mark the alpha bits as zero - transparent 1830 return 0x00FFFFFF & rgb; 1831 } else { 1832 return rgb; 1833 } 1834 } 1835 }; 1836 ImageProducer ip = new FilteredImageSource(bi.getSource(), filter); 1837 Image img = Toolkit.getDefaultToolkit().createImage(ip); 1838 ColorModel colorModel = ColorModel.getRGBdefault(); 1839 WritableRaster raster = colorModel.createCompatibleWritableRaster(img.getWidth(null), img.getHeight(null)); 1840 String[] names = bi.getPropertyNames(); 1841 Hashtable<String, Object> properties = new Hashtable<>(1 + (names != null ? names.length : 0)); 1842 if (names != null) { 1843 for (String name : names) { 1844 properties.put(name, bi.getProperty(name)); 1845 } 1846 } 1847 properties.put(PROP_TRANSPARENCY_FORCED, Boolean.TRUE); 1848 BufferedImage result = new BufferedImage(colorModel, raster, false, properties); 1849 Graphics2D g2 = result.createGraphics(); 1850 g2.drawImage(img, 0, 0, null); 1851 g2.dispose(); 1852 return result; 1853 } 1854 1855 /** 1856 * Determines if the transparency of the given {@code BufferedImage} has been enforced by a previous call to {@link #makeImageTransparent}. 1857 * @param bi The {@code BufferedImage} to test 1858 * @return {@code true} if the transparency of {@code bi} has been enforced by a previous call to {@code makeImageTransparent}. 1859 * @see #makeImageTransparent 1860 * @since 7132 1861 */ 1862 public static boolean isTransparencyForced(BufferedImage bi) { 1863 return bi != null && !bi.getProperty(PROP_TRANSPARENCY_FORCED).equals(Image.UndefinedProperty); 1864 } 1865 1866 /** 1867 * Determines if the given {@code BufferedImage} has a transparent color determined by a previous call to {@link #read}. 1868 * @param bi The {@code BufferedImage} to test 1869 * @return {@code true} if {@code bi} has a transparent color determined by a previous call to {@code read}. 1870 * @see #read 1871 * @since 7132 1872 */ 1873 public static boolean hasTransparentColor(BufferedImage bi) { 1874 return bi != null && !bi.getProperty(PROP_TRANSPARENCY_COLOR).equals(Image.UndefinedProperty); 1875 } 1876 1877 /** 1878 * Shutdown background image fetcher. 1879 * @param now if {@code true}, attempts to stop all actively executing tasks, halts the processing of waiting tasks. 1880 * if {@code false}, initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted 1881 * @since 8412 1882 */ 1883 public static void shutdown(boolean now) { 1884 if (now) { 1885 IMAGE_FETCHER.shutdownNow(); 1886 } else { 1887 IMAGE_FETCHER.shutdown(); 1888 } 1889 } 1890}