src/ecmascript/ecmascript.c

   1 /* Base ECMAScript file. Mostly a proxy for specific library backends. */
   2
   3 #ifdef HAVE_CONFIG_H
   4 #include "config.h"
   5 #endif
   6
   7 #include <stdlib.h>
   8
   9 #include "elinks.h"
  10
  11 #include "config/options.h"
  12 #include "document/document.h"
  13 #include "document/view.h"
  14 #include "ecmascript/ecmascript.h"
  15 #include "ecmascript/see.h"
  16 #include "ecmascript/spidermonkey.h"
  17 #include "intl/gettext/libintl.h"
  18 #include "main/module.h"
  19 #include "main/timer.h"
  20 #include "osdep/osdep.h"
  21 #include "protocol/protocol.h"
  22 #include "protocol/uri.h"
  23 #include "session/session.h"
  24 #include "session/task.h"
  25 #include "terminal/terminal.h"
  26 #include "terminal/window.h"
  27 #include "util/conv.h"
  28 #include "util/string.h"
  29 #include "viewer/text/view.h" /* current_frame() */
  30 #include "viewer/text/form.h" /* <-ecmascript_reset_state() */
  31 #include "viewer/text/vs.h"
  32
  33
  34 /* TODO: We should have some kind of ACL for the scripts - i.e. ability to
  35  * disallow the scripts to open new windows (or so that the windows are always
  36  * directed to tabs, this particular option would be a tristate), disallow
  37  * messing with your menubar/statusbar visibility, disallow changing the
  38  * statusbar content etc. --pasky */
  39
  40 static union option_info ecmascript_options[] = {
  41         INIT_OPT_TREE("", N_("ECMAScript"),
  42                 "ecmascript", 0,
  43                 N_("ECMAScript options.")),
  44
  45         INIT_OPT_BOOL("ecmascript", N_("Enable"),
  46                 "enable", 0, 0,
  47                 N_("Whether to run those scripts inside of documents.")),
  48
  49         INIT_OPT_BOOL("ecmascript", N_("Script error reporting"),
  50                 "error_reporting", 0, 0,
  51                 N_("Open a message box when a script reports an error.")),
  52
  53         INIT_OPT_BOOL("ecmascript", N_("Ignore <noscript> content"),
  54                 "ignore_noscript", 0, 0,
  55                 N_("Whether to ignore content enclosed by the <noscript> tag "
  56                 "when ECMAScript is enabled.")),
  57
  58         INIT_OPT_INT("ecmascript", N_("Maximum execution time"),
  59                 "max_exec_time", 0, 1, 3600, 5,
  60                 N_("Maximum execution time in seconds for a script.")),
  61
  62         INIT_OPT_BOOL("ecmascript", N_("Pop-up window blocking"),
  63                 "block_window_opening", 0, 0,
  64                 N_("Whether to disallow scripts to open new windows or tabs.")),
  65
  66         NULL_OPTION_INFO,
  67 };
  68
  69 struct ecmascript_interpreter *
  70 ecmascript_get_interpreter(struct view_state *vs)
  71 {
  72         struct ecmascript_interpreter *interpreter;
  73
  74         assert(vs);
  75
  76         interpreter = mem_calloc(1, sizeof(*interpreter));
  77         if (!interpreter)
  78                 return NULL;
  79
  80         interpreter->vs = vs;
  81         interpreter->vs->ecmascript_fragile = 0;
  82         init_list(interpreter->onload_snippets);
  83         /* The following backend call reads interpreter->vs.  */
  84         if (
  85 #ifdef CONFIG_ECMASCRIPT_SEE
  86             !see_get_interpreter(interpreter)
  87 #else
  88             !spidermonkey_get_interpreter(interpreter)
  89 #endif
  90             ) {
  91                 /* Undo what was done above.  */
  92                 interpreter->vs->ecmascript_fragile = 1;
  93                 mem_free(interpreter);
  94                 return NULL;
  95         }
  96
  97         init_string(&interpreter->code);
  98         return interpreter;
  99 }
 100
 101 void
 102 ecmascript_put_interpreter(struct ecmascript_interpreter *interpreter)
 103 {
 104         assert(interpreter);
 105         assert(interpreter->backend_nesting == 0);
 106         /* If the assertion fails, it is better to leak the
 107          * interpreter than to corrupt memory.  */
 108         if_assert_failed return;
 109
 110 #ifdef CONFIG_ECMASCRIPT_SEE
 111         see_put_interpreter(interpreter);
 112 #else
 113         spidermonkey_put_interpreter(interpreter);
 114 #endif
 115         free_string_list(&interpreter->onload_snippets);
 116         done_string(&interpreter->code);
 117         /* Is it superfluous? */
 118         if (interpreter->vs->doc_view)
 119                 kill_timer(&interpreter->vs->doc_view->document->timeout);
 120         interpreter->vs->ecmascript = NULL;
 121         interpreter->vs->ecmascript_fragile = 1;
 122         mem_free(interpreter);
 123 }
 124
 125 void
 126 ecmascript_eval(struct ecmascript_interpreter *interpreter,
 127                 struct string *code, struct string *ret)
 128 {
 129         if (!get_ecmascript_enable())
 130                 return;
 131         assert(interpreter);
 132         interpreter->backend_nesting++;
 133 #ifdef CONFIG_ECMASCRIPT_SEE
 134         see_eval(interpreter, code, ret);
 135 #else
 136         spidermonkey_eval(interpreter, code, ret);
 137 #endif
 138         interpreter->backend_nesting--;
 139 }
 140
 141 unsigned char *
 142 ecmascript_eval_stringback(struct ecmascript_interpreter *interpreter,
 143                            struct string *code)
 144 {
 145         unsigned char *result;
 146
 147         if (!get_ecmascript_enable())
 148                 return NULL;
 149         assert(interpreter);
 150         interpreter->backend_nesting++;
 151 #ifdef CONFIG_ECMASCRIPT_SEE
 152         result = see_eval_stringback(interpreter, code);
 153 #else
 154         result = spidermonkey_eval_stringback(interpreter, code);
 155 #endif
 156         interpreter->backend_nesting--;
 157         return result;
 158 }
 159
 160 int
 161 ecmascript_eval_boolback(struct ecmascript_interpreter *interpreter,
 162                          struct string *code)
 163 {
 164         int result;
 165
 166         if (!get_ecmascript_enable())
 167                 return -1;
 168         assert(interpreter);
 169         interpreter->backend_nesting++;
 170 #ifdef CONFIG_ECMASCRIPT_SEE
 171         result = see_eval_boolback(interpreter, code);
 172 #else
 173         result = spidermonkey_eval_boolback(interpreter, code);
 174 #endif
 175         interpreter->backend_nesting--;
 176         return result;
 177 }
 178
 179 void
 180 ecmascript_detach_form_view(struct form_view *fv)
 181 {
 182 #ifdef CONFIG_ECMASCRIPT_SEE
 183         see_detach_form_view(fv);
 184 #else
 185         spidermonkey_detach_form_view(fv);
 186 #endif
 187 }
 188
 189 void ecmascript_detach_form_state(struct form_state *fs)
 190 {
 191 #ifdef CONFIG_ECMASCRIPT_SEE
 192         see_detach_form_state(fs);
 193 #else
 194         spidermonkey_detach_form_state(fs);
 195 #endif
 196 }
 197
 198 void ecmascript_moved_form_state(struct form_state *fs)
 199 {
 200 #ifdef CONFIG_ECMASCRIPT_SEE
 201         see_moved_form_state(fs);
 202 #else
 203         spidermonkey_moved_form_state(fs);
 204 #endif
 205 }
 206
 207 void
 208 ecmascript_reset_state(struct view_state *vs)
 209 {
 210         struct form_view *fv;
 211         int i;
 212
 213         /* Normally, if vs->ecmascript == NULL, the associated
 214          * ecmascript_obj pointers are also NULL.  However, they might
 215          * be non-NULL if the ECMAScript objects have been lazily
 216          * created because of scripts running in sibling HTML frames.  */
 217         foreach (fv, vs->forms)
 218                 ecmascript_detach_form_view(fv);
 219         for (i = 0; i < vs->form_info_len; i++)
 220                 ecmascript_detach_form_state(&vs->form_info[i]);
 221
 222         vs->ecmascript_fragile = 0;
 223         if (vs->ecmascript)
 224                 ecmascript_put_interpreter(vs->ecmascript);
 225
 226         vs->ecmascript = ecmascript_get_interpreter(vs);
 227         if (!vs->ecmascript)
 228                 vs->ecmascript_fragile = 1;
 229 }
 230
 231 void
 232 ecmascript_protocol_handler(struct session *ses, struct uri *uri)
 233 {
 234         struct document_view *doc_view = current_frame(ses);
 235         struct string current_url = INIT_STRING(struri(uri), strlen(struri(uri)));
 236         unsigned char *redirect_url, *redirect_abs_url;
 237         struct uri *redirect_uri;
 238
 239         if (!doc_view) /* Blank initial document. TODO: Start at about:blank? */
 240                 return;
 241         assert(doc_view->vs);
 242         if (doc_view->vs->ecmascript_fragile)
 243                 ecmascript_reset_state(doc_view->vs);
 244         if (!doc_view->vs->ecmascript)
 245                 return;
 246
 247         redirect_url = ecmascript_eval_stringback(doc_view->vs->ecmascript,
 248                 &current_url);
 249         if (!redirect_url)
 250                 return;
 251         /* XXX: This code snippet is duplicated over here,
 252          * location_set_property(), html_a() and who knows where else. */
 253         redirect_abs_url = join_urls(doc_view->document->uri,
 254                                      trim_chars(redirect_url, ' ', 0));
 255         mem_free(redirect_url);
 256         if (!redirect_abs_url)
 257                 return;
 258         redirect_uri = get_uri(redirect_abs_url, 0);
 259         mem_free(redirect_abs_url);
 260         if (!redirect_uri)
 261                 return;
 262
 263         /* XXX: Is that safe to do at this point? --pasky */
 264         goto_uri_frame(ses, redirect_uri, doc_view->name,
 265                 CACHE_MODE_NORMAL);
 266         done_uri(redirect_uri);
 267 }
 268
 269
 270 void
 271 ecmascript_timeout_dialog(struct terminal *term, int max_exec_time)
 272 {
 273         info_box(term, MSGBOX_FREE_TEXT,
 274                  N_("JavaScript Emergency"), ALIGN_LEFT,
 275                  msg_text(term,
 276                   N_("A script embedded in the current document was running\n"
 277                   "for more than %d seconds. This probably means there is\n"
 278                   "a bug in the script and it could have halted the whole\n"
 279                   "ELinks, so the script execution was interrupted."),
 280                   max_exec_time));
 281
 282 }
 283
 284 void
 285 ecmascript_set_action(unsigned char **action, unsigned char *string)
 286 {
 287         struct uri *protocol;
 288
 289         trim_chars(string, ' ', NULL);
 290         protocol = get_uri(string, URI_PROTOCOL);
 291
 292         if (protocol) { /* full uri with protocol */
 293                 done_uri(protocol);
 294                 mem_free_set(action, string);
 295         } else {
 296                 if (dir_sep(string[0])) { /* absolute uri, TODO: disk drive under WIN32 */
 297                         struct uri *uri = get_uri(*action, URI_HTTP_REFERRER_HOST);
 298
 299                         if (uri->protocol == PROTOCOL_FILE) {
 300                                 mem_free_set(action, straconcat(struri(uri), string, (unsigned char *) NULL));
 301                         }
 302                         else
 303                                 mem_free_set(action, straconcat(struri(uri), string + 1, (unsigned char *) NULL));
 304                         done_uri(uri);
 305                         mem_free(string);
 306                 } else { /* relative uri */
 307                         unsigned char *last_slash = strrchr(*action, '/');
 308                         unsigned char *new_action;
 309
 310                         if (last_slash) *(last_slash + 1) = '\0';
 311                         new_action = straconcat(*action, string,
 312                                                 (unsigned char *) NULL);
 313                         mem_free_set(action, new_action);
 314                         mem_free(string);
 315                 }
 316         }
 317 }
 318
 319 /* Timer callback for @interpreter->vs->doc_view->document->timeout.
 320  * As explained in @install_timer, this function must erase the
 321  * expired timer ID from all variables.  */
 322 static void
 323 ecmascript_timeout_handler(void *i)
 324 {
 325         struct ecmascript_interpreter *interpreter = i;
 326
 327         assertm(interpreter->vs->doc_view != NULL,
 328                 "setTimeout: vs with no document (e_f %d)",
 329                 interpreter->vs->ecmascript_fragile);
 330         interpreter->vs->doc_view->document->timeout = TIMER_ID_UNDEF;
 331         /* The expired timer ID has now been erased.  */
 332
 333         ecmascript_eval(interpreter, &interpreter->code, NULL);
 334 }
 335
 336 void
 337 ecmascript_set_timeout(struct ecmascript_interpreter *interpreter, unsigned char *code, int timeout)
 338 {
 339         assert(interpreter && interpreter->vs->doc_view->document);
 340         if (!code) return;
 341         done_string(&interpreter->code);
 342         init_string(&interpreter->code);
 343         add_to_string(&interpreter->code, code);
 344         mem_free(code);
 345         kill_timer(&interpreter->vs->doc_view->document->timeout);
 346         install_timer(&interpreter->vs->doc_view->document->timeout, timeout, ecmascript_timeout_handler, interpreter);
 347 }
 348
 349 static struct module *ecmascript_modules[] = {
 350 #ifdef CONFIG_ECMASCRIPT_SEE
 351         &see_module,
 352 #elif defined(CONFIG_ECMASCRIPT_SMJS)
 353         &spidermonkey_module,
 354 #endif
 355         NULL,
 356 };
 357
 358
 359 struct module ecmascript_module = struct_module(
 360         /* name: */             N_("ECMAScript"),
 361         /* options: */          ecmascript_options,
 362         /* events: */           NULL,
 363         /* submodules: */       ecmascript_modules,
 364         /* data: */             NULL,
 365         /* init: */             NULL,
 366         /* done: */             NULL
 367 );