1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
// Copyright (c) 2012 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 CHROME_BROWSER_UI_WEBSITE_SETTINGS_WEBSITE_SETTINGS_UI_H_
#define CHROME_BROWSER_UI_WEBSITE_SETTINGS_WEBSITE_SETTINGS_UI_H_
#include <string>
#include <vector>
#include "base/memory/scoped_ptr.h"
#include "base/strings/string16.h"
#include "chrome/browser/ui/website_settings/website_settings.h"
#include "components/content_settings/core/common/content_settings.h"
#include "components/content_settings/core/common/content_settings_types.h"
#include "content/public/browser/permission_type.h"
#include "ui/gfx/native_widget_types.h"
class GURL;
class Profile;
class WebsiteSettings;
namespace base {
class Value;
};
namespace gfx {
class Image;
}
// The class |WebsiteSettingsUI| specifies the platform independent
// interface of the website settings UI. The website settings UI displays
// information and controls for site specific data (local stored objects like
// cookies), site specific permissions (location, popup, plugin, etc.
// permissions) and site specific information (identity, connection status,
// etc.).
class WebsiteSettingsUI {
public:
// The Website Settings UI contains several tabs. Each tab is associated with
// a unique tab id. The enum |TabId| contains all the ids for the tabs.
enum TabId {
TAB_ID_PERMISSIONS = 0,
TAB_ID_CONNECTION,
NUM_TAB_IDS,
};
// |CookieInfo| contains information about the cookies from a specific source.
// A source can for example be a specific origin or an entire wildcard domain.
struct CookieInfo {
CookieInfo();
// String describing the cookie source.
std::string cookie_source;
// The number of allowed cookies.
int allowed;
// The number of blocked cookies.
int blocked;
// Whether these cookies are from the current top-level origin as seen by
// the user, or from third-party origins.
bool is_first_party;
};
// |PermissionInfo| contains information about a single permission |type| for
// the current website.
struct PermissionInfo {
PermissionInfo();
// Site permission |type|.
ContentSettingsType type;
// The current value for the permission |type| (e.g. ALLOW or BLOCK).
ContentSetting setting;
// The global default settings for this permission |type|.
ContentSetting default_setting;
// The settings source e.g. user, extensions, policy, ... .
content_settings::SettingSource source;
// Whether the profile is off the record.
bool is_incognito;
};
// |ChosenObjectInfo| contains information about a single |object| of a
// chooser |type| that the current website has been granted access to.
struct ChosenObjectInfo {
ChosenObjectInfo(const WebsiteSettings::ChooserUIInfo& ui_info,
scoped_ptr<base::DictionaryValue> object);
~ChosenObjectInfo();
// |ui_info| for this chosen object type.
const WebsiteSettings::ChooserUIInfo& ui_info;
// The opaque |object| representing the thing the user selected.
scoped_ptr<base::DictionaryValue> object;
};
// |IdentityInfo| contains information about the site's identity and
// connection.
struct IdentityInfo {
IdentityInfo();
~IdentityInfo();
// The site's identity: the certificate's Organization Name for sites with
// Extended Validation certificates, or the URL's hostname for all other
// sites.
std::string site_identity;
// Status of the site's identity.
WebsiteSettings::SiteIdentityStatus identity_status;
// Helper to get the status text to display to the user.
base::string16 GetSecuritySummary() const;
// Textual description of the site's identity status that is displayed to
// the user.
std::string identity_status_description;
// The ID is the server certificate of a secure connection or 0.
int cert_id;
// Status of the site's connection.
WebsiteSettings::SiteConnectionStatus connection_status;
// Textual description of the site's connection status that is displayed to
// the user.
std::string connection_status_description;
// Set when the user has explicitly bypassed an SSL error for this host and
// has a flag set to remember ssl decisions (explicit flag or in the
// experimental group). When |show_ssl_decision_revoke_button| is true, the
// connection area of the page info will include an option for the user to
// revoke their decision to bypass the SSL error for this host.
bool show_ssl_decision_revoke_button;
};
using CookieInfoList = std::vector<CookieInfo>;
using PermissionInfoList = std::vector<PermissionInfo>;
using ChosenObjectInfoList = std::vector<ChosenObjectInfo*>;
virtual ~WebsiteSettingsUI();
// Returns the UI string for the given permission |type|.
static base::string16 PermissionTypeToUIString(ContentSettingsType type);
// Returns the UI string for the given permission |value|, used in the
// permission-changing menu. Generally this will be a verb in the imperative
// form, e.g. "ask", "allow", "block".
static base::string16 PermissionValueToUIString(ContentSetting value);
// Returns the UI string describing the action taken for a permission,
// including why that action was taken. E.g. "Allowed by you",
// "Blocked by default".
static base::string16 PermissionActionToUIString(
ContentSettingsType type,
ContentSetting setting,
ContentSetting default_setting,
content_settings::SettingSource source);
// Returns the icon resource ID for the given permission |type| and |setting|.
static int GetPermissionIconID(ContentSettingsType type,
ContentSetting setting);
// Returns the icon for the given permissionInfo |info|. If |info|'s current
// setting is CONTENT_SETTING_DEFAULT, it will return the icon for |info|'s
// default setting.
static const gfx::Image& GetPermissionIcon(const PermissionInfo& info);
// Returns the UI string describing the given object |info|.
static base::string16 ChosenObjectToUIString(const ChosenObjectInfo& info);
// Returns the icon for the given object |info|.
static const gfx::Image& GetChosenObjectIcon(const ChosenObjectInfo& info,
bool deleted);
// Returns the identity icon ID for the given identity |status|.
static int GetIdentityIconID(WebsiteSettings::SiteIdentityStatus status);
// Returns the identity icon for the given identity |status|.
static const gfx::Image& GetIdentityIcon(
WebsiteSettings::SiteIdentityStatus status);
// Returns the connection icon ID for the given connection |status|.
static int GetConnectionIconID(
WebsiteSettings::SiteConnectionStatus status);
// Returns the connection icon for the given connection |status|.
static const gfx::Image& GetConnectionIcon(
WebsiteSettings::SiteConnectionStatus status);
// Sets cookie information.
virtual void SetCookieInfo(const CookieInfoList& cookie_info_list) = 0;
// Sets permission information. The callee is expected to take ownership of
// the objects in |chosen_object_info_list|.
virtual void SetPermissionInfo(
const PermissionInfoList& permission_info_list,
const ChosenObjectInfoList& chosen_object_info_list) = 0;
// Sets site identity information.
virtual void SetIdentityInfo(const IdentityInfo& identity_info) = 0;
// Selects the tab with the given |tab_id|.
virtual void SetSelectedTab(TabId tab_id) = 0;
};
typedef WebsiteSettingsUI::CookieInfoList CookieInfoList;
typedef WebsiteSettingsUI::PermissionInfoList PermissionInfoList;
typedef WebsiteSettingsUI::ChosenObjectInfoList ChosenObjectInfoList;
#endif // CHROME_BROWSER_UI_WEBSITE_SETTINGS_WEBSITE_SETTINGS_UI_H_
|
