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

Last change on this file since 8688 was 8390, checked in by Don-vip, 9 years ago

Sonar - various performance improvements
  • Property svn:eol-style set to native
File size: 14.6 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 * @param fileList A list of files
85 */
86 public static void openFiles(List<File> fileList) {
87 openFiles(fileList, false);
88 }
89
90 public static void openFiles(List<File> fileList, boolean recordHistory) {
91 OpenFileTask task = new OpenFileTask(fileList, null);
92 task.setRecordHistory(recordHistory);
93 Main.worker.submit(task);
94 }
95
96 public static class OpenFileTask extends PleaseWaitRunnable {
97 private final List<File> files;
98 private final List<File> successfullyOpenedFiles = new ArrayList<>();
99 private final Set<String> fileHistory = new LinkedHashSet<>();
100 private final Set<String> failedAll = new HashSet<>();
101 private final FileFilter fileFilter;
102 private boolean canceled;
103 private boolean recordHistory = false;
104
105 public OpenFileTask(final List<File> files, final FileFilter fileFilter, final String title) {
106 super(title, false /* don't ignore exception */);
107 this.fileFilter = fileFilter;
108 this.files = new ArrayList<>(files.size());
109 for (final File file : files) {
110 if (file.exists()) {
111 this.files.add(file);
112 } else {
113 // try to guess an extension using the specified fileFilter
114 final File[] matchingFiles = file.getParentFile().listFiles(new FilenameFilter() {
115 @Override
116 public boolean accept(File dir, String name) {
117 return name.startsWith(file.getName()) && fileFilter.accept(new File(dir, name));
118 }
119 });
120 if (matchingFiles != null && matchingFiles.length == 1) {
121 // use the unique match as filename
122 this.files.add(matchingFiles[0]);
123 } else {
124 // add original filename for error reporting later on
125 this.files.add(file);
126 }
127 }
128 }
129 }
130
131 public OpenFileTask(List<File> files, FileFilter fileFilter) {
132 this(files, fileFilter, tr("Opening files"));
133 }
134
135 /**
136 * save filename in history (for list of recently opened files)
137 * default: false
138 */
139 public void setRecordHistory(boolean recordHistory) {
140 this.recordHistory = recordHistory;
141 }
142
143 public boolean isRecordHistory() {
144 return recordHistory;
145 }
146
147 @Override
148 protected void cancel() {
149 this.canceled = true;
150 }
151
152 @Override
153 protected void finish() {
154 // do nothing
155 }
156
157 protected void alertFilesNotMatchingWithImporter(Collection<File> files, FileImporter importer) {
158 final StringBuilder msg = new StringBuilder();
159 msg.append("<html>").append(
160 trn(
161 "Cannot open {0} file with the file importer ''{1}''.",
162 "Cannot open {0} files with the file importer ''{1}''.",
163 files.size(),
164 files.size(),
165 importer.filter.getDescription()
166 )
167 ).append("<br><ul>");
168 for (File f: files) {
169 msg.append("<li>").append(f.getAbsolutePath()).append("</li>");
170 }
171 msg.append("</ul>");
172
173 HelpAwareOptionPane.showMessageDialogInEDT(
174 Main.parent,
175 msg.toString(),
176 tr("Warning"),
177 JOptionPane.WARNING_MESSAGE,
178 HelpUtil.ht("/Action/Open#ImporterCantImportFiles")
179 );
180 }
181
182 protected void alertFilesWithUnknownImporter(Collection<File> files) {
183 final StringBuilder msg = new StringBuilder();
184 msg.append("<html>").append(
185 trn(
186 "Cannot open {0} file because file does not exist or no suitable file importer is available.",
187 "Cannot open {0} files because files do not exist or no suitable file importer is available.",
188 files.size(),
189 files.size()
190 )
191 ).append("<br><ul>");
192 for (File f: files) {
193 msg.append("<li>").append(f.getAbsolutePath()).append(" (<i>")
194 .append(f.exists() ? tr("no importer") : tr("does not exist"))
195 .append("</i>)</li>");
196 }
197 msg.append("</ul>");
198
199 HelpAwareOptionPane.showMessageDialogInEDT(
200 Main.parent,
201 msg.toString(),
202 tr("Warning"),
203 JOptionPane.WARNING_MESSAGE,
204 HelpUtil.ht("/Action/Open#MissingImporterForFiles")
205 );
206 }
207
208 @Override
209 protected void realRun() throws SAXException, IOException, OsmTransferException {
210 if (files == null || files.isEmpty()) return;
211
212 /**
213 * Find the importer with the chosen file filter
214 */
215 FileImporter chosenImporter = null;
216 if (fileFilter != null) {
217 for (FileImporter importer : ExtensionFileFilter.importers) {
218 if (fileFilter.equals(importer.filter)) {
219 chosenImporter = importer;
220 }
221 }
222 }
223 /**
224 * If the filter hasn't been changed in the dialog, chosenImporter is null now.
225 * When the filter has been set explicitly to AllFormatsImporter, treat this the same.
226 */
227 if (chosenImporter instanceof AllFormatsImporter) {
228 chosenImporter = null;
229 }
230 getProgressMonitor().setTicksCount(files.size());
231
232 if (chosenImporter != null) {
233 // The importer was explicitly chosen, so use it.
234 List<File> filesNotMatchingWithImporter = new LinkedList<>();
235 List<File> filesMatchingWithImporter = new LinkedList<>();
236 for (final File f : files) {
237 if (!chosenImporter.acceptFile(f)) {
238 if (f.isDirectory()) {
239 SwingUtilities.invokeLater(new Runnable() {
240 @Override
241 public void run() {
242 JOptionPane.showMessageDialog(Main.parent, tr(
243 "<html>Cannot open directory ''{0}''.<br>Please select a file.</html>",
244 f.getAbsolutePath()), tr("Open file"), JOptionPane.ERROR_MESSAGE);
245 }
246 });
247 // TODO when changing to Java 6: Don't cancel the
248 // task here but use different modality. (Currently 2 dialogs
249 // would block each other.)
250 return;
251 } else {
252 filesNotMatchingWithImporter.add(f);
253 }
254 } else {
255 filesMatchingWithImporter.add(f);
256 }
257 }
258
259 if (!filesNotMatchingWithImporter.isEmpty()) {
260 alertFilesNotMatchingWithImporter(filesNotMatchingWithImporter, chosenImporter);
261 }
262 if (!filesMatchingWithImporter.isEmpty()) {
263 importData(chosenImporter, filesMatchingWithImporter);
264 }
265 } else {
266 // find appropriate importer
267 MultiMap<FileImporter, File> importerMap = new MultiMap<>();
268 List<File> filesWithUnknownImporter = new LinkedList<>();
269 List<File> urlFiles = new LinkedList<>();
270 FILES: for (File f : files) {
271 for (FileImporter importer : ExtensionFileFilter.importers) {
272 if (importer.acceptFile(f)) {
273 importerMap.put(importer, f);
274 continue FILES;
275 }
276 }
277 if (URL_FILE_FILTER.accept(f)) {
278 urlFiles.add(f);
279 } else {
280 filesWithUnknownImporter.add(f);
281 }
282 }
283 if (!filesWithUnknownImporter.isEmpty()) {
284 alertFilesWithUnknownImporter(filesWithUnknownImporter);
285 }
286 List<FileImporter> importers = new ArrayList<>(importerMap.keySet());
287 Collections.sort(importers);
288 Collections.reverse(importers);
289
290 for (FileImporter importer : importers) {
291 importData(importer, new ArrayList<>(importerMap.get(importer)));
292 }
293
294 for (File urlFile: urlFiles) {
295 try (BufferedReader reader = Files.newBufferedReader(urlFile.toPath(), StandardCharsets.UTF_8)) {
296 String line;
297 while ((line = reader.readLine()) != null) {
298 Matcher m = Pattern.compile(".*(https?://.*)").matcher(line);
299 if (m.matches()) {
300 String url = m.group(1);
301 Main.main.menu.openLocation.openUrl(false, url);
302 }
303 }
304 } catch (Exception e) {
305 Main.error(e);
306 }
307 }
308 }
309
310 if (recordHistory) {
311 Collection<String> oldFileHistory = Main.pref.getCollection("file-open.history");
312 fileHistory.addAll(oldFileHistory);
313 // remove the files which failed to load from the list
314 fileHistory.removeAll(failedAll);
315 int maxsize = Math.max(0, Main.pref.getInteger("file-open.history.max-size", 15));
316 Main.pref.putCollectionBounded("file-open.history", maxsize, fileHistory);
317 }
318 }
319
320 public void importData(FileImporter importer, List<File> files) {
321 if (importer.isBatchImporter()) {
322 if (canceled) return;
323 String msg = trn("Opening {0} file...", "Opening {0} files...", files.size(), files.size());
324 getProgressMonitor().setCustomText(msg);
325 getProgressMonitor().indeterminateSubTask(msg);
326 if (importer.importDataHandleExceptions(files, getProgressMonitor().createSubTaskMonitor(files.size(), false))) {
327 successfullyOpenedFiles.addAll(files);
328 }
329 } else {
330 for (File f : files) {
331 if (canceled) return;
332 getProgressMonitor().indeterminateSubTask(tr("Opening file ''{0}'' ...", f.getAbsolutePath()));
333 if (importer.importDataHandleExceptions(f, getProgressMonitor().createSubTaskMonitor(1, false))) {
334 successfullyOpenedFiles.add(f);
335 }
336 }
337 }
338 if (recordHistory && !importer.isBatchImporter()) {
339 for (File f : files) {
340 try {
341 if (successfullyOpenedFiles.contains(f)) {
342 fileHistory.add(f.getCanonicalPath());
343 } else {
344 failedAll.add(f.getCanonicalPath());
345 }
346 } catch (IOException e) {
347 Main.warn(e);
348 }
349 }
350 }
351 }
352
353 /**
354 * Replies the list of files that have been successfully opened.
355 * @return The list of files that have been successfully opened.
356 */
357 public List<File> getSuccessfullyOpenedFiles() {
358 return successfullyOpenedFiles;
359 }
360 }
361}
Note: See TracBrowser for help on using the repository browser.