source: josm/trunk/scripts/TagInfoExtract.groovy @ 9953

Last change on this file since 9953 was 9953, checked in by Don-vip, 4 years ago

fix sonar issues in Groovy and XML files

  • Property svn:eol-style set to native
File size: 17.4 KB
Line 
1// License: GPL. For details, see LICENSE file.
2/**
3 * Extracts tag information for the taginfo project.
4 *
5 * Run from the base directory of a JOSM checkout:
6 *
7 * groovy -cp dist/josm-custom.jar scripts/taginfoextract.groovy -t mappaint
8 * groovy -cp dist/josm-custom.jar scripts/taginfoextract.groovy -t presets
9 * groovy -cp dist/josm-custom.jar scripts/taginfoextract.groovy -t external_presets
10 */
11import groovy.json.JsonBuilder
12
13import java.awt.image.BufferedImage
14import java.nio.file.FileSystems
15import java.nio.file.Files
16import java.nio.file.Path
17
18import javax.imageio.ImageIO
19
20import org.openstreetmap.josm.Main
21import org.openstreetmap.josm.data.Version
22import org.openstreetmap.josm.data.coor.LatLon
23import org.openstreetmap.josm.data.osm.Node
24import org.openstreetmap.josm.data.osm.OsmPrimitive
25import org.openstreetmap.josm.data.osm.Way
26import org.openstreetmap.josm.data.osm.visitor.paint.MapPaintSettings
27import org.openstreetmap.josm.data.osm.visitor.paint.StyledMapRenderer
28import org.openstreetmap.josm.data.projection.Projections
29import org.openstreetmap.josm.gui.NavigatableComponent
30import org.openstreetmap.josm.gui.mappaint.Environment
31import org.openstreetmap.josm.gui.mappaint.MultiCascade
32import org.openstreetmap.josm.gui.mappaint.MapPaintStyles.IconReference
33import org.openstreetmap.josm.gui.mappaint.mapcss.MapCSSStyleSource
34import org.openstreetmap.josm.gui.mappaint.mapcss.Condition.SimpleKeyValueCondition
35import org.openstreetmap.josm.gui.mappaint.mapcss.Selector.GeneralSelector
36import org.openstreetmap.josm.gui.mappaint.mapcss.parsergen.MapCSSParser
37import org.openstreetmap.josm.gui.mappaint.styleelement.AreaElement
38import org.openstreetmap.josm.gui.mappaint.styleelement.LineElement
39import org.openstreetmap.josm.gui.mappaint.styleelement.StyleElement
40import org.openstreetmap.josm.gui.preferences.map.TaggingPresetPreference
41import org.openstreetmap.josm.gui.tagging.presets.TaggingPreset
42import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetReader
43import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetType
44import org.openstreetmap.josm.gui.tagging.presets.items.KeyedItem
45import org.openstreetmap.josm.gui.tagging.presets.items.KeyedItem.MatchType
46import org.openstreetmap.josm.io.CachedFile
47import org.openstreetmap.josm.tools.Utils
48
49class TagInfoExtract {
50
51    static def options
52    static String image_dir
53    int josm_svn_revision
54    String input_file
55    MapCSSStyleSource style_source
56    FileWriter output_file
57    String base_dir = "."
58    Set tags = []
59
60    private def cached_svnrev
61
62    /**
63     * Check if a certain tag is supported by the style as node / way / area.
64     */
65    abstract class Checker {
66
67        def tag
68        OsmPrimitive osm
69
70        Checker(tag) {
71            this.tag = tag
72        }
73
74        Environment apply_stylesheet(OsmPrimitive osm) {
75            osm.put(tag[0], tag[1])
76            MultiCascade mc = new MultiCascade()
77
78            Environment env = new Environment(osm, mc, null, style_source)
79            for (def r in style_source.rules) {
80                env.clearSelectorMatchingInformation()
81                if (r.selector.matches(env)) {
82                    // ignore selector range
83                    if (env.layer == null) {
84                        env.layer = "default"
85                    }
86                    r.execute(env)
87                }
88            }
89            env.layer = "default"
90            return env
91        }
92
93        /**
94         * Create image file from StyleElement.
95         * @return the URL
96         */
97        def create_image(StyleElement elem_style, type, nc) {
98            def img = new BufferedImage(16, 16, BufferedImage.TYPE_INT_ARGB)
99            def g = img.createGraphics()
100            g.setClip(0, 0, 16, 16)
101            def renderer = new StyledMapRenderer(g, nc, false)
102            renderer.getSettings(false)
103            elem_style.paintPrimitive(osm, MapPaintSettings.INSTANCE, renderer, false, false, false)
104            def base_url = options.imgurlprefix ? options.imgurlprefix : image_dir
105            def image_name = "${type}_${tag[0]}=${tag[1]}.png"
106            ImageIO.write(img, "png", new File("${image_dir}/${image_name}"))
107            return "${base_url}/${image_name}"
108        }
109
110        /**
111         * Checks, if tag is supported and find URL for image icon in this case.
112         * @param generate_image if true, create or find a suitable image icon and return URL,
113         * if false, just check if tag is supported and return true or false
114         */
115        abstract def find_url(boolean generate_image)
116    }
117
118    class NodeChecker extends Checker {
119        NodeChecker(tag) {
120            super(tag)
121        }
122
123        @Override
124        def find_url(boolean generate_image) {
125            osm = new Node(LatLon.ZERO)
126            def env = apply_stylesheet(osm)
127            def c = env.mc.getCascade("default")
128            def image = c.get("icon-image")
129            if (image) {
130                if (image instanceof IconReference) {
131                    if (image.iconName != "misc/deprecated.png")
132                        return find_image_url(image.iconName)
133                }
134            }
135        }
136    }
137
138    class WayChecker extends Checker {
139        WayChecker(tag) {
140            super(tag)
141        }
142
143        @Override
144        def find_url(boolean generate_image) {
145            osm = new Way()
146            def nc = new NavigatableComponent()
147            def n1 = new Node(nc.getLatLon(2,8))
148            def n2 = new Node(nc.getLatLon(14,8))
149            ((Way)osm).addNode(n1)
150            ((Way)osm).addNode(n2)
151            def env = apply_stylesheet(osm)
152            def les = LineElement.createLine(env)
153            if (les != null) {
154                if (!generate_image) return true
155                return create_image(les, 'way', nc)
156            }
157        }
158    }
159
160    class AreaChecker extends Checker {
161        AreaChecker(tag) {
162            super(tag)
163        }
164
165        @Override
166        def find_url(boolean generate_image) {
167            osm = new Way()
168            def nc = new NavigatableComponent()
169            def n1 = new Node(nc.getLatLon(2,2))
170            def n2 = new Node(nc.getLatLon(14,2))
171            def n3 = new Node(nc.getLatLon(14,14))
172            def n4 = new Node(nc.getLatLon(2,14))
173            ((Way)osm).addNode(n1)
174            ((Way)osm).addNode(n2)
175            ((Way)osm).addNode(n3)
176            ((Way)osm).addNode(n4)
177            ((Way)osm).addNode(n1)
178            def env = apply_stylesheet(osm)
179            def aes = AreaElement.create(env)
180            if (aes != null) {
181                if (!generate_image) return true
182                return create_image(aes, 'area', nc)
183            }
184        }
185    }
186
187    /**
188     * Main method.
189     */
190    static main(def args) {
191        parse_command_line_arguments(args)
192        def script = new TagInfoExtract()
193        if (!options.t || options.t == 'mappaint') {
194            script.run()
195        } else if (options.t == 'presets') {
196            script.run_presets()
197        } else if (options.t == 'external_presets') {
198            script.run_external_presets()
199        } else {
200            System.err.println 'Invalid type ' + options.t
201            if (!options.noexit) {
202                System.exit(1)
203            }
204        }
205
206        if (!options.noexit) {
207            System.exit(0)
208        }
209    }
210
211    /**
212     * Parse command line arguments.
213     */
214    static void parse_command_line_arguments(args) {
215        def cli = new CliBuilder(usage:'taginfoextract.groovy [options] [inputfile]',
216            header:"Options:",
217            footer:"[inputfile]           the file to process (optional, default is 'resource://styles/standard/elemstyles.mapcss')")
218        cli.o(args:1, argName: "file", "output file (json), - prints to stdout (default: -)")
219        cli.t(args:1, argName: "type", "the project type to be generated")
220        cli._(longOpt:'svnrev', args:1, argName:"revision", "corresponding revision of the repository https://svn.openstreetmap.org/ (optional, current revision is read from the local checkout or from the web if not given, see --svnweb)")
221        cli._(longOpt:'imgdir', args:1, argName:"directory", "directory to put the generated images in (default: ./taginfo-img)")
222        cli._(longOpt:'noexit', "don't call System.exit(), for use from Ant script")
223        cli._(longOpt:'svnweb', 'fetch revision of the repository https://svn.openstreetmap.org/ from web and not from the local repository')
224        cli._(longOpt:'imgurlprefix', args:1, argName:'prefix', 'image URLs prefix for generated image files')
225        cli.h(longOpt:'help', "show this help")
226        options = cli.parse(args)
227
228        if (options.h) {
229            cli.usage()
230            System.exit(0)
231        }
232        if (options.arguments().size() > 1) {
233            System.err.println "Error: More than one input file given!"
234            cli.usage()
235            System.exit(-1)
236        }
237        if (options.svnrev) {
238            assert Integer.parseInt(options.svnrev) > 0
239        }
240        image_dir = 'taginfo-img'
241        if (options.imgdir) {
242            image_dir = options.imgdir
243        }
244        def image_dir_file = new File(image_dir)
245        if (!image_dir_file.exists()) {
246            image_dir_file.mkdirs()
247        }
248    }
249
250    void run_presets() {
251        init()
252        def presets = TaggingPresetReader.readAll(input_file, true)
253        def tags = convert_presets(presets, "", true)
254        write_json("JOSM main presets", "Tags supported by the default presets in the OSM editor JOSM", tags)
255    }
256
257    def convert_presets(Iterable<TaggingPreset> presets, String descriptionPrefix, boolean addImages) {
258        def tags = []
259        for (TaggingPreset preset : presets) {
260            for (KeyedItem item : Utils.filteredCollection(preset.data, KeyedItem.class)) {
261                def values
262                switch (MatchType.ofString(item.match)) {
263                    case MatchType.KEY_REQUIRED: values = item.getValues(); break;
264                    case MatchType.KEY_VALUE_REQUIRED: values = item.getValues(); break;
265                    default: values = [];
266                }
267                for (String value : values) {
268                    def tag = [
269                            description: descriptionPrefix + preset.name,
270                            key: item.key,
271                            value: value,
272                            object_types: preset.types.collect {it == TaggingPresetType.CLOSEDWAY ? "area" : it.toString().toLowerCase()},
273                    ]
274                    if (addImages && preset.iconName) tag += [icon_url: find_image_url(preset.iconName)]
275                    tags += tag
276                }
277            }
278        }
279        return tags
280    }
281
282    void run_external_presets() {
283        init()
284        TaggingPresetReader.setLoadIcons(false)
285        def sources = new TaggingPresetPreference.TaggingPresetSourceEditor().loadAndGetAvailableSources()
286        def tags = []
287        for (def source : sources) {
288            if (source.url.startsWith("resource")) {
289                // default presets
290                continue;
291            }
292            try {
293                println "Loading ${source.url}"
294                def presets = TaggingPresetReader.readAll(source.url, false)
295                def t = convert_presets(presets, source.title + " ", false)
296                println "Converting ${t.size()} presets of ${source.title}"
297                tags += t
298            } catch (Exception ex) {
299                System.err.println("Skipping ${source.url} due to error")
300                ex.printStackTrace()
301            }
302        }
303        write_json("JOSM user presets", "Tags supported by the user contributed presets in the OSM editor JOSM", tags)
304    }
305
306    void run() {
307        init()
308        parse_style_sheet()
309        collect_tags()
310
311        def tags = tags.collect {
312            def tag = it
313            def types = []
314            def final_url = null
315
316            def node_url = new NodeChecker(tag).find_url(true)
317            if (node_url) {
318                types += 'node'
319                final_url = node_url
320            }
321            def way_url = new WayChecker(tag).find_url(final_url == null)
322            if (way_url) {
323                types += 'way'
324                if (!final_url) {
325                    final_url = way_url
326                }
327            }
328            def area_url = new AreaChecker(tag).find_url(final_url == null)
329            if (area_url) {
330                types += 'area'
331                if (!final_url) {
332                    final_url = area_url
333                }
334            }
335
336            def obj = [key: tag[0], value: tag[1]]
337            if (types) obj += [object_types: types]
338            if (final_url) obj += [icon_url: final_url]
339            obj
340        }
341
342        write_json("JOSM main mappaint style", "Tags supported by the main mappaint style in the OSM editor JOSM", tags)
343    }
344
345    void write_json(name, description, tags) {
346        def json = new JsonBuilder()
347        def project = [
348                name: name,
349                description: description,
350                project_url: "https://josm.openstreetmap.de/",
351                icon_url: "https://josm.openstreetmap.de/export/7770/josm/trunk/images/logo_16x16x8.png",
352                contact_name: "JOSM developer team",
353                contact_email: "josm-dev@openstreetmap.org",
354        ]
355        json data_format: 1, data_updated: new Date().format("yyyyMMdd'T'hhmmssZ"), project: project, tags: tags
356
357        if (output_file != null) {
358            json.writeTo(output_file)
359            output_file.close()
360        } else {
361            print json.toPrettyString()
362        }
363    }
364
365    /**
366     * Initialize the script.
367     */
368    def init() {
369        Main.initApplicationPreferences()
370        Main.determinePlatformHook()
371        Main.pref.enableSaveOnPut(false)
372        Main.setProjection(Projections.getProjectionByCode("EPSG:3857"))
373        Path tmpdir = Files.createTempDirectory(FileSystems.getDefault().getPath(base_dir), "pref")
374        tmpdir.toFile().deleteOnExit()
375        System.setProperty("josm.home", tmpdir.toString())
376
377        josm_svn_revision = Version.getInstance().getVersion()
378        assert josm_svn_revision != Version.JOSM_UNKNOWN_VERSION
379
380        if (options.arguments().size() == 0 && (!options.t || options.t == 'mappaint')) {
381            input_file = "resource://styles/standard/elemstyles.mapcss"
382        } else if (options.arguments().size() == 0 && options.t == 'presets') {
383            input_file = "resource://data/defaultpresets.xml"
384        } else {
385            input_file = options.arguments()[0]
386        }
387
388        output_file = null
389        if (options.o && options.o != "-") {
390            output_file = new FileWriter(options.o)
391        }
392    }
393
394    /**
395     * Determine full image url (can refer to JOSM or OSM repository).
396     */
397    def find_image_url(String path) {
398        def f = new File("${base_dir}/images/styles/standard/${path}")
399        if (f.exists()) {
400            def rev = osm_svn_revision()
401            return "https://trac.openstreetmap.org/export/${rev}/subversion/applications/share/map-icons/classic.small/${path}"
402        }
403        f = new File("${base_dir}/images/${path}")
404        if (f.exists()) {
405            if (path.startsWith("images/styles/standard/")) {
406                path = path.substring("images/styles/standard/".length())
407                def rev = osm_svn_revision()
408                return "https://trac.openstreetmap.org/export/${rev}/subversion/applications/share/map-icons/classic.small/${path}"
409            } else if (path.startsWith("styles/standard/")) {
410                path = path.substring("styles/standard/".length())
411                def rev = osm_svn_revision()
412                return "https://trac.openstreetmap.org/export/${rev}/subversion/applications/share/map-icons/classic.small/${path}"
413            } else {
414                return "https://josm.openstreetmap.de/export/${josm_svn_revision}/josm/trunk/images/${path}"
415            }
416        }
417        assert false, "Cannot find image url for ${path}"
418    }
419
420    /**
421     * Get revision for the repository https://svn.openstreetmap.org.
422     */
423    def osm_svn_revision() {
424        if (cached_svnrev != null) return cached_svnrev
425        if (options.svnrev) {
426            cached_svnrev = Integer.parseInt(options.svnrev)
427            return cached_svnrev
428        }
429        def xml
430        if (options.svnweb) {
431            xml = "svn info --xml https://svn.openstreetmap.org/applications/share/map-icons/classic.small".execute().text
432        } else {
433            xml = "svn info --xml ${base_dir}/images/styles/standard/".execute().text
434        }
435
436        def svninfo = new XmlParser().parseText(xml)
437        def rev = svninfo.entry.'@revision'[0]
438        cached_svnrev = Integer.parseInt(rev)
439        assert cached_svnrev > 0
440        return cached_svnrev
441    }
442
443    /**
444     * Read the style sheet file and parse the MapCSS code.
445     */
446    def parse_style_sheet() {
447        def file = new CachedFile(input_file)
448        def stream = file.getInputStream()
449        def parser = new MapCSSParser(stream, "UTF-8", MapCSSParser.LexicalState.DEFAULT)
450        style_source = new MapCSSStyleSource("")
451        style_source.url = ""
452        parser.sheet(style_source)
453    }
454
455    /**
456     * Collect all the tag from the style sheet.
457     */
458    def collect_tags() {
459        for (rule in style_source.rules) {
460            def selector = rule.selector
461            if (selector instanceof GeneralSelector) {
462                def conditions = selector.getConditions()
463                for (cond in conditions) {
464                    if (cond instanceof SimpleKeyValueCondition) {
465                        tags.add([cond.k, cond.v])
466                    }
467                }
468            }
469        }
470    }
471}
Note: See TracBrowser for help on using the repository browser.