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