1 // Copyright (c) 2012 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 #ifndef CHROME_COMMON_MAC_APP_MODE_COMMON_H_
6 #define CHROME_COMMON_MAC_APP_MODE_COMMON_H_
8 #import <Foundation/Foundation.h>
10 #include "base/files/file_path.h"
11 #include "base/strings/string16.h"
13 // This file contains constants, interfaces, etc. which are common to the
14 // browser application and the app mode loader (a.k.a. shim).
18 // These are keys for an Apple Event ping that the app shim process sends to
19 // Chrome to get confirmation that Chrome is alive. The main Chrome process
20 // doesn't need to register any handlers for them -- the event is just sent for
21 // the empty reply that's automatically returned by the system.
22 const AEEventClass kAEChromeAppClass = 'cApp';
23 const AEEventID kAEChromeAppPing = 'ping';
25 // The IPC socket used to communicate between app shims and Chrome will be
26 // created under a temporary directory with this name.
27 extern const char kAppShimSocketShortName[];
28 // A symlink to allow the app shim to find the socket will be created under the
29 // user data dir with this name.
30 extern const char kAppShimSocketSymlinkName[];
32 // Special app mode id used for the App Launcher.
33 extern const char kAppListModeId[];
35 // The process ID of the Chrome process that launched the app shim.
36 // The presence of this switch instructs the app shim to send LaunchApp with
37 // launch_now = false. This associates the shim without launching the app.
38 extern const char kLaunchedByChromeProcessId[];
40 // The display name of the bundle as shown in Finder and the Dock. For localized
41 // bundles, this overrides the bundle's file name.
42 extern NSString* const kCFBundleDisplayNameKey;
44 // The key specifying whether the display name should be localized. This makes
45 // Finder look in localization folders in the app bundle for a display name.
46 // (e.g. Content/Resources/en.lproj/)
47 extern NSString* const kLSHasLocalizedDisplayNameKey;
49 // The key under which the browser's bundle ID will be stored in the
50 // app mode launcher bundle's Info.plist.
51 extern NSString* const kBrowserBundleIDKey;
53 // Key for the shortcut ID.
54 extern NSString* const kCrAppModeShortcutIDKey;
56 // Key for the app's name.
57 extern NSString* const kCrAppModeShortcutNameKey;
59 // Key for the app's URL.
60 extern NSString* const kCrAppModeShortcutURLKey;
62 // Key for the app user data directory.
63 extern NSString* const kCrAppModeUserDataDirKey;
65 // Key for the app's extension path.
66 extern NSString* const kCrAppModeProfileDirKey;
68 // Key for the app's profile display name.
69 extern NSString* const kCrAppModeProfileNameKey;
71 // When the Chrome browser is run, it stores its location in the defaults
72 // system using this key.
73 extern NSString* const kLastRunAppBundlePathPrefsKey;
75 // Placeholders used in the app mode loader bundle' Info.plist:
76 extern NSString* const kShortcutIdPlaceholder; // Extension shortcut ID.
77 extern NSString* const kShortcutNamePlaceholder; // Extension name.
78 extern NSString* const kShortcutURLPlaceholder;
79 // Bundle ID of the Chrome browser bundle.
80 extern NSString* const kShortcutBrowserBundleIDPlaceholder;
82 // Current major/minor version numbers of |ChromeAppModeInfo| (defined below).
83 const unsigned kCurrentChromeAppModeInfoMajorVersion = 1;
84 const unsigned kCurrentChromeAppModeInfoMinorVersion = 0;
86 // The structure used to pass information from the app mode loader to the
87 // (browser) framework. This is versioned using major and minor version numbers,
88 // written below as v<major>.<minor>. Version-number checking is done by the
89 // framework, and the framework must accept all structures with the same major
90 // version number. It may refuse to load if the major version of the structure
91 // is different from the one it accepts.
92 struct ChromeAppModeInfo {
97 // Major and minor version number of this structure.
98 unsigned major_version; // Required: all versions
99 unsigned minor_version; // Required: all versions
101 // Original |argc| and |argv|.
102 int argc; // Required: v1.0
103 char** argv; // Required: v1.0
105 // Versioned path to the browser which is being loaded.
106 base::FilePath chrome_versioned_path; // Required: v1.0
108 // Path to Chrome app bundle.
109 base::FilePath chrome_outer_bundle_path; // Required: v1.0
111 // Information about the App Mode shortcut:
113 // Path to the App Mode Loader application bundle that launched the process.
114 base::FilePath app_mode_bundle_path; // Optional: v1.0
116 // Short ID string, preferably derived from |app_mode_short_name|. Should be
117 // safe for the file system.
118 std::string app_mode_id; // Required: v1.0
120 // Unrestricted (e.g., several-word) UTF8-encoded name for the shortcut.
121 base::string16 app_mode_name; // Optional: v1.0
123 // URL for the shortcut. Must be a valid URL.
124 std::string app_mode_url; // Required: v1.0
126 // Path to the app's user data directory.
127 base::FilePath user_data_dir;
129 // Directory of the profile associated with the app.
130 base::FilePath profile_dir;
133 // Check that the socket and its parent directory have the correct permissions
134 // and are owned by the user.
135 void VerifySocketPermissions(const base::FilePath& socket_path);
137 } // namespace app_mode
139 #endif // CHROME_COMMON_MAC_APP_MODE_COMMON_H_