Shuffle some code around in preparation for a change to how poseAsWebKitApp works.
[WebKit-https.git] / WebKitTools / WebKitLauncher / WebKitNightlyEnabler.m
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009 Apple Inc.  All rights reserved.
3  * Copyright (C) 2006 Graham Dennis.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #import <Cocoa/Cocoa.h>
31 #import "WebKitNightlyEnablerSparkle.h"
32
33 static void enableWebKitNightlyBehaviour() __attribute__ ((constructor));
34
35 static NSString *WKNERunState = @"WKNERunState";
36 static NSString *WKNEShouldMonitorShutdowns = @"WKNEShouldMonitorShutdowns";
37
38 typedef enum {
39     RunStateShutDown,
40     RunStateInitializing,
41     RunStateRunning
42 } WKNERunStates;
43
44 static char *webKitAppPath;
45 static bool extensionBundlesWereLoaded = NO;
46 static NSSet *extensionPaths = nil;
47
48 static int32_t systemVersion()
49 {
50     static SInt32 version = 0;
51     if (!version)
52         Gestalt(gestaltSystemVersion, &version);
53
54     return version;
55 }
56
57
58 static void myBundleDidLoad(CFNotificationCenterRef center, void *observer, CFStringRef name, const void *object, CFDictionaryRef userInfo)
59 {
60     NSBundle *bundle = (NSBundle *)object;
61     NSString *bundlePath = [[bundle bundlePath] stringByAbbreviatingWithTildeInPath];
62     NSString *bundleFileName = [bundlePath lastPathComponent];
63
64     // Explicitly ignore SIMBL.bundle, as its only purpose is to load extensions
65     // on a per-application basis.  It's presence indicates a user has application
66     // extensions, but not that any will be loaded into Safari
67     if ([bundleFileName isEqualToString:@"SIMBL.bundle"])
68         return;
69
70     // If the bundle lives inside a known extension path, flag it as an extension
71     NSEnumerator *e = [extensionPaths objectEnumerator];
72     NSString *path = nil;
73     while ((path = [e nextObject])) {
74         if ([bundlePath length] < [path length])
75             continue;
76
77         if ([[bundlePath substringToIndex:[path length]] isEqualToString:path]) {
78             NSLog(@"Extension detected: %@", bundlePath);
79             extensionBundlesWereLoaded = YES;
80             break;
81         }
82     }
83 }
84
85 static void myApplicationWillFinishLaunching(CFNotificationCenterRef center, void *observer, CFStringRef name, const void *object, CFDictionaryRef userInfo)
86 {
87     CFNotificationCenterRemoveObserver(CFNotificationCenterGetLocalCenter(), &myApplicationWillFinishLaunching, NULL, NULL);
88     CFNotificationCenterRemoveObserver(CFNotificationCenterGetLocalCenter(), &myBundleDidLoad, NULL, NULL);
89     [extensionPaths release];
90     extensionPaths = nil;
91
92     NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
93     [userDefaults setInteger:RunStateRunning forKey:WKNERunState];
94     [userDefaults synchronize];
95
96     if (extensionBundlesWereLoaded)
97         NSRunInformationalAlertPanel(@"Safari extensions detected",
98                                      @"Safari extensions were detected on your system.  Extensions are incompatible with nightly builds of WebKit, and may cause crashes or incorrect behavior.  Please disable them if you experience such behavior.", @"Continue",
99                                      nil, nil);
100
101     initializeSparkle();
102 }
103
104 static void myApplicationWillTerminate(CFNotificationCenterRef center, void *observer, CFStringRef name, const void *object, CFDictionaryRef userInfo)
105 {
106     NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
107     [userDefaults setInteger:RunStateShutDown forKey:WKNERunState];
108     [userDefaults synchronize];
109 }
110
111 NSBundle *webKitLauncherBundle()
112 {
113     NSString *executablePath = [NSString stringWithUTF8String:webKitAppPath];
114     NSRange appLocation = [executablePath rangeOfString:@".app/" options:NSBackwardsSearch];
115     NSString *appPath = [executablePath substringToIndex:appLocation.location + appLocation.length];
116     return [NSBundle bundleWithPath:appPath];
117 }
118
119 extern char **_CFGetProcessPath() __attribute__((weak));
120
121 static void poseAsWebKitApp()
122 {
123     webKitAppPath = strdup(getenv("WebKitAppPath"));
124     if (!webKitAppPath || !_CFGetProcessPath)
125         return;
126
127     // Set up the main bundle early so it points at Safari.app
128     CFBundleGetMainBundle();
129
130     // Fiddle with CoreFoundation to have it pick up the executable path as being within WebKit.app
131     char **processPath = _CFGetProcessPath();
132     *processPath = NULL;
133     setenv("CFProcessPath", webKitAppPath, 1);
134     _CFGetProcessPath();
135
136     // Clean up
137     unsetenv("CFProcessPath");
138     unsetenv("WebKitAppPath");
139 }
140
141 static BOOL insideSafari4OnTigerTrampoline()
142 {
143     // If we're not on Tiger then we can't be in the trampoline state.
144     if ((systemVersion() & 0xFFF0) != 0x1040)
145         return NO;
146
147     // If we're running Safari < 4.0 then we can't be in the trampoline state.
148     CFBundleRef safariBundle = CFBundleGetMainBundle();
149     CFStringRef safariVersion = CFBundleGetValueForInfoDictionaryKey(safariBundle, CFSTR("CFBundleShortVersionString"));
150     if ([(NSString *)safariVersion intValue] < 4)
151         return NO;
152
153     const char* frameworkPath = getenv("DYLD_FRAMEWORK_PATH");
154     if (!frameworkPath)
155         frameworkPath = "";
156
157     // If the framework search path is empty or otherwise does not contain the Safari
158     // framework's Frameworks directory then we are in the trampoline state.
159     const char safariFrameworkSearchPath[] = "/System/Library/PrivateFrameworks/Safari.framework/Frameworks";
160     return strstr(frameworkPath, safariFrameworkSearchPath) == 0;
161 }
162
163 static void enableWebKitNightlyBehaviour()
164 {
165     // If we're inside Safari in its trampoline state, it will very shortly relaunch itself.
166     // We bail out here so that we'll be called again in the freshly-launched Safari process.
167     if (insideSafari4OnTigerTrampoline())
168         return;
169
170     unsetenv("DYLD_INSERT_LIBRARIES");
171     poseAsWebKitApp();
172
173     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
174     extensionPaths = [[NSSet alloc] initWithObjects:@"~/Library/InputManagers/", @"/Library/InputManagers/",
175                                                     @"~/Library/Application Support/SIMBL/Plugins/", @"/Library/Application Support/SIMBL/Plugins/",
176                                                     @"~/Library/Application Enhancers/", @"/Library/Application Enhancers/",
177                                                     nil];
178
179     // As of 2008-11 attempting to load Saft would cause a crash on launch, so prevent it from being loaded.
180     NSArray *disabledInputManagers = [NSArray arrayWithObjects:@"Saft", nil];
181
182     NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
183     NSDictionary *defaultPrefs = [NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithBool:RunStateShutDown], WKNERunState,
184                                                                             [NSNumber numberWithBool:YES], WKNEShouldMonitorShutdowns,
185                                                                             disabledInputManagers, @"NSDisabledInputManagers", nil];
186     [userDefaults registerDefaults:defaultPrefs];
187     if ([userDefaults boolForKey:WKNEShouldMonitorShutdowns]) {
188         WKNERunStates savedState = (WKNERunStates)[userDefaults integerForKey:WKNERunState];
189         if (savedState == RunStateInitializing) {
190             // Use CoreFoundation here as AppKit hasn't been initialized at this stage of Safari's lifetime
191             CFOptionFlags responseFlags;
192             CFUserNotificationDisplayAlert(0, kCFUserNotificationCautionAlertLevel,
193                                            NULL, NULL, NULL,
194                                            CFSTR("WebKit failed to open correctly"),
195                                            CFSTR("WebKit failed to open correctly on your previous attempt. Please disable any Safari extensions that you may have installed.  If the problem continues to occur, please file a bug report at http://webkit.org/quality/reporting.html"), 
196                                            CFSTR("Continue"), NULL, NULL, &responseFlags);
197         }
198         else if (savedState == RunStateRunning) {
199             NSLog(@"WebKit failed to shut down cleanly.  Checking for Safari extensions.");
200             CFNotificationCenterAddObserver(CFNotificationCenterGetLocalCenter(), &myBundleDidLoad,
201                                             myBundleDidLoad, (CFStringRef) NSBundleDidLoadNotification,
202                                             NULL, CFNotificationSuspensionBehaviorDeliverImmediately);
203         }
204     }
205     [userDefaults setInteger:RunStateInitializing forKey:WKNERunState];
206     [userDefaults synchronize];
207
208     CFNotificationCenterAddObserver(CFNotificationCenterGetLocalCenter(), &myApplicationWillFinishLaunching,
209                                     myApplicationWillFinishLaunching, (CFStringRef) NSApplicationWillFinishLaunchingNotification,
210                                     NULL, CFNotificationSuspensionBehaviorDeliverImmediately);
211     CFNotificationCenterAddObserver(CFNotificationCenterGetLocalCenter(), &myApplicationWillTerminate,
212                                     myApplicationWillTerminate, (CFStringRef) NSApplicationWillTerminateNotification,
213                                     NULL, CFNotificationSuspensionBehaviorDeliverImmediately);
214
215     NSLog(@"WebKit %@ initialized.", [webKitLauncherBundle() objectForInfoDictionaryKey:@"CFBundleShortVersionString"]);
216
217     [pool release];
218 }