PretendYoureXyzzy/WebContent/js/cah.app.js

/*
 * Copyright (c) 2012-2018, Andy Janata
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are permitted
 * provided that the following conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright notice, this list of conditions
 *   and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice, this list of
 *   conditions and the following disclaimer in the documentation and/or other materials provided
 *   with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * Main application for Pretend You're Xyzzy. This only has to handle the initial nickname
 * registration, the chat box, the logout button, and resizing the window. It should probably be
 * split up into multiple files.
 * 
 * @author Andy Janata (ajanata@socialgamer.net)
 */

$(document).ready(function() {
  // Initialize the logger (i.e. the global chat tab) before anything needs it.
  cah.log.init();

  // see if we already exist on the server so we can resume
  cah.Ajax.build(cah.$.AjaxOperation.FIRST_LOAD).run();

  if ($.cookie("nickname")) {
    $("#nickname").val($.cookie("nickname"));
  }
  $("#nicknameconfirm").click(nicknameconfirm_click);
  $("#nickname").keyup(nickname_keyup);
  $("#nickname").focus();
  if (document.location.protocol == "https:" || cah.INSECURE_ID_ALLOWED) {
    $("#idcode").prop("disabled", false);
    // re-use existing handler
    $("#idcode").keyup(nickname_keyup);
  }

  $(".chat", $("#tab-global")).keyup(chat_keyup($(".chat_submit", $("#tab-global"))));
  $(".chat_submit", $("#tab-global")).click(chatsubmit_click(null, $("#tab-global")));

  // TODO: have some sort of mechanism to alert the server that we have unloaded the page, but
  // have not expressed an interest in being cleared out yet.
  // $(window).bind("beforeunload", window_beforeunload);
  $("#logout").click(logout_click);

  cah.Preferences.load();

  $("#tabs").tabs();
  $("#button-global").click();

  if ($.browser.mozilla) {
    // Firefox sucks.
    $("body").css("font-size", "12px");
  }

  $(window).resize(app_resize);
  app_resize();
});

$(window).focus(function() {
  cah.windowActive = true;
  if (cah.missedGameListRefresh) {
    cah.GameList.instance.update();
  }
});

$(window).blur(function() {
  cah.windowActive = false;
});

/**
 * Handle a key up event in the nick box. If the key was enter, try to register with the server.
 * 
 * @param {jQuery.Event}
 *          e
 */
function nickname_keyup(e) {
  if (e.which == 13) {
    $("#nicknameconfirm").click();
    e.preventDefault();
  }
}

/**
 * Handle a click event on the set nickname box. Try to register with the server.
 */
function nicknameconfirm_click() {
  var nickname = $.trim($("#nickname").val());
  cah.setCookie("nickname", nickname);
  var builder = cah.Ajax.build(cah.$.AjaxOperation.REGISTER).withNickname(nickname);
  var idCode = $.trim($("#idcode").val());
  if (idCode) {
    builder.withIdCode(idCode);
  }
  if (!cah.noPersistentId && cah.persistentId) {
    builder.withPersistentId(cah.persistentId);
  }
  builder.run();
}

/**
 * Handle a key up event in the chat box. If the key was enter, send the message to the server.
 * 
 * @param {jQuery.HTMLButtonElement}
 *          submitButton Submit button for the chat box.
 */
function chat_keyup(submitButton) {
  return function(e) {
    if (e.which == 13) {
      $(submitButton).click();
      e.preventDefault();
    }
  };
}

/**
 * Generate a click handler for the chat submit button. This parses the line for any /-commands,
 * then sends the request to the server.
 * 
 * @param {number}
 *          game_id Game ID to use in AJAX requests, or null for global chat
 * @param {jQuery.HTMLDivElement}
 *          parent_element Parent element, which contains one text-input-box element of class
 *          "chat", which will be used to source the data.
 */
function chatsubmit_click(game_id, parent_element) {
  return function() {
    var ajax = null;

    var text = $.trim($(".chat", parent_element).val());
    if (text == "") {
      return;
    }
    var cmd = '';
    if ('/' == text.substring(0, 1)) {
      cmd = text.substring(1, text.indexOf(' ') >= 0 ? text.indexOf(' ') : undefined);
      if (text.indexOf(' ') >= 0) {
        text = text.substring(text.indexOf(' ') + 1);
      } else {
        text = '';
      }
    }
    switch (cmd) {
      // TODO support an /ignore command
      case '':
        if (game_id !== null) {
          ajax = cah.Ajax.build(cah.$.AjaxOperation.GAME_CHAT).withGameId(game_id);
        } else {
          ajax = cah.Ajax.build(cah.$.AjaxOperation.CHAT);
        }
        ajax = ajax.withEmote(false).withMessage(text);
        var clazz = '';
        if (cah.sigil == cah.$.Sigil.ADMIN) {
          clazz = 'admin';
        }
        cah.log.status_with_game(game_id, "<" + cah.sigil + cah.nickname + "> " + text, clazz,
            false, cah.log.getTitleForIdCode(cah.idcode));
        break;
      case 'me':
        if (game_id !== null) {
          ajax = cah.Ajax.build(cah.$.AjaxOperation.GAME_CHAT).withGameId(game_id);
        } else {
          ajax = cah.Ajax.build(cah.$.AjaxOperation.CHAT);
        }
        ajax = ajax.withEmote(true).withMessage(text);
        var clazz = '';
        if (cah.sigil == cah.$.Sigil.ADMIN) {
          clazz = 'admin';
        }
        cah.log.status_with_game(game_id, "* " + cah.sigil + cah.nickname + " " + text, clazz,
            false, cah.log.getTitleForIdCode(cah.idcode));
        break;
      case 'wall':
        ajax = cah.Ajax.build(cah.$.AjaxOperation.CHAT).withWall(true).withMessage(text);
        break;
      case 'kick':
        ajax = cah.Ajax.build(cah.$.AjaxOperation.KICK).withNickname(text.split(' ')[0]);
        break;
      case 'ban':
        // this could also be an IP address
        ajax = cah.Ajax.build(cah.$.AjaxOperation.BAN).withNickname(text.split(' ')[0]);
        break;
      case 'sync':
        if (game_id !== null) {
          var game = cah.currentGames[game_id];
          if (game) {
            game.removeAllCards();
          }
          ajax = cah.Ajax.build(cah.$.AjaxOperation.GET_CARDS).withGameId(game_id);
        } else {
          cah.log.error("This command only works in a game.");
        }
        break;
      case 'score':
        ajax = cah.Ajax.build(cah.$.AjaxOperation.SCORE).withMessage(text);
        if (game_id != null) {
          ajax = ajax.withGameId(game_id);
        }
        break;
      case 'names':
        ajax = cah.Ajax.build(cah.$.AjaxOperation.NAMES);
        break;
      case 'addcardcast':
        if (game_id !== null) {
          ajax = cah.Ajax.build(cah.$.AjaxOperation.CARDCAST_ADD_CARDSET).withCardcastId(
              text.split(' ')[0]).withGameId(game_id);
        } else {
          cah.log.error("This command only works in a game.");
        }
        break;
      case 'removecardcast':
        if (game_id !== null) {
          ajax = cah.Ajax.build(cah.$.AjaxOperation.CARDCAST_REMOVE_CARDSET).withCardcastId(
              text.split(' ')[0]).withGameId(game_id);
        } else {
          cah.log.error("This command only works in a game.");
        }
        break;
      case 'listcardcast':
        if (game_id !== null) {
          ajax = cah.Ajax.build(cah.$.AjaxOperation.CARDCAST_LIST_CARDSETS).withGameId(game_id);
        } else {
          cah.log.error("This command only works in a game.");
        }
        break;
      case 'whois':
        ajax = cah.Ajax.build(cah.$.AjaxOperation.WHOIS).withNickname(text.split(' ')[0]);
        // so we can show it in the right place; the server ignores this
        if (game_id !== null) {
          ajax = ajax.withGameId(game_id);
        }
        break;
      default:
        cah.log.error("Invalid command.");
    }

    if (ajax) {
      ajax.run();
    }

    $(".chat", parent_element).val("");
    $(".chat", parent_element).focus();
  };
}

/**
 * Handle a click event on the log out button. Tell the server to log us out.
 */
function logout_click() {
  if (confirm("Are you sure you wish to log out?")) {
    cah.Ajax.build(cah.$.AjaxOperation.LOG_OUT).run();
    cah.updateHash('');
  }
}

/**
 * Handle a click event on the preferences button. Shows the preferences modal dialog.
 */
function preferences_click() {
  $("#preferences_dialog").dialog({
    modal : true,
    buttons : {
      Ok : function() {
        save_preferences();
        $(this).dialog("close");
      }
    }
  });
}

function load_preferences() {
  // FIXME remove these after making sure everything calls the new way.
  debugger;
  cah.Preferences.load();
}

function save_preferences() {
  // FIXME remove these after making sure everything calls the new way.
  debugger;
  cah.Preferences.save();
}

function apply_preferences() {
  // FIXME remove these after making sure everything calls the new way.
  debugger;
  cah.Preferences.apply();
}

/**
 * Add selected items from sourceList to destList, ignoring duplicates.
 */
cah.transferItems = function(sourceListId, destListId, idPrefix) {
  cah.transferItems(sourceListId, destListId, idPrefix, function(a, b) {
    return Number(a.value) - Number(b.value);
  });
};

cah.transferItems = function(sourceListId, destListId, idPrefix, sortFunc) {
  $('#' + sourceListId + ' option').filter(':selected').each(function() {
    var existing = $('#' + idPrefix + '_' + this.value);
    if (existing.length == 0) {
      cah.addItem(destListId, this.value, this.text, idPrefix);
    }
  });
  $('#' + destListId + ' option').sort(sortFunc).appendTo('#' + destListId);

  cah.removeItems(sourceListId);
};

/**
 * Add an item to a list.
 * 
 * @param listId
 *          {String} Id of the select element.
 * @param value
 *          {String} Value attribute of the item to insert into the list.
 * @param text
 *          {String} The display text to insert into the list.
 * @param idPrefix
 *          {String} The prefix for the id of the item to insert into the list.
 */
cah.addItem = function(listId, value, text, idPrefix) {
  $('#' + listId).append(
      '<option value="' + value + '" id="' + idPrefix + '_' + value + '">' + text + '</option>');
};

/**
 * Remove selected items from list.
 * 
 * @param listId
 *          {String} Id of the list from which to remove selected items.
 */
cah.removeItems = function(listId) {
  $('#' + listId + ' option').filter(':selected').each(function() {
    this.parentElement.removeChild(this);
  });
};

/**
 * Set a cookie.
 * 
 * @param {String}
 *          name The name of the cookie.
 * @param {Any}
 *          value The value of the cookie.
 */
cah.setCookie = function(name, value) {
  return $.cookie(name, value, {
    domain : cah.COOKIE_DOMAIN,
    expires : 365
  });
};

/**
 * Remove a cookie.
 * 
 * @param {String}
 *          name The name of the cookie.
 */
cah.removeCookie = function(name) {
  $.removeCookie(name, {
    domain : cah.COOKIE_DOMAIN
  });
};

/**
 * Get a cookie.
 * 
 * @param {String}
 *          name The name of the cookie.
 * @returns The value of the cookie, or {@code undefined} if the cookie is not set.
 */
cah.getCookie = function(name) {
  return $.cookie(name);
};

/**
 * Handle a window resize event. Resize the chat and info areas to fit vertically and horizontally.
 * This was tested extensively in Chrome. It may not be pixel-perfect in other browsers.
 */
function app_resize() {
  var chat = $(".chat", $("#tab-global"));
  var log = cah.log.log;

  var chatWidth = $("#canvas").width() - 257;
  $("#tabs").width(chatWidth + 'px');
  var bottomHeight = $(window).height() - $("#main").height() - $("#menubar").height() - 29;
  $("#bottom").height(bottomHeight);
  $("#info_area").height(bottomHeight);
  $("#tabs").height(bottomHeight);
  $("#tab-preferences").height(bottomHeight - 45);
  $("#tab-gamelist-filters").height(bottomHeight - 45);

  // global chat
  do_app_resize(chat, log);
  // per-game chats
  for ( var id in cah.currentGames) {
    chat = $(".chat", $("#tab-chat-game_" + id));
    log = $(".log", $("#tab-chat-game_" + id));
    do_app_resize(chat, log);
  }

  // this is ugly and terrible.
  if ($(window).height() < 650) {
    $("body").css("overflow-y", "auto");
  } else {
    $("body").css("overflow-y", "hidden");
  }
}

function do_app_resize(chatElement, logElement) {
  var chatWidth = $("#canvas").width() - 257;
  logElement.width((chatWidth + 2) + 'px');
  chatElement.width((chatWidth - 42) + 'px');
  var bottomHeight = $(window).height() - $("#main").height() - $("#menubar").height() - 29;
  logElement.height(bottomHeight - chatElement.height() - 40);
}

cah.logUserPermalinks = function(data) {
  var linkMsg = "";
  if (cah.$.AjaxResponse.SESSION_PERMALINK in data) {
    linkMsg += "<a href='" + data[cah.$.AjaxResponse.SESSION_PERMALINK]
        + "'rel='noopener' target='_blank'>Permanent link to games you play this session.</a> ";
  }
  if (cah.$.AjaxResponse.USER_PERMALINK in data && !cah.noPersistentId) {
    linkMsg += "<a href='"
        + data[cah.$.AjaxResponse.USER_PERMALINK]
        + "'rel='noopener' target='_blank'>Permanent link to every time you've played on this device.</a> ";
  }
  if ("" != linkMsg) {
    cah.log.status(linkMsg, undefined, true);
  }
}