Ticket #1259: kml_styling_v3.diff

lib/OpenLayers/Format/KML.js

@@ -48 +48 @@
-    /**
-     * APIProperty: extractAttributes
-     * {Boolean} Extract attributes from KML.  Default is true.
+     *           Extracting styleUrls requires this to be set to true
-     */
-    extractAttributes: true,
-    
@@ -59 +60 @@
-    internalns: null,
-
-    /**
+     * Property: features
+     * {Array} Array of features
+     *     
+     */
+    features: null,
+
+    /**
+     * Property: styles
+     * {Object} Storage of style objects
+     *     
+     */
+    styles: null,
+
+    /**
+     * Property: fetched
+     * {Object} Storage of KML URLs that have been fetched before
+     *     in order to prevent reloading them.
+     */
+    fetched: null,
+
+    /**
+     * APIProperty: maxDepth
+     * {Integer} Maximum depth for recursive loading external KML URLs 
+     *           Defaults to 0: do no external fetching
+     */
+    maxDepth: 0,
+
+    /**
-     * Constructor: OpenLayers.Format.KML
-     * Create a new parser for KML.
-     *
@@ -72 +101 @@
-            trimSpace: (/^\s*|\s*$/g),
-            removeSpace: (/\s*/g),
-            splitSpace: (/\s+/),
-
+
+
+
+
-        };
-        OpenLayers.Format.XML.prototype.initialize.apply(this, [options]);
-    },
@@ -88 +120 @@
-     * {Array(<OpenLayers.Feature.Vector>)} List of features.
-     */
-    read: function(data) {
+        this.features = this.features || [];
+        this.styles   = this.styles   || {};
+        this.fetched  = this.fetched  || {};
+        return this.parseData(data);
+    },
+
+    /**
+     * Method: parseData
+     * Read data from a string, and return a list of features. 
+     * 
+     * Parameters: 
+     * data    - {String} or {DOMElement} data to read/parse.
+     * options - {Object} Hash of options
+     *
+     * Returns:
+     * {Array(<OpenLayers.Feature.Vector>)} List of features.
+     */
+    parseData: function(data, options) {
-        if(typeof data == "string") {
-            data = OpenLayers.Format.XML.prototype.read.apply(this, [data]);
-        }
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-            if(feature) {
+
+                // Create reference to styleUrl 
+                if (feature.attributes && feature.attributes.styleUrl) {
+                    feature.style = this.getStyle(feature.attributes.styleUrl);
+                }
+
+                // Make sure that <Style> nodes within a placemark are 
+                // processed as well
+                var inlineStyleNode = this.getElementsByTagNameNS(featureNode,
+                                                       "*",
+                                                       "Style")[0];
+                if (inlineStyleNode) {
+                    var inlineStyle= this.parseStyle(styleNode);
+                    if (inlineStyle) {
+                        feature.style = OpenLayers.Util.extend({}, 
+                                            feature.style);
+                        OpenLayers.Util.extend(feature.style, inlineStyle);
+                    }
+                }
+
+                // add feature to list of features
-                features[i] = feature;
-            } else {
-                throw "Bad Placemark: " + i;
-            }
-        }
-
+
+
+
-    },
-
-    /**
@@ -154 +591 @@
-        }
-        var feature = new OpenLayers.Feature.Vector(geometry, attributes);
-
-
+ || node.getAttribute("name")
-        if(fid != null) {
-            feature.fid = fid;
-        }
@@ -163 +600 @@
-    },        
-    
-    /**
+     * Method: getStyle
+     * Retrieves a style from a style hash using styleUrl as the key
+     * If the styleUrl doesn't exist yet, we try to fetch it 
+     * Internet
+     * 
+     * Parameters: 
+     * styleUrl  - {String} URL of style
+     * options   - {Object} Hash of options 
+     *
+     * Returns:
+     * {Object}  - (reference to) Style hash
+     */
+    getStyle: function(styleUrl, options) {
+
+        var styleBaseUrl = OpenLayers.Util.removeTail(styleUrl);
+
+        var newOptions = OpenLayers.Util.extend({}, options);
+        newOptions.depth++;
+        newOptions.styleBaseUrl = styleBaseUrl;
+
+        // Fetch remote Style URLs (if not fetched before) 
+        if (!this.styles[styleUrl] 
+                && !OpenLayers.String.startsWith(styleUrl, "#") 
+                && newOptions.depth <= this.maxDepth
+                && !this.fetched[styleBaseUrl] ) {
+
+            var data = this.fetchLink(styleBaseUrl);
+            if (data) {
+                this.parseData(data, newOptions);
+            }
+
+        }
+
+        // return requested style
+        var style = this.styles[styleUrl];
+        return style;
+    },
+    
+    /**
-     * Property: parseGeometry
-     * Properties of this object are the functions that parse geometries based
-     *     on their type.
@@ -334 +810 @@
-     */
-    parseAttributes: function(node) {
-        var attributes = {};
-
+or 4 
-        var child, grandchildren, grandchild;
-        var children = node.childNodes;
-        for(var i=0; i<children.length; ++i) {
-            child = children[i];
-            if(child.nodeType == 1) {
-                grandchildren = child.childNodes;
-
-
+
+
+
+
+
+
+
+
+
+
+
-                    if(grandchild.nodeType == 3 || grandchild.nodeType == 4) {
-                        var name = (child.prefix) ?
-                                child.nodeName.split(":")[1] :
-                                child.nodeName;
-
-
-
+
+
+
+
+
-                    }
-
+ 
-            }
-        }
-        return attributes;
-    },
-
+    
-    /**
+     * Method: parseProperty
+     * Convenience method to find a node and return its value
+     *
+     * Parameters:
+     * xmlNode    - {<DOMElement>}
+     * namespace  - {String} namespace of the node to find
+     * tagName    - {String} name of the property to parse
+     * 
+     * Returns:
+     * {String} The value for the requested property (defaults to null)
+     */    
+    parseProperty: function(xmlNode, namespace, tagName) {
+        var value;
+        var nodeList = this.getElementsByTagNameNS(xmlNode, namespace, tagName);
+        try {
+            value = OpenLayers.Util.getXmlNodeValue(nodeList[0]);
+        } catch(e) {
+            value = null;
+        }
+     
+        return value;
+    },                                                              
+
+    /**
-     * APIMethod: write
-     * Accept Feature Collection, and return a string. 
-     *