Ticket #1176: WMSCapabilities.patch

Format/WMSCapabilities/v1_1_1.js

@@ +1 @@
+/**
+ * @requires OpenLayers/Format/WMSCapabilities.js
+ *
+ * Class: OpenLayers.Format.WMSCapabilities.v1_1_1
+ * Read WMS Capabilities version 1.1.1.
+ * 
+ * Inherits from:
+ *  - <OpenLayers.Format.WMSCapabilities>
+ */
+OpenLayers.Format.WMSCapabilities.v1_1_1 = OpenLayers.Class(
+    OpenLayers.Format.WMSCapabilities, {
+    
+    /**
+     * Constructor: OpenLayers.Format.WMSCapabilities.v1_1_1
+     * Create a new parser for WMS capabilities version 1_1_1.
+     *
+     * Parameters:
+     * options - {Object} An optional object whose properties will be set on
+     *     this instance.
+     */
+    initialize: function(options) {
+        OpenLayers.Format.WMSCapabilities.prototype.initialize.apply(
+            this, [options]
+        );
+    },
+
+    /**
+     * APIMethod: read
+     * Read capabilities data from a string, and return a list of layers. 
+     * 
+     * Parameters: 
+     * data - {String} or {DOMElement} data to read/parse.
+     *
+     * Returns:
+     * {Array} List of named layers.
+     */
+    read: function(data) {
+        if(typeof data == "string") {
+            data = OpenLayers.Format.XML.prototype.read.apply(this, [data]);
+        }
+        var capabilities = {};
+        var root = data.documentElement;
+        this.runChildNodes(capabilities, root);
+        return capabilities;
+    },
+    
+    /**
+     * Method: runChildNodes
+     */
+    runChildNodes: function(obj, node) {
+        var children = node.childNodes;
+        var childNode, processor;
+        for(var i=0; i<children.length; ++i) {
+            childNode = children[i];
+            if(childNode.nodeType == 1) {
+                processor = this["process" + childNode.nodeName];
+                if(processor) {
+                    processor.apply(this, [obj, childNode]);
+                }
+            }
+        }
+    },
+
+
+    /**
+     * Method: processService
+     */
+    processService: function(capabilities, node) {
+        var service = {};
+        this.runChildNodes(service, node);
+        capabilities.service = service;
+    },
+
+    /**
+     * Method: processName
+     */
+    processName: function(obj, node) {
+        var id = this.getChildValue(node);
+        if(id) {
+            obj["name"] = id;
+        }
+    },
+
+    /**
+     * Method: processAbstract
+     */
+    processAbstract: function(obj, node) {
+        var abst = this.getChildValue(node);
+        if(abst) {
+            obj["abstract"] = abst;
+        }
+    },
+
+    /**
+     * Method: processKeywordList
+     */
+    processKeywordList: function(obj, node) {
+        obj.keywords = [];
+        this.runChildNodes(obj, node);
+    },
+
+    /**
+     * Method: processKeyword
+     */
+    processKeyword: function(obj, node) {
+        var keyword = this.getChildValue(node);
+        obj.keywords.push(keyword);
+    },
+
+
+    /**
+     * Method: processCapability
+     */
+    processCapability: function(capabilities, node) {
+        var capability = {
+            layers: []
+        };
+        this.runChildNodes(capability, node);
+        capabilities.capability = capability;
+    },
+
+    /**
+     * Method: processRequest
+     */
+    processRequest: function(capabilities, node) {
+        var requests = {};
+        this.runChildNodes(requests, node);
+        capabilities.requests = requests;
+    },    
+
+    /**
+     * Method: processGetCapabilities
+     */
+    processGetCapabilities: function(requests, node) {
+        var GetCapabilities = {
+            format: []
+        };
+        this.runChildNodes(GetCapabilities, node);
+        requests.GetCapabilities = GetCapabilities;
+    },
+
+    /**
+     * Method: processGetMap
+     */
+    processGetMap: function(requests, node) {
+        var GetMap = {
+            format: []
+        };
+        this.runChildNodes(GetMap, node);
+        requests.GetMap = GetMap;
+    },
+
+    /**
+     * Method: processGetFeatureInfo
+     */
+    processGetFeatureInfo: function(requests, node) {
+        var GetFeatureInfo = {
+            format: []
+        };
+        this.runChildNodes(GetFeatureInfo, node);
+        requests.GetFeatureInfo = GetFeatureInfo;
+    },
+
+    /**
+     * Method: processFormat
+     */
+    processFormat: function(request, node) {
+        var format = this.getChildValue(node);
+        request.format.push(format);
+    },
+
+    /**
+     * Method: processDCPType
+     */
+    processDCPType: function(request, node) {
+        this.runChildNodes(request, node);
+    },
+
+    /**
+     * Method: processHTTP
+     */
+    processHTTP: function(request, node) {
+        this.runChildNodes(request, node);
+    },
+
+    /**
+     * Method: processGet
+     */
+    processGet: function(request, node) {
+        this.readMethod(request, "GET", node);
+    },
+
+    /**
+     * Method: processPost
+     */
+    processPost: function(request, node) {
+        this.readMethod(request, "POST", node);
+    },
+
+    readMethod: function(request, method, node) {
+        var children = node.childNodes;
+        for(var i=0; i<children.length; ++i) {
+            childNode = children[i];
+            if(childNode.nodeType == 1) {
+                var href = this.getAttributeNS(
+                    childNode, "http://www.w3.org/1999/xlink", "href"
+                );
+                
+                if(href.indexOf("?") < 0)
+                    href += "?";
+                else if(href.lastIndexOf("&", href.length-1) != href.length-1)
+                    href += "&";
+                
+                request[method] = href;
+            }
+        }
+    },
+    
+    /**
+     * Method: processLayer
+     */
+    processLayer: function(capability, node, parentLayer) {
+        var layer = {
+            styles: [],
+            bbox: {},
+            srs: []
+        };
+        
+        // deal with property inheritance
+        if(parentLayer) {
+            if("styles" in parentLayer)
+                layer.styles = layer.styles.concat(parentLayer.styles);
+            if("srs" in parentLayer)
+                layer.srs = layer.srs.concat(parentLayer.srs);
+            if("bbox" in parentLayer)
+                OpenLayers.Util.applyDefaults(layer.bbox, parentLayer.bbox);
+        }
+        
+        // if the layer supports GetFeatureInfo request
+        if(node.getAttribute("queryable"))
+            layer.queryable = node.getAttribute("queryable") == "1";
+        // this attribute can be inherited
+        else if(parentLayer && "queryable" in parentLayer)
+            layer.queryable = parentLayer.queryable;
+        else
+            layer.queryable = false;
+        
+        var children = node.childNodes;
+        var childNode, nodeName, processor;
+        for(var i=0; i<children.length; ++i) {
+            childNode = children[i];
+            nodeName = childNode.nodeName;
+            processor = this["process" + childNode.nodeName];
+            if(processor) {
+                if(nodeName == "Layer") {
+                    processor.apply(this, [capability, childNode, layer]);
+                } else {
+                    processor.apply(this, [layer, childNode]);
+                }
+            }
+        }
+        if("name" in layer) {
+            var index = layer.name.indexOf(":");
+            if(index > 0) {
+                layer.prefix = layer.name.substring(0, index);
+            }
+            capability.layers.push(layer);
+        }
+    },
+    
+    /**
+     * Method: processSRS
+     */
+    processSRS: function(obj, node) {
+        var srs = this.getChildValue(node);
+        if(srs) {
+            srs = srs.split(' ');
+            
+            // do not duplicate values
+            for(var i=0; i<srs.length; ++i) {
+                var test = false;
+                for(var j=0; j<obj.srs.length; ++j)
+                    if(srs[i] == obj.srs[j]) {
+                        test = true;
+                        break;
+                    }
+                if(!test)
+                    obj.srs.push(srs[i]);
+            }
+        }
+    },
+
+    /**
+     * Method: processTitle
+     */
+    processTitle: function(obj, node) {
+        var title = this.getChildValue(node);
+        if(title) {
+            obj.title = title;
+        }
+    },
+
+    /**
+     * Method: processLatLonBoundingBox
+     */
+    processLatLonBoundingBox: function(layer, node) {
+        layer.bbox["default"] = new OpenLayers.Bounds(
+            parseFloat(node.getAttribute("minx")),
+            parseFloat(node.getAttribute("miny")),
+            parseFloat(node.getAttribute("maxx")),
+            parseFloat(node.getAttribute("maxy"))
+        );
+    },
+    
+    
+    /**
+     * Method: processBoundingBox
+     */
+    processBoundingBox: function(layer, node) {
+        var srs = node.getAttribute("SRS");
+        
+        layer.bbox[srs] = new OpenLayers.Bounds(
+            parseFloat(node.getAttribute("minx")),
+            parseFloat(node.getAttribute("miny")),
+            parseFloat(node.getAttribute("maxx")),
+            parseFloat(node.getAttribute("maxy"))
+        );
+    },
+    
+    /**
+     * Method: processStyle
+     */
+    processStyle: function(layer, node) {
+        var style = {};
+        this.runChildNodes(style, node);
+        layer.styles.push(style);
+    },
+
+    /**
+     * Method: processLegendURL
+     */
+    processLegendURL: function(style, node) {
+        var legend = {
+            width: node.getAttribute('width'),
+            height: node.getAttribute('height')
+        };
+        var links = node.getElementsByTagName("OnlineResource");
+        if(links.length > 0) {
+            this.processOnlineResource(legend, links[0]);
+        }
+        style.legend = legend;
+    },
+    
+    /**
+     * Method: processOnlineResource
+     */
+    processOnlineResource: function(obj, node) {
+        obj.href = this.getAttributeNS(
+            node, "http://www.w3.org/1999/xlink", "href"
+        );
+    },
+
+    CLASS_NAME: "OpenLayers.Format.WMSCapabilities.v1_1_1" 
+
+});

Format/WMSCapabilities.js

@@ +1 @@
+/**
+ * @requires OpenLayers/Format/XML.js
+ *
+ * Class: OpenLayers.Format.WMSCapabilities
+ * Read WMS Capabilities.
+ * 
+ * Inherits from:
+ *  - <OpenLayers.Format.XML>
+ */
+OpenLayers.Format.WMSCapabilities = OpenLayers.Class(OpenLayers.Format.XML, {
+    
+    /**
+     * APIProperty: defaultVersion
+     * {String} Version number to assume if none found.  Default is "1.1.1".
+     */
+    defaultVersion: "1.1.1",
+    
+    /**
+     * APIProperty: version
+     * {String} Specify a version string if one is known.
+     */
+    version: null,
+
+    /**
+     * Constructor: OpenLayers.Format.WMSCapabilities
+     * Create a new parser for WMS capabilities.
+     *
+     * Parameters:
+     * options - {Object} An optional object whose properties will be set on
+     *     this instance.
+     */
+    initialize: function(options) {
+        OpenLayers.Format.XML.prototype.initialize.apply(this, [options]);
+        this.options = options;
+    },
+
+    /**
+     * APIMethod: read
+     * Read capabilities data from a string, and return a list of layers. 
+     * 
+     * Parameters: 
+     * data - {String} or {DOMElement} data to read/parse.
+     *
+     * Returns:
+     * {Array} List of named layers.
+     */
+    read: function(data) {
+        if(typeof data == "string") {
+            data = OpenLayers.Format.XML.prototype.read.apply(this, [data]);
+        }
+        var root = data.documentElement;
+        var version = this.version;
+        if(!version) {
+            version = root.getAttribute("version");
+            if(!version) {
+                version = this.defaultVersion;
+            }
+        }
+        var constructor = OpenLayers.Format.WMSCapabilities[
+            "v" + version.replace(/\./g, "_")
+        ];
+        if(!constructor) {
+            throw "Can't find a WMS capabilities parser for version " + version;
+        }
+        var parser = new constructor(this.options);
+        var capabilities = parser.read(data);
+        capabilities.version = version;
+        return capabilities;
+    },
+    
+    CLASS_NAME: "OpenLayers.Format.WMSCapabilities" 
+
+});