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 #ifndef CHROME_BROWSER_UI_ASH_LAUNCHER_CHROME_LAUNCHER_CONTROLLER_H_
6 #define CHROME_BROWSER_UI_ASH_LAUNCHER_CHROME_LAUNCHER_CONTROLLER_H_
14 #include "ash/display/display_controller.h"
15 #include "ash/shelf/shelf_delegate.h"
16 #include "ash/shelf/shelf_item_delegate.h"
17 #include "ash/shelf/shelf_item_types.h"
18 #include "ash/shelf/shelf_layout_manager_observer.h"
19 #include "ash/shelf/shelf_model_observer.h"
20 #include "ash/shelf/shelf_types.h"
21 #include "ash/shell_observer.h"
22 #include "base/basictypes.h"
23 #include "base/compiler_specific.h"
24 #include "base/memory/scoped_ptr.h"
25 #include "base/memory/scoped_vector.h"
26 #include "base/prefs/pref_change_registrar.h"
27 #include "chrome/browser/extensions/app_icon_loader.h"
28 #include "chrome/browser/prefs/pref_service_syncable_observer.h"
29 #include "chrome/browser/ui/ash/app_sync_ui_state_observer.h"
30 #include "chrome/browser/ui/ash/launcher/chrome_launcher_app_menu_item.h"
31 #include "chrome/browser/ui/ash/launcher/chrome_launcher_types.h"
32 #include "chrome/browser/ui/extensions/extension_enable_flow_delegate.h"
33 #include "extensions/browser/extension_registry_observer.h"
34 #include "extensions/common/constants.h"
35 #include "ui/aura/window_observer.h"
39 class BrowserShortcutLauncherItemController;
40 class BrowserStatusMonitor;
41 class ExtensionEnableFlow;
43 class LauncherItemController;
45 class AppWindowLauncherController;
49 class ShelfItemDelegateManager;
62 namespace extensions {
70 // A list of the elements which makes up a simple menu description.
71 typedef ScopedVector<ChromeLauncherAppMenuItem> ChromeLauncherAppMenuItems;
73 // A class which needs to be overwritten dependent on the used OS to moitor
75 class ChromeLauncherControllerUserSwitchObserver {
77 ChromeLauncherControllerUserSwitchObserver() {}
78 virtual ~ChromeLauncherControllerUserSwitchObserver() {}
81 DISALLOW_COPY_AND_ASSIGN(ChromeLauncherControllerUserSwitchObserver);
84 // ChromeLauncherController manages the launcher items needed for content
85 // windows. Launcher items have a type, an optional app id, and a controller.
86 // This incarnation groups running tabs/windows in application specific lists.
87 // * Browser app windows have BrowserLauncherItemController, owned by the
88 // BrowserView instance.
89 // * App windows have AppWindowLauncherItemController, owned by
90 // AppWindowLauncherController.
91 // * Shortcuts have no LauncherItemController.
92 class ChromeLauncherController : public ash::ShelfDelegate,
93 public ash::ShelfModelObserver,
94 public ash::ShellObserver,
95 public ash::DisplayController::Observer,
96 public extensions::ExtensionRegistryObserver,
97 public extensions::AppIconLoader::Delegate,
98 public PrefServiceSyncableObserver,
99 public AppSyncUIStateObserver,
100 public ExtensionEnableFlowDelegate,
101 public ash::ShelfLayoutManagerObserver {
103 // Indicates if a shelf item is incognito or not.
104 enum IncognitoState {
109 // Used to update the state of non plaform apps, as web contents change.
112 APP_STATE_WINDOW_ACTIVE,
117 // Mockable interface to get app ids from tabs.
120 virtual ~AppTabHelper() {}
122 // Returns the app id of the specified tab, or an empty string if there is
123 // no app. All known profiles will be queried for this.
124 virtual std::string GetAppID(content::WebContents* tab) = 0;
126 // Returns true if |id| is valid for the currently active profile.
127 // Used during restore to ignore no longer valid extensions.
128 // Note that already running applications are ignored by the restore
130 virtual bool IsValidIDForCurrentUser(const std::string& id) = 0;
132 // Sets the currently active profile for the usage of |GetAppID|.
133 virtual void SetCurrentUser(Profile* profile) = 0;
136 ChromeLauncherController(Profile* profile, ash::ShelfModel* model);
137 ~ChromeLauncherController() override;
139 // Initializes this ChromeLauncherController.
142 // Creates an instance.
143 static ChromeLauncherController* CreateInstance(Profile* profile,
144 ash::ShelfModel* model);
146 // Returns the single ChromeLauncherController instance.
147 static ChromeLauncherController* instance() { return instance_; }
149 // Creates a new app item on the shelf for |controller|.
150 ash::ShelfID CreateAppLauncherItem(LauncherItemController* controller,
151 const std::string& app_id,
152 ash::ShelfItemStatus status);
154 // Updates the running status of an item. It will also update the status of
155 // browsers shelf item if needed.
156 void SetItemStatus(ash::ShelfID id, ash::ShelfItemStatus status);
158 // Updates the controller associated with id (which should be a shortcut).
159 // |controller| remains owned by caller.
160 void SetItemController(ash::ShelfID id, LauncherItemController* controller);
162 // Closes or unpins the shelf item.
163 void CloseLauncherItem(ash::ShelfID id);
165 // Pins the specified id. Currently only supports platform apps.
166 void Pin(ash::ShelfID id);
168 // Unpins the specified id, closing if not running.
169 void Unpin(ash::ShelfID id);
171 // Returns true if the item identified by |id| is pinned.
172 bool IsPinned(ash::ShelfID id);
174 // Pins/unpins the specified id.
175 void TogglePinned(ash::ShelfID id);
177 // Returns true if the specified item can be pinned or unpinned. Only apps can
179 bool IsPinnable(ash::ShelfID id) const;
181 // Installs the specified id. Only valid if the id corresponds to an ephemeral
183 void Install(ash::ShelfID id);
185 // Returns true if the specified item can be installed. Only true for
187 bool CanInstall(ash::ShelfID id);
189 // If there is no shelf item in the shelf for application |app_id|, one
190 // gets created. The (existing or created) shelf items get then locked
191 // against a users un-pinning removal.
192 void LockV1AppWithID(const std::string& app_id);
194 // A previously locked shelf item of type |app_id| gets unlocked. If the
195 // lock count reaches 0 and the item is not pinned it will go away.
196 void UnlockV1AppWithID(const std::string& app_id);
198 // Requests that the shelf item controller specified by |id| open a new
199 // instance of the app. |event_flags| holds the flags of the event which
200 // triggered this command.
201 void Launch(ash::ShelfID id, int event_flags);
203 // Closes the specified item.
204 void Close(ash::ShelfID id);
206 // Returns true if the specified item is open.
207 bool IsOpen(ash::ShelfID id);
209 // Returns true if the specified item is for a platform app.
210 bool IsPlatformApp(ash::ShelfID id);
212 // Opens a new instance of the application identified by |app_id|.
213 // Used by the app-list, and by pinned-app shelf items.
214 void LaunchApp(const std::string& app_id,
215 ash::LaunchSource source,
218 // If |app_id| is running, reactivates the app's most recently active window,
219 // otherwise launches and activates the app.
220 // Used by the app-list, and by pinned-app shelf items.
221 void ActivateApp(const std::string& app_id,
222 ash::LaunchSource source,
225 // Returns the launch type of app for the specified id.
226 extensions::LaunchType GetLaunchType(ash::ShelfID id);
228 // Set the image for a specific shelf item (e.g. when set by the app).
229 void SetLauncherItemImage(ash::ShelfID shelf_id, const gfx::ImageSkia& image);
231 // Find out if the given application |id| is a windowed app item and not a
232 // pinned item in the shelf.
233 bool IsWindowedAppInLauncher(const std::string& app_id);
235 // Updates the launch type of the app for the specified id to |launch_type|.
236 void SetLaunchType(ash::ShelfID id, extensions::LaunchType launch_type);
238 // Returns true if the user is currently logged in as a guest.
239 // Makes virtual for unittest in LauncherContextMenuTest.
240 virtual bool IsLoggedInAsGuest();
242 // Invoked when user clicks on button in the shelf and there is no last
243 // used window (or CTRL is held with the click).
244 void CreateNewWindow();
246 // Invoked when the user clicks on button in the shelf to create a new
248 void CreateNewIncognitoWindow();
250 // Updates the pinned pref state. The pinned state consists of a list pref.
251 // Each item of the list is a dictionary. The key |kAppIDPath| gives the
253 void PersistPinnedState();
255 ash::ShelfModel* model();
257 // Accessor to the currently loaded profile. Note that in multi profile use
258 // cases this might change over time.
261 // Gets the shelf auto-hide behavior on |root_window|.
262 ash::ShelfAutoHideBehavior GetShelfAutoHideBehavior(
263 aura::Window* root_window) const;
265 // Returns |true| if the user is allowed to modify the shelf auto-hide
266 // behavior on |root_window|.
267 bool CanUserModifyShelfAutoHideBehavior(aura::Window* root_window) const;
269 // Toggles the shelf auto-hide behavior on |root_window|. Does nothing if the
270 // user is not allowed to modify the auto-hide behavior.
271 void ToggleShelfAutoHideBehavior(aura::Window* root_window);
273 // Notify the controller that the state of an non platform app's tabs
275 void UpdateAppState(content::WebContents* contents, AppState app_state);
277 // Returns ShelfID for |contents|. If |contents| is not an app or is not
278 // pinned, returns the id of browser shrotcut.
279 ash::ShelfID GetShelfIDForWebContents(content::WebContents* contents);
281 // Limits application refocusing to urls that match |url| for |id|.
282 void SetRefocusURLPatternForTest(ash::ShelfID id, const GURL& url);
284 // Returns the extension identified by |app_id|.
285 const extensions::Extension* GetExtensionForAppID(
286 const std::string& app_id) const;
288 // Activates a |window|. If |allow_minimize| is true and the system allows
289 // it, the the window will get minimized instead.
290 void ActivateWindowOrMinimizeIfActive(ui::BaseWindow* window,
291 bool allow_minimize);
293 // ash::ShelfDelegate overrides:
294 void OnShelfCreated(ash::Shelf* shelf) override;
295 void OnShelfDestroyed(ash::Shelf* shelf) override;
296 ash::ShelfID GetShelfIDForAppID(const std::string& app_id) override;
297 const std::string& GetAppIDForShelfID(ash::ShelfID id) override;
298 void PinAppWithID(const std::string& app_id) override;
299 bool IsAppPinned(const std::string& app_id) override;
300 bool CanPin() const override;
301 void UnpinAppWithID(const std::string& app_id) override;
303 // ash::ShelfModelObserver overrides:
304 void ShelfItemAdded(int index) override;
305 void ShelfItemRemoved(int index, ash::ShelfID id) override;
306 void ShelfItemMoved(int start_index, int target_index) override;
307 void ShelfItemChanged(int index, const ash::ShelfItem& old_item) override;
308 void ShelfStatusChanged() override;
310 // ash::ShellObserver overrides:
311 void OnShelfAlignmentChanged(aura::Window* root_window) override;
313 // ash::DisplayController::Observer overrides:
314 void OnDisplayConfigurationChanged() override;
316 // ExtensionRegistryObserver overrides:
317 void OnExtensionLoaded(content::BrowserContext* browser_context,
318 const extensions::Extension* extension) override;
319 void OnExtensionUnloaded(
320 content::BrowserContext* browser_context,
321 const extensions::Extension* extension,
322 extensions::UnloadedExtensionInfo::Reason reason) override;
324 // PrefServiceSyncableObserver overrides:
325 void OnIsSyncingChanged() override;
327 // AppSyncUIStateObserver overrides:
328 void OnAppSyncUIStatusChanged() override;
330 // ExtensionEnableFlowDelegate overrides:
331 void ExtensionEnableFlowFinished() override;
332 void ExtensionEnableFlowAborted(bool user_initiated) override;
334 // extensions::AppIconLoader overrides:
335 void SetAppImage(const std::string& app_id,
336 const gfx::ImageSkia& image) override;
338 // ash::ShelfLayoutManagerObserver overrides:
339 void OnAutoHideBehaviorChanged(
340 aura::Window* root_window,
341 ash::ShelfAutoHideBehavior new_behavior) override;
343 // Called when the active user has changed.
344 void ActiveUserChanged(const std::string& user_email);
346 // Called when a user got added to the session.
347 void AdditionalUserAddedToSession(Profile* profile);
349 // Get the list of all running incarnations of this item.
350 // |event_flags| specifies the flags which were set by the event which
351 // triggered this menu generation. It can be used to generate different lists.
352 ChromeLauncherAppMenuItems GetApplicationList(const ash::ShelfItem& item,
355 // Get the list of all tabs which belong to a certain application type.
356 std::vector<content::WebContents*> GetV1ApplicationsFromAppId(
359 // Activates a specified shell application.
360 void ActivateShellApp(const std::string& app_id, int index);
362 // Checks if a given |web_contents| is known to be associated with an
363 // application of type |app_id|.
364 bool IsWebContentHandledByApplication(content::WebContents* web_contents,
365 const std::string& app_id);
367 // Check if the gMail app is loaded and it can handle the given web content.
368 // This special treatment is required to address crbug.com/234268.
369 bool ContentCanBeHandledByGmailApp(content::WebContents* web_contents);
371 // Get the favicon for the application list entry for |web_contents|.
372 // Note that for incognito windows the incognito icon will be returned.
373 // If |web_contents| has not loaded, returns the default favicon.
374 gfx::Image GetAppListIcon(content::WebContents* web_contents) const;
376 // Get the title for the applicatoin list entry for |web_contents|.
377 // If |web_contents| has not loaded, returns "Net Tab".
378 base::string16 GetAppListTitle(content::WebContents* web_contents) const;
380 // Returns the LauncherItemController of BrowserShortcut.
381 BrowserShortcutLauncherItemController*
382 GetBrowserShortcutLauncherItemController();
384 LauncherItemController* GetLauncherItemController(const ash::ShelfID id);
386 // Returns true if |browser| is owned by the active user.
387 bool IsBrowserFromActiveUser(Browser* browser);
389 // Check if the shelf visibility (location, visibility) will change with a new
390 // user profile or not. However, since the full visibility calculation of the
391 // shelf cannot be performed here, this is only a probability used for
392 // animation predictions.
393 bool ShelfBoundsChangesProbablyWithUser(aura::Window* root_window,
394 const std::string& user_id) const;
396 // Access to the BrowserStatusMonitor for tests.
397 BrowserStatusMonitor* browser_status_monitor_for_test() {
398 return browser_status_monitor_.get();
401 // Access to the AppWindowLauncherController for tests.
402 AppWindowLauncherController* app_window_controller_for_test() {
403 return app_window_controller_.get();
407 // Creates a new app shortcut item and controller on the shelf at |index|.
408 // Use kInsertItemAtEnd to add a shortcut as the last item.
409 ash::ShelfID CreateAppShortcutLauncherItem(const std::string& app_id,
412 // Sets the AppTabHelper/AppIconLoader, taking ownership of the helper class.
413 // These are intended for testing.
414 void SetAppTabHelperForTest(AppTabHelper* helper);
415 void SetAppIconLoaderForTest(extensions::AppIconLoader* loader);
416 const std::string& GetAppIdFromShelfIdForTest(ash::ShelfID id);
418 // Sets the ash::ShelfItemDelegateManager only for unittests and doesn't
419 // take an ownership of it.
420 void SetShelfItemDelegateManagerForTest(
421 ash::ShelfItemDelegateManager* manager);
424 friend class ChromeLauncherControllerTest;
425 friend class ShelfAppBrowserTest;
426 friend class LauncherPlatformAppBrowserTest;
428 typedef std::map<ash::ShelfID, LauncherItemController*> IDToItemControllerMap;
429 typedef std::map<content::WebContents*, std::string> WebContentsToAppIDMap;
431 // Remembers / restores list of running applications.
432 // Note that this order will neither be stored in the preference nor will it
433 // remember the order of closed applications since it is only temporary.
434 void RememberUnpinnedRunningApplicationOrder();
435 void RestoreUnpinnedRunningApplicationOrder(const std::string& user_id);
437 // Creates a new app shortcut item and controller on the shelf at |index|.
438 // Use kInsertItemAtEnd to add a shortcut as the last item.
439 ash::ShelfID CreateAppShortcutLauncherItemWithType(
440 const std::string& app_id,
442 ash::ShelfItemType shelf_item_type);
444 // Invoked when the associated browser or app is closed.
445 void LauncherItemClosed(ash::ShelfID id);
447 // Internal helpers for pinning and unpinning that handle both
448 // client-triggered and internal pinning operations.
449 void DoPinAppWithID(const std::string& app_id);
450 void DoUnpinAppWithID(const std::string& app_id);
452 // Pin a running app with |shelf_id| internally to |index|. It returns
453 // the index where the item was pinned.
454 int PinRunningAppInternal(int index, ash::ShelfID shelf_id);
456 // Unpin a locked application. This is an internal call which converts the
457 // model type of the given app index from a shortcut into an unpinned running
459 void UnpinRunningAppInternal(int index);
461 // Re-syncs shelf model with prefs::kPinnedLauncherApps.
462 void UpdateAppLaunchersFromPref();
464 // Persists the shelf auto-hide behavior to prefs.
465 void SetShelfAutoHideBehaviorPrefs(ash::ShelfAutoHideBehavior behavior,
466 aura::Window* root_window);
468 // Sets the shelf auto-hide behavior from prefs.
469 void SetShelfAutoHideBehaviorFromPrefs();
471 // Sets the shelf alignment from prefs.
472 void SetShelfAlignmentFromPrefs();
474 // Sets both of auto-hide behavior and alignment from prefs.
475 void SetShelfBehaviorsFromPrefs();
477 #if defined(OS_CHROMEOS)
478 // Sets whether the virtual keyboard is enabled from prefs.
479 void SetVirtualKeyboardBehaviorFromPrefs();
480 #endif // defined(OS_CHROMEOS)
482 // Returns the shelf item status for the given |app_id|, which can be either
483 // STATUS_ACTIVE (if the app is active), STATUS_RUNNING (if there is such an
484 // app) or STATUS_CLOSED.
485 ash::ShelfItemStatus GetAppState(const std::string& app_id);
487 // Creates an app launcher to insert at |index|. Note that |index| may be
488 // adjusted by the model to meet ordering constraints.
489 // The |shelf_item_type| will be set into the ShelfModel.
490 ash::ShelfID InsertAppLauncherItem(LauncherItemController* controller,
491 const std::string& app_id,
492 ash::ShelfItemStatus status,
494 ash::ShelfItemType shelf_item_type);
496 bool HasItemController(ash::ShelfID id) const;
498 // Enumerate all Web contents which match a given shortcut |controller|.
499 std::vector<content::WebContents*> GetV1ApplicationsFromController(
500 LauncherItemController* controller);
502 // Create ShelfItem for Browser Shortcut.
503 ash::ShelfID CreateBrowserShortcutLauncherItem();
505 // Check if the given |web_contents| is in incognito mode.
506 bool IsIncognito(const content::WebContents* web_contents) const;
508 // Update browser shortcut's index.
509 void PersistChromeItemIndex(int index);
511 // Get browser shortcut's index from pref.
512 int GetChromeIconIndexFromPref() const;
514 // Depending on the provided flags, move either the chrome icon, the app icon
515 // or none to the given |target_index|. The provided |chrome_index| and
516 // |app_list_index| locations will get adjusted within this call to finalize
517 // the action and to make sure that the other item can still be moved
518 // afterwards (index adjustments).
519 void MoveChromeOrApplistToFinalPosition(
524 int* app_list_index);
526 // Finds the index of where to insert the next item.
527 int FindInsertionPoint(bool is_app_list);
529 // Get the browser shortcut's index in the shelf using the current's systems
530 // configuration of pinned and known (but not running) apps.
531 int GetChromeIconIndexForCreation();
533 // Get the list of pinned programs from the preferences.
534 std::vector<std::string> GetListOfPinnedAppsAndBrowser();
536 // Close all windowed V1 applications of a certain extension which was already
538 void CloseWindowedAppsFromRemovedExtension(const std::string& app_id,
539 const Profile* profile);
541 // Set ShelfItemDelegate |item_delegate| for |id| and take an ownership.
542 // TODO(simon.hong81): Make this take a scoped_ptr of |item_delegate|.
543 void SetShelfItemDelegate(ash::ShelfID id,
544 ash::ShelfItemDelegate* item_delegate);
546 // Attach to a specific profile.
547 void AttachProfile(Profile* proifile);
549 // Forget the current profile to allow attaching to a new one.
550 void ReleaseProfile();
552 // Returns true if |app_id| is a Packaged App that has already launched on the
553 // native desktop and, if so, executes it as a desktop shortcut to activate
554 // desktop mode and send another OnLaunched event to the Extension.
555 bool LaunchedInNativeDesktop(const std::string& app_id);
557 static ChromeLauncherController* instance_;
559 ash::ShelfModel* model_;
561 ash::ShelfItemDelegateManager* item_delegate_manager_;
563 // Profile used for prefs and loading extensions. This is NOT necessarily the
564 // profile new windows are created with.
567 IDToItemControllerMap id_to_item_controller_map_;
569 // Direct access to app_id for a web contents.
570 WebContentsToAppIDMap web_contents_to_app_id_;
572 // Used to track app windows.
573 scoped_ptr<AppWindowLauncherController> app_window_controller_;
575 // Used to get app info for tabs.
576 scoped_ptr<AppTabHelper> app_tab_helper_;
578 // Used to load the image for an app item.
579 scoped_ptr<extensions::AppIconLoader> app_icon_loader_;
581 PrefChangeRegistrar pref_change_registrar_;
583 AppSyncUIState* app_sync_ui_state_;
585 scoped_ptr<ExtensionEnableFlow> extension_enable_flow_;
587 // Shelves that are currently being observed.
588 std::set<ash::Shelf*> shelves_;
590 // The owned browser status monitor.
591 scoped_ptr<BrowserStatusMonitor> browser_status_monitor_;
593 // A special observer class to detect user switches.
594 scoped_ptr<ChromeLauncherControllerUserSwitchObserver> user_switch_observer_;
596 // If true, incoming pinned state changes should be ignored.
597 bool ignore_persist_pinned_state_change_;
599 // True if each user has an own desktop.
600 bool multi_profile_desktop_separation_;
602 // The list of running & un-pinned applications for different users on hidden
604 typedef std::vector<std::string> RunningAppListIds;
605 typedef std::map<std::string, RunningAppListIds> RunningAppListIdMap;
606 RunningAppListIdMap last_used_running_application_order_;
608 DISALLOW_COPY_AND_ASSIGN(ChromeLauncherController);
611 #endif // CHROME_BROWSER_UI_ASH_LAUNCHER_CHROME_LAUNCHER_CONTROLLER_H_