getDocs: function()

in modules/services/osm_wikibase.js [259:340]


    getDocs: function(params, callback) {
        var that = this;
        var langCode = utilDetect().locale.toLowerCase();
        params.langCode = langCode;

        this.getEntity(params, function(err, data) {
            if (err) {
                callback(err);
                return;
            }

            var entity = data.rtype || data.tag || data.key;
            if (!entity) {
                callback('No entity');
                return;
            }

            // prepare result
            var result = {
                title: entity.title,
                description: entity.description,
                editURL: 'https://wiki.openstreetmap.org/wiki/' + entity.title
            };

            // add image
            if (entity.claims) {
                var imageroot;
                var image = that.claimToValue(entity, 'P4', langCode);
                if (image) {
                    imageroot = 'https://commons.wikimedia.org/w/index.php';
                } else {
                    image = that.claimToValue(entity, 'P28', langCode);
                    if (image) {
                        imageroot = 'https://wiki.openstreetmap.org/w/index.php';
                    }
                }
                if (imageroot && image) {
                    result.imageURL = imageroot + '?' + utilQsString({
                        title: 'Special:Redirect/file/' + image,
                        width: 400
                    });
                }
            }

            // Try to get a wiki page from tag data item first, followed by the corresponding key data item.
            // If neither tag nor key data item contain a wiki page in the needed language nor English,
            // get the first found wiki page from either the tag or the key item.
            var rtypeWiki = that.monolingualClaimToValueObj(data.rtype, 'P31');
            var tagWiki = that.monolingualClaimToValueObj(data.tag, 'P31');
            var keyWiki = that.monolingualClaimToValueObj(data.key, 'P31');

            // If exact language code does not exist, try to find the first part before the '-'
            // BUG: in some cases, a more elaborate fallback logic might be needed
            var langPrefix = langCode.split('-', 2)[0];

            // use the first acceptable wiki page
            result.wiki =
                getWikiInfo(rtypeWiki, langCode, 'inspector.wiki_reference') ||
                getWikiInfo(rtypeWiki, langPrefix, 'inspector.wiki_reference') ||
                getWikiInfo(rtypeWiki, 'en', 'inspector.wiki_en_reference') ||
                getWikiInfo(tagWiki, langCode, 'inspector.wiki_reference') ||
                getWikiInfo(tagWiki, langPrefix, 'inspector.wiki_reference') ||
                getWikiInfo(tagWiki, 'en', 'inspector.wiki_en_reference') ||
                getWikiInfo(keyWiki, langCode, 'inspector.wiki_reference') ||
                getWikiInfo(keyWiki, langPrefix, 'inspector.wiki_reference') ||
                getWikiInfo(keyWiki, 'en', 'inspector.wiki_en_reference');

            callback(null, result);


            // Helper method to get wiki info if a given language exists
            function getWikiInfo(wiki, langCode, tKey) {
                if (wiki && wiki[langCode]) {
                    return {
                        title: wiki[langCode],
                        text: tKey,
                        url: 'https://wiki.openstreetmap.org/wiki/' + wiki[langCode]
                    };
                }
            }
        });
    },