8443f430bc9363b93b08a37a343210f0bcc2dfc4
[WebKit-https.git] / Source / WebKit / UIProcess / API / APIAttachment.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(ATTACHMENT_ELEMENT)
29
30 #include "APIObject.h"
31 #include "WKBase.h"
32 #include "WebPageProxy.h"
33 #include <wtf/RefPtr.h>
34 #include <wtf/WeakPtr.h>
35 #include <wtf/text/WTFString.h>
36
37 OBJC_CLASS NSFileWrapper;
38
39 namespace WebCore {
40 class SharedBuffer;
41 struct AttachmentDisplayOptions;
42 }
43
44 namespace WebKit {
45 class WebPageProxy;
46 }
47
48 namespace API {
49
50 class Attachment final : public ObjectImpl<Object::Type::Attachment> {
51 public:
52     static Ref<Attachment> create(const WTF::String& identifier, WebKit::WebPageProxy&);
53     virtual ~Attachment();
54
55     enum class InsertionState : uint8_t { NotInserted, Inserted };
56
57     const WTF::String& identifier() const { return m_identifier; }
58     void setDisplayOptions(WebCore::AttachmentDisplayOptions, Function<void(WebKit::CallbackBase::Error)>&&);
59     void updateAttributes(Function<void(WebKit::CallbackBase::Error)>&&);
60
61     void invalidate();
62     bool isValid() const { return !!m_webPage; }
63
64 #if PLATFORM(COCOA)
65     NSFileWrapper *fileWrapper() const { return m_fileWrapper.get(); }
66     void setFileWrapper(NSFileWrapper *fileWrapper) { m_fileWrapper = fileWrapper; }
67     void setFileWrapperAndUpdateContentType(NSFileWrapper *, NSString *contentType);
68     WTF::String utiType() const;
69 #endif
70     WTF::String mimeType() const;
71
72     const WTF::String& filePath() const { return m_filePath; }
73     void setFilePath(const WTF::String& filePath) { m_filePath = filePath; }
74     WTF::String fileName() const;
75
76     const WTF::String& contentType() const { return m_contentType; }
77     void setContentType(const WTF::String& contentType) { m_contentType = contentType; }
78
79     InsertionState insertionState() const { return m_insertionState; }
80     void setInsertionState(InsertionState state) { m_insertionState = state; }
81
82     std::optional<uint64_t> fileSizeForDisplay() const;
83
84 private:
85     explicit Attachment(const WTF::String& identifier, WebKit::WebPageProxy&);
86
87 #if PLATFORM(COCOA)
88     RetainPtr<NSFileWrapper> m_fileWrapper;
89 #endif
90     WTF::String m_identifier;
91     WTF::String m_filePath;
92     WTF::String m_contentType;
93     WeakPtr<WebKit::WebPageProxy> m_webPage;
94     InsertionState m_insertionState { InsertionState::NotInserted };
95 };
96
97 } // namespace API
98
99 #endif // ENABLE(ATTACHMENT_ELEMENT)