Changeset 6570

Timestamp:

Oct 22, 2014, 7:55:46 AM (8 years ago)

Author:

Nicklas Nordborg

Message:

References #1867: Prevent browsers from caching scripts and style sheets between releases

Now also checks if an absolute path is pointing to a file from an extensions and uses the version from the extension if so.

Added the same functionality to taglibs used by extensions to add extra scripts and style sheets.

Location:

branches/3.3-stable/src/clients/web/net/sf/basedb/clients/web/taglib

Files:

• Head.java (modified) (5 diffs)
• extensions/Scripts.java (modified) (2 diffs)
• extensions/Stylesheets.java (modified) (2 diffs)

branches/3.3-stable/src/clients/web/net/sf/basedb/clients/web/taglib/Head.java

@@ -103 +103 @@
   private static final Map<String, String> xtVersions = new HashMap<String, String>();
 
-  // Match files under /extensions path. group 2 is the JAR file name
+  // Match files under /base-root/extensions path. group 1 is the JAR file name
   private static final Pattern PATH_MATCH = 
-      Pattern.compile("(" + ExtensionsControl.RESOURCES_URL + "/([^/]+)/(.*))");
-
-  /**
-    Register the version for an exteniosn JAR file
+      Pattern.compile("/?[^/]*" + ExtensionsControl.RESOURCES_URL + "/([^/]+)/(.*)");
+
+  /**
+    Register the version for an exteniosn JAR file.
+    Used for appending a query parameter to all scripts and style sheets
+    to prevent that browsers cache the old version.
+    @see #getVersionParameter(String)
     @since 3.3.2
   */
@@ -119 +122 @@
   }
 
+  /**
+    Get query parameter to the given absolute path (including root directory).
+    If the path points to a file in the /base-root/extensions/ directory the version
+    of the extension is used, otherwise the BASE version is used. The
+    returned parameter is of the form v=<version>.
+    @param absolutePath An absolute path with or without the base-root directory
+    @since 3.3.2
+  */
+  public static final String getVersionParameter(String absolutePath)
+  {
+    Matcher m = PATH_MATCH.matcher(absolutePath);
+    String version = globalVersion;
+    if (m.matches())
+    {
+      String jarFile = m.group(1);
+      if (xtVersions.containsKey(jarFile))
+      {
+        version = xtVersions.get(jarFile);
+      }
+    }
+    return version;
+  }
+
+  
   /**
     The parent &lt;base:page&gt; tag.
@@ -179 +206 @@
       {
         // Full absolute path 
-        sb.append(style).append(pp).append(globalVersion);
+        sb.append(style).append(pp).append(getVersionParameter(style));
       }
       else if (style.startsWith("/"))
       {
-        // Absolute path is relative the page root (eg. /foo/bar.css --> /base/foo/bar.css)
-        sb.append(appRoot).append(style.substring(1)).append(pp).append(globalVersion);
+        sb.append(appRoot).append(style.substring(1)).append(pp).append(getVersionParameter(style));
       }
       else if (style.startsWith("~"))
@@ -229 +255 @@
       {
         // Full absolute path 
-        sb.append(script).append(pp).append(globalVersion);
+        sb.append(script).append(pp).append(getVersionParameter(script));
       }
       else if (script.startsWith("/"))
       {
         // Absolute path that is relative the BASE root (eg. /foo/bar.js --> /base/foo/bar.js)
-        sb.append(appRoot).append(script.substring(1)).append(pp).append(globalVersion);
+        sb.append(appRoot).append(script.substring(1)).append(pp).append(getVersionParameter(script));
       }
       else if (script.startsWith("~"))
@@ -254 +280 @@
   {
     super.setPageContext(pageContext);
-
+    HttpServletRequest req = (HttpServletRequest)pageContext.getRequest();
     // If we are on /extension subpage, the localVersion is the
     // version for the extension, otherwise we use the global version
-    localVersion = globalVersion;
-    HttpServletRequest req = (HttpServletRequest)pageContext.getRequest();
-    Matcher m = PATH_MATCH.matcher(req.getServletPath());
-    if (m.matches())
-    {
-      String jarFile = m.group(2);
-      if (xtVersions.containsKey(jarFile))
-      {
-        localVersion = xtVersions.get(jarFile);
-      }
-    }
+    localVersion = getVersionParameter(req.getServletPath());
   }
   

branches/3.3-stable/src/clients/web/net/sf/basedb/clients/web/taglib/extensions/Scripts.java

@@ -34 +34 @@
 
 import net.sf.basedb.clients.web.extensions.JspContext;
+import net.sf.basedb.clients.web.taglib.Head;
 
 /**
@@ -92 +93 @@
     for (String script : scripts)
     {
+      char pp = script.indexOf('?') == -1 ? '?' : '&';
       sb.append("<script type=\"text/javascript\" src=\"");
-      sb.append(script);
+      sb.append(script).append(pp).append(Head.getVersionParameter(script));
       sb.append("\" charset=\"UTF-8\"></script>\n");
     }

branches/3.3-stable/src/clients/web/net/sf/basedb/clients/web/taglib/extensions/Stylesheets.java

@@ -34 +34 @@
 
 import net.sf.basedb.clients.web.extensions.JspContext;
+import net.sf.basedb.clients.web.taglib.Head;
 
 /**
@@ -93 +94 @@
     for (String stylesheet : stylesheets)
     {
+      char pp = stylesheet.indexOf('?') == -1 ? '?' : '&';
       sb.append("<link rel=\"stylesheet\" type=\"text/css\" href=\"");
-      sb.append(stylesheet);
+      sb.append(stylesheet).append(pp).append(Head.getVersionParameter(stylesheet));
       sb.append("\">\n");
     }