☰

IMDb Weaver

Enhances the content of imdb pages by correlating information from related pages.

  1. // $Id: imdbweaver.user.js 781 2014-06-26 23:26:56Z Chris $
  2. // -----------------------------------------------------------------------------
  3. // This is a Greasemonkey user script.
  4. // To use it, first install Greasemonkey: http://www.greasespot.net/
  5. // Then restart Firefox and revisit this script
  6. // From the Firefox menu select: Tools -> Install User Script
  7. // Accept the default configuration and install
  8. // Now whenever you visit imdb.com you will see extra functionality
  9. // Documentation here: http://refactoror.net/greasemonkey/imdbWeaver/doc.html
  10. // -----------------------------------------------------------------------------
  11.  
  12. // ==UserScript==
  13. // @name         IMDb Weaver
  14. // @moniker      iwvr
  15. // @namespace    http://refactoror.net/
  16. // @description  Enhances the content of imdb pages by correlating information from related pages.
  17. // @version      0.3.8.2
  18. // @author       Chris Noe
  19. // @include      imdb.com/*
  20. // @include      *.imdb.com/*
  21. //---------
  22. // @exclude      *.imdb.com/images/*
  23. // @exclude      *doubleclick*
  24. // @exclude      *google_afc*
  25. // @grant        GM_getValue
  26. // @grant        GM_setValue
  27. // @grant        GM_registerMenuCommand
  28. // @grant        GM_log
  29. // @grant        GM_xmlhttpRequest
  30. // ==/UserScript==
  31.  
  32. var dm = new DomMonkey({
  33.    name : "IMDb Weaver"
  34.   ,moniker : "iwvr"
  35.   ,version : "0.3.8.2"
  36. });
  37.  
  38.  
  39. // The values listed here are the first-time-use defaults
  40. // They have NO EFFECT once this script is installed.
  41. prefs.config({
  42.     "ajaxOperationLimit":           10
  43.     ,"all-topnav-isExpanded":       true
  44.     ,"highlightTitleTypes":         true
  45.     ,"firstMatchAccessKey":         "A"
  46.     ,"name-headshotMagnifier":      true
  47.     ,"name-ShowAge":                true
  48.     ,"name-ShowAgeAtTitleRelease":  true
  49.     ,"prefsMenuAccessKey":          "P"
  50.     ,"prefsMenuPosition":           "BR"
  51.     ,"prefsMenuVisible":            true
  52.     ,"removeAds":                   true
  53.     ,"title-attributes":            true
  54.     ,"title-headshotMagnifier":     true
  55.     ,"title-headshotMagnification": 12
  56.     ,"title-ShowAges":              true
  57.     ,"title-StartResearch":         true
  58. });
  59.  
  60. var titleHighlighers = {
  61.      Khaki:    ["(V)"]  // direct to video, no theatrical release
  62.     ,Lavender: ["(TV)", "TV series", "TV mini-series", "TV episode"]
  63.     ,Pink:     ["(VG)"] // video game
  64. };
  65.  
  66.  
  67. // --------------- Page handlers ---------------
  68.  
  69. tryCatch(dm.metadata["moniker"], function () {
  70.     if (isStaticPageRequest()) {
  71.         // a request from a DocumentContainer object
  72.         log.debug("~~~~~ Static page request, no page processing: " + dm.xdoc.location.href);
  73.         // TBD: need to add "ajaxstatic" param to all URLs to prevent page graph recursion
  74.         dm.xdoc.foreachNode(
  75.             "//a[contains(@href, 'imdb.com')]",
  76.             function(a) {
  77.                 a.href = ajaxstaticUrl(a.href);
  78. log.debug("In " + dm.xdoc.location.href + " :: " + a.href);
  79.             }
  80.         );
  81.         return;
  82.     }
  83.     if (window != window.top) {
  84.         log.debug("subordinate window, no page processing: " + document.location.href);
  85.         return; // this is a subordinate window (iframe, etc)
  86.     }
  87.  
  88.          if (dm.xdoc.location.href.match(/\/title\/tt\d+\/?/))  enhanceTitlePage();
  89.     else if (dm.xdoc.location.href.match(/\/name\/nm\d+\/?/))   enhanceNamePage();
  90.     else if (dm.xdoc.location.href.match(/\/find\?/))           enhanceFindPage();
  91.     else if (dm.xdoc.location.href.match(/\/updates\/history/)) enhanceUpdatePage();
  92.     else {
  93.         log.info("IMDb generic page");
  94.         extendImdbDocument(dm.xdoc);
  95.         enhanceImdbPage(dm.xdoc);
  96.     }
  97. });
  98.  
  99. function isStaticPageRequest() {
  100.     return dm.xdoc.location.href.match("ajaxstatic");
  101. }
  102.  
  103.  
  104. var titleDoc;
  105. var nameDoc;
  106.  
  107. // --------- Annoying intervening Ad pages ---------
  108.  
  109. function expediteAdPage()
  110. {
  111.     var i = location.href.indexOf("dest=");
  112.     var redirUrl = "http:" + location.href.substring(i + 12);
  113.     log.info("Ad page, skipping immediately to: " + redirUrl);
  114. //     location.href = redirUrl;
  115. }
  116.  
  117. // --------------- Title Page handler ---------------
  118.  
  119. function enhanceTitlePage()
  120. {
  121.     log.info("IMDb Title page");
  122.     titleDoc = extendImdbTitleDocument(dm.xdoc);
  123.     enhanceImdbPage(dm.xdoc);
  124.  
  125.     dispatchFeature("removeAds", function()
  126.     {
  127.         titleDoc.removeAds();
  128.     });
  129.  
  130.     // Gallery Magnifier
  131. //     titleDoc.foreachNode("//div[@class='media_strip_thumbs']//img[contains(@src, '._V1._CR')]", function(img) {
  132. //         // substitute the larger image
  133. //         img.src = img.src.replace("_V1._CR75,0,300,300_SS90_.jpg", "_V1._SY400_SX600_.jpg");
  134. //         img.style.cssFloat = "none";
  135. //         var a = img.selectNode("ancestor::a[1]");
  136. //         var wrapper_div = a.wrapIn("div", {className: "iwvr_gallery_pic"} );
  137. //         wrapper_div.style.minWidth = img.clientWidth;
  138. //     });
  139. //     titleDoc.addStyle(
  140. //         "div.iwvr_gallery_pic:hover a img {\n"
  141. //         + "    height: auto;\n"
  142. //         + "    width:  auto;\n"
  143. //         + "    position: absolute;\n"
  144. //         + "    margin-top: +100px;\n"
  145. //         + "    margin-left: -25px;\n"
  146. //         + "}\n"
  147. //     );
  148.  
  149. //    createImageMagnifiers(titleDoc, "_V1._CR", /_CR[0-9,_]*/, "_SX600_SY400_");
  150.  
  151.     dispatchFeature("title-headshotMagnifier", function()
  152.     {
  153.         var mag = prefs.get("title-headshotMagnification") || 12;
  154.         var pixels = mag * 32;
  155.         var fileSfx = "_V1._SX" + pixels + "_SY" + pixels + "_";
  156.         createImageMagnifiers(titleDoc, "_V1._SX23_SY30_", /_SX\d+_SY\d+_/, fileSfx);
  157.     });
  158.  
  159.     dispatchFeature("title-attributes", function()
  160.     {
  161.         addTitleAttrs();
  162.     });
  163.  
  164.     // Display rating/runtime/language directly below title
  165.     function addTitleAttrs()
  166.     {
  167.         var titleAttrs = new Array();
  168.  
  169.         var cert = titleDoc.getCertification();
  170.         if (cert != null) {
  171.             titleAttrs.push(cert);
  172.         }
  173.         var runtime = titleDoc.getRuntime();
  174.         if (runtime != null) {
  175.             var rt = runtime + " min";
  176.             if (runtime > 60) {
  177.                 rt += " (" + formatHoursMinutes(runtime) + ")";
  178.             }
  179.             titleAttrs.push(rt);
  180.         }
  181.         var lang = titleDoc.getLanguage();
  182.         if (lang != null) {
  183.             titleAttrs.push(lang);
  184.         }
  185.  
  186.         var languages = [];
  187.         titleDoc.foreachNode("//a[contains(@href,'/language/')]", function(lang_a) {
  188.             languages.push(lang_a.textContent);
  189.         });
  190.         titleAttrs.push(languages.join("/"));
  191.  
  192.         var title_div = titleDoc.selectNodeNullable("//div[@id='tn15title']");
  193.         if (titleAttrs.length > 0) {
  194.             title_div.appendChildText(titleAttrs.join(", "));
  195.         }
  196.     }
  197.  
  198.     function formatHoursMinutes(min)
  199.     {
  200.         var m = "0" + min % 60;  // (extra leading zero)
  201.         var h = (min - m) / 60;
  202.         return h + ":" + m.substring(m.length - 2);
  203.     }
  204.  
  205.     addCastToolbar();
  206.  
  207.     function addCastToolbar()
  208.     {
  209.         var toolbar_span = titleDoc.createXElement("span", {id: "iwvr_casttoolbar"} );
  210.         var quotedTitle = '"' + titleDoc.getTitle()  + '"';
  211.  
  212.         dispatchFeature("title-ShowAges", function()
  213.         {
  214.             var showCastAges_button = titleDoc.createXElement("button", {id: "iwvr_showCastAges"} );
  215.             with (showCastAges_button) {
  216.                 className = "iwvr_button";
  217.                 textContent = "Show Ages";
  218.                 title = "Show cast ages when " + quotedTitle  + " was released in " + titleDoc.getTitleYear();
  219.                 addEventListener('click', showCastAges, false);
  220.             }
  221.             with (toolbar_span) {
  222.                 appendChildTextNbsp(3);
  223.                 appendChild(showCastAges_button);
  224.             }
  225.         });
  226.  
  227.         dispatchFeature("title-StartResearch", function()
  228.         {
  229.             var startResearch_button = titleDoc.createXElement("button", {id: "iwvr_startReasearch"} );
  230.             with (startResearch_button) {
  231.                 className = "iwvr_button";
  232.                 addEventListener('click', startResearch, false);
  233.                 textContent = "Start Research...";
  234.                 title = "Mine additional information about " + quotedTitle;
  235.             }
  236.             with (toolbar_span) {
  237.                 appendChildTextNbsp(3);
  238.                 appendChild(startResearch_button);
  239.             }
  240.         });
  241.  
  242.         var cast_table = titleDoc.getCast_table();
  243.         if (cast_table != null) {
  244.             cast_table.prependSibling(toolbar_span);
  245.         }
  246.     }
  247.  
  248.     function showCastAges(event)
  249.     {
  250.         // prevent second execution on same page
  251.         event.target.removeEventListener('click', showCastAges, false);
  252.  
  253.         // process each cast member name
  254.         var nodeCount = 0;
  255.         var ajaxOperationLimit = prefs.get("ajaxOperationLimit");
  256.         titleDoc.foreachCastMember_tr
  257.         (
  258.             "//td[@class='nm']"
  259.                 + titleDoc.CAST_NAMES_A
  260.                 + "[not(following-sibling::span[@id='iwvr_age'])]",
  261.             function(a_name)
  262.             {
  263.                 if (nodeCount < ajaxOperationLimit || ajaxOperationLimit == -1)
  264.                 {
  265.                     var titleDC = new DocumentContainer();
  266. log.debug("%%%%% loadFromSameOrigin: " + a_name.href);
  267.                     titleDC.loadFromSameOrigin(
  268.                         // extract info from the cast member page
  269.                         a_name.href,
  270.                         function(doc) {
  271.                             var nameDoc = extendImdbNameDocument(doc);
  272.                             var titleYear = titleDoc.getTitleYear();
  273.                             if (titleYear == null || titleYear == "") {
  274.                                 age = "?";
  275.                             }
  276.                             else {
  277.                                 var age = nameDoc.getAge(titleYear);
  278.                                 if (age == null)
  279.                                     age = "?";
  280.                             }
  281. //                             var dd_a = nameDoc.selectNodeNullable("//a[contains(@href, 'death_date=')]");
  282. //                             if (dd_a)
  283. //                                 dd = " " + dd_a.textContent;
  284.                             var age_span = titleDoc.createXElement("span", {id: "iwvr_age"} );
  285.                             age_span.appendChildText(" (" + age + ")");
  286.                             a_name.appendSibling(age_span);
  287.                         }
  288.                     );
  289.                 }
  290.                 nodeCount++;
  291.             }
  292.         )
  293.         event.target.textContent = "Show More Ages";
  294.         event.target.addEventListener('click', showCastAges, false);
  295.     }
  296.  
  297.     function startResearch()
  298.     {
  299.         if (titleDoc.selectNodeNullable("//div[@id='iwvr_researchItems_dialog']")) {
  300.             return;  // the dialog is already open
  301.         }
  302.  
  303.         // make all names on page draggable
  304.         titleDoc.foreachNode(
  305.             titleDoc.CAST_NAMES_A,
  306.             function(name_a) {
  307.                 name_a.className = "iwvr_researchable_item";
  308.                 name_a.addEventListener('draggesture', addResearchItem, false);
  309.             }
  310.         );
  311.  
  312.         function addResearchItem(event)
  313.         {
  314.             var original_item_a = event.target.parentNode;
  315.             var dragged_item_a = original_item_a.cloneNode(true);
  316.  
  317.             var tip = titleDoc.selectNodeNullable("//*[@id='draggingTip']");
  318.             if (tip != null)
  319.                 tip.remove();
  320.  
  321.             var ul = titleDoc.selectNode("//ul[@id='iwvr_research_itemlist']");
  322.             var li = titleDoc.createXElement("li");
  323.             li.appendChild(dragged_item_a);
  324.             ul.appendChild(li);
  325.  
  326.             original_item_a.className = null;
  327.             original_item_a.removeEventListener('draggesture', addResearchItem, false);
  328.         };
  329.  
  330.         // present the Research dialog
  331.         var researchDialog = new DialogBox(titleDoc, "Research");
  332.         var researchDialog_div = researchDialog.createDialog(
  333.                 "iwvr_researchItems",
  334.                 "z-index: 999; position: fixed; bottom: 5px; right: 10px;",
  335.                 { OK: okResearch, Cancel: cancelResearch }
  336.         );
  337.         researchDialog.main_td.style.padding = "6px";
  338.         with (researchDialog_div)
  339.         {
  340.             style.fontSize = "10pt";
  341.             style.fontFamily = "Arial, Helvetica, sans-serif";
  342.  
  343.             researchDialog_div.style.overflow = "auto";
  344.  
  345.             var sel = titleDoc.createSelect(
  346.                 "Research",
  347.                 { name: "researchmode" },
  348.                 { tic: "Titles in common" }, "tic");
  349.             appendChild(sel);
  350.  
  351.             var scroll_div = titleDoc.createXElement("div");
  352.             with (scroll_div) {
  353.                 with (style) {
  354.                     border = "1px inset Black"; margin = 4; padding = 5;
  355.                     width = 200; height = 60; overflow = "auto";
  356.                 }
  357.  
  358.                 var items_ul = titleDoc.createXElement("ul", {id: "iwvr_research_itemlist"} );
  359.                 with (items_ul.style) {
  360.                     marginTop  = "0px"; paddingTop  = "0px";
  361.                     marginLeft = "0px"; paddingLeft = "1em";
  362.                 }
  363.                 appendChild(items_ul);
  364.  
  365.                 var tip_div = titleDoc.createXElement("div");
  366.                 tip_div.id = "draggingTip";
  367.                 with (tip_div.style) { color = "Gray";
  368.                     width = "100%";  textAlign = "center";
  369.                     height = "85%"; verticalAlign = "middle";
  370.                 }
  371.                 tip_div.appendChildText("Drag Names Here");
  372.                 appendChild(tip_div);
  373.             }
  374.             appendChild(scroll_div);
  375.  
  376.             var includes_div = titleDoc.createTopicDiv("Include");
  377.             includes_div.style.borderColor = "DarkGreen";
  378. //             includes_div.style.backgroundColor = "#66CC33";
  379.             with (includes_div.contentElement)
  380.             {
  381.                 appendChild(titleDoc.createCheckbox(
  382.                     "Individual Episodes",
  383.                     {id: "include-episodes"},
  384.                     false
  385.                 ));
  386.             }
  387.             appendChild(includes_div);
  388.  
  389.             var excludes_div = titleDoc.createTopicDiv("Exclude Categories");
  390.             excludes_div.style.borderColor = "#AA0000";
  391. //             excludes_div.style.backgroundColor = "#FF3300";
  392.             with (excludes_div.contentElement)
  393.             {
  394.                 appendChild(titleDoc.createCheckbox(
  395.                     "Self",
  396.                     {id: "exclude-self", title: "Examples: Oprah, Letterman"},
  397.                     true
  398.                 ));
  399.                 appendChildElement("br");
  400.                 appendChild(titleDoc.createCheckbox(
  401.                     "Archive Footage",
  402.                     {id: "exclude-archive-footage"},
  403.                     true
  404.                 ));
  405.             }
  406.             appendChild(excludes_div);
  407.         }
  408.     }
  409.  
  410.     function okResearch(doc)
  411.     {
  412.         var titleDoc = extendImdbTitleDocument(doc);
  413.  
  414.         // get URLs of selected research items
  415.         var peopleUrls = new Array();
  416.         titleDoc.foreachNode("//ul[@id='iwvr_research_itemlist']//a", function(name_a) {
  417.             peopleUrls.push(name_a.href);
  418.         });
  419.  
  420.         var includeEpisodes = titleDoc.selectNode("//input[@id='include-episodes']").checked;
  421.  
  422.         var omitCategories = new Array();
  423.         if (titleDoc.selectNode("//input[@id='exclude-self']").checked)
  424.             omitCategories.push("self");
  425.         if (titleDoc.selectNode("//input[@id='exclude-archive-footage']").checked)
  426.             omitCategories.push("archive");
  427.  
  428.         endResearch(titleDoc);
  429.         if (peopleUrls.length > 0) {
  430.             correlatePeople(peopleUrls, includeEpisodes, omitCategories);
  431.         }
  432.     }
  433.  
  434.     function cancelResearch(doc)
  435.     {
  436.         var titleDoc = extendImdbTitleDocument(doc);
  437.         endResearch(titleDoc);
  438.     }
  439.  
  440.     function endResearch(titleDoc)
  441.     {
  442.         // remove class="iwvr_researchable_item"
  443.         titleDoc.foreachNode(
  444.             titleDoc.CAST_NAMES_A,
  445.             function(name_a) {
  446.                 name_a.className = null;
  447.             }
  448.         );
  449.     }
  450.  
  451.     var DEFAULT_JOB_ABBREVS = {
  452.         "A":  "Actor",
  453.         "A'": "Actress",
  454.         "D":  "Director",
  455.         "P":  "Producer",
  456.         "PD": "Production Designer",
  457.         "W":  "Writer",
  458.         "C":  "Composer",
  459.         "ST": "Soundtrack",
  460.         "AD": "Art Department",
  461.         "MC": "Miscellaneous Crew",
  462.         "S":  "Self",
  463.         "Ar": "Archive Footage"
  464.     };
  465.  
  466.     // gather credits for specified people and
  467.     // determine what titles they have in common
  468.     function correlatePeople(urlList, includeEpisodes, omitCatList)
  469.     {
  470. // foreach (var User in Users)
  471. // {
  472. //   <div class="action-time">[ActionSpan(User)]</div>
  473. //   if (User.IsAnonymous)
  474. //   {
  475. //     <div class="gravatar32">[RenderGravatar(User)]</div>
  476. //     <div class="details">[UserRepSpan(User)]<br/>[UserFlairSpan(User)]</div>
  477. //   }
  478. //   else
  479. //   {
  480. //     <div class="anon">anonymous</div>
  481. //   }
  482. // }
  483.         var jobAbbrevs = new AbbreviationMap(DEFAULT_JOB_ABBREVS);
  484.  
  485.         var jointCredits_a = new Array();
  486.         var nameSet_a = new Array();
  487.  
  488.         withDocuments(
  489.             urlList,  // gather credits from each person's page
  490.             function(doc) {
  491.                 var nameDoc = extendImdbNameDocument(doc);
  492.                 var name_a = nameDoc.getName_a();
  493.                 nameSet_a.push(name_a);
  494.                 jointCredits_a = jointCredits_a.concat(
  495.                     nameDoc.getCredits_a( {imdbName_a: name_a}, includeEpisodes, omitCatList)
  496.                 );
  497.             },
  498.             function(docList)
  499.             {
  500.                 // sort combined credits (by url)
  501.                 sortBy(jointCredits_a, ["href"] );
  502.                 sortBy(nameSet_a, ["textContent"] );
  503.  
  504.                 var creditsInCommon_a = new Array();
  505.                 var soloCreditCount = 0;
  506.                 foreachGrouping(jointCredits_a, "href", function(creds_a)
  507.                 {
  508.                     if (creds_a.length < 2) {
  509.                         soloCreditCount++;
  510.                         return;  // exclude where not in common with anybody else
  511.                     }
  512.  
  513.                     var nameJobMap = new Array();
  514.                     for (var c in creds_a) {
  515.                         var jobList = jobAbbrevs.registerList(creds_a[c].categoryList);
  516.                         nameJobMap[creds_a[c].propertySet.imdbName_a] = jobList;
  517.                     }
  518.  
  519.                     var combo_a = creds_a[0].cloneNode(true);
  520.                     combo_a.nameJobMap = nameJobMap;
  521.  
  522.                     creditsInCommon_a.push(combo_a);
  523.                 });
  524.  
  525.                 // sort combined credits (by title)
  526.                 sortBy(creditsInCommon_a, ["textContent"] );
  527.  
  528.                 // create information popup
  529.                 var resultsWindow = new DialogBox(titleDoc, "Research Results");
  530.                 var resultsWindow_div = resultsWindow.createDialog(
  531.                         "iwvr_creditsInCommon",
  532.                         "z-index: 999; position: fixed; left: 15px; top: 20px;",
  533.                         { X: noop }
  534.                 );
  535.                 resultsWindow.main_td.style.padding = "6px";
  536.                 with (resultsWindow_div)
  537.                 {
  538.                     style.maxWidth = window.innerWidth - 70;
  539.                     style.maxHeight = window.innerHeight - 90;
  540. //                     style.overflow = "auto";
  541.  
  542.                     // construct the data table
  543.                     var i = 1;
  544.                     var table = titleDoc.createXElement("table", {className: "iwvr_results"} );
  545.                     var caption = titleDoc.createXElement("caption");
  546.                     caption.appendChildText("Credits in common", ["b"]);
  547.                     table.appendChild(caption);
  548.                     var cellAttrList = [
  549.                         {className: "iwvr_results bulletcol"},
  550.                         {className: "iwvr_results titlecol"}
  551.                     ].concat(
  552.                         dup(nameSet_a.length, {className: "iwvr_results datacol"} )
  553.                     );
  554.                     var thead = titleDoc.createXElement("thead");
  555.                     thead.appendTableRow([null, "Title"].concat(nameSet_a), cellAttrList);
  556.                     table.appendChild(thead);
  557.                     var tbody = titleDoc.createXElement("tbody");
  558.                     for (var c in creditsInCommon_a)
  559.                     {
  560.                         var rowSet = initArrayIndices(2 + nameSet_a.length);
  561.                         rowSet[0] = i + ")";
  562.                         var credit_span = titleDoc.createXElement("span");
  563.                         if (creditsInCommon_a[c].seriesTitle != null) {
  564.                             credit_span.appendChildText(creditsInCommon_a[c].seriesTitle);
  565.                         }
  566.                         credit_span.appendChild(creditsInCommon_a[c]);
  567.                         rowSet[1] = credit_span;
  568.                         for (var name_a in creditsInCommon_a[c].nameJobMap) {
  569.                             var jobList = creditsInCommon_a[c].nameJobMap[name_a];
  570.                             var col = 2 + parseInt(arrayIndexOf(nameSet_a, name_a));
  571.                             rowSet[col] = jobList.sort().join(", ");
  572.                         }
  573.                         tbody.appendTableRow(rowSet, cellAttrList);
  574.                         i++;
  575.                     }
  576.                     var legend_div = jobAbbrevs.toLegend("div",
  577.                         { className: "iwvr_results_legend" } );
  578.                     tbody.appendTableRow(
  579.                         [ legend_div ],
  580.                         [ { colSpan: (2 + nameSet_a.length) } ]
  581.                     );
  582.                     table.appendChild(tbody);
  583.  
  584.                     appendChild(table);
  585.                 }
  586.             }
  587.         );
  588.     }
  589. }
  590.  
  591.  
  592. function dup(count, value) {
  593.     var returnValue = new Array();
  594.     for (var i = 0; i < count; i++) {
  595.         returnValue.push(value);
  596.     }
  597.     return returnValue;
  598. }
  599.  
  600. // --------------- Name Page handler ---------------
  601.  
  602. function enhanceNamePage()
  603. {
  604.     log.info("IMDb Name page");
  605.     var nameDoc = extendImdbNameDocument(dm.xdoc);
  606.     enhanceImdbPage(dm.xdoc);
  607.  
  608.     dispatchFeature("removeAds", function()
  609.     {
  610.         nameDoc.removeAds();
  611.     });
  612.  
  613.     dispatchFeature("name-headshotMagnifier", function()
  614.     {
  615.         createImageMagnifiers(nameDoc, "_V1._SX32_", /_SX\d+_/, "_SX640_SY720_");
  616.     });
  617.  
  618.     var birthInfo_div = nameDoc.selectNodeNullable(
  619.         "//a[contains(@href, 'birth_year=')]/ancestor::div[1]");
  620.     var age = nameDoc.getAge();
  621.  
  622.     var deathInfo_div = nameDoc.selectNodeNullable(
  623.         "//a[contains(@href, 'death_date=')]/ancestor::div[1]");
  624.     var ageDeath = nameDoc.getAgeDeath();
  625.  
  626.     dispatchFeature("highlightTitleTypes", function()
  627.     {
  628.         // first defeat the site's regular even/odd row highlighting
  629.         nameDoc.foreachNode("//tbody[contains(@class, 'row-filmo-')]", function(tbody)
  630.         {
  631.             tbody.style.backgroundColor = "White";
  632.         });
  633.         // now add custom highlighting
  634.         highlightTitleTypes(titleHighlighers);
  635.         function highlightTitleTypes(hSpecs)
  636.         {
  637.             for (var color in hSpecs) {
  638.                 var matchStrs = hSpecs[color];
  639.                 for (var i in matchStrs) {
  640.                     nameDoc.foreachNode([
  641.                         "//text()[contains(., '" + matchStrs[i] + "')]//ancestor-or-self::tbody[1]",
  642.                         "//text()[contains(., '" + matchStrs[i] + "')]//ancestor-or-self::li[1]"
  643.                     ],
  644.                     function(item)
  645.                     {
  646.                         item.style.backgroundColor = color;
  647.                     });
  648.                 }
  649.             }
  650.         }
  651.     });
  652.  
  653.     dispatchFeature("name-ShowAge", function()
  654.     {
  655.         if (birthInfo_div == null || age == null) {
  656.             log.info("name-ShowAge: no birth year");
  657.         }
  658.         else {
  659.             birthInfo_div.appendChildElement("br");
  660.             birthInfo_div.appendChildText(
  661.                 ((nameDoc.getDeathDetails_div() != null) ? "would be " : "is ")
  662.                 + age + " years old"
  663.             );
  664.         }
  665.  
  666.         if (deathInfo_div == null || ageDeath == null) {
  667.             log.info("name-ShowAge: no death year");
  668.         }
  669.         else {
  670.             deathInfo_div.appendChildElement("br");
  671.             deathInfo_div.appendChildText(
  672.                 "at age " + ageDeath
  673.             );
  674.         }
  675.     });
  676.  
  677.     dispatchFeature("name-ShowAgeAtTitleRelease", function()
  678.     {
  679.         // if we are arriving at a person's page from a specific title page
  680.         if (dm.xdoc.referrer.match("imdb.com/title"))
  681.         {
  682.             // trim all but base title URL, (could be arriving from other detail pages)
  683.             dm.xdoc.referrer.match(/(.*tt\d*)/);
  684.             var referrerUrl = RegExp.$1;
  685.  
  686.             var nameDC = new DocumentContainer();
  687.             nameDC.loadFromSameOrigin(
  688.                 // use info from the referring title page
  689.                 referrerUrl,
  690.                 function(doc)
  691.                 {
  692.                     var titleDoc = extendImdbTitleDocument(doc);
  693.                     var titleYear = titleDoc.getTitleYear();
  694.                     var ageThen;
  695.                     if (titleYear == null || titleYear == "") {
  696.                         ageThen = "?";
  697.                     }
  698.                     else {
  699.                         ageThen = nameDoc.getAge(titleYear);
  700.                         if (ageThen == null)
  701.                             ageThen = "?";
  702.                     }
  703.  
  704.                     if (birthInfo_div == null || age == null) {
  705.                         log.info("name-ShowAgeAtTitleRelease: no birth year");
  706.                         return;
  707.                     }
  708.  
  709.                     birthInfo_div.appendChildElement("br");
  710.                     var t;
  711.                     if (titleYear > (new Date()).getFullYear())
  712.                         t = '(will be ' + ageThen
  713.                             + ' when "' + titleDoc.getTitle()
  714.                             + '" releases in ' + titleYear + ')'
  715.                         ;
  716.                     else
  717.                         t = '(was ' + ageThen
  718.                             + ' when "' + titleDoc.getTitle()
  719.                             + '" was released in ' + titleYear + ')'
  720.                         ;
  721.                     birthInfo_div.appendChildText(t);
  722.                 }
  723.             );
  724.         }
  725.         else {
  726.             if (dm.xdoc.referrer == "") {
  727.                 log.warn("The name-ShowAgeAtTitleRelease option is enable"
  728.                     + " , but document.referrer is empty. REFERRER MAY BE DISABLED."
  729.                 );
  730.             }
  731.         }
  732.     });
  733. }
  734.  
  735. // --------------- Find Page handler ---------------
  736.  
  737. function enhanceFindPage()
  738. {
  739.     log.info("IMDb Find page");
  740.     var findDoc = extendImdbNameDocument(dm.xdoc);
  741.     enhanceImdbPage(dm.xdoc);
  742.  
  743.     // assign access key to first matching item
  744.     var accessKey = prefs.get("firstMatchAccessKey");
  745.     if (accessKey != null)
  746.     {
  747.         // first text link to "/rg/find-", that is inside a TD
  748.         var firstMatch_a = findDoc.selectNodeNullable(
  749.                     "//td/a[not(img)][contains(@onclick, '/rg/find-')][1]");
  750.         if (firstMatch_a != null) {
  751.             firstMatch_a.accessKey = accessKey.toUpperCase();
  752.             var itemNum_td = firstMatch_a.selectNodeNullable("preceding::td[1]");
  753.             if (itemNum_td != null) {
  754.                 var span = findDoc.createXElement("span");
  755.                 span.appendChildText("[" + accessKey + "]");
  756.                 firstMatch_a.href.match(/\/(\w+)\//);
  757.                 var linkType = RegExp.$1; // "title" or "name"
  758.                 span.title = "Alt-Shift-" + accessKey + " to go to this " + linkType;
  759.                 span.style.fontWeight = "bold";
  760.                 itemNum_td.innerHTML = "";
  761.                 itemNum_td.appendChild(span);
  762.             }
  763.         }
  764.     }
  765.  
  766.     dispatchFeature("highlightTitleTypes", function()
  767.     {
  768.         highlightTitleTypes(titleHighlighers);
  769.         function highlightTitleTypes(hSpecs)
  770.         {
  771.             for (var color in hSpecs) {
  772.                 var matchStrs = hSpecs[color];
  773.                 for (var i in matchStrs) {
  774.                     findDoc.foreachNode("//a[contains(@onclick, '/rg/find-title')]/ancestor::table[1]//text()[contains(., '" + matchStrs[i] + "')]"
  775.                         + "//ancestor-or-self::td[1]", function(item)
  776.                     {
  777.                         item.style.backgroundColor = color;
  778.                     });
  779.                 }
  780.             }
  781.         }
  782.     });
  783.  
  784. //     // Poster Magnifier
  785. //     findDoc.foreachNode("//a[contains(@href, 'title-tiny')]/img", function(img) {
  786. //         // substitute the larger image
  787. //         img.src = img.src.replace(/(\d)t\.(jpg|png|gif)$/, "$1m.$2");
  788. //         img.className = "iwvr_headshot";
  789. //         img.height = null;
  790. //         img.width = null;
  791. //     });
  792. //     titleDoc.addStyle(
  793. //         "img.iwvr_headshot { height: 32px; width: 22px; }\n"
  794. //         + "td:hover img.iwvr_headshot {\n"
  795. //         + "    height: auto;\n"
  796. //         + "    width:  auto;\n"
  797. //         + "    position: absolute;\n"
  798. //         + "    margin-top:   -59px;\n"
  799. //         + "    margin-left: -125px;\n"
  800. //         + "}\n"
  801. //     );
  802. }
  803.  
  804. // --------------- Find Page handler ---------------
  805.  
  806. function enhanceUpdatePage()
  807. {
  808.     log.info("IMDb updates page");
  809.  
  810.     // assign access key to first matching item
  811.     var accessKey = prefs.get("firstMatchAccessKey");
  812.     if (accessKey)
  813.     {
  814.         var updateDoc = extendDocument(dm.xdoc);
  815.         // first update item
  816.         var firstMatch_a = updateDoc.selectNodeNullable("(//a[contains(@href, 'update?load=')])[1]");
  817.         if (firstMatch_a) {
  818.             firstMatch_a.accessKey = accessKey.toUpperCase();
  819.             var item_td = firstMatch_a.selectNodeNullable("ancestor::td[1]");
  820.             if (item_td) {
  821.                 var span = updateDoc.createXElement("span");
  822.                 span.appendChildText("[" + accessKey + "]");
  823.                 span.style.fontWeight = "bold";
  824.                 item_td.prependChild(span);
  825.             }
  826.         }
  827.     }
  828. }
  829.  
  830. // --------------- Find Page handler ---------------
  831.  
  832. function enhanceImdbPage(imdbDoc)
  833. {
  834. log.info("enhanceImdbPage");
  835.     imdbDoc.removeAds();
  836.  
  837.     var navbar_div = imdbDoc.selectNodeNullable("//div[@id='nb20']");
  838.     if (navbar_div != null) {
  839.         navbar_div.makeCollapsible("all-topnav-isExpanded", true);
  840.     }
  841. }
  842.  
  843.  
  844. // --------------- Title Page extensions ---------------
  845.  
  846. function extendImdbTitleDocument(titleDoc)
  847. {
  848.     if (titleDoc == null)
  849.         return null;
  850.  
  851.     extendImdbDocument(titleDoc);
  852.  
  853.     titleDoc.removeAds_super = titleDoc.removeAds;
  854.     titleDoc.removeAds = function()
  855.     {
  856.         this.removeAds_super();
  857.  
  858.         titleDoc.foreachNode([
  859.              "//div[@id='tn15shopbox']"
  860.             ,"//div[@id='tn15adrhs']"
  861.             ,"//div[starts-with(@id, 'banner')]"
  862.             ,"//div[@id='tn15tc']"
  863. //            ,"//a[contains(href, NAVSTRIP)]"
  864.             ], function(node) {
  865.                 node.remove();
  866.                 log.debug("Removing ad element: <" + node.tagName + " id=" + node.id);
  867.             }
  868.         );
  869.     }
  870.  
  871.     titleDoc.getTitle = function()
  872.     {
  873.         var title;
  874.         var poster_a = this.selectNodeNullable("//a[@name='poster']");
  875.         if (poster_a != null) {
  876.             title = poster_a.title;
  877.         }
  878.         else {
  879.             var title_span = this.selectNode("//title/text()");
  880.             title = title_span.textContent.replace(/\(\d\d\d\d\)/, "");
  881.         }
  882.         return title.stripQuoteMarks().normalizeWhitespace();
  883.     };
  884.  
  885.     titleDoc.getTitle_a = function()
  886.     {
  887.         var a = this.createXElement("a");
  888.         a.href = this.location.href;
  889.         a.appendChildText(this.getTitle());
  890.         return a;
  891.     }
  892.  
  893.     titleDoc.getTitleYear = function() {
  894.         var year;
  895.  
  896.         var airDate = this.selectTextContent(
  897.             "//*[text()='Original Air Date:']/following-sibling::*[1]/text()");
  898.         if (airDate != null) {
  899.             airDate.match(/\d+ \w+ (\d\d\d\d)/);
  900.             year = RegExp.$1;
  901.             return year;
  902.         }
  903.  
  904.         var year = this.selectTextContent(
  905.             "//div[@id='tn15title']//a[contains(@href, '/year/')]/text()");
  906.  
  907.         return year;
  908.     };
  909.  
  910.     titleDoc.getUserRating = function() {
  911.         var userRating = this.selectTextContent(
  912.             "//*[contains(text(), 'User Rating:')]/following-sibling::*[1]");
  913.         if (userRating == null)
  914.             return null;
  915.         userRating = userRating.split("/");
  916.         return userRating[0] / userRating[1];
  917.     };
  918.  
  919.     titleDoc.getRuntime = function() {
  920.         var runtime_text = this.selectNodeNullable(
  921.             "//*[text()='Runtime:']/following-sibling::*[1]/text()");
  922.         if (runtime_text == null) {
  923.             return null;
  924.         }
  925.         var runtime = runtime_text.textContent.match(/(\d+)/);
  926.         return RegExp.$1;
  927.     };
  928.  
  929.     titleDoc.getCertification = function(country) {
  930.         if (country == null) {
  931.             country = "USA";
  932.         }
  933.         var cert = this.selectTextContent(
  934.             "//a[starts-with(@href, concat('/List?certificates=', '" + country + ":'))]");
  935.         return cert;
  936.     };
  937.  
  938.     titleDoc.getLanguage = function() {
  939.         var lang_a = this.selectNodeNullable(
  940.             "//a[starts-with(@href, '/Sections/Languages/')]");
  941.         if (lang_a == null) {
  942.             return null;
  943.         }
  944.         return lang_a.textContent;
  945.     };
  946.  
  947.     titleDoc.CAST_TABLE =
  948.         "//table[@class='cast']"
  949.     ;
  950.     titleDoc.CAST_NAMES_A = "//a[starts-with(@href, '/name/')]";
  951.     titleDoc.CHARACTER_NAME_A = "//a[@href='quotes']";
  952.  
  953.     titleDoc.foreachCastMember_tr = function(relativeXpath, func)
  954.     {
  955.         this.foreachNode(
  956.             titleDoc.CAST_TABLE
  957.             + "//tr"
  958.             + relativeXpath,
  959.             func
  960.         );
  961.     }
  962.  
  963.     titleDoc.getCast_table = function() {
  964.         return this.selectNodeNullable(titleDoc.CAST_TABLE);
  965.     };
  966.  
  967.     log.debug(
  968.         "extendImdbTitleDocument: "
  969.         + "title='" + titleDoc.getTitle() + "'"
  970.         + ", titleYear=" + titleDoc.getTitleYear()
  971.         + ", userRating=" + titleDoc.getUserRating()
  972.     );
  973.  
  974.     return titleDoc;
  975. }
  976.  
  977.  
  978. // --------------- Title Page extensions ---------------
  979.  
  980. function extendImdbNameDocument(nameDoc)
  981. {
  982.     if (nameDoc == null)
  983.         return null;
  984.  
  985.     extendImdbDocument(nameDoc);
  986.  
  987.     nameDoc.removeAds_super = nameDoc.removeAds;
  988.     nameDoc.removeAds = function()
  989.     {
  990.         this.removeAds_super();
  991.  
  992.         var ad_div = nameDoc.selectNodeNullable("//div[@id='tn15adrhs']");
  993.         if (ad_div != null) {
  994.             ad_div.remove();
  995.         }
  996.     }
  997.  
  998.     nameDoc.getName = function() {
  999.         return this.selectTextContent("//title");
  1000.     };
  1001.  
  1002.     nameDoc.getName_a = function()
  1003.     {
  1004.         var a = this.createXElement("a");
  1005.         a.href = this.location.href;
  1006.         a.appendChildText(this.getName());
  1007.         return a;
  1008.     }
  1009.  
  1010.     nameDoc.getAge = function(refYear) {
  1011.         if (refYear == null) {
  1012.             refYear = (new Date()).getFullYear();
  1013.         }
  1014.         var birthYear = this.getBirthYear();
  1015.         if (birthYear == null) {
  1016.             return null;
  1017.         }
  1018.         var age = refYear - birthYear;
  1019.         if (isNaN(age)) {
  1020.             return "??";
  1021.         }
  1022.         else {
  1023.             return age;
  1024.         }
  1025.     };
  1026.  
  1027.     nameDoc.getBirthYear = function() {
  1028.         var birthYear_a = this.selectNodeNullable(
  1029.             "//a[contains(@href, 'birth_year=')]"
  1030.         );
  1031.         if (birthYear_a == null)
  1032.             return null;
  1033.         else
  1034.             return birthYear_a.textContent;
  1035.     };
  1036.  
  1037.     nameDoc.getBirthDetails_end = function() {
  1038.         var birthDetails_end = this.selectNodeNullable(
  1039.             "//a[contains(@href, 'birth_year=')]"
  1040.             + "/following::br[1]"
  1041.         );
  1042.         return birthDetails_end;
  1043.     }
  1044.  
  1045.     nameDoc.getAgeDeath = function() {
  1046.         var deathYear = this.getDeathYear();
  1047.         if (deathYear == null) {
  1048.             return null;
  1049.         }
  1050.         var ageDeath = deathYear - this.getBirthYear();
  1051.         if (isNaN(ageDeath)) {
  1052.             return "??";
  1053.         }
  1054.         else {
  1055.             return ageDeath;
  1056.         }
  1057.     };
  1058.  
  1059.     nameDoc.getDeathYear = function() {
  1060.         var deathYear_a = this.selectNodeNullable(
  1061.             "//a[contains(@href, 'death_date=')]"
  1062.         );
  1063.         if (deathYear_a == null)
  1064.             return null;
  1065.         else
  1066.             return deathYear_a.textContent;
  1067.     };
  1068.  
  1069.     nameDoc.getDeathDetails_div = function() {
  1070.         return this.selectNodeNullable(
  1071.             "//*[contains(@href, 'death_date=')]"
  1072.             + "//ancestor::div[1]"
  1073.         );
  1074.     }
  1075.  
  1076.     nameDoc.CREDIT_CATEGORIES_A =
  1077.         "//a[starts-with(@href, '/title/')]"
  1078.         + "/ancestor::div[@class='filmo']/descendant::a[@name][1]";
  1079.  
  1080.     // Get all the credits on this page, grouped by title.
  1081.     // The list of job categories is attached to each "merged" title reference.
  1082.     nameDoc.getCredits_a = function(propSet, includeEpisodes, omitCatList)
  1083.     {
  1084.         var creditList_a = new Array();
  1085.         nameDoc.foreachNode(  // Director, Writer, Actor, etc
  1086.             nameDoc.CREDIT_CATEGORIES_A,
  1087.             function (category_a)
  1088.             {
  1089.                 var catLabel = category_a.textContent.replace(/:/, "");
  1090.                 if (arrayIndexOf(omitCatList, category_a.name))
  1091.                     return;
  1092.  
  1093.                 var matchCredits = "//a[@name='" + category_a.name + "']"
  1094.                     + "/following::ol[1]/li/a[1]";
  1095.  
  1096.                 nameDoc.foreachNode(  // each credit within a category
  1097.                     matchCredits,
  1098.                     function (credit_a) {
  1099.                         credit_a.category = catLabel;
  1100.                         if (propSet != null) {
  1101.                             credit_a.propertySet = propSet;
  1102.                         }
  1103.                         creditList_a.push(credit_a);
  1104.  
  1105.                         if (includeEpisodes) {
  1106.                             credit_a.foreachNode(  // each sub-credit within a credit
  1107.                                 "following-sibling::a",
  1108.                                 function (subCredit_a) {
  1109.                                     subCredit_a.category = catLabel;
  1110.                                     if (propSet != null) {
  1111.                                         subCredit_a.propertySet = propSet;
  1112.                                     }
  1113.                                     subCredit_a.seriesTitle = credit_a.textContent;
  1114.                                     creditList_a.push(subCredit_a);
  1115.                                 }
  1116.                             );
  1117.                         }
  1118.                 });
  1119.         });
  1120.  
  1121.         return mergeCreditCategories(creditList_a);
  1122.  
  1123.         // for each title combine multiple credits into a single object
  1124.         // with an array property that lists the category names
  1125.         function mergeCreditCategories(creditList_a)
  1126.         {
  1127.             sortBy(creditList_a, ["href"] );
  1128.  
  1129.             var mergedCredits = new Array();
  1130.             foreachGrouping(creditList_a, "href", function(creds_a)
  1131.             {
  1132.                 var catList = new Array();
  1133.                 for (var i in creds_a) {
  1134.                     catList.push(creds_a[i].category);
  1135.                 }
  1136.  
  1137.                 // reuse first element as a protoype
  1138.                 var combined_a = creds_a[0].cloneNode(true);
  1139.                 combined_a.textContent = combined_a.textContent.stripQuoteMarks();
  1140.                 combined_a.category = null;
  1141.                 combined_a.categoryList = catList;
  1142.                 combined_a.propertySet = creds_a[0].propertySet;
  1143.  
  1144.                 mergedCredits.push(combined_a);
  1145.             });
  1146.             return mergedCredits;
  1147.         }
  1148.     }
  1149.  
  1150.     log.debug(
  1151.         "extendImdbNameDocument: "
  1152.         + "name='" + nameDoc.getName() + "'"
  1153.         + ", birthYear='" + nameDoc.getBirthYear() + "'"
  1154.         + ", age=" + nameDoc.getAge()
  1155.     );
  1156.  
  1157.     return nameDoc;
  1158. }
  1159.  
  1160.  
  1161. // --------------- IMDb Page extensions ---------------
  1162.  
  1163. function extendImdbDocument(imdbDoc)
  1164. {
  1165.     extendDocument(imdbDoc);
  1166.  
  1167.     addPrefsButton();
  1168.  
  1169.     imdbDoc.removeAds = function()
  1170.     {
  1171.         log.debug("imdbDoc.removeAds");
  1172.         this.foreachNode("//div[starts-with(@id, 'swf_')]", function(node) {
  1173.                 node.remove();
  1174.                 log.debug("Removing ad element: <" + node.tagName + " id=" + node.id);
  1175.             }
  1176.         );
  1177. //         log.debug("sweeping for DOUBLECLICK:");
  1178. //         this.foreachNode("//img[contains(@src, 'doubleclick.net')]/ancestor::d[1]", function(node) {
  1179. //                 node.remove();
  1180. //                 log.debug("Removing DOUBLECLICK ad div");
  1181. //             }
  1182. //         );
  1183.         this.removeFlashAds();
  1184.  
  1185.         // experimental
  1186. //         this.foreachNode("//area[@alt='Learn more']", function(div) {
  1187. //                 div.remove();
  1188. //                 log.debug("REMOVING NAVSTRIPE AD");
  1189. //             }
  1190. //         );
  1191. //         this.foreachNode("//a[contains(@href, '_NAVSTRIPE')]//ancestor::div[1]", function(div) {
  1192. //                 div.remove();
  1193. //                 log.debug("REMOVING NAVSTRIPE AD");
  1194. //             }
  1195. //         );
  1196.         this.foreachNode(
  1197.             "//div[starts-with(@id, 'swf_')]",
  1198.             function(ad_div) {
  1199.                 log.debug("REMOVING FLOATER AD");
  1200.                 ad_div.hideNode();
  1201.             }
  1202.         );
  1203. //         this.removeFloaterAds();
  1204. //         imdbDoc.onAppears("//div[starts-with(@id, 'swf_')]", 500, function(ad_div)
  1205. //         {
  1206. //             log.debug("Removing floater ad");
  1207. // alert("Removing floater ad");
  1208. //             ad_div.hide();
  1209. //         });
  1210.     }
  1211.  
  1212.     imdbDoc.removeFlashAds = function()
  1213.     {
  1214.         this.foreachNode(
  1215.             "//comment()[contains(., 'FLASH AD BEGINS')]",
  1216.             function(adbegin_cmt) {
  1217. //                 log.info("COMMENT< '" + adbegin_cmt.textContent + "'");
  1218. //                 var adend_cmt = adbegin_cmt.selectNodeNullable(
  1219. //                     "//following-sibling::comment()[contains(., 'FLASH AD ENDS')][1]");
  1220. //                 if (adend_cmt != null) {
  1221. //                     log.info("COMMENT> '" + adend_cmt.textContent + "'");
  1222. //                 }
  1223.                 var ad_div = adbegin_cmt.nextSibling.nextSibling;
  1224.                 if (ad_div != null) {
  1225.                     log.debug("Removing ad element: <" + ad_div.tagName + " id=" + ad_div.id);
  1226.                     ad_div.parentNode.removeChild(ad_div);
  1227.                 }
  1228.             }
  1229.         );
  1230.     }
  1231.  
  1232.     // buttons
  1233.     imdbDoc.addStyle(
  1234.         ".iwvr_button {\n"
  1235.         + "    font-size: 8pt;\n"
  1236.         + "    font-family: Helvetica Narrow, sans-serif;\n"
  1237.         + "}\n"
  1238.     );
  1239.  
  1240.     // research items
  1241.     imdbDoc.addStyle(
  1242.           "a.iwvr_researchable_item { background-color: Gold; }\n"
  1243.         + "a.iwvr_researchable_item:hover { cursor: crosshair; }\n"
  1244.     );
  1245.  
  1246.     // research result grid styles
  1247.     imdbDoc.addStyle(
  1248.           ".iwvr_results {\n"
  1249.         + "    padding: 3;\n"
  1250.         + "    font-family: Arial Narrow, Helvetica Narrow, sans-serif;\n"
  1251.         + "    font-size: small;\n"
  1252.         + "}\n"
  1253.  
  1254.         + "table.iwvr_results {\n"
  1255.         + "    border-collapse: collapse;\n"
  1256.         + "    font-family: Arial, Helvetica, sans-serif;\n"
  1257.         + "}\n"
  1258.  
  1259.         + "td.iwvr_results {\n"
  1260.         + "    border: 1px solid Gray;\n"
  1261.         + "    padding: 3;\n"
  1262.         + "}\n"
  1263.  
  1264.         + "div.iwvr_results_legend {\n"
  1265.         + "    max-width: 100%;\n"
  1266.         + "    text-align: center;\n"
  1267.         + "}\n"
  1268.  
  1269.         + "td.bulletcol { text-align: right; }\n"
  1270.         + "td.titlecol { text-align: left; }\n"
  1271.         + "td.datacol { text-align: center; }\n"
  1272.     );
  1273.  
  1274.     return imdbDoc;
  1275. }
  1276.  
  1277. // --------------- helper functions ---------------
  1278.  
  1279. function createImageMagnifiers(theDoc, imgUrlContains, imgUrlRegex, imgUrlReplacement)
  1280. {
  1281.     // Headshot Magnifier
  1282.     theDoc.foreachNode("//img[contains(@src, '" + imgUrlContains + "')]", function(img) {
  1283.         if (img.src.indexOf("addtiny.gif") != -1) {
  1284.            return;  // skip place-holders
  1285.         }
  1286.         // substitute the larger image
  1287.         img.src = img.src.replace(imgUrlRegex, imgUrlReplacement);
  1288.         img.className = "iwvr_headshot";
  1289.         img.height = null;
  1290.         img.width = null;
  1291.     });
  1292.     theDoc.addStyle(
  1293.         "img.iwvr_headshot { height: 30px; width: 23px; }\n"
  1294.         + "td:hover img.iwvr_headshot {\n"
  1295.         + "    height: auto;\n"
  1296.         + "    width:  auto;\n"
  1297.         + "    z-index: 999;\n"
  1298.         + "    position: fixed;\n"
  1299.         + "    top: 5%;\n"
  1300.         + "    right: 5%;\n"
  1301.         + "}\n"
  1302.     );
  1303.         // zoom visualization graphic
  1304. //         var zoom_img = dm.xdoc.createXElement("img");
  1305. //         with (zoom_img.style) {
  1306. //            position = "absolute";
  1307. //            top = "614px";
  1308. //            left = "145px";
  1309. //         }
  1310. //         var zoom_img_src = 'data:image/gif;base64,' +
  1311. //             'R0lGODlhGACCAPcAAAAAAIAAAACAAICAAAAAgIAAgACAgICAgMDAwP8AAAD/AP//AAAA//8A/wD/////' +
  1312. //             '/wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA' +
  1313. //             'AAAAAAAAAAAAAAAAAAAAAAAAMwAAZgAAmQAAzAAA/wAzAAAzMwAzZgAzmQAzzAAz/wBmAABmMwBmZgBm' +
  1314. //             'mQBmzABm/wCZAACZMwCZZgCZmQCZzACZ/wDMAADMMwDMZgDMmQDMzADM/wD/AAD/MwD/ZgD/mQD/zAD/' +
  1315. //             '/zMAADMAMzMAZjMAmTMAzDMA/zMzADMzMzMzZjMzmTMzzDMz/zNmADNmMzNmZjNmmTNmzDNm/zOZADOZ' +
  1316. //             'MzOZZjOZmTOZzDOZ/zPMADPMMzPMZjPMmTPMzDPM/zP/ADP/MzP/ZjP/mTP/zDP//2YAAGYAM2YAZmYA' +
  1317. //             'mWYAzGYA/2YzAGYzM2YzZmYzmWYzzGYz/2ZmAGZmM2ZmZmZmmWZmzGZm/2aZAGaZM2aZZmaZmWaZzGaZ' +
  1318. //             '/2bMAGbMM2bMZmbMmWbMzGbM/2b/AGb/M2b/Zmb/mWb/zGb//5kAAJkAM5kAZpkAmZkAzJkA/5kzAJkz' +
  1319. //             'M5kzZpkzmZkzzJkz/5lmAJlmM5lmZplmmZlmzJlm/5mZAJmZM5mZZpmZmZmZzJmZ/5nMAJnMM5nMZpnM' +
  1320. //             'mZnMzJnM/5n/AJn/M5n/Zpn/mZn/zJn//8wAAMwAM8wAZswAmcwAzMwA/8wzAMwzM8wzZswzmcwzzMwz' +
  1321. //             '/8xmAMxmM8xmZsxmmcxmzMxm/8yZAMyZM8yZZsyZmcyZzMyZ/8zMAMzMM8zMZszMmczMzMzM/8z/AMz/' +
  1322. //             'M8z/Zsz/mcz/zMz///8AAP8AM/8AZv8Amf8AzP8A//8zAP8zM/8zZv8zmf8zzP8z//9mAP9mM/9mZv9m' +
  1323. //             'mf9mzP9m//+ZAP+ZM/+ZZv+Zmf+ZzP+Z///MAP/MM//MZv/Mmf/MzP/M////AP//M///Zv//mf//zP//' +
  1324. //             '/ywAAAAAGACCAAAI/wAfCBxIsKBBgggOKlSIIOHChwIbQoTY0OHEgxUvMsyosWBFix0jcgwpcmTIjyA7' +
  1325. //             'okx5cSXJBy5JrmRJMabKmSdx3tTZcibNjTwn+pTY06fGoURrDi26VGnTh0iTLowqFSNVp0ihUv1Z8ipQ' +
  1326. //             'r1a3Tt1adSDZsl3FGjyLli1NtyzhrpWLkK5ZuCDx5sVbl29atnf1/gUMU69Dw4cNDz67mGxjtYgfe41c' +
  1327. //             'WHBlv5QzK75MV7Nlz5g3g+4suvRn06FPq07N2m1gu5YlP+XM+HVt24773sYNlnfWubt9zxYeVHdv47/D' +
  1328. //             'HkdudOxy5sU9PoeOEmt04MOVX8e+XXpzodm/2i60bpI8WvHlzeesvv6jzPFMz2t1/z59/JeX8efHT/+l' +
  1329. //             '/aPygaefSAPCVOCBDwQEADs=';
  1330. //         zoom_img.src = zoom_img_src;
  1331. //         titleDoc.body.appendChild(zoom_img);
  1332. //         zoom_img.hide();
  1333. }
  1334.  
  1335.  
  1336. // ==================== AbbreviationMap object ====================
  1337.  
  1338. function AbbreviationMap(initMap)
  1339. {
  1340.     this.map = initMap;
  1341.  
  1342.     if (this.map == null) {
  1343.         this.map = new Array();
  1344.     }
  1345.  
  1346.     this.register = function(value)
  1347.     {
  1348.         var abbrev = arrayIndexOf(this.map, value);
  1349.         if (abbrev != null)
  1350.             return abbrev;
  1351.  
  1352.         for (var len = 1; len < value.length; len++)
  1353.         {
  1354.             var abbrev = value.substring(0, len);
  1355.             if (this.map[abbrev] == null) {
  1356.                 this.map[abbrev] = value;
  1357.                 return abbrev;
  1358.             }
  1359.         }
  1360.         throw "Can't abbreviate: '" + value + "'";
  1361.     }
  1362.  
  1363.     this.registerList = function(theList)
  1364.     {
  1365.         var abbrevList = new Array();
  1366.         for (var i in theList) {
  1367.             abbrevList.push(this.register(theList[i]));
  1368.         }
  1369.         return abbrevList;
  1370.     }
  1371.  
  1372.     this.toLegend = function(elemType, attrMap)
  1373.     {
  1374. //         var dm.xdoc = extendDocument(document);
  1375.         var node = dm.xdoc.createXElement(elemType, attrMap);
  1376.         with (node) {
  1377.             for (var i in this.map) {
  1378.                 appendChildText(i);
  1379.                 appendChildText(':\u00A0"');
  1380.                 appendChildText(this.map[i]);
  1381.                 appendChildText('"');
  1382.                 appendChildText(' - ');
  1383.             }
  1384.         }
  1385.         return node;
  1386.     }
  1387. }
  1388.  
  1389.  
  1390. // ==================== Preferences Dialog ====================
  1391.  
  1392. function addPrefsButton()
  1393. {
  1394.     configurePrefsButton(function(prefsMgr, prefsDialog_div)
  1395.     {
  1396.         var table = dm.xdoc.createXElement("table");
  1397.         prefsDialog_div.appendChild(table);
  1398.  
  1399.         var tr = dm.xdoc.createXElement("tr");
  1400.         table.appendChild(tr);
  1401.  
  1402.         var td = dm.xdoc.createXElement("td");
  1403.         td.style.verticalAlign = "top";
  1404.         tr.appendChild(td);
  1405.         with (td)
  1406.         {
  1407.             var features_div = dm.xdoc.createTopicDiv("Enabled Features", td);
  1408.             appendChild(features_div);
  1409.             with (features_div.contentElement)
  1410.             {
  1411.                 var genFeatures_div = dm.xdoc.createTopicDiv("All Pages", features_div);
  1412.                 appendChild(genFeatures_div);
  1413.                 with (genFeatures_div.contentElement)
  1414.                 {
  1415.                     appendChild(prefsMgr.createPreferenceInput(
  1416.                         "highlightTitleTypes",
  1417.                         "Highlight titles by type",
  1418.                         "white: theatrical release / gold: direct to video / blue: TV / pink: video game"
  1419.                     ));
  1420.                     appendChildElement("br");
  1421.                     appendChild(prefsMgr.createPreferenceInput(
  1422.                         "removeAds",
  1423.                         "Remove advertising",
  1424.                         "Remove advertising"
  1425.                     ));
  1426.                 }
  1427.  
  1428.                 var titleFeatures_div = dm.xdoc.createTopicDiv("On Title Pages", features_div);
  1429.                 appendChild(titleFeatures_div);
  1430.                 with (titleFeatures_div.contentElement)
  1431.                 {
  1432.                     appendChild(prefsMgr.createPreferenceInput(
  1433.                         "title-attributes",
  1434.                         "Display title attributes",
  1435.                         "Display rating/runtime/language directly below title"
  1436.                     ));
  1437.                     appendChildElement("br");
  1438.                     appendChild(prefsMgr.createPreferenceInput(
  1439.                         "title-ShowAges",
  1440.                         "[Show Ages] button",
  1441.                         "Compute the ages of cast members"
  1442.                     ));
  1443.                     appendChildElement("br");
  1444.                     appendChild(prefsMgr.createPreferenceInput(
  1445.                         "title-StartResearch",
  1446.                         "[Start Research] button",
  1447.                         "Open the Research dialog"
  1448.                     ));
  1449.                     appendChildElement("br");
  1450.                     appendChild(prefsMgr.createPreferenceInput(
  1451.                         "title-headshotMagnifier",
  1452.                         "Headshot Magnifier",
  1453.                         "Hover mouse to magnify cast pictures"
  1454.                     ));
  1455.                     appendChildElement("br");
  1456.                     appendChild(prefsMgr.createPreferenceInput(
  1457.                         "title-headshotMagnification",
  1458.                         "Mag level",
  1459.                         "Magnification factor",
  1460.                         { size:2, maxLength: 2 }
  1461.                     )).style.marginLeft = "28px";
  1462.                 }
  1463.  
  1464.                 var nameFeatures_div = dm.xdoc.createTopicDiv("On Name Pages", features_div);
  1465.                 appendChild(nameFeatures_div);
  1466.                 with (nameFeatures_div.contentElement)
  1467.                 {
  1468.                     appendChild(prefsMgr.createPreferenceInput(
  1469.                         "name-ShowAge",
  1470.                         "Display age",
  1471.                         "Display current age of the person"
  1472.                     ));
  1473.                     appendChildElement("br");
  1474.                     appendChild(prefsMgr.createPreferenceInput(
  1475.                         "name-ShowAgeAtTitleRelease",
  1476.                         "Display age at release",
  1477.                         "Display age at time title was released"
  1478.                     ));
  1479.                 }
  1480.  
  1481.                 var findFeatures_div = dm.xdoc.createTopicDiv("On Search Results", features_div);
  1482.                 appendChild(findFeatures_div);
  1483.                 with (findFeatures_div.contentElement)
  1484.                 {
  1485.                     appendChild(prefsMgr.createPreferenceInput(
  1486.                         "firstMatchAccessKey",
  1487.                         "Select first match",
  1488.                         "Alt-Shift keyboard to navigate to first title matched",
  1489.                         { size:1, maxLength: 1 }
  1490.                     ));
  1491.                 }
  1492.             }
  1493.         }
  1494.  
  1495.         var td = dm.xdoc.createXElement("td");
  1496.         td.style.verticalAlign = "top";
  1497.         tr.appendChild(td);
  1498.         with (td) {
  1499.             appendChild(prefsMgr.constructDockPrefsMenuSection(td));
  1500.             appendChild(prefsMgr.constructAdvancedControlsSection(td));
  1501.  
  1502.             var controls_div = dm.xdoc.createTopicDiv("Performance Controls", td);
  1503.             with (controls_div.contentElement)
  1504.             {
  1505.                 appendChild(prefsMgr.createPreferenceInput(
  1506.                     "ajaxOperationLimit",
  1507.                     "Background threads",
  1508.                     "Control how many simultaneous background operations are allowed"
  1509.                         + ", (primarily affects Show Ages)",
  1510.                     { size:1, maxLength: 2 }
  1511.                 ));
  1512.             }
  1513.             appendChild(controls_div);
  1514.         }
  1515.  
  1516.         // Help link
  1517.         var docs_div = dm.xdoc.createXElement("div");
  1518.         prefsDialog_div.appendChild(docs_div);
  1519.         with (docs_div) {
  1520.             appendChild(dm.xdoc.createHtmlLink(
  1521.                 "http://refactoror.com/greasemonkey/imdbWeaver/doc.html#prefs",
  1522.                 "Help"
  1523.             ));
  1524.             align = "center";
  1525.             style.padding = "3px";
  1526.         }
  1527.     });
  1528. }
  1529.  
  1530.  
  1531. // =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  1532. // =-=-=-=-=-=-=-=-=-=-= refactoror lib -=-=-=-=-=-=-=-=-=-=-=
  1533. // =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  1534.  
  1535. // common logic for the way I like to setup Preferences in my apps
  1536. // Requires preferences: prefsMenuAccessKey, prefsMenuPosition, prefsMenuVisible, loggerLevel
  1537. function configurePrefsButton(dialogConstructor)
  1538. {
  1539.     // Preferences dialog
  1540.     GM_registerMenuCommand(dm.metadata["name"] + " Preferences...", openPrefsDialog);
  1541.     createPrefsButton();
  1542.  
  1543.     // Prefs dialog
  1544.     function createPrefsButton()
  1545.     {
  1546.         var menuButton = dm.xdoc.createXElement("button", { textContent: "Prefs" });
  1547.         setScreenPosition(menuButton, prefs.get("prefsMenuPosition"));
  1548.         if (prefs.get("prefsMenuVisible") == false) {
  1549.             menuButton.style.opacity = 0; // active but not visibile
  1550.             menuButton.style.zIndex = -1; // don't block other content
  1551.         }
  1552.  
  1553.         with (menuButton) {
  1554.             id = dm.metadata["moniker"] + "_prefs_menu_button";
  1555.             title = dm.metadata["name"] + " Preferences";
  1556.             style.fontSize = "9pt";
  1557.             addEventListener('click', openPrefsDialog, false);
  1558. //            accessKey = getDeconflicted("prefsMenuAccessKey", "accessKey");
  1559.             accessKey = prefs.get("prefsMenuAccessKey");
  1560.         }
  1561.         if (dm.xdoc.body != null) {
  1562.             dm.xdoc.body.appendChild(menuButton);
  1563.         }
  1564.     }
  1565.  
  1566.     function getDeconflicted(prefsName, attrName)
  1567.     {
  1568.         var prefValue = prefs.get(prefsName);
  1569.         var node = xdoc.selectNodeNullable("//*[@" + attrName + "='" + prefValue + "']");
  1570.         if (node != null) {
  1571.             log.warn("Conflict: <" + node.nodeName + "> element on this page is already using "
  1572.                   + attrName + "=" + prefValue);
  1573.             prefValue = null;
  1574.         }
  1575.         return prefValue;
  1576.     }
  1577.  
  1578.     // Prefs dialog
  1579.     function openPrefsDialog(event)
  1580.     {
  1581.         var prefsMgr = new PreferencesManager(
  1582.             dm.xdoc,
  1583.             dm.metadata["moniker"] + "_prefs",
  1584.             dm.metadata["name"] + " Preferences",
  1585.             { OK: function okPrefs(doc) { prefsMgr.storePrefs(); },
  1586.               Cancel: noop
  1587.             }
  1588.         );
  1589.         var prefsDialog_div = prefsMgr.open();
  1590.         if (prefsDialog_div == null)
  1591.             return;  // the dialog is already open
  1592.  
  1593.         prefsMgr.constructDockPrefsMenuSection = function(contextNode)
  1594.         {
  1595.             var prefsDock_div = dm.xdoc.createTopicDiv("Dock [Prefs] Menu", contextNode);
  1596.             contextNode.style.verticalAlign = "top";
  1597.             with (prefsDock_div.contentElement)
  1598.             {
  1599.                 appendChild(prefsMgr.createPreferenceInput(
  1600.                     "prefsMenuVisible",
  1601.                     "Visible",
  1602.                     "Prefs menu button visible on the screen"
  1603.                 ));
  1604.                 with (appendChild(prefsMgr.createScreenCornerPreference("prefsMenuPosition"))) {
  1605.                     title = "Screen corner for [Prefs] menu button";
  1606.                     style.margin = "1px 0px 3px 20px";
  1607.                 }
  1608.                 appendChild(prefsMgr.createPreferenceInput(
  1609.                     "prefsMenuAccessKey",
  1610.                     "Access Key",
  1611.                     "Alt-Shift keyboard shortcut",
  1612.                     { size:1, maxLength: 1 }
  1613.                 ));
  1614.             }
  1615.             return prefsDock_div;
  1616.         }
  1617.  
  1618.         prefsMgr.constructAdvancedControlsSection = function(contextNode)
  1619.         {
  1620.             var controls_div = dm.xdoc.createTopicDiv("Advanced Controls", contextNode);
  1621.             with (controls_div.contentElement)
  1622.             {
  1623.                 appendChild(prefsMgr.createPreferenceInput(
  1624.                     "loggerLevel",
  1625.                     "Logging Level",
  1626.                     "Control level of information that appears in the Error Console",
  1627.                     null,
  1628.                     log.getLogLevelMap()
  1629.                 ));
  1630.             }
  1631.             return controls_div;
  1632.         }
  1633.  
  1634.         dialogConstructor(prefsMgr, prefsDialog_div);
  1635.     }
  1636.  
  1637.     dispatchFeature("sendAnonymousStatistics", function() {
  1638.         if (getElapsed("sendAnonymousStatistics") < 2000) {
  1639. log.debug("--------- SKIPPING COUNTER on rapid fire: " + dm.xdoc.location.href);
  1640.             return;
  1641.         }
  1642. log.debug("--------- EMBEDDING COUNTER: " + dm.xdoc.location.href);
  1643. //     	var counter_img = document.createElement("img");
  1644. //     	counter_img.id = "refactoror.net_counter";
  1645. //     	counter_img.src = "http://refactoror.net/spacer.gif?"
  1646. //     		+ dm.metadata["moniker"] + "ver=" + dm.metadata["version"]
  1647. //     		+ "&od=" + GM_getValue("odometer")
  1648. //     	;
  1649. // log.debug(counter_img.src + " :: location=" + document.location.href);
  1650. //     	dm.xdoc.body.appendChild(counter_img);
  1651.     });
  1652.  
  1653.     function getElapsed(name) {
  1654.         var prev_ms = parseInt(GM_getValue(name + "_ms", "0"));
  1655.         var now_ms = Number(new Date());
  1656.         GM_setValue(name + "_ms", now_ms.toString());
  1657.  
  1658.         return (now_ms - prev_ms);
  1659.     }
  1660. }
  1661.  
  1662.  
  1663. // =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  1664. // =-=-=-=-=-=-=-=-=-=-=-= DOM Monkey -=-=-=-=-=-=-=-=-=-=-=-=
  1665. // =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  1666.  
  1667. /* Parses the script headers into the metadata object.
  1668.  * Adds constants & utility methods to various javascript objects.
  1669.  * Initializes the Preferences object.
  1670.  * Initializes the logger object.
  1671.  */
  1672. function DomMonkey(metadata)
  1673. {
  1674.     extendJavascriptObjects();
  1675.  
  1676.     // DM objects provided on the context
  1677.  
  1678.     this.xdoc = extendDocument(document);
  1679.     this.metadata = metadata;
  1680.  
  1681.     // The values listed here are the first-time-use defaults
  1682.     // They have no effect once they are stored as mozilla preferences.
  1683.     prefs = new Preferences({
  1684.         "loggerLevel":               "WARN"
  1685.         ,"sendAnonymousStatistics":  true
  1686.     });
  1687.  
  1688.     log = new Logger(this.metadata["version"]);
  1689.  
  1690.     GM_setValue("odometer", GM_getValue("odometer", 0) + 1);
  1691. }
  1692.  
  1693.  
  1694. // ==================== DOM object extensions ====================
  1695.  
  1696. /** Extend the given document with methods
  1697. * for querying and modifying the document object.
  1698. */
  1699. function extendDocument(doc)
  1700. {
  1701.     if (doc == null)
  1702.         return null;
  1703.  
  1704.     /** Determine if the current document is empty.
  1705.     */
  1706.     doc.isEmpty = function() {
  1707.         return (this.body == null || this.body.childNodes.length == 0);
  1708.     };
  1709.  
  1710.     /** Report number of nodes that matach the given xpath expression.
  1711.     */
  1712.     doc.countNodes = function(xpath) {
  1713.         var n = 0;
  1714.         this.foreachNode(xpath, function(node) {
  1715.             n++;
  1716.         });
  1717.         return n;
  1718.     };
  1719.  
  1720.     /** Remove nodes that match the given xpath expression.
  1721.     */
  1722.     doc.removeNodes = function(xpath) {
  1723.         this.foreachNode(xpath, function(node) {
  1724.             node.remove();
  1725.         });
  1726.     };
  1727.  
  1728.     /** Hide nodes that match the given xpath expression.
  1729.     */
  1730.     doc.hideNodes = function(xpath)
  1731.     {
  1732.         if (xpath instanceof Array) {
  1733.             for (var xp in xpath) {
  1734.                 this.foreachNode(xp, function(node) {
  1735.                     node.hide();
  1736.                 });
  1737.             }
  1738.         }
  1739.         else {
  1740.             this.foreachNode(xpath, function(node) {
  1741.                 node.hide();
  1742.             });
  1743.         }
  1744.     };
  1745.  
  1746.     /** Make visible the nodes that match the given xpath expression.
  1747.     */
  1748.     doc.showNodes = function(xpath) {
  1749.         this.foreachNode(xpath, function(node) {
  1750.             node.show();
  1751.         });
  1752.     };
  1753.  
  1754.     /** Retrieve the value of the node that matches the given xpath expression.
  1755.     */
  1756.     doc.selectValue = function(xpath, contextNode)
  1757.     {
  1758.         if (contextNode == null)
  1759.             contextNode = this;
  1760.  
  1761.         var result = this.evaluate(xpath, contextNode, null, XPathResult.ANY_TYPE, null);
  1762.         var resultVal;
  1763.         switch (result.resultType) {
  1764.             case result.STRING_TYPE:  resultVal = result.stringValue;  break;
  1765.             case result.NUMBER_TYPE:  resultVal = result.numberValue;  break;
  1766.             case result.BOOLEAN_TYPE: resultVal = result.booleanValue; break;
  1767.             default:
  1768.                 log.error("Unhandled value type: " + result.resultType);
  1769.         }
  1770.         return resultVal;
  1771.     }
  1772.  
  1773.     /** Select the first node that matches the given xpath expression.
  1774.     * If none found, log warning and return null.
  1775.     */
  1776.     doc.selectNode = function(xpath, contextNode)
  1777.     {
  1778.         var node = this.selectNodeNullable(xpath, contextNode);
  1779.         if (node == null) {
  1780.             // is it possible that the structure of this web page has changed?
  1781.             log.warn("XPath returned no elements: " + xpath
  1782.                 + "\n" + genStackTrace(arguments.callee)
  1783.             );
  1784.         }
  1785.         return node;
  1786.     }
  1787.  
  1788.     /** Select the first node that matches the given xpath expression.
  1789.     * If none found, return null.
  1790.     */
  1791.     doc.selectNodeNullable = function(xpath, contextNode)
  1792.     {
  1793.         if (contextNode == null)
  1794.             contextNode = this;
  1795.  
  1796.         var resultNode = this.evaluate(
  1797.             xpath, contextNode, null,
  1798.             XPathResult.FIRST_ORDERED_NODE_TYPE, null);
  1799.  
  1800.         if (resultNode.singleNodeValue == null)
  1801.             log.debug("null result for: " + xpath);
  1802.         return extendNode(resultNode.singleNodeValue);
  1803.     }
  1804.  
  1805.     /** Select all first nodes that match the given xpath expression.
  1806.     * If none found, return an empty Array.
  1807.     */
  1808.     doc.selectNodes = function(xpath, contextNode)
  1809.     {
  1810.         var nodeList = new Array();
  1811.         this.foreachNode(xpath, function(n) { nodeList.push(n); }, contextNode);
  1812.         return nodeList;
  1813.     }
  1814.  
  1815.     /** Select all nodes that match the given xpath expression.
  1816.     * If none found, return null.
  1817.     */
  1818.     doc.selectNodeSet = function(xpath, contextNode)
  1819.     {
  1820.         if (contextNode == null)
  1821.             contextNode = this;
  1822.  
  1823.         var nodeSet = this.evaluate(
  1824.             xpath, contextNode, null,
  1825.             XPathResult.UNORDERED_NODE_SNAPSHOT_TYPE, null);
  1826.  
  1827.         return nodeSet;
  1828.     }
  1829.  
  1830.     /** Iteratively execute the given func for each node that matches the given xpath expression.
  1831.     */
  1832.     doc.foreachNode = function(xpath, func, contextNode)
  1833.     {
  1834.         if (contextNode == null)
  1835.             contextNode = this;
  1836.  
  1837.         // if array of xpath strings, call recursively
  1838.         if (xpath instanceof Array) {
  1839.             for (var i=0; i < xpath.length; i++)
  1840.                 this.foreachNode(xpath[i], func, contextNode);
  1841.             return;
  1842.         }
  1843.  
  1844.         var nodeSet = contextNode.selectNodeSet(xpath, contextNode);
  1845.  
  1846.         var i = 0;
  1847.         var n = nodeSet.snapshotItem(i);
  1848.         while (n != null) {
  1849.             var result = func(extendNode(n));
  1850.             if (result == false) {
  1851.                 // dispatching func can abort the loop by returning false
  1852.                 return;
  1853.             }
  1854.             n = nodeSet.snapshotItem(++i);
  1855.         }
  1856.     }
  1857.  
  1858.     /** Retrieve the text content of the node that matches the given xpath expression.
  1859.     */
  1860.     doc.selectTextContent = function(xpath) {
  1861.         var node = this.selectNodeNullable(xpath, this);
  1862.         if (node == null)
  1863.             return null;
  1864.         return node.textContent.normalizeWhitespace();
  1865.     };
  1866.  
  1867.     /** Retrieve the text content of the node that matches the given xpath expression,
  1868.     * and apply the given regular expression to it, returning the portion that matches.
  1869.     */
  1870.     doc.selectMatchTextContent = function(xpath, regex) {
  1871.         var text = this.selectTextContent(xpath);
  1872.         if (text == null)
  1873.             return null;
  1874.         return text.match(regex);
  1875.     };
  1876.  
  1877.     /** Replace contents of contextNode (default: body), with specified node.
  1878.     * (The specified node is removed, then re-added to the emptied contextNode.)
  1879.     * The specified node is expected to be a descendent of the context node.
  1880.     * Otherwise the result is probably an error.
  1881.     * DOC-DEFAULT
  1882.     */
  1883.     doc.isolateNode = function(xpath, contextNode)
  1884.     {
  1885.         if (contextNode == null)
  1886.             contextNode = this.body;
  1887.  
  1888.         extendNode(contextNode);
  1889.  
  1890.         var subjectNode = this.selectNode(xpath);
  1891.         if (subjectNode == null || subjectNode.parentNode == null)
  1892.             return;
  1893.  
  1894.         // gut the parent node (leave script elements alone)
  1895.         contextNode.foreachNode("child::*", function(node) {
  1896.             if (node.tagName != "SCRIPT" && node.tagName != "NOSCRIPT") {
  1897.                 node.remove();
  1898.             }
  1899.         });
  1900.  
  1901.         // re-add the subject node
  1902.         var replacement_div = this.createElement("div");
  1903.         replacement_div.id = "isolateNode:" + xpath;
  1904.         replacement_div.appendChild(subjectNode);
  1905.  
  1906.         contextNode.appendChild(replacement_div);
  1907.         return replacement_div;
  1908.     };
  1909.  
  1910.     /** Add a <script> reference to this document.
  1911.     * DOC-CENTRIC
  1912.     */
  1913.     doc.addScriptReference = function(url)
  1914.     {
  1915.         var script = this.createElement("script");
  1916.         script.src = url;
  1917.         this.selectNode("//head").appendChild(script);
  1918.  
  1919.         return script;
  1920.     }
  1921.  
  1922.     /** Add a CSS style definition to this document.
  1923.     * DOC-CENTRIC
  1924.     */
  1925.     doc.addStyle = function(cssBody, id)
  1926.     {
  1927.         var style = this.createXElement("style");
  1928.         style.innerHTML = cssBody;
  1929.         this.selectNode("//head").appendChild(style);
  1930.  
  1931.         return style;
  1932.     }
  1933.  
  1934.     /** Create an "extended" HTML element of the specified type,
  1935.     * with the given attributes applied to it.
  1936.     * The returned object is extended by extendNode().
  1937.     * DOC-NONSPECIFIC
  1938.     */
  1939.     doc.createXElement = function(tagName, attrMap)
  1940.     {
  1941.         var node = extendNode(this.createElement(tagName));
  1942.         node.applyAttributes(attrMap);
  1943.         return node;
  1944.     }
  1945.  
  1946.     /** Create
  1947.     */
  1948.     doc.createHtmlLink = function(url, text, attrMap)
  1949.     {
  1950.         var a = this.createXElement("a");
  1951.         a.href = url;
  1952.         if (text == null) {
  1953.             text = url;
  1954.         }
  1955.         a.textContent = text;
  1956.         a.applyAttributes(attrMap);
  1957.         return a;
  1958.     }
  1959.  
  1960.     /** Create an HTML input field, wrapped in an HTML label,
  1961.     * with the given attributes applied to it,
  1962.     * The returned HTML objects are extended by extendNode().
  1963.     * DOC-NONSPECIFIC
  1964.     */
  1965.     doc.createInputText = function(labelText, attrMap, defaultVal)
  1966.     {
  1967.         var span = this.createXElement("label");
  1968.         with (span) {
  1969.             if (labelText != null)
  1970.                 appendChildText(labelText + ": ");
  1971.             var input = this.createXElement("input", attrMap);
  1972.             with (input) {
  1973.                 type = "text";
  1974.                 value = defaultVal;
  1975.             }
  1976.             appendChild(input);
  1977.         }
  1978.         return span;
  1979.     }
  1980.  
  1981.     doc.createTextArea = function(labelText, attrMap, defaultVal)
  1982.     {
  1983.         var span = this.createXElement("label");
  1984.         with (span) {
  1985.             if (labelText != null)
  1986.                 appendChildText(labelText + ": ");
  1987.             var input = this.createXElement("textarea", attrMap);
  1988.             with (input) {
  1989.                 value = defaultVal;
  1990.             }
  1991.             appendChild(input);
  1992.         }
  1993.         return span;
  1994.     }
  1995.  
  1996.     /** Create an HTML checkbox, wrapped in an HTML label,
  1997.     * with the given attributes applied to it,
  1998.     * The returned HTML objects are extended by extendNode().
  1999.     * DOC-NONSPECIFIC
  2000.     */
  2001.     doc.createCheckbox = function(labelText, attrMap, isChecked)
  2002.     {
  2003.         var span = this.createXElement("label");
  2004.         with (span) {
  2005.             var input = this.createXElement("input", attrMap);
  2006.             with (input) {
  2007.                 type = "checkbox";
  2008.                 checked = isChecked;
  2009.             }
  2010.             appendChild(input);
  2011.             appendChildText(labelText);
  2012.         }
  2013.         return span;
  2014.     }
  2015.  
  2016.     /** Create a set of HTML radio buttons, wrapped in an HTML label element.
  2017.     * The returned HTML objects are extended by extendNode().
  2018.     * DOC-NONSPECIFIC
  2019.     */
  2020.     doc.createRadioset = function(attrMap, optionMap, defaultKey)
  2021.     {
  2022.         var spanList = new Array();
  2023.  
  2024.         for (var key in optionMap)
  2025.         {
  2026.             var label = this.createXElement("label");
  2027.             with (label) {
  2028.                 var input = this.createXElement("input", attrMap);
  2029.                 with (input) {
  2030.                     type = "radio";
  2031.                     value = key;
  2032.                     if (key == defaultKey)
  2033.                         checked = true;
  2034.                 }
  2035.                 appendChild(input);
  2036.                 appendChildText(optionMap[key]);
  2037.             }
  2038.             spanList.push(label);
  2039.         }
  2040.         return spanList;
  2041.     }
  2042.  
  2043.     /** Create an HTML select element, wrapped in an HTML label element.
  2044.     * The returned HTML objects are extended by extendNode().
  2045.     * DOC-NONSPECIFIC
  2046.     */
  2047.     doc.createSelect = function(labelText, attrMap, optionMap, defaultKey)
  2048.     {
  2049.         var span = this.createXElement("label");
  2050.         with (span) {
  2051.             if (labelText != null)
  2052.                 appendChildText(labelText + ": ");
  2053.             var select = this.createXElement("select", attrMap);
  2054.             with (select)
  2055.             {
  2056.                 for (var key in optionMap)
  2057.                 {
  2058.                     var option = this.createXElement("option");
  2059.                     with (option) {
  2060.                         value = key;
  2061.                         if (key == defaultKey) {
  2062.                             selected = true;
  2063.                         }
  2064.                         appendChildText(optionMap[key]);
  2065.                     }
  2066.                     appendChild(option);
  2067.                 }
  2068.             }
  2069.             appendChild(select);
  2070.         }
  2071.         return span;
  2072.     }
  2073.  
  2074.     /** Create a labeled/boxed area (eg, typical dialog box component).
  2075.     */
  2076.     doc.createTopicDiv = function(topicTitle, contextNode)
  2077.     {
  2078.         var shiftEms = ".7";
  2079.         var basecolor = getBaseColor(contextNode);
  2080.  
  2081.         var frame_div = this.createXElement("div");
  2082.         with (frame_div) {
  2083.             with (style) {
  2084.                 border = "1px solid Gray";
  2085.                 marginTop = (shiftEms * 1.5) + "em";
  2086.                 marginLeft = "6px";
  2087.                 marginRight = "6px";
  2088.                 MozBorderRadius = "3px";
  2089.             }
  2090.  
  2091.             // superimposed title
  2092.             var title_span = this.createXElement("span");
  2093.             with (title_span.style) {
  2094.                 position = "relative";
  2095.                 top = -shiftEms + "em";
  2096.                 fontSize = "10pt";
  2097.                 color = "Black";
  2098.                 backgroundColor = basecolor;
  2099.                 marginLeft = "6px";  // shift title right
  2100.                 padding = "0px 4px 0px 4px"; // blot out frame on left & right
  2101.             }
  2102.             title_span.appendChildText(topicTitle);
  2103.             appendChild(title_span);
  2104.             // maintatin default mouse cursor over the topic label text
  2105.             title_span.wrapIn("label");
  2106.  
  2107.             // content area
  2108.             var content_div = this.createXElement("div");
  2109.             content_div.style.marginTop = -shiftEms + "em";
  2110.             content_div.style.padding = "6px";
  2111.             appendChild(content_div);
  2112.         }
  2113.         frame_div.contentElement = content_div;
  2114.  
  2115.         return frame_div;
  2116.  
  2117.         function getBaseColor(contextNode)
  2118.         {
  2119.             while (contextNode != null && contextNode.tagName != "BODY") {
  2120.                 var c = contextNode.style.backgroundColor;
  2121.                 if (c != "") {
  2122.                     return c;
  2123.                 }
  2124.                 contextNode = contextNode.parentNode;
  2125.             }
  2126.             return "White";
  2127.         }
  2128.     }
  2129.  
  2130.     return doc;
  2131. }
  2132.  
  2133. /** Extend the given node with methods
  2134. * for querying and modifying the node object.
  2135. */
  2136. function extendNode(node)
  2137. {
  2138.     if (node == null)
  2139.         return null;
  2140.  
  2141.     /** Create an HTML element of the specified type,
  2142.     * with the given attributes applied to it.
  2143.     * The returned object is extended by extendNode().
  2144.     */
  2145.     node.createXElement = function(tagName, attrMap)
  2146.     {
  2147.         var node = extendNode(this.ownerDocument.createElement(tagName));
  2148.         this.applyAttributes(attrMap);
  2149.         return node;
  2150.     }
  2151.  
  2152.     // Selection methods that operate within the scope of this node
  2153.  
  2154.     node.selectValue        = function(xpath) { return document.selectValue(xpath, this); }
  2155.     node.selectNode         = function(xpath) { return document.selectNode(xpath, this); }
  2156.     node.selectNodeNullable = function(xpath) { return document.selectNodeNullable(xpath, this); }
  2157.     node.selectNodeSet      = function(xpath) { return document.selectNodeSet(xpath, this); }
  2158.  
  2159.     node.foreachNode = function(xpath, func) { document.foreachNode(xpath, func, this); }
  2160.     node.isolateNode = function(xpath) { document.isolateNode(xpath, this); }
  2161.  
  2162.     node.applyAttributes = function(attrMap) {
  2163.         for (var key in attrMap) {
  2164.             this[key] = attrMap[key];
  2165.         }
  2166.     }
  2167.  
  2168.     /** &nbsp;
  2169.     */
  2170.     node.NBSP = "\u00A0";
  2171.  
  2172.     /** Create a DOM object of the given type,
  2173.     * and append it to this node.
  2174.     */
  2175.     node.appendChildElement = function(tagName) {
  2176.         var newNode = this.createXElement(tagName);
  2177.         this.appendChild(newNode);
  2178.         return newNode;
  2179.     };
  2180.  
  2181.     /** Create a text node,
  2182.     * optionally wrapped in the given HTML element types,
  2183.     * and append it to this node.
  2184.     */
  2185.     node.appendChildText = function(text, spanList, attrMap)
  2186.     {
  2187.         var newNode = this.ownerDocument.createTextNode(text);
  2188.         // wrap with other elements, if any, (eg: ["b", "i"])
  2189.         if (spanList != null) {
  2190.             for (var i = spanList.length - 1; i >= 0; i--) {
  2191.                 var n = this.createXElement(spanList[i]);
  2192.                 n.appendChild(newNode);
  2193.                 newNode = n;
  2194.             }
  2195.         }
  2196.         if (attrMap != null) {
  2197.             newNode.applyAttributes(attrMap);
  2198.         }
  2199.         this.appendChild(newNode);
  2200.         return newNode;
  2201.     };
  2202.  
  2203.     /** Create a text node consisting of a series of &nbsp; entities,
  2204.     * and append it to this node.
  2205.     */
  2206.     node.appendChildTextNbsp = function(count) {
  2207.         if (count == null)
  2208.             count = 1;
  2209.         var buf = "";
  2210.         for (var i = 0; i < count; i++) {
  2211.             buf += this.NBSP;
  2212.         }
  2213.         return this.appendChildText(buf);
  2214.     };
  2215.  
  2216.     /** Insert the given node as the first child of this node.
  2217.     */
  2218.     node.prependChild = function(newNode) {
  2219.         this.insertBefore(newNode, this.firstChild);
  2220.         return newNode;
  2221.     };
  2222.  
  2223.     /** Insert the given node in front of this node.
  2224.     */
  2225.     node.prependSibling = function(newNode) {
  2226.         var p = this.parentNode;
  2227.         p.insertBefore(newNode, this);
  2228.         return newNode;
  2229.     };
  2230.  
  2231.     /** Insert the given node after this node.
  2232.     */
  2233.     node.appendSibling = function(newNode) {
  2234.         var p = this.parentNode;
  2235.         var followingSibling = this.nextSibling;
  2236.         p.insertBefore(newNode, followingSibling);
  2237.         return newNode;
  2238.     };
  2239.  
  2240.     /** Create an HTML element of the specified type,
  2241.     * with the given attributes applied to it,
  2242.     * then move this node inside the newly created node,
  2243.     * and attach the newly created node in place of this node
  2244.     * returning the newly created object.
  2245.     */
  2246.     node.wrapIn = function(type, attrs) {
  2247.         var wrapperNode = this.createXElement(type, attrs);
  2248.         this.prependSibling(wrapperNode);
  2249.         this.remove();
  2250.         wrapperNode.appendChild(this);
  2251.         return wrapperNode;
  2252.     };
  2253.  
  2254.     /** 
  2255.     */
  2256.     node.makeCollapsible = function(id, isPersistent, isInitExpanded) {
  2257.         return new Collapsible(this, id, isPersistent, isInitExpanded);
  2258.     };
  2259.  
  2260.     /** Remove this node, and insert the given node in its place.
  2261.     * .. more details
  2262.     */
  2263.     node.replaceWith = function(node) {
  2264.         this.appendSibling(node);
  2265.         this.remove();
  2266.         return node;
  2267.     };
  2268.  
  2269.     /** Create an HTML table row.
  2270.     * .. more details
  2271.     */
  2272.     node.appendTableRow = function(valueList, tdAttrMapList)
  2273.     {
  2274.         var tr = this.createXElement("tr");
  2275.         for (var i in valueList)
  2276.         {
  2277.             var td = this.createXElement("td");
  2278.             if (tdAttrMapList != null)
  2279.                 td.applyAttributes(tdAttrMapList[i]);
  2280.             if (valueList[i] == null)
  2281.                 ;
  2282.             else if (typeof(valueList[i]) == "string")
  2283.                 td.appendChild( this.ownerDocument.createTextNode(valueList[i]) );
  2284.             else
  2285.                 td.appendChild( valueList[i] );
  2286.             tr.appendChild(td);
  2287.         }
  2288.         this.appendChild(tr);
  2289.     }
  2290.  
  2291.     /** Remove this node from the DOM.
  2292.     */
  2293.     node.remove = function() {
  2294.         this.parentNode.removeChild(this);
  2295.         return this;
  2296.     }
  2297.  
  2298.     /** Hide this node.
  2299.     */
  2300.     node.hide = function() {
  2301.         this.style.display = "none";
  2302.     }
  2303.  
  2304.     /** Hide nodes that are siblings to this node.
  2305.     */
  2306.     node.hideSiblings = function() {
  2307.         this.foreachNode("../child::*", function(node) {
  2308.             if (! this.isSameNode(node)) {
  2309.                 if (node.tagName != "SCRIPT" && node.tagName != "NOSCRIPT")
  2310.                     node.hide();
  2311.             }
  2312.         });
  2313.     };
  2314.  
  2315.     /** Show this node.
  2316.     */
  2317.     node.show = function() {
  2318.         this.style.display = null;
  2319.     }
  2320.  
  2321.     /** Calculate the absolute X position of this HTML element.
  2322.     */
  2323.     node.findPosX = function()
  2324.     {
  2325.         var x = 0;
  2326.         var node = this;
  2327.         while (node.offsetParent != null) {
  2328.             x += node.offsetLeft;
  2329.             node = node.offsetParent;
  2330.         }
  2331.         if (node.x != null)
  2332.             x += node.x;
  2333.         return x;
  2334.     }
  2335.  
  2336.     /** Calculate the absolute Y position of this HTML element.
  2337.     */
  2338.     node.findPosY = function()
  2339.     {
  2340.         var y = 0;
  2341.         var node = this;
  2342.         while (node.offsetParent != null) {
  2343.             y += node.offsetTop;
  2344.             node = node.offsetParent;
  2345.         }
  2346.         if (node.y != null)
  2347.             y += node.y;
  2348.         return y;
  2349.     }
  2350.  
  2351.     return node;
  2352. }
  2353.  
  2354.  
  2355. // ==================== TabSet object ====================
  2356.  
  2357. var activeTabsets = new Array();
  2358.  
  2359. // assumes that doc has already been extended
  2360. function TabSet(doc, tabsetId, tabLabels)
  2361. {
  2362.     this.doc = doc;
  2363.     this.tabsetId = tabsetId;
  2364.     this.tabLinkMap = new Array();
  2365.     this.tabDivMap = new Array();
  2366.  
  2367.     // save TabSet object reference for callbacks
  2368.     activeTabsets[tabsetId] = this;
  2369.  
  2370.     this.getTabContent_div = function(labelText) {
  2371.         return this.tabDivMap[labelText];
  2372.     }
  2373.  
  2374.     this.createTab = function(idx, labelText)
  2375.     {
  2376.         var a = this.doc.createXElement("a", {
  2377.             name: this.tabsetId,
  2378.             textContent: labelText,
  2379.             className: "DialogBox_clickable"
  2380.         });
  2381.         with (a.style) {
  2382.             padding = "3px 4px";
  2383.             border = "1px solid Black";
  2384.             MozBorderRadius = "4px";
  2385.             borderBottom = "none";
  2386.             fontSize = "9pt";
  2387.             color = "Black";
  2388.             textDecoration = "none";
  2389.         }
  2390.         return a;
  2391.     }
  2392.  
  2393.     this.activateTab = function(a) {
  2394.         with (a.style) {
  2395.             paddingTop = "4px";
  2396.             backgroundColor = "LightGray";
  2397.         }
  2398.         var content_div = this.getTabContent_div(a.textContent);
  2399.         content_div.show();
  2400.     }
  2401.  
  2402.     this.deactivateTab = function(a) {
  2403.         with (a.style) {
  2404.             paddingTop = "3px";
  2405.             backgroundColor = "DarkGray";
  2406.         }
  2407.         var content_div = this.getTabContent_div(a.textContent);
  2408.         content_div.hide();
  2409.     }
  2410.  
  2411.     this.selectTab = function(selected_a)
  2412.     {
  2413.         // (can be called from outside this object's context, (ie, click listener))
  2414.         var tabset = activeTabsets[selected_a.name];
  2415.         // deselect all tabs
  2416.         tabset.doc.foreachNode("//a[@name='" + selected_a.name + "']", function(a) {
  2417.             tabset.deactivateTab(a);
  2418.         });
  2419.         // then select the clicked tab
  2420.         tabset.activateTab(selected_a);
  2421.     }
  2422.  
  2423.     this.initialize = function(labelText)
  2424.     {
  2425.         var maxX = 0;
  2426.         var maxY = 0;
  2427.         // determine largest width/height across content divs
  2428.         for (var d in this.tabDivMap) {
  2429.             var div = this.tabDivMap[d];
  2430.             if (div.clientWidth  > maxX) maxX = div.clientWidth;
  2431.             if (div.clientHeight > maxY) maxY = div.clientHeight;
  2432.         }
  2433.         // equalize size of content divs to largest
  2434.         for (var d in this.tabDivMap) {
  2435.             var div = this.tabDivMap[d];
  2436.             div.style.width = maxX;
  2437.             div.style.height = maxY;
  2438.         }
  2439.         // select the default tab
  2440.         if (labelText == null) {
  2441.             labelText = tabLabels[0];
  2442.         }
  2443.         this.selectTab(this.tabLinkMap[labelText])
  2444.     }
  2445.  
  2446.  
  2447.     this.container_div = this.doc.createXElement("div", { id: this.tabsetId });
  2448.  
  2449.     var ul = this.doc.createXElement("ul");
  2450.     this.container_div.appendChild(ul);
  2451.     with (ul.style) {
  2452.         margin = "13px 7px 1px 12px";
  2453.         padding = "0px 0px 0px 0px";
  2454.         fontSize = "10pt";
  2455.     }
  2456.  
  2457.     for (var t in tabLabels)
  2458.     {
  2459.         var tab_a = this.createTab(t, tabLabels[t]);
  2460.         tab_a.addEventListener('click', function(event) {
  2461.                 // now we're in the isolated context of the click
  2462.                 // ie, context inferred from event & globals
  2463.                 var selected_a = event.target;
  2464.                 var tabset = activeTabsets[selected_a.name];
  2465.                 tabset.selectTab(selected_a);
  2466.             },
  2467.             false
  2468.         );
  2469.         ul.appendChild(tab_a);
  2470.         // maintatin default mouse cursor over the topic label text
  2471.         tab_a.wrapIn("label");
  2472.         this.tabLinkMap[tabLabels[t]] = tab_a;
  2473.         // corresponding content div
  2474.         var tabContent_div = this.doc.createXElement("div", {
  2475.             id: this.tabsetId + ":" + tabLabels[t]
  2476.         });
  2477.         with (tabContent_div.style) {
  2478.             margin = "0px 7px 0px 7px";
  2479.             padding = "4px 4px 4px 4px";
  2480.             border = "2px outset Black";
  2481.         }
  2482.         this.container_div.appendChild(tabContent_div);
  2483.         this.tabDivMap[tabLabels[t]] = tabContent_div;
  2484.     }
  2485. }
  2486.  
  2487.  
  2488. // ==================== DialogBox object ====================
  2489.  
  2490. var activeDialogs = new Array();
  2491.  
  2492. // assumes that doc has already been extended
  2493. function DialogBox(doc, dialogTitle)
  2494. {
  2495.     this.doc = doc;
  2496.     this.callbacks = null;
  2497.  
  2498.     this.createDialog = function(popupName, dialogStyle, buttonDefs)
  2499.     {
  2500.         this.popupId = popupName + "_dialog";
  2501.  
  2502.         var main_div = this.doc.createXElement("div");
  2503.         with (main_div) {
  2504.             id = this.popupId;
  2505.             setAttribute("style", dialogStyle);
  2506.             style.maxWidth  = window.innerWidth - 50;
  2507.             style.maxHeight = window.innerHeight - 70;
  2508.             style.overflow = "auto";
  2509.             if (style.backgroundColor == "")
  2510.                 style.backgroundColor = "White";
  2511.  
  2512.             // dialog box structure
  2513.             innerHTML =
  2514.                 // border layers
  2515.                   '<div style="border: 1px solid; border-color: Gainsboro DarkSlateGray DarkSlateGray Gainsboro;">'
  2516.                 + '<div style="border: 1px solid; border-color: White DarkGray DarkGray White;">'
  2517.                 + '<div style="border: 2px solid Gainsboro;">'
  2518.                 // grid (has to be a table to acheive float behaviors)
  2519.                 + '<table cellspacing="0" cellpadding="0">'
  2520.                 + '<tbody>'
  2521.                 // titlebar (optional)
  2522.                 + ((dialogTitle != null) ?
  2523.                       '<tr id="' + this.popupId + '_titlebar"><td'
  2524.                     + ' style="padding: 2px; background-color: Navy; color: White; font: bold 9pt Arial;"'
  2525.                     + '>' + dialogTitle
  2526.                     + '</td></tr>'
  2527.                     : "")
  2528.                 // main content area
  2529.                 + '<tr id="' + this.popupId + '_main" style="overflow: auto;"><td>'
  2530.                 + '<div id="' + this.popupId + '_content"/>'
  2531.                 + '</td></tr>'
  2532.                 // button bar
  2533.                 + '<tr id="' + this.popupId + '_buttons"><td style="padding: 6px;">'
  2534.                 + '</td></tr>'
  2535.                 + '</tbody>'
  2536.                 + '</table>'
  2537.                 + '</div>'
  2538.                 + '</div>'
  2539.                 + '</div>'
  2540.             ;
  2541.         }
  2542.         this.doc.body.appendChild(main_div);
  2543. //        $(main_div).addClass("ui-widget-content ui-draggable");
  2544. //        $(main_div).draggable();
  2545.  
  2546.         this.main_td = main_div.selectNodeNullable("//tr[@id='" + this.popupId + "_main']/td")
  2547.         var content_div = main_div.selectNode("//div[@id='" + this.popupId + "_content']");
  2548.         var buttonbar_td = main_div.selectNodeNullable("//tr[@id='" + this.popupId + "_buttons']/td")
  2549.  
  2550.         var controlButtons_span = this.doc.createXElement("center");
  2551.  
  2552.         if (buttonDefs != null)
  2553.         {
  2554.             this.callbacks = buttonDefs;
  2555.             for (var b in buttonDefs)
  2556.             {
  2557.                 var button = null;
  2558.                 if (b == "X")
  2559.                 {
  2560.                     var titlebar_td = main_div.selectNodeNullable("//tr[@id='" + this.popupId + "_titlebar']/td")
  2561.                     if (titlebar_td != null) {
  2562.                         // X close button in the right side of the titlebar
  2563.                         button = this.doc.createXElement("a");
  2564.                         with (button) {
  2565.                             id = this.popupId + "_closer";
  2566.                             href = "javascript:void(0)";
  2567.                             with (style) {
  2568.                                 cssFloat = "right";
  2569.                                 border = "1px solid";
  2570.                                 borderColor = "White DarkSlateGray DarkSlateGray White";
  2571.                                 backgroundColor = "LightGray";
  2572.                                 padding = "0px 1px 0px 2px";
  2573.                                 font = "bold 9pt Arial";
  2574.                                 color = "Black";
  2575.                                 textAlign = "center";
  2576.                                 lineHeight = "110%";
  2577.                             }
  2578.                             appendChildText("X");
  2579.                         }
  2580.                         titlebar_td.prependChild(button);
  2581.                     }
  2582.                     else {
  2583.                         // X close button in the upper-right of window
  2584.                         button = this.doc.createXElement("a");
  2585.                         with (button) {
  2586.                             id = this.popupId + "_closer";
  2587.                             href = "javascript:void(0)";
  2588.                             with (style) {
  2589.                                 cssFloat = "right";
  2590.                                 backgroundColor = "#AA0000";
  2591.                                 padding = "2px";
  2592.                                 font = "bold 8pt Arial";
  2593.                                 textDecoration = "none";
  2594.                                 color = "White";
  2595.                             }
  2596.                             appendChildText("X");
  2597.                         }
  2598.                         content_div.prependSibling(button);
  2599.                     }
  2600.                 }
  2601.                 else {
  2602.                     // a regular button at bottom of window
  2603.                     button = this.doc.createXElement("button");
  2604.                     with (button.style) {
  2605.                         margin = "0px 5px";
  2606.                         fontSize = "8pt";
  2607.                         fontFamily = "Helvetica, sans-serif";
  2608.                     }
  2609.                     controlButtons_span.appendChild(button);
  2610.                 }
  2611.  
  2612.                 with (button) {
  2613.                     name = this.popupId; // name attr associates callbacks with the dialog id
  2614.                     className = "DialogBox_clickable";
  2615.                     textContent = b;
  2616.                     addEventListener('click', function(event) {
  2617.                             // now we're in the isolated context of the click
  2618.                             // ie, context inferred from event & globals
  2619.                             var doc = extendDocument(event.target.ownerDocument);
  2620.                             var dialog = activeDialogs[event.target.name];
  2621.                             var popupId = event.target.textContent;
  2622.                             var callbackFunc = dialog.callbacks[popupId];
  2623.                             dialog.hidePopup();
  2624.                             callbackFunc(doc);
  2625.                             dialog.removePopup();
  2626.                         },
  2627.                         false
  2628.                     );
  2629.                 }
  2630.             }
  2631.             buttonbar_td.appendChild(controlButtons_span);
  2632.  
  2633.             this.doc.addStyle(
  2634.                 ".DialogBox_clickable:hover { cursor: pointer; }\n"
  2635.             );
  2636.         }
  2637.  
  2638.         // save DialogBox object reference for callbacks
  2639.         activeDialogs[this.popupId] = this;
  2640.  
  2641.         return content_div;
  2642.     }
  2643.  
  2644.     this.hidePopup = function() {
  2645.         var div = this.doc.getElementById(this.popupId);
  2646.         div.style.display = "none";
  2647.     }
  2648.  
  2649.     this.removePopup = function() {
  2650.         var div = this.doc.getElementById(this.popupId);
  2651.         div.parentNode.removeChild(div);
  2652.  
  2653.         activeDialogs[this.popupId] = null;
  2654.     }
  2655. }
  2656.  
  2657. function noop() {
  2658. }
  2659.  
  2660.  
  2661. // ==================== Preferences object ====================
  2662.  
  2663. /** (This object is created before the Logger object,
  2664.  * therefore the log methods cannot be used. Use GM_log instead.)
  2665. */
  2666. function Preferences(defaultValuesMap)
  2667. {
  2668.     this.defaultValuesMap = defaultValuesMap;
  2669.     this.cacheMap = new Object();
  2670.  
  2671.     /** Adds additional attributes to the map.
  2672.     */
  2673.     // TBD: rename (add, merge)
  2674.     this.config = function(valuesMap) {
  2675.         for (var k in valuesMap) {
  2676.             this.defaultValuesMap[k] = valuesMap[k];
  2677.         }
  2678.     }
  2679.  
  2680.     this.get = function(prefName)
  2681.     {
  2682.         var value = this.cacheMap[prefName];
  2683.         if (typeof(value) == "undefined")
  2684.         {
  2685.             value = GM_getValue(prefName);
  2686.             if (typeof(value) == "undefined")
  2687.             {
  2688.                 value = this.defaultValuesMap[prefName];
  2689.                 if (typeof(value) == "undefined") {
  2690.                     GM_log("Unmanaged preference: " + prefName);
  2691.                     return value;
  2692.                 }
  2693.             }
  2694.             this.set(prefName, value);
  2695.         }
  2696.         return value;
  2697.     }
  2698.  
  2699.     this.set = function(prefName, prefValue)
  2700.     {
  2701.         GM_setValue(prefName, prefValue);
  2702.         this.cacheMap[prefName] = prefValue;
  2703.     }
  2704.  
  2705.     this.getAsList = function(prefName, delim, wrapperType)
  2706.     {
  2707.         var value = this.get(prefName);
  2708.         var valueList;
  2709.         if (value != null) {
  2710.             valueList = value.split(delim);
  2711.         }
  2712.         else {
  2713.             valueList = new Array();
  2714.         }
  2715.  
  2716.         if (wrapperType != null) {
  2717.             // wrap elements in custom object type
  2718.             var wrappedValueList = new Array();
  2719.             for (var i=0; i < valueList.length; i++) {
  2720.                 wrappedValueList[i] = new wrapperType(valueList[i]);
  2721.             }
  2722.             return wrappedValueList;
  2723.         }
  2724.  
  2725.         // add utility methods to the resulting Array object
  2726.  
  2727.         valueList.contains = function(matchText)
  2728.         {
  2729.             if (matchText == null) {
  2730.                 log.error("a null arg: " + this + " " + matchText);
  2731.                 return false;
  2732.             }
  2733.  
  2734.             for (var i in this) {
  2735.                 if (matchText == this[i])
  2736.                     return true;
  2737.             }
  2738.             return false;
  2739.         }
  2740.  
  2741.         return valueList;
  2742.     }
  2743. }
  2744.  
  2745.  
  2746. // ==================== PreferencesManager object ====================
  2747.  
  2748. function setScreenPosition(node, posIndicator)
  2749. {
  2750.     with (node.style)
  2751.     {
  2752.         position = "fixed";
  2753.         zIndex = 999;
  2754.         switch (posIndicator) {
  2755.             case "TL": top = 0;    left = 0;  break;
  2756.             case "TR": top = 0;    right = 0; break;
  2757.             case "BL": bottom = 0; left = 0;  break;
  2758.             case "BR": bottom = 0; right = 0; break;
  2759.             default:
  2760.                 log.error("Unrecognized menu position indicator: " + menuPos);
  2761.         }
  2762.     }
  2763. }
  2764.  
  2765. function PreferencesManager(doc, uniqId, title, buttonDefs)
  2766. {
  2767.     this.doc = extendDocument(doc);
  2768.     this.uniqId = uniqId;
  2769.     this.dialogBox = new DialogBox(this.doc, title);
  2770.     this.buttonDefs = buttonDefs;
  2771.  
  2772.     /** Display the Preferences dialog.
  2773.     */
  2774.     this.open = function()
  2775.     {
  2776.         if (this.doc.selectNodeNullable("//div[@id='" + this.uniqId + "_dialog']")) {
  2777.             log.info("Preferences dialog already open");
  2778.             return null;  // the dialog is already open
  2779.         }
  2780.  
  2781.         var dialogBox_div = this.dialogBox.createDialog(
  2782.             this.uniqId,
  2783.             "z-index: 999; left: 15%; top: 25px; position: fixed;"
  2784.             + " background-color: LightGray;",
  2785.             this.buttonDefs
  2786.         );
  2787.         with (dialogBox_div.style) {
  2788.             fontSize = "10pt";
  2789.             fontFamily = "Arial, Helvetica, sans-serif";
  2790.             overflow = "auto";
  2791.             backgroundColor = "LightGray";
  2792.         }
  2793.  
  2794.         return dialogBox_div;
  2795.     }
  2796.  
  2797.     /** Create an HTML input element associated with the named greasemonkey preference.
  2798.     */
  2799.     this.createPreferenceInput = function(prefName, titleText, tipText, attrMap, optionMap)
  2800.     {
  2801.         var prefValue = prefs.get(prefName);
  2802.         var item_label;
  2803.         var inputTagname = "input";
  2804.         switch (typeof(prefValue)) {
  2805.             case "boolean":
  2806.                 item_label = this.doc.createCheckbox(titleText, attrMap, prefValue);
  2807.                 break;
  2808.             case "string":
  2809.             case "number":
  2810.                 if (optionMap != null) {
  2811.                     item_label = this.doc.createSelect(titleText, attrMap, optionMap, prefValue);
  2812.                     inputTagname = "select";
  2813.                 }
  2814.                 else if (attrMap["rows"] != null) {
  2815.                     item_label = this.doc.createTextArea(titleText, attrMap, prefValue);
  2816.                     inputTagname = "textarea";
  2817.                 }
  2818.                 else {
  2819.                     item_label = this.doc.createInputText(titleText, attrMap, prefValue);
  2820.                 }
  2821.                 break;
  2822.             default:
  2823.                 log.warn("For " + prefName + ", unrecognized type: " + typeof(prefValue));
  2824.         }
  2825.         item_label.style.fontSize = "9pt";
  2826.         if (tipText != null)
  2827.             item_label.title = tipText;
  2828.         with (item_label.selectNode(inputTagname)) {
  2829.             name = prefName;
  2830.             className = "preferenceSetting";
  2831.             applyAttributes(attrMap);
  2832.         }
  2833.         return item_label;
  2834.     }
  2835.  
  2836.     this.createScreenCornerPreference = function(prefName)
  2837.     {
  2838.         var prefValue = prefs.get(prefName);
  2839.  
  2840.         var table = this.doc.createXElement("table", {
  2841.             id: prefName + "_2x2"
  2842.         });
  2843.         with (table) {
  2844.             style.borderCollapse = "collapse";
  2845.             cellPadding = 0; cellSpacing = 0;
  2846.  
  2847.             appendTableRow([ createRadioButton("TL"), null, createRadioButton("TR") ]);
  2848.             appendTableRow([          null,           null,          null           ]);
  2849.             appendTableRow([ createRadioButton("BL"), null, createRadioButton("BR") ]);
  2850.  
  2851.             style.border = "3px inset Black";
  2852.             foreachNode(".//input", function(inp) {
  2853.                 inp.style.margin = "0px";
  2854.             });
  2855.             with (selectNode(".//tr[2]/td[2]")) {
  2856.                 // acheive roughly 4/3 aspect ratio
  2857.                 style.width = "14px";
  2858.                 style.height = "4px";
  2859.             };
  2860.         }
  2861.         return table;
  2862.  
  2863.         function createRadioButton(choiceValue)
  2864.         {
  2865.             var radio_input = doc.createXElement("input", {
  2866.                 type: "radio", name: prefName, value: choiceValue,
  2867.                 className: "preferenceSetting"
  2868.             });
  2869.             if (choiceValue == prefValue) {
  2870.                 radio_input.checked = true;
  2871.             }
  2872.             return radio_input;
  2873.         }
  2874.     }
  2875.  
  2876.     /** Store current screen values into the associated Preferences,
  2877.     * but only for values that have changed.
  2878.     * (This is the primary logic for the OK button)
  2879.     */
  2880.     this.storePrefs = function()
  2881.     {
  2882.         this.doc.foreachNode("//*[@class='preferenceSetting']", function(inputObj) {
  2883.             var prefName = inputObj.name;
  2884.             var prefValue;
  2885.             if (inputObj.type == "checkbox") {
  2886.                 prefValue = inputObj.checked;
  2887.             }
  2888.             else if (inputObj.type == "radio") {
  2889.                 if (inputObj.checked)
  2890.                     prefValue = inputObj.value;
  2891.                 else
  2892.                     return; // skip all in group except the checked one
  2893.             }
  2894.             else {
  2895.                 prefValue = inputObj.value;
  2896.             }
  2897.  
  2898.             var oldValue = GM_getValue(prefName, prefValue);
  2899.             if (prefValue != oldValue)
  2900.             {
  2901.                 var defaultValue = prefs.get(prefName);
  2902.                 if (typeof(defaultValue) == "number") {
  2903.                     if (isNaN(prefValue)) {
  2904.                         alert("Non-numeric value '" + prefValue + "' is invalid for preference " + prefName);
  2905.                         return false; // continue on to next preference item
  2906.                     }
  2907.                     prefValue = parseFloat(prefValue);
  2908.                 }
  2909.                 if (typeof(prefValue) == "string")
  2910.                     log.info("Setting preference: " + prefName + " => '" + prefValue + "'");
  2911.                 else
  2912.                     log.info("Setting preference: " + prefName + " => " + prefValue);
  2913.                 prefs.set(prefName, prefValue);
  2914.             }
  2915.         });
  2916.     }
  2917. }
  2918.  
  2919.  
  2920. // ==================== Collapsible object ====================
  2921.  
  2922. function Collapsible(theNode, collapserId, isPersistent, isInitExpanded)
  2923. {
  2924.     this.node = theNode;
  2925.     this.doc = extendDocument(theNode.ownerDocument);
  2926.  
  2927.     if (collapserId == null) {
  2928.         if (theNode.id == null)
  2929.             collapserId = "collapser_" + generateUuid();
  2930.         else
  2931.             collapserId = theNode.id + "_collapser";
  2932.     }
  2933.  
  2934.     // maintain object reference(s) for callbacks
  2935.     if (document.activeCollapsers == null) {
  2936.         document.activeCollapsers = new Object();
  2937.     }
  2938.     document.activeCollapsers[collapserId] = this;
  2939.  
  2940.     this.expand = function(event) {
  2941.         collapsible = this;
  2942.         if (event != null) {
  2943.             var collapserId = event.target.parentNode.id;
  2944.             collapsible = document.activeCollapsers[collapserId];
  2945.             if (isPersistent) {
  2946.                 prefs.set(collapserId, true);
  2947.             }
  2948.         }
  2949.         collapsible.node.show();
  2950.         collapsible.expander.hide();
  2951.         collapsible.collapser.show();
  2952.     }
  2953.  
  2954.     this.collapse = function(event) {
  2955.         var collapsible = this;
  2956.         if (event != null) {
  2957.             var collapserId = event.target.parentNode.id;
  2958.             collapsible = document.activeCollapsers[collapserId];
  2959.             if (isPersistent) {
  2960.                 prefs.set(collapserId, false);
  2961.             }
  2962.         }
  2963.         collapsible.node.hide();
  2964.         collapsible.collapser.hide();
  2965.         collapsible.expander.show();
  2966.     }
  2967.  
  2968.     this.createController = function(func, base64) {
  2969.         var img = this.doc.createXElement("img");
  2970. //         img.title = label;
  2971.         img.src = 'data:image/gif;base64,' + base64;
  2972.         img.addEventListener('click', func, false);
  2973.  
  2974.         with (img.style) {
  2975.             cssFloat = "left";
  2976.             left = "0px";
  2977.             position = "absolute";
  2978.             zIndex = 999;
  2979.         }
  2980.         return img;
  2981.     }
  2982.  
  2983.     var span = this.doc.createXElement("span", { id: collapserId });
  2984.     this.node.prependSibling(span);
  2985.  
  2986.     this.expander = this.createController(this.expand,
  2987.         'R0lGODlhEAAQAKEDAAAA/wAAAMzMzP///yH5BAEAAAMALAAAAAAQABAAAAIhnI+pywOtwINHTmpvy3rx' +
  2988.         'nnABlAUCKZkYoGItJZzUTCMFACH+H09wdGltaXplZCBieSBVbGVhZCBTbWFydFNhdmVyIQAAOw=='
  2989.     );
  2990.     span.appendChild(this.expander);
  2991.  
  2992.     this.collapser = this.createController(this.collapse,
  2993.         'R0lGODlhEAAQAKEDAAAA/wAAAMzMzP///yH5BAEAAAMALAAAAAAQABAAAAIdnI+py+0Popwx0RmEuiAz' +
  2994.         '6jVS6HTaY5zoyrZuWwAAIf4fT3B0aW1pemVkIGJ5IFVsZWFkIFNtYXJ0U2F2ZXIhAAA7'
  2995.     );
  2996.     span.appendChild(this.collapser);
  2997.  
  2998.     var isExpanded = isInitExpanded;
  2999.     if (isPersistent == true) {
  3000.         isExpanded = prefs.get(collapserId);
  3001.     }
  3002.  
  3003.     if (isExpanded)
  3004.         this.expand()
  3005.     else
  3006.         this.collapse()
  3007. }
  3008.  
  3009.  
  3010. // ==================== DocumentContainer object ====================
  3011.  
  3012. /** Create and manage invisible iframe content loaded from an arbitrary URL.
  3013. * If the same URL is requested more than once, it is returned from cache.
  3014. * Example:
  3015. *    var dc = new DocumentContainer();
  3016. *    dc.loadFromSameOrigin("search.do?category=eligible",
  3017. *        function(doc) {
  3018. *            if (dm.xdoc.selectNode("//text()[.='Dilbert']"))
  3019. *                alert("Hide your daughters!");
  3020. *        }
  3021. *    );
  3022. */
  3023. function DocumentContainer(debugFlag)
  3024. {
  3025.     var iframeCache = new Array();
  3026.     this.debug = debugFlag;
  3027.  
  3028.     this.loadFromSameOrigin = function(theUrl, theFunc)
  3029.     {
  3030.         var iframe = iframeCache[theUrl];
  3031.         if (iframe != null) {
  3032.             if (theFunc != null)
  3033.                 theFunc(iframe.contentDocument);
  3034.             return;
  3035.         }
  3036.  
  3037.         var iframe = this.attachIframe(theUrl);
  3038.  
  3039.         // wait for the DOM to be available, then dispatch
  3040.         iframe.addEventListener(
  3041.             "load",
  3042.             function(evt) {
  3043.                 var theIframe = evt.currentTarget;
  3044.                 var theUrl = theIframe.contentWindow.location.href;
  3045.                 iframeCache[theUrl] = theIframe;
  3046.                 if (theFunc != null)
  3047.                     theFunc(theIframe.contentDocument);
  3048.             },
  3049.             false
  3050.         );
  3051.  
  3052.         // load the content
  3053.         iframe.contentWindow.location.href = ajaxstaticUrl(theUrl);
  3054.     }
  3055.  
  3056.     this.loadFromForeignOrigin = function(theUrl, theFunc)
  3057.     {
  3058.         if (window != top) {
  3059.             return;  // prevent infinite recursion
  3060.         }
  3061.         var iframe = this.attachIframe(theUrl);
  3062.  
  3063.         GM_xmlhttpRequest(
  3064.         {
  3065.             method: "GET",
  3066.             url: ajaxstaticUrl(theUrl),
  3067.             onload: function(details) {
  3068.  
  3069.                 // give it a URL so that it will create a .contentDocument property.
  3070.                 // Make it the same as the current page,
  3071.                 // Otherwise, same-origin policy would prevent us.
  3072.                 // TBD: why is this a literal? Would foobar.com work as well??
  3073.                 iframe.contentWindow.location.href = "http://tv.yahoo.com/";
  3074.  
  3075.                 // wait for the DOM to be available, then dispatch
  3076.                 iframe.addEventListener(
  3077.                     "DOMContentLoaded",
  3078.                     function() {
  3079.                         if (theFunc != null)
  3080.                             theFunc(iframe.contentDocument);
  3081.                     },
  3082.                     false
  3083.                 );
  3084.  
  3085.                 // write the received content into the document
  3086.                 iframe.contentDocument.open("text/html");
  3087.                 iframe.contentDocument.write(details.responseText);
  3088.                 iframe.contentDocument.close();
  3089.             }
  3090.         });
  3091.  
  3092.         return iframe.contentDocument;
  3093.     }
  3094.  
  3095.     this.attachIframe = function(theUrl)
  3096.     {
  3097.         // create an IFRAME element to write the document into.
  3098.         // It must be added to the document and rendered (eg, display != none)
  3099.         // to be properly initialized.
  3100.         var iframe = document.createElement("iframe");
  3101.         iframe.id = "DocumentContainer_" + theUrl;
  3102.         if (this.debug == null) {
  3103.             iframe.width = 0;
  3104.             iframe.height = 0;
  3105.             iframe.style.display = "none";
  3106.         }
  3107.         else {
  3108.             iframe.width = 800;
  3109.             iframe.height = 700;
  3110.         }
  3111.         document.body.appendChild(iframe);
  3112.  
  3113.         iframe.contentWindow.location.href = "about:blank";
  3114.  
  3115.         return iframe;
  3116.     }
  3117.  
  3118.     // private helper methods
  3119. }
  3120.  
  3121.     /** Add param to URL, marking it as not to be re-processed.
  3122.     */
  3123.     function ajaxstaticUrl(theUrl)
  3124.     {
  3125.         var newUrl = theUrl;
  3126.         if (newUrl.indexOf("?") == -1)
  3127.             newUrl += "?";
  3128.         if (newUrl.indexOf("?") != newUrl.length-1)
  3129.             newUrl += "&";
  3130.         return newUrl + "ajaxstatic";
  3131.     }
  3132.  
  3133. /** Retrieve each document specified in the urlList
  3134. * invoking onloadFunc with each doc,
  3135. * and then finally invoking onrendezvousFunc with the assembled list of docs
  3136. */
  3137. function withDocuments(urlList, onloadFunc, onrendezvousFunc)
  3138. {
  3139.     var context = new Object();
  3140.     context.resultDocList = new Array();
  3141.     context.pendingCount = urlList.length;
  3142.  
  3143.     for (var u in urlList)
  3144.     {
  3145.         var dc = new DocumentContainer();
  3146.         dc.loadFromSameOrigin(urlList[u],
  3147.             function(curDoc) {
  3148.                 if (onloadFunc != null) {
  3149.                     onloadFunc(curDoc);
  3150.                 }
  3151.                 if (--context.pendingCount == 0) {
  3152.                     if (onrendezvousFunc != null) {
  3153.                         context.resultDocList.push(curDoc);
  3154.                         onrendezvousFunc(context.resultDocList);
  3155.                     }
  3156.                 }
  3157.             }
  3158.         );
  3159.     }
  3160. }
  3161.  
  3162. /** Recursively retrieve each document specified in the urlList,
  3163. * then invoke the dispatch function with the list of loaded docs.
  3164. */
  3165. function withDocumentsSerialized(urlList, func, docList)
  3166. {
  3167.     var curUrl = urlList.shift();
  3168.     if (docList == null)
  3169.         docList = new Array();
  3170.  
  3171.     var dc = new DocumentContainer();
  3172.     dc.loadFromSameOrigin(curUrl,
  3173.         function(curDoc) {
  3174.             if (urlList.length > 0)
  3175.                 withDocuments(urlList, func, docList);
  3176.             else
  3177.                 func(docList);
  3178.         }
  3179.     );
  3180. }
  3181.  
  3182.  
  3183.  
  3184. // ==================== Logger object ====================
  3185.  
  3186. function Logger(verNum)
  3187. {
  3188.     this.logLevels = ["ERROR", "WARN", "INFO", "DEBUG", "TRACE"];
  3189.  
  3190.     this.level = null;
  3191.  
  3192.     this.setLevel = function(level) {
  3193.         this.level = level;
  3194.         if (level >= 2)
  3195.             GM_log("[" + verNum + "] === LOGGER LEVEL: " + this.logLevels[this.level] + " ==="
  3196.             + " " + document.location.href);
  3197.     }
  3198.  
  3199.     this.setLevel(arrayIndexOf(this.logLevels, prefs.get("loggerLevel")));
  3200.  
  3201.     this.error = function(msg) { if (this.level >= 0) GM_log("ERROR: " + msg); }
  3202.     this.warn  = function(msg) { if (this.level >= 1) GM_log("WARN: " + msg); }
  3203.     this.info  = function(msg) { if (this.level >= 2) GM_log("INFO: " + msg); }
  3204.     this.debug = function(msg) { if (this.level >= 3) GM_log("DEBUG: " + msg); }
  3205.     this.trace = function(msg) { if (this.level >= 4) GM_log("TRACE: " + msg); }
  3206.  
  3207.     this.getLogLevelMap = function() { return IdentityMapForArray(this.logLevels); };
  3208. }
  3209.  
  3210.  
  3211. // ==================== JavaScript object extenstions ====================
  3212.  
  3213. function extendJavascriptObjects()
  3214. {
  3215.     // ---------- String extensions ----------
  3216.  
  3217.     /** Format text content as it will appear on a page (before wrapping, etc).
  3218.     */
  3219.     String.prototype.normalizeWhitespace = function()
  3220.     {
  3221.         var text = this.replace(/\s+/g, " ");      // reduce internal whitespace
  3222.         text = text.replace(/ ([,;:\.!])/g, "$1"); // snug-up punctuation
  3223.         return text.trimWhitespace();
  3224.     }
  3225.  
  3226.     /** Format text content as it will appear on a page (before wrapping, etc).
  3227.     */
  3228.     String.prototype.trimWhitespace = function()
  3229.     {
  3230.         return this.replace(/^\s*/, "").replace(/\s*$/, "");
  3231.     }
  3232.  
  3233.     String.prototype.stripQuoteMarks = function()
  3234.     {
  3235.         var text = this.replace(/"/g, "");
  3236.         return text;
  3237.     }
  3238.  
  3239.     // ---------- Date extensions ----------
  3240.  
  3241.     SECOND = 1000;
  3242.     MINUTE = SECOND * 60;
  3243.     HOUR = MINUTE * 60;
  3244.     DAY = HOUR * 24;
  3245.     WEEK = DAY * 7;
  3246.  
  3247.     // Example, on the hour: floor(Date.HOUR)
  3248.     Date.prototype.floor = function(unit) {
  3249.         var floorMilli = Math.floor(this.getTime() / unit) * unit;
  3250.         return new Date(floorMilli);
  3251.     }
  3252.  
  3253.     Date.prototype.add = function(millis) {
  3254.         return new Date(this.getTime() + millis);
  3255.     }
  3256. }
  3257.  
  3258.  
  3259. // ---------- Array helpers ----------
  3260.  
  3261. function arrayIndexOf(theList, value, attrName)
  3262. {
  3263.     if (attrName == null) {
  3264.         // by element value
  3265.         for (var i in theList) {
  3266.             if (theList[i] == value)
  3267.                 return i;
  3268.         }
  3269.     }
  3270.     else {
  3271.         if (typeof(value) == "object") {
  3272.             // by corresponding attribute in value array
  3273.             for (var i in theList) {
  3274.                 if (theList[i][attrName] == value[attrName])
  3275.                     return i;
  3276.             }
  3277.         }
  3278.         else {
  3279.             // by attribute value
  3280.             for (var i in theList) {
  3281.                 if (theList[i][attrName] == value) {
  3282.                     return i;
  3283.                 }
  3284.             }
  3285.         }
  3286.     }
  3287.     return null;
  3288. }
  3289.  
  3290. function sortBy(theList, fieldList)
  3291. {
  3292.     theList.sort( function(a, b)
  3293.     {
  3294.         for (var i in fieldList) {
  3295.             if (a[fieldList[i]] < b[fieldList[i]]) return -1;
  3296.             if (a[fieldList[i]] > b[fieldList[i]]) return 1;
  3297.         }
  3298.         return 0;
  3299.     });
  3300.     return theList;
  3301. }
  3302.  
  3303. function sortDescBy(theList, fieldList)
  3304. {
  3305.     theList.sort( function(a, b)
  3306.     {
  3307.         for (var i in fieldList) {
  3308.             if (a[fieldList[i]] > b[fieldList[i]]) return -1;
  3309.             if (a[fieldList[i]] < b[fieldList[i]]) return 1;
  3310.         }
  3311.         return 0;
  3312.     });
  3313.     return theList;
  3314. }
  3315.  
  3316. function numericComparatorAsc(a, b) {
  3317.     return (a-b);
  3318. }
  3319.  
  3320. function numericComparatorDesc(a, b) {
  3321.     return (b-a);
  3322. }
  3323.  
  3324. /** .
  3325. */
  3326. function IdentityMapForArray(ary)
  3327. {
  3328.     var map = new Array();
  3329.     for (var i=0; i < ary.length; i++) {
  3330.         map[ary[i]] = ary[i];
  3331.     }
  3332.     return map;
  3333. }
  3334.  
  3335. /** Create a new Array with pre-defined numeric indices,
  3336. * (ie, ready for inserts to random indices).
  3337. */
  3338. function initArrayIndices(count) {
  3339.     var a = new Array(count);
  3340.     for (var i = 0; i < count; i++) {
  3341.         a[i] = null;
  3342.     }
  3343.     return a;
  3344. }
  3345.  
  3346.  
  3347. /** Dispatch processing for each grouping of elements based upon the named field.
  3348.  * Example:
  3349.  *   var nodes = dm.xdoc.selectNodes("//*[@class]");
  3350.  *   GM_log(nodes.length + " nodes");
  3351.  *   foreachGrouping(sortBy(nodes, ["className"] ), "className", function(groups) {
  3352.  *     GM_log(groups.length + " nodes with class='" + groups[0].className+ "'");
  3353.  *   });
  3354. */
  3355. function foreachGrouping(theList, attrName, func)
  3356. {
  3357.     var curList = new Array();
  3358.     var prevValue = null;
  3359.     for (var i in theList)
  3360.     {
  3361.         if (theList[i][attrName] != prevValue)
  3362.         {
  3363.             if (curList.length > 0) {
  3364.                 func(curList);
  3365.             }
  3366.             curList = new Array();
  3367.         }
  3368.         curList.push(theList[i]);
  3369.         prevValue = theList[i][attrName];
  3370.     }
  3371. }
  3372.  
  3373.  
  3374. // ==================== UrlParser object ====================
  3375.  
  3376. /** Parsing and formatting of URLs.
  3377. * url, params; scheme, host, port, path
  3378. */
  3379. function UrlParser(urlString)
  3380. {
  3381.     var urlParts = urlString.split("?");
  3382.     this.url = urlParts[0];
  3383.     this.parms = new Array();
  3384.  
  3385.     // parse query params into name/value associative list
  3386.     if (urlParts[1]) {
  3387.         var queryItems = urlParts[1].split("&");
  3388.  
  3389.         for (var i in queryItems) {
  3390.             var parm = queryItems[i].split("=");
  3391.             this.parms[unescape(parm[0])] = unescape(parm[1]);
  3392.             // convert to numeric if appropriate
  3393.             var num = parseInt(parm[1]);
  3394.             if (!isNaN(num) && parm[1].substring(0, 1) != "0") {
  3395.                 this.parms[unescape(parm[0])] = num;
  3396.             }
  3397.         }
  3398.     }
  3399.  
  3400.     // parse http://domain/path into scheme, domain, path
  3401.     this.url.match(/(\w+):\/\/([\w\.]+)(\/.*)/);
  3402.     this.scheme = RegExp.$1;
  3403.     this.host = RegExp.$2;
  3404.     this.path = RegExp.$3;
  3405.  
  3406.     // METHODS
  3407.  
  3408.     // assemble the query part of the URL
  3409.     this.getQuery = function()
  3410.     {
  3411.         queryItems = new Array();
  3412.         for (var p in this.parms) {
  3413.             if (this.parms[p])
  3414.                 queryItems.push(escape(p) + "=" + escape(this.parms[p]));
  3415.         }
  3416.         if (queryItems.length == 0) {
  3417.             return "";
  3418.         }
  3419.         else {
  3420.             return "?" + queryItems.join("&");
  3421.         }
  3422.     }
  3423.  
  3424.     // assemble the whole URL
  3425.     this.toString = function()
  3426.     {
  3427.         return this.url + this.getQuery();
  3428.     }
  3429. }
  3430.  
  3431.  
  3432. // --------------- helper functions ---------------
  3433.  
  3434. /** Lookup preference setting and conditionally execute with error handling.
  3435. */
  3436. function dispatchFeature(feaureName, func)
  3437. {
  3438.     if (prefs.get(feaureName))
  3439.     {
  3440.         tryCatch("feature: " + feaureName, func);
  3441.     }
  3442. }
  3443.  
  3444. /** Provide debug info if function throws an exception.
  3445. */
  3446. function tryCatch(desc, func)
  3447. {
  3448.     try { func(); }
  3449.     catch(err) {
  3450.         log.error(
  3451.             "exception @ " + err.lineNumber + " [" + desc + "]" + " : " + err + "\n"
  3452.             + genStackTrace(arguments.callee)
  3453.         );
  3454.     }
  3455. }
  3456.  
  3457. /** Generate a UUID.
  3458. */
  3459. function generateUuid() {
  3460.     return (S4()+S4() + "-" + S4() + "-" + S4() + "-" + S4() + "-" + S4()+S4()+S4());
  3461.  
  3462.     function S4() {
  3463.         // 5 digit random #
  3464.         return (((1+Math.random())*0x10000)|0).toString(16).substring(1);
  3465.     }
  3466. }
  3467.  
  3468. // --------------- Stack Trace ---------------
  3469.  
  3470. function genStackTrace(func)
  3471. {
  3472.     var depthLimit = 20;
  3473.     var stackTrace = "Stack trace:\n";
  3474.     while (func != null) {
  3475.         if (--depthLimit < 0) {
  3476.             stackTrace += "more ...\n";
  3477.             break;
  3478.         }
  3479.         stackTrace += "called by: " + getFunctionSignature(func) + "\n";
  3480.         // TBD: line# within func
  3481.         func = func.caller;
  3482.     }
  3483.  
  3484.     return stackTrace + "\n\n";
  3485. }
  3486.  
  3487. function getFunctionSignature(func)
  3488. {
  3489.     var signature = getFunctionName(func);
  3490.     signature += "(";
  3491.     for (var i = 0; i < func.arguments.length; i++)
  3492.     {
  3493.         // trim long arguments
  3494.         var nextArgument = func.arguments[i];
  3495.         if (nextArgument.length > 30)
  3496.             nextArgument = nextArgument.substring(0, 30) + "...";
  3497.  
  3498.         // apend the next argument to the signature
  3499.         signature += "'" + nextArgument + "'";
  3500.  
  3501.         // comma separator
  3502.         if (i < func.arguments.length - 1)
  3503.             signature += ", ";
  3504.     }
  3505.     signature += ")";
  3506.  
  3507.     return signature;
  3508. }
  3509.  
  3510. function getFunctionName(func)
  3511. {
  3512.     // mozilla makes it easy
  3513.     if (func.name != null) {
  3514.         return func.name;
  3515.     }
  3516.  
  3517.     // try to parse the function name from the defintion
  3518.     var definition = func.toString();
  3519.     var name = definition.substring(
  3520.         definition.indexOf('function') + 8,
  3521.         definition.indexOf('(')
  3522.     );
  3523.     if (name != null)
  3524.         return name;
  3525.  
  3526.     // sometimes there won't be a function name (eg, dynamic functions)
  3527.     return "anonymous";
  3528. }