psdi-data-conversion 0.0.23__py3-none-any.whl

psdi_data_conversion/static/javascript/psdi-common.js

@@ -0,0 +1,177 @@
+// This file provides common functions related to the PSDI common assets. Most of these are run automatically as
+// appropriate, except the first batch of functions exported below. These are exposed to the user so that they can
+// customise aspects of the common HTML header
+
+const ORIG_TITLE = "$REPLACEME_SITE_TITLE"
+const ORIG_TITLE_LINK = "./"
+
+const DEFAULT_TITLE = "";
+const DEFAULT_TITLE_LINK_TARGET = "./";
+const DEFAULT_HEADER_LINKS_SOURCE = "./header-links.html";
+const DEFAULT_HEADER_SOURCE = "./psdi-common-header.html";
+const DEFAULT_FOOTER_SOURCE = "./psdi-common-footer.html";
+
+let title = DEFAULT_TITLE;
+let useDefaultTitle = true;
+let titleLinkTarget = DEFAULT_TITLE_LINK_TARGET;
+let useDefaultTitleLink = true;
+let headerLinksSource = DEFAULT_HEADER_LINKS_SOURCE;
+let headerSource = DEFAULT_HEADER_SOURCE
+let footerSource = DEFAULT_FOOTER_SOURCE
+
+export function setTitle(s) {
+  // Public function for the user to set the site title that will appear in the header, to the right of the PSDI logo
+  title = s;
+  useDefaultTitle = false;
+}
+
+export function setTitleLinkTarget(s) {
+  // Public function for the user to set the target that clicking on the site title should link to
+  titleLinkTarget = s;
+  useDefaultTitleLink = false;
+}
+
+// Alias for previous name of `setTitleLinkTarget` to maintain backwards compatibility
+export const setBrandLinkTarget = setTitleLinkTarget;
+
+export function setHeaderLinksSource(s) {
+  // Public function to set the name of an HTML file containing the links to appear on the right side of the header
+  // for a given page
+  headerLinksSource = s;
+}
+
+export function setHeaderSource(s) {
+  // Public function to set the name of the header HTML file to be loaded
+  headerSource = s;
+}
+
+export function setFooterSource(s) {
+  // Public function to set the name of the footer HTML file to be loaded
+  footerSource = s;
+}
+
+const LIGHT_MODE = "light";
+const DARK_MODE = "dark";
+
+// Load color mode from session storage and apply it
+let mode = sessionStorage.getItem("mode");
+if (!mode) {
+  mode = LIGHT_MODE;
+}
+document.documentElement.setAttribute("data-theme", mode);
+
+function toggleMode() {
+  let currentMode = document.documentElement.getAttribute("data-theme");
+  let new_mode;
+
+  if (currentMode == DARK_MODE) {
+    new_mode = LIGHT_MODE;
+  } else {
+    new_mode = DARK_MODE;
+  }
+
+  document.documentElement.setAttribute("data-theme", new_mode);
+  sessionStorage.setItem("mode", new_mode);
+}
+
+export function connectModeToggleButton() {
+  // Connect the mode toggle function to the button
+  const lModeToggleButton = document.querySelectorAll(".color-mode-toggle");
+  lModeToggleButton.forEach(function (modeToggleButton) {
+    modeToggleButton.addEventListener("click", toggleMode);
+  });
+}
+
+// Counter for elements that need to be loaded - each we request loading will increment this by 1
+let loadSteps = 0;
+
+function finalizeLoad() {
+  // Decrement the load steps and check if all steps are finished. If so, remove the cover
+  --loadSteps;
+  if (loadSteps <= 0) {
+    $("#cover").hide();
+  }
+}
+
+export function addHeaderLinks() {
+  // We want to load in the links, but preserve the existing mode toggle button alongside them, so this function
+  // handles saving it and re-adding it
+
+  let headerLinksParent = $("#psdi-header .navbar__items--right");
+  let modeToggle = $("#psdi-header .color-mode-toggle");
+
+  headerLinksParent.load(headerLinksSource,
+    function (_response, status, _xhr) {
+      if (status == "error") {
+        headerLinksParent[0].textContent = "ERROR: Could not load header links";
+      }
+      headerLinksParent[0].appendChild(modeToggle[0]);
+      connectModeToggleButton();
+      finalizeLoad();
+    });
+}
+
+$(document).ready(function () {
+
+  // Start fading out the cover over one second as a failsafe in case something goes wrong and it never gets removed
+  $("#cover").fadeOut(1000);
+
+  // Count the elements we'll need to load first, to avoid prematurely removing the cover
+  // We load an element only if it's a pure stub with no children; otherwise we assume it is intended to be used
+  // as-is and not overwritten by a load. If it's intended to be used as a fallback for if we can't load, it can be
+  // assigned the "fallback" class to load if possible despite something existing
+
+  const headerStub = $("#psdi-header");
+  let loadHeader = false;
+  if (headerStub.length > 0 && (headerStub[0].childNodes.length == 0 || headerStub[0].classList.contains("fallback"))) {
+    loadHeader = true;
+    ++loadSteps;
+  }
+
+  const footerStub = $("#psdi-footer");
+  let loadFooter = false;
+  if (footerStub.length > 0 && (footerStub[0].childNodes.length == 0 || footerStub[0].classList.contains("fallback"))) {
+    loadFooter = true;
+    ++loadSteps;
+  }
+
+  // Load only if the header stub has no children
+  if (loadHeader) {
+    $("#psdi-header").load(headerSource,
+      function (_response, status, _xhr) {
+        if (status != "error") {
+          // Check if we should replace the title link by if a value is set, or if the value in the header matches
+          // the original value in the source
+          let titleLinkElement = $("#psdi-header a.navbar__title")[0];
+          if (!useDefaultTitleLink || String(titleLinkElement.href) == ORIG_TITLE_LINK)
+            titleLinkElement.href = titleLinkTarget;
+
+          // Check if we should replace the title by if a value is set, or if the value in the header matches
+          // the original value in the source
+          let titleElement = $("#psdi-header .navbar__title h5")[0];
+          if (!useDefaultTitle || String(titleElement.textContent) == ORIG_TITLE)
+            titleElement.textContent = title;
+          addHeaderLinks();
+        } else {
+          $("#psdi-header")[0].textContent = "ERROR: Could not load page header";
+          connectModeToggleButton();
+          finalizeLoad();
+        }
+      });
+  }
+
+  // Load only if the footer stub has no children
+  if (loadFooter) {
+    $("#psdi-footer").load(footerSource,
+      function (_response, status, _xhr) {
+        if (status == "error") {
+          $("#psdi-footer")[0].textContent = "ERROR: Could not load page footer";
+        }
+        finalizeLoad();
+      });
+  }
+
+  if (loadSteps == 0)
+    finalizeLoad();
+
+});

psdi_data_conversion/static/javascript/report.js

@@ -0,0 +1,381 @@
+/*
+  report.js
+  Version 1.0, 26th June 2024
+
+  This is the JavaScript which makes the report.htm gui work.
+*/
+
+import { getAllFormats, getConverters } from "./data.js";
+import { loadServiceMode } from "./common.js";
+
+var token = "",
+    fromList = new Array(),
+    toList = new Array(),
+    formatList = new Array();
+
+const pageURL = new URL(window.location.toLocaleString());
+
+// If coming to this page from a local version of the app, warn if the user clicks a link in the header, which will
+// take them to another page on the public app
+const originUrlParam = pageURL.searchParams.get('origin');
+const localOrigin = (originUrlParam != null && originUrlParam.toLowerCase() == "local") ? true : false;
+let originAlertDisplayed = false;
+
+if (localOrigin) {
+    $("#psdi-header").click(function (e) {
+        if (originAlertDisplayed) return;
+        alert("WARNING: This is the online, public version of the app, which you arrived at from the local " +
+            "app. Press the back button on your browser to return to the local version, or click \"OK\" on this " +
+            "alert to continue to the public app.");
+        originAlertDisplayed = true;
+    });
+}
+
+// Set the service mode variable for this page so that only appropriate elements are shown
+loadServiceMode();
+
+$(document).ready(function () {
+
+    token = sessionStorage.getItem("token");
+
+    $("#success").css({ display: "none" });
+
+    // Populates the "Convert from" and "Convert to" selection lists
+    getAllFormats().then((allFormats) => {
+        populateList(allFormats, "from");
+        populateList(allFormats, "to");
+        populateList(allFormats, "format");
+    });
+
+    $("#reason").change(display);
+    $("#fromList").click(populateConversionSuccess);
+    $("#toList").click(populateConversionSuccess);
+    $("#formatList").click(populateConversionSuccess);
+    $("#searchTo").keyup(filterOptions);
+    $("#searchFrom").keyup(filterOptions);
+    $("#searchFormats").keyup(filterOptions);
+    $("#resetButton").click(resetAll);
+    $("#resetButton2").click(resetAll);
+    $("#reportButton").click(submitUserInput);
+});
+
+// Included in this file for convenience. When the 'Report' button is clicked, a user's missing conversion report
+// is only sent if the undisplayed conversion success box is empty (i.e., the conversion really is missing)
+function populateConversionSuccess(event) {
+    const selectedText = getSelectedText(this);
+
+    if (this.id == "fromList") {
+        $("#searchFrom").val(selectedText);
+    }
+    else if (this.id == "toList") {
+        $("#searchTo").val(selectedText);
+    }
+    else {
+        $("#searchFormats").val(selectedText);
+    }
+
+    const from_text = $("#searchFrom").val();
+    const to_text = $("#searchTo").val();
+
+    sessionStorage.setItem("in_str", from_text);
+    sessionStorage.setItem("out_str", to_text);
+
+    this.selectionStart = -1;
+    this.selectionEnd = -1;
+    this.blur();
+    emptySuccess();
+    hideConverterDetails();
+    hideOffer();
+
+    try {
+        const in_str = $("#searchFrom").val(), // e.g. "ins: ShelX"
+            in_str_array = in_str.split(": "),
+            in_ext = in_str_array[0],           // e.g. "ins"
+            in_note = in_str_array[1];          // e.g. "ShelX"
+
+        const out_str = $("#searchTo").val(),
+            out_str_array = out_str.split(": "),
+            out_ext = out_str_array[0],
+            out_note = out_str_array[1];
+
+        getConverters(in_ext, in_note, out_ext, out_note).then((converters) => {
+            populateList(converters, "success");
+        });
+    }
+    catch (e) {
+        // Can do without an error message if the 'Conversion options' box remains empty;
+        // however, consider a greyed-out message inside the box (using some of the commented out code below).
+
+        //        const ID_a = getFormat($("#searchFrom").val()),
+        //            ID_b = getFormat($("#searchTo").val());
+
+        //    if (ID_a.toString() != ID_b.toString() && ID_a != "" && ID_b != "") {
+        //          conversionSuccessEmpty();
+        //}
+    }
+}
+
+// Retrieve selected text from the "Conversion success" textarea
+function getSelectedText(el) {
+    const text = el.value;
+    const before = text.substring(0, el.selectionStart);
+    const after = text.substring(el.selectionEnd, text.length);
+
+    el.selectionStart = before.lastIndexOf("\n") >= 0 ? before.lastIndexOf("\n") + 1 : 0;
+    el.selectionEnd = after.indexOf("\n") >= 0 ? el.selectionEnd + after.indexOf("\n") : text.length;
+
+    return el.value.substring(el.selectionStart, el.selectionEnd);
+}
+
+// Hides converter details
+function hideConverterDetails() {
+    $("#converter").css({ display: "none" });
+    $("h3").css({ display: "none" });
+}
+
+// Submits user input
+function submitUserInput() {
+    const from = $("#searchFrom").val(),
+        to = $("#searchTo").val();
+
+    var reason = $("#in").val(),
+        missing = $("#missingFormat").val()
+
+    if (reason.length > 9 && reason.length < 501) {
+        if ($("#reason").val() == "format") {
+            if (missing.length > 1 && missing.length < 101) {
+                submitFeedback({
+                    type: "missingFormat",
+                    missing: missing,
+                    reason: reason
+                });
+            }
+            else {
+                alert("Please enter the missing format (2 to 100 characters).");
+            }
+        }
+        else {
+            if (from != "" && to != "") {
+                if ($("#success option").length == 0) {
+                    submitFeedback({
+                        type: "missingConversion",
+                        from: from,
+                        to: to,
+                        reason: reason
+                    });
+                }
+                else {
+                    alert("At least one converter is capable of carrying out this conversion, therefore your report has not been sent. If you wish to send feedback about this conversion, please click on 'Contact' in the navigation bar.");
+                }
+            }
+            else if (to != "") {
+                alert("Please select 'from' format.");
+            }
+            else if (from != "") {
+                alert("Please select 'to' format.");
+            }
+            else {
+                alert("Please select 'to' and 'from' formats.");
+            }
+        }
+    }
+    else {
+        alert("Please enter a reason, etc. (10 to 500 characters).");
+    }
+}
+
+// Hide Open Babel conversion offer (not required to do anything on this page)
+function hideOffer() { }
+
+// Writes user input to a server-side file
+// $$$$$$$$$$ Retain for now in case logging to file is required for some other purpose $$$$$$$$$$
+//function writeLog(message) {
+//  var jqXHR = $.get(`/data/`, {
+//        'token': token,
+//      'data': message
+//})
+//        .done(response => {
+//          alert("Report received!");
+//    })
+//  .fail(function(e) {
+//    alert("Reporting failed. Please provide feedback by clicking on 'Contact' in the navigation bar.");
+
+//  // For debugging
+//console.log("Error writing to log");
+//            console.log(e.status);
+//          console.log(e.responseText);
+//    })
+//}
+
+// Submit feedback
+function submitFeedback(data) {
+    $.post(`/feedback/`, {
+        'token': token,
+        'data': JSON.stringify(data)
+    })
+        .done(() => {
+            alert("Report received!");
+        })
+        .fail(function (e) {
+            alert("Reporting failed. Please provide feedback by clicking on 'Contact' in the navigation bar.");
+
+            // For debugging
+            console.error("Error submitting feedback", e.status, e.responseText);
+        });
+}
+
+// Only options having user filter input as a substring (case insensitive) are included in the selection list
+function filterOptions(event) {
+    const str = this.value.toLowerCase();
+    var box, list,
+        count = 0,
+        text = "";
+
+    if (this.id == "searchFrom") {
+        box = $("#fromList");
+        list = fromList;
+    }
+    else if (this.id == "searchTo") {
+        box = $("#toList");
+        list = toList;
+    }
+    else {
+        box = $("#formatList");
+        list = formatList;
+    }
+
+    box.children().remove();
+
+    for (var i = 0; i < list.length; i++) {
+        if (list[i].toLowerCase().includes(str)) {
+            box.append($('<option>', { text: list[i] }));
+            count += 1;
+        }
+    }
+
+    if (this.id == "searchFrom") {
+        $("#fromLabel").html("Select format to convert from (" + count + "):");
+    }
+    else if (this.id == "searchTo") {
+        $("#toLabel").html("Select format to convert to (" + count + "):");
+    }
+    else {
+        $("#formatLabel").html("Check that the format is not present in the list. If it is, consider reporting a missing conversion. (" + count + ")");
+    }
+
+    $("#success").prop({ disabled: true });
+    emptySuccess();
+    hideConverterDetails();
+    hideOffer();
+}
+
+// Empties the "Conversion success" textarea
+function emptySuccess() {
+    $("#success").html("");
+}
+
+// Populates a selection list
+function populateList(entries, sel) {
+
+    let rows = [];
+
+    if ((sel === "from") || (sel === "to") || (sel === "format")) {
+
+        rows = entries.map(entry => `${entry.extension}: ${entry.note}`);
+
+    } else if (sel === "success") {
+
+        rows = entries.map(entry => `${entry.name}: ${entry.degree_of_success}`);
+    }
+
+    rows.sort(function (a, b) {
+        return a.toLowerCase().localeCompare(b.toLowerCase());
+    });
+
+    $("#success").prop({ disabled: true });
+
+    for (var i = 0; i < rows.length; i++) {
+        const support = rows[i].substring(0, 10) == "Open Babel" ? " (supported)" : " (unsupported)";
+
+        if (sel == "success") {
+            if (rows.length > 0) {
+                $("#success").prop({ disabled: false });
+            }
+
+            $("#success").append($('<option>', { text: "" + rows[i] + support }));
+        }
+
+        if (sel == "from") {
+            $("#fromList").append($('<option>', { text: rows[i] }));
+            fromList[i] = rows[i] + "\n";
+        }
+        else if (sel == "to") {
+            $("#toList").append($('<option>', { text: rows[i] }));
+            toList[i] = rows[i] + "\n";
+        }
+        else if (sel == "format") {
+            $("#formatList").append($('<option>', { text: rows[i] }));
+            formatList[i] = rows[i] + "\n";
+        }
+    }
+
+    if (sel != "success") {
+        $("#fromLabel").html("Select format to convert from (" + fromList.length + "):");
+        $("#toLabel").html("Select format to convert to (" + toList.length + "):");
+        $("#formatLabel").html("Check that the format is not present in the list. If it is, consider reporting a missing conversion. (" + toList.length + ")");
+    }
+}
+
+// Resets the filtering and format list boxes
+function resetAll() {
+    $("#searchFrom").val("");
+    $("#searchFrom").keyup();
+
+    $("#searchTo").val("");
+    $("#searchTo").keyup();
+
+    $("#searchFormats").val("");
+    $("#searchFormats").keyup();
+}
+
+// Displays format or conversion related content as appropriate
+function display(event) {
+    const selectedText = getSelectedText(this);
+
+    $("#in").val("");
+    $("#missingFormat").val("");
+
+    if (selectedText == "conversion") {
+        $("#in_out_formats").css({ display: "block" });
+        $("#message").css({ display: "inline" });
+
+        $("#userInput").css({ display: "block" });
+
+        $("#formats").css({ display: "none" });
+        $("#missing").css({ display: "none" });
+
+        $("#message").html("Explain why the conversion is required and provide a link to appropriate documentation if possible [max 500 characters].");
+        $("#message1").html("The displayed 'from' and 'to' formats will be automatically submitted with your message.");
+    }
+    else if (selectedText == "format") {
+        $("#formats").css({ display: "block" });
+        $("#missing").css({ display: "block" });
+
+        $("#userInput").css({ display: "block" });
+
+        $("#in_out_formats").css({ display: "none" });
+        $("#message").css({ display: "none" });
+
+        $("#message1").html("Enter details of the file conversions expected for this format and provide a link to appropriate documentation if possible [max 500 characters].");
+    }
+    else {
+        $("#in_out_formats").css({ display: "none" });
+        $("#message").css({ display: "none" });
+
+        $("#formats").css({ display: "none" });
+        $("#missing").css({ display: "none" });
+
+        $("#userInput").css({ display: "none" });
+    }
+}
+

psdi_data_conversion/static/styles/format.css

@@ -0,0 +1,147 @@
+/*
+  format.css
+  Version 1.0, 11th October 2024
+*/
+
+@import url("./psdi-common.css");
+
+/* Forms inherit style from normal content, and make sure content is well away from the edges */
+form {
+  width      : 95%;
+  min-width  : 320px;
+  padding-top: 1rem;
+  align-self : center;
+}
+
+/* Padding for link to converter website. */
+#visit {
+  padding-left: 0.125rem;
+}
+
+/* Width management for select boxes and forms */
+
+.med-width {
+  width: 25rem;
+}
+
+@media (max-width: 25rem) {
+  .med-width {
+    width: 100%
+  }
+}
+
+.large-width {
+  width: 50rem;
+}
+
+@media (max-width: 50rem) {
+  .large-width {
+    width: 100%
+  }
+
+  input.large-width {
+    width: calc(100% - 0.5rem)
+  }
+}
+
+/* Converter details, user input and file conversion initially not displayed. */
+.init-hidden {
+  display: none
+}
+
+/* Buttons that are initially disabled */
+input.button.init-disabled {
+  background-color: var(--psdi-bg-color-secondary);
+  color           : gray
+}
+
+/* Small vertical space. */
+.smallGap {
+  padding: 0.125rem;
+}
+
+/* Medium vertical space. */
+.medGap {
+  padding: 1rem;
+}
+
+/* Large vertical space. */
+.largeGap {
+  padding: 8rem;
+}
+
+/* Grid for textarea label/elements. */
+.access-options {
+  display              : grid;
+  grid-template-columns: repeat(auto-fit, minmax(10rem, 1fr));
+  column-gap           : 2rem;
+}
+
+.access-option-container {
+  padding-left   : 0 1rem 0 1rem;
+  display        : flex;
+  flex-direction : column;
+  justify-content: flex-end;
+}
+
+[data-theme="dark"] .access-option-container.lm-only {
+  display: none;
+}
+
+/* Select boxes for accessibility options */
+.access-option-container select {
+  min-width: 5rem;
+  width    : 100%;
+}
+
+select#light-colour,
+select#dark-background {
+  background-color: var(--ifm-color-primary);
+  color           : var(--psdi-light-text-color-body);
+}
+
+select#size option {
+  font-family: var(--psdi-default-font);
+}
+
+select#font option {
+  font-size: var(--psdi-default-font-size);
+}
+
+select#dark-colour option {
+  color: var(--psdi-default-dark-text-color-body);
+}
+
+select#light-colour option {
+  background-color: var(--ifm-color-primary);
+  color           : var(--psdi-default-light-text-color-body);
+}
+
+select#light-background option {
+  background-color: var(--psdi-default-background-color);
+}
+
+select#dark-background option {
+  background-color: var(--psdi-default-color-primary);
+  color           : var(--psdi-light-text-color-body);
+}
+
+/* We use the service-mode variable to control whether elements with the "service-only" or "local-only" class are shown
+*/
+[service-mode=True] .local-only {
+  display: none;
+}
+
+[service-mode=False] .service-only {
+  display: none;
+}
+
+/* We use the production-mode variable to control whether elements with the "prod-only" or "dev-only" class are shown
+*/
+[production-mode=True] .prod-only {
+  display: none;
+}
+
+[production-mode=False] .dev-only {
+  display: none;
+}