src/chrome/browser/ui/toolbar/toolbar_model.h

   1 // Copyright 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_UI_TOOLBAR_TOOLBAR_MODEL_H_
   6 #define CHROME_BROWSER_UI_TOOLBAR_TOOLBAR_MODEL_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/strings/string16.h"
  12 #include "url/gurl.h"
  13
  14 namespace net {
  15 class X509Certificate;
  16 }
  17
  18 // This class is the model used by the toolbar, location bar and autocomplete
  19 // edit.  It populates its states from the current navigation entry retrieved
  20 // from the navigation controller returned by GetNavigationController().
  21 class ToolbarModel {
  22  public:
  23   // TODO(wtc): unify ToolbarModel::SecurityLevel with SecurityStyle.  We
  24   // don't need two sets of security UI levels.  SECURITY_STYLE_AUTHENTICATED
  25   // needs to be refined into three levels: warning, standard, and EV.
  26   //
  27   // A Java counterpart will be generated for this enum.
  28   // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.chrome.browser.ui.toolbar
  29   // GENERATED_JAVA_CLASS_NAME_OVERRIDE: ToolbarModelSecurityLevel
  30   enum SecurityLevel {
  31     // HTTP/no URL/user is editing
  32     NONE = 0,
  33
  34     // HTTPS with valid EV cert
  35     EV_SECURE = 1,
  36
  37     // HTTPS (non-EV)
  38     SECURE = 2,
  39
  40     // HTTPS, but unable to check certificate revocation status or with insecure
  41     // content on the page
  42     SECURITY_WARNING = 3,
  43
  44     // HTTPS, but the certificate verification chain is anchored on a
  45     // certificate that was installed by the system administrator
  46     SECURITY_POLICY_WARNING = 4,
  47
  48     // Attempted HTTPS and failed, page not authenticated
  49     SECURITY_ERROR = 5,
  50
  51     NUM_SECURITY_LEVELS = 6,
  52   };
  53
  54   virtual ~ToolbarModel();
  55
  56   // Returns the text to be displayed in the toolbar for the current page.
  57   // The text is formatted in various ways:
  58   //   - If the current page's URL is a search URL for the user's default search
  59   //     engine, the query will be extracted and returned for display instead
  60   //     of the URL.
  61   //   - If the origin chip is enabled and visible, the text will be empty.
  62   //   - Otherwise, the text will contain the URL returned by GetFormattedURL().
  63   virtual base::string16 GetText() const = 0;
  64
  65   // Returns a formatted URL for display in the toolbar. The formatting
  66   // includes:
  67   //   - Some characters may be unescaped.
  68   //   - The scheme and/or trailing slash may be dropped.
  69   // If |prefix_end| is non-NULL, it is set to the length of the pre-hostname
  70   // portion of the resulting URL.
  71   virtual base::string16 GetFormattedURL(size_t* prefix_end) const = 0;
  72
  73   // Some search URLs bundle a special "corpus" param that we can extract and
  74   // display next to users' search terms in cases where we'd show the search
  75   // terms instead of the URL anyway.  For example, a Google image search might
  76   // show the corpus "Images:" plus a search string.  This is only used on
  77   // mobile.
  78   virtual base::string16 GetCorpusNameForMobile() const = 0;
  79
  80   // Returns the URL of the current navigation entry.
  81   virtual GURL GetURL() const = 0;
  82
  83   // Returns true if a call to GetText() would successfully replace the URL
  84   // with search terms.  If |ignore_editing| is true, the result reflects the
  85   // underlying state of the page without regard to any user edits that may be
  86   // in progress in the omnibox.
  87   virtual bool WouldPerformSearchTermReplacement(bool ignore_editing) const = 0;
  88
  89   // Returns true if a call to GetText() would return something other than the
  90   // URL because of either search term replacement or URL omission in favor of
  91   // the origin chip.
  92   bool WouldReplaceURL() const;
  93
  94   // Returns the security level that the toolbar should display.  If
  95   // |ignore_editing| is true, the result reflects the underlying state of the
  96   // page without regard to any user edits that may be in progress in the
  97   // omnibox.
  98   virtual SecurityLevel GetSecurityLevel(bool ignore_editing) const = 0;
  99
 100   // Returns the resource_id of the icon to show to the left of the address,
 101   // based on the current URL.  When search term replacement is active, this
 102   // returns a search icon.  This doesn't cover specialized icons while the
 103   // user is editing; see OmniboxView::GetIcon().
 104   virtual int GetIcon() const = 0;
 105
 106   // As |GetIcon()|, but returns the icon only taking into account the security
 107   // |level| given, ignoring search term replacement state.
 108   virtual int GetIconForSecurityLevel(SecurityLevel level) const = 0;
 109
 110   // Returns the name of the EV cert holder.  This returns an empty string if
 111   // the security level is not EV_SECURE.
 112   virtual base::string16 GetEVCertName() const = 0;
 113
 114   // Returns whether the URL for the current navigation entry should be
 115   // in the location bar.
 116   virtual bool ShouldDisplayURL() const = 0;
 117
 118   // Returns true if a call to GetText() would return an empty string instead of
 119   // the URL that would have otherwise been displayed because the host/origin is
 120   // instead being displayed in the origin chip.  This returns false when we
 121   // wouldn't have displayed a URL to begin with (e.g. for the NTP).
 122   virtual bool WouldOmitURLDueToOriginChip() const = 0;
 123
 124   // Returns true if the origin should be shown based on the current state of
 125   // the ToolbarModel.
 126   bool ShouldShowOriginChip() const;
 127
 128   // Whether the text in the omnibox is currently being edited.
 129   void set_input_in_progress(bool input_in_progress) {
 130     input_in_progress_ = input_in_progress;
 131   }
 132   bool input_in_progress() const { return input_in_progress_; }
 133
 134   // Whether the origin chip should be enabled.
 135   void set_origin_chip_enabled(bool enabled) {
 136     origin_chip_enabled_ = enabled;
 137   }
 138   bool origin_chip_enabled() const {
 139     return origin_chip_enabled_;
 140   }
 141
 142   // Whether URL replacement should be enabled.
 143   void set_url_replacement_enabled(bool enabled) {
 144     url_replacement_enabled_ = enabled;
 145   }
 146   bool url_replacement_enabled() const {
 147     return url_replacement_enabled_;
 148   }
 149
 150  protected:
 151   ToolbarModel();
 152
 153  private:
 154   bool input_in_progress_;
 155   bool origin_chip_enabled_;
 156   bool url_replacement_enabled_;
 157
 158   DISALLOW_COPY_AND_ASSIGN(ToolbarModel);
 159 };
 160
 161 #endif  // CHROME_BROWSER_UI_TOOLBAR_TOOLBAR_MODEL_H_