☰

AO3 Review + Last Chapter Shortcut + Kudos-sortable Bookmarks

Adds shortcuts for last chapter and a floaty review box, sorts bookmarks by kudos (slow) and allows filter by complete only, download link to listing

  1. // ==UserScript==
  2. // @name         AO3 Review + Last Chapter Shortcut + Kudos-sortable Bookmarks
  3. // @namespace    saxamaphone
  4. // @version      2.2
  5. // @description  Adds shortcuts for last chapter and a floaty review box, sorts bookmarks by kudos (slow) and allows filter by complete only, download link to listing
  6. // @author       You
  7. // @match        http://archiveofourown.org/*
  8. // @match        https://archiveofourown.org/*
  9. // @grant        none
  10. // ==/UserScript==
  11.  
  12. // Change here to pick what filetype you want the default download to be
  13. var sTypeWanted = 'epub';
  14.  
  15. var oTypeMapping = {
  16.     'mobi': 1,
  17.     'epub': 2,
  18.     'pdf': 3,
  19.     'html': 4
  20. };
  21.  
  22. // From http://stackoverflow.com/a/1909997/584004
  23. (function (jQuery, undefined) {
  24.     jQuery.fn.getCursorPosition = function() {
  25.         var el = jQuery(this).get(0);
  26.         var pos = 0;
  27.         if('selectionStart' in el) {
  28.             pos = el.selectionStart;
  29.         } else if('selection' in document) {
  30.             el.focus();
  31.             var Sel = document.selection.createRange();
  32.             var SelLength = document.selection.createRange().text.length;
  33.             Sel.moveStart('character', -el.value.length);
  34.             pos = Sel.text.length - SelLength;
  35.         }
  36.         return pos;
  37.     };
  38. })(jQuery);
  39.  
  40. // From http://stackoverflow.com/a/841121/584004
  41. (function (jQuery, undefined) {
  42.     jQuery.fn.selectRange = function(start, end) {
  43.         if(end === undefined) {
  44.             end = start;
  45.         }
  46.         return this.each(function() {
  47.             if('selectionStart' in this) {
  48.                 this.selectionStart = start;
  49.                 this.selectionEnd = end;
  50.             } else if(this.setSelectionRange) {
  51.                 this.setSelectionRange(start, end);
  52.             } else if(this.createTextRange) {
  53.                 var range = this.createTextRange();
  54.                 range.collapse(true);
  55.                 range.moveEnd('character', end);
  56.                 range.moveStart('character', start);
  57.                 range.select();
  58.             }
  59.         });
  60.     };
  61. })(jQuery);
  62.  
  63. // From http://stackoverflow.com/questions/11582512/how-to-get-url-parameters-with-javascript/11582513#11582513, modified to allow [] in params
  64. function getURLParameter(name) {
  65.   return decodeURIComponent((new RegExp('[?|&]' + name + '=' + '([^&;]+?)(&|#|;|$)').exec(location.search.replace(/\[/g, '%5B').replace(/\]/g, '%5D')) || [null, ''])[1].replace(/\+/g, '%20')) || null;
  66. }
  67.  
  68. function getStoryId()
  69. {
  70.     var aMatch = window.location.pathname.match(/works\/(\d+)/);
  71.     if(aMatch !== null)
  72.         return aMatch[1];
  73.     else
  74.         return jQuery('#chapter_index li form').attr('action').match(/works\/(\d+)/)[1];
  75. }
  76.  
  77. function getBookmarks(sNextPath, aBookmarks, oDeferred) {
  78.     jQuery.get(sNextPath, function(oData) {
  79.         aBookmarks = jQuery.merge(aBookmarks, jQuery(oData).find('li.bookmark'));
  80.         if(jQuery(oData).find('.next a').length)
  81.             getBookmarks(jQuery(oData).find('.next').first().find('a').attr('href'), aBookmarks, oDeferred);
  82.         else
  83.             oDeferred.resolve();
  84.     });
  85. }
  86.  
  87. jQuery(window).ready(function() {
  88.     // Process bookmarks first because of extra sorting steps. Once this is done, handle everything else
  89.     var oBookmarksProcessed = jQuery.Deferred();
  90.     
  91.     // If on the bookmarks page, add option to sort by kudos
  92.     if(window.location.pathname.indexOf('/bookmarks') != -1)
  93.     {
  94.         // Wait to handle the bookmarks after they're loaded
  95.         var oBookmarksLoaded = jQuery.Deferred();
  96.         
  97.         var bKudos = false, bComplete = false;
  98.         
  99.         // Add options for Kudos sorting and Complete works only
  100.         jQuery('#bookmark_search_sort_column').append('<option value="kudos_count">Kudos</option>');
  101.         jQuery('#bookmark_search_with_notes').parent().after('<dt>Status</dt><dd><input id="work_search_complete" name="work_search[complete]" type="checkbox" value="1"/><label for="work_search_complete">Complete only</label></dd>');
  102.         
  103.         if(getURLParameter('bookmark_search%5Bsort_column%5D') == 'kudos_count')
  104.         {
  105.             jQuery('#bookmark_search_sort_column').val('kudos_count');
  106.             bKudos = true;
  107.         }
  108.         
  109.         if(getURLParameter('work_search%5Bcomplete%5D') == '1')
  110.         {
  111.             jQuery('#work_search_complete').attr('checked', 'checked');
  112.             bComplete = true;
  113.         }
  114.         
  115.         // If either option has been selected, we perform our own process
  116.         if(bKudos || bComplete)
  117.         {
  118.             // Get bookmarks, this takes at least a few seconds so we have to wait for that to finish
  119.             var aBookmarks = [];
  120.             getBookmarks(window.location.href.replace(/&page=\d+/, ''), aBookmarks, oBookmarksLoaded);
  121.             
  122.             jQuery.when(oBookmarksLoaded).done(function () {
  123.                 if(bKudos)
  124.                 {
  125.                     aBookmarks.sort(function(oA, oB) {
  126.                         return (parseInt(jQuery(oB).find('dd.kudos').find('a').html()) || 0) - (parseInt(jQuery(oA).find('dd.kudos').find('a').html()) || 0);
  127.                     });
  128.                 }
  129.                 
  130.                 if(bComplete)
  131.                 {
  132.                     jQuery.each(aBookmarks, function(iArrayIndex) {
  133.                         var sChapters = jQuery(this).find('dd.chapters').html();
  134.                         if(sChapters !== undefined)
  135.                         {
  136.                             var aChapters = sChapters.split('\/');
  137.                             if(aChapters[0] != aChapters[1])
  138.                                 aBookmarks.splice(iArrayIndex, 1);
  139.                         }
  140.                         else if (jQuery(this).find('.stats').length === 0)
  141.                             aBookmarks.splice(iArrayIndex, 1);
  142.                     });
  143.                 }
  144.  
  145.                 var iPage = getURLParameter('page');
  146.                 if(iPage === null)
  147.                     iPage = 1;
  148.  
  149.                 jQuery('li.bookmark').remove();
  150.  
  151.                 var iIndex;
  152.                 var iNumBookmarks = aBookmarks.length;
  153.                 for(iIndex = (iPage-1) * 20; iIndex < (iPage*20) && iIndex < iNumBookmarks; iIndex++)
  154.                 {
  155.                     jQuery('ol.bookmark').append(aBookmarks[iIndex]);
  156.                 }
  157.                 
  158.                 // If bookmarks are limited by Complete, change the number displayed
  159.                 if(bComplete)
  160.                 {
  161.                     var sPrevHeading = jQuery('h2.heading').html();
  162.                     jQuery('h2.heading').html(sPrevHeading.replace(/\d+ - \d+ of \d+/, (iPage-1)*20+1 + ' - ' + iIndex + ' of ' + aBookmarks.length));
  163.                     
  164.                     // Repaginate if necessary
  165.                     var iFinalPage = jQuery('ol.pagination').first().find('li').not('.previous, .next').last().text();
  166.                     var iNewFinalPage = Math.ceil(iNumBookmarks/20);
  167.                     if(iFinalPage > iNewFinalPage)
  168.                     {
  169.                         // Rules for AO3 pagination are way too complicated for me to bother replicating, so just going to remove extra pages
  170.                         var aPageLinks = jQuery('ol.pagination').first().find('li');
  171.                         jQuery('ol.pagination').find('li a').each(function () {
  172.                             if(jQuery.isNumeric(jQuery(this).text()) && jQuery(this).text() > iNewFinalPage) 
  173.                                 jQuery(this).parent().remove();
  174.                         });
  175.                         
  176.                         // Deactivate the last Next link if necessary
  177.                         if(iPage == iNewFinalPage)
  178.                            jQuery('ol.pagination').find('li.next').html('<li class="next" title="next"><span class="disabled">Next →</span></li>');
  179.                     }
  180.                 }
  181.                 
  182.                 oBookmarksProcessed.resolve();
  183.             });
  184.         }
  185.         else
  186.             oBookmarksProcessed.resolve();
  187.     }
  188.     else
  189.         oBookmarksProcessed.resolve();
  190.     
  191.     jQuery.when(oBookmarksProcessed).done(function() {
  192.         // Check if you're on a story or a list
  193.         // If not a story page, presume an index page (tags, collections, author, bookmarks, series) and process each work individually, add last chapter link to the end
  194.         if(jQuery('.header h4.heading').length)
  195.         {
  196.             // Near as I can figure, the best way of identifying actual stories in an index page is with the h4 tag with class 'heading' within a list of type 'header' 
  197.             jQuery('.header h4.heading').each(function() {
  198.                 var sStoryPath = jQuery(this).find('a').first().attr('href');
  199.                 var oHeader = this;
  200.  
  201.                 // If link is from collections, get proper link
  202.                 var aMatch = sStoryPath.match(/works\/(\d+)/);
  203.                 if(aMatch !== null)
  204.                 {
  205.                     var iStoryId = aMatch[1];
  206. console.log('hi');
  207.                     // Access first chapter of story to get last chapter and download links
  208.                     jQuery.get('https://archiveofourown.org/works/' + iStoryId, function(oData) {
  209.                         console.log(oData);
  210.                         var iLastChapterId = jQuery(oData).find('#selected_id option').last().val();
  211.                         jQuery(oHeader).append(' <a href="/works/' + iStoryId + '/chapters/' + iLastChapterId +'" title="Jump to last chapter">»</a>');
  212.                         
  213.                         // Use the chosen filetype from the beginning
  214.                         var sDownloadLink = jQuery(oData).find('.download ul li:nth-child(' + oTypeMapping[sTypeWanted] + ') a').attr('href');
  215.                         console.log('link: '+sDownloadLink);
  216.                         jQuery(oHeader).append(' <a href="' + sDownloadLink + '" title="Download work">↡</a>');
  217.                     }).fail(function() {
  218.                         console.log('failed');
  219.                     });
  220.                 }
  221.             });
  222.         }
  223.         // Review box and last chapter buttons are story-specific
  224.         else if(jQuery('ul.work'))
  225.         {
  226.             // HTML to define layout of popup box
  227.             // Include x button to close box
  228.             var sHtml = '<p class="close actions" id="close_floaty"><a aria-label="cancel" style="display: inline-block;">×</a></p>';
  229.             // Button to insert highlighted text and for a help list
  230.             sHtml += '<ul class="actions" style="float: left; margin-top: 10px;"><li id="insert_floaty_text"><a>Insert</a></li><li id="pop_up_review_tips"><a>Review Tips</a></li></ul>';
  231.             // Textarea
  232.             sHtml += '<textarea style="margin: 5px; width: 99%;" id="floaty_textarea"></textarea>';
  233.  
  234.             // Create popup box
  235.             jQuery("<div/>", {
  236.                 id: "reviewTextArea",
  237.                 width:600, // Change for dimensions
  238.                 height:300, // Change for dimensions
  239.                 css: {
  240.                     backgroundColor:"#ffffff",
  241.                     opacity: 0.75,
  242.                     border: "thin solid black",
  243.                     display: "inline-block",
  244.                     "padding-right": 10,
  245.                     position: "fixed",
  246.                     top: 150,
  247.                     right: 5
  248.                 },
  249.                 html: sHtml
  250.             }).resizable().draggable().appendTo("body");
  251.  
  252.             // Hide the popup box by default (comment out line below if you want it to always appear by adding // before it)
  253.             jQuery('#reviewTextArea').hide();
  254.  
  255.             // To close the box
  256.             jQuery('#close_floaty').click(function() {
  257.                 jQuery('#reviewTextArea').hide();
  258.             });
  259.  
  260.             // Anything you type in the box gets inserted into the real comment box below
  261.             jQuery('#floaty_textarea').on('input', function() {
  262.                 jQuery('.comment_form').val(jQuery('#floaty_textarea').val());
  263.             });
  264.  
  265.             // Add Float review box button to the top
  266.             jQuery('ul.work').prepend('<li id="floaty_review_box"><a>Floaty Review Box</a></li>');
  267.  
  268.             // If the above button is clicked, display the review box
  269.             jQuery('#floaty_review_box').click(function() {
  270.                 jQuery('#reviewTextArea').show();
  271.             });
  272.  
  273.             // Insert highlighted/selected text into textarea when Insert button is clicked
  274.             jQuery('#insert_floaty_text').click(function() {
  275.                 var sInitialText = jQuery('#floaty_textarea').val();
  276.                 var iPosition = jQuery('#floaty_textarea').getCursorPosition();
  277.  
  278.                 var sHighlightedText = window.getSelection().toString();
  279.  
  280.                 var sNewText = sInitialText.substr(0, iPosition) + '<i>"' + sHighlightedText + '"</i>\n' + sInitialText.substr(iPosition);
  281.                 jQuery('#floaty_textarea').val(sNewText);
  282.                 jQuery('#floaty_textarea').focus();
  283.                 jQuery('#floaty_textarea').selectRange(iPosition+sHighlightedText.length+10);
  284.  
  285.                 // Copy into real comment box
  286.                 jQuery('.comment_form').val(jQuery('#floaty_textarea').val());
  287.             });
  288.             
  289.             // Create the review tips box
  290.             sReviewTipsHtml = '<p class="close actions" id="close_review_tips"><a aria-label="cancel" style="display: inline-block;">×</a></p>' + 
  291.                     'Writers will love any love you give them. If you&#39;re looking for things to help jumpstart a review, there are lots of different things you could focus on.<br />' + 
  292.                     '<ul><li>Quotes you liked</li><li>Scenes you liked</li><li>What&#39;s your feeling at the end of the chapter (did it move you?)</li><li>What are you most looking forward to next?</li>' +
  293.                     '<li>Do you have any predictions for the next chapters you want to share?</li><li>Did this chapter give you any questions you can&#39;t wait to find out the answers for?</li>' +
  294.                     '<li>How would you describe the fic to a friend if you were recommending it?</li><li>Is there something unique about the story that you like?</li><li>Does the author have a style that really works for you?</li>' + 
  295.                     '<li>Did the author leave any comments in the notes that said what they wanted feedback on?</li>' + 
  296.                     '<li>Even if all you have are &quot;incoherent screams of delight&quot;, and can&#39;t come up with a real comment at the moment, authors love to hear that as well</li></ul>';
  297.             jQuery("<div/>", {
  298.                 id: "reviewTips",
  299.                 width:600, // Change for dimensions
  300.                 height:300, // Change for dimensions
  301.                 css: {
  302.                     backgroundColor:"#ffffff",
  303.                     border: "thin solid black",
  304.                     'font-size': '80%',
  305.                     padding: '10px 10px 0 10px',
  306.                     position: "fixed",
  307.                     top: 150,
  308.                     right: 620
  309.                 },
  310.                 html: sReviewTipsHtml
  311.             }).resizable().draggable().appendTo("body");
  312.             jQuery('#reviewTips li').css('list-style', 'circle inside none');
  313.             jQuery('#reviewTips').hide();
  314.             
  315.             // Pop up list of review tips
  316.             jQuery('#pop_up_review_tips').click(function() {
  317.                 jQuery('#reviewTips').show();
  318.             });
  319.             
  320.             jQuery('#close_review_tips').click(function() {
  321.                 jQuery('#reviewTips').hide();
  322.             });
  323.  
  324.             // Before adding button for Last Chapter, make sure we're not on the last (or only) chapter already
  325.             if(jQuery('.next').length)
  326.             {
  327.                 // Add button for Last Chapter
  328.                 jQuery('ul.work').prepend('<li id="go_to_last_chap"><a>Last Chapter</a></li>');
  329.  
  330.                 // If the above button is clicked, go to last chapter
  331.                 jQuery('#go_to_last_chap').click(function() {
  332.                     window.location.href = '/works/' + getStoryId() + '/chapters/' + jQuery('#selected_id option').last().val();
  333.                 });
  334.             }
  335.  
  336.             // Adding a First Chapter button
  337.             if(jQuery('.previous').length)
  338.             {
  339.                 // Add button for First Chapter
  340.                 jQuery('ul.work').prepend('<li id="go_to_first_chap"><a>First Chapter</a></li>');
  341.  
  342.                 // If the above button is clicked, go to first chapter
  343.                 jQuery('#go_to_first_chap').click(function() {
  344.                     window.location.href = '/works/' + getStoryId();
  345.                 });
  346.             }
  347.         }
  348.     });
  349. });