blob: 12bad9d839bde3fdf63c70cf20bfc4c95b00eac9 [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]3ab9cb82011-06-03 18:02:0718#include "content/browser/javascript_dialogs.h"
[email protected]07161902011-11-11 09:57:4219#include "content/browser/renderer_host/java/java_bridge_dispatcher_host_manager.h"
[email protected]5de634712011-03-02 00:20:1920#include "content/browser/renderer_host/render_view_host_delegate.h"
[email protected]d202a7c2012-01-04 07:53:4721#include "content/browser/tab_contents/navigation_controller_impl.h"
[email protected]0dd3a0ab2011-02-18 08:17:4422#include "content/browser/tab_contents/render_view_host_manager.h"
[email protected]8d128d62011-09-13 22:11:5723#include "content/common/content_export.h"
[email protected]58f5d562011-12-20 17:13:0324#include "content/public/browser/web_contents.h"
[email protected]daf82f82011-10-31 22:35:3125#include "content/public/common/renderer_preferences.h"
[email protected]0dd3a0ab2011-02-18 08:17:4426#include "net/base/load_states.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]0dd3a0ab2011-02-18 08:17:4433class LoadNotificationDetails;
[email protected]0dd3a0ab2011-02-18 08:17:4434class RenderViewHost;
35class SessionStorageNamespace;
36class SiteInstance;
[email protected]0dd3a0ab2011-02-18 08:17:4437class TabContentsView;
[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]d8c660432011-12-22 20:51:2542class WebContentsObserver;
[email protected]674bc592011-12-20 23:00:4243class WebContentsDelegate;
[email protected]e582fdd2011-12-20 16:48:1744}
45
[email protected]daf82f82011-10-31 22:35:3146namespace webkit_glue {
47struct WebIntentData;
48}
[email protected]0dd3a0ab2011-02-18 08:17:4449
[email protected]01d65172011-12-25 04:39:3050class CONTENT_EXPORT TabContents
51 : public NON_EXPORTED_BASE(content::WebContents),
[email protected]01d65172011-12-25 04:39:3052 public RenderViewHostDelegate,
53 public RenderViewHostManager::Delegate,
54 public content::JavaScriptDialogDelegate {
[email protected]0dd3a0ab2011-02-18 08:17:4455 public:
[email protected]a81343d232011-12-27 07:39:2056 // See WebContents::Create for a description of these parameters.
[email protected]3d7474ff2011-07-27 17:47:3757 TabContents(content::BrowserContext* browser_context,
[email protected]0dd3a0ab2011-02-18 08:17:4458 SiteInstance* site_instance,
59 int routing_id,
60 const TabContents* base_tab_contents,
61 SessionStorageNamespace* session_storage_namespace);
62 virtual ~TabContents();
63
[email protected]c7dd2f62011-07-18 15:57:5964 // Returns the SavePackage which manages the page saving job. May be NULL.
65 SavePackage* save_package() const { return save_package_.get(); }
66
[email protected]74ce1ad2011-12-16 21:51:4667 // Updates the max page ID for the current SiteInstance in this TabContents
68 // to be at least |page_id|.
[email protected]0dd3a0ab2011-02-18 08:17:4469 void UpdateMaxPageID(int32 page_id);
70
[email protected]74ce1ad2011-12-16 21:51:4671 // Updates the max page ID for the given SiteInstance in this TabContents
72 // to be at least |page_id|.
73 void UpdateMaxPageIDForSiteInstance(SiteInstance* site_instance,
74 int32 page_id);
75
[email protected]91854cd2012-01-10 19:43:5776 // Copy the current map of SiteInstance ID to max page ID from another tab.
77 // This is necessary when this tab adopts the NavigationEntries from
78 // |tab_contents|.
79 void CopyMaxPageIDsFrom(TabContents* tab_contents);
80
[email protected]0dd3a0ab2011-02-18 08:17:4481 // Called by the NavigationController to cause the TabContents to navigate to
82 // the current pending entry. The NavigationController should be called back
[email protected]9a7e68c2011-05-26 17:35:5083 // with RendererDidNavigate on success or DiscardPendingEntry on failure.
84 // The callbacks can be inside of this function, or at some future time.
[email protected]0dd3a0ab2011-02-18 08:17:4485 //
86 // The entry has a PageID of -1 if newly created (corresponding to navigation
87 // to a new URL).
88 //
89 // If this method returns false, then the navigation is discarded (equivalent
90 // to calling DiscardPendingEntry on the NavigationController).
[email protected]0bfbf882011-12-22 18:19:2791 bool NavigateToPendingEntry(
[email protected]71fde352011-12-29 03:29:5692 content::NavigationController::ReloadType reload_type);
[email protected]0dd3a0ab2011-02-18 08:17:4493
[email protected]0dd3a0ab2011-02-18 08:17:4494 // Sets the passed passed interstitial as the currently showing interstitial.
95 // |interstitial_page| should be non NULL (use the remove_interstitial_page
96 // method to unset the interstitial) and no interstitial page should be set
97 // when there is already a non NULL interstitial page set.
98 void set_interstitial_page(InterstitialPage* interstitial_page) {
99 render_manager_.set_interstitial_page(interstitial_page);
100 }
101
102 // Unsets the currently showing interstitial.
103 void remove_interstitial_page() {
104 render_manager_.remove_interstitial_page();
105 }
106
[email protected]1fd1a502011-03-30 16:55:56107 void set_opener_web_ui_type(WebUI::TypeID opener_web_ui_type) {
[email protected]0dd3a0ab2011-02-18 08:17:44108 opener_web_ui_type_ = opener_web_ui_type;
109 }
110
[email protected]276b37a22011-11-08 20:45:46111 JavaBridgeDispatcherHostManager* java_bridge_dispatcher_host_manager() const {
112 return java_bridge_dispatcher_host_manager_.get();
113 }
114
[email protected]cdcb1dee2012-01-04 00:46:20115 // Like GetController from WebContents, but returns the concrete object.
[email protected]d202a7c2012-01-04 07:53:47116 NavigationControllerImpl& GetControllerImpl();
[email protected]cdcb1dee2012-01-04 00:46:20117
[email protected]58f5d562011-12-20 17:13:03118 // content::WebContents ------------------------------------------------------
[email protected]6934a702011-12-20 00:04:51119 virtual const base::PropertyBag* GetPropertyBag() const OVERRIDE;
120 virtual base::PropertyBag* GetPropertyBag() OVERRIDE;
[email protected]674bc592011-12-20 23:00:42121 virtual content::WebContentsDelegate* GetDelegate() OVERRIDE;
122 virtual void SetDelegate(content::WebContentsDelegate* delegate) OVERRIDE;
[email protected]cdcb1dee2012-01-04 00:46:20123 virtual content::NavigationController& GetController() OVERRIDE;
124 virtual const content::NavigationController& GetController() const OVERRIDE;
[email protected]627e0512011-12-21 22:55:30125 virtual content::BrowserContext* GetBrowserContext() const OVERRIDE;
[email protected]f5fa20e2011-12-21 22:35:56126 virtual void SetViewType(content::ViewType type) OVERRIDE;
[email protected]ea049a02011-12-25 21:37:09127 virtual content::ViewType GetViewType() const OVERRIDE;
[email protected]f5fa20e2011-12-21 22:35:56128 virtual content::RenderProcessHost* GetRenderProcessHost() const OVERRIDE;
[email protected]151a63d2011-12-20 22:32:52129 virtual RenderViewHost* GetRenderViewHost() const OVERRIDE;
[email protected]d487beefe2011-12-21 05:41:21130 virtual RenderWidgetHostView* GetRenderWidgetHostView() const OVERRIDE;
131 virtual TabContentsView* GetView() const OVERRIDE;
[email protected]be1f56ab2011-12-22 06:55:31132 virtual WebUI* GetWebUI() const OVERRIDE;
133 virtual WebUI* GetCommittedWebUI() const OVERRIDE;
134 virtual const string16& GetTitle() const OVERRIDE;
135 virtual int32 GetMaxPageID() OVERRIDE;
136 virtual int32 GetMaxPageIDForSiteInstance(
137 SiteInstance* site_instance) OVERRIDE;
138 virtual SiteInstance* GetSiteInstance() const OVERRIDE;
139 virtual SiteInstance* GetPendingSiteInstance() const OVERRIDE;
140 virtual bool IsLoading() const OVERRIDE;
141 virtual bool IsWaitingForResponse() const OVERRIDE;
142 virtual const net::LoadStateWithParam& GetLoadState() const OVERRIDE;
143 virtual const string16& GetLoadStateHost() const OVERRIDE;
144 virtual uint64 GetUploadSize() const OVERRIDE;
145 virtual uint64 GetUploadPosition() const OVERRIDE;
146 virtual const std::string& GetEncoding() const OVERRIDE;
147 virtual bool DisplayedInsecureContent() const OVERRIDE;
148 virtual void SetCapturingContents(bool cap) OVERRIDE;
149 virtual bool IsCrashed() const OVERRIDE;
150 virtual void SetIsCrashed(base::TerminationStatus status,
151 int error_code) OVERRIDE;
152 virtual base::TerminationStatus GetCrashedStatus() const OVERRIDE;
153 virtual bool IsBeingDestroyed() const OVERRIDE;
154 virtual void NotifyNavigationStateChanged(unsigned changed_flags) OVERRIDE;
155 virtual void DidBecomeSelected() OVERRIDE;
156 virtual base::TimeTicks GetLastSelectedTime() const OVERRIDE;
157 virtual void WasHidden() OVERRIDE;
158 virtual void ShowContents() OVERRIDE;
159 virtual void HideContents() OVERRIDE;
160 virtual bool NeedToFireBeforeUnload() OVERRIDE;
161 virtual RenderViewHostManager* GetRenderManagerForTesting() OVERRIDE;
[email protected]0bfbf882011-12-22 18:19:27162 virtual void Stop() OVERRIDE;
[email protected]d9083482012-01-06 00:38:46163 virtual content::WebContents* Clone() OVERRIDE;
[email protected]0bfbf882011-12-22 18:19:27164 virtual void ShowPageInfo(const GURL& url,
[email protected]d583e3f22011-12-27 21:38:17165 const content::SSLStatus& ssl,
[email protected]0bfbf882011-12-22 18:19:27166 bool show_history) OVERRIDE;
[email protected]2a6bc3e2011-12-28 23:51:33167 virtual void AddNewContents(content::WebContents* new_contents,
[email protected]0bfbf882011-12-22 18:19:27168 WindowOpenDisposition disposition,
169 const gfx::Rect& initial_pos,
170 bool user_gesture) OVERRIDE;
171 virtual gfx::NativeView GetContentNativeView() const OVERRIDE;
172 virtual gfx::NativeView GetNativeView() const OVERRIDE;
173 virtual void GetContainerBounds(gfx::Rect* out) const OVERRIDE;
174 virtual void Focus() OVERRIDE;
175 virtual void FocusThroughTabTraversal(bool reverse) OVERRIDE;
176 virtual bool ShowingInterstitialPage() const OVERRIDE;
177 virtual InterstitialPage* GetInterstitialPage() const OVERRIDE;
178 virtual void OnSavePage() OVERRIDE;
179 virtual bool SavePage(const FilePath& main_file,
180 const FilePath& dir_path,
181 SavePackage::SavePackageType save_type) OVERRIDE;
182 virtual bool IsActiveEntry(int32 page_id) OVERRIDE;
183
184 virtual const std::string& GetContentsMimeType() const OVERRIDE;
185 virtual bool WillNotifyDisconnection() const OVERRIDE;
186 virtual void SetOverrideEncoding(const std::string& encoding) OVERRIDE;
187 virtual void ResetOverrideEncoding() OVERRIDE;
188 virtual content::RendererPreferences* GetMutableRendererPrefs() OVERRIDE;
189 virtual void SetNewTabStartTime(const base::TimeTicks& time) OVERRIDE;
190 virtual base::TimeTicks GetNewTabStartTime() const OVERRIDE;
191 virtual void OnCloseStarted() OVERRIDE;
192 virtual bool ShouldAcceptDragAndDrop() const OVERRIDE;
193 virtual void SystemDragEnded() OVERRIDE;
194 virtual void SetClosedByUserGesture(bool value) OVERRIDE;
195 virtual bool GetClosedByUserGesture() const OVERRIDE;
196 virtual double GetZoomLevel() const OVERRIDE;
197 virtual int GetZoomPercent(bool* enable_increment,
198 bool* enable_decrement) OVERRIDE;
199 virtual void ViewSource() OVERRIDE;
200 virtual void ViewFrameSource(const GURL& url,
201 const std::string& content_state) OVERRIDE;
202 virtual int GetMinimumZoomPercent() const OVERRIDE;
203 virtual int GetMaximumZoomPercent() const OVERRIDE;
204 virtual int GetContentRestrictions() const OVERRIDE;
205 virtual WebUI::TypeID GetWebUITypeForCurrentState() OVERRIDE;
206 virtual WebUI* GetWebUIForCurrentState() OVERRIDE;
207 virtual bool GotResponseToLockMouseRequest(bool allowed) OVERRIDE;
208
209 // Implementation of PageNavigator.
[email protected]e5d549d2011-12-28 01:29:20210 virtual content::WebContents* OpenURL(
211 const content::OpenURLParams& params) OVERRIDE;
[email protected]151a63d2011-12-20 22:32:52212
[email protected]952a68e2011-11-17 00:36:10213 // RenderViewHostDelegate ----------------------------------------------------
214
215 virtual RenderViewHostDelegate::View* GetViewDelegate() OVERRIDE;
216 virtual RenderViewHostDelegate::RendererManagement*
217 GetRendererManagementDelegate() OVERRIDE;
[email protected]be1f56ab2011-12-22 06:55:31218 virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
219 virtual const GURL& GetURL() const OVERRIDE;
[email protected]952a68e2011-11-17 00:36:10220 virtual TabContents* GetAsTabContents() OVERRIDE;
[email protected]768c5472011-12-26 19:06:17221 virtual WebContents* GetAsWebContents() OVERRIDE;
[email protected]952a68e2011-11-17 00:36:10222 virtual content::ViewType GetRenderViewType() const OVERRIDE;
223 virtual void RenderViewCreated(RenderViewHost* render_view_host) OVERRIDE;
224 virtual void RenderViewReady(RenderViewHost* render_view_host) OVERRIDE;
225 virtual void RenderViewGone(RenderViewHost* render_view_host,
226 base::TerminationStatus status,
227 int error_code) OVERRIDE;
228 virtual void RenderViewDeleted(RenderViewHost* render_view_host) OVERRIDE;
229 virtual void DidNavigate(
230 RenderViewHost* render_view_host,
231 const ViewHostMsg_FrameNavigate_Params& params) OVERRIDE;
232 virtual void UpdateState(RenderViewHost* render_view_host,
233 int32 page_id,
234 const std::string& state) OVERRIDE;
235 virtual void UpdateTitle(RenderViewHost* render_view_host,
236 int32 page_id,
237 const string16& title,
238 base::i18n::TextDirection title_direction) OVERRIDE;
239 virtual void UpdateEncoding(RenderViewHost* render_view_host,
240 const std::string& encoding) OVERRIDE;
241 virtual void UpdateTargetURL(int32 page_id, const GURL& url) OVERRIDE;
242 virtual void Close(RenderViewHost* render_view_host) OVERRIDE;
243 virtual void RequestMove(const gfx::Rect& new_bounds) OVERRIDE;
244 virtual void SwappedOut(RenderViewHost* render_view_host) OVERRIDE;
245 virtual void DidStartLoading() OVERRIDE;
246 virtual void DidStopLoading() OVERRIDE;
247 virtual void DidCancelLoading() OVERRIDE;
248 virtual void DidChangeLoadProgress(double progress) OVERRIDE;
249 virtual void DocumentAvailableInMainFrame(
250 RenderViewHost* render_view_host) OVERRIDE;
251 virtual void DocumentOnLoadCompletedInMainFrame(
252 RenderViewHost* render_view_host,
253 int32 page_id) OVERRIDE;
254 virtual void RequestOpenURL(const GURL& url,
[email protected]445e1042011-12-03 21:03:15255 const content::Referrer& referrer,
[email protected]952a68e2011-11-17 00:36:10256 WindowOpenDisposition disposition,
257 int64 source_frame_id) OVERRIDE;
[email protected]4ad5d77d2011-12-03 02:00:48258 virtual void RequestTransferURL(
259 const GURL& url,
[email protected]bce1f1c2011-12-05 15:11:58260 const content::Referrer& referrer,
[email protected]4ad5d77d2011-12-03 02:00:48261 WindowOpenDisposition disposition,
262 int64 source_frame_id,
[email protected]e5d549d2011-12-28 01:29:20263 const content::GlobalRequestID& transferred_global_request_id) OVERRIDE;
[email protected]952a68e2011-11-17 00:36:10264 virtual void RunJavaScriptMessage(const RenderViewHost* rvh,
265 const string16& message,
266 const string16& default_prompt,
267 const GURL& frame_url,
[email protected]269f86d2011-12-07 02:43:47268 ui::JavascriptMessageType type,
[email protected]952a68e2011-11-17 00:36:10269 IPC::Message* reply_msg,
270 bool* did_suppress_message) OVERRIDE;
271 virtual void RunBeforeUnloadConfirm(const RenderViewHost* rvh,
272 const string16& message,
273 IPC::Message* reply_msg) OVERRIDE;
274 virtual content::RendererPreferences GetRendererPrefs(
275 content::BrowserContext* browser_context) const OVERRIDE;
276 virtual WebPreferences GetWebkitPrefs() OVERRIDE;
277 virtual void OnUserGesture() OVERRIDE;
278 virtual void OnIgnoredUIEvent() OVERRIDE;
279 virtual void RendererUnresponsive(RenderViewHost* render_view_host,
280 bool is_during_unload) OVERRIDE;
281 virtual void RendererResponsive(RenderViewHost* render_view_host) OVERRIDE;
282 virtual void LoadStateChanged(const GURL& url,
283 const net::LoadStateWithParam& load_state,
284 uint64 upload_position,
285 uint64 upload_size) OVERRIDE;
286 virtual void WorkerCrashed() OVERRIDE;
287 virtual void Activate() OVERRIDE;
288 virtual void Deactivate() OVERRIDE;
289 virtual void LostCapture() OVERRIDE;
290 virtual bool PreHandleKeyboardEvent(const NativeWebKeyboardEvent& event,
291 bool* is_keyboard_shortcut) OVERRIDE;
292 virtual void HandleKeyboardEvent(
293 const NativeWebKeyboardEvent& event) OVERRIDE;
294 virtual void HandleMouseDown() OVERRIDE;
295 virtual void HandleMouseUp() OVERRIDE;
296 virtual void HandleMouseActivate() OVERRIDE;
[email protected]edc64de2011-11-17 20:07:38297 virtual void RunFileChooser(
298 RenderViewHost* render_view_host,
[email protected]8caadeb2011-11-22 02:45:23299 const content::FileChooserParams& params) OVERRIDE;
[email protected]952a68e2011-11-17 00:36:10300 virtual void ToggleFullscreenMode(bool enter_fullscreen) OVERRIDE;
301 virtual bool IsFullscreenForCurrentTab() const OVERRIDE;
302 virtual void UpdatePreferredSize(const gfx::Size& pref_size) OVERRIDE;
303 virtual void WebUISend(RenderViewHost* render_view_host,
304 const GURL& source_url,
305 const std::string& name,
306 const base::ListValue& args) OVERRIDE;
307 virtual void RequestToLockMouse() OVERRIDE;
308 virtual void LostMouseLock() OVERRIDE;
309
[email protected]0bfbf882011-12-22 18:19:27310 // RenderViewHostManager::Delegate -------------------------------------------
311
312 virtual bool CreateRenderViewForRenderManager(
313 RenderViewHost* render_view_host) OVERRIDE;
314 virtual void BeforeUnloadFiredFromRenderManager(
315 bool proceed,
316 bool* proceed_to_fire_unload) OVERRIDE;
317 virtual void DidStartLoadingFromRenderManager(
318 RenderViewHost* render_view_host) OVERRIDE;
319 virtual void RenderViewGoneFromRenderManager(
320 RenderViewHost* render_view_host) OVERRIDE;
321 virtual void UpdateRenderViewSizeForRenderManager() OVERRIDE;
322 virtual void NotifySwappedFromRenderManager() OVERRIDE;
[email protected]d202a7c2012-01-04 07:53:47323 virtual NavigationControllerImpl& GetControllerForRenderManager() OVERRIDE;
[email protected]0bfbf882011-12-22 18:19:27324 virtual WebUI* CreateWebUIForRenderManager(const GURL& url) OVERRIDE;
[email protected]ad23a092011-12-28 07:02:04325 virtual content::NavigationEntry*
[email protected]0bfbf882011-12-22 18:19:27326 GetLastCommittedNavigationEntryForRenderManager() OVERRIDE;
327 virtual bool FocusLocationBarByDefault() OVERRIDE;
328 virtual void SetFocusToLocationBar(bool select_all) OVERRIDE;
329 virtual void CreateViewAndSetSizeForRVH(RenderViewHost* rvh) OVERRIDE;
330
331 // Overridden from JavaScriptDialogDelegate:
332 virtual void OnDialogClosed(IPC::Message* reply_msg,
333 bool success,
334 const string16& user_input) OVERRIDE;
335 virtual gfx::NativeWindow GetDialogRootWindow() const OVERRIDE;
336 virtual void OnDialogShown() OVERRIDE;
337
[email protected]0dd3a0ab2011-02-18 08:17:44338 protected:
[email protected]d8c660432011-12-22 20:51:25339 friend class content::WebContentsObserver;
[email protected]553602e12011-04-05 17:01:18340
341 // Add and remove observers for page navigation notifications. Adding or
342 // removing multiple times has no effect. The order in which notifications
343 // are sent to observers is undefined. Clients must be sure to remove the
344 // observer before they go away.
[email protected]d8c660432011-12-22 20:51:25345 void AddObserver(content::WebContentsObserver* observer);
346 void RemoveObserver(content::WebContentsObserver* observer);
[email protected]553602e12011-04-05 17:01:18347
[email protected]0dd3a0ab2011-02-18 08:17:44348 private:
[email protected]d202a7c2012-01-04 07:53:47349 friend class NavigationControllerImpl;
[email protected]0dd3a0ab2011-02-18 08:17:44350
351 FRIEND_TEST_ALL_PREFIXES(TabContentsTest, NoJSMessageOnInterstitials);
352 FRIEND_TEST_ALL_PREFIXES(TabContentsTest, UpdateTitle);
353 FRIEND_TEST_ALL_PREFIXES(TabContentsTest, CrossSiteCantPreemptAfterUnload);
354 FRIEND_TEST_ALL_PREFIXES(FormStructureBrowserTest, HTMLFiles);
355 FRIEND_TEST_ALL_PREFIXES(NavigationControllerTest, HistoryNavigate);
356 FRIEND_TEST_ALL_PREFIXES(RenderViewHostManagerTest, PageDoesBackAndReload);
357
358 // Temporary until the view/contents separation is complete.
359 friend class TabContentsView;
[email protected]9a56a0d2011-05-13 19:03:31360#if defined(TOOLKIT_VIEWS)
[email protected]7e2cef52011-04-11 21:47:23361 friend class TabContentsViewViews;
[email protected]0dd3a0ab2011-02-18 08:17:44362#elif defined(OS_MACOSX)
363 friend class TabContentsViewMac;
364#elif defined(TOOLKIT_USES_GTK)
365 friend class TabContentsViewGtk;
366#endif
367
368 // So InterstitialPage can access SetIsLoading.
369 friend class InterstitialPage;
370
371 // TODO(brettw) TestTabContents shouldn't exist!
372 friend class TestTabContents;
373
[email protected]0dd3a0ab2011-02-18 08:17:44374 // Message handlers.
[email protected]8b5af492011-11-28 21:50:58375 void OnRegisterIntentService(const string16& action,
[email protected]63c239322011-10-31 23:56:30376 const string16& type,
377 const string16& href,
378 const string16& title,
379 const string16& disposition);
[email protected]678105012011-12-09 04:01:21380 void OnWebIntentDispatch(const webkit_glue::WebIntentData& intent,
[email protected]63c239322011-10-31 23:56:30381 int intent_id);
[email protected]0dd3a0ab2011-02-18 08:17:44382 void OnDidStartProvisionalLoadForFrame(int64 frame_id,
383 bool main_frame,
[email protected]57b9396c2011-10-07 19:11:59384 const GURL& opener_url,
[email protected]0dd3a0ab2011-02-18 08:17:44385 const GURL& url);
386 void OnDidRedirectProvisionalLoad(int32 page_id,
[email protected]57b9396c2011-10-07 19:11:59387 const GURL& opener_url,
[email protected]0dd3a0ab2011-02-18 08:17:44388 const GURL& source_url,
389 const GURL& target_url);
[email protected]d7b175e2011-10-11 15:31:58390 void OnDidFailProvisionalLoadWithError(
391 const ViewHostMsg_DidFailProvisionalLoadWithError_Params& params);
[email protected]0dd3a0ab2011-02-18 08:17:44392 void OnDidLoadResourceFromMemoryCache(const GURL& url,
[email protected]70435962011-08-02 20:13:28393 const std::string& security_info,
394 const std::string& http_request,
395 ResourceType::Type resource_type);
[email protected]0dd3a0ab2011-02-18 08:17:44396 void OnDidDisplayInsecureContent();
397 void OnDidRunInsecureContent(const std::string& security_origin,
398 const GURL& target_url);
399 void OnDocumentLoadedInFrame(int64 frame_id);
[email protected]1a55c5be2011-11-29 11:36:31400 void OnDidFinishLoad(int64 frame_id,
401 const GURL& validated_url,
402 bool is_main_frame);
403 void OnDidFailLoadWithError(int64 frame_id,
404 const GURL& validated_url,
405 bool is_main_frame,
406 int error_code,
407 const string16& error_description);
[email protected]0dd3a0ab2011-02-18 08:17:44408 void OnUpdateContentRestrictions(int restrictions);
[email protected]0dd3a0ab2011-02-18 08:17:44409 void OnGoToEntryAtOffset(int offset);
[email protected]216813952011-05-19 22:21:26410 void OnUpdateZoomLimits(int minimum_percent,
411 int maximum_percent,
412 bool remember);
[email protected]0bfbf882011-12-22 18:19:27413 void OnSaveURL(const GURL& url);
[email protected]3a29a6e2011-08-24 18:26:21414 void OnEnumerateDirectory(int request_id, const FilePath& path);
[email protected]7d189022011-08-25 22:54:20415 void OnJSOutOfMemory();
416 void OnRegisterProtocolHandler(const std::string& protocol,
417 const GURL& url,
418 const string16& title);
[email protected]b888919c2011-09-02 00:32:16419 void OnFindReply(int request_id, int number_of_matches,
420 const gfx::Rect& selection_rect, int active_match_ordinal,
421 bool final_update);
[email protected]d952a052011-09-06 18:42:45422 void OnCrashedPlugin(const FilePath& plugin_path);
[email protected]7fc4bbb2011-09-08 21:23:10423 void OnAppCacheAccessed(const GURL& manifest_url, bool blocked_by_policy);
[email protected]0dd3a0ab2011-02-18 08:17:44424
425 // Changes the IsLoading state and notifies delegate as needed
426 // |details| is used to provide details on the load that just finished
427 // (but can be null if not applicable). Can be overridden.
428 void SetIsLoading(bool is_loading,
429 LoadNotificationDetails* details);
430
[email protected]0dd3a0ab2011-02-18 08:17:44431 // Called by derived classes to indicate that we're no longer waiting for a
432 // response. This won't actually update the throbber, but it will get picked
433 // up at the next animation step if the throbber is going.
434 void SetNotWaitingForResponse() { waiting_for_response_ = false; }
435
[email protected]0dd3a0ab2011-02-18 08:17:44436 // Navigation helpers --------------------------------------------------------
437 //
438 // These functions are helpers for Navigate() and DidNavigate().
439
440 // Handles post-navigation tasks in DidNavigate AFTER the entry has been
441 // committed to the navigation controller. Note that the navigation entry is
442 // not provided since it may be invalid/changed after being committed. The
443 // current navigation entry is in the NavigationController at this point.
444 void DidNavigateMainFramePostCommit(
[email protected]8286f51a2011-05-31 17:39:13445 const content::LoadCommittedDetails& details,
[email protected]0dd3a0ab2011-02-18 08:17:44446 const ViewHostMsg_FrameNavigate_Params& params);
447 void DidNavigateAnyFramePostCommit(
448 RenderViewHost* render_view_host,
[email protected]8286f51a2011-05-31 17:39:13449 const content::LoadCommittedDetails& details,
[email protected]0dd3a0ab2011-02-18 08:17:44450 const ViewHostMsg_FrameNavigate_Params& params);
451
[email protected]74ce1ad2011-12-16 21:51:46452 // If our controller was restored, update the max page ID associated with the
453 // given RenderViewHost to be larger than the number of restored entries.
454 // This is called in CreateRenderView before any navigations in the RenderView
455 // have begun, to prevent any races in updating RenderView::next_page_id.
456 void UpdateMaxPageIDIfNecessary(RenderViewHost* rvh);
[email protected]0dd3a0ab2011-02-18 08:17:44457
[email protected]0dd3a0ab2011-02-18 08:17:44458 // Saves the given title to the navigation entry and does associated work. It
459 // will update history and the view for the new title, and also synthesize
460 // titles for file URLs that have none (so we require that the URL of the
461 // entry already be set).
462 //
463 // This is used as the backend for state updates, which include a new title,
464 // or the dedicated set title message. It returns true if the new title is
465 // different and was therefore updated.
[email protected]10f417c52011-12-28 21:04:23466 bool UpdateTitleForEntry(content::NavigationEntryImpl* entry,
467 const string16& title);
[email protected]0dd3a0ab2011-02-18 08:17:44468
469 // Causes the TabContents to navigate in the right renderer to |entry|, which
470 // must be already part of the entries in the navigation controller.
471 // This does not change the NavigationController state.
[email protected]10f417c52011-12-28 21:04:23472 bool NavigateToEntry(const content::NavigationEntryImpl& entry,
[email protected]71fde352011-12-29 03:29:56473 content::NavigationController::ReloadType reload_type);
[email protected]0dd3a0ab2011-02-18 08:17:44474
[email protected]796931a92011-08-10 01:32:14475 // Sets the history for this tab_contents to |history_length| entries, and
476 // moves the current page_id to the last entry in the list if it's valid.
477 // This is mainly used when a prerendered page is swapped into the current
[email protected]9e1ad4b2011-08-14 16:49:19478 // tab. The method is virtual for testing.
479 virtual void SetHistoryLengthAndPrune(const SiteInstance* site_instance,
480 int merge_history_length,
481 int32 minimum_page_id);
[email protected]796931a92011-08-10 01:32:14482
[email protected]0dd3a0ab2011-02-18 08:17:44483 // Misc non-view stuff -------------------------------------------------------
484
485 // Helper functions for sending notifications.
486 void NotifySwapped();
487 void NotifyConnected();
488 void NotifyDisconnected();
489
[email protected]be1f56ab2011-12-22 06:55:31490 void SetEncoding(const std::string& encoding);
491
[email protected]81898992011-06-14 22:15:00492 // Stores random bits of data for others to associate with this object.
493 // WARNING: this needs to be deleted after NavigationController.
[email protected]45644f62011-11-23 00:58:23494 base::PropertyBag property_bag_;
[email protected]81898992011-06-14 22:15:00495
[email protected]0dd3a0ab2011-02-18 08:17:44496 // Data for core operation ---------------------------------------------------
497
498 // Delegate for notifying our owner about stuff. Not owned by us.
[email protected]674bc592011-12-20 23:00:42499 content::WebContentsDelegate* delegate_;
[email protected]0dd3a0ab2011-02-18 08:17:44500
501 // Handles the back/forward list and loading.
[email protected]d202a7c2012-01-04 07:53:47502 NavigationControllerImpl controller_;
[email protected]0dd3a0ab2011-02-18 08:17:44503
504 // The corresponding view.
505 scoped_ptr<TabContentsView> view_;
506
[email protected]996042972011-11-08 22:43:59507 // A list of observers notified when page state changes. Weak references.
508 // This MUST be listed above render_manager_ since at destruction time the
509 // latter might cause RenderViewHost's destructor to call us and we might use
510 // the observer list then.
[email protected]d8c660432011-12-22 20:51:25511 ObserverList<content::WebContentsObserver> observers_;
[email protected]996042972011-11-08 22:43:59512
[email protected]0dd3a0ab2011-02-18 08:17:44513 // Helper classes ------------------------------------------------------------
514
515 // Manages creation and swapping of render views.
516 RenderViewHostManager render_manager_;
517
[email protected]483623eb2011-10-25 09:30:00518 // Manages injecting Java objects into all RenderViewHosts associated with
519 // this TabContents.
520 scoped_ptr<JavaBridgeDispatcherHostManager>
521 java_bridge_dispatcher_host_manager_;
522
[email protected]c7dd2f62011-07-18 15:57:59523 // SavePackage, lazily created.
524 scoped_refptr<SavePackage> save_package_;
525
[email protected]0dd3a0ab2011-02-18 08:17:44526 // Data for loading state ----------------------------------------------------
527
528 // Indicates whether we're currently loading a resource.
529 bool is_loading_;
530
531 // Indicates if the tab is considered crashed.
532 base::TerminationStatus crashed_status_;
533 int crashed_error_code_;
534
[email protected]be1f56ab2011-12-22 06:55:31535 // Whether this tab contents is waiting for a first-response for the
536 // main resource of the page. This controls whether the throbber state is
537 // "waiting" or "loading."
[email protected]0dd3a0ab2011-02-18 08:17:44538 bool waiting_for_response_;
539
[email protected]74ce1ad2011-12-16 21:51:46540 // Map of SiteInstance ID to max page ID for this tab. A page ID is specific
541 // to a given tab and SiteInstance, and must be valid for the lifetime of the
542 // TabContents.
543 std::map<int32, int32> max_page_ids_;
[email protected]0dd3a0ab2011-02-18 08:17:44544
545 // System time at which the current load was started.
546 base::TimeTicks current_load_start_;
547
548 // The current load state and the URL associated with it.
[email protected]9c235f042011-08-10 22:28:21549 net::LoadStateWithParam load_state_;
[email protected]0dd3a0ab2011-02-18 08:17:44550 string16 load_state_host_;
551 // Upload progress, for displaying in the status bar.
552 // Set to zero when there is no significant upload happening.
553 uint64 upload_size_;
554 uint64 upload_position_;
555
556 // Data for current page -----------------------------------------------------
557
[email protected]987fc3a2011-05-26 14:18:09558 // When a title cannot be taken from any entry, this title will be used.
559 string16 page_title_when_no_navigation_entry_;
560
[email protected]0dd3a0ab2011-02-18 08:17:44561 // When a navigation occurs, we record its contents MIME type. It can be
562 // used to check whether we can do something for some special contents.
563 std::string contents_mime_type_;
564
565 // Character encoding.
566 std::string encoding_;
567
[email protected]0dd3a0ab2011-02-18 08:17:44568 // True if this is a secure page which displayed insecure content.
569 bool displayed_insecure_content_;
570
[email protected]0dd3a0ab2011-02-18 08:17:44571 // Data for misc internal state ----------------------------------------------
572
[email protected]be1f56ab2011-12-22 06:55:31573 // Whether the tab contents is currently being screenshotted by the
574 // DraggedTabController.
[email protected]0dd3a0ab2011-02-18 08:17:44575 bool capturing_contents_;
576
577 // See getter above.
578 bool is_being_destroyed_;
579
580 // Indicates whether we should notify about disconnection of this
581 // TabContents. This is used to ensure disconnection notifications only
582 // happen if a connection notification has happened and that they happen only
583 // once.
584 bool notify_disconnection_;
585
[email protected]2e5b90c2011-08-16 21:11:55586 // Pointer to the JavaScript dialog creator, lazily assigned. Used because the
587 // delegate of this TabContents is nulled before its destructor is called.
588 content::JavaScriptDialogCreator* dialog_creator_;
589
[email protected]0dd3a0ab2011-02-18 08:17:44590#if defined(OS_WIN)
591 // Handle to an event that's set when the page is showing a message box (or
592 // equivalent constrained window). Plugin processes check this to know if
593 // they should pump messages then.
594 base::win::ScopedHandle message_box_active_;
595#endif
596
[email protected]0dd3a0ab2011-02-18 08:17:44597 // Set to true when there is an active "before unload" dialog. When true,
598 // we've forced the throbber to start in Navigate, and we need to remember to
599 // turn it off in OnJavaScriptMessageBoxClosed if the navigation is canceled.
600 bool is_showing_before_unload_dialog_;
601
[email protected]0dd3a0ab2011-02-18 08:17:44602 // Settings that get passed to the renderer process.
[email protected]daf82f82011-10-31 22:35:31603 content::RendererPreferences renderer_preferences_;
[email protected]0dd3a0ab2011-02-18 08:17:44604
605 // If this tab was created from a renderer using window.open, this will be
606 // non-NULL and represent the WebUI of the opening renderer.
[email protected]1fd1a502011-03-30 16:55:56607 WebUI::TypeID opener_web_ui_type_;
[email protected]0dd3a0ab2011-02-18 08:17:44608
609 // The time that we started to create the new tab page.
610 base::TimeTicks new_tab_start_time_;
611
612 // The time that we started to close the tab.
613 base::TimeTicks tab_close_start_time_;
614
615 // The time that this tab was last selected.
616 base::TimeTicks last_selected_time_;
617
[email protected]0dd3a0ab2011-02-18 08:17:44618 // See description above setter.
619 bool closed_by_user_gesture_;
620
621 // Minimum/maximum zoom percent.
622 int minimum_zoom_percent_;
623 int maximum_zoom_percent_;
624 // If true, the default zoom limits have been overriden for this tab, in which
625 // case we don't want saved settings to apply to it and we don't want to
626 // remember it.
627 bool temporary_zoom_settings_;
628
[email protected]0dd3a0ab2011-02-18 08:17:44629 // Content restrictions, used to disable print/copy etc based on content's
630 // (full-page plugins for now only) permissions.
631 int content_restrictions_;
632
[email protected]32ded2212011-11-10 18:51:43633 // Our view type. Default is VIEW_TYPE_TAB_CONTENTS.
634 content::ViewType view_type_;
635
[email protected]0dd3a0ab2011-02-18 08:17:44636 DISALLOW_COPY_AND_ASSIGN(TabContents);
637};
638
639#endif // CONTENT_BROWSER_TAB_CONTENTS_TAB_CONTENTS_H_