// Copyright (c) 2015 GitHub, Inc. // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. #include "shell/common/gin_converters/content_converter.h" #include #include #include "content/public/browser/context_menu_params.h" #include "content/public/browser/native_web_keyboard_event.h" #include "content/public/browser/web_contents.h" #include "shell/browser/api/electron_api_web_contents.h" #include "shell/browser/web_contents_permission_helper.h" #include "shell/common/gin_converters/blink_converter.h" #include "shell/common/gin_converters/callback_converter.h" #include "shell/common/gin_converters/gfx_converter.h" #include "shell/common/gin_converters/gurl_converter.h" #include "shell/common/gin_helper/dictionary.h" #include "third_party/blink/public/common/context_menu_data/untrustworthy_context_menu_params.h" #include "ui/events/keycodes/dom/keycode_converter.h" #include "ui/events/keycodes/keyboard_code_conversion.h" namespace { void ExecuteCommand(content::WebContents* web_contents, int action, const GURL& link_followed) { web_contents->ExecuteCustomContextMenuCommand(action, link_followed); } // Forward declaration for nested recursive call. v8::Local MenuToV8(v8::Isolate* isolate, content::WebContents* web_contents, const GURL& link_followed, const std::vector& menu); v8::Local MenuItemToV8(v8::Isolate* isolate, content::WebContents* web_contents, const GURL& link_followed, const blink::MenuItem& item) { gin_helper::Dictionary v8_item = gin::Dictionary::CreateEmpty(isolate); switch (item.type) { case blink::MenuItem::CHECKABLE_OPTION: case blink::MenuItem::GROUP: v8_item.Set("checked", item.checked); FALLTHROUGH; case blink::MenuItem::OPTION: case blink::MenuItem::SUBMENU: v8_item.Set("label", item.label); v8_item.Set("enabled", item.enabled); FALLTHROUGH; default: v8_item.Set("type", item.type); } if (item.type == blink::MenuItem::SUBMENU) v8_item.Set("submenu", MenuToV8(isolate, web_contents, link_followed, item.submenu)); else if (item.action > 0) v8_item.Set("click", base::BindRepeating(ExecuteCommand, web_contents, item.action, link_followed)); return v8_item.GetHandle(); } v8::Local MenuToV8(v8::Isolate* isolate, content::WebContents* web_contents, const GURL& link_followed, const std::vector& menu) { std::vector> v8_menu; v8_menu.reserve(menu.size()); for (const auto& menu_item : menu) v8_menu.push_back( MenuItemToV8(isolate, web_contents, link_followed, menu_item)); return gin::ConvertToV8(isolate, v8_menu); } } // namespace namespace gin { template <> struct Converter { static v8::Local ToV8(v8::Isolate* isolate, const ui::MenuSourceType& in) { switch (in) { case ui::MENU_SOURCE_MOUSE: return StringToV8(isolate, "mouse"); case ui::MENU_SOURCE_KEYBOARD: return StringToV8(isolate, "keyboard"); case ui::MENU_SOURCE_TOUCH: return StringToV8(isolate, "touch"); case ui::MENU_SOURCE_TOUCH_EDIT_MENU: return StringToV8(isolate, "touchMenu"); case ui::MENU_SOURCE_LONG_PRESS: return StringToV8(isolate, "longPress"); case ui::MENU_SOURCE_LONG_TAP: return StringToV8(isolate, "longTap"); case ui::MENU_SOURCE_TOUCH_HANDLE: return StringToV8(isolate, "touchHandle"); case ui::MENU_SOURCE_STYLUS: return StringToV8(isolate, "stylus"); case ui::MENU_SOURCE_ADJUST_SELECTION: return StringToV8(isolate, "adjustSelection"); case ui::MENU_SOURCE_ADJUST_SELECTION_RESET: return StringToV8(isolate, "adjustSelectionReset"); default: return StringToV8(isolate, "none"); } } }; // static v8::Local Converter::ToV8( v8::Isolate* isolate, const blink::MenuItem::Type& val) { switch (val) { case blink::MenuItem::CHECKABLE_OPTION: return StringToV8(isolate, "checkbox"); case blink::MenuItem::GROUP: return StringToV8(isolate, "radio"); case blink::MenuItem::SEPARATOR: return StringToV8(isolate, "separator"); case blink::MenuItem::SUBMENU: return StringToV8(isolate, "submenu"); case blink::MenuItem::OPTION: default: return StringToV8(isolate, "normal"); } } // static v8::Local Converter::ToV8( v8::Isolate* isolate, const ContextMenuParamsWithWebContents& val) { const auto& params = val.first; gin_helper::Dictionary dict = gin::Dictionary::CreateEmpty(isolate); dict.Set("x", params.x); dict.Set("y", params.y); dict.Set("linkURL", params.link_url); dict.Set("linkText", params.link_text); dict.Set("pageURL", params.page_url); dict.Set("frameURL", params.frame_url); dict.Set("srcURL", params.src_url); dict.Set("mediaType", params.media_type); dict.Set("mediaFlags", MediaFlagsToV8(isolate, params.media_flags)); bool has_image_contents = (params.media_type == blink::mojom::ContextMenuDataMediaType::kImage) && params.has_image_contents; dict.Set("hasImageContents", has_image_contents); dict.Set("isEditable", params.is_editable); dict.Set("editFlags", EditFlagsToV8(isolate, params.edit_flags)); dict.Set("selectionText", params.selection_text); dict.Set("titleText", params.title_text); dict.Set("altText", params.alt_text); dict.Set("suggestedFilename", params.suggested_filename); dict.Set("misspelledWord", params.misspelled_word); dict.Set("selectionRect", params.selection_rect); #if BUILDFLAG(ENABLE_BUILTIN_SPELLCHECKER) dict.Set("dictionarySuggestions", params.dictionary_suggestions); dict.Set("spellcheckEnabled", params.spellcheck_enabled); #else dict.Set("spellcheckEnabled", false); #endif dict.Set("frameCharset", params.frame_charset); dict.Set("referrerPolicy", params.referrer_policy); dict.Set("inputFieldType", params.input_field_type); dict.Set("menuSourceType", params.source_type); return gin::ConvertToV8(isolate, dict); } // static bool Converter::FromV8( v8::Isolate* isolate, v8::Local val, blink::mojom::PermissionStatus* out) { bool result; if (!ConvertFromV8(isolate, val, &result)) return false; if (result) *out = blink::mojom::PermissionStatus::GRANTED; else *out = blink::mojom::PermissionStatus::DENIED; return true; } // static v8::Local Converter::ToV8( v8::Isolate* isolate, const content::PermissionType& val) { using PermissionType = electron::WebContentsPermissionHelper::PermissionType; // Based on mappings from content/browser/devtools/protocol/browser_handler.cc // Not all permissions are currently used by Electron but this will future // proof these conversions. switch (val) { case content::PermissionType::ACCESSIBILITY_EVENTS: return StringToV8(isolate, "accessibility-events"); case content::PermissionType::AR: return StringToV8(isolate, "ar"); case content::PermissionType::BACKGROUND_FETCH: return StringToV8(isolate, "background-fetch"); case content::PermissionType::BACKGROUND_SYNC: return StringToV8(isolate, "background-sync"); case content::PermissionType::CLIPBOARD_READ_WRITE: return StringToV8(isolate, "clipboard-read"); case content::PermissionType::CLIPBOARD_SANITIZED_WRITE: return StringToV8(isolate, "clipboard-sanitized-write"); case content::PermissionType::FONT_ACCESS: return StringToV8(isolate, "font-access"); case content::PermissionType::IDLE_DETECTION: return StringToV8(isolate, "idle-detection"); case content::PermissionType::MIDI_SYSEX: return StringToV8(isolate, "midiSysex"); case content::PermissionType::NFC: return StringToV8(isolate, "nfc"); case content::PermissionType::NOTIFICATIONS: return StringToV8(isolate, "notifications"); case content::PermissionType::PAYMENT_HANDLER: return StringToV8(isolate, "payment-handler"); case content::PermissionType::PERIODIC_BACKGROUND_SYNC: return StringToV8(isolate, "periodic-background-sync"); case content::PermissionType::DURABLE_STORAGE: return StringToV8(isolate, "persistent-storage"); case content::PermissionType::GEOLOCATION: return StringToV8(isolate, "geolocation"); case content::PermissionType::CAMERA_PAN_TILT_ZOOM: case content::PermissionType::AUDIO_CAPTURE: case content::PermissionType::VIDEO_CAPTURE: return StringToV8(isolate, "media"); case content::PermissionType::PROTECTED_MEDIA_IDENTIFIER: return StringToV8(isolate, "mediaKeySystem"); case content::PermissionType::MIDI: return StringToV8(isolate, "midi"); case content::PermissionType::WAKE_LOCK_SCREEN: return StringToV8(isolate, "screen-wake-lock"); case content::PermissionType::SENSORS: return StringToV8(isolate, "sensors"); case content::PermissionType::STORAGE_ACCESS_GRANT: return StringToV8(isolate, "storage-access"); case content::PermissionType::VR: return StringToV8(isolate, "vr"); case content::PermissionType::WAKE_LOCK_SYSTEM: return StringToV8(isolate, "system-wake-lock"); case content::PermissionType::WINDOW_PLACEMENT: return StringToV8(isolate, "window-placement"); case content::PermissionType::DISPLAY_CAPTURE: return StringToV8(isolate, "display-capture"); case content::PermissionType::NUM: break; } switch (static_cast(val)) { case PermissionType::POINTER_LOCK: return StringToV8(isolate, "pointerLock"); case PermissionType::FULLSCREEN: return StringToV8(isolate, "fullscreen"); case PermissionType::OPEN_EXTERNAL: return StringToV8(isolate, "openExternal"); case PermissionType::SERIAL: return StringToV8(isolate, "serial"); default: return StringToV8(isolate, "unknown"); } } // static bool Converter::FromV8(v8::Isolate* isolate, v8::Local val, content::StopFindAction* out) { std::string action; if (!ConvertFromV8(isolate, val, &action)) return false; if (action == "clearSelection") *out = content::STOP_FIND_ACTION_CLEAR_SELECTION; else if (action == "keepSelection") *out = content::STOP_FIND_ACTION_KEEP_SELECTION; else if (action == "activateSelection") *out = content::STOP_FIND_ACTION_ACTIVATE_SELECTION; else return false; return true; } // static v8::Local Converter::ToV8( v8::Isolate* isolate, content::WebContents* val) { if (!val) return v8::Null(isolate); return electron::api::WebContents::FromOrCreate(isolate, val).ToV8(); } // static bool Converter::FromV8(v8::Isolate* isolate, v8::Local val, content::WebContents** out) { if (!val->IsObject()) return false; // gin's unwrapping converter doesn't expect the pointer inside to ever be // nullptr, so we check here first before attempting to unwrap. if (gin_helper::Destroyable::IsDestroyed(val.As())) return false; electron::api::WebContents* web_contents = nullptr; if (!gin::ConvertFromV8(isolate, val, &web_contents) || !web_contents) return false; *out = web_contents->web_contents(); return true; } // static v8::Local Converter::ToV8( v8::Isolate* isolate, const content::Referrer& val) { gin_helper::Dictionary dict = gin::Dictionary::CreateEmpty(isolate); dict.Set("url", ConvertToV8(isolate, val.url)); dict.Set("policy", ConvertToV8(isolate, val.policy)); return gin::ConvertToV8(isolate, dict); } // static bool Converter::FromV8(v8::Isolate* isolate, v8::Local val, content::Referrer* out) { gin_helper::Dictionary dict; if (!ConvertFromV8(isolate, val, &dict)) return false; if (!dict.Get("url", &out->url)) return false; if (!dict.Get("policy", &out->policy)) return false; return true; } // static bool Converter::FromV8( v8::Isolate* isolate, v8::Local val, content::NativeWebKeyboardEvent* out) { gin_helper::Dictionary dict; if (!ConvertFromV8(isolate, val, &dict)) return false; if (!ConvertFromV8(isolate, val, static_cast(out))) return false; dict.Get("skipInBrowser", &out->skip_in_browser); return true; } // static v8::Local Converter::ToV8( v8::Isolate* isolate, const content::NativeWebKeyboardEvent& in) { gin_helper::Dictionary dict = gin::Dictionary::CreateEmpty(isolate); if (in.GetType() == blink::WebInputEvent::Type::kRawKeyDown) dict.Set("type", "keyDown"); else if (in.GetType() == blink::WebInputEvent::Type::kKeyUp) dict.Set("type", "keyUp"); dict.Set("key", ui::KeycodeConverter::DomKeyToKeyString(in.dom_key)); dict.Set("code", ui::KeycodeConverter::DomCodeToCodeString( static_cast(in.dom_code))); using Modifiers = blink::WebInputEvent::Modifiers; dict.Set("isAutoRepeat", (in.GetModifiers() & Modifiers::kIsAutoRepeat) != 0); dict.Set("isComposing", (in.GetModifiers() & Modifiers::kIsComposing) != 0); dict.Set("shift", (in.GetModifiers() & Modifiers::kShiftKey) != 0); dict.Set("control", (in.GetModifiers() & Modifiers::kControlKey) != 0); dict.Set("alt", (in.GetModifiers() & Modifiers::kAltKey) != 0); dict.Set("meta", (in.GetModifiers() & Modifiers::kMetaKey) != 0); return dict.GetHandle(); } } // namespace gin