6aecac8ff49425455cdf7ba37bbd17e682f7dd1e
[WebKit-https.git] / Source / WebCore / dom / DataTransfer.h
1 /*
2  * Copyright (C) 2001 Peter Kelly (pmk@post.com)
3  * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
4  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
5  * Copyright (C) 2003-2016 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #pragma once
25
26 #include "CachedResourceHandle.h"
27 #include "DragActions.h"
28 #include "DragImage.h"
29 #include <pal/SessionID.h>
30 #include <wtf/text/WTFString.h>
31
32 namespace WebCore {
33
34 class CachedImage;
35 class DataTransferItemList;
36 class Document;
37 class DragData;
38 class DragImageLoader;
39 class Element;
40 class FileList;
41 class File;
42 class Pasteboard;
43 enum class WebContentReadingPolicy;
44
45 class DataTransfer : public RefCounted<DataTransfer> {
46 public:
47     // https://html.spec.whatwg.org/multipage/dnd.html#drag-data-store-mode
48     enum class StoreMode { Invalid, ReadWrite, Readonly, Protected };
49
50     static Ref<DataTransfer> createForCopyAndPaste(const Document&, StoreMode, std::unique_ptr<Pasteboard>&&);
51     static Ref<DataTransfer> createForInputEvent(const Document&, const String& plainText, const String& htmlText);
52
53     WEBCORE_EXPORT ~DataTransfer();
54
55     String dropEffect() const;
56     void setDropEffect(const String&);
57
58     String effectAllowed() const;
59     void setEffectAllowed(const String&);
60
61     DataTransferItemList& items();
62     Vector<String> types() const;
63     Vector<String> typesForItemList() const;
64
65     FileList& files() const;
66
67     void clearData(const String& type = String());
68
69     String getData(Document&, const String& type) const;
70     String getDataForItem(Document&, const String& type) const;
71
72     void setData(const String& type, const String& data);
73     void setDataFromItemList(const String& type, const String& data);
74
75     void setDragImage(Element*, int x, int y);
76
77     void makeInvalidForSecurity() { m_storeMode = StoreMode::Invalid; }
78
79     bool canReadTypes() const;
80     bool canReadData() const;
81     bool canWriteData() const;
82
83     bool hasFileOfType(const String&);
84     bool hasStringOfType(const String&);
85
86     Pasteboard& pasteboard() { return *m_pasteboard; }
87     void commitToPasteboard(Pasteboard&);
88
89 #if ENABLE(DRAG_SUPPORT)
90     static Ref<DataTransfer> createForDrag(const Document&);
91     static Ref<DataTransfer> createForDragStartEvent(const Document&);
92     static Ref<DataTransfer> createForDrop(const Document&, std::unique_ptr<Pasteboard>&&, DragOperation, bool draggingFiles);
93     static Ref<DataTransfer> createForUpdatingDropTarget(const Document&, std::unique_ptr<Pasteboard>&&, DragOperation, bool draggingFiles);
94
95     bool dropEffectIsUninitialized() const { return m_dropEffect == "uninitialized"; }
96
97     DragOperation sourceOperation() const;
98     DragOperation destinationOperation() const;
99     void setSourceOperation(DragOperation);
100     void setDestinationOperation(DragOperation);
101
102     void setDragHasStarted() { m_shouldUpdateDragImage = true; }
103     DragImageRef createDragImage(IntPoint& dragLocation) const;
104     void updateDragImage();
105     RefPtr<Element> dragImageElement() const;
106
107     void moveDragState(Ref<DataTransfer>&&);
108     bool hasDragImage() const;
109 #endif
110
111     void didAddFileToItemList();
112     void updateFileList();
113
114 private:
115     enum class Type { CopyAndPaste, DragAndDropData, DragAndDropFiles, InputEvent };
116     DataTransfer(const Document&, StoreMode, std::unique_ptr<Pasteboard>, Type = Type::CopyAndPaste);
117
118 #if ENABLE(DRAG_SUPPORT)
119     bool forDrag() const { return m_type == Type::DragAndDropData || m_type == Type::DragAndDropFiles; }
120     bool forFileDrag() const { return m_type == Type::DragAndDropFiles; }
121 #else
122     bool forDrag() const { return false; }
123     bool forFileDrag() const { return false; }
124 #endif
125
126     String readStringFromPasteboard(Document&, const String& lowercaseType, WebContentReadingPolicy) const;
127     bool shouldSuppressGetAndSetDataToAvoidExposingFilePaths() const;
128
129     enum class AddFilesType { No, Yes };
130     Vector<String> types(AddFilesType) const;
131     Vector<Ref<File>> filesFromPasteboardAndItemList() const;
132
133     PAL::SessionID m_sessionID;
134     String m_originIdentifier;
135     StoreMode m_storeMode;
136     std::unique_ptr<Pasteboard> m_pasteboard;
137     std::unique_ptr<DataTransferItemList> m_itemList;
138
139     mutable RefPtr<FileList> m_fileList;
140
141 #if ENABLE(DRAG_SUPPORT)
142     Type m_type;
143     String m_dropEffect;
144     String m_effectAllowed;
145     bool m_shouldUpdateDragImage;
146     IntPoint m_dragLocation;
147     CachedResourceHandle<CachedImage> m_dragImage;
148     RefPtr<Element> m_dragImageElement;
149     std::unique_ptr<DragImageLoader> m_dragImageLoader;
150 #endif
151 };
152
153 } // namespace WebCore