/*
 *  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.coyote.http11;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameter;

import org.apache.catalina.Context;
import org.apache.catalina.startup.SimpleHttpClient;
import org.apache.catalina.startup.TesterServlet;
import org.apache.catalina.startup.Tomcat;
import org.apache.catalina.startup.TomcatBaseTest;

@RunWith(Parameterized.class)
public class TestHttp11InputBufferCRLF extends TomcatBaseTest {

    private static final String CR = "\r";
    private static final String LF = "\n";
    private static final String CRLF = CR + LF;

    @Parameterized.Parameters
    public static Collection<Object[]> parameters() {
        List<Object[]> parameterSets = new ArrayList<>();

        // Requests to exercise code that allows HT in place of SP
        parameterSets.add(new Object[] { Boolean.FALSE, new String[] {
                "GET\t/test\tHTTP/1.1" + CRLF +
                "Host: localhost:8080" + CRLF +
               "Connection: close" + CRLF +
                CRLF }, Boolean.TRUE } );

        // Requests to simulate package boundaries
        // HTTP/0.9 request
        addRequestWithSplits("GET /test" + CRLF, Boolean.TRUE, parameterSets);

        // HTTP/0.9 request with space
        // Either malformed but acceptable HTTP/0.9 or invalid HTTP/1.1
        // Tomcat opts for invalid HTTP/1.1
        addRequestWithSplits("GET /test " + CRLF, Boolean.FALSE, Boolean.FALSE, parameterSets);

        // HTTP/0.9 request (no optional CR)
        addRequestWithSplits("GET /test" + LF, Boolean.TRUE, parameterSets);

        // HTTP/0.9 request with space (no optional CR)
        // Either malformed but acceptable HTTP/0.9 or invalid HTTP/1.1
        // Tomcat opts for invalid HTTP/1.1
        addRequestWithSplits("GET /test " + LF, Boolean.FALSE, Boolean.FALSE, parameterSets);

        // Standard HTTP/1.1 request
        addRequestWithSplits("GET /test HTTP/1.1" + CRLF +
                "Host: localhost:8080" + CRLF +
                "Connection: close" + CRLF +
                CRLF,
                Boolean.FALSE, parameterSets);

        // Standard HTTP/1.1 request with invalid HTTP protocol
        addRequestWithSplits("GET /test HTTP/" + CR + "1.1" + CRLF +
                "Host: localhost:8080" + CRLF +
                "Connection: close" + CRLF +
                CRLF,
                Boolean.FALSE, Boolean.FALSE, parameterSets);

        // Invalid (request target) HTTP/1.1 request
        addRequestWithSplits("GET /te<st HTTP/1.1" + CRLF +
                "Host: localhost:8080" + CRLF +
                "Connection: close" + CRLF +
                CRLF,
                Boolean.FALSE, Boolean.FALSE, parameterSets);

        // Invalid (use of CR) HTTP/1.1 request
        addRequestWithSplits("GET /test HTTP/1.1" + CRLF +
                "Host: localhost:8080" + CRLF +
                "Connection: close" + CRLF +
                "X-aaa: bbb" + CR + CRLF +
                CRLF,
                Boolean.FALSE, Boolean.FALSE, parameterSets);

        // Standard HTTP/1.1 request with a query string
        addRequestWithSplits("GET /test?a=b HTTP/1.1" + CRLF +
                "Host: localhost:8080" + CRLF +
                "Connection: close" + CRLF +
                CRLF,
                Boolean.FALSE, parameterSets);

        // Standard HTTP/1.1 request with a query string that includes ?
        addRequestWithSplits("GET /test?a=?b HTTP/1.1" + CRLF +
                "Host: localhost:8080" + CRLF +
                "Connection: close" + CRLF +
                CRLF,
                Boolean.FALSE, parameterSets);

        // Standard HTTP/1.1 request with an invalid query string
        addRequestWithSplits("GET /test?a=<b HTTP/1.1" + CRLF +
                "Host: localhost:8080" + CRLF +
                "Connection: close" + CRLF +
                CRLF,
                Boolean.FALSE, Boolean.FALSE, parameterSets);

        // Standard HTTP/1.1 request using LF rather than CRLF
        addRequestWithSplits("GET /test HTTP/1.1" + LF +
                "Host: localhost:8080" + LF +
                "Connection: close" + LF +
                LF,
                Boolean.FALSE, parameterSets);

        // Invalid HTTP/1.1 request using CR rather than CRLF
        addRequestWithSplits("GET /test HTTP/1.1" + CR +
                "Host: localhost:8080" + CR +
                "Connection: close" + CR +
                CR,
                Boolean.FALSE, Boolean.FALSE, parameterSets);

        return parameterSets;
    }


    private static void addRequestWithSplits(String request, Boolean isHttp09, List<Object[]> parameterSets) {
        addRequestWithSplits(request, isHttp09, Boolean.TRUE, parameterSets);
    }

    private static void addRequestWithSplits(String request, Boolean isHttp09, Boolean valid, List<Object[]> parameterSets) {
        // Add as a single String
        parameterSets.add(new Object[] { isHttp09, new String[] { request }, valid });

        // Add with all CRLF split between the CR and LF
        List<String> parts = new ArrayList<>();
        int lastPos = 0;
        int pos = request.indexOf('\n');
        while (pos > -1) {
            parts.add(request.substring(lastPos, pos));
            lastPos = pos;
            pos = request.indexOf('\n', lastPos + 1);
        }
        parts.add(request.substring(lastPos));
        parameterSets.add(new Object[] { isHttp09, parts.toArray(new String[0]), valid });

        // Add with a split between each character
        List<String> chars = new ArrayList<>();
        for (char c : request.toCharArray()) {
            chars.add(Character.toString(c));
        }
        parameterSets.add(new Object[] { isHttp09, chars.toArray(new String[0]), valid });
    }

    @Parameter(0)
    public boolean isHttp09;

    @Parameter(1)
    public String[] request;

    @Parameter(2)
    public boolean valid;


    @Test
    public void testBug54947() {

        Client client = new Client(request, isHttp09);

        Exception e = client.doRequest();

        if (valid) {
            Assert.assertTrue(client.isResponseBodyOK());
        } else if (e == null){
            Assert.assertTrue(client.isResponse400());
        } else {
            // The invalid request was detected before the entire request had
            // been sent to Tomcat reset the connection when the client tried to
            // continue sending the invalid request.
        }
    }


    private class Client extends SimpleHttpClient {

        public Client(String[] request, boolean isHttp09) {
            setRequest(request);
            setUseHttp09(isHttp09);
        }

        private Exception doRequest() {

            Tomcat tomcat = getTomcatInstance();

            Context root = tomcat.addContext("", TEMP_DIR);
            Tomcat.addServlet(root, "TesterServlet", new TesterServlet());
            root.addServletMappingDecoded("/test", "TesterServlet");

            try {
                tomcat.start();
                setPort(tomcat.getConnector().getLocalPort());
                setRequestPause(20);

                // Open connection
                connect();

                processRequest(); // blocks until response has been read

                // Close the connection
                disconnect();
            } catch (Exception e) {
                return e;
            }
            return null;
        }

        @Override
        public boolean isResponseBodyOK() {
            if (getResponseBody() == null) {
                return false;
            }
            if (!getResponseBody().contains("OK")) {
                return false;
            }
            return true;
        }
    }
}
