Index: /applications/editors/josm/plugins/build.xml =================================================================== --- /applications/editors/josm/plugins/build.xml (revision 36092) +++ /applications/editors/josm/plugins/build.xml (revision 36093) @@ -11,5 +11,6 @@ - + + + + + + + Index: /applications/editors/josm/plugins/imageio/.project =================================================================== --- /applications/editors/josm/plugins/imageio/.project (revision 36093) +++ /applications/editors/josm/plugins/imageio/.project (revision 36093) @@ -0,0 +1,15 @@ + + + JOSM-imageio + + + + + org.eclipse.jdt.core.javabuilder + + + + + org.eclipse.jdt.core.javanature + + Index: /applications/editors/josm/plugins/imageio/LICENSE =================================================================== --- /applications/editors/josm/plugins/imageio/LICENSE (revision 36093) +++ /applications/editors/josm/plugins/imageio/LICENSE (revision 36093) @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. Index: /applications/editors/josm/plugins/imageio/README.md =================================================================== --- /applications/editors/josm/plugins/imageio/README.md (revision 36093) +++ /applications/editors/josm/plugins/imageio/README.md (revision 36093) @@ -0,0 +1,17 @@ +README +====== + +# Usage +1. Install the plugin +2. Go to JOSM Preferences -> `Imagery` -> `ImageIO` +3. Enable the additional image formats you want JOSM to read + +Right now, ImageIO plugins should be updated if you go to the ImageIO plugin page (in `Imagery`). + +# Plugin Information +## License +GPL v2 or any later version + +# Authors +* Taylor Smock (taylor.smock) + Index: /applications/editors/josm/plugins/imageio/build.xml =================================================================== --- /applications/editors/josm/plugins/imageio/build.xml (revision 36093) +++ /applications/editors/josm/plugins/imageio/build.xml (revision 36093) @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + + + + + Index: /applications/editors/josm/plugins/imageio/src/main/java/org/openstreetmap/josm/plugins/imageio/Artifact.java =================================================================== --- /applications/editors/josm/plugins/imageio/src/main/java/org/openstreetmap/josm/plugins/imageio/Artifact.java (revision 36093) +++ /applications/editors/josm/plugins/imageio/src/main/java/org/openstreetmap/josm/plugins/imageio/Artifact.java (revision 36093) @@ -0,0 +1,91 @@ +// License: GPL. For details, see LICENSE file. +// SPDX-License-Identifier: GPL-2.0-or-later +package org.openstreetmap.josm.plugins.imageio; + +import org.openstreetmap.josm.spi.preferences.Config; + +import javax.annotation.Nullable; + +/** + * An artifact from Maven + * @param group The artifact group + * @param artifact The artifact to get + * @param version The artifact version, may be {@code null}, in which case the latest version should be used + */ +record Artifact(String group, String artifact, @Nullable String version) implements Comparable { + + /** + * Get the name of the jar file that will be saved to disk + * @return The jar name + */ + public String getLocalName() { + if (version() == null) { + return group() + '.' + artifact(); + } + return group() + '.' + artifact() + '-' + version() + ".jar"; + } + + /** + * Get the jar URL for this artifact + * @return The jar url + */ + public String jar() { + if (version == null) { + throw new IllegalStateException("jar cannot be called when no version is set"); + } + return getBaseUrl() + ".jar"; + } + + /** + * Get the pom for this artifact + * @return The pom + */ + public String pom() { + if (version == null) { + throw new IllegalStateException("pom cannot be called when no version is set"); + } + return getBaseUrl() + ".pom"; + } + + /** + * Get the URL for additional versions of the artifact + * @return The version URL + */ + public String versions() { + return baseUrl() + dotGroup() + '/' + artifact() + "/maven-metadata.xml"; + } + + private String getBaseUrl() { + final var dotGroup = dotGroup(); + return baseUrl() + dotGroup + '/' + artifact() + '/' + version() + '/' + artifact() + '-' + version(); + } + + private String baseUrl() { + return Config.getPref().get("imageio.nexus.url", "https://josm.openstreetmap.de/nexus/service/local/repositories/central/content/"); + } + + private String dotGroup() { + return group().replace(".", "/"); + } + + @Override + public int compareTo(Artifact o) { + final int gComp = group.compareTo(o.group); + if (gComp != 0) { + return gComp; + } + final int aComp = artifact.compareTo(o.artifact); + if (aComp != 0) { + return aComp; + } + if (version == null && o.version == null) { + return 0; + } + if (version == null) { + return -1; + } else if (o.version == null) { + return 1; + } + return version.compareTo(o.version); + } +} Index: /applications/editors/josm/plugins/imageio/src/main/java/org/openstreetmap/josm/plugins/imageio/ImageIOPlugin.java =================================================================== --- /applications/editors/josm/plugins/imageio/src/main/java/org/openstreetmap/josm/plugins/imageio/ImageIOPlugin.java (revision 36093) +++ /applications/editors/josm/plugins/imageio/src/main/java/org/openstreetmap/josm/plugins/imageio/ImageIOPlugin.java (revision 36093) @@ -0,0 +1,91 @@ +// License: GPL. For details, see LICENSE file. +// SPDX-License-Identifier: GPL-2.0-or-later +package org.openstreetmap.josm.plugins.imageio; + +import org.openstreetmap.josm.gui.MainApplication; +import org.openstreetmap.josm.gui.MapFrame; +import org.openstreetmap.josm.gui.preferences.PreferenceSetting; +import org.openstreetmap.josm.plugins.Plugin; +import org.openstreetmap.josm.plugins.PluginHandler; +import org.openstreetmap.josm.plugins.PluginInformation; +import org.openstreetmap.josm.spi.preferences.Config; + +import javax.imageio.ImageIO; +import java.io.UncheckedIOException; +import java.net.MalformedURLException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.TreeSet; + +/** + * The entry point for the plugin + */ +public final class ImageIOPlugin extends Plugin { + /** Used to check and see if we have ensured that the ImageIO plugins have been initialized */ + private static boolean initialized; + + /** + * Creates the plugin + * + * @param info the plugin information describing the plugin. + */ + public ImageIOPlugin(PluginInformation info) { + super(info); + initialize(false); + MainApplication.worker.submit(() -> NexusDownloader.setDownloadDirectory(this.getPluginDirs().getCacheDirectory(true))); + } + + @Override + public PreferenceSetting getPreferenceSetting() { + initialize(false); + return new ImageIOPreferenceSetting(() -> this.initialize(true)); + } + + @Override + public void mapFrameInitialized(MapFrame oldFrame, MapFrame newFrame) { + initialize(false); + super.mapFrameInitialized(oldFrame, newFrame); + } + + synchronized void initialize(boolean force) { + // This is why we cannot do the initialization in the constructor; it currently returns null until + // after the constructor is finished. + final var pluginLoader = PluginHandler.getPluginClassLoader(getPluginInformation().getName()); + if ((!initialized || force) && pluginLoader != null && !Config.getPref().getList("imageio.classpath").isEmpty()) { + final var urlList = Arrays.asList(pluginLoader.getURLs()); + final var loaded = new TreeSet<>(Config.getPref().getList("imageio.classpath")); + final var missing = new TreeSet(); + for (String classPath : loaded) { + final var path = Path.of(classPath); + if (!Files.isRegularFile(path)) { + missing.add(classPath); + continue; + } + try { + final var url = path.toUri().toURL(); + if (!urlList.contains(url)) { + pluginLoader.addURL(url); + } + } catch (MalformedURLException e) { + Config.getPref().put("imageio.classpath", null); // Reset since someone probably borked their config + throw new UncheckedIOException(e); + } + } + if (!missing.isEmpty()) { + loaded.removeAll(missing); + Config.getPref().putList("imageio.classpath", new ArrayList<>(loaded)); + } + final var currentLoader = Thread.currentThread().getContextClassLoader(); + + try { + Thread.currentThread().setContextClassLoader(pluginLoader); + ImageIO.scanForPlugins(); + } finally { + Thread.currentThread().setContextClassLoader(currentLoader); + } + initialized = true; + } + } +} Index: /applications/editors/josm/plugins/imageio/src/main/java/org/openstreetmap/josm/plugins/imageio/ImageIOPreferenceSetting.java =================================================================== --- /applications/editors/josm/plugins/imageio/src/main/java/org/openstreetmap/josm/plugins/imageio/ImageIOPreferenceSetting.java (revision 36093) +++ /applications/editors/josm/plugins/imageio/src/main/java/org/openstreetmap/josm/plugins/imageio/ImageIOPreferenceSetting.java (revision 36093) @@ -0,0 +1,97 @@ +// License: GPL. For details, see LICENSE file. +// SPDX-License-Identifier: GPL-2.0-or-later +package org.openstreetmap.josm.plugins.imageio; + +import org.openstreetmap.josm.gui.MainApplication; +import org.openstreetmap.josm.gui.preferences.PreferenceTabbedPane; +import org.openstreetmap.josm.gui.preferences.SubPreferenceSetting; +import org.openstreetmap.josm.gui.preferences.TabPreferenceSetting; +import org.openstreetmap.josm.spi.preferences.Config; +import org.openstreetmap.josm.tools.GBC; + +import javax.imageio.ImageIO; +import javax.swing.JCheckBox; +import javax.swing.JLabel; +import javax.swing.JPanel; +import javax.swing.JScrollPane; +import javax.swing.JSeparator; +import java.awt.GridBagLayout; +import java.util.ArrayList; +import java.util.Set; +import java.util.TreeSet; + +import static org.openstreetmap.josm.tools.I18n.tr; + +/** + * The preferences class for the {@link ImageIOPlugin} + */ +final class ImageIOPreferenceSetting implements SubPreferenceSetting { + private final Set imagePlugins = new TreeSet<>(); + private final Runnable callback; + + ImageIOPreferenceSetting(Runnable callback) { + this.callback = callback; + } + + @Override + public void addGui(PreferenceTabbedPane gui) { + final var panel = new JPanel(new GridBagLayout()); + panel.add(new JLabel("

" + + tr("Enable or disable additional image formats. Disabling an image format requires a restart.") + + "

"), + GBC.eol().anchor(GBC.PAGE_START).insets(5, 5, 5, 5).fill(GBC.HORIZONTAL)); + panel.add(new JSeparator(JSeparator.HORIZONTAL), GBC.eol()); + final var checkboxes = new JPanel(new GridBagLayout()); + panel.add(new JScrollPane(checkboxes), GBC.eol().fill(GBC.BOTH)); + addWebPPanel(checkboxes); + // Used to force the panel to put the checkboxes at the top of the screen. + // There is probably a better way, but I don't know it off the top of my head. + checkboxes.add(new JLabel(""), GBC.eol().fill(GBC.BOTH)); + + getTabPreferenceSetting(gui).addSubTab(this, tr("ImageIO"), panel); + } + + private void addWebPPanel(JPanel panel) { + final var webp = new Artifact("com.twelvemonkeys.imageio", "imageio-webp", null); + final var webpCheck = new JCheckBox(tr("webp (recommended, implementation provided by TwelveMonkeys, BSD-3-Clause)")); + final var webpIterator = ImageIO.getImageReadersByFormatName("WEBP"); + webpCheck.setSelected(webpIterator.hasNext() + && "com.twelvemonkeys.imageio.plugins.webp.WebPImageReader" + .equals(webpIterator.next().getClass().getCanonicalName())); + if (webpCheck.isSelected()) { + imagePlugins.add(webp); + } + webpCheck.addActionListener(l -> { + if (webpCheck.isSelected()) { + imagePlugins.add(webp); + } else { + imagePlugins.remove(webp); + } + }); + panel.add(webpCheck, GBC.eol().anchor(GBC.PAGE_START)); + } + + @Override + public boolean ok() { + final var classPath = new TreeSet(); + for (var artifact : imagePlugins) { + classPath.addAll(NexusDownloader.download(artifact)); + } + final var oldConfig = new TreeSet<>(Config.getPref().getList("imageio.classpath")); + if (Config.getPref().putList("imageio.classpath", new ArrayList<>(classPath))) { + MainApplication.worker.execute(this.callback); + } + // If the user removed an ImageIO plugin, they need to restart to actually remove it. + return !classPath.containsAll(oldConfig); + } + + @Override + public boolean isExpert() { + return false; + } + + @Override + public TabPreferenceSetting getTabPreferenceSetting(PreferenceTabbedPane gui) { + return gui.getImageryPreference(); + } +} Index: /applications/editors/josm/plugins/imageio/src/main/java/org/openstreetmap/josm/plugins/imageio/NexusDownloader.java =================================================================== --- /applications/editors/josm/plugins/imageio/src/main/java/org/openstreetmap/josm/plugins/imageio/NexusDownloader.java (revision 36093) +++ /applications/editors/josm/plugins/imageio/src/main/java/org/openstreetmap/josm/plugins/imageio/NexusDownloader.java (revision 36093) @@ -0,0 +1,325 @@ +// License: GPL. For details, see LICENSE file. +// SPDX-License-Identifier: GPL-2.0-or-later +package org.openstreetmap.josm.plugins.imageio; + +import org.apache.commons.jcs3.access.CacheAccess; +import org.openstreetmap.josm.data.cache.JCSCacheManager; +import org.openstreetmap.josm.spi.preferences.Config; +import org.openstreetmap.josm.tools.HttpClient; +import org.openstreetmap.josm.tools.JosmRuntimeException; +import org.openstreetmap.josm.tools.Logging; +import org.openstreetmap.josm.tools.Utils; +import org.openstreetmap.josm.tools.XmlUtils; +import org.xml.sax.Attributes; +import org.xml.sax.SAXException; +import org.xml.sax.helpers.DefaultHandler; + +import javax.xml.parsers.ParserConfigurationException; +import java.io.ByteArrayInputStream; +import java.io.File; +import java.io.IOException; +import java.io.UncheckedIOException; +import java.net.MalformedURLException; +import java.net.URI; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.attribute.FileTime; +import java.security.DigestInputStream; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.List; +import java.util.Set; +import java.util.TreeSet; +import java.util.concurrent.TimeUnit; +import java.util.stream.Collectors; + +/** + * Download files from JOSM nexus + */ +final class NexusDownloader { + private record ResponseHeader(String etag, long size, long lastModified) {} + private NexusDownloader() { + // Hide constructor + } + + private static final CacheAccess CACHED_RESPONSES_HEAD = JCSCacheManager.getCache("imageio.maven.head", + 100, 0, null); + private static final CacheAccess CACHED_RESPONSES_GET = JCSCacheManager.getCache("imageio.maven.get", + 100, 0, null); + + static { + CACHED_RESPONSES_GET.getDefaultElementAttributes() + .setMaxLife(TimeUnit.SECONDS.toMillis(Config.getPref().getLong("mirror.maxtime", TimeUnit.DAYS.toSeconds(7)))); + } + + private static Path cacheDirectory; + + /** + * Set the download directory for the files + * @param cacheDirectory The directory to use + */ + static void setDownloadDirectory(File cacheDirectory) { + if (NexusDownloader.cacheDirectory != null) { + throw new IllegalStateException("setDownloadDirectory can only be called once!"); + } + NexusDownloader.cacheDirectory = cacheDirectory.getAbsoluteFile().toPath(); + } + + /** + * Download a maven artifact + * @param artifact The artifact to download + * @return A set of jars to add to the classpath + */ + static Set download(Artifact artifact) { + try { + if (artifact.version() == null) { + artifact = getLatest(artifact); + } + return new TreeSet<>(getDependencies(artifact)) + .stream().map(NexusDownloader::realDownload) + .collect(Collectors.toCollection(TreeSet::new)); + } catch (IOException e) { + throw new JosmRuntimeException(e); + } + } + + private static String realDownload(Artifact artifact) { + final Path output; + try { + if (artifact.version() == null) { + artifact = getLatest(artifact); + } + final var baseName = artifact.group() + '.' + artifact.artifact(); + output = NexusDownloader.cacheDirectory.resolve(artifact.getLocalName()); + + // Check if the file is already downloaded + final var jarUrl = URI.create(artifact.jar()).toURL(); + final var head = CACHED_RESPONSES_HEAD.get(artifact.jar(), () -> { + final var client = HttpClient.create(jarUrl, "HEAD"); + try { + final var response = client.connect(); + return new ResponseHeader(response.getHeaderField("ETag"), response.getContentLength(), response.getLastModified()); + } catch (IOException e) { + // We cannot put null in the cache + throw new UncheckedIOException(e); + } finally { + client.disconnect(); + } + }); + final var alreadyDownloaded = Files.exists(output) && head.size() == Files.size(output) + && Files.getLastModifiedTime(output).toMillis() == head.lastModified() + && checkETag(output, head.etag()); + + if (!alreadyDownloaded) { + final var client = HttpClient.create(jarUrl); + final var response = client.connect(); + try (var writer = Files.newOutputStream(output)) { + var is = response.getContent(); + is.transferTo(writer); + Files.setLastModifiedTime(output, FileTime.fromMillis(response.getLastModified())); + } + client.disconnect(); + } + // Now we can delete "old" versions of the artifact + try (var files = Files.walk(NexusDownloader.cacheDirectory)) { + files.filter(path -> path.startsWith(baseName) && !path.equals(output)) + .filter(Files::isWritable) + .filter(Files::isRegularFile) + .forEach(path -> { + try { + Files.deleteIfExists(path); + } catch (IOException e) { + throw new UncheckedIOException(e); + } + }); + } + } catch (IOException exception) { + throw new JosmRuntimeException(exception); + } + return output.toString(); + } + + /** + * If the etag matches a well-known hash pattern, check that the file content matches + * @param path The path to hash + * @param etag The ETag to check the path against + * @return {@code true} if the ETag is not a well-known hash pattern or the file matches the expected hash. + */ + private static boolean checkETag(Path path, String etag) { + final MessageDigest md; + final String expected; + if (etag.startsWith("\"") && etag.endsWith("\"")) { + etag = etag.substring(1, etag.length() - 1); + } + if (etag.startsWith("{SHA1{")) { + try { + md = MessageDigest.getInstance("SHA-1"); + expected = etag.substring("{SHA1{".length(), etag.length() - 2); + } catch (NoSuchAlgorithmException e) { + // Realistically, we shouldn't hit this. But if we do, maybe SHA1 has been removed, and hopefully + // etags use something else. + throw new JosmRuntimeException(e); + } + } else { + return true; + } + try (var is = Files.newInputStream(path); + var dis = new DigestInputStream(is, md)) { + final var tByte = new byte[4096]; + while (dis.readNBytes(tByte, 0, tByte.length) > 0) { + // We need to read the bytes... + } + } catch (IOException e) { + Logging.error(e); + return false; // Assume that the file is corrupted + } + return expected.equals(Utils.toHexString(md.digest())); + } + + /** + * Get the dependencies from a pom + * @param artifact The artifact to use + * @return The jars to add to the classpath + * @throws MalformedURLException if the pom string is not a valid URL + * @throws IOException if there is a read error + */ + private static Set getDependencies(Artifact artifact) throws IOException { + final var url = URI.create(artifact.pom()).toURL(); + final var text = CACHED_RESPONSES_GET.get(artifact.pom(), () -> { + final var client = HttpClient.create(url); + try { + return client.connect().fetchContent(); + } catch (IOException e) { + throw new UncheckedIOException(e); + } finally { + client.disconnect(); + } + }); + try (var is = new ByteArrayInputStream(text.getBytes(StandardCharsets.UTF_8))) { + var handler = new MavenDependenciesHandler(); + XmlUtils.newSafeSAXParser().parse(is, handler); + final var dependencies = new TreeSet<>(handler.dependencies); + dependencies.add(artifact); + for (var dependency : handler.dependencies) { + if (dependency.version() == null) { + dependency = getLatest(dependency); + } + dependencies.addAll(getDependencies(dependency)); + } + return dependencies; + } catch (ParserConfigurationException | SAXException e) { + throw new JosmRuntimeException(e); + } + } + + private static Artifact getLatest(Artifact artifact) throws IOException { + final var url = URI.create(artifact.versions()).toURL(); + final var text = CACHED_RESPONSES_GET.get(artifact.versions(), () -> { + final var client = HttpClient.create(url); + try { + return client.connect().fetchContent(); + } catch (IOException e) { + throw new UncheckedIOException(e); + } finally { + client.disconnect(); + } + }); + try (var is = new ByteArrayInputStream(text.getBytes(StandardCharsets.UTF_8))) { + final var handler = new MavenMetadataHandler(); + XmlUtils.newSafeSAXParser().parse(is, handler); + final var version = Utils.firstNotEmptyString(handler.release, handler.latest, + handler.versions.stream() + .filter(v -> !v.contains("rc") && !v.contains("b")) + .findFirst().orElse(artifact.version())); + return new Artifact(artifact.group(), artifact.artifact(), version); + } catch (ParserConfigurationException | SAXException e) { + throw new JosmRuntimeException(e); + } + } + + private static class MavenMetadataHandler extends DefaultHandler { + private final StringBuilder characters = new StringBuilder(); + private final List versions = new ArrayList<>(); + private String latest; + private String release; + + @Override + public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException { + super.startElement(uri, localName, qName, attributes); + this.characters.setLength(0); + } + + @Override + public void endElement(String uri, String localName, String qName) throws SAXException { + if ("latest".equals(qName)) { + this.latest = this.characters.toString(); + } else if ("release".equals(qName)) { + this.release = this.characters.toString(); + } else if ("version".equals(qName)) { + this.versions.add(this.characters.toString()); + } + } + + @Override + public void characters(char[] ch, int start, int length) throws SAXException { + super.characters(ch, start, length); + this.characters.append(ch, start, length); + } + } + + private static class MavenDependenciesHandler extends DefaultHandler { + private final List dependencies = new ArrayList<>(); + private final StringBuilder characters = new StringBuilder(); + private Artifact parent; + private String groupId; + private String artifactId; + private String version; + private String type; + private String scope; + @Override + public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException { + super.startElement(uri, localName, qName, attributes); + this.characters.setLength(0); + if ("dependency".equals(qName) || "parent".equals(qName)) { + this.groupId = null; + this.artifactId = null; + this.version = null; + this.type = null; + this.scope = null; + } + } + + @Override + public void endElement(String uri, String localName, String qName) throws SAXException { + super.endElement(uri, localName, qName); + if ("parent".equals(qName) && groupId != null && artifactId != null) { + this.parent = new Artifact(groupId, artifactId, version); + } else if ("dependency".equals(qName) && groupId != null && artifactId != null) { + if (!"test-jar".equals(this.type) && !"test".equals(this.scope) && !"provided".equals(this.scope)) { + dependencies.add(new Artifact(groupId, artifactId, version)); + } + } else if ("groupId".equals(qName)) { + this.groupId = this.characters.toString(); + if ("${project.groupId}".equals(this.groupId)) { + this.groupId = this.parent.group(); + } + } else if ("artifactId".equals(qName)) { + this.artifactId = this.characters.toString(); + } else if ("version".equals(qName)) { + this.version = this.characters.toString(); + } else if ("type".equals(qName)) { + this.type = this.characters.toString(); + } else if ("scope".equals(qName)) { + this.scope = this.characters.toString(); + } + } + + @Override + public void characters(char[] ch, int start, int length) throws SAXException { + super.characters(ch, start, length); + this.characters.append(ch, start, length); + } + } +}