source: josm/trunk/src/org/openstreetmap/josm/gui/layer/AutosaveTask.java@ 17181

Last change on this file since 17181 was 17181, checked in by simon04, 4 years ago

fix #19918 - AutosaveTask: sort files by modify time (patch by gaben, modified)
  • Property svn:eol-style set to native
File size: 19.6 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.layer;
3
4import static org.openstreetmap.josm.tools.I18n.marktr;
5import static org.openstreetmap.josm.tools.I18n.tr;
6import static org.openstreetmap.josm.tools.Utils.getSystemProperty;
7
8import java.io.BufferedReader;
9import java.io.File;
10import java.io.FileFilter;
11import java.io.IOException;
12import java.lang.management.ManagementFactory;
13import java.nio.charset.StandardCharsets;
14import java.nio.file.Files;
15import java.nio.file.Path;
16import java.util.ArrayList;
17import java.util.Arrays;
18import java.util.Collections;
19import java.util.Comparator;
20import java.util.Date;
21import java.util.Deque;
22import java.util.HashSet;
23import java.util.Iterator;
24import java.util.LinkedList;
25import java.util.List;
26import java.util.Locale;
27import java.util.Set;
28import java.util.Timer;
29import java.util.TimerTask;
30import java.util.concurrent.ExecutionException;
31import java.util.concurrent.Future;
32import java.util.concurrent.TimeUnit;
33import java.util.regex.Pattern;
34
35import org.openstreetmap.josm.actions.OpenFileAction.OpenFileTask;
36import org.openstreetmap.josm.data.Data;
37import org.openstreetmap.josm.data.osm.NoteData;
38import org.openstreetmap.josm.data.osm.NoteData.NoteDataUpdateListener;
39import org.openstreetmap.josm.data.osm.event.AbstractDatasetChangedEvent;
40import org.openstreetmap.josm.data.osm.event.DataSetListenerAdapter;
41import org.openstreetmap.josm.data.osm.event.DataSetListenerAdapter.Listener;
42import org.openstreetmap.josm.data.preferences.BooleanProperty;
43import org.openstreetmap.josm.data.preferences.IntegerProperty;
44import org.openstreetmap.josm.gui.MainApplication;
45import org.openstreetmap.josm.gui.Notification;
46import org.openstreetmap.josm.gui.io.importexport.NoteImporter;
47import org.openstreetmap.josm.gui.io.importexport.OsmImporter;
48import org.openstreetmap.josm.gui.layer.LayerManager.LayerAddEvent;
49import org.openstreetmap.josm.gui.layer.LayerManager.LayerChangeListener;
50import org.openstreetmap.josm.gui.layer.LayerManager.LayerOrderChangeEvent;
51import org.openstreetmap.josm.gui.layer.LayerManager.LayerRemoveEvent;
52import org.openstreetmap.josm.gui.util.GuiHelper;
53import org.openstreetmap.josm.spi.preferences.Config;
54import org.openstreetmap.josm.tools.Logging;
55import org.openstreetmap.josm.tools.Utils;
56
57/**
58 * Saves data and note layers periodically so they can be recovered in case of a crash.
59 *
60 * There are 2 directories
61 * - autosave dir: copies of the currently open data layers are saved here every
62 * PROP_INTERVAL seconds. When a data layer is closed normally, the corresponding
63 * files are removed. If this dir is non-empty on start, JOSM assumes
64 * that it crashed last time.
65 * - deleted layers dir: "secondary archive" - when autosaved layers are restored
66 * they are copied to this directory. We cannot keep them in the autosave folder,
67 * but just deleting it would be dangerous: Maybe a feature inside the file
68 * caused JOSM to crash. If the data is valuable, the user can still try to
69 * open with another versions of JOSM or fix the problem manually.
70 *
71 * The deleted layers dir keeps at most PROP_DELETED_LAYERS files.
72 *
73 * @since 3378 (creation)
74 * @since 10386 (new LayerChangeListener interface)
75 */
76public class AutosaveTask extends TimerTask implements LayerChangeListener, Listener, NoteDataUpdateListener {
77
78 private static final char[] ILLEGAL_CHARACTERS = {'/', '\n', '\r', '\t', '\0', '\f', '`', '?', '*', '\\', '<', '>', '|', '\"', ':'};
79 private static final String AUTOSAVE_DIR = "autosave";
80 private static final String DELETED_LAYERS_DIR = "autosave/deleted_layers";
81
82 /**
83 * If autosave is enabled
84 */
85 public static final BooleanProperty PROP_AUTOSAVE_ENABLED = new BooleanProperty("autosave.enabled", true);
86 /**
87 * The number of files to store per layer
88 */
89 public static final IntegerProperty PROP_FILES_PER_LAYER = new IntegerProperty("autosave.filesPerLayer", 1);
90 /**
91 * How many deleted layers should be stored
92 */
93 public static final IntegerProperty PROP_DELETED_LAYERS = new IntegerProperty("autosave.deletedLayersBackupCount", 5);
94 /**
95 * The autosave interval, in seconds
96 */
97 public static final IntegerProperty PROP_INTERVAL = new IntegerProperty("autosave.interval", (int) TimeUnit.MINUTES.toSeconds(5));
98 /**
99 * The maximum number of autosave files to store
100 */
101 public static final IntegerProperty PROP_INDEX_LIMIT = new IntegerProperty("autosave.index-limit", 1000);
102 /**
103 * Defines if a notification should be displayed after each autosave
104 */
105 public static final BooleanProperty PROP_NOTIFICATION = new BooleanProperty("autosave.notification", false);
106
107 protected static final class AutosaveLayerInfo<T extends AbstractModifiableLayer> {
108 private final T layer;
109 private String layerName;
110 private String layerFileName;
111 private final Deque<File> backupFiles = new LinkedList<>();
112
113 AutosaveLayerInfo(T layer) {
114 this.layer = layer;
115 }
116 }
117
118 private final DataSetListenerAdapter datasetAdapter = new DataSetListenerAdapter(this);
119 private final Set<Data> changedData = new HashSet<>();
120 private final List<AutosaveLayerInfo<?>> layersInfo = new ArrayList<>();
121 private final Object layersLock = new Object();
122 private final Deque<File> deletedLayers = new LinkedList<>();
123
124 private final File autosaveDir = new File(Config.getDirs().getUserDataDirectory(true), AUTOSAVE_DIR);
125 private final File deletedLayersDir = new File(Config.getDirs().getUserDataDirectory(true), DELETED_LAYERS_DIR);
126
127 /**
128 * Replies the autosave directory.
129 * @return the autosave directory
130 * @since 10299
131 */
132 public final Path getAutosaveDir() {
133 return autosaveDir.toPath();
134 }
135
136 /**
137 * Starts the autosave background task.
138 */
139 public void schedule() {
140 if (PROP_INTERVAL.get() > 0) {
141
142 if (!autosaveDir.exists() && !autosaveDir.mkdirs()) {
143 Logging.warn(tr("Unable to create directory {0}, autosave will be disabled", autosaveDir.getAbsolutePath()));
144 return;
145 }
146 if (!deletedLayersDir.exists() && !deletedLayersDir.mkdirs()) {
147 Logging.warn(tr("Unable to create directory {0}, autosave will be disabled", deletedLayersDir.getAbsolutePath()));
148 return;
149 }
150
151 File[] files = deletedLayersDir.listFiles();
152 if (files != null) {
153 try {
154 Arrays.sort(files, Comparator.comparingLong(File::lastModified));
155 } catch (Exception e) {
156 Logging.error(e);
157 }
158 deletedLayers.addAll(Arrays.asList(files));
159 }
160
161 new Timer(true).schedule(this, TimeUnit.SECONDS.toMillis(1), TimeUnit.SECONDS.toMillis(PROP_INTERVAL.get()));
162 MainApplication.getLayerManager().addAndFireLayerChangeListener(this);
163 }
164 }
165
166 private static String getFileName(String layerName, int index) {
167 String result = layerName;
168 for (char illegalCharacter : ILLEGAL_CHARACTERS) {
169 result = result.replaceAll(Pattern.quote(String.valueOf(illegalCharacter)),
170 '&' + String.valueOf((int) illegalCharacter) + ';');
171 }
172 if (index != 0) {
173 result = result + '_' + index;
174 }
175 return result;
176 }
177
178 private void setLayerFileName(AutosaveLayerInfo<?> layer) {
179 int index = 0;
180 while (true) {
181 String filename = getFileName(layer.layer.getName(), index);
182 boolean foundTheSame = layersInfo.stream().anyMatch(info -> info != layer && filename.equals(info.layerFileName));
183 if (!foundTheSame) {
184 layer.layerFileName = filename;
185 return;
186 }
187
188 index++;
189 }
190 }
191
192 protected File getNewLayerFile(AutosaveLayerInfo<?> layer, Date now, int startIndex) {
193 int index = startIndex;
194 while (true) {
195 String filename = String.format(Locale.ENGLISH, "%1$s_%2$tY%2$tm%2$td_%2$tH%2$tM%2$tS%2$tL%3$s",
196 layer.layerFileName, now, index == 0 ? "" : ('_' + Integer.toString(index)));
197 File result = new File(autosaveDir, filename + '.' +
198 (layer.layer instanceof NoteLayer ?
199 Config.getPref().get("autosave.notes.extension", "osn") :
200 Config.getPref().get("autosave.extension", "osm")));
201 try {
202 if (index > PROP_INDEX_LIMIT.get())
203 throw new IOException("index limit exceeded");
204 if (result.createNewFile()) {
205 createNewPidFile(autosaveDir, filename);
206 return result;
207 } else {
208 Logging.warn(tr("Unable to create file {0}, other filename will be used", result.getAbsolutePath()));
209 }
210 } catch (IOException e) {
211 Logging.log(Logging.LEVEL_ERROR, tr("IOError while creating file, autosave will be skipped: {0}", e.getMessage()), e);
212 return null;
213 }
214 index++;
215 }
216 }
217
218 private static void createNewPidFile(File autosaveDir, String filename) {
219 File pidFile = new File(autosaveDir, filename+".pid");
220 try {
221 final String content = ManagementFactory.getRuntimeMXBean().getName();
222 Files.write(pidFile.toPath(), Collections.singleton(content), StandardCharsets.UTF_8);
223 } catch (IOException | SecurityException t) {
224 Logging.error(t);
225 }
226 }
227
228 private void savelayer(AutosaveLayerInfo<?> info) {
229 if (!info.layer.getName().equals(info.layerName)) {
230 setLayerFileName(info);
231 info.layerName = info.layer.getName();
232 }
233 try {
234 Data data = info.layer.getData();
235 if (data != null && changedData.remove(data)) {
236 File file = getNewLayerFile(info, new Date(), 0);
237 if (file != null) {
238 info.backupFiles.add(file);
239 info.layer.autosave(file);
240 }
241 }
242 } catch (IOException e) {
243 Logging.error(e);
244 }
245 while (info.backupFiles.size() > PROP_FILES_PER_LAYER.get()) {
246 File oldFile = info.backupFiles.remove();
247 if (Utils.deleteFile(oldFile, marktr("Unable to delete old backup file {0}"))) {
248 Utils.deleteFile(getPidFile(oldFile), marktr("Unable to delete old backup file {0}"));
249 }
250 }
251 }
252
253 @Override
254 public void run() {
255 synchronized (layersLock) {
256 try {
257 for (AutosaveLayerInfo<?> info: layersInfo) {
258 savelayer(info);
259 }
260 changedData.clear();
261 if (PROP_NOTIFICATION.get() && !layersInfo.isEmpty()) {
262 GuiHelper.runInEDT(this::displayNotification);
263 }
264 } catch (RuntimeException t) { // NOPMD
265 // Don't let exception stop time thread
266 Logging.error("Autosave failed:");
267 Logging.error(t);
268 }
269 }
270 }
271
272 protected void displayNotification() {
273 new Notification(tr("Your work has been saved automatically."))
274 .setDuration(Notification.TIME_SHORT)
275 .show();
276 }
277
278 @Override
279 public void layerOrderChanged(LayerOrderChangeEvent e) {
280 // Do nothing
281 }
282
283 private void registerNewlayer(OsmDataLayer layer) {
284 synchronized (layersLock) {
285 layer.getDataSet().addDataSetListener(datasetAdapter);
286 layersInfo.add(new AutosaveLayerInfo<>(layer));
287 }
288 }
289
290 private void registerNewlayer(NoteLayer layer) {
291 synchronized (layersLock) {
292 layer.getNoteData().addNoteDataUpdateListener(this);
293 layersInfo.add(new AutosaveLayerInfo<>(layer));
294 }
295 }
296
297 @Override
298 public void layerAdded(LayerAddEvent e) {
299 if (e.getAddedLayer() instanceof OsmDataLayer) {
300 registerNewlayer((OsmDataLayer) e.getAddedLayer());
301 } else if (e.getAddedLayer() instanceof NoteLayer) {
302 registerNewlayer((NoteLayer) e.getAddedLayer());
303 } else if (e.getAddedLayer() instanceof AbstractModifiableLayer) {
304 synchronized (layersLock) {
305 layersInfo.add(new AutosaveLayerInfo<>((AbstractModifiableLayer) e.getAddedLayer()));
306 }
307 }
308 }
309
310 @Override
311 public void layerRemoving(LayerRemoveEvent e) {
312 if (e.getRemovedLayer() instanceof OsmDataLayer) {
313 synchronized (layersLock) {
314 OsmDataLayer osmLayer = (OsmDataLayer) e.getRemovedLayer();
315 osmLayer.getDataSet().removeDataSetListener(datasetAdapter);
316 cleanupLayer(osmLayer);
317 }
318 } else if (e.getRemovedLayer() instanceof NoteLayer) {
319 synchronized (layersLock) {
320 NoteLayer noteLayer = (NoteLayer) e.getRemovedLayer();
321 noteLayer.getNoteData().removeNoteDataUpdateListener(this);
322 cleanupLayer(noteLayer);
323 }
324 } else if (e.getRemovedLayer() instanceof AbstractModifiableLayer) {
325 synchronized (layersLock) {
326 cleanupLayer((AbstractModifiableLayer) e.getRemovedLayer());
327 }
328 }
329 }
330
331 private void cleanupLayer(AbstractModifiableLayer removedLayer) {
332 Iterator<AutosaveLayerInfo<?>> it = layersInfo.iterator();
333 while (it.hasNext()) {
334 AutosaveLayerInfo<?> info = it.next();
335 if (info.layer == removedLayer) {
336
337 savelayer(info);
338 File lastFile = info.backupFiles.pollLast();
339 if (lastFile != null) {
340 moveToDeletedLayersFolder(lastFile);
341 }
342 for (File file: info.backupFiles) {
343 if (Utils.deleteFile(file)) {
344 Utils.deleteFile(getPidFile(file));
345 }
346 }
347
348 it.remove();
349 }
350 }
351 }
352
353 @Override
354 public void processDatasetEvent(AbstractDatasetChangedEvent event) {
355 dataUpdated(event.getDataset());
356 }
357
358 @Override
359 public void noteDataUpdated(NoteData data) {
360 dataUpdated(data);
361 }
362
363 /**
364 * Indicate that data has changed, and it might be a good idea to autosave.
365 *
366 * @param data The data that has changed
367 * @return See {@link Set#add}
368 * @since 16548
369 */
370 public boolean dataUpdated(Data data) {
371 return changedData.add(data);
372 }
373
374 @Override
375 public void selectedNoteChanged(NoteData noteData) {
376 // Do nothing
377 }
378
379 protected File getPidFile(File osmFile) {
380 return new File(autosaveDir, osmFile.getName().replaceFirst("[.][^.]+$", ".pid"));
381 }
382
383 /**
384 * Replies the list of .osm files still present in autosave dir, that are not currently managed by another instance of JOSM.
385 * These files are hence unsaved layers from an old instance of JOSM that crashed and may be recovered by this instance.
386 * @return The list of .osm files still present in autosave dir, that are not currently managed by another instance of JOSM
387 */
388 public List<File> getUnsavedLayersFiles() {
389 List<File> result = new ArrayList<>();
390 try {
391 File[] files = autosaveDir.listFiles((FileFilter)
392 pathname -> OsmImporter.FILE_FILTER.accept(pathname) || NoteImporter.FILE_FILTER.accept(pathname));
393 if (files == null)
394 return result;
395 for (File file: files) {
396 if (file.isFile()) {
397 boolean skipFile = false;
398 File pidFile = getPidFile(file);
399 if (pidFile.exists()) {
400 try (BufferedReader reader = Files.newBufferedReader(pidFile.toPath(), StandardCharsets.UTF_8)) {
401 String jvmId = reader.readLine();
402 if (jvmId != null) {
403 String pid = jvmId.split("@", -1)[0];
404 skipFile = jvmPerfDataFileExists(pid);
405 }
406 } catch (IOException | SecurityException t) {
407 Logging.error(t);
408 }
409 }
410 if (!skipFile) {
411 result.add(file);
412 }
413 }
414 }
415 } catch (SecurityException e) {
416 Logging.log(Logging.LEVEL_ERROR, "Unable to list unsaved layers files", e);
417 }
418 return result;
419 }
420
421 private static boolean jvmPerfDataFileExists(final String jvmId) {
422 File jvmDir = new File(getSystemProperty("java.io.tmpdir") + File.separator + "hsperfdata_" + getSystemProperty("user.name"));
423 if (jvmDir.exists() && jvmDir.canRead()) {
424 File[] files = jvmDir.listFiles((FileFilter) file -> file.getName().equals(jvmId) && file.isFile());
425 return files != null && files.length == 1;
426 }
427 return false;
428 }
429
430 /**
431 * Recover the unsaved layers and open them asynchronously.
432 * @return A future that can be used to wait for the completion of this task.
433 */
434 public Future<?> recoverUnsavedLayers() {
435 List<File> files = getUnsavedLayersFiles();
436 final OpenFileTask openFileTsk = new OpenFileTask(files, null, tr("Restoring files"));
437 final Future<?> openFilesFuture = MainApplication.worker.submit(openFileTsk);
438 return MainApplication.worker.submit(() -> {
439 try {
440 // Wait for opened tasks to be generated.
441 openFilesFuture.get();
442 for (File f: openFileTsk.getSuccessfullyOpenedFiles()) {
443 moveToDeletedLayersFolder(f);
444 }
445 } catch (InterruptedException | ExecutionException e) {
446 Logging.error(e);
447 }
448 });
449 }
450
451 /**
452 * Move file to the deleted layers directory.
453 * If moving does not work, it will try to delete the file directly.
454 * Afterwards, if the number of deleted layers gets larger than PROP_DELETED_LAYERS,
455 * some files in the deleted layers directory will be removed.
456 *
457 * @param f the file, usually from the autosave dir
458 */
459 private void moveToDeletedLayersFolder(File f) {
460 File backupFile = new File(deletedLayersDir, f.getName());
461 File pidFile = getPidFile(f);
462
463 if (backupFile.exists()) {
464 deletedLayers.remove(backupFile);
465 Utils.deleteFile(backupFile, marktr("Unable to delete old backup file {0}"));
466 }
467 if (f.renameTo(backupFile)) {
468 deletedLayers.add(backupFile);
469 Utils.deleteFile(pidFile);
470 } else {
471 Logging.warn(String.format("Could not move autosaved file %s to %s folder", f.getName(), deletedLayersDir.getName()));
472 // we cannot move to deleted folder, so just try to delete it directly
473 if (Utils.deleteFile(f, marktr("Unable to delete backup file {0}"))) {
474 Utils.deleteFile(pidFile, marktr("Unable to delete PID file {0}"));
475 }
476 }
477 while (deletedLayers.size() > PROP_DELETED_LAYERS.get()) {
478 File next = deletedLayers.remove();
479 if (next == null) {
480 break;
481 }
482 Utils.deleteFile(next, marktr("Unable to delete archived backup file {0}"));
483 }
484 }
485
486 /**
487 * Mark all unsaved layers as deleted. They are still preserved in the deleted layers folder.
488 */
489 public void discardUnsavedLayers() {
490 for (File f: getUnsavedLayersFiles()) {
491 moveToDeletedLayersFolder(f);
492 }
493 }
494}
Note: See TracBrowser for help on using the repository browser.