Merge pull request #763 from bbinet/cleanup-attribution-control

Cleanup attribution control

src/ol/control/attributioncontrol.js

@@ -3,17 +3,14 @@
 goog.provide('ol.control.Attribution');
 
 goog.require('goog.array');
-goog.require('goog.asserts');
 goog.require('goog.dom');
 goog.require('goog.dom.TagName');
 goog.require('goog.object');
 goog.require('goog.style');
 goog.require('ol.Attribution');
 goog.require('ol.FrameState');
-goog.require('ol.TileRange');
 goog.require('ol.control.Control');
 goog.require('ol.css');
-goog.require('ol.source.Source');
 
 
 
@@ -71,37 +68,45 @@ goog.inherits(ol.control.Attribution, ol.control.Control);
 
 
 /**
- * @param {?Object.<string, Object.<string, ol.TileRange>>} usedTiles Used
+ * @param {?ol.FrameState} frameState Frame state.
- *     tiles.
+ * @return {Array.<Object.<string, ol.Attribution>>} Attributions.
- * @param {Object.<string, ol.source.Source>} sources Sources.
- * @return {Object.<string, ol.Attribution>} Attributions.
  */
-ol.control.Attribution.prototype.getTileSourceAttributions =
+ol.control.Attribution.prototype.getSourceAttributions =
-    function(usedTiles, sources) {
+    function(frameState) {
+  var i, ii, j, jj, tileRanges, source, sourceAttribution,
+      sourceAttributionKey, sourceAttributions, sourceKey;
+  var layers = frameState.layersArray;
   /** @type {Object.<string, ol.Attribution>} */
-  var attributions = {};
+  var attributions = goog.object.clone(frameState.attributions);
-  var i, ii, tileRanges, tileSource, tileSourceAttribution,
+  /** @type {Object.<string, ol.Attribution>} */
-      tileSourceAttributionKey, tileSourceAttributions, tileSourceKey, z;
+  var hiddenAttributions = {};
-  for (tileSourceKey in usedTiles) {
+  for (i = 0, ii = layers.length; i < ii; i++) {
-    goog.asserts.assert(tileSourceKey in sources);
+    source = layers[i].getSource();
-    tileSource = sources[tileSourceKey];
+    sourceKey = goog.getUid(source).toString();
-    tileSourceAttributions = tileSource.getAttributions();
+    sourceAttributions = source.getAttributions();
-    if (goog.isNull(tileSourceAttributions)) {
+    if (goog.isNull(sourceAttributions)) {
       continue;
     }
-    tileRanges = usedTiles[tileSourceKey];
+    for (j = 0, jj = sourceAttributions.length; j < jj; j++) {
-    for (i = 0, ii = tileSourceAttributions.length; i < ii; ++i) {
+      sourceAttribution = sourceAttributions[j];
-      tileSourceAttribution = tileSourceAttributions[i];
+      sourceAttributionKey = goog.getUid(sourceAttribution).toString();
-      tileSourceAttributionKey = goog.getUid(tileSourceAttribution).toString();
+      if (sourceAttributionKey in attributions) {
-      if (tileSourceAttributionKey in attributions) {
         continue;
       }
-      if (tileSourceAttribution.intersectsAnyTileRange(tileRanges)) {
+      tileRanges = frameState.usedTiles[sourceKey];
-        attributions[tileSourceAttributionKey] = tileSourceAttribution;
+      if (goog.isDef(tileRanges) &&
+          sourceAttribution.intersectsAnyTileRange(tileRanges)) {
+        if (sourceAttributionKey in hiddenAttributions) {
+          delete hiddenAttributions[sourceAttributionKey];
+        }
+        attributions[sourceAttributionKey] = sourceAttribution;
+      }
+      else {
+        hiddenAttributions[sourceAttributionKey] = sourceAttribution;
       }
     }
   }
-  return attributions;
+  return [attributions, hiddenAttributions];
 };
 
 
@@ -127,64 +132,54 @@ ol.control.Attribution.prototype.updateElement_ = function(frameState) {
     return;
   }
 
-  var map = this.getMap();
+  var attributions = this.getSourceAttributions(frameState);
-
-  /** @type {Object.<string, boolean>} */
-  var attributionsToRemove = {};
-  /** @type {Object.<string, ol.source.Source>} */
-  var sources = {};
-  var layers = map.getLayers();
-  if (goog.isDef(layers)) {
-    layers.forEach(function(layer) {
-      var source = layer.getSource();
-      sources[goog.getUid(source).toString()] = source;
-      var attributions = source.getAttributions();
-      if (!goog.isNull(attributions)) {
-        var attribution, i, ii;
-        for (i = 0, ii = attributions.length; i < ii; ++i) {
-          attribution = attributions[i];
-          attributionKey = goog.getUid(attribution).toString();
-          attributionsToRemove[attributionKey] = true;
-        }
-      }
-    });
-  }
-
   /** @type {Object.<string, ol.Attribution>} */
-  var attributions = goog.object.clone(frameState.attributions);
+  var visibleAttributions = attributions[0];
-  var tileSourceAttributions = this.getTileSourceAttributions(
+  /** @type {Object.<string, ol.Attribution>} */
-      frameState.usedTiles, sources);
+  var hiddenAttributions = attributions[1];
-  goog.object.extend(attributions, tileSourceAttributions);
 
-  /** @type {Array.<number>} */
+  var attributionElement, attributionKey;
-  var attributionKeys =
+  for (attributionKey in this.attributionElements_) {
-      goog.array.map(goog.object.getKeys(attributions), Number);
+    if (attributionKey in visibleAttributions) {
-  goog.array.sort(attributionKeys);
-  var i, ii, attributionElement, attributionKey;
-  for (i = 0, ii = attributionKeys.length; i < ii; ++i) {
-    attributionKey = attributionKeys[i].toString();
-    if (attributionKey in this.attributionElements_) {
       if (!this.attributionElementRenderedVisible_[attributionKey]) {
         goog.style.showElement(this.attributionElements_[attributionKey], true);
         this.attributionElementRenderedVisible_[attributionKey] = true;
       }
-    } else {
+      delete visibleAttributions[attributionKey];
-      attributionElement = goog.dom.createElement(goog.dom.TagName.LI);
-      attributionElement.innerHTML = attributions[attributionKey].getHTML();
-      goog.dom.appendChild(this.ulElement_, attributionElement);
-      this.attributionElements_[attributionKey] = attributionElement;
-      this.attributionElementRenderedVisible_[attributionKey] = true;
     }
-    delete attributionsToRemove[attributionKey];
+    else if (attributionKey in hiddenAttributions) {
+      if (this.attributionElementRenderedVisible_[attributionKey]) {
+        goog.style.showElement(
+            this.attributionElements_[attributionKey], false);
+        delete this.attributionElementRenderedVisible_[attributionKey];
+      }
+      delete hiddenAttributions[attributionKey];
+    }
+    else {
+      goog.dom.removeNode(this.attributionElements_[attributionKey]);
+      delete this.attributionElements_[attributionKey];
+      delete this.attributionElementRenderedVisible_[attributionKey];
+    }
+  }
+  for (attributionKey in visibleAttributions) {
+    attributionElement = goog.dom.createElement(goog.dom.TagName.LI);
+    attributionElement.innerHTML =
+        visibleAttributions[attributionKey].getHTML();
+    goog.dom.appendChild(this.ulElement_, attributionElement);
+    this.attributionElements_[attributionKey] = attributionElement;
+    this.attributionElementRenderedVisible_[attributionKey] = true;
+  }
+  for (attributionKey in hiddenAttributions) {
+    attributionElement = goog.dom.createElement(goog.dom.TagName.LI);
+    attributionElement.innerHTML =
+        hiddenAttributions[attributionKey].getHTML();
+    goog.style.showElement(attributionElement, false);
+    goog.dom.appendChild(this.ulElement_, attributionElement);
+    this.attributionElements_[attributionKey] = attributionElement;
   }
 
-  for (attributionKey in attributionsToRemove) {
+  var renderVisible =
-    goog.dom.removeNode(this.attributionElements_[attributionKey]);
+      !goog.object.isEmpty(this.attributionElementRenderedVisible_);
-    delete this.attributionElements_[attributionKey];
-    delete this.attributionElementRenderedVisible_[attributionKey];
-  }
-
-  var renderVisible = !goog.array.isEmpty(attributionKeys);
   if (this.renderedVisible_ != renderVisible) {
     goog.style.showElement(this.element, renderVisible);
     this.renderedVisible_ = renderVisible;