0.5:

    - fixed config dialog URL to use /res, required in 4.2. addresses issue 129.
    - added the configurable server-side ability to query for entries containing a specific audit path.
         Note : querying for values when an audit path query is configured will restrict the search to entries with that value for that specific audit path.
    - made the repo version check configurable through the audit application data webscript config file
    - made the audit path trimming configurable through the config dialog
    - minor : added the year by default in the displayed timestamps.
    - fixed ID format for json entries, to make sure the ID representation does not have comma separators for high entry IDs. addresses issue 129, comment #6.
    - fixed an unreported issue where storing config values with double quotes in the text would prevent the config options to be loaded afterwards.



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

Author: romainguinot

README.txt

@@ -40,7 +40,7 @@ The dashlet has been developed to install on top of an existing Alfresco 3.4 ins
 
     Once you have run this you will need to restart Tomcat so that the classpath resources in the JAR file are picked up.
 
-    As an alternative, you may also copy the exploded files in your classpath, but they must have the classpath tree
+    As an alternative, you may also copy the exploded files in your classpath, but they must have the same classpath tree
     than the one in the jar. If using development/debug mode for the web framework, you will not need to restart tomcat,
     but you may have to clear your browser's cache.
 
@@ -58,13 +58,15 @@ of the dashboard and drag the dashlet into one of the columns from the list of d
     For convenience, the list will pop out when opening the configure dialog with no applications currently configured.
     Could be useful if you don't know what application name to search for.
 
-    The number of data rows (audit events) displayed per page is configurable by the 'Entries per page' parameter.
+    The number of data rows (audit events) displayed per page is configurable with the 'Entries per page' parameter.
 
     Additional server side filters are configurable :
             UI Name                              Description                                  Audit API corresponding parameter
     --------------------------------------------------------------------------------------------------------------------------------
-    - value filter                  filter on the audit value (exact match, optional)                 'value'
-    - limit                         maximum number of audit entries retrieved (optional)              'limit' (default 100)
+    - Value Filter                  filter on the audit value (exact match, optional)                 'value'
+    - Max Entry Count               maximum number of audit entries retrieved (optional)              'limit' (default 100)
+    - Audit Path Filter             select only the audit entries with a matching audit path          URL path after application (default none)
+                                    key in their values map.
     - Additional Query params       other possible query parameters (optional)                        from/to time, from/to id, user
 
     (See http://wiki.alfresco.com/wiki/Auditing_(from_V3.4)#Advanced_Query). This filtering is done server-side.
@@ -74,6 +76,14 @@ of the dashboard and drag the dashlet into one of the columns from the list of d
     Note : the output in the "audited values" field will depend on the configuration of the current audit application.
     (ie what data extractors have been configured, if using the access auditor or not, etc...).
 
+    Note : querying for values when an audit path query is configured will restrict the search to entries with that value for that specific audit path.
+
+    The "Trim Audit Paths" checkbox can be used to show the full audit paths up to the audit key, or just the audit key, in the audit values.
+    It can be useful to temporarily turn on in case one wants to use the audit path filter above, as it will show the full audit paths required for that filter.
+
+    Note : The data webscript does a version check to determine if a workaround for the unquoted json feed prior to 3.4.3 Enterprise / 4.0 Community (ALF-8307) is required.
+    This can be overriden by copying the webscript config file (audit-application-data.get.config.xml) in the equivalent path in web-extension, if required.
+
  * Search box
 
     The dashlet search box allows more search capabilities than the server side filter, ie :
@@ -114,6 +124,16 @@ of the dashboard and drag the dashlet into one of the columns from the list of d
 Changelog
 ---------
 
+0.5:
+    - fixed config dialog URL to use /res, required in 4.2. addresses issue 129.
+    - added the configurable server-side ability to query for entries containing a specific audit path.
+         Note : querying for values when an audit path query is configured will restrict the search to entries with that value for that specific audit path.
+    - made the repo version check configurable through the audit application data webscript config file
+    - made the audit path trimming configurable through the config dialog
+    - minor : added the year by default in the displayed timestamps.
+    - fixed ID format for json entries, to make sure the ID representation does not have comma separators for high entry IDs. addresses issue 129, comment #6.
+    - fixed an unreported issue where storing config values with double quotes in the text would prevent the config options to be loaded afterwards.
+
 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

build.properties

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

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

@@ -0,0 +1,4 @@
+<config>
+   <!-- if true, the script will check the current version of the repo to determine if the feed needs to be fixed for missing quotes before it gets parsed -->
+   <enableVersionCheck>true</enableVersionCheck>
+</config>

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

@@ -1,6 +1,6 @@
 <webscript>
    <shortname>Audit Application Data Component</shortname>
    <description>Audit Application Data Component</description>
-   <url>/components/dashlets/audit-application/entries?application={application}&amp;valueFilter={valueFilter}&amp;limit={limit}&amp;additionalQueryParams={additionalQueryParams}</url>
+   <url>/components/dashlets/audit-application/entries?application={application}&amp;valueFilter={valueFilter}&amp;limit={limit}&amp;pathFilter={pathFilter}&amp;trimAuditPaths={trimAuditPaths}&amp;additionalQueryParams={additionalQueryParams}</url>
    <format default="json">extension</format>
 </webscript>

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

@@ -1,43 +1,68 @@
 function main()
 {
+   // read this webscript's config.
+   var scriptConfig = new XML(config.script);
+   var enableVersionCheck = (scriptConfig["enableVersionCheck"] == "true");
+
+   if (logger.isLoggingEnabled())
+      logger.log("script config - enableVersionCheck : " +enableVersionCheck);
+
    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...)
-   var additionalQueryParams = args.additionalQueryParams;
+   var pathFilter = args.pathFilter;      // optional : select only the audit entries which possess a matching audit path key in their values map.
+   var additionalQueryParams = args.additionalQueryParams;     // optional : free field to add in other server-side filters (e.g fromTime...)
+
+   // optional : keep only the audit key for better readability / shorter text.
+   // Path trimming applies to the freemarker template, so push it into the model.
+   model.trimAuditPaths = (args.trimAuditPaths ? (args.trimAuditPaths == "true") : false);
+   if (logger.isLoggingEnabled())
+      logger.log("trimAuditPaths:" +model.trimAuditPaths);
 
    if (application != null)
    {
       var valueFilterQuery = valueFilter ? "&value=" + stringUtils.urlEncode(valueFilter) : "";
-      if (logger.isLoggingEnabled())
-         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,'&')) : "";
+      // this pathFilter is not a URL argument, it will be appended to the application name.
+      // Note : pending the ability to call the urlEncoder with reserveUriChars set to true, only the '/' are decoded back with a regex replace for use by the repo audit webscript.
+      var pathFilterQuery = pathFilter ? (stringUtils.urlEncode(pathFilter)+"").replace(/\%2f/g,'/') : "";
 
+      if (logger.isLoggingEnabled())
+         logger.log("  application:" +application+ " - " + "  - pathFilterQuery: '" +pathFilterQuery+ "'" + "valueFilterQuery:" +valueFilterQuery);
+
+      // decode the '&' param separators from the optional additional params passed in by the dashlet, and encode the rest with the standard encoder (see note above).
+      var optionalAdditionalQueryParams = additionalQueryParams ? ("&" + encodeURI(additionalQueryParams.replace(/\uFFFF/g,'&'))) : "";
       if (logger.isLoggingEnabled())
          logger.log("  optionalAdditionalQueryParams: '" +optionalAdditionalQueryParams+ "'");
 
       var sortOrder =  "&forward=" + false; // most recent first
 
-      var uri = "/api/audit/query/"+stringUtils.urlEncode(application)+"?verbose=true"
+      // build the query URL using all the required parameters and perform the request.
+      // Note optionalAdditionalQueryParams is unencoded, pending the ability to call the urlEncoder with reserveUriChars set to true.
+      var uri = "/api/audit/query/"+stringUtils.urlEncode(application) +  "/" + pathFilterQuery +"?verbose=true"
                   + optionalAdditionalQueryParams + valueFilterQuery + maxEntryCount + sortOrder;
 
       var connector = remote.connect("alfresco");
       var result = connector.get(uri);
       if (logger.isLoggingEnabled())
-      logger.log("called URI:'"+uri+"'");
+         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);
 
-         var jsonQuoteFixRequired = isJsonQuoteFixRequired(connector);
+         var jsonQuoteFixRequired = false;
+         if(enableVersionCheck)
+         {
+            if (logger.isLoggingEnabled())
+               logger.log("versionCheck is enabled, will check repo version");
+            jsonQuoteFixRequired = isJsonQuoteFixRequired(connector);
+         }
+
          if (logger.isLoggingEnabled())
             logger.log("jsonQuoteFixRequired:'"+jsonQuoteFixRequired+"'");
 

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

@@ -4,18 +4,26 @@
    [
       <#list auditresponse.entries as e>
       {
-         "id": ${e.id},
+         <#-- output the ID in 'machine' representation, i.e. wihout any separators of any kind -->
+         "id": ${e.id?c},
          "application": "${e.application}",
          <#-- escape quotes that may exist in the persisted values for this entry -->
-         "user": "${e.user?replace('"',"\\\\\\\"",'r')}",
+         "user": "${e.user!'null'?replace('"',"\\\\\\\"",'r')}",
          "time": "${e.time}",
          "values":
          {
          <#list e.values?keys as key>
-            <#-- keep only the audit key for readability, remove spurious/invalid linebreaks (see ALF-11190) -->
+
+            <#assign displayed_key=key>
+            <#if trimAuditPaths>
+               <#-- keep only the audit key for better readability -->
+               <#assign displayed_key=key?replace('.*/', '', 'r')>
+            </#if>
+
+            <#-- 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')}"
+            "${displayed_key}":"${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.head.ftl

@@ -1,5 +1,5 @@
 <#include "/org/alfresco/components/component.head.inc">
 <!-- Audit Application dashlet -->
-<@script type="text/javascript" src="${page.url.context}/modules/simple-dialog.js"></@script>
+<@script type="text/javascript" src="${page.url.context}/res/modules/simple-dialog.js"></@script>
 <@link rel="stylesheet" type="text/css" href="${page.url.context}/res/extras/components/dashlets/audit-application.css" />
 <@script type="text/javascript" src="${page.url.context}/res/extras/components/dashlets/audit-application.js"></@script>

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

@@ -4,19 +4,26 @@
    new Extras.dashlet.AuditApplication("${el}").setOptions(
    {
       componentId: "${instance.object.id}",
-      application: "${args.application!''}",
-      valueFilter: "${args.valueFilter!''}",
-      limit: "${args.limit!''}",
-      rowsPerPage: "${args.rowsPerPage!'10'}",
-      additionalQueryParams: "${args.additionalQueryParams!''}",
-      show_id_column: "${args.show_id_column!'show'}",
-      show_user_column: "${args.show_user_column!'show'}",
-      show_time_column: "${args.show_time_column!'show'}",
-      show_values_column: "${args.show_values_column!'show'}"
+
+      <#-- escape quotes in user-entered parameters, just in case -->
+      application: "${escape_quotes(args.application!'')}",
+      valueFilter: "${escape_quotes(args.valueFilter!'')}",
+      limit: "${escape_quotes(args.limit!'')}",
+      rowsPerPage: "${escape_quotes(args.rowsPerPage!'10')}",
+      pathFilter: "${escape_quotes(args.pathFilter!'')}",
+      additionalQueryParams: "${escape_quotes(args.additionalQueryParams!'')}",
+
+      <#-- these values are managed by the dashlet, but escape them anyways, just in case... -->
+      show_id_column: "${escape_quotes(args.show_id_column!'show')}",
+      show_user_column: "${escape_quotes(args.show_user_column!'show')}",
+      show_time_column: "${escape_quotes(args.show_time_colum!'show')}",
+      show_values_column: "${escape_quotes(args.show_values_column!'show')}",
+      trim_audit_paths: "${escape_quotes(args.trim_audit_paths!'true')}"
+
    }).setMessages(${messages});
 
-   <#-- dashlet resizer does not dynamically adjust the number of rows displayed on the page re: pagination -->
-   <#-- the number of rows can be configured in the dialog though, sufficient for now -->
+   <#-- dashlet resizer does not dynamically adjust the number of rows displayed on the page re: pagination. -->
+   <#-- The number of rows can be configured in the dialog though, sufficient for now. -->
    <#-- future research : subscribe to rowsPerPageChange, "" etc...    -->
    new Alfresco.widget.DashletResizer("${el}", "${instance.object.id}").setOptions(
    {
@@ -49,7 +56,7 @@
       </div>
    </div>
 
-   <#-- audit only allows admin to query audit entries. therefore the dashlet is only usable by admin users. -->
+   <#-- audit only allows admin to query audit entries. Therefore the dashlet is only usable by admin users. -->
    <#if userIsAdmin>
       <#assign currentHeight=default_height>
       <#if args.height??><#assign currentHeight=args.height></#if>
@@ -70,3 +77,14 @@
       </div>
    </#if>
 </div>
+
+<#-- for safety, escape double quotes in the arguments that will be passed to the instanciated dashlet component options, otherwise the json feed will be invalid. -->
+<#-- Takes a string as parameter (cannot be null), and returns the string with double quotes escaped. If the parameter is the empty string, it will be returned as is. -->
+<#function escape_quotes string>
+   <#if string?has_content>
+      <#-- note that the various backslashes are required to pass through the evaluation chain -->
+      <#return string?replace('"',"\\\\\\\"",'r')>
+   <#else>
+      <#return string>
+   </#if>
+</#function>

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

@@ -2,7 +2,7 @@ audit.dashlet.header.default=Audit Dashlet
 
 audit.dashlet.link.configure=Configure
 audit.dashlet.link.help=Help
-audit.dashlet.link.help.url=http://code.google.com/p/share-extras/wiki/SampleAuditDashlet
+audit.dashlet.link.help.url=http://code.google.com/p/share-extras/wiki/AuditDashlet
 
 audit.dashlet.notConfigured=No application is configured.
 audit.dashlet.loading=Loading...

config/alfresco/site-webscripts/org/sharextras/components/dashlets/audit-application.get_en.properties

@@ -2,7 +2,7 @@ audit.dashlet.header.default=Audit Dashlet
 
 audit.dashlet.link.configure=Configure
 audit.dashlet.link.help=Help
-audit.dashlet.link.help.url=http://code.google.com/p/share-extras/wiki/SampleAuditDashlet
+audit.dashlet.link.help.url=http://code.google.com/p/share-extras/wiki/AuditDashlet
 
 audit.dashlet.notConfigured=No application is configured.
 audit.dashlet.loading=Loading...