source: osm/applications/editors/josm/plugins/cadastre-fr/src/cadastre_fr/CadastrePlugin.java@ 29784

Last change on this file since 29784 was 29784, checked in by akks, 12 years ago

[josm_plugins]: use new core function for default menu position (see #josm8900)
  • Property svn:eol-style set to native
File size: 23.7 KB
Line 
1// License: GPL. v2 and later. Copyright 2008-2009 by Pieren <pieren3@gmail.com> and others
2package cadastre_fr;
3
4import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
5import static org.openstreetmap.josm.tools.I18n.marktr;
6import static org.openstreetmap.josm.tools.I18n.tr;
7
8import java.awt.event.ActionEvent;
9import java.awt.event.ActionListener;
10import java.awt.event.KeyEvent;
11import java.io.File;
12import java.util.Arrays;
13import java.util.HashMap;
14import java.util.Map;
15
16import javax.swing.JCheckBoxMenuItem;
17import javax.swing.JDialog;
18import javax.swing.JMenu;
19import javax.swing.JMenuItem;
20import javax.swing.JOptionPane;
21import javax.swing.KeyStroke;
22
23import org.openstreetmap.josm.Main;
24import org.openstreetmap.josm.actions.JosmAction;
25import org.openstreetmap.josm.actions.UploadAction;
26import org.openstreetmap.josm.data.projection.AbstractProjection;
27import org.openstreetmap.josm.data.projection.Projection;
28import org.openstreetmap.josm.gui.MainMenu;
29import org.openstreetmap.josm.gui.MapFrame;
30import org.openstreetmap.josm.gui.IconToggleButton;
31import org.openstreetmap.josm.gui.layer.Layer;
32import org.openstreetmap.josm.gui.preferences.PreferenceDialog;
33import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
34import org.openstreetmap.josm.gui.preferences.map.MapPreference;
35import org.openstreetmap.josm.gui.preferences.projection.ProjectionPreference;
36import org.openstreetmap.josm.plugins.Plugin;
37import org.openstreetmap.josm.plugins.PluginInformation;
38
39/**
40 *
41 * Plugin to access the French Cadastre WMS server at www.cadastre.gouv.fr This
42 * WMS server requires some specific handling like retrieving a cookie for a
43 * limitation in case of no activity, or the request to the server shall provide
44 * a city/town/village code.
45 *
46 * @author Pieren <pieren3@gmail.com>,
47 * @author <matthieu.lochegnies@gmail.com> for the extension to codeCommune
48 * @version 0.8
49 * History:
50 * 0.1 17-Jun-2008 first prototype using a first Lambert projection impl. in core
51 * 0.2 22-Jun-2008 first stable version
52 * 0.3 24-Jun-2008 add code departement
53 * 0.4 06-Jul-2008 - add images scales, icons, menu items disabling
54 * - remove dependencies of wmsplugin
55 * - add option to force a Lambert zone (for median locations)
56 * - add auto-sourcing
57 * 0.5 16-Aug-2008 - add transparency in layer (allowing multiple wms layers displayed together)
58 * - no overlapping of grabbed images if transparency is enabled
59 * - set one layer per location
60 * - use utf-8 charset in POST request to server
61 * - improve the preferences setting dialog
62 * - cancel the current download is now possible
63 * - add automatic images caching and load on request (+ manage cache directory size)
64 * - enable auto-sourcing only if a WMS layer is used
65 * 0.6 18-Aug-2008 - suppress the null-exception message after the dialog 'open a layer first'
66 * - process the overlapping images when cache is loaded from disk
67 * - save the last 'new location request' text again in preferences
68 * - avoid duplicate layers with same name
69 * - set text input for new locations in upper case
70 * - the cache directory is configurable in "cadastrewms.cacheDir"
71 * - improve configuration change updates
72 * 0.7 24-Aug-2008 - mask images only if transparency enabled
73 * - validate projection name by Lambert.toString() method
74 * 0.8 25-Jan-2009 - display returned list of communes if direct name is not recognized by server
75 * - new possible grab factor of 100 square meters fixed size
76 * - minor fixes due to changes in JOSM core classes
77 * - first draft of raster image support
78 * 0.9 05-Feb-2009 - grab vectorized full commune bbox, save in file, convert to OSM way
79 * and simplify
80 * 1.0 18-Feb-2009 - fix various bugs in color management and preference dialog
81 * - increase PNG picture size requested to WMS (800x1000)
82 * - set 4th grab scale fixed size configurable (from 25 to 1000 meters)
83 * 1.1 11-Jun-2009 - fixed a null exception error when trying to displace a vectorized layer
84 * - propose to use shortcut F11 for grabbing
85 * 1.2 16-Aug-2009 - implementation of raster image grabbing, cropping and georeferencing (not the
86 * overview rasters (Tableau d'assemblage) but directly small units (Feuille)
87 * 1.3 23-Aug-2009 - improve georeferencing action cancellation
88 * - fixed bug of raster image loaded from cache not working on Java1.6
89 * - improve mouse click bounce detection during georeferencing process
90 * 1.4 25-Oct-2009 - add support for new Lambert CC 9 Zones projection
91 * - add optional crosspieces display on raster image layers
92 * - add automatic raster images georeferencing when WMS provides data
93 * - re-implement manual adjustment mode in raster image layer
94 * 1.5 21-Nov-2009 - major changes in projection in core : no magical zone prediction anymore for
95 * Lambert 4 and 9 zones; grid translation implemented for Lambert 4 zones;
96 * support of subprojections in preferences for zones setting and UTM20N
97 * - removed autosourcing of empty new nodes
98 * 1.6 28-Nov-2009 - Fix minor issues if Grab is called without layer (possible since projection rework)
99 * 1.7 12-Dec-2009 - Change URL's changes for cookie and downgrade imgs resolution due to WMS changes
100 * 1.8 11-Mar-2010 - filter the mouse button 1 during georeferencing
101 * - retry if getting a new cookie failed (10 times during 30 seconds)
102 * - cookie expiration automatically detected and renewed (after 30 minutes)
103 * - proper WMS layer cleanup at destruction (workaround for memory leak)
104 * - new cache format (v3) storing original image and cropped image bbox + angle
105 * - new cache format (v4) storing original image size for later rotation
106 * - cache files read compatible with previous formats
107 * - raster image rotation issues fixed, now using shift+ctrl key instead of ctrl
108 * - raster image adjustment using default system menu modifier (ctrl for windows) for Mac support
109 * - image resolution configurable (high, medium, low) like the online interface
110 * - layer selection configurable for vectorized images
111 * - improved download cancellation
112 * - from Erik Amzallag:
113 * - possibility to modify the auto-sourcing text just before upload
114 * - from Clément Ménier:
115 * - new option allowing an auto-selection of the first cadastre layer for grab
116 * - non-modal JDialog in MenuActionGrabPlanImage
117 * - new options in the image filter (bilinear, bicubic)
118 * 1.9 05-Apr-2010 - added a scroll bar in preferences
119 * - download cancellation improved
120 * - last deployment for Java1.5 compatibility
121 * 2.0 07-Jul-2010 - update projection for "La Reunion" departement to RGR92, UTM40S.
122 * - add 'departement' as option in the municipality selection
123 * - fixed bug in cache directory size control (and disabled by default)
124 * - add map mode for addressing
125 * - from Nicolas Dumoulin:
126 * - add "tableau d'assemblage" in raster images for georeferencing (as option)
127 * 2.1 14-Jan-2011 - add GrabThread moving the grab to a separate thread
128 * - the divided BBox mode starts from the central square and loads the next in a spiral
129 * - move the grabber from CadastrPlugin singleton to each wmsLayer instance to allow grabbing
130 * of multiple municipalities in parallel.
131 * 2.2 01-Jul-2011 - replace deprecated Main.proj by newest Main.getProjection()
132 * - fix list of raster images (Feuilles) parsing failing after a Cadastre server change/maintenance
133 * 2.3 11-Jan-2013 - add various improvements from Don-Vip (Vincent Privat) trac #8175, #8229 and #5626.
134 * 2.4 27-Jun-2013 - fix raster image georeferencing issues. Add new MenuActionRefineGeoRef for a new georeferencing
135 * of already referenced plan image.
136 */
137public class CadastrePlugin extends Plugin {
138 static String VERSION = "2.1";
139
140 static JMenu cadastreJMenu;
141
142 public static String source = "";
143
144 // true if the checkbox "auto-sourcing" is set in the plugin menu
145 public static boolean autoSourcing = false;
146
147 // true when the plugin is first used, e.g. grab from WMS or download cache file
148 public static boolean pluginUsed = false;
149
150 public static String cacheDir = null;
151
152 public static boolean alterColors = false;
153
154 public static boolean backgroundTransparent = false;
155
156 public static float transparency = 1.0f;
157
158 public static boolean drawBoundaries = false;
159
160 public static int imageWidth, imageHeight;
161
162 public static String grabLayers, grabStyles = null;
163
164 static private boolean menuEnabled = false;
165
166 private static String LAYER_BULDINGS = "CDIF:LS2";
167 private static String STYLE_BUILDING = "LS2_90";
168 private static String LAYER_WATER = "CDIF:LS3";
169 private static String STYLE_WATER = "LS3_90";
170 private static String LAYER_SYMBOL = "CDIF:LS1";
171 private static String STYLE_SYMBOL = "LS1_90";
172 private static String LAYER_PARCELS = "CDIF:PARCELLE";
173 private static String STYLE_PARCELS = "PARCELLE_90";
174 private static String LAYER_NUMERO = "CDIF:NUMERO";
175 private static String STYLE_NUMERO = "NUMERO_90";
176 private static String LAYER_LABEL = "CDIF:PT3,CDIF:PT2,CDIF:PT1";
177 private static String STYLE_LABEL = "PT3_90,PT2_90,PT1_90";
178 private static String LAYER_LIEUDIT = "CDIF:LIEUDIT";
179 private static String STYLE_LIEUDIT = "LIEUDIT_90";
180 private static String LAYER_SECTION = "CDIF:SUBSECTION,CDIF:SECTION";
181 private static String STYLE_SECTION = "SUBSECTION_90,SECTION_90";
182 private static String LAYER_COMMUNE = "CDIF:COMMUNE";
183 private static String STYLE_COMMUNE = "COMMUNE_90";
184
185 /**
186 * Creates the plugin and setup the default settings if necessary
187 *
188 * @throws Exception
189 */
190 public CadastrePlugin(PluginInformation info) throws Exception {
191 super(info);
192 System.out.println("Pluging cadastre-fr v"+VERSION+" started...");
193 if (Main.pref.get("cadastrewms.cacheDir").equals(""))
194 cacheDir = Main.pref.getPreferencesDir()+"plugins"+File.separatorChar+"cadastrewms"+File.separatorChar;
195 else {
196 cacheDir = Main.pref.get("cadastrewms.cacheDir");
197 if (cacheDir.charAt(cacheDir.length()-1) != File.separatorChar )
198 cacheDir += File.separatorChar;
199 }
200 System.out.println("current cache directory: "+cacheDir);
201
202 refreshConfiguration();
203
204 UploadAction.registerUploadHook(new CheckSourceUploadHook());
205
206 }
207
208 public static void refreshMenu() {
209 MainMenu menu = Main.main.menu;
210
211 if (cadastreJMenu == null) {
212 cadastreJMenu = menu.addMenu(marktr("Cadastre"), KeyEvent.VK_C, menu.getDefaultMenuPos(), ht("/Plugin/CadastreFr"));
213 JosmAction grab = new MenuActionGrab();
214 JMenuItem menuGrab = new JMenuItem(grab);
215 KeyStroke ks = grab.getShortcut().getKeyStroke();
216 if (ks != null) {
217 menuGrab.setAccelerator(ks);
218 }
219 JMenuItem menuActionGrabPlanImage = new JMenuItem(new MenuActionGrabPlanImage());
220 JMenuItem menuSettings = new JMenuItem(new MenuActionNewLocation());
221 final JCheckBoxMenuItem menuSource = new JCheckBoxMenuItem(tr("Auto sourcing"));
222 menuSource.setSelected(autoSourcing);
223 menuSource.addActionListener(new ActionListener() {
224 public void actionPerformed(ActionEvent ev) {
225 Main.pref.put("cadastrewms.autosourcing", menuSource.isSelected());
226 autoSourcing = menuSource.isSelected();
227 }
228 });
229
230 //JMenuItem menuResetCookie = new JMenuItem(new MenuActionResetCookie());
231 //JMenuItem menuLambertZone = new JMenuItem(new MenuActionLambertZone());
232 JMenuItem menuLoadFromCache = new JMenuItem(new MenuActionLoadFromCache());
233 // temporary disabled:
234 //JMenuItem menuActionBoundaries = new JMenuItem(new MenuActionBoundaries());
235 //JMenuItem menuActionBuildings = new JMenuItem(new MenuActionBuildings());
236
237 cadastreJMenu.add(menuGrab);
238 cadastreJMenu.add(menuActionGrabPlanImage);
239 cadastreJMenu.add(menuSettings);
240 cadastreJMenu.add(menuSource);
241 //cadastreJMenu.add(menuResetCookie); not required any more
242 //cadastreJMenu.add(menuLambertZone);
243 //if (Main.pref.getBoolean("cadastrewms.buildingsMenu", false))
244 // cadastreJMenu.add(menuActionBuildings);
245 cadastreJMenu.add(menuLoadFromCache);
246 // all SVG features disabled until official WMS is released
247 //cadastreJMenu.add(menuActionBoundaries);
248 cadastreJMenu.add(new JMenuItem(new MenuActionOpenPreferences()));
249 }
250 setEnabledAll(menuEnabled);
251 }
252
253 public static void refreshConfiguration() {
254 source = checkSourceMillesime();
255 autoSourcing = Main.pref.getBoolean("cadastrewms.autosourcing", true);
256 alterColors = Main.pref.getBoolean("cadastrewms.alterColors");
257 drawBoundaries = Main.pref.getBoolean("cadastrewms.drawBoundaries", false);
258 if (alterColors) {
259 backgroundTransparent = Main.pref.getBoolean("cadastrewms.backgroundTransparent");
260 transparency = Float.parseFloat(Main.pref.get("cadastrewms.brightness", "1.0f"));
261 } else {
262 backgroundTransparent = false;
263 transparency = 1.0f;
264 }
265 String currentResolution = Main.pref.get("cadastrewms.resolution", "high");
266 if (currentResolution.equals("high")) {
267 imageWidth = 1000; imageHeight = 800;
268 } else if (currentResolution.equals("medium")){
269 imageWidth = 800; imageHeight = 600;
270 } else {
271 imageWidth = 600; imageHeight = 400;
272 }
273 refreshLayersURL();
274
275 /* TODO: remove in july 2012 */
276 if(!Main.pref.getBoolean("cadastregrab.shortcut.warn", false))
277 {
278 Main.pref.put("cadastregrab.shortcut.warn", true);
279 JOptionPane.showMessageDialog(Main.parent,
280 tr("Plugin cadastre-fr used the key shortcut F11 for grabbing,\n"+
281 "which is now allocated for full-screen switch.\n"+
282 "The new grabbing key is F10, but you can change the key\n" +
283 "in the shortcut settings if you want."));
284 }
285 refreshMenu();
286 }
287
288 private static void refreshLayersURL() {
289 grabLayers = "";
290 grabStyles = "";
291 int countLayers = 0;
292 if (Main.pref.getBoolean("cadastrewms.layerWater", true)) {
293 grabLayers += LAYER_WATER + ",";
294 grabStyles += STYLE_WATER + ",";
295 countLayers++;
296 }
297 if (Main.pref.getBoolean("cadastrewms.layerBuilding", true)) {
298 grabLayers += LAYER_BULDINGS + ",";
299 grabStyles += STYLE_BUILDING + ",";
300 countLayers++;
301 }
302 if (Main.pref.getBoolean("cadastrewms.layerSymbol", true)) {
303 grabLayers += LAYER_SYMBOL + ",";
304 grabStyles += STYLE_SYMBOL + ",";
305 countLayers++;
306 }
307 if (Main.pref.getBoolean("cadastrewms.layerParcel", true)) {
308 grabLayers += LAYER_PARCELS + ",";
309 grabStyles += STYLE_PARCELS + ",";
310 countLayers++;
311 }
312 if (Main.pref.getBoolean("cadastrewms.layerNumero", true)) {
313 grabLayers += LAYER_NUMERO + ",";
314 grabStyles += STYLE_NUMERO + ",";
315 countLayers++;
316 }
317 if (Main.pref.getBoolean("cadastrewms.layerLabel", true)) {
318 grabLayers += LAYER_LABEL + ",";
319 grabStyles += STYLE_LABEL + ",";
320 countLayers++;
321 }
322 if (Main.pref.getBoolean("cadastrewms.layerLieudit", true)) {
323 grabLayers += LAYER_LIEUDIT + ",";
324 grabStyles += STYLE_LIEUDIT + ",";
325 countLayers++;
326 }
327 if (Main.pref.getBoolean("cadastrewms.layerSection", true)) {
328 grabLayers += LAYER_SECTION + ",";
329 grabStyles += STYLE_SECTION + ",";
330 countLayers++;
331 }
332 if (Main.pref.getBoolean("cadastrewms.layerCommune", true)) {
333 grabLayers += LAYER_COMMUNE + ",";
334 grabStyles += STYLE_COMMUNE + ",";
335 countLayers++;
336 }
337 if (countLayers > 2) { // remove the last ','
338 grabLayers = grabLayers.substring(0, grabLayers.length()-1);
339 grabStyles = grabStyles.substring(0, grabStyles.length()-1);
340 } else {
341 JOptionPane.showMessageDialog(Main.parent,tr("Please enable at least two WMS layers in the cadastre-fr "
342 + "plugin configuration.\nLayers ''Building'' and ''Parcel'' added by default."));
343 Main.pref.put("cadastrewms.layerBuilding", true);
344 Main.pref.put("cadastrewms.layerParcel", true);
345 grabLayers += LAYER_BULDINGS + "," + LAYER_PARCELS;
346 grabStyles += STYLE_BUILDING + "," + STYLE_PARCELS;
347 }
348 }
349
350 @Override
351 public PreferenceSetting getPreferenceSetting() {
352 return new CadastrePreferenceSetting();
353 }
354
355 private static void setEnabledAll(boolean isEnabled) {
356 for (int i = 0; i < cadastreJMenu.getItemCount(); i++) {
357 JMenuItem item = cadastreJMenu.getItem(i);
358 if (item != null)
359 if (item.getText().equals(MenuActionGrabPlanImage.name) /*||
360 item.getText().equals(MenuActionGrab.name) ||
361 item.getText().equals(MenuActionBoundaries.name) ||
362 item.getText().equals(MenuActionBuildings.name)*/) {
363 item.setEnabled(isEnabled);
364 }
365 }
366 menuEnabled = isEnabled;
367 }
368
369 public void mapFrameInitialized(MapFrame oldFrame, MapFrame newFrame) {
370 if (cadastreJMenu != null) {
371 if (oldFrame == null && newFrame != null) {
372 setEnabledAll(true);
373 Main.map.addMapMode(new IconToggleButton(new WMSAdjustAction(Main.map)));
374 Main.map.addMapMode(new IconToggleButton(new Address(Main.map)));
375 } else if (oldFrame != null && newFrame == null) {
376 setEnabledAll(false);
377 //Lambert.layoutZone = -1;
378 //LambertCC9Zones.layoutZone = -1;
379 }
380 }
381 }
382
383 public static boolean isLambert() {
384 String code = Main.getProjection().toCode();
385 return Arrays.asList(ProjectionPreference.lambert.allCodes()).contains(code);
386 }
387
388 public static boolean isUtm_france_dom() {
389 String code = Main.getProjection().toCode();
390 return Arrays.asList(ProjectionPreference.utm_france_dom.allCodes()).contains(code);
391 }
392
393 public static boolean isLambert_cc9() {
394 String code = Main.getProjection().toCode();
395 return Arrays.asList(ProjectionPreference.lambert_cc9.allCodes()).contains(code);
396 }
397
398 public static boolean isCadastreProjection() {
399 return isLambert() || isUtm_france_dom() || isLambert_cc9();
400 }
401
402 public static int getCadastreProjectionLayoutZone() {
403 int zone = -1;
404 Projection proj = Main.getProjection();
405 if (proj instanceof AbstractProjection) {
406 Integer code = ((AbstractProjection) proj).getEpsgCode();
407 if (code != null) {
408 if (code >= 3942 && code <= 3950) { // LambertCC9Zones
409 zone = code - 3942;
410 } else if (code >= 27561 && 27564 <= code) { // Lambert
411 zone = code - 27561;
412 } else { // UTM_France_DOM
413 Map<Integer, Integer> utmfr = new HashMap<Integer, Integer>();
414 utmfr.put(2969, 0);
415 utmfr.put(2970, 1);
416 utmfr.put(2973, 2);
417 utmfr.put(2975, 3);
418 utmfr.put(2972, 4);
419 if (utmfr.containsKey(code)) {
420 zone = utmfr.get(code);
421 }
422 }
423 }
424 }
425 return zone;
426 }
427
428 public static void safeSleep(long milliseconds) {
429 try {
430 Thread.sleep(milliseconds);
431 } catch (InterruptedException e) {}
432 }
433
434 // See OptionPaneUtil
435 // FIXME: this is a temporary solution.
436 public static void prepareDialog(JDialog dialog) {
437 if (Main.pref.getBoolean("window-handling.option-pane-always-on-top", true)) {
438 try {
439 dialog.setAlwaysOnTop(true);
440 } catch(SecurityException e) {
441 System.out.println(tr("Warning: failed to put option pane dialog always on top. Exception was: {0}", e.toString()));
442 }
443 }
444 dialog.setModal(true);
445 dialog.toFront();
446 dialog.setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE);
447 }
448
449 /**
450 * Adds the WMSLayer following this rule:<br/>
451 * - if a WMSLayer exists place this new layer just before this layer<br/>
452 * - Otherwise place it at the bottom
453 * @param wmsLayer the wmsLayer to add
454 */
455 public static void addWMSLayer(WMSLayer wmsLayer) {
456 if (Main.map != null && Main.map.mapView != null) {
457 int wmsNewLayerPos = Main.map.mapView.getAllLayers().size();
458 for(Layer l : Main.map.mapView.getLayersOfType(WMSLayer.class)) {
459 int wmsPos = Main.map.mapView.getLayerPos(l);
460 if (wmsPos < wmsNewLayerPos) wmsNewLayerPos = wmsPos;
461 }
462 Main.main.addLayer(wmsLayer);
463 // Move the layer to its new position
464 Main.map.mapView.moveLayer(wmsLayer, wmsNewLayerPos);
465 } else
466 Main.main.addLayer(wmsLayer);
467 }
468
469 private static String checkSourceMillesime() {
470 java.util.Calendar calendar = java.util.Calendar.getInstance();
471 int currentYear = calendar.get(java.util.Calendar.YEAR);
472 String src = Main.pref.get("cadastrewms.source",
473 "cadastre-dgi-fr source : Direction G\u00e9n\u00e9rale des Imp\u00f4ts - Cadastre. Mise \u00e0 jour : AAAA");
474 String srcYear = src.substring(src.lastIndexOf(" ")+1);
475 Integer year = null;
476 try {
477 year = Integer.decode(srcYear);
478 } catch (NumberFormatException e) {}
479 if (srcYear.equals("AAAA") || (year != null && year < currentYear)) {
480 System.out.println("Replace source year "+srcYear+" by current year "+currentYear);
481 src = src.substring(0, src.lastIndexOf(" ")+1)+currentYear;
482 Main.pref.put("cadastrewms.source", src);
483 }
484 return src;
485 }
486
487 public static void askToChangeProjection() {
488 if (JOptionPane.showConfirmDialog(Main.parent,
489 tr("To enable the cadastre WMS plugin, change\n"
490 + "the current projection to one of the cadastre\n"
491 + "projections and retry"),
492 tr("Change the current projection"), JOptionPane.OK_CANCEL_OPTION)
493 == JOptionPane.OK_OPTION) {
494 PreferenceDialog p = new PreferenceDialog(Main.parent);
495 p.selectPreferencesTabByClass(MapPreference.class);
496 p.getTabbedPane().getSetting(ProjectionPreference.class).selectProjection(ProjectionPreference.lambert_cc9);
497 p.setVisible(true);
498 }
499 }
500}
Note: See TracBrowser for help on using the repository browser.