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