/* 
 *  Copyright (C) 2000 - 2008 TagServlet Ltd
 *
 *  This file is part of Open BlueDragon (OpenBD) CFML Server Engine.
 *  
 *  OpenBD is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  Free Software Foundation,version 3.
 *  
 *  OpenBD is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *  
 *  You should have received a copy of the GNU General Public License
 *  along with OpenBD.  If not, see http://www.gnu.org/licenses/
 *  
 *  Additional permission under GNU GPL version 3 section 7
 *  
 *  If you modify this Program, or any covered work, by linking or combining 
 *  it with any of the JARS listed in the README.txt (or a modified version of 
 *  (that library), containing parts covered by the terms of that JAR, the 
 *  licensors of this Program grant you additional permission to convey the 
 *  resulting work. 
 *  README.txt @ http://www.openbluedragon.org/license/README.txt
 *  
 *  http://www.openbluedragon.org/
 */

package com.naryx.tagfusion.expression.function;

import java.util.List;

import com.naryx.tagfusion.cfm.engine.cfData;
import com.naryx.tagfusion.cfm.engine.cfSession;
import com.naryx.tagfusion.cfm.engine.cfStringData;
import com.naryx.tagfusion.cfm.engine.cfUrlData;
import com.naryx.tagfusion.cfm.engine.cfmRunTimeException;
import com.naryx.tagfusion.cfm.engine.variableStore;
import com.naryx.tagfusion.util.RequestUtil;

public class urlDecode extends functionBase {

	private static final long serialVersionUID = 1L;

	public urlDecode() {
		min = 1;
		max = 2;
	}

  public String[] getParamInfo(){
		return new String[]{
			"string",
			"encoding - default encoding of the URL/FORM"
		};
	}
	
	public java.util.Map getInfo(){
		return makeInfo(
				"format", 
				"Decodes the URL string to the original string, using the given encoding", 
				ReturnType.STRING );
	}
  
	public cfData execute(cfSession _session, List<cfData> parameters) throws cfmRunTimeException {
		boolean charsetSpecified = parameters.size() == 2;
		int dataIndex = charsetSpecified ? 1 : 0;

		String encoding;
		String data = parameters.get(dataIndex).getString();

		if (charsetSpecified) {
			encoding = parameters.get(0).getString();
		} else {
			encoding = ((cfUrlData) _session.getQualifiedData(variableStore.URL_SCOPE)).getEncoding();
		}

		String temp = RequestUtil.URLDecode(data.getBytes(), com.nary.util.Localization.convertCharSetToCharEncoding(encoding));
		return new cfStringData(temp);
	}
}