script/
drag_data_store.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use std::sync::Arc;
6
7use indexmap::IndexMap;
8use js::context::JSContext;
9use pixels::RasterImage;
10use servo_constellation_traits::BlobImpl;
11
12use crate::dom::bindings::error::{Error, Fallible};
13use crate::dom::bindings::root::DomRoot;
14use crate::dom::bindings::str::DOMString;
15use crate::dom::file::File;
16use crate::dom::globalscope::GlobalScope;
17
18/// <https://html.spec.whatwg.org/multipage/#the-drag-data-item-kind>
19#[derive(MallocSizeOf)]
20pub(crate) enum Kind {
21    Text {
22        data: DOMString,
23        type_: DOMString,
24    },
25    File {
26        bytes: Vec<u8>,
27        name: DOMString,
28        type_: String,
29    },
30}
31
32impl Kind {
33    pub(crate) fn type_(&self) -> DOMString {
34        match self {
35            Kind::Text { type_, .. } => type_.clone(),
36            Kind::File { type_, .. } => DOMString::from(type_.clone()),
37        }
38    }
39
40    pub(crate) fn as_string(&self) -> Option<String> {
41        match self {
42            Kind::Text { data, .. } => Some(data.to_string()),
43            Kind::File { .. } => None,
44        }
45    }
46
47    // TODO for now we create a new BlobImpl
48    // since File constructor requires moving it.
49    pub(crate) fn as_file(
50        &self,
51        cx: &mut JSContext,
52        global: &GlobalScope,
53    ) -> Option<DomRoot<File>> {
54        match self {
55            Kind::Text { .. } => None,
56            Kind::File { bytes, name, type_ } => Some(File::new(
57                cx,
58                global,
59                BlobImpl::new_from_bytes(bytes.clone(), type_.clone()),
60                name.clone(),
61                None,
62            )),
63        }
64    }
65
66    fn text_type_matches(&self, text_type: &DOMString) -> bool {
67        matches!(self, Kind::Text { type_, .. } if type_.eq(text_type))
68    }
69
70    fn is_file(&self) -> bool {
71        matches!(self, Kind::File { .. })
72    }
73}
74
75/// <https://html.spec.whatwg.org/multipage/#drag-data-store-bitmap>
76#[derive(MallocSizeOf)]
77struct Bitmap {
78    #[conditional_malloc_size_of]
79    image: Option<Arc<RasterImage>>,
80    x: i32,
81    y: i32,
82}
83
84/// Control the behaviour of the drag data store
85#[derive(Clone, Copy, Eq, MallocSizeOf, PartialEq)]
86pub(crate) enum Mode {
87    /// <https://html.spec.whatwg.org/multipage/#concept-dnd-rw>
88    ReadWrite,
89    /// <https://html.spec.whatwg.org/multipage/#concept-dnd-ro>
90    ReadOnly,
91    /// <https://html.spec.whatwg.org/multipage/#concept-dnd-p>
92    Protected,
93}
94
95#[derive(MallocSizeOf)]
96pub(crate) struct DragDataStore {
97    /// <https://html.spec.whatwg.org/multipage/#drag-data-store-item-list>
98    item_list: IndexMap<u16, Kind>,
99    next_item_id: u16,
100    /// <https://html.spec.whatwg.org/multipage/#drag-data-store-default-feedback>
101    default_feedback: Option<String>,
102    bitmap: Option<Bitmap>,
103    mode: Mode,
104    /// <https://html.spec.whatwg.org/multipage/#drag-data-store-allowed-effects-state>
105    allowed_effects_state: String,
106    pub clear_was_called: bool,
107}
108
109impl DragDataStore {
110    /// <https://html.spec.whatwg.org/multipage/#create-a-drag-data-store>
111    // We don't really need it since it's only instantiated by DataTransfer.
112    pub(crate) fn new() -> DragDataStore {
113        DragDataStore {
114            item_list: IndexMap::new(),
115            next_item_id: 0,
116            default_feedback: None,
117            bitmap: None,
118            mode: Mode::Protected,
119            allowed_effects_state: String::from("uninitialized"),
120            clear_was_called: false,
121        }
122    }
123
124    /// Get the drag data store mode
125    pub(crate) fn mode(&self) -> Mode {
126        self.mode
127    }
128
129    /// Set the drag data store mode
130    pub(crate) fn set_mode(&mut self, mode: Mode) {
131        self.mode = mode;
132    }
133
134    pub(crate) fn set_bitmap(&mut self, image: Option<Arc<RasterImage>>, x: i32, y: i32) {
135        self.bitmap = Some(Bitmap { image, x, y });
136    }
137
138    /// <https://html.spec.whatwg.org/multipage/#concept-datatransfer-types>
139    pub(crate) fn types(&self) -> Vec<DOMString> {
140        let mut types = Vec::new();
141
142        let has_files = self.item_list.values().fold(false, |has_files, item| {
143            // Step 2.1 For each item in the item list whose kind is text,
144            // add an entry to L consisting of the item's type string.
145            match item {
146                Kind::Text { type_, .. } => types.push(type_.clone()),
147                Kind::File { .. } => return true,
148            }
149
150            has_files
151        });
152
153        // Step 2.2 If there are any items in the item list whose kind is File,
154        // add an entry to L consisting of the string "Files".
155        if has_files {
156            types.push(DOMString::from("Files"));
157        }
158        types
159    }
160
161    pub(crate) fn find_matching_text(&self, type_: &DOMString) -> Option<DOMString> {
162        self.item_list
163            .values()
164            .find(|item| item.text_type_matches(type_))
165            .and_then(|item| item.as_string())
166            .map(DOMString::from)
167    }
168
169    pub(crate) fn add(&mut self, kind: Kind) -> Fallible<u16> {
170        if let Kind::Text { ref type_, .. } = kind {
171            // Step 2.1 If there is already an item in the item list whose kind is text
172            // and whose type string is equal to the method's second argument, throw "NotSupportedError".
173            if self
174                .item_list
175                .values()
176                .any(|item| item.text_type_matches(type_))
177            {
178                return Err(Error::NotSupported(None));
179            }
180        }
181
182        let item_id = self.next_item_id;
183
184        // Step 2.2
185        self.item_list.insert(item_id, kind);
186
187        self.next_item_id += 1;
188        Ok(item_id)
189    }
190
191    pub(crate) fn set_data(&mut self, format: DOMString, data: DOMString) {
192        // Step 3-4
193        let type_ = normalize_mime(format);
194
195        // Step 5 Remove the item in the drag data store item list whose kind is text
196        // and whose type string is equal to format, if there is one.
197        self.item_list
198            .retain(|_, item| !item.text_type_matches(&type_));
199
200        // Step 6 Add an item whose kind is text, whose type is format, and whose data is the method's second argument.
201        self.item_list
202            .insert(self.next_item_id, Kind::Text { data, type_ });
203        self.next_item_id += 1;
204    }
205
206    pub(crate) fn clear_data(&mut self, format: Option<DOMString>) -> bool {
207        let mut was_modified = false;
208
209        if let Some(format) = format {
210            // Step 4-5
211            let type_ = normalize_mime(format);
212
213            // Step 6 Remove the item in the item list whose kind is text and whose type is format.
214            self.item_list.retain(|_, item| {
215                let matches = item.text_type_matches(&type_);
216
217                if matches {
218                    was_modified = true;
219                }
220                !matches
221            });
222        } else {
223            // Step 3 Remove each item in the item list whose kind is text.
224            self.item_list.retain(|_, item| {
225                let matches = item.is_file();
226
227                if !matches {
228                    was_modified = true;
229                }
230                matches
231            });
232        }
233
234        was_modified
235    }
236
237    pub(crate) fn files(
238        &self,
239        cx: &mut JSContext,
240        global: &GlobalScope,
241        file_list: &mut Vec<DomRoot<File>>,
242    ) {
243        // Step 3 If the data store is in the protected mode return the empty list.
244        if self.mode == Mode::Protected {
245            return;
246        }
247
248        // Step 4 For each item in the drag data store item list whose kind is File, add the item's data to the list L.
249        self.item_list
250            .values()
251            .filter_map(|item| item.as_file(cx, global))
252            .for_each(|file| file_list.push(file));
253    }
254
255    pub(crate) fn list_len(&self) -> usize {
256        self.item_list.len()
257    }
258
259    pub(crate) fn iter_item_list(&self) -> indexmap::map::Values<'_, u16, Kind> {
260        self.item_list.values()
261    }
262
263    pub(crate) fn get_by_index(&self, index: usize) -> Option<(&u16, &Kind)> {
264        self.item_list.get_index(index)
265    }
266
267    pub(crate) fn get_by_id(&self, id: &u16) -> Option<&Kind> {
268        self.item_list.get(id)
269    }
270
271    pub(crate) fn remove(&mut self, index: usize) {
272        self.item_list.shift_remove_index(index);
273    }
274
275    pub(crate) fn clear_list(&mut self) {
276        self.item_list.clear();
277        self.clear_was_called = true;
278    }
279}
280
281fn normalize_mime(mut format: DOMString) -> DOMString {
282    // Convert format to ASCII lowercase.
283    format.make_ascii_lowercase();
284
285    match &*format.str() {
286        // If format equals "text", change it to "text/plain".
287        "text" => DOMString::from("text/plain"),
288        // If format equals "url", change it to "text/uri-list".
289        "url" => DOMString::from("text/uri-list"),
290        s => DOMString::from(s),
291    }
292}
script/drag_data_store.rs

script/
drag_data_store.rs
