web_contents_impl.h revision 5821806d5e7f356e8fa4b058a389a808ea183019 
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 "content/browser/renderer_host/java/java_bridge_dispatcher_host_manager.h"
17#include "content/browser/renderer_host/render_view_host_delegate.h"
18#include "content/browser/renderer_host/render_widget_host_delegate.h"
19#include "content/browser/web_contents/navigation_controller_impl.h"
20#include "content/browser/web_contents/render_view_host_manager.h"
21#include "content/common/content_export.h"
22#include "content/public/browser/notification_observer.h"
23#include "content/public/browser/notification_registrar.h"
24#include "content/public/browser/web_contents.h"
25#include "content/public/common/renderer_preferences.h"
26#include "net/base/load_states.h"
27#include "ui/gfx/rect_f.h"
28#include "ui/gfx/size.h"
29#include "webkit/glue/resource_type.h"
30
31#if defined(OS_WIN)
32#include "base/win/scoped_handle.h"
33#endif
34
35struct BrowserPluginHostMsg_CreateGuest_Params;
36struct BrowserPluginHostMsg_ResizeGuest_Params;
37struct ViewMsg_PostMessage_Params;
38
39namespace webkit_glue {
40struct WebIntentData;
41struct WebIntentServiceData;
42}
43
44namespace content {
45class BrowserPluginEmbedder;
46class BrowserPluginGuest;
47class ColorChooser;
48class DownloadItem;
49class InterstitialPageImpl;
50class JavaScriptDialogCreator;
51class RenderViewHost;
52class RenderViewHostDelegateView;
53class RenderViewHostImpl;
54class RenderWidgetHostImpl;
55class SavePackage;
56class SessionStorageNamespaceImpl;
57class SiteInstance;
58class TestWebContents;
59class WebContentsDelegate;
60class WebContentsImpl;
61class WebContentsObserver;
62class WebContentsView;
63class WebContentsViewDelegate;
64struct LoadNotificationDetails;
65
66// Factory function for the implementations that content knows about. Takes
67// ownership of |delegate|.
68WebContentsView* CreateWebContentsView(
69    WebContentsImpl* web_contents,
70    WebContentsViewDelegate* delegate,
71    RenderViewHostDelegateView** render_view_host_delegate_view);
72
73class CONTENT_EXPORT WebContentsImpl
74    : public NON_EXPORTED_BASE(WebContents),
75      public RenderViewHostDelegate,
76      public RenderWidgetHostDelegate,
77      public RenderViewHostManager::Delegate,
78      public NotificationObserver {
79 public:
80  virtual ~WebContentsImpl();
81
82  static WebContentsImpl* Create(
83      BrowserContext* browser_context,
84      SiteInstance* site_instance,
85      int routing_id,
86      const WebContentsImpl* base_web_contents);
87
88  static WebContentsImpl* CreateWithOpener(
89      BrowserContext* browser_context,
90      SiteInstance* site_instance,
91      int routing_id,
92      const WebContentsImpl* base_web_contents,
93      WebContentsImpl* opener);
94
95  // Creates a WebContents to be used as a browser plugin guest.
96  static WebContentsImpl* CreateGuest(
97      BrowserContext* browser_context,
98      content::SiteInstance* site_instance,
99      int guest_instance_id,
100      const BrowserPluginHostMsg_CreateGuest_Params& params);
101
102  // Returns the content specific prefs for the given RVH.
103  static webkit_glue::WebPreferences GetWebkitPrefs(
104      RenderViewHost* rvh, const GURL& url);
105
106  // Creates a swapped out RenderView. This is used by the browser plugin to
107  // create a swapped out RenderView in the embedder render process for the
108  // guest, to expose the guest's window object to the embedder.
109  // This returns the routing ID of the newly created swapped out RenderView.
110  int CreateSwappedOutRenderView(SiteInstance* instance);
111
112  // Complex initialization here. Specifically needed to avoid having
113  // members call back into our virtual functions in the constructor.
114  virtual void Init(BrowserContext* browser_context,
115                    SiteInstance* site_instance,
116                    int routing_id,
117                    const WebContents* base_web_contents);
118
119  // Returns the SavePackage which manages the page saving job. May be NULL.
120  SavePackage* save_package() const { return save_package_.get(); }
121
122  // Updates the max page ID for the current SiteInstance in this
123  // WebContentsImpl to be at least |page_id|.
124  void UpdateMaxPageID(int32 page_id);
125
126  // Updates the max page ID for the given SiteInstance in this WebContentsImpl
127  // to be at least |page_id|.
128  void UpdateMaxPageIDForSiteInstance(SiteInstance* site_instance,
129                                      int32 page_id);
130
131  // Copy the current map of SiteInstance ID to max page ID from another tab.
132  // This is necessary when this tab adopts the NavigationEntries from
133  // |web_contents|.
134  void CopyMaxPageIDsFrom(WebContentsImpl* web_contents);
135
136  // Called by the NavigationController to cause the WebContentsImpl to navigate
137  // to the current pending entry. The NavigationController should be called
138  // back with RendererDidNavigate on success or DiscardPendingEntry on failure.
139  // The callbacks can be inside of this function, or at some future time.
140  //
141  // The entry has a PageID of -1 if newly created (corresponding to navigation
142  // to a new URL).
143  //
144  // If this method returns false, then the navigation is discarded (equivalent
145  // to calling DiscardPendingEntry on the NavigationController).
146  bool NavigateToPendingEntry(NavigationController::ReloadType reload_type);
147
148  // Called by InterstitialPageImpl when it creates a RenderViewHost.
149  void RenderViewForInterstitialPageCreated(RenderViewHost* render_view_host);
150
151  // Sets the passed passed interstitial as the currently showing interstitial.
152  // |interstitial_page| should be non NULL (use the remove_interstitial_page
153  // method to unset the interstitial) and no interstitial page should be set
154  // when there is already a non NULL interstitial page set.
155  void set_interstitial_page(InterstitialPageImpl* interstitial_page) {
156    render_manager_.set_interstitial_page(interstitial_page);
157  }
158
159  // Unsets the currently showing interstitial.
160  void remove_interstitial_page() {
161    render_manager_.remove_interstitial_page();
162  }
163
164  void set_opener_web_ui_type(WebUI::TypeID opener_web_ui_type) {
165    opener_web_ui_type_ = opener_web_ui_type;
166  }
167
168  JavaBridgeDispatcherHostManager* java_bridge_dispatcher_host_manager() const {
169    return java_bridge_dispatcher_host_manager_.get();
170  }
171
172  // Expose the render manager for testing.
173  RenderViewHostManager* GetRenderManagerForTesting();
174
175  // Returns guest browser plugin object, or NULL if this WebContents is not a
176  // guest.
177  BrowserPluginGuest* GetBrowserPluginGuest();
178  // Returns embedder browser plugin object, or NULL if this WebContents is not
179  // an embedder.
180  BrowserPluginEmbedder* GetBrowserPluginEmbedder();
181
182  // WebContents ------------------------------------------------------
183  virtual WebContentsDelegate* GetDelegate() OVERRIDE;
184  virtual void SetDelegate(WebContentsDelegate* delegate) OVERRIDE;
185  virtual NavigationControllerImpl& GetController() OVERRIDE;
186  virtual const NavigationControllerImpl& GetController() const OVERRIDE;
187  virtual BrowserContext* GetBrowserContext() const OVERRIDE;
188  virtual RenderProcessHost* GetRenderProcessHost() const OVERRIDE;
189  virtual RenderViewHost* GetRenderViewHost() const OVERRIDE;
190  virtual int GetRoutingID() const OVERRIDE;
191  virtual RenderWidgetHostView* GetRenderWidgetHostView() const OVERRIDE;
192  virtual WebContentsView* GetView() const OVERRIDE;
193  virtual WebUI* CreateWebUI(const GURL& url) OVERRIDE;
194  virtual WebUI* GetWebUI() const OVERRIDE;
195  virtual WebUI* GetCommittedWebUI() const OVERRIDE;
196  virtual void SetUserAgentOverride(const std::string& override) OVERRIDE;
197  virtual const std::string& GetUserAgentOverride() const OVERRIDE;
198  virtual const string16& GetTitle() const OVERRIDE;
199  virtual int32 GetMaxPageID() OVERRIDE;
200  virtual int32 GetMaxPageIDForSiteInstance(
201      SiteInstance* site_instance) OVERRIDE;
202  virtual SiteInstance* GetSiteInstance() const OVERRIDE;
203  virtual SiteInstance* GetPendingSiteInstance() const OVERRIDE;
204  virtual bool IsLoading() const OVERRIDE;
205  virtual bool IsWaitingForResponse() const OVERRIDE;
206  virtual const net::LoadStateWithParam& GetLoadState() const OVERRIDE;
207  virtual const string16& GetLoadStateHost() const OVERRIDE;
208  virtual uint64 GetUploadSize() const OVERRIDE;
209  virtual uint64 GetUploadPosition() const OVERRIDE;
210  virtual const std::string& GetEncoding() const OVERRIDE;
211  virtual bool DisplayedInsecureContent() const OVERRIDE;
212  virtual void SetCapturingContents(bool cap) OVERRIDE;
213  virtual bool IsCrashed() const OVERRIDE;
214  virtual void SetIsCrashed(base::TerminationStatus status,
215                            int error_code) OVERRIDE;
216  virtual base::TerminationStatus GetCrashedStatus() const OVERRIDE;
217  virtual bool IsBeingDestroyed() const OVERRIDE;
218  virtual void NotifyNavigationStateChanged(unsigned changed_flags) OVERRIDE;
219  virtual base::TimeTicks GetLastSelectedTime() const OVERRIDE;
220  virtual void WasShown() OVERRIDE;
221  virtual void WasHidden() OVERRIDE;
222  virtual bool NeedToFireBeforeUnload() OVERRIDE;
223  virtual void Stop() OVERRIDE;
224  virtual WebContents* Clone() OVERRIDE;
225  virtual gfx::NativeView GetContentNativeView() const OVERRIDE;
226  virtual gfx::NativeView GetNativeView() const OVERRIDE;
227  virtual void GetContainerBounds(gfx::Rect* out) const OVERRIDE;
228  virtual void Focus() OVERRIDE;
229  virtual void FocusThroughTabTraversal(bool reverse) OVERRIDE;
230  virtual bool ShowingInterstitialPage() const OVERRIDE;
231  virtual InterstitialPage* GetInterstitialPage() const OVERRIDE;
232  virtual bool IsSavable() OVERRIDE;
233  virtual void OnSavePage() OVERRIDE;
234  virtual bool SavePage(const FilePath& main_file,
235                        const FilePath& dir_path,
236                        SavePageType save_type) OVERRIDE;
237  virtual void GenerateMHTML(
238      const FilePath& file,
239      const base::Callback<void(const FilePath&, int64)>& callback) OVERRIDE;
240  virtual bool IsActiveEntry(int32 page_id) OVERRIDE;
241
242  virtual const std::string& GetContentsMimeType() const OVERRIDE;
243  virtual bool WillNotifyDisconnection() const OVERRIDE;
244  virtual void SetOverrideEncoding(const std::string& encoding) OVERRIDE;
245  virtual void ResetOverrideEncoding() OVERRIDE;
246  virtual RendererPreferences* GetMutableRendererPrefs() OVERRIDE;
247  virtual void SetNewTabStartTime(const base::TimeTicks& time) OVERRIDE;
248  virtual base::TimeTicks GetNewTabStartTime() const OVERRIDE;
249  virtual void Close() OVERRIDE;
250  virtual void OnCloseStarted() OVERRIDE;
251  virtual bool ShouldAcceptDragAndDrop() const OVERRIDE;
252  virtual void SystemDragEnded() OVERRIDE;
253  virtual void UserGestureDone() OVERRIDE;
254  virtual void SetClosedByUserGesture(bool value) OVERRIDE;
255  virtual bool GetClosedByUserGesture() const OVERRIDE;
256  virtual double GetZoomLevel() const OVERRIDE;
257  virtual int GetZoomPercent(bool* enable_increment,
258                             bool* enable_decrement) const OVERRIDE;
259  virtual void ViewSource() OVERRIDE;
260  virtual void ViewFrameSource(const GURL& url,
261                               const std::string& content_state) OVERRIDE;
262  virtual int GetMinimumZoomPercent() const OVERRIDE;
263  virtual int GetMaximumZoomPercent() const OVERRIDE;
264  virtual gfx::Size GetPreferredSize() const OVERRIDE;
265  virtual int GetContentRestrictions() const OVERRIDE;
266  virtual WebUI::TypeID GetWebUITypeForCurrentState() OVERRIDE;
267  virtual WebUI* GetWebUIForCurrentState() OVERRIDE;
268  virtual bool GotResponseToLockMouseRequest(bool allowed) OVERRIDE;
269  virtual bool HasOpener() const OVERRIDE;
270  virtual void DidChooseColorInColorChooser(int color_chooser_id,
271                                            SkColor color) OVERRIDE;
272  virtual void DidEndColorChooser(int color_chooser_id) OVERRIDE;
273
274  // Implementation of PageNavigator.
275  virtual WebContents* OpenURL(const OpenURLParams& params) OVERRIDE;
276
277  // Implementation of IPC::Sender.
278  virtual bool Send(IPC::Message* message) OVERRIDE;
279
280  // RenderViewHostDelegate ----------------------------------------------------
281
282  virtual RenderViewHostDelegateView* GetDelegateView() OVERRIDE;
283  virtual RenderViewHostDelegate::RendererManagement*
284      GetRendererManagementDelegate() OVERRIDE;
285  virtual bool OnMessageReceived(RenderViewHost* render_view_host,
286                                 const IPC::Message& message) OVERRIDE;
287  virtual const GURL& GetURL() const OVERRIDE;
288  virtual WebContents* GetAsWebContents() OVERRIDE;
289  virtual gfx::Rect GetRootWindowResizerRect() const OVERRIDE;
290  virtual void RenderViewCreated(RenderViewHost* render_view_host) OVERRIDE;
291  virtual void RenderViewReady(RenderViewHost* render_view_host) OVERRIDE;
292  virtual void RenderViewGone(RenderViewHost* render_view_host,
293                              base::TerminationStatus status,
294                              int error_code) OVERRIDE;
295  virtual void RenderViewDeleted(RenderViewHost* render_view_host) OVERRIDE;
296  virtual void DidStartProvisionalLoadForFrame(
297      RenderViewHost* render_view_host,
298      int64 frame_id,
299      int64 parent_frame_id,
300      bool main_frame,
301      const GURL& opener_url,
302      const GURL& url) OVERRIDE;
303  virtual void DidRedirectProvisionalLoad(
304      RenderViewHost* render_view_host,
305      int32 page_id,
306      const GURL& opener_url,
307      const GURL& source_url,
308      const GURL& target_url) OVERRIDE;
309  virtual void DidFailProvisionalLoadWithError(
310      RenderViewHost* render_view_host,
311      const ViewHostMsg_DidFailProvisionalLoadWithError_Params& params)
312          OVERRIDE;
313  virtual void DidNavigate(
314      RenderViewHost* render_view_host,
315      const ViewHostMsg_FrameNavigate_Params& params) OVERRIDE;
316  virtual void UpdateState(RenderViewHost* render_view_host,
317                           int32 page_id,
318                           const std::string& state) OVERRIDE;
319  virtual void UpdateTitle(RenderViewHost* render_view_host,
320                           int32 page_id,
321                           const string16& title,
322                           base::i18n::TextDirection title_direction) OVERRIDE;
323  virtual void UpdateEncoding(RenderViewHost* render_view_host,
324                              const std::string& encoding) OVERRIDE;
325  virtual void UpdateTargetURL(int32 page_id, const GURL& url) OVERRIDE;
326  virtual void Close(RenderViewHost* render_view_host) OVERRIDE;
327  virtual void RequestMove(const gfx::Rect& new_bounds) OVERRIDE;
328  virtual void SwappedOut(RenderViewHost* render_view_host) OVERRIDE;
329  virtual void DidStartLoading(RenderViewHost* render_view_host) OVERRIDE;
330  virtual void DidStopLoading(RenderViewHost* render_view_host) OVERRIDE;
331  virtual void DidCancelLoading() OVERRIDE;
332  virtual void DidChangeLoadProgress(double progress) OVERRIDE;
333  virtual void DidUpdateFrameTree(RenderViewHost* rvh) OVERRIDE;
334  virtual void DocumentAvailableInMainFrame(
335      RenderViewHost* render_view_host) OVERRIDE;
336  virtual void DocumentOnLoadCompletedInMainFrame(
337      RenderViewHost* render_view_host,
338      int32 page_id) OVERRIDE;
339  virtual void RequestOpenURL(RenderViewHost* rvh,
340                              const GURL& url,
341                              const Referrer& referrer,
342                              WindowOpenDisposition disposition,
343                              int64 source_frame_id) OVERRIDE;
344  virtual void RequestTransferURL(
345      const GURL& url,
346      const Referrer& referrer,
347      WindowOpenDisposition disposition,
348      int64 source_frame_id,
349      const GlobalRequestID& transferred_global_request_id) OVERRIDE;
350  virtual void RouteCloseEvent(RenderViewHost* rvh) OVERRIDE;
351  virtual void RouteMessageEvent(
352      RenderViewHost* rvh,
353      const ViewMsg_PostMessage_Params& params) OVERRIDE;
354  virtual void RunJavaScriptMessage(RenderViewHost* rvh,
355                                    const string16& message,
356                                    const string16& default_prompt,
357                                    const GURL& frame_url,
358                                    JavaScriptMessageType type,
359                                    IPC::Message* reply_msg,
360                                    bool* did_suppress_message) OVERRIDE;
361  virtual void RunBeforeUnloadConfirm(RenderViewHost* rvh,
362                                      const string16& message,
363                                      bool is_reload,
364                                      IPC::Message* reply_msg) OVERRIDE;
365  virtual bool AddMessageToConsole(int32 level,
366                                   const string16& message,
367                                   int32 line_no,
368                                   const string16& source_id) OVERRIDE;
369  virtual RendererPreferences GetRendererPrefs(
370      BrowserContext* browser_context) const OVERRIDE;
371  virtual webkit_glue::WebPreferences GetWebkitPrefs() OVERRIDE;
372  virtual void OnUserGesture() OVERRIDE;
373  virtual void OnIgnoredUIEvent() OVERRIDE;
374  virtual void RendererUnresponsive(RenderViewHost* render_view_host,
375                                    bool is_during_unload) OVERRIDE;
376  virtual void RendererResponsive(RenderViewHost* render_view_host) OVERRIDE;
377  virtual void LoadStateChanged(const GURL& url,
378                                const net::LoadStateWithParam& load_state,
379                                uint64 upload_position,
380                                uint64 upload_size) OVERRIDE;
381  virtual void WorkerCrashed() OVERRIDE;
382  virtual void Activate() OVERRIDE;
383  virtual void Deactivate() OVERRIDE;
384  virtual void LostCapture() OVERRIDE;
385  virtual void HandleMouseDown() OVERRIDE;
386  virtual void HandleMouseUp() OVERRIDE;
387  virtual void HandlePointerActivate() OVERRIDE;
388  virtual void HandleGestureBegin() OVERRIDE;
389  virtual void HandleGestureEnd() OVERRIDE;
390  virtual void RunFileChooser(
391      RenderViewHost* render_view_host,
392      const FileChooserParams& params) OVERRIDE;
393  virtual void ToggleFullscreenMode(bool enter_fullscreen) OVERRIDE;
394  virtual bool IsFullscreenForCurrentTab() const OVERRIDE;
395  virtual void UpdatePreferredSize(const gfx::Size& pref_size) OVERRIDE;
396  virtual void ResizeDueToAutoResize(const gfx::Size& new_size) OVERRIDE;
397  virtual void RequestToLockMouse(bool user_gesture,
398                                  bool last_unlocked_by_target) OVERRIDE;
399  virtual void LostMouseLock() OVERRIDE;
400  virtual void CreateNewWindow(
401      int route_id,
402      const ViewHostMsg_CreateWindow_Params& params,
403      SessionStorageNamespace* session_storage_namespace) OVERRIDE;
404  virtual void CreateNewWidget(int route_id,
405                               WebKit::WebPopupType popup_type) OVERRIDE;
406  virtual void CreateNewFullscreenWidget(int route_id) OVERRIDE;
407  virtual void ShowCreatedWindow(int route_id,
408                                 WindowOpenDisposition disposition,
409                                 const gfx::Rect& initial_pos,
410                                 bool user_gesture) OVERRIDE;
411  virtual void ShowCreatedWidget(int route_id,
412                                 const gfx::Rect& initial_pos) OVERRIDE;
413  virtual void ShowCreatedFullscreenWidget(int route_id) OVERRIDE;
414  virtual void ShowContextMenu(
415      const ContextMenuParams& params,
416      ContextMenuSourceType type) OVERRIDE;
417  virtual void RequestMediaAccessPermission(
418      const MediaStreamRequest* request,
419      const MediaResponseCallback& callback) OVERRIDE;
420
421#if defined(OS_ANDROID)
422  virtual void AttachLayer(WebKit::WebLayer* layer) OVERRIDE;
423  virtual void RemoveLayer(WebKit::WebLayer* layer) OVERRIDE;
424#endif
425
426  // RenderWidgetHostDelegate --------------------------------------------------
427
428  virtual void RenderWidgetDeleted(
429      RenderWidgetHostImpl* render_widget_host) OVERRIDE;
430  virtual bool PreHandleKeyboardEvent(
431      const NativeWebKeyboardEvent& event,
432      bool* is_keyboard_shortcut) OVERRIDE;
433  virtual void HandleKeyboardEvent(
434      const NativeWebKeyboardEvent& event) OVERRIDE;
435
436  // RenderViewHostManager::Delegate -------------------------------------------
437
438  virtual bool CreateRenderViewForRenderManager(
439      RenderViewHost* render_view_host, int opener_route_id) OVERRIDE;
440  virtual void BeforeUnloadFiredFromRenderManager(
441      bool proceed, const base::TimeTicks& proceed_time,
442      bool* proceed_to_fire_unload) OVERRIDE;
443  virtual void RenderViewGoneFromRenderManager(
444      RenderViewHost* render_view_host) OVERRIDE;
445  virtual void UpdateRenderViewSizeForRenderManager() OVERRIDE;
446  virtual void NotifySwappedFromRenderManager() OVERRIDE;
447  virtual int CreateOpenerRenderViewsForRenderManager(
448      SiteInstance* instance) OVERRIDE;
449  virtual NavigationControllerImpl&
450      GetControllerForRenderManager() OVERRIDE;
451  virtual WebUIImpl* CreateWebUIForRenderManager(const GURL& url) OVERRIDE;
452  virtual NavigationEntry*
453      GetLastCommittedNavigationEntryForRenderManager() OVERRIDE;
454  virtual bool FocusLocationBarByDefault() OVERRIDE;
455  virtual void SetFocusToLocationBar(bool select_all) OVERRIDE;
456  virtual void CreateViewAndSetSizeForRVH(RenderViewHost* rvh) OVERRIDE;
457
458  // NotificationObserver ------------------------------------------------------
459
460  virtual void Observe(int type,
461                       const NotificationSource& source,
462                       const NotificationDetails& details) OVERRIDE;
463
464
465 private:
466  friend class NavigationControllerImpl;
467  friend class WebContentsObserver;
468  friend class WebContents;  // To implement factory methods.
469
470  FRIEND_TEST_ALL_PREFIXES(WebContentsImplTest, NoJSMessageOnInterstitials);
471  FRIEND_TEST_ALL_PREFIXES(WebContentsImplTest, UpdateTitle);
472  FRIEND_TEST_ALL_PREFIXES(WebContentsImplTest,
473                           CrossSiteCantPreemptAfterUnload);
474  FRIEND_TEST_ALL_PREFIXES(FormStructureBrowserTest, HTMLFiles);
475  FRIEND_TEST_ALL_PREFIXES(NavigationControllerTest, HistoryNavigate);
476  FRIEND_TEST_ALL_PREFIXES(RenderViewHostManagerTest, PageDoesBackAndReload);
477
478  // So InterstitialPageImpl can access SetIsLoading.
479  friend class InterstitialPageImpl;
480
481  // TODO(brettw) TestWebContents shouldn't exist!
482  friend class TestWebContents;
483
484  // See WebContents::Create for a description of these parameters.
485  WebContentsImpl(BrowserContext* browser_context,
486                  WebContentsImpl* opener);
487
488  // Add and remove observers for page navigation notifications. Adding or
489  // removing multiple times has no effect. The order in which notifications
490  // are sent to observers is undefined. Clients must be sure to remove the
491  // observer before they go away.
492  void AddObserver(WebContentsObserver* observer);
493  void RemoveObserver(WebContentsObserver* observer);
494
495  // Clears this tab's opener if it has been closed.
496  void OnWebContentsDestroyed(WebContents* web_contents);
497
498  // Callback function when showing JS dialogs.
499  void OnDialogClosed(RenderViewHost* rvh,
500                      IPC::Message* reply_msg,
501                      bool success,
502                      const string16& user_input);
503
504  // Callback function when requesting permission to access the PPAPI broker.
505  // |result| is true if permission was granted.
506  void OnPpapiBrokerPermissionResult(int request_id, bool result);
507
508  // IPC message handlers.
509  void OnRegisterIntentService(const webkit_glue::WebIntentServiceData& data,
510                               bool user_gesture);
511  void OnWebIntentDispatch(const webkit_glue::WebIntentData& intent,
512                           int intent_id);
513  void OnDidLoadResourceFromMemoryCache(const GURL& url,
514                                        const std::string& security_info,
515                                        const std::string& http_request,
516                                        const std::string& mime_type,
517                                        ResourceType::Type resource_type);
518  void OnDidDisplayInsecureContent();
519  void OnDidRunInsecureContent(const std::string& security_origin,
520                               const GURL& target_url);
521  void OnDocumentLoadedInFrame(int64 frame_id);
522  void OnDidFinishLoad(int64 frame_id,
523                       const GURL& validated_url,
524                       bool is_main_frame);
525  void OnDidFailLoadWithError(int64 frame_id,
526                              const GURL& validated_url,
527                              bool is_main_frame,
528                              int error_code,
529                              const string16& error_description);
530  void OnUpdateContentRestrictions(int restrictions);
531  void OnGoToEntryAtOffset(int offset);
532  void OnUpdateZoomLimits(int minimum_percent,
533                          int maximum_percent,
534                          bool remember);
535  void OnSaveURL(const GURL& url, const Referrer& referrer);
536  void OnEnumerateDirectory(int request_id, const FilePath& path);
537  void OnJSOutOfMemory();
538
539  void OnRegisterProtocolHandler(const std::string& protocol,
540                                 const GURL& url,
541                                 const string16& title,
542                                 bool user_gesture);
543  void OnFindReply(int request_id,
544                   int number_of_matches,
545                   const gfx::Rect& selection_rect,
546                   int active_match_ordinal,
547                   bool final_update);
548#if defined(OS_ANDROID)
549  void OnFindMatchRectsReply(int version,
550                             const std::vector<gfx::RectF>& rects,
551                             const gfx::RectF& active_rect);
552#endif
553  void OnCrashedPlugin(const FilePath& plugin_path);
554  void OnAppCacheAccessed(const GURL& manifest_url, bool blocked_by_policy);
555  void OnOpenColorChooser(int color_chooser_id, SkColor color);
556  void OnEndColorChooser(int color_chooser_id);
557  void OnSetSelectedColorInColorChooser(int color_chooser_id, SkColor color);
558  void OnPepperPluginHung(int plugin_child_id,
559                          const FilePath& path,
560                          bool is_hung);
561  void OnWebUISend(const GURL& source_url,
562                   const std::string& name,
563                   const base::ListValue& args);
564  void OnRequestPpapiBrokerPermission(int request_id,
565                                      const GURL& url,
566                                      const FilePath& plugin_path);
567  void OnBrowserPluginCreateGuest(
568      int instance_id,
569      const BrowserPluginHostMsg_CreateGuest_Params& params);
570
571  // Changes the IsLoading state and notifies delegate as needed
572  // |details| is used to provide details on the load that just finished
573  // (but can be null if not applicable). Can be overridden.
574  void SetIsLoading(bool is_loading,
575                    LoadNotificationDetails* details);
576
577  // Called by derived classes to indicate that we're no longer waiting for a
578  // response. This won't actually update the throbber, but it will get picked
579  // up at the next animation step if the throbber is going.
580  void SetNotWaitingForResponse() { waiting_for_response_ = false; }
581
582  // Navigation helpers --------------------------------------------------------
583  //
584  // These functions are helpers for Navigate() and DidNavigate().
585
586  // Handles post-navigation tasks in DidNavigate AFTER the entry has been
587  // committed to the navigation controller. Note that the navigation entry is
588  // not provided since it may be invalid/changed after being committed. The
589  // current navigation entry is in the NavigationController at this point.
590  void DidNavigateMainFramePostCommit(
591      const LoadCommittedDetails& details,
592      const ViewHostMsg_FrameNavigate_Params& params);
593  void DidNavigateAnyFramePostCommit(
594      RenderViewHost* render_view_host,
595      const LoadCommittedDetails& details,
596      const ViewHostMsg_FrameNavigate_Params& params);
597
598  // If our controller was restored, update the max page ID associated with the
599  // given RenderViewHost to be larger than the number of restored entries.
600  // This is called in CreateRenderView before any navigations in the RenderView
601  // have begun, to prevent any races in updating RenderView::next_page_id.
602  void UpdateMaxPageIDIfNecessary(RenderViewHost* rvh);
603
604  // Saves the given title to the navigation entry and does associated work. It
605  // will update history and the view for the new title, and also synthesize
606  // titles for file URLs that have none (so we require that the URL of the
607  // entry already be set).
608  //
609  // This is used as the backend for state updates, which include a new title,
610  // or the dedicated set title message. It returns true if the new title is
611  // different and was therefore updated.
612  bool UpdateTitleForEntry(NavigationEntryImpl* entry,
613                           const string16& title);
614
615  // Causes the WebContentsImpl to navigate in the right renderer to |entry|,
616  // which must be already part of the entries in the navigation controller.
617  // This does not change the NavigationController state.
618  bool NavigateToEntry(const NavigationEntryImpl& entry,
619                       NavigationController::ReloadType reload_type);
620
621  // Sets the history for this WebContentsImpl to |history_length| entries, and
622  // moves the current page_id to the last entry in the list if it's valid.
623  // This is mainly used when a prerendered page is swapped into the current
624  // tab. The method is virtual for testing.
625  virtual void SetHistoryLengthAndPrune(
626      const SiteInstance* site_instance,
627      int merge_history_length,
628      int32 minimum_page_id);
629
630  // Recursively creates swapped out RenderViews for this tab's opener chain
631  // (including this tab) in the given SiteInstance, allowing other tabs to send
632  // cross-process JavaScript calls to their opener(s).  Returns the route ID of
633  // this tab's RenderView for |instance|.
634  int CreateOpenerRenderViews(SiteInstance* instance);
635
636  // Helper for CreateNewWidget/CreateNewFullscreenWidget.
637  void CreateNewWidget(int route_id,
638                       bool is_fullscreen,
639                       WebKit::WebPopupType popup_type);
640
641  // Helper for ShowCreatedWidget/ShowCreatedFullscreenWidget.
642  void ShowCreatedWidget(int route_id,
643                         bool is_fullscreen,
644                         const gfx::Rect& initial_pos);
645
646  // Finds the new RenderWidgetHost and returns it. Note that this can only be
647  // called once as this call also removes it from the internal map.
648  RenderWidgetHostView* GetCreatedWidget(int route_id);
649
650  // Finds the new WebContentsImpl by route_id, initializes it for
651  // renderer-initiated creation, and returns it. Note that this can only be
652  // called once as this call also removes it from the internal map.
653  WebContentsImpl* GetCreatedWindow(int route_id);
654
655  // Misc non-view stuff -------------------------------------------------------
656
657  // Helper functions for sending notifications.
658  void NotifySwapped();
659  void NotifyConnected();
660  void NotifyDisconnected();
661
662  void SetEncoding(const std::string& encoding);
663
664  // Save a URL to the local filesystem.
665  void SaveURL(const GURL& url,
666               const Referrer& referrer,
667               bool is_main_frame);
668
669  RenderViewHostImpl* GetRenderViewHostImpl();
670
671  // Removes browser plugin embedder if there is one.
672  void RemoveBrowserPluginEmbedder();
673
674  // Data for core operation ---------------------------------------------------
675
676  // Delegate for notifying our owner about stuff. Not owned by us.
677  WebContentsDelegate* delegate_;
678
679  // Handles the back/forward list and loading.
680  NavigationControllerImpl controller_;
681
682  // The corresponding view.
683  scoped_ptr<WebContentsView> view_;
684
685  // The view of the RVHD. Usually this is our WebContentsView implementation,
686  // but if an embedder uses a different WebContentsView, they'll need to
687  // provide this.
688  RenderViewHostDelegateView* render_view_host_delegate_view_;
689
690  // Tracks created WebContentsImpl objects that have not been shown yet. They
691  // are identified by the route ID passed to CreateNewWindow.
692  typedef std::map<int, WebContentsImpl*> PendingContents;
693  PendingContents pending_contents_;
694
695  // These maps hold on to the widgets that we created on behalf of the renderer
696  // that haven't shown yet.
697  typedef std::map<int, RenderWidgetHostView*> PendingWidgetViews;
698  PendingWidgetViews pending_widget_views_;
699
700  // A list of observers notified when page state changes. Weak references.
701  // This MUST be listed above render_manager_ since at destruction time the
702  // latter might cause RenderViewHost's destructor to call us and we might use
703  // the observer list then.
704  ObserverList<WebContentsObserver> observers_;
705
706  // The tab that opened this tab, if any.  Will be set to null if the opener
707  // is closed.
708  WebContentsImpl* opener_;
709
710  // Helper classes ------------------------------------------------------------
711
712  // Manages creation and swapping of render views.
713  RenderViewHostManager render_manager_;
714
715  // Manages injecting Java objects into all RenderViewHosts associated with
716  // this WebContentsImpl.
717  scoped_ptr<JavaBridgeDispatcherHostManager>
718      java_bridge_dispatcher_host_manager_;
719
720  // SavePackage, lazily created.
721  scoped_refptr<SavePackage> save_package_;
722
723  // Data for loading state ----------------------------------------------------
724
725  // Indicates whether we're currently loading a resource.
726  bool is_loading_;
727
728  // Indicates if the tab is considered crashed.
729  base::TerminationStatus crashed_status_;
730  int crashed_error_code_;
731
732  // Whether this WebContents is waiting for a first-response for the
733  // main resource of the page. This controls whether the throbber state is
734  // "waiting" or "loading."
735  bool waiting_for_response_;
736
737  // Map of SiteInstance ID to max page ID for this tab. A page ID is specific
738  // to a given tab and SiteInstance, and must be valid for the lifetime of the
739  // WebContentsImpl.
740  std::map<int32, int32> max_page_ids_;
741
742  // System time at which the current load was started.
743  base::TimeTicks current_load_start_;
744
745  // The current load state and the URL associated with it.
746  net::LoadStateWithParam load_state_;
747  string16 load_state_host_;
748  // Upload progress, for displaying in the status bar.
749  // Set to zero when there is no significant upload happening.
750  uint64 upload_size_;
751  uint64 upload_position_;
752
753  // Data for current page -----------------------------------------------------
754
755  // When a title cannot be taken from any entry, this title will be used.
756  string16 page_title_when_no_navigation_entry_;
757
758  // When a navigation occurs, we record its contents MIME type. It can be
759  // used to check whether we can do something for some special contents.
760  std::string contents_mime_type_;
761
762  // Character encoding.
763  std::string encoding_;
764
765  // True if this is a secure page which displayed insecure content.
766  bool displayed_insecure_content_;
767
768  // Data for misc internal state ----------------------------------------------
769
770  // Whether the WebContents is currently being screenshotted.
771  bool capturing_contents_;
772
773  // See getter above.
774  bool is_being_destroyed_;
775
776  // Indicates whether we should notify about disconnection of this
777  // WebContentsImpl. This is used to ensure disconnection notifications only
778  // happen if a connection notification has happened and that they happen only
779  // once.
780  bool notify_disconnection_;
781
782  // Pointer to the JavaScript dialog creator, lazily assigned. Used because the
783  // delegate of this WebContentsImpl is nulled before its destructor is called.
784  JavaScriptDialogCreator* dialog_creator_;
785
786#if defined(OS_WIN)
787  // Handle to an event that's set when the page is showing a message box (or
788  // equivalent constrained window).  Plugin processes check this to know if
789  // they should pump messages then.
790  base::win::ScopedHandle message_box_active_;
791#endif
792
793  // Set to true when there is an active "before unload" dialog.  When true,
794  // we've forced the throbber to start in Navigate, and we need to remember to
795  // turn it off in OnJavaScriptMessageBoxClosed if the navigation is canceled.
796  bool is_showing_before_unload_dialog_;
797
798  // Settings that get passed to the renderer process.
799  RendererPreferences renderer_preferences_;
800
801  // If this tab was created from a renderer using window.open, this will be
802  // non-NULL and represent the WebUI of the opening renderer.
803  WebUI::TypeID opener_web_ui_type_;
804
805  // The time that we started to create the new tab page.
806  base::TimeTicks new_tab_start_time_;
807
808  // The time that we started to close this WebContents.
809  base::TimeTicks close_start_time_;
810
811  // The time when onbeforeunload ended.
812  base::TimeTicks before_unload_end_time_;
813
814  // The time that this tab was last selected.
815  base::TimeTicks last_selected_time_;
816
817  // See description above setter.
818  bool closed_by_user_gesture_;
819
820  // Minimum/maximum zoom percent.
821  int minimum_zoom_percent_;
822  int maximum_zoom_percent_;
823  // If true, the default zoom limits have been overriden for this tab, in which
824  // case we don't want saved settings to apply to it and we don't want to
825  // remember it.
826  bool temporary_zoom_settings_;
827
828  // The intrinsic size of the page.
829  gfx::Size preferred_size_;
830
831  // Content restrictions, used to disable print/copy etc based on content's
832  // (full-page plugins for now only) permissions.
833  int content_restrictions_;
834
835  // Color chooser that was opened by this tab.
836  ColorChooser* color_chooser_;
837
838  // Manages the embedder state for browser plugins, if this WebContents is an
839  // embedder; NULL otherwise.
840  scoped_ptr<BrowserPluginEmbedder> browser_plugin_embedder_;
841  // Manages the guest state for browser plugin, if this WebContents is a guest;
842  // NULL otherwise.
843  scoped_ptr<BrowserPluginGuest> browser_plugin_guest_;
844
845  // This must be at the end, or else we might get notifications and use other
846  // member variables that are gone.
847  NotificationRegistrar registrar_;
848
849  // Used during IPC message dispatching so that the handlers can get a pointer
850  // to the RVH through which the message was received.
851  RenderViewHost* message_source_;
852
853  // All live RenderWidgetHostImpls that are created by this object and may
854  // outlive it.
855  std::set<RenderWidgetHostImpl*> created_widgets_;
856
857  DISALLOW_COPY_AND_ASSIGN(WebContentsImpl);
858};
859
860}  // namespace content
861
862#endif  // CONTENT_BROWSER_WEB_CONTENTS_WEB_CONTENTS_IMPL_H_
863