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