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