Providing a notification publisher clone feature

Implemented as per DependencyTrack/dependency-track#1760 (comment)

Signed-off-by: Alioune SY <[email protected]>

Author: syalioune

src/i18n/locales/en.json

@@ -533,10 +533,17 @@
     "delete_template": "Delete Template",
     "template_deleted": "Template deleted",
     "template_basedir": "Template base directory",
+    "template_basedir_tooltip": "This property is used as base directory for notification templates search",
     "general_template_configuration": "General template configuration",
+    "template_override_description": "Switching the template override control on and providing a template base directory allow you to override Dependency Track default notification publisher templates.",
+    "template_override_file_hierarchy": "Any Pebble templates available in the template base directory with the appropriate directory hierarchy and naming scheme (e.g ${base directory}/templates/notification/publisher/email.peb) will override Dependency Track default one.",
+    "template_override_security_warning": "You must set appropriate rights to the template base directory to prevent untrusted third party from supplying fraudulent Pebble templates that could lead to potential remote code execution.",
+    "template_override_restart_needed": "Dependency Track restart is required for the modifications to be taken into account.",
     "enable_default_template_override": "Enable default template override",
     "restore_default_template": "Restore default templates",
-    "default_template_restored": "Default templates restored"
+    "default_template_restored": "Default templates restored",
+    "clone_template": "Clone Template",
+    "template_cloned": "Template cloned"
   },
   "condition": {
     "warning": "Warning",

src/views/administration/notifications/CreateTemplateModal.vue

@@ -44,9 +44,24 @@
 
 <script>
   import permissionsMixin from "../../../mixins/permissionsMixin";
+  import EventBus from "../../../shared/eventbus";
 
   export default {
     mixins: [permissionsMixin],
+    mounted() {
+      EventBus.$on('admin:templates:cloneTemplate', (template) => {
+        this.name = `${template.name} - clone`;
+        this.publisherClass = template.publisherClass;
+        this.description = template.description;
+        this.mimeType = template.templateMimeType;
+        this.template = template.template;
+      });
+      this.$root.$on('bv::modal::hide', (_, modalId) => {
+        if(modalId == 'createTemplateModal') {
+          this.resetValues();
+        }
+      });
+    },
     data() {
       return {
         name: null,
@@ -58,7 +73,6 @@
     },
     methods: {
       createTemplate: function() {
-        this.$root.$emit('bv::hide::modal', 'createTemplateModal');
         let url = `${this.$api.BASE_URL}/${this.$api.URL_NOTIFICATION_PUBLISHER}`;
         this.axios.put(url, {
           name: this.name,
@@ -73,7 +87,7 @@
         }).catch(() => {
           this.$toastr.w(this.$t('condition.unsuccessful_action'));
         });
-        this.resetValues();
+        this.$root.$emit('bv::hide::modal', 'createTemplateModal');
       },
       resetValues: function () {
         this.name = null;

src/views/administration/notifications/GeneralTemplateConfigurationModal.vue

@@ -1,5 +1,9 @@
 <template>
-  <b-modal id="generalTemplateConfigurationModal" size="md" hide-header-close no-stacking :title="$t('admin.general_template_configuration')" @show="loadConfigProperties">
+  <b-modal id="generalTemplateConfigurationModal" size="lg" hide-header-close no-stacking :title="$t('admin.general_template_configuration')" @show="loadConfigProperties">
+    <p>{{ $t('admin.template_override_description') }}</p>
+    <p>{{ $t('admin.template_override_file_hierarchy') }}</p>
+    <p>{{ $t('admin.template_override_security_warning') }}</p>
+    <p>{{ $t('admin.template_override_restart_needed') }}</p>
     <b-form-group>
         <c-switch id="template_override" color="primary" v-model="enableDefaultTemplatesOverride" label v-bind="labelIcon"/>
         {{ $t('admin.enable_default_template_override') }}
@@ -11,12 +15,12 @@
         rules="required"
         type="text"
         v-model="templateBasedir"
-        tooltip="This property is used as base directory for notification templates search."
+        :tooltip="$t('admin.template_basedir_tooltip')"
     />
     <template v-slot:modal-footer="{ cancel }">
       <b-button size="md" variant="secondary" @click="cancel()">{{ $t('message.close') }}</b-button>
       <b-button size="md" variant="primary" @click="updateConfiguration()">{{ $t('message.update') }}</b-button>
-      <b-button size="md" variant="primary" @click="restoreDefaultTemplates()">{{ $t('admin.restore_default_template') }}</b-button>
+      <b-button size="md" variant="warning" @click="restoreDefaultTemplates()">{{ $t('admin.restore_default_template') }}</b-button>
     </template>
   </b-modal>
 </template>

src/views/administration/notifications/Templates.vue

@@ -50,6 +50,9 @@
       EventBus.$on('admin:templates:rowDeleted', () => {
         this.refreshTable();
       });
+      EventBus.$on('admin:templates:cloneTemplate', () => {
+        this.$bvModal.show("createTemplateModal");
+      });
     },
     beforeDestroy() {
       EventBus.$off('admin:templates:rowUpdate');
@@ -126,6 +129,7 @@
                       <b-form-textarea v-else id="input-5" v-model="template.template" rows="10" class="form-control" required trim />
                     </b-form-group>
                     <div style="text-align:right">
+                      <b-button variant="outline-primary" @click="cloneNotificationPublisher">{{ $t('admin.clone_template') }}</b-button>
                       <b-button v-if="!template.defaultPublisher" variant="outline-primary" @click="updateNotificationPublisher">{{ $t('message.update') }}</b-button>
                       <b-button v-if="!template.defaultPublisher" variant="outline-danger" @click="deleteNotificationPublisher">{{ $t('admin.delete_template') }}</b-button>
                     </div>    
@@ -168,6 +172,9 @@
                   }).catch(() => {
                     this.$toastr.w(this.$t('condition.unsuccessful_action'));
                   });
+                },
+                cloneNotificationPublisher: function() {
+                  EventBus.$emit('admin:templates:cloneTemplate', this.template);
                 }
               }
             })