def testquery():
""" Returns the query expressed in elastics search api """
auth, permitted = validate_user(mode="read")
try:
from translator import parser
query = request.query_string
# default
settings = parser.make_settings(permitted, {'size': 25, 'page': 0})
elasticq = parser.parse(query, settings)
mode = settings['mode']
if not settings.get('sort', ''):
# default: group by lexicon, then sort by score
sort = configM.searchfield(mode, 'sort_by')
else:
sort = settings['sort']
start = settings['start'] if 'start' in settings\
else settings['page'] * settings['size']
query = unquote(query)
elasticq = parser.parse(query)
return elasticq + dumps({
'sort': sort,
'_from': start,
'size': settings['size'],
'version': 'true'
})
except Exception as e: # catch *all* exceptions
# TODO only catch relevant exceptions
logging.exception(e)
raise eh.KarpGeneralError(e, query)
def requestquery(page=0):
""" The Function for querying our database """
# page is assumed to be 0 indexed here
query = request.query_string
auth, permitted = validate_user(mode="read")
try:
# default values
default = {'size': 25, 'page': page, 'version': 'true'}
settings = parser.make_settings(permitted, default)
elasticq = parser.parse(query, settings)
except PErr.QueryError as e:
logging.exception(e)
raise eh.KarpQueryError('Parse error',
debug_msg=e.message,
query=query)
except PErr.AuthenticationError as e:
logging.exception(e)
msg = e.message
raise eh.KarpAuthenticationError(msg)
except eh.KarpException as e: # pass on karp exceptions
logging.exception(e)
raise
except Exception as e: # catch *all* exceptions
logging.exception(e)
raise eh.KarpQueryError("Could not parse data",
debug_msg=e,
query=query)
mode = settings['mode']
sort = sortorder(settings, mode, settings.get('query_command', ''))
start = settings['start'] if 'start' in settings\
else settings['page'] * settings['size']
# size = min(settings['size'], setupconf.max_page)
size = settings['size']
index, typ = configM.get_mode_index(mode)
exclude = configM.searchfield(mode, 'secret_fields') if not auth else []
ans = parser.adapt_query(
size, start, configM.elastic(mode=mode), loads(elasticq), {
'size': size,
'sort': sort,
'from_': start,
'index': index,
'_source_exclude': exclude,
'version': settings['version'],
'search_type': 'dfs_query_then_fetch'
})
if settings.get('highlight', False):
clean_highlight(ans)
if settings.get('format') or settings.get('export'):
formatmethod = 'format' if 'format' in settings else 'export'
toformat = settings.get(formatmethod)
msg = 'Unkown %s %s for mode %s' % (formatmethod, toformat, mode)
format_posts = configM.extra_src(mode, formatmethod,
helpers.notdefined(msg))
format_posts(ans, configM.elastic(mode=mode), mode, index, toformat)
return ans
def export(lexicon):
# TODO can user with only read permissions export all the lexicon?
# (eg saol)
auth, permitted = validate_user(mode="read")
if lexicon not in permitted:
raise eh.KarpAuthenticationError('You are not allowed to search the '
'lexicon %s' % lexicon)
settings = parser.make_settings(permitted, {
"size": -1,
"resource": lexicon
})
query = request.query_string
parsed = parser.parse_qs(query)
parser.parse_extra(parsed, settings)
date = settings.get('date', '')
mode = settings.get('mode', '')
if date:
from dateutil.parser import parserinfo, parse
from datetime import datetime
# parse the date as inclusive (including the whole selected day)
date = parse(date,
parserinfo(yearfirst=True),
default=datetime(1999, 01, 01, 23, 59))
to_keep = {}
engine, db_entry = db.get_engine(lexicon, echo=False)
logging.debug('exporting entries from %s ' % lexicon)
for entry in db.dbselect(lexicon,
engine=engine,
db_entry=db_entry,
max_hits=-1,
to_date=date):
_id = entry['id']
if _id in to_keep:
last = to_keep[_id]['date']
if last < entry['date']:
to_keep[_id] = entry
else:
to_keep[_id] = entry
ans = [
val['doc'] for val in to_keep.values() if val['status'] != 'removed'
]
ans = ans[:settings['size']]
logging.debug('exporting %s entries' % len(ans))
if settings.get('format', ''):
toformat = settings.get('format')
index, typ = configM.get_mode_index(mode)
msg = 'Unkown %s %s for mode %s' % ('format', toformat, mode)
format_posts = configM.extra_src(mode, 'exportformat',
helpers.notdefined(msg))
lmf, err = format_posts(ans, lexicon, mode, toformat)
return Response(lmf, mimetype='text/xml')
else:
return jsonify({lexicon: ans})
def querycount(page=0):
# TODO error if buckets is used here
# TODO validate_user is also done once in requestquery
# but since we need the permitted dict, it is called
# here as well
auth, permitted = validate_user(mode="read")
try:
# TODO buckets should be gathered from some config
default = {
"buckets": ['lexiconOrder', 'lexiconName'],
"size": configM.setupconfig['MAX_PAGE']
}
settings = parser.make_settings(permitted, default)
q_ans = requestquery(page=page)
# TODO does search_type=count work with the new es version?
# if not, use query_then_fetch, size=0
# raise the size for the statistics call
stat_size = configM.setupconfig['MAX_PAGE']
count_elasticq, more = parser.statistics(
request.query_string,
settings,
order={"lexiconOrder": ("_term", "asc")},
show_missing=False,
force_size=stat_size)
mode = settings['mode']
es = configM.elastic(mode=mode)
index, typ = configM.get_mode_index(mode)
count_ans = es.search(
index=index,
body=loads(count_elasticq),
search_type="count",
# raise the size for the statistics call
size=stat_size)
distribution = count_ans['aggregations']['q_statistics'][
'lexiconOrder']['buckets']
except eh.KarpException as e: # pass on karp exceptions
logging.exception(e)
raise
except (elasticsearch.RequestError, elasticsearch.TransportError) as e:
logging.exception(e)
raise eh.KarpElasticSearchError(
"ElasticSearch failure. Message: %s.\n" % e)
except Exception as e: # catch *all* exceptions
# Remember that 'buckets' is not allowed here! %s"
logging.exception(e)
raise eh.KarpQueryError("Could not parse data",
debug_msg=e,
query=request.query_string)
return jsonify({'query': q_ans, 'distribution': distribution})
def statlist():
# TODO add is_more here (as above)
""" Returns the counts and stats for the query """
auth, permitted = validate_user(mode="read")
try:
query = request.query_string
mode = parser.get_mode(query)
logging.debug('mode is %s' % mode)
default = {
"buckets": configM.searchfield(mode, 'statistics_buckets'),
"size": 100,
"cardinality": False
}
settings = parser.make_settings(permitted, default)
exclude = [] if auth else configM.searchfield(mode, 'secret_fields')
elasticq, more = parser.statistics(query,
settings,
exclude=exclude,
prefix='STAT_')
es = configM.elastic(mode=settings['mode'])
is_more = check_bucketsize(more, settings["size"], mode, es)
# TODO allow more than 100 000 hits here?
size = settings['size']
index, typ = configM.get_mode_index(settings['mode'])
ans = es.search(index=index,
body=loads(elasticq),
search_type="count",
size=size)
tables = []
for key, val in ans['aggregations']['q_statistics'].items():
if key.startswith('STAT_'):
tables.extend(generate_table(val, []))
# the length of tables might be longer than size, so truncate it
# generating shorter tables is not faster than generating all of it
# and then truncating
if size:
tables = tables[:size]
return jsonify({"stat_table": tables, "is_more": is_more})
except eh.KarpException as e: # pass on karp exceptions
logging.exception(e)
raise
except PErr.AuthenticationError as e:
logging.exception(e)
msg = e.message
raise eh.KarpAuthenticationError(msg)
except Exception as e: # catch *all* exceptions
# raise
logging.exception(e)
raise eh.KarpGeneralError("Unknown error", debug_msg=e, query=query)
def minientry():
""" Returns the counts and stats for the query """
max_page = configM.setupconfig['MINIENTRY_PAGE']
auth, permitted = validate_user(mode="read")
try:
query = request.query_string
mode = parser.get_mode(query)
default = {
'show': configM.searchfield(mode, 'minientry_fields'),
'size': 25
}
settings = parser.make_settings(permitted, default)
elasticq = parser.parse(query, settings)
show = settings['show']
if not auth:
# show = show - exclude
exclude = configM.searchfield(mode, 'secret_fields')
show = list(set(show).difference(exclude))
sort = sortorder(settings, mode, settings.get('query_command', ''))
start = settings['start'] if 'start' in settings else 0
es = configM.elastic(mode=settings['mode'])
index, typ = configM.get_mode_index(settings['mode'])
ans = parser.adapt_query(
settings['size'], start, es, loads(elasticq), {
'index': index,
'_source': show,
'from_': start,
'sort': sort,
'size': min(settings['size'], max_page),
'search_type': 'dfs_query_then_fetch'
})
if settings.get('highlight', False):
clean_highlight(ans)
return jsonify(ans)
except PErr.AuthenticationError as e:
logging.exception(e)
msg = e.message
raise eh.KarpAuthenticationError(msg)
except PErr.QueryError as e:
raise eh.KarpQueryError("Parse error, %s" % e.message,
debug_msg=e,
query=query)
except eh.KarpException as e: # pass on karp exceptions
logging.exception(e)
raise
except Exception as e: # catch *all* exceptions
logging.exception(e)
raise eh.KarpGeneralError("Unknown error", debug_msg=e, query=query)
def explain():
query = request.query_string
auth, permitted = validate_user(mode="read")
try:
# default
settings = parser.make_settings(permitted, {'size': 25, 'page': 0})
elasticq = parser.parse(query, settings)
except PErr.QueryError as e:
raise eh.KarpQueryError("Parse error", debug_msg=e, query=query)
es = configM.elastic(mode=settings['mode'])
index, typ = configM.get_mode_index(settings['mode'])
ex_ans = es.indices.validate_query(index=index,
body=loads(elasticq),
explain=True)
q_ans = requestquery(page=0)
return jsonify({
'elastic_json_query': loads(elasticq),
'ans': q_ans,
'explain': ex_ans
})
def random():
auth, permitted = validate_user(mode="read")
try:
query = request.query_string
mode = parser.get_mode(query)
default = {
"show": configM.searchfield(mode, 'minientry_fields'),
"size": 1
}
settings = parser.make_settings(permitted, default)
elasticq = parser.random(query, settings)
es = configM.elastic(mode=mode)
index, typ = configM.get_mode_index(mode)
es_q = {
'index': index,
'body': loads(elasticq),
'size': settings['size']
}
if settings['show']:
show = settings['show']
if not auth:
# show = show - exclude
exclude = configM.searchfield(mode, 'secret_fields')
show = list(set(show).difference(exclude))
es_q['_source'] = show
ans = es.search(**es_q)
return jsonify(ans)
except PErr.AuthenticationError as e:
logging.exception(e)
msg = e.message
raise eh.KarpAuthenticationError(msg)
except eh.KarpException as e: # pass on karp exceptions
logging.exception(e)
raise
except Exception as e: # catch *all* exceptions
logging.exception(e)
raise eh.KarpGeneralError("Unknown error", debug_msg=e, query=query)
def formatpost():
""" Formats the posted data into wanted format
The data should be a list
Currently only working for saol
"""
# get and parse data
request.get_data()
data = request.data
try:
data = loads(data)
except ValueError as e:
raise eh.KarpParsingError(str(e))
# set all allowed lexicons (to avoid authentication exception
auth, permitted = validate_user(mode="read")
# find the wanted format
settings = parser.make_settings(permitted, {'size': 25})
query = request.query_string
parsed = parser.parse_qs(query)
parser.parse_extra(parsed, settings)
to_format = settings.get('format', '')
mode = parser.get_mode(query)
logging.debug('mode "%s"' % mode)
index, typ = configM.get_mode_index(mode)
if to_format:
if type(data) != list:
data = [data]
errmsg = 'Unkown format %s for mode %s' % (settings['format'], mode)
format_list = configM.extra_src(mode, 'format_list',
helpers.notdefined(errmsg))
ok, html = format_list(data, configM.elastic(mode=mode),
settings['format'], index)
return jsonify({'all': len(data), 'ok': ok, 'data': html})
else:
raise eh.KarpQueryError('Unkown format %s' % to_format)
def statistics():
""" Returns the counts and stats for the query """
auth, permitted = validate_user(mode="read")
try:
query = request.query_string
mode = parser.get_mode(query)
default = {
"buckets": configM.searchfield(mode, 'statistics_buckets'),
"size": 100,
"cardinality": False
}
settings = parser.make_settings(permitted, default)
exclude = [] if auth else configM.searchfield(mode, 'secret_fields')
elasticq, more = parser.statistics(query, settings, exclude=exclude)
es = configM.elastic(mode=settings['mode'])
is_more = check_bucketsize(more, settings, mode, es)
index, typ = configM.get_mode_index(settings['mode'])
# TODO allow more than 100 000 hits here?
ans = es.search(index=index,
body=loads(elasticq),
search_type="count",
size=settings['size'])
ans["is_more"] = is_more
return jsonify(ans)
except PErr.AuthenticationError as e:
logging.exception(e)
msg = e.message
raise eh.KarpAuthenticationError(msg)
except eh.KarpException as e: # pass on karp exceptions
logging.exception(e)
raise
except Exception as e: # catch *all* exceptions
logging.exception(e)
raise eh.KarpGeneralError("Unknown error", debug_msg=e, query=query)
def get_context(lexicon):
""" Find and return the alphabetically (or similar, as specified for the
lexicon) context of a word/entry.
"""
auth, permitted = validate_user(mode="read")
if lexicon not in permitted:
raise eh.KarpAuthenticationError('You are not allowed to search the '
'lexicon %s' % lexicon)
# make default settings
settings = parser.make_settings(permitted, {
"size": 10,
"resource": lexicon
})
# parse querystring
query = request.query_string
parsed = parser.parse_qs(query)
# parse parameter settings
parser.parse_extra(parsed, settings)
# set searching configurations
mode = configM.get_lexicon_mode(lexicon)
settings['mode'] = mode
es = configM.elastic(mode=mode)
index, typ = configM.get_mode_index(mode)
# get the sort_by list (eg. ['baseform.sort', 'lemmaid.search'])
# leave out lexiconOrder and _score
sortfieldnames = [
field for field in configM.searchconf(mode, 'sort_by')
if field not in ['_score', 'lexiconOrder']
]
# get the sort field paths (eg. ['FormRep.baseform.raw', 'lemmaid.raw'])
# Used for sorting.
sortfield = sum([F.lookup_multiple(f, mode) for f in sortfieldnames], [])
# get the field name of the head sort field. Used for searching
sortfieldname = sortfieldnames[0]
# find the center entry (by its id)
if 'center' in settings:
center_id = settings['center']
lexstart = es.search(index=index,
doc_type=typ,
size=1,
body={"query": {
"term": {
"_id": center_id
}
}},
sort=['%s:asc' % f for f in sortfield])
# if no center id is given, pick the first entry of the lexicon
else:
exps = []
parser.parse_ext('and|resource|equals|%s' % lexicon, exps, [], mode)
center_q = parser.search(exps, [], [], usefilter=True)
lexstart = es.search(index=index,
doc_type=typ,
size=1,
body=center_q,
sort=['%s:asc' % f for f in sortfield])
center_id = lexstart['hits']['hits'][0]['_id']
# lexstart = es.search(index=index, doc_type=typ, size=1,
# sort=['%s:asc' % f for f in sortfield])
# center_id = lexstart['hits']['hits'][0]['_id']
if not lexstart['hits']['hits']:
logging.error('No center found %s, %s' % (center_id, lexstart))
raise eh.KarpElasticSearchError("Could not find entry %s" % center_id)
centerentry = lexstart['hits']['hits'][0]
logging.debug('center %s, %s' % (centerentry, centerentry['_id']))
origentry_sort = [key for key in centerentry['sort'] if key is not None][0]
# TODO what to do if the sort key is not in the lexicon? as below?
# origentry_sort = centerentry['sort'][0]
sortvalue = control_escape(origentry_sort)
sortvalue = control_escape(origentry_sort)
logging.debug(u'Orig entry escaped key %s' % sortvalue)
# Construct queries to es
exps = []
querystring = settings.get('q', '').decode(
'utf8') # the query string from the user
parser.parse_ext('and|resource|equals|%s' % lexicon, exps, [], mode)
if querystring:
if querystring.startswith('simple'):
querystring = 'and|anything|equals|%s' % querystring.split('|')[-1]
else:
querystring = re.sub('extended\|\|', '', querystring)
parser.parse_ext(querystring, exps, [], mode)
preexps = copy.deepcopy(exps) # deep copy for the pre-query
parser.parse_ext('and|%s|gte|%s' % (sortfieldname, sortvalue), exps, [],
mode)
elasticq_post = parser.search(exps, [], [], usefilter=True)
parser.parse_ext('and|%s|lte|%s' % (sortfieldname, sortvalue), preexps, [],
mode)
elasticq_pre = parser.search(preexps, [], [], usefilter=True)
# +1 to compensate for the word itself being in the context
size = settings['size'] + 1
show = configM.searchfield(mode, 'minientry_fields')
# TODO size*3 (magic number) because many entries may have the same sort
# value (eg homographs in saol)
ans_pre = parser.adapt_query(
size * 3, 0, es, elasticq_pre, {
'size': size * 3,
'from_': 0,
'sort': ['%s:desc' % f for f in sortfield],
'index': index,
'_source': show,
'search_type': 'dfs_query_then_fetch'
})
ans_post = parser.adapt_query(
size * 3, 0, es, elasticq_post, {
'size': size * 3,
'from_': 0,
'sort': ['%s:asc' % f for f in sortfield],
'index': index,
'_source': show,
'search_type': 'dfs_query_then_fetch'
})
hits_pre = ans_pre.get('hits', {}).get('hits', [])
hits_post = ans_post.get('hits', {}).get('hits', [])
hits_pre = go_to_sortkey(hits_pre, origentry_sort, center_id)
hits_post = go_to_sortkey(hits_post, origentry_sort, center_id)
return jsonify({
"pre": hits_pre[:settings['size']],
"post": hits_post[:settings['size']],
"center": centerentry
})
def autocomplete():
""" Returns lemgrams matching the query text.
Each mode specifies in the configs which fields that should be
considered.
The parameter 'q' or 'query' is used when only one word form is to be
processed.
The parameter 'multi' is used when multiple word forms should be
processed.
The format of result depends on which flag that is set.
"""
auth, permitted = validate_user(mode="read")
query = request.query_string
try:
settings = parser.make_settings(permitted, {'size': 1000})
parsed = parser.parse_qs(query)
mode = parser.get_mode(query)
p_extra = parser.parse_extra(parsed, settings)
qs = parsed.get('q', []) or parsed.get('query', [])
multi = False
if not qs:
# check if there are multiple words forms to complete
qs = settings.get('multi', [])
logging.debug('qs %s' % qs)
multi = True
# use utf8, escape '"'
qs = [re.sub('"', '\\"', q.decode('utf8')) for q in qs]
headboost = configM.searchfield(mode, 'boosts')[0]
res = {}
ans = {}
# if multi is not true, only one iteration of this loop will be done
for q in qs:
boost = '''"functions": [{"boost_factor" : "500",
"filter":{"term":{"%s":"%s"}}}]''' % (headboost, q)
autocompleteq = configM.extra_src(mode, 'autocomplete',
autocompletequery)
exp = autocompleteq(mode, boost, q)
autocomplete_field = configM.searchonefield(
mode, 'autocomplete_field')
fields = ['"exists": {"field" : "%s"}' % autocomplete_field]
# last argument is the 'fields' used for highlightning
# TODO use filter?
elasticq = parser.search([exp] + p_extra,
fields,
'',
usefilter=True)
es = configM.elastic(mode=mode)
logging.debug('_source: %s' % autocomplete_field)
logging.debug(elasticq)
index, typ = configM.get_mode_index(mode)
ans = parser.adapt_query(
settings['size'], 0, es, loads(elasticq), {
'size': settings['size'],
'index': index,
'_source': autocomplete_field
})
# save the results for multi
res[q] = ans
if multi:
return jsonify(res)
else:
# single querys: only return the latest answer
return jsonify(ans)
except PErr.AuthenticationError as e:
logging.exception(e)
msg = e.message
raise eh.KarpAuthenticationError(msg)
except eh.KarpException as e: # pass on karp exceptions
logging.exception(e)
raise
except Exception as e: # catch *all* exceptions
logging.exception(e)
raise eh.KarpGeneralError("Unknown error", debug_msg=e, query=query)