☰

mTurkWiki.net Great HITs Export

Export HIT description as phpBB formatted text with turkopticon link and all relevant data.

  1. // ==UserScript==
  2. // @name        mTurkWiki.net Great HITs Export
  3. // @namespace   localhost
  4. // @author      ThirdClassInternationalMasterTurker and DCI modded for mTurk Wiki by ChrisM77
  5. // @description Export HIT description as phpBB formatted text with turkopticon link and all relevant data.
  6. // @include     https://www.mturk.com/mturk/searchbar*
  7. // @include     https://www.mturk.com/mturk/findhits*
  8. // @include     https://www.mturk.com/mturk/viewhits*
  9. // @include     https://www.mturk.com/mturk/viewsearchbar*
  10. // @include     https://www.mturk.com/mturk/sortsearchbar*
  11. // @include     https://www.mturk.com/mturk/sorthits*
  12. // @require     https://cdnjs.cloudflare.com/ajax/libs/jquery/1.9.1/jquery.min.js
  13. // @grant       GM_getValue
  14. // @grant       GM_setValue
  15. // @grant       GM_deleteValue
  16. // @version     2.1
  17. // ==/UserScript==
  18.  
  19. //
  20. // 2012-11-19 0.2: Added customizable template
  21. //
  22. // 2012-11-20 0.3: Fixed: verifies that HIT link is correct
  23. //
  24. // 2012-11-26 0.4: Try to get requester and requesterId right even if some other script has changed the page.
  25. //                 Added requester link to default template.
  26. // 
  27. // 2012-11-26 0.5: Partially works with Opera (No customisation)
  28. //
  29. // 2012-12-02 1.0: Added @downloadURL and @updateURL
  30. //
  31. // 2013-05-20 1.2: Added a Time field that will need to be manually changed after pasting into forum thread. Changed name of scipt.
  32.  
  33. (function () {
  34.     var EDIT = false;
  35.     var HITS = [];
  36.     var HIT;
  37.  
  38.     DEFAULT_TEMPLATE = '[b]Title:[/b] [url={link}][COLOR=#be2c2a]{title}[/COLOR][/url]\n';
  39.     DEFAULT_TEMPLATE += '[b]Requester:[/b] [url=https://www.mturk.com/mturk/searchbar?selectedSearchType=hitgroups&requesterId={requesterId}][COLOR=#be2c2a]{requester}[/COLOR][/url]';
  40.     DEFAULT_TEMPLATE += ' [{requesterId}] ([url=http://turkopticon.differenceengines.com/{requesterId}][COLOR=#be2c2a]TO[/COLOR][/url])';
  41.     DEFAULT_TEMPLATE += '{to_stuff}';
  42.     DEFAULT_TEMPLATE += '\n[b]Description:[/b] {description}';
  43.     DEFAULT_TEMPLATE += '\n[b]Reward:[/b] [COLOR=green][b]{reward}[/b][/COLOR]';
  44.     DEFAULT_TEMPLATE += '\n[b]Qualifications:[/b] {qualifications}';
  45.     var TO_BASE = "http://turkopticon.ucsd.edu/";
  46.     var API_BASE = "https://mturk-api.istrack.in/";
  47.     var API_MULTI_ATTRS_URL = API_BASE + "multi-attrs.php?ids=";
  48.  
  49.     var TEMPLATE;
  50.     var EASYLINK;
  51.  
  52.     if (typeof GM_getValue === 'undefined')
  53.         TEMPLATE = null;
  54.     else {
  55.         TEMPLATE = GM_getValue('HITExport Template');
  56.         EASYLINK = GM_getValue('HITExport Easylink');
  57.     }
  58.     if (TEMPLATE == null) {
  59.         TEMPLATE = DEFAULT_TEMPLATE;
  60.     }
  61.  
  62.     function get_requester_id(s) {
  63.         var idx = 12 + s.search('requesterId=');
  64.         return s.substr(idx);
  65.     }
  66.  
  67.     function getRequesterAnchorsAndIds(a) {
  68.         var rai = {};
  69.         var re = new RegExp(/requesterId/);
  70.         var rf = new RegExp(/contact/);
  71.         for (var i = 0; i < a.length; i++) {
  72.             var href = a[i].getAttribute('href');
  73.             if (re.test(href) && !rf.test(href)) {
  74.                 var id = a[i].href.split('requesterId=')[1].split('&')[0]
  75.                 if (!rai.hasOwnProperty(id)) {
  76.                     rai[id] = [];
  77.                 }
  78.                 rai[id].push(a[i]);
  79.             }
  80.         }
  81.         return rai;
  82.     }
  83.  
  84.     function buildXhrUrl(rai) {
  85.         var url = API_MULTI_ATTRS_URL;
  86.         var ri = Object.keys(rai);
  87.         for (var i = 0; i < ri.length; i++) {
  88.             url += ri[i];
  89.             if (i < ri.length - 1) {
  90.                 url += ",";
  91.             }
  92.         }
  93.         return url;
  94.     }
  95.  
  96.     function makeXhrQuery(url) {
  97.         var xhr = new XMLHttpRequest();
  98.         xhr.open('GET', url, false);
  99.         xhr.send(null);
  100.         return $.parseJSON(xhr.response);
  101.     }
  102.  
  103.     function getNamesForEmptyResponses(rai, resp) {
  104.         for (var rid in rai) {
  105.             if (rai.hasOwnProperty(rid) && resp[rid] == "") {
  106.                 resp[rid] = $.parseJSON('{"name": "' + rai[rid][0].innerHTML + '"}');
  107.             }
  108.         }
  109.         return resp;
  110.     }
  111.  
  112.     function getKeys(obj) {
  113.         var keys = [];
  114.         for (var key in obj) {
  115.             keys.push(key);
  116.         }
  117.         return keys;
  118.     }
  119.  
  120.     function apply_template(hit_data) {
  121.         var txt = TEMPLATE;
  122.  
  123.         var vars = ['title', 'requester', 'requesterId', 'description', 'reward', 'qualifications', 'link', 'time', 'hits_available', 'to_stuff', 'to_text', 'adfly'];
  124.  
  125.         var a = document.getElementsByTagName('a');
  126.         var rai = getRequesterAnchorsAndIds(a);
  127.         var url = buildXhrUrl(rai);
  128.         var resp = makeXhrQuery(url);
  129.         resp = getNamesForEmptyResponses(rai, resp);
  130.         //var toText = "[list]";
  131.         var toText = "";
  132.         var toStuff = "";
  133.         var toData = "";
  134.         var numResp = resp[hit_data["requesterId"]].reviews;
  135.         if (resp[hit_data["requesterId"]].attrs == null) {
  136.             toStuff = " No TO ";
  137.             toText = " No TO ";
  138.                       
  139.         }
  140.         else {
  141.             for (var key in resp[hit_data["requesterId"]].attrs) {
  142.                 //toText += "\n[*]"+key+": "+resp[hit_data["requesterId"]].attrs[key]+"\n";
  143.                 var i = 0;
  144.                 var color = "green";
  145.                 var name = key;
  146.                 var num = Math.floor(resp[hit_data["requesterId"]].attrs[key]);
  147.                
  148.                 toText += " "+Number(resp[hit_data["requesterId"]].attrs[key]).toFixed(2)+" "+name;
  149.                 toData += resp[hit_data["requesterId"]].attrs[key] + ",";
  150.             }
  151.             //toText += "[/list]";
  152.             toText += (txt.indexOf('{to_stuff}') >= 0 ? "" : "\nNumber of Responses: "+numResp+"\n[URL=\"http://turkopticon.differenceengines.com/report?requester[amzn_id]=" + hit_data['requesterId'] + "&requester[amzn_name]=" + hit_data['requester'] + "\"](Submit a new TO rating for this requester)[/URL]");
  153.             toStuff = '\n[img]http://data.istrack.in/turkopticon.php?data=' + toData.slice(0,-1) + '[/img]';
  154.             toStuff += "\nNumber of Responses: "+numResp;
  155.            
  156.         }
  157.  
  158.         for (var i = 0; i < vars.length; i++) {
  159.             t = new RegExp('\{' + vars[i] + '\}', 'g');
  160.             if (vars[i] == "to_stuff") {
  161.                 txt = txt.replace(t, toStuff);
  162.             }
  163.             else if (vars[i] == "to_text"){
  164.                 txt = txt.replace(t, toText);
  165.             }
  166.             else
  167.                 txt = txt.replace(t, hit_data[vars[i]]);
  168.         }
  169.         textarea.value = txt;
  170.     }
  171.  
  172.     function export_func(item) {
  173.         return function () {
  174.             HIT = item;
  175.             EDIT = false;
  176.             edit_button.textContent = 'Edit Template';
  177.             apply_template(HITS[HIT]);
  178.             div.style.display = 'block';
  179.             textarea.select();
  180.         }
  181.     }
  182.  
  183.     function hide_func(div) {
  184.         return function () {
  185.             if (EDIT == false)
  186.                 div.style.display = 'none';
  187.         }
  188.     }
  189.  
  190.     function default_func() {
  191.         return function () {
  192.             GM_deleteValue('HITExport Template');
  193.             TEMPLATE = DEFAULT_TEMPLATE;
  194.             EDIT = false;
  195.             edit_button.textContent = 'Edit Template';
  196.             apply_template(HITS[HIT]);
  197.         }
  198.     }
  199.  
  200.  
  201.     function edit_func() {
  202.         return function () {
  203.             if (EDIT == true) {
  204.                 EDIT = false;
  205.                 TEMPLATE = textarea.value;
  206.                 edit_button.textContent = 'Edit Template';
  207.                 apply_template(HITS[HIT]);
  208.             }
  209.             else {
  210.                 EDIT = true;
  211.                 edit_button.textContent = 'Show Changes';
  212.                 save_button.disabled = false;
  213.                 textarea.value = TEMPLATE;
  214.             }
  215.         }
  216.     }
  217.  
  218.     function easy_func() {
  219.         return function () {
  220.             var input = prompt("Please enter your adfly easy link, or leave blank if you don't have one.");
  221.             if (input.substring(input.length - 1) != "/")
  222.                 input += "/";
  223.             EASYLINK = input;
  224.             GM_setValue('HITExport Easylink', EASYLINK);
  225.             var url = EASYLINK + hit_data["link"];
  226.             hit_data["adfly"] = url;
  227.             apply_template(hit_data);
  228.         }
  229.     }
  230.  
  231.     function save_func() {
  232.         return function () {
  233.             if (EDIT)
  234.                 TEMPLATE = textarea.value;
  235.             GM_setValue('HITExport Template', TEMPLATE);
  236.         }
  237.     }
  238.  
  239.     for (var item = 0; item < 10; item++) {
  240.         var tooltip = document.getElementById('requester.tooltip--' + item);
  241.         if (tooltip == null)
  242.             break; // no need to continue
  243.         var titleElement = document.getElementById('capsule' + item + '-0');
  244.         var requesterId = tooltip.parentNode.parentNode.getElementsByTagName('a');
  245.  
  246.         var hit_data = {};
  247.         hit_data.title = titleElement.textContent.trim();
  248.  
  249.         for (var i = 0; i < requesterId.length; i++) {
  250.             if (requesterId[i].href.match(/requesterId=/)) {
  251.                 hit_data.requesterId = get_requester_id(requesterId[i].href);
  252.                 hit_data.requester = requesterId[i].textContent.trim();
  253.                 break;
  254.             }
  255.         }
  256.  
  257.         hit_data.description = document.getElementById('description.tooltip--' + item).parentNode.parentNode.childNodes[3].textContent.trim();
  258.         hit_data.reward = document.getElementById('reward.tooltip--' + item).parentNode.parentNode.childNodes[3].textContent.trim();
  259.         hit_data.time = document.getElementById('duration_to_complete.tooltip--' + item).parentNode.parentNode.childNodes[3].textContent.trim();
  260.         hit_data.hits_available = document.getElementById('number_of_hits.tooltip--' + item).parentNode.parentNode.childNodes[3].textContent.trim();
  261.         //hit_data.to_stuff = toStuff;
  262.  
  263.         var linkElements = titleElement.parentNode.parentNode.getElementsByTagName('a');
  264.  
  265.         if (linkElements != null)
  266.             for (var i = 0; i < linkElements.length; i++) {
  267.                 if (linkElements[i] != null && linkElements[i].textContent == 'View a HIT in this group') {
  268.                     var url = EASYLINK + linkElements[i].href;
  269.                     hit_data.adfly = url;
  270.                     hit_data.link = linkElements[i].href;
  271.                     break;
  272.                 }
  273.             }
  274.  
  275.         var qElements = document.getElementById('qualificationsRequired.tooltip--' + item).parentNode.parentNode.parentNode.getElementsByTagName('tr');
  276.  
  277.         var qualifications = [];
  278.         for (var i = 1; i < qElements.length; i++) {
  279.             qualifications.push(qElements[i].childNodes[1].textContent.trim().replace(/\s+/g, ' '));
  280.         }
  281.         hit_data.qualifications = (qualifications.join(', ') ? qualifications.join(', ') : "None");
  282.  
  283.     HITS[item] = hit_data;
  284.   
  285.     button = document.createElement('button');
  286.     button.textContent = 'MTW';
  287.     button.title = 'Export this HIT description as MTW formatted text';
  288.  
  289.     button.style.height = '14px';
  290.     button.style.width = '30px';
  291.     button.style.fontSize = '8px';
  292.     button.style.border = '1px solid';
  293.     button.style.padding = '2px';
  294.     button.style.backgroundColor = 'transparent';
  295.  
  296.     button.addEventListener("click", export_func(item), false);
  297.     titleElement.parentNode.appendChild(button);
  298.   }
  299.  
  300.   var div = document.createElement('div');
  301.   var textarea = document.createElement('textarea');
  302.   var div2 = document.createElement('label');
  303.  
  304.   div.style.position = 'fixed';
  305.   div.style.width = '500px';
  306.   div.style.height = '235px';
  307.   div.style.left = '50%';
  308.   div.style.right = '50%';
  309.   div.style.margin = '-250px 0px 0px -250px';
  310.   div.style.top = '300px';
  311.   div.style.padding = '5px';
  312.   div.style.border = '2px';
  313.   div.style.backgroundColor = '#be2c2a';
  314.   div.style.color = 'white';
  315.   div.style.zIndex = '100';
  316.  
  317.   textarea.style.padding = '2px';
  318.   textarea.style.width = '500px';
  319.   textarea.style.height = '200px';
  320.   textarea.title = '{title}\n{requester}\n{requesterId}\n{description}\n{reward}\n{qualifications}\n{link}\n{time}\n{hits_available}';
  321.  
  322.   div.textContent = 'Press Ctrl+C to copy to clipboard. Click textarea to close';
  323.   div.style.fontSize = '12px';
  324.   div.appendChild(textarea);
  325.   div2.style.position = 'fixed';
  326.   div2.style.right = '230px';
  327.   div2.style.fontSize = '9px';
  328.  
  329.   var edit_button = document.createElement('button');
  330.   var save_button = document.createElement('button');
  331.   var default_button = document.createElement('button');
  332.  
  333.   edit_button.textContent = 'Edit Template';
  334.   edit_button.setAttribute('id', 'edit_button');
  335.   edit_button.style.height = '18px';
  336.   edit_button.style.width = '100px';
  337.   edit_button.style.fontSize = '10px';
  338.   edit_button.style.paddingLeft = '3px';
  339.   edit_button.style.paddingRight = '3px';
  340.   edit_button.style.backgroundColor = 'white';
  341.      
  342.   save_button.textContent = 'Save Template';
  343.   save_button.setAttribute('id', 'save_button');
  344.   save_button.style.height = '18px';
  345.   save_button.style.width = '100px';
  346.   save_button.style.fontSize = '10px';
  347.   save_button.style.paddingLeft = '3px';
  348.   save_button.style.paddingRight = '3px';
  349.   save_button.style.backgroundColor = 'white';
  350.   save_button.style.marginLeft = '5px';
  351.  
  352.   default_button.textContent = ' D ';
  353.   default_button.setAttribute('id', 'default_button');
  354.   default_button.style.height = '18px';
  355.   default_button.style.width = '20px';
  356.   default_button.style.fontSize = '10px';
  357.   default_button.style.paddingLeft = '3px';
  358.   default_button.style.paddingRight = '3px';
  359.   default_button.style.backgroundColor = 'white';
  360.   default_button.style.marginLeft = '5px';
  361.   default_button.title = 'Return default template';
  362.  
  363.       
  364.   div.appendChild(edit_button);
  365.   div.appendChild(save_button);
  366.   div.appendChild(default_button);
  367.   save_button.disabled = true;
  368.  
  369.   div.appendChild(div2);
  370.   div.style.display = 'none';
  371.   textarea.addEventListener("click", hide_func(div), false);
  372.   edit_button.addEventListener("click", edit_func(), false);
  373.   save_button.addEventListener("click", save_func(), false);
  374.   default_button.addEventListener("click", default_func(), false);
  375.   document.body.insertBefore(div,document.body.firstChild);
  376. })();