From e2b625af45043a4cba04166e2563301a66c4967b Mon Sep 17 00:00:00 2001
From: Erik Hatcher <ehatcher@apache.org>
Date: Fri, 18 Jun 2010 00:24:41 +0000
Subject: [PATCH] SOLR-1957: Move VelocityResponseWriter from contrib to core

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@955796 13f79535-47bb-0310-9956-ffa450edef68
---
 solr/CHANGES.txt                              |  6 +-
 solr/example/solr/conf/solrconfig.xml         | 35 ++++++-
 .../solr/conf/velocity/VM_global_library.vm   | 51 ++++++++--
 solr/example/solr/conf/velocity/browse.vm     | 55 +++++++++++
 solr/example/solr/conf/velocity/facets.vm     | 12 +++
 solr/example/solr/conf/velocity/footer.vm     |  7 ++
 solr/example/solr/conf/velocity/header.vm     |  1 +
 solr/example/solr/conf/velocity/hit.vm        | 19 ++++
 solr/example/solr/conf/velocity/layout.vm     | 23 +++++
 solr/example/solr/conf/velocity/main.css      | 96 +++++++++++++++++++
 .../solr => }/lib/commons-beanutils-1.7.0.jar |  0
 .../lib/commons-collections-3.2.1.jar         |  0
 .../main/solr => }/lib/commons-lang-2.4.jar   |  0
 .../src/main/solr => }/lib/velocity-1.6.1.jar |  0
 .../lib/velocity-tools-2.0-beta3.jar          |  0
 .../java/org/apache/solr/core/SolrCore.java   |  2 +
 .../org/apache/solr/response/PageTool.java    |  0
 .../response/SolrParamResourceLoader.java     |  0
 .../response/SolrVelocityResourceLoader.java  |  0
 .../solr/response/VelocityResponseWriter.java |  0
 .../velocity/VelocityResponseWriterTest.java  |  0
 .../solr/conf/velocity/VM_global_library.vm   |  0
 22 files changed, 295 insertions(+), 12 deletions(-)
 create mode 100644 solr/example/solr/conf/velocity/browse.vm
 create mode 100644 solr/example/solr/conf/velocity/facets.vm
 create mode 100644 solr/example/solr/conf/velocity/footer.vm
 create mode 100644 solr/example/solr/conf/velocity/header.vm
 create mode 100644 solr/example/solr/conf/velocity/hit.vm
 create mode 100644 solr/example/solr/conf/velocity/layout.vm
 create mode 100644 solr/example/solr/conf/velocity/main.css
 rename solr/{contrib/velocity/src/main/solr => }/lib/commons-beanutils-1.7.0.jar (100%)
 rename solr/{contrib/velocity/src/main/solr => }/lib/commons-collections-3.2.1.jar (100%)
 rename solr/{contrib/velocity/src/main/solr => }/lib/commons-lang-2.4.jar (100%)
 rename solr/{contrib/velocity/src/main/solr => }/lib/velocity-1.6.1.jar (100%)
 rename solr/{contrib/velocity/src/main/solr => }/lib/velocity-tools-2.0-beta3.jar (100%)
 rename solr/{contrib/velocity/src/main => src}/java/org/apache/solr/response/PageTool.java (100%)
 rename solr/{contrib/velocity/src/main => src}/java/org/apache/solr/response/SolrParamResourceLoader.java (100%)
 rename solr/{contrib/velocity/src/main => src}/java/org/apache/solr/response/SolrVelocityResourceLoader.java (100%)
 rename solr/{contrib/velocity/src/main => src}/java/org/apache/solr/response/VelocityResponseWriter.java (100%)
 rename solr/{contrib/velocity => }/src/test/org/apache/solr/velocity/VelocityResponseWriterTest.java (100%)
 rename solr/{contrib/velocity/src/main => src/test/test-files}/solr/conf/velocity/VM_global_library.vm (100%)

diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index afff725a78a..0625204169d 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -27,6 +27,7 @@ Versions of Major Components
 Apache Lucene trunk
 Apache Tika 0.6
 Carrot2 3.1.0
+Velocity 1.6.1
 
 
 Upgrading from Solr 1.4
@@ -179,7 +180,10 @@ New Features
 
 * SOLR-1932: New relevancy function queries: termfreq, tf, docfreq, idf
   norm, maxdoc, numdocs. (yonik)
-
+  
+* SOLR-1957: The VelocityResponseWriter contrib moved to core.
+             Example search UI now available at http://localhost:8983/solr/browse
+             (ehatcher)
 
    
 Optimizations
diff --git a/solr/example/solr/conf/solrconfig.xml b/solr/example/solr/conf/solrconfig.xml
index 53d042b1ee1..af046ad3f91 100755
--- a/solr/example/solr/conf/solrconfig.xml
+++ b/solr/example/solr/conf/solrconfig.xml
@@ -55,7 +55,6 @@
        classpath, this is useful for including all jars in a directory.
     -->
   <lib dir="../../contrib/extraction/lib" />
-  <lib dir="../../contrib/velocity/src/main/solr/lib" />
   <!-- When a regex is specified in addition to a directory, only the files in that
        directory which completely match the regex (anchored on both ends)
        will be included.
@@ -509,6 +508,37 @@
         -->
      </lst>
   </requestHandler>
+  
+  <!-- 
+  -->
+  <requestHandler name="/browse" class="solr.SearchHandler">
+     <lst name="defaults">
+       <str name="wt">velocity</str>
+
+       <str name="v.template">browse</str>
+       <str name="v.layout">layout</str>
+       <str name="title">Solritas</str>
+
+       <str name="defType">dismax</str>
+       <str name="q.alt">*:*</str>
+       <str name="rows">10</str>
+       <str name="fl">*,score</str>
+
+       <str name="facet">on</str>
+       <str name="facet.field">cat</str>
+       <str name="facet.field">manu_exact</str>
+       <str name="facet.mincount">1</str>
+       <str name="qf">
+          text^0.5 features^1.0 name^1.2 sku^1.5 id^10.0 manu^1.1 cat^1.4
+       </str>
+       
+       <str name="hl">on</str>
+       <str name="hl.fl">text features name</str>
+       <str name="f.name.hl.fragsize">0</str>
+       <str name="f.name.hl.alternateField">name</str>
+     </lst>
+  </requestHandler>
+  
 
 <!-- Please refer to http://wiki.apache.org/solr/SolrReplication for details on configuring replication -->
 <!-- remove the <lst name="master"> section if this is just a slave -->
@@ -1022,14 +1052,13 @@
     <queryResponseWriter name="ruby" class="solr.RubyResponseWriter"/>
     <queryResponseWriter name="php" class="solr.PHPResponseWriter"/>
     <queryResponseWriter name="phps" class="solr.PHPSerializedResponseWriter"/>
+    <queryResponseWriter name="velocity" class="solr.VelocityResponseWriter"/>
 
       Custom response writers can be declared as needed...
     
     <queryResponseWriter name="custom" class="com.example.MyResponseWriter"/>
   -->
 
-  <queryResponseWriter name="velocity" class="solr.VelocityResponseWriter"/>
-
   <!-- XSLT response writer transforms the XML output by any xslt file found
        in Solr's conf/xslt directory.  Changes to xslt files are checked for
        every xsltCacheLifetimeSeconds.  
diff --git a/solr/example/solr/conf/velocity/VM_global_library.vm b/solr/example/solr/conf/velocity/VM_global_library.vm
index aff58380b3e..6b7d88af894 100644
--- a/solr/example/solr/conf/velocity/VM_global_library.vm
+++ b/solr/example/solr/conf/velocity/VM_global_library.vm
@@ -1,11 +1,46 @@
-#macro(nl2ul $named_list)
-  <ul>
-  #foreach($kv in $named_list)
-    <li>$kv.key ($kv.value)
-      #nl2ul($kv.value)
-    </li>
+#macro(param $key)$request.params.get($key)#end
+
+#macro(url_for_solr)/solr#end
+#macro(url_for_home)#url_for_solr/browse#end
+
+#macro(q)q=$!{esc.url($params.get('q'))}#end
+
+#macro(fqs $p)#foreach($fq in $p)#if($velocityCount>1)&#{end}fq=$esc.url($fq)#end#end
+
+#macro(debug)#if($request.params.get('debugQuery'))&debugQuery=true#end#end
+
+#macro(lens)?#q#if($list.size($request.params.getParams('fq')) > 0)&#fqs($request.params.getParams('fq'))#end#debug#end
+
+#macro(url_for_lens)#{url_for_home}#lens#end
+
+#macro(url_for_start $start)#url_for_home#lens&start=$start#end
+
+#macro(url_for_filters $p)#url_for_home?#q#if($list.size($p) > 0)&#fqs($p)#end#debug#end
+
+## TODO: convert to use {!raw f=$field}$value (with escaping of course)
+#macro(url_for_facet_filter $field $value)#url_for_home#lens&fq=$esc.url($field):%22$esc.url($value)%22#end
+
+#macro(link_to_previous_page $text)
+  #if($page.current_page_number > 1)
+    #set($prev_start = $page.start - $page.results_per_page)
+    <a class="prev-page" href="#url_for_start($prev_start)">$text</a>
   #end
-  </ul>
 #end
 
-#macro(param $key)$request.params.get($key)#end
+#macro(link_to_next_page $text)
+  #if($page.current_page_number < $page.page_count)
+    #set($next_start = $page.start + $page.results_per_page)
+    <a class="next-page" href="#url_for_start($next_start)">$text</a>
+  #end
+#end
+
+#macro(link_to_page $page_number $text)
+  #if($page_number == $page.current_page_number)
+    $text
+  #else
+    #if($page_number <= $page.page_count)
+      #set($page_start = $page_number * $page.results_per_page - $page.results_per_page)
+      <a class="page" href="#url_for_start($page_start)">$text</a>
+    #end
+  #end
+#end
diff --git a/solr/example/solr/conf/velocity/browse.vm b/solr/example/solr/conf/velocity/browse.vm
new file mode 100644
index 00000000000..ddea03b5349
--- /dev/null
+++ b/solr/example/solr/conf/velocity/browse.vm
@@ -0,0 +1,55 @@
+#set($searcher=$request.searcher)
+#set($params=$request.params)
+#set($clusters = $response.response.clusters)
+
+<div class="query-box">
+  <form id="query-form" action="#{url_for_home}#fqs($request.params.getParams('fq'))" method="GET">
+    <a href="#url_for_home#if($request.params.get('debugQuery'))?debugQuery=true#end">Find</a>: <input type="text" name="q" value="$!esc.html($params.get('q'))"/>
+    #if($request.params.get('debugQuery'))
+      <input type="hidden" name="debugQuery" value="true"/>
+    #end
+    <div>
+      #foreach($fq in $params.getParams('fq'))
+        #set($previous_fq_count=$velocityCount - 1)
+      &gt; <a style="{text-decoration: line-through;}" href="#url_for_filters($request.params.getParams('fq').subList(0,$previous_fq_count))">$fq</a>
+      #end
+    </div>
+     #if($request.params.get('debugQuery'))
+        <a href="#" onclick='jQuery(this).siblings("pre").toggle(); return false;'>toggle parsed query</a>
+        <pre style="display:none">$response.response.debug.parsedquery</pre>
+      #end    
+  </form>
+  <script language="text/javascript">
+    $("input[type=text]").autoSuggest("/solr/suggest", {selectedItemProp: "name", searchObjProps: "name"}});
+  </script>
+</div>
+
+#if($response.response.spellcheck.suggestions.size() > 0)
+  Did you mean <a href="#url_for_home?q=$esc.url($response.response.spellcheck.suggestions.collation)#if($list.size($request.params.getParams('fq')) > 0)&#fqs($request.params.getParams('fq'))#end#debug">$response.response.spellcheck.suggestions.collation</a>?
+#end
+
+<div class="navigators">
+  #parse("facets.vm")
+</div>
+
+<div class="pagination">
+  <span><span class="results-found">$page.results_found</span> results found in ${response.responseHeader.QTime} ms</span>
+  Page <span class="page-num">$page.current_page_number</span> of <span
+        class="page-count">$page.page_count</span>
+</div>
+
+<div class="results">
+  #foreach($doc in $response.results)
+    #parse("hit.vm")
+  #end
+</div>
+
+<div class="pagination">
+  #link_to_previous_page("previous")
+  <span class="results-found">$page.results_found</span> results found.
+  Page <span class="page-num">$page.current_page_number</span> of <span
+        class="page-count">$page.page_count</span>
+  #link_to_next_page("next")
+
+  <br/>
+</div>
diff --git a/solr/example/solr/conf/velocity/facets.vm b/solr/example/solr/conf/velocity/facets.vm
new file mode 100644
index 00000000000..bd1fd3f085a
--- /dev/null
+++ b/solr/example/solr/conf/velocity/facets.vm
@@ -0,0 +1,12 @@
+  #if($response.facetFields)
+    <h2>Facets</h2>
+    #foreach($field in $response.facetFields)
+      <span class="facet-field">$field.name</span>
+      
+      <ul>
+        #foreach($facet in $field.values)
+            <li><a href="#url_for_facet_filter($field.name, $facet.name)">$facet.name</a> ($facet.count)</li>
+        #end
+      </ul>
+    #end
+  #end
diff --git a/solr/example/solr/conf/velocity/footer.vm b/solr/example/solr/conf/velocity/footer.vm
new file mode 100644
index 00000000000..5dd0416ad10
--- /dev/null
+++ b/solr/example/solr/conf/velocity/footer.vm
@@ -0,0 +1,7 @@
+<hr/>
+Generated by <a href="http://wiki.apache.org/solr/VelocityResponseWriter">VelocityResponseWriter</a>
+#if($request.params.get('debugQuery'))
+  <a href="#url_for_home?#q#if($list.size($request.params.getParams('fq')) > 0)&#fqs($request.params.getParams('fq'))#end">disable debug</a>
+#else
+  <a href="#url_for_lens&debugQuery=true">enable debug</a>
+#end
diff --git a/solr/example/solr/conf/velocity/header.vm b/solr/example/solr/conf/velocity/header.vm
new file mode 100644
index 00000000000..067f77745e8
--- /dev/null
+++ b/solr/example/solr/conf/velocity/header.vm
@@ -0,0 +1 @@
+## empty header, customize as desired
\ No newline at end of file
diff --git a/solr/example/solr/conf/velocity/hit.vm b/solr/example/solr/conf/velocity/hit.vm
new file mode 100644
index 00000000000..a312a0b0dd2
--- /dev/null
+++ b/solr/example/solr/conf/velocity/hit.vm
@@ -0,0 +1,19 @@
+#macro(field $f)
+  #if($response.response.highlighting.get($doc.getFieldValue('id')).get($f).get(0))
+    $!response.response.highlighting.get($doc.getFieldValue('id')).get($f).get(0)
+  #else
+    #foreach($v in $doc.getFieldValues($f))
+      $v
+    #end
+  #end
+#end
+<div class="result-document">
+  <p><b>#field('name')</b> $!number.currency($doc.getFieldValue('price'))</p>
+  
+  <p>#field('features')</p>
+  
+  #if($params.getBool("debugQuery",false))
+    <a href="#" onclick='jQuery(this).siblings("pre").toggle(); return false;'>toggle explain</a>
+    <pre style="display:none">$response.getExplainMap().get($doc.getFirstValue('id'))</pre>
+  #end
+</div>
diff --git a/solr/example/solr/conf/velocity/layout.vm b/solr/example/solr/conf/velocity/layout.vm
new file mode 100644
index 00000000000..fb0e7feb8eb
--- /dev/null
+++ b/solr/example/solr/conf/velocity/layout.vm
@@ -0,0 +1,23 @@
+<html>
+  <head>
+    ## An example of using an arbitrary request parameter
+    <title>#param('title')</title>
+    <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
+    <script type="text/javascript" src="/solr/admin/jquery-1.2.3.min.js"></script>
+    <link rel="stylesheet" type="text/css" href="/solr/admin/file?file=/velocity/main.css&contentType=text/css"/>
+  </head>
+  <body>
+    <div id="header">
+      #parse("header.vm")
+    </div>
+    
+    <div id="content">
+      $content
+    </div>
+  
+    <div id="footer">
+      #parse("footer.vm")
+    </div>
+
+  </body>
+</html>
\ No newline at end of file
diff --git a/solr/example/solr/conf/velocity/main.css b/solr/example/solr/conf/velocity/main.css
new file mode 100644
index 00000000000..5a82702fad8
--- /dev/null
+++ b/solr/example/solr/conf/velocity/main.css
@@ -0,0 +1,96 @@
+.array-field {
+  border: 2px solid #474747;
+  background: #FFE9D8;
+  padding: 5px;
+  margin: 5px;
+}
+
+.array-field-list li {
+  list-style: circle;
+  margin-left: 20px;
+}
+
+body {
+  font-family: Arial, Helvetica, sans-serif;
+  font-size: 10pt;
+}
+
+.constraints-title {
+  background: gray;
+}
+
+.navigators {
+  float: left;
+  margin: 5px;
+  margin-top: 0px;
+  background: #FEC293;
+  border: 2px solid #474747;
+  width: 185px;
+  padding: 2px;
+}
+
+.facet-field {
+  font-weight: bold;
+}
+
+.highlight {
+  color: white;
+  background-color: gray;
+  border: 1px black solid;
+}
+
+.highlight-box {
+  margin-left: 15px;
+}
+
+.field-name {
+  font-weight: bold;
+}
+
+.highlighted-facet-field {
+  background: white;
+}
+
+#logo {
+  margin: 10px;
+}
+
+.query-box, .constraints {
+  padding: 5px;
+  margin: 5px;
+  border: 3px solid #474747;
+  color: white;
+  background: #FD9644;
+  font-weight: bold;
+  font-size: 16px;
+}
+
+.query-box input {
+  margin-left: 8px;
+  width: 85%;
+}
+
+.pagination {
+  padding-left: 33%;
+  font-weight: bold;
+  background: gray;
+  color: white;
+  margin: 5px;
+  margin-left: 200px;
+}
+
+.result-document {
+  border: 3px solid #474747;
+  background: #FEC293;
+  padding: 5px;
+  margin: 5px;
+  margin-left: 200px;
+}
+
+.selected-facet-field {
+  font-weight: bold;
+}
+
+li.show {
+  list-style: disc;
+}
\ No newline at end of file
diff --git a/solr/contrib/velocity/src/main/solr/lib/commons-beanutils-1.7.0.jar b/solr/lib/commons-beanutils-1.7.0.jar
similarity index 100%
rename from solr/contrib/velocity/src/main/solr/lib/commons-beanutils-1.7.0.jar
rename to solr/lib/commons-beanutils-1.7.0.jar
diff --git a/solr/contrib/velocity/src/main/solr/lib/commons-collections-3.2.1.jar b/solr/lib/commons-collections-3.2.1.jar
similarity index 100%
rename from solr/contrib/velocity/src/main/solr/lib/commons-collections-3.2.1.jar
rename to solr/lib/commons-collections-3.2.1.jar
diff --git a/solr/contrib/velocity/src/main/solr/lib/commons-lang-2.4.jar b/solr/lib/commons-lang-2.4.jar
similarity index 100%
rename from solr/contrib/velocity/src/main/solr/lib/commons-lang-2.4.jar
rename to solr/lib/commons-lang-2.4.jar
diff --git a/solr/contrib/velocity/src/main/solr/lib/velocity-1.6.1.jar b/solr/lib/velocity-1.6.1.jar
similarity index 100%
rename from solr/contrib/velocity/src/main/solr/lib/velocity-1.6.1.jar
rename to solr/lib/velocity-1.6.1.jar
diff --git a/solr/contrib/velocity/src/main/solr/lib/velocity-tools-2.0-beta3.jar b/solr/lib/velocity-tools-2.0-beta3.jar
similarity index 100%
rename from solr/contrib/velocity/src/main/solr/lib/velocity-tools-2.0-beta3.jar
rename to solr/lib/velocity-tools-2.0-beta3.jar
diff --git a/solr/src/java/org/apache/solr/core/SolrCore.java b/solr/src/java/org/apache/solr/core/SolrCore.java
index c25fea58c70..f9265d3a1f1 100644
--- a/solr/src/java/org/apache/solr/core/SolrCore.java
+++ b/solr/src/java/org/apache/solr/core/SolrCore.java
@@ -43,6 +43,7 @@ import org.apache.solr.response.QueryResponseWriter;
 import org.apache.solr.response.RawResponseWriter;
 import org.apache.solr.response.RubyResponseWriter;
 import org.apache.solr.response.SolrQueryResponse;
+import org.apache.solr.response.VelocityResponseWriter;
 import org.apache.solr.response.XMLResponseWriter;
 import org.apache.solr.schema.IndexSchema;
 import org.apache.solr.search.QParserPlugin;
@@ -1406,6 +1407,7 @@ public final class SolrCore implements SolrInfoMBean {
     m.put("ruby", new RubyResponseWriter());
     m.put("raw", new RawResponseWriter());
     m.put("javabin", new BinaryResponseWriter());
+    m.put("velocity", new VelocityResponseWriter());
     DEFAULT_RESPONSE_WRITERS = Collections.unmodifiableMap(m);
   }
   
diff --git a/solr/contrib/velocity/src/main/java/org/apache/solr/response/PageTool.java b/solr/src/java/org/apache/solr/response/PageTool.java
similarity index 100%
rename from solr/contrib/velocity/src/main/java/org/apache/solr/response/PageTool.java
rename to solr/src/java/org/apache/solr/response/PageTool.java
diff --git a/solr/contrib/velocity/src/main/java/org/apache/solr/response/SolrParamResourceLoader.java b/solr/src/java/org/apache/solr/response/SolrParamResourceLoader.java
similarity index 100%
rename from solr/contrib/velocity/src/main/java/org/apache/solr/response/SolrParamResourceLoader.java
rename to solr/src/java/org/apache/solr/response/SolrParamResourceLoader.java
diff --git a/solr/contrib/velocity/src/main/java/org/apache/solr/response/SolrVelocityResourceLoader.java b/solr/src/java/org/apache/solr/response/SolrVelocityResourceLoader.java
similarity index 100%
rename from solr/contrib/velocity/src/main/java/org/apache/solr/response/SolrVelocityResourceLoader.java
rename to solr/src/java/org/apache/solr/response/SolrVelocityResourceLoader.java
diff --git a/solr/contrib/velocity/src/main/java/org/apache/solr/response/VelocityResponseWriter.java b/solr/src/java/org/apache/solr/response/VelocityResponseWriter.java
similarity index 100%
rename from solr/contrib/velocity/src/main/java/org/apache/solr/response/VelocityResponseWriter.java
rename to solr/src/java/org/apache/solr/response/VelocityResponseWriter.java
diff --git a/solr/contrib/velocity/src/test/org/apache/solr/velocity/VelocityResponseWriterTest.java b/solr/src/test/org/apache/solr/velocity/VelocityResponseWriterTest.java
similarity index 100%
rename from solr/contrib/velocity/src/test/org/apache/solr/velocity/VelocityResponseWriterTest.java
rename to solr/src/test/org/apache/solr/velocity/VelocityResponseWriterTest.java
diff --git a/solr/contrib/velocity/src/main/solr/conf/velocity/VM_global_library.vm b/solr/src/test/test-files/solr/conf/velocity/VM_global_library.vm
similarity index 100%
rename from solr/contrib/velocity/src/main/solr/conf/velocity/VM_global_library.vm
rename to solr/src/test/test-files/solr/conf/velocity/VM_global_library.vm