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