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