Source/WebCore/editing/WebContentReader.h

/*
 * Copyright (C) 2013-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 "DocumentFragment.h"
#include "LocalFrame.h"
#include "Pasteboard.h"
#include "SimpleRange.h"
#include "markup.h"
#include <wtf/WeakRef.h>

namespace WebCore {

class ArchiveResource;

class FrameWebContentReader : public PasteboardWebContentReader {
public:
    FrameWebContentReader(LocalFrame& frame)
        : m_frame(frame)
    {
    }

    LocalFrame& frame() const { return m_frame.get(); }
    Ref<LocalFrame> protectedFrame() const { return m_frame.get(); }

protected:
    bool shouldSanitize() const;
    MSOListQuirks msoListQuirksForMarkup() const;

private:
    WeakRef<LocalFrame> m_frame;
};

class WebContentReader final : public FrameWebContentReader {
public:
#if PLATFORM(COCOA)
    static constexpr auto placeholderAttachmentFilenamePrefix = "webkit-attachment-"_s;
#endif

    WebContentReader(LocalFrame& frame, const SimpleRange& context, bool allowPlainText)
        : FrameWebContentReader(frame)
        , m_context(context)
#if PLATFORM(COCOA) || PLATFORM(GTK) || PLATFORM(WPE)
        , m_allowPlainText(allowPlainText)
#endif
    {
        UNUSED_PARAM(allowPlainText);
    }

    void addFragment(Ref<DocumentFragment>&&);
    RefPtr<DocumentFragment> takeFragment() { return std::exchange(m_fragment, nullptr); }
    DocumentFragment* fragment() const { return m_fragment.get(); }
    RefPtr<DocumentFragment> protectedFragment() const { return m_fragment; }

    bool madeFragmentFromPlainText() const { return m_madeFragmentFromPlainText; }

private:
#if PLATFORM(COCOA) || PLATFORM(GTK) || PLATFORM(WPE)
    bool readFilePath(const String&, PresentationSize preferredPresentationSize = { }, const String& contentType = { }) override;
    bool readFilePaths(const Vector<String>&) override;
    bool readHTML(const String&) override;
    bool readImage(Ref<FragmentedSharedBuffer>&&, const String& type, PresentationSize preferredPresentationSize = { }) override;
    bool readURL(const URL&, const String& title) override;
    bool readPlainText(const String&) override;
#endif

#if PLATFORM(COCOA)
    bool readWebArchive(SharedBuffer&) override;
    bool readRTFD(SharedBuffer&) override;
    bool readRTF(SharedBuffer&) override;
    bool readDataBuffer(SharedBuffer&, const String& type, const AtomString& name, PresentationSize preferredPresentationSize = { }) override;
#endif

    const SimpleRange m_context;
#if PLATFORM(COCOA) || PLATFORM(GTK) || PLATFORM(WPE)
    const bool m_allowPlainText;
#endif

    RefPtr<DocumentFragment> m_fragment;
    bool m_madeFragmentFromPlainText { false };
};

class WebContentMarkupReader final : public FrameWebContentReader {
public:
    explicit WebContentMarkupReader(LocalFrame& frame)
        : FrameWebContentReader(frame)
    {
    }

    String takeMarkup() { return std::exchange(m_markup, { }); }

private:
#if PLATFORM(COCOA) || PLATFORM(GTK) || PLATFORM(WPE)
    bool readFilePath(const String&, PresentationSize = { }, const String& = { }) override { return false; }
    bool readFilePaths(const Vector<String>&) override { return false; }
    bool readHTML(const String&) override;
    bool readImage(Ref<FragmentedSharedBuffer>&&, const String&, PresentationSize = { }) override { return false; }
    bool readURL(const URL&, const String&) override { return false; }
    bool readPlainText(const String&) override { return false; }
#endif

#if PLATFORM(COCOA)
    bool readWebArchive(SharedBuffer&) override;
    bool readRTFD(SharedBuffer&) override;
    bool readRTF(SharedBuffer&) override;
    bool readDataBuffer(SharedBuffer&, const String&, const AtomString&, PresentationSize = { }) override { return false; }
#endif

    String m_markup;
};

#if PLATFORM(COCOA) && defined(__OBJC__)
struct FragmentAndResources {
    RefPtr<DocumentFragment> fragment;
    Vector<Ref<ArchiveResource>> resources;
};

enum class FragmentCreationOptions : uint8_t {
    IgnoreResources = 1 << 0,
    NoInterchangeNewlines = 1 << 1,
    SanitizeMarkup = 1 << 2
};

WEBCORE_EXPORT RefPtr<DocumentFragment> createFragment(LocalFrame&, NSAttributedString *, OptionSet<FragmentCreationOptions> = { });
#endif

}