/*
 * $Id: util.js,v 1.2 2009/09/16 17:16:42 aqn Exp $
 *
 * General utility functions.
 */


/**
 * Checks if the specified array contains the specified object.
 *
 * @return <tt>true</tt> if the array contains the object, <tt>false</tt> otherwise
 */
function contains(arr, obj)
{
    if (arr == null) return false;
    if (obj == null) return false;

    var i = arr.length;
    while (i--) {
	if (arr[i] === obj) {
	    return true;
	}
    }
    return false;
}


function strstr( haystack, needle, return_substr_before_needle )
{
  // http://kevin.vanzonneveld.net
  // +   original by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
  // *     example 1: strstr('Kevin van Zonneveld', 'van');
  // *     returns 1: 'van Zonneveld'
  // *     example 2: strstr('Kevin van Zonneveld', 'van', true);
  // *     returns 2: 'Kevin '

  var pos = 0;

  try {
	pos = haystack.indexOf( needle );
	if( pos == -1 ){
	  return false;
	} else{
	  if( return_substr_before_needle ){
		return haystack.substr( 0, pos );
	  } else{
		return haystack.slice( pos );
	  }
	}
  } catch (err) {
	return false;
  }
}


/**
 * Find all child elements of the specify parent element with the specify tag (for example, "TD", "img") with ID matching the specified
 * ID regular expression.
 * (Note that the special tag name of '*' will match all tag names.)
 * If the parent element is not specified, it defaults to the document root element.
 *
 * @param id_regexp
 * @param parent_element parent element; if not specified, defaults to the document root element
 * @param tag_name
 *
 * @return array of elements
 */
function getElementsByRegExpId(id_regexp, parent_element, tag_name)
{
// alert("getElementsByRegExpId, id_regexp <" + id_regexp + "> parent_element <" + parent_element + "> tag_name <" + tag_name + ">");
    parent_element = parent_element === undefined ? document : parent_element;
    tag_name = tag_name === undefined ? '*' : tag_name;
    var v_return = [];
    var v_inc = 0;
    for (var v_i = 0, v_il = parent_element.getElementsByTagName(tag_name).length;  v_i < v_il;  v_i++) {
	if (parent_element.getElementsByTagName(tag_name).item(v_i).id  &&
	    parent_element.getElementsByTagName(tag_name).item(v_i).id.match(id_regexp)
	) {
	    v_return[v_inc] = parent_element.getElementsByTagName(tag_name).item(v_i);
	    v_inc++;
	}
    }
    return v_return;
}


function urlDecode(str)
{
    // http://kevin.vanzonneveld.net
    // +   original by: Philip Peterson
    // +   improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
    // +      input by: AJ
    // +   improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
    // +   improved by: Brett Zamir (http://brett-zamir.me)
    // +      input by: travc
    // +      input by: Brett Zamir (http://brett-zamir.me)
    // +   bugfixed by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
    // +   improved by: Lars Fischer
    // +      input by: Ratheous
    // +   improved by: Orlando
    // %        note 1: info on what encoding functions to use from: http://xkr.us/articles/javascript/encode-compare/
    // *     example 1: urldecode('Kevin+van+Zonneveld%21');
    // *     returns 1: 'Kevin van Zonneveld!'
    // *     example 2: urldecode('http%3A%2F%2Fkevin.vanzonneveld.net%2F');
    // *     returns 2: 'http://kevin.vanzonneveld.net/'
    // *     example 3: urldecode('http%3A%2F%2Fwww.google.nl%2Fsearch%3Fq%3Dphp.js%26ie%3Dutf-8%26oe%3Dutf-8%26aq%3Dt%26rls%3Dcom.ubuntu%3Aen-US%3Aunofficial%26client%3Dfirefox-a');
    // *     returns 3: 'http://www.google.nl/search?q=php.js&ie=utf-8&oe=utf-8&aq=t&rls=com.ubuntu:en-US:unofficial&client=firefox-a'

    var hash_map = {}, ret = str.toString(), unicodeStr='', hexEscStr='';

    var replacer = function (search, replace, str) {
	var tmp_arr = [];
	tmp_arr = str.split(search);
	return tmp_arr.join(replace);
    };

    // The hash_map is identical to the one in urlencode.
    hash_map["'"]   = '%27';
    hash_map['(']   = '%28';
    hash_map[')']   = '%29';
    hash_map['*']   = '%2A';
    hash_map['~']   = '%7E';
    hash_map[' ']   = '%20';
    hash_map['!']   = '%21';
    hash_map['%20'] = '+';
    hash_map['\u00DC'] = '%DC';
    hash_map['\u00FC'] = '%FC';
    hash_map['\u00C4'] = '%D4';
    hash_map['\u00E4'] = '%E4';
    hash_map['\u00D6'] = '%D6';
    hash_map['\u00F6'] = '%F6';
    hash_map['\u00DF'] = '%DF';
    hash_map['\u20AC'] = '%80';
    hash_map['\u0081'] = '%81';
    hash_map['\u201A'] = '%82';
    hash_map['\u0192'] = '%83';
    hash_map['\u201E'] = '%84';
    hash_map['\u2026'] = '%85';
    hash_map['\u2020'] = '%86';
    hash_map['\u2021'] = '%87';
    hash_map['\u02C6'] = '%88';
    hash_map['\u2030'] = '%89';
    hash_map['\u0160'] = '%8A';
    hash_map['\u2039'] = '%8B';
    hash_map['\u0152'] = '%8C';
    hash_map['\u008D'] = '%8D';
    hash_map['\u017D'] = '%8E';
    hash_map['\u008F'] = '%8F';
    hash_map['\u0090'] = '%90';
    hash_map['\u2018'] = '%91';
    hash_map['\u2019'] = '%92';
    hash_map['\u201C'] = '%93';
    hash_map['\u201D'] = '%94';
    hash_map['\u2022'] = '%95';
    hash_map['\u2013'] = '%96';
    hash_map['\u2014'] = '%97';
    hash_map['\u02DC'] = '%98';
    hash_map['\u2122'] = '%99';
    hash_map['\u0161'] = '%9A';
    hash_map['\u203A'] = '%9B';
    hash_map['\u0153'] = '%9C';
    hash_map['\u009D'] = '%9D';
    hash_map['\u017E'] = '%9E';
    hash_map['\u0178'] = '%9F';
    hash_map['\u00C6'] = '%C3%86';
    hash_map['\u00D8'] = '%C3%98';
    hash_map['\u00C5'] = '%C3%85';

    for (unicodeStr in hash_map) {
	hexEscStr = hash_map[unicodeStr]; // Switch order when decoding
	ret = replacer(hexEscStr, unicodeStr, ret); // Custom replace. No regexing
    }

    // End with decodeURIComponent, which most resembles PHP's encoding functions
    ret = decodeURIComponent(ret);

    return ret;
}