]> git.sesse.net Git - remoteglot/blobdiff - www/js/remoteglot.js
Minor clarifications with board highlights.
[remoteglot] / www / js / remoteglot.js
index d34b4d6bf8767675952e892f264e11641159abcf..b2b80ebc672c4a9c6b4ce558469c9963817bdccc 100644 (file)
@@ -1,5 +1,22 @@
 (function() {
 
+/**
+ * Version of this script. If the server returns a version larger than
+ * this, it is a sign we should reload to upgrade ourselves.
+ *
+ * @type {Number}
+ * @const
+ * @private */
+var SCRIPT_VERSION = 2015062104;
+
+/**
+ * The current backend URL.
+ *
+ * @type {!string}
+ * @private
+ */
+var backend_url = "/analysis.pl";
+
 /** @type {window.ChessBoard} @private */
 var board = null;
 
@@ -20,6 +37,18 @@ var current_analysis_data = null;
  */
 var displayed_analysis_data = null;
 
+/**
+ * Games currently in progress, if any.
+ *
+ * @type {?Array.<{
+ *      name: string,
+ *      url: string,
+ *      id: string,
+ * }>}
+ * @private
+ */
+var current_games = null;
+
 /** @type {Array.<{
  *      from_col: number,
  *      from_row: number,
@@ -59,7 +88,9 @@ var highlight_from = undefined;
 /** @type {!string|undefined} @private */
 var highlight_to = undefined;
 
-/** @type {?jQuery} @private */
+/** The HTML object of the move currently being highlighted (in red).
+ * @type {?jQuery}
+ * @private */
 var highlighted_move = null;
 
 /** @type {?number} @private */
@@ -94,7 +125,13 @@ var fen = null;
  * }} DisplayLine
  */
 
-/** @type {Array.<DisplayLine>}
+/** All PVs that we currently know of.
+ *
+ * Element 0 is history (or null if no history).
+ * Element 1 is current main PV.
+ * All remaining elements are refutation lines (multi-PV).
+ *
+ * @type {Array.<DisplayLine>}
  * @private
  */
 var display_lines = [];
@@ -108,6 +145,32 @@ var current_display_line_is_history = false;
 /** @type {?number} @private */
 var current_display_move = null;
 
+/**
+ * The current backend request to get main analysis (not history), if any,
+ * so that we can abort it.
+ *
+ * @type {?jqXHR}
+ * @private
+ */
+var current_analysis_xhr = null;
+
+/**
+ * The current timer to fire off a request to get main analysis (not history),
+ * if any, so that we can abort it.
+ *
+ * @type {?Number}
+ * @private
+ */
+var current_analysis_request_timer = null;
+
+/**
+ * The current backend request to get historic data, if any.
+ *
+ * @type {?jqXHR}
+ * @private
+ */
+var current_historic_xhr = null;
+
 var supports_html5_storage = function() {
        try {
                return 'localStorage' in window && window['localStorage'] !== null;
@@ -131,26 +194,43 @@ var get_unique = function() {
 }
 
 var request_update = function() {
-       $.ajax({
-               url: "/analysis.pl?ims=" + ims + "&unique=" + unique
+       current_analysis_request_timer = null;
+
+       current_analysis_xhr = $.ajax({
+               url: backend_url + "?ims=" + ims + "&unique=" + unique
        }).done(function(data, textstatus, xhr) {
                sync_server_clock(xhr.getResponseHeader('Date'));
                ims = xhr.getResponseHeader('X-RGLM');
                var num_viewers = xhr.getResponseHeader('X-RGNV');
-               possibly_play_sound(current_analysis_data, data);
+               var new_data;
                if (Array.isArray(data)) {
-                       current_analysis_data = JSON_delta.patch(current_analysis_data, data);
+                       new_data = JSON.parse(JSON.stringify(current_analysis_data));
+                       JSON_delta.patch(new_data, data);
                } else {
-                       current_analysis_data = data;
+                       new_data = data;
+               }
+
+               var minimum_version = xhr.getResponseHeader('X-RGMV');
+               if (minimum_version && minimum_version > SCRIPT_VERSION) {
+                       // Upgrade to latest version with a force-reload.
+                       location.reload(true);
                }
+
+               possibly_play_sound(current_analysis_data, new_data);
+               current_analysis_data = new_data;
                update_board(current_analysis_data, displayed_analysis_data);
                update_num_viewers(num_viewers);
 
                // Next update.
-               setTimeout(function() { request_update(); }, 100);
-       }).fail(function() {
-               // Wait ten seconds, then try again.
-               setTimeout(function() { request_update(); }, 10000);
+               current_analysis_request_timer = setTimeout(function() { request_update(); }, 100);
+       }).fail(function(jqXHR, textStatus, errorThrown) {
+               if (textStatus === "abort") {
+                       // Aborted because we are switching backends. Abandon and don't retry,
+                       // because another one is already started for us.
+               } else {
+                       // Backend error or similar. Wait ten seconds, then try again.
+                       current_analysis_request_timer = setTimeout(function() { request_update(); }, 10000);
+               }
        });
 }
 
@@ -192,7 +272,9 @@ var sync_server_clock = function(server_date_string) {
 var clear_arrows = function() {
        for (var i = 0; i < arrows.length; ++i) {
                if (arrows[i].svg) {
-                       arrows[i].svg.parentElement.removeChild(arrows[i].svg);
+                       if (arrows[i].svg.parentElement) {
+                               arrows[i].svg.parentElement.removeChild(arrows[i].svg);
+                       }
                        delete arrows[i].svg;
                }
        }
@@ -307,7 +389,9 @@ var point_from_end = function(x1, y1, x2, y2, t, u) {
 
 var position_arrow = function(arrow) {
        if (arrow.svg) {
-               arrow.svg.parentElement.removeChild(arrow.svg);
+               if (arrow.svg.parentElement) {
+                       arrow.svg.parentElement.removeChild(arrow.svg);
+               }
                delete arrow.svg;
        }
        if (current_display_line !== null && !current_display_line_is_history) {
@@ -543,7 +627,10 @@ var print_pv = function(line_num, pretty_pv, move_num, toplay, opt_limit, opt_sh
        return pv;
 }
 
-var update_highlight = function() {
+/** Update the highlighted to/from squares on the board.
+ * Based on the global "highlight_from" and "highlight_to" variables.
+ */
+var update_board_highlight = function() {
        $("#board").find('.square-55d63').removeClass('nonuglyhighlight');
        if ((current_display_line === null || current_display_line_is_history) &&
            highlight_from !== undefined && highlight_to !== undefined) {
@@ -573,11 +660,16 @@ var collapse_history = function(truncate_history) {
 }
 window['collapse_history'] = collapse_history;
 
+/** Update the HTML display of multi-PV from the global "refutation_lines".
+ *
+ * Also recreates the global "display_lines".
+ */
 var update_refutation_lines = function() {
        if (fen === null) {
                return;
        }
        if (display_lines.length > 2) {
+               // Truncate so that only the history and PV is left.
                display_lines = [ display_lines[0], display_lines[1] ];
        }
 
@@ -634,6 +726,9 @@ var update_refutation_lines = function() {
 }
 
 /**
+ * Create a Chess.js board object, containing the given position plus the given moves,
+ * up to the given limit.
+ *
  * @param {?string} fen
  * @param {Array.<string>} moves
  * @param {number} last_move
@@ -655,6 +750,51 @@ var chess_from = function(fen, moves, last_move) {
        return hiddenboard;
 }
 
+var update_game_list = function(games) {
+       $("#games").text("");
+       if (games === null) {
+               return;
+       }
+
+       var games_div = document.getElementById('games');
+       for (var game_num = 0; game_num < games.length; ++game_num) {
+               var game = games[game_num];
+               var game_span = document.createElement("span");
+               game_span.setAttribute("class", "game");
+
+               var game_name = document.createTextNode(game['name']);
+               if (game['url'] === backend_url) {
+                       game_span.appendChild(game_name);
+               } else {
+                       var game_a = document.createElement("a");
+                       game_a.setAttribute("href", "#" + game['id']);
+                       game_a.appendChild(game_name);
+                       game_span.appendChild(game_a);
+               }
+               games_div.appendChild(game_span);
+       }
+}
+
+/**
+ * Try to find a running game that matches with the current hash,
+ * and switch to it if we're not already displaying it.
+ */
+var possibly_switch_game_from_hash = function() {
+       if (current_games === null) {
+               return;
+       }
+
+       var hash = window.location.hash.replace(/^#/,'');
+       for (var i = 0; i < current_games.length; ++i) {
+               if (current_games[i]['id'] === hash) {
+                       if (backend_url !== current_games[i]['url']) {
+                               switch_backend(current_games[i]['url']);
+                       }
+                       return;
+               }
+       }
+}
+
 /**
  * @param {Object} data
  * @param {?Object} display_data
@@ -674,6 +814,16 @@ var update_board = function(current_data, display_data) {
        }
        update_history();
 
+       // Games currently in progress, if any.
+       if (current_data['games']) {
+               current_games = current_data['games'];
+               possibly_switch_game_from_hash();
+               update_game_list(current_data['games']);
+       } else {
+               current_games = null;
+               update_game_list(null);
+       }
+
        // The headline. Names are always fetched from current_data;
        // the rest can depend a bit.
        var headline;
@@ -685,14 +835,57 @@ var update_board = function(current_data, display_data) {
                headline = 'Analysis';
        }
 
+       // Credits, where applicable. Note that we don't want the footer to change a lot
+       // when e.g. viewing history, so if any of these changed during the game,
+       // use the current one still.
+       if (current_data['using_lomonosov']) {
+               $("#lomonosov").show();
+       } else {
+               $("#lomonosov").hide();
+       }
+
+       // Credits: The engine name/version.
+       if (current_data['engine'] && current_data['engine']['name'] !== null) {
+               $("#engineid").text(current_data['engine']['name']);
+       }
+
+       // Credits: The engine URL.
+       if (current_data['engine'] && current_data['engine']['url']) {
+               $("#engineid").attr("href", current_data['engine']['url']);
+       } else {
+               $("#engineid").removeAttr("href");
+       }
+
+       // Credits: Engine details.
+       if (current_data['engine'] && current_data['engine']['details']) {
+               $("#enginedetails").text(" (" + current_data['engine']['details'] + ")");
+       } else {
+               $("#enginedetails").text("");
+       }
+
+       // Credits: Move source, possibly with URL.
+       if (current_data['move_source'] && current_data['move_source_url']) {
+               $("#movesource").text("Moves provided by ");
+               var movesource_a = document.createElement("a");
+               movesource_a.setAttribute("href", current_data['move_source_url']);
+               var movesource_text = document.createTextNode(current_data['move_source']);
+               movesource_a.appendChild(movesource_text);
+               var movesource_period = document.createTextNode(".");
+               document.getElementById("movesource").appendChild(movesource_a);
+               document.getElementById("movesource").appendChild(movesource_period);
+       } else if (current_data['move_source']) {
+               $("#movesource").text("Moves provided by " + current_data['move_source'] + ".");
+       } else {
+               $("#movesource").text("");
+       }
+
        var last_move;
        if (display_data) {
                // Displaying some non-current position, pick out the last move
                // from the history. This will work even if the fetch failed.
-               last_move = format_move_with_number(
+               last_move = format_halfmove_with_number(
                        current_display_line.pretty_pv[current_display_move],
-                       Math.floor((current_display_move + 1) / 2) + 1,
-                       (current_display_move % 2 == 1));
+                       current_display_move + 1);
                headline += ' after ' + last_move;
        } else if (data['position']['last_move'] !== 'none') {
                last_move = format_move_with_number(
@@ -736,7 +929,7 @@ var update_board = function(current_data, display_data) {
        } else {
                highlight_from = highlight_to = undefined;
        }
-       update_highlight();
+       update_board_highlight();
 
        if (data['failed']) {
                $("#score").text("No analysis for this move");
@@ -754,11 +947,6 @@ var update_board = function(current_data, display_data) {
 
        update_clock();
 
-       // The engine id.
-       if (data['id'] && data['id']['name'] !== null) {
-               $("#engineid").text(data['id']['name']);
-       }
-
        // The score.
        if (data['score'] !== null) {
                $("#score").text(data['score']);
@@ -850,6 +1038,69 @@ var update_board = function(current_data, display_data) {
        toplay = data['position']['toplay'];
        refutation_lines = data['refutation_lines'];
        update_refutation_lines();
+
+       // Update the sparkline last, since its size depends on how everything else reflowed.
+       update_sparkline(data);
+}
+
+var update_sparkline = function(data) {
+       if (data && data['score_history']) {
+               var first_move_num = undefined;
+               for (var halfmove_num in data['score_history']) {
+                       halfmove_num = parseInt(halfmove_num);
+                       if (first_move_num === undefined || halfmove_num < first_move_num) {
+                               first_move_num = halfmove_num;
+                       }
+               }
+               if (first_move_num !== undefined) {
+                       var last_move_num = data['position']['move_num'] * 2 - 3;
+                       if (data['position']['toplay'] === 'B') {
+                               ++last_move_num;
+                       }
+
+                       // Possibly truncate some moves if we don't have enough width.
+                       // FIXME: Sometimes width() for #scorecontainer (and by extent,
+                       // #scoresparkcontainer) on Chrome for mobile seems to start off
+                       // at something very small, and then suddenly snap back into place.
+                       // Figure out why.
+                       var max_moves = Math.floor($("#scoresparkcontainer").width() / 5) - 5;
+                       if (last_move_num - first_move_num > max_moves) {
+                               first_move_num = last_move_num - max_moves;
+                       }
+
+                       var min_score = -100;
+                       var max_score = 100;
+                       var last_score = null;
+                       var scores = [];
+                       for (var halfmove_num = first_move_num; halfmove_num <= last_move_num; ++halfmove_num) {
+                               if (data['score_history'][halfmove_num]) {
+                                       var score = data['score_history'][halfmove_num][0];
+                                       if (score < min_score) min_score = score;
+                                       if (score > max_score) max_score = score;
+                                       last_score = data['score_history'][halfmove_num][0];
+                               }
+                               scores.push(last_score);
+                       }
+                       if (data['plot_score']) {
+                               scores.push(data['plot_score']);
+                       }
+                       // FIXME: at some widths, calling sparkline() seems to push
+                       // #scorecontainer under the board.
+                       $("#scorespark").sparkline(scores, {
+                               type: 'bar',
+                               zeroColor: 'gray',
+                               chartRangeMin: min_score,
+                               chartRangeMax: max_score,
+                               tooltipFormatter: function(sparkline, options, fields) {
+                                       return format_tooltip(data, fields[0].offset + first_move_num);
+                               }
+                       });
+               } else {
+                       $("#scorespark").text("");
+               }
+       } else {
+               $("#scorespark").text("");
+       }
 }
 
 /**
@@ -1008,6 +1259,46 @@ var format_move_with_number = function(move, move_num, white_to_play) {
        return ret;
 }
 
+/**
+ * @param {string} move
+ * @param {Number} halfmove_num
+ */
+var format_halfmove_with_number = function(move, halfmove_num) {
+       return format_move_with_number(
+               move,
+               Math.floor(halfmove_num / 2) + 1,
+               halfmove_num % 2 == 0);
+}
+
+/**
+ * @param {Object} data
+ * @param {Number} halfmove_num
+ */
+var format_tooltip = function(data, halfmove_num) {
+       if (data['score_history'][halfmove_num] ||
+           halfmove_num === data['position']['pretty_history'].length) {
+               var move;
+               var short_score;
+               if (halfmove_num === data['position']['pretty_history'].length) {
+                       move = data['position']['last_move'];
+                       short_score = data['short_score'];
+               } else {
+                       move = data['position']['pretty_history'][halfmove_num];
+                       short_score = data['score_history'][halfmove_num][1];
+               }
+               var move_with_number = format_halfmove_with_number(move, halfmove_num);
+
+               return "After " + move_with_number + ": " + short_score;
+       } else {
+               for (var i = halfmove_num; i --> 0; ) {
+                       if (data['score_history'][i]) {
+                               var move = data['position']['pretty_history'][i];
+                               return "[Analysis kept from " + format_halfmove_with_number(move, i) + "]";
+                       }
+               }
+       }
+}
+
 /**
  * @param {boolean} sort_by_score
  */
@@ -1051,7 +1342,7 @@ var show_line = function(line_num, move_num) {
 
        update_historic_analysis();
        update_displayed_line();
-       update_highlight();
+       update_board_highlight();
        redraw_arrows();
 }
 window['show_line'] = show_line;
@@ -1088,14 +1379,19 @@ var update_historic_analysis = function() {
        var filename = "/history/move" + (current_display_move + 1) + "-" +
                hiddenboard.fen().replace(/ /g, '_').replace(/\//g, '-') + ".json";
 
-       $.ajax({
+       current_historic_xhr = $.ajax({
                url: filename
        }).done(function(data, textstatus, xhr) {
                displayed_analysis_data = data;
                update_board(current_analysis_data, displayed_analysis_data);
-       }).fail(function() {
-               displayed_analysis_data = {'failed': true};
-               update_board(current_analysis_data, displayed_analysis_data);
+       }).fail(function(jqXHR, textStatus, errorThrown) {
+               if (textStatus === "abort") {
+                       // Aborted because we are switching backends. Don't do anything;
+                       // we will already have been cleared.
+               } else {
+                       displayed_analysis_data = {'failed': true};
+                       update_board(current_analysis_data, displayed_analysis_data);
+               }
        });
 }
 
@@ -1194,6 +1490,38 @@ var set_sound = function(param_enable_sound) {
 }
 window['set_sound'] = set_sound;
 
+/**
+ * @param {string} new_backend_url
+ */
+var switch_backend = function(new_backend_url) {
+       // Stop looking at historic data.
+       current_display_line = null;
+       current_display_move = null;
+       displayed_analysis_data = null;
+       if (current_historic_xhr) {
+               current_historic_xhr.abort();
+       }
+
+       // If we already have a backend response going, abort it.
+       if (current_analysis_xhr) {
+               current_analysis_xhr.abort();
+       }
+
+       // Otherwise, we should have a timer going to start a new one.
+       // Kill that, too.
+       if (current_analysis_request_timer) {
+               clearTimeout(current_analysis_request_timer);
+               current_analysis_request_timer = null;
+       }
+
+       // Request an immediate fetch with the new backend.
+       backend_url = new_backend_url;
+       current_analysis_data = null;
+       ims = 0;
+       request_update();
+}
+window['switch_backend'] = switch_backend;
+
 var init = function() {
        unique = get_unique();
 
@@ -1215,7 +1543,8 @@ var init = function() {
        request_update();
        $(window).resize(function() {
                board.resize();
-               update_highlight();
+               update_sparkline(displayed_analysis_data || current_analysis_data);
+               update_board_highlight();
                redraw_arrows();
        });
        $(window).keyup(function(event) {
@@ -1225,6 +1554,7 @@ var init = function() {
                        prev_move();
                }
        });
+       window.addEventListener('hashchange', possibly_switch_game_from_hash, false);
 };
 $(document).ready(init);