001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.actions; 003 004import static org.openstreetmap.josm.gui.help.HelpUtil.ht; 005import static org.openstreetmap.josm.tools.I18n.tr; 006import static org.openstreetmap.josm.tools.I18n.trn; 007 008import java.awt.event.ActionEvent; 009import java.awt.event.KeyEvent; 010import java.io.BufferedReader; 011import java.io.File; 012import java.io.FilenameFilter; 013import java.io.IOException; 014import java.nio.charset.StandardCharsets; 015import java.nio.file.Files; 016import java.util.ArrayList; 017import java.util.Arrays; 018import java.util.Collection; 019import java.util.Collections; 020import java.util.HashSet; 021import java.util.LinkedHashSet; 022import java.util.LinkedList; 023import java.util.List; 024import java.util.Set; 025import java.util.regex.Matcher; 026import java.util.regex.Pattern; 027 028import javax.swing.JOptionPane; 029import javax.swing.SwingUtilities; 030import javax.swing.filechooser.FileFilter; 031 032import org.openstreetmap.josm.Main; 033import org.openstreetmap.josm.gui.HelpAwareOptionPane; 034import org.openstreetmap.josm.gui.PleaseWaitRunnable; 035import org.openstreetmap.josm.gui.help.HelpUtil; 036import org.openstreetmap.josm.gui.widgets.AbstractFileChooser; 037import org.openstreetmap.josm.io.AllFormatsImporter; 038import org.openstreetmap.josm.io.FileImporter; 039import org.openstreetmap.josm.io.OsmTransferException; 040import org.openstreetmap.josm.tools.MultiMap; 041import org.openstreetmap.josm.tools.Shortcut; 042import org.xml.sax.SAXException; 043 044/** 045 * Open a file chooser dialog and select a file to import. 046 * 047 * @author imi 048 * @since 1146 049 */ 050public class OpenFileAction extends DiskAccessAction { 051 052 /** 053 * The {@link ExtensionFileFilter} matching .url files 054 */ 055 public static final ExtensionFileFilter URL_FILE_FILTER = new ExtensionFileFilter("url", "url", tr("URL Files") + " (*.url)"); 056 057 /** 058 * Create an open action. The name is "Open a file". 059 */ 060 public OpenFileAction() { 061 super(tr("Open..."), "open", tr("Open a file."), 062 Shortcut.registerShortcut("system:open", tr("File: {0}", tr("Open...")), KeyEvent.VK_O, Shortcut.CTRL)); 063 putValue("help", ht("/Action/Open")); 064 } 065 066 @Override 067 public void actionPerformed(ActionEvent e) { 068 AbstractFileChooser fc = createAndOpenFileChooser(true, true, null); 069 if (fc == null) 070 return; 071 File[] files = fc.getSelectedFiles(); 072 OpenFileTask task = new OpenFileTask(Arrays.asList(files), fc.getFileFilter()); 073 task.setRecordHistory(true); 074 Main.worker.submit(task); 075 } 076 077 @Override 078 protected void updateEnabledState() { 079 setEnabled(true); 080 } 081 082 /** 083 * Open a list of files. The complete list will be passed to batch importers. 084 * Filenames will not be saved in history. 085 * @param fileList A list of files 086 */ 087 public static void openFiles(List<File> fileList) { 088 openFiles(fileList, false); 089 } 090 091 /** 092 * Open a list of files. The complete list will be passed to batch importers. 093 * @param fileList A list of files 094 * @param recordHistory {@code true} to save filename in history (default: false) 095 */ 096 public static void openFiles(List<File> fileList, boolean recordHistory) { 097 OpenFileTask task = new OpenFileTask(fileList, null); 098 task.setRecordHistory(recordHistory); 099 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 // do nothing 180 } 181 182 protected void alertFilesNotMatchingWithImporter(Collection<File> files, FileImporter importer) { 183 final StringBuilder msg = new StringBuilder(); 184 msg.append("<html>").append( 185 trn( 186 "Cannot open {0} file with the file importer ''{1}''.", 187 "Cannot open {0} files with the file importer ''{1}''.", 188 files.size(), 189 files.size(), 190 importer.filter.getDescription() 191 ) 192 ).append("<br><ul>"); 193 for (File f: files) { 194 msg.append("<li>").append(f.getAbsolutePath()).append("</li>"); 195 } 196 msg.append("</ul>"); 197 198 HelpAwareOptionPane.showMessageDialogInEDT( 199 Main.parent, 200 msg.toString(), 201 tr("Warning"), 202 JOptionPane.WARNING_MESSAGE, 203 HelpUtil.ht("/Action/Open#ImporterCantImportFiles") 204 ); 205 } 206 207 protected void alertFilesWithUnknownImporter(Collection<File> files) { 208 final StringBuilder msg = new StringBuilder(); 209 msg.append("<html>").append( 210 trn( 211 "Cannot open {0} file because file does not exist or no suitable file importer is available.", 212 "Cannot open {0} files because files do not exist or no suitable file importer is available.", 213 files.size(), 214 files.size() 215 ) 216 ).append("<br><ul>"); 217 for (File f: files) { 218 msg.append("<li>").append(f.getAbsolutePath()).append(" (<i>") 219 .append(f.exists() ? tr("no importer") : tr("does not exist")) 220 .append("</i>)</li>"); 221 } 222 msg.append("</ul>"); 223 224 HelpAwareOptionPane.showMessageDialogInEDT( 225 Main.parent, 226 msg.toString(), 227 tr("Warning"), 228 JOptionPane.WARNING_MESSAGE, 229 HelpUtil.ht("/Action/Open#MissingImporterForFiles") 230 ); 231 } 232 233 @Override 234 protected void realRun() throws SAXException, IOException, OsmTransferException { 235 if (files == null || files.isEmpty()) return; 236 237 /** 238 * Find the importer with the chosen file filter 239 */ 240 FileImporter chosenImporter = null; 241 if (fileFilter != null) { 242 for (FileImporter importer : ExtensionFileFilter.importers) { 243 if (fileFilter.equals(importer.filter)) { 244 chosenImporter = importer; 245 } 246 } 247 } 248 /** 249 * If the filter hasn't been changed in the dialog, chosenImporter is null now. 250 * When the filter has been set explicitly to AllFormatsImporter, treat this the same. 251 */ 252 if (chosenImporter instanceof AllFormatsImporter) { 253 chosenImporter = null; 254 } 255 getProgressMonitor().setTicksCount(files.size()); 256 257 if (chosenImporter != null) { 258 // The importer was explicitly chosen, so use it. 259 List<File> filesNotMatchingWithImporter = new LinkedList<>(); 260 List<File> filesMatchingWithImporter = new LinkedList<>(); 261 for (final File f : files) { 262 if (!chosenImporter.acceptFile(f)) { 263 if (f.isDirectory()) { 264 SwingUtilities.invokeLater(new Runnable() { 265 @Override 266 public void run() { 267 JOptionPane.showMessageDialog(Main.parent, tr( 268 "<html>Cannot open directory ''{0}''.<br>Please select a file.</html>", 269 f.getAbsolutePath()), tr("Open file"), JOptionPane.ERROR_MESSAGE); 270 } 271 }); 272 // TODO when changing to Java 6: Don't cancel the 273 // task here but use different modality. (Currently 2 dialogs 274 // would block each other.) 275 return; 276 } else { 277 filesNotMatchingWithImporter.add(f); 278 } 279 } else { 280 filesMatchingWithImporter.add(f); 281 } 282 } 283 284 if (!filesNotMatchingWithImporter.isEmpty()) { 285 alertFilesNotMatchingWithImporter(filesNotMatchingWithImporter, chosenImporter); 286 } 287 if (!filesMatchingWithImporter.isEmpty()) { 288 importData(chosenImporter, filesMatchingWithImporter); 289 } 290 } else { 291 // find appropriate importer 292 MultiMap<FileImporter, File> importerMap = new MultiMap<>(); 293 List<File> filesWithUnknownImporter = new LinkedList<>(); 294 List<File> urlFiles = new LinkedList<>(); 295 FILES: for (File f : files) { 296 for (FileImporter importer : ExtensionFileFilter.importers) { 297 if (importer.acceptFile(f)) { 298 importerMap.put(importer, f); 299 continue FILES; 300 } 301 } 302 if (URL_FILE_FILTER.accept(f)) { 303 urlFiles.add(f); 304 } else { 305 filesWithUnknownImporter.add(f); 306 } 307 } 308 if (!filesWithUnknownImporter.isEmpty()) { 309 alertFilesWithUnknownImporter(filesWithUnknownImporter); 310 } 311 List<FileImporter> importers = new ArrayList<>(importerMap.keySet()); 312 Collections.sort(importers); 313 Collections.reverse(importers); 314 315 for (FileImporter importer : importers) { 316 importData(importer, new ArrayList<>(importerMap.get(importer))); 317 } 318 319 for (File urlFile: urlFiles) { 320 try (BufferedReader reader = Files.newBufferedReader(urlFile.toPath(), StandardCharsets.UTF_8)) { 321 String line; 322 while ((line = reader.readLine()) != null) { 323 Matcher m = Pattern.compile(".*(https?://.*)").matcher(line); 324 if (m.matches()) { 325 String url = m.group(1); 326 Main.main.menu.openLocation.openUrl(false, url); 327 } 328 } 329 } catch (Exception e) { 330 Main.error(e); 331 } 332 } 333 } 334 335 if (recordHistory) { 336 Collection<String> oldFileHistory = Main.pref.getCollection("file-open.history"); 337 fileHistory.addAll(oldFileHistory); 338 // remove the files which failed to load from the list 339 fileHistory.removeAll(failedAll); 340 int maxsize = Math.max(0, Main.pref.getInteger("file-open.history.max-size", 15)); 341 Main.pref.putCollectionBounded("file-open.history", maxsize, fileHistory); 342 } 343 } 344 345 /** 346 * Import data files with the given importer. 347 * @param importer file importer 348 * @param files data files to import 349 */ 350 public void importData(FileImporter importer, List<File> files) { 351 if (importer.isBatchImporter()) { 352 if (canceled) return; 353 String msg = trn("Opening {0} file...", "Opening {0} files...", files.size(), files.size()); 354 getProgressMonitor().setCustomText(msg); 355 getProgressMonitor().indeterminateSubTask(msg); 356 if (importer.importDataHandleExceptions(files, getProgressMonitor().createSubTaskMonitor(files.size(), false))) { 357 successfullyOpenedFiles.addAll(files); 358 } 359 } else { 360 for (File f : files) { 361 if (canceled) return; 362 getProgressMonitor().indeterminateSubTask(tr("Opening file ''{0}'' ...", f.getAbsolutePath())); 363 if (importer.importDataHandleExceptions(f, getProgressMonitor().createSubTaskMonitor(1, false))) { 364 successfullyOpenedFiles.add(f); 365 } 366 } 367 } 368 if (recordHistory && !importer.isBatchImporter()) { 369 for (File f : files) { 370 try { 371 if (successfullyOpenedFiles.contains(f)) { 372 fileHistory.add(f.getCanonicalPath()); 373 } else { 374 failedAll.add(f.getCanonicalPath()); 375 } 376 } catch (IOException e) { 377 Main.warn(e); 378 } 379 } 380 } 381 } 382 383 /** 384 * Replies the list of files that have been successfully opened. 385 * @return The list of files that have been successfully opened. 386 */ 387 public List<File> getSuccessfullyOpenedFiles() { 388 return successfullyOpenedFiles; 389 } 390 } 391}