Move the legacy WebKit API into WebKitLegacy.framework and move it inside WebKit...
[WebKit-https.git] / Source / WebKit / mac / Panels / WebAuthenticationPanel.m
1 /*
2  * Copyright (C) 2005 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  *
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 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 #if !PLATFORM(IOS)
30
31 #import <WebKitLegacy/WebAuthenticationPanel.h>
32
33 #import "WebLocalizableStringsInternal.h"
34 #import <Foundation/NSURLAuthenticationChallenge.h>
35 #import <Foundation/NSURLProtectionSpace.h>
36 #import <Foundation/NSURLCredential.h>
37 #import <WebKitLegacy/WebKitNSStringExtras.h>
38 #import <WebKitLegacy/WebNSURLExtras.h>
39 #import <wtf/Assertions.h>
40
41 #import <WebKitLegacy/WebNSControlExtras.h>
42
43 #define WebAuthenticationPanelNibName @"WebAuthenticationPanel"
44
45 @implementation WebAuthenticationPanel
46
47 -(id)initWithCallback:(id)cb selector:(SEL)sel
48 {
49     self = [self init];
50     if (self != nil) {
51         callback = [cb retain];
52         selector = sel;
53     }
54     return self;
55 }
56
57
58 - (void)dealloc
59 {
60     [panel release];
61
62     [callback release];
63     
64     [super dealloc];
65 }
66
67 // IB actions
68
69 - (IBAction)cancel:(id)sender
70 {
71     // This is required because the body of this method is going to
72     // remove all of the panel's remaining refs, which can cause a
73     // crash later when finishing button hit tracking.  So we make
74     // sure it lives on a bit longer.
75     [[panel retain] autorelease];
76     
77     // This is required as a workaround for AppKit issue 4118422
78     [[self retain] autorelease];
79
80     [panel close];
81     if (usingSheet) {
82 #if __MAC_OS_X_VERSION_MIN_REQUIRED >= 1090
83         [panel.sheetParent endSheet:panel returnCode:NSModalResponseCancel];
84 #else
85         [[NSApplication sharedApplication] endSheet:panel returnCode:1];
86 #endif
87     } else {
88         [[NSApplication sharedApplication] stopModalWithCode:1];
89     }
90 }
91
92 - (IBAction)logIn:(id)sender
93 {
94     // This is required because the body of this method is going to
95     // remove all of the panel's remaining refs, which can cause a
96     // crash later when finishing button hit tracking.  So we make
97     // sure it lives on a bit longer.
98     [[panel retain] autorelease];
99
100     [panel close];
101     if (usingSheet) {
102 #if __MAC_OS_X_VERSION_MIN_REQUIRED >= 1090
103         [panel.sheetParent endSheet:panel returnCode:NSModalResponseOK];
104 #else
105         [[NSApplication sharedApplication] endSheet:panel returnCode:0];
106 #endif
107     } else {
108         [[NSApplication sharedApplication] stopModalWithCode:0];
109     }
110 }
111
112 - (BOOL)loadNib
113 {
114     if (!nibLoaded) {
115 #pragma clang diagnostic push
116 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
117         if ([NSBundle loadNibNamed:WebAuthenticationPanelNibName owner:self]) {
118 #pragma clang diagnostic pop
119             nibLoaded = YES;
120             [imageView setImage:[NSImage imageNamed:@"NSApplicationIcon"]];
121         } else {
122             LOG_ERROR("couldn't load nib named '%@'", WebAuthenticationPanelNibName);
123             return FALSE;
124         }
125     }
126     return TRUE;
127 }
128
129 // Methods related to displaying the panel
130
131 -(void)setUpForChallenge:(NSURLAuthenticationChallenge *)chall
132 {
133     [self loadNib];
134
135     NSURLProtectionSpace *space = [chall protectionSpace];
136
137     NSString *host;
138     if ([space port] == 0) {
139         host = [[space host] _web_decodeHostName];
140     } else {
141         host = [NSString stringWithFormat:@"%@:%ld", [[space host] _web_decodeHostName], (long)[space port]];
142     }
143
144     NSString *realm = [space realm];
145     if (!realm)
146         realm = @"";
147     NSString *message;
148
149     // Consider the realm name to be "simple" if it does not contain any whitespace or newline characters.
150     // If the realm name is determined to be complex, we will use a slightly different sheet layout, designed
151     // to keep a malicious realm name from spoofing the wording in the sheet text.
152     BOOL realmNameIsSimple = [realm rangeOfCharacterFromSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]].location == NSNotFound;    
153     
154     if ([chall previousFailureCount] == 0) {
155         if ([space isProxy]) {
156             message = [NSString stringWithFormat:UI_STRING_INTERNAL("To view this page, you must log in to the %@ proxy server %@.",
157                                                            "prompt string in authentication panel"),
158                 [space proxyType], host];
159         } else {
160             if (realmNameIsSimple)
161                 message = [NSString stringWithFormat:UI_STRING_INTERNAL("To view this page, you must log in to area “%@” on %@.",
162                                                                "prompt string in authentication panel"), realm, host];
163             else
164                 message = [NSString stringWithFormat:UI_STRING_INTERNAL("To view this page, you must log in to this area on %@:",
165                                                                "prompt string in authentication panel"), host];
166         }
167     } else {
168         if ([space isProxy]) {
169             message = [NSString stringWithFormat:UI_STRING_INTERNAL("The user name or password you entered for the %@ proxy server %@ was incorrect. Make sure you’re entering them correctly, and then try again.",
170                                                            "prompt string in authentication panel"),
171                 [space proxyType], host];
172         } else {
173             if (realmNameIsSimple)
174                 message = [NSString stringWithFormat:UI_STRING_INTERNAL("The user name or password you entered for area “%@” on %@ was incorrect. Make sure you’re entering them correctly, and then try again.",
175                                                                "prompt string in authentication panel"), realm, host];
176             else
177                 message = [NSString stringWithFormat:UI_STRING_INTERNAL("The user name or password you entered for this area on %@ was incorrect. Make sure you’re entering them correctly, and then try again.",
178                                                                "prompt string in authentication panel"), host];
179         }
180     }
181     
182     if (![space isProxy] && !realmNameIsSimple) {
183         [separateRealmLabel setHidden:NO];
184         [separateRealmLabel setStringValue:realm];
185         [separateRealmLabel setAutoresizingMask:NSViewMinYMargin];
186         [separateRealmLabel sizeToFitAndAdjustWindowHeight];
187         [separateRealmLabel setAutoresizingMask:NSViewMaxYMargin];
188     } else {
189         // In the proxy or "simple" realm name case, we need to hide the 'separateRealmLabel'
190         // and move the rest of the contents up appropriately to fill the space.
191         NSRect mainLabelFrame = [mainLabel frame];
192         NSRect realmFrame = [separateRealmLabel frame];
193         NSRect smallLabelFrame = [smallLabel frame];
194
195         // Find the distance between the 'smallLabel' and the label above it, initially the 'separateRealmLabel'.
196         // Then, find the current distance between 'smallLabel' and 'mainLabel'.  The difference between
197         // these two is how much shorter the panel needs to be after hiding the 'separateRealmLabel'.
198         CGFloat smallLabelMargin = NSMinY(realmFrame) - NSMaxY(smallLabelFrame);
199         CGFloat smallLabelToMainLabel = NSMinY(mainLabelFrame) - NSMaxY(smallLabelFrame);
200         CGFloat deltaMargin = smallLabelToMainLabel - smallLabelMargin;
201         
202         [separateRealmLabel setHidden:YES];
203         NSRect windowFrame = [panel frame];
204         windowFrame.size.height -= deltaMargin;
205         [panel setFrame:windowFrame display:NO];
206     }
207     
208     [mainLabel setStringValue:message];
209     [mainLabel sizeToFitAndAdjustWindowHeight];
210
211     if ([space receivesCredentialSecurely] || [[space protocol] _webkit_isCaseInsensitiveEqualToString:@"https"]) {
212         [smallLabel setStringValue:
213             UI_STRING_INTERNAL("Your login information will be sent securely.",
214                 "message in authentication panel")];
215     } else {
216         // Use this scary-sounding phrase only when using basic auth with non-https servers. In this case the password
217         // could be sniffed by intercepting the network traffic.
218         [smallLabel setStringValue:
219             UI_STRING_INTERNAL("Your password will be sent unencrypted.",
220                 "message in authentication panel")];
221     }
222
223     if ([[chall proposedCredential] user] != nil) {
224         [username setStringValue:[[chall proposedCredential] user]];
225         [panel setInitialFirstResponder:password];
226     } else {
227         [username setStringValue:@""];
228         [password setStringValue:@""];
229         [panel setInitialFirstResponder:username];
230     }
231 }
232
233 - (void)runAsModalDialogWithChallenge:(NSURLAuthenticationChallenge *)chall
234 {
235     [self setUpForChallenge:chall];
236
237     usingSheet = FALSE;
238     [chall retain];
239     NSURLCredential *credential = nil;
240
241     if ([[NSApplication sharedApplication] runModalForWindow:panel] == 0) {
242         credential = [[NSURLCredential alloc] initWithUser:[username stringValue] password:[password stringValue] persistence:([remember state] == NSOnState) ? NSURLCredentialPersistencePermanent : NSURLCredentialPersistenceForSession];
243     }
244
245     [callback performSelector:selector withObject:chall withObject:credential];
246     [credential release];
247     [chall release];
248 }
249
250 - (void)runAsSheetOnWindow:(NSWindow *)window withChallenge:(NSURLAuthenticationChallenge *)chall
251 {
252     ASSERT(!usingSheet);
253
254     [self setUpForChallenge:chall];
255
256     usingSheet = TRUE;
257     challenge = [chall retain];
258
259 #if __MAC_OS_X_VERSION_MIN_REQUIRED >= 1090
260     [window beginSheet:panel completionHandler:^(NSModalResponse modalResponse) {
261         int returnCode = (modalResponse == NSModalResponseCancel) ? 1 : 0;
262         [self sheetDidEnd:panel returnCode:returnCode contextInfo:NULL];
263     }];
264 #else
265     [[NSApplication sharedApplication] beginSheet:panel modalForWindow:window modalDelegate:self didEndSelector:@selector(sheetDidEnd:returnCode:contextInfo:) contextInfo:NULL];
266 #endif
267 }
268
269 - (void)sheetDidEnd:(NSWindow *)sheet returnCode:(int)returnCode contextInfo:(void  *)contextInfo
270 {
271     NSURLCredential *credential = nil;
272     NSURLAuthenticationChallenge *chall;
273
274     ASSERT(usingSheet);
275     ASSERT(challenge != nil);
276
277     if (returnCode == 0) {
278         credential = [[NSURLCredential alloc] initWithUser:[username stringValue] password:[password stringValue] persistence:([remember state] == NSOnState) ? NSURLCredentialPersistencePermanent : NSURLCredentialPersistenceForSession];
279     }
280
281     // We take this tricky approach to nilling out and releasing the challenge
282     // because the callback below might remove our last ref.
283     chall = challenge;
284     challenge = nil;
285     [callback performSelector:selector withObject:chall withObject:credential];
286     [credential release];
287     [chall release];
288 }
289
290 @end
291
292 @implementation WebNonBlockingPanel
293
294 - (BOOL)_blocksActionWhenModal:(SEL)theAction
295 {
296     // This override of a private AppKit method allows the user to quit when a login dialog
297     // is onscreen, which is nice in general but in particular prevents pathological cases
298     // like 3744583 from requiring a Force Quit.
299     //
300     // It would be nice to allow closing the individual window as well as quitting the app when
301     // a login sheet is up, but this _blocksActionWhenModal: mechanism doesn't support that.
302     // This override matches those in NSOpenPanel and NSToolbarConfigPanel.
303     if (theAction == @selector(terminate:)) {
304         return NO;
305     }
306     return YES;
307 }
308
309 @end
310
311 #endif // !PLATFORM(IOS)