HTML Credits #6331
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -686,6 +686,34 @@ https://github.com/google/draco | |
| >License for the specific language governing permissions and limitations under | ||
| >the License. | ||
|
|
||
| ### JSXSS | ||
|
|
||
| https://github.com/leizongmin/js-xss | ||
|
|
||
| > Copyright (c) 2012-2017 Zongmin Lei(雷宗民) <[email protected]> | ||
| > http://ucdok.com | ||
| > | ||
| > The MIT License | ||
| > | ||
| > Permission is hereby granted, free of charge, to any person obtaining | ||
| > a copy of this software and associated documentation files (the | ||
| > "Software"), to deal in the Software without restriction, including | ||
| > without limitation the rights to use, copy, modify, merge, publish, | ||
| > distribute, sublicense, and/or sell copies of the Software, and to | ||
| > permit persons to whom the Software is furnished to do so, subject to | ||
| > the following conditions: | ||
| > | ||
| > The above copyright notice and this permission notice shall be | ||
| > included in all copies or substantial portions of the Software. | ||
| > | ||
| > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| > EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
| > MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| > NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
| > LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
| > OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
| > WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
|
|
||
| Tests | ||
| ===== | ||
|
|
||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,39 @@ | ||
| define([ | ||
| './defaultValue', | ||
| './defined', | ||
| './defineProperties', | ||
| './deprecationWarning', | ||
| './DeveloperError', | ||
| '../ThirdParty/xss' | ||
| ], function( | ||
| defaultValue, | ||
| defined, | ||
| defineProperties, | ||
| deprecationWarning, | ||
| DeveloperError, | ||
| xss) { | ||
| 'use strict'; | ||
|
|
||
| var nextCreditId = 0; | ||
| var creditToId = {}; | ||
|
|
||
| function createDomNode(html) { | ||
| var span = document.createElement('span'); | ||
|
There was a problem hiding this comment. I thought we were going to make this a div? Also, this function no longer seems necessary since it's only used in the equally small There was a problem hiding this comment. In fact, getElement can also be moved into the |
||
| span.innerHTML = html; | ||
|
|
||
| return span; | ||
| } | ||
|
|
||
| function getElement(credit) { | ||
| var html = credit.html; | ||
| html = xss(html); | ||
|
There was a problem hiding this comment. What are we using for a whitelist here? Because it looks like not even the There was a problem hiding this comment. Turns out the fact that There was a problem hiding this comment. I'm just using the default whitelist https://github.com/leizongmin/js-xss/blob/master/lib/default.js I'll look into the |
||
| return createDomNode(html); | ||
| } | ||
|
|
||
| /** | ||
| * A credit contains data pertaining to how to display attributions/credits for certain content on the screen. | ||
| * @param {String} html An string representing an html code snippet (can be text only) | ||
| * @param {Boolean} [showOnScreen=false] If true, the credit will be visible in the main credit container. Otherwise, it will appear in a popover | ||
| * | ||
| * @alias Credit | ||
| * @constructor | ||
|
|
@@ -71,38 +48,74 @@ define([ | |
| * link : 'https://cesiumjs.org/' | ||
| * }); | ||
| */ | ||
| function Credit(html, showOnScreen) { | ||
| var id; | ||
| var key; | ||
| if (typeof html !== 'string') { | ||
| var options = defaultValue(html, defaultValue.EMPTY_OBJECT); | ||
| deprecationWarning('Credit options', 'The options parameter has been deprecated and will be removed in Cesium 1.46. Instead, pass in an HTML string (or a string of text)'); | ||
| showOnScreen = defaultValue(options.showOnScreen, showOnScreen); | ||
| var text = options.text; | ||
| var imageUrl = options.imageUrl; | ||
| var link = options.link; | ||
|
|
||
| var hasLink = (defined(link)); | ||
| var hasImage = (defined(imageUrl)); | ||
| var hasText = (defined(text)); | ||
|
|
||
| //>>includeStart('debug', pragmas.debug); | ||
| if (!hasText && !hasImage && !hasLink) { | ||
| throw new DeveloperError('options.text, options.imageUrl, or options.link is required.'); | ||
| } | ||
| //>>includeEnd('debug'); | ||
|
|
||
| if (!hasText && !hasImage) { | ||
| text = link; | ||
| } | ||
|
|
||
| this._text = text; | ||
| this._imageUrl = imageUrl; | ||
| this._link = link; | ||
| this._hasLink = hasLink; | ||
| this._hasImage = hasImage; | ||
|
|
||
| var element = document.createElement('span'); | ||
| var a; | ||
| if (hasImage) { | ||
| var content = document.createElement('img'); | ||
| content.src = imageUrl; | ||
| if (defined(text)) { | ||
| content.alt = text; | ||
| content.title = text; | ||
| } | ||
| if (hasLink) { | ||
| a = document.createElement('a'); | ||
| a.appendChild(content); | ||
| a.href = link; | ||
| a.target = '_blank'; | ||
| element.appendChild(a); | ||
| } else { | ||
| element.appendChild(content); | ||
| } | ||
| element.className = 'cesium-credit-image'; | ||
| } else { | ||
| if (hasLink) { | ||
| a = document.createElement('a'); | ||
| a.textContent = text; | ||
| a.href = link; | ||
| a.target = '_blank'; | ||
| element.appendChild(a); | ||
| } else { | ||
| element.textContent = text; | ||
| } | ||
| element.className = 'cesium-credit-text'; | ||
| } | ||
|
|
||
| html = '<span>' + element.innerHTML + '</span>'; | ||
| key = JSON.stringify([text, imageUrl, link]); | ||
| } else { | ||
| key = html; | ||
| } | ||
|
|
||
| if (defined(creditToId[key])) { | ||
|
There was a problem hiding this comment. Do we even need There was a problem hiding this comment.
|
||
| id = creditToId[key]; | ||
|
|
@@ -111,12 +124,27 @@ define([ | |
| creditToId[key] = id; | ||
| } | ||
|
|
||
| showOnScreen = defaultValue(showOnScreen, false); | ||
|
|
||
| // Credits are immutable so generate an id to use to optimize equal() | ||
| this._id = id; | ||
| this._html = html; | ||
| this._showOnScreen = showOnScreen; | ||
| this._element = undefined; | ||
| } | ||
|
|
||
| defineProperties(Credit.prototype, { | ||
| /** | ||
| * The credit content | ||
| * @memberof Credit.prototype | ||
| * @type {String} | ||
| * @readonly | ||
| */ | ||
| html : { | ||
| get : function() { | ||
| return this._html; | ||
| } | ||
| }, | ||
| /** | ||
| * The credit text | ||
| * @memberof Credit.prototype | ||
|
|
@@ -125,6 +153,7 @@ define([ | |
| */ | ||
| text : { | ||
| get : function() { | ||
| deprecationWarning('Credit.text', 'Credit.text is deprecated and will be removed in Cesium 1.46. Instead, use Credit.html to get the credit content.'); | ||
| return this._text; | ||
| } | ||
| }, | ||
|
|
@@ -137,6 +166,7 @@ define([ | |
| */ | ||
| imageUrl : { | ||
| get : function() { | ||
| deprecationWarning('Credit.imageUrl', 'Credit.imageUrl is deprecated and will be removed in Cesium 1.46. Instead, use Credit.html to get the credit content.'); | ||
| return this._imageUrl; | ||
| } | ||
| }, | ||
|
|
@@ -149,6 +179,7 @@ define([ | |
| */ | ||
| link : { | ||
| get : function() { | ||
| deprecationWarning('Credit.link', 'Credit.link is deprecated and will be removed in Cesium 1.46. Instead, use Credit.html to get the credit content.'); | ||
| return this._link; | ||
| } | ||
| }, | ||
|
|
@@ -200,6 +231,7 @@ define([ | |
| * @returns {Boolean} | ||
| */ | ||
| Credit.prototype.hasImage = function() { | ||
| deprecationWarning('Credit.hasImage', 'Credit.hasImage is deprecated and will be removed in Cesium 1.46.'); | ||
| return this._hasImage; | ||
| }; | ||
|
|
||
|
|
@@ -209,6 +241,7 @@ define([ | |
| * @returns {Boolean} | ||
| */ | ||
| Credit.prototype.hasLink = function() { | ||
| deprecationWarning('Credit.hasLink', 'Credit.hasLink is deprecated and will be removed in Cesium 1.46.'); | ||
| return this._hasLink; | ||
| }; | ||
|
|
||
|
|
@@ -236,5 +269,26 @@ define([ | |
| return Credit.equals(this, credit); | ||
| }; | ||
|
|
||
| /** | ||
| * @private | ||
| * @param attribution | ||
| * @return {Credit} | ||
| */ | ||
| Credit.getIonCredit = function(attribution) { | ||
| var credit; | ||
| var showOnScreen = defined(attribution.collapsible) && !attribution.collapsible; | ||
| if (defined(attribution.html)) { | ||
| credit = new Credit(attribution.html, showOnScreen); | ||
| } else { | ||
| credit = new Credit({ | ||
| text: attribution.text, | ||
| link: attribution.url, | ||
| imageUrl: attribution.image | ||
| }, showOnScreen); | ||
| } | ||
| credit._isIon = true; | ||
| return credit; | ||
| }; | ||
|
|
||
| return Credit; | ||
| }); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should have createDomNode automatically add target='_blank' to all credit links (then we can remove them all from this PR)