1 // Copyright (c) 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.
5 #include "chrome/browser/ui/webui/options/options_ui.h"
10 #include "base/basictypes.h"
11 #include "base/callback.h"
12 #include "base/command_line.h"
13 #include "base/memory/ref_counted_memory.h"
14 #include "base/memory/singleton.h"
15 #include "base/message_loop/message_loop.h"
16 #include "base/strings/string_piece.h"
17 #include "base/strings/string_util.h"
18 #include "base/threading/thread.h"
19 #include "base/time/time.h"
20 #include "base/values.h"
21 #include "chrome/browser/autocomplete/autocomplete_match.h"
22 #include "chrome/browser/autocomplete/autocomplete_result.h"
23 #include "chrome/browser/browser_about_handler.h"
24 #include "chrome/browser/browser_process.h"
25 #include "chrome/browser/profiles/profile.h"
26 #include "chrome/browser/ui/webui/metrics_handler.h"
27 #include "chrome/browser/ui/webui/options/autofill_options_handler.h"
28 #include "chrome/browser/ui/webui/options/automatic_settings_reset_handler.h"
29 #include "chrome/browser/ui/webui/options/browser_options_handler.h"
30 #include "chrome/browser/ui/webui/options/clear_browser_data_handler.h"
31 #include "chrome/browser/ui/webui/options/content_settings_handler.h"
32 #include "chrome/browser/ui/webui/options/cookies_view_handler.h"
33 #include "chrome/browser/ui/webui/options/core_options_handler.h"
34 #include "chrome/browser/ui/webui/options/create_profile_handler.h"
35 #include "chrome/browser/ui/webui/options/font_settings_handler.h"
36 #include "chrome/browser/ui/webui/options/handler_options_handler.h"
37 #include "chrome/browser/ui/webui/options/home_page_overlay_handler.h"
38 #include "chrome/browser/ui/webui/options/import_data_handler.h"
39 #include "chrome/browser/ui/webui/options/language_dictionary_overlay_handler.h"
40 #include "chrome/browser/ui/webui/options/language_options_handler.h"
41 #include "chrome/browser/ui/webui/options/manage_profile_handler.h"
42 #include "chrome/browser/ui/webui/options/managed_user_create_confirm_handler.h"
43 #include "chrome/browser/ui/webui/options/managed_user_import_handler.h"
44 #include "chrome/browser/ui/webui/options/managed_user_learn_more_handler.h"
45 #include "chrome/browser/ui/webui/options/media_devices_selection_handler.h"
46 #include "chrome/browser/ui/webui/options/media_galleries_handler.h"
47 #include "chrome/browser/ui/webui/options/password_manager_handler.h"
48 #include "chrome/browser/ui/webui/options/reset_profile_settings_handler.h"
49 #include "chrome/browser/ui/webui/options/search_engine_manager_handler.h"
50 #include "chrome/browser/ui/webui/options/startup_pages_handler.h"
51 #include "chrome/browser/ui/webui/sync_setup_handler.h"
52 #include "chrome/browser/ui/webui/theme_source.h"
53 #include "chrome/common/url_constants.h"
54 #include "content/public/browser/notification_types.h"
55 #include "content/public/browser/render_view_host.h"
56 #include "content/public/browser/url_data_source.h"
57 #include "content/public/browser/web_contents.h"
58 #include "content/public/browser/web_contents_delegate.h"
59 #include "content/public/browser/web_ui.h"
60 #include "grit/chromium_strings.h"
61 #include "grit/generated_resources.h"
62 #include "grit/locale_settings.h"
63 #include "grit/options_resources.h"
64 #include "grit/theme_resources.h"
65 #include "net/base/escape.h"
66 #include "ui/base/l10n/l10n_util.h"
67 #include "ui/base/resource/resource_bundle.h"
68 #include "ui/base/webui/jstemplate_builder.h"
69 #include "ui/base/webui/web_ui_util.h"
72 #if defined(OS_CHROMEOS)
73 #include "chrome/browser/chromeos/system/pointer_device_observer.h"
74 #include "chrome/browser/ui/webui/options/chromeos/accounts_options_handler.h"
75 #include "chrome/browser/ui/webui/options/chromeos/bluetooth_options_handler.h"
76 #include "chrome/browser/ui/webui/options/chromeos/change_picture_options_handler.h"
77 #include "chrome/browser/ui/webui/options/chromeos/core_chromeos_options_handler.h"
78 #include "chrome/browser/ui/webui/options/chromeos/cros_language_options_handler.h"
79 #include "chrome/browser/ui/webui/options/chromeos/display_options_handler.h"
80 #include "chrome/browser/ui/webui/options/chromeos/display_overscan_handler.h"
81 #include "chrome/browser/ui/webui/options/chromeos/internet_options_handler.h"
82 #include "chrome/browser/ui/webui/options/chromeos/keyboard_handler.h"
83 #include "chrome/browser/ui/webui/options/chromeos/pointer_handler.h"
84 #include "chrome/browser/ui/webui/options/chromeos/proxy_handler.h"
85 #include "chrome/browser/ui/webui/options/chromeos/stats_options_handler.h"
86 #include "chrome/browser/ui/webui/options/chromeos/user_image_source.h"
90 #include "chrome/browser/ui/webui/options/certificate_manager_handler.h"
93 #if defined(ENABLE_GOOGLE_NOW)
94 #include "chrome/browser/ui/webui/options/geolocation_options_handler.h"
97 using content::RenderViewHost;
101 const char kLocalizedStringsFile[] = "strings.js";
102 const char kOptionsBundleJsFile[] = "options_bundle.js";
108 ////////////////////////////////////////////////////////////////////////////////
110 // OptionsUIHTMLSource
112 ////////////////////////////////////////////////////////////////////////////////
114 class OptionsUIHTMLSource : public content::URLDataSource {
116 // The constructor takes over ownership of |localized_strings|.
117 explicit OptionsUIHTMLSource(base::DictionaryValue* localized_strings);
119 // content::URLDataSource implementation.
120 virtual std::string GetSource() const OVERRIDE;
121 virtual void StartDataRequest(
122 const std::string& path,
123 int render_process_id,
125 const content::URLDataSource::GotDataCallback& callback) OVERRIDE;
126 virtual std::string GetMimeType(const std::string&) const OVERRIDE;
127 virtual bool ShouldDenyXFrameOptions() const OVERRIDE;
130 virtual ~OptionsUIHTMLSource();
132 // Localized strings collection.
133 scoped_ptr<base::DictionaryValue> localized_strings_;
135 DISALLOW_COPY_AND_ASSIGN(OptionsUIHTMLSource);
138 OptionsUIHTMLSource::OptionsUIHTMLSource(
139 base::DictionaryValue* localized_strings) {
140 DCHECK(localized_strings);
141 localized_strings_.reset(localized_strings);
144 std::string OptionsUIHTMLSource::GetSource() const {
145 return chrome::kChromeUISettingsFrameHost;
148 void OptionsUIHTMLSource::StartDataRequest(
149 const std::string& path,
150 int render_process_id,
152 const content::URLDataSource::GotDataCallback& callback) {
153 scoped_refptr<base::RefCountedMemory> response_bytes;
154 webui::SetFontAndTextDirection(localized_strings_.get());
156 if (path == kLocalizedStringsFile) {
157 // Return dynamically-generated strings from memory.
158 webui::UseVersion2 version;
159 std::string strings_js;
160 webui::AppendJsonJS(localized_strings_.get(), &strings_js);
161 response_bytes = base::RefCountedString::TakeString(&strings_js);
162 } else if (path == kOptionsBundleJsFile) {
163 // Return (and cache) the options javascript code.
164 response_bytes = ui::ResourceBundle::GetSharedInstance().
165 LoadDataResourceBytes(IDR_OPTIONS_BUNDLE_JS);
167 // Return (and cache) the main options html page as the default.
168 response_bytes = ui::ResourceBundle::GetSharedInstance().
169 LoadDataResourceBytes(IDR_OPTIONS_HTML);
172 callback.Run(response_bytes.get());
175 std::string OptionsUIHTMLSource::GetMimeType(const std::string& path) const {
176 if (path == kLocalizedStringsFile || path == kOptionsBundleJsFile)
177 return "application/javascript";
182 bool OptionsUIHTMLSource::ShouldDenyXFrameOptions() const {
186 OptionsUIHTMLSource::~OptionsUIHTMLSource() {}
188 ////////////////////////////////////////////////////////////////////////////////
190 // OptionsPageUIHandler
192 ////////////////////////////////////////////////////////////////////////////////
194 const char OptionsPageUIHandler::kSettingsAppKey[] = "settingsApp";
196 OptionsPageUIHandler::OptionsPageUIHandler() {
199 OptionsPageUIHandler::~OptionsPageUIHandler() {
202 bool OptionsPageUIHandler::IsEnabled() {
207 void OptionsPageUIHandler::RegisterStrings(
208 base::DictionaryValue* localized_strings,
209 const OptionsStringResource* resources,
211 for (size_t i = 0; i < length; ++i) {
212 base::string16 value;
213 if (resources[i].substitution_id == 0) {
214 value = l10n_util::GetStringUTF16(resources[i].id);
216 value = l10n_util::GetStringFUTF16(
218 l10n_util::GetStringUTF16(resources[i].substitution_id));
220 localized_strings->SetString(resources[i].name, value);
224 void OptionsPageUIHandler::RegisterTitle(
225 base::DictionaryValue* localized_strings,
226 const std::string& variable_name,
228 localized_strings->SetString(variable_name,
229 l10n_util::GetStringUTF16(title_id));
230 localized_strings->SetString(variable_name + "TabTitle",
231 l10n_util::GetStringFUTF16(IDS_OPTIONS_TAB_TITLE,
232 l10n_util::GetStringUTF16(IDS_SETTINGS_TITLE),
233 l10n_util::GetStringUTF16(title_id)));
236 ////////////////////////////////////////////////////////////////////////////////
240 ////////////////////////////////////////////////////////////////////////////////
242 OptionsUI::OptionsUI(content::WebUI* web_ui)
243 : WebUIController(web_ui),
244 WebContentsObserver(web_ui->GetWebContents()),
245 initialized_handlers_(false) {
246 base::DictionaryValue* localized_strings = new base::DictionaryValue();
247 localized_strings->Set(OptionsPageUIHandler::kSettingsAppKey,
248 new base::DictionaryValue());
250 CoreOptionsHandler* core_handler;
251 #if defined(OS_CHROMEOS)
252 core_handler = new chromeos::options::CoreChromeOSOptionsHandler();
254 core_handler = new CoreOptionsHandler();
256 core_handler->set_handlers_host(this);
257 AddOptionsPageUIHandler(localized_strings, core_handler);
259 AddOptionsPageUIHandler(localized_strings, new AutofillOptionsHandler());
260 AddOptionsPageUIHandler(localized_strings,
261 new AutomaticSettingsResetHandler());
263 BrowserOptionsHandler* browser_options_handler = new BrowserOptionsHandler();
264 AddOptionsPageUIHandler(localized_strings, browser_options_handler);
266 AddOptionsPageUIHandler(localized_strings, new ClearBrowserDataHandler());
267 AddOptionsPageUIHandler(localized_strings, new ContentSettingsHandler());
268 AddOptionsPageUIHandler(localized_strings, new CookiesViewHandler());
269 AddOptionsPageUIHandler(localized_strings, new CreateProfileHandler());
270 AddOptionsPageUIHandler(localized_strings, new FontSettingsHandler());
271 #if defined(ENABLE_GOOGLE_NOW)
272 AddOptionsPageUIHandler(localized_strings, new GeolocationOptionsHandler());
274 AddOptionsPageUIHandler(localized_strings, new HomePageOverlayHandler());
275 AddOptionsPageUIHandler(localized_strings,
276 new MediaDevicesSelectionHandler());
277 AddOptionsPageUIHandler(localized_strings, new MediaGalleriesHandler());
278 #if defined(OS_CHROMEOS)
279 AddOptionsPageUIHandler(localized_strings,
280 new chromeos::options::CrosLanguageOptionsHandler());
282 AddOptionsPageUIHandler(localized_strings, new LanguageOptionsHandler());
284 AddOptionsPageUIHandler(localized_strings,
285 new LanguageDictionaryOverlayHandler());
286 AddOptionsPageUIHandler(localized_strings, new ManageProfileHandler());
287 AddOptionsPageUIHandler(localized_strings,
288 new ManagedUserCreateConfirmHandler());
289 AddOptionsPageUIHandler(localized_strings, new ManagedUserImportHandler());
290 AddOptionsPageUIHandler(localized_strings, new ManagedUserLearnMoreHandler());
291 AddOptionsPageUIHandler(localized_strings, new PasswordManagerHandler());
292 AddOptionsPageUIHandler(localized_strings, new ResetProfileSettingsHandler());
293 AddOptionsPageUIHandler(localized_strings, new SearchEngineManagerHandler());
294 AddOptionsPageUIHandler(localized_strings, new ImportDataHandler());
295 AddOptionsPageUIHandler(localized_strings, new StartupPagesHandler());
296 AddOptionsPageUIHandler(localized_strings, new SyncSetupHandler(
297 g_browser_process->profile_manager()));
298 #if defined(OS_CHROMEOS)
299 AddOptionsPageUIHandler(localized_strings,
300 new chromeos::options::AccountsOptionsHandler());
301 AddOptionsPageUIHandler(localized_strings,
302 new chromeos::options::BluetoothOptionsHandler());
303 AddOptionsPageUIHandler(localized_strings,
304 new chromeos::options::DisplayOptionsHandler());
305 AddOptionsPageUIHandler(localized_strings,
306 new chromeos::options::DisplayOverscanHandler());
307 AddOptionsPageUIHandler(localized_strings,
308 new chromeos::options::InternetOptionsHandler());
309 AddOptionsPageUIHandler(localized_strings,
310 new chromeos::options::KeyboardHandler());
312 chromeos::options::PointerHandler* pointer_handler =
313 new chromeos::options::PointerHandler();
314 AddOptionsPageUIHandler(localized_strings, pointer_handler);
316 AddOptionsPageUIHandler(localized_strings,
317 new chromeos::options::ProxyHandler());
318 AddOptionsPageUIHandler(
320 new chromeos::options::ChangePictureOptionsHandler());
321 AddOptionsPageUIHandler(localized_strings,
322 new chromeos::options::StatsOptionsHandler());
325 AddOptionsPageUIHandler(localized_strings, new CertificateManagerHandler());
327 AddOptionsPageUIHandler(localized_strings, new HandlerOptionsHandler());
329 web_ui->AddMessageHandler(new MetricsHandler());
331 // |localized_strings| ownership is taken over by this constructor.
332 OptionsUIHTMLSource* html_source =
333 new OptionsUIHTMLSource(localized_strings);
335 // Set up the chrome://settings-frame/ source.
336 Profile* profile = Profile::FromWebUI(web_ui);
337 content::URLDataSource::Add(profile, html_source);
339 // Set up the chrome://theme/ source.
340 ThemeSource* theme = new ThemeSource(profile);
341 content::URLDataSource::Add(profile, theme);
343 #if defined(OS_CHROMEOS)
344 // Set up the chrome://userimage/ source.
345 chromeos::options::UserImageSource* user_image_source =
346 new chromeos::options::UserImageSource();
347 content::URLDataSource::Add(profile, user_image_source);
349 pointer_device_observer_.reset(
350 new chromeos::system::PointerDeviceObserver());
351 pointer_device_observer_->AddObserver(browser_options_handler);
352 pointer_device_observer_->AddObserver(pointer_handler);
356 OptionsUI::~OptionsUI() {
357 // Uninitialize all registered handlers. Deleted by WebUIImpl.
358 for (size_t i = 0; i < handlers_.size(); ++i)
359 handlers_[i]->Uninitialize();
363 void OptionsUI::ProcessAutocompleteSuggestions(
364 const AutocompleteResult& result,
365 base::ListValue* const suggestions) {
366 for (size_t i = 0; i < result.size(); ++i) {
367 const AutocompleteMatch& match = result.match_at(i);
368 AutocompleteMatchType::Type type = match.type;
369 if (type != AutocompleteMatchType::HISTORY_URL &&
370 type != AutocompleteMatchType::HISTORY_TITLE &&
371 type != AutocompleteMatchType::HISTORY_BODY &&
372 type != AutocompleteMatchType::HISTORY_KEYWORD &&
373 type != AutocompleteMatchType::NAVSUGGEST)
375 base::DictionaryValue* entry = new base::DictionaryValue();
376 entry->SetString("title", match.description);
377 entry->SetString("displayURL", match.contents);
378 entry->SetString("url", match.destination_url.spec());
379 suggestions->Append(entry);
384 base::RefCountedMemory* OptionsUI::GetFaviconResourceBytes(
385 ui::ScaleFactor scale_factor) {
386 return ui::ResourceBundle::GetSharedInstance().
387 LoadDataResourceBytesForScale(IDR_SETTINGS_FAVICON, scale_factor);
390 void OptionsUI::DidStartProvisionalLoadForFrame(
392 int64 parent_frame_id,
394 const GURL& validated_url,
396 bool is_iframe_srcdoc,
397 content::RenderViewHost* render_view_host) {
398 if (render_view_host == web_ui()->GetWebContents()->GetRenderViewHost() &&
399 validated_url.host() == chrome::kChromeUISettingsFrameHost) {
400 for (size_t i = 0; i < handlers_.size(); ++i)
401 handlers_[i]->PageLoadStarted();
405 void OptionsUI::InitializeHandlers() {
406 Profile* profile = Profile::FromWebUI(web_ui());
407 DCHECK(!profile->IsOffTheRecord() || profile->IsGuestSession());
409 // A new web page DOM has been brought up in an existing renderer, causing
410 // this method to be called twice. If that happens, ignore the second call.
411 if (!initialized_handlers_) {
412 for (size_t i = 0; i < handlers_.size(); ++i)
413 handlers_[i]->InitializeHandler();
414 initialized_handlers_ = true;
416 #if defined(OS_CHROMEOS)
417 pointer_device_observer_->Init();
421 #if defined(OS_CHROMEOS)
422 pointer_device_observer_->CheckDevices();
425 // Always initialize the page as when handlers are left over we still need to
426 // do various things like show/hide sections and send data to the Javascript.
427 for (size_t i = 0; i < handlers_.size(); ++i)
428 handlers_[i]->InitializePage();
430 web_ui()->CallJavascriptFunction(
431 "BrowserOptions.notifyInitializationComplete");
434 void OptionsUI::AddOptionsPageUIHandler(
435 base::DictionaryValue* localized_strings,
436 OptionsPageUIHandler* handler_raw) {
437 scoped_ptr<OptionsPageUIHandler> handler(handler_raw);
438 DCHECK(handler.get());
439 // Add only if handler's service is enabled.
440 if (handler->IsEnabled()) {
441 // Add handler to the list and also pass the ownership.
442 web_ui()->AddMessageHandler(handler.release());
443 handler_raw->GetLocalizedValues(localized_strings);
444 handlers_.push_back(handler_raw);
448 } // namespace options