/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 * 
 */

package org.apache.jmeter.functions;


import java.util.Collection;
import java.util.LinkedList;
import java.util.List;

import org.apache.commons.lang.StringEscapeUtils;
import org.apache.jmeter.engine.util.CompoundVariable;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.samplers.Sampler;
import org.apache.jmeter.util.JMeterUtils;

/**
 * Function to unescape a string containing entity escapes
 * to a string containing the actual Unicode characters corresponding to the escapes. 
 * Supports HTML 4.0 entities.
 * For example, the string "&lt;Fran&ccedil;ais&gt;" will become "<Franais>"
 * If an entity is unrecognized, it is left alone, and inserted verbatim into the result string.
 * e.g. "&gt;&zzzz;x" will become ">&zzzz;x".
 * @see StringEscapeUtils#unescapeHtml(String) (Commons Lang)
 */
public class UnEscapeHtml extends AbstractFunction {

    private static final List desc = new LinkedList();

    private static final String KEY = "__unescapeHtml"; //$NON-NLS-1$

    static {
        desc.add(JMeterUtils.getResString("unescape_html_string")); //$NON-NLS-1$
    }

    private Object[] values;

    public UnEscapeHtml() {
    }

    public synchronized String execute(SampleResult previousResult, Sampler currentSampler)
            throws InvalidVariableException {

        String escapedString = ((CompoundVariable) values[0]).execute();
        return StringEscapeUtils.unescapeHtml(escapedString);

    }

    public synchronized void setParameters(Collection parameters) throws InvalidVariableException {
        checkParameterCount(parameters, 1);
        values = parameters.toArray();
    }

    public String getReferenceKey() {
        return KEY;
    }

    public List getArgumentDesc() {
        return desc;
    }
}

@@ -1340,16 +1340,23 @@
 tities.%0A
+ * %3Cp%3E%0A
  * For e
@@ -1380,16 +1380,20 @@
 g %22&
+amp;
 lt;Fran&
 cced
@@ -1388,16 +1388,20 @@
 lt;Fran&
+amp;
 ccedil;a
@@ -1403,16 +1403,20 @@
 dil;ais&
+amp;
 gt;%22 wil
@@ -1429,18 +1429,47 @@
 me %22
-%3CFranais%3E%22
+&lt;Fran&ccedil;ais&gt;%22%0A * %3C/p%3E%0A * %3Cp%3E
 %0A * 
@@ -1576,12 +1576,20 @@
 . %22&
-gt;&
+amp;gt;&amp;
 zzzz
@@ -1609,10 +1609,17 @@
 me %22
-%3E
 &
+gt;&amp;
 zzzz
@@ -1630,13 +1630,45 @@
 %0A * 
-@see 
+%3C/p%3E%0A * @see org.apache.commons.lang.
 Stri
@@ -1705,23 +1705,8 @@
 ing)
- (Commons Lang)
 %0A */

Fix up Javadoc; avoids UTF-8 warning with cedilla when compiling with Java 1.5+