15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_BROWSER_CAPTIVE_PORTAL_CAPTIVE_PORTAL_TAB_HELPER_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_CAPTIVE_PORTAL_CAPTIVE_PORTAL_TAB_HELPER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/threading/non_thread_safe.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/captive_portal/captive_portal_service.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/notification_observer.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/notification_registrar.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/web_contents_observer.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/web_contents_user_data.h" 17ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#include "webkit/common/resource_type.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class GURL; 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Profile; 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace content { 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class WebContents; 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SSLInfo; 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace captive_portal { 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class CaptivePortalLoginDetector; 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class CaptivePortalTabReloader; 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Along with the classes it owns, responsible for detecting page loads broken 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// by a captive portal, triggering captive portal checks on navigation events 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// that may indicate a captive portal is present, or has been removed / logged 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in to, and taking any correcting actions. 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// It acts as a WebContentsObserver for its CaptivePortalLoginDetector and 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// CaptivePortalTabReloader. It filters out non-main-frame resource loads, and 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// treats the commit of an error page as a single event, rather than as 3 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (ProvisionalLoadFail, DidStartProvisionalLoad, DidCommit), which simplifies 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the CaptivePortalTabReloader. It is also needed by CaptivePortalTabReloaders 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// to inform the tab's CaptivePortalLoginDetector when the tab is at a captive 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// portal's login page. 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The TabHelper assumes that a WebContents can only have one RenderViewHost 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// with a provisional load at a time, and tracks only that navigation. This 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// assumption can be violated in rare cases, for example, a same-site 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// navigation interrupted by a cross-process navigation started from the 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// omnibox, may commit before it can be cancelled. In these cases, this class 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// may pass incorrect messages to the TabReloader, which will, at worst, result 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in not opening up a login tab until a second load fails or not automatically 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// reloading a tab after logging in. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// For the design doc, see: 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// https://docs.google.com/document/d/1k-gP2sswzYNvryu9NcgN7q5XrsMlUdlUdoW9WRaEmfM/edit 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class CaptivePortalTabHelper 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) : public content::WebContentsObserver, 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public content::NotificationObserver, 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public base::NonThreadSafe, 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public content::WebContentsUserData<CaptivePortalTabHelper> { 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~CaptivePortalTabHelper(); 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // content::WebContentsObserver: 682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void RenderViewDeleted( 692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) content::RenderViewHost* render_view_host) OVERRIDE; 702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void DidStartProvisionalLoadForFrame( 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 frame_id, 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 parent_frame_id, 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_main_frame, 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const GURL& validated_url, 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_error_page, 772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool is_iframe_srcdoc, 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::RenderViewHost* render_view_host) OVERRIDE; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void DidCommitProvisionalLoadForFrame( 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 frame_id, 82a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) const base::string16& frame_unique_name, 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_main_frame, 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const GURL& url, 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::PageTransition transition_type, 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::RenderViewHost* render_view_host) OVERRIDE; 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void DidFailProvisionalLoad( 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 frame_id, 90a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) const base::string16& frame_unique_name, 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_main_frame, 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const GURL& validated_url, 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int error_code, 94a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) const base::string16& error_description, 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::RenderViewHost* render_view_host) OVERRIDE; 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void DidStopLoading( 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::RenderViewHost* render_view_host) OVERRIDE; 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // content::NotificationObserver: 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Observe( 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int type, 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const content::NotificationSource& source, 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const content::NotificationDetails& details) OVERRIDE; 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a certificate interstitial error page is about to be shown. 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnSSLCertError(const net::SSLInfo& ssl_info); 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A "Login Tab" is a tab that was originally at a captive portal login 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // page. This is set to false when a captive portal is no longer detected. 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool IsLoginTab() const; 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class CaptivePortalBrowserTest; 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class CaptivePortalTabHelperTest; 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class content::WebContentsUserData<CaptivePortalTabHelper>; 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit CaptivePortalTabHelper(content::WebContents* web_contents); 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called by Observe in response to the corresponding event. 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnRedirect(int child_id, 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ResourceType::Type resource_type, 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const GURL& new_url); 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called by Observe in response to the corresponding event. 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnCaptivePortalResults(Result previous_result, Result result); 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnLoadAborted(); 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called to indicate a tab is at, or is navigating to, the captive portal 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // login page. 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetIsLoginTab(); 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |this| takes ownership of |tab_reloader|. 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetTabReloaderForTest(CaptivePortalTabReloader* tab_reloader); 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const content::RenderViewHost* provisional_render_view_host() const { 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return provisional_render_view_host_; 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CaptivePortalTabReloader* GetTabReloaderForTest(); 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Opens a login tab if the profile's active window doesn't have one already. 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OpenLoginTab(); 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Profile* profile_; 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Neither of these will ever be NULL. 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<CaptivePortalTabReloader> tab_reloader_; 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<CaptivePortalLoginDetector> login_detector_; 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::WebContents* web_contents_; 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If a provisional load has failed, and the tab is loading an error page, the 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // error code associated with the error page we're loading. 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // net::OK, otherwise. 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int pending_error_code_; 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The RenderViewHost with a provisional load, if any. Can either be 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the currently displayed RenderViewHost or a pending RenderViewHost for 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // cross-process navitations. NULL when there's currently no provisional 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // load. 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::RenderViewHost* provisional_render_view_host_; 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::NotificationRegistrar registrar_; 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(CaptivePortalTabHelper); 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace captive_portal 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_CAPTIVE_PORTAL_CAPTIVE_PORTAL_TAB_HELPER_H_ 173