Study to template (#906)

Provides the tester user a way to convert studies into templates.

closes #905

Frontend:
- Create template: Provide an option in the study browser to convert a study into a template.
- Update template metadata: Enable the textfields of a template if it belongs to that user.
- Delete template: Provide an option in the study browser to delete a template if it belongs to that user.

Backend:
- Update the openapi specs to enable such a feature. (as_template)
- Implement the Study -> Template converter
- Only super-users allowed to create templates
- cleanup all dta/project json resources

Author: odeimaiz

api/specs/webserver/v0/openapi-projects.yaml

@@ -49,6 +49,11 @@ paths:
           schema:
             type: string
           description: 'Option to create a project from existing template: from_template={template_uuid}'
+        - name: as_template
+          in: query
+          schema:
+            type: string
+          description: 'Option to create a template from existing project: as_template={study_uuid}'
       requestBody:
         content:
           application/json:

services/web/client/source/class/qxapp/data/Permissions.js

@@ -83,6 +83,7 @@ qx.Class.define("qxapp.data.Permissions", {
 
   members: {
     __userRole: null,
+    __userLogin: null,
 
     getRole() {
       return this.__userRole;
@@ -95,6 +96,10 @@ qx.Class.define("qxapp.data.Permissions", {
       this.__userRole = role;
     },
 
+    getLogin() {
+      return this.__userLogin;
+    },
+
     getChildrenRoles(role) {
       role = role.toLowerCase();
       const childrenRoles = [];
@@ -151,7 +156,10 @@ qx.Class.define("qxapp.data.Permissions", {
           "preferences.role.update",
           "study.nodestree.uuid.read",
           "study.filestree.uuid.read",
-          "study.logger.debug.read"
+          "study.logger.debug.read",
+          "studies.template.create",
+          "studies.template.update",
+          "studies.template.delete"
         ],
         "admin": []
       };
@@ -215,6 +223,7 @@ qx.Class.define("qxapp.data.Permissions", {
       profile.addListenerOnce("getSuccess", e => {
         let profileData = e.getRequest().getResponse().data;
         this.__userRole = profileData.role;
+        this.__userLogin = profileData.login;
         this.fireDataEvent("userProfileRecieved", true);
       }, this);
       profile.addListenerOnce("getError", e => {

services/web/client/source/class/qxapp/desktop/StudyBrowser.js

@@ -513,13 +513,19 @@ qx.Class.define("qxapp.desktop.StudyBrowser", {
       });
     },
 
-    __createForm: function(studyData, fromTemplate) {
+    __createForm: function(studyData, isTemplate) {
       while (this.__editStudyLayout.getChildren().length > 1) {
         this.__editStudyLayout.removeAt(1);
       }
 
+      const canCreateTemplate = qxapp.data.Permissions.getInstance().canDo("studies.template.create");
+      const canUpdateTemplate = qxapp.data.Permissions.getInstance().canDo("studies.template.update");
+      const canDeleteTemplate = qxapp.data.Permissions.getInstance().canDo("studies.template.delete");
+      const isMyTemplate = studyData["prjOwner"] === qxapp.data.Permissions.getInstance().getLogin();
+
       const itemsToBeDisplayed = ["name", "description", "thumbnail", "prjOwner", "creationDate", "lastChangeDate"];
-      const itemsToBeModified = fromTemplate ? [] : ["name", "description", "thumbnail"];
+      const itemsToBeModified = (isTemplate && !(canUpdateTemplate && isMyTemplate)) ? [] : ["name", "description", "thumbnail"];
+
       let form = new qx.ui.form.Form();
       let control;
       for (const dataId in studyData) {
@@ -571,7 +577,7 @@ qx.Class.define("qxapp.desktop.StudyBrowser", {
       // buttons
       let saveButton = new qx.ui.form.Button(this.tr("Save"));
       saveButton.setMinWidth(70);
-      saveButton.setEnabled(!fromTemplate);
+      saveButton.setEnabled(!isTemplate || (canUpdateTemplate && isMyTemplate));
       saveButton.addListener("execute", e => {
         for (let i=0; i<itemsToBeModified.length; i++) {
           const key = itemsToBeModified[i];
@@ -582,7 +588,11 @@ qx.Class.define("qxapp.desktop.StudyBrowser", {
         let resource = this.__studyResources.project;
 
         resource.addListenerOnce("putSuccess", ev => {
-          this.reloadUserStudies();
+          if (isTemplate) {
+            this.reloadTemplateStudies();
+          } else {
+            this.reloadUserStudies();
+          }
         }, this);
 
         resource.put({
@@ -593,6 +603,35 @@ qx.Class.define("qxapp.desktop.StudyBrowser", {
       }, this);
       form.addButton(saveButton);
 
+      if (!isTemplate && canCreateTemplate) {
+        const saveAsButton = new qx.ui.form.Button(this.tr("Save As Template"));
+        saveAsButton.setMinWidth(70);
+
+        saveAsButton.addListener("execute", e => {
+          for (let i=0; i<itemsToBeModified.length; i++) {
+            const key = itemsToBeModified[i];
+            let getter = "get" + qx.lang.String.firstUp(key);
+            let newVal = model[getter]();
+            studyData[key] = newVal;
+          }
+
+          const resources = this.__studyResources.projects;
+
+          resources.addListenerOnce("postSaveAsTemplateSuccess", ev => {
+            console.log(ev);
+            this.reloadTemplateStudies();
+          }, this);
+          resources.addListenerOnce("postSaveAsTemplateError", ev => {
+            console.error(ev);
+          });
+          resources.postSaveAsTemplate({
+            "study_id": studyData["uuid"]
+          }, studyData);
+        }, this);
+
+        form.addButton(saveAsButton);
+      }
+
       let cancelButton = new qx.ui.form.Button(this.tr("Cancel"));
       cancelButton.setMinWidth(70);
       cancelButton.addListener("execute", e => {
@@ -602,14 +641,14 @@ qx.Class.define("qxapp.desktop.StudyBrowser", {
 
       let deleteButton = new qx.ui.form.Button(this.tr("Delete"));
       deleteButton.setMinWidth(70);
-      deleteButton.setEnabled(!fromTemplate);
+      deleteButton.setEnabled(!isTemplate || (canDeleteTemplate && isMyTemplate));
       deleteButton.addListener("execute", e => {
         let win = this.__createConfirmWindow();
         win.center();
         win.open();
         win.addListener("close", () => {
           if (win["value"] === 1) {
-            this.__deleteStudy(studyData);
+            this.__deleteStudy(studyData, isTemplate);
           }
         }, this);
       }, this);
@@ -618,13 +657,17 @@ qx.Class.define("qxapp.desktop.StudyBrowser", {
       this.__editStudyLayout.add(new qx.ui.form.renderer.Single(form));
     },
 
-    __deleteStudy: function(studyData) {
+    __deleteStudy: function(studyData, isTemplate = false) {
       this.__stopInteractiveServicesInStudy(studyData);
 
       let resource = this.__studyResources.project;
 
       resource.addListenerOnce("delSuccess", ev => {
-        this.reloadUserStudies();
+        if (isTemplate) {
+          this.reloadTemplateStudies();
+        } else {
+          this.reloadUserStudies();
+        }
       }, this);
 
       resource.del({

services/web/client/source/class/qxapp/io/rest/ResourceFactory.js

@@ -126,6 +126,11 @@ qx.Class.define("qxapp.io.rest.ResourceFactory", {
         postFromTemplate: {
           method: "POST",
           url: basePath+"/projects?from_template={template_id}"
+        },
+
+        postSaveAsTemplate: {
+          method: "POST",
+          url: basePath+"/projects?as_template={study_id}"
         }
       });