added open search compatibility

git-svn-id: https://svn.berlios.de/svnroot/repos/yacy/trunk@2401 6c8d7289-2bf4-0310-a012-ef5d649a1542
yacy · Aug 12, 2006 · 248627a · 248627a
1 parent 8418af1
commit 248627a
Show file tree

Hide file tree

Showing 3 changed files with 83 additions and 3 deletions.
diff --git a/htroot/opensearchdescription.java b/htroot/opensearchdescription.java
@@ -0,0 +1,53 @@
+// opensearchdescription.java
+// (C) 2006 by Michael Peter Christen; mc@anomic.de, Frankfurt a. M., Germany
+// first published 12.08.2006 on http://www.anomic.de
+//
+// This is a part of YaCy, a peer-to-peer based web search engine
+//
+// $LastChangedDate: 2006-04-02 22:40:07 +0200 (So, 02 Apr 2006) $
+// $LastChangedRevision: 1986 $
+// $LastChangedBy: orbiter $
+//
+// LICENSE
+// 
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+import de.anomic.http.httpHeader;
+import de.anomic.server.serverCore;
+import de.anomic.server.serverObjects;
+import de.anomic.server.serverSwitch;
+import de.anomic.yacy.yacyCore;
+
+public class opensearchdescription {
+
+    public static serverObjects respond(httpHeader header, serverObjects post, serverSwitch env) {
+
+        // generate message content for open search description
+        String promoteSearchPageGreeting = env.getConfig("promoteSearchPageGreeting", "");
+        if (promoteSearchPageGreeting.length() == 0) promoteSearchPageGreeting = "P2P WEB SEARCH";
+
+        String thisaddress = (String) header.get("Host", "localhost");
+        if (thisaddress.indexOf(":") == -1) thisaddress += ":" + serverCore.getPortNr(env.getConfig("port", "8080"));
+
+        final serverObjects prop = new serverObjects();
+        prop.put("thisaddress", thisaddress);
+        prop.put("SearchPageGreeting", promoteSearchPageGreeting);
+        prop.put("clientname", yacyCore.seedDB.mySeed.getName());
+
+        // return rewrite properties
+        return prop;
+    }
+
+}
diff --git a/htroot/opensearchdescription.xml b/htroot/opensearchdescription.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
+  <ShortName>#[SearchPageGreeting]#</ShortName>
+  <Description>YaCy Multi-User P2P-based Web Indexing Cluster</Description>
+  <Tags>YaCy P2P Web Search</Tags>
+  <Contact>YaCy P2P Web Indexing Software: yacy.net; Peer Owner '#[clientname]#': see http://#[thisaddress]#/ViewProfile.html?hash=localhash</Contact>
+  <Url type="application/rss+xml" template="http://#[thisaddress]#/yacysearch.rss?search={searchTerms}&amp;Enter=Search" />
+  <Url type="text/html" template="http://#[thisaddress]#/yacysearch.html?search={searchTerms}&amp;Enter=Search" />
+  <LongName>YaCy.net P2P Web Search - this is peer #[clientname]#</LongName>
+  <Image type="image/gif">http://#[thisaddress]#/env/grafics/yacy.gif</Image>
+  <Image type="image/vnd.microsoft.icon">http://#[thisaddress]#/env/grafics/yacy.ico</Image>
+  <Query role="example" searchTerms="cat" />
+  <Developer>YaCy.net Development Team. See http://developer.berlios.de/projects/yacy/</Developer>
+  <Attribution>YaCy P2P WebSearch &amp;copy; 2006, YaCy.net</Attribution>
+  <SyndicationRight>open</SyndicationRight>
+  <AdultContent>true</AdultContent>
+  <Language>en-us</Language>
+  <OutputEncoding>UTF-8</OutputEncoding>
+  <InputEncoding>UTF-8</InputEncoding>
+</OpenSearchDescription>
diff --git a/htroot/yacysearch.rss b/htroot/yacysearch.rss
@@ -1,13 +1,20 @@
 <?xml version="1.0"?>
 <?xml-stylesheet type='text/xsl' href='/yacysearch.xsl' version='1.0'?>
-<rss version="2.0" xmlns:yacyTopwords="http://www.yacy.net/yacy/topwords">
+<rss version="2.0"
+    xmlns:yacyTopwords="http://www.yacy.net/yacy/topwords"
+    xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
 	<channel>
-		<title>Search for #[former]#</title>
+		<title>YaCy P2P-Search for #[former]#</title>
 		<description>Search for #[former]#</description>
 		<image>
 			<url>#[rssYacyImageURL]#</url>
 			<title>Search for #[former]#</title>
 		</image>
+		<opensearch:totalResults>#[type_num-results]#</opensearch:totalResults>
+    		<opensearch:startIndex>1</opensearch:startIndex>
+    		<opensearch:itemsPerPage>#[type_num-results]#</opensearch:itemsPerPage>
+    		<opensearch:link rel="search" href="opensearchdescription.xml" type="application/opensearchdescription+xml"/>
+    		<opensearch:Query role="request" searchTerms="#[former]#" />
 		#(type)#
 		#{results}#
 		<item>
@@ -30,4 +37,4 @@
         ::
 		#(/type)#
 	</channel>
-</rss>
+</rss>