From 45e78728bd339dd3f130f6ac09a66c344e012e98 Mon Sep 17 00:00:00 2001 From: Milan Burda Date: Tue, 29 May 2018 10:09:51 +0200 Subject: [PATCH] chore: move more constants to options_switches.h/cc (#13093) * Add options::kNativeWindowOpen * Add options::kSandbox * Add options::kPlugins * Add options::kWebSecurity * Add options::kAllowRunningInsecureContent * Add options::kOffscreen --- atom/browser/api/atom_api_top_level_window.cc | 2 +- atom/browser/api/atom_api_web_contents.cc | 2 +- atom/browser/atom_browser_client.cc | 5 ++-- .../browser/atom_download_manager_delegate.cc | 4 ++- .../browser/atom_javascript_dialog_manager.cc | 3 ++- .../atom_resource_dispatcher_host_delegate.cc | 2 +- atom/browser/common_web_contents_delegate.cc | 4 ++- atom/browser/web_contents_preferences.cc | 27 ++++++++++--------- atom/common/options_switches.cc | 12 +++++++++ atom/common/options_switches.h | 6 +++++ atom/renderer/atom_renderer_client.cc | 2 +- 11 files changed, 47 insertions(+), 22 deletions(-) diff --git a/atom/browser/api/atom_api_top_level_window.cc b/atom/browser/api/atom_api_top_level_window.cc index 9a168504ff2..145b6b2e98b 100644 --- a/atom/browser/api/atom_api_top_level_window.cc +++ b/atom/browser/api/atom_api_top_level_window.cc @@ -84,7 +84,7 @@ TopLevelWindow::TopLevelWindow(v8::Isolate* isolate, mate::Dictionary web_preferences; bool offscreen; if (options.Get(options::kWebPreferences, &web_preferences) && - web_preferences.Get("offscreen", &offscreen) && offscreen) { + web_preferences.Get(options::kOffscreen, &offscreen) && offscreen) { const_cast(options).Set(options::kFrame, false); } #endif diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 7a578e153cb..3cc197d8ada 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -368,7 +368,7 @@ WebContents::WebContents(v8::Isolate* isolate, else if (options.Get("isBrowserView", &b) && b) type_ = BROWSER_VIEW; #if defined(ENABLE_OSR) - else if (options.Get("offscreen", &b) && b) + else if (options.Get(options::kOffscreen, &b) && b) type_ = OFF_SCREEN; #endif diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index 32c8d3dd802..bee1f9c11dc 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -181,8 +181,9 @@ void AtomBrowserClient::RenderProcessWillLaunch( auto* web_preferences = WebContentsPreferences::From(GetWebContentsFromProcessID(process_id)); if (web_preferences) { - prefs.sandbox = web_preferences->IsEnabled("sandbox"); - prefs.native_window_open = web_preferences->IsEnabled("nativeWindowOpen"); + prefs.sandbox = web_preferences->IsEnabled(options::kSandbox); + prefs.native_window_open = + web_preferences->IsEnabled(options::kNativeWindowOpen); prefs.disable_popups = web_preferences->IsEnabled("disablePopups"); } AddProcessPreferences(host->GetID(), prefs); diff --git a/atom/browser/atom_download_manager_delegate.cc b/atom/browser/atom_download_manager_delegate.cc index 791a6f7b677..6d72c95dbf0 100644 --- a/atom/browser/atom_download_manager_delegate.cc +++ b/atom/browser/atom_download_manager_delegate.cc @@ -11,6 +11,7 @@ #include "atom/browser/native_window.h" #include "atom/browser/ui/file_dialog.h" #include "atom/browser/web_contents_preferences.h" +#include "atom/common/options_switches.h" #include "base/bind.h" #include "base/files/file_util.h" #include "chrome/common/pref_names.h" @@ -90,7 +91,8 @@ void AtomDownloadManagerDelegate::OnDownloadPathGenerated( window = relay->window.get(); auto* web_preferences = WebContentsPreferences::From(web_contents); - bool offscreen = !web_preferences || web_preferences->IsEnabled("offscreen"); + bool offscreen = + !web_preferences || web_preferences->IsEnabled(options::kOffscreen); base::FilePath path; GetItemSavePath(item, &path); diff --git a/atom/browser/atom_javascript_dialog_manager.cc b/atom/browser/atom_javascript_dialog_manager.cc index fcbf6ea75e5..03f11c3a351 100644 --- a/atom/browser/atom_javascript_dialog_manager.cc +++ b/atom/browser/atom_javascript_dialog_manager.cc @@ -11,6 +11,7 @@ #include "atom/browser/native_window.h" #include "atom/browser/ui/message_box.h" #include "atom/browser/web_contents_preferences.h" +#include "atom/common/options_switches.h" #include "base/bind.h" #include "base/strings/utf_string_conversions.h" #include "ui/gfx/image/image_skia.h" @@ -66,7 +67,7 @@ void AtomJavaScriptDialogManager::RunJavaScriptDialog( // Don't set parent for offscreen window. NativeWindow* window = nullptr; - if (web_preferences && !web_preferences->IsEnabled("offscreen")) { + if (web_preferences && !web_preferences->IsEnabled(options::kOffscreen)) { auto* relay = NativeWindowRelay::FromWebContents(web_contents); if (relay) window = relay->window.get(); diff --git a/atom/browser/atom_resource_dispatcher_host_delegate.cc b/atom/browser/atom_resource_dispatcher_host_delegate.cc index 84261e92534..68b4fc5cf59 100644 --- a/atom/browser/atom_resource_dispatcher_host_delegate.cc +++ b/atom/browser/atom_resource_dispatcher_host_delegate.cc @@ -80,7 +80,7 @@ void OnPdfResourceIntercepted( return; auto* web_preferences = WebContentsPreferences::From(web_contents); - if (!web_preferences || !web_preferences->IsEnabled("plugins")) { + if (!web_preferences || !web_preferences->IsEnabled(options::kPlugins)) { auto* browser_context = web_contents->GetBrowserContext(); auto* download_manager = content::BrowserContext::GetDownloadManager(browser_context); diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index 1912f49003d..1c7ff9c4b3a 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -14,6 +14,7 @@ #include "atom/browser/web_contents_preferences.h" #include "atom/browser/web_dialog_helper.h" #include "atom/common/atom_constants.h" +#include "atom/common/options_switches.h" #include "base/files/file_util.h" #include "chrome/browser/printing/print_preview_message_handler.h" #include "chrome/browser/printing/print_view_manager_basic.h" @@ -156,7 +157,8 @@ void CommonWebContentsDelegate::InitWithWebContents( // Determien whether the WebContents is offscreen. auto* web_preferences = WebContentsPreferences::From(web_contents); - offscreen_ = !web_preferences || web_preferences->IsEnabled("offscreen"); + offscreen_ = + !web_preferences || web_preferences->IsEnabled(options::kOffscreen); // Create InspectableWebContents. web_contents_.reset(brightray::InspectableWebContents::Create(web_contents)); diff --git a/atom/browser/web_contents_preferences.cc b/atom/browser/web_contents_preferences.cc index 27ea03430ba..63232bf0759 100644 --- a/atom/browser/web_contents_preferences.cc +++ b/atom/browser/web_contents_preferences.cc @@ -51,32 +51,33 @@ WebContentsPreferences::WebContentsPreferences( instances_.push_back(this); // Set WebPreferences defaults onto the JS object - SetDefaultBoolIfUndefined("plugins", false); + SetDefaultBoolIfUndefined(options::kPlugins, false); SetDefaultBoolIfUndefined(options::kExperimentalFeatures, false); SetDefaultBoolIfUndefined(options::kExperimentalCanvasFeatures, false); bool node = SetDefaultBoolIfUndefined(options::kNodeIntegration, true); SetDefaultBoolIfUndefined(options::kNodeIntegrationInWorker, false); SetDefaultBoolIfUndefined(options::kWebviewTag, node); - SetDefaultBoolIfUndefined("sandbox", false); - SetDefaultBoolIfUndefined("nativeWindowOpen", false); + SetDefaultBoolIfUndefined(options::kSandbox, false); + SetDefaultBoolIfUndefined(options::kNativeWindowOpen, false); SetDefaultBoolIfUndefined(options::kContextIsolation, false); SetDefaultBoolIfUndefined("javascript", true); SetDefaultBoolIfUndefined("images", true); SetDefaultBoolIfUndefined("textAreasAreResizable", true); SetDefaultBoolIfUndefined("webgl", true); bool webSecurity = true; - SetDefaultBoolIfUndefined("webSecurity", webSecurity); + SetDefaultBoolIfUndefined(options::kWebSecurity, webSecurity); // If webSecurity was explicity set to false, let's inherit that into // insecureContent - if (web_preferences.Get("webSecurity", &webSecurity) && !webSecurity) { - SetDefaultBoolIfUndefined("allowRunningInsecureContent", true); + if (web_preferences.Get(options::kWebSecurity, &webSecurity) && + !webSecurity) { + SetDefaultBoolIfUndefined(options::kAllowRunningInsecureContent, true); } else { - SetDefaultBoolIfUndefined("allowRunningInsecureContent", false); + SetDefaultBoolIfUndefined(options::kAllowRunningInsecureContent, false); } #if defined(OS_MACOSX) SetDefaultBoolIfUndefined(options::kScrollBounce, false); #endif - SetDefaultBoolIfUndefined("offscreen", false); + SetDefaultBoolIfUndefined(options::kOffscreen, false); last_dict_ = std::move(*dict_.CreateDeepCopy()); } @@ -131,7 +132,7 @@ void WebContentsPreferences::AppendCommandLineSwitches( base::CommandLine* command_line) { bool b; // Check if plugins are enabled. - if (dict_.GetBoolean("plugins", &b) && b) + if (dict_.GetBoolean(options::kPlugins, &b) && b) command_line->AppendSwitch(switches::kEnablePlugins); // Experimental flags. @@ -161,11 +162,11 @@ void WebContentsPreferences::AppendCommandLineSwitches( // If the `sandbox` option was passed to the BrowserWindow's webPreferences, // pass `--enable-sandbox` to the renderer so it won't have any node.js // integration. - if (dict_.GetBoolean("sandbox", &b) && b) + if (dict_.GetBoolean(options::kSandbox, &b) && b) command_line->AppendSwitch(switches::kEnableSandbox); else if (!command_line->HasSwitch(switches::kEnableSandbox)) command_line->AppendSwitch(::switches::kNoSandbox); - if (dict_.GetBoolean("nativeWindowOpen", &b) && b) + if (dict_.GetBoolean(options::kNativeWindowOpen, &b) && b) command_line->AppendSwitch(switches::kNativeWindowOpen); // The preload script. @@ -278,11 +279,11 @@ void WebContentsPreferences::OverrideWebkitPrefs( prefs->webgl1_enabled = b; prefs->webgl2_enabled = b; } - if (dict_.GetBoolean("webSecurity", &b)) { + if (dict_.GetBoolean(options::kWebSecurity, &b)) { prefs->web_security_enabled = b; prefs->allow_running_insecure_content = !b; } - if (dict_.GetBoolean("allowRunningInsecureContent", &b)) + if (dict_.GetBoolean(options::kAllowRunningInsecureContent, &b)) prefs->allow_running_insecure_content = b; if (dict_.GetBoolean("navigateOnDragDrop", &b)) prefs->navigate_on_drag_drop = b; diff --git a/atom/common/options_switches.cc b/atom/common/options_switches.cc index 9d62dcfc9f7..0f0fba391a9 100644 --- a/atom/common/options_switches.cc +++ b/atom/common/options_switches.cc @@ -139,8 +139,20 @@ const char kNodeIntegrationInWorker[] = "nodeIntegrationInWorker"; // Enable the web view tag. const char kWebviewTag[] = "webviewTag"; +const char kNativeWindowOpen[] = "nativeWindowOpen"; + const char kCustomArgs[] = "additionalArguments"; +const char kPlugins[] = "plugins"; + +const char kSandbox[] = "sandbox"; + +const char kWebSecurity[] = "webSecurity"; + +const char kAllowRunningInsecureContent[] = "allowRunningInsecureContent"; + +const char kOffscreen[] = "offscreen"; + } // namespace options namespace switches { diff --git a/atom/common/options_switches.h b/atom/common/options_switches.h index cdd55e457b8..d45b811ae73 100644 --- a/atom/common/options_switches.h +++ b/atom/common/options_switches.h @@ -68,7 +68,13 @@ extern const char kBlinkFeatures[]; extern const char kDisableBlinkFeatures[]; extern const char kNodeIntegrationInWorker[]; extern const char kWebviewTag[]; +extern const char kNativeWindowOpen[]; extern const char kCustomArgs[]; +extern const char kPlugins[]; +extern const char kSandbox[]; +extern const char kWebSecurity[]; +extern const char kAllowRunningInsecureContent[]; +extern const char kOffscreen[]; } // namespace options diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index 5ae1adb1ef3..2794ce0ad92 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -205,7 +205,7 @@ void AtomRendererClient::SetupMainWorldOverrides( dict.Set(options::kOpenerID, command_line->GetSwitchValueASCII(switches::kOpenerID)); dict.Set("hiddenPage", command_line->HasSwitch(switches::kHiddenPage)); - dict.Set("nativeWindowOpen", + dict.Set(options::kNativeWindowOpen, command_line->HasSwitch(switches::kNativeWindowOpen)); v8::Local args[] = {binding};