org.gwtopenmaps.openlayers.client.js.gwt-openlayers.util.js Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-openlayers-client Show documentation
The newest version!
/*
 *
 *   Copyright 2015 sourceforge.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
/*
 * Utility class with helper functions and workarounds for problematic JSNI cases.
 *
 * gwt_openlayers_util.relay
 *   Relays calls to OpenLayers functions that taken an Array parameter
 *   and perform an instanceof test for the type Array, and possible for other
 *   corner cases.
 *
 * @author
 */

//make namespacing object
if(!gwt_openlayers_util){ var gwt_openlayers_util = new Object(); }


//function for converting Object to Array
gwt_openlayers_util.convertToArray = function(o){
	var a = new Array();
	for(var i = 0, m = o.length; i < m; i++){
		a[i] = o[i];
	}
	return a;
}

//function for converting JSNI created javascript Object to plain javascript Object
//GWT created javascript objects fail instanceof Object test
//  TO DO make recursive
gwt_openlayers_util.convertToPlainObject = function(o){
	var obj = new Object();
	for(prop in o){
		var x = prop;
	}
	return obj;
}

//to get around the test: if(this.eventListeners instanceof Object){ ...}
gwt_openlayers_util.eventListenersToObject = function(options){
	if(options.eventListeners){
		var obj = new Object();
		for(i in options.eventListeners){
			alert(i)
			obj[i] = options.eventListeners[i]
		}
		options.eventListeners = new Object();
		for(j in obj){
			options.eventListeners[j] = obj[j]
		}
	}
	return options;
}

//relay functions
//TODO move these functions to JSNI methods on the Impl classes
gwt_openlayers_util.relay = {

	/* copy, paste directly below here, adjust name of function, and specify body
		exampleRelayFnt : function(o){
	},
	*/

	//paste new relay function here

	writeArray : function(format, o){
		return format.write(gwt_openlayers_util.convertToArray(o));
	},

	vectorAddFeatures : function(vector, o){
		vector.addFeatures(gwt_openlayers_util.convertToArray(o));
	}

}

/**
 * For performing output sanitization on strings that are inserted into the html dom at runtime.
 *
 * This is to prevent XSS. Sanitization should only be done on input that
 * can be inserted by "users" in some way. If an attacker can hijack javascript
 * methods that take input html than sanitization is not relevant anymore.
 *
 * Output sanitization should always be based on a whitelist.
 */
gwt_openlayers_util.sanitize = function(input){
	var originalInput = input;
	var whiteListRegEx = [
		new RegExp("", "g"),
		new RegExp("", "g"),
		new RegExp("", "g"),
		new RegExp("", "g"),
		new RegExp("", "g"),
		new RegExp("", "g"),
		new RegExp("", "g")
	];

	for(var i = 0, max = whiteListRegEx.length; i < max; i++){
		input = input.replace(whiteListRegEx[i], "")
	}

	var whiteListCharsRegEx = /^[a-zA-Z0-9\.\s",';:\u00B0]+$/;
	if(whiteListCharsRegEx.test(input)){
		return originalInput;
	} else {
		return "";
	}
}