Home | History | Annotate | Download | only in web_contents
      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.
      4 
      5 #ifndef CONTENT_BROWSER_WEB_CONTENTS_WEB_CONTENTS_IMPL_H_
      6 #define CONTENT_BROWSER_WEB_CONTENTS_WEB_CONTENTS_IMPL_H_
      7 
      8 #include <map>
      9 #include <set>
     10 #include <string>
     11 
     12 #include "base/compiler_specific.h"
     13 #include "base/gtest_prod_util.h"
     14 #include "base/memory/scoped_ptr.h"
     15 #include "base/observer_list.h"
     16 #include "base/process/process.h"
     17 #include "base/values.h"
     18 #include "content/browser/renderer_host/render_view_host_delegate.h"
     19 #include "content/browser/renderer_host/render_widget_host_delegate.h"
     20 #include "content/browser/web_contents/frame_tree_node.h"
     21 #include "content/browser/web_contents/navigation_controller_impl.h"
     22 #include "content/browser/web_contents/render_view_host_manager.h"
     23 #include "content/common/content_export.h"
     24 #include "content/public/browser/notification_observer.h"
     25 #include "content/public/browser/notification_registrar.h"
     26 #include "content/public/browser/web_contents.h"
     27 #include "content/public/common/renderer_preferences.h"
     28 #include "content/public/common/three_d_api_types.h"
     29 #include "net/base/load_states.h"
     30 #include "third_party/WebKit/public/web/WebDragOperation.h"
     31 #include "ui/gfx/rect_f.h"
     32 #include "ui/gfx/size.h"
     33 #include "ui/gfx/vector2d.h"
     34 #include "webkit/common/resource_type.h"
     35 
     36 struct BrowserPluginHostMsg_ResizeGuest_Params;
     37 struct ViewHostMsg_DateTimeDialogValue_Params;
     38 struct ViewMsg_PostMessage_Params;
     39 
     40 namespace content {
     41 class BrowserPluginEmbedder;
     42 class BrowserPluginGuest;
     43 class BrowserPluginGuestManager;
     44 class ColorChooser;
     45 class DateTimeChooserAndroid;
     46 class DownloadItem;
     47 class InterstitialPageImpl;
     48 class JavaBridgeDispatcherHostManager;
     49 class JavaScriptDialogManager;
     50 class PowerSaveBlocker;
     51 class RenderViewHost;
     52 class RenderViewHostDelegateView;
     53 class RenderViewHostImpl;
     54 class RenderWidgetHostImpl;
     55 class RenderWidgetHostViewPort;
     56 class SavePackage;
     57 class SessionStorageNamespaceImpl;
     58 class SiteInstance;
     59 class TestWebContents;
     60 class WebContentsDelegate;
     61 class WebContentsImpl;
     62 class WebContentsObserver;
     63 class WebContentsViewPort;
     64 class WebContentsViewDelegate;
     65 struct FaviconURL;
     66 struct LoadNotificationDetails;
     67 
     68 // Factory function for the implementations that content knows about. Takes
     69 // ownership of |delegate|.
     70 WebContentsViewPort* CreateWebContentsView(
     71     WebContentsImpl* web_contents,
     72     WebContentsViewDelegate* delegate,
     73     RenderViewHostDelegateView** render_view_host_delegate_view);
     74 
     75 class CONTENT_EXPORT WebContentsImpl
     76     : public NON_EXPORTED_BASE(WebContents),
     77       public RenderViewHostDelegate,
     78       public RenderWidgetHostDelegate,
     79       public RenderViewHostManager::Delegate,
     80       public NotificationObserver {
     81  public:
     82   virtual ~WebContentsImpl();
     83 
     84   static WebContentsImpl* CreateWithOpener(
     85       const WebContents::CreateParams& params,
     86       WebContentsImpl* opener);
     87 
     88   // Returns the opener WebContentsImpl, if any. This can be set to null if the
     89   // opener is closed or the page clears its window.opener.
     90   WebContentsImpl* opener() const { return opener_; }
     91 
     92   // Creates a WebContents to be used as a browser plugin guest.
     93   static BrowserPluginGuest* CreateGuest(
     94       BrowserContext* browser_context,
     95       content::SiteInstance* site_instance,
     96       int guest_instance_id,
     97       scoped_ptr<base::DictionaryValue> extra_params);
     98 
     99   // Returns the content specific prefs for the given RVH.
    100   static WebPreferences GetWebkitPrefs(
    101       RenderViewHost* rvh, const GURL& url);
    102 
    103   // Creates a swapped out RenderView. This is used by the browser plugin to
    104   // create a swapped out RenderView in the embedder render process for the
    105   // guest, to expose the guest's window object to the embedder.
    106   // This returns the routing ID of the newly created swapped out RenderView.
    107   int CreateSwappedOutRenderView(SiteInstance* instance);
    108 
    109   // Complex initialization here. Specifically needed to avoid having
    110   // members call back into our virtual functions in the constructor.
    111   virtual void Init(const WebContents::CreateParams& params);
    112 
    113   // Returns the SavePackage which manages the page saving job. May be NULL.
    114   SavePackage* save_package() const { return save_package_.get(); }
    115 
    116   // Updates the max page ID for the current SiteInstance in this
    117   // WebContentsImpl to be at least |page_id|.
    118   void UpdateMaxPageID(int32 page_id);
    119 
    120   // Updates the max page ID for the given SiteInstance in this WebContentsImpl
    121   // to be at least |page_id|.
    122   void UpdateMaxPageIDForSiteInstance(SiteInstance* site_instance,
    123                                       int32 page_id);
    124 
    125   // Copy the current map of SiteInstance ID to max page ID from another tab.
    126   // This is necessary when this tab adopts the NavigationEntries from
    127   // |web_contents|.
    128   void CopyMaxPageIDsFrom(WebContentsImpl* web_contents);
    129 
    130   // Called by the NavigationController to cause the WebContentsImpl to navigate
    131   // to the current pending entry. The NavigationController should be called
    132   // back with RendererDidNavigate on success or DiscardPendingEntry on failure.
    133   // The callbacks can be inside of this function, or at some future time.
    134   //
    135   // The entry has a PageID of -1 if newly created (corresponding to navigation
    136   // to a new URL).
    137   //
    138   // If this method returns false, then the navigation is discarded (equivalent
    139   // to calling DiscardPendingEntry on the NavigationController).
    140   bool NavigateToPendingEntry(NavigationController::ReloadType reload_type);
    141 
    142   // Called by InterstitialPageImpl when it creates a RenderViewHost.
    143   void RenderViewForInterstitialPageCreated(RenderViewHost* render_view_host);
    144 
    145   // Sets the passed interstitial as the currently showing interstitial.
    146   // No interstitial page should already be attached.
    147   void AttachInterstitialPage(InterstitialPageImpl* interstitial_page);
    148 
    149   // Unsets the currently showing interstitial.
    150   void DetachInterstitialPage();
    151 
    152 #if defined(OS_ANDROID)
    153   JavaBridgeDispatcherHostManager* java_bridge_dispatcher_host_manager() const {
    154     return java_bridge_dispatcher_host_manager_.get();
    155   }
    156 
    157   // In Android WebView, the RenderView needs created even there is no
    158   // navigation entry, this allows Android WebViews to use
    159   // javascript: URLs that load into the DOMWindow before the first page
    160   // load. This is not safe to do in any context that a web page could get a
    161   // reference to the DOMWindow before the first page load.
    162   bool CreateRenderViewForInitialEmptyDocument();
    163 #endif
    164 
    165   // Expose the render manager for testing.
    166   RenderViewHostManager* GetRenderManagerForTesting();
    167 
    168   // Returns guest browser plugin object, or NULL if this WebContents is not a
    169   // guest.
    170   BrowserPluginGuest* GetBrowserPluginGuest() const;
    171 
    172   // Sets a BrowserPluginGuest object for this WebContents. If this WebContents
    173   // has a BrowserPluginGuest then that implies that it is being hosted by
    174   // a BrowserPlugin object in an embedder renderer process.
    175   void SetBrowserPluginGuest(BrowserPluginGuest* guest);
    176 
    177   // Returns embedder browser plugin object, or NULL if this WebContents is not
    178   // an embedder.
    179   BrowserPluginEmbedder* GetBrowserPluginEmbedder() const;
    180 
    181   // Returns the BrowserPluginGuestManager object, or NULL if this web contents
    182   // does not have a BrowserPluginGuestManager.
    183   BrowserPluginGuestManager* GetBrowserPluginGuestManager() const;
    184 
    185   // Gets the current fullscreen render widget's routing ID. Returns
    186   // MSG_ROUTING_NONE when there is no fullscreen render widget.
    187   int GetFullscreenWidgetRoutingID() const;
    188 
    189   // Invoked when visible SSL state (as defined by SSLStatus) changes.
    190   void DidChangeVisibleSSLState();
    191 
    192   // Invoked before a form repost warning is shown.
    193   void NotifyBeforeFormRepostWarningShow();
    194 
    195 
    196   // Informs the render view host and the BrowserPluginEmbedder, if present, of
    197   // a Drag Source End.
    198   void DragSourceEndedAt(int client_x, int client_y, int screen_x,
    199       int screen_y, WebKit::WebDragOperation operation);
    200 
    201   // Informs the render view host and the BrowserPluginEmbedder, if present, of
    202   // a Drag Source Move.
    203   void DragSourceMovedTo(int client_x, int client_y,
    204                          int screen_x, int screen_y);
    205 
    206   FrameTreeNode* GetFrameTreeRootForTesting() {
    207     return frame_tree_root_.get();
    208   }
    209 
    210   // WebContents ------------------------------------------------------
    211   virtual WebContentsDelegate* GetDelegate() OVERRIDE;
    212   virtual void SetDelegate(WebContentsDelegate* delegate) OVERRIDE;
    213   virtual NavigationControllerImpl& GetController() OVERRIDE;
    214   virtual const NavigationControllerImpl& GetController() const OVERRIDE;
    215   virtual BrowserContext* GetBrowserContext() const OVERRIDE;
    216   virtual RenderProcessHost* GetRenderProcessHost() const OVERRIDE;
    217   virtual RenderViewHost* GetRenderViewHost() const OVERRIDE;
    218   virtual void GetRenderViewHostAtPosition(
    219       int x,
    220       int y,
    221       const GetRenderViewHostCallback& callback) OVERRIDE;
    222   virtual WebContents* GetEmbedderWebContents() const OVERRIDE;
    223   virtual int GetEmbeddedInstanceID() const OVERRIDE;
    224   virtual int GetRoutingID() const OVERRIDE;
    225   virtual RenderWidgetHostView* GetRenderWidgetHostView() const OVERRIDE;
    226   virtual WebContentsView* GetView() const OVERRIDE;
    227   virtual WebUI* CreateWebUI(const GURL& url) OVERRIDE;
    228   virtual WebUI* GetWebUI() const OVERRIDE;
    229   virtual WebUI* GetCommittedWebUI() const OVERRIDE;
    230   virtual void SetUserAgentOverride(const std::string& override) OVERRIDE;
    231   virtual const std::string& GetUserAgentOverride() const OVERRIDE;
    232 #if defined(OS_WIN) && defined(USE_AURA)
    233   virtual void SetParentNativeViewAccessible(
    234       gfx::NativeViewAccessible accessible_parent) OVERRIDE;
    235 #endif
    236   virtual const string16& GetTitle() const OVERRIDE;
    237   virtual int32 GetMaxPageID() OVERRIDE;
    238   virtual int32 GetMaxPageIDForSiteInstance(
    239       SiteInstance* site_instance) OVERRIDE;
    240   virtual SiteInstance* GetSiteInstance() const OVERRIDE;
    241   virtual SiteInstance* GetPendingSiteInstance() const OVERRIDE;
    242   virtual bool IsLoading() const OVERRIDE;
    243   virtual bool IsWaitingForResponse() const OVERRIDE;
    244   virtual const net::LoadStateWithParam& GetLoadState() const OVERRIDE;
    245   virtual const string16& GetLoadStateHost() const OVERRIDE;
    246   virtual uint64 GetUploadSize() const OVERRIDE;
    247   virtual uint64 GetUploadPosition() const OVERRIDE;
    248   virtual std::set<GURL> GetSitesInTab() const OVERRIDE;
    249   virtual const std::string& GetEncoding() const OVERRIDE;
    250   virtual bool DisplayedInsecureContent() const OVERRIDE;
    251   virtual void IncrementCapturerCount() OVERRIDE;
    252   virtual void DecrementCapturerCount() OVERRIDE;
    253   virtual int GetCapturerCount() const OVERRIDE;
    254   virtual bool IsCrashed() const OVERRIDE;
    255   virtual void SetIsCrashed(base::TerminationStatus status,
    256                             int error_code) OVERRIDE;
    257   virtual base::TerminationStatus GetCrashedStatus() const OVERRIDE;
    258   virtual bool IsBeingDestroyed() const OVERRIDE;
    259   virtual void NotifyNavigationStateChanged(unsigned changed_flags) OVERRIDE;
    260   virtual base::TimeTicks GetLastSelectedTime() const OVERRIDE;
    261   virtual void WasShown() OVERRIDE;
    262   virtual void WasHidden() OVERRIDE;
    263   virtual bool NeedToFireBeforeUnload() OVERRIDE;
    264   virtual void Stop() OVERRIDE;
    265   virtual WebContents* Clone() OVERRIDE;
    266   virtual void FocusThroughTabTraversal(bool reverse) OVERRIDE;
    267   virtual bool ShowingInterstitialPage() const OVERRIDE;
    268   virtual InterstitialPage* GetInterstitialPage() const OVERRIDE;
    269   virtual bool IsSavable() OVERRIDE;
    270   virtual void OnSavePage() OVERRIDE;
    271   virtual bool SavePage(const base::FilePath& main_file,
    272                         const base::FilePath& dir_path,
    273                         SavePageType save_type) OVERRIDE;
    274   virtual void SaveFrame(const GURL& url,
    275                          const Referrer& referrer) OVERRIDE;
    276   virtual void GenerateMHTML(
    277       const base::FilePath& file,
    278       const base::Callback<void(const base::FilePath&, int64)>& callback)
    279           OVERRIDE;
    280   virtual bool IsActiveEntry(int32 page_id) OVERRIDE;
    281 
    282   virtual const std::string& GetContentsMimeType() const OVERRIDE;
    283   virtual bool WillNotifyDisconnection() const OVERRIDE;
    284   virtual void SetOverrideEncoding(const std::string& encoding) OVERRIDE;
    285   virtual void ResetOverrideEncoding() OVERRIDE;
    286   virtual RendererPreferences* GetMutableRendererPrefs() OVERRIDE;
    287   virtual void Close() OVERRIDE;
    288   virtual void SystemDragEnded() OVERRIDE;
    289   virtual void UserGestureDone() OVERRIDE;
    290   virtual void SetClosedByUserGesture(bool value) OVERRIDE;
    291   virtual bool GetClosedByUserGesture() const OVERRIDE;
    292   virtual double GetZoomLevel() const OVERRIDE;
    293   virtual int GetZoomPercent(bool* enable_increment,
    294                              bool* enable_decrement) const OVERRIDE;
    295   virtual void ViewSource() OVERRIDE;
    296   virtual void ViewFrameSource(const GURL& url,
    297                                const PageState& page_state) OVERRIDE;
    298   virtual int GetMinimumZoomPercent() const OVERRIDE;
    299   virtual int GetMaximumZoomPercent() const OVERRIDE;
    300   virtual gfx::Size GetPreferredSize() const OVERRIDE;
    301   virtual bool GotResponseToLockMouseRequest(bool allowed) OVERRIDE;
    302   virtual bool HasOpener() const OVERRIDE;
    303   virtual void DidChooseColorInColorChooser(SkColor color) OVERRIDE;
    304   virtual void DidEndColorChooser() OVERRIDE;
    305   virtual int DownloadImage(const GURL& url,
    306                             bool is_favicon,
    307                             uint32_t preferred_image_size,
    308                             uint32_t max_image_size,
    309                             const ImageDownloadCallback& callback) OVERRIDE;
    310 
    311   // Implementation of PageNavigator.
    312   virtual WebContents* OpenURL(const OpenURLParams& params) OVERRIDE;
    313 
    314   // Implementation of IPC::Sender.
    315   virtual bool Send(IPC::Message* message) OVERRIDE;
    316 
    317   // RenderViewHostDelegate ----------------------------------------------------
    318 
    319   virtual RenderViewHostDelegateView* GetDelegateView() OVERRIDE;
    320   virtual RenderViewHostDelegate::RendererManagement*
    321       GetRendererManagementDelegate() OVERRIDE;
    322   virtual bool OnMessageReceived(RenderViewHost* render_view_host,
    323                                  const IPC::Message& message) OVERRIDE;
    324   virtual const GURL& GetURL() const OVERRIDE;
    325   virtual const GURL& GetVisibleURL() const OVERRIDE;
    326   virtual const GURL& GetLastCommittedURL() const OVERRIDE;
    327   virtual WebContents* GetAsWebContents() OVERRIDE;
    328   virtual gfx::Rect GetRootWindowResizerRect() const OVERRIDE;
    329   virtual void RenderViewCreated(RenderViewHost* render_view_host) OVERRIDE;
    330   virtual void RenderViewReady(RenderViewHost* render_view_host) OVERRIDE;
    331   virtual void RenderViewTerminated(RenderViewHost* render_view_host,
    332                                     base::TerminationStatus status,
    333                                     int error_code) OVERRIDE;
    334   virtual void RenderViewDeleted(RenderViewHost* render_view_host) OVERRIDE;
    335   virtual void DidStartProvisionalLoadForFrame(
    336       RenderViewHost* render_view_host,
    337       int64 frame_id,
    338       int64 parent_frame_id,
    339       bool main_frame,
    340       const GURL& url) OVERRIDE;
    341   virtual void DidRedirectProvisionalLoad(
    342       RenderViewHost* render_view_host,
    343       int32 page_id,
    344       const GURL& source_url,
    345       const GURL& target_url) OVERRIDE;
    346   virtual void DidFailProvisionalLoadWithError(
    347       RenderViewHost* render_view_host,
    348       const ViewHostMsg_DidFailProvisionalLoadWithError_Params& params)
    349           OVERRIDE;
    350   virtual void DidNavigate(
    351       RenderViewHost* render_view_host,
    352       const ViewHostMsg_FrameNavigate_Params& params) OVERRIDE;
    353   virtual void UpdateState(RenderViewHost* render_view_host,
    354                            int32 page_id,
    355                            const PageState& page_state) OVERRIDE;
    356   virtual void UpdateTitle(RenderViewHost* render_view_host,
    357                            int32 page_id,
    358                            const string16& title,
    359                            base::i18n::TextDirection title_direction) OVERRIDE;
    360   virtual void UpdateEncoding(RenderViewHost* render_view_host,
    361                               const std::string& encoding) OVERRIDE;
    362   virtual void UpdateTargetURL(int32 page_id, const GURL& url) OVERRIDE;
    363   virtual void Close(RenderViewHost* render_view_host) OVERRIDE;
    364   virtual void RequestMove(const gfx::Rect& new_bounds) OVERRIDE;
    365   virtual void SwappedOut(RenderViewHost* render_view_host) OVERRIDE;
    366   virtual void DidStartLoading(RenderViewHost* render_view_host) OVERRIDE;
    367   virtual void DidStopLoading(RenderViewHost* render_view_host) OVERRIDE;
    368   virtual void DidCancelLoading() OVERRIDE;
    369   virtual void DidChangeLoadProgress(double progress) OVERRIDE;
    370   virtual void DidDisownOpener(RenderViewHost* rvh) OVERRIDE;
    371   virtual void DidAccessInitialDocument() OVERRIDE;
    372   virtual void DocumentAvailableInMainFrame(
    373       RenderViewHost* render_view_host) OVERRIDE;
    374   virtual void DocumentOnLoadCompletedInMainFrame(
    375       RenderViewHost* render_view_host,
    376       int32 page_id) OVERRIDE;
    377   virtual void RequestOpenURL(RenderViewHost* rvh,
    378                               const GURL& url,
    379                               const Referrer& referrer,
    380                               WindowOpenDisposition disposition,
    381                               int64 source_frame_id,
    382                               bool should_replace_current_entry,
    383                               bool user_gesture) OVERRIDE;
    384   virtual void RequestTransferURL(
    385       const GURL& url,
    386       const Referrer& referrer,
    387       WindowOpenDisposition disposition,
    388       int64 source_frame_id,
    389       const GlobalRequestID& transferred_global_request_id,
    390       bool should_replace_current_entry,
    391       bool user_gesture) OVERRIDE;
    392   virtual void RouteCloseEvent(RenderViewHost* rvh) OVERRIDE;
    393   virtual void RouteMessageEvent(
    394       RenderViewHost* rvh,
    395       const ViewMsg_PostMessage_Params& params) OVERRIDE;
    396   virtual void RunJavaScriptMessage(RenderViewHost* rvh,
    397                                     const string16& message,
    398                                     const string16& default_prompt,
    399                                     const GURL& frame_url,
    400                                     JavaScriptMessageType type,
    401                                     IPC::Message* reply_msg,
    402                                     bool* did_suppress_message) OVERRIDE;
    403   virtual void RunBeforeUnloadConfirm(RenderViewHost* rvh,
    404                                       const string16& message,
    405                                       bool is_reload,
    406                                       IPC::Message* reply_msg) OVERRIDE;
    407   virtual bool AddMessageToConsole(int32 level,
    408                                    const string16& message,
    409                                    int32 line_no,
    410                                    const string16& source_id) OVERRIDE;
    411   virtual RendererPreferences GetRendererPrefs(
    412       BrowserContext* browser_context) const OVERRIDE;
    413   virtual WebPreferences GetWebkitPrefs() OVERRIDE;
    414   virtual void OnUserGesture() OVERRIDE;
    415   virtual void OnIgnoredUIEvent() OVERRIDE;
    416   virtual void RendererUnresponsive(RenderViewHost* render_view_host,
    417                                     bool is_during_unload) OVERRIDE;
    418   virtual void RendererResponsive(RenderViewHost* render_view_host) OVERRIDE;
    419   virtual void LoadStateChanged(const GURL& url,
    420                                 const net::LoadStateWithParam& load_state,
    421                                 uint64 upload_position,
    422                                 uint64 upload_size) OVERRIDE;
    423   virtual void WorkerCrashed() OVERRIDE;
    424   virtual void Activate() OVERRIDE;
    425   virtual void Deactivate() OVERRIDE;
    426   virtual void LostCapture() OVERRIDE;
    427   virtual void HandleMouseDown() OVERRIDE;
    428   virtual void HandleMouseUp() OVERRIDE;
    429   virtual void HandlePointerActivate() OVERRIDE;
    430   virtual void HandleGestureBegin() OVERRIDE;
    431   virtual void HandleGestureEnd() OVERRIDE;
    432   virtual void RunFileChooser(
    433       RenderViewHost* render_view_host,
    434       const FileChooserParams& params) OVERRIDE;
    435   virtual void ToggleFullscreenMode(bool enter_fullscreen) OVERRIDE;
    436   virtual bool IsFullscreenForCurrentTab() const OVERRIDE;
    437   virtual void UpdatePreferredSize(const gfx::Size& pref_size) OVERRIDE;
    438   virtual void ResizeDueToAutoResize(const gfx::Size& new_size) OVERRIDE;
    439   virtual void RequestToLockMouse(bool user_gesture,
    440                                   bool last_unlocked_by_target) OVERRIDE;
    441   virtual void LostMouseLock() OVERRIDE;
    442   virtual void CreateNewWindow(
    443       int route_id,
    444       int main_frame_route_id,
    445       const ViewHostMsg_CreateWindow_Params& params,
    446       SessionStorageNamespace* session_storage_namespace) OVERRIDE;
    447   virtual void CreateNewWidget(int route_id,
    448                                WebKit::WebPopupType popup_type) OVERRIDE;
    449   virtual void CreateNewFullscreenWidget(int route_id) OVERRIDE;
    450   virtual void ShowCreatedWindow(int route_id,
    451                                  WindowOpenDisposition disposition,
    452                                  const gfx::Rect& initial_pos,
    453                                  bool user_gesture) OVERRIDE;
    454   virtual void ShowCreatedWidget(int route_id,
    455                                  const gfx::Rect& initial_pos) OVERRIDE;
    456   virtual void ShowCreatedFullscreenWidget(int route_id) OVERRIDE;
    457   virtual void ShowContextMenu(const ContextMenuParams& params) OVERRIDE;
    458   virtual void RequestMediaAccessPermission(
    459       const MediaStreamRequest& request,
    460       const MediaResponseCallback& callback) OVERRIDE;
    461   virtual SessionStorageNamespace* GetSessionStorageNamespace(
    462       SiteInstance* instance) OVERRIDE;
    463 
    464   // RenderWidgetHostDelegate --------------------------------------------------
    465 
    466   virtual void RenderWidgetDeleted(
    467       RenderWidgetHostImpl* render_widget_host) OVERRIDE;
    468   virtual bool PreHandleKeyboardEvent(
    469       const NativeWebKeyboardEvent& event,
    470       bool* is_keyboard_shortcut) OVERRIDE;
    471   virtual void HandleKeyboardEvent(
    472       const NativeWebKeyboardEvent& event) OVERRIDE;
    473   virtual bool PreHandleWheelEvent(
    474       const WebKit::WebMouseWheelEvent& event) OVERRIDE;
    475   virtual void DidSendScreenRects(RenderWidgetHostImpl* rwh) OVERRIDE;
    476 #if defined(OS_WIN) && defined(USE_AURA)
    477   virtual gfx::NativeViewAccessible GetParentNativeViewAccessible() OVERRIDE;
    478 #endif
    479 
    480   // RenderViewHostManager::Delegate -------------------------------------------
    481 
    482   virtual bool CreateRenderViewForRenderManager(
    483       RenderViewHost* render_view_host, int opener_route_id) OVERRIDE;
    484   virtual void BeforeUnloadFiredFromRenderManager(
    485       bool proceed, const base::TimeTicks& proceed_time,
    486       bool* proceed_to_fire_unload) OVERRIDE;
    487   virtual void RenderProcessGoneFromRenderManager(
    488       RenderViewHost* render_view_host) OVERRIDE;
    489   virtual void UpdateRenderViewSizeForRenderManager() OVERRIDE;
    490   virtual void NotifySwappedFromRenderManager(
    491       RenderViewHost* old_render_view_host) OVERRIDE;
    492   virtual int CreateOpenerRenderViewsForRenderManager(
    493       SiteInstance* instance) OVERRIDE;
    494   virtual NavigationControllerImpl&
    495       GetControllerForRenderManager() OVERRIDE;
    496   virtual WebUIImpl* CreateWebUIForRenderManager(const GURL& url) OVERRIDE;
    497   virtual NavigationEntry*
    498       GetLastCommittedNavigationEntryForRenderManager() OVERRIDE;
    499   virtual bool FocusLocationBarByDefault() OVERRIDE;
    500   virtual void SetFocusToLocationBar(bool select_all) OVERRIDE;
    501   virtual void CreateViewAndSetSizeForRVH(RenderViewHost* rvh) OVERRIDE;
    502 
    503   // NotificationObserver ------------------------------------------------------
    504 
    505   virtual void Observe(int type,
    506                        const NotificationSource& source,
    507                        const NotificationDetails& details) OVERRIDE;
    508 
    509 
    510  private:
    511   friend class NavigationControllerImpl;
    512   friend class WebContentsObserver;
    513   friend class WebContents;  // To implement factory methods.
    514 
    515   FRIEND_TEST_ALL_PREFIXES(WebContentsImplTest, NoJSMessageOnInterstitials);
    516   FRIEND_TEST_ALL_PREFIXES(WebContentsImplTest, UpdateTitle);
    517   FRIEND_TEST_ALL_PREFIXES(WebContentsImplTest, FindOpenerRVHWhenPending);
    518   FRIEND_TEST_ALL_PREFIXES(WebContentsImplTest,
    519                            CrossSiteCantPreemptAfterUnload);
    520   FRIEND_TEST_ALL_PREFIXES(WebContentsImplTest, PendingContents);
    521   FRIEND_TEST_ALL_PREFIXES(WebContentsImplTest, FrameTreeShape);
    522   FRIEND_TEST_ALL_PREFIXES(FormStructureBrowserTest, HTMLFiles);
    523   FRIEND_TEST_ALL_PREFIXES(NavigationControllerTest, HistoryNavigate);
    524   FRIEND_TEST_ALL_PREFIXES(RenderViewHostManagerTest, PageDoesBackAndReload);
    525 
    526   // So InterstitialPageImpl can access SetIsLoading.
    527   friend class InterstitialPageImpl;
    528 
    529   // TODO(brettw) TestWebContents shouldn't exist!
    530   friend class TestWebContents;
    531 
    532   class DestructionObserver;
    533 
    534   // See WebContents::Create for a description of these parameters.
    535   WebContentsImpl(BrowserContext* browser_context,
    536                   WebContentsImpl* opener);
    537 
    538   // Add and remove observers for page navigation notifications. Adding or
    539   // removing multiple times has no effect. The order in which notifications
    540   // are sent to observers is undefined. Clients must be sure to remove the
    541   // observer before they go away.
    542   void AddObserver(WebContentsObserver* observer);
    543   void RemoveObserver(WebContentsObserver* observer);
    544 
    545   // Clears this tab's opener if it has been closed.
    546   void OnWebContentsDestroyed(WebContentsImpl* web_contents);
    547 
    548   // Creates and adds to the map a destruction observer watching |web_contents|.
    549   // No-op if such an observer already exists.
    550   void AddDestructionObserver(WebContentsImpl* web_contents);
    551 
    552   // Deletes and removes from the map a destruction observer
    553   // watching |web_contents|. No-op if there is no such observer.
    554   void RemoveDestructionObserver(WebContentsImpl* web_contents);
    555 
    556   // Callback function when showing JS dialogs.
    557   void OnDialogClosed(RenderViewHost* rvh,
    558                       IPC::Message* reply_msg,
    559                       bool success,
    560                       const string16& user_input);
    561 
    562   // Callback function when requesting permission to access the PPAPI broker.
    563   // |result| is true if permission was granted.
    564   void OnPpapiBrokerPermissionResult(int routing_id, bool result);
    565 
    566   // IPC message handlers.
    567   void OnDidLoadResourceFromMemoryCache(const GURL& url,
    568                                         const std::string& security_info,
    569                                         const std::string& http_request,
    570                                         const std::string& mime_type,
    571                                         ResourceType::Type resource_type);
    572   void OnDidDisplayInsecureContent();
    573   void OnDidRunInsecureContent(const std::string& security_origin,
    574                                const GURL& target_url);
    575   void OnDocumentLoadedInFrame(int64 frame_id);
    576   void OnDidFinishLoad(int64 frame_id,
    577                        const GURL& url,
    578                        bool is_main_frame);
    579   void OnDidFailLoadWithError(int64 frame_id,
    580                               const GURL& url,
    581                               bool is_main_frame,
    582                               int error_code,
    583                               const string16& error_description);
    584   void OnGoToEntryAtOffset(int offset);
    585   void OnUpdateZoomLimits(int minimum_percent,
    586                           int maximum_percent,
    587                           bool remember);
    588   void OnEnumerateDirectory(int request_id, const base::FilePath& path);
    589   void OnJSOutOfMemory();
    590 
    591   void OnRegisterProtocolHandler(const std::string& protocol,
    592                                  const GURL& url,
    593                                  const string16& title,
    594                                  bool user_gesture);
    595   void OnFindReply(int request_id,
    596                    int number_of_matches,
    597                    const gfx::Rect& selection_rect,
    598                    int active_match_ordinal,
    599                    bool final_update);
    600   void OnDidProgrammaticallyScroll(const gfx::Vector2d& scroll_point);
    601 #if defined(OS_ANDROID)
    602   void OnFindMatchRectsReply(int version,
    603                              const std::vector<gfx::RectF>& rects,
    604                              const gfx::RectF& active_rect);
    605 
    606   void OnOpenDateTimeDialog(
    607       const ViewHostMsg_DateTimeDialogValue_Params& value);
    608 #endif
    609   void OnCrashedPlugin(const base::FilePath& plugin_path,
    610                        base::ProcessId plugin_pid);
    611   void OnAppCacheAccessed(const GURL& manifest_url, bool blocked_by_policy);
    612   void OnOpenColorChooser(int color_chooser_id, SkColor color);
    613   void OnEndColorChooser(int color_chooser_id);
    614   void OnSetSelectedColorInColorChooser(int color_chooser_id, SkColor color);
    615   void OnPepperPluginHung(int plugin_child_id,
    616                           const base::FilePath& path,
    617                           bool is_hung);
    618   void OnWebUISend(const GURL& source_url,
    619                    const std::string& name,
    620                    const base::ListValue& args);
    621   void OnRequestPpapiBrokerPermission(int routing_id,
    622                                       const GURL& url,
    623                                       const base::FilePath& plugin_path);
    624   void OnBrowserPluginMessage(const IPC::Message& message);
    625   void OnDidDownloadImage(int id,
    626                           int http_status_code,
    627                           const GURL& image_url,
    628                           int requested_size,
    629                           const std::vector<SkBitmap>& bitmaps);
    630   void OnUpdateFaviconURL(int32 page_id,
    631                           const std::vector<FaviconURL>& candidates);
    632   void OnFrameAttached(int64 parent_frame_id,
    633                        int64 frame_id,
    634                        const std::string& frame_name);
    635   void OnFrameDetached(int64 parent_frame_id, int64 frame_id);
    636 
    637   void OnMediaNotification(int64 player_cookie,
    638                            bool has_video,
    639                            bool has_audio,
    640                            bool is_playing);
    641 
    642   // Changes the IsLoading state and notifies delegate as needed
    643   // |details| is used to provide details on the load that just finished
    644   // (but can be null if not applicable). Can be overridden.
    645   void SetIsLoading(bool is_loading,
    646                     LoadNotificationDetails* details);
    647 
    648   // Called by derived classes to indicate that we're no longer waiting for a
    649   // response. This won't actually update the throbber, but it will get picked
    650   // up at the next animation step if the throbber is going.
    651   void SetNotWaitingForResponse() { waiting_for_response_ = false; }
    652 
    653   // Navigation helpers --------------------------------------------------------
    654   //
    655   // These functions are helpers for Navigate() and DidNavigate().
    656 
    657   // Handles post-navigation tasks in DidNavigate AFTER the entry has been
    658   // committed to the navigation controller. Note that the navigation entry is
    659   // not provided since it may be invalid/changed after being committed. The
    660   // current navigation entry is in the NavigationController at this point.
    661   void DidNavigateMainFramePostCommit(
    662       const LoadCommittedDetails& details,
    663       const ViewHostMsg_FrameNavigate_Params& params);
    664   void DidNavigateAnyFramePostCommit(
    665       RenderViewHost* render_view_host,
    666       const LoadCommittedDetails& details,
    667       const ViewHostMsg_FrameNavigate_Params& params);
    668 
    669   // Specifies whether the passed in URL should be assigned as the site of the
    670   // current SiteInstance, if it does not yet have a site.
    671   bool ShouldAssignSiteForURL(const GURL& url);
    672 
    673   // If our controller was restored, update the max page ID associated with the
    674   // given RenderViewHost to be larger than the number of restored entries.
    675   // This is called in CreateRenderView before any navigations in the RenderView
    676   // have begun, to prevent any races in updating RenderView::next_page_id.
    677   void UpdateMaxPageIDIfNecessary(RenderViewHost* rvh);
    678 
    679   // Saves the given title to the navigation entry and does associated work. It
    680   // will update history and the view for the new title, and also synthesize
    681   // titles for file URLs that have none (so we require that the URL of the
    682   // entry already be set).
    683   //
    684   // This is used as the backend for state updates, which include a new title,
    685   // or the dedicated set title message. It returns true if the new title is
    686   // different and was therefore updated.
    687   bool UpdateTitleForEntry(NavigationEntryImpl* entry,
    688                            const string16& title);
    689 
    690   // Causes the WebContentsImpl to navigate in the right renderer to |entry|,
    691   // which must be already part of the entries in the navigation controller.
    692   // This does not change the NavigationController state.
    693   bool NavigateToEntry(const NavigationEntryImpl& entry,
    694                        NavigationController::ReloadType reload_type);
    695 
    696   // Sets the history for this WebContentsImpl to |history_length| entries, and
    697   // moves the current page_id to the last entry in the list if it's valid.
    698   // This is mainly used when a prerendered page is swapped into the current
    699   // tab. The method is virtual for testing.
    700   virtual void SetHistoryLengthAndPrune(
    701       const SiteInstance* site_instance,
    702       int merge_history_length,
    703       int32 minimum_page_id);
    704 
    705   // Recursively creates swapped out RenderViews for this tab's opener chain
    706   // (including this tab) in the given SiteInstance, allowing other tabs to send
    707   // cross-process JavaScript calls to their opener(s).  Returns the route ID of
    708   // this tab's RenderView for |instance|.
    709   int CreateOpenerRenderViews(SiteInstance* instance);
    710 
    711   // Helper for CreateNewWidget/CreateNewFullscreenWidget.
    712   void CreateNewWidget(int route_id,
    713                        bool is_fullscreen,
    714                        WebKit::WebPopupType popup_type);
    715 
    716   // Helper for ShowCreatedWidget/ShowCreatedFullscreenWidget.
    717   void ShowCreatedWidget(int route_id,
    718                          bool is_fullscreen,
    719                          const gfx::Rect& initial_pos);
    720 
    721   // Finds the new RenderWidgetHost and returns it. Note that this can only be
    722   // called once as this call also removes it from the internal map.
    723   RenderWidgetHostView* GetCreatedWidget(int route_id);
    724 
    725   // Finds the new WebContentsImpl by route_id, initializes it for
    726   // renderer-initiated creation, and returns it. Note that this can only be
    727   // called once as this call also removes it from the internal map.
    728   WebContentsImpl* GetCreatedWindow(int route_id);
    729 
    730   // Returns the RenderWidgetHostView that is associated with a native window
    731   // and can be used in showing created widgets.
    732   // If this WebContents belongs to a browser plugin guest, there is no native
    733   // window 'view' associated with this WebContents. This method returns the
    734   // 'view' of the embedder instead.
    735   RenderWidgetHostViewPort* GetRenderWidgetHostViewPort() const;
    736 
    737   // Misc non-view stuff -------------------------------------------------------
    738 
    739   // Helper functions for sending notifications.
    740   void NotifySwapped(RenderViewHost* old_render_view_host);
    741   void NotifyConnected();
    742   void NotifyDisconnected();
    743   void NotifyNavigationEntryCommitted(const LoadCommittedDetails& load_details);
    744 
    745   void SetEncoding(const std::string& encoding);
    746 
    747   RenderViewHostImpl* GetRenderViewHostImpl();
    748 
    749   FrameTreeNode* FindFrameTreeNodeByID(int64 frame_id);
    750 
    751   // Removes browser plugin embedder if there is one.
    752   void RemoveBrowserPluginEmbedder();
    753 
    754   // Clear |render_view_host|'s PowerSaveBlockers.
    755   void ClearPowerSaveBlockers(RenderViewHost* render_view_host);
    756 
    757   // Clear all PowerSaveBlockers, leave power_save_blocker_ empty.
    758   void ClearAllPowerSaveBlockers();
    759 
    760   // Data for core operation ---------------------------------------------------
    761 
    762   // Delegate for notifying our owner about stuff. Not owned by us.
    763   WebContentsDelegate* delegate_;
    764 
    765   // Handles the back/forward list and loading.
    766   NavigationControllerImpl controller_;
    767 
    768   // The corresponding view.
    769   scoped_ptr<WebContentsViewPort> view_;
    770 
    771   // The view of the RVHD. Usually this is our WebContentsView implementation,
    772   // but if an embedder uses a different WebContentsView, they'll need to
    773   // provide this.
    774   RenderViewHostDelegateView* render_view_host_delegate_view_;
    775 
    776   // Tracks created WebContentsImpl objects that have not been shown yet. They
    777   // are identified by the route ID passed to CreateNewWindow.
    778   typedef std::map<int, WebContentsImpl*> PendingContents;
    779   PendingContents pending_contents_;
    780 
    781   // These maps hold on to the widgets that we created on behalf of the renderer
    782   // that haven't shown yet.
    783   typedef std::map<int, RenderWidgetHostView*> PendingWidgetViews;
    784   PendingWidgetViews pending_widget_views_;
    785 
    786   typedef std::map<WebContentsImpl*, DestructionObserver*> DestructionObservers;
    787   DestructionObservers destruction_observers_;
    788 
    789   // A list of observers notified when page state changes. Weak references.
    790   // This MUST be listed above render_manager_ since at destruction time the
    791   // latter might cause RenderViewHost's destructor to call us and we might use
    792   // the observer list then.
    793   ObserverList<WebContentsObserver> observers_;
    794 
    795   // The tab that opened this tab, if any.  Will be set to null if the opener
    796   // is closed.
    797   WebContentsImpl* opener_;
    798 
    799 #if defined(OS_WIN) && defined(USE_AURA)
    800   gfx::NativeViewAccessible accessible_parent_;
    801 #endif
    802 
    803   // Helper classes ------------------------------------------------------------
    804 
    805   // Maps the RenderViewHost to its media_player_cookie and PowerSaveBlocker
    806   // pairs. Key is the RenderViewHost, value is the map which maps player_cookie
    807   // on to PowerSaveBlocker.
    808   typedef std::map<RenderViewHost*, std::map<int64, PowerSaveBlocker*> >
    809       PowerSaveBlockerMap;
    810   PowerSaveBlockerMap power_save_blockers_;
    811 
    812   // Manages creation and swapping of render views.
    813   RenderViewHostManager render_manager_;
    814 
    815 #if defined(OS_ANDROID)
    816   // Manages injecting Java objects into all RenderViewHosts associated with
    817   // this WebContentsImpl.
    818   scoped_ptr<JavaBridgeDispatcherHostManager>
    819       java_bridge_dispatcher_host_manager_;
    820 #endif
    821 
    822   // SavePackage, lazily created.
    823   scoped_refptr<SavePackage> save_package_;
    824 
    825   // Data for loading state ----------------------------------------------------
    826 
    827   // Indicates whether we're currently loading a resource.
    828   bool is_loading_;
    829 
    830   // Indicates if the tab is considered crashed.
    831   base::TerminationStatus crashed_status_;
    832   int crashed_error_code_;
    833 
    834   // Whether this WebContents is waiting for a first-response for the
    835   // main resource of the page. This controls whether the throbber state is
    836   // "waiting" or "loading."
    837   bool waiting_for_response_;
    838 
    839   // Map of SiteInstance ID to max page ID for this tab. A page ID is specific
    840   // to a given tab and SiteInstance, and must be valid for the lifetime of the
    841   // WebContentsImpl.
    842   std::map<int32, int32> max_page_ids_;
    843 
    844   // System time at which the current load was started.
    845   base::TimeTicks current_load_start_;
    846 
    847   // The current load state and the URL associated with it.
    848   net::LoadStateWithParam load_state_;
    849   string16 load_state_host_;
    850   // Upload progress, for displaying in the status bar.
    851   // Set to zero when there is no significant upload happening.
    852   uint64 upload_size_;
    853   uint64 upload_position_;
    854 
    855   // Data for current page -----------------------------------------------------
    856 
    857   // When a title cannot be taken from any entry, this title will be used.
    858   string16 page_title_when_no_navigation_entry_;
    859 
    860   // When a navigation occurs, we record its contents MIME type. It can be
    861   // used to check whether we can do something for some special contents.
    862   std::string contents_mime_type_;
    863 
    864   // Character encoding.
    865   std::string encoding_;
    866 
    867   // True if this is a secure page which displayed insecure content.
    868   bool displayed_insecure_content_;
    869 
    870   // The frame tree structure of the current page.
    871   scoped_ptr<FrameTreeNode> frame_tree_root_;
    872 
    873   // Data for misc internal state ----------------------------------------------
    874 
    875   // When > 0, the WebContents is currently being captured (e.g., for
    876   // screenshots or mirroring); and the underlying RenderWidgetHost should not
    877   // be told it is hidden.
    878   int capturer_count_;
    879 
    880   // Tracks whether RWHV should be visible once capturer_count_ becomes zero.
    881   bool should_normally_be_visible_;
    882 
    883   // See getter above.
    884   bool is_being_destroyed_;
    885 
    886   // Indicates whether we should notify about disconnection of this
    887   // WebContentsImpl. This is used to ensure disconnection notifications only
    888   // happen if a connection notification has happened and that they happen only
    889   // once.
    890   bool notify_disconnection_;
    891 
    892   // Pointer to the JavaScript dialog manager, lazily assigned. Used because the
    893   // delegate of this WebContentsImpl is nulled before its destructor is called.
    894   JavaScriptDialogManager* dialog_manager_;
    895 
    896   // Set to true when there is an active "before unload" dialog.  When true,
    897   // we've forced the throbber to start in Navigate, and we need to remember to
    898   // turn it off in OnJavaScriptMessageBoxClosed if the navigation is canceled.
    899   bool is_showing_before_unload_dialog_;
    900 
    901   // Settings that get passed to the renderer process.
    902   RendererPreferences renderer_preferences_;
    903 
    904   // The time that this tab was last selected.
    905   base::TimeTicks last_selected_time_;
    906 
    907   // See description above setter.
    908   bool closed_by_user_gesture_;
    909 
    910   // Minimum/maximum zoom percent.
    911   int minimum_zoom_percent_;
    912   int maximum_zoom_percent_;
    913   // If true, the default zoom limits have been overriden for this tab, in which
    914   // case we don't want saved settings to apply to it and we don't want to
    915   // remember it.
    916   bool temporary_zoom_settings_;
    917 
    918   // The intrinsic size of the page.
    919   gfx::Size preferred_size_;
    920 
    921 #if defined(OS_ANDROID)
    922   // Date time chooser opened by this tab.
    923   // Only used in Android since all other platforms use a multi field UI.
    924   scoped_ptr<DateTimeChooserAndroid> date_time_chooser_;
    925 #endif
    926 
    927   // Color chooser that was opened by this tab.
    928   scoped_ptr<ColorChooser> color_chooser_;
    929 
    930   // A unique identifier for the current color chooser.  Identifiers are unique
    931   // across a renderer process.  This avoids race conditions in synchronizing
    932   // the browser and renderer processes.  For example, if a renderer closes one
    933   // chooser and opens another, and simultaneously the user picks a color in the
    934   // first chooser, the IDs can be used to drop the "chose a color" message
    935   // rather than erroneously tell the renderer that the user picked a color in
    936   // the second chooser.
    937   int color_chooser_identifier_;
    938 
    939   // Manages the embedder state for browser plugins, if this WebContents is an
    940   // embedder; NULL otherwise.
    941   scoped_ptr<BrowserPluginEmbedder> browser_plugin_embedder_;
    942   // Manages the guest state for browser plugin, if this WebContents is a guest;
    943   // NULL otherwise.
    944   scoped_ptr<BrowserPluginGuest> browser_plugin_guest_;
    945 
    946   // This must be at the end, or else we might get notifications and use other
    947   // member variables that are gone.
    948   NotificationRegistrar registrar_;
    949 
    950   // Used during IPC message dispatching so that the handlers can get a pointer
    951   // to the RVH through which the message was received.
    952   RenderViewHost* message_source_;
    953 
    954   // All live RenderWidgetHostImpls that are created by this object and may
    955   // outlive it.
    956   std::set<RenderWidgetHostImpl*> created_widgets_;
    957 
    958   // Routing id of the shown fullscreen widget or MSG_ROUTING_NONE otherwise.
    959   int fullscreen_widget_routing_id_;
    960 
    961   // Maps the ids of pending image downloads to their callbacks
    962   typedef std::map<int, ImageDownloadCallback> ImageDownloadMap;
    963   ImageDownloadMap image_download_map_;
    964 
    965   DISALLOW_COPY_AND_ASSIGN(WebContentsImpl);
    966 };
    967 
    968 }  // namespace content
    969 
    970 #endif  // CONTENT_BROWSER_WEB_CONTENTS_WEB_CONTENTS_IMPL_H_
    971