ios/chrome/browser/ssl/ios_ssl_error_tab_helper.h

// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef IOS_CHROME_BROWSER_SSL_IOS_SSL_ERROR_TAB_HELPER_H_
#define IOS_CHROME_BROWSER_SSL_IOS_SSL_ERROR_TAB_HELPER_H_

#include "ios/chrome/browser/interstitials/ios_security_interstitial_page.h"
#include "ios/web/public/web_state/web_state_observer.h"
#import "ios/web/public/web_state/web_state_user_data.h"

namespace web {
class WebState;
}  // namespace web

// Helps manage IOSSecurityInterstitialPage lifetime independent from
// interstitial code. Stores an IOSSecurityInterstitialPage while an SSL error
// is currently being shown, then cleans it up when the user navigates away
// from the SSL error.
class IOSSSLErrorTabHelper
    : public web::WebStateObserver,
      public web::WebStateUserData<IOSSSLErrorTabHelper> {
 public:
  ~IOSSSLErrorTabHelper() override;

  // Associates |blocking_page| with an IOSSSLErrorTabHelper to manage the
  // |blocking_page|'s lifetime.
  static void AssociateBlockingPage(
      web::WebState* web_state,
      int64_t navigation_id,
      std::unique_ptr<IOSSecurityInterstitialPage> blocking_page);

  // web::WebStateObserver implementation.
  void DidFinishNavigation(web::WebState* web_state,
                           web::NavigationContext* navigation_context) override;
  void WebStateDestroyed(web::WebState* web_state) override;

 private:
  explicit IOSSSLErrorTabHelper(web::WebState* web_state);
  friend class web::WebStateUserData<IOSSSLErrorTabHelper>;

  void SetBlockingPage(
      int64_t navigation_id,
      std::unique_ptr<IOSSecurityInterstitialPage> blocking_page);

  // Keeps track of blocking pages for navigations that have encountered
  // certificate errors in this WebState. When a navigation commits, the
  // corresponding blocking page is moved out and stored in
  // |blocking_page_for_currently_committed_navigation_|.
  std::map<int64_t, std::unique_ptr<IOSSecurityInterstitialPage>>
      blocking_pages_for_navigations_;
  // Keeps track of the blocking page for the currently committed navigation, if
  // there is one. The value is replaced (if the new committed navigation has a
  // blocking page) or reset on every committed navigation.
  std::unique_ptr<IOSSecurityInterstitialPage>
      blocking_page_for_currently_committed_navigation_;

  // The WebState this instance is observing. Will be null after
  // WebStateDestroyed has been called.
  web::WebState* web_state_ = nullptr;

  WEB_STATE_USER_DATA_KEY_DECL();

  DISALLOW_COPY_AND_ASSIGN(IOSSSLErrorTabHelper);
};

#endif  // IOS_CHROME_BROWSER_SSL_IOS_SSL_ERROR_TAB_HELPER_H_