blob: 56cd1cffa224df144e0d42efe0924fe97d12debf [file] [log] [blame]
[email protected]91854cd2012-01-10 19:43:571// Copyright (c) 2012 The Chromium Authors. All rights reserved.
[email protected]0dd3a0ab2011-02-18 08:17:442// 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_TAB_CONTENTS_TAB_CONTENTS_H_
6#define CONTENT_BROWSER_TAB_CONTENTS_TAB_CONTENTS_H_
7#pragma once
8
9#include <deque>
10#include <map>
11#include <string>
[email protected]0dd3a0ab2011-02-18 08:17:4412
[email protected]01d65172011-12-25 04:39:3013#include "base/compiler_specific.h"
[email protected]0dd3a0ab2011-02-18 08:17:4414#include "base/gtest_prod_util.h"
[email protected]3b63f8f42011-03-28 01:54:1515#include "base/memory/scoped_ptr.h"
[email protected]6eac57a2011-07-12 21:15:0916#include "base/observer_list.h"
[email protected]45644f62011-11-23 00:58:2317#include "base/property_bag.h"
[email protected]07161902011-11-11 09:57:4218#include "content/browser/renderer_host/java/java_bridge_dispatcher_host_manager.h"
[email protected]d202a7c2012-01-04 07:53:4719#include "content/browser/tab_contents/navigation_controller_impl.h"
[email protected]0dd3a0ab2011-02-18 08:17:4420#include "content/browser/tab_contents/render_view_host_manager.h"
[email protected]8d128d62011-09-13 22:11:5721#include "content/common/content_export.h"
[email protected]b0b67cf2012-01-18 21:59:5722#include "content/public/browser/render_view_host_delegate.h"
[email protected]58f5d562011-12-20 17:13:0323#include "content/public/browser/web_contents.h"
[email protected]daf82f82011-10-31 22:35:3124#include "content/public/common/renderer_preferences.h"
[email protected]0dd3a0ab2011-02-18 08:17:4425#include "net/base/load_states.h"
[email protected]bcd2815602012-01-14 18:17:2326#include "ui/gfx/size.h"
[email protected]70435962011-08-02 20:13:2827#include "webkit/glue/resource_type.h"
[email protected]0dd3a0ab2011-02-18 08:17:4428
29#if defined(OS_WIN)
30#include "base/win/scoped_handle.h"
31#endif
32
[email protected]cadaec52012-02-08 21:53:1333class InterstitialPageImpl;
[email protected]0dd3a0ab2011-02-18 08:17:4434class LoadNotificationDetails;
[email protected]0dd3a0ab2011-02-18 08:17:4435class RenderViewHost;
[email protected]a53209b2012-01-20 16:48:1636class SavePackage;
[email protected]adbfb8df2012-02-24 01:19:4337class SessionStorageNamespaceImpl;
[email protected]d7b175e2011-10-11 15:31:5838struct ViewHostMsg_DidFailProvisionalLoadWithError_Params;
[email protected]daf82f82011-10-31 22:35:3139
[email protected]e582fdd2011-12-20 16:48:1740namespace content {
41class DownloadItem;
[email protected]b6583592012-01-25 19:52:3342class SiteInstance;
[email protected]51da7e32012-01-30 19:24:5243class JavaScriptDialogCreator;
[email protected]674bc592011-12-20 23:00:4244class WebContentsDelegate;
[email protected]51da7e32012-01-30 19:24:5245class WebContentsObserver;
[email protected]8643e6d2012-01-18 20:26:1046class WebContentsView;
[email protected]e582fdd2011-12-20 16:48:1747}
48
[email protected]daf82f82011-10-31 22:35:3149namespace webkit_glue {
50struct WebIntentData;
51}
[email protected]0dd3a0ab2011-02-18 08:17:4452
[email protected]01d65172011-12-25 04:39:3053class CONTENT_EXPORT TabContents
54 : public NON_EXPORTED_BASE(content::WebContents),
[email protected]b0b67cf2012-01-18 21:59:5755 public content::RenderViewHostDelegate,
[email protected]51da7e32012-01-30 19:24:5256 public RenderViewHostManager::Delegate {
[email protected]0dd3a0ab2011-02-18 08:17:4457 public:
[email protected]a81343d232011-12-27 07:39:2058 // See WebContents::Create for a description of these parameters.
[email protected]3d7474ff2011-07-27 17:47:3759 TabContents(content::BrowserContext* browser_context,
[email protected]b6583592012-01-25 19:52:3360 content::SiteInstance* site_instance,
[email protected]0dd3a0ab2011-02-18 08:17:4461 int routing_id,
62 const TabContents* base_tab_contents,
[email protected]adbfb8df2012-02-24 01:19:4363 SessionStorageNamespaceImpl* session_storage_namespace);
[email protected]0dd3a0ab2011-02-18 08:17:4464 virtual ~TabContents();
65
[email protected]64d69de42012-02-06 00:19:5466 // Returns the content specific prefs for the given RVH.
67 static WebPreferences GetWebkitPrefs(RenderViewHost* rvh, const GURL& url);
68
[email protected]c7dd2f62011-07-18 15:57:5969 // Returns the SavePackage which manages the page saving job. May be NULL.
70 SavePackage* save_package() const { return save_package_.get(); }
71
[email protected]74ce1ad2011-12-16 21:51:4672 // Updates the max page ID for the current SiteInstance in this TabContents
73 // to be at least |page_id|.
[email protected]0dd3a0ab2011-02-18 08:17:4474 void UpdateMaxPageID(int32 page_id);
75
[email protected]74ce1ad2011-12-16 21:51:4676 // Updates the max page ID for the given SiteInstance in this TabContents
77 // to be at least |page_id|.
[email protected]b6583592012-01-25 19:52:3378 void UpdateMaxPageIDForSiteInstance(content::SiteInstance* site_instance,
[email protected]74ce1ad2011-12-16 21:51:4679 int32 page_id);
80
[email protected]91854cd2012-01-10 19:43:5781 // Copy the current map of SiteInstance ID to max page ID from another tab.
82 // This is necessary when this tab adopts the NavigationEntries from
83 // |tab_contents|.
84 void CopyMaxPageIDsFrom(TabContents* tab_contents);
85
[email protected]0dd3a0ab2011-02-18 08:17:4486 // Called by the NavigationController to cause the TabContents to navigate to
87 // the current pending entry. The NavigationController should be called back
[email protected]9a7e68c2011-05-26 17:35:5088 // with RendererDidNavigate on success or DiscardPendingEntry on failure.
89 // The callbacks can be inside of this function, or at some future time.
[email protected]0dd3a0ab2011-02-18 08:17:4490 //
91 // The entry has a PageID of -1 if newly created (corresponding to navigation
92 // to a new URL).
93 //
94 // If this method returns false, then the navigation is discarded (equivalent
95 // to calling DiscardPendingEntry on the NavigationController).
[email protected]0bfbf882011-12-22 18:19:2796 bool NavigateToPendingEntry(
[email protected]71fde352011-12-29 03:29:5697 content::NavigationController::ReloadType reload_type);
[email protected]0dd3a0ab2011-02-18 08:17:4498
[email protected]0dd3a0ab2011-02-18 08:17:4499 // Sets the passed passed interstitial as the currently showing interstitial.
100 // |interstitial_page| should be non NULL (use the remove_interstitial_page
101 // method to unset the interstitial) and no interstitial page should be set
102 // when there is already a non NULL interstitial page set.
[email protected]cadaec52012-02-08 21:53:13103 void set_interstitial_page(InterstitialPageImpl* interstitial_page) {
[email protected]0dd3a0ab2011-02-18 08:17:44104 render_manager_.set_interstitial_page(interstitial_page);
105 }
106
107 // Unsets the currently showing interstitial.
108 void remove_interstitial_page() {
109 render_manager_.remove_interstitial_page();
110 }
111
[email protected]01ec4ec2012-01-18 04:13:47112 void set_opener_web_ui_type(content::WebUI::TypeID opener_web_ui_type) {
[email protected]0dd3a0ab2011-02-18 08:17:44113 opener_web_ui_type_ = opener_web_ui_type;
114 }
115
[email protected]276b37a22011-11-08 20:45:46116 JavaBridgeDispatcherHostManager* java_bridge_dispatcher_host_manager() const {
117 return java_bridge_dispatcher_host_manager_.get();
118 }
119
[email protected]cdcb1dee2012-01-04 00:46:20120 // Like GetController from WebContents, but returns the concrete object.
[email protected]d202a7c2012-01-04 07:53:47121 NavigationControllerImpl& GetControllerImpl();
[email protected]cdcb1dee2012-01-04 00:46:20122
[email protected]765187182012-01-11 23:59:28123 // Expose the render manager for testing.
124 RenderViewHostManager* GetRenderManagerForTesting();
125
[email protected]58f5d562011-12-20 17:13:03126 // content::WebContents ------------------------------------------------------
[email protected]6934a702011-12-20 00:04:51127 virtual const base::PropertyBag* GetPropertyBag() const OVERRIDE;
128 virtual base::PropertyBag* GetPropertyBag() OVERRIDE;
[email protected]674bc592011-12-20 23:00:42129 virtual content::WebContentsDelegate* GetDelegate() OVERRIDE;
130 virtual void SetDelegate(content::WebContentsDelegate* delegate) OVERRIDE;
[email protected]cdcb1dee2012-01-04 00:46:20131 virtual content::NavigationController& GetController() OVERRIDE;
132 virtual const content::NavigationController& GetController() const OVERRIDE;
[email protected]627e0512011-12-21 22:55:30133 virtual content::BrowserContext* GetBrowserContext() const OVERRIDE;
[email protected]f5fa20e2011-12-21 22:35:56134 virtual void SetViewType(content::ViewType type) OVERRIDE;
[email protected]ea049a02011-12-25 21:37:09135 virtual content::ViewType GetViewType() const OVERRIDE;
[email protected]f5fa20e2011-12-21 22:35:56136 virtual content::RenderProcessHost* GetRenderProcessHost() const OVERRIDE;
[email protected]151a63d2011-12-20 22:32:52137 virtual RenderViewHost* GetRenderViewHost() const OVERRIDE;
[email protected]5626b0892012-02-20 14:46:58138 virtual content::RenderWidgetHostView*
139 GetRenderWidgetHostView() const OVERRIDE;
[email protected]8643e6d2012-01-18 20:26:10140 virtual content::WebContentsView* GetView() const OVERRIDE;
[email protected]01ec4ec2012-01-18 04:13:47141 virtual content::WebUI* CreateWebUI(const GURL& url) OVERRIDE;
142 virtual content::WebUI* GetWebUI() const OVERRIDE;
143 virtual content::WebUI* GetCommittedWebUI() const OVERRIDE;
[email protected]be1f56ab2011-12-22 06:55:31144 virtual const string16& GetTitle() const OVERRIDE;
145 virtual int32 GetMaxPageID() OVERRIDE;
146 virtual int32 GetMaxPageIDForSiteInstance(
[email protected]b6583592012-01-25 19:52:33147 content::SiteInstance* site_instance) OVERRIDE;
148 virtual content::SiteInstance* GetSiteInstance() const OVERRIDE;
149 virtual content::SiteInstance* GetPendingSiteInstance() const OVERRIDE;
[email protected]be1f56ab2011-12-22 06:55:31150 virtual bool IsLoading() const OVERRIDE;
151 virtual bool IsWaitingForResponse() const OVERRIDE;
152 virtual const net::LoadStateWithParam& GetLoadState() const OVERRIDE;
153 virtual const string16& GetLoadStateHost() const OVERRIDE;
154 virtual uint64 GetUploadSize() const OVERRIDE;
155 virtual uint64 GetUploadPosition() const OVERRIDE;
156 virtual const std::string& GetEncoding() const OVERRIDE;
157 virtual bool DisplayedInsecureContent() const OVERRIDE;
158 virtual void SetCapturingContents(bool cap) OVERRIDE;
159 virtual bool IsCrashed() const OVERRIDE;
160 virtual void SetIsCrashed(base::TerminationStatus status,
161 int error_code) OVERRIDE;
162 virtual base::TerminationStatus GetCrashedStatus() const OVERRIDE;
163 virtual bool IsBeingDestroyed() const OVERRIDE;
164 virtual void NotifyNavigationStateChanged(unsigned changed_flags) OVERRIDE;
165 virtual void DidBecomeSelected() OVERRIDE;
166 virtual base::TimeTicks GetLastSelectedTime() const OVERRIDE;
167 virtual void WasHidden() OVERRIDE;
168 virtual void ShowContents() OVERRIDE;
169 virtual void HideContents() OVERRIDE;
170 virtual bool NeedToFireBeforeUnload() OVERRIDE;
[email protected]0bfbf882011-12-22 18:19:27171 virtual void Stop() OVERRIDE;
[email protected]d9083482012-01-06 00:38:46172 virtual content::WebContents* Clone() OVERRIDE;
[email protected]2a6bc3e2011-12-28 23:51:33173 virtual void AddNewContents(content::WebContents* new_contents,
[email protected]0bfbf882011-12-22 18:19:27174 WindowOpenDisposition disposition,
175 const gfx::Rect& initial_pos,
176 bool user_gesture) OVERRIDE;
177 virtual gfx::NativeView GetContentNativeView() const OVERRIDE;
178 virtual gfx::NativeView GetNativeView() const OVERRIDE;
179 virtual void GetContainerBounds(gfx::Rect* out) const OVERRIDE;
180 virtual void Focus() OVERRIDE;
181 virtual void FocusThroughTabTraversal(bool reverse) OVERRIDE;
182 virtual bool ShowingInterstitialPage() const OVERRIDE;
[email protected]cadaec52012-02-08 21:53:13183 virtual content::InterstitialPage* GetInterstitialPage() const OVERRIDE;
[email protected]a53209b2012-01-20 16:48:16184 virtual bool IsSavable() OVERRIDE;
[email protected]0bfbf882011-12-22 18:19:27185 virtual void OnSavePage() OVERRIDE;
186 virtual bool SavePage(const FilePath& main_file,
187 const FilePath& dir_path,
[email protected]a53209b2012-01-20 16:48:16188 content::SavePageType save_type) OVERRIDE;
[email protected]0bfbf882011-12-22 18:19:27189 virtual bool IsActiveEntry(int32 page_id) OVERRIDE;
190
191 virtual const std::string& GetContentsMimeType() const OVERRIDE;
192 virtual bool WillNotifyDisconnection() const OVERRIDE;
193 virtual void SetOverrideEncoding(const std::string& encoding) OVERRIDE;
194 virtual void ResetOverrideEncoding() OVERRIDE;
195 virtual content::RendererPreferences* GetMutableRendererPrefs() OVERRIDE;
196 virtual void SetNewTabStartTime(const base::TimeTicks& time) OVERRIDE;
197 virtual base::TimeTicks GetNewTabStartTime() const OVERRIDE;
198 virtual void OnCloseStarted() OVERRIDE;
199 virtual bool ShouldAcceptDragAndDrop() const OVERRIDE;
200 virtual void SystemDragEnded() OVERRIDE;
201 virtual void SetClosedByUserGesture(bool value) OVERRIDE;
202 virtual bool GetClosedByUserGesture() const OVERRIDE;
203 virtual double GetZoomLevel() const OVERRIDE;
204 virtual int GetZoomPercent(bool* enable_increment,
205 bool* enable_decrement) OVERRIDE;
206 virtual void ViewSource() OVERRIDE;
207 virtual void ViewFrameSource(const GURL& url,
208 const std::string& content_state) OVERRIDE;
209 virtual int GetMinimumZoomPercent() const OVERRIDE;
210 virtual int GetMaximumZoomPercent() const OVERRIDE;
[email protected]bcd2815602012-01-14 18:17:23211 virtual gfx::Size GetPreferredSize() const OVERRIDE;
[email protected]0bfbf882011-12-22 18:19:27212 virtual int GetContentRestrictions() const OVERRIDE;
[email protected]01ec4ec2012-01-18 04:13:47213 virtual content::WebUI::TypeID GetWebUITypeForCurrentState() OVERRIDE;
214 virtual content::WebUI* GetWebUIForCurrentState() OVERRIDE;
[email protected]0bfbf882011-12-22 18:19:27215 virtual bool GotResponseToLockMouseRequest(bool allowed) OVERRIDE;
216
217 // Implementation of PageNavigator.
[email protected]e5d549d2011-12-28 01:29:20218 virtual content::WebContents* OpenURL(
219 const content::OpenURLParams& params) OVERRIDE;
[email protected]151a63d2011-12-20 22:32:52220
[email protected]952a68e2011-11-17 00:36:10221 // RenderViewHostDelegate ----------------------------------------------------
222
[email protected]b0b67cf2012-01-18 21:59:57223 virtual content::RenderViewHostDelegate::View* GetViewDelegate() OVERRIDE;
224 virtual content::RenderViewHostDelegate::RendererManagement*
[email protected]952a68e2011-11-17 00:36:10225 GetRendererManagementDelegate() OVERRIDE;
[email protected]be1f56ab2011-12-22 06:55:31226 virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
227 virtual const GURL& GetURL() const OVERRIDE;
[email protected]768c5472011-12-26 19:06:17228 virtual WebContents* GetAsWebContents() OVERRIDE;
[email protected]952a68e2011-11-17 00:36:10229 virtual content::ViewType GetRenderViewType() const OVERRIDE;
[email protected]b7a756d42012-01-23 18:08:17230 virtual gfx::Rect GetRootWindowResizerRect() const OVERRIDE;
[email protected]952a68e2011-11-17 00:36:10231 virtual void RenderViewCreated(RenderViewHost* render_view_host) OVERRIDE;
232 virtual void RenderViewReady(RenderViewHost* render_view_host) OVERRIDE;
233 virtual void RenderViewGone(RenderViewHost* render_view_host,
234 base::TerminationStatus status,
235 int error_code) OVERRIDE;
236 virtual void RenderViewDeleted(RenderViewHost* render_view_host) OVERRIDE;
237 virtual void DidNavigate(
238 RenderViewHost* render_view_host,
239 const ViewHostMsg_FrameNavigate_Params& params) OVERRIDE;
240 virtual void UpdateState(RenderViewHost* render_view_host,
241 int32 page_id,
242 const std::string& state) OVERRIDE;
243 virtual void UpdateTitle(RenderViewHost* render_view_host,
244 int32 page_id,
245 const string16& title,
246 base::i18n::TextDirection title_direction) OVERRIDE;
247 virtual void UpdateEncoding(RenderViewHost* render_view_host,
248 const std::string& encoding) OVERRIDE;
249 virtual void UpdateTargetURL(int32 page_id, const GURL& url) OVERRIDE;
250 virtual void Close(RenderViewHost* render_view_host) OVERRIDE;
251 virtual void RequestMove(const gfx::Rect& new_bounds) OVERRIDE;
252 virtual void SwappedOut(RenderViewHost* render_view_host) OVERRIDE;
253 virtual void DidStartLoading() OVERRIDE;
254 virtual void DidStopLoading() OVERRIDE;
255 virtual void DidCancelLoading() OVERRIDE;
256 virtual void DidChangeLoadProgress(double progress) OVERRIDE;
257 virtual void DocumentAvailableInMainFrame(
258 RenderViewHost* render_view_host) OVERRIDE;
259 virtual void DocumentOnLoadCompletedInMainFrame(
260 RenderViewHost* render_view_host,
261 int32 page_id) OVERRIDE;
262 virtual void RequestOpenURL(const GURL& url,
[email protected]445e1042011-12-03 21:03:15263 const content::Referrer& referrer,
[email protected]952a68e2011-11-17 00:36:10264 WindowOpenDisposition disposition,
265 int64 source_frame_id) OVERRIDE;
[email protected]4ad5d77d2011-12-03 02:00:48266 virtual void RequestTransferURL(
267 const GURL& url,
[email protected]bce1f1c2011-12-05 15:11:58268 const content::Referrer& referrer,
[email protected]4ad5d77d2011-12-03 02:00:48269 WindowOpenDisposition disposition,
270 int64 source_frame_id,
[email protected]e5d549d2011-12-28 01:29:20271 const content::GlobalRequestID& transferred_global_request_id) OVERRIDE;
[email protected]fedec012012-01-28 03:09:34272 virtual void RunJavaScriptMessage(RenderViewHost* rvh,
[email protected]952a68e2011-11-17 00:36:10273 const string16& message,
274 const string16& default_prompt,
275 const GURL& frame_url,
[email protected]269f86d2011-12-07 02:43:47276 ui::JavascriptMessageType type,
[email protected]952a68e2011-11-17 00:36:10277 IPC::Message* reply_msg,
278 bool* did_suppress_message) OVERRIDE;
[email protected]fedec012012-01-28 03:09:34279 virtual void RunBeforeUnloadConfirm(RenderViewHost* rvh,
[email protected]952a68e2011-11-17 00:36:10280 const string16& message,
[email protected]3b3301f62012-02-29 04:32:32281 bool is_reload,
[email protected]952a68e2011-11-17 00:36:10282 IPC::Message* reply_msg) OVERRIDE;
283 virtual content::RendererPreferences GetRendererPrefs(
284 content::BrowserContext* browser_context) const OVERRIDE;
285 virtual WebPreferences GetWebkitPrefs() OVERRIDE;
286 virtual void OnUserGesture() OVERRIDE;
287 virtual void OnIgnoredUIEvent() OVERRIDE;
288 virtual void RendererUnresponsive(RenderViewHost* render_view_host,
289 bool is_during_unload) OVERRIDE;
290 virtual void RendererResponsive(RenderViewHost* render_view_host) OVERRIDE;
291 virtual void LoadStateChanged(const GURL& url,
292 const net::LoadStateWithParam& load_state,
293 uint64 upload_position,
294 uint64 upload_size) OVERRIDE;
295 virtual void WorkerCrashed() OVERRIDE;
296 virtual void Activate() OVERRIDE;
297 virtual void Deactivate() OVERRIDE;
298 virtual void LostCapture() OVERRIDE;
299 virtual bool PreHandleKeyboardEvent(const NativeWebKeyboardEvent& event,
300 bool* is_keyboard_shortcut) OVERRIDE;
301 virtual void HandleKeyboardEvent(
302 const NativeWebKeyboardEvent& event) OVERRIDE;
303 virtual void HandleMouseDown() OVERRIDE;
304 virtual void HandleMouseUp() OVERRIDE;
305 virtual void HandleMouseActivate() OVERRIDE;
[email protected]edc64de2011-11-17 20:07:38306 virtual void RunFileChooser(
307 RenderViewHost* render_view_host,
[email protected]8caadeb2011-11-22 02:45:23308 const content::FileChooserParams& params) OVERRIDE;
[email protected]952a68e2011-11-17 00:36:10309 virtual void ToggleFullscreenMode(bool enter_fullscreen) OVERRIDE;
310 virtual bool IsFullscreenForCurrentTab() const OVERRIDE;
311 virtual void UpdatePreferredSize(const gfx::Size& pref_size) OVERRIDE;
312 virtual void WebUISend(RenderViewHost* render_view_host,
313 const GURL& source_url,
314 const std::string& name,
315 const base::ListValue& args) OVERRIDE;
316 virtual void RequestToLockMouse() OVERRIDE;
317 virtual void LostMouseLock() OVERRIDE;
318
[email protected]0bfbf882011-12-22 18:19:27319 // RenderViewHostManager::Delegate -------------------------------------------
320
321 virtual bool CreateRenderViewForRenderManager(
322 RenderViewHost* render_view_host) OVERRIDE;
323 virtual void BeforeUnloadFiredFromRenderManager(
324 bool proceed,
325 bool* proceed_to_fire_unload) OVERRIDE;
326 virtual void DidStartLoadingFromRenderManager(
327 RenderViewHost* render_view_host) OVERRIDE;
328 virtual void RenderViewGoneFromRenderManager(
329 RenderViewHost* render_view_host) OVERRIDE;
330 virtual void UpdateRenderViewSizeForRenderManager() OVERRIDE;
331 virtual void NotifySwappedFromRenderManager() OVERRIDE;
[email protected]d202a7c2012-01-04 07:53:47332 virtual NavigationControllerImpl& GetControllerForRenderManager() OVERRIDE;
[email protected]d2353452012-01-19 19:53:56333 virtual WebUIImpl* CreateWebUIForRenderManager(const GURL& url) OVERRIDE;
[email protected]ad23a092011-12-28 07:02:04334 virtual content::NavigationEntry*
[email protected]0bfbf882011-12-22 18:19:27335 GetLastCommittedNavigationEntryForRenderManager() OVERRIDE;
336 virtual bool FocusLocationBarByDefault() OVERRIDE;
337 virtual void SetFocusToLocationBar(bool select_all) OVERRIDE;
338 virtual void CreateViewAndSetSizeForRVH(RenderViewHost* rvh) OVERRIDE;
339
[email protected]0dd3a0ab2011-02-18 08:17:44340 protected:
[email protected]d8c660432011-12-22 20:51:25341 friend class content::WebContentsObserver;
[email protected]553602e12011-04-05 17:01:18342
343 // Add and remove observers for page navigation notifications. Adding or
344 // removing multiple times has no effect. The order in which notifications
345 // are sent to observers is undefined. Clients must be sure to remove the
346 // observer before they go away.
[email protected]d8c660432011-12-22 20:51:25347 void AddObserver(content::WebContentsObserver* observer);
348 void RemoveObserver(content::WebContentsObserver* observer);
[email protected]553602e12011-04-05 17:01:18349
[email protected]0dd3a0ab2011-02-18 08:17:44350 private:
[email protected]d202a7c2012-01-04 07:53:47351 friend class NavigationControllerImpl;
[email protected]0dd3a0ab2011-02-18 08:17:44352
353 FRIEND_TEST_ALL_PREFIXES(TabContentsTest, NoJSMessageOnInterstitials);
354 FRIEND_TEST_ALL_PREFIXES(TabContentsTest, UpdateTitle);
355 FRIEND_TEST_ALL_PREFIXES(TabContentsTest, CrossSiteCantPreemptAfterUnload);
356 FRIEND_TEST_ALL_PREFIXES(FormStructureBrowserTest, HTMLFiles);
357 FRIEND_TEST_ALL_PREFIXES(NavigationControllerTest, HistoryNavigate);
358 FRIEND_TEST_ALL_PREFIXES(RenderViewHostManagerTest, PageDoesBackAndReload);
359
360 // Temporary until the view/contents separation is complete.
[email protected]8643e6d2012-01-18 20:26:10361 friend class content::WebContentsView;
[email protected]9a56a0d2011-05-13 19:03:31362#if defined(TOOLKIT_VIEWS)
[email protected]7e2cef52011-04-11 21:47:23363 friend class TabContentsViewViews;
[email protected]0dd3a0ab2011-02-18 08:17:44364#elif defined(OS_MACOSX)
[email protected]eb668c92012-02-06 15:35:29365 friend class WebContentsViewMac;
[email protected]0dd3a0ab2011-02-18 08:17:44366#elif defined(TOOLKIT_USES_GTK)
367 friend class TabContentsViewGtk;
368#endif
369
[email protected]cadaec52012-02-08 21:53:13370 // So InterstitialPageImpl can access SetIsLoading.
371 friend class InterstitialPageImpl;
[email protected]0dd3a0ab2011-02-18 08:17:44372
373 // TODO(brettw) TestTabContents shouldn't exist!
374 friend class TestTabContents;
375
[email protected]51da7e32012-01-30 19:24:52376 // Callback function when showing JS dialogs.
377 void OnDialogClosed(RenderViewHost* rvh,
378 IPC::Message* reply_msg,
379 bool success,
380 const string16& user_input);
381
[email protected]0dd3a0ab2011-02-18 08:17:44382 // Message handlers.
[email protected]8b5af492011-11-28 21:50:58383 void OnRegisterIntentService(const string16& action,
[email protected]63c239322011-10-31 23:56:30384 const string16& type,
385 const string16& href,
386 const string16& title,
387 const string16& disposition);
[email protected]678105012011-12-09 04:01:21388 void OnWebIntentDispatch(const webkit_glue::WebIntentData& intent,
[email protected]63c239322011-10-31 23:56:30389 int intent_id);
[email protected]0dd3a0ab2011-02-18 08:17:44390 void OnDidStartProvisionalLoadForFrame(int64 frame_id,
391 bool main_frame,
[email protected]57b9396c2011-10-07 19:11:59392 const GURL& opener_url,
[email protected]0dd3a0ab2011-02-18 08:17:44393 const GURL& url);
394 void OnDidRedirectProvisionalLoad(int32 page_id,
[email protected]57b9396c2011-10-07 19:11:59395 const GURL& opener_url,
[email protected]0dd3a0ab2011-02-18 08:17:44396 const GURL& source_url,
397 const GURL& target_url);
[email protected]d7b175e2011-10-11 15:31:58398 void OnDidFailProvisionalLoadWithError(
399 const ViewHostMsg_DidFailProvisionalLoadWithError_Params& params);
[email protected]0dd3a0ab2011-02-18 08:17:44400 void OnDidLoadResourceFromMemoryCache(const GURL& url,
[email protected]70435962011-08-02 20:13:28401 const std::string& security_info,
402 const std::string& http_request,
403 ResourceType::Type resource_type);
[email protected]0dd3a0ab2011-02-18 08:17:44404 void OnDidDisplayInsecureContent();
405 void OnDidRunInsecureContent(const std::string& security_origin,
406 const GURL& target_url);
407 void OnDocumentLoadedInFrame(int64 frame_id);
[email protected]1a55c5be2011-11-29 11:36:31408 void OnDidFinishLoad(int64 frame_id,
409 const GURL& validated_url,
410 bool is_main_frame);
411 void OnDidFailLoadWithError(int64 frame_id,
412 const GURL& validated_url,
413 bool is_main_frame,
414 int error_code,
415 const string16& error_description);
[email protected]0dd3a0ab2011-02-18 08:17:44416 void OnUpdateContentRestrictions(int restrictions);
[email protected]0dd3a0ab2011-02-18 08:17:44417 void OnGoToEntryAtOffset(int offset);
[email protected]216813952011-05-19 22:21:26418 void OnUpdateZoomLimits(int minimum_percent,
419 int maximum_percent,
420 bool remember);
[email protected]0bfbf882011-12-22 18:19:27421 void OnSaveURL(const GURL& url);
[email protected]3a29a6e2011-08-24 18:26:21422 void OnEnumerateDirectory(int request_id, const FilePath& path);
[email protected]7d189022011-08-25 22:54:20423 void OnJSOutOfMemory();
[email protected]b7a756d42012-01-23 18:08:17424
[email protected]7d189022011-08-25 22:54:20425 void OnRegisterProtocolHandler(const std::string& protocol,
426 const GURL& url,
427 const string16& title);
[email protected]b888919c2011-09-02 00:32:16428 void OnFindReply(int request_id, int number_of_matches,
429 const gfx::Rect& selection_rect, int active_match_ordinal,
430 bool final_update);
[email protected]d952a052011-09-06 18:42:45431 void OnCrashedPlugin(const FilePath& plugin_path);
[email protected]7fc4bbb2011-09-08 21:23:10432 void OnAppCacheAccessed(const GURL& manifest_url, bool blocked_by_policy);
[email protected]0dd3a0ab2011-02-18 08:17:44433
434 // Changes the IsLoading state and notifies delegate as needed
435 // |details| is used to provide details on the load that just finished
436 // (but can be null if not applicable). Can be overridden.
437 void SetIsLoading(bool is_loading,
438 LoadNotificationDetails* details);
439
[email protected]0dd3a0ab2011-02-18 08:17:44440 // Called by derived classes to indicate that we're no longer waiting for a
441 // response. This won't actually update the throbber, but it will get picked
442 // up at the next animation step if the throbber is going.
443 void SetNotWaitingForResponse() { waiting_for_response_ = false; }
444
[email protected]0dd3a0ab2011-02-18 08:17:44445 // Navigation helpers --------------------------------------------------------
446 //
447 // These functions are helpers for Navigate() and DidNavigate().
448
449 // Handles post-navigation tasks in DidNavigate AFTER the entry has been
450 // committed to the navigation controller. Note that the navigation entry is
451 // not provided since it may be invalid/changed after being committed. The
452 // current navigation entry is in the NavigationController at this point.
453 void DidNavigateMainFramePostCommit(
[email protected]8286f51a2011-05-31 17:39:13454 const content::LoadCommittedDetails& details,
[email protected]0dd3a0ab2011-02-18 08:17:44455 const ViewHostMsg_FrameNavigate_Params& params);
456 void DidNavigateAnyFramePostCommit(
457 RenderViewHost* render_view_host,
[email protected]8286f51a2011-05-31 17:39:13458 const content::LoadCommittedDetails& details,
[email protected]0dd3a0ab2011-02-18 08:17:44459 const ViewHostMsg_FrameNavigate_Params& params);
460
[email protected]74ce1ad2011-12-16 21:51:46461 // If our controller was restored, update the max page ID associated with the
462 // given RenderViewHost to be larger than the number of restored entries.
463 // This is called in CreateRenderView before any navigations in the RenderView
464 // have begun, to prevent any races in updating RenderView::next_page_id.
465 void UpdateMaxPageIDIfNecessary(RenderViewHost* rvh);
[email protected]0dd3a0ab2011-02-18 08:17:44466
[email protected]0dd3a0ab2011-02-18 08:17:44467 // Saves the given title to the navigation entry and does associated work. It
468 // will update history and the view for the new title, and also synthesize
469 // titles for file URLs that have none (so we require that the URL of the
470 // entry already be set).
471 //
472 // This is used as the backend for state updates, which include a new title,
473 // or the dedicated set title message. It returns true if the new title is
474 // different and was therefore updated.
[email protected]10f417c52011-12-28 21:04:23475 bool UpdateTitleForEntry(content::NavigationEntryImpl* entry,
476 const string16& title);
[email protected]0dd3a0ab2011-02-18 08:17:44477
478 // Causes the TabContents to navigate in the right renderer to |entry|, which
479 // must be already part of the entries in the navigation controller.
480 // This does not change the NavigationController state.
[email protected]10f417c52011-12-28 21:04:23481 bool NavigateToEntry(const content::NavigationEntryImpl& entry,
[email protected]71fde352011-12-29 03:29:56482 content::NavigationController::ReloadType reload_type);
[email protected]0dd3a0ab2011-02-18 08:17:44483
[email protected]796931a92011-08-10 01:32:14484 // Sets the history for this tab_contents to |history_length| entries, and
485 // moves the current page_id to the last entry in the list if it's valid.
486 // This is mainly used when a prerendered page is swapped into the current
[email protected]9e1ad4b2011-08-14 16:49:19487 // tab. The method is virtual for testing.
[email protected]b6583592012-01-25 19:52:33488 virtual void SetHistoryLengthAndPrune(
489 const content::SiteInstance* site_instance,
490 int merge_history_length,
491 int32 minimum_page_id);
[email protected]796931a92011-08-10 01:32:14492
[email protected]0dd3a0ab2011-02-18 08:17:44493 // Misc non-view stuff -------------------------------------------------------
494
495 // Helper functions for sending notifications.
496 void NotifySwapped();
497 void NotifyConnected();
498 void NotifyDisconnected();
499
[email protected]be1f56ab2011-12-22 06:55:31500 void SetEncoding(const std::string& encoding);
501
[email protected]27678b2a2012-02-04 22:09:14502 // Save a URL to the local filesystem.
[email protected]e30d68d2012-02-09 00:06:26503 void SaveURL(const GURL& url, const GURL& referrer, bool is_main_frame);
[email protected]27678b2a2012-02-04 22:09:14504
[email protected]81898992011-06-14 22:15:00505 // Stores random bits of data for others to associate with this object.
506 // WARNING: this needs to be deleted after NavigationController.
[email protected]45644f62011-11-23 00:58:23507 base::PropertyBag property_bag_;
[email protected]81898992011-06-14 22:15:00508
[email protected]0dd3a0ab2011-02-18 08:17:44509 // Data for core operation ---------------------------------------------------
510
511 // Delegate for notifying our owner about stuff. Not owned by us.
[email protected]674bc592011-12-20 23:00:42512 content::WebContentsDelegate* delegate_;
[email protected]0dd3a0ab2011-02-18 08:17:44513
514 // Handles the back/forward list and loading.
[email protected]d202a7c2012-01-04 07:53:47515 NavigationControllerImpl controller_;
[email protected]0dd3a0ab2011-02-18 08:17:44516
517 // The corresponding view.
[email protected]8643e6d2012-01-18 20:26:10518 scoped_ptr<content::WebContentsView> view_;
[email protected]0dd3a0ab2011-02-18 08:17:44519
[email protected]996042972011-11-08 22:43:59520 // A list of observers notified when page state changes. Weak references.
521 // This MUST be listed above render_manager_ since at destruction time the
522 // latter might cause RenderViewHost's destructor to call us and we might use
523 // the observer list then.
[email protected]d8c660432011-12-22 20:51:25524 ObserverList<content::WebContentsObserver> observers_;
[email protected]996042972011-11-08 22:43:59525
[email protected]0dd3a0ab2011-02-18 08:17:44526 // Helper classes ------------------------------------------------------------
527
528 // Manages creation and swapping of render views.
529 RenderViewHostManager render_manager_;
530
[email protected]483623eb2011-10-25 09:30:00531 // Manages injecting Java objects into all RenderViewHosts associated with
532 // this TabContents.
533 scoped_ptr<JavaBridgeDispatcherHostManager>
534 java_bridge_dispatcher_host_manager_;
535
[email protected]c7dd2f62011-07-18 15:57:59536 // SavePackage, lazily created.
537 scoped_refptr<SavePackage> save_package_;
538
[email protected]0dd3a0ab2011-02-18 08:17:44539 // Data for loading state ----------------------------------------------------
540
541 // Indicates whether we're currently loading a resource.
542 bool is_loading_;
543
544 // Indicates if the tab is considered crashed.
545 base::TerminationStatus crashed_status_;
546 int crashed_error_code_;
547
[email protected]be1f56ab2011-12-22 06:55:31548 // Whether this tab contents is waiting for a first-response for the
549 // main resource of the page. This controls whether the throbber state is
550 // "waiting" or "loading."
[email protected]0dd3a0ab2011-02-18 08:17:44551 bool waiting_for_response_;
552
[email protected]74ce1ad2011-12-16 21:51:46553 // Map of SiteInstance ID to max page ID for this tab. A page ID is specific
554 // to a given tab and SiteInstance, and must be valid for the lifetime of the
555 // TabContents.
556 std::map<int32, int32> max_page_ids_;
[email protected]0dd3a0ab2011-02-18 08:17:44557
558 // System time at which the current load was started.
559 base::TimeTicks current_load_start_;
560
561 // The current load state and the URL associated with it.
[email protected]9c235f042011-08-10 22:28:21562 net::LoadStateWithParam load_state_;
[email protected]0dd3a0ab2011-02-18 08:17:44563 string16 load_state_host_;
564 // Upload progress, for displaying in the status bar.
565 // Set to zero when there is no significant upload happening.
566 uint64 upload_size_;
567 uint64 upload_position_;
568
569 // Data for current page -----------------------------------------------------
570
[email protected]987fc3a2011-05-26 14:18:09571 // When a title cannot be taken from any entry, this title will be used.
572 string16 page_title_when_no_navigation_entry_;
573
[email protected]0dd3a0ab2011-02-18 08:17:44574 // When a navigation occurs, we record its contents MIME type. It can be
575 // used to check whether we can do something for some special contents.
576 std::string contents_mime_type_;
577
578 // Character encoding.
579 std::string encoding_;
580
[email protected]0dd3a0ab2011-02-18 08:17:44581 // True if this is a secure page which displayed insecure content.
582 bool displayed_insecure_content_;
583
[email protected]0dd3a0ab2011-02-18 08:17:44584 // Data for misc internal state ----------------------------------------------
585
[email protected]be1f56ab2011-12-22 06:55:31586 // Whether the tab contents is currently being screenshotted by the
587 // DraggedTabController.
[email protected]0dd3a0ab2011-02-18 08:17:44588 bool capturing_contents_;
589
590 // See getter above.
591 bool is_being_destroyed_;
592
593 // Indicates whether we should notify about disconnection of this
594 // TabContents. This is used to ensure disconnection notifications only
595 // happen if a connection notification has happened and that they happen only
596 // once.
597 bool notify_disconnection_;
598
[email protected]2e5b90c2011-08-16 21:11:55599 // Pointer to the JavaScript dialog creator, lazily assigned. Used because the
600 // delegate of this TabContents is nulled before its destructor is called.
601 content::JavaScriptDialogCreator* dialog_creator_;
602
[email protected]0dd3a0ab2011-02-18 08:17:44603#if defined(OS_WIN)
604 // Handle to an event that's set when the page is showing a message box (or
605 // equivalent constrained window). Plugin processes check this to know if
606 // they should pump messages then.
607 base::win::ScopedHandle message_box_active_;
608#endif
609
[email protected]0dd3a0ab2011-02-18 08:17:44610 // Set to true when there is an active "before unload" dialog. When true,
611 // we've forced the throbber to start in Navigate, and we need to remember to
612 // turn it off in OnJavaScriptMessageBoxClosed if the navigation is canceled.
613 bool is_showing_before_unload_dialog_;
614
[email protected]0dd3a0ab2011-02-18 08:17:44615 // Settings that get passed to the renderer process.
[email protected]daf82f82011-10-31 22:35:31616 content::RendererPreferences renderer_preferences_;
[email protected]0dd3a0ab2011-02-18 08:17:44617
618 // If this tab was created from a renderer using window.open, this will be
619 // non-NULL and represent the WebUI of the opening renderer.
[email protected]01ec4ec2012-01-18 04:13:47620 content::WebUI::TypeID opener_web_ui_type_;
[email protected]0dd3a0ab2011-02-18 08:17:44621
622 // The time that we started to create the new tab page.
623 base::TimeTicks new_tab_start_time_;
624
625 // The time that we started to close the tab.
626 base::TimeTicks tab_close_start_time_;
627
628 // The time that this tab was last selected.
629 base::TimeTicks last_selected_time_;
630
[email protected]0dd3a0ab2011-02-18 08:17:44631 // See description above setter.
632 bool closed_by_user_gesture_;
633
634 // Minimum/maximum zoom percent.
635 int minimum_zoom_percent_;
636 int maximum_zoom_percent_;
637 // If true, the default zoom limits have been overriden for this tab, in which
638 // case we don't want saved settings to apply to it and we don't want to
639 // remember it.
640 bool temporary_zoom_settings_;
641
[email protected]bcd2815602012-01-14 18:17:23642 // The intrinsic size of the page.
643 gfx::Size preferred_size_;
644
[email protected]0dd3a0ab2011-02-18 08:17:44645 // Content restrictions, used to disable print/copy etc based on content's
646 // (full-page plugins for now only) permissions.
647 int content_restrictions_;
648
[email protected]32ded2212011-11-10 18:51:43649 // Our view type. Default is VIEW_TYPE_TAB_CONTENTS.
650 content::ViewType view_type_;
651
[email protected]0dd3a0ab2011-02-18 08:17:44652 DISALLOW_COPY_AND_ASSIGN(TabContents);
653};
654
655#endif // CONTENT_BROWSER_TAB_CONTENTS_TAB_CONTENTS_H_