0.45:

    - refined workaround against unquoted json feed for application and user json properties
    - apply this workaround only when running against a repository affected by the bug
    - minor CSS fix : historical margins for dashlet body no longer required.



git-svn-id: https://share-extras.googlecode.com/svn/trunk/Audit Dashlet@1433 a3f5c567-fd0f-3a89-9b71-a290c5a5f590

Author: romainguinot

README.txt

@@ -114,6 +114,11 @@ of the dashboard and drag the dashlet into one of the columns from the list of d
 Changelog
 ---------
 
+0.45:
+    - refined workaround against unquoted json feed for application and user json properties
+    - apply this workaround only when running against a repository affected by the bug
+    - minor CSS fix : historical margins for dashlet body no longer required.
+
 0.44:
     - expanded workaround against unquoted json feed for application and user json properties. addresses issue 71.
     - additional newline sanitizing of the server side json feed, in addition to the checks already present in the freemarker output. possibly addresses issue 82.

build.properties

@@ -1,3 +1,3 @@
-build.version=0.44
+build.version=0.45
 project.name=audit-dashlet
 jar.name=${project.name}-${build.version}.jar

config/alfresco/site-webscripts/org/sharextras/components/dashlets/audit-application-data.get.js

@@ -1,25 +1,25 @@
 function main()
 {
-   var application = args.application;    // audit application name (as reported by /api/audit/control
+   var application = args.application;    // audit application name (as reported by /api/audit/control)
    var valueFilter = args.valueFilter;    // optional : "value" filter on the audit entries. match all
    var limit = args.limit;                // optional : max entry count retrieved by the repo query
 
-   // optional : free field to add in other server-side filters (e.g fromTime... )
+   // optional : free field to add in other server-side filters (e.g fromTime...)
    var additionalQueryParams = args.additionalQueryParams;
 
    if (application != null)
    {
       var valueFilterQuery = valueFilter ? "&value=" + stringUtils.urlEncode(valueFilter) : "";
       if (logger.isLoggingEnabled())
-      logger.log("  application:" +application+ " - " + "valueFilter:" +valueFilter);
+         logger.log("  application:" +application+ " - " + "valueFilter:" +valueFilter);
 
       var maxEntryCount = limit ? "&limit=" + stringUtils.urlEncode(limit) : "";
 
       // decode the '&' param separators from the optional additional params passed in by the dashlet.
       var optionalAdditionalQueryParams = additionalQueryParams ? ("&" + additionalQueryParams.replace(/\uFFFF/g,'&')) : "";
 
       if (logger.isLoggingEnabled())
-      logger.log("  optionalAdditionalQueryParams: '" +optionalAdditionalQueryParams+ "'");
+         logger.log("  optionalAdditionalQueryParams: '" +optionalAdditionalQueryParams+ "'");
 
       var sortOrder =  "&forward=" + false; // most recent first
 
@@ -31,19 +31,29 @@ function main()
       if (logger.isLoggingEnabled())
       logger.log("called URI:'"+uri+"'");
 
+
       if (result.status == status.STATUS_OK)
       {
          var rawresponse = result.response+""; // cast rawresponse back into a js string
          //if (logger.isLoggingEnabled()) logger.log("rawresponse:\n"+rawresponse);
 
-         // the json outputted by the audit template does not quote user and application keys in the ouput
-         // pending ALF-8307, working around it by adding the quotes with a regex replace
-         var requoting_regex = /:([\w-@.]+)\,/g;
-         var requoted_response = rawresponse.replace(requoting_regex, ":\"$1\",");
-         //if (logger.isLoggingEnabled()) logger.log("requoted_response:\n"+requoted_response);
+         var jsonQuoteFixRequired = isJsonQuoteFixRequired(connector);
+         if (logger.isLoggingEnabled())
+            logger.log("jsonQuoteFixRequired:'"+jsonQuoteFixRequired+"'");
+
+         var json_requoted_response = rawresponse;
+         if(jsonQuoteFixRequired)
+         {
+            // the json outputted by the audit template does not quote user and application keys in the ouput.
+            // Pending ALF-8307, working around it by adding the quotes with a regex replace.
+            // Constrain the regex to only 'application' and 'user' entries, and expand the criteria to allow any character except quotes,  in these field values.
+            var json_requoting_regex = /"(application|user)":([^"]+)\,$/gm;
+            json_requoted_response   = rawresponse.replace(json_requoting_regex,"\"$1\":\"$2\",");
+            //if (logger.isLoggingEnabled()) logger.log("json_requoted_response:\n"+json_requoted_response);
+         }
 
          // replace with a space spurious newlines that could have been stored in a json item, before the feed gets eval'd. see also ALF-11190.
-         var escaped_response = requoted_response.replace(/(\n|\r\n|\r)/g, " ");
+         var escaped_response = json_requoted_response.replace(/(\n|\r\n|\r)/g, " ");
          //if (logger.isLoggingEnabled()) logger.log("escaped_response:\n"+escaped_response);
 
          var auditresponse = eval("(" + escaped_response + ")");
@@ -53,8 +63,7 @@ function main()
 
       else
       {
-         status.setCode(result.status, "Error during remote call. " +
-               "Status: " + result.status + ", Response: " + result.response);
+         status.setCode(result.status, "Error during remote call. Status: " + result.status + ", Response: " + result.response);
          status.redirect = true;
       }
    }
@@ -64,4 +73,38 @@ function main()
       status.redirect = true;
    }
 }
+
+// ALF-8307 (missing quotes around audit application and user) is fixed in Enterprise 3.4.3 and Community 4.0.a, and above.
+// Determine is the fix is required, depending on the current version of the repository the web-tier is currently running against.
+function isJsonQuoteFixRequired(connector)
+{
+   // get current server version to determine if a workaround for ALF-8307 is needed.
+   var srvInfo = connector.get("/api/server");
+   var srvInfoJson = eval('(' + srvInfo + ')');
+
+   var serverVersion, serverEdition, serverVersionNumbers;
+
+   // setup defaults
+   serverVersion = srvInfoJson.data ? srvInfoJson.data.version : "1.0.0";
+   serverEdition = srvInfoJson.data ? srvInfoJson.data.edition : "Enterprise";
+
+   // if Enterprise edition, extract x.y.z from the version number. if community, only extract x.y (exclude service packs).
+   if (serverEdition == "Enterprise")
+   {
+      serverVersionNumbers = ((serverVersion.substr(0,5).replace(/\./g,""))*1); // extract x.y.z from the version number (i.e, include service pack).
+      if (logger.isLoggingEnabled())
+         logger.log("Enterprise serverVersionNumbers:'"+serverVersionNumbers+"'");
+      return (serverVersionNumbers < 343);
+   }
+   else if (serverEdition == "Community")
+   {
+       serverVersionNumbers = ((serverVersion.substr(0,3).replace(/\./g,""))*1); // extract x.y from the version number (i.e, exclude service pack).
+       if (logger.isLoggingEnabled())
+          logger.log("Community serverVersionNumbers:'"+serverVersionNumbers+"'");
+       return (serverVersionNumbers < 40);
+   }
+   else
+      return true; // apply the fix if unhandled / different edition.
+}
+
 main();

config/alfresco/site-webscripts/org/sharextras/components/dashlets/audit-application-data.get.json.ftl

@@ -6,14 +6,16 @@
       {
          "id": ${e.id},
          "application": "${e.application}",
-         "user": "${e.user}",
+         <#-- escape quotes that may exist in the persisted values for this entry -->
+         "user": "${e.user?replace('"',"\\\\\\\"",'r')}",
          "time": "${e.time}",
          "values":
          {
          <#list e.values?keys as key>
-            <#-- keep only the audit key for readability -->
-            <#-- and remove spurious/invalid linebreaks (see ALF-11190) -->
-            "${key?replace('.*/', '', 'r')}":"${e.values[key]?replace('(\n|\r\n|\r)',' ','r')}"
+            <#-- keep only the audit key for readability, remove spurious/invalid linebreaks (see ALF-11190) -->
+            <#-- and escape quotes that may exist in the persisted values for this entry. -->
+            <#-- Note that the various backslashes are required to pass through the evaluation chain. -->
+           "${key?replace('.*/', '', 'r')}":"${e.values[key]?replace('(\n|\r\n|\r)',' ','r')?replace('"',"\\\\\\\"",'r')}"
             <#if key_has_next>,</#if>
          </#list>
          }

config/alfresco/site-webscripts/org/sharextras/components/dashlets/audit-application.get.html.ftl

@@ -56,7 +56,7 @@
          <div class="body" style="height: ${currentHeight}px;" id="${el}-body">
             <div class="message spaced-left" id="${el}-message"></div>
 
-            <div class="spaced-left" id="${el}-searchbox">
+            <div class="spaced-left top-padded" id="${el}-searchbox">
                <#-- search box to filter audit values from YUI -->
                <label id="${el}-searchWithinResultsFilterLabel" for="${el}-searchWithinResultsFilter">${msg("audit.dashlet.searchWithinResults",0)} :</label>
                <input type="text" id="${el}-searchWithinResultsFilter">

source/web/extras/components/dashlets/audit-application.css

@@ -11,10 +11,15 @@
    height: 90%;
 }
 
-.audit-application-dashlet .body
+/*.audit-application-dashlet .body
 {
    margin-top: 10px;
    margin-bottom: 10px;
+}*/
+
+.audit-application-dashlet .top-padded
+{
+ margin-top: 10px;
 }
 
 .audit-application-dashlet .yui-dt table