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 @role='link'] | " +
 132         "//input[not(@type='hidden')] | //a | //area | //iframe | //textarea | //button | //select | " +
 133         "//*[@contenteditable = 'true'] |" +
 134         "//xhtml:*[@onclick or @onmouseover or @onmousedown or @onmouseup or @oncommand or @role='link'] | " +
 135         "//xhtml:input[not(@type='hidden')] | //xhtml:a | //xhtml:area | //xhtml:iframe | //xhtml:textarea | //xhtml:button | //xhtml:select | " +
 136         "//xhtml:*[@contenteditable = 'true']"),
 137     $hint = "select link");
 138
 139 define_browser_object_class("mathml",
 140     "Browser object class for selecting a MathML node via hinting.",
 141     xpath_browser_object_handler("//m:math"),
 142     $hint = "select MathML element");
 143
 144 define_browser_object_class("top",
 145     "Browser object class which returns the top frame of the document.",
 146     function (I, prompt) { return I.buffer.top_frame; });
 147
 148 define_browser_object_class("url",
 149     "Browser object class which prompts the user for an url or webjump.",
 150     function (I, prompt) {
 151         var result = yield I.buffer.window.minibuffer.read_url($prompt = prompt);
 152         yield co_return(result);
 153     },
 154     $hint = "enter URL/webjump");
 155
 156 define_browser_object_class("paste-url",
 157     "Browser object which reads an url from the X Primary Selection, "+
 158     "falling back on the clipboard for operating systems which lack one.",
 159     function (I, prompt) {
 160                 var url = read_from_x_primary_selection();
 161                 // trim spaces
 162                 url = url.replace(/^\s*|\s*$/,"");
 163                 // add http:// if needed
 164                 if (url.match(/^[^:]+\./)) {
 165                         url = "http://" + url;
 166                 }
 167         try {
 168             return make_uri(url).spec;
 169         } catch (e) {
 170             throw new interactive_error("error: malformed url: "+url);
 171         }
 172     });
 173
 174 define_browser_object_class("file",
 175     "Browser object which prompts for a file name.",
 176     function (I, prompt) {
 177         var result = yield I.buffer.window.minibuffer.read_file(
 178             $prompt = prompt,
 179             $history = I.command.name+"/file",
 180             $initial_value = I.local.cwd.path);
 181         yield co_return(result);
 182     },
 183     $hint = "enter file name");
 184
 185 define_browser_object_class("alt",
 186     "Browser object class which returns the alt text of an html:img, "+
 187     "selected via hinting",
 188     function (I, prompt) {
 189         var result = yield I.buffer.window.minibuffer.read_hinted_element(
 190             $buffer = I.buffer,
 191             $prompt = prompt,
 192             $hint_xpath_expression = "//img[@alt] | //xhtml:img[@alt]");
 193         yield co_return(result.alt);
 194     },
 195     $hint = "select image for alt-text");
 196
 197 define_browser_object_class("title",
 198     "Browser object class which returns the title attribute of an element, "+
 199     "selected via hinting",
 200     function (I, prompt) {
 201         var result = yield I.buffer.window.minibuffer.read_hinted_element(
 202             $buffer = I.buffer,
 203             $prompt = prompt,
 204             $hint_xpath_expression = "//*[@title] | //xhtml:*[@title]");
 205         yield co_return(result.title);
 206     },
 207     $hint = "select element for title attribute");
 208
 209 define_browser_object_class("title-or-alt",
 210     "Browser object which is the union of browser-object-alt and "+
 211     "browser-object-title, with title having higher precedence in "+
 212     "the case of an element that has both.",
 213     function (I, prompt) {
 214         var result = yield I.buffer.window.minibuffer.read_hinted_element(
 215             $buffer = I.buffer,
 216             $prompt = prompt,
 217             $hint_xpath_expression = "//img[@alt] | //*[@title] | //xhtml:img[@alt] | //xhtml:*[@title]");
 218         yield co_return(result.title ? result.title : result.alt);
 219     },
 220     $hint = "select element for title or alt-text");
 221
 222 define_browser_object_class("scrape-url",
 223     "Browser object which lets the user choose an url from a list of "+
 224     "urls scraped from the source code of the document.",
 225     function (I, prompt) {
 226         var completions = I.buffer.document.documentElement.innerHTML
 227             .match(/http:[^\s>"]*/g)
 228             .filter(remove_duplicates_filter());
 229         var completer = prefix_completer($completions = completions);
 230         var result = yield I.buffer.window.minibuffer.read(
 231             $prompt = prompt,
 232             $completer = completer,
 233             $initial_value = null,
 234             $auto_complete = "url",
 235             $select,
 236             $match_required = false);
 237         yield co_return(result);
 238     },
 239     $hint = "choose scraped URL");
 240
 241 define_browser_object_class("up-url",
 242     "Browser object which returns the url one level above the current one.",
 243     function (I, prompt) {
 244         var up = compute_url_up_path(I.buffer.current_uri.spec);
 245         return I.buffer.current_uri.resolve(up);
 246     });
 247
 248 define_browser_object_class("focused-element",
 249     "Browser object which returns the focused element.",
 250     function (I, prompt) { return I.buffer.focused_element; });
 251
 252 define_browser_object_class("dom-node", null,
 253     xpath_browser_object_handler("//* | //xhtml:*"),
 254     $hint = "select DOM node");
 255
 256 function read_browser_object (I) {
 257     var browser_object = I.browser_object;
 258     var result;
 259     // literals cannot be overridden
 260     if (browser_object instanceof Function) {
 261         result = yield browser_object(I);
 262         yield co_return(result);
 263     }
 264     if (! (browser_object instanceof browser_object_class))
 265         yield co_return(browser_object);
 266
 267     var prompt = I.command.prompt;
 268     if (! prompt) {
 269         prompt = I.command.name.split(/-|_/).join(" ");
 270         prompt = prompt[0].toUpperCase() + prompt.substring(1);
 271     }
 272     if (I.target != null)
 273         prompt += TARGET_PROMPTS[I.target];
 274     if (browser_object.hint)
 275         prompt += " (" + browser_object.hint + ")";
 276     prompt += ":";
 277
 278     result = yield browser_object.handler.call(null, I, prompt);
 279     yield co_return(result);
 280 }
 281
 282
 283 /**
 284  * This is a simple wrapper function that sets focus to elem, and
 285  * bypasses the automatic focus prevention system, which might
 286  * otherwise prevent this from happening.
 287  */
 288 function browser_set_element_focus (buffer, elem, prevent_scroll) {
 289     if (!element_dom_node_or_window_p(elem))
 290         return;
 291     if (prevent_scroll)
 292         set_focus_no_scroll(buffer.window, elem);
 293     else
 294         elem.focus();
 295 }
 296
 297 function browser_element_focus (buffer, elem) {
 298     if (!element_dom_node_or_window_p(elem))
 299         return;
 300
 301     if (elem instanceof Ci.nsIDOMXULTextBoxElement)
 302         elem = elem.wrappedJSObject.inputField; // focus the input field
 303
 304     browser_set_element_focus(buffer, elem);
 305     if (elem instanceof Ci.nsIDOMWindow)
 306         return;
 307
 308     // If it is not a window, it must be an HTML element
 309     var x = 0;
 310     var y = 0;
 311     if (elem instanceof Ci.nsIDOMHTMLFrameElement ||
 312         elem instanceof Ci.nsIDOMHTMLIFrameElement)
 313     {
 314         elem.contentWindow.focus();
 315         return;
 316     }
 317     if (elem instanceof Ci.nsIDOMHTMLAreaElement) {
 318         var coords = elem.getAttribute("coords").split(",");
 319         x = Number(coords[0]);
 320         y = Number(coords[1]);
 321     }
 322
 323     var doc = elem.ownerDocument;
 324     var evt = doc.createEvent("MouseEvents");
 325
 326     evt.initMouseEvent("mouseover", true, true, doc.defaultView, 1, x, y, 0, 0, 0, 0, 0, 0, 0, null);
 327     elem.dispatchEvent(evt);
 328 }
 329
 330 function browser_object_follow (buffer, target, elem) {
 331     // XXX: would be better to let nsILocalFile objects be load_specs
 332     if (elem instanceof Ci.nsILocalFile)
 333         elem = elem.path;
 334
 335     var e;
 336     if (elem instanceof load_spec)
 337         e = load_spec_element(elem);
 338     if (! e)
 339         e = elem;
 340
 341     browser_set_element_focus(buffer, e, true /* no scroll */);
 342
 343     var no_click = (((elem instanceof load_spec) &&
 344                      load_spec_forced_charset(elem)) ||
 345                     (e instanceof load_spec) ||
 346                     (e instanceof Ci.nsIDOMWindow) ||
 347                     (e instanceof Ci.nsIDOMHTMLFrameElement) ||
 348                     (e instanceof Ci.nsIDOMHTMLIFrameElement) ||
 349                     (e instanceof Ci.nsIDOMHTMLLinkElement) ||
 350                     (e instanceof Ci.nsIDOMHTMLImageElement &&
 351                      !e.hasAttribute("onmousedown") && !e.hasAttribute("onclick")));
 352
 353     if (target == FOLLOW_DEFAULT && !no_click) {
 354         var x = 1, y = 1;
 355         if (e instanceof Ci.nsIDOMHTMLAreaElement) {
 356             var coords = e.getAttribute("coords").split(",");
 357             if (coords.length >= 2) {
 358                 x = Number(coords[0]) + 1;
 359                 y = Number(coords[1]) + 1;
 360             }
 361         }
 362         dom_node_click(e, x, y);
 363         return;
 364     }
 365
 366     var spec = load_spec(elem);
 367
 368     if (load_spec_uri_string(spec).match(/^\s*javascript:/)) {
 369         // it is nonsensical to follow a javascript url in a different
 370         // buffer or window
 371         target = FOLLOW_DEFAULT;
 372     } else if (!(buffer instanceof content_buffer) &&
 373         (target == FOLLOW_CURRENT_FRAME ||
 374          target == FOLLOW_DEFAULT ||
 375          target == OPEN_CURRENT_BUFFER))
 376     {
 377         target = OPEN_NEW_BUFFER;
 378     }
 379
 380     switch (target) {
 381     case FOLLOW_CURRENT_FRAME:
 382         var current_frame = load_spec_source_frame(spec);
 383         if (current_frame && current_frame != buffer.top_frame) {
 384             var target_obj = get_web_navigation_for_frame(current_frame);
 385             apply_load_spec(target_obj, spec);
 386             break;
 387         }
 388     case FOLLOW_DEFAULT:
 389     case OPEN_CURRENT_BUFFER:
 390         buffer.load(spec);
 391         break;
 392     case OPEN_NEW_WINDOW:
 393     case OPEN_NEW_BUFFER:
 394     case OPEN_NEW_BUFFER_BACKGROUND:
 395         create_buffer(buffer.window,
 396                       buffer_creator(content_buffer,
 397                                      $opener = buffer,
 398                                      $load = spec),
 399                       target);
 400     }
 401 }
 402
 403 /**
 404  * Follow a link-like element by generating fake mouse events.
 405  */
 406 function dom_node_click (elem, x, y) {
 407     var doc = elem.ownerDocument;
 408     var view = doc.defaultView;
 409
 410     var evt = doc.createEvent("MouseEvents");
 411     evt.initMouseEvent("mousedown", 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     evt = doc.createEvent("MouseEvents");
 416     evt.initMouseEvent("click", true, true, view, 1, x, y, 0, 0, /*ctrl*/ 0, /*event.altKey*/0,
 417                        /*event.shiftKey*/ 0, /*event.metaKey*/ 0, 0, null);
 418     elem.dispatchEvent(evt);
 419 }
 420
 421
 422 function follow (I, target) {
 423     if (target == null)
 424         target = FOLLOW_DEFAULT;
 425     I.target = target;
 426     if (target == OPEN_CURRENT_BUFFER)
 427         check_buffer(I.buffer, content_buffer);
 428     var element = yield read_browser_object(I);
 429     try {
 430         element = load_spec(element);
 431         if (I.forced_charset)
 432             element.forced_charset = I.forced_charset;
 433     } catch (e) {}
 434     browser_object_follow(I.buffer, target, element);
 435 }
 436
 437 function follow_new_buffer (I) {
 438     yield follow(I, OPEN_NEW_BUFFER);
 439 }
 440
 441 function follow_new_buffer_background (I) {
 442     yield follow(I, OPEN_NEW_BUFFER_BACKGROUND);
 443 }
 444
 445 function follow_new_window (I) {
 446     yield follow(I, OPEN_NEW_WINDOW);
 447 }
 448
 449 function follow_current_frame (I) {
 450     yield follow(I, FOLLOW_CURRENT_FRAME);
 451 }
 452
 453 function follow_current_buffer (I) {
 454     yield follow(I, OPEN_CURRENT_BUFFER);
 455 }
 456
 457
 458 function element_get_load_target_label (element) {
 459     if (element instanceof Ci.nsIDOMWindow)
 460         return "page";
 461     if (element instanceof Ci.nsIDOMHTMLFrameElement)
 462         return "frame";
 463     if (element instanceof Ci.nsIDOMHTMLIFrameElement)
 464         return "iframe";
 465     return null;
 466 }
 467
 468 function element_get_operation_label (element, op_name, suffix) {
 469     var target_label = element_get_load_target_label(element);
 470     if (target_label != null)
 471         target_label = " " + target_label;
 472     else
 473         target_label = "";
 474
 475     if (suffix != null)
 476         suffix = " " + suffix;
 477     else
 478         suffix = "";
 479
 480     return op_name + target_label + suffix + ":";
 481 }
 482
 483
 484 function browser_element_copy (buffer, elem) {
 485     var spec;
 486     try {
 487        spec = load_spec(elem);
 488     } catch (e) {}
 489     var text = null;
 490     if (spec)
 491         text = load_spec_uri_string(spec);
 492     else  {
 493         if (!(elem instanceof Ci.nsIDOMNode))
 494             throw interactive_error("Element has no associated text to copy.");
 495         switch (elem.localName) {
 496         case "INPUT":
 497         case "TEXTAREA":
 498             text = elem.value;
 499             break;
 500         case "SELECT":
 501             if (elem.selectedIndex >= 0)
 502                 text = elem.item(elem.selectedIndex).text;
 503             break;
 504         default:
 505             text = elem.textContent;
 506             break;
 507         }
 508     }
 509     browser_set_element_focus(buffer, elem);
 510     writeToClipboard(text);
 511     buffer.window.minibuffer.message("Copied: " + text);
 512 }
 513
 514
 515 define_variable("view_source_use_external_editor", false,
 516     "When true, the `view-source' command will send its document to "+
 517     "your external editor.");
 518
 519 define_variable("view_source_function", null,
 520     "May be set to a user-defined function for viewing source code. "+
 521     "The function should accept an nsILocalFile of the filename as "+
 522     "its one positional argument, and it will also be called with "+
 523     "the keyword `$temporary', whose value will be true if the file "+
 524     "is considered temporary, and therefore the function must take "+
 525     "responsibility for deleting it.");
 526
 527 function browser_object_view_source (buffer, target, elem) {
 528     if (view_source_use_external_editor || view_source_function) {
 529         var spec = load_spec(elem);
 530
 531         let [file, temp] = yield download_as_temporary(spec,
 532                                                        $buffer = buffer,
 533                                                        $action = "View source");
 534         if (view_source_use_external_editor)
 535             yield open_file_with_external_editor(file, $temporary = temp);
 536         else
 537             yield view_source_function(file, $temporary = temp);
 538         return;
 539     }
 540
 541     var win = null;
 542     var window = buffer.window;
 543     if (elem.localName) {
 544         switch (elem.localName.toLowerCase()) {
 545         case "frame": case "iframe":
 546             win = elem.contentWindow;
 547             break;
 548         case "math":
 549             view_mathml_source(window, charset, elem);
 550             return;
 551         default:
 552             throw new Error("Invalid browser element");
 553         }
 554     } else
 555         win = elem;
 556     win.focus();
 557
 558     var url_s = win.location.href;
 559     if (url_s.substring (0,12) != "view-source:") {
 560         try {
 561             browser_object_follow(buffer, target, "view-source:" + url_s);
 562         } catch(e) { dump_error(e); }
 563     } else {
 564         window.minibuffer.message ("Already viewing source");
 565     }
 566 }
 567
 568 function view_source (I, target) {
 569     I.target = target;
 570     if (target == null)
 571         target = OPEN_CURRENT_BUFFER;
 572     var element = yield read_browser_object(I);
 573     yield browser_object_view_source(I.buffer, target, element);
 574 }
 575
 576 function view_source_new_buffer (I) {
 577     yield view_source(I, OPEN_NEW_BUFFER);
 578 }
 579
 580 function view_source_new_window (I) {
 581     yield view_source(I, OPEN_NEW_WINDOW);
 582 }
 583
 584
 585 function browser_element_shell_command (buffer, elem, command, cwd) {
 586     var spec = load_spec(elem);
 587     yield download_as_temporary(spec,
 588                                 $buffer = buffer,
 589                                 $shell_command = command,
 590                                 $shell_command_cwd = cwd);
 591 }
 592