ac20be2d4e0b1b84fb8e37efc77dd3fe6575cee4
[WebKit-https.git] / Source / WebKit / mac / DefaultDelegates / WebDefaultContextMenuDelegate.mm
1 /*
2  * Copyright (C) 2005 Apple Computer, 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #import "WebDefaultContextMenuDelegate.h"
30
31 #import "WebDOMOperations.h"
32 #import "WebDataSourcePrivate.h"
33 #import "WebDefaultUIDelegate.h"
34 #import "WebFrameInternal.h"
35 #import "WebFrameView.h"
36 #import "WebHTMLViewPrivate.h"
37 #import "WebLocalizableStringsInternal.h"
38 #import "WebNSPasteboardExtras.h"
39 #import "WebNSURLRequestExtras.h"
40 #import "WebPolicyDelegate.h"
41 #import "WebUIDelegate.h"
42 #import "WebUIDelegatePrivate.h"
43 #import "WebViewInternal.h"
44 #import <Foundation/NSURLConnection.h>
45 #import <Foundation/NSURLRequest.h>
46 #import <WebCore/Editor.h>
47 #import <WebCore/Frame.h>
48 #import <WebCore/FrameLoader.h>
49 #import <WebKit/DOM.h>
50 #import <WebKit/DOMPrivate.h>
51 #import <WebKitSystemInterface.h>
52 #import <wtf/Assertions.h>
53
54 @implementation WebDefaultUIDelegate (WebContextMenu)
55
56 - (NSMenuItem *)menuItemWithTag:(int)tag target:(id)target representedObject:(id)representedObject
57 {
58     NSMenuItem *menuItem = [[[NSMenuItem alloc] init] autorelease];
59     [menuItem setTag:tag];
60     [menuItem setTarget:target]; // can be nil
61     [menuItem setRepresentedObject:representedObject];
62     
63     NSString *title = nil;
64     SEL action = NULL;
65     
66     switch(tag) {
67         case WebMenuItemTagCopy:
68             title = UI_STRING_INTERNAL("Copy", "Copy context menu item");
69             action = @selector(copy:);
70             break;
71         case WebMenuItemTagGoBack:
72             title = UI_STRING_INTERNAL("Back", "Back context menu item");
73             action = @selector(goBack:);
74             break;
75         case WebMenuItemTagGoForward:
76             title = UI_STRING_INTERNAL("Forward", "Forward context menu item");
77             action = @selector(goForward:);
78             break;
79         case WebMenuItemTagStop:
80             title = UI_STRING_INTERNAL("Stop", "Stop context menu item");
81             action = @selector(stopLoading:);
82             break;
83         case WebMenuItemTagReload:
84             title = UI_STRING_INTERNAL("Reload", "Reload context menu item");
85             action = @selector(reload:);
86             break;
87         case WebMenuItemTagSearchInSpotlight:
88             title = UI_STRING_INTERNAL("Search in Spotlight", "Search in Spotlight context menu item");
89             action = @selector(_searchWithSpotlightFromMenu:);
90             break;
91         case WebMenuItemTagSearchWeb: {
92             RetainPtr<CFStringRef> searchProviderName = adoptCF(WKCopyDefaultSearchProviderDisplayName());
93             title = [NSString stringWithFormat:UI_STRING_INTERNAL("Search with %@", "Search with search provider context menu item with provider name inserted"), searchProviderName.get()];
94             action = @selector(_searchWithGoogleFromMenu:);
95             break;
96         }
97         case WebMenuItemTagLookUpInDictionary:
98             title = UI_STRING_INTERNAL("Look Up in Dictionary", "Look Up in Dictionary context menu item");
99             action = @selector(_lookUpInDictionaryFromMenu:);
100             break;
101         case WebMenuItemTagOpenFrameInNewWindow:
102             title = UI_STRING_INTERNAL("Open Frame in New Window", "Open Frame in New Window context menu item");
103             action = @selector(_openFrameInNewWindowFromMenu:);
104             break;
105         default:
106             ASSERT_NOT_REACHED();
107             return nil;
108     }
109
110     if (title)
111         [menuItem setTitle:title];
112
113     [menuItem setAction:action];
114     
115     return menuItem;
116 }
117
118 - (void)appendDefaultItems:(NSArray *)defaultItems toArray:(NSMutableArray *)menuItems
119 {
120     ASSERT_ARG(menuItems, menuItems != nil);
121     if ([defaultItems count] > 0) {
122         ASSERT(![[menuItems lastObject] isSeparatorItem]);
123         if (![[defaultItems objectAtIndex:0] isSeparatorItem]) {
124             [menuItems addObject:[NSMenuItem separatorItem]];
125             
126             NSEnumerator *e = [defaultItems objectEnumerator];
127             NSMenuItem *item;
128             while ((item = [e nextObject]) != nil) {
129                 [menuItems addObject:item];
130             }
131         }
132     }
133 }
134
135 - (NSArray *)webView:(WebView *)wv contextMenuItemsForElement:(NSDictionary *)element  defaultMenuItems:(NSArray *)defaultMenuItems
136 {
137     // The defaultMenuItems here are ones supplied by the WebDocumentView protocol implementation. WebPDFView is
138     // one case that has non-nil default items here.
139     NSMutableArray *menuItems = [NSMutableArray array];
140
141     WebFrame *webFrame = [element objectForKey:WebElementFrameKey];
142     
143     if ([[element objectForKey:WebElementIsSelectedKey] boolValue]) {
144         // The Spotlight and Google items are implemented in WebView, and require that the
145         // current document view conforms to WebDocumentText
146         ASSERT([[[webFrame frameView] documentView] conformsToProtocol:@protocol(WebDocumentText)]);
147
148         // FIXME 4184640: The Look Up in Dictionary item is only implemented in WebHTMLView, and so is present but
149         // dimmed for other cases where WebElementIsSelectedKey is present. It would probably 
150         // be better not to include it in the menu if the documentView isn't a WebHTMLView, but that could break 
151         // existing clients that have code that relies on it being present (unlikely for clients outside of Apple, 
152         // but Safari has such code).
153
154         NSMenuItem *lookupMenuItem = [self menuItemWithTag:WebMenuItemTagLookUpInDictionary target:nil representedObject:element];
155         NSString *selectedString = [(id <WebDocumentText>)[[webFrame frameView] documentView] selectedString];
156         [lookupMenuItem setTitle:[NSString stringWithFormat:UI_STRING_INTERNAL("Look Up “%@”", "Look Up context menu item with selected word"), selectedString]];
157         [menuItems addObject:lookupMenuItem];
158
159         [menuItems addObject:[self menuItemWithTag:WebMenuItemTagSearchWeb target:nil representedObject:element]];
160
161         [menuItems addObject:[NSMenuItem separatorItem]];
162         [menuItems addObject:[self menuItemWithTag:WebMenuItemTagCopy target:nil representedObject:element]];
163     } else {
164         WebView *wv = [webFrame webView];
165         if ([wv canGoBack]) {
166             [menuItems addObject:[self menuItemWithTag:WebMenuItemTagGoBack target:wv representedObject:element]];
167         }
168         if ([wv canGoForward]) {
169             [menuItems addObject:[self menuItemWithTag:WebMenuItemTagGoForward target:wv representedObject:element]];
170         }
171         if ([wv isLoading]) {
172             [menuItems addObject:[self menuItemWithTag:WebMenuItemTagStop target:wv representedObject:element]];
173         } else {
174             [menuItems addObject:[self menuItemWithTag:WebMenuItemTagReload target:wv representedObject:element]];
175         }
176
177         if (webFrame != [wv mainFrame]) {
178             [menuItems addObject:[self menuItemWithTag:WebMenuItemTagOpenFrameInNewWindow target:wv representedObject:element]];
179         }
180     }
181     
182     // Add the default items at the end, if any, after a separator
183     [self appendDefaultItems:defaultMenuItems toArray:menuItems];
184
185     return menuItems;
186 }
187
188 @end