Ticket #1259: kml_styling_v2.diff

lib/OpenLayers/Format/KML.js

@@ -48 +48 @@
-    /**
-     * APIProperty: extractAttributes
-     * {Boolean} Extract attributes from KML.  Default is true.
+     *           Extracting styles requires this to be set to true
-     */
-    extractAttributes: true,
-    
+    /* APIProperty: reverseFeatures 
+     * {Boolean} Reverse drawing order of features. Default is false, but
+     *           it seems like it should be true.
+     * */
+    reverseFeatures: false,
+
-    /**
-     * Property: internalns
-     * {String} KML Namespace to use -- defaults to the namespace of the
@@ -59 +66 @@
-    internalns: null,
-
-    /**
+     * Property: features
+     * {Array} Array of features
+     *     
+     */
+    features: [],
+
+    /**
+     * Property: styles
+     * {Object} Storage of style objects
+     *     
+     */
+    styles: {},
+
+    /**
+     * Property: fetched
+     * {Object} Storage of KML URLs that have been fetched before
+     *     in order to prevent reloading them.
+     */
+    fetched: {},
+
+    /**
+     * APIProperty: maxDepth
+     * {Integer} Maximum depth for recursive loading external KML URLs 
+     *           Defaults to 1: fetch 1 level deep 
+     *           To disable any external fetching: set this to 0
+     */
+    maxDepth: 1,
+
+    /**
-     * Constructor: OpenLayers.Format.KML
-     * Create a new parser for KML.
-     *
@@ -72 +108 @@
-            trimSpace: (/^\s*|\s*$/g),
-            removeSpace: (/\s*/g),
-            splitSpace: (/\s+/),
-
+
+
+
+
-        };
-        OpenLayers.Format.XML.prototype.initialize.apply(this, [options]);
-    },
@@ -82 +121 @@
-     * Read data from a string, and return a list of features. 
-     * 
-     * Parameters: 
-
+
+
-     *
-     * Returns:
-     * {Array(<OpenLayers.Feature.Vector>)} List of features.
-     */
-
+, options
-        if(typeof data == "string") {
-            data = OpenLayers.Format.XML.prototype.read.apply(this, [data]);
-        }
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-            if(feature) {
+                // give feature default style
+                var styleHash = OpenLayers.Util.extend({}, 
+                                   OpenLayers.Feature.Vector.style["default"]);
+                 
+                if (feature.attributes.styleUrl) {
+                    var urlStyleObject = this.getStyle(
+                                         feature.attributes.styleUrl, options);
+                    if (urlStyleObject) {
+                        OpenLayers.Util.extend(styleHash, 
+                                           urlStyleObject.createStyle(feature));
+                    }
+                }
+
+                // Make sure that <Style> nodes within a placemark are 
+                // processed as well: add a styleUrl attribute to the feature.
+                var styleNode = this.getElementsByTagNameNS(featureNode,
+                                                       "*",
+                                                       "Style")[0];
+                if (styleNode) {
+                    var inlineStyleObject = this.parseStyle(styleNode);
+                    if (inlineStyleObject) {
+                        OpenLayers.Util.extend(styleHash, 
+                                        inlineStyleObject.createStyle(feature));
+                    }
+                }
+
+                // Give feature the created style
+                feature.style = new OpenLayers.Style(styleHash);
+
+                // add feature to list of features
-                features[i] = feature;
-            } else {
-                throw "Bad Placemark: " + i;
-            }
-        }
-
+
+
+
-    },
-
-    /**
@@ -154 +593 @@
-        }
-        var feature = new OpenLayers.Feature.Vector(geometry, attributes);
-
-
+ || node.getAttribute("name")
-        if(fid != null) {
-            feature.fid = fid;
-        }
@@ -163 +602 @@
-    },        
-    
-    /**
+     * 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
+     * optinos   - {Object} Hash of options 
+     */
+    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.read(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 +809 @@
-     */
-    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 parse the different kinds of properties
+     *     found in the sld and ogc namespace.
+     *
+     * Calls OpenLayers.Format.SLD.parseProperty and returns its output
+     *
+     * Parameters:
+     * xmlNode        - {<DOMElement>}
+     * namespace      - {String} namespace of the node to find
+     * propertyName   - {String} name of the property to parse
+     * 
+     * Returns:
+     * {String} The value for the requested property.
+     */    
+    parseProperty: function(xmlNode, namespace, propertyName, attributeName,
+                                                              attributeValue) {
+        return OpenLayers.Format.SLD.prototype.parseProperty(xmlNode, 
+                  namespace, propertyName, attributeName, attributeValue);
+    },                                                              
+
+    /**
-     * APIMethod: write
-     * Accept Feature Collection, and return a string. 
-     *