From 0a42813e439bdca415355bd7fc37e684b342f99f Mon Sep 17 00:00:00 2001
From: Steve Jones <steve@squaregoldfish.co.uk>
Date: Fri, 13 Dec 2024 11:45:54 +0100
Subject: [PATCH] (#137) Only show sharing icon when appropriate

---
 .../instrument/instrument_list.xhtml          | 14 +++++++----
 .../QuinCe/data/Instrument/Instrument.java    | 22 ++++++++++++++++++
 .../QuinCe/web/Instrument/BeanInstrument.java | 23 +++++++++++++++++++
 .../web/Instrument/InstrumentListBean.java    | 15 ++++++------
 4 files changed, 63 insertions(+), 11 deletions(-)
 create mode 100644 WebApp/src/uk/ac/exeter/QuinCe/web/Instrument/BeanInstrument.java

diff --git a/WebApp/WebContent/instrument/instrument_list.xhtml b/WebApp/WebContent/instrument/instrument_list.xhtml
index 769a7814b..eb4db3a12 100644
--- a/WebApp/WebContent/instrument/instrument_list.xhtml
+++ b/WebApp/WebContent/instrument/instrument_list.xhtml
@@ -230,10 +230,16 @@
               <h:graphicImage value="/resources/image/spacer.svg" alt="" title=""
                 styleClass="actionIconLarge"/>
             </ui:fragment>
-            <p:commandLink onclick="showOwnershipDialog(#{instrument.id})">
-              <h:graphicImage value="/resources/image/share.svg" alt="Ownership and Sharing"
-                title="Ownership and Sharing" styleClass="actionIconLarge"/>
-            </p:commandLink>
+            <ui:fragment rendered="#{instrument.canShare}">
+              <p:commandLink onclick="showOwnershipDialog(#{instrument.id})">
+                <h:graphicImage value="/resources/image/share.svg" alt="Ownership and Sharing"
+                  title="Ownership and Sharing" styleClass="actionIconLarge"/>
+              </p:commandLink>
+            </ui:fragment>
+            <ui:fragment rendered="#{not instrument.canShare}">
+              <h:graphicImage value="/resources/image/spacer.svg" alt="" title=""
+                styleClass="actionIconLarge"/>
+            </ui:fragment>
             <ui:fragment rendered="#{not instrumentListBean.hasDatasets(instrument.id)}">
               <p:commandLink onclick="confirmInstrumentDelete(#{instrument.id}, '#{instrument.displayName}')">
                 <h:graphicImage value="/resources/image/trash.svg" alt="Delete instrument"
diff --git a/WebApp/src/uk/ac/exeter/QuinCe/data/Instrument/Instrument.java b/WebApp/src/uk/ac/exeter/QuinCe/data/Instrument/Instrument.java
index 908f68300..6758b64d1 100644
--- a/WebApp/src/uk/ac/exeter/QuinCe/data/Instrument/Instrument.java
+++ b/WebApp/src/uk/ac/exeter/QuinCe/data/Instrument/Instrument.java
@@ -200,6 +200,28 @@ public Instrument(User owner, long databaseId, String name,
     parsePropertiesJson(propertiesJson);
   }
 
+  /**
+   * Copy constructor. Performs a shallow copy on members.
+   *
+   * @param source
+   *          The source object.
+   */
+  public Instrument(Instrument source) {
+    this.owner = source.owner;
+    this.id = source.id;
+    this.name = source.name;
+    this.sharedWith = source.sharedWith;
+    this.fileDefinitions = source.fileDefinitions;
+    this.variables = source.variables;
+    this.variableProperties = source.variableProperties;
+    this.sensorAssignments = source.sensorAssignments;
+    this.platformName = source.platformName;
+    this.platformCode = source.platformCode;
+    this.nrt = source.nrt;
+    this.lastNrtExport = source.lastNrtExport;
+    this.properties = source.properties;
+  }
+
   /**
    * Create a new instrument with defined properties.
    *
diff --git a/WebApp/src/uk/ac/exeter/QuinCe/web/Instrument/BeanInstrument.java b/WebApp/src/uk/ac/exeter/QuinCe/web/Instrument/BeanInstrument.java
new file mode 100644
index 000000000..1701d7064
--- /dev/null
+++ b/WebApp/src/uk/ac/exeter/QuinCe/web/Instrument/BeanInstrument.java
@@ -0,0 +1,23 @@
+package uk.ac.exeter.QuinCe.web.Instrument;
+
+import uk.ac.exeter.QuinCe.User.User;
+import uk.ac.exeter.QuinCe.data.Instrument.Instrument;
+
+/**
+ * Wrapper around the {@link Instrument} class that adds some extra features for
+ * use in a web context.
+ */
+public class BeanInstrument extends Instrument {
+
+  private boolean canShare;
+
+  protected BeanInstrument(Instrument instrument, User currentUser) {
+    super(instrument);
+    canShare = currentUser.isAdminUser()
+      || currentUser.equals(instrument.getOwner());
+  }
+
+  public boolean getCanShare() {
+    return canShare;
+  }
+}
diff --git a/WebApp/src/uk/ac/exeter/QuinCe/web/Instrument/InstrumentListBean.java b/WebApp/src/uk/ac/exeter/QuinCe/web/Instrument/InstrumentListBean.java
index 356dce390..c19527888 100644
--- a/WebApp/src/uk/ac/exeter/QuinCe/web/Instrument/InstrumentListBean.java
+++ b/WebApp/src/uk/ac/exeter/QuinCe/web/Instrument/InstrumentListBean.java
@@ -53,7 +53,7 @@ public class InstrumentListBean extends BaseManagedBean {
 
   private Map<Long, Integer> datasetCounts;
 
-  private List<Instrument> filteredInstruments;
+  private List<BeanInstrument> filteredInstruments;
 
   private LinkedHashMap<Long, String> userNames;
 
@@ -69,7 +69,7 @@ public class InstrumentListBean extends BaseManagedBean {
   /**
    * The ID of the instrument chosen from the instrument list
    */
-  private Instrument chosenInstrument = null;
+  private BeanInstrument chosenInstrument = null;
 
   private int shareAction = Integer.MIN_VALUE;
 
@@ -94,15 +94,16 @@ public String start() {
    *
    * @return The instruments owned by the current user
    */
-  public List<Instrument> getInstrumentList() {
-    return getInstruments();
+  public List<BeanInstrument> getInstrumentList() {
+    return getInstruments().stream().map(i -> new BeanInstrument(i, getUser()))
+      .toList();
   }
 
-  public List<Instrument> getFilteredInstruments() {
+  public List<BeanInstrument> getFilteredInstruments() {
     return filteredInstruments;
   }
 
-  public void setFilteredInstruments(List<Instrument> filteredInstruments) {
+  public void setFilteredInstruments(List<BeanInstrument> filteredInstruments) {
     this.filteredInstruments = filteredInstruments;
   }
 
@@ -157,7 +158,7 @@ public long getChosenInstrument() {
    *          The instrument ID
    */
   public void setChosenInstrument(long chosenInstrument) {
-    for (Instrument instrument : getInstruments()) {
+    for (BeanInstrument instrument : getInstrumentList()) {
       if (instrument.getId() == chosenInstrument) {
         this.chosenInstrument = instrument;
         setCurrentInstrumentId(instrument.getId());