/*
 * Copyright (C) 2010 Google Inc. All rights reserved.
 * Copyright (C) 2025 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:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS 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 APPLE INC. OR ITS 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/BlobData.h>
#include <WebCore/FileStreamClient.h>
#include <WebCore/HTTPParsers.h>
#include <wtf/Box.h>
#include <wtf/Forward.h>
#include <wtf/Variant.h>
#include <wtf/Vector.h>

namespace WebCore {

class AsyncFileStream;
class BlobDataItem;
class FileStream;
class ResourceRequest;

class BlobResourceHandleBase : public FileStreamClient {
public:
    enum class Error {
        NoError = 0,
        NotFoundError = 1,
        SecurityError = 2,
        RangeError = 3,
        NotReadableError = 4,
        MethodNotAllowed = 5
    };

protected:
    WEBCORE_EXPORT BlobResourceHandleBase(bool async = true, RefPtr<BlobData>&& = nullptr);
    WEBCORE_EXPORT virtual ~BlobResourceHandleBase();

    WEBCORE_EXPORT void start();
    WEBCORE_EXPORT void readAsync();
    WEBCORE_EXPORT void closeFileIfOpen();
    bool isFileOpen() const { return m_isFileOpen; }
    void setIsFileOpen(bool isOpen) { m_isFileOpen = isOpen; }
    bool async() const { return std::holds_alternative<std::unique_ptr<AsyncFileStream>>(m_stream); }
    uint64_t totalSize() { return m_totalSize; }
    uint64_t totalRemainingSize() const { return m_totalRemainingSize; }
    uint64_t currentItemReadSize() const { return m_currentItemReadSize; }
    void setCurrentItemReadSize(uint64_t size) { m_currentItemReadSize = size; }
    void decrementTotalRemainingSizeBy(uint64_t value) { m_totalRemainingSize -= value; }
    uint64_t readItemCount() const { return m_readItemCount; }
    void incrementReadItemCount() { ++m_readItemCount; }
    uint64_t lengthOfItemBeingRead() const { return m_itemLengthList[m_readItemCount]; }
    WEBCORE_EXPORT void clearAsyncStream();
    WEBCORE_EXPORT BlobData* NODELETE blobData() const;
    FileStream* syncStream() const;
    AsyncFileStream* asyncStream() const;
    WEBCORE_EXPORT void resizeBuffer(size_t);
    const Vector<uint8_t>& buffer() const LIFETIME_BOUND { return *m_buffer; }

private:
    void getSizeForNext();
    std::optional<Error> NODELETE seek();
    std::optional<Error> NODELETE adjustAndValidateRangeBounds();
    bool consumeData(std::span<const uint8_t>);
    bool readDataAsync(const BlobDataItem&, DataSegment&);
    void readFileAsync(const BlobDataItem&, BlobDataFileReference&);
    void dispatchDidReceiveResponse();
    void doStart();
    void didRead(int); // -1 in case of error.

    virtual void didReceiveResponse(ResourceResponse&&) = 0;
    virtual void didFail(Error) = 0;
    virtual bool didReceiveData(std::span<const uint8_t>) = 0;
    virtual void didFinish() = 0;
    virtual bool erroredOrAborted() const = 0;
    virtual bool shouldAbortDispatchDidReceiveResponse() { return false; }
    virtual const ResourceRequest& firstRequest() const = 0;
    virtual void clearStream() { }

    // FileStreamClient methods.
    WEBCORE_EXPORT void didOpen(bool) final;
    WEBCORE_EXPORT void didGetSize(long long) final;

    RefPtr<BlobData> m_blobData;
    // For Async or Sync loading.
    Variant<std::unique_ptr<AsyncFileStream>, std::unique_ptr<FileStream>> m_stream;
    std::optional<HTTPRange> m_range;
    bool m_isWritingIntoBuffer { false };
    const Box<Vector<uint8_t>> m_buffer;
    Vector<uint64_t> m_itemLengthList;
    uint64_t m_totalSize { 0 };
    uint64_t m_totalRemainingSize { 0 };
    uint64_t m_currentItemReadSize { 0 };
    unsigned m_readItemCount { 0 };
    unsigned m_sizeItemCount { 0 };
    bool m_isFileOpen { false };
    bool m_isRangeRequest { false };
};

} // WebCore
