electron/atom/renderer/atom_renderer_client.cc

// Copyright (c) 2013 GitHub, Inc.
// Use of this source code is governed by the MIT license that can be
// found in the LICENSE file.

#include "atom/renderer/atom_renderer_client.h"

#include <string>

#include "atom/common/api/atom_bindings.h"
#include "atom/common/native_mate_converters/callback.h"
#include "atom/common/node_bindings.h"
#include "atom/common/options_switches.h"
#include "atom/renderer/atom_render_view_observer.h"
#include "atom/renderer/guest_view_container.h"
#include "base/command_line.h"
#include "chrome/renderer/pepper/pepper_helper.h"
#include "chrome/renderer/printing/print_web_view_helper.h"
#include "chrome/renderer/tts_dispatcher.h"
#include "content/public/common/content_constants.h"
#include "content/public/renderer/render_frame.h"
#include "content/public/renderer/render_frame_observer.h"
#include "content/public/renderer/render_thread.h"
#include "third_party/WebKit/public/web/WebArrayBuffer.h"
#include "third_party/WebKit/public/web/WebArrayBufferConverter.h"
#include "third_party/WebKit/public/web/WebCustomElement.h"
#include "third_party/WebKit/public/web/WebLocalFrame.h"
#include "third_party/WebKit/public/web/WebPluginParams.h"
#include "third_party/WebKit/public/web/WebKit.h"
#include "third_party/WebKit/public/web/WebRuntimeFeatures.h"
#include "third_party/WebKit/Source/wtf/ArrayBufferContents.h"

#include "atom/common/node_includes.h"

#if defined(OS_WIN)
#include <shlobj.h>
#endif

namespace atom {

namespace {

bool IsSwitchEnabled(base::CommandLine* command_line,
                     const char* switch_string,
                     bool* enabled) {
  std::string value = command_line->GetSwitchValueASCII(switch_string);
  if (value == "true")
    *enabled = true;
  else if (value == "false")
    *enabled = false;
  else
    return false;
  return true;
}

// global.Uint8Array;
v8::Local<v8::Function> GetUint8ArrayConstructor(
    v8::Isolate* isolate, v8::Local<v8::Context> context) {
  v8::Local<v8::Value> constructor = context->Global()->Get(
      mate::StringToV8(isolate, "Uint8Array"));
  return v8::Local<v8::Function>::Cast(constructor);
}

// new ArrayBuffer(size);
v8::Local<v8::ArrayBuffer> BlinkArrayBufferCreate(
    v8::Isolate* isolate, size_t size) {
  blink::WebArrayBuffer buffer = blink::WebArrayBuffer::create(size, 1);
  return v8::Local<v8::ArrayBuffer>::Cast(
      blink::WebArrayBufferConverter::toV8Value(
          &buffer, isolate->GetCurrentContext()->Global(), isolate));
}

// new Uint8Array(array_buffer, offset, size);
v8::Local<v8::Uint8Array> BlinkUint8ArrayCreate(
    v8::Local<v8::ArrayBuffer> ab, size_t offset, size_t size) {
  v8::Local<v8::Context> context = ab->CreationContext();
  v8::Isolate* isolate = context->GetIsolate();
  v8::Local<v8::Function> constructor =
      GetUint8ArrayConstructor(isolate, context);
  v8::Local<v8::Value> args[] = {
      ab, mate::ConvertToV8(isolate, offset), mate::ConvertToV8(isolate, size)
  };
  return v8::Local<v8::Uint8Array>::Cast(constructor->NewInstance(
      context, arraysize(args), args).ToLocalChecked());
}

// Helper class to forward the messages to the client.
class AtomRenderFrameObserver : public content::RenderFrameObserver {
 public:
  AtomRenderFrameObserver(content::RenderFrame* frame,
                          AtomRendererClient* renderer_client)
      : content::RenderFrameObserver(frame),
        renderer_client_(renderer_client) {}

  // content::RenderFrameObserver:
  void DidCreateScriptContext(v8::Handle<v8::Context> context,
                              int extension_group,
                              int world_id) {
    renderer_client_->DidCreateScriptContext(
        render_frame()->GetWebFrame(), context);
  }

 private:
  AtomRendererClient* renderer_client_;

  DISALLOW_COPY_AND_ASSIGN(AtomRenderFrameObserver);
};

}  // namespace

AtomRendererClient::AtomRendererClient()
    : node_bindings_(NodeBindings::Create(false)),
      atom_bindings_(new AtomBindings),
      main_frame_(nullptr) {
}

AtomRendererClient::~AtomRendererClient() {
}

void AtomRendererClient::WebKitInitialized() {
  EnableWebRuntimeFeatures();

  blink::WebCustomElement::addEmbedderCustomElementName("webview");
  blink::WebCustomElement::addEmbedderCustomElementName("browserplugin");

  // Override Node's ArrayBuffer with DOM's ArrayBuffer.
  node::Buffer::SetArrayBufferCreator(&BlinkArrayBufferCreate,
                                      &BlinkUint8ArrayCreate);

  node_bindings_->Initialize();
  node_bindings_->PrepareMessageLoop();

  DCHECK(!global_env);

  // Create a default empty environment which would be used when we need to
  // run V8 code out of a window context (like running a uv callback).
  v8::Isolate* isolate = blink::mainThreadIsolate();
  v8::HandleScope handle_scope(isolate);
  v8::Local<v8::Context> context = v8::Context::New(isolate);
  global_env = node::Environment::New(context, uv_default_loop());
}

void AtomRendererClient::RenderThreadStarted() {
  content::RenderThread::Get()->AddObserver(this);

#if defined(OS_WIN)
  base::CommandLine* command_line = base::CommandLine::ForCurrentProcess();
  base::string16 app_id =
      command_line->GetSwitchValueNative(switches::kAppUserModelId);
  if (!app_id.empty()) {
    SetCurrentProcessExplicitAppUserModelID(app_id.c_str());
  }
#endif
}

void AtomRendererClient::RenderFrameCreated(
    content::RenderFrame* render_frame) {
  new PepperHelper(render_frame);
  new AtomRenderFrameObserver(render_frame, this);
}

void AtomRendererClient::RenderViewCreated(content::RenderView* render_view) {
  new printing::PrintWebViewHelper(render_view);
  new AtomRenderViewObserver(render_view, this);
}

blink::WebSpeechSynthesizer* AtomRendererClient::OverrideSpeechSynthesizer(
    blink::WebSpeechSynthesizerClient* client) {
  return new TtsDispatcher(client);
}

bool AtomRendererClient::OverrideCreatePlugin(
    content::RenderFrame* render_frame,
    blink::WebLocalFrame* frame,
    const blink::WebPluginParams& params,
    blink::WebPlugin** plugin) {
  base::CommandLine* command_line = base::CommandLine::ForCurrentProcess();
  if (params.mimeType.utf8() == content::kBrowserPluginMimeType ||
      command_line->HasSwitch(switches::kEnablePlugins))
    return false;

  *plugin = nullptr;
  return true;
}

void AtomRendererClient::DidCreateScriptContext(
    blink::WebFrame* frame,
    v8::Handle<v8::Context> context) {
  if (main_frame_)
    return;

  // The first web frame is the main frame.
  main_frame_ = frame;

  // Give the node loop a run to make sure everything is ready.
  node_bindings_->RunMessageLoop();

  // Setup node environment for each window.
  node::Environment* env = node_bindings_->CreateEnvironment(context);

  // Add atom-shell extended APIs.
  atom_bindings_->BindTo(env->isolate(), env->process_object());

  // Make uv loop being wrapped by window context.
  if (node_bindings_->uv_env() == nullptr)
    node_bindings_->set_uv_env(env);

  // Load everything.
  node_bindings_->LoadEnvironment(env);
}

bool AtomRendererClient::ShouldFork(blink::WebFrame* frame,
                                    const GURL& url,
                                    const std::string& http_method,
                                    bool is_initial_navigation,
                                    bool is_server_redirect,
                                    bool* send_referrer) {
  // Handle all the navigations and reloads in browser.
  // FIXME We only support GET here because http method will be ignored when
  // the OpenURLFromTab is triggered, which means form posting would not work,
  // we should solve this by patching Chromium in future.
  *send_referrer = true;
  return http_method == "GET";
}

content::BrowserPluginDelegate* AtomRendererClient::CreateBrowserPluginDelegate(
    content::RenderFrame* render_frame,
    const std::string& mime_type,
    const GURL& original_url) {
  if (mime_type == content::kBrowserPluginMimeType) {
    return new GuestViewContainer(render_frame);
  } else {
    return nullptr;
  }
}

bool AtomRendererClient::ShouldOverridePageVisibilityState(
    const content::RenderFrame* render_frame,
    blink::WebPageVisibilityState* override_state) {
  base::CommandLine* command_line = base::CommandLine::ForCurrentProcess();
  bool b;

  if (IsSwitchEnabled(command_line, switches::kPageVisibility, &b)
      && b) {
    *override_state = blink::WebPageVisibilityStateVisible;
    return true;
  }

  return false;
}

void AtomRendererClient::EnableWebRuntimeFeatures() {
  base::CommandLine* command_line = base::CommandLine::ForCurrentProcess();
  bool b;
  if (IsSwitchEnabled(command_line, switches::kExperimentalFeatures, &b))
    blink::WebRuntimeFeatures::enableExperimentalFeatures(b);
  if (IsSwitchEnabled(command_line, switches::kExperimentalCanvasFeatures, &b))
    blink::WebRuntimeFeatures::enableExperimentalCanvasFeatures(b);
  if (IsSwitchEnabled(command_line, switches::kSubpixelFontScaling, &b))
    blink::WebRuntimeFeatures::enableSubpixelFontScaling(b);
  if (IsSwitchEnabled(command_line, switches::kOverlayScrollbars, &b))
    blink::WebRuntimeFeatures::enableOverlayScrollbars(b);
  if (IsSwitchEnabled(command_line, switches::kOverlayFullscreenVideo, &b))
    blink::WebRuntimeFeatures::enableOverlayFullscreenVideo(b);
  if (IsSwitchEnabled(command_line, switches::kSharedWorker, &b))
    blink::WebRuntimeFeatures::enableSharedWorker(b);
}

}  // namespace atom