Support both API and ui term query.

* Move data pre- and post-processing to JS
* Use JSON for I/O
* Pass straight strings to SPARQL
* Improve descriptions

lakesuperior/api/query.py

@@ -73,20 +73,15 @@ def term_query(terms, or_logic=False):
     """
     qry_term_ls = []
     for i, term in enumerate(terms):
-        pred_uri, comp, val = term
-        if comp not in operands:
-            raise ValueError('Not a valid operand: {}'.format(comp))
+        if term['op'] not in operands:
+            raise ValueError('Not a valid operand: {}'.format(term['op']))
 
-        oname = '?o_{}'.format(i)
-        if comp == '_id':
-            qry_term = '?s {} {} .'.format(pred_uri.n3(), val)
+        if term['op'] == '_id':
+            qry_term = '?s {} {} .'.format(term['pred'], term['val'])
         else:
-            if type(val) == str:
-                filter_stmt = 'str({}) {} "{}"'.format(oname, comp, val)
-            else:
-                filter_stmt = '{} {} {}'.format(oname, comp, val.n3())
-            qry_term = '?s {} {}\nFILTER ({}) .'.format(
-                    oname, pred_uri.n3(), filter_stmt)
+            oname = '?o_{}'.format(i)
+            qry_term = '?s {0} {1}\nFILTER (str({1}) {2} "{3}") .'.format(
+                    term['pred'], oname, term['op'], term['val'])
 
         qry_term_ls.append(qry_term)
 

lakesuperior/endpoints/query.py

@@ -1,6 +1,8 @@
 import logging
 
-from flask import Blueprint, current_app, request, render_template, send_file
+from flask import (
+        Blueprint, current_app, jsonify, request, make_response,
+        render_template, send_file)
 from rdflib import URIRef
 from rdflib.plugin import PluginException
 
@@ -27,7 +29,6 @@ def term_search():
     Search by entering a search term and optional property and comparison term.
     """
     operands = (
-        ('_id', 'Has Type'),
         ('_id', 'Matches Term'),
         ('=', 'Is Equal To'),
         ('!=', 'Is Not Equal To'),
@@ -39,30 +40,17 @@ def term_search():
     qres = term_list = []
 
     if request.method == 'POST':
-        # Some magic needed to associate pseudo-array field notation with
-        # an actual dict. Flask does not fully support this syntax as Rails
-        # or other frameworks do: https://stackoverflow.com/q/24808660
-        fnames = ('pred_ns', 'pred', 'op', 'val')
-        term_list = [
-                request.form.getlist('{}[]'.format(tn))
-                for tn in fnames]
-        # Transpose matrix.
-        txm = list(zip(*term_list))
-        logger.info('transposed matrix: {}'.format(txm))
-        terms = []
-        for row in txm:
-            fmt_row = list(row)
-            ns = fmt_row.pop(0)
-            fmt_row[0] = nsc[ns][fmt_row[0]] if ns else URIRef(fmt_row[0])
-            terms.append(fmt_row)
+        terms = request.json.get('terms', {})
+        or_logic = request.json.get('logic', 'and') == 'or'
+        logger.info('Form: {}'.format(request.json))
         logger.info('Terms: {}'.format(terms))
-
-        or_logic = request.form.get('logic') == 'or'
+        logger.info('Logic: {}'.format(or_logic))
         qres = query_api.term_query(terms, or_logic)
 
-        def gl(uri):
-            return uri.replace(nsc['fcres'], '/ldp')
-        return render_template('term_search_results.html', qres=qres, gl=gl)
+        rsp = [
+            uri.replace(nsc['fcres'], request.host_url.rstrip('/') + '/ldp')
+            for uri in qres]
+        return jsonify(rsp), 200
     else:
         return render_template(
             'term_search.html', operands=operands, qres=qres, nsm=nsm)

lakesuperior/endpoints/templates/term_search.html

@@ -2,13 +2,30 @@
 {% block title %}Term Search{% endblock %}
 {% block content %}
     <p>Enter terms to query:</p>
-    <ul>
-        <li><strong>Logic:</strong> use "and" or "or" logic to concatenate multiple query criteria.</li>
-        <li><strong>Prefix:</strong> optionally select a namespace prefix from a list of pre-configured ones.</li>
-        <li><strong>Predicate:</strong> the fully qualified predicate URI if the prefix is empty, or the URI part following the namespace prefix (without the colon sign).</li>
-        <li><strong>Operand:</strong> Select an operand for the comparison. The "Matches Term" operand expects an RDF literal or URI, all others a string.</li>
-        <li><strong>Value:</strong> Value to compare against. If "Matches Term" is selected, an RDF URI literal as represented in SPARQL should be used, e.g. <pre>&lt;http://ex.org/ns/A&gt;</pre> or <pre>"title"^^xsd:string</pre>. For other operands, use a plain string without quotes.</li>
-    </ul>
+    <dl>
+        <dt>Logic</dt>
+        <dd>use "and" or "or" logic to concatenate multiple query criteria.</dd>
+        <dt>Predicate</dt>
+        <dd>a fully qualified or namespace-prefixed
+            predicate URI in SPARQL notation, e.g.
+            <code>&lt;http://www.w3.org/1999/02/22-rdf-syntax-ns#type&gt;</code>
+            or
+            <code>skos:prefLabel</code>.
+            For a full list of namespace prefixes supported by this system,
+            see the collapsable namespace reference at the bottom of this page.
+        </dd>
+        <dt>Operand</dt>
+        <dd> Select an operand for the comparison. The "Matches Term" operand
+            expects an RDF literal or URI, all others a string.</dd>
+        <dt>Value</dt>
+        <dd>Value to compare against. If "Matches Term" is selected, an RDF URI
+            or literal in SPARQL notation should be used, e.g.
+            <code>&lt;http://ex.org/ns/A&gt;</code>
+            or
+            <code>"title"^^xsd:string</code>.
+            For other operands, use a plain string without quotes.</dd>
+        </dd>
+    </dl>
     <form id="term-search-form" method="POST" action="">
         <div class="my-sm-3 mb-2">
             <label for="logic">Logic</label>
@@ -19,15 +36,6 @@
         </div>
         <div id="term-cont">
             <div class="term-block form-row">
-                <div class="form-group col-md-1">
-                    <label for="pred_ns[]">Prefix</label>
-                    <select class="form-control" name="pred_ns[]">
-                        <option selected value=""></option>
-                    {% for ns in nsm.namespaces() | sort %}
-                        <option value="{{ns[0]}}">{{ns[0]}}</option>
-                    {% endfor %}
-                    </select>
-                </div>
                 <div class="form-group col-md-4">
                     <label for="pred[]">Predicate</label>
                     <input type="text" class="form-control" name="pred[]">
@@ -40,7 +48,7 @@
                     {% endfor %}
                     </select>
                 </div>
-                <div class="form-group col-md-4">
+                <div class="form-group col-md-5">
                     <label for="val[]">Value</label>
                     <input type="text" class="form-control" name="val[]">
                 </div>
@@ -61,6 +69,20 @@
 {% endblock %}
 {% block tail_js %}
     <script>
+        function format_fields() {
+            var conds = [];
+            var terms = ['pred', 'op', 'val'];
+            for (term of terms) {
+                $(":input[name='" + term + "[]']").each(function(i) {
+                    if (typeof conds[i] == 'undefined') {
+                        conds[i] = {};
+                    }
+                    conds[i][term] = $(this).val();
+                });
+            }
+            return conds
+        }
+
         $(function(){
             $('.term-block').first().find('.delete-row').hide();
             $('#add-row').on('click', function(){
@@ -78,13 +100,24 @@
                 $.ajax({
                     type: 'POST',
                     url: '',
-                    data: $(this).serialize(),
+                    data: JSON.stringify({
+                        terms: format_fields(),
+                        logic: $('select[name="logic"]').val(),
+                    }),
+                    contentType: 'application/json; charset=utf-8',
+                    dataType: 'json',
                     encode: true
                 })
                     .done(function(data) {
                         //var cont = $('#search-results-wrap')
                         $('#search-results-wrap').removeClass('bg-danger')
-                            .html(data);
+                            .html('<h2>Search Results</h2>'
+                                + '<ul id="url-list"></ul>');
+                        for (url of data) {
+                            $('#url-list').append(
+                                '<li><a href="' + url + '">'
+                                + url + '</a></li>');
+                        }
                     })
                     .fail(function(data) {
                         $('#search-results-wrap').addClass('bg-danger')

lakesuperior/endpoints/templates/term_search_results.html

@@ -1,13 +0,0 @@
-<div id="search-results">
-{% if qres %}
-    <h2>Search Results</h2>
-    <ol>
-    {% for uri in qres %}
-        <li><a href="{{gl(uri)}}">{{uri}}</a></li>
-    {% else %}
-        <p class="bg-warning">No resources match the given criteria.</p>
-    {% endfor %}
-    </ol>
-{% endif %}
-</div>
-