Changeset 35763

Timestamp:

2021-12-03T12:10:48+13:00 (2 years ago)

Author:

cstephen

Message:

Improve various components

Location:

gs3-extensions/atea-nlp-tools/trunk/src/koreromaori-proxy

Files:

• build.xml (modified) (5 diffs)
• src/main/java/org/atea/nlptools/koreromaoriproxy/TranscriptionServlet.java (modified) (6 diffs)
• src/main/java/org/atea/nlptools/koreromaoriproxy/models/HttpStatusCode.java (added)
• src/main/java/org/atea/nlptools/koreromaoriproxy/services/ReoTuhituhiApiService.java (modified) (2 diffs)
• src/main/webapp/WEB-INF/log4j2.xml (modified) (1 diff)

gs3-extensions/atea-nlp-tools/trunk/src/koreromaori-proxy/build.xml

@@ -2 +2 @@
 
 <project name="gs3-koreromaori-ext" default="usage" basedir=".">
-    <loadproperties prefix="gs3." srcFile="${basedir}/../../../build.properties" />
+    <property name="package.name" value="gs3-koreromaori" />
+    <property environment="env"/>
+    <property name="gsdl3.src.home" value="${env.GSDL3SRCHOME}"/>
     <property name="src.home" value="${basedir}/src/main/java" />
     <property name="build.home" value="${basedir}/build" />
     <property name="web.dir" value="${basedir}/src/main/webapp" />
-    
-    <condition property="tomcat.dir" value="${gs3.tomcat.installed.path}" else="${basedir}/../../../packages/tomcat">
-        <and>
-            <isset property="gs3.tomcat.installed.path" />
-            <not>
-                <equals arg1="${gs3.tomcat.installed.path}" arg2="" />
-            </not>
-        </and>
-    </condition>
-    
-    <property name="tomcat.webapps.dir" value="${tomcat.dir}/webapps" />
+    <property name="tomcat.webapps.dir" value="${gsdl3.src.home}/packages/tomcat/webapps" />
     
     <path id="compile.classpath">
@@ -23 +15 @@
         </fileset>
     </path>
+
+    <!-- Targets -->
+    <target name="usage" description="Print a help message">
+        <echo message="  Execute 'ant -projecthelp' for a list of targets." />
+        <echo message="  Execute 'ant -help' for Ant help." />
+    </target>
     
-    <!-- Targets -->
+    <target name="gs3-setup" description="Ensures that the gs3-setup script has been sourced.">
+        <fail message="Please run 'gs3-setup' (Windows) or 'source gs3-setup.sh' (Linux/Mac) in the Greenstone3 installation that's associated with this installation before running this step.">
+            <condition>
+                <not>
+                    <isset property="env.GSDL3HOME" />
+                </not>
+            </condition>
+        </fail>
+    </target>
+
     <target name="file-checks" description="Ensures that required external files exist.">
         <fail message="config.properties was not found. Please run ${basedir}/setup.sh">
@@ -33 +40 @@
             </condition>
         </fail>
-     </target>
-
-    <target name="usage" description="Print a help message">
-        <echo message="  Execute 'ant -projecthelp' for a list of targets." />
-        <echo message="  Execute 'ant -help' for Ant help." />
-    </target>
+    </target>
     
     <target name="compile" description="Compile any java classes.">
@@ -57 +59 @@
     
     <target name="package" depends="file-checks,compile" description="Packages the Korero Maori interface into a war file.">
-        <echo message="Creating ${build.home}/gs3-koreromaori.war" />
-
-        <!-- <copy file="${basedir}/log4j2.xml" todir="${build.classes}" /> -->
+        <echo message="Creating ${build.home}/${package.name}.war" />
             
-        <war destfile="${build.home}/gs3-koreromaori.war" webxml="${web.dir}/WEB-INF/web.xml">
+        <war destfile="${build.home}/${package.name}.war" webxml="${web.dir}/WEB-INF/web.xml">
             <fileset dir="${web.dir}/webContent" includes="**" />
             <fileset file="${basedir}/config.properties" />
         
-            <lib dir="lib/java">
-                <exclude name="tomcat-servlet-api-8.5.51.jar" /> <!-- The tomcat server should already have its own server-api jar -->
-            </lib>
-            
+            <lib dir="lib/java" />
             <classes dir="${build.classes}" />
 
@@ -75 +72 @@
     </target>
     
-    <target name="install" depends="package" description="Installs the Korero Maori Interface package.">
+    <target name="install" depends="gs3-setup,package" description="Installs the Korero Maori Interface package.">
         <echo message="Copying war package to ${tomcat.webapps.dir}" />
-        <copy file="${build.home}/gs3-koreromaori.war" todir="${tomcat.webapps.dir}" />
+        <copy file="${build.home}/${package.name}.war" todir="${tomcat.webapps.dir}" />
         <echo message="Done! Tomcat may take a few seconds to recognise the changes." />
     </target>

gs3-extensions/atea-nlp-tools/trunk/src/koreromaori-proxy/src/main/java/org/atea/nlptools/koreromaoriproxy/TranscriptionServlet.java

@@ -24 +24 @@
 import org.apache.logging.log4j.Logger;
 import org.atea.nlptools.koreromaoriproxy.models.AudioFilePart;
+import org.atea.nlptools.koreromaoriproxy.models.HttpStatusCode;
 import org.atea.nlptools.koreromaoriproxy.models.TranscriptionResult;
 import org.atea.nlptools.koreromaoriproxy.models.TranscriptionResultDto;
@@ -50 +51 @@
         Properties prop = new Properties();
 
-        try {
+        try
+        {
             FileInputStream fis = new FileInputStream("../webapps/gs3-koreromaori/config.properties");
             prop.load(fis);
             fis.close();
-        } catch (IOException e) {
+        }
+        catch (IOException e)
+        {
             e.printStackTrace();
         }
@@ -70 +74 @@
         throws IOException
     {
-        response.sendError(403);
+        response.sendError(HttpStatusCode.MethodNotAllowed, "Expected a POST request with form-data.");
     }
     
@@ -88 +92 @@
             if (audioFileKeysParameter == null)
             {
-                response.sendError(400, "Form data was incorrect: missing audioFileKeys part.");
+                response.sendError(HttpStatusCode.BadRequest, "Form data was incorrect: missing audioFileKeys part.");
                 logger.trace("Request rejected due: Form data was missing the audioFileKeys part.");
                 return;
@@ -100 +104 @@
                 // Attempt to get the part that this key specifies should be present
                 Part p = request.getPart(audioFileKey);
-                if (p == null) {
-                    response.sendError(400, "Form data was incorrect: a part key listed in the audioFileKeys was not found.");
+                if (p == null)
+                {
+                    response.sendError(HttpStatusCode.BadRequest, "Form data was incorrect: a part key listed in the audioFileKeys was not found.");
                     logger.trace("Request rejected due: Form data was missing a client-specified part.");
                     return;
@@ -125 +130 @@
         catch (Exception ex)
         {
-            response.sendError(500, "Failed to process the request.");
+            response.sendError(HttpStatusCode.InternalServerError, "An unexpected error occured. Please try again.");
             logger.error("Failed to complete API call", ex);
         }

gs3-extensions/atea-nlp-tools/trunk/src/koreromaori-proxy/src/main/java/org/atea/nlptools/koreromaoriproxy/services/ReoTuhituhiApiService.java

@@ -105 +105 @@
         if (!request.ok())
         {
-            logger.error
-            (
+            logger.error(
                 "The Reo Tuhituhi API returned a non-OK status code {} with message {}",
                 request.code(),
@@ -118 +117 @@
         if (!request.contentType().equals("application/json"))
         {
-            logger.error
-            (
+            logger.error(
                 "The Reo Tuhituhi API returned an invalid content type of {}. Provided content was {}",
                 request.contentType(),

gs3-extensions/atea-nlp-tools/trunk/src/koreromaori-proxy/src/main/webapp/WEB-INF/log4j2.xml

@@ -9 +9 @@
   </Appenders>
   <Loggers>
-    <Root level="trace">
+    <Root level="WARN">
       <AppenderRef ref="FileOutput"/>
     </Root>