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