From f9e9d0b80865a42630dcd497e57e0580f2cd9b72 Mon Sep 17 00:00:00 2001
From: David Caruana <david.caruana@alfresco.com>
Date: Mon, 8 Jan 2007 12:36:17 +0000
Subject: [PATCH] OpenSearch - comply with atom feed validators - addition of
 xmldate and urlencode freemarker methods

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@4750 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
---
 .../web/api/services/APIServiceImpl.java      |  4 +++
 .../alfresco/web/api/services/TextSearch.java | 34 ++++++++++---------
 2 files changed, 22 insertions(+), 16 deletions(-)

diff --git a/source/java/org/alfresco/web/api/services/APIServiceImpl.java b/source/java/org/alfresco/web/api/services/APIServiceImpl.java
index b3c2c6da44..62d2ece787 100644
--- a/source/java/org/alfresco/web/api/services/APIServiceImpl.java
+++ b/source/java/org/alfresco/web/api/services/APIServiceImpl.java
@@ -23,6 +23,8 @@ import java.util.Map;
 
 import javax.servlet.ServletContext;
 
+import org.alfresco.repo.template.ISO8601DateFormatMethod;
+import org.alfresco.repo.template.UrlEncodeMethod;
 import org.alfresco.service.ServiceRegistry;
 import org.alfresco.service.cmr.repository.TemplateService;
 import org.alfresco.service.descriptor.DescriptorService;
@@ -170,6 +172,8 @@ public abstract class APIServiceImpl implements BeanNameAware, APIService, APICo
     protected Map<String, Object> createTemplateModel(APIRequest req, APIResponse res)
     {
         Map<String, Object> model = new HashMap<String, Object>(7, 1.0f);
+        model.put("xmldate", new ISO8601DateFormatMethod());
+        model.put("urlencode", new UrlEncodeMethod());
         model.put("date", new Date());
         model.put("agent", descriptorService.getServerDescriptor());
         model.put("request", req);
diff --git a/source/java/org/alfresco/web/api/services/TextSearch.java b/source/java/org/alfresco/web/api/services/TextSearch.java
index c5cfdd6c14..417cd30b01 100644
--- a/source/java/org/alfresco/web/api/services/TextSearch.java
+++ b/source/java/org/alfresco/web/api/services/TextSearch.java
@@ -25,6 +25,8 @@ import java.util.Locale;
 import java.util.Map;
 
 import org.alfresco.i18n.I18NUtil;
+import org.alfresco.repo.template.ISO8601DateFormatMethod;
+import org.alfresco.repo.template.UrlEncodeMethod;
 import org.alfresco.service.ServiceRegistry;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.StoreRef;
@@ -407,13 +409,11 @@ public class TextSearch extends APIServiceImpl
     
     // TODO: place into accessible file
     private final static String ATOM_TEMPLATE = 
-        "<#assign dateformat=\"yyyy-MM-dd\">" +
-        "<#assign timeformat=\"HH:mm:sszzz\">" +
         "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
         "<feed xmlns=\"http://www.w3.org/2005/Atom\" xmlns:opensearch=\"http://a9.com/-/spec/opensearch/1.1/\" xmlns:relevance=\"http://a9.com/-/opensearch/extensions/relevance/1.0/\">\n" +
         "  <generator version=\"${agent.version}\">Alfresco (${agent.edition})</generator>\n" +
         "  <title>Alfresco Search: ${search.searchTerms}</title>\n" + 
-        "  <updated>${date?string(dateformat)}T${date?string(timeformat)}</updated>\n" +
+        "  <updated>${xmldate(date)}</updated>\n" +
         "  <icon>${request.path}/images/logo/AlfrescoLogo16.ico</icon>\n" +
         "  <author>\n" + 
         "    <name><#if request.authenticatedUsername?exists>${request.authenticatedUsername}<#else>unknown</#if></name>\n" +
@@ -423,24 +423,24 @@ public class TextSearch extends APIServiceImpl
         "  <opensearch:startIndex>${search.startIndex}</opensearch:startIndex>\n" +
         "  <opensearch:itemsPerPage>${search.itemsPerPage}</opensearch:itemsPerPage>\n" +
         "  <opensearch:Query role=\"request\" searchTerms=\"${search.searchTerms}\" startPage=\"${search.startPage}\" count=\"${search.itemsPerPage}\" language=\"${search.localeId}\"/>\n" +
-        "  <link rel=\"alternate\" href=\"${request.servicePath}/search/text?q=${search.searchTerms}&amp;p=${search.startPage}&amp;c=${search.itemsPerPage}&amp;l=${search.localeId}&amp;guest=${request.guest?string(\"true\",\"\")}&amp;format=html\" type=\"text/html\"/>\n" +
-        "  <link rel=\"self\" href=\"${request.servicePath}/search/text?q=${search.searchTerms}&amp;p=${search.startPage}&amp;c=${search.itemsPerPage}&amp;l=${search.localeId}&amp;guest=${request.guest?string(\"true\",\"\")}&amp;format=atom\" type=\"application/atom+xml\"/>\n" +
-        "  <link rel=\"first\" href=\"${request.servicePath}/search/text?q=${search.searchTerms}&amp;p=1&amp;c=${search.itemsPerPage}&amp;l=${search.localeId}&amp;guest=${request.guest?string(\"true\",\"\")}&amp;format=atom\" type=\"application/atom+xml\"/>\n" +
+        "  <link rel=\"alternate\" href=\"${request.servicePath}/search/text?q=${urlencode(search.searchTerms)}&amp;p=${search.startPage}&amp;c=${search.itemsPerPage}&amp;l=${search.localeId}&amp;guest=${request.guest?string(\"true\",\"\")}&amp;format=html\" type=\"text/html\"/>\n" +
+        "  <link rel=\"self\" href=\"${request.servicePath}/search/text?q=${urlencode(search.searchTerms)}&amp;p=${search.startPage}&amp;c=${search.itemsPerPage}&amp;l=${search.localeId}&amp;guest=${request.guest?string(\"true\",\"\")}&amp;format=atom\" type=\"application/atom+xml\"/>\n" +
+        "  <link rel=\"first\" href=\"${request.servicePath}/search/text?q=${urlencode(search.searchTerms)}&amp;p=1&amp;c=${search.itemsPerPage}&amp;l=${search.localeId}&amp;guest=${request.guest?string(\"true\",\"\")}&amp;format=atom\" type=\"application/atom+xml\"/>\n" +
         "<#if search.startPage &gt; 1>" +
-        "  <link rel=\"previous\" href=\"${request.servicePath}/search/text?q=${search.searchTerms}&amp;p=${search.startPage - 1}&amp;c=${search.itemsPerPage}&amp;l=${search.localeId}&amp;guest=${request.guest?string(\"true\",\"\")}&amp;format=atom\" type=\"application/atom+xml\"/>\n" +
+        "  <link rel=\"previous\" href=\"${request.servicePath}/search/text?q=${urlencode(search.searchTerms)}&amp;p=${search.startPage - 1}&amp;c=${search.itemsPerPage}&amp;l=${search.localeId}&amp;guest=${request.guest?string(\"true\",\"\")}&amp;format=atom\" type=\"application/atom+xml\"/>\n" +
         "</#if>" +
         "<#if search.startPage &lt; search.totalPages>" +
-        "  <link rel=\"next\" href=\"${request.servicePath}/search/text?q=${search.searchTerms}&amp;p=${search.startPage + 1}&amp;c=${search.itemsPerPage}&amp;l=${search.localeId}&amp;guest=${request.guest?string(\"true\",\"\")}&amp;format=atom\" type=\"application/atom+xml\"/>\n" + 
+        "  <link rel=\"next\" href=\"${request.servicePath}/search/text?q=${urlencode(search.searchTerms)}&amp;p=${search.startPage + 1}&amp;c=${search.itemsPerPage}&amp;l=${search.localeId}&amp;guest=${request.guest?string(\"true\",\"\")}&amp;format=atom\" type=\"application/atom+xml\"/>\n" + 
         "</#if>" +
-        "  <link rel=\"last\" href=\"${request.servicePath}/search/text?q=${search.searchTerms}&amp;p=${search.totalPages}&amp;c=${search.itemsPerPage}&amp;l=${search.localeId}&amp;guest=${request.guest?string(\"true\",\"\")}&amp;format=atom\" type=\"application/atom+xml\"/>\n" +
+        "  <link rel=\"last\" href=\"${request.servicePath}/search/text?q=${urlencode(search.searchTerms)}&amp;p=${search.totalPages}&amp;c=${search.itemsPerPage}&amp;l=${search.localeId}&amp;guest=${request.guest?string(\"true\",\"\")}&amp;format=atom\" type=\"application/atom+xml\"/>\n" +
         "  <link rel=\"search\" type=\"application/opensearchdescription+xml\" href=\"${request.servicePath}/search/text/textsearchdescription.xml\"/>\n" +
         "<#list search.results as row>" +            
         "  <entry>\n" +
         "    <title>${row.name}</title>\n" +
         "    <link href=\"${request.path}${row.url}\"/>\n" +
-        "    <icon>${request.path}${row.icon16}\"</icon>\n" +  // TODO: Standard for entry icons?
+        "    <icon>${request.path}${row.icon16}</icon>\n" +  // TODO: Standard for entry icons?
         "    <id>urn:uuid:${row.id}</id>\n" +
-        "    <updated>${row.properties.modified?string(dateformat)}T${row.properties.modified?string(timeformat)}</updated>\n" +
+        "    <updated>${xmldate(row.properties.modified)}</updated>\n" +
         "    <summary>${row.properties.description}</summary>\n" +
         "    <author>\n" + 
         "      <name>${row.properties.creator}</name>\n" +
@@ -477,15 +477,15 @@ public class TextSearch extends APIServiceImpl
         "      </li>\n" +
         "</#list>" +
         "    </ul>\n" +
-        "    <a href=\"${request.servicePath}/search/text?q=${search.searchTerms}&p=1&c=${search.itemsPerPage}&l=${search.localeId}&guest=${request.guest?string(\"true\",\"\")}\">first</a>" +
+        "    <a href=\"${request.servicePath}/search/text?q=${urlencode(search.searchTerms)}&p=1&c=${search.itemsPerPage}&l=${search.localeId}&guest=${request.guest?string(\"true\",\"\")}\">first</a>" +
         "<#if search.startPage &gt; 1>" +
-        "    <a href=\"${request.servicePath}/search/text?q=${search.searchTerms}&p=${search.startPage - 1}&c=${search.itemsPerPage}&l=${search.localeId}&guest=${request.guest?string(\"true\",\"\")}\">previous</a>" +
+        "    <a href=\"${request.servicePath}/search/text?q=${urlencode(search.searchTerms)}&p=${search.startPage - 1}&c=${search.itemsPerPage}&l=${search.localeId}&guest=${request.guest?string(\"true\",\"\")}\">previous</a>" +
         "</#if>" +
-        "    <a href=\"${request.servicePath}/search/text?q=${search.searchTerms}&p=${search.startPage}&c=${search.itemsPerPage}&l=${search.localeId}&guest=${request.guest?string(\"true\",\"\")}\">${search.startPage}</a>" +
+        "    <a href=\"${request.servicePath}/search/text?q=${urlencode(search.searchTerms)}&p=${search.startPage}&c=${search.itemsPerPage}&l=${search.localeId}&guest=${request.guest?string(\"true\",\"\")}\">${search.startPage}</a>" +
         "<#if search.startPage &lt; search.totalPages>" +
-        "    <a href=\"${request.servicePath}/search/text?q=${search.searchTerms}&p=${search.startPage + 1}&c=${search.itemsPerPage}&l=${search.localeId}&guest=${request.guest?string(\"true\",\"\")}\">next</a>" +
+        "    <a href=\"${request.servicePath}/search/text?q=${urlencode(search.searchTerms)}&p=${search.startPage + 1}&c=${search.itemsPerPage}&l=${search.localeId}&guest=${request.guest?string(\"true\",\"\")}\">next</a>" +
         "</#if>" +
-        "    <a href=\"${request.servicePath}/search/text?q=${search.searchTerms}&p=${search.totalPages}&c=${search.itemsPerPage}&l=${search.localeId}&guest=${request.guest?string(\"true\",\"\")}\">last</a>" +
+        "    <a href=\"${request.servicePath}/search/text?q=${urlencode(search.searchTerms)}&p=${search.totalPages}&c=${search.itemsPerPage}&l=${search.localeId}&guest=${request.guest?string(\"true\",\"\")}\">last</a>" +
         "  </body>\n" +
         "</html>\n";
 
@@ -550,6 +550,8 @@ public class TextSearch extends APIServiceImpl
         request.put("servicePath", "http://localhost:8080/alfresco/service");
         request.put("path", "http://localhost:8080/alfresco");
         request.put("guest", false);
+        searchModel.put("xmldate", new ISO8601DateFormatMethod());
+        searchModel.put("urlencode", new UrlEncodeMethod());
         searchModel.put("date", new Date());
         searchModel.put("agent", getDescriptorService().getServerDescriptor());
         searchModel.put("request", request);