source: josm/trunk/src/org/openstreetmap/josm/actions/OpenFileAction.java@ 9722

Last change on this file since 9722 was 9707, checked in by bastiK, 8 years ago

applied #12461 - fix NPE for session load (patch by kolesar)
  • Property svn:eol-style set to native
File size: 15.8 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.actions;
3
4import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
5import static org.openstreetmap.josm.tools.I18n.tr;
6import static org.openstreetmap.josm.tools.I18n.trn;
7
8import java.awt.event.ActionEvent;
9import java.awt.event.KeyEvent;
10import java.io.BufferedReader;
11import java.io.File;
12import java.io.FilenameFilter;
13import java.io.IOException;
14import java.nio.charset.StandardCharsets;
15import java.nio.file.Files;
16import java.util.ArrayList;
17import java.util.Arrays;
18import java.util.Collection;
19import java.util.Collections;
20import java.util.HashSet;
21import java.util.LinkedHashSet;
22import java.util.LinkedList;
23import java.util.List;
24import java.util.Set;
25import java.util.regex.Matcher;
26import java.util.regex.Pattern;
27
28import javax.swing.JOptionPane;
29import javax.swing.SwingUtilities;
30import javax.swing.filechooser.FileFilter;
31
32import org.openstreetmap.josm.Main;
33import org.openstreetmap.josm.gui.HelpAwareOptionPane;
34import org.openstreetmap.josm.gui.PleaseWaitRunnable;
35import org.openstreetmap.josm.gui.help.HelpUtil;
36import org.openstreetmap.josm.gui.widgets.AbstractFileChooser;
37import org.openstreetmap.josm.io.AllFormatsImporter;
38import org.openstreetmap.josm.io.FileImporter;
39import org.openstreetmap.josm.io.OsmTransferException;
40import org.openstreetmap.josm.tools.MultiMap;
41import org.openstreetmap.josm.tools.Shortcut;
42import org.xml.sax.SAXException;
43
44/**
45 * Open a file chooser dialog and select a file to import.
46 *
47 * @author imi
48 * @since 1146
49 */
50public class OpenFileAction extends DiskAccessAction {
51
52 /**
53 * The {@link ExtensionFileFilter} matching .url files
54 */
55 public static final ExtensionFileFilter URL_FILE_FILTER = new ExtensionFileFilter("url", "url", tr("URL Files") + " (*.url)");
56
57 /**
58 * Create an open action. The name is "Open a file".
59 */
60 public OpenFileAction() {
61 super(tr("Open..."), "open", tr("Open a file."),
62 Shortcut.registerShortcut("system:open", tr("File: {0}", tr("Open...")), KeyEvent.VK_O, Shortcut.CTRL));
63 putValue("help", ht("/Action/Open"));
64 }
65
66 @Override
67 public void actionPerformed(ActionEvent e) {
68 AbstractFileChooser fc = createAndOpenFileChooser(true, true, null);
69 if (fc == null)
70 return;
71 File[] files = fc.getSelectedFiles();
72 OpenFileTask task = new OpenFileTask(Arrays.asList(files), fc.getFileFilter());
73 task.setRecordHistory(true);
74 Main.worker.submit(task);
75 }
76
77 @Override
78 protected void updateEnabledState() {
79 setEnabled(true);
80 }
81
82 /**
83 * Open a list of files. The complete list will be passed to batch importers.
84 * Filenames will not be saved in history.
85 * @param fileList A list of files
86 */
87 public static void openFiles(List<File> fileList) {
88 openFiles(fileList, false);
89 }
90
91 /**
92 * Open a list of files. The complete list will be passed to batch importers.
93 * @param fileList A list of files
94 * @param recordHistory {@code true} to save filename in history (default: false)
95 */
96 public static void openFiles(List<File> fileList, boolean recordHistory) {
97 OpenFileTask task = new OpenFileTask(fileList, null);
98 task.setRecordHistory(recordHistory);
99 Main.worker.submit(task);
100 }
101
102 /**
103 * Task to open files.
104 */
105 public static class OpenFileTask extends PleaseWaitRunnable {
106 private final List<File> files;
107 private final List<File> successfullyOpenedFiles = new ArrayList<>();
108 private final Set<String> fileHistory = new LinkedHashSet<>();
109 private final Set<String> failedAll = new HashSet<>();
110 private final FileFilter fileFilter;
111 private boolean canceled;
112 private boolean recordHistory;
113
114 /**
115 * Constructs a new {@code OpenFileTask}.
116 * @param files files to open
117 * @param fileFilter file filter
118 * @param title message for the user
119 */
120 public OpenFileTask(final List<File> files, final FileFilter fileFilter, final String title) {
121 super(title, false /* don't ignore exception */);
122 this.fileFilter = fileFilter;
123 this.files = new ArrayList<>(files.size());
124 for (final File file : files) {
125 if (file.exists()) {
126 this.files.add(file);
127 } else if (file.getParentFile() != null) {
128 // try to guess an extension using the specified fileFilter
129 final File[] matchingFiles = file.getParentFile().listFiles(new FilenameFilter() {
130 @Override
131 public boolean accept(File dir, String name) {
132 return name.startsWith(file.getName())
133 && fileFilter != null && fileFilter.accept(new File(dir, name));
134 }
135 });
136 if (matchingFiles != null && matchingFiles.length == 1) {
137 // use the unique match as filename
138 this.files.add(matchingFiles[0]);
139 } else {
140 // add original filename for error reporting later on
141 this.files.add(file);
142 }
143 }
144 }
145 }
146
147 /**
148 * Constructs a new {@code OpenFileTask}.
149 * @param files files to open
150 * @param fileFilter file filter
151 */
152 public OpenFileTask(List<File> files, FileFilter fileFilter) {
153 this(files, fileFilter, tr("Opening files"));
154 }
155
156 /**
157 * Sets whether to save filename in history (for list of recently opened files).
158 * @param recordHistory {@code true} to save filename in history (default: false)
159 */
160 public void setRecordHistory(boolean recordHistory) {
161 this.recordHistory = recordHistory;
162 }
163
164 /**
165 * Determines if filename must be saved in history (for list of recently opened files).
166 * @return {@code true} if filename must be saved in history
167 */
168 public boolean isRecordHistory() {
169 return recordHistory;
170 }
171
172 @Override
173 protected void cancel() {
174 this.canceled = true;
175 }
176
177 @Override
178 protected void finish() {
179 if (Main.map != null) {
180 Main.map.repaint();
181 }
182 }
183
184 protected void alertFilesNotMatchingWithImporter(Collection<File> files, FileImporter importer) {
185 final StringBuilder msg = new StringBuilder();
186 msg.append("<html>").append(
187 trn(
188 "Cannot open {0} file with the file importer ''{1}''.",
189 "Cannot open {0} files with the file importer ''{1}''.",
190 files.size(),
191 files.size(),
192 importer.filter.getDescription()
193 )
194 ).append("<br><ul>");
195 for (File f: files) {
196 msg.append("<li>").append(f.getAbsolutePath()).append("</li>");
197 }
198 msg.append("</ul>");
199
200 HelpAwareOptionPane.showMessageDialogInEDT(
201 Main.parent,
202 msg.toString(),
203 tr("Warning"),
204 JOptionPane.WARNING_MESSAGE,
205 HelpUtil.ht("/Action/Open#ImporterCantImportFiles")
206 );
207 }
208
209 protected void alertFilesWithUnknownImporter(Collection<File> files) {
210 final StringBuilder msg = new StringBuilder();
211 msg.append("<html>").append(
212 trn(
213 "Cannot open {0} file because file does not exist or no suitable file importer is available.",
214 "Cannot open {0} files because files do not exist or no suitable file importer is available.",
215 files.size(),
216 files.size()
217 )
218 ).append("<br><ul>");
219 for (File f: files) {
220 msg.append("<li>").append(f.getAbsolutePath()).append(" (<i>")
221 .append(f.exists() ? tr("no importer") : tr("does not exist"))
222 .append("</i>)</li>");
223 }
224 msg.append("</ul>");
225
226 HelpAwareOptionPane.showMessageDialogInEDT(
227 Main.parent,
228 msg.toString(),
229 tr("Warning"),
230 JOptionPane.WARNING_MESSAGE,
231 HelpUtil.ht("/Action/Open#MissingImporterForFiles")
232 );
233 }
234
235 @Override
236 protected void realRun() throws SAXException, IOException, OsmTransferException {
237 if (files == null || files.isEmpty()) return;
238
239 /**
240 * Find the importer with the chosen file filter
241 */
242 FileImporter chosenImporter = null;
243 if (fileFilter != null) {
244 for (FileImporter importer : ExtensionFileFilter.importers) {
245 if (fileFilter.equals(importer.filter)) {
246 chosenImporter = importer;
247 }
248 }
249 }
250 /**
251 * If the filter hasn't been changed in the dialog, chosenImporter is null now.
252 * When the filter has been set explicitly to AllFormatsImporter, treat this the same.
253 */
254 if (chosenImporter instanceof AllFormatsImporter) {
255 chosenImporter = null;
256 }
257 getProgressMonitor().setTicksCount(files.size());
258
259 if (chosenImporter != null) {
260 // The importer was explicitly chosen, so use it.
261 List<File> filesNotMatchingWithImporter = new LinkedList<>();
262 List<File> filesMatchingWithImporter = new LinkedList<>();
263 for (final File f : files) {
264 if (!chosenImporter.acceptFile(f)) {
265 if (f.isDirectory()) {
266 SwingUtilities.invokeLater(new Runnable() {
267 @Override
268 public void run() {
269 JOptionPane.showMessageDialog(Main.parent, tr(
270 "<html>Cannot open directory ''{0}''.<br>Please select a file.</html>",
271 f.getAbsolutePath()), tr("Open file"), JOptionPane.ERROR_MESSAGE);
272 }
273 });
274 // TODO when changing to Java 6: Don't cancel the
275 // task here but use different modality. (Currently 2 dialogs
276 // would block each other.)
277 return;
278 } else {
279 filesNotMatchingWithImporter.add(f);
280 }
281 } else {
282 filesMatchingWithImporter.add(f);
283 }
284 }
285
286 if (!filesNotMatchingWithImporter.isEmpty()) {
287 alertFilesNotMatchingWithImporter(filesNotMatchingWithImporter, chosenImporter);
288 }
289 if (!filesMatchingWithImporter.isEmpty()) {
290 importData(chosenImporter, filesMatchingWithImporter);
291 }
292 } else {
293 // find appropriate importer
294 MultiMap<FileImporter, File> importerMap = new MultiMap<>();
295 List<File> filesWithUnknownImporter = new LinkedList<>();
296 List<File> urlFiles = new LinkedList<>();
297 FILES: for (File f : files) {
298 for (FileImporter importer : ExtensionFileFilter.importers) {
299 if (importer.acceptFile(f)) {
300 importerMap.put(importer, f);
301 continue FILES;
302 }
303 }
304 if (URL_FILE_FILTER.accept(f)) {
305 urlFiles.add(f);
306 } else {
307 filesWithUnknownImporter.add(f);
308 }
309 }
310 if (!filesWithUnknownImporter.isEmpty()) {
311 alertFilesWithUnknownImporter(filesWithUnknownImporter);
312 }
313 List<FileImporter> importers = new ArrayList<>(importerMap.keySet());
314 Collections.sort(importers);
315 Collections.reverse(importers);
316
317 for (FileImporter importer : importers) {
318 importData(importer, new ArrayList<>(importerMap.get(importer)));
319 }
320
321 for (File urlFile: urlFiles) {
322 try (BufferedReader reader = Files.newBufferedReader(urlFile.toPath(), StandardCharsets.UTF_8)) {
323 String line;
324 while ((line = reader.readLine()) != null) {
325 Matcher m = Pattern.compile(".*(https?://.*)").matcher(line);
326 if (m.matches()) {
327 String url = m.group(1);
328 Main.main.menu.openLocation.openUrl(false, url);
329 }
330 }
331 } catch (Exception e) {
332 Main.error(e);
333 }
334 }
335 }
336
337 if (recordHistory) {
338 Collection<String> oldFileHistory = Main.pref.getCollection("file-open.history");
339 fileHistory.addAll(oldFileHistory);
340 // remove the files which failed to load from the list
341 fileHistory.removeAll(failedAll);
342 int maxsize = Math.max(0, Main.pref.getInteger("file-open.history.max-size", 15));
343 Main.pref.putCollectionBounded("file-open.history", maxsize, fileHistory);
344 }
345 }
346
347 /**
348 * Import data files with the given importer.
349 * @param importer file importer
350 * @param files data files to import
351 */
352 public void importData(FileImporter importer, List<File> files) {
353 if (importer.isBatchImporter()) {
354 if (canceled) return;
355 String msg = trn("Opening {0} file...", "Opening {0} files...", files.size(), files.size());
356 getProgressMonitor().setCustomText(msg);
357 getProgressMonitor().indeterminateSubTask(msg);
358 if (importer.importDataHandleExceptions(files, getProgressMonitor().createSubTaskMonitor(files.size(), false))) {
359 successfullyOpenedFiles.addAll(files);
360 }
361 } else {
362 for (File f : files) {
363 if (canceled) return;
364 getProgressMonitor().indeterminateSubTask(tr("Opening file ''{0}'' ...", f.getAbsolutePath()));
365 if (importer.importDataHandleExceptions(f, getProgressMonitor().createSubTaskMonitor(1, false))) {
366 successfullyOpenedFiles.add(f);
367 }
368 }
369 }
370 if (recordHistory && !importer.isBatchImporter()) {
371 for (File f : files) {
372 try {
373 if (successfullyOpenedFiles.contains(f)) {
374 fileHistory.add(f.getCanonicalPath());
375 } else {
376 failedAll.add(f.getCanonicalPath());
377 }
378 } catch (IOException e) {
379 Main.warn(e);
380 }
381 }
382 }
383 }
384
385 /**
386 * Replies the list of files that have been successfully opened.
387 * @return The list of files that have been successfully opened.
388 */
389 public List<File> getSuccessfullyOpenedFiles() {
390 return successfullyOpenedFiles;
391 }
392 }
393}
Note: See TracBrowser for help on using the repository browser.