WebScript Runtime response/url model extended to support output of client-side webscript url generation function.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5902 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

config/alfresco/templates/webscripts/org/alfresco/portlets/myspaces.get.html.ftl

@@ -90,7 +90,7 @@
    <div id="spacePanel">
       <#-- populated via an AJAX call to 'myspacespanel' webscript -->
       <#-- resolved path, filter and home.noderef required as arguments -->
-      <script>MySpaces.ServiceContext="${url.serviceContext}";MySpaces.Path="${path?replace("\"","\\\"")}";MySpaces.Filter="${filter}";MySpaces.Home="${home.nodeRef}";</script>
+      <script>MySpaces.ServiceContext="${url.serviceContext}";MySpaces.ScriptUrlEncoder=eval("MySpaces.ScriptUrlEncoder=" + unescape("${url.getClientUrlFunction("encUrl")}"));MySpaces.Path="${path?replace("\"","\\\"")}";MySpaces.Filter="${filter}";MySpaces.Home="${home.nodeRef}";</script>
    </div>
    <div class="spaceFooter">
       <#-- the count value is retrieved and set dynamically from the AJAX webscript output above -->

config/alfresco/templates/webscripts/org/alfresco/portlets/myspacespanel.get.html.ftl

@@ -14,7 +14,10 @@
          <#if d.isDocument>
             <a href="${url.context}${d.url}" target="new" onclick="event.cancelBubble=true"><img class="spaceIconImage" alt="" width="16" height="16" src="${url.context}${d.icon16?replace(".gif",".png")}" border=0></a>
          <#else>
-            <a href="${scripturl("${url.serviceContext}/myspaces?f=${args.f}&p=${args.p}/${d.name}", false)}"><img class="spaceIconImage" alt="" width="16" height="16" src="${url.context}${d.icon16?replace(".gif",".png")}" border="0" onclick="event.cancelBubble=true;"></a>
+            <#-- the component parts need to build up an encoded url to the outer webscript -->
+            <#-- the client-side url encoder method of the outer webscript runtime will be used -->
+            <span class="spaceNavLinkUrl">${url.serviceContext}/myspaces?f=${args.f}&amp;p=${args.p}/${d.name}</span>
+            <span class="spaceNavLinkImg" style="display:none"><img class="spaceIconImage" alt="" width="16" height="16" src="${url.context}${d.icon16?replace(".gif",".png")}" border="0"></span>
          </#if>
          <div style="display:none"><img class="spaceIconImage64" alt="" width="64" height="64" src="${url.context}${d.icon64}"></div>
       </div>

source/java/org/alfresco/web/scripts/AbstractWebScript.java

@@ -206,11 +206,12 @@ public abstract class AbstractWebScript implements WebScript
      * Create a model for script usage
      *  
      * @param req  web script request
+     * @param res  web script response
      * @param customModel  custom model entries
      * 
      * @return  script model
      */
-    final protected Map<String, Object> createScriptModel(WebScriptRequest req, Map<String, Object> customModel)
+    final protected Map<String, Object> createScriptModel(WebScriptRequest req, WebScriptResponse res,  Map<String, Object> customModel)
     {
         // create script model
         Map<String, Object> model = new HashMap<String, Object>(7, 1.0f);
@@ -235,7 +236,7 @@ public abstract class AbstractWebScript implements WebScript
         // add web script context
         model.put("args", createArgModel(req));
         model.put("guest", req.isGuest());
-        model.put("url", new URLModel(req));
+        model.put("url", new URLModel(req, res));
         model.put("server", new ServerModel(descriptorService.getServerDescriptor()));
 
         // add custom model
@@ -282,7 +283,7 @@ public abstract class AbstractWebScript implements WebScript
         // add web script context
         model.put("args", createArgModel(req));
         model.put("guest", req.isGuest());
-        model.put("url", new URLModel(req));
+        model.put("url", new URLModel(req, res));
         model.put("server", new ServerModel(descriptorService.getServerDescriptor()));
         
         // add template support

source/java/org/alfresco/web/scripts/DeclarativeWebScript.java

@@ -109,7 +109,7 @@ public class DeclarativeWebScript extends AbstractWebScript
                 if (logger.isDebugEnabled())
                     logger.debug("Executing script " + executeScript);
                 
-                Map<String, Object> scriptModel = createScriptModel(req, model);
+                Map<String, Object> scriptModel = createScriptModel(req, res, model);
                 // add return model allowing script to add items to template model
                 Map<String, Object> returnModel = new ScriptableHashMap<String, Object>();
                 scriptModel.put("model", returnModel);

source/java/org/alfresco/web/scripts/URLModel.java

@@ -33,15 +33,18 @@ package org.alfresco.web.scripts;
 public class URLModel
 {
     private WebScriptRequest req;
+    private WebScriptResponse res;
     
     /**
      * Construct
      * 
      * @param req
+     * @param res
      */
-    URLModel(WebScriptRequest req)
+    URLModel(WebScriptRequest req, WebScriptResponse res)
     {
         this.req = req;
+        this.res = res;
     }
 
     /**
@@ -153,5 +156,16 @@ public class URLModel
     {
         return getExtension();
     }
-
+    
+    /**
+     * Gets the client url encoding function script 
+     * 
+     * @param name      name of the function object to return
+     * 
+     * @return script to encode urls on the client
+     */
+    public String getClientUrlFunction(String name)
+    {
+        return res.getEncodeScriptUrlFunction(name);
+    }
 }

source/java/org/alfresco/web/scripts/WebScriptRequest.java

@@ -166,5 +166,4 @@ public interface WebScriptRequest
      * @return true => force return of 200, otherwise return status explicitly set
      */
     public boolean forceSuccessStatus();
-    
 }

source/java/org/alfresco/web/scripts/WebScriptRequestImpl.java

@@ -34,7 +34,6 @@ import org.alfresco.web.scripts.WebScriptDescription.FormatStyle;
  */
 public abstract class WebScriptRequestImpl implements WebScriptRequest
 {
-    
     /* (non-Javadoc)
      * @see org.alfresco.web.scripts.WebScriptRequest#getExtensionPath()
      */
@@ -154,5 +153,4 @@ public abstract class WebScriptRequestImpl implements WebScriptRequest
     {
         return false;
     }
-
 }

source/java/org/alfresco/web/scripts/WebScriptResponse.java

@@ -82,11 +82,19 @@ public interface WebScriptResponse
     /**
      * Encode a script URL
      * 
-     * Note: Some Web Script Runtime environments (e.g. portal) require urls to be re-written.
+     * Note: Some Web Script Runtime environments (e.g. JSR-168, JSF) require urls to be re-written.
      * 
-     * @param url  url to encode
+     * @param url  to encode
-     * @return  encoded url
+     * @return encoded url
      */
     public String encodeScriptUrl(String url);
     
+    /**
+     * Return a client side javascript function to build urls to this service
+     *  
+     * @param name      Generated function name
+     *  
+     * @return javascript function definition
+     */
+    public String getEncodeScriptUrlFunction(String name);
 }

source/java/org/alfresco/web/scripts/WebScriptRuntime.java

@@ -204,7 +204,7 @@ public abstract class WebScriptRuntime
             WebScriptResponse res = createResponse();
             Map<String, Object> model = new HashMap<String, Object>();
             model.put("status", status);
-            model.put("url", new URLModel(req));
+            model.put("url", new URLModel(req, res));
             
             // locate status template
             // NOTE: search order...

source/java/org/alfresco/web/scripts/WebScriptServletResponse.java

@@ -30,6 +30,8 @@ import java.io.Writer;
 
 import javax.servlet.http.HttpServletResponse;
 
+import org.alfresco.web.ui.common.Utils;
+
 /**
  * HTTP Servlet Web Script Response
  * 
@@ -113,4 +115,13 @@ public class WebScriptServletResponse implements WebScriptResponse
         return url;
     }
 
+    /* (non-Javadoc)
+     * @see org.alfresco.web.scripts.WebScriptResponse#getEncodeScriptUrlFunction(java.lang.String)
+     */
+    public String getEncodeScriptUrlFunction(String name)
+    {
+        return Utils.encodeJavascript(ENCODE_FUNCTION.replace("$name$", name));
+    }
+    
+    private static final String ENCODE_FUNCTION = "{ $name$: function(url) { return url; } }";
 }

source/java/org/alfresco/web/scripts/WebScriptURLRequest.java

@@ -87,7 +87,6 @@ public abstract class WebScriptURLRequest extends WebScriptRequestImpl
         return urlParts;
     }
 
-    
     /**
      * Construct
      * 
@@ -199,6 +198,4 @@ public abstract class WebScriptURLRequest extends WebScriptRequestImpl
     {
         return queryArgs.get(name);
     }
-
-    
 }

source/java/org/alfresco/web/scripts/jsf/WebScriptJSFRequest.java

@@ -38,7 +38,6 @@ import org.alfresco.web.scripts.WebScriptURLRequest;
  */
 public class WebScriptJSFRequest extends WebScriptURLRequest
 {
-
    /**
     * Constructor
     * 
@@ -85,5 +84,4 @@ public class WebScriptJSFRequest extends WebScriptURLRequest
       // NOTE: unknown in the JSF environment
       return null;
    }
-
 }

source/java/org/alfresco/web/scripts/jsf/WebScriptJSFResponse.java

@@ -105,11 +105,12 @@ public class WebScriptJSFResponse implements WebScriptResponse
       return buf.toString();
    }
 
-   /* (non-Javadoc)
+   /**
     * @see org.alfresco.web.scripts.WebScriptResponse#reset()
     */
    public void reset()
    {
+       // nothing to do
    }
 
    /**
@@ -128,11 +129,12 @@ public class WebScriptJSFResponse implements WebScriptResponse
       return fc.getResponseWriter();
    }
 
-   /* (non-Javadoc)
+   /**
     * @see org.alfresco.web.scripts.WebScriptResponse#setStatus(int)
     */
    public void setStatus(int status)
    {
+      // makes no sense in the JSF env
    }
     
    /**
@@ -142,5 +144,32 @@ public class WebScriptJSFResponse implements WebScriptResponse
    {
       // Alfresco JSF framework only supports the default of text-html
    }
-
+   
+   /* (non-Javadoc)
+    * @see org.alfresco.web.scripts.WebScriptResponse#getEncodeScriptUrlFunction(java.lang.String)
+    */
+   public String getEncodeScriptUrlFunction(String name)
+   {
+      UIForm form = Utils.getParentForm(fc, component);
+      if (form == null)
+      {
+         throw new IllegalStateException("Must nest components inside UIForm to generate form submit!");
+      }
+      String fieldId = component.getClientId(fc);
+      String formClientId = form.getClientId(fc);
+      HtmlFormRendererBase.addHiddenCommandParameter(fc, form, fieldId);
+      
+      String func = ENCODE_FUNCTION.replace("$name$", name);
+      func = func.replace("$formClientId$", formClientId);
+      func = func.replace("$fieldId$", fieldId);
+      return Utils.encodeJavascript(func);
+   }
+   
+   private static final String ENCODE_FUNCTION = 
+            "{ $name$: function(url) {" + 
+            " var out = '';" + 
+            " out += \"#\\\" onclick=\\\"document.forms['$formClientId$']['$fieldId$'].value='\";" + 
+            " out += escape(url);" + 
+            " out += \"';document.forms['$formClientId$'].submit();return false;\";" + 
+            " return out; } }";
 }

source/java/org/alfresco/web/scripts/portlet/WebScriptPortletResponse.java

@@ -33,6 +33,7 @@ import javax.portlet.RenderResponse;
 
 import org.alfresco.web.scripts.WebScriptRequest;
 import org.alfresco.web.scripts.WebScriptResponse;
+import org.alfresco.web.ui.common.Utils;
 
 
 /**
@@ -127,4 +128,34 @@ public class WebScriptPortletResponse implements WebScriptResponse
         return portletUrl.toString();
     }
 
+    /* (non-Javadoc)
+     * @see org.alfresco.web.scripts.WebScriptResponse#getEncodeScriptUrlFunction(java.lang.String)
+     */
+    public String getEncodeScriptUrlFunction(String name)
+    {
+        PortletURL portletUrl = res.createActionURL();
+        
+        String func = ENCODE_FUNCTION.replace("$name$", name);
+        func = func.replace("$actionUrl$", portletUrl.toString());
+        return Utils.encodeJavascript(func);
+    }
+    
+    private static final String ENCODE_FUNCTION = 
+            "{ $name$: function(url) {" + 
+            " var out = \"$actionUrl$\";" + 
+            " var argsIndex = url.indexOf(\"?\");" + 
+            " if (argsIndex == -1)" + 
+            " {" + 
+            "    out += \"&scriptUrl=\" + escape(url);" + 
+            " }" + 
+            " else" + 
+            " {" + 
+            "    out += \"&scriptUrl=\" + escape(url.substring(0, argsIndex));" + 
+            "    var args = url.substring(argsIndex + 1).split(\"&\");" + 
+            "    for (var i=0; i<args.length; i++)" + 
+            "    {" + 
+            "       out += \"arg.\" + args[i];" + 
+            "    }" + 
+            " }" + 
+            " return out; } }"; 
 }

source/java/org/alfresco/web/ui/common/Utils.java

@@ -116,7 +116,6 @@ public final class Utils
     * 
     * @param string     the String to convert
     */
-   //XXXarielb perhaps use org.springframework.web.util.HtmlUtils instead?
    public static String encode(String string)
    {
       if (string == null)
@@ -235,6 +234,28 @@ public final class Utils
       }
    }
    
+   /**
+    * Encode a string to the %AB hex style JavaScript compatible notation.
+    * Used to encode a string to a value that can be safely inserted into an HTML page and
+    * then decoded (and probably eval()ed) using the unescape() JavaScript method.
+    * 
+    * @param s      string to encode
+    * 
+    * @return %AB hex style encoded string
+    */
+   public static String encodeJavascript(String s)
+   {
+       StringBuilder buf = new StringBuilder(s.length() * 3);
+       for (int i=0; i<s.length(); i++)
+       {
+           char c = s.charAt(i);
+           int iChar = (int)c;
+           buf.append('%');
+           buf.append(Integer.toHexString(iChar));
+       }
+       return buf.toString();
+   }
+   
    /**
     * Replace one string instance with another within the specified string
     * 
@@ -474,11 +495,9 @@ public final class Utils
       String formClientId = form.getClientId(context);
       
       StringBuilder buf = new StringBuilder(200);
-      buf.append("document.forms[");
+      buf.append("document.forms['");
-      buf.append("'");
       buf.append(formClientId);
-      buf.append("'");
+      buf.append("']['");
-      buf.append("]['");
       buf.append(fieldId);
       buf.append("'].value=");
       if (valueIsParam == false)
@@ -496,11 +515,9 @@ public final class Utils
       {
          for (String name : params.keySet())
          {
-            buf.append("document.forms[");
+            buf.append("document.forms['");
-            buf.append("'");
             buf.append(formClientId);
-            buf.append("'");
+            buf.append("']['");
-            buf.append("]['");
             buf.append(name);
             buf.append("'].value='");
             buf.append(params.get(name));
@@ -512,11 +529,9 @@ public final class Utils
          }
       }
       
-      buf.append("document.forms[");
+      buf.append("document.forms['");
-      buf.append("'");
       buf.append(formClientId);
-      buf.append("'");
+      buf.append("'].submit();");
-      buf.append("].submit();");
       
       if (valueIsParam == false)
       {
@@ -550,11 +565,9 @@ public final class Utils
       
       StringBuilder buf = new StringBuilder(48);
       
-      buf.append("document.forms[");
+      buf.append("document.forms['");
-      buf.append("'");
       buf.append(formClientId);
-      buf.append("'");
+      buf.append("'].submit()");
-      buf.append("].submit()");
       
       buf.append(";return false;");
       

source/web/WEB-INF/portlet.xml

@@ -29,7 +29,7 @@
         
         <init-param>
            <name>scriptUrl</name>
-           <value>/alfresco/service/mytasks</value>
+           <value>/alfresco/wcservice/mytasks</value>
         </init-param>
 
         <supports>
@@ -50,7 +50,7 @@
         
         <init-param>
            <name>scriptUrl</name>
-           <value>/alfresco/service/doclist</value>
+           <value>/alfresco/wcservice/doclist</value>
         </init-param>
 
         <supports>
@@ -71,7 +71,7 @@
         
         <init-param>
            <name>scriptUrl</name>
-           <value>/alfresco/service/myspaces</value>
+           <value>/alfresco/wcservice/myspaces</value>
         </init-param>
 
         <supports>
@@ -92,7 +92,7 @@
         
         <init-param>
            <name>scriptUrl</name>
-           <value>/alfresco/service/mywebforms</value>
+           <value>/alfresco/wcservice/mywebforms</value>
         </init-param>
 
         <supports>

source/web/scripts/ajax/myspaces.js

@@ -11,6 +11,7 @@ var MySpaces = {
    Home: null,
    ServiceContext: null,
    popupPanel: null,
+   ScriptUrlEncoder: null,
    
    start: function()
    {
@@ -26,14 +27,32 @@ var MySpaces = {
                {
                   // push the response into the space panel div
                   $('spacePanel').setHTML(response.responseText);
+                  
+                  // Construct the links to the outer webscript - we use the client script url encoder
+                  // method provided by the outer webscript runtime to generate urls to call it from the
+                  // inner webscript we called via a servlet - this means we can gen urls to call JSF or
+                  // portlet webscript from the inner.
+                  var navLinks = $$('#spacePanel .spaceNavLinkUrl');
+                  var navImgs  = $$('#spacePanel .spaceNavLinkImg');
+                  navLinks.each(function(navLink, i)
+                  {
+                     navLink.setHTML('<a href="' + MySpaces.ScriptUrlEncoder.encUrl(navLink.innerHTML.replace(/&amp;/, "&")) + '">' + navImgs[i].innerHTML + '</a>');
+                     navImgs[i].innerHTML = "";    // remove the html so the class is not selected during init()
+                  });
                   // extract the count value from a hidden div and display it
                   $('spaceCount').setHTML($('spaceCountValue').innerHTML);
+                  
                   // wire up all the events and animations
                   MySpaces.init();
                },
                failure: function(response)
                {
+                  // display the error
                   $('spacePanel').setHTML("Sorry, data currently unavailable.");
+                  
+                  // hide the ajax wait panel and show the main spaces panel
+                  $('spacePanelOverlay').setStyle('visibility', 'hidden');
+                  $('spacePanel').setStyle('visibility', 'visible');
                }
             }
          );
@@ -43,6 +62,7 @@ var MySpaces = {
    init: function()
    {
       MySpaces.parseSpacePanels();
+      
       // hide the ajax wait panel and show the main spaces panel
       $('spacePanelOverlay').setStyle('visibility', 'hidden');
       $('spacePanel').setStyle('visibility', 'visible');

source/web/scripts/ajax/mytasks.js

@@ -25,7 +25,12 @@ var MyTasks = {
                },
                failure: function(response)
                {
+                  // display the error
                   $('taskPanel').setHTML("Sorry, data currently unavailable.");
+                  
+                  // hide the ajax wait panel and show the main task panel
+                  $('taskPanelOverlay').setStyle('visibility', 'hidden');
+                  $('taskPanel').setStyle('visibility', 'visible');
                }
             }
          );
@@ -35,6 +40,7 @@ var MyTasks = {
    init: function()
    {
       MyTasks.parseTaskPanels();
+      
       // hide the ajax wait panel and show the main task panel
       $('taskPanelOverlay').setStyle('visibility', 'hidden');
       $('taskPanel').setStyle('visibility', 'visible');