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

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

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