path: root/fg21sim/webui/static/js/products.js

/**
 * Copyright (c) 2016 Weitian LI <liweitianux@live.com>
 * MIT license
 *
 * Web UI of "fg21sim"
 * Manage and manipulate the simulation products
 */

"use strict";


/**
 * Reset the manifest table
 */
var resetManifestTable = function () {
  var table = $("table#products-manifest");
  // Empty table caption, head, and body
  table.children().empty();
};


/**
 * Compose the manifest table cell element for each product
 *
 * @param {Object} data - The metadata of the product
 * @param {Boolean} localhost - Whether the connection from localhost
 */
var makeManifestTableCell = function (data, localhost) {
  var cell = $("<td>").addClass("product");
  cell.data("localhost", localhost)
    .data("frequency", data.frequency)
    .data("healpix-path", data.healpix.path)
    .data("healpix-size", data.healpix.size)
    .data("healpix-md5", data.healpix.md5);
  cell.append($("<span>").attr("title", "Show product information")
              .addClass("info btn btn-small fa fa-info-circle"));
  cell.append($("<span>").attr("title", "Download HEALPix map")
              .data("ptype", "healpix")
              .addClass("healpix healpix-download btn btn-small fa fa-file"));
  if (data.hpx) {
    cell.data("hpx-image", true)
      .data("hpx-path", data.hpx.path)
      .data("hpx-size", data.hpx.size)
      .data("hpx-md5", data.hpx.md5);
    cell.append($("<span>").attr("title", localhost
                                 ? "Open HPX FITS image"
                                 : "Download HPX FITS image")
                .data("ptype", "hpx")
                .addClass("hpx")
                .addClass(localhost ? "hpx-open" : "hpx-download")
                .addClass("btn btn-small fa fa-image"));
  } else {
    cell.data("hpx-image", false);
    cell.append($("<span>").attr("title", "Generate HPX image")
                .addClass("hpx hpx-convert btn btn-small fa fa-image"));
  }
  return cell;
};


/**
 * Load the products manifest into table
 *
 * @param {Object} manifest - The products manifest data
 * @param {Boolean} [localhost=false] - Whether the connection from localhost
 */
var loadManifestToTable = function (manifest, localhost) {
  localhost = typeof localhost !== "undefined" ? localhost : false;

  var frequency, components, table, row, cell, tbody;
  frequency = manifest.frequency;
  components = Object.keys(manifest);
  // Remove the `frequency` element
  components.splice(components.indexOf("frequency"), 1);

  // Reset the table first
  resetManifestTable();

  table = $("table#products-manifest");
  // Table head
  row = $("<tr>");
  row.append($("<th scope='col'>").text("Frequency (" + frequency.unit + ")"));
  components.forEach(function (compID) {
    row.append($("<th scope='col'>").text(compID).data("compID", compID));
  });
  table.children("thead").append(row);

  // Table body
  tbody = table.children("tbody");
  frequency.id.forEach(function (freqID) {
    // One table row for each frequency
    row = $("<tr>");
    row.append($("<th scope='row'>").addClass("frequency freqid-" + freqID)
              .text(frequency.frequencies[freqID])
              .data("freqID", freqID));
    components.forEach(function (compID) {
      cell = makeManifestTableCell(manifest[compID][freqID], localhost);
      cell.data("compID", compID).data("freqID", freqID);
      row.append(cell);
    });
    tbody.append(row);
  });
};


/**
 * Update the content of one single cell in the manifest table
 *
 * @param {Object} cell - The table cell DOM/jQuery object
 */
var updateManifestTableCell = function (cell, data) {
  cell = $(cell);
  var cell_new = makeManifestTableCell(data, cell.data("localhost"));
  cell_new.data("compID", cell.data("compID"))
    .data("freqID", cell.data("freqID"));
  cell.replaceWith(cell_new);
};


/**
 * Request the server to load the specified products manifest
 *
 * @param {String} url - The URL that handles the "products" AJAX requests.
 * @param {String} manifestfile - The (absolute) path to the manifest file.
 */
var loadServerManifest = function (url, manifestfile) {
  if (typeof manifestfile === "undefined") {
    manifestfile = $("input#products-manifest").val();
  };
  var data = {action: "load", manifestfile: manifestfile};
  return $.postJSON(url, data)
    .fail(function (jqxhr) {
      showModal({
        icon: "times-circle",
        contents: "Failed to load the products manifest!",
        code: jqxhr.status,
        reason: jqxhr.statusText
      });
    });
};


/**
 * Save the current products manifest to file
 *
 * @param {Boolean} [clobber=false] - Whether overwrite the existing file.
 */
var saveServerManifest = function (url, clobber) {
  clobber = typeof clobber !== "undefined" ? clobber : false;
  var outfile = $("input#products-manifest").val();
  var data = {
    action: "save",
    outfile: outfile,
    clobber: clobber
  };
  return $.postJSON(url, data)
    .done(function () {
      showModal({
        icon: "check-circle",
        contents: "Current products manifest saved."
      });
    })
    .fail(function (jqxhr) {
      showModal({
        icon: "times-circle",
        contents: "Failed to save current products manifest!",
        code: jqxhr.status,
        reason: jqxhr.statusText
      });
    });
};


/**
 * Get the products manifest from server
 */
var getServerManifest = function (url) {
  return $.getJSONUncached(url)
    .fail(function (jqxhr) {
      showModal({
        icon: "times-circle",
        contents: "Failed to load the products manifest!",
        code: jqxhr.status,
        reason: jqxhr.statusText
      });
    });
};


/**
 * Locate the command in the `$PATH` on the server, which checks
 * whether the command can be called.
 *
 * @param {String} cmd - The command name or path.
 */
var whichExecutable = function (url, cmd) {
  return $.getJSONUncached(url, {action: "which", cmd: JSON.stringify(cmd)});
};


/**
 * Reset the products manifest on both the server side and client side
 */
var resetManifest = function (url) {
  return $.postJSON(url, {action: "reset"})
    .done(function () {
      resetManifestTable();
      showModal({
        icon: "check-circle",
        contents: "Reset the products manifest."
      });
    })
    .fail(function (jqxhr) {
      showModal({
        icon: "times-circle",
        contents: "Failed to reset the products manifest on server!",
        code: jqxhr.status,
        reason: jqxhr.statusText
      });
    });
};


/**
 * Convert a product from HEALPix map to HPX projected FITS image
 *
 * @param {String} compID - ID of the foreground component
 * @param {Integer} freqID - Frequency ID
 */
var convertProductHPX = function (url, compID, freqID) {
  return $.postJSON(url, {action: "convert", compID: compID, freqID: freqID})
    .fail(function (jqxhr) {
      showModal({
        icon: "times-circle",
        contents: "Failed to convert the HEALPix map to HPX image!",
        code: jqxhr.status,
        reason: jqxhr.statusText
      });
    });
};


/**
 * Open the HPX FITS image of the specified product
 *
 * NOTE: This request is only allowed when using the Web UI on the localhost
 *
 * @param {String} viewer - The command name or path for the FITS viewer.
 */
var openProductHPX = function (url, compID, freqID, viewer) {
  var data = {
    action: "open",
    compID: JSON.stringify(compID),
    freqID: JSON.stringify(freqID),
    viewer: JSON.stringify(viewer)
  };
  return $.getJSONUncached(url, data)
    .fail(function (jqxhr) {
      showModal({
        icon: "times-circle",
        contents: "Failed to open the HPX image!",
        code: jqxhr.status,
        reason: jqxhr.statusText
      });
    });
};


$(document).ready(function () {
  // URL to handle the "products" AJAX requests
  var ajax_url = "/ajax/products";
  // URL to download the products (NOTE the trailing slash "/")
  var download_url = "/products/download/";

  // Update the products manifest file path
  $("#conf-form input[name='workdir'], " +
    "#conf-form input[name='common/manifest']")
    .on("change", function (e) {
      var workdir = $("#conf-form input[name='workdir']").val();
      var manifest = $("#conf-form input[name='output/manifest']").val();
      $("input#products-manifest").val(joinPath(workdir, manifest));
  });

  // Validate the FITS viewer executable on change
  $("input#products-fitsviewer").on("change", function () {
    var target = $(this);
    var cmd = target.val();
    whichExecutable(ajax_url, cmd)
      .done(function (response) {
        target[0].setCustomValidity("");
        target.removeClass("error").data("validity", true);
      })
      .fail(function (jqxhr) {
        target[0].setCustomValidity(jqxhr.statusText);
        target.addClass("error").data("validity", false);
      });
  }).trigger("change");  // Manually trigger the "change" after loading

  // Get and load products manifest into table
  $("#load-products").on("click", function () {
    loadServerManifest(ajax_url)
      .then(function () { return getServerManifest(ajax_url); })
      .done(function (response) {
        console.log("GET products response:", response);
        if ($.isEmptyObject(response.manifest)) {
          showModal({
            icon: "warning",
            contents: "Products manifest not loaded on the server."
          });
        } else {
          loadManifestToTable(response.manifest, response.localhost);
          showModal({
            icon: "check-circle",
            contents: "Loaded products manifest to table."
          });
        }
      });
  });

  // Save current products manifest
  $("#save-products").on("click", function () {
    saveServerManifest(ajax_url, true);
  });

  // Show product information (metadata)
  // NOTE:
  // Since the table cell are dynamically built, so "click" event handler
  // should be bound to the "document" with the proper selector.
  $(document).on("click", "td.product > .info", function () {
    var product = $(this).closest("td");
    var modalData = {
      icon: "info-circle",
      title: ("Product: " + product.data("compID") + " @ " +
              product.data("frequency") + " (#" + product.data("freqID") + ")"),
      contents: [
        ("<strong>HEALPix map:</strong> " + product.data("healpix-path") +
         ", size: " + (product.data("healpix-size")/1024/1024).toFixed(1) +
         " MB, MD5: " + product.data("healpix-md5"))
      ]
    };
    if (product.data("hpx-image")) {
      var p = ("<strong>HPX image:</strong> " + product.data("hpx-path") +
               ", size: " + (product.data("hpx-size")/1024/1024).toFixed(1) +
               " MB, MD5: " + product.data("hpx-md5"));
      modalData.contents.push(p);
    }
    showModal(modalData);
  });

  // Convert HEALPix map of a product to HPX projected FITS image.
  $(document).on("click", "td.product > .hpx.hpx-convert", function () {
    var cell = $(this).closest("td");
    var compID = cell.data("compID");
    var freqID = cell.data("freqID");
    // Replace the icon with a spinner when converting
    $(this).removeClass("fa-image").addClass("fa-spinner fa-pulse")
      .fadeTo("fast", 1.0).css({"font-size": "2em"})
      .attr("title", "Generating HPX image ...");
    convertProductHPX(ajax_url, compID, freqID)
      .done(function (response) {
        updateManifestTableCell(cell, response.data);
        showModal({
          icon: "check-circle",
          contents: "Generated HPX projected FITS image."
        });
      });
  });

  // Open the HPX FITS image
  // NOTE: Only allowed when accessing the Web UI from localhost
  $(document).on("click", "td.product > .hpx.hpx-open", function () {
    var cell = $(this).closest("td");
    var compID = cell.data("compID");
    var freqID = cell.data("freqID");
    var input_viewer = $("input#products-fitsviewer");
    var viewer;
    if (input_viewer.data("validity")) {
      viewer = input_viewer.val();
      openProductHPX(ajax_url, compID, freqID, viewer)
        .done(function (response) {
          showModal({
            icon: "check-circle",
            contents: "Opened HPX FITS image. (PID: " + response.pid + ")"
          });
        });
    } else {
      showModal({
        icon: "times-circle",
        contents: "Invalid name/path for the FITS viewer executable!"
      });
    }
  });

  // Download the HEALPix maps and HPX images
  $(document).on(
    "click",
    ("td.product > .healpix.healpix-download, " +
     "td.product > .hpx.hpx-download"),
    function () {
      var cell = $(this).closest("td");
      var ptype = $(this).data("ptype");
      var filepath = cell.data(ptype + "-path");
      var url = download_url + filepath;
      console.log("Download", ptype, "product at URL:", url);
      // Open the download URL in a new window
      window.open(url, "_blank");
  });
});