/*
 * Copyright (C) 2011 Google Inc. All rights reserved.
 * Copyright (C) 2021 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include <WebCore/CookieRequestHeaderFieldProxy.h>
#include <WebCore/HTTPHeaderMap.h>
#include <WebCore/ResourceResponse.h>
#include <WebCore/WebSocketExtensionDispatcher.h>
#include <WebCore/WebSocketExtensionProcessor.h>
#include <wtf/TZoneMalloc.h>
#include <wtf/URL.h>
#include <wtf/WeakPtr.h>
#include <wtf/text/WTFString.h>

namespace WebCore {

class ResourceRequest;

class WebSocketHandshake {
    WTF_MAKE_TZONE_ALLOCATED_EXPORT(WebSocketHandshake, WEBCORE_EXPORT);
    WTF_MAKE_NONCOPYABLE(WebSocketHandshake);
public:
    enum Mode {
        Incomplete, Normal, Failed, Connected
    };
    WEBCORE_EXPORT WebSocketHandshake(const URL&, const String& protocol, const String& userAgent, const String& clientOrigin, bool allowCookies, bool isAppInitiated);
    WEBCORE_EXPORT ~WebSocketHandshake();

    WEBCORE_EXPORT const URL& NODELETE url() const;
    void setURL(const URL&);
    WEBCORE_EXPORT URL httpURLForAuthenticationAndCookies() const;
    const String host() const;

    const String& NODELETE clientProtocol() const;
    void setClientProtocol(const String&);

    bool NODELETE secure() const;

    String clientLocation() const;

    WEBCORE_EXPORT CString clientHandshakeMessage() const;
    WEBCORE_EXPORT ResourceRequest clientHandshakeRequest(NOESCAPE const Function<String(const URL&)>& cookieRequestHeaderFieldValue) const;

    WEBCORE_EXPORT void setClientHandshakeRequestHeaders(const HTTPHeaderMap&);

    WEBCORE_EXPORT void reset();

    WEBCORE_EXPORT int readServerHandshake(std::span<const uint8_t> header);
    WEBCORE_EXPORT Mode NODELETE mode() const;
    WEBCORE_EXPORT String NODELETE failureReason() const; // Returns a string indicating the reason of failure if mode() == Failed.

    WEBCORE_EXPORT String serverWebSocketProtocol() const;
    WEBCORE_EXPORT String serverSetCookie() const;
    String serverUpgrade() const;
    String serverConnection() const;
    String serverWebSocketAccept() const;
    WEBCORE_EXPORT String acceptedExtensions() const;

    WEBCORE_EXPORT const ResourceResponse& NODELETE serverHandshakeResponse() const;

    WEBCORE_EXPORT void addExtensionProcessor(std::unique_ptr<WebSocketExtensionProcessor>);

    static String getExpectedWebSocketAccept(const String& secWebSocketKey);

private:

    int readStatusLine(std::span<const uint8_t> header, int& statusCode, String& statusText);

    // Reads all headers except for the two predefined ones.
    std::span<const uint8_t> readHTTPHeaders(std::span<const uint8_t>);
    void processHeaders();
    bool checkResponseHeaders();

    URL m_url;
    String m_clientProtocol;
    bool m_secure;

    Mode m_mode;
    String m_userAgent;
    String m_clientOrigin;
    bool m_allowCookies;
    bool m_isAppInitiated;

    HTTPHeaderMap m_clientHandshakeRequestHeaders;

    ResourceResponse m_serverHandshakeResponse;

    String m_failureReason;

    String m_secWebSocketKey;
    String m_expectedAccept;

    WebSocketExtensionDispatcher m_extensionDispatcher;
};

} // namespace WebCore
