#349 - add displayName (required) to metadata

docs/extensions-howto.md

@@ -22,6 +22,7 @@ Each extension consists of a JavaScript script, you can find a sample below:
 function getScriptMetadata() {
     return {
         id: 'myExtensionIdentifier', // optional: id and version will be used later as a mechanism for checking if the script has a newer version
+        displayName: 'My Extension', //mandatory: the name displayed in the configuration page
         version: 0, // optional
         async: false,
         events: [

src/main/java/alfio/extension/ExtensionMetadata.java

@@ -26,6 +26,7 @@
 @AllArgsConstructor
 public class ExtensionMetadata {
     String id;
+    String displayName;
     Integer version;
     boolean async;
     List<String> events;

src/main/java/alfio/extension/ExtensionService.java

@@ -20,7 +20,10 @@
 import alfio.model.Event;
 import alfio.model.ExtensionLog;
 import alfio.model.ExtensionSupport;
-import alfio.model.ExtensionSupport.*;
+import alfio.model.ExtensionSupport.ExtensionMetadataValue;
+import alfio.model.ExtensionSupport.ExtensionParameterMetadataAndValue;
+import alfio.model.ExtensionSupport.NameAndValue;
+import alfio.model.ExtensionSupport.ScriptPathNameHash;
 import alfio.model.user.Organization;
 import alfio.repository.ExtensionLogRepository;
 import alfio.repository.ExtensionRepository;
@@ -110,13 +113,15 @@ public void createOrUpdate(String previousPath, String previousName, Extension s
         String hash = DigestUtils.sha256Hex(script.getScript());
         ExtensionMetadata extensionMetadata = getMetadata(script.getName(), script.getScript());
 
+        Validate.notBlank(extensionMetadata.displayName, "Display Name is mandatory");
+
         extensionRepository.deleteEventsForPath(previousPath, previousName);
 
         if (!Objects.equals(previousPath, script.getPath()) || !Objects.equals(previousName, script.getName())) {
             extensionRepository.deleteScriptForPath(previousPath, previousName);
-            extensionRepository.insert(script.getPath(), script.getName(), hash, script.isEnabled(), extensionMetadata.async, script.getScript());
+            extensionRepository.insert(script.getPath(), script.getName(), extensionMetadata.displayName, hash, script.isEnabled(), extensionMetadata.async, script.getScript());
         } else {
-            extensionRepository.update(script.getPath(), script.getName(), hash, script.isEnabled(), extensionMetadata.async, script.getScript());
+            extensionRepository.update(script.getPath(), script.getName(), extensionMetadata.displayName, hash, script.isEnabled(), extensionMetadata.async, script.getScript());
             //TODO: load all saved parameters value, then delete the register extension parameter
         }
 

src/main/java/alfio/manager/ExtensionManager.java

@@ -20,9 +20,7 @@
 import alfio.extension.ExtensionService;
 import alfio.model.*;
 import alfio.model.extension.InvoiceGeneration;
-import alfio.model.user.Organization;
 import alfio.repository.EventRepository;
-import alfio.repository.TicketReservationRepository;
 import lombok.AllArgsConstructor;
 import org.springframework.stereotype.Component;
 
@@ -34,7 +32,6 @@ public class ExtensionManager {
 
     private final ExtensionService extensionService;
     private final EventRepository eventRepository;
-    private final TicketReservationRepository ticketReservationRepository;
 
     public enum ExtensionEvent {
         RESERVATION_CONFIRMED,

src/main/java/alfio/model/ExtensionSupport.java

@@ -65,6 +65,7 @@ public ScriptPathNameHash(@Column("path") String path,
     public static class ExtensionParameterMetadataAndValue {
         private final int id;
         private final String name;
+        private final String extensionDisplayName;
         private final String configurationLevel;
         private final String description;
         private final String type;
@@ -85,6 +86,7 @@ public ExtensionParameterMetadataAndValue(@Column("ecm_id") int id,
                                                   @Column("path") String path,
                                                   @Column("es_id") int extensionId,
                                                   @Column("name") String extensionName,
+                                                  @Column("display_name") String extensionDisplayName,
                                                   @Column("conf_path") String configurationPath,
                                                   @Column("conf_value") String configurationValue) {
             this.id = id;
@@ -96,6 +98,7 @@ public ExtensionParameterMetadataAndValue(@Column("ecm_id") int id,
             this.path = path;
             this.extensionId = extensionId;
             this.extensionName = extensionName;
+            this.extensionDisplayName = extensionDisplayName;
             this.configurationPath = configurationPath;
             this.configurationValue = configurationValue;
         }

src/main/java/alfio/repository/ExtensionRepository.java

@@ -18,7 +18,9 @@
 package alfio.repository;
 
 import alfio.model.ExtensionSupport;
-import ch.digitalfondue.npjt.*;
+import ch.digitalfondue.npjt.Bind;
+import ch.digitalfondue.npjt.Query;
+import ch.digitalfondue.npjt.QueryRepository;
 
 import java.util.List;
 import java.util.Optional;
@@ -27,18 +29,20 @@
 @QueryRepository
 public interface ExtensionRepository {
 
-    @Query("insert into extension_support(path, name, hash, enabled, async, script) values " +
-        " (:path, :name, :hash, :enabled, :async, :script)")
+    @Query("insert into extension_support(path, name, display_name, hash, enabled, async, script) values " +
+        " (:path, :name, :displayName, :hash, :enabled, :async, :script)")
     int insert(@Bind("path") String path,
                @Bind("name") String name,
+               @Bind("displayName") String displayName,
                @Bind("hash") String hash,
                @Bind("enabled") boolean enabled,
                @Bind("async") boolean async,
                @Bind("script") String script);
 
-    @Query("update extension_support set hash = :hash, enabled = :enabled, async = :async, script = :script where path = :path and name = :name")
+    @Query("update extension_support set display_name = :displayName, hash = :hash, enabled = :enabled, async = :async, script = :script where path = :path and name = :name")
     int update(@Bind("path") String path,
                @Bind("name") String name,
+               @Bind("displayName") String displayName,
                @Bind("hash") String hash,
                @Bind("enabled") boolean enabled,
                @Bind("async") boolean async,
@@ -96,7 +100,7 @@ int registerExtensionConfigurationMetadata(@Bind("extensionId") int extensionId,
                                                @Bind("mandatory") boolean mandatory);
 
 
-    @Query("select ecm_id, ecm_name, ecm_configuration_level, ecm_description, ecm_type, ecm_mandatory, path, es_id, name, conf_path, conf_value"+
+    @Query("select ecm_id, ecm_name, ecm_configuration_level, ecm_description, ecm_type, ecm_mandatory, path, es_id, name, display_name, conf_path, conf_value"+
         " from extension_configuration_metadata " +
         " inner join extension_support on es_id = ecm_es_id_fk " +
         " left outer join extension_configuration_metadata_value on ecm_id = fk_ecm_id and (conf_path is null or (conf_path in (:possiblePaths))) " +

src/main/resources/alfio/extension/sample.js

@@ -5,6 +5,7 @@
 function getScriptMetadata() {
     return {
         id: 'myExtensionIdentifier', // optional: id and version will be used later as a mechanism for checking if the script has a newer version
+        displayName: 'My Extension', //mandatory: the name displayed in the configuration page
         version: 0, // optional
         async: false,
         events: [

src/main/webapp/resources/angular-templates/admin/partials/configuration/system.html

@@ -225,7 +225,7 @@ <h2>Extensions</h2>
         </div>
         <div class="panel panel-default" data-ng-repeat="settingId in systemConf.extensionSettings | keys">
             <div class="panel-heading">
-                <div class="panel-title"><i class="fa fa-plug"></i> {{systemConf.extensionSettings[settingId][0].extensionName}}</div>
+                <div class="panel-title"><i class="fa fa-plug"></i> {{systemConf.extensionSettings[settingId][0].extensionDisplayName}}</div>
             </div>
             <div class="panel-body">
                 <div>