Add clock support.
[remoteglot] / www / js / remoteglot.js
index b59c6e4..01fee37 100644 (file)
@@ -65,6 +65,21 @@ var highlighted_move = null;
 /** @type {?number} @private */
 var unique = null;
 
+/** @type {boolean} @private */
+var enable_sound = false;
+
+/**
+ * Our best estimate of how many milliseconds we need to add to 
+ * new Date() to get the true UTC time. Calibrated against the
+ * server clock.
+ *
+ * @type {?number}
+ * @private
+ */
+var client_clock_offset_ms = null;
+
+var clock_timer = null;
+
 /** The current position on the board, represented as a FEN string.
  * @type {?string}
  * @private
@@ -119,8 +134,10 @@ var request_update = function() {
        $.ajax({
                url: "/analysis.pl?ims=" + ims + "&unique=" + unique
        }).done(function(data, textstatus, xhr) {
+               sync_server_clock(xhr.getResponseHeader('Date'));
                ims = xhr.getResponseHeader('X-Remoteglot-Last-Modified');
                var num_viewers = xhr.getResponseHeader('X-Remoteglot-Num-Viewers');
+               possibly_play_sound(current_analysis_data, data);
                current_analysis_data = data;
                update_board(current_analysis_data, displayed_analysis_data);
                update_num_viewers(num_viewers);
@@ -133,6 +150,41 @@ var request_update = function() {
        });
 }
 
+var possibly_play_sound = function(old_data, new_data) {
+       if (!enable_sound) {
+               return;
+       }
+       if (old_data === null) {
+               return;
+       }
+       var ding = document.getElementById('ding');
+       if (ding && ding.play) {
+               if (old_data['position'] && old_data['position']['fen'] &&
+                   new_data['position'] && new_data['position']['fen'] &&
+                   (old_data['position']['fen'] !== new_data['position']['fen'] ||
+                    old_data['position']['move_num'] !== new_data['position']['move_num'])) {
+                       ding.play();
+               }
+       }
+}
+
+/**
+ * @type {!string} server_date_string
+ */
+var sync_server_clock = function(server_date_string) {
+       var server_time_ms = new Date(server_date_string).getTime();
+       var client_time_ms = new Date().getTime();
+       var estimated_offset_ms = server_time_ms - client_time_ms;
+
+       // In order not to let the noise move us too much back and forth
+       // (the server only has one-second resolution anyway), we only
+       // change an existing skew if we are at least five seconds off.
+       if (client_clock_offset_ms === null ||
+           Math.abs(estimated_offset_ms - client_clock_offset_ms) > 5000) {
+               client_clock_offset_ms = estimated_offset_ms;
+       }
+}
+
 var clear_arrows = function() {
        for (var i = 0; i < arrows.length; ++i) {
                if (arrows[i].svg) {
@@ -630,7 +682,7 @@ var update_board = function(current_data, display_data) {
        // The <title> contains a very brief headline.
        var title_elems = [];
        if (data['short_score'] !== undefined && data['short_score'] !== null) {
-               title_elems.push(data['short_score']);
+               title_elems.push(data['short_score'].replace(/^ /, ""));
        }
        if (last_move !== null) {
                title_elems.push(last_move);
@@ -642,17 +694,43 @@ var update_board = function(current_data, display_data) {
                document.title = 'analysis.sesse.net';
        }
 
+       // The last move (shown by highlighting the from and to squares).
+       if (data['position'] && data['position']['last_move_uci']) {
+               highlight_from = data['position']['last_move_uci'].substr(0, 2);
+               highlight_to = data['position']['last_move_uci'].substr(2, 2);
+       } else if (current_display_line_is_history && current_display_move >= 0) {
+               // We don't have historic analysis for this position, but we
+               // can reconstruct what the last move was by just replaying
+               // from the start.
+               var hiddenboard = new Chess();
+               for (var i = 0; i <= current_display_move; ++i) {
+                       hiddenboard.move(current_display_line.pretty_pv[i]);
+               }
+               var moves = hiddenboard.history({ verbose: true });
+               var last_move = moves.pop();
+               highlight_from = last_move.from;
+               highlight_to = last_move.to;
+       } else {
+               highlight_from = highlight_to = undefined;
+       }
+       update_highlight();
+
        if (data['failed']) {
                $("#score").text("No analysis for this move");
                $("#pv").empty();
                $("#searchstats").html("&nbsp;");
                $("#refutationlines").empty();
+               $("#whiteclock").empty();
+               $("#blackclock").empty();
                refutation_lines = [];
                update_refutation_lines();
                clear_arrows();
+               update_displayed_line();
                return;
        }
 
+       update_clock();
+
        // The engine id.
        if (data['id'] && data['id']['name'] !== null) {
                $("#engineid").text(data['id']['name']);
@@ -688,14 +766,6 @@ var update_board = function(current_data, display_data) {
        fen = data['position']['fen'];
        update_displayed_line();
 
-       if (data['position']['last_move_uci']) {
-               highlight_from = data['position']['last_move_uci'].substr(0, 2);
-               highlight_to = data['position']['last_move_uci'].substr(2, 2);
-       } else {
-               highlight_from = highlight_to = undefined;
-       }
-       update_highlight();
-
        // Print the PV.
        $("#pv").html(add_pv(data['position']['fen'], data['pv_pretty'], data['position']['move_num'], data['position']['toplay']));
 
@@ -772,6 +842,93 @@ var update_num_viewers = function(num_viewers) {
        }
 }
 
+var update_clock = function() {
+       clearTimeout(clock_timer);
+
+       var data = displayed_analysis_data || current_analysis_data;
+       if (data['position']) {
+               var result = data['position']['result'];
+               if (result === '1-0') {
+                       $("#whiteclock").text("1");
+                       $("#blackclock").text("0");
+                       return;
+               }
+               if (result === '1/2-1/2') {
+                       $("#whiteclock").text("1/2");
+                       $("#blackclock").text("1/2");
+                       return;
+               }       
+               if (result === '0-1') {
+                       $("#whiteclock").text("0");
+                       $("#blackclock").text("1");
+                       return;
+               }
+       }
+
+       var white_clock = "";
+       var black_clock = "";
+
+       // Static clocks.
+       if (data['position'] &&
+           data['position']['white_clock'] &&
+           data['position']['black_clock']) {
+               white_clock = data['position']['white_clock'];
+               black_clock = data['position']['black_clock'];
+       }
+
+       // Dynamic clock (only one, obviously).
+       var color;
+       if (data['position']['white_clock_target']) {
+               color = "white";
+       } else if (data['position']['black_clock_target']) {
+               color = "black";
+       }
+       if (color) {
+               var now = new Date().getTime() + client_clock_offset_ms;
+               var remaining_ms = data['position'][color + '_clock_target'] * 1000 - now;
+               if (color === "white") {
+                       white_clock = format_clock(remaining_ms);
+               } else {
+                       black_clock = format_clock(remaining_ms);
+               }
+
+               // See when the clock will change next, and update right after that.
+               var next_update_ms = remaining_ms % 1000 + 100;
+               clock_timer = setTimeout(update_clock, next_update_ms);
+       }
+
+       $("#whiteclock").text(white_clock);
+       $("#blackclock").text(black_clock);
+}
+
+/**
+ * @param {Number} remaining_ms
+ */
+var format_clock = function(remaining_ms) {
+       if (remaining_ms <= 0) {
+               return "00:00:00";
+       }
+
+       var remaining = Math.floor(remaining_ms / 1000);
+       var seconds = remaining % 60;
+       remaining = (remaining - seconds) / 60;
+       var minutes = remaining % 60;
+       remaining = (remaining - minutes) / 60;
+       var hours = remaining;
+       return format_2d(hours) + ":" + format_2d(minutes) + ":" + format_2d(seconds);  
+}
+
+/**
+ * @param {Number} x
+ */
+var format_2d = function(x) {
+       if (x >= 10) {
+               return x;
+       } else {
+               return "0" + x;
+       }
+}
+
 /**
  * @param {string} move
  * @param {Number} move_num
@@ -793,6 +950,9 @@ var format_move_with_number = function(move, move_num, white_to_play) {
  */
 var resort_refutation_lines = function(sort_by_score) {
        sort_refutation_lines_by_score = sort_by_score;
+       if (supports_html5_storage()) {
+               localStorage['sort_refutation_lines_by_score'] = sort_by_score ? 1 : 0;
+       }
        update_refutation_lines();
 }
 window['resort_refutation_lines'] = resort_refutation_lines;
@@ -916,9 +1076,47 @@ var update_displayed_line = function() {
        board.position(hiddenboard.fen());
 }
 
+/**
+ * @param {boolean} param_enable_sound
+ */
+var set_sound = function(param_enable_sound) {
+       enable_sound = param_enable_sound;
+       if (enable_sound) {
+               $("#soundon").html("<strong>On</strong>");
+               $("#soundoff").html("<a href=\"javascript:set_sound(false)\">Off</a>");
+
+               // Seemingly at least Firefox prefers MP3 over Opus; tell it otherwise,
+               // and also preload the file since the user has selected audio.
+               var ding = document.getElementById('ding');
+               if (ding && ding.canPlayType && ding.canPlayType('audio/ogg; codecs="opus"') === 'probably') {
+                       ding.src = 'ding.opus';
+                       ding.load();
+               }
+       } else {
+               $("#soundon").html("<a href=\"javascript:set_sound(true)\">On</a>");
+               $("#soundoff").html("<strong>Off</strong>");
+       }
+       if (supports_html5_storage()) {
+               localStorage['enable_sound'] = enable_sound ? 1 : 0;
+       }
+}
+window['set_sound'] = set_sound;
+
 var init = function() {
        unique = get_unique();
 
+       // Load settings from HTML5 local storage if available.
+       if (supports_html5_storage() && localStorage['enable_sound']) {
+               set_sound(parseInt(localStorage['enable_sound']));
+       } else {
+               set_sound(false);
+       }
+       if (supports_html5_storage() && localStorage['sort_refutation_lines_by_score']) {
+               sort_refutation_lines_by_score = parseInt(localStorage['sort_refutation_lines_by_score']);
+       } else {
+               sort_refutation_lines_by_score = true;
+       }
+
        // Create board.
        board = new window.ChessBoard('board', 'start');