CQ library contains all CQ component classes and utilities.
* @static
* @class CQ
*/
window.CQ = window.CQ || {};
CQ.shared = {};
// debug console
if (window.console === undefined) {
window.console = {log:function(m){}};
}
/*
* Copyright 1997-2010 Day Management AG
* Barfuesserplatz 6, 4001 Basel, Switzerland
* All Rights Reserved.
*
* This software is the confidential and proprietary information of
* Day Management AG, ("Confidential Information"). You shall not
* disclose such Confidential Information and shall use it only in
* accordance with the terms of the license agreement you entered into
* with Day.
*/
CQ.shared.HTTP = new function() {
/**
* Creates an empty response object.
* @private
* @static
* @return {Object} The response object
*/
var createResponse = function() {
var response = new Object();
response.headers = new Object();
response.body = new Object();
return response;
};
var getResponseFromXhr = function(request) {
if (!request) return null;
var response = createResponse();
response.body = request.responseText;
response.headers[CQ.shared.HTTP.HEADER_STATUS] = request.status;
// set properties for backward compatibility (pre 5.3)
response.responseText = request.responseText;
response.status = request.status;
return response;
};
/**
* The context path used on the server.
* May only be set by {@link CQ.shared.HTTP.detectContextPath}.
* @private
* @type String
*/
var contextPath = null;
/**
* The regular expression to detect the context path used
* on the server using the URL of this script.
* @private
* @final
* @type RegExp
*/
var SCRIPT_URL_REGEXP = /\/etc\/clientlibs\/foundation\/shared.*\.js$/;
/**
* The regular expression to detect unescaped special characters in a path.
* @private
* @final
* @type RegExp
*/
var ENCODE_PATH_REGEXP = /[^\w-\.!~\*'\(\)\/%;:@&=\$,]/;
return {
/**
* The extension for HTML files.
* @static
* @final
* @type String
*/
EXTENSION_HTML: ".html",
/**
* The extension for JSON files.
* @static
* @final
* @type String
*/
EXTENSION_JSON: ".json",
/**
* The extension for resources.
* @private
* @static
* @final
* @type String
*/
EXTENSION_RES: ".res",
/**
* The Status header.
* @static
* @final
* @type String
*/
HEADER_STATUS: "Status",
/**
* The Message header.
* @static
* @final
* @type String
*/
HEADER_MESSAGE: "Message",
/**
* The Location header.
* @static
* @final
* @type String
*/
HEADER_LOCATION: "Location",
/**
* The Path header.
* @static
* @final
* @type String
*/
HEADER_PATH: "Path",
/**
* The parameter name for no caching.
* @static
* @final
* @type String
*/
PARAM_NO_CACHE: "cq_ck",
/**
* Requests the specified URL from the server using GET. The request
* will be synchronous, unless a callback function is specified.
* @static
* @param {String} url The URL to request
* @param {Function} callback (optional) The callback function which is
* called regardless of success or failure and is passed the following
* parameters:{ headers: { "Status": 200, ... } }Examples:
/x/y.sel.html?param=abc => /x/y
http://www.day.com/foo/bar.html => /foo/bar
* @static
* @param {String} url The URL
* @return {String} The path
* @since 5.3
*/
getPath: function(url) {
url = url || window.location.href;
url = CQ.shared.HTTP.internalize(url);
url = CQ.shared.HTTP.removeParameters(url);
url = CQ.shared.HTTP.removeAnchor(url);
var i = url.indexOf(".", url.lastIndexOf("/"));
if (i != -1) {
url = url.substring(0, url.indexOf(".", url.lastIndexOf("/")));
}
return url;
},
/**
* Returns an array with the selectors present in the given url.
* If no selectors are present, an empty array is returned.
* @static
* @param {String} url The URL
* @return {Array} An array containing the selectors or an empty
* array if none were found.
* @since 5.4
*/
getSelectors: function(url) {
var selectors = [];
url = CQ.shared.HTTP.removeParameters(url);
url = CQ.shared.HTTP.removeAnchor(url);
var fragment = url.substring(url.lastIndexOf("/"));
if (fragment) {
var split = fragment.split(".");
if (split.length > 2) {
for (var i = 0; i < split.length; i++) {
// don't add node name and extension as selectors
if (i > 0 && i < split.length - 1) {
selectors.push(split[i]);
}
}
}
}
return selectors;
},
/**
* Returns the extension of an URL. This is the string
* after the last dot until the end of the url without
* any request parameters, anchors or suffix, for
* example "html".
*
* @param {String} url The URL
* @return {String} The URL extension (without the dot)
* or an empty string if no was found.
* @since 5.4
*/
getExtension: function(url) {
// strip things from the end
url = CQ.shared.HTTP.removeParameters(url);
url = CQ.shaerd.HTTP.removeAnchor(url);
// extension is everything after the last dot
var pos = url.lastIndexOf(".");
if (pos < 0) {
return "";
}
// do not include the dot
url = url.substring(pos + 1);
// remove suffix if present
pos = url.indexOf("/");
if (pos < 0) {
return url;
}
return url.substring(0, pos);
},
/**
* Encodes the path of the specified URL if it is not already encoded.
* Path means the part of the URL before the first question mark or
* hash sign.
* See {@link CQ.HTTP.encodePath} for details about the encoding.
* Sample:
* /x/y+z.png?path=/x/y+z >> /x/y%2Bz.png?path=x/y+z
* Note that the sample would not work because the "+" in the request
* parameter would be interpreted as a space. Parameters must be encoded
* separately.
* @param {String} url The URL to encoded
* @return {String} The encoded URL
* @since 5.3
*/
encodePathOfURI: function(url) {
var parts, delim;
if (url.indexOf("?") != -1) {
parts = url.split("?");
delim = "?";
}
else if (url.indexOf("#") != -1) {
parts = url.split("#");
delim = "#";
}
else {
parts = [url];
}
if (ENCODE_PATH_REGEXP.test(parts[0])) {
parts[0] = CQ.shared.HTTP.encodePath(parts[0]);
}
return parts.join(delim);
},
/**
* Encodes the specified path using encodeURI. Additionally +,
* # and ? are encoded.
* The following characters are not encoded:
* 0-9 a-z A-Z
* - _ . ! ~ * ( )
* / : @ & =
* @param {String} path The path to encode
* @return {String} The encoded path
* @since 5.3
*/
encodePath: function(path) {
path = encodeURI(path);
path = path.replace(/\+/g, "%2B");
path = path.replace(/\?/g, "%3F");
path = path.replace(/;/g, "%3B");
path = path.replace(/#/g, "%23");
path = path.replace(/=/g, "%3D");
path = path.replace(/\$/g, "%24");
path = path.replace(/,/g, "%2C");
path = path.replace(/'/g, "%27");
path = path.replace(/"/g, "%22");
return path;
},
/**
* Evaluates and returns the body of the specified response object.
* Alternatively, a URL can be specified, in which case it will be
* requested using a synchornous {@link #get} in order to acquire
* the response object.
* @static
* @param {Object/String} response The response object or URL
* @return {Object} The evaluated response body
* @since 5.3
*/
eval: function(response) {
if (typeof response != "object") {
response = CQ.shared.HTTP.get(response);
}
try {
// support responseText for backward compatibility (pre 5.3)
return eval("(" + (response.body ? response.body :
response.responseText) + ")");
} catch (e) {
}
return null;
},
/**
* Checks whether the specified status code is OK.
* @static
* @param {Number} status The status code
* @return {Boolean} True if the status is OK, else false
*/
isOkStatus: function(status) {
try {
return (new String(status).indexOf("2") == 0);
} catch (e) {
return false;
}
},
/**
* Checks if the specified response is OK.
* The response object is expected to look like this:
*
{ headers: { "Status": 200, ... } }