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 // Path to an app shim bundle. Indicates to Chrome that this shim attempted to
42 extern const char kAppShimError[];
44 // Keys for specifying the file types handled by an app.
45 extern NSString* const kCFBundleDocumentTypesKey;
46 extern NSString* const kCFBundleTypeExtensionsKey;
47 extern NSString* const kCFBundleTypeIconFileKey;
48 extern NSString* const kCFBundleTypeNameKey;
49 extern NSString* const kCFBundleTypeMIMETypesKey;
50 extern NSString* const kCFBundleTypeRoleKey;
51 extern NSString* const kBundleTypeRoleViewer;
53 // The display name of the bundle as shown in Finder and the Dock. For localized
54 // bundles, this overrides the bundle's file name.
55 extern NSString* const kCFBundleDisplayNameKey;
57 // The key specifying whether the display name should be localized. This makes
58 // Finder look in localization folders in the app bundle for a display name.
59 // (e.g. Content/Resources/en.lproj/)
60 extern NSString* const kLSHasLocalizedDisplayNameKey;
62 // The key under which the browser's bundle ID will be stored in the
63 // app mode launcher bundle's Info.plist.
64 extern NSString* const kBrowserBundleIDKey;
66 // Key for the shortcut ID.
67 extern NSString* const kCrAppModeShortcutIDKey;
69 // Key for the app's name.
70 extern NSString* const kCrAppModeShortcutNameKey;
72 // Key for the app's URL.
73 extern NSString* const kCrAppModeShortcutURLKey;
75 // Key for the app user data directory.
76 extern NSString* const kCrAppModeUserDataDirKey;
78 // Key for the app's extension path.
79 extern NSString* const kCrAppModeProfileDirKey;
81 // Key for the app's profile display name.
82 extern NSString* const kCrAppModeProfileNameKey;
84 // When the Chrome browser is run, it stores its location in the defaults
85 // system using this key.
86 extern NSString* const kLastRunAppBundlePathPrefsKey;
88 // Placeholders used in the app mode loader bundle' Info.plist:
89 extern NSString* const kShortcutIdPlaceholder; // Extension shortcut ID.
90 extern NSString* const kShortcutNamePlaceholder; // Extension name.
91 extern NSString* const kShortcutURLPlaceholder;
92 // Bundle ID of the Chrome browser bundle.
93 extern NSString* const kShortcutBrowserBundleIDPlaceholder;
95 // Current major/minor version numbers of |ChromeAppModeInfo| (defined below).
96 const unsigned kCurrentChromeAppModeInfoMajorVersion = 1;
97 const unsigned kCurrentChromeAppModeInfoMinorVersion = 1;
99 // The structure used to pass information from the app mode loader to the
100 // (browser) framework. This is versioned using major and minor version numbers,
101 // written below as v<major>.<minor>. Version-number checking is done by the
102 // framework, and the framework must accept all structures with the same major
103 // version number. It may refuse to load if the major version of the structure
104 // is different from the one it accepts.
105 struct ChromeAppModeInfo {
108 ~ChromeAppModeInfo();
110 // Major and minor version number of this structure.
111 unsigned major_version; // Required: all versions
112 unsigned minor_version; // Required: all versions
114 // Original |argc| and |argv|.
115 int argc; // Required: v1.0
116 char** argv; // Required: v1.0
118 // Versioned path to the browser which is being loaded.
119 base::FilePath chrome_versioned_path; // Required: v1.0
121 // Path to Chrome app bundle.
122 base::FilePath chrome_outer_bundle_path; // Required: v1.0
124 // Information about the App Mode shortcut:
126 // Path to the App Mode Loader application bundle that launched the process.
127 base::FilePath app_mode_bundle_path; // Optional: v1.0
129 // Short ID string, preferably derived from |app_mode_short_name|. Should be
130 // safe for the file system.
131 std::string app_mode_id; // Required: v1.0
133 // Unrestricted (e.g., several-word) UTF8-encoded name for the shortcut.
134 base::string16 app_mode_name; // Optional: v1.0
136 // URL for the shortcut. Must be a valid URL.
137 std::string app_mode_url; // Required: v1.0
139 // Path to the app's user data directory.
140 base::FilePath user_data_dir;
142 // Directory of the profile associated with the app.
143 base::FilePath profile_dir;
146 // Check that the socket and its parent directory have the correct permissions
147 // and are owned by the user.
148 void VerifySocketPermissions(const base::FilePath& socket_path);
150 } // namespace app_mode
152 #endif // CHROME_COMMON_MAC_APP_MODE_COMMON_H_