1 // Copyright 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 // On Mac, one can't make shortcuts with command-line arguments. Instead, we
6 // produce small app bundles which locate the Chromium framework and load it,
7 // passing the appropriate data. This is the entry point into the framework for
10 #import <Cocoa/Cocoa.h>
13 #include "base/at_exit.h"
14 #include "base/command_line.h"
15 #include "base/files/file_path.h"
16 #include "base/files/file_util.h"
17 #include "base/logging.h"
18 #include "base/mac/bundle_locations.h"
19 #include "base/mac/foundation_util.h"
20 #include "base/mac/launch_services_util.h"
21 #include "base/mac/mac_logging.h"
22 #include "base/mac/mac_util.h"
23 #include "base/mac/scoped_nsautorelease_pool.h"
24 #include "base/mac/scoped_nsobject.h"
25 #include "base/mac/sdk_forward_declarations.h"
26 #include "base/message_loop/message_loop.h"
27 #include "base/path_service.h"
28 #include "base/strings/string_number_conversions.h"
29 #include "base/strings/sys_string_conversions.h"
30 #include "base/threading/thread.h"
31 #include "chrome/common/chrome_constants.h"
32 #include "chrome/common/chrome_paths.h"
33 #include "chrome/common/chrome_switches.h"
34 #include "chrome/common/mac/app_mode_common.h"
35 #include "chrome/common/mac/app_shim_messages.h"
36 #include "chrome/grit/generated_resources.h"
37 #include "ipc/ipc_channel_proxy.h"
38 #include "ipc/ipc_listener.h"
39 #include "ipc/ipc_message.h"
40 #include "ui/base/l10n/l10n_util.h"
41 #include "ui/base/resource/resource_bundle.h"
45 // Timeout in seconds to wait for a reply for the initial Apple Event. Note that
46 // kAEDefaultTimeout on Mac is "about one minute" according to Apple's
47 // documentation, but is no longer supported for asynchronous Apple Events.
48 const int kPingChromeTimeoutSeconds = 60;
50 const app_mode::ChromeAppModeInfo* g_info;
51 base::Thread* g_io_thread = NULL;
55 class AppShimController;
57 // An application delegate to catch user interactions and send the appropriate
58 // IPC messages to Chrome.
59 @interface AppShimDelegate : NSObject<NSApplicationDelegate> {
61 AppShimController* appShimController_; // Weak, initially NULL.
63 BOOL terminateRequested_;
64 std::vector<base::FilePath> filesToOpenAtStartup_;
67 // The controller is initially NULL. Setting it indicates to the delegate that
68 // the controller has finished initialization.
69 - (void)setController:(AppShimController*)controller;
71 // Gets files that were queued because the controller was not ready.
72 // Returns whether any FilePaths were added to |out|.
73 - (BOOL)getFilesToOpenAtStartup:(std::vector<base::FilePath>*)out;
75 // If the controller is ready, this sends a FocusApp with the files to open.
76 // Otherwise, this adds the files to |filesToOpenAtStartup_|.
77 // Takes an array of NSString*.
78 - (void)openFiles:(NSArray*)filename;
80 // Terminate immediately. This is necessary as we override terminate: to send
86 // The AppShimController is responsible for communication with the main Chrome
87 // process, and generally controls the lifetime of the app shim process.
88 class AppShimController : public IPC::Listener {
91 ~AppShimController() override;
93 // Called when the main Chrome process responds to the Apple Event ping that
94 // was sent, or when the ping fails (if |success| is false).
95 void OnPingChromeReply(bool success);
97 // Called |kPingChromeTimeoutSeconds| after startup, to allow a timeout on the
98 // ping event to be detected.
99 void OnPingChromeTimeout();
101 // Connects to Chrome and sends a LaunchApp message.
104 // Create a channel from |socket_path| and send a LaunchApp message.
105 void CreateChannelAndSendLaunchApp(const base::FilePath& socket_path);
107 // Builds main menu bar items.
110 void SendSetAppHidden(bool hidden);
114 // Called when the app is activated, e.g. by clicking on it in the dock, by
115 // dropping a file on the dock icon, or by Cmd+Tabbing to it.
116 // Returns whether the message was sent.
117 bool SendFocusApp(apps::AppShimFocusType focus_type,
118 const std::vector<base::FilePath>& files);
121 // IPC::Listener implemetation.
122 bool OnMessageReceived(const IPC::Message& message) override;
123 void OnChannelError() override;
125 // If Chrome failed to launch the app, |success| will be false and the app
126 // shim process should die.
127 void OnLaunchAppDone(apps::AppShimLaunchResult result);
132 // Requests user attention.
133 void OnRequestUserAttention();
134 void OnSetUserAttention(apps::AppShimAttentionType attention_type);
136 // Terminates the app shim process.
139 base::FilePath user_data_dir_;
140 scoped_ptr<IPC::ChannelProxy> channel_;
141 base::scoped_nsobject<AppShimDelegate> delegate_;
142 bool launch_app_done_;
143 bool ping_chrome_reply_received_;
144 NSInteger attention_request_id_;
146 DISALLOW_COPY_AND_ASSIGN(AppShimController);
149 AppShimController::AppShimController()
150 : delegate_([[AppShimDelegate alloc] init]),
151 launch_app_done_(false),
152 ping_chrome_reply_received_(false),
153 attention_request_id_(0) {
154 // Since AppShimController is created before the main message loop starts,
155 // NSApp will not be set, so use sharedApplication.
156 [[NSApplication sharedApplication] setDelegate:delegate_];
159 AppShimController::~AppShimController() {
160 // Un-set the delegate since NSApplication does not retain it.
161 [[NSApplication sharedApplication] setDelegate:nil];
164 void AppShimController::OnPingChromeReply(bool success) {
165 ping_chrome_reply_received_ = true;
167 [NSApp terminate:nil];
174 void AppShimController::OnPingChromeTimeout() {
175 if (!ping_chrome_reply_received_)
176 [NSApp terminate:nil];
179 void AppShimController::Init() {
184 // Chrome will relaunch shims when relaunching apps.
185 if (base::mac::IsOSLionOrLater())
186 [NSApp disableRelaunchOnLogin];
188 // The user_data_dir for shims actually contains the app_data_path.
189 // I.e. <user_data_dir>/<profile_dir>/Web Applications/_crx_extensionid/
190 user_data_dir_ = g_info->user_data_dir.DirName().DirName().DirName();
191 CHECK(!user_data_dir_.empty());
193 base::FilePath symlink_path =
194 user_data_dir_.Append(app_mode::kAppShimSocketSymlinkName);
196 base::FilePath socket_path;
197 if (!base::ReadSymbolicLink(symlink_path, &socket_path)) {
198 // The path in the user data dir is not a symlink, try connecting directly.
199 CreateChannelAndSendLaunchApp(symlink_path);
203 app_mode::VerifySocketPermissions(socket_path);
205 CreateChannelAndSendLaunchApp(socket_path);
208 void AppShimController::CreateChannelAndSendLaunchApp(
209 const base::FilePath& socket_path) {
210 IPC::ChannelHandle handle(socket_path.value());
211 channel_ = IPC::ChannelProxy::Create(handle,
212 IPC::Channel::MODE_NAMED_CLIENT,
214 g_io_thread->message_loop_proxy().get());
216 bool launched_by_chrome =
217 CommandLine::ForCurrentProcess()->HasSwitch(
218 app_mode::kLaunchedByChromeProcessId);
219 apps::AppShimLaunchType launch_type = launched_by_chrome ?
220 apps::APP_SHIM_LAUNCH_REGISTER_ONLY : apps::APP_SHIM_LAUNCH_NORMAL;
222 [delegate_ setController:this];
224 std::vector<base::FilePath> files;
225 [delegate_ getFilesToOpenAtStartup:&files];
227 channel_->Send(new AppShimHostMsg_LaunchApp(
228 g_info->profile_dir, g_info->app_mode_id, launch_type, files));
231 void AppShimController::SetUpMenu() {
232 NSString* title = base::SysUTF16ToNSString(g_info->app_mode_name);
234 // Create a main menu since [NSApp mainMenu] is nil.
235 base::scoped_nsobject<NSMenu> main_menu([[NSMenu alloc] initWithTitle:title]);
237 // The title of the first item is replaced by OSX with the name of the app and
238 // bold styling. Create a dummy item for this and make it hidden.
239 NSMenuItem* dummy_item = [main_menu addItemWithTitle:title
242 base::scoped_nsobject<NSMenu> dummy_submenu(
243 [[NSMenu alloc] initWithTitle:title]);
244 [dummy_item setSubmenu:dummy_submenu];
245 [dummy_item setHidden:YES];
247 // Construct an unbolded app menu, to match how it appears in the Chrome menu
248 // bar when the app is focused.
249 NSMenuItem* item = [main_menu addItemWithTitle:title
252 base::scoped_nsobject<NSMenu> submenu([[NSMenu alloc] initWithTitle:title]);
253 [item setSubmenu:submenu];
256 NSString* quit_localized_string =
257 l10n_util::GetNSStringF(IDS_EXIT_MAC, g_info->app_mode_name);
258 [submenu addItemWithTitle:quit_localized_string
259 action:@selector(terminate:)
262 // Add File, Edit, and Window menus. These are just here to make the
263 // transition smoother, i.e. from another application to the shim then to
265 [main_menu addItemWithTitle:l10n_util::GetNSString(IDS_FILE_MENU_MAC)
268 [main_menu addItemWithTitle:l10n_util::GetNSString(IDS_EDIT_MENU_MAC)
271 [main_menu addItemWithTitle:l10n_util::GetNSString(IDS_WINDOW_MENU_MAC)
275 [NSApp setMainMenu:main_menu];
278 void AppShimController::SendQuitApp() {
279 channel_->Send(new AppShimHostMsg_QuitApp);
282 bool AppShimController::OnMessageReceived(const IPC::Message& message) {
284 IPC_BEGIN_MESSAGE_MAP(AppShimController, message)
285 IPC_MESSAGE_HANDLER(AppShimMsg_LaunchApp_Done, OnLaunchAppDone)
286 IPC_MESSAGE_HANDLER(AppShimMsg_Hide, OnHide)
287 IPC_MESSAGE_HANDLER(AppShimMsg_RequestUserAttention, OnRequestUserAttention)
288 IPC_MESSAGE_HANDLER(AppShimMsg_SetUserAttention, OnSetUserAttention)
289 IPC_MESSAGE_UNHANDLED(handled = false)
290 IPC_END_MESSAGE_MAP()
295 void AppShimController::OnChannelError() {
299 void AppShimController::OnLaunchAppDone(apps::AppShimLaunchResult result) {
300 if (result != apps::APP_SHIM_LAUNCH_SUCCESS) {
305 std::vector<base::FilePath> files;
306 if ([delegate_ getFilesToOpenAtStartup:&files])
307 SendFocusApp(apps::APP_SHIM_FOCUS_OPEN_FILES, files);
309 launch_app_done_ = true;
312 void AppShimController::OnHide() {
316 void AppShimController::OnRequestUserAttention() {
317 OnSetUserAttention(apps::APP_SHIM_ATTENTION_INFORMATIONAL);
320 void AppShimController::OnSetUserAttention(
321 apps::AppShimAttentionType attention_type) {
322 switch (attention_type) {
323 case apps::APP_SHIM_ATTENTION_CANCEL:
324 [NSApp cancelUserAttentionRequest:attention_request_id_];
325 attention_request_id_ = 0;
327 case apps::APP_SHIM_ATTENTION_CRITICAL:
328 attention_request_id_ = [NSApp requestUserAttention:NSCriticalRequest];
330 case apps::APP_SHIM_ATTENTION_INFORMATIONAL:
331 attention_request_id_ =
332 [NSApp requestUserAttention:NSInformationalRequest];
334 case apps::APP_SHIM_ATTENTION_NUM_TYPES:
339 void AppShimController::Close() {
340 [delegate_ terminateNow];
343 bool AppShimController::SendFocusApp(apps::AppShimFocusType focus_type,
344 const std::vector<base::FilePath>& files) {
345 if (launch_app_done_) {
346 channel_->Send(new AppShimHostMsg_FocusApp(focus_type, files));
353 void AppShimController::SendSetAppHidden(bool hidden) {
354 channel_->Send(new AppShimHostMsg_SetAppHidden(hidden));
357 @implementation AppShimDelegate
359 - (BOOL)getFilesToOpenAtStartup:(std::vector<base::FilePath>*)out {
360 if (filesToOpenAtStartup_.empty())
363 out->insert(out->end(),
364 filesToOpenAtStartup_.begin(),
365 filesToOpenAtStartup_.end());
366 filesToOpenAtStartup_.clear();
370 - (void)setController:(AppShimController*)controller {
371 appShimController_ = controller;
374 - (void)openFiles:(NSArray*)filenames {
375 std::vector<base::FilePath> filePaths;
376 for (NSString* filename in filenames)
377 filePaths.push_back(base::mac::NSStringToFilePath(filename));
379 // If the AppShimController is ready, try to send a FocusApp. If that fails,
380 // (e.g. if launching has not finished), enqueue the files.
381 if (appShimController_ &&
382 appShimController_->SendFocusApp(apps::APP_SHIM_FOCUS_OPEN_FILES,
387 filesToOpenAtStartup_.insert(filesToOpenAtStartup_.end(),
392 - (BOOL)application:(NSApplication*)app
393 openFile:(NSString*)filename {
394 [self openFiles:@[filename]];
398 - (void)application:(NSApplication*)app
399 openFiles:(NSArray*)filenames {
400 [self openFiles:filenames];
401 [app replyToOpenOrPrint:NSApplicationDelegateReplySuccess];
404 - (BOOL)applicationOpenUntitledFile:(NSApplication*)app {
405 if (appShimController_) {
406 return appShimController_->SendFocusApp(apps::APP_SHIM_FOCUS_REOPEN,
407 std::vector<base::FilePath>());
413 - (void)applicationWillBecomeActive:(NSNotification*)notification {
414 if (appShimController_) {
415 appShimController_->SendFocusApp(apps::APP_SHIM_FOCUS_NORMAL,
416 std::vector<base::FilePath>());
420 - (NSApplicationTerminateReply)
421 applicationShouldTerminate:(NSApplication*)sender {
422 if (terminateNow_ || !appShimController_)
423 return NSTerminateNow;
425 appShimController_->SendQuitApp();
426 // Wait for the channel to close before terminating.
427 terminateRequested_ = YES;
428 return NSTerminateLater;
431 - (void)applicationWillHide:(NSNotification*)notification {
432 if (appShimController_)
433 appShimController_->SendSetAppHidden(true);
436 - (void)applicationWillUnhide:(NSNotification*)notification {
437 if (appShimController_)
438 appShimController_->SendSetAppHidden(false);
441 - (void)terminateNow {
442 if (terminateRequested_) {
443 [NSApp replyToApplicationShouldTerminate:NSTerminateNow];
448 [NSApp terminate:nil];
453 //-----------------------------------------------------------------------------
455 // A ReplyEventHandler is a helper class to send an Apple Event to a process
456 // and call a callback when the reply returns.
458 // This is used to 'ping' the main Chrome process -- once Chrome has sent back
459 // an Apple Event reply, it's guaranteed that it has opened the IPC channel
460 // that the app shim will connect to.
461 @interface ReplyEventHandler : NSObject {
462 base::Callback<void(bool)> onReply_;
465 // Sends an Apple Event to the process identified by |psn|, and calls |replyFn|
466 // when the reply is received. Internally this creates a ReplyEventHandler,
467 // which will delete itself once the reply event has been received.
468 + (void)pingProcess:(const ProcessSerialNumber&)psn
469 andCall:(base::Callback<void(bool)>)replyFn;
472 @interface ReplyEventHandler (PrivateMethods)
473 // Initialise the reply event handler. Doesn't register any handlers until
474 // |-pingProcess:| is called. |replyFn| is the function to be called when the
475 // Apple Event reply arrives.
476 - (id)initWithCallback:(base::Callback<void(bool)>)replyFn;
478 // Sends an Apple Event ping to the process identified by |psn| and registers
479 // to listen for a reply.
480 - (void)pingProcess:(const ProcessSerialNumber&)psn;
482 // Called when a response is received from the target process for the ping sent
483 // by |-pingProcess:|.
484 - (void)message:(NSAppleEventDescriptor*)event
485 withReply:(NSAppleEventDescriptor*)reply;
487 // Calls |onReply_|, passing it |success| to specify whether the ping was
489 - (void)closeWithSuccess:(bool)success;
492 @implementation ReplyEventHandler
493 + (void)pingProcess:(const ProcessSerialNumber&)psn
494 andCall:(base::Callback<void(bool)>)replyFn {
495 // The object will release itself when the reply arrives, or possibly earlier
496 // if an unrecoverable error occurs.
497 ReplyEventHandler* handler =
498 [[ReplyEventHandler alloc] initWithCallback:replyFn];
499 [handler pingProcess:psn];
503 @implementation ReplyEventHandler (PrivateMethods)
504 - (id)initWithCallback:(base::Callback<void(bool)>)replyFn {
505 if ((self = [super init])) {
511 - (void)pingProcess:(const ProcessSerialNumber&)psn {
512 // Register the reply listener.
513 NSAppleEventManager* em = [NSAppleEventManager sharedAppleEventManager];
514 [em setEventHandler:self
515 andSelector:@selector(message:withReply:)
518 // Craft the Apple Event to send.
519 NSAppleEventDescriptor* target = [NSAppleEventDescriptor
520 descriptorWithDescriptorType:typeProcessSerialNumber
523 NSAppleEventDescriptor* initial_event =
524 [NSAppleEventDescriptor
525 appleEventWithEventClass:app_mode::kAEChromeAppClass
526 eventID:app_mode::kAEChromeAppPing
527 targetDescriptor:target
528 returnID:kAutoGenerateReturnID
529 transactionID:kAnyTransactionID];
531 // Note that AESendMessage effectively ignores kAEDefaultTimeout, because this
532 // call does not pass kAEWantReceipt (which is deprecated and unsupported on
533 // Mac). Instead, rely on OnPingChromeTimeout().
534 OSStatus status = AESendMessage(
535 [initial_event aeDesc], &replyEvent_, kAEQueueReply, kAEDefaultTimeout);
536 if (status != noErr) {
537 OSSTATUS_LOG(ERROR, status) << "AESendMessage";
538 [self closeWithSuccess:false];
542 - (void)message:(NSAppleEventDescriptor*)event
543 withReply:(NSAppleEventDescriptor*)reply {
544 [self closeWithSuccess:true];
547 - (void)closeWithSuccess:(bool)success {
548 onReply_.Run(success);
549 NSAppleEventManager* em = [NSAppleEventManager sharedAppleEventManager];
550 [em removeEventHandlerForEventClass:'aevt' andEventID:'ansr'];
555 //-----------------------------------------------------------------------------
559 // |ChromeAppModeStart()| is the point of entry into the framework from the app
561 __attribute__((visibility("default")))
562 int ChromeAppModeStart(const app_mode::ChromeAppModeInfo* info);
566 int ChromeAppModeStart(const app_mode::ChromeAppModeInfo* info) {
567 CommandLine::Init(info->argc, info->argv);
569 base::mac::ScopedNSAutoreleasePool scoped_pool;
570 base::AtExitManager exit_manager;
571 chrome::RegisterPathProvider();
573 if (info->major_version < app_mode::kCurrentChromeAppModeInfoMajorVersion) {
574 RAW_LOG(ERROR, "App Mode Loader too old.");
577 if (info->major_version > app_mode::kCurrentChromeAppModeInfoMajorVersion) {
578 RAW_LOG(ERROR, "Browser Framework too old to load App Shortcut.");
584 // Set bundle paths. This loads the bundles.
585 base::mac::SetOverrideOuterBundlePath(g_info->chrome_outer_bundle_path);
586 base::mac::SetOverrideFrameworkBundlePath(
587 g_info->chrome_versioned_path.Append(chrome::kFrameworkName));
589 // Calculate the preferred locale used by Chrome.
590 // We can't use l10n_util::OverrideLocaleWithCocoaLocale() because it calls
591 // [base::mac::OuterBundle() preferredLocalizations] which gets localizations
592 // from the bundle of the running app (i.e. it is equivalent to
593 // [[NSBundle mainBundle] preferredLocalizations]) instead of the target
595 NSArray* preferred_languages = [NSLocale preferredLanguages];
596 NSArray* supported_languages = [base::mac::OuterBundle() localizations];
597 std::string preferred_localization;
598 for (NSString* language in preferred_languages) {
599 if ([supported_languages containsObject:language]) {
600 preferred_localization = base::SysNSStringToUTF8(language);
604 std::string locale = l10n_util::NormalizeLocale(
605 l10n_util::GetApplicationLocale(preferred_localization));
607 // Load localized strings.
608 ui::ResourceBundle::InitSharedInstanceWithLocale(
609 locale, NULL, ui::ResourceBundle::DO_NOT_LOAD_COMMON_RESOURCES);
611 // Launch the IO thread.
612 base::Thread::Options io_thread_options;
613 io_thread_options.message_loop_type = base::MessageLoop::TYPE_IO;
614 base::Thread *io_thread = new base::Thread("CrAppShimIO");
615 io_thread->StartWithOptions(io_thread_options);
616 g_io_thread = io_thread;
618 // Find already running instances of Chrome.
620 std::string chrome_process_id = CommandLine::ForCurrentProcess()->
621 GetSwitchValueASCII(app_mode::kLaunchedByChromeProcessId);
622 if (!chrome_process_id.empty()) {
623 if (!base::StringToInt(chrome_process_id, &pid))
624 LOG(FATAL) << "Invalid PID: " << chrome_process_id;
626 NSString* chrome_bundle_id = [base::mac::OuterBundle() bundleIdentifier];
627 NSArray* existing_chrome = [NSRunningApplication
628 runningApplicationsWithBundleIdentifier:chrome_bundle_id];
629 if ([existing_chrome count] > 0)
630 pid = [[existing_chrome objectAtIndex:0] processIdentifier];
633 AppShimController controller;
634 base::MessageLoopForUI main_message_loop;
635 main_message_loop.set_thread_name("MainThread");
636 base::PlatformThread::SetName("CrAppShimMain");
638 // In tests, launching Chrome does nothing, and we won't get a ping response,
639 // so just assume the socket exists.
641 !CommandLine::ForCurrentProcess()->HasSwitch(
642 app_mode::kLaunchedForTest)) {
643 // Launch Chrome if it isn't already running.
644 ProcessSerialNumber psn;
645 CommandLine command_line(CommandLine::NO_PROGRAM);
646 command_line.AppendSwitch(switches::kSilentLaunch);
648 // If the shim is the app launcher, pass --show-app-list when starting a new
649 // Chrome process to inform startup codepaths and load the correct profile.
650 if (info->app_mode_id == app_mode::kAppListModeId) {
651 command_line.AppendSwitch(switches::kShowAppList);
653 command_line.AppendSwitchPath(switches::kProfileDirectory,
658 base::mac::OpenApplicationWithPath(base::mac::OuterBundlePath(),
665 base::Callback<void(bool)> on_ping_chrome_reply =
666 base::Bind(&AppShimController::OnPingChromeReply,
667 base::Unretained(&controller));
669 // This code abuses the fact that Apple Events sent before the process is
670 // fully initialized don't receive a reply until its run loop starts. Once
671 // the reply is received, Chrome will have opened its IPC port, guaranteed.
672 [ReplyEventHandler pingProcess:psn
673 andCall:on_ping_chrome_reply];
675 main_message_loop.PostDelayedTask(
677 base::Bind(&AppShimController::OnPingChromeTimeout,
678 base::Unretained(&controller)),
679 base::TimeDelta::FromSeconds(kPingChromeTimeoutSeconds));
681 // Chrome already running. Proceed to init. This could still fail if Chrome
682 // is still starting up or shutting down, but the process will exit quickly,
683 // which is preferable to waiting for the Apple Event to timeout after one
685 main_message_loop.PostTask(
687 base::Bind(&AppShimController::Init,
688 base::Unretained(&controller)));
691 main_message_loop.Run();