source: josm/trunk/scripts/SyncEditorImageryIndex.groovy @ 11572

Last change on this file since 11572 was 11572, checked in by stoecker, 4 years ago

fix imagery compare, add date check

  • Property svn:eol-style set to native
File size: 22.1 KB
Line 
1// License: GPL. For details, see LICENSE file.
2/**
3 * Compare and analyse the differences of the editor imagery index and the JOSM imagery list.
4 * The goal is to keep both lists in sync.
5 *
6 * The editor imagery index project (https://github.com/osmlab/editor-imagery-index)
7 * provides also a version in the JOSM format, but the JSON is the original source
8 * format, so we read that.
9 *
10 * How to run:
11 * -----------
12 *
13 * Main JOSM binary needs to be in classpath, e.g.
14 *
15 * $ groovy -cp ../dist/josm-custom.jar SyncEditorImageryIndex.groovy
16 *
17 * Add option "-h" to show the available command line flags.
18 */
19import javax.json.Json
20import javax.json.JsonArray
21import javax.json.JsonObject
22import javax.json.JsonReader
23import javax.json.JsonValue
24
25import org.openstreetmap.josm.data.imagery.ImageryInfo
26import org.openstreetmap.josm.data.imagery.Shape
27import org.openstreetmap.josm.io.imagery.ImageryReader
28
29class SyncEditorImageryIndex {
30
31    List<ImageryInfo> josmEntries;
32    JsonArray eiiEntries;
33
34    def eiiUrls = new HashMap<String, JsonObject>()
35    def josmUrls = new HashMap<String, ImageryInfo>()
36    def josmMirrors = new HashMap<String, ImageryInfo>()
37
38    static String eiiInputFile = 'imagery.geojson'
39    static String josmInputFile = 'maps.xml'
40    static String ignoreInputFile = 'maps_ignores.txt'
41    static FileWriter outputFile = null
42    static BufferedWriter outputStream = null
43    int skipCount = 0;
44    String skipColor = "greenyellow" // should never be visible
45    def skipEntries = [:]
46    def skipColors = [:]
47
48    static def options
49
50    /**
51     * Main method.
52     */
53    static main(def args) {
54        parse_command_line_arguments(args)
55        def script = new SyncEditorImageryIndex()
56        script.loadSkip()
57        script.start()
58        script.loadJosmEntries()
59        script.loadEIIEntries()
60        script.checkInOneButNotTheOther()
61        script.checkCommonEntries()
62        script.end()
63        if(outputStream != null) {
64            outputStream.close();
65        }
66        if(outputFile != null) {
67            outputFile.close();
68        }
69    }
70
71    /**
72     * Parse command line arguments.
73     */
74    static void parse_command_line_arguments(args) {
75        def cli = new CliBuilder(width: 160)
76        cli.o(longOpt:'output', args:1, argName: "output", "Output file, - prints to stdout (default: -)")
77        cli.e(longOpt:'eii_input', args:1, argName:"eii_input", "Input file for the editor imagery index (json). Default is $eiiInputFile (current directory).")
78        cli.j(longOpt:'josm_input', args:1, argName:"josm_input", "Input file for the JOSM imagery list (xml). Default is $josmInputFile (current directory).")
79        cli.i(longOpt:'ignore_input', args:1, argName:"ignore_input", "Input file for the ignore list. Default is $ignoreInputFile (current directory).")
80        cli.s(longOpt:'shorten', "shorten the output, so it is easier to read in a console window")
81        cli.n(longOpt:'noskip', argName:"noskip", "don't skip known entries")
82        cli.x(longOpt:'xhtmlbody', argName:"xhtmlbody", "create XHTML body for display in a web page")
83        cli.X(longOpt:'xhtml', argName:"xhtml", "create XHTML for display in a web page")
84        cli.m(longOpt:'nomissingeii', argName:"nomissingeii", "don't show missing editor imagery index entries")
85        cli.h(longOpt:'help', "show this help")
86        options = cli.parse(args)
87
88        if (options.h) {
89            cli.usage()
90            System.exit(0)
91        }
92        if (options.eii_input) {
93            eiiInputFile = options.eii_input
94        }
95        if (options.josm_input) {
96            josmInputFile = options.josm_input
97        }
98        if (options.ignore_input) {
99            ignoreInputFile = options.ignore_input
100        }
101        if (options.output && options.output != "-") {
102            outputFile = new FileWriter(options.output)
103            outputStream = new BufferedWriter(outputFile)
104        }
105    }
106
107    void loadSkip() {
108        FileReader fr = new FileReader(ignoreInputFile)
109        def line
110
111        while((line = fr.readLine()) != null) {
112            def res = (line =~ /^\|\| *(\d) *\|\| *(EII|Ignore) *\|\| *\{\{\{(.+)\}\}\} *\|\|/)
113            if(res.count)
114            {
115                skipEntries[res[0][3]] = res[0][1] as int
116                if(res[0][2].equals("Ignore")) {
117                    skipColors[res[0][3]] = "green"
118                } else {
119                    skipColors[res[0][3]] = "darkgoldenrod"
120                }
121            }
122        }
123    }
124
125    void myprintlnfinal(String s) {
126        if(outputStream != null) {
127            outputStream.write(s);
128            outputStream.newLine();
129        } else {
130            println s;
131        }
132    }
133
134    void myprintln(String s) {
135        if(skipEntries.containsKey(s)) {
136            skipCount = skipEntries.get(s)
137            skipEntries.remove(s)
138            if(skipColors.containsKey(s)) {
139                skipColor = skipColors.get(s)
140            } else {
141                skipColor = "greenyellow"
142            }
143        }
144        if(skipCount) {
145            skipCount -= 1;
146            if(options.xhtmlbody || options.xhtml) {
147                s = "<pre style=\"margin:3px;color:"+skipColor+"\">"+s.replaceAll("&","&amp;").replaceAll("<","&lt;").replaceAll(">","&gt;")+"</pre>"
148            }
149            if (!options.noskip) {
150                return;
151            }
152        } else if(options.xhtmlbody || options.xhtml) {
153            String color = s.startsWith("***") ? "black" : ((s.startsWith("+ ") || s.startsWith("+++ EII")) ? "blue" : "red")
154            s = "<pre style=\"margin:3px;color:"+color+"\">"+s.replaceAll("&","&amp;").replaceAll("<","&lt;").replaceAll(">","&gt;")+"</pre>"
155        }
156        myprintlnfinal(s)
157    }
158
159    void start() {
160        if (options.xhtml) {
161            myprintlnfinal "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n"
162            myprintlnfinal "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"/><title>JOSM - EII differences</title></head><body>\n"
163        }
164    }
165
166    void end() {
167        for (def s: skipEntries.keySet()) {
168            myprintln "+++ Obsolete skip entry: " + s
169        }
170        if (options.xhtml) {
171            myprintlnfinal "</body></html>\n"
172        }
173    }
174
175    void loadEIIEntries() {
176        FileReader fr = new FileReader(eiiInputFile)
177        JsonReader jr = Json.createReader(fr)
178        eiiEntries = jr.readObject().get("features")
179        jr.close()
180
181        for (def e : eiiEntries) {
182            def url = getUrl(e)
183            if (url.contains("{z}")) {
184                myprintln "+++ EII-URL uses {z} instead of {zoom}: "+url
185                url = url.replace("{z}","{zoom}")
186            }
187            if (eiiUrls.containsKey(url)) {
188                myprintln "+++ EII-URL is not unique: "+url
189            } else {
190                eiiUrls.put(url, e)
191            }
192        }
193        myprintln "*** Loaded ${eiiEntries.size()} entries (EII). ***"
194    }
195
196    void loadJosmEntries() {
197        def reader = new ImageryReader(josmInputFile)
198        josmEntries = reader.parse()
199
200        for (def e : josmEntries) {
201            def url = getUrl(e)
202            if (url.contains("{z}")) {
203                myprintln "+++ JOSM-URL uses {z} instead of {zoom}: "+url
204                url = url.replace("{z}","{zoom}")
205            }
206            if (josmUrls.containsKey(url)) {
207                myprintln "+++ JOSM-URL is not unique: "+url
208            } else {
209                josmUrls.put(url, e)
210            }
211            for (def m : e.getMirrors()) {
212                url = getUrl(m)
213                m.setName(m.getName().replaceAll(" mirror server( \\d+)?",""))
214                if (josmUrls.containsKey(url)) {
215                    myprintln "+++ JOSM-Mirror-URL is not unique: "+url
216                } else {
217                    josmUrls.put(url, m)
218                    josmMirrors.put(url, m)
219                }
220            }
221        }
222        myprintln "*** Loaded ${josmEntries.size()} entries (JOSM). ***"
223    }
224
225    List inOneButNotTheOther(Map m1, Map m2) {
226        def l = []
227        for (def url : m1.keySet()) {
228            if (!m2.containsKey(url)) {
229                def name = getName(m1.get(url))
230                l += "  "+getDescription(m1.get(url))
231            }
232        }
233        l.sort()
234    }
235
236    void checkInOneButNotTheOther() {
237        def l1 = inOneButNotTheOther(eiiUrls, josmUrls)
238        myprintln "*** URLs found in EII but not in JOSM (${l1.size()}): ***"
239        if (!l1.isEmpty()) {
240            for (def l : l1) {
241                myprintln "-" + l
242            }
243        }
244
245        if (options.nomissingeii)
246            return
247        def l2 = inOneButNotTheOther(josmUrls, eiiUrls)
248        myprintln "*** URLs found in JOSM but not in EII (${l2.size()}): ***"
249        if (!l2.isEmpty()) {
250            for (def l : l2) {
251                myprintln "+" + l
252            }
253        }
254    }
255
256    void checkCommonEntries() {
257        myprintln "*** Same URL, but different name: ***"
258        for (def url : eiiUrls.keySet()) {
259            def e = eiiUrls.get(url)
260            if (!josmUrls.containsKey(url)) continue
261            def j = josmUrls.get(url)
262            if (!getName(e).equals(getName(j))) {
263                myprintln "  name differs: $url"
264                myprintln "     (EII):     ${getName(e)}"
265                myprintln "     (JOSM):    ${getName(j)}"
266            }
267        }
268
269        myprintln "*** Same URL, but different type: ***"
270        for (def url : eiiUrls.keySet()) {
271            def e = eiiUrls.get(url)
272            if (!josmUrls.containsKey(url)) continue
273            def j = josmUrls.get(url)
274            if (!getType(e).equals(getType(j))) {
275                myprintln "  type differs: ${getName(j)} - $url"
276                myprintln "     (EII):     ${getType(e)}"
277                myprintln "     (JOSM):    ${getType(j)}"
278            }
279        }
280
281        myprintln "*** Same URL, but different zoom bounds: ***"
282        for (def url : eiiUrls.keySet()) {
283            def e = eiiUrls.get(url)
284            if (!josmUrls.containsKey(url)) continue
285            def j = josmUrls.get(url)
286
287            Integer eMinZoom = getMinZoom(e)
288            Integer jMinZoom = getMinZoom(j)
289            if (eMinZoom != jMinZoom  && !(eMinZoom == 0 && jMinZoom == null)) {
290                myprintln "  minzoom differs: ${getDescription(j)}"
291                myprintln "     (EII):     ${eMinZoom}"
292                myprintln "     (JOSM):    ${jMinZoom}"
293            }
294            Integer eMaxZoom = getMaxZoom(e)
295            Integer jMaxZoom = getMaxZoom(j)
296            if (eMaxZoom != jMaxZoom) {
297                myprintln "  maxzoom differs: ${getDescription(j)}"
298                myprintln "     (EII):     ${eMaxZoom}"
299                myprintln "     (JOSM):    ${jMaxZoom}"
300            }
301        }
302
303        myprintln "*** Same URL, but different country code: ***"
304        for (def url : eiiUrls.keySet()) {
305            def e = eiiUrls.get(url)
306            if (!josmUrls.containsKey(url)) continue
307            def j = josmUrls.get(url)
308            if (!getCountryCode(e).equals(getCountryCode(j))) {
309                myprintln "  country code differs: ${getDescription(j)}"
310                myprintln "     (EII):     ${getCountryCode(e)}"
311                myprintln "     (JOSM):    ${getCountryCode(j)}"
312            }
313        }
314        /*myprintln "*** Same URL, but different quality: ***"
315        for (def url : eiiUrls.keySet()) {
316            def e = eiiUrls.get(url)
317            if (!josmUrls.containsKey(url)) {
318              def q = getQuality(e)
319              if("best".equals(q)) {
320                myprintln "  quality best entry not in JOSM for ${getDescription(e)}"
321              }
322              continue
323            }
324            def j = josmUrls.get(url)
325            if (!getQuality(e).equals(getQuality(j))) {
326                myprintln "  quality differs: ${getDescription(j)}"
327                myprintln "     (EII):     ${getQuality(e)}"
328                myprintln "     (JOSM):    ${getQuality(j)}"
329            }
330        }*/
331        myprintln "*** Mismatching shapes: ***"
332        for (def url : josmUrls.keySet()) {
333            def j = josmUrls.get(url)
334            def num = 1
335            for (def shape : getShapes(j)) {
336                def p = shape.getPoints()
337                if(!p[0].equals(p[p.size()-1])) {
338                    myprintln "+++ JOSM shape $num unclosed: ${getDescription(j)}"
339                }
340                ++num
341            }
342        }
343        for (def url : eiiUrls.keySet()) {
344            def e = eiiUrls.get(url)
345            def num = 1
346            def s = getShapes(e)
347            for (def shape : s) {
348                def p = shape.getPoints()
349                if(!p[0].equals(p[p.size()-1]) && !options.nomissingeii) {
350                    myprintln "+++ EII shape $num unclosed: ${getDescription(e)}"
351                }
352                ++num
353            }
354            if (!josmUrls.containsKey(url)) {
355                continue
356            }
357            def j = josmUrls.get(url)
358            def js = getShapes(j)
359            if(!s.size() && js.size()) {
360                if(!options.nomissingeii) {
361                    myprintln "+ No EII shape: ${getDescription(j)}"
362                }
363            } else if(!js.size() && s.size()) {
364                // don't report boundary like 5 point shapes as difference
365                if (s.size() != 1 || s[0].getPoints().size() != 5) {
366                    myprintln "- No JOSM shape: ${getDescription(j)}"
367                }
368            } else if(s.size() != js.size()) {
369                myprintln "* Different number of shapes (${s.size()} != ${js.size()}): ${getDescription(j)}"
370            } else {
371                for(def nums = 0; nums < s.size(); ++nums) {
372                    def ep = s[nums].getPoints()
373                    def jp = js[nums].getPoints()
374                    if(ep.size() != jp.size()) {
375                        myprintln "* Different number of points for shape ${nums+1} (${ep.size()} ! = ${jp.size()})): ${getDescription(j)}"
376                    } else {
377                        for(def nump = 0; nump < ep.size(); ++nump) {
378                            def ept = ep[nump]
379                            def jpt = jp[nump]
380                            if(Math.abs(ept.getLat()-jpt.getLat()) > 0.000001 || Math.abs(ept.getLon()-jpt.getLon()) > 0.000001) {
381                                myprintln "* Different coordinate for point ${nump+1} of shape ${nums+1}: ${getDescription(j)}"
382                                nump = ep.size()
383                                num = s.size()
384                            }
385                        }
386                    }
387                }
388            }
389        }
390        myprintln "*** Mismatching icons: ***"
391        for (def url : eiiUrls.keySet()) {
392            def e = eiiUrls.get(url)
393            if (!josmUrls.containsKey(url)) {
394                continue
395            }
396            def j = josmUrls.get(url)
397            def ij = getIcon(j)
398            def ie = getIcon(e)
399            if(ij != null && ie == null) {
400                if(!options.nomissingeii) {
401                    myprintln "+ No EII icon: ${getDescription(j)}"
402                }
403            } else if(ij == null && ie != null) {
404                myprintln "- No JOSM icon: ${getDescription(j)}"
405            } else if(!ij.equals(ie)) {
406                myprintln "* Different icons: ${getDescription(j)}"
407            }
408        }
409        myprintln "*** Miscellaneous checks: ***"
410        def josmIds = new HashMap<String, ImageryInfo>()
411        for (def url : josmUrls.keySet()) {
412            def j = josmUrls.get(url)
413            def id = getId(j)
414            if(josmMirrors.containsKey(url)) {
415                continue;
416            }
417            if(id == null) {
418                myprintln "* No JOSM-ID: ${getDescription(j)}"
419            } else if(josmIds.containsKey(id)) {
420                myprintln "* JOSM-ID ${id} not unique: ${getDescription(j)}"
421            } else {
422                josmIds.put(id, j);
423            }
424            def d = getDate(j)
425            if(d != null) {
426                def reg = (d =~ /^(\d\d\d\d)(-(\d\d)(-(\d\d))?)?(;(\d\d\d\d)(-(\d\d)(-(\d\d))?)?)?/)
427                if(reg == null || reg.count != 1) {
428                    myprintln "* JOSM-Date '${d}' is strange: ${getDescription(j)}"
429                } else {
430                    try {
431                        def first = verifyDate(reg[0][1],reg[0][3],reg[0][5]);
432                        def second = verifyDate(reg[0][7],reg[0][9],reg[0][11]);
433                        if(second.compareTo(first) < 0) {
434                            myprintln "* JOSM-Date '${d}' is strange (second earlier than first): ${getDescription(j)}"
435                        }
436                    }
437                    catch (Exception e) {
438                        myprintln "* JOSM-Date '${d}' is strange (${e.getMessage()}): ${getDescription(j)}"
439                    }
440                }
441            }           
442            def js = getShapes(j)
443            if(js.size()) {
444                def minlat = 1000;
445                def minlon = 1000;
446                def maxlat = -1000;
447                def maxlon = -1000;
448                for(def s: js) {
449                    for(def p: s.getPoints()) {
450                        def lat = p.getLat();
451                        def lon = p.getLon();
452                        if(lat > maxlat) maxlat = lat;
453                        if(lon > maxlon) maxlon = lon;
454                        if(lat < minlat) minlat = lat;
455                        if(lon < minlon) minlon = lon;
456                    }
457                }
458                def b = j.getBounds();
459                if(b.getMinLat() != minlat || b.getMinLon() != minlon || b.getMaxLat() != maxlat || b.getMaxLon() != maxlon) {
460                    myprintln "* Bounds do not match shape (is ${b.getMinLat()},${b.getMinLon()},${b.getMaxLat()},${b.getMaxLon()}, calculated <bounds min-lat='${minlat}' min-lon='${minlon}' max-lat='${maxlat}' max-lon='${maxlon}'>): ${getDescription(j)}"
461                }
462            }
463        }
464    }
465
466    /**
467     * Utility functions that allow uniform access for both ImageryInfo and JsonObject.
468     */
469    static String getUrl(Object e) {
470        if (e instanceof ImageryInfo) return e.url
471        return e.get("properties").getString("url")
472    }
473    static String getDate(Object e) {
474        if (e instanceof ImageryInfo) return e.date
475        def start = e.get("properties").getString("start_date")
476        def end = e.get("properties").getString("end_date")
477        if(start != null && end != null)
478            return start+";"+end
479        else if(start != null)
480            return start
481        else
482            return end
483    }
484    static Date verifyDate(String year, String month, String day) {
485        def date
486        if(year == null)
487            date = "3000-01-01"
488        else
489            date = year + "-" + (month == null ? "01" : month) + "-" + (day == null ? "01" : day)
490        def df = new java.text.SimpleDateFormat("yyyy-MM-dd")
491        df.setLenient(false)
492        return df.parse(date)
493    }
494    static String getId(Object e) {
495        if (e instanceof ImageryInfo) return e.getId()
496        return e.get("properties").getString("id")
497    }
498    static String getName(Object e) {
499        if (e instanceof ImageryInfo) return e.getOriginalName()
500        return e.get("properties").getString("name")
501    }
502    static List<Shape> getShapes(Object e) {
503        if (e instanceof ImageryInfo) {
504            def bounds = e.getBounds();
505            if(bounds != null) {
506                return bounds.getShapes();
507            }
508            return []
509        }
510        if(!e.isNull("geometry")) {
511            def ex = e.get("geometry")
512            if(ex != null && !ex.isNull("coordinates")) {
513                def poly = ex.get("coordinates")
514                List<Shape> l = []
515                for(def shapes: poly) {
516                    def s = new Shape()
517                    for(def point: shapes) {
518                        def lon = point[0].toString()
519                        def lat = point[1].toString()
520                        s.addPoint(lat, lon)
521                    }
522                    l.add(s)
523                }
524                return l
525            }
526        }
527        return []
528    }
529    static String getType(Object e) {
530        if (e instanceof ImageryInfo) return e.getImageryType().getTypeString()
531        return e.get("properties").getString("type")
532    }
533    static Integer getMinZoom(Object e) {
534        if (e instanceof ImageryInfo) {
535            int mz = e.getMinZoom()
536            return mz == 0 ? null : mz
537        } else {
538            def num = e.get("properties").getJsonNumber("min_zoom")
539            if (num == null) return null
540            return num.intValue()
541        }
542    }
543    static Integer getMaxZoom(Object e) {
544        if (e instanceof ImageryInfo) {
545            int mz = e.getMaxZoom()
546            return mz == 0 ? null : mz
547        } else {
548            def num = e.get("properties").getJsonNumber("max_zoom")
549            if (num == null) return null
550            return num.intValue()
551        }
552    }
553    static String getCountryCode(Object e) {
554        if (e instanceof ImageryInfo) return "".equals(e.getCountryCode()) ? null : e.getCountryCode()
555        return e.get("properties").getString("country_code", null)
556    }
557    static String getQuality(Object e) {
558        //if (e instanceof ImageryInfo) return "".equals(e.getQuality()) ? null : e.getQuality()
559        if (e instanceof ImageryInfo) return null
560        return e.get("properties").get("best") ? "best" : null
561    }
562    static String getIcon(Object e) {
563        if (e instanceof ImageryInfo) return e.getIcon()
564        return e.get("properties").getString("icon", null)
565    }
566    String getDescription(Object o) {
567        def url = getUrl(o)
568        def cc = getCountryCode(o)
569        if (cc == null) {
570            def j = josmUrls.get(url)
571            if (j != null) cc = getCountryCode(j)
572            if (cc == null) {
573                def e = eiiUrls.get(url)
574                if (e != null) cc = getCountryCode(e)
575            }
576        }
577        if (cc == null) {
578            cc = ''
579        } else {
580            cc = "[$cc] "
581        }
582        def d = cc + getName(o) + " - " + getUrl(o)
583        if (options.shorten) {
584            def MAXLEN = 140
585            if (d.length() > MAXLEN) d = d.substring(0, MAXLEN-1) + "..."
586        }
587        return d
588    }
589}
Note: See TracBrowser for help on using the repository browser.