modules/element.js

   1 /**
   2  * (C) Copyright 2007-2009 John J. Foerch
   3  * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
   4  *
   5  * Portions of this file are derived from Vimperator,
   6  * (C) Copyright 2006-2007 Martin Stubenschrott.
   7  *
   8  * Use, modification, and distribution are subject to the terms specified in the
   9  * COPYING file.
  10 **/
  11
  12 require("hints.js");
  13 require("save.js");
  14 require("mime-type-override.js");
  15 require("minibuffer-read-mime-type.js");
  16
  17 var browser_object_classes = {};
  18
  19 /**
  20  * browser_object_class
  21  *
  22  *   In normal cases, make a new browser_object_class with the function,
  23  * `define_browser_object_class'.
  24  *
  25  * name: See note on `define_browser_object_class'.
  26  *
  27  * doc: a docstring
  28  *
  29  * handler: a coroutine called as: handler(I, prompt).  `I' is a normal
  30  *          interactive context.  `prompt' is there to pass along as the
  31  *          $prompt of various minibuffer read procedures, if needed.
  32  *
  33  * $hint: short string (usually verb and noun) to describe the UI
  34  *        of the browser object class to the user.  Only used by
  35  *        browser object classes which make use of the minibuffer.
  36  */
  37 define_keywords("$hint");
  38 function browser_object_class (name, doc, handler) {
  39     keywords(arguments);
  40     this.name = name;
  41     this.handler = handler;
  42     this.doc = doc;
  43     this.hint = arguments.$hint;
  44 }
  45
  46 /**
  47  * define_browser_object_class
  48  *
  49  *   In normal cases, make a new browser_object_class with the function,
  50  * `define_browser_object_class'.
  51  *
  52  * name: the name of the browser object class.  multiword names should be
  53  *       hyphenated.  From this name, a variable browser_object_NAME and
  54  *       an interactive command browser-object-NAME will be generated.
  55  *
  56  *   Other arguments are as for `browser_object_class'.
  57  */
  58 // keywords: $hint
  59 function define_browser_object_class (name, doc, handler) {
  60     keywords(arguments);
  61     var varname = 'browser_object_'+name.replace('-','_','g');
  62     var ob = conkeror[varname] =
  63         new browser_object_class(name, doc, handler,
  64                                  forward_keywords(arguments));
  65     interactive("browser-object-"+name,
  66         "A prefix command to specify that the following command operate "+
  67         "on objects of type: "+name+".",
  68         function (I) { I.browser_object = ob; },
  69         $prefix = true);
  70     return ob;
  71 }
  72
  73 /**
  74  * xpath_browser_object_handler
  75  *
  76  *   This generates a function of the type needed for a handler of a
  77  * browser object class.  The handler uses `read_hinted_element' of
  78  * hints.js to let the user pick a DOM node from those matched by
  79  * `xpath_expression'.
  80  */
  81 function xpath_browser_object_handler (xpath_expression) {
  82     return function (I, prompt) {
  83         var result = yield I.buffer.window.minibuffer.read_hinted_element(
  84             $buffer = I.buffer,
  85             $prompt = prompt,
  86             $hint_xpath_expression = xpath_expression);
  87         yield co_return(result);
  88     };
  89 }
  90
  91 define_browser_object_class("images",
  92     "Browser object class for selecting an html:img via hinting.",
  93     xpath_browser_object_handler("//img | //xhtml:img"),
  94     $hint = "select image");
  95
  96 define_browser_object_class("frames",
  97     "Browser object class for selecting a frame or iframe via hinting.",
  98     function (I, prompt) {
  99         var doc = I.buffer.document;
 100         // Check for any frames or visible iframes
 101         var skip_hints = true;
 102         if (doc.getElementsByTagName("frame").length > 0)
 103             skip_hints = false;
 104         else {
 105             let topwin = I.buffer.top_frame;
 106             let iframes = doc.getElementsByTagName("iframe");
 107             for (var i = 0, nframes = iframes.length; i < nframes; i++) {
 108                 let style = topwin.getComputedStyle(iframes[i], "");
 109                 if (style.display == "none" || style.visibility == "hidden")
 110                     continue;
 111                 skip_hints = false;
 112                 break;
 113             }
 114         }
 115         if (skip_hints) {
 116             // only one frame (the top-level one), no need to use the hints system
 117             yield co_return(I.buffer.top_frame);
 118         }
 119         var result = yield I.buffer.window.minibuffer.read_hinted_element(
 120             $buffer = I.buffer,
 121             $prompt = prompt,
 122             $hint_xpath_expression = "//iframe | //frame | //xhtml:iframe | //xhtml:frame");
 123         yield co_return(result);
 124     },
 125     $hint = "select frame");
 126
 127 define_browser_object_class("links",
 128     "Browser object class for selecting a hyperlink, form field, "+
 129     "or link-like element, via hinting.",
 130     xpath_browser_object_handler(
 131         "//*[@onclick or @onmouseover or @onmousedown or @onmouseup or @oncommand or " +
 132         "@role='link'] | " +
 133         "//input[not(@type='hidden')] | //a | //area | //iframe | //textarea | //button | //select | " +
 134         "//*[@contenteditable = 'true']"),
 135     $hint = "select link");
 136
 137 define_browser_object_class("mathml",
 138     "Browser object class for selecting a MathML node via hinting.",
 139     xpath_browser_object_handler("//m:math"),
 140     $hint = "select MathML element");
 141
 142 define_browser_object_class("top",
 143     "Browser object class which returns the top frame of the document.",
 144     function (I, prompt) { return I.buffer.top_frame; });
 145
 146 define_browser_object_class("url",
 147     "Browser object class which prompts the user for an url or webjump.",
 148     function (I, prompt) {
 149         var result = yield I.buffer.window.minibuffer.read_url($prompt = prompt);
 150         yield co_return(result);
 151     },
 152     $hint = "enter URL/webjump");
 153
 154 define_browser_object_class("paste-url",
 155     "Browser object which reads an url from the X Primary Selection, "+
 156     "falling back on the clipboard for operating systems which lack one.",
 157     function (I, prompt) {
 158                 var url = read_from_x_primary_selection();
 159                 // trim spaces
 160                 url = url.replace(/^\s*|\s*$/,"");
 161                 // add http:// if needed
 162                 if (url.match(/^[^:]+\./)) {
 163                         url = "http://" + url;
 164                 }
 165         try {
 166             return make_uri(url).spec;
 167         } catch (e) {
 168             throw new interactive_error("error: malformed url: "+url);
 169         }
 170     });
 171
 172 define_browser_object_class("file",
 173     "Browser object which prompts for a file name.",
 174     function (I, prompt) {
 175         var result = yield I.buffer.window.minibuffer.read_file(
 176             $prompt = prompt,
 177             $history = I.command.name+"/file",
 178             $initial_value = I.local.cwd.path);
 179         yield co_return(result);
 180     },
 181     $hint = "enter file name");
 182
 183 define_browser_object_class("alt",
 184     "Browser object class which returns the alt text of an html:img, "+
 185     "selected via hinting",
 186     function (I, prompt) {
 187         var result = yield I.buffer.window.minibuffer.read_hinted_element(
 188             $buffer = I.buffer,
 189             $prompt = prompt,
 190             $hint_xpath_expression = "//img[@alt]");
 191         yield co_return(result.alt);
 192     },
 193     $hint = "select image for alt-text");
 194
 195 define_browser_object_class("title",
 196     "Browser object class which returns the title attribute of an element, "+
 197     "selected via hinting",
 198     function (I, prompt) {
 199         var result = yield I.buffer.window.minibuffer.read_hinted_element(
 200             $buffer = I.buffer,
 201             $prompt = prompt,
 202             $hint_xpath_expression = "//*[@title]");
 203         yield co_return(result.title);
 204     },
 205     $hint = "select element for title attribute");
 206
 207 define_browser_object_class("title-or-alt",
 208     "Browser object which is the union of browser-object-alt and "+
 209     "browser-object-title, with title having higher precedence in "+
 210     "the case of an element that has both.",
 211     function (I, prompt) {
 212         var result = yield I.buffer.window.minibuffer.read_hinted_element(
 213             $buffer = I.buffer,
 214             $prompt = prompt,
 215             $hint_xpath_expression = "//img[@alt] | //*[@title]");
 216         yield co_return(result.title ? result.title : result.alt);
 217     },
 218     $hint = "select element for title or alt-text");
 219
 220 define_browser_object_class("scrape-url",
 221     "Browser object which lets the user choose an url from a list of "+
 222     "urls scraped from the source code of the document.",
 223     function (I, prompt) {
 224         var completions = I.buffer.document.documentElement.innerHTML
 225             .match(/http:[^\s>"]*/g)
 226             .filter(remove_duplicates_filter());
 227         var completer = prefix_completer($completions = completions);
 228         var result = yield I.buffer.window.minibuffer.read(
 229             $prompt = prompt,
 230             $completer = completer,
 231             $initial_value = null,
 232             $auto_complete = "url",
 233             $select,
 234             $match_required = false);
 235         yield co_return(result);
 236     },
 237     $hint = "choose scraped URL");
 238
 239 define_browser_object_class("up-url",
 240     "Browser object which returns the url one level above the current one.",
 241     function (I, prompt) {
 242         var up = compute_url_up_path(I.buffer.current_uri.spec);
 243         return I.buffer.current_uri.resolve(up);
 244     });
 245
 246 define_browser_object_class("focused-element",
 247     "Browser object which returns the focused element.",
 248     function (I, prompt) { return I.buffer.focused_element; });
 249
 250 define_browser_object_class("dom-node", null,
 251     xpath_browser_object_handler("//*"),
 252     $hint = "select DOM node");
 253
 254 function read_browser_object (I) {
 255     var browser_object = I.browser_object;
 256     // literals cannot be overridden
 257     if (browser_object instanceof Function)
 258         yield co_return(browser_object(I));
 259     if (! (browser_object instanceof browser_object_class))
 260         yield co_return(browser_object);
 261
 262     var prompt = I.command.prompt;
 263     if (! prompt) {
 264         prompt = I.command.name.split(/-|_/).join(" ");
 265         prompt = prompt[0].toUpperCase() + prompt.substring(1);
 266     }
 267     if (I.target != null)
 268         prompt += TARGET_PROMPTS[I.target];
 269     if (browser_object.hint)
 270         prompt += " (" + browser_object.hint + ")";
 271     prompt += ":";
 272
 273     var result = yield browser_object.handler.call(null, I, prompt);
 274     yield co_return(result);
 275 }
 276
 277
 278 /**
 279  * This is a simple wrapper function that sets focus to elem, and
 280  * bypasses the automatic focus prevention system, which might
 281  * otherwise prevent this from happening.
 282  */
 283 function browser_set_element_focus (buffer, elem, prevent_scroll) {
 284     if (!element_dom_node_or_window_p(elem))
 285         return;
 286     if (prevent_scroll)
 287         set_focus_no_scroll(buffer.window, elem);
 288     else
 289         elem.focus();
 290 }
 291
 292 function browser_element_focus (buffer, elem) {
 293     if (!element_dom_node_or_window_p(elem))
 294         return;
 295
 296     if (elem instanceof Ci.nsIDOMXULTextBoxElement)
 297         elem = elem.wrappedJSObject.inputField; // focus the input field
 298
 299     browser_set_element_focus(buffer, elem);
 300     if (elem instanceof Ci.nsIDOMWindow)
 301         return;
 302
 303     // If it is not a window, it must be an HTML element
 304     var x = 0;
 305     var y = 0;
 306     if (elem instanceof Ci.nsIDOMHTMLFrameElement ||
 307         elem instanceof Ci.nsIDOMHTMLIFrameElement)
 308     {
 309         elem.contentWindow.focus();
 310         return;
 311     }
 312     if (elem instanceof Ci.nsIDOMHTMLAreaElement) {
 313         var coords = elem.getAttribute("coords").split(",");
 314         x = Number(coords[0]);
 315         y = Number(coords[1]);
 316     }
 317
 318     var doc = elem.ownerDocument;
 319     var evt = doc.createEvent("MouseEvents");
 320
 321     evt.initMouseEvent("mouseover", true, true, doc.defaultView, 1, x, y, 0, 0, 0, 0, 0, 0, 0, null);
 322     elem.dispatchEvent(evt);
 323 }
 324
 325 function browser_object_follow (buffer, target, elem) {
 326     // XXX: would be better to let nsILocalFile objects be load_specs
 327     if (elem instanceof Ci.nsILocalFile)
 328         elem = elem.path;
 329
 330     var e;
 331     if (elem instanceof load_spec)
 332         e = load_spec_element(elem);
 333     if (! e)
 334         e = elem;
 335
 336     browser_set_element_focus(buffer, e, true /* no scroll */);
 337
 338     var no_click = (((elem instanceof load_spec) &&
 339                      load_spec_forced_charset(elem)) ||
 340                     (e instanceof load_spec) ||
 341                     (e instanceof Ci.nsIDOMWindow) ||
 342                     (e instanceof Ci.nsIDOMHTMLFrameElement) ||
 343                     (e instanceof Ci.nsIDOMHTMLIFrameElement) ||
 344                     (e instanceof Ci.nsIDOMHTMLLinkElement) ||
 345                     (e instanceof Ci.nsIDOMHTMLImageElement &&
 346                      !e.hasAttribute("onmousedown") && !e.hasAttribute("onclick")));
 347
 348     if (target == FOLLOW_DEFAULT && !no_click) {
 349         var x = 1, y = 1;
 350         if (e instanceof Ci.nsIDOMHTMLAreaElement) {
 351             var coords = e.getAttribute("coords").split(",");
 352             if (coords.length >= 2) {
 353                 x = Number(coords[0]) + 1;
 354                 y = Number(coords[1]) + 1;
 355             }
 356         }
 357         dom_node_click(e, x, y);
 358         return;
 359     }
 360
 361     var spec = load_spec(elem);
 362
 363     if (load_spec_uri_string(spec).match(/^\s*javascript:/)) {
 364         // it is nonsensical to follow a javascript url in a different
 365         // buffer or window
 366         target = FOLLOW_DEFAULT;
 367     } else if (!(buffer instanceof content_buffer) &&
 368         (target == FOLLOW_CURRENT_FRAME ||
 369          target == FOLLOW_DEFAULT ||
 370          target == OPEN_CURRENT_BUFFER))
 371     {
 372         target = OPEN_NEW_BUFFER;
 373     }
 374
 375     switch (target) {
 376     case FOLLOW_CURRENT_FRAME:
 377         var current_frame = load_spec_source_frame(spec);
 378         if (current_frame && current_frame != buffer.top_frame) {
 379             var target_obj = get_web_navigation_for_frame(current_frame);
 380             apply_load_spec(target_obj, spec);
 381             break;
 382         }
 383     case FOLLOW_DEFAULT:
 384     case OPEN_CURRENT_BUFFER:
 385         buffer.load(spec);
 386         break;
 387     case OPEN_NEW_WINDOW:
 388     case OPEN_NEW_BUFFER:
 389     case OPEN_NEW_BUFFER_BACKGROUND:
 390         create_buffer(buffer.window,
 391                       buffer_creator(content_buffer,
 392                                      $opener = buffer,
 393                                      $load = spec),
 394                       target);
 395     }
 396 }
 397
 398 /**
 399  * Follow a link-like element by generating fake mouse events.
 400  */
 401 function dom_node_click (elem, x, y) {
 402     var doc = elem.ownerDocument;
 403     var view = doc.defaultView;
 404
 405     var evt = doc.createEvent("MouseEvents");
 406     evt.initMouseEvent("mousedown", true, true, view, 1, x, y, 0, 0, /*ctrl*/ 0, /*event.altKey*/0,
 407                        /*event.shiftKey*/ 0, /*event.metaKey*/ 0, 0, null);
 408     elem.dispatchEvent(evt);
 409
 410     evt = doc.createEvent("MouseEvents");
 411     evt.initMouseEvent("click", true, true, view, 1, x, y, 0, 0, /*ctrl*/ 0, /*event.altKey*/0,
 412                        /*event.shiftKey*/ 0, /*event.metaKey*/ 0, 0, null);
 413     elem.dispatchEvent(evt);
 414 }
 415
 416
 417 function follow (I, target) {
 418     if (target == null)
 419         target = FOLLOW_DEFAULT;
 420     I.target = target;
 421     if (target == OPEN_CURRENT_BUFFER)
 422         check_buffer(I.buffer, content_buffer);
 423     var element = yield read_browser_object(I);
 424     try {
 425         element = load_spec(element);
 426         if (I.forced_charset)
 427             element.forced_charset = I.forced_charset;
 428     } catch (e) {}
 429     browser_object_follow(I.buffer, target, element);
 430 }
 431
 432 function follow_new_buffer (I) {
 433     yield follow(I, OPEN_NEW_BUFFER);
 434 }
 435
 436 function follow_new_buffer_background (I) {
 437     yield follow(I, OPEN_NEW_BUFFER_BACKGROUND);
 438 }
 439
 440 function follow_new_window (I) {
 441     yield follow(I, OPEN_NEW_WINDOW);
 442 }
 443
 444 function follow_current_frame (I) {
 445     yield follow(I, FOLLOW_CURRENT_FRAME);
 446 }
 447
 448 function follow_current_buffer (I) {
 449     yield follow(I, OPEN_CURRENT_BUFFER);
 450 }
 451
 452
 453 function element_get_load_target_label (element) {
 454     if (element instanceof Ci.nsIDOMWindow)
 455         return "page";
 456     if (element instanceof Ci.nsIDOMHTMLFrameElement)
 457         return "frame";
 458     if (element instanceof Ci.nsIDOMHTMLIFrameElement)
 459         return "iframe";
 460     return null;
 461 }
 462
 463 function element_get_operation_label (element, op_name, suffix) {
 464     var target_label = element_get_load_target_label(element);
 465     if (target_label != null)
 466         target_label = " " + target_label;
 467     else
 468         target_label = "";
 469
 470     if (suffix != null)
 471         suffix = " " + suffix;
 472     else
 473         suffix = "";
 474
 475     return op_name + target_label + suffix + ":";
 476 }
 477
 478
 479 function browser_element_copy (buffer, elem) {
 480     var spec;
 481     try {
 482        spec = load_spec(elem);
 483     } catch (e) {}
 484     var text = null;
 485     if (spec)
 486         text = load_spec_uri_string(spec);
 487     else  {
 488         if (!(elem instanceof Ci.nsIDOMNode))
 489             throw interactive_error("Element has no associated text to copy.");
 490         switch (elem.localName) {
 491         case "INPUT":
 492         case "TEXTAREA":
 493             text = elem.value;
 494             break;
 495         case "SELECT":
 496             if (elem.selectedIndex >= 0)
 497                 text = elem.item(elem.selectedIndex).text;
 498             break;
 499         default:
 500             text = elem.textContent;
 501             break;
 502         }
 503     }
 504     browser_set_element_focus(buffer, elem);
 505     writeToClipboard(text);
 506     buffer.window.minibuffer.message("Copied: " + text);
 507 }
 508
 509
 510 define_variable("view_source_use_external_editor", false,
 511     "When true, the `view-source' command will send its document to "+
 512     "your external editor.");
 513
 514 define_variable("view_source_function", null,
 515     "May be set to a user-defined function for viewing source code. "+
 516     "The function should accept an nsILocalFile of the filename as "+
 517     "its one positional argument, and it will also be called with "+
 518     "the keyword `$temporary', whose value will be true if the file "+
 519     "is considered temporary, and therefore the function must take "+
 520     "responsibility for deleting it.");
 521
 522 function browser_object_view_source (buffer, target, elem) {
 523     if (view_source_use_external_editor || view_source_function) {
 524         var spec = load_spec(elem);
 525
 526         let [file, temp] = yield download_as_temporary(spec,
 527                                                        $buffer = buffer,
 528                                                        $action = "View source");
 529         if (view_source_use_external_editor)
 530             yield open_file_with_external_editor(file, $temporary = temp);
 531         else
 532             yield view_source_function(file, $temporary = temp);
 533         return;
 534     }
 535
 536     var win = null;
 537     var window = buffer.window;
 538     if (elem.localName) {
 539         switch (elem.localName.toLowerCase()) {
 540         case "frame": case "iframe":
 541             win = elem.contentWindow;
 542             break;
 543         case "math":
 544             view_mathml_source(window, charset, elem);
 545             return;
 546         default:
 547             throw new Error("Invalid browser element");
 548         }
 549     } else
 550         win = elem;
 551     win.focus();
 552
 553     var url_s = win.location.href;
 554     if (url_s.substring (0,12) != "view-source:") {
 555         try {
 556             browser_object_follow(buffer, target, "view-source:" + url_s);
 557         } catch(e) { dump_error(e); }
 558     } else {
 559         window.minibuffer.message ("Already viewing source");
 560     }
 561 }
 562
 563 function view_source (I, target) {
 564     I.target = target;
 565     if (target == null)
 566         target = OPEN_CURRENT_BUFFER;
 567     var element = yield read_browser_object(I);
 568     yield browser_object_view_source(I.buffer, target, element);
 569 }
 570
 571 function view_source_new_buffer (I) {
 572     yield view_source(I, OPEN_NEW_BUFFER);
 573 }
 574
 575 function view_source_new_window (I) {
 576     yield view_source(I, OPEN_NEW_WINDOW);
 577 }
 578
 579
 580 function browser_element_shell_command (buffer, elem, command, cwd) {
 581     var spec = load_spec(elem);
 582     yield download_as_temporary(spec,
 583                                 $buffer = buffer,
 584                                 $shell_command = command,
 585                                 $shell_command_cwd = cwd);
 586 }
 587