Changeset 6562

Timestamp:

Oct 14, 2014, 7:53:51 AM (9 years ago)

Author:

Nicklas Nordborg

Message:

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

Append version numbers to URLs for scripts and style sheets. Uses BASE version (?v=3.3.2) except for files in /extensions directory which uses the extension version (?v=2.16.1).

Location:

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

Files:

• extensions/WebClientRegisterExtensionsProcessor.java (modified) (2 diffs)
• taglib/Head.java (modified) (6 diffs)

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

@@ -23 +23 @@
 
 import net.sf.basedb.clients.web.servlet.ContentSecurityPolicyFilter;
+import net.sf.basedb.clients.web.taglib.Head;
 import net.sf.basedb.core.plugin.About;
 import net.sf.basedb.util.Values;
@@ -98 +99 @@
       ContentSecurityPolicyFilter.setSafeResources(xtFile.getName(), safeResources);
     }
+    // Register the version of this extension so
+    // we can append ?version to script and css URLs
+    if (about != null && about.getVersion() != null)
+    {
+      Head.setExtensionVersion(xtFile.getName(), about.getVersion());
+    }
 
     super.processFile(manager, wFile);

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

@@ -23 +23 @@
 package net.sf.basedb.clients.web.taglib;
 
+import net.sf.basedb.clients.web.extensions.ExtensionsControl;
+import net.sf.basedb.clients.web.util.HTML;
 import net.sf.basedb.core.SessionControl;
+import net.sf.basedb.core.Version;
 import net.sf.basedb.util.Values;
 
+import java.util.HashMap;
 import java.util.LinkedHashSet;
 import java.util.Arrays;
-
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import javax.servlet.http.HttpServletRequest;
 import javax.servlet.jsp.JspException;
 import javax.servlet.jsp.JspTagException;
+import javax.servlet.jsp.PageContext;
 import javax.servlet.jsp.tagext.TagSupport;
 
@@ -91 +100 @@
   private static final long serialVersionUID = 948719986796860767L;
 
+  // Contain the file name of extension JAR files mapped to versions
+  private static final Map<String, String> xtVersions = new HashMap<String, String>();
+
+  // Match files under /extensions path. group 2 is the JAR file name
+  private static final Pattern PATH_MATCH = 
+      Pattern.compile("(" + ExtensionsControl.RESOURCES_URL + "/([^/]+)/(.*))");
+
+  /**
+    Register the version for an exteniosn JAR file
+    @since 3.3.2
+  */
+  public static void setExtensionVersion(String jarName, String version)
+  {
+    synchronized (xtVersions)
+    {
+      xtVersions.put(jarName, "v="+HTML.urlEncode(version));
+    }
+  }
+
   /**
     The parent &lt;base:page&gt; tag.
@@ -105 +133 @@
   */
   private String scripts = null;
+  
+  private static final String globalVersion = "v=" + Version.getMajor()+"."+Version.getMinor()+"."+Version.getMaintenance();
+  private String localVersion;
   
   /*
@@ -143 +174 @@
     for (String style : allStyles)
     {
+      char pp = style.indexOf('?') == -1 ? '?' : '&';
       sb.append("\t<link rel=\"stylesheet\" type=\"text/css\" href=\"");
       if (style.startsWith(appRoot))
       {
         // Full absolute path 
-        sb.append(style);
+        sb.append(style).append(pp).append(globalVersion);
       }
       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));
+        sb.append(appRoot).append(style.substring(1)).append(pp).append(globalVersion);
       }
       else if (style.startsWith("~"))
       {
         // Relative path is relative the current page (eg. ~bar.css --> bar.css)
-        sb.append(style.substring(1));
+        sb.append(style.substring(1)).append(pp).append(localVersion);
       }
       else
       {
         // All other style sheets are in the /include/styles folder
-        sb.append(appRoot).append("include/styles/").append(style);
+        sb.append(appRoot).append("include/styles/").append(style).append(pp).append(globalVersion);
       }
       sb.append("\">\n");
@@ -192 +224 @@
     for (String script : allScripts)
     {
+      char pp = script.indexOf('?') == -1 ? '?' : '&';
       sb.append("\t<script type=\"text/javascript\" charset=\"UTF-8\" src=\"");
       if (script.startsWith(appRoot))
       {
         // Full absolute path 
-        sb.append(script);
+        sb.append(script).append(pp).append(globalVersion);
       }
       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));
+        sb.append(appRoot).append(script.substring(1)).append(pp).append(globalVersion);
       }
       else if (script.startsWith("~"))
       {
         // Relative path is relative the current page (eg. ~bar.js --> bar.js)
-        sb.append(script.substring(1));
+        sb.append(script.substring(1)).append(pp).append(localVersion);
       }
       else
       {
         // All other scripts are in the /include/scripts folder
-        sb.append(appRoot).append("include/scripts/").append(script);
+        sb.append(appRoot).append("include/scripts/").append(script).append(pp).append(globalVersion);
       }
       sb.append("\"></script>\n");
@@ -217 +250 @@
   }
 
+  @Override
+  public void setPageContext(PageContext pageContext) 
+  {
+    super.setPageContext(pageContext);
+
+    // 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);
+      }
+    }
+  }
+  
+  
   @Override
   public int doStartTag()