Merge remote-tracking branch 'upstream'

Author: haitao127

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+
+<!-- ^^^ Describe your changes here ^^^ -->
+
+## Checklist
+
+<!--
+    Check all that apply.
+
+    Note that these are not all required,
+    but serves as information for reviewers.
+-->
+
+- Testing:
+    - [ ] The feature has automated tests
+    - [ ] Tests were run
+    - If not, explain how you tested your changes
+
+- Documentation:
+    - [ ] The feature is documented
+    - [ ] The documentation is up to date
+    - Release notes:
+        - [ ] Added an entry if the change is breaking or significant
+        - [ ] Added an entry when adding a new feature

.gitignore

@@ -123,6 +123,5 @@ phoebus-product/settings_template.ini
 
 # doc files generated by docs/source/conf.py 
 docs/source/applications.rst
-docs/source/preference_properties.rst
 docs/source/services.rst
 

app/alarm/examples/talk.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+#
+# Send talk message
+
+if [ $# -ne 2 ]
+then
+    echo "Usage: talk.sh Accelerator Message"
+    exit 1
+fi
+
+topic="$1"
+text="$2"
+
+kafka/bin/kafka-console-producer.sh --broker-list localhost:9092 --property 'parse.key=true' --property key.separator=" : "  --topic ${topic}Talk <<END
+talk:/$topic/pv : {"severity":"MAJOR", "standout":true, "talk":"$text"}
+END
+
+

app/alarm/model/src/main/java/org/phoebus/applications/alarm/talk/TalkClient.java

@@ -7,13 +7,19 @@
  *******************************************************************************/
 package org.phoebus.applications.alarm.talk;
 
+import static java.lang.Thread.sleep;
 import static org.phoebus.applications.alarm.AlarmSystem.logger;
+import static org.phoebus.applications.alarm.AlarmSystem.nag_period_ms;
 
+import java.time.Duration;
+import java.time.Instant;
 import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.concurrent.atomic.AtomicReference;
 import java.util.logging.Level;
 
 import org.apache.kafka.clients.consumer.Consumer;
@@ -41,7 +47,10 @@ public class TalkClient
     private final CopyOnWriteArrayList<TalkClientListener> listeners = new CopyOnWriteArrayList<>();
     private final AtomicBoolean running = new AtomicBoolean(true);
     private final Consumer<String, String> consumer;
+    private final Consumer<String, String> heartbeatConsumer;
     private final Thread thread;
+    private final Thread updateHeartbeatTimestampThread;
+    private final Thread annunciateDisconnectionThread;
 
     /** @param server - Kafka Server host:port
      *  @param config_name - Name of kafka config topic that the talk topic accompanies.
@@ -56,6 +65,16 @@ public TalkClient(final String server, final String config_name)
 
         thread = new Thread(this::run, "TalkClient");
         thread.setDaemon(true);
+
+        {
+            heartbeatConsumer = KafkaHelper.connectConsumer(server, List.of(config_name), Collections.emptyList(), AlarmSystem.kafka_properties);
+            updateHeartbeatTimestampThread = new Thread(() -> updateHeartbeatTimestampLoop(), "UpdateHeartbeatTimestampThread");
+            updateHeartbeatTimestampThread.setDaemon(false);
+            updateHeartbeatTimestampThread.start();
+            annunciateDisconnectionThread = new Thread(() -> annunciateDisconnectionLoop(), "AnnunciateDisconnectionThread");
+            annunciateDisconnectionThread.setDaemon(false);
+            annunciateDisconnectionThread.start();
+        }
     }
 
     /** @param listener - Listener to add */
@@ -144,11 +163,62 @@ private void checkUpdates()
         }
     }
 
+    private Optional<Instant> nextDisconnectedAnnunciation = Optional.empty(); // When alarm server is disconnected: point in time for next annunciation of disconnection.
+    private final Duration disconnectionAnnunciationPeriod = Duration.ofMillis(AlarmSystem.nag_period_ms);
+    private final Duration idleTimeoutDuration = Duration.ofMillis(AlarmSystem.idle_timeout_ms).multipliedBy(3);
+    private AtomicReference<Instant> lastReceivedUpdateFromAlarmServer = new AtomicReference<>(Instant.now());
+
+    private void updateHeartbeatTimestampLoop() {
+        while (running.get()) {
+            final ConsumerRecords<String, String> records = heartbeatConsumer.poll(100);
+            if (!records.isEmpty()) {
+                lastReceivedUpdateFromAlarmServer.set(Instant.now());
+            }
+            try {
+                sleep(1000);
+            } catch (InterruptedException e) {
+                logger.log(Level.WARNING, "updateHeartbeatTimestampLoop() was interrupted when sleeping.");
+            }
+        }
+    }
+
+    /** Background thread loop that detects and annunciates disconnections. */
+    private void annunciateDisconnectionLoop() {
+        while (running.get()) {
+            Instant now = Instant.now();
+            if (Duration.between(lastReceivedUpdateFromAlarmServer.get(), now).compareTo(idleTimeoutDuration) > 0) {
+                if (nextDisconnectedAnnunciation.isEmpty() || nextDisconnectedAnnunciation.get().isBefore(now)) {
+                    try {
+                        for (final TalkClientListener listener : listeners) {
+                            listener.messageReceived(SeverityLevel.UNDEFINED, true, "Alarm Server Disconnected");
+                        }
+                    } catch (final Exception ex) {
+                        logger.log(Level.WARNING, "Talk error for " + SeverityLevel.UNDEFINED + ", " + "Alarm Server Disconnected", ex);
+                    }
+                    if (nag_period_ms > 0) {
+                        nextDisconnectedAnnunciation = Optional.of(now.plus(disconnectionAnnunciationPeriod)); // Annunciate disconnect again after nag period_ms
+                    }
+                    else {
+                        nextDisconnectedAnnunciation = Optional.of(Instant.MAX); // When nag_period_ms == 0, don't annunciate the disconnection again.
+                    }
+                }
+            } else {
+                nextDisconnectedAnnunciation = Optional.empty(); // Connection to the Alarm Server exists.
+            }
+            try {
+                sleep(1000);
+            } catch (InterruptedException e) {
+                logger.log(Level.WARNING, "annunciateDisconnectionLoop() was interrupted when sleeping.");
+            }
+        }
+    }
+
     /** Stop client */
     public void shutdown()
     {
         running.set(false);
         consumer.wakeup();
+        heartbeatConsumer.wakeup();
         try
         {
             thread.join(2000);
@@ -157,6 +227,22 @@ public void shutdown()
         {
             logger.log(Level.WARNING, "Talk client thread doesn't shut down", ex);
         }
+        try
+        {
+            annunciateDisconnectionThread.join(2000);
+        }
+        catch (final InterruptedException ex)
+        {
+            logger.log(Level.WARNING, "Annunciate Disconnection from Alarm Server thread doesn't shut down", ex);
+        }
+        try
+        {
+            updateHeartbeatTimestampThread.join(2000);
+        }
+        catch (final InterruptedException ex)
+        {
+            logger.log(Level.WARNING, "Update Alarm Server Heartbeat thread doesn't shut down", ex);
+        }
         logger.info(thread.getName() + " shut down");
     }
 }

app/alarm/ui/src/main/resources/org/phoebus/applications/alarm/ui/messages_fr.properties

@@ -2,8 +2,12 @@ error=Erreur
 acknowledgeFailed=\u00C9chec de l\u0027acquittement de(s) (\u0027)alarme(s)
 addComponentFailed=\u00C9chec de l\u0027ajout du composant
 disableAlarmFailed=\u00C9chec de la d\u00E9sactivation de l\u0027alarme
+disabled=D\u00E9sactiv\u00E9
+disabledUntil=D\u00E9sactiv\u00E9 jusqu\u0027\u00E0
 enableAlarmFailed=\u00C9chec de l\u0027activation de l\u0027alarme
 moveItemFailed=\u00C9chec du d\u00E9placement de l\u0027\u00E9l\u00E9ment
+partlyDisabled=Partiellement d\u00E9sactiv\u00E9
 removeComponentFailed=\u00C9chec de la suppression du composant
 renameItemFailed=\u00C9chec du renommage de l\u0027\u00E9l\u00E9ment
+timer=Minuteur
 unacknowledgeFailed=\u00C9chec de la d\u00E9sacquittement de(s) (l\u0027)alarme(s)

app/credentials-management/doc/images/CredentialsManagement.png

@@ -8,18 +8,25 @@ Further, Phoebus may be configured to store the credentials entered by the user
 In order to also support an explicit logout capability, the Credentials Management application offers means to
 remove stored credentials.
 
-In some cases an explicit login procedure can be useful, e.g. login to service for the purpose of storing
-user credentials and thereby support automated creation of logbook entries.
-
 The application is launched using the dedicated button in the (bottom) status bar.
 
-The below screen shot shows an example where credentials have been stored for the "logbook" scope,
-plus an option to login to the "<remote service>" scope. User may also choose to "logout" from all scopes,
+The below screen shot shows an example where credentials have been stored for the "Logbook" scope,
+plus an option to login to the "<remote service>" scope. User may also choose to "Logout from all" services,
 i.e. to remove all stored credentials.
 
 .. image:: images/CredentialsManagement.png
 
-If no credentials are stored in the credentials store, and if no services supporting authentication have been configured,
+If no credentials are stored in the credentials store, and if no services supporting authentication are available,
 the Credentials Management UI will show a static message:
 
-.. image:: images/CredentialsManagement_Empty.png
+.. image:: images/CredentialsManagement_empty.png
+
+The "Login To All" button can be used to login to all services as a single action.
+In this case credentials entered in the text fields of toolbar at the top are used for all services, irrespective of
+the credentials (if any) entered in other input fields.
+
+If login to a service fails (service off-line or invalid credentials), this is indicated in the "Login Result" column.
+
+.. image:: images/CredentialsManagement_one_failed.png
+
+If on the other hand login succeeds to a single or all services, the dialog is closed automatically.