ios/components/security_interstitials/ios_security_interstitial_page.h

// Copyright 2015 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_COMPONENTS_SECURITY_INTERSTITIALS_IOS_SECURITY_INTERSTITIAL_PAGE_H_
#define IOS_COMPONENTS_SECURITY_INTERSTITIALS_IOS_SECURITY_INTERSTITIAL_PAGE_H_

#include <string>

#include "base/macros.h"
#include "base/strings/string16.h"
#include "ios/components/security_interstitials/ios_blocking_page_controller_client.h"
#include "ios/web/public/security/web_interstitial_delegate.h"
#include "url/gurl.h"

namespace base {
class DictionaryValue;
}

namespace web {
class WebFrame;
class WebInterstitial;
class WebState;
}  // namespace web

namespace security_interstitials {

class IOSSecurityInterstitialPage : public web::WebInterstitialDelegate {
 public:
  IOSSecurityInterstitialPage(web::WebState* web_state,
                              const GURL& request_url,
                              IOSBlockingPageControllerClient* client);
  ~IOSSecurityInterstitialPage() override;

  // Creates an interstitial and shows it.
  void Show();

  // web::WebInterstitialDelegate implementation.
  std::string GetHtmlContents() const override;

  // Handles JS commands from the interstitial page. Overridden in subclasses
  // to handle actions specific to the type of interstitial.
  virtual void HandleScriptCommand(const base::DictionaryValue& message,
                                   const GURL& origin_url,
                                   bool user_is_interacting,
                                   web::WebFrame* sender_frame) = 0;

 protected:
  // Returns true if the interstitial should create a new navigation item.
  virtual bool ShouldCreateNewNavigation() const = 0;

  // Populates the strings used to generate the HTML from the template.
  virtual void PopulateInterstitialStrings(
      base::DictionaryValue* load_time_data) const = 0;

  // Gives an opportunity for child classes to react to Show() having run. The
  // |web_interstitial_| will now have a value.
  virtual void AfterShow() = 0;

  // Returns the formatted host name for the request url.
  base::string16 GetFormattedHostName() const;

  web::WebState* web_state() const { return web_state_; }
  const GURL& request_url() const { return request_url_; }
  web::WebInterstitial* web_interstitial() const { return web_interstitial_; }

 private:
  // The WebState with which this interstitial page is associated. Not
  // available in the destructor since the it can be destroyed before this
  // class is destroyed.
  web::WebState* web_state_;
  const GURL request_url_;

  // Once non-null, the |web_interstitial_| takes ownership of this
  // IOSSecurityInterstitialPage instance.
  web::WebInterstitial* web_interstitial_;

  // Used to interact with the embedder. Unowned pointer; must outlive |this|
  // instance.
  IOSBlockingPageControllerClient* const client_ = nullptr;

  DISALLOW_COPY_AND_ASSIGN(IOSSecurityInterstitialPage);
};

}  // namespace security_interstitials

#endif  // IOS_COMPONENTS_SECURITY_INTERSTITIALS_IOS_SECURITY_INTERSTITIAL_PAGE_H_