source: josm/trunk/src/org/openstreetmap/josm/actions/ExtensionFileFilter.java@ 13350

Last change on this file since 13350 was 13350, checked in by stoecker, 6 years ago

see #15816 - add XZ support
  • Property svn:eol-style set to native
File size: 19.0 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.actions;
3
4import java.io.File;
5import java.util.ArrayList;
6import java.util.Arrays;
7import java.util.Collection;
8import java.util.Collections;
9import java.util.Comparator;
10import java.util.LinkedHashSet;
11import java.util.LinkedList;
12import java.util.List;
13import java.util.Objects;
14import java.util.ServiceConfigurationError;
15
16import javax.swing.filechooser.FileFilter;
17
18import org.openstreetmap.josm.gui.MainApplication;
19import org.openstreetmap.josm.gui.io.importexport.AllFormatsImporter;
20import org.openstreetmap.josm.gui.io.importexport.FileExporter;
21import org.openstreetmap.josm.gui.io.importexport.FileImporter;
22import org.openstreetmap.josm.gui.io.importexport.GpxImporter;
23import org.openstreetmap.josm.gui.io.importexport.JpgImporter;
24import org.openstreetmap.josm.gui.io.importexport.NMEAImporter;
25import org.openstreetmap.josm.gui.io.importexport.NoteImporter;
26import org.openstreetmap.josm.gui.io.importexport.OsmChangeImporter;
27import org.openstreetmap.josm.gui.io.importexport.OsmImporter;
28import org.openstreetmap.josm.gui.io.importexport.WMSLayerImporter;
29import org.openstreetmap.josm.gui.widgets.AbstractFileChooser;
30import org.openstreetmap.josm.io.session.SessionImporter;
31import org.openstreetmap.josm.tools.Logging;
32import org.openstreetmap.josm.tools.Utils;
33
34/**
35 * A file filter that filters after the extension. Also includes a list of file
36 * filters used in JOSM.
37 * @since 32
38 */
39public class ExtensionFileFilter extends FileFilter implements java.io.FileFilter {
40
41 /**
42 * List of supported formats for import.
43 * @since 4869
44 */
45 private static final ArrayList<FileImporter> importers;
46
47 /**
48 * List of supported formats for export.
49 * @since 4869
50 */
51 private static final ArrayList<FileExporter> exporters;
52
53 // add some file types only if the relevant classes are there.
54 // this gives us the option to painlessly drop them from the .jar
55 // and build JOSM versions without support for these formats
56
57 static {
58
59 importers = new ArrayList<>();
60
61 final List<Class<? extends FileImporter>> importerNames = Arrays.asList(
62 OsmImporter.class,
63 OsmChangeImporter.class,
64 GpxImporter.class,
65 NMEAImporter.class,
66 NoteImporter.class,
67 JpgImporter.class,
68 WMSLayerImporter.class,
69 AllFormatsImporter.class,
70 SessionImporter.class
71 );
72
73 for (final Class<? extends FileImporter> importerClass : importerNames) {
74 try {
75 FileImporter importer = importerClass.getConstructor().newInstance();
76 importers.add(importer);
77 } catch (ReflectiveOperationException e) {
78 Logging.debug(e);
79 } catch (ServiceConfigurationError e) {
80 // error seen while initializing WMSLayerImporter in plugin unit tests:
81 // -
82 // ServiceConfigurationError: javax.imageio.spi.ImageWriterSpi:
83 // Provider com.sun.media.imageioimpl.plugins.jpeg.CLibJPEGImageWriterSpi could not be instantiated
84 // Caused by: java.lang.IllegalArgumentException: vendorName == null!
85 // at javax.imageio.spi.IIOServiceProvider.<init>(IIOServiceProvider.java:76)
86 // at javax.imageio.spi.ImageReaderWriterSpi.<init>(ImageReaderWriterSpi.java:231)
87 // at javax.imageio.spi.ImageWriterSpi.<init>(ImageWriterSpi.java:213)
88 // at com.sun.media.imageioimpl.plugins.jpeg.CLibJPEGImageWriterSpi.<init>(CLibJPEGImageWriterSpi.java:84)
89 // -
90 // This is a very strange behaviour of JAI:
91 // http://thierrywasyl.wordpress.com/2009/07/24/jai-how-to-solve-vendorname-null-exception/
92 // -
93 // that can lead to various problems, see #8583 comments
94 Logging.error(e);
95 }
96 }
97
98 exporters = new ArrayList<>();
99
100 final List<Class<? extends FileExporter>> exporterClasses = Arrays.asList(
101 org.openstreetmap.josm.gui.io.importexport.GpxExporter.class,
102 org.openstreetmap.josm.gui.io.importexport.OsmExporter.class,
103 org.openstreetmap.josm.gui.io.importexport.OsmGzipExporter.class,
104 org.openstreetmap.josm.gui.io.importexport.OsmBzip2Exporter.class,
105 org.openstreetmap.josm.gui.io.importexport.GeoJSONExporter.class,
106 org.openstreetmap.josm.gui.io.importexport.WMSLayerExporter.class,
107 org.openstreetmap.josm.gui.io.importexport.NoteExporter.class,
108 org.openstreetmap.josm.gui.io.importexport.ValidatorErrorExporter.class
109 );
110
111 for (final Class<? extends FileExporter> exporterClass : exporterClasses) {
112 try {
113 FileExporter exporter = exporterClass.getConstructor().newInstance();
114 exporters.add(exporter);
115 MainApplication.getLayerManager().addAndFireActiveLayerChangeListener(exporter);
116 } catch (ReflectiveOperationException e) {
117 Logging.debug(e);
118 } catch (ServiceConfigurationError e) {
119 // see above in importers initialization
120 Logging.error(e);
121 }
122 }
123 }
124
125 private final String extensions;
126 private final String description;
127 private final String defaultExtension;
128
129 protected static void sort(List<ExtensionFileFilter> filters) {
130 filters.sort(new Comparator<ExtensionFileFilter>() {
131 private AllFormatsImporter all = new AllFormatsImporter();
132 @Override
133 public int compare(ExtensionFileFilter o1, ExtensionFileFilter o2) {
134 if (o1.getDescription().equals(all.filter.getDescription())) return 1;
135 if (o2.getDescription().equals(all.filter.getDescription())) return -1;
136 return o1.getDescription().compareTo(o2.getDescription());
137 }
138 }
139 );
140 }
141
142 /**
143 * Strategy to determine if extensions must be added to the description.
144 */
145 public enum AddArchiveExtension {
146 /** No extension is added */
147 NONE,
148 /** Only base extension is added */
149 BASE,
150 /** All extensions are added (base + archives) */
151 ALL
152 }
153
154 /**
155 * Adds a new file importer at the end of the global list. This importer will be evaluated after core ones.
156 * @param importer new file importer
157 * @since 10407
158 */
159 public static void addImporter(FileImporter importer) {
160 if (importer != null) {
161 importers.add(importer);
162 }
163 }
164
165 /**
166 * Adds a new file importer at the beginning of the global list. This importer will be evaluated before core ones.
167 * @param importer new file importer
168 * @since 10407
169 */
170 public static void addImporterFirst(FileImporter importer) {
171 if (importer != null) {
172 importers.add(0, importer);
173 }
174 }
175
176 /**
177 * Adds a new file exporter at the end of the global list. This exporter will be evaluated after core ones.
178 * @param exporter new file exporter
179 * @since 10407
180 */
181 public static void addExporter(FileExporter exporter) {
182 if (exporter != null) {
183 exporters.add(exporter);
184 }
185 }
186
187 /**
188 * Adds a new file exporter at the beginning of the global list. This exporter will be evaluated before core ones.
189 * @param exporter new file exporter
190 * @since 10407
191 */
192 public static void addExporterFirst(FileExporter exporter) {
193 if (exporter != null) {
194 exporters.add(0, exporter);
195 }
196 }
197
198 /**
199 * Returns the list of file importers.
200 * @return unmodifiable list of file importers
201 * @since 10407
202 */
203 public static List<FileImporter> getImporters() {
204 return Collections.unmodifiableList(importers);
205 }
206
207 /**
208 * Returns the list of file exporters.
209 * @return unmodifiable list of file exporters
210 * @since 10407
211 */
212 public static List<FileExporter> getExporters() {
213 return Collections.unmodifiableList(exporters);
214 }
215
216 /**
217 * Updates the {@link AllFormatsImporter} that is contained in the importers list. If
218 * you do not use the importers variable directly, you don't need to call this.
219 * <p>
220 * Updating the AllFormatsImporter is required when plugins add new importers that
221 * support new file extensions. The old AllFormatsImporter doesn't include the new
222 * extensions and thus will not display these files.
223 *
224 * @since 5131
225 */
226 public static void updateAllFormatsImporter() {
227 for (int i = 0; i < importers.size(); i++) {
228 if (importers.get(i) instanceof AllFormatsImporter) {
229 importers.set(i, new AllFormatsImporter());
230 }
231 }
232 }
233
234 /**
235 * Replies an ordered list of {@link ExtensionFileFilter}s for importing.
236 * The list is ordered according to their description, an {@link AllFormatsImporter}
237 * is append at the end.
238 *
239 * @return an ordered list of {@link ExtensionFileFilter}s for importing.
240 * @since 2029
241 */
242 public static List<ExtensionFileFilter> getImportExtensionFileFilters() {
243 updateAllFormatsImporter();
244 List<ExtensionFileFilter> filters = new LinkedList<>();
245 for (FileImporter importer : importers) {
246 filters.add(importer.filter);
247 }
248 sort(filters);
249 return filters;
250 }
251
252 /**
253 * Replies an ordered list of enabled {@link ExtensionFileFilter}s for exporting.
254 * The list is ordered according to their description, an {@link AllFormatsImporter}
255 * is append at the end.
256 *
257 * @return an ordered list of enabled {@link ExtensionFileFilter}s for exporting.
258 * @since 2029
259 */
260 public static List<ExtensionFileFilter> getExportExtensionFileFilters() {
261 List<ExtensionFileFilter> filters = new LinkedList<>();
262 for (FileExporter exporter : exporters) {
263 if (filters.contains(exporter.filter) || !exporter.isEnabled()) {
264 continue;
265 }
266 filters.add(exporter.filter);
267 }
268 sort(filters);
269 return filters;
270 }
271
272 /**
273 * Replies the default {@link ExtensionFileFilter} for a given extension
274 *
275 * @param extension the extension
276 * @return the default {@link ExtensionFileFilter} for a given extension
277 * @since 2029
278 */
279 public static ExtensionFileFilter getDefaultImportExtensionFileFilter(String extension) {
280 if (extension == null) return new AllFormatsImporter().filter;
281 for (FileImporter importer : importers) {
282 if (extension.equals(importer.filter.getDefaultExtension()))
283 return importer.filter;
284 }
285 return new AllFormatsImporter().filter;
286 }
287
288 /**
289 * Replies the default {@link ExtensionFileFilter} for a given extension
290 *
291 * @param extension the extension
292 * @return the default {@link ExtensionFileFilter} for a given extension
293 * @since 2029
294 */
295 public static ExtensionFileFilter getDefaultExportExtensionFileFilter(String extension) {
296 if (extension == null) return new AllFormatsImporter().filter;
297 for (FileExporter exporter : exporters) {
298 if (extension.equals(exporter.filter.getDefaultExtension()))
299 return exporter.filter;
300 }
301 // if extension did not match defaultExtension of any exporter,
302 // scan all supported extensions
303 File file = new File("file." + extension);
304 for (FileExporter exporter : exporters) {
305 if (exporter.filter.accept(file))
306 return exporter.filter;
307 }
308 return new AllFormatsImporter().filter;
309 }
310
311 /**
312 * Applies the choosable {@link FileFilter} to a {@link AbstractFileChooser} before using the
313 * file chooser for selecting a file for reading.
314 *
315 * @param fileChooser the file chooser
316 * @param extension the default extension
317 * @param allTypes If true, all the files types known by JOSM will be proposed in the "file type" combobox.
318 * If false, only the file filters that include {@code extension} will be proposed
319 * @since 5438
320 */
321 public static void applyChoosableImportFileFilters(AbstractFileChooser fileChooser, String extension, boolean allTypes) {
322 for (ExtensionFileFilter filter: getImportExtensionFileFilters()) {
323
324 if (allTypes || filter.acceptName("file."+extension)) {
325 fileChooser.addChoosableFileFilter(filter);
326 }
327 }
328 fileChooser.setFileFilter(getDefaultImportExtensionFileFilter(extension));
329 }
330
331 /**
332 * Applies the choosable {@link FileFilter} to a {@link AbstractFileChooser} before using the
333 * file chooser for selecting a file for writing.
334 *
335 * @param fileChooser the file chooser
336 * @param extension the default extension
337 * @param allTypes If true, all the files types known by JOSM will be proposed in the "file type" combobox.
338 * If false, only the file filters that include {@code extension} will be proposed
339 * @since 5438
340 */
341 public static void applyChoosableExportFileFilters(AbstractFileChooser fileChooser, String extension, boolean allTypes) {
342 for (ExtensionFileFilter filter: getExportExtensionFileFilters()) {
343 if (allTypes || filter.acceptName("file."+extension)) {
344 fileChooser.addChoosableFileFilter(filter);
345 }
346 }
347 fileChooser.setFileFilter(getDefaultExportExtensionFileFilter(extension));
348 }
349
350 /**
351 * Construct an extension file filter by giving the extension to check after.
352 * @param extension The comma-separated list of file extensions
353 * @param defaultExtension The default extension
354 * @param description A short textual description of the file type
355 * @since 1169
356 */
357 public ExtensionFileFilter(String extension, String defaultExtension, String description) {
358 this.extensions = extension;
359 this.defaultExtension = defaultExtension;
360 this.description = description;
361 }
362
363 /**
364 * Construct an extension file filter with the extensions supported by {@link org.openstreetmap.josm.io.Compression}
365 * automatically added to the {@code extensions}. The specified {@code extensions} will be added to the description
366 * in the form {@code old-description (*.ext1, *.ext2)}.
367 * @param extensions The comma-separated list of file extensions
368 * @param defaultExtension The default extension
369 * @param description A short textual description of the file type without supported extensions in parentheses
370 * @param addArchiveExtension Whether to also add the archive extensions to the description
371 * @param archiveExtensions List of extensions to be added
372 * @return The constructed filter
373 */
374 public static ExtensionFileFilter newFilterWithArchiveExtensions(String extensions, String defaultExtension,
375 String description, AddArchiveExtension addArchiveExtension, List<String> archiveExtensions) {
376 final Collection<String> extensionsPlusArchive = new LinkedHashSet<>();
377 final Collection<String> extensionsForDescription = new LinkedHashSet<>();
378 for (String e : extensions.split(",")) {
379 extensionsPlusArchive.add(e);
380 if (addArchiveExtension != AddArchiveExtension.NONE) {
381 extensionsForDescription.add("*." + e);
382 }
383 for (String extension : archiveExtensions) {
384 extensionsPlusArchive.add(e + '.' + extension);
385 if (addArchiveExtension == AddArchiveExtension.ALL) {
386 extensionsForDescription.add("*." + e + '.' + extension);
387 }
388 }
389 }
390 return new ExtensionFileFilter(
391 Utils.join(",", extensionsPlusArchive),
392 defaultExtension,
393 description + (!extensionsForDescription.isEmpty()
394 ? (" (" + Utils.join(", ", extensionsForDescription) + ')')
395 : "")
396 );
397 }
398
399 /**
400 * Construct an extension file filter with the extensions supported by {@link org.openstreetmap.josm.io.Compression}
401 * automatically added to the {@code extensions}. The specified {@code extensions} will be added to the description
402 * in the form {@code old-description (*.ext1, *.ext2)}.
403 * @param extensions The comma-separated list of file extensions
404 * @param defaultExtension The default extension
405 * @param description A short textual description of the file type without supported extensions in parentheses
406 * @param addArchiveExtensionsToDescription Whether to also add the archive extensions to the description
407 * @return The constructed filter
408 */
409 public static ExtensionFileFilter newFilterWithArchiveExtensions(
410 String extensions, String defaultExtension, String description, boolean addArchiveExtensionsToDescription) {
411
412 List<String> archiveExtensions = Arrays.asList("gz", "bz", "bz2", "xz", "zip");
413 return newFilterWithArchiveExtensions(
414 extensions,
415 defaultExtension,
416 description,
417 addArchiveExtensionsToDescription ? AddArchiveExtension.ALL : AddArchiveExtension.BASE,
418 archiveExtensions
419 );
420 }
421
422 /**
423 * Returns true if this file filter accepts the given filename.
424 * @param filename The filename to check after
425 * @return true if this file filter accepts the given filename (i.e if this filename ends with one of the extensions)
426 * @since 1169
427 */
428 public boolean acceptName(String filename) {
429 return Utils.hasExtension(filename, extensions.split(","));
430 }
431
432 @Override
433 public boolean accept(File pathname) {
434 if (pathname.isDirectory())
435 return true;
436 return acceptName(pathname.getName());
437 }
438
439 @Override
440 public String getDescription() {
441 return description;
442 }
443
444 /**
445 * Replies the comma-separated list of file extensions of this file filter.
446 * @return the comma-separated list of file extensions of this file filter, as a String
447 * @since 5131
448 */
449 public String getExtensions() {
450 return extensions;
451 }
452
453 /**
454 * Replies the default file extension of this file filter.
455 * @return the default file extension of this file filter
456 * @since 2029
457 */
458 public String getDefaultExtension() {
459 return defaultExtension;
460 }
461
462 @Override
463 public int hashCode() {
464 return Objects.hash(extensions, description, defaultExtension);
465 }
466
467 @Override
468 public boolean equals(Object obj) {
469 if (this == obj) return true;
470 if (obj == null || getClass() != obj.getClass()) return false;
471 ExtensionFileFilter that = (ExtensionFileFilter) obj;
472 return Objects.equals(extensions, that.extensions) &&
473 Objects.equals(description, that.description) &&
474 Objects.equals(defaultExtension, that.defaultExtension);
475 }
476}
Note: See TracBrowser for help on using the repository browser.