Changeset 4384 for trunk

Timestamp:

Aug 8, 2008, 12:12:25 PM (14 years ago)

Author:

Nicklas Nordborg

Message:

References #1032: Apache server complains "Request-URI Too Large"

Main functionality is in place. The "New experiment" function is fixed and probably all other places where a new window is opened with the Main.openPopup script. Other functions that use 'location.href', 'location.replace' or 'window.open' are not fixed.

Location:

trunk

Files:

• config/dist/web.xml (modified) (1 diff)
• src/clients/web/net/sf/basedb/clients/web/taglib/Head.java (modified) (1 diff)
• src/clients/web/net/sf/basedb/clients/web/taglib/Page.java (modified) (4 diffs)
• www/include/scripts/main.js (modified) (6 diffs)

trunk/config/dist/web.xml

@@ -37 +37 @@
     <location>/exception/exception.jsp</location>
   </error-page>
+  
+  <!-- 
+    If BASE Javascript encounters an URL that is longer than
+    specified by this setting when assigning it to for example
+    location.href = url, BASE will instead try to rewrite the document
+    to generate a POST request instead. This is to avoid problem with
+    web servers that doesn't accept URL:s longer than a specified size
+    For example, Apache has a default max length of 8190. If this setting
+    is 0, the rewrite functionality is disabled.
+  -->
+  <context-param>
+    <param-name>max-url-length</param-name>
+    <param-value>8000</param-value>
+  </context-param>
   
   <!-- 

trunk/src/clients/web/net/sf/basedb/clients/web/taglib/Head.java

@@ -171 +171 @@
     sb.append("\t\t\treturn '").append(sc == null ? "" : sc.getId()).append("';\n");
     sb.append("\t\t}\n");
+    if (page.getMaxUrlLength() != null)
+    {
+      sb.append("\t\tfunction getMaxUrlLength()\n");
+      sb.append("\t\t{\n");
+      sb.append("\t\t\treturn '").append(page.getMaxUrlLength()).append("';\n");
+      sb.append("\t\t}\n");
+    }
     sb.append("\t</script>\n");
   }

trunk/src/clients/web/net/sf/basedb/clients/web/taglib/Page.java

@@ -28 +28 @@
 import net.sf.basedb.core.SessionControl;
 import net.sf.basedb.clients.web.Base;
+import net.sf.basedb.util.Values;
 
 import javax.servlet.jsp.PageContext;
@@ -163 +164 @@
   */
   private static String BASE_VERSION = null;
+  
+  private static String MAX_URL_LENGTH = null;
 
   /**
@@ -221 +224 @@
   {
     return ROOT;
+  }
+  /**
+    @since 2.8
+  */
+  public String getMaxUrlLength()
+  {
+    return MAX_URL_LENGTH;
   }
   public String getServerName()
@@ -246 +256 @@
   {
     super.setPageContext(pageContext);
-    if (ROOT == null) ROOT = ((HttpServletRequest)pageContext.getRequest()).getContextPath()+"/";
+    if (ROOT == null) 
+    {
+      ROOT = ((HttpServletRequest)pageContext.getRequest()).getContextPath()+"/";
+      int maxUrlLength = Values.getInt(pageContext.getServletContext().getInitParameter("max-url-length"));
+      MAX_URL_LENGTH = maxUrlLength > 0 ? String.valueOf(maxUrlLength) : null;
+    }
     try
     {

trunk/www/include/scripts/main.js

@@ -91 +91 @@
       url += '&warnIfOpen=0';
     }
-    window.newWindow = window.open(url, name, options);
-    window.newWindow.isOld = true;
+    newWin.isOld = true;
+    window.newWindow = newWin;
+    Main.safeSetLocation(url, newWin, true);
     setTimeout("window.newWindow.focus()", 100);
   }
@@ -510 +511 @@
         i++;
       }
-      theWindow.location.href = url;
+      Main.safeSetLocation(url, theWindow);
     } 
   }
@@ -540 +541 @@
         i++;
       }
-      theWindow.location.href = url;
+      Main.safeSetLocation(url, theWindow);
     }
   }
@@ -581 +582 @@
     url += '&item_type='+itemType+'&item_id='+itemId;
     if (extraUrl) url += extraUrl;
-    location.href = url;
-  }
-  
-  this.getIdFromLocation = function()
+    Main.safeSetLocation(url);
+  }
+  
+  this.getIdFromLocation = function(url)
   {
     var findId = /ID=([0-9a-f]*)/;
-    var ID = location.search.match(findId)[1];
-    return ID;
+    if (!url) url = location.search;
+    var matches = url.match(findId);
+    return matches && matches.length > 1 ? matches[1] : null;
   }
   
@@ -625 +627 @@
   }
   
-  
-  this.viewSource = function()
-  {
+  /*
+    Safely set the location of a document using as if
+    win.document.location.href = url or win.document.replace(url)
+    had been used. If the url is longer
+    than specified by getMaxUrlLength() function the url will
+    be re-written to a <form> using hidden fields to submit
+    query values.
+    @param url The url to set
+    @param win The window to set the location on, if not given,
+      the current window is assumed
+    @param replace If given, use location.replace() instead of location.href
+      (only if url is not too long)
+  */
+  this.safeSetLocation = function(url, win, replace)
+  {
+    if (!url) return;
+    if (!win) win = window;
+    var postform;
+    if (window.getMaxUrlLength && url.length > window.getMaxUrlLength())
+    {
+      postform = this.convertToPostForm(url, win);
+    }
+    if (postform)
+    {
+      document.body.appendChild(postform);
+      postform.submit();
+    }
+    else if (replace)
+    {
+      win.document.location.replace(url);
+    }
+    else
+    {
+      win.document.location.href = url;
+    }
+  }
+  
+  /*
+    Convert an URL to a HTML form using POST and write it to
+    a document. This method extract all query parameters from the 
+    URL (except ID) and generate a <form> tag with hidden input fields. 
+    The method returns an unattached Form object. To post it, 
+    do: document.body.appendChild(form); form.submit();
+    @param url The url to convert
+    @param win The window the form should post to, if no window is given
+      or if it doesn't have a name the form is posted to the current
+      window.
+  */
+  this.convertToPostForm = function(url, win)
+  {
+    var i = url.indexOf('?');
+    if (i < 0) return null;
+    
+    var query = url.substring(i+1);
+    if (!query) return null;
+    
+    url = url.substring(0, i);
+    var ID = Main.getIdFromLocation(query);
+    if (ID) url += '?ID=' + ID;
+
+    var frm = document.createElement('form');
+    frm.setAttribute('action', url);
+    frm.setAttribute('method', 'post');
+    if (win && win.name) frm.setAttribute('target', win.name);
+    
+    var options = query.split('&');
+    for (var i = 0; i < options.length; i++)
+    {
+      var pair = options[i].split('=');
+      var name = pair[0];
+      var value = decodeURIComponent(pair[1]);
+      if (name && name != 'ID')
+      {
+        Forms.createHidden(frm, name, value, document);
+      }
+    }
+    return frm;
+  }
+  
+  this.viewSource = function(doc)
+  {
+    if (!doc) doc = document;
     this.openPopup('', 'ViewSource', 800, 800);
-    var html = document.body.parentNode.innerHTML;
+    var html = doc.body.parentNode.innerHTML;
     html = html.replace(/\</g, '&lt;');
     html = html.replace(/\>/g, '&gt;');
@@ -1692 +1773 @@
     @param name The name of the hidden element
     @param value The value of the hidden element
-  */
-  this.createHidden = function(frm, name, value)
-  {
-    var hidden = document.createElement('input');
+    @param doc The document to create the element in, if not given
+      uses the global 'document' object
+  */
+  this.createHidden = function(frm, name, value, doc)
+  {
+    if (!doc) doc = document;
+    var hidden = doc.createElement('input');
     hidden.setAttribute('type', 'hidden');
     hidden.setAttribute('name', name);