import

webui.py

@@ -0,0 +1,245 @@
+#!env python
+#{{{ imports
+import os
+import bottle
+import time
+import recoll
+import datetime
+import glob
+import hashlib
+import json
+import csv
+import StringIO
+import ConfigParser
+import string
+import shlex
+from pprint import pprint
+#}}}
+#{{{ settings
+# recoll settings
+RECOLL_CONFS = [ '~/.recoll/recoll.conf', '/etc/recoll.conf' ]
+
+# settings defaults
+DEFAULTS = {
+    'prefix': 'z:/',
+    'context': 30,
+    'stem': 1,
+    'timefmt': '%c',
+    'dirdepth': 3,
+}
+
+# sort fields/labels
+SORTS = [
+    ("mtime", "Date",),
+    ("url", "Path"),
+    ("filename", "Filename"),
+    ("relevancyrating", "Relevancy"),
+    ("fbytes", "Size"),
+    ("author", "Author"),
+]
+
+# doc fields
+FIELDS = [
+    # exposed by python api
+    'ipath',
+    'filename',
+    'title',
+    'author',
+    'fbytes',
+    'dbytes',
+    'size',
+    'fmtime',
+    'dmtime',
+    'mtime',
+    'mtype',
+    'origcharset',
+    'sig',
+    'relevancyrating',
+    'url',
+    'abstract',
+    'keywords',
+    # calculated
+    'time',
+    'snippet',
+    'label',
+]
+#}}}
+#{{{  functions
+#{{{  helpers
+def select(ls, invalid=[None]):
+    for value in ls:
+        if value not in invalid:
+            return value
+
+def timestr(secs, fmt):
+    t = time.gmtime(int(secs))
+    return time.strftime(fmt, t)
+
+def normalise_filename(fn):
+    valid_chars = "_-%s%s" % (string.ascii_letters, string.digits)
+    out = ""
+    for i in range(0,len(fn)):
+        if fn[i] in valid_chars:
+            out += fn[i]
+        else:
+            out += "_"
+    return out
+#}}}
+#{{{ get_config
+def get_config():
+    config = {}
+    # find recoll.conf
+    for f in RECOLL_CONFS:
+        f = os.path.expanduser(f)
+        if os.path.isfile(f):
+            path = f
+            break
+    # read recoll.conf
+    rc_ini_str = '[main]\n' + open(path, 'r').read()
+    rc_ini_fp = StringIO.StringIO(rc_ini_str)
+    rc_ini = ConfigParser.RawConfigParser()
+    rc_ini.readfp(rc_ini_fp)
+    # parse recoll.conf
+    rc = {}
+    for s in rc_ini.sections():
+        rc[s] = {}
+        for k, v in rc_ini.items(s):
+            rc[s][k] = v
+    # get useful things from recoll.conf
+    config['dirs'] = shlex.split(rc['main']['topdirs'])
+    # get config from cookies or defaults
+    for k, v in DEFAULTS.items():
+        config[k] = select([bottle.request.get_cookie(k), v])
+    return config
+#}}}
+#{{{ get_dirs
+def get_dirs(tops, depth):
+    v = []
+    for top in tops:
+        dirs = [top]
+        for d in range(1, int(depth)+1):
+            dirs = dirs + glob.glob(top + '/*' * d)
+        dirs = filter(lambda f: os.path.isdir(f), dirs)
+        top_path = top.rsplit('/', 1)[0]
+        dirs = [w.replace(top_path+'/', '') for w in dirs]
+        v = v + dirs
+    return ['<all>'] + v
+#}}}
+#{{{ get_query
+def get_query():
+    query = {
+        'keywords': select([bottle.request.query.get('query'), '']),
+        'before': select([bottle.request.query.get('before'), '']),
+        'after': select([bottle.request.query.get('after'), '']),
+        'dir': select([bottle.request.query.get('dir'), '', '<all>'], [None, '']),
+        'sort': select([bottle.request.query.get('sort'), SORTS[0][0]]),
+        'ascending': select([bottle.request.query.get('ascending'), 0]),
+    }
+    return query
+#}}}
+#{{{ query_to_recoll_string
+def query_to_recoll_string(q):
+    qs = q['keywords'].decode('utf-8')
+    if len(q['after']) > 0 or len(q['before']) > 0:
+        qs += " date:%s/%s" % (q['after'], q['before'])
+    if q['dir'] != '<all>':
+        qs += " dir:\"%s\" " % q['dir']
+    return qs
+#}}}
+#{{{ recoll_search
+def recoll_search(q, sort, ascending):
+    config = get_config()
+    tstart = datetime.datetime.now()
+    results = []
+    db = recoll.connect()
+    db.setAbstractParams(contextwords=int(config['context']), maxchars=5000)
+    query = db.query()
+    query.sortby(sort, int(ascending))
+    try:
+        nres = query.execute(q, stemming=int(config['stem']))
+    except:
+        nres = 0
+    for i in range(0, nres):
+        doc = query.fetchone()
+        d = {}
+        for f in FIELDS:
+            d[f] = getattr(doc, f).encode('utf-8')
+        d['label'] = select([d['title'], d['filename'], '?'], [None, ''])
+        d['sha'] = hashlib.sha1(d['url']+d['ipath']).hexdigest()
+        d['time'] = timestr(d['mtime'], config['timefmt'])
+        d['snippet'] = db.makeDocAbstract(doc, query).encode('utf-8')
+        results.append(d)
+    tend = datetime.datetime.now()
+    return results, tend - tstart
+#}}}
+#}}}
+#{{{ routes
+#{{{ static
+@bottle.route('/static/:path#.+#')
+def server_static(path):
+    return bottle.static_file(path, root='./static')
+#}}}
+#{{{ main
+@bottle.route('/')
+@bottle.view('main')
+def main():
+    config = get_config()
+    return { 'dirs': get_dirs(config['dirs'], config['dirdepth']),
+            'query': get_query(), 'sorts': SORTS }
+#}}}
+#{{{ results
+@bottle.route('/results')
+@bottle.view('results')
+def results():
+    config = get_config()
+    query = get_query()
+    qs = query_to_recoll_string(query)
+    pprint(query)
+    res, timer = recoll_search(qs, query['sort'], query['ascending'])
+    return { 'res': res, 'time': timer, 'query': query, 'dirs':
+            get_dirs(config['dirs'], config['dirdepth']),'qs': qs, 'sorts': SORTS, 'config': config,
+            'query_string': bottle.request.query_string, 'roots': config['dirs'] }
+#}}}
+#{{{ json
+@bottle.route('/json')
+def get_json():
+    query = get_query()
+    qs = query_to_recoll_string(query)
+    bottle.response.headers['Content-Type'] = 'application/json'
+    bottle.response.headers['Content-Disposition'] = 'attachment; filename=recoll-%s.json' % normalise_filename(qs)
+    res, timer = recoll_search(qs, query['sort'], query['ascending'])
+
+    return json.dumps({ 'query': query, 'results': res })
+#}}}
+#{{{ csv
+@bottle.route('/csv')
+def get_csv():
+    query = get_query()
+    qs = query_to_recoll_string(query)
+    bottle.response.headers['Content-Type'] = 'text/csv'
+    bottle.response.headers['Content-Disposition'] = 'attachment; filename=recoll-%s.csv' % normalise_filename(qs)
+    res, timer = recoll_search(qs, query['sort'], query['ascending'])
+    si = StringIO.StringIO()
+    cw = csv.writer(si)
+    cw.writerow(FIELDS)
+    for doc in res:
+        row = []
+        for f in FIELDS:
+            row.append(doc[f])
+        cw.writerow(row)
+    return si.getvalue().strip("\r\n")
+#}}}
+#{{{ settings/set
+@bottle.route('/settings')
+@bottle.view('settings')
+def settings():
+    return get_config()
+
+@bottle.route('/set')
+def set():
+    for k, v in DEFAULTS.items():
+        bottle.response.set_cookie(k, str(bottle.request.query.get(k)), max_age=3153600000)
+    bottle.redirect('..')
+#}}}
+#}}}
+# vim: fdm=marker:tw=80:ts=4:sw=4:sts=4:et