#474 #478 #480 rollback a bug fix that removed necessary functionality

Author: Adam Collins

README.md

@@ -123,6 +123,34 @@ The dependent services point to other production servers by default
 ##### Fork [spatial-hub](https://github.com/AtlasOfLivingAustralia/spatial-hub), modify and deploy
 * Use when development of spatial-hub is expected. It can be used with with the other methods.
 
+##### Local files
+* Adding files local to deployment can add new layouts and resources.
+    
+    1. Add a new layout gsp to the ```/data/spatial-hub/views/layouts``` directory.
+        ```
+        /data/spatial-hub/views/layouts/myLayout.gsp
+        ```
+
+    1. Additional assets can be added to the ```/data/spatial-hub/assets``` directory.
+        ```
+        /data/spatial-hub/assets/css/externalCss.css
+        /data/spatial-hub/assets/js/externalJs.js
+        /data/spatial-hub/assets/img/externalImage.png
+        ```
+
+    1. Assets can be referenced within the new layout gsp.
+        ```
+        <asset:stylesheet src="css/externalCss.css" />
+        <asset:javascript src="js/externalJs.js" />
+        <asset:image src="img/externalImg.png" />
+        ```
+
+    1. Change config to use the new layout gsp.
+        ```
+        # edit /data/spatial-hub/config/spatial-hub-config.properties
+        skin.layout=myLayout
+        ```
+
 > **Note:**
 >
 > A forked [commonui-bs3](https://github.com/AtlasOfLivingAustralia/commonui-bs3) can be deployed to ```/data/spatial-hub/assets/``` and used with the config

build.gradle

@@ -7,7 +7,8 @@ buildscript {
     dependencies {
         classpath "org.grails:grails-gradle-plugin:$grailsVersion"
         classpath "gradle.plugin.com.github.erdi.webdriver-binaries:webdriver-binaries-gradle-plugin:2.7"
-        classpath("com.bertramlabs.plugins:asset-pipeline-gradle:3.4.6")
+        classpath "com.bertramlabs.plugins:asset-pipeline-gradle:3.4.6"
+//        classpath 'com.bertramlabs.plugins:asset-pipeline-core:3.2.4'
     }
 }
 
@@ -93,6 +94,8 @@ dependencies {
     implementation group: 'commons-io', name: 'commons-io', version: '2.6'
     implementation group: 'commons-lang', name: 'commons-lang', version: '2.6'
 
+    implementation group: "com.bertramlabs.plugins", name: "asset-pipeline-gradle", version: "3.4.6"
+
     //Angular profile wrapper needs
     assets 'com.craigburke.angular:angular-annotate-asset-pipeline:2.4.1'
     //Fork version in Atlas

grails-app/init/au/org/ala/spatial/portal/BootStrap.groovy

@@ -1,8 +1,11 @@
 package au.org.ala.spatial.portal
 
+import asset.pipeline.AssetPipelineConfigHolder
+import asset.pipeline.fs.FileSystemAssetResolver
 import au.org.ala.cas.util.AuthenticationUtils
 import au.org.ala.web.AuthService
 import grails.converters.JSON
+import org.apache.commons.io.FileUtils
 import org.apache.commons.lang3.StringUtils
 import org.springframework.core.io.FileSystemResource
 import org.springframework.core.io.Resource
@@ -28,9 +31,75 @@ class BootStrap {
         // fix config data types when using a .properties file
         parseConfig()
 
+        // support for external layouts
+        //
+        // e.g. config "skin.layout=myLayout" will use the layout file /data/spatial-hub/views/layouts/myLayout.gsp
+        //
+        // support external files with the asset tag in the layout gsp
+        // e.g.
+        //   files
+        //     /data/spatial-hub/assets/css/externalCss.css
+        //     /data/spatial-hub/assets/js/externalJs.js
+        //     /data/spatial-hub/assets/img/externalImage.png
+        //   asset tags
+        //     <asset:stylesheet src="css/externalCss.css" />
+        //     <asset:javascript src="js/externalJs.js" />
+        //     <asset:image src="img/externalImg.png" />
+        //
+        // Support the use of the default "skin.layout=generic" with a local "headerAndFooter.baseURL" by the creating files
+        //   /data/spatial-hub/assets/css/bootstrap.min.css
+        //   /data/spatial-hub/assets/css/ala-styles.css
+        addExternalViews()
+        addExternalAssets(servletContext)
+
         portalService.updateListQueries()
     }
 
+    def addExternalViews = {
+        groovyPageLocator.addResourceLoader(new ResourceLoader() {
+
+            @Override
+            Resource getResource(String s) {
+                File resource = new File('/data/spatial-hub/views' + s)
+                if (resource.exists()) {
+                    return new FileSystemResource(resource)
+                }
+                return null
+            }
+
+            @Override
+            ClassLoader getClassLoader() {
+                return null
+            }
+        })
+    }
+
+    def addExternalAssets = { servletContext ->
+        try {
+            File src = new File('/data/spatial-hub/assets')
+
+            if (src.exists() && src.isDirectory()) {
+                // asset-pipeline resolves files differently depending on the presence of a manifest
+                if (AssetPipelineConfigHolder.manifest) {
+                    // copy external asset files into expanded war assets directory so they can be discovered
+                    File dst = new File(servletContext.getRealPath("/assets"))
+
+                    if (dst.exists() && dst.isDirectory()) {
+                        FileUtils.copyDirectory(src, dst)
+                    } else {
+                        log.error("External assets are unavailable. Expanded WAR asset directory '${dst.path}' does not exist.")
+                    }
+                } else {
+                    // a new Resolver is required to find the external assets at runtime
+                    def resolver = new FileSystemAssetResolver("external-assets", '/data/spatial-hub/assets', false)
+                    AssetPipelineConfigHolder.registerResolver(resolver)
+                }
+            }
+        } catch (err) {
+            log.error("External assets are not available.", err)
+        }
+    }
+
     def destroy = {
     }