Merge pull request #531 from guyou/add-doku-engine

Add doku engine

2 files changed, 91 insertions, 0 deletions

diff --git a/searx/engines/doku.py b/searx/engines/doku.py
new file mode 100644
index 000000000..93867fd0d
--- /dev/null
+++ b/searx/engines/doku.py
@@ -0,0 +1,84 @@
+# Doku Wiki
+#
+# @website     https://www.dokuwiki.org/
+# @provide-api yes
+#              (https://www.dokuwiki.org/devel:xmlrpc)
+#
+# @using-api   no
+# @results     HTML
+# @stable      yes
+# @parse       (general)    url, title, content
+
+from urllib import urlencode
+from lxml.html import fromstring
+from searx.engines.xpath import extract_text
+
+# engine dependent config
+categories = ['general']  # TODO , 'images', 'music', 'videos', 'files'
+paging = False
+language_support = False
+number_of_results = 5
+
+# search-url
+# Doku is OpenSearch compatible
+base_url = 'http://localhost:8090'
+search_url = '/?do=search'\
+             '&{query}'
+# TODO             '&startRecord={offset}'\
+# TODO             '&maximumRecords={limit}'\
+
+
+# do search-request
+def request(query, params):
+
+    params['url'] = base_url +\
+        search_url.format(query=urlencode({'id': query}))
+
+    return params
+
+
+# get response from search-request
+def response(resp):
+    results = []
+
+    doc = fromstring(resp.text)
+
+    # parse results
+    # Quickhits
+    for r in doc.xpath('//div[@class="search_quickresult"]/ul/li'):
+        try:
+            res_url = r.xpath('.//a[@class="wikilink1"]/@href')[-1]
+        except:
+            continue
+
+        if not res_url:
+            continue
+
+        title = extract_text(r.xpath('.//a[@class="wikilink1"]/@title'))
+
+        # append result
+        results.append({'title': title,
+                        'content': "",
+                        'url': base_url + res_url})
+
+    # Search results
+    for r in doc.xpath('//dl[@class="search_results"]/*'):
+        try:
+            if r.tag == "dt":
+                res_url = r.xpath('.//a[@class="wikilink1"]/@href')[-1]
+                title = extract_text(r.xpath('.//a[@class="wikilink1"]/@title'))
+            elif r.tag == "dd":
+                content = extract_text(r.xpath('.'))
+
+                # append result
+                results.append({'title': title,
+                                'content': content,
+                                'url': base_url + res_url})
+        except:
+            continue
+
+        if not res_url:
+            continue
+
+    # return results
+    return results
diff --git a/searx/settings.yml b/searx/settings.yml
index 462a0bcc2..40f569e9f 100644
--- a/searx/settings.yml
+++ b/searx/settings.yml
@@ -337,6 +337,13 @@ engines:
 #    number_of_results : 5
 #    timeout : 3.0
 
+# Doku engine lets you access to any Doku wiki instance:
+# A public one or a privete/corporate one.
+#  - name : ubuntuwiki
+#    engine : doku
+#    shortcut : uw
+#    base_url : 'http://doc.ubuntu-fr.org'
+
 locales:
     en : English
     bg : Български (Bulgarian)