hazendaz / httpunit / 656

Committed 06 Dec 2025 09:11PM UTC coverage: 80.452% (+0.02%) from 80.435%

Build # 656

Build Type

push

github

Committed by

hazendaz

Commit Message

[maven-release-plugin] prepare for next development iteration

Run Details

3213 of 4105 branches covered (78.27%)

Branch coverage included in aggregate %.

8245 of 10137 relevant lines covered (81.34%)

0.81 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

88.66

/src/main/java/com/meterware/httpunit/WebRequest.java

/*
 * MIT License
 *
 * Copyright 2011-2025 Russell Gold
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
 * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
 * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */
package com.meterware.httpunit;

import com.meterware.httpunit.protocol.ParameterProcessor;
import com.meterware.httpunit.protocol.UploadFileSpec;
import com.meterware.httpunit.scripting.ScriptingHandler;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLConnection;
import java.net.URLStreamHandler;
import java.util.Dictionary;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.Locale;

import org.w3c.dom.Element;
import org.xml.sax.SAXException;

/**
 * A request sent to a web server.
 **/
public abstract class WebRequest {

    /** The Constant REFERER_HEADER_NAME. */
    static final String REFERER_HEADER_NAME = "Referer";

    /** The javascript stream handler. */
    private static URLStreamHandler JAVASCRIPT_STREAM_HANDLER = new JavascriptURLStreamHandler();

    /** The https stream handler. */
    private static URLStreamHandler HTTPS_STREAM_HANDLER = new HttpsURLStreamHandler();

    /** The parameter holder. */
    private final ParameterHolder _parameterHolder;

    /** The url base. */
    private URL _urlBase;

    /** The source frame. */
    private FrameSelector _sourceFrame;

    /** The request target. */
    private String _requestTarget;

    /** The url string. */
    private String _urlString;

    /** The headers. */
    private Hashtable _headers;

    /** The web request source. */
    private WebRequestSource _webRequestSource;

    /** The referring page. */
    private WebResponse _referringPage;

    /** The button. */
    private SubmitButton _button;

    /** The source element. */
    private Element _sourceElement;

    /** The character set. */
    private String _characterSet;

    /**
     * Sets the value of a header to be sent with this request. A header set here will override any matching header set
     * in the WebClient when the request is actually sent.
     *
     * @param headerName
     *            - the name of the header
     * @param headerValue
     *            - the value to be set
     */
    public void setHeaderField(String headerName, String headerValue) {
        getHeaderDictionary().put(headerName, headerValue);
    }

    /**
     * Returns a copy of the headers to be sent with this request.
     *
     * @return the dictionary of headers
     **/
    public Dictionary getHeaders() {
        return (Dictionary) getHeaderDictionary().clone();
    }

    /**
     * Returns the final URL associated with this web request.
     *
     * @return the Uniform Resource Locator for this Web request
     *
     * @throws MalformedURLException
     *             if the URL is not o.k.
     **/
    public URL getURL() throws MalformedURLException {
        if (getURLBase() == null || getURLBase().toString().indexOf("?") < 0) {
            return newURL(getURLBase(), getURLString());
        }
        final String urlBaseString = getURLBase().toString();
        URL newurlbase = new URL(urlBaseString.substring(0, urlBaseString.indexOf("?")));
        return newURL(newurlbase, getURLString());
    }

    /**
     * Creates a new URL, handling the case where the relative URL begins with a '?'.
     *
     * @param base
     *            - the URL to start from
     * @param spec
     *            - additional specification string
     *
     * @return the URL
     *
     * @throws MalformedURLException
     *             the malformed URL exception
     */
    private URL newURL(final URL base, final String spec) throws MalformedURLException {
        if (spec.toLowerCase(Locale.ENGLISH).startsWith("javascript:")) {
            return new URL("javascript", null, -1, spec.substring("javascript:".length()), JAVASCRIPT_STREAM_HANDLER);
        }
        if (spec.toLowerCase(Locale.ENGLISH).startsWith("https:") && !HttpsProtocolSupport.hasHttpsSupport()) {
            return new URL("https", null, -1, spec.substring("https:".length()), HTTPS_STREAM_HANDLER);
        }
        if (getURLBase() == null || getURLString().indexOf(':') > 0) {
            if (getURLString().indexOf(':') <= 0) {
                throw new RuntimeException("No protocol specified in URL '" + getURLString() + "'");
            }
            HttpsProtocolSupport.verifyProtocolSupport(getURLString().substring(0, getURLString().indexOf(':')));
        }
        return spec.startsWith("?") ? new URL(base + spec) : newCombinedURL(base, spec);
    }

    /**
     * New combined URL.
     *
     * @param base
     *            the base
     * @param spec
     *            the spec
     *
     * @return the url
     *
     * @throws MalformedURLException
     *             the malformed URL exception
     */
    private URL newCombinedURL(final URL base, final String spec) throws MalformedURLException {
        if (base == null) {
            return new URL(getNormalizedURL(spec));
        }
        if (spec.startsWith("..")) {
            return new URL(getNormalizedURL(getURLDirectory(base) + spec));
        }
        return new URL(base, getNormalizedURL(spec));
    }

    /**
     * Gets the URL directory.
     *
     * @param base
     *            the base
     *
     * @return the URL directory
     */
    private String getURLDirectory(final URL base) {
        String url = base.toExternalForm();
        int i = url.lastIndexOf('/');
        return url.substring(0, i + 1);
    }

    /**
     * Gets the normalized URL.
     *
     * @param url
     *            the url
     *
     * @return the normalized URL
     */
    private String getNormalizedURL(String url) {
        int questionIndex = url.indexOf('?');
        if (questionIndex < 0) {
            return getNormalizedPath(url);
        }
        return getNormalizedPath(url.substring(0, questionIndex)) + url.substring(questionIndex);
    }

    /**
     * Gets the normalized path.
     *
     * @param path
     *            the path
     *
     * @return the normalized path
     */
    private String getNormalizedPath(String path) {
        if (path.lastIndexOf("//") > path.lastIndexOf("://") + 1) {
            return getNormalizedPath(stripDoubleSlashes(path));
        }
        if (path.indexOf("/../") > 0 || path.endsWith("/..")) {
            return getNormalizedPath(stripUpNavigation(path));
        }
        if (path.indexOf("/./") > 0) {
            return getNormalizedPath(stripInPlaceNavigation(path));
        }
        return path;
    }

    /**
     * Strip in place navigation.
     *
     * @param url
     *            the url
     *
     * @return the string
     */
    private String stripInPlaceNavigation(String url) {
        int i = url.lastIndexOf("/./");
        return url.substring(0, i + 1) + url.substring(i + 2);
    }

    /**
     * Strip up navigation.
     *
     * @param url
     *            the url
     *
     * @return the string
     */
    private String stripUpNavigation(String url) {
        int i = url.indexOf("/..");
        int j = url.lastIndexOf("/", i - 1);
        return url.substring(0, j + 1) + url.substring(i + 3);
    }

    /**
     * Strip double slashes.
     *
     * @param url
     *            the url
     *
     * @return the string
     */
    private String stripDoubleSlashes(String url) {
        int i = url.lastIndexOf("//");
        return url.substring(0, i) + url.substring(i + 1);
    }

    /**
     * Returns the target for this web request.
     *
     * @return the target
     */
    public String getTarget() {
        return _requestTarget;
    }

    /**
     * Returns the frame from which this request originates.
     *
     * @return the source frame
     */
    FrameSelector getSourceFrame() {
        return _sourceFrame;
    }

    /**
     * the HTTP method defined for this request e.g. DELETE,OPTIONS,HEAD
     */
    protected String method;

    /**
     * Gets the method.
     *
     * @return the method
     */
    public String getMethod() {
        return method;
    }

    /**
     * Returns the query string defined for this request. The query string is sent to the HTTP server as part of the
     * request header. This default implementation returns an empty string.
     *
     * @return the query string
     */
    public String getQueryString() {
        return "";
    }

    // ------------------------------------- ParameterCollection methods ------------------------------------

    /**
     * Sets the value of a parameter in a web request.
     *
     * @param name
     *            the name
     * @param value
     *            the value
     */
    public void setParameter(String name, String value) {
        _parameterHolder.setParameter(name, value);
    }

    /**
     * Sets the multiple values of a parameter in a web request.
     *
     * @param name
     *            the name
     * @param values
     *            the values
     */
    public void setParameter(String name, String[] values) {
        _parameterHolder.setParameter(name, values);
    }

    /**
     * Sets the multiple values of a file upload parameter in a web request.
     *
     * @param parameterName
     *            the parameter name
     * @param files
     *            the files
     */
    public void setParameter(String parameterName, UploadFileSpec[] files) {
        if (!maySelectFile(parameterName)) {
            throw new IllegalNonFileParameterException(parameterName);
        }
        if (!isMimeEncoded()) {
            throw new MultipartFormRequiredException();
        }
        _parameterHolder.setParameter(parameterName, files);
    }

    /**
     * Specifies the click position for the submit button. When a user clioks on an image button, not only the name and
     * value of the button, but also the position of the mouse at the time of the click is submitted with the form. This
     * method allows the caller to override the position selected when this request was created.
     *
     * @param x
     *            the x
     * @param y
     *            the y
     *
     * @exception IllegalRequestParameterException
     *                thrown if the request was not created from a form with an image button.
     */
    public void setImageButtonClickPosition(int x, int y) throws IllegalRequestParameterException {
        if (_button == null) {
            throw new IllegalButtonPositionException();
        }
        _parameterHolder.selectImageButtonPosition(_button, x, y);
    }

    /**
     * Returns true if the specified parameter is a file field.
     *
     * @param name
     *            the name
     *
     * @return true, if is file parameter
     */
    public boolean isFileParameter(String name) {
        return _parameterHolder.isFileParameter(name);
    }

    /**
     * Sets the file for a parameter upload in a web request.
     *
     * @param parameterName
     *            the parameter name
     * @param file
     *            the file
     */
    public void selectFile(String parameterName, File file) {
        setParameter(parameterName, new UploadFileSpec[] { new UploadFileSpec(file) });
    }

    /**
     * Sets the file for a parameter upload in a web request.
     *
     * @param parameterName
     *            the parameter name
     * @param file
     *            the file
     * @param contentType
     *            the content type
     */
    public void selectFile(String parameterName, File file, String contentType) {
        setParameter(parameterName, new UploadFileSpec[] { new UploadFileSpec(file, contentType) });
    }

    /**
     * Sets the file for a parameter upload in a web request.
     *
     * @param parameterName
     *            the parameter name
     * @param fileName
     *            the file name
     * @param inputStream
     *            the input stream
     * @param contentType
     *            the content type
     */
    public void selectFile(String parameterName, String fileName, InputStream inputStream, String contentType) {
        setParameter(parameterName, new UploadFileSpec[] { new UploadFileSpec(fileName, inputStream, contentType) });
    }

    /**
     * Returns an array of all parameter names defined as part of this web request.
     *
     * @return the request parameter names
     */
    public String[] getRequestParameterNames() {
        final HashSet<String> names = new HashSet<>();
        ParameterProcessor pp = new ParameterProcessor() {
            @Override
            public void addParameter(String name, String value, String characterSet) throws IOException {
                names.add(name);
            }

            @Override
            public void addFile(String parameterName, UploadFileSpec fileSpec) throws IOException {
                names.add(parameterName);
            }
        };

        try {
            _parameterHolder.recordPredefinedParameters(pp);
            _parameterHolder.recordParameters(pp);
        } catch (IOException e) {
        }

        return names.toArray(new String[names.size()]);
    }

    /**
     * Returns the value of a parameter in this web request.
     *
     * @param name
     *            the name
     *
     * @return the value of the named parameter, or empty string if it is not set.
     */
    public String getParameter(String name) {
        String[] values = getParameterValues(name);
        return values.length == 0 ? "" : values[0];
    }

    /**
     * Returns the multiple default values of the named parameter.
     *
     * @param name
     *            the name
     *
     * @return the parameter values
     */
    public String[] getParameterValues(String name) {
        return _parameterHolder.getParameterValues(name);
    }

    /**
     * Removes a parameter from this web request.
     *
     * @param name
     *            the name
     */
    public void removeParameter(String name) {
        _parameterHolder.removeParameter(name);
    }

    // ------------------------------------- Object methods ------------------------------------

    @Override
    public String toString() {
        return getMethod() + " request for (" + getURLBase() + ") " + getURLString();
    }

    // ------------------------------------- protected members ------------------------------------

    /**
     * Constructs a web request using an absolute URL string.
     *
     * @param urlString
     *            the url string
     */
    protected WebRequest(String urlString) {
        this(null, urlString);
    }

    /**
     * Constructs a web request using a base URL and a relative URL string.
     *
     * @param urlBase
     *            the url base
     * @param urlString
     *            the url string
     */
    protected WebRequest(URL urlBase, String urlString) {
        this(urlBase, urlString, TOP_FRAME);
    }

    /**
     * Constructs a web request using a base request and a relative URL string.
     *
     * @param baseRequest
     *            the base request
     * @param urlString
     *            the url string
     * @param target
     *            the target
     *
     * @throws MalformedURLException
     *             the malformed URL exception
     */
    protected WebRequest(WebRequest baseRequest, String urlString, String target) throws MalformedURLException {
        this(baseRequest.getURL(), urlString, target);
    }

    /**
     * Constructs a web request using a base URL, a relative URL string, and a target.
     *
     * @param urlBase
     *            the url base
     * @param urlString
     *            the url string
     * @param target
     *            the target
     */
    protected WebRequest(URL urlBase, String urlString, String target) {
        this(urlBase, urlString, FrameSelector.TOP_FRAME, target);
    }

    /**
     * Constructs a web request using a base URL, a relative URL string, and a target.
     *
     * @param referer
     *            the referer
     * @param sourceElement
     *            the source element
     * @param urlBase
     *            the url base
     * @param urlString
     *            the url string
     * @param target
     *            the target
     */
    protected WebRequest(WebResponse referer, Element sourceElement, URL urlBase, String urlString, String target) {
        this(urlBase, urlString, referer.getFrame(), target != null ? target : referer.getBaseTarget());
        _sourceElement = sourceElement;
        _referringPage = referer;
        setHeaderField(REFERER_HEADER_NAME, referer.getURL().toExternalForm());
    }

    /**
     * Constructs a web request using a base URL, a relative URL string, and a target.
     *
     * @param urlBase
     *            the url base
     * @param urlString
     *            the url string
     * @param frame
     *            the frame
     * @param target
     *            the target
     */
    protected WebRequest(URL urlBase, String urlString, FrameSelector frame, String target) {
        this(urlBase, urlString, frame, target, new UncheckedParameterHolder());
    }

    /**
     * Constructs a web request from a form.
     *
     * @param sourceForm
     *            - the WebForm to startFrom
     * @param parameterHolder
     *            - the parameter holder
     * @param button
     *            - the submit button
     * @param x
     *            - x position
     * @param y
     *            - y position
     **/
    protected WebRequest(WebForm sourceForm, ParameterHolder parameterHolder, SubmitButton button, int x, int y) {
        this(sourceForm, parameterHolder);
        // [ 1443333 ] Allow unnamed Image input elements to submit x,y values
        if (button != null && button.isValidImageButton()) {
            _button = button;
            _parameterHolder.selectImageButtonPosition(_button, x, y);
        }
    }

    /**
     * Instantiates a new web request.
     *
     * @param requestSource
     *            the request source
     * @param parameterHolder
     *            the parameter holder
     */
    protected WebRequest(WebRequestSource requestSource, ParameterHolder parameterHolder) {
        this(requestSource.getBaseURL(), requestSource.getRelativePage(), requestSource.getFrame(),
                requestSource.getTarget(), parameterHolder);
        _webRequestSource = requestSource;
        _sourceElement = requestSource.getElement();
    }

    /**
     * New parameter holder.
     *
     * @param requestSource
     *            the request source
     *
     * @return the parameter holder
     */
    static ParameterHolder newParameterHolder(WebRequestSource requestSource) {
        if (HttpUnitOptions.getParameterValuesValidated()) {
            return requestSource;
        }
        return new UncheckedParameterHolder(requestSource);
    }

    /**
     * Constructs a web request using a base URL, a relative URL string, and a target.
     *
     * @param urlBase
     *            the url base
     * @param urlString
     *            the url string
     * @param sourceFrame
     *            the source frame
     * @param requestTarget
     *            the request target
     * @param parameterHolder
     *            the parameter holder
     */
    private WebRequest(URL urlBase, String urlString, FrameSelector sourceFrame, String requestTarget,
            ParameterHolder parameterHolder) {
        _urlBase = urlBase;
        _sourceFrame = sourceFrame;
        _requestTarget = requestTarget;
        _urlString = urlString.toLowerCase(Locale.ENGLISH).startsWith("http") ? escape(urlString) : urlString;
        _parameterHolder = parameterHolder;
        _characterSet = parameterHolder.getCharacterSet();
    }

    /**
     * Escape.
     *
     * @param urlString
     *            the url string
     *
     * @return the string
     */
    private static String escape(String urlString) {
        if (urlString.indexOf(' ') < 0) {
            return urlString;
        }
        StringBuilder sb = new StringBuilder();

        int start = 0;
        do {
            int index = urlString.indexOf(' ', start);
            if (index < 0) {
                sb.append(urlString.substring(start));
                break;
            }
            sb.append(urlString.substring(start, index)).append("%20");
            start = index + 1;
        } while (true);
        return sb.toString();
    }

    /**
     * Returns true if selectFile may be called with this parameter.
     *
     * @param parameterName
     *            the parameter name
     *
     * @return true, if successful
     */
    protected boolean maySelectFile(String parameterName) {
        return isFileParameter(parameterName);
    }

    /**
     * Returns true if this request is to be MIME-encoded.
     *
     * @return true, if is mime encoded
     */
    protected boolean isMimeEncoded() {
        return false;
    }

    /**
     * Returns the content type of this request. If null, no content is specified.
     *
     * @return the content type
     */
    protected String getContentType() {
        return null;
    }

    /**
     * Returns the character set required for this request.
     *
     * @return the character set
     */
    protected final String getCharacterSet() {
        return _characterSet;
    }

    /**
     * Performs any additional processing necessary to complete the request.
     *
     * @param connection
     *            the connection
     *
     * @throws IOException
     *             Signals that an I/O exception has occurred.
     */
    protected void completeRequest(URLConnection connection) throws IOException {
        if (connection instanceof HttpURLConnection) {
            ((HttpURLConnection) connection).setRequestMethod(getMethod());
        }
    }

    /**
     * Writes the contents of the message body to the specified stream.
     *
     * @param stream
     *            the stream
     *
     * @throws IOException
     *             Signals that an I/O exception has occurred.
     */
    protected void writeMessageBody(OutputStream stream) throws IOException {
    }

    /**
     * Gets the URL base.
     *
     * @return the URL base
     */
    protected final URL getURLBase() {
        return _urlBase;
    }

    // ------------------------------------- protected members ---------------------------------------------

    /**
     * Gets the URL string.
     *
     * @return the URL string
     */
    protected String getURLString() {
        final String queryString = getQueryString();
        if (queryString.isEmpty()) {
            return _urlString;
        }
        return _urlString + "?" + queryString;
    }

    /**
     * Gets the parameter holder.
     *
     * @return the parameter holder
     */
    protected final ParameterHolder getParameterHolder() {
        return _parameterHolder;
    }

    // ---------------------------------- package members --------------------------------

    /** The target indicating the topmost frame of a window. **/
    static final String TOP_FRAME = "_top";

    /** The target indicating the parent of a frame. **/
    static final String PARENT_FRAME = "_parent";

    /** The target indicating a new, empty window. **/
    static final String NEW_WINDOW = "_blank";

    /** The target indicating the same frame. **/
    static final String SAME_FRAME = "_self";

    /**
     * Gets the header dictionary.
     *
     * @return the header dictionary
     */
    Hashtable getHeaderDictionary() {
        if (_headers == null) {
            _headers = new Hashtable<>();
            if (getContentType() != null) {
                _headers.put("Content-Type", getContentType());
            }
        }
        return _headers;
    }

    /**
     * Gets the referer.
     *
     * @return the referer
     */
    String getReferer() {
        return _headers == null ? null : (String) _headers.get(REFERER_HEADER_NAME);
    }

    /**
     * Gets the source scripting handler.
     *
     * @return the source scripting handler
     */
    ScriptingHandler getSourceScriptingHandler() {
        WebRequestSource wrs = _webRequestSource;
        if (wrs != null) {
            return wrs.getScriptingHandler();
        }
        if (_referringPage != null && _sourceElement != null) {
            try {
                _referringPage.getReceivedPage().getElement(_sourceElement).getScriptingHandler();
            } catch (SAXException e) {
            }
        }
        return null;
    }

}

// ======================================== class JavaScriptURLStreamHandler
// ============================================

class JavascriptURLStreamHandler extends URLStreamHandler {

    @Override
    protected URLConnection openConnection(URL u) throws IOException {
        return null;
    }
}

// ======================================== class HttpsURLStreamHandler ============================================

class HttpsURLStreamHandler extends URLStreamHandler {

    @Override
    protected URLConnection openConnection(URL u) throws IOException {
        throw new RuntimeException(
                "https support requires the Java Secure Sockets Extension. See http://java.sun.com/products/jsse");
    }
}

// ============================= exception class IllegalNonFileParameterException ======================================

/**
 * This exception is thrown on an attempt to set a non-file parameter to a file value.
 **/
class IllegalNonFileParameterException extends IllegalRequestParameterException {

    private static final long serialVersionUID = 1L;

    IllegalNonFileParameterException(String parameterName) {
        _parameterName = parameterName;
    }

    @Override
    public String getMessage() {
        return "Parameter '" + _parameterName + "' is not a file parameter and may not be set to a file value.";
    }

    private String _parameterName;

}

// ============================= exception class MultipartFormRequiredException ======================================

/**
 * This exception is thrown on an attempt to set a file parameter in a form that does not specify MIME encoding.
 **/
class MultipartFormRequiredException extends IllegalRequestParameterException {

    private static final long serialVersionUID = 1L;

    MultipartFormRequiredException() {
    }

    @Override
    public String getMessage() {
        return "The request does not use multipart/form-data encoding, and cannot be used to upload files ";
    }

}

// ============================= exception class IllegalButtonPositionException ======================================

/**
 * This exception is thrown on an attempt to set a file parameter in a form that does not specify MIME encoding.
 **/
class IllegalButtonPositionException extends IllegalRequestParameterException {

    private static final long serialVersionUID = 1L;

    IllegalButtonPositionException() {
    }

    @Override
    public String getMessage() {
        return "The request was not created with an image button, and cannot accept an image button click position";
    }

}

hazendaz / httpunit / 656

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous