f1e0c3a6356f03b26809c6372e88ff455ac15997
[WebKit-https.git] / Source / WebKit / Shared / ios / InteractionInformationAtPosition.mm
1 /*
2  * Copyright (C) 2014-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 #import "config.h"
27 #import "InteractionInformationAtPosition.h"
28
29 #import "ArgumentCodersCF.h"
30 #import "WebCoreArgumentCoders.h"
31 #import <pal/spi/cocoa/DataDetectorsCoreSPI.h>
32 #import <pal/spi/cocoa/NSKeyedArchiverSPI.h>
33 #import <wtf/SoftLinking.h>
34
35 SOFT_LINK_PRIVATE_FRAMEWORK(DataDetectorsCore)
36 SOFT_LINK_CLASS(DataDetectorsCore, DDScannerResult)
37
38 namespace WebKit {
39
40 #if PLATFORM(IOS_FAMILY)
41
42 void InteractionInformationAtPosition::encode(IPC::Encoder& encoder) const
43 {
44     encoder << request;
45
46     encoder << nodeAtPositionIsAssistedNode;
47 #if ENABLE(DATA_INTERACTION)
48     encoder << hasSelectionAtPosition;
49 #endif
50     encoder << isSelectable;
51     encoder << isNearMarkedText;
52     encoder << touchCalloutEnabled;
53     encoder << isLink;
54     encoder << isImage;
55     encoder << isAttachment;
56     encoder << isAnimatedImage;
57     encoder << isElement;
58     encoder << adjustedPointForNodeRespondingToClickEvents;
59     encoder << url;
60     encoder << imageURL;
61     encoder << title;
62     encoder << idAttribute;
63     encoder << bounds;
64 #if PLATFORM(IOSMAC)
65     encoder << caretRect;
66 #endif
67     encoder << textBefore;
68     encoder << textAfter;
69     encoder << linkIndicator;
70
71     ShareableBitmap::Handle handle;
72     if (image)
73         image->createHandle(handle, SharedMemory::Protection::ReadOnly);
74     encoder << handle;
75 #if ENABLE(DATA_DETECTION)
76     encoder << isDataDetectorLink;
77     if (isDataDetectorLink) {
78         encoder << dataDetectorIdentifier;
79         auto archiver = secureArchiver();
80         [archiver encodeObject:dataDetectorResults.get() forKey:@"dataDetectorResults"];
81
82         IPC::encode(encoder, reinterpret_cast<CFDataRef>(archiver.get().encodedData));
83     }
84 #endif
85 #if ENABLE(DATALIST_ELEMENT)
86     encoder << preventTextInteraction;
87 #endif
88 }
89
90 bool InteractionInformationAtPosition::decode(IPC::Decoder& decoder, InteractionInformationAtPosition& result)
91 {
92     if (!decoder.decode(result.request))
93         return false;
94
95     if (!decoder.decode(result.nodeAtPositionIsAssistedNode))
96         return false;
97
98 #if ENABLE(DATA_INTERACTION)
99     if (!decoder.decode(result.hasSelectionAtPosition))
100         return false;
101 #endif
102
103     if (!decoder.decode(result.isSelectable))
104         return false;
105
106     if (!decoder.decode(result.isNearMarkedText))
107         return false;
108
109     if (!decoder.decode(result.touchCalloutEnabled))
110         return false;
111
112     if (!decoder.decode(result.isLink))
113         return false;
114
115     if (!decoder.decode(result.isImage))
116         return false;
117
118     if (!decoder.decode(result.isAttachment))
119         return false;
120     
121     if (!decoder.decode(result.isAnimatedImage))
122         return false;
123     
124     if (!decoder.decode(result.isElement))
125         return false;
126
127     if (!decoder.decode(result.adjustedPointForNodeRespondingToClickEvents))
128         return false;
129
130     if (!decoder.decode(result.url))
131         return false;
132
133     if (!decoder.decode(result.imageURL))
134         return false;
135
136     if (!decoder.decode(result.title))
137         return false;
138
139     if (!decoder.decode(result.idAttribute))
140         return false;
141     
142     if (!decoder.decode(result.bounds))
143         return false;
144     
145 #if PLATFORM(IOSMAC)
146     if (!decoder.decode(result.caretRect))
147         return false;
148 #endif
149
150     if (!decoder.decode(result.textBefore))
151         return false;
152     
153     if (!decoder.decode(result.textAfter))
154         return false;
155     
156     std::optional<WebCore::TextIndicatorData> linkIndicator;
157     decoder >> linkIndicator;
158     if (!linkIndicator)
159         return false;
160     result.linkIndicator = WTFMove(*linkIndicator);
161
162     ShareableBitmap::Handle handle;
163     if (!decoder.decode(handle))
164         return false;
165
166     if (!handle.isNull())
167         result.image = ShareableBitmap::create(handle, SharedMemory::Protection::ReadOnly);
168
169 #if ENABLE(DATA_DETECTION)
170     if (!decoder.decode(result.isDataDetectorLink))
171         return false;
172     
173     if (result.isDataDetectorLink) {
174         if (!decoder.decode(result.dataDetectorIdentifier))
175             return false;
176         RetainPtr<CFDataRef> data;
177         if (!IPC::decode(decoder, data))
178             return false;
179         
180         auto unarchiver = secureUnarchiverFromData((NSData *)data.get());
181         @try {
182             result.dataDetectorResults = [unarchiver decodeObjectOfClasses:[NSSet setWithArray:@[ [NSArray class], getDDScannerResultClass()] ] forKey:@"dataDetectorResults"];
183         } @catch (NSException *exception) {
184             LOG_ERROR("Failed to decode NSArray of DDScanResult: %@", exception);
185             return false;
186         }
187         
188         [unarchiver finishDecoding];
189     }
190 #endif
191
192 #if ENABLE(DATALIST_ELEMENT)
193     if (!decoder.decode(result.preventTextInteraction))
194         return false;
195 #endif
196
197     return true;
198 }
199
200 void InteractionInformationAtPosition::mergeCompatibleOptionalInformation(const InteractionInformationAtPosition& oldInformation)
201 {
202     if (oldInformation.request.point != request.point)
203         return;
204
205     if (oldInformation.request.includeSnapshot && !request.includeSnapshot)
206         image = oldInformation.image;
207
208     if (oldInformation.request.includeLinkIndicator && !request.includeLinkIndicator)
209         linkIndicator = oldInformation.linkIndicator;
210 }
211
212 #endif // PLATFORM(IOS_FAMILY)
213
214 }