Sprint 9

.github/workflows/build.yml

@@ -4,7 +4,7 @@ on: [ push, pull_request, workflow_dispatch ]
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     steps:
       - uses: actions/checkout@v3

.wvr/build-config.js

@@ -41,7 +41,8 @@ const config = {
         return content
           .toString()
           .replace('${AUTH_SERVICE_URL}', 'window.location.protocol + \'//\' + window.location.host + window.location.base + \'/mock/auth\'')
-          .replace('${STOMP_DEBUG}', 'false');
+          .replace('${STOMP_DEBUG}', 'false')
+          .replace('${LOCAL_AUTHENTICATION}', 'true');
       },
     },
   ],

README.md

@@ -66,7 +66,7 @@ $ mvn clean spring-boot:run -Dproduction
 $ mvn clean package -DskipTests -Dproduction -Dassets.uri=file:/opt/vireo/ -Dconfig.uri=file:/opt/vireo/config/
 ```
 
-If build succeeds, you should have both a `vireo-4.2.11.war` and a `vireo-4.2.11-install.zip` in the `target/` directory. When building for production required static assets are copied into the packaged war file and the index.html template is optimized for production. For development a symlink is used to allow the application to access required static assets.
+If build succeeds, you should have both a `vireo-4.3.0.war` and a `vireo-4.3.0-install.zip` in the `target/` directory. When building for production required static assets are copied into the packaged war file and the index.html template is optimized for production. For development a symlink is used to allow the application to access required static assets.
 
 #### Apache Reverse Proxy Config
 
@@ -117,7 +117,7 @@ Unzip package into preferred directory (or any directory you choose):
 
 ```bash
 $ cd /opt/vireo
-$ unzip vireo-4.2.11-install.zip
+$ unzip vireo-4.3.0-install.zip
 ```
 
 ### Directory Structure of installed package
@@ -190,13 +190,13 @@ ln -s /opt/vireo/webapp /opt/tomcat/webapps/ROOT
 Copy war file into Tomcat webapps directory (your location may vary -- this is an example):
 
 ```bash
-$ cp ~/vireo-4.2.11.war /usr/local/tomcat/webapps/vireo.war
+$ cp ~/vireo-4.3.0.war /usr/local/tomcat/webapps/vireo.war
 ```
 
 or as root:
 
 ```bash
-$ cp ~/vireo-4.2.11.war /usr/local/tomcat/webapps/ROOT.war
+$ cp ~/vireo-4.3.0.war /usr/local/tomcat/webapps/ROOT.war
 ```
 
 **if not specifying assets.uri during build the assets will be stored under the vireo webapp's classpath, /opt/tomcat/webapps/vireo/WEB-INF/classes**
@@ -209,7 +209,7 @@ $ cp ~/vireo-4.2.11.war /usr/local/tomcat/webapps/ROOT.war
 ## Running WAR as a stand-alone Spring Boot application
 
 ```bash
-java -jar target/vireo-4.2.11.war
+java -jar target/vireo-4.3.0.war
 ```
 
 <div align="right">(<a href="#readme-top">back to top</a>)</div>

build/appConfig.js.template

@@ -1,6 +1,6 @@
 var appConfig = {
 
-    'version': '4.2.11',
+    'version': '4.3.0',
 
     'allowAnonymous': true,
     'anonymousRole': 'ROLE_ANONYMOUS',
@@ -40,7 +40,7 @@ var appConfig = {
       When set to the boolean false, a modal is not used and Shibboleth login is automatically attempted and no registration link is shown.
       When set to the string 'alternate' to hide the local login (and registration) as if localAuthentication is false and provide an alterate (hidden) login page for local authentication.
      */
-    'localAuthentication': true,
+    'localAuthentication': ${LOCAL_AUTHENTICATION},
 
     /*
        Designate predicates that require date/times value filtering on save.

example.env

@@ -4,14 +4,16 @@
 ##############################
 
 IMAGE_HOST=127.0.0.1
-IMAGE_VERSION=4.2.11
+IMAGE_VERSION=4.3.0
 SERVICE_PROJECT=tdl
 SERVICE_PATH=vireo
 
 NODE_ENV=production
 
 STOMP_DEBUG=false
 
+LOCAL_AUTHENTICATION=true
+
 AUTH_STRATEGY=weaverAuth
 
 AUTH_SERVICE_URL="window.location.protocol + '//' + window.location.host + window.location.base + '/mock/auth'"

package.json

@@ -1,7 +1,7 @@
 {
   "name": "vireo",
   "private": false,
-  "version": "4.2.11",
+  "version": "4.3.0",
   "description": "Vireo 4",
   "homepage": "https://github.com/TexasDigitalLibrary/Vireo",
   "repository": {
@@ -22,7 +22,7 @@
     "build": "wvr build --clean"
   },
   "dependencies": {
-    "@wvr/core": "2.3.0-rc3",
+    "@wvr/core": "2.3.0-rc5",
     "angular-ui-tinymce": "0.0.19",
     "file-saver": "2.0.5",
     "ng-csv": "0.3.6",

pom.xml

@@ -6,7 +6,7 @@
 
   <groupId>org.tdl</groupId>
   <artifactId>vireo</artifactId>
-  <version>4.2.11</version>
+  <version>4.3.0</version>
 
   <name>Vireo</name>
   <description>Vireo Thesis and Dissertation Submission System</description>
@@ -149,6 +149,18 @@
       </exclusions>
     </dependency>
 
+    <dependency>
+      <groupId>org.apache.poi</groupId>
+      <artifactId>poi-ooxml</artifactId>
+      <version>5.2.3</version>
+      <exclusions>
+        <exclusion>
+          <groupId>org.apache.logging.log4j</groupId>
+          <artifactId>log4j-api</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+
     <dependency>
       <groupId>org.apache.tika</groupId>
       <artifactId>tika-core</artifactId>

src/main/java/org/tdl/vireo/ApplicationConstants.java

@@ -0,0 +1,11 @@
+package org.tdl.vireo;
+
+public class ApplicationConstants {
+
+    public static final String UNKNOWN = "Unknown";
+
+    private ApplicationConstants() {
+
+    }
+
+}

src/main/java/org/tdl/vireo/config/constant/ConfigurationName.java

@@ -98,9 +98,6 @@ public class ConfigurationName {
     /** Custom CSS */
     public final static String LEFT_LOGO = "left_logo";
 
-    /** Custom CSS */
-    public final static String RIGTH_LOGO = "right_logo";
-
     /** Custom CSS */
     public final static String CUSTOM_CSS = "custom_css";
 

src/main/java/org/tdl/vireo/controller/OrganizationController.java

@@ -13,6 +13,9 @@
 import java.util.Map;
 import java.util.Optional;
 
+import com.fasterxml.jackson.annotation.JsonView;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -23,16 +26,19 @@
 import org.tdl.vireo.exception.ComponentNotPresentOnOrgException;
 import org.tdl.vireo.exception.SystemEmailRuleNotDeleteableException;
 import org.tdl.vireo.exception.WorkflowStepNonOverrideableException;
+import org.tdl.vireo.model.Action;
 import org.tdl.vireo.model.EmailRecipient;
 import org.tdl.vireo.model.EmailTemplate;
-import org.tdl.vireo.model.EmailWorkflowRule;
+import org.tdl.vireo.model.EmailWorkflowRuleByAction;
+import org.tdl.vireo.model.EmailWorkflowRuleByStatus;
 import org.tdl.vireo.model.FieldPredicate;
 import org.tdl.vireo.model.Organization;
 import org.tdl.vireo.model.Submission;
 import org.tdl.vireo.model.SubmissionStatus;
 import org.tdl.vireo.model.WorkflowStep;
 import org.tdl.vireo.model.repo.AbstractEmailRecipientRepo;
 import org.tdl.vireo.model.repo.EmailTemplateRepo;
+import org.tdl.vireo.model.repo.EmailWorkflowRuleByActionRepo;
 import org.tdl.vireo.model.repo.EmailWorkflowRuleRepo;
 import org.tdl.vireo.model.repo.FieldPredicateRepo;
 import org.tdl.vireo.model.repo.OrganizationRepo;
@@ -42,10 +48,6 @@
 import org.tdl.vireo.view.ShallowOrganizationView;
 import org.tdl.vireo.view.TreeOrganizationView;
 
-import com.fasterxml.jackson.annotation.JsonView;
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
-
 import edu.tamu.weaver.response.ApiResponse;
 import edu.tamu.weaver.response.ApiView;
 import edu.tamu.weaver.validation.aspect.annotation.WeaverValidatedModel;
@@ -70,6 +72,9 @@ public class OrganizationController {
     @Autowired
     private EmailWorkflowRuleRepo emailWorkflowRuleRepo;
 
+    @Autowired
+    private EmailWorkflowRuleByActionRepo emailWorkflowRuleByActionRepo;
+
     @Autowired
     private SubmissionRepo submissionRepo;
 
@@ -254,7 +259,7 @@ public ApiResponse addEmailWorkflowRule(@PathVariable Long requestingOrgId, @Req
         if (emailRecipient == null) {
             response = new ApiResponse(ERROR, "Could not create recipient.");
         } else {
-            EmailWorkflowRule newEmailWorkflowRule = emailWorkflowRuleRepo.create(submissionStatus, emailRecipient, emailTemplate);
+            EmailWorkflowRuleByStatus newEmailWorkflowRule = emailWorkflowRuleRepo.create(submissionStatus, emailRecipient, emailTemplate);
             org.addEmailWorkflowRule(newEmailWorkflowRule);
             organizationRepo.update(org);
 
@@ -275,7 +280,7 @@ public ApiResponse editEmailWorkflowRule(@PathVariable Long requestingOrgId, @Pa
         JsonNode recipientNode = objectMapper.convertValue(data, JsonNode.class).get("recipient");
         EmailTemplate emailTemplate = emailTemplateRepo.findById(Long.valueOf((Integer) data.get("templateId"))).get();
 
-        EmailWorkflowRule emailWorkflowRuleToUpdate = emailWorkflowRuleRepo.findById(emailWorkflowRuleId).get();
+        EmailWorkflowRuleByStatus emailWorkflowRuleToUpdate = emailWorkflowRuleRepo.findById(emailWorkflowRuleId).get();
 
         EmailRecipient emailRecipient = buildRecipient(recipientNode);
 
@@ -301,7 +306,7 @@ public ApiResponse editEmailWorkflowRule(@PathVariable Long requestingOrgId, @Pa
     public ApiResponse removeEmailWorkflowRule(@PathVariable Long requestingOrgId, @PathVariable Long emailWorkflowRuleId) throws SystemEmailRuleNotDeleteableException {
 
         Organization org = organizationRepo.read(requestingOrgId);
-        EmailWorkflowRule rule = emailWorkflowRuleRepo.findById(emailWorkflowRuleId).get();
+        EmailWorkflowRuleByStatus rule = emailWorkflowRuleRepo.findById(emailWorkflowRuleId).get();
 
         if (rule.isSystem()) {
             throw new SystemEmailRuleNotDeleteableException();
@@ -320,7 +325,7 @@ public ApiResponse removeEmailWorkflowRule(@PathVariable Long requestingOrgId, @
     @PreAuthorize("hasRole('MANAGER')")
     public ApiResponse changeEmailWorkflowRuleActivation(@PathVariable Long requestingOrgId, @PathVariable Long emailWorkflowRuleId) {
 
-        EmailWorkflowRule rule = emailWorkflowRuleRepo.findById(emailWorkflowRuleId).get();
+        EmailWorkflowRuleByStatus rule = emailWorkflowRuleRepo.findById(emailWorkflowRuleId).get();
 
         rule.isDisabled(!rule.isDisabled());
 
@@ -331,6 +336,99 @@ public ApiResponse changeEmailWorkflowRuleActivation(@PathVariable Long requesti
         return new ApiResponse(SUCCESS);
     }
 
+    @PreAuthorize("hasRole('MANAGER')")
+    @RequestMapping(value = "/{requestingOrgId}/add-email-workflow-rule-by-action", method = POST)
+    public ApiResponse addEmailWorkflowRuleByAction(@PathVariable Long requestingOrgId, @RequestBody Map<String, Object> data) {
+
+        ApiResponse response = new ApiResponse(SUCCESS);
+
+        Organization org = organizationRepo.read(requestingOrgId);
+        Action action = Action.valueOf((String) data.get("action"));
+        JsonNode recipientNode = objectMapper.convertValue(data, JsonNode.class).get("recipient");
+        EmailTemplate emailTemplate = emailTemplateRepo.findById(Long.valueOf((Integer) data.get("templateId"))).get();
+
+        EmailRecipient emailRecipient = buildRecipient(recipientNode);
+
+        if (emailRecipient == null) {
+            response = new ApiResponse(ERROR, "Could not create recipient.");
+        } else {
+            EmailWorkflowRuleByAction newEmailWorkflowRule = emailWorkflowRuleByActionRepo.create(action, emailRecipient, emailTemplate);
+            org.addEmailWorkflowRuleByAction(newEmailWorkflowRule);
+            organizationRepo.update(org);
+
+            HashMap<String, Object> payload = new HashMap<String, Object>();
+            payload.put("id", newEmailWorkflowRule.getId());
+            response.setPayload(payload);
+        }
+
+        return response;
+    }
+
+    @RequestMapping("/{requestingOrgId}/edit-email-workflow-rule-by-action/{emailWorkflowRuleId}")
+    @PreAuthorize("hasRole('MANAGER')")
+    public ApiResponse editEmailWorkflowRuleByAction(@PathVariable Long requestingOrgId, @PathVariable Long emailWorkflowRuleId, @RequestBody Map<String, Object> data) {
+
+        ApiResponse response = new ApiResponse(SUCCESS);
+
+        JsonNode recipientNode = objectMapper.convertValue(data, JsonNode.class).get("recipient");
+        EmailTemplate emailTemplate = emailTemplateRepo.findById(Long.valueOf((Integer) data.get("templateId"))).get();
+
+        EmailWorkflowRuleByAction emailWorkflowRuleToUpdate = emailWorkflowRuleByActionRepo.findById(emailWorkflowRuleId).get();
+
+        EmailRecipient emailRecipient = buildRecipient(recipientNode);
+
+        if (emailRecipient == null) {
+            response = new ApiResponse(ERROR, "Could not create recipient.");
+        } else {
+
+            emailWorkflowRuleToUpdate.setEmailTemplate(emailTemplate);
+            emailWorkflowRuleToUpdate.setEmailRecipient(emailRecipient);
+
+            // TODO emailWorkflowRuleRepo.update(emailWorkflowRuleToUpdate);
+            emailWorkflowRuleByActionRepo.save(emailWorkflowRuleToUpdate);
+
+            // TODO: Is this needed?
+            organizationRepo.broadcast(requestingOrgId);
+        }
+
+        return response;
+    }
+
+    @RequestMapping("/{requestingOrgId}/remove-email-workflow-rule-by-action/{emailWorkflowRuleId}")
+    @PreAuthorize("hasRole('MANAGER')")
+    public ApiResponse removeEmailWorkflowRuleByAction(@PathVariable Long requestingOrgId, @PathVariable Long emailWorkflowRuleId) throws SystemEmailRuleNotDeleteableException {
+
+        Organization org = organizationRepo.read(requestingOrgId);
+        EmailWorkflowRuleByAction rule = emailWorkflowRuleByActionRepo.findById(emailWorkflowRuleId).get();
+
+        if (rule.isSystem()) {
+            throw new SystemEmailRuleNotDeleteableException();
+        } else {
+
+            org.removeEmailWorkflowRuleByAction(rule);
+            emailWorkflowRuleByActionRepo.delete(rule);
+
+            organizationRepo.update(org);
+
+            return new ApiResponse(SUCCESS);
+        }
+    }
+
+    @RequestMapping("/{requestingOrgId}/change-email-workflow-rule-by-action-activation/{emailWorkflowRuleId}")
+    @PreAuthorize("hasRole('MANAGER')")
+    public ApiResponse changeEmailWorkflowRuleByActionActivation(@PathVariable Long requestingOrgId, @PathVariable Long emailWorkflowRuleId) {
+
+        EmailWorkflowRuleByAction rule = emailWorkflowRuleByActionRepo.findById(emailWorkflowRuleId).get();
+
+        rule.isDisabled(!rule.isDisabled());
+
+        emailWorkflowRuleByActionRepo.save(rule);
+
+        organizationRepo.broadcast(requestingOrgId);
+
+        return new ApiResponse(SUCCESS);
+    }
+
     @RequestMapping("/{requestingOrgId}/count-submissions")
     @PreAuthorize("hasRole('MANAGER')")
     public ApiResponse countSubmissions(@PathVariable Long requestingOrgId) {