1 // Copyright (c) 2013 GitHub, Inc.
2 // Use of this source code is governed by the MIT license that can be
3 // found in the LICENSE file.
5 #include "atom/common/node_bindings.h"
10 #include "atom/common/api/event_emitter_caller.h"
11 #include "atom/common/api/locker.h"
12 #include "atom/common/atom_command_line.h"
13 #include "atom/common/native_mate_converters/file_path_converter.h"
14 #include "atom/common/node_includes.h"
15 #include "base/command_line.h"
16 #include "base/base_paths.h"
17 #include "base/environment.h"
18 #include "base/files/file_path.h"
19 #include "base/message_loop/message_loop.h"
20 #include "base/path_service.h"
21 #include "content/public/browser/browser_thread.h"
22 #include "content/public/common/content_paths.h"
23 #include "native_mate/dictionary.h"
24 #include "third_party/WebKit/public/web/WebScopedMicrotaskSuppression.h"
26 using content::BrowserThread;
28 // Force all builtin modules to be referenced so they can actually run their
29 // DSO constructors, see http://git.io/DRIqCg.
30 #define REFERENCE_MODULE(name) \
31 extern "C" void _register_ ## name(void); \
32 void (*fp_register_ ## name)(void) = _register_ ## name
33 // Electron's builtin modules.
34 REFERENCE_MODULE(atom_browser_app);
35 REFERENCE_MODULE(atom_browser_auto_updater);
36 REFERENCE_MODULE(atom_browser_content_tracing);
37 REFERENCE_MODULE(atom_browser_dialog);
38 REFERENCE_MODULE(atom_browser_debugger);
39 REFERENCE_MODULE(atom_browser_desktop_capturer);
40 REFERENCE_MODULE(atom_browser_download_item);
41 REFERENCE_MODULE(atom_browser_menu);
42 REFERENCE_MODULE(atom_browser_power_monitor);
43 REFERENCE_MODULE(atom_browser_power_save_blocker);
44 REFERENCE_MODULE(atom_browser_protocol);
45 REFERENCE_MODULE(atom_browser_global_shortcut);
46 REFERENCE_MODULE(atom_browser_session);
47 REFERENCE_MODULE(atom_browser_tray);
48 REFERENCE_MODULE(atom_browser_web_contents);
49 REFERENCE_MODULE(atom_browser_web_view_manager);
50 REFERENCE_MODULE(atom_browser_window);
51 REFERENCE_MODULE(atom_common_asar);
52 REFERENCE_MODULE(atom_common_clipboard);
53 REFERENCE_MODULE(atom_common_crash_reporter);
54 REFERENCE_MODULE(atom_common_id_weak_map);
55 REFERENCE_MODULE(atom_common_native_image);
56 REFERENCE_MODULE(atom_common_screen);
57 REFERENCE_MODULE(atom_common_shell);
58 REFERENCE_MODULE(atom_common_v8_util);
59 REFERENCE_MODULE(atom_renderer_ipc);
60 REFERENCE_MODULE(atom_renderer_web_frame);
61 #undef REFERENCE_MODULE
63 // The "v8::Function::kLineOffsetNotFound" is exported in node.dll, but the
64 // linker can not find it, could be a bug of VS.
65 #if defined(OS_WIN) && !defined(DEBUG)
67 const int Function::kLineOffsetNotFound = -1;
75 // Empty callback for async handle.
76 void UvNoOp(uv_async_t* handle) {
79 // Convert the given vector to an array of C-strings. The strings in the
80 // returned vector are only guaranteed valid so long as the vector of strings
82 scoped_ptr<const char*[]> StringVectorToArgArray(
83 const std::vector<std::string>& vector) {
84 scoped_ptr<const char*[]> array(new const char*[vector.size()]);
85 for (size_t i = 0; i < vector.size(); ++i) {
86 array[i] = vector[i].c_str();
91 base::FilePath GetResourcesPath(bool is_browser) {
92 auto command_line = base::CommandLine::ForCurrentProcess();
93 base::FilePath exec_path(command_line->GetProgram());
94 PathService::Get(base::FILE_EXE, &exec_path);
96 base::FilePath resources_path =
97 #if defined(OS_MACOSX)
98 is_browser ? exec_path.DirName().DirName().Append("Resources") :
99 exec_path.DirName().DirName().DirName().DirName().DirName()
100 .Append("Resources");
102 exec_path.DirName().Append(FILE_PATH_LITERAL("resources"));
104 return resources_path;
109 NodeBindings::NodeBindings(bool is_browser)
110 : is_browser_(is_browser),
111 message_loop_(nullptr),
112 uv_loop_(uv_default_loop()),
113 embed_closed_(false),
115 weak_factory_(this) {
118 NodeBindings::~NodeBindings() {
119 // Quit the embed thread.
120 embed_closed_ = true;
121 uv_sem_post(&embed_sem_);
124 // Wait for everything to be done.
125 uv_thread_join(&embed_thread_);
128 uv_sem_destroy(&embed_sem_);
131 void NodeBindings::Initialize() {
132 // Open node's error reporting system for browser process.
133 node::g_standalone_mode = is_browser_;
134 node::g_upstream_node_mode = false;
136 #if defined(OS_LINUX)
137 // Get real command line in renderer process forked by zygote.
139 AtomCommandLine::InitializeFromCommandLine();
143 // (we assume node::Init would not modify the parameters under embedded mode).
144 node::Init(nullptr, nullptr, nullptr, nullptr);
147 // uv_init overrides error mode to suppress the default crash dialog, bring
148 // it back if user wants to show it.
149 scoped_ptr<base::Environment> env(base::Environment::Create());
150 if (env->HasVar("ELECTRON_DEFAULT_ERROR_MODE"))
155 node::Environment* NodeBindings::CreateEnvironment(
156 v8::Handle<v8::Context> context) {
157 auto args = AtomCommandLine::argv();
159 // Feed node the path to initialization script.
160 base::FilePath::StringType process_type = is_browser_ ?
161 FILE_PATH_LITERAL("browser") : FILE_PATH_LITERAL("renderer");
162 base::FilePath resources_path = GetResourcesPath(is_browser_);
163 base::FilePath script_path =
164 resources_path.Append(FILE_PATH_LITERAL("electron.asar"))
165 .Append(process_type)
166 .Append(FILE_PATH_LITERAL("init.js"));
167 std::string script_path_str = script_path.AsUTF8Unsafe();
168 args.insert(args.begin() + 1, script_path_str.c_str());
170 scoped_ptr<const char*[]> c_argv = StringVectorToArgArray(args);
171 node::Environment* env = node::CreateEnvironment(
172 context->GetIsolate(), uv_default_loop(), context,
173 args.size(), c_argv.get(), 0, nullptr);
175 mate::Dictionary process(context->GetIsolate(), env->process_object());
176 process.Set("type", process_type);
177 process.Set("resourcesPath", resources_path);
178 // Do not set DOM globals for renderer process.
180 process.Set("_noBrowserGlobals", resources_path);
181 // The path to helper app.
182 base::FilePath helper_exec_path;
183 PathService::Get(content::CHILD_PROCESS_EXE, &helper_exec_path);
184 process.Set("helperExecPath", helper_exec_path);
188 void NodeBindings::LoadEnvironment(node::Environment* env) {
189 node::LoadEnvironment(env);
190 mate::EmitEvent(env->isolate(), env->process_object(), "loaded");
193 void NodeBindings::PrepareMessageLoop() {
194 DCHECK(!is_browser_ || BrowserThread::CurrentlyOn(BrowserThread::UI));
196 // Add dummy handle for libuv, otherwise libuv would quit when there is
198 uv_async_init(uv_loop_, &dummy_uv_handle_, UvNoOp);
200 // Start worker that will interrupt main loop when having uv events.
201 uv_sem_init(&embed_sem_, 0);
202 uv_thread_create(&embed_thread_, EmbedThreadRunner, this);
205 void NodeBindings::RunMessageLoop() {
206 DCHECK(!is_browser_ || BrowserThread::CurrentlyOn(BrowserThread::UI));
208 // The MessageLoop should have been created, remember the one in main thread.
209 message_loop_ = base::MessageLoop::current();
211 // Run uv loop for once to give the uv__io_poll a chance to add all events.
215 void NodeBindings::UvRunOnce() {
216 DCHECK(!is_browser_ || BrowserThread::CurrentlyOn(BrowserThread::UI));
218 node::Environment* env = uv_env();
221 // Use Locker in browser process.
222 mate::Locker locker(env->isolate());
223 v8::HandleScope handle_scope(env->isolate());
225 // Enter node context while dealing with uv events.
226 v8::Context::Scope context_scope(env->context());
228 // Perform microtask checkpoint after running JavaScript.
229 scoped_ptr<blink::WebScopedRunV8Script> script_scope(
230 is_browser_ ? nullptr : new blink::WebScopedRunV8Script);
232 // Deal with uv events.
233 int r = uv_run(uv_loop_, UV_RUN_NOWAIT);
234 if (r == 0 || uv_loop_->stop_flag != 0)
235 message_loop_->QuitWhenIdle(); // Quit from uv.
237 // Tell the worker thread to continue polling.
238 uv_sem_post(&embed_sem_);
241 void NodeBindings::WakeupMainThread() {
242 DCHECK(message_loop_);
243 message_loop_->PostTask(FROM_HERE, base::Bind(&NodeBindings::UvRunOnce,
244 weak_factory_.GetWeakPtr()));
247 void NodeBindings::WakeupEmbedThread() {
248 uv_async_send(&dummy_uv_handle_);
252 void NodeBindings::EmbedThreadRunner(void *arg) {
253 NodeBindings* self = static_cast<NodeBindings*>(arg);
256 // Wait for the main loop to deal with events.
257 uv_sem_wait(&self->embed_sem_);
258 if (self->embed_closed_)
261 // Wait for something to happen in uv loop.
262 // Note that the PollEvents() is implemented by derived classes, so when
263 // this class is being destructed the PollEvents() would not be available
264 // anymore. Because of it we must make sure we only invoke PollEvents()
265 // when this class is alive.
267 if (self->embed_closed_)
270 // Deal with event in main thread.
271 self->WakeupMainThread();