0035853: Use the StaticResourceProvider in mobile to cache static resources

diff --git a/modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/StaticResourceComponent.java b/modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/StaticResourceComponent.java
--- a/modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/StaticResourceComponent.java
+++ b/modules/org.openbravo.client.kernel/src/org/openbravo/client/kernel/StaticResourceComponent.java
@@ -93,12 +93,6 @@
     final long t1 = System.currentTimeMillis();
 
     try {
-      // note the document.write content must be divided up like this, if the document.write
-      // contains a complete string like <script or </script> then the browser will execute
-      // them
-      // directly and not the document.write, see here:
-      // http://www.codehouse.com/javascript/articles/external/
-
       if (isClassicMode()) {
         // set in the session that we are looking at the new ui
         // note injecting the HttpSession through Weld does not work
@@ -110,7 +104,6 @@
       }
 
       final String appName = getApplicationName();
-
       String staticResourceFileName = resourceProvider.getStaticResourceCachedInfo(appName);
       if (staticResourceFileName == null) {
         staticResourceFileName = getStaticResourceFileName();
@@ -119,29 +112,7 @@
         }
       }
 
-      StringBuilder result = new StringBuilder();
-      final String scriptPath = getContextUrl() + GEN_TARGET_LOCATION.substring(1) + "/"
-          + staticResourceFileName + ".js";
-
-      if (isClassicMode()) {
-        result.append("document.write(\"<LINK rel='stylesheet' type='text/css' href='"
-            + getContextUrl()
-            + "org.openbravo.client.kernel/OBCLKER_Kernel/StyleSheetResources?_skinVersion="
-            + KernelConstants.SKIN_DEFAULT + "&_mode=" + KernelConstants.MODE_PARAMETER_CLASSIC
-            + "'></link>\");\n");
-        result
-            .append("var isomorphicDir='../web/org.openbravo.userinterface.smartclient/isomorphic/';\n");
-
-        final String scDevModulePackage = "org.openbravo.userinterface.smartclient.dev";
-        if (KernelUtils.getInstance().isModulePresent(scDevModulePackage)
-            && KernelUtils.getInstance().getModule(scDevModulePackage).isInDevelopment()) {
-          result
-              .append("document.write('<'+'SCRIPT SRC=' + window.isomorphicDir + 'ISC_Combined.uncompressed.js><'+'/SCRIPT>');");
-        }
-      }
-      result.append("document.write(\"<s\" + \"cript type='text/javascript' src='" + scriptPath
-          + "'><\\/s\"+\"cript>\");");
-      return result.toString();
+      return generateResult(staticResourceFileName);
     } catch (Exception e) {
       log.error("Error generating component; " + e.getMessage(), e);
     } finally {
@@ -151,6 +122,45 @@
     return "";
   }
 
+  /**
+   * Returns the result of the component generation. This method should be overridden by the classes
+   * extending this one in order to return its own result.
+   * 
+   * @param staticResourceFileName
+   *          The name of the static resource file already generated by the component.
+   * @return a String containing the result of the component generation. By default, it returns a
+   *         javascript expression that writes an <script> that imports the generated static
+   *         resource file.
+   */
+  protected String generateResult(String staticResourceFileName) {
+    // note the document.write content must be divided up like this, if the document.write
+    // contains a complete string like <script or </script> then the browser will execute
+    // them directly and not the document.write, see here:
+    // http://www.codehouse.com/javascript/articles/external/
+    StringBuilder result = new StringBuilder();
+    final String scriptPath = getContextUrl() + GEN_TARGET_LOCATION.substring(1) + "/"
+        + staticResourceFileName + ".js";
+    if (isClassicMode()) {
+      result.append("document.write(\"<LINK rel='stylesheet' type='text/css' href='"
+          + getContextUrl()
+          + "org.openbravo.client.kernel/OBCLKER_Kernel/StyleSheetResources?_skinVersion="
+          + KernelConstants.SKIN_DEFAULT + "&_mode=" + KernelConstants.MODE_PARAMETER_CLASSIC
+          + "'></link>\");\n");
+      result
+          .append("var isomorphicDir='../web/org.openbravo.userinterface.smartclient/isomorphic/';\n");
+
+      final String scDevModulePackage = "org.openbravo.userinterface.smartclient.dev";
+      if (KernelUtils.getInstance().isModulePresent(scDevModulePackage)
+          && KernelUtils.getInstance().getModule(scDevModulePackage).isInDevelopment()) {
+        result
+            .append("document.write('<'+'SCRIPT SRC=' + window.isomorphicDir + 'ISC_Combined.uncompressed.js><'+'/SCRIPT>');");
+      }
+    }
+    result.append("document.write(\"<s\" + \"cript type='text/javascript' src='" + scriptPath
+        + "'><\\/s\"+\"cript>\");");
+    return result.toString();
+  }
+
   public String getId() {
     return KernelConstants.RESOURCE_COMPONENT_ID;
   }

# HG changeset patch
# User Jorge Garcia <jorge.garcia@openbravo.com>
# Date 1494414826 -7200
#      Wed May 10 13:13:46 2017 +0200
# Node ID 2edc5b3909053d4c94f0f3627d834257fd18f286
# Parent  a15b5a6fd27fea114b15e36d619a76e6cd442e3d
Fixed issue 35853: Use the StaticResourceProvider in mobile to cache static
resourcesFixed issue

Adapt infrastructure for static resources in mobile applications.

diff --git a/src/org/openbravo/mobile/core/MobileCoreApplicationCacheComponent.java b/src/org/openbravo/mobile/core/MobileCoreApplicationCacheComponent.java
--- a/src/org/openbravo/mobile/core/MobileCoreApplicationCacheComponent.java
+++ b/src/org/openbravo/mobile/core/MobileCoreApplicationCacheComponent.java
@@ -228,6 +228,6 @@
 
   public String getGenFileName() {
     mobileStaticResourceComponent.setParameters(getParameters());
-    return mobileStaticResourceComponent.getGeneratedJavascriptFilename();
+    return mobileStaticResourceComponent.getStaticResourceFileName();
   }
 }
diff --git a/src/org/openbravo/mobile/core/MobileStaticResourceComponent.java b/src/org/openbravo/mobile/core/MobileStaticResourceComponent.java
--- a/src/org/openbravo/mobile/core/MobileStaticResourceComponent.java
+++ b/src/org/openbravo/mobile/core/MobileStaticResourceComponent.java
@@ -8,20 +8,7 @@
  */
 package org.openbravo.mobile.core;
 
-import java.io.File;
-import java.util.HashMap;
-import java.util.List;
-
-import javax.inject.Inject;
-import javax.servlet.ServletContext;
-
-import org.apache.commons.codec.digest.DigestUtils;
-import org.apache.log4j.Logger;
-import org.openbravo.client.kernel.BaseComponent;
-import org.openbravo.client.kernel.KernelConstants;
-import org.openbravo.client.kernel.KernelUtils;
 import org.openbravo.client.kernel.StaticResourceComponent;
-import org.openbravo.model.ad.module.Module;
 
 /**
  * Provides the components which generates the static resources such as the javascript loaded in the
@@ -29,152 +16,16 @@
  * 
  * @author mtaal, ral
  */
-public class MobileStaticResourceComponent extends BaseComponent {
-  private static final Logger log = Logger.getLogger(MobileStaticResourceComponent.class);
-
-  // generatedJavascriptFilenames does not need to be synchronized because its used in a
-  // synchronized method. If this variable is accesed out of the synchronized scope, it should be
-  // synchronized
-  private static HashMap<String, String> generatedJavascriptFilenames = new HashMap<String, String>();
-
-  // remember the last moduleVersion md5
-  private static String modulesVersionMd5 = null;
-
-  public static boolean isDevelopment() {
-    for (final Module module : KernelUtils.getInstance().getModulesOrderedByDependency()) {
-      if (module.isInDevelopment()) {
-        return true;
-      }
-    }
-    return false;
-  }
-
-  /**
-   * generates a new javascript file if the conditions are met: when tomcat starts, or in
-   * development, or when some module have changed version, or if the file didn't exists. This will
-   * not happen even if any of the javascript files has changed its code.
-   *
-   * synchronized because its quite heavy to do and race conditions would be nasty
-   */
-  private static synchronized String generateStaticResources(final StaticResourceComponent src,
-      final String realPath, final String appName) {
-
-    // verify if the moduleVersion has changed since the last tomcat start
-    final String currentModulesVersionMd5 = getModulesVersionMd5();
-    final boolean isModuleVersionChange = currentModulesVersionMd5 == modulesVersionMd5;
-
-    // retrieve the previous generatedJavascriptFilename if exists
-    final String existingJavascriptFilename = generatedJavascriptFilenames.get(appName);
-
-    // explicitely calling the io subsystem gives tomcat the ability to not fail in the first
-    // request if that request was made when tomcat just finished to started up. I have no idea
-    // why and could be wrong, could change depending on tomcat versions, could be etc.
-    // this is required even if the fileName is null
-    final boolean isFileExists = new File(realPath + "/" + existingJavascriptFilename + ".js")
-        .exists();
-
-    /*
-     * set forceGeneration to 'true' to force the generation of a new javascript if the javascript
-     * content changed. useful for development if no module is 'in development'
-     */
-    final boolean forceGeneration = false;
-
-    // decide if a new javascript file must be generated. See conditions above
-    if (existingJavascriptFilename == null //
-        || isDevelopment() //
-        || isModuleVersionChange //
-        || !isFileExists //
-        || forceGeneration) {
-
-      // staticResourceComponent creates the directory structure
-      final String generatedJavascriptMd5 = src.getStaticResourceFileName();
-
-      final File newGeneratedFile = new File(realPath + "/" + generatedJavascriptMd5 + ".js");
-
-      // get the modules version md5
-      modulesVersionMd5 = currentModulesVersionMd5;
-
-      // generate the definitive filename
-      final String newGeneratedJavascriptFilename = DigestUtils.md5Hex(generatedJavascriptMd5
-          + modulesVersionMd5)
-          + "_" + appName;
-
-      // if the filename has changed, use it. otherwise, delete the generated javascript file
-      if (newGeneratedJavascriptFilename.equals(existingJavascriptFilename) && isFileExists) {
-        // delete the generated file, as we don't need it and we don't want to use it because the
-        // timestamp would be updated and, thus, the manifest would be invalidated
-        newGeneratedFile.delete();
-      } else {
-        // rename the staticResouceComponent generated file to the definitive filename
-        newGeneratedFile
-            .renameTo(new File(realPath + "/" + newGeneratedJavascriptFilename + ".js"));
-        // remember the filename
-        generatedJavascriptFilenames.put(appName, newGeneratedJavascriptFilename);
-        String message = String.format("A new javascript file (%s) has been created at '%s'",
-            generatedJavascriptFilenames.get(appName), newGeneratedFile.getParent());
-        log.info(message);
-      }
-
-      // delete all other appName generated files, as no terminal should use them anymore
-      if (new File(realPath).exists()) {
-        for (final File file : new File(realPath + "/").listFiles()) {
-          if (file.getName().contains(appName)
-              && !file.getName().contains(generatedJavascriptFilenames.get(appName))) {
-            file.delete();
-          }
-        }
-      }
-    }
-
-    return generatedJavascriptFilenames.get(appName);
-  }
-
-  private static String getModulesVersionMd5() {
-    final StringBuffer versionString = new StringBuffer();
-    final List<Module> modules = KernelUtils.getInstance().getModulesOrderedByDependency();
-    for (final Module module : modules) {
-      versionString.append(module.getVersion());
-    }
-    return DigestUtils.md5Hex(versionString.toString());
-  }
-
-  @Inject
-  private StaticResourceComponent staticResourceComponent;
+public class MobileStaticResourceComponent extends StaticResourceComponent {
 
   @Override
-  public String generate() {
+  public String generateResult(String staticResourceFileName) {
     return ("enyo.depends('" + getContextUrl() + StaticResourceComponent.GEN_TARGET_LOCATION + "/"
-        + getGeneratedJavascriptFilename() + ".js" + "');").replaceAll("//", "/");
-  }
-
-  /**
-   * the exposed method to get the generated javascript filename if the file does not exists, the
-   * file is created before this method returns. this can take several milliseconds
-   */
-  public String getGeneratedJavascriptFilename() {
-    staticResourceComponent.setParameters(getParameters());
-    final ServletContext context = (ServletContext) getParameters().get(
-        KernelConstants.SERVLET_CONTEXT);
-    final String appName = getParameters().containsKey("_appName") ? (String) getParameters().get(
-        "_appName") : MobileCoreConstants.RETAIL_CORE;
-    return generateStaticResources(staticResourceComponent,
-        context.getRealPath(StaticResourceComponent.GEN_TARGET_LOCATION), appName);
-  }
-
-  @Override
-  public Object getData() {
-    return null;
+        + staticResourceFileName + ".js" + "');").replaceAll("//", "/");
   }
 
   @Override
   public boolean bypassAuthentication() {
     return true;
   }
-
-  @Override
-  public String getETag() {
-    // prevent the browser to cache this class call
-    // i.e.: "../../org.openbravo.mobile.core/OBMOBC_Main/StaticResources?_appName=xxxx"
-    return String.valueOf(System.currentTimeMillis());
-  }
 }
\ No newline at end of file
diff --git a/src/org/openbravo/mobile/core/login/MobileCoreLoginHandler.java b/src/org/openbravo/mobile/core/login/MobileCoreLoginHandler.java
--- a/src/org/openbravo/mobile/core/login/MobileCoreLoginHandler.java
+++ b/src/org/openbravo/mobile/core/login/MobileCoreLoginHandler.java
@@ -71,7 +71,7 @@
   private MobileDefaultsHandler defaultsHandler;
 
   @Inject
-  private MobileStaticResourceComponent staticResourceComponent;
+  private MobileStaticResourceComponent mobileStaticResourceComponent;
 
   @Override
   public void service(HttpServletRequest request, HttpServletResponse response) throws IOException,
@@ -183,8 +183,8 @@
         if (parameters.get("appName") != null) {
           parameters.put("_appName", parameters.get("appName"));
         }
-        staticResourceComponent.setParameters(parameters);
-        jsonMsg.put("sourceVersion", staticResourceComponent.getGeneratedJavascriptFilename());
+        mobileStaticResourceComponent.setParameters(parameters);
+        jsonMsg.put("sourceVersion", mobileStaticResourceComponent.getStaticResourceFileName());
       } else {
         errorLogin(res, vars, session, "OBMOBC_NO_POS_ROLE_TITLE", "OBMOBC_NO_POS_ROLE_MSG",
             Collections.singletonList(defaultsHandler.getDefaults(appName).getAppName()));
diff --git a/src/org/openbravo/mobile/core/process/JSONProcessSimple.java b/src/org/openbravo/mobile/core/process/JSONProcessSimple.java
--- a/src/org/openbravo/mobile/core/process/JSONProcessSimple.java
+++ b/src/org/openbravo/mobile/core/process/JSONProcessSimple.java
@@ -73,11 +73,11 @@
               parameters.put("_appName", jsonsent.getString("appName"));
             }
             mobileStaticResourceComponent.setParameters(parameters);
-            if (!MobileStaticResourceComponent.isDevelopment()) {
+            if (!mobileStaticResourceComponent.isInDevelopment()) {
               if (RequestContext.get().getSession() != null
                   && RequestContext.get().getSessionAttribute("sourceVersion") == null) {
                 RequestContext.get().setSessionAttribute("sourceVersion",
-                    mobileStaticResourceComponent.getGeneratedJavascriptFilename());
+                    mobileStaticResourceComponent.getStaticResourceFileName());
               }
               response.put("sourceVersion",
                   RequestContext.get().getSessionAttribute("sourceVersion"));