javascript: add new plugin to run javascript scripts in WeeChat

This plugin was originally written by Koka El Kiwi
(repository: https://github.com/KokaKiwi/weechat-js-plugin).

This plugin uses Google V8 engine to execute JS scripts.

AUTHORS.asciidoc

@@ -46,6 +46,7 @@ Alphabetically:
 * Jim Ramsay (lack)
 * Jiri Golembiovsky (GolemJ)
 * Julien Louis (ptitlouis)
+* Koka El Kiwi (KiwiDash)
 * Krzysztof Koroscik (soltys)
 * Kyle Fuller (kylef)
 * Lázaro A.

CMakeLists.txt

@@ -96,6 +96,7 @@ option(ENABLE_RUBY      "Enable Ruby scripting language"            ON)
 option(ENABLE_LUA       "Enable Lua scripting language"             ON)
 option(ENABLE_TCL       "Enable Tcl scripting language"             ON)
 option(ENABLE_GUILE     "Enable Scheme (guile) scripting language"  ON)
+option(ENABLE_JAVASCRIPT "Enable JavaScript scripting language"      ON)
 option(ENABLE_TRIGGER   "Enable Trigger plugin"                     ON)
 option(ENABLE_XFER      "Enable Xfer plugin"                        ON)
 option(ENABLE_MAN       "Enable build of man page"                  OFF)

cmake/FindV8.cmake

@@ -0,0 +1,49 @@
+#
+# Copyright (C) 2015 Sébastien Helleu <flashcode@flashtux.org>
+#
+# This file is part of WeeChat, the extensible chat client.
+#
+# WeeChat is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# WeeChat is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with WeeChat.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+# - Find Aspell
+# This module finds if libaspell is installed and determines where
+# the include files and libraries are.
+#
+# This code sets the following variables:
+#
+#  V8_INCLUDE_DIR = path to where v8.h can be found
+#  V8_LIBRARY = path to where libv8.so* can be found
+
+if(V8_FOUND)
+  # Already in cache, be silent
+  SET(V8_FIND_QUIETLY TRUE)
+endif()
+
+set(V8_INC_PATHS
+  /usr/include
+  ${CMAKE_INCLUDE_PATH}
+)
+find_path(V8_INCLUDE_DIR v8.h PATHS ${V8_INC_PATHS})
+find_library(V8_LIBRARY
+  NAMES v8
+  PATHS /lib /usr/lib /usr/local/lib /usr/pkg/lib
+)
+
+find_package_handle_standard_args(V8 DEFAULT_MSG V8_LIBRARY V8_INCLUDE_DIR)
+
+mark_as_advanced(
+  V8_INCLUDE_DIR
+  V8_LIBRARY
+)

po/POTFILES.in

@@ -180,6 +180,12 @@
 ./src/plugins/irc/irc-sasl.h
 ./src/plugins/irc/irc-server.c
 ./src/plugins/irc/irc-server.h
+./src/plugins/javascript/weechat-js-api.cpp
+./src/plugins/javascript/weechat-js-api.h
+./src/plugins/javascript/weechat-js-v8.cpp
+./src/plugins/javascript/weechat-js-v8.h
+./src/plugins/javascript/weechat-js.cpp
+./src/plugins/javascript/weechat-js.h
 ./src/plugins/logger/logger-buffer.c
 ./src/plugins/logger/logger-buffer.h
 ./src/plugins/logger/logger.c

po/srcfiles.cmake

@@ -181,6 +181,12 @@ SET(WEECHAT_SOURCES
 ./src/plugins/irc/irc-sasl.h
 ./src/plugins/irc/irc-server.c
 ./src/plugins/irc/irc-server.h
+./src/plugins/javascript/weechat-js-api.cpp
+./src/plugins/javascript/weechat-js-api.h
+./src/plugins/javascript/weechat-js-v8.cpp
+./src/plugins/javascript/weechat-js-v8.h
+./src/plugins/javascript/weechat-js.cpp
+./src/plugins/javascript/weechat-js.h
 ./src/plugins/logger/logger-buffer.c
 ./src/plugins/logger/logger-buffer.h
 ./src/plugins/logger/logger.c

src/plugins/CMakeLists.txt

@@ -141,6 +141,13 @@ if(ENABLE_SCRIPTS AND ENABLE_GUILE)
   endif()
 endif()
 
+if(ENABLE_SCRIPTS AND ENABLE_JAVASCRIPT)
+  find_package(V8)
+  if(V8_FOUND)
+    add_subdirectory(javascript)
+  endif()
+endif()
+
 if(ENABLE_TRIGGER)
   add_subdirectory(trigger)
 endif()

src/plugins/javascript/CMakeLists.txt

@@ -0,0 +1,33 @@
+#
+# Copyright (C) 2015 Sébastien Helleu <flashcode@flashtux.org>
+#
+# This file is part of WeeChat, the extensible chat client.
+#
+# WeeChat is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# WeeChat is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with WeeChat.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+enable_language(CXX)
+
+add_library(javascript MODULE weechat-js.cpp weechat-js.h
+weechat-js-v8.cpp weechat-js-v8.h
+weechat-js-api.cpp weechat-js-api.h)
+
+set_target_properties(javascript PROPERTIES PREFIX "")
+
+if(V8_FOUND)
+  include_directories(${V8_INCLUDE_DIR})
+  target_link_libraries(javascript ${V8_LIBRARY} weechat_plugins_scripts)
+endif()
+
+install(TARGETS javascript LIBRARY DESTINATION ${LIBDIR}/plugins)

src/plugins/javascript/Makefile.am

@@ -0,0 +1,35 @@
+#
+# Copyright (C) 2015 Sébastien Helleu <flashcode@flashtux.org>
+#
+# This file is part of WeeChat, the extensible chat client.
+#
+# WeeChat is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# WeeChat is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with WeeChat.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+AM_CPPFLAGS = -DLOCALEDIR=\"$(datadir)/locale\" $(JAVASCRIPT_CFLAGS)
+
+libdir = ${weechat_libdir}/plugins
+
+lib_LTLIBRARIES = javascript.la
+
+javascript_la_SOURCES = weechat-js.c \
+                        weechat-js.h \
+                        weechat-js-v8.c \
+                        weechat-js-v8.h \
+                        weechat-js-api.c \
+                        weechat-js-api.h
+javascript_la_LDFLAGS = -module -no-undefined
+javascript_la_LIBADD  = ../lib_weechat_plugins_scripts.la $(JAVASCRIPT_LFLAGS)
+
+EXTRA_DIST = CMakeLists.txt

src/plugins/javascript/weechat-js-api.h

@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2013 Koka El Kiwi <admin@kokabsolu.com>
+ * Copyright (C) 2015 Sébastien Helleu <flashcode@flashtux.org>
+ *
+ * This file is part of WeeChat, the extensible chat client.
+ *
+ * WeeChat is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * WeeChat is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with WeeChat.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef WEECHAT_JS_API_H
+#define WEECHAT_JS_API_H 1
+
+extern int weechat_js_api_buffer_input_data_cb (void *data,
+                                                struct t_gui_buffer *buffer,
+                                                const char *input_data);
+extern int weechat_js_api_buffer_close_cb (void *data,
+                                           struct t_gui_buffer *buffer);
+
+#endif /* WEECHAT_JS_API_H */

src/plugins/javascript/weechat-js-v8.h

@@ -0,0 +1,54 @@
+/*
+ * Copyright (C) 2013 Koka El Kiwi <admin@kokabsolu.com>
+ * Copyright (C) 2015 Sébastien Helleu <flashcode@flashtux.org>
+ *
+ * This file is part of WeeChat, the extensible chat client.
+ *
+ * WeeChat is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * WeeChat is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with WeeChat.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef WEECHAT_JS_V8_H
+#define WEECHAT_JS_V8_H 1
+
+#include <cstdio>
+#include <v8.h>
+
+class WeechatJsV8
+{
+public:
+    WeechatJsV8(void);
+    ~WeechatJsV8(void);
+
+    bool load(v8::Handle<v8::String>);
+    bool load(const char *);
+
+    bool execScript(void);
+    bool functionExists(const char *);
+    v8::Handle<v8::Value> execFunction(const char *,
+                                       int argc, v8::Handle<v8::Value> *);
+
+    void addGlobal(v8::Handle<v8::String>, v8::Handle<v8::Template>);
+    void addGlobal(const char *, v8::Handle<v8::Template>);
+
+    void loadLibs(void);
+
+private:
+    v8::HandleScope handle_scope;
+    v8::Handle<v8::ObjectTemplate> global;
+    v8::Persistent<Context> context;
+
+    v8::Handle<v8::String> source;
+};
+
+#endif /* WEECHAT_JS_V8_H */

src/plugins/javascript/weechat-js.h

@@ -0,0 +1,64 @@
+/*
+ * Copyright (C) 2013 Koka El Kiwi <admin@kokabsolu.com>
+ * Copyright (C) 2015 Sébastien Helleu <flashcode@flashtux.org>
+ *
+ * This file is part of WeeChat, the extensible chat client.
+ *
+ * WeeChat is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * WeeChat is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with WeeChat.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef WEECHAT_JS_H
+#define WEECHAT_JS_H 1
+
+#include <v8.h>
+
+#ifdef __cplusplus
+#ifdef _WIN32
+#define EXPORT extern "C" __declspec (dllexport)
+#else
+#define EXPORT extern "C"
+#endif
+#else
+#define EXPORT
+#endif
+
+#define weechat_plugin weechat_js_plugin
+#define JS_PLUGIN_NAME "javascript"
+
+#define JS_CURRENT_SCRIPT_NAME ((js_current_script) ? js_current_script->name : "-")
+
+using namespace v8;
+
+class WeechatJsV8;
+
+extern struct t_weechat_plugin *weechat_js_plugin;
+
+extern int js_quiet;
+extern struct t_plugin_script *js_scripts;
+extern struct t_plugin_script *last_js_script;
+extern struct t_plugin_script *js_current_script;
+extern struct t_plugin_script *js_registered_script;
+extern const char *js_current_script_filename;
+extern WeechatJsV8 *js_current_interpreter;
+
+extern Handle<Object> weechat_js_hashtable_to_object (struct t_hashtable *hashtable);
+extern struct t_hashtable *weechat_js_object_to_hashtable (Handle<Object> obj,
+                                                           int size,
+                                                           const char *type_keys,
+                                                           const char *type_values);
+extern void *weechat_js_exec (struct t_plugin_script *script,
+                              int ret_type, const char *function,
+                              const char *format, void **argv);
+
+#endif /* WEECHAT_JS_H */

src/plugins/script/script-command.c

@@ -370,9 +370,9 @@ script_command_init ()
         " || show %(script_scripts)"
         " || load %(script_files)|%*"
         " || unload %(python_script)|%(perl_script)|%(ruby_script)|"
-        "%(tcl_script)|%(lua_script)|%(guile_script)|%*"
+        "%(tcl_script)|%(lua_script)|%(guile_script)|%(javascript_script)|%*"
         " || reload %(python_script)|%(perl_script)|%(ruby_script)|"
-        "%(tcl_script)|%(lua_script)|%(guile_script)|%*"
+        "%(tcl_script)|%(lua_script)|%(guile_script)|%(javascript_script)|%*"
         " || autoload %(script_scripts_installed)|%*"
         " || noautoload %(script_scripts_installed)|%*"
         " || toggleautoload %(script_scripts_installed)|%*"

src/plugins/script/script.c

@@ -45,9 +45,9 @@ WEECHAT_PLUGIN_PRIORITY(2000);
 struct t_weechat_plugin *weechat_script_plugin = NULL;
 
 char *script_language[SCRIPT_NUM_LANGUAGES] =
-{ "guile", "lua", "perl", "python", "ruby", "tcl" };
+{ "guile", "lua", "perl", "python", "ruby", "tcl", "javascript" };
 char *script_extension[SCRIPT_NUM_LANGUAGES] =
-{ "scm",   "lua", "pl",   "py",     "rb",   "tcl" };
+{ "scm",   "lua", "pl",   "py",     "rb",   "tcl", "js" };
 
 int script_plugin_loaded[SCRIPT_NUM_LANGUAGES];
 struct t_hashtable *script_loaded = NULL;

src/plugins/script/script.h

@@ -23,7 +23,7 @@
 #define weechat_plugin weechat_script_plugin
 #define SCRIPT_PLUGIN_NAME "script"
 
-#define SCRIPT_NUM_LANGUAGES 6
+#define SCRIPT_NUM_LANGUAGES 7
 
 extern struct t_weechat_plugin *weechat_script_plugin;