Skip to content

Commit

Permalink
added search suggestions in XML format. This also supports CORS
Browse files Browse the repository at this point in the history
git-svn-id: https://svn.berlios.de/svnroot/repos/yacy/trunk@7293 6c8d7289-2bf4-0310-a012-ef5d649a1542
  • Loading branch information
orbiter committed Nov 3, 2010
1 parent f5324b2 commit 3e303db
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 10 deletions.
3 changes: 2 additions & 1 deletion htroot/opensearchdescription.xml
Expand Up @@ -18,7 +18,8 @@
::
<Url type="text/html" method="GET" template="http://#[thisaddress]#/compare_yacy.html?verify=true&amp;resource=global&amp;nav=all&amp;query={searchTerms}" />
#(/compareyacy)#
<Url type="application/x-suggestions+json" template="http://#[thisaddress]#/suggest?query={searchTerms}"/>
<Url type="application/x-suggestions+json" template="http://#[thisaddress]#/suggest.json?query={searchTerms}"/>
<Url type="application/x-suggestions+xml" template="http://#[thisaddress]#/suggest.xml?query={searchTerms}"/>
<!-- syntax according to http://www.loc.gov/standards/sru/. Set verify=true to get snippets in the search results -->
<Developer>See http://developer.berlios.de/projects/yacy/</Developer>
<Query role="example" searchTerms="yacy+open+source" />
Expand Down
42 changes: 34 additions & 8 deletions htroot/suggest.java
Expand Up @@ -20,28 +20,42 @@

import java.util.Iterator;

import net.yacy.cora.protocol.HeaderFramework;
import net.yacy.cora.protocol.RequestHeader;
import net.yacy.cora.protocol.ResponseHeader;

import de.anomic.data.DidYouMean;
import de.anomic.search.Segment;
import de.anomic.search.Segments;
import de.anomic.search.Switchboard;
import de.anomic.server.serverObjects;
import de.anomic.server.serverSwitch;
import de.anomic.server.servletProperties;

/**
* for json format:
* implementation of the opensearch suggestion extension, see
* http://www.opensearch.org/Specifications/OpenSearch/Extensions/Suggestions/1.1
* or
* https://wiki.mozilla.org/Search_Service/Suggestions
*
* for xml format:
* see Microsoft Search Suggestion Format
* http://msdn.microsoft.com/en-us/library/cc848863%28VS.85%29.aspx
* and
* http://msdn.microsoft.com/en-us/library/cc848862%28v=VS.85%29.aspx
*/
public class suggest {

private static final int meanMax = 30;

public static serverObjects respond(final RequestHeader header, final serverObjects post, final serverSwitch env) {
final Switchboard sb = (Switchboard) env;
final serverObjects prop = new serverObjects();
final servletProperties prop = new servletProperties();

final String ext = header.get("EXT", "");
final boolean json = ext.equals("json");
final boolean xml = ext.equals("xml");

// get query
String originalquerystring = (post == null) ? "" : post.get("query", post.get("q", "")).trim();
Expand All @@ -63,17 +77,29 @@ public static serverObjects respond(final RequestHeader header, final serverObje

DidYouMean didYouMean = new DidYouMean(indexSegment.termIndex(), querystring);
Iterator<String> meanIt = didYouMean.getSuggestions(timeout, count).iterator();
int meanCount = 0;
int c = 0;
String suggestion;
StringBuilder suggestions = new StringBuilder(120);
while (meanCount < meanMax && meanIt.hasNext()) {
//[#[query]#,[#{suggestions}##[text]##(eol)#,::#(/eol)##{/suggestions}#]]
while (c < meanMax && meanIt.hasNext()) {
suggestion = meanIt.next();
suggestions.append(',').append('"').append(suggestion).append('"');
meanCount++;
if (json) prop.putJSON("suggestions_" + c + "_text", suggestion);
else if (xml) prop.putXML("suggestions_" + c + "_text", suggestion);
else prop.putHTML("suggestions_" + c + "_text", suggestion);
prop.put("suggestions_" + c + "_eol", 0);
c++;
}
if (c > 0) prop.put("suggestions_" + (c - 1) + "_eol", 1);
prop.put("suggestions", c);
if (json) prop.putJSON("query", originalquerystring);
else if (xml) prop.putXML("query", originalquerystring);
else prop.putHTML("query", originalquerystring);

prop.put("query", '"' + originalquerystring + '"');
prop.put("suggestions", suggestions.length() > 0 ? suggestions.substring(1) : "");
// Adding CORS Access header for xml output
if (xml) {
final ResponseHeader outgoingHeader = new ResponseHeader();
outgoingHeader.addHeader(HeaderFramework.CORS_ALLOW_ORIGIN, "*");
prop.setOutgoingHeader(outgoingHeader);
}

// return rewrite properties
return prop;
Expand Down
2 changes: 1 addition & 1 deletion htroot/suggest.json
@@ -1 +1 @@
[#[query]#,[#[suggestions]#]]
["#[query]#",[#{suggestions}#"#[text]#"#(eol)#,::#(/eol)##{/suggestions}#]]
11 changes: 11 additions & 0 deletions htroot/suggest.xml
@@ -0,0 +1,11 @@
<?xml version="1.0"?>
<SearchSuggestion xmlns ="http://schemas.microsoft.com/Search/2008/suggestions">
<Query>#[query]#</Query>
<Section>
#{suggestions}#
<Item>
<Text>#[text]#</Text>
</Item>
#{/suggestions}#
</Section>
</SearchSuggestion>

0 comments on commit 3e303db

Please sign in to comment.