apps/app_window.h

   1 // Copyright 2014 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.
   4
   5 #ifndef APPS_APP_WINDOW_H_
   6 #define APPS_APP_WINDOW_H_
   7
   8 #include "base/memory/scoped_ptr.h"
   9 #include "base/memory/weak_ptr.h"
  10 #include "chrome/browser/extensions/extension_icon_image.h"
  11 #include "chrome/browser/sessions/session_id.h"
  12 #include "components/web_modal/web_contents_modal_dialog_manager_delegate.h"
  13 #include "content/public/browser/notification_observer.h"
  14 #include "content/public/browser/notification_registrar.h"
  15 #include "content/public/browser/web_contents_delegate.h"
  16 #include "content/public/browser/web_contents_observer.h"
  17 #include "content/public/common/console_message_level.h"
  18 #include "ui/base/ui_base_types.h"  // WindowShowState
  19 #include "ui/gfx/image/image.h"
  20 #include "ui/gfx/rect.h"
  21
  22 class GURL;
  23 class SkRegion;
  24
  25 namespace base {
  26 class DictionaryValue;
  27 }
  28
  29 namespace content {
  30 class BrowserContext;
  31 class WebContents;
  32 }
  33
  34 namespace extensions {
  35 class Extension;
  36 class PlatformAppBrowserTest;
  37 class WindowController;
  38
  39 struct DraggableRegion;
  40 }
  41
  42 namespace ui {
  43 class BaseWindow;
  44 }
  45
  46 namespace apps {
  47
  48 class NativeAppWindow;
  49
  50 // Manages the web contents for app windows. The implementation for this
  51 // class should create and maintain the WebContents for the window, and handle
  52 // any message passing between the web contents and the extension system or
  53 // native window.
  54 class AppWindowContents {
  55  public:
  56   AppWindowContents() {}
  57   virtual ~AppWindowContents() {}
  58
  59   // Called to initialize the WebContents, before the app window is created.
  60   virtual void Initialize(content::BrowserContext* context,
  61                           const GURL& url) = 0;
  62
  63   // Called to load the contents, after the app window is created.
  64   virtual void LoadContents(int32 creator_process_id) = 0;
  65
  66   // Called when the native window changes.
  67   virtual void NativeWindowChanged(NativeAppWindow* native_app_window) = 0;
  68
  69   // Called when the native window closes.
  70   virtual void NativeWindowClosed() = 0;
  71
  72   virtual content::WebContents* GetWebContents() const = 0;
  73
  74  private:
  75   DISALLOW_COPY_AND_ASSIGN(AppWindowContents);
  76 };
  77
  78 // AppWindow is the type of window used by platform apps. App windows
  79 // have a WebContents but none of the chrome of normal browser windows.
  80 class AppWindow : public content::NotificationObserver,
  81                   public content::WebContentsDelegate,
  82                   public content::WebContentsObserver,
  83                   public web_modal::WebContentsModalDialogManagerDelegate,
  84                   public extensions::IconImage::Observer {
  85  public:
  86   enum WindowType {
  87     WINDOW_TYPE_DEFAULT = 1 << 0,   // Default app window.
  88     WINDOW_TYPE_PANEL = 1 << 1,     // OS controlled panel window (Ash only).
  89     WINDOW_TYPE_V1_PANEL = 1 << 2,  // For apps v1 support in Ash; deprecate
  90                                     // with v1 apps.
  91   };
  92
  93   enum Frame {
  94     FRAME_CHROME,  // Chrome-style window frame.
  95     FRAME_NONE,    // Frameless window.
  96   };
  97
  98   enum FullscreenType {
  99     // Not fullscreen.
 100     FULLSCREEN_TYPE_NONE = 0,
 101
 102     // Fullscreen entered by the app.window api.
 103     FULLSCREEN_TYPE_WINDOW_API = 1 << 0,
 104
 105     // Fullscreen entered by HTML requestFullscreen().
 106     FULLSCREEN_TYPE_HTML_API = 1 << 1,
 107
 108     // Fullscreen entered by the OS. ChromeOS uses this type of fullscreen to
 109     // enter immersive fullscreen when the user hits the <F4> key.
 110     FULLSCREEN_TYPE_OS = 1 << 2,
 111
 112     // Fullscreen mode that could not be exited by the user. ChromeOS uses
 113     // this type of fullscreen to run an app in kiosk mode.
 114     FULLSCREEN_TYPE_FORCED = 1 << 3,
 115   };
 116
 117   struct BoundsSpecification {
 118     // INT_MIN represents an unspecified position component.
 119     static const int kUnspecifiedPosition;
 120
 121     BoundsSpecification();
 122     ~BoundsSpecification();
 123
 124     // INT_MIN designates 'unspecified' for the position components, and 0
 125     // designates 'unspecified' for the size components. When unspecified,
 126     // they should be replaced with a default value.
 127     gfx::Rect bounds;
 128
 129     gfx::Size minimum_size;
 130     gfx::Size maximum_size;
 131
 132     // Reset the bounds fields to their 'unspecified' values. The minimum and
 133     // maximum size constraints remain unchanged.
 134     void ResetBounds();
 135   };
 136
 137   struct CreateParams {
 138     CreateParams();
 139     ~CreateParams();
 140
 141     WindowType window_type;
 142     Frame frame;
 143
 144     bool has_frame_color;
 145     SkColor active_frame_color;
 146     SkColor inactive_frame_color;
 147     bool transparent_background;  // Only supported on ash.
 148
 149     // The initial content/inner bounds specification (excluding any window
 150     // decorations).
 151     BoundsSpecification content_spec;
 152
 153     // The initial window/outer bounds specification (including window
 154     // decorations).
 155     BoundsSpecification window_spec;
 156
 157     std::string window_key;
 158
 159     // The process ID of the process that requested the create.
 160     int32 creator_process_id;
 161
 162     // Initial state of the window.
 163     ui::WindowShowState state;
 164
 165     // If true, don't show the window after creation.
 166     bool hidden;
 167
 168     // If true, the window will be resizable by the user. Defaults to true.
 169     bool resizable;
 170
 171     // If true, the window will be focused on creation. Defaults to true.
 172     bool focused;
 173
 174     // If true, the window will stay on top of other windows that are not
 175     // configured to be always on top. Defaults to false.
 176     bool always_on_top;
 177
 178     // The API enables developers to specify content or window bounds. This
 179     // function combines them into a single, constrained window size.
 180     gfx::Rect GetInitialWindowBounds(const gfx::Insets& frame_insets) const;
 181
 182     // The API enables developers to specify content or window size constraints.
 183     // These functions combine them so that we can work with one set of
 184     // constraints.
 185     gfx::Size GetContentMinimumSize(const gfx::Insets& frame_insets) const;
 186     gfx::Size GetContentMaximumSize(const gfx::Insets& frame_insets) const;
 187     gfx::Size GetWindowMinimumSize(const gfx::Insets& frame_insets) const;
 188     gfx::Size GetWindowMaximumSize(const gfx::Insets& frame_insets) const;
 189   };
 190
 191   class Delegate {
 192    public:
 193     virtual ~Delegate();
 194
 195     // General initialization.
 196     virtual void InitWebContents(content::WebContents* web_contents) = 0;
 197     virtual NativeAppWindow* CreateNativeAppWindow(
 198         AppWindow* window,
 199         const CreateParams& params) = 0;
 200
 201     // Link handling.
 202     virtual content::WebContents* OpenURLFromTab(
 203         content::BrowserContext* context,
 204         content::WebContents* source,
 205         const content::OpenURLParams& params) = 0;
 206     virtual void AddNewContents(content::BrowserContext* context,
 207                                 content::WebContents* new_contents,
 208                                 WindowOpenDisposition disposition,
 209                                 const gfx::Rect& initial_pos,
 210                                 bool user_gesture,
 211                                 bool* was_blocked) = 0;
 212
 213     // Feature support.
 214     virtual content::ColorChooser* ShowColorChooser(
 215         content::WebContents* web_contents,
 216         SkColor initial_color) = 0;
 217     virtual void RunFileChooser(content::WebContents* tab,
 218                                 const content::FileChooserParams& params) = 0;
 219     virtual void RequestMediaAccessPermission(
 220         content::WebContents* web_contents,
 221         const content::MediaStreamRequest& request,
 222         const content::MediaResponseCallback& callback,
 223         const extensions::Extension* extension) = 0;
 224     virtual int PreferredIconSize() = 0;
 225
 226     // Web contents modal dialog support.
 227     virtual void SetWebContentsBlocked(content::WebContents* web_contents,
 228                                        bool blocked) = 0;
 229     virtual bool IsWebContentsVisible(content::WebContents* web_contents) = 0;
 230   };
 231
 232   // Convert draggable regions in raw format to SkRegion format. Caller is
 233   // responsible for deleting the returned SkRegion instance.
 234   static SkRegion* RawDraggableRegionsToSkRegion(
 235       const std::vector<extensions::DraggableRegion>& regions);
 236
 237   // The constructor and Init methods are public for constructing a AppWindow
 238   // with a non-standard render interface (e.g. v1 apps using Ash Panels).
 239   // Normally AppWindow::Create should be used.
 240   // The constructed app window takes ownership of |delegate|.
 241   AppWindow(content::BrowserContext* context,
 242             Delegate* delegate,
 243             const extensions::Extension* extension);
 244
 245   // Initializes the render interface, web contents, and native window.
 246   // |app_window_contents| will become owned by AppWindow.
 247   void Init(const GURL& url,
 248             AppWindowContents* app_window_contents,
 249             const CreateParams& params);
 250
 251   const std::string& window_key() const { return window_key_; }
 252   const SessionID& session_id() const { return session_id_; }
 253   const std::string& extension_id() const { return extension_id_; }
 254   content::WebContents* web_contents() const;
 255   WindowType window_type() const { return window_type_; }
 256   bool window_type_is_panel() const {
 257     return (window_type_ == WINDOW_TYPE_PANEL ||
 258             window_type_ == WINDOW_TYPE_V1_PANEL);
 259   }
 260   content::BrowserContext* browser_context() const { return browser_context_; }
 261   const gfx::Image& app_icon() const { return app_icon_; }
 262   const GURL& app_icon_url() const { return app_icon_url_; }
 263   const gfx::Image& badge_icon() const { return badge_icon_; }
 264   const GURL& badge_icon_url() const { return badge_icon_url_; }
 265
 266   const extensions::Extension* GetExtension() const;
 267   NativeAppWindow* GetBaseWindow();
 268   gfx::NativeWindow GetNativeWindow();
 269
 270   // Returns the bounds that should be reported to the renderer.
 271   gfx::Rect GetClientBounds() const;
 272
 273   // NativeAppWindows should call this to determine what the window's title
 274   // is on startup and from within UpdateWindowTitle().
 275   base::string16 GetTitle() const;
 276
 277   // Call to notify ShellRegistry and delete the window. Subclasses should
 278   // invoke this method instead of using "delete this".
 279   void OnNativeClose();
 280
 281   // Should be called by native implementations when the window size, position,
 282   // or minimized/maximized state has changed.
 283   void OnNativeWindowChanged();
 284
 285   // Should be called by native implementations when the window is activated.
 286   void OnNativeWindowActivated();
 287
 288   // Specifies a url for the launcher icon.
 289   void SetAppIconUrl(const GURL& icon_url);
 290
 291   // Specifies a url for the window badge.
 292   void SetBadgeIconUrl(const GURL& icon_url);
 293
 294   // Clear the current badge.
 295   void ClearBadge();
 296
 297   // Set the window shape. Passing a NULL |region| sets the default shape.
 298   void UpdateShape(scoped_ptr<SkRegion> region);
 299
 300   // Called from the render interface to modify the draggable regions.
 301   void UpdateDraggableRegions(
 302       const std::vector<extensions::DraggableRegion>& regions);
 303
 304   // Updates the app image to |image|. Called internally from the image loader
 305   // callback. Also called externally for v1 apps using Ash Panels.
 306   void UpdateAppIcon(const gfx::Image& image);
 307
 308   // Transitions window into fullscreen, maximized, minimized or restores based
 309   // on chrome.app.window API.
 310   void Fullscreen();
 311   void Maximize();
 312   void Minimize();
 313   void Restore();
 314
 315   // Transitions to OS fullscreen. See FULLSCREEN_TYPE_OS for more details.
 316   void OSFullscreen();
 317
 318   // Transitions to forced fullscreen. See FULLSCREEN_TYPE_FORCED for more
 319   // details.
 320   void ForcedFullscreen();
 321
 322   // Set the minimum and maximum size of the content bounds.
 323   void SetContentSizeConstraints(const gfx::Size& min_size,
 324                                  const gfx::Size& max_size);
 325
 326   enum ShowType { SHOW_ACTIVE, SHOW_INACTIVE };
 327
 328   // Shows the window if its contents have been painted; otherwise flags the
 329   // window to be shown as soon as its contents are painted for the first time.
 330   void Show(ShowType show_type);
 331
 332   // Hides the window. If the window was previously flagged to be shown on
 333   // first paint, it will be unflagged.
 334   void Hide();
 335
 336   AppWindowContents* app_window_contents_for_test() {
 337     return app_window_contents_.get();
 338   }
 339
 340   // Set whether the window should stay above other windows which are not
 341   // configured to be always-on-top.
 342   void SetAlwaysOnTop(bool always_on_top);
 343
 344   // Whether the always-on-top property has been set by the chrome.app.window
 345   // API. Note that the actual value of this property in the native app window
 346   // may be false if the bit is silently switched off for security reasons.
 347   bool IsAlwaysOnTop() const;
 348
 349   // Retrieve the current state of the app window as a dictionary, to pass to
 350   // the renderer.
 351   void GetSerializedState(base::DictionaryValue* properties) const;
 352
 353  protected:
 354   virtual ~AppWindow();
 355
 356  private:
 357   // PlatformAppBrowserTest needs access to web_contents()
 358   friend class extensions::PlatformAppBrowserTest;
 359
 360   // content::WebContentsDelegate implementation.
 361   virtual void CloseContents(content::WebContents* contents) OVERRIDE;
 362   virtual bool ShouldSuppressDialogs() OVERRIDE;
 363   virtual content::ColorChooser* OpenColorChooser(
 364       content::WebContents* web_contents,
 365       SkColor color,
 366       const std::vector<content::ColorSuggestion>& suggestions) OVERRIDE;
 367   virtual void RunFileChooser(content::WebContents* tab,
 368                               const content::FileChooserParams& params)
 369       OVERRIDE;
 370   virtual bool IsPopupOrPanel(const content::WebContents* source)
 371       const OVERRIDE;
 372   virtual void MoveContents(content::WebContents* source,
 373                             const gfx::Rect& pos) OVERRIDE;
 374   virtual void NavigationStateChanged(const content::WebContents* source,
 375                                       unsigned changed_flags) OVERRIDE;
 376   virtual void ToggleFullscreenModeForTab(content::WebContents* source,
 377                                           bool enter_fullscreen) OVERRIDE;
 378   virtual bool IsFullscreenForTabOrPending(const content::WebContents* source)
 379       const OVERRIDE;
 380   virtual void RequestMediaAccessPermission(
 381       content::WebContents* web_contents,
 382       const content::MediaStreamRequest& request,
 383       const content::MediaResponseCallback& callback) OVERRIDE;
 384   virtual content::WebContents* OpenURLFromTab(
 385       content::WebContents* source,
 386       const content::OpenURLParams& params) OVERRIDE;
 387   virtual void AddNewContents(content::WebContents* source,
 388                               content::WebContents* new_contents,
 389                               WindowOpenDisposition disposition,
 390                               const gfx::Rect& initial_pos,
 391                               bool user_gesture,
 392                               bool* was_blocked) OVERRIDE;
 393   virtual bool PreHandleKeyboardEvent(
 394       content::WebContents* source,
 395       const content::NativeWebKeyboardEvent& event,
 396       bool* is_keyboard_shortcut) OVERRIDE;
 397   virtual void HandleKeyboardEvent(content::WebContents* source,
 398                                    const content::NativeWebKeyboardEvent& event)
 399       OVERRIDE;
 400   virtual void RequestToLockMouse(content::WebContents* web_contents,
 401                                   bool user_gesture,
 402                                   bool last_unlocked_by_target) OVERRIDE;
 403   virtual bool PreHandleGestureEvent(content::WebContents* source,
 404                                      const blink::WebGestureEvent& event)
 405       OVERRIDE;
 406
 407   // content::WebContentsObserver implementation.
 408   virtual void DidFirstVisuallyNonEmptyPaint() OVERRIDE;
 409
 410   // content::NotificationObserver implementation.
 411   virtual void Observe(int type,
 412                        const content::NotificationSource& source,
 413                        const content::NotificationDetails& details) OVERRIDE;
 414
 415   // web_modal::WebContentsModalDialogManagerDelegate implementation.
 416   virtual void SetWebContentsBlocked(content::WebContents* web_contents,
 417                                      bool blocked) OVERRIDE;
 418   virtual bool IsWebContentsVisible(content::WebContents* web_contents)
 419       OVERRIDE;
 420
 421   // Helper method to add a message to the renderer's DevTools console.
 422   void AddMessageToDevToolsConsole(content::ConsoleMessageLevel level,
 423                                    const std::string& message);
 424
 425   // Saves the window geometry/position/screen bounds.
 426   void SaveWindowPosition();
 427
 428   // Helper method to adjust the cached bounds so that we can make sure it can
 429   // be visible on the screen. See http://crbug.com/145752.
 430   void AdjustBoundsToBeVisibleOnScreen(const gfx::Rect& cached_bounds,
 431                                        const gfx::Rect& cached_screen_bounds,
 432                                        const gfx::Rect& current_screen_bounds,
 433                                        const gfx::Size& minimum_size,
 434                                        gfx::Rect* bounds) const;
 435
 436   // Loads the appropriate default or cached window bounds. Returns a new
 437   // CreateParams that should be used to create the window.
 438   CreateParams LoadDefaults(CreateParams params) const;
 439
 440   // Load the app's image, firing a load state change when loaded.
 441   void UpdateExtensionAppIcon();
 442
 443   // Set the fullscreen state in the native app window.
 444   void SetNativeWindowFullscreen();
 445
 446   // Returns true if there is any overlap between the window and the taskbar
 447   // (Windows only).
 448   bool IntersectsWithTaskbar() const;
 449
 450   // Update the always-on-top bit in the native app window.
 451   void UpdateNativeAlwaysOnTop();
 452
 453   // web_modal::WebContentsModalDialogManagerDelegate implementation.
 454   virtual web_modal::WebContentsModalDialogHost* GetWebContentsModalDialogHost()
 455       OVERRIDE;
 456
 457   // Updates the badge to |image|. Called internally from the image loader
 458   // callback.
 459   void UpdateBadgeIcon(const gfx::Image& image);
 460
 461   // Callback from web_contents()->DownloadFavicon.
 462   void DidDownloadFavicon(int id,
 463                           int http_status_code,
 464                           const GURL& image_url,
 465                           const std::vector<SkBitmap>& bitmaps,
 466                           const std::vector<gfx::Size>& original_bitmap_sizes);
 467
 468   // extensions::IconImage::Observer implementation.
 469   virtual void OnExtensionIconImageChanged(extensions::IconImage* image)
 470       OVERRIDE;
 471
 472   // The browser context with which this window is associated. AppWindow does
 473   // not own this object.
 474   content::BrowserContext* browser_context_;
 475
 476   const std::string extension_id_;
 477
 478   // Identifier that is used when saving and restoring geometry for this
 479   // window.
 480   std::string window_key_;
 481
 482   const SessionID session_id_;
 483   WindowType window_type_;
 484   content::NotificationRegistrar registrar_;
 485
 486   // Icon shown in the task bar.
 487   gfx::Image app_icon_;
 488
 489   // Icon URL to be used for setting the app icon. If not empty, app_icon_ will
 490   // be fetched and set using this URL.
 491   GURL app_icon_url_;
 492
 493   // An object to load the app's icon as an extension resource.
 494   scoped_ptr<extensions::IconImage> app_icon_image_;
 495
 496   // Badge for icon shown in the task bar.
 497   gfx::Image badge_icon_;
 498
 499   // URL to be used for setting the badge on the app icon.
 500   GURL badge_icon_url_;
 501
 502   // An object to load the badge as an extension resource.
 503   scoped_ptr<extensions::IconImage> badge_icon_image_;
 504
 505   scoped_ptr<NativeAppWindow> native_app_window_;
 506   scoped_ptr<AppWindowContents> app_window_contents_;
 507   scoped_ptr<Delegate> delegate_;
 508
 509   base::WeakPtrFactory<AppWindow> image_loader_ptr_factory_;
 510
 511   // Bit field of FullscreenType.
 512   int fullscreen_types_;
 513
 514   // Show has been called, so the window should be shown once the first visually
 515   // non-empty paint occurs.
 516   bool show_on_first_paint_;
 517
 518   // The first visually non-empty paint has completed.
 519   bool first_paint_complete_;
 520
 521   // Whether the delayed Show() call was for an active or inactive window.
 522   ShowType delayed_show_type_;
 523
 524   // Cache the desired value of the always-on-top property. When windows enter
 525   // fullscreen or overlap the Windows taskbar, this property will be
 526   // automatically and silently switched off for security reasons. It is
 527   // reinstated when the window exits fullscreen and moves away from the
 528   // taskbar.
 529   bool cached_always_on_top_;
 530
 531   DISALLOW_COPY_AND_ASSIGN(AppWindow);
 532 };
 533
 534 }  // namespace apps
 535
 536 #endif  // APPS_APP_WINDOW_H_