]> git.sesse.net Git - remoteglot/blobdiff - www/js/remoteglot.js
Minor clarifications with board highlights.
[remoteglot] / www / js / remoteglot.js
index 6844428dc8ee617151e3266c77f8629fbb22a5c5..b2b80ebc672c4a9c6b4ce558469c9963817bdccc 100644 (file)
@@ -7,7 +7,15 @@
  * @type {Number}
  * @const
  * @private */
-var SCRIPT_VERSION = 2015062103;
+var SCRIPT_VERSION = 2015062104;
+
+/**
+ * The current backend URL.
+ *
+ * @type {!string}
+ * @private
+ */
+var backend_url = "/analysis.pl";
 
 /** @type {window.ChessBoard} @private */
 var board = null;
@@ -29,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,
@@ -68,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 */
@@ -103,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 = [];
@@ -117,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;
@@ -140,8 +194,10 @@ 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');
@@ -166,10 +222,15 @@ var request_update = function() {
                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);
+               }
        });
 }
 
@@ -211,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;
                }
        }
@@ -326,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) {
@@ -562,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) {
@@ -592,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] ];
        }
 
@@ -653,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
@@ -674,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
@@ -693,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;
@@ -704,6 +835,50 @@ 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
@@ -754,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");
@@ -772,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']);
@@ -1172,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;
@@ -1209,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);
+               }
        });
 }
 
@@ -1315,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();
 
@@ -1337,7 +1544,7 @@ var init = function() {
        $(window).resize(function() {
                board.resize();
                update_sparkline(displayed_analysis_data || current_analysis_data);
-               update_highlight();
+               update_board_highlight();
                redraw_arrows();
        });
        $(window).keyup(function(event) {
@@ -1347,6 +1554,7 @@ var init = function() {
                        prev_move();
                }
        });
+       window.addEventListener('hashchange', possibly_switch_game_from_hash, false);
 };
 $(document).ready(init);