source: josm/trunk/src/org/openstreetmap/josm/data/AutosaveTask.java@ 8314

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

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