Scheduled scans in scan server

app/display/actions/src/main/java/org/csstudio/display/actions/WritePVAction.java

@@ -5,11 +5,14 @@
 package org.csstudio.display.actions;
 
 import javafx.scene.image.Image;
+import org.csstudio.display.builder.model.Widget;
 import org.csstudio.display.builder.model.persist.ModelReader;
 import org.csstudio.display.builder.model.persist.ModelWriter;
 import org.csstudio.display.builder.model.persist.XMLTags;
 import org.csstudio.display.builder.model.properties.ActionInfoBase;
 import org.csstudio.display.builder.representation.javafx.actionsdialog.ActionsDialog;
+import org.phoebus.framework.macros.MacroHandler;
+import org.phoebus.framework.macros.MacroValueProvider;
 import org.phoebus.framework.persistence.XMLUtil;
 import org.phoebus.ui.javafx.ImageCache;
 import org.w3c.dom.Element;
@@ -107,4 +110,33 @@ public void setPv(String pv) {
     public void setValue(String value) {
         this.value = value;
     }
+
+    public String formatPv(Widget widget) {
+        final MacroValueProvider macros = widget.getMacrosOrProperties();
+        String pvName = getPV();
+        try
+        {
+            pvName = MacroHandler.replace(macros, pvName);
+        }
+        catch (Exception ignore)
+        {
+            // NOP
+        }
+        return pvName;
+    }
+
+    public String formatValue(Widget widget) {
+        final MacroValueProvider macros = widget.getMacrosOrProperties();
+        value = getValue();
+
+        try
+        {
+            value = MacroHandler.replace(macros, value);
+        }
+        catch (Exception ignore)
+        {
+            // NOP
+        }
+        return value;
+    }
 }

app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/app/actionhandlers/WritePVActionHandler.java

@@ -25,23 +25,8 @@ public void handleAction(Widget sourceWidget, ActionInfo pluggableActionInfo) {
         // System.out.println(action.getDescription() + ": Set " + action.getPV() + " = " + action.getValue());
         final MacroValueProvider macros = sourceWidget.getMacrosOrProperties();
         WritePVAction writePVAction = (WritePVAction)pluggableActionInfo;
-        String pvName = writePVAction.getPV(), value = writePVAction.getValue();
-        try
-        {
-            pvName = MacroHandler.replace(macros, pvName);
-        }
-        catch (Exception ignore)
-        {
-            // NOP
-        }
-        try
-        {
-            value = MacroHandler.replace(macros, value);
-        }
-        catch (Exception ignore)
-        {
-            // NOP
-        }
+        String pvName = writePVAction.formatPv(sourceWidget);
+        String value = writePVAction.formatValue(sourceWidget);
         try
         {
             runtime.writePV(pvName,value);

app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/internal/BaseWidgetRuntimes.java

@@ -13,6 +13,7 @@
 
 import org.csstudio.display.builder.model.DisplayModel;
 import org.csstudio.display.builder.model.Widget;
+import org.csstudio.display.builder.model.widgets.ActionButtonWidget;
 import org.csstudio.display.builder.model.widgets.ArrayWidget;
 import org.csstudio.display.builder.model.widgets.EmbeddedDisplayWidget;
 import org.csstudio.display.builder.model.widgets.GroupWidget;

app/scan/client/src/main/java/org/csstudio/scan/client/ScanClient.java

@@ -43,6 +43,7 @@
 import org.csstudio.scan.util.IOUtils;
 import org.csstudio.scan.util.PathUtil;
 import org.phoebus.framework.persistence.XMLUtil;
+import org.phoebus.util.time.TimestampFormats;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 
@@ -402,12 +403,26 @@ public Collection<DeviceInfo> getScanDevices(final long id) throws Exception
      *  @param name Name of the new scan
      *  @param xml_commands XML commands of the scan to submit
      *  @param queue Submit to queue or for immediate execution?
+     *  @param scheduled Time at which to run the scan
      *  @return Scan ID
      *  @throws Exception on error
      */
-    public long submitScan(final String name, final String xml_commands, final boolean queue) throws Exception
+    public long submitScan(
+            final String name,
+            final String xml_commands,
+            final boolean queue,
+            Instant scheduled
+    ) throws Exception
     {
-        final HttpURLConnection connection = connect("/scan/" + name, queue ? "" : "queue=false", long_timeout);
+        List<String> query = new ArrayList<>();
+        if (!queue) {
+            query.add("queue=false");
+        }
+        if (scheduled != null) {
+            query.add("scheduled=" + TimestampFormats.SECONDS_FORMAT.format(scheduled));
+        }
+
+        final HttpURLConnection connection = connect("/scan/" + name, String.join("&", query), long_timeout);
         connection.setReadTimeout(0);
         try
         {
@@ -427,6 +442,10 @@ public long submitScan(final String name, final String xml_commands, final boole
         }
     }
 
+    public long submitScan(final String name, final String xml_commands, final boolean queue) throws Exception {
+        return submitScan(name, xml_commands, queue, null);
+    }
+
     /** Submit a scan for simulation
      *  @param xml_commands XML commands of the scan to submit
      *  @return Scan ID

app/scan/client/src/main/java/org/csstudio/scan/client/ScanInfoModel.java

@@ -65,7 +65,7 @@ public class ScanInfoModel
      *  @throws Exception on error creating the initial instance
      *  @see #release()
      */
-    public static ScanInfoModel getInstance() throws Exception
+    public static ScanInfoModel getInstance()
     {
         synchronized (ScanInfoModel.class)
         {
@@ -124,7 +124,7 @@ public void removeListener(final ScanInfoModelListener listener)
     }
 
     /** Start model, i.e. connect to server, poll, ... */
-    private void start() throws Exception
+    private void start()
     {
         final long poll_period = Preferences.poll_period;
         poller = new Thread(new Runnable()

app/scan/model/src/main/java/org/csstudio/scan/info/ScanState.java

@@ -45,7 +45,10 @@ public enum ScanState
     Finished("Finished - OK", false, true),
 
     /** Scan that executed in the past; data has been logged */
-    Logged("Logged", false, true);
+    Logged("Logged", false, true),
+
+    /** Scan is waiting to be executed */
+    Scheduled("Scheduled", false, false);
 
     final private String name;
     final private boolean active;

app/scan/ui/src/main/java/org/csstudio/scan/ui/Messages.java

@@ -27,6 +27,8 @@ public class Messages
     public static String scan_remove;
     public static String scan_resume;
     public static String scan_resume_all;
+    public static String scan_schedule;
+    public static String scan_schedule_unqueued;
     public static String scan_simulate;
     public static String scan_submit;
     public static String scan_submit_unqueued;

app/scan/ui/src/main/java/org/csstudio/scan/ui/editor/ScanEditor.java

@@ -12,6 +12,7 @@
 import java.io.File;
 import java.util.Collections;
 import java.util.List;
+import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.logging.Level;
@@ -249,7 +250,33 @@ private ToolBar createToolbar()
         jump_to_current.setOnAction(event -> scan_tree.revealActiveItem(jump_to_current.isSelected()));
 
         final Button[] undo_redo = UndoButtons.createButtons(undo);
-        return new ToolBar(info_text, ToolbarHelper.createStrut(), buttons, ToolbarHelper.createSpring(), undo_redo[0], undo_redo[1]);
+
+        final Button schedule_button = new Button();
+        schedule_button.setGraphic(ImageCache.getImageView(ScanSystem.class, "/icons/clock.png"));
+        schedule_button.setTooltip(new Tooltip(Messages.scan_schedule));
+        schedule_button.setOnAction(event -> schedule(true));
+
+        final Button run_button = new Button();
+        run_button.setGraphic(ImageCache.getImageView(ScanSystem.class, "/icons/run.png"));
+        run_button.setTooltip(new Tooltip(Messages.scan_submit));
+        run_button.setOnAction(event -> submitOrSimulate(true));
+
+        final Button simulate_button = new Button();
+        simulate_button.setGraphic(ImageCache.getImageView(ScanSystem.class, "/icons/simulate.png"));
+        simulate_button.setTooltip(new Tooltip(Messages.scan_simulate));
+        simulate_button.setOnAction(event -> submitOrSimulate(null));
+
+        return new ToolBar(
+                info_text,
+                ToolbarHelper.createStrut(),
+                buttons,
+                ToolbarHelper.createSpring(),
+                undo_redo[0],
+                undo_redo[1],
+                schedule_button,
+                simulate_button,
+                run_button
+        );
     }
 
     private void createContextMenu()
@@ -266,6 +293,14 @@ private void createContextMenu()
                                              ImageCache.getImageView(ImageCache.class, "/icons/delete.png"));
         delete.setOnAction(event -> scan_tree.cutToClipboard());
 
+        final MenuItem schedule = new MenuItem(Messages.scan_schedule,
+                ImageCache.getImageView(ScanSystem.class, "/icons/clock.png"));
+        schedule.setOnAction(event -> schedule(true));
+
+        final MenuItem schedule_unqueued = new MenuItem(Messages.scan_schedule_unqueued,
+                ImageCache.getImageView(ScanSystem.class, "/icons/clock.png"));
+        schedule_unqueued.setOnAction(event -> schedule(false));
+
         final MenuItem simulate = new MenuItem(Messages.scan_simulate,
                                                ImageCache.getImageView(ScanSystem.class, "/icons/simulate.png"));
         simulate.setOnAction(event -> submitOrSimulate(null));
@@ -284,12 +319,26 @@ private void createContextMenu()
 
         final ContextMenu menu = new ContextMenu(copy, paste, delete,
                                                  new SeparatorMenuItem(),
-                                                 simulate, submit, submit_unqueued,
+                                                 schedule, schedule_unqueued, simulate, submit, submit_unqueued,
                                                  new SeparatorMenuItem(),
                                                  open_monitor);
         setContextMenu(menu);
     }
 
+    private void schedule(final Boolean queued) {
+        final String xml_commands;
+        try {
+            xml_commands = XMLCommandWriter.toXMLString(model.getCommands());
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+        final ScanClient scan_client = new ScanClient(Preferences.host, Preferences.port);
+        ScheduledScanDialog dialog = new ScheduledScanDialog(scan_name, scan_client, xml_commands, queued);
+        DialogHelper.positionDialog(dialog, this, 100, 100);
+        Optional<Long> scan_id = dialog.showAndWait();
+        scan_id.ifPresent(this::attachScan);
+    }
+
     /** @param how true/false to submit queue/un-queued, <code>null</code> to simulate */
     private void submitOrSimulate(final Boolean how)
     {
@@ -362,7 +411,7 @@ UndoableActionManager getUndo()
      *  @param id Scan ID
      *  @throws Exception on error
      */
-    void attachScan(final long id) throws Exception
+    void attachScan(final long id)
     {
         active_scan = id;
 

app/scan/ui/src/main/java/org/csstudio/scan/ui/editor/ScheduledScanDialog.java

@@ -0,0 +1,53 @@
+package org.csstudio.scan.ui.editor;
+
+import javafx.scene.control.ButtonType;
+import javafx.scene.control.Dialog;
+import org.csstudio.scan.client.ScanClient;
+import org.phoebus.ui.time.DateTimePane;
+
+import java.time.Instant;
+import java.time.ZoneId;
+
+
+public class ScheduledScanDialog extends Dialog<Long> {
+    final String scan_name;
+    final ScanClient scan_client;
+    final String script_xml;
+    final boolean queued;
+
+    public ScheduledScanDialog(String scan_name, ScanClient scan_client, String script_xml) {
+        this(scan_name, scan_client, script_xml, true);
+    }
+
+    public ScheduledScanDialog(String scan_name, ScanClient scan_client, String script_xml, boolean queued) {
+        this.scan_name = scan_name;
+        this.scan_client = scan_client;
+        this.script_xml = script_xml;
+        this.queued = queued;
+
+        setTitle("Schedule " + scan_name);
+        getDialogPane().getButtonTypes().addAll(ButtonType.OK, ButtonType.CANCEL);
+
+        final DateTimePane datetime = new DateTimePane();
+        getDialogPane().setContent(datetime);
+
+        setResultConverter(button ->
+        {
+            if (button == ButtonType.OK) {
+                try {
+                    return scan_client.submitScan(
+                            scan_name,
+                            script_xml,
+                            queued,
+                            datetime.getInstant()
+                    );
+                }
+                catch (Exception e) {
+                    return null;
+                }
+            } else {
+                return null;
+            }
+        });
+    }
+}

app/scan/ui/src/main/java/org/csstudio/scan/ui/monitor/ScansTable.java

@@ -260,17 +260,19 @@ private static int rankState(final ScanState state)
     {
         switch (state)
         {
-        case Running: // Most important, happening right now
+        case Running:   // Most important, happening right now
+            return 7;
+        case Paused:    // Very similar to a running state
             return 6;
-        case Paused:  // Very similar to a running state
+        case Idle:      // About to run next
             return 5;
-        case Idle:    // About to run next
+        case Scheduled: // Scheduled to run in the future
             return 4;
-        case Failed:  // Of the not running ones, failure is important to know
+        case Failed:    // Of the not running ones, failure is important to know
             return 3;
-        case Aborted: // Aborted on purpose
+        case Aborted:   // Aborted on purpose
             return 2;
-        case Finished:// Water down the bridge
+        case Finished:  // Water down the bridge
             return 1;
         case Logged:
         default:

app/scan/ui/src/main/java/org/csstudio/scan/ui/monitor/StateCell.java

@@ -179,6 +179,9 @@ protected void updateItem(final ScanState state, final boolean empty)
                 show(getResume());
                 show(getAbort());
                 break;
+            case Scheduled:
+                show(getAbort());
+                break;
             case Aborted:
             case Failed:
             case Finished:
@@ -201,6 +204,7 @@ static Color getStateColor(final ScanState state)
         case Finished:  return Color.DARKGREEN;
         case Paused:    return Color.GRAY;
         case Running:   return Color.GREEN;
+        case Scheduled: return Color.DARKBLUE;
         default:        return Color.BLACK;
         }
     }

app/scan/ui/src/main/resources/org/csstudio/scan/ui/messages.properties

@@ -11,6 +11,8 @@ scan_pause_all=Pause all running scans
 scan_remove=Remove this scan
 scan_resume=Resume execution
 scan_resume_all=Resume all paused scans
+scan_schedule=Schedule scan
+scan_schedule_unqueued=Schedule scan (not queued)
 scan_simulate=Simulate scan
 scan_submit=Submit scan
 scan_submit_unqueued=Submit scan (not queued)

core/ui/src/main/java/org/phoebus/ui/time/WraparoundValueFactory.java

@@ -75,7 +75,7 @@ public void decrement(final int steps)
     public void increment(final int steps)
     {
         final int value = getValue() + 1;
-        if (value != max)
+        if (value != max + 1)
             setValue(value);
         else
         {