From dc16666f7c35aa607aebff66dc8064b5d1ea4d1a Mon Sep 17 00:00:00 2001
From: Tariq Soliman <Tariq.K.Soliman@jpl.nasa.gov>
Date: Wed, 20 Dec 2023 15:16:30 -0800
Subject: [PATCH] #481 ShadeTool Touchups (#482)

* #481 ShadeTool Touchups

* #481 Fix docs
---
 docs/pages/Tools/Shade/Shade.md      |  10 ++-
 private/api/spice/chronice.py        |  71 +++++++++++++++
 private/api/spice/chronos.py         |   2 +-
 scripts/server.js                    |  24 +++++
 src/essence/Tools/Shade/ShadeTool.js | 129 ++++++++++++++++++---------
 src/essence/Tools/Shade/config.json  |   4 +-
 src/pre/calls.js                     |   4 +
 7 files changed, 199 insertions(+), 45 deletions(-)
 create mode 100644 private/api/spice/chronice.py

diff --git a/docs/pages/Tools/Shade/Shade.md b/docs/pages/Tools/Shade/Shade.md
index 80062f80..1e47afff 100644
--- a/docs/pages/Tools/Shade/Shade.md
+++ b/docs/pages/Tools/Shade/Shade.md
@@ -66,7 +66,9 @@ There are two SPICE python scripts that require these backend kernel setups:
             "value": "MSL"
         }
     ],
-    "defaultHeight": 0
+    "defaultHeight": 0,
+    "observerTimePlaceholder": null,
+    "utcTimeFormat": null
 }
 ```
 
@@ -80,6 +82,10 @@ _**observers**_ - An array of objects with the properties "name" and "value". "n
 
 _**defaultHeight**_ - Sets a default for the 'Height' parameter (see below). The regular default is 0 meters.
 
+_**observerTimePlaceholder**_ - Sets the placeholder information for when the observer time's input box is cleared. Useful for denoting the expected time format to be inputed. For example "SOL DDDD HH:MM:SS". Default null.
+
+_**utcTimeFormat**_ - Sets the placeholder information for when the observer time's input box is cleared. Useful for denoting the expected time format to be inputed. Uses [d3 time syntax](https://d3js.org/d3-time-format#locale_format). Example for day-of-year: `"%Y-%j %H:%M:%S"`. Defaults to times like so: `2023 SEP 06 19:27:05`.
+
 ## Tool Use
 
 **Note:** Terrain beyond the screen's current extent is **not** factored into the displayed visiblity map — only observer-target direction and on-screen terrain is considered. A distant off-screen mountain will **not** cast shadows.
@@ -87,7 +93,7 @@ _**defaultHeight**_ - Sets a default for the 'Height' parameter (see below). The
 ### Interface
 
 - _Time_
-  - The desired datetime to query. Formatted as `YYYY MMM DD HH:MM:SS` and for example `2023 SEP 06 19:27:05`. Updating this time and pressing 'Enter' will set it as the current time for the ShadeTool and for all of MMGIS. It is both connected to the Observer's local time as well as MMGIS' timeline (expandable via the clock icon in the bottom left of the screen).
+  - The desired datetime to query. Formatted as `YYYY MMM DD HH:MM:SS` and for example `2023 SEP 06 19:27:05` (or based on `utcTimeFormat`). Updating this time and pressing 'Enter' will set it as the current time for the ShadeTool and for all of MMGIS. It is both connected to the Observer's local time as well as MMGIS' timeline (expandable via the clock icon in the bottom left of the screen).
 
 #### Source
 
diff --git a/private/api/spice/chronice.py b/private/api/spice/chronice.py
new file mode 100644
index 00000000..ff3f4f45
--- /dev/null
+++ b/private/api/spice/chronice.py
@@ -0,0 +1,71 @@
+# chronice: chronos + spice (but without chronos since spice-alone offered more controll)
+# chronice.py <target> <from_format> <time>
+#     <from_format>: 'utc' or 'lmst' and will convert into the other
+# !!! Currently only designed for Mars
+
+# examples:
+#        python chronice.py msl utc "2024-01-17T20:56:20.280"
+#           => {"result": "SOL-04070M09:30:00"}
+#        python chronice.py msl lmst "SOL-4070M09:30:00"
+#           => {"result": "2024-01-17T20:56:20.279"}
+
+import sys
+import json
+import os
+
+import spiceypy
+
+try:
+    from urllib.parse import unquote
+except ImportError:
+    from urllib import unquote
+
+def chronice(target, fromFormat, time):
+    # Load kernels
+    package_dir = os.path.dirname(os.path.abspath(__file__)).replace('\\','/')
+
+    kernels_to_load = []
+    # Crawl dir for kernels
+    for x in os.listdir(os.path.join(package_dir + '/kernels')):
+        if x.endswith(('.bsp', '.tpc', '.tsc', '.tf', '.tls')) and not x.startswith('dynamic'):
+            # Prints only text file present in My Folder
+            kernels_to_load.append(x)
+
+    for k in kernels_to_load:
+        spiceypy.furnsh( os.path.join(package_dir + '/kernels/', k) )
+
+    targetId = 0
+    if target == 'msl':
+        targetId = -76900
+    # LMST
+    if fromFormat == 'utc':
+        et = spiceypy.utc2et(time)
+        result = spiceypy.sce2s(targetId, et)
+        result = sclk2lmst(result, target)
+    else:
+        time = lmst2sclk(time, target)
+        et = spiceypy.scs2e(targetId, time)
+        result = spiceypy.et2utc(et, "ISOC", 3)
+
+    return json.dumps({
+        "result": result
+    })
+
+def sclk2lmst(sclk, target):
+    if target == 'msl':
+        s = sclk.split('/')[1].split(':')
+        return f'SOL-{s[0]}M{s[1]}:{s[2]}:{s[3]}'
+def lmst2sclk(lmst, target, partition = 1):
+    if target == 'msl':
+        s = lmst.replace(' ', ':').replace('-', ':').replace('M', ':').split(':')
+        return f'{partition}/{s[1].zfill(5)}:{s[2].zfill(2)}:{s[3].zfill(2)}:{s[4].zfill(2)}:00000'
+
+# Start
+target = unquote(sys.argv[1])
+fromFormat = unquote(sys.argv[2])
+time = unquote(sys.argv[3])
+
+try:
+    print(chronice(target, fromFormat, time))
+except:
+    print(json.dumps({"error": True, "message": 'Error: ' + str(sys.exc_info()[0])}))
diff --git a/private/api/spice/chronos.py b/private/api/spice/chronos.py
index a6599b95..19e8b68d 100644
--- a/private/api/spice/chronos.py
+++ b/private/api/spice/chronos.py
@@ -1,4 +1,4 @@
-# SImply wraps commands such as
+# Simply wraps commands such as
 # chronos.exe -setup ./chronos/chronos-msl.setup -from utc -fromtype scet -to lst -totype lst -time "2023-07-27 23:16:05.644" -NOLABEL
 # chronos.exe -setup ./chronos/chronos-msl.setup -to utc -totype scet -from lst -fromtype lst -time "SOL 3901 03:46:54" -NOLABEL
 
diff --git a/scripts/server.js b/scripts/server.js
index f712d89f..bd5efcef 100644
--- a/scripts/server.js
+++ b/scripts/server.js
@@ -764,6 +764,30 @@ setups.getBackendSetups(function (setups) {
     }
   );
 
+  //utils chronos (spice time converter)
+  app.post(
+    `${ROOT_PATH}/api/utils/chronice`,
+    ensureUser(),
+    ensureGroup(permissions.users),
+    function (req, res) {
+      const target = encodeURIComponent(req.body.target);
+      const fromFormat = encodeURIComponent(req.body.from);
+      const time = encodeURIComponent(req.body.time)
+        .replace(/%20/g, " ")
+        .replace(/%3A/g, ":");
+
+      execFile(
+        "python",
+        ["private/api/spice/chronice.py", target, fromFormat, time],
+        function (error, stdout, stderr) {
+          if (error)
+            logger("error", "chronice failure:", "server", null, error);
+          res.send(stdout);
+        }
+      );
+    }
+  );
+
   //utils chronos (spice time converter)
   app.get(
     `${ROOT_PATH}/api/utils/proj42wkt`,
diff --git a/src/essence/Tools/Shade/ShadeTool.js b/src/essence/Tools/Shade/ShadeTool.js
index 97ed24ec..3cc3549f 100644
--- a/src/essence/Tools/Shade/ShadeTool.js
+++ b/src/essence/Tools/Shade/ShadeTool.js
@@ -45,6 +45,14 @@ let ShadeTool = {
     dynamicUpdatePanCutoff: 0,
     MMGISInterface: null,
     tempSheet: null,
+    tempIndicatorPoint: null,
+    indicatorLastDragPoint: null,
+    tempIndicatorPointStyle: {
+        fillColor: '#000',
+        fillOpacity: 0,
+        color: 'lime',
+        weight: 3,
+    },
     sunColor: '#d2db58',
     earthColor: '#58dbb8',
     initialize: function () {
@@ -93,6 +101,8 @@ let ShadeTool = {
     make: function () {
         this.MMGISInterface = new interfaceWithMMGIS()
 
+        ShadeTool.indicatorLastDragPoint = null
+
         if (this.firstOpen) {
             // Turn on files from url if any
             if (L_.FUTURES.tools) {
@@ -159,13 +169,16 @@ let ShadeTool = {
 
         return urlString
     },
-    timeChange: function (time) {
+    timeChange: function () {
         $('#shadeTool .vstRegen').addClass('changed')
         $('#vstShades > li').each((i, elm) => {
             const id = $(elm).attr('shadeId')
             $('.vstOptionTime input').val(
-                ShadeTool.parseToUTCTime(TimeControl.getEndTime())
+                ShadeTool.parseToUTCTime(TimeControl.getEndTime(), true)
             )
+            const rawTime = ShadeTool.parseToUTCTime(TimeControl.getEndTime())
+            $('.vstOptionTime input').attr('raw', rawTime)
+            $('.vstOptionTime input').attr('title', rawTime)
             ShadeTool.updateObserverSpecificTime(id)
             // prettier-ignore
             if (
@@ -177,6 +190,7 @@ let ShadeTool = {
         })
     },
     panEnd: function () {
+        ShadeTool.indicatorLastDragPoint = null
         $('#shadeTool .vstRegen').addClass('changed')
         $('#vstShades > li').each((i, elm) => {
             const id = $(elm).attr('shadeId')
@@ -334,7 +348,7 @@ let ShadeTool = {
                             `<div title='Ground observer time'>Time</div>`,
                             "<div class='flexbetween'>",
                                 `<div class='vstClockIcon2'><i class='mdi mdi-clock-outline mdi-18px'></i></div>`,
-                                `<input type='text' placeholder='YYYY mmm DD HH:MM:SS' value='${TimeControl.getEndTime()}'>`,
+                                `<input type='text' placeholder='${ShadeTool.vars.observerTimePlaceholder || ''}' value='${TimeControl.getEndTime()}'>`,
                             "</div>",
                         "</div>",
                         "<div class='vstOptionHeight'>",
@@ -490,17 +504,23 @@ let ShadeTool = {
             'change',
             (function (id) {
                 return function () {
-                    const time = $(this).val() + 'Z'
+                    let time = $(this).val()
+                    if (ShadeTool.vars.utcTimeFormat) {
+                        const parseTime = d3.utcParse(
+                            ShadeTool.vars.utcTimeFormat
+                        )
+                        time = parseTime(time).toISOString()
+                    } else {
+                        time += 'Z'
+                    }
+
                     let isValid = false
                     try {
                         new Date(time).toISOString()
                         isValid = true
                     } catch {}
                     if (isValid) {
-                        TimeControl.setTime(
-                            TimeControl.getStartTime(),
-                            $(this).val() + 'Z'
-                        )
+                        TimeControl.setTime(TimeControl.getStartTime(), time)
                         ShadeTool.updateObserverSpecificTime(id)
                     } else {
                         CursorInfo.update(
@@ -679,7 +699,7 @@ let ShadeTool = {
     updateObserverSpecificTime: function (id) {
         id = id || 0
         calls.api(
-            'chronos',
+            'chronice',
             {
                 target: $(
                     '#vstShades #vstId_' + id + ' .vstOptionObserver select'
@@ -687,9 +707,6 @@ let ShadeTool = {
                     .val()
                     .toLowerCase(),
                 from: 'utc',
-                fromtype: 'scet',
-                to: 'lst',
-                totype: 'lst',
                 time: TimeControl.getEndTime(),
             },
             function (s) {
@@ -728,17 +745,14 @@ let ShadeTool = {
     updateFromObserverSpecificTime: function (id) {
         id = id || 0
         calls.api(
-            'chronos',
+            'chronice',
             {
                 target: $(
                     '#vstShades #vstId_' + id + ' .vstOptionObserver select'
                 )
                     .val()
                     .toLowerCase(),
-                from: 'lst',
-                fromtype: 'lst',
-                to: 'utc',
-                totype: 'scet',
+                from: 'lmst',
                 time: $(
                     '#vstShades #vstId_' + id + ' .vstOptionTimeSpecific input'
                 ).val(),
@@ -784,7 +798,10 @@ let ShadeTool = {
         const mapRect = document.getElementById('map').getBoundingClientRect()
         const wOffset = mapRect.width / 2
         const hOffset = mapRect.height / 2
-        const centerLatLng = Map_.map.containerPointToLatLng([wOffset, hOffset])
+        let centerLatLng = Map_.map.containerPointToLatLng([wOffset, hOffset])
+
+        if (ShadeTool.indicatorLastDragPoint)
+            centerLatLng = ShadeTool.indicatorLastDragPoint
 
         source = {
             lng: parseFloat(centerLatLng.lng),
@@ -865,15 +882,14 @@ let ShadeTool = {
                                 ShadeTool.tempIndicatorPoint =
                                     new L.circleMarker(
                                         [source.lat, source.lng],
-                                        {
-                                            fillColor: '#000',
-                                            fillOpacity: 0,
-                                            color: 'lime',
-                                            weight: 2,
-                                        }
+                                        ShadeTool.tempIndicatorPointStyle
                                     )
                                         .setRadius(4)
                                         .addTo(Map_.map)
+                                        .bringToFront()
+
+                                ShadeTool.indicatorDragOn()
+
                                 try {
                                     s = JSON.parse(s)
                                 } catch {
@@ -940,7 +956,6 @@ let ShadeTool = {
                                 }
                             },
                             function (e) {
-                                console.log('e', e)
                                 $(
                                     '#vstShades #vstId_' +
                                         activeElmId +
@@ -1191,8 +1206,10 @@ let ShadeTool = {
                     '#vstShades #vstId_' + elmId + ' .vstOptionHeight input'
                 ).val()
             ),
-            height: 0,
-            time: $('.vstOptionTime input').val(),
+            height: $(
+                '#vstShades #vstId_' + elmId + ' .vstOptionHeight input'
+            ).val(),
+            time: $('.vstOptionTime input').attr('raw'),
         }
     },
     // Update Range Azimuth Elevation indicators
@@ -1519,7 +1536,11 @@ let ShadeTool = {
             options.color || 'yellow'
         )
     },
-    parseToUTCTime(time) {
+    parseToUTCTime(time, formatted) {
+        if (formatted && ShadeTool.vars.utcTimeFormat) {
+            const tF = d3.utcFormat(ShadeTool.vars.utcTimeFormat)
+            return tF(Date.parse(time))
+        }
         //'2023-06-28T03:15:20.883Z' -> '2023 JUL 16 03:56:00'
         return (
             time.substring(0, 4) +
@@ -1538,6 +1559,43 @@ let ShadeTool = {
         L_.layers.layer['shade' + activeElmId] = null
         ShadeTool.canvases[activeElmId] = null
     },
+    indicatorDragOn: function () {
+        ShadeTool.tempIndicatorPoint.on(
+            'mousedown',
+            ShadeTool.indicatorDragDown
+        )
+        Map_.map.on('mouseup', ShadeTool.indicatorDragUp)
+        Map_.map.on('mousemove', ShadeTool.indicatorDragMove)
+    },
+    indicatorDragOff: function () {
+        ShadeTool.tempIndicatorPoint.off('mousedown', DrawTool.cmLayerDown)
+        Map_.map.off('mouseup', DrawTool.cmLayerUp)
+        Map_.map.off('mousemove', DrawTool.cmLayerMove)
+
+        ShadeTool.tempIndicatorPoint.dragging = false
+        Map_.map.dragging.enable()
+    },
+    indicatorDragDown: function () {
+        ShadeTool.tempIndicatorPoint.dragging = true
+        Map_.map.dragging.disable()
+    },
+    indicatorDragUp: function () {
+        if (ShadeTool.tempIndicatorPoint.dragging == true) {
+            ShadeTool.tempIndicatorPoint.dragging = false
+            //So the layer itself can ignore the click to drag
+            ShadeTool.tempIndicatorPoint.justDragged = true
+            Map_.map.dragging.enable()
+            if (DrawTool.indicatorLastDragPoint) {
+                Map_.rmNotNull(ShadeTool.tempIndicatorPoint)
+            }
+        }
+    },
+    indicatorDragMove: function (e) {
+        if (ShadeTool.tempIndicatorPoint.dragging) {
+            ShadeTool.tempIndicatorPoint.setLatLng(e.latlng)
+            ShadeTool.indicatorLastDragPoint = e.latlng
+        }
+    },
 }
 
 //
@@ -1546,6 +1604,7 @@ function interfaceWithMMGIS() {
         separateFromMMGIS()
     }
 
+    const rawTime = ShadeTool.parseToUTCTime(TimeControl.getEndTime())
     // prettier-ignore
     let markup = [
         "<div id='shadeTool'>",
@@ -1555,25 +1614,13 @@ function interfaceWithMMGIS() {
                         "<div id='vstTitle'>Shade</div>",
                         Help.getComponent(helpKey),
                     "</div>",
-                    /*
-                    "<div id='vstNew'>",
-                        "<div>New</div>",
-                        "<i class='mdi mdi-plus mdi-18px'></i>",
-                    "</div>",
-                    */
                 "</div>",
                 "<div class='vstOptionTime'>",
                     "<div class='flexbetween'>",
                         `<div class='vstClockIcon'><i class='mdi mdi-clock-outline mdi-18px'></i></div>`,
-                        `<input type='text' value='${ShadeTool.parseToUTCTime(TimeControl.getEndTime())}'>`,
+                        `<input type='text' value='${ShadeTool.parseToUTCTime(TimeControl.getEndTime(), true)}' raw='${rawTime}' title='${rawTime}'>`,
                     "</div>",
                 "</div>",
-                /*
-                "<div>",
-                    "<div id='vstToggleAll' class='checkbox on'></div>",
-                    "<div class='vstLabel'>Toggle All</div>",
-                "</div>",
-                */
             "</div>",
             "<div id='vstContent'>",
                 "<ul id='vstShades'>",
diff --git a/src/essence/Tools/Shade/config.json b/src/essence/Tools/Shade/config.json
index beead680..89975922 100644
--- a/src/essence/Tools/Shade/config.json
+++ b/src/essence/Tools/Shade/config.json
@@ -29,7 +29,9 @@
                     "value": "SPICE Spacecraft name or ID"
                 }
             ],
-            "defaultHeight": 0
+            "defaultHeight": 0,
+            "observerTimePlaceholder": null,
+            "utcTimeFormat": null
         }
     },
     "hasVars": true,
diff --git a/src/pre/calls.js b/src/pre/calls.js
index 6ccd0584..b365c0c0 100644
--- a/src/pre/calls.js
+++ b/src/pre/calls.js
@@ -38,6 +38,10 @@ const c = {
         type: 'POST',
         url: 'api/utils/chronos',
     },
+    chronice: {
+        type: 'POST',
+        url: 'api/utils/chronice',
+    },
     proj42wkt: {
         type: 'GET',
         url: 'api/utils/proj42wkt',