// Copyright (c) 2014 GitHub, Inc. // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. #include "shell/browser/api/electron_api_global_shortcut.h" #include #include "base/containers/contains.h" #include "base/stl_util.h" #include "base/strings/utf_string_conversions.h" #include "extensions/common/command.h" #include "gin/dictionary.h" #include "gin/object_template_builder.h" #include "shell/browser/api/electron_api_system_preferences.h" #include "shell/browser/browser.h" #include "shell/common/gin_converters/accelerator_converter.h" #include "shell/common/gin_converters/callback_converter.h" #include "shell/common/node_includes.h" #if BUILDFLAG(IS_MAC) #include "base/mac/mac_util.h" #endif using extensions::Command; using extensions::GlobalShortcutListener; namespace { #if BUILDFLAG(IS_MAC) bool RegisteringMediaKeyForUntrustedClient(const ui::Accelerator& accelerator) { return Command::IsMediaKey(accelerator) && !electron::api::SystemPreferences::IsTrustedAccessibilityClient(false); } bool MapHasMediaKeys( const std::map& accelerator_map) { auto media_key = std::find_if( accelerator_map.begin(), accelerator_map.end(), [](const auto& ac) { return Command::IsMediaKey(ac.first); }); return media_key != accelerator_map.end(); } #endif } // namespace namespace electron::api { gin::WrapperInfo GlobalShortcut::kWrapperInfo = {gin::kEmbedderNativeGin}; GlobalShortcut::GlobalShortcut(v8::Isolate* isolate) {} GlobalShortcut::~GlobalShortcut() { UnregisterAll(); } void GlobalShortcut::OnKeyPressed(const ui::Accelerator& accelerator) { if (!base::Contains(accelerator_callback_map_, accelerator)) { // This should never occur, because if it does, GlobalShortcutListener // notifies us with wrong accelerator. NOTREACHED(); return; } accelerator_callback_map_[accelerator].Run(); } bool GlobalShortcut::RegisterAll( const std::vector& accelerators, const base::RepeatingClosure& callback) { if (!electron::Browser::Get()->is_ready()) { gin_helper::ErrorThrower(JavascriptEnvironment::GetIsolate()) .ThrowError("globalShortcut cannot be used before the app is ready"); return false; } std::vector registered; for (auto& accelerator : accelerators) { if (!Register(accelerator, callback)) { // Unregister all shortcuts if any failed. UnregisterSome(registered); return false; } registered.push_back(accelerator); } return true; } bool GlobalShortcut::Register(const ui::Accelerator& accelerator, const base::RepeatingClosure& callback) { if (!electron::Browser::Get()->is_ready()) { gin_helper::ErrorThrower(JavascriptEnvironment::GetIsolate()) .ThrowError("globalShortcut cannot be used before the app is ready"); return false; } #if BUILDFLAG(IS_MAC) if (Command::IsMediaKey(accelerator)) { if (RegisteringMediaKeyForUntrustedClient(accelerator)) return false; GlobalShortcutListener::SetShouldUseInternalMediaKeyHandling(false); } #endif if (!GlobalShortcutListener::GetInstance()->RegisterAccelerator(accelerator, this)) { return false; } accelerator_callback_map_[accelerator] = callback; return true; } void GlobalShortcut::Unregister(const ui::Accelerator& accelerator) { if (!electron::Browser::Get()->is_ready()) { gin_helper::ErrorThrower(JavascriptEnvironment::GetIsolate()) .ThrowError("globalShortcut cannot be used before the app is ready"); return; } if (accelerator_callback_map_.erase(accelerator) == 0) return; #if BUILDFLAG(IS_MAC) if (Command::IsMediaKey(accelerator) && !MapHasMediaKeys(accelerator_callback_map_)) { GlobalShortcutListener::SetShouldUseInternalMediaKeyHandling(true); } #endif GlobalShortcutListener::GetInstance()->UnregisterAccelerator(accelerator, this); } void GlobalShortcut::UnregisterSome( const std::vector& accelerators) { for (auto& accelerator : accelerators) { Unregister(accelerator); } } bool GlobalShortcut::IsRegistered(const ui::Accelerator& accelerator) { return base::Contains(accelerator_callback_map_, accelerator); } void GlobalShortcut::UnregisterAll() { if (!electron::Browser::Get()->is_ready()) { gin_helper::ErrorThrower(JavascriptEnvironment::GetIsolate()) .ThrowError("globalShortcut cannot be used before the app is ready"); return; } accelerator_callback_map_.clear(); GlobalShortcutListener::GetInstance()->UnregisterAccelerators(this); } // static gin::Handle GlobalShortcut::Create(v8::Isolate* isolate) { return gin::CreateHandle(isolate, new GlobalShortcut(isolate)); } // static gin::ObjectTemplateBuilder GlobalShortcut::GetObjectTemplateBuilder( v8::Isolate* isolate) { return gin::Wrappable::GetObjectTemplateBuilder(isolate) .SetMethod("registerAll", &GlobalShortcut::RegisterAll) .SetMethod("register", &GlobalShortcut::Register) .SetMethod("isRegistered", &GlobalShortcut::IsRegistered) .SetMethod("unregister", &GlobalShortcut::Unregister) .SetMethod("unregisterAll", &GlobalShortcut::UnregisterAll); } const char* GlobalShortcut::GetTypeName() { return "GlobalShortcut"; } } // namespace electron::api namespace { void Initialize(v8::Local exports, v8::Local unused, v8::Local context, void* priv) { v8::Isolate* isolate = context->GetIsolate(); gin::Dictionary dict(isolate, exports); dict.Set("globalShortcut", electron::api::GlobalShortcut::Create(isolate)); } } // namespace NODE_LINKED_BINDING_CONTEXT_AWARE(electron_browser_global_shortcut, Initialize)