/*
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* This program 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 Lesser General Public License for more details.
*
* Copyright (c) 2006 - 2013 Pentaho Corporation and Contributors. All rights reserved.
*/
package org.pentaho.reporting.libraries.formula.function.text;
import java.io.UnsupportedEncodingException;
import org.pentaho.reporting.libraries.base.util.URLEncoder;
import org.pentaho.reporting.libraries.formula.EvaluationException;
import org.pentaho.reporting.libraries.formula.FormulaContext;
import org.pentaho.reporting.libraries.formula.LibFormulaErrorValue;
import org.pentaho.reporting.libraries.formula.function.Function;
import org.pentaho.reporting.libraries.formula.function.ParameterCallback;
import org.pentaho.reporting.libraries.formula.lvalues.TypeValuePair;
import org.pentaho.reporting.libraries.formula.typing.Type;
import org.pentaho.reporting.libraries.formula.typing.coretypes.TextType;
/**
* This function encodes a given text using the URL-Encoding schema. An optional
* second parameter can be given to specify the character encoding that should
* be used when converting text to bytes.
*
* @author Cedric Pronzato
*/
public class URLEncodeFunction implements Function
{
private static final long serialVersionUID = 646428113862238221L;
public URLEncodeFunction()
{
}
public TypeValuePair evaluate(final FormulaContext context, final ParameterCallback parameters) throws EvaluationException
{
final int parameterCount = parameters.getParameterCount();
if (parameterCount < 1)
{
throw EvaluationException.getInstance(LibFormulaErrorValue.ERROR_ARGUMENTS_VALUE);
}
final Type textType = parameters.getType(0);
final Object textValue = parameters.getValue(0);
final String textResult =
context.getTypeRegistry().convertToText(textType, textValue);
if(textResult == null)
{
throw EvaluationException.getInstance(LibFormulaErrorValue.ERROR_INVALID_ARGUMENT_VALUE);
}
final String encodingResult;
if(parameterCount == 2)
{
final Type encodingType = parameters.getType(1);
final Object encodingValue = parameters.getValue(1);
encodingResult = context.getTypeRegistry().convertToText(encodingType, encodingValue);
if(encodingResult == null)
{
throw EvaluationException.getInstance(LibFormulaErrorValue.ERROR_INVALID_ARGUMENT_VALUE);
}
}
else
{
encodingResult = context.getConfiguration().getConfigProperty
("org.pentaho.reporting.libraries.formula.URLEncoding", "UTF-8");
}
try
{
return new TypeValuePair
(TextType.TYPE, URLEncoder.encode(textResult, encodingResult));
}
catch(final UnsupportedEncodingException use)
{
throw EvaluationException.getInstance(LibFormulaErrorValue.ERROR_INVALID_ARGUMENT_VALUE);
}
}
public String getCanonicalName()
{
return "URLENCODE";
}
}