f58e1425a7f515d7f64a3232f30ea317787c254c
[WebKit-https.git] / Source / WebKit / UIProcess / API / Cocoa / _WKElementAction.mm
1 /*
2  * Copyright (C) 2014 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 "_WKElementActionInternal.h"
28
29 #if PLATFORM(IOS_FAMILY)
30
31 #import "GestureTypes.h"
32 #import "WKActionSheetAssistant.h"
33 #import "WKContentViewInteraction.h"
34 #import "_WKActivatedElementInfoInternal.h"
35 #import <WebCore/LocalizedStrings.h>
36 #import <wtf/RetainPtr.h>
37 #import <wtf/SoftLinking.h>
38 #import <wtf/WeakObjCPtr.h>
39 #import <wtf/text/WTFString.h>
40
41 #if HAVE(SAFARI_SERVICES_FRAMEWORK)
42 #import <SafariServices/SSReadingList.h>
43 SOFT_LINK_FRAMEWORK(SafariServices);
44 SOFT_LINK_CLASS(SafariServices, SSReadingList);
45 #endif
46
47 typedef void (^WKElementActionHandlerInternal)(WKActionSheetAssistant *, _WKActivatedElementInfo *);
48
49 static UIActionIdentifier const WKElementActionTypeCustomIdentifier = @"WKElementActionTypeCustom";
50 static UIActionIdentifier const WKElementActionTypeOpenIdentifier = @"WKElementActionTypeOpen";
51 static UIActionIdentifier const WKElementActionTypeCopyIdentifier = @"WKElementActionTypeCopy";
52 static UIActionIdentifier const WKElementActionTypeSaveImageIdentifier = @"WKElementActionTypeSaveImage";
53 #if !defined(TARGET_OS_IOS) || TARGET_OS_IOS
54 static UIActionIdentifier const WKElementActionTypeAddToReadingListIdentifier = @"WKElementActionTypeAddToReadingList";
55 static UIActionIdentifier const WKElementActionTypeOpenInDefaultBrowserIdentifier = @"WKElementActionTypeOpenInDefaultBrowser";
56 static UIActionIdentifier const WKElementActionTypeOpenInExternalApplicationIdentifier = @"WKElementActionTypeOpenInExternalApplication";
57 #endif
58 static UIActionIdentifier const WKElementActionTypeShareIdentifier = @"WKElementActionTypeShare";
59 static UIActionIdentifier const WKElementActionTypeOpenInNewTabIdentifier = @"WKElementActionTypeOpenInNewTab";
60 static UIActionIdentifier const WKElementActionTypeOpenInNewWindowIdentifier = @"WKElementActionTypeOpenInNewWindow";
61 static UIActionIdentifier const WKElementActionTypeDownloadIdentifier = @"WKElementActionTypeDownload";
62
63 @implementation _WKElementAction  {
64     RetainPtr<NSString> _title;
65     WKElementActionHandlerInternal _actionHandler;
66     WKElementActionDismissalHandler _dismissalHandler;
67     WeakObjCPtr<WKActionSheetAssistant> _defaultActionSheetAssistant;
68 }
69
70 - (id)_initWithTitle:(NSString *)title actionHandler:(WKElementActionHandlerInternal)handler type:(_WKElementActionType)type assistant:(WKActionSheetAssistant *)assistant
71 {
72     if (!(self = [super init]))
73         return nil;
74
75     _title = adoptNS([title copy]);
76     _type = type;
77     _actionHandler = [handler copy];
78     _defaultActionSheetAssistant = assistant;
79     return self;
80 }
81
82 - (void)dealloc
83 {
84     [_actionHandler release];
85     [_dismissalHandler release];
86
87     [super dealloc];
88 }
89
90 + (instancetype)elementActionWithTitle:(NSString *)title actionHandler:(WKElementActionHandler)handler
91 {
92     return [[[self alloc] _initWithTitle:title actionHandler:^(WKActionSheetAssistant *, _WKActivatedElementInfo *actionInfo) { handler(actionInfo); }
93         type:_WKElementActionTypeCustom assistant:nil] autorelease];
94 }
95
96 #if HAVE(SAFARI_SERVICES_FRAMEWORK)
97 static void addToReadingList(NSURL *targetURL, NSString *title)
98 {
99     if (!title || [title length] == 0)
100         title = [targetURL absoluteString];
101
102     [[getSSReadingListClass() defaultReadingList] addReadingListItemWithURL:targetURL title:title previewText:nil error:nil];
103 }
104 #endif
105
106 + (instancetype)elementActionWithType:(_WKElementActionType)type title:(NSString *)title actionHandler:(WKElementActionHandler)actionHandler
107 {
108     return [_WKElementAction _elementActionWithType:type title:title actionHandler:actionHandler];
109 }
110
111 + (instancetype)_elementActionWithType:(_WKElementActionType)type title:(NSString *)title actionHandler:(WKElementActionHandler)actionHandler
112 {
113     WKElementActionHandlerInternal handler = ^(WKActionSheetAssistant *, _WKActivatedElementInfo *actionInfo) { actionHandler(actionInfo); };
114     return [[[self alloc] _initWithTitle:title actionHandler:handler type:type assistant:nil] autorelease];
115 }
116
117 + (instancetype)_elementActionWithType:(_WKElementActionType)type customTitle:(NSString *)customTitle assistant:(WKActionSheetAssistant *)assistant
118 {
119     NSString *title;
120     WKElementActionHandlerInternal handler;
121     switch (type) {
122     case _WKElementActionTypeCopy:
123         title = WEB_UI_STRING_KEY("Copy", "Copy (ActionSheet)", "Title for Copy Link or Image action button");
124         handler = ^(WKActionSheetAssistant *assistant, _WKActivatedElementInfo *actionInfo) {
125             [assistant.delegate actionSheetAssistant:assistant performAction:WebKit::SheetAction::Copy];
126         };
127         break;
128     case _WKElementActionTypeOpen:
129         title = WEB_UI_STRING("Open", "Title for Open Link action button");
130         handler = ^(WKActionSheetAssistant *assistant, _WKActivatedElementInfo *actionInfo) {
131             [assistant.delegate actionSheetAssistant:assistant openElementAtLocation:actionInfo._interactionLocation];
132         };
133         break;
134     case _WKElementActionTypeSaveImage:
135         title = WEB_UI_STRING("Add to Photos", "Title for Add to Photos action button");
136         handler = ^(WKActionSheetAssistant *assistant, _WKActivatedElementInfo *actionInfo) {
137             [assistant.delegate actionSheetAssistant:assistant performAction:WebKit::SheetAction::SaveImage];
138         };
139         break;
140 #if HAVE(SAFARI_SERVICES_FRAMEWORK)
141     case _WKElementActionTypeAddToReadingList:
142         title = WEB_UI_STRING("Add to Reading List", "Title for Add to Reading List action button");
143         handler = ^(WKActionSheetAssistant *, _WKActivatedElementInfo *actionInfo) {
144             addToReadingList(actionInfo.URL, actionInfo.title);
145         };
146         break;
147 #endif
148     case _WKElementActionTypeShare:
149         title = WEB_UI_STRING("Share…", "Title for Share action button");
150         handler = ^(WKActionSheetAssistant *assistant, _WKActivatedElementInfo *actionInfo) {
151             [assistant.delegate actionSheetAssistant:assistant shareElementWithURL:actionInfo.URL ?: actionInfo.imageURL rect:actionInfo.boundingRect];
152         };
153         break;
154     default:
155         [NSException raise:NSInvalidArgumentException format:@"There is no standard web element action of type %ld.", (long)type];
156         return nil;
157     }
158
159     return [[[self alloc] _initWithTitle:(customTitle ? customTitle : title) actionHandler:handler type:type assistant:assistant] autorelease];
160 }
161
162 + (instancetype)_elementActionWithType:(_WKElementActionType)type assistant:(WKActionSheetAssistant *)assistant
163 {
164     return [self _elementActionWithType:type customTitle:nil assistant:assistant];
165 }
166
167 + (instancetype)elementActionWithType:(_WKElementActionType)type customTitle:(NSString *)customTitle
168 {
169     return [self _elementActionWithType:type customTitle:customTitle assistant:nil];
170 }
171
172 + (instancetype)elementActionWithType:(_WKElementActionType)type
173 {
174     return [self elementActionWithType:type customTitle:nil];
175 }
176
177 - (NSString *)title
178 {
179     return _title.get();
180 }
181
182 - (void)_runActionWithElementInfo:(_WKActivatedElementInfo *)info forActionSheetAssistant:(WKActionSheetAssistant *)assistant
183 {
184     _actionHandler(assistant, info);
185 }
186
187 - (void)runActionWithElementInfo:(_WKActivatedElementInfo *)info
188 {
189     [self _runActionWithElementInfo:info forActionSheetAssistant:_defaultActionSheetAssistant.get().get()];
190 }
191
192 #if USE(UICONTEXTMENU)
193 + (UIImage *)imageForElementActionType:(_WKElementActionType)actionType
194 {
195     switch (actionType) {
196     case _WKElementActionTypeCustom:
197         return nil;
198     case _WKElementActionTypeOpen:
199         return [UIImage systemImageNamed:@"safari"];
200     case _WKElementActionTypeCopy:
201         return [UIImage systemImageNamed:@"doc.on.doc"];
202     case _WKElementActionTypeSaveImage:
203         return [UIImage systemImageNamed:@"square.and.arrow.down"];
204     case _WKElementActionTypeAddToReadingList:
205         return [UIImage systemImageNamed:@"eyeglasses"];
206     case _WKElementActionTypeOpenInDefaultBrowser:
207         return [UIImage systemImageNamed:@"safari"];
208     case _WKElementActionTypeOpenInExternalApplication:
209         return [UIImage systemImageNamed:@"arrow.up.right.square"];
210     case _WKElementActionTypeShare:
211         return [UIImage systemImageNamed:@"square.and.arrow.up"];
212     case _WKElementActionTypeOpenInNewTab:
213         return [UIImage systemImageNamed:@"plus.square.on.square"];
214     case _WKElementActionTypeOpenInNewWindow:
215         return [UIImage systemImageNamed:@"square.grid.2x2"];
216     case _WKElementActionTypeDownload:
217         return [UIImage systemImageNamed:@"arrow.down.circle"];
218     }
219 }
220
221 static UIActionIdentifier elementActionTypeToUIActionIdentifier(_WKElementActionType actionType)
222 {
223     switch (actionType) {
224     case _WKElementActionTypeCustom:
225         return WKElementActionTypeCustomIdentifier;
226     case _WKElementActionTypeOpen:
227         return WKElementActionTypeOpenIdentifier;
228     case _WKElementActionTypeCopy:
229         return WKElementActionTypeCopyIdentifier;
230     case _WKElementActionTypeSaveImage:
231         return WKElementActionTypeSaveImageIdentifier;
232     case _WKElementActionTypeAddToReadingList:
233         return WKElementActionTypeAddToReadingListIdentifier;
234     case _WKElementActionTypeOpenInDefaultBrowser:
235         return WKElementActionTypeOpenInDefaultBrowserIdentifier;
236     case _WKElementActionTypeOpenInExternalApplication:
237         return WKElementActionTypeOpenInExternalApplicationIdentifier;
238     case _WKElementActionTypeShare:
239         return WKElementActionTypeShareIdentifier;
240     case _WKElementActionTypeOpenInNewTab:
241         return WKElementActionTypeOpenInNewTabIdentifier;
242     case _WKElementActionTypeOpenInNewWindow:
243         return WKElementActionTypeOpenInNewWindowIdentifier;
244     case _WKElementActionTypeDownload:
245         return WKElementActionTypeDownloadIdentifier;
246     }
247 }
248
249 static _WKElementActionType uiActionIdentifierToElementActionType(UIActionIdentifier identifier)
250 {
251     if ([identifier isEqualToString:WKElementActionTypeCustomIdentifier])
252         return _WKElementActionTypeCustom;
253     if ([identifier isEqualToString:WKElementActionTypeOpenIdentifier])
254         return _WKElementActionTypeOpen;
255     if ([identifier isEqualToString:WKElementActionTypeCopyIdentifier])
256         return _WKElementActionTypeCopy;
257     if ([identifier isEqualToString:WKElementActionTypeSaveImageIdentifier])
258         return _WKElementActionTypeSaveImage;
259     if ([identifier isEqualToString:WKElementActionTypeAddToReadingListIdentifier])
260         return _WKElementActionTypeAddToReadingList;
261     if ([identifier isEqualToString:WKElementActionTypeOpenInDefaultBrowserIdentifier])
262         return _WKElementActionTypeOpenInDefaultBrowser;
263     if ([identifier isEqualToString:WKElementActionTypeOpenInExternalApplicationIdentifier])
264         return _WKElementActionTypeOpenInExternalApplication;
265     if ([identifier isEqualToString:WKElementActionTypeShareIdentifier])
266         return _WKElementActionTypeShare;
267     if ([identifier isEqualToString:WKElementActionTypeOpenInNewTabIdentifier])
268         return _WKElementActionTypeOpenInNewTab;
269     if ([identifier isEqualToString:WKElementActionTypeOpenInNewWindowIdentifier])
270         return _WKElementActionTypeOpenInNewWindow;
271     if ([identifier isEqualToString:WKElementActionTypeDownloadIdentifier])
272         return _WKElementActionTypeDownload;
273
274     return _WKElementActionTypeCustom;
275 }
276
277 + (_WKElementActionType)elementActionTypeForUIActionIdentifier:(UIActionIdentifier)identifier
278 {
279     return uiActionIdentifierToElementActionType(identifier);
280 }
281
282 - (UIAction *)uiActionForElementInfo:(_WKActivatedElementInfo *)elementInfo
283 {
284     UIImage *image = [_WKElementAction imageForElementActionType:self.type];
285     UIActionIdentifier identifier = elementActionTypeToUIActionIdentifier(self.type);
286
287     return [UIAction actionWithTitle:self.title image:image identifier:identifier handler:[weakSelf = WeakObjCPtr<_WKElementAction>(self), weakElementInfo = WeakObjCPtr<_WKActivatedElementInfo>(elementInfo)] (UIAction *) {
288         auto strongSelf = weakSelf.get();
289         if (!strongSelf)
290             return;
291         auto strongElementInfo = weakElementInfo.get();
292         if (!strongElementInfo)
293             return;
294         [strongSelf runActionWithElementInfo:strongElementInfo.get()];
295     }];
296 }
297 #else
298 + (UIImage *)imageForElementActionType:(_WKElementActionType)actionType
299 {
300     return nil;
301 }
302
303 + (_WKElementActionType)elementActionTypeForUIActionIdentifier:(UIActionIdentifier)identifier
304 {
305     return _WKElementActionTypeCustom;
306 }
307
308 - (UIAction *)uiActionForElementInfo:(_WKActivatedElementInfo *)elementInfo
309 {
310     return nil;
311 }
312 #endif // USE(UICONTEXTMENU)
313
314 @end
315
316 #endif // PLATFORM(IOS_FAMILY)