Semantic search storage and routing

backend/items/admin.py

@@ -1,3 +1,19 @@
 from django.contrib import admin
 
-# Register your models here.
+from .models import SemanticQuery
+
+
+@admin.register(SemanticQuery)
+class SemanticQueryAdmin(admin.ModelAdmin):
+    date_hierarchy = 'created'
+    fields = ('label', 'creator', 'created', 'query')
+    readonly_fields = ('created', 'query')
+    autocomplete_fields = ('creator',)
+    search_fields = ('label',)
+    list_display = ('id', 'label', 'creator', 'created')
+    list_display_links = ('id', 'label')
+    list_filter = ('created', 'creator')
+    show_full_result_count = False
+
+    def view_on_site(self, obj):
+        return '/explore/query/{}'.format(obj.id)

backend/items/migrations/0004_semanticquery.py

@@ -0,0 +1,22 @@
+# Generated by Django 2.0.13 on 2021-07-01 15:41
+
+import django.contrib.postgres.fields.jsonb
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('items', '0003_init_permissions'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='SemanticQuery',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('label', models.CharField(blank=True, max_length=100)),
+                ('query', django.contrib.postgres.fields.jsonb.JSONField()),
+            ],
+        ),
+    ]

backend/items/migrations/0005_auto_20210708_1249.py

@@ -0,0 +1,28 @@
+# Generated by Django 2.0.13 on 2021-07-08 10:49
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('items', '0004_semanticquery'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='semanticquery',
+            name='created',
+            field=models.DateTimeField(auto_now_add=True, default=django.utils.timezone.now),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name='semanticquery',
+            name='creator',
+            field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL),
+        ),
+    ]

backend/items/models.py

@@ -1,3 +1,7 @@
+from django.db import models
+from django.contrib.postgres.fields import JSONField
+from django.conf import settings
+
 from rdf.baseclasses import BaseCounter
 from .constants import ITEMS_NS, ITEMS_HISTORY_NS
 
@@ -8,3 +12,15 @@ class ItemCounter(BaseCounter):
 
 class EditCounter(BaseCounter):
     namespace = ITEMS_HISTORY_NS
+
+
+class SemanticQuery(models.Model):
+    label = models.CharField(blank=True, max_length=100)
+    query = JSONField()
+    creator = models.ForeignKey(
+        settings.AUTH_USER_MODEL, null=True, on_delete=models.SET_NULL,
+    )
+    created = models.DateTimeField(auto_now_add=True)
+
+    def __str__(self):
+        return self.label or str(self.id)

backend/items/serializers.py

@@ -0,0 +1,20 @@
+from rest_framework import serializers
+
+from .models import SemanticQuery
+
+
+class SemanticQuerySerializerFull(serializers.ModelSerializer):
+    class Meta:
+        model = SemanticQuery
+        fields = ['id', 'label', 'query']
+
+
+class SemanticQuerySerializer(serializers.ModelSerializer):
+    class Meta(SemanticQuerySerializerFull.Meta):
+        extra_kwargs = {
+            'query': {'write_only': True}
+        }
+
+    def create(self, validated_data):
+        validated_data['creator'] = self.context['request'].user
+        return super().create(validated_data)

backend/items/views.py

@@ -4,11 +4,13 @@
 
 from django.http import FileResponse, HttpResponse
 
-from rest_framework.decorators import action, api_view, renderer_classes 
+from rest_framework.decorators import action, api_view, renderer_classes
 from rest_framework.permissions import IsAuthenticatedOrReadOnly
 from rest_framework.response import Response
 from rest_framework.status import *
 from rest_framework.exceptions import ValidationError, NotFound, PermissionDenied
+from rest_framework.viewsets import GenericViewSet
+from rest_framework.mixins import CreateModelMixin, ListModelMixin, RetrieveModelMixin
 
 from rdflib import Graph, URIRef, BNode, Literal
 from rdflib.query import ResultException
@@ -24,8 +26,9 @@
 from sources import namespace as source
 from . import namespace as my
 from .graph import graph, history
-from .models import ItemCounter, EditCounter
+from .models import ItemCounter, EditCounter, SemanticQuery
 from .permissions import *
+from .serializers import SemanticQuerySerializer, SemanticQuerySerializerFull
 
 MUST_SINGLE_BLANK_400 = 'POST requires exactly one subject which must be a blank node.'
 MUST_EQUAL_IDENTIFIER_400 = 'PUT must affect exactly the resource URI.'
@@ -267,7 +270,7 @@ class ItemSuggestion(RDFView):
     def graph(self):
         return graph()
 
-    def get_graph(self, request, **kwargs):  
+    def get_graph(self, request, **kwargs):
         items = self.graph()
         if not request.user.has_perm('rdflib_django.view_all_annotations'):
             user, now = submission_info(request)
@@ -287,7 +290,7 @@ class ItemsOfCategory(RDFView):
     def graph(self):
         return graph()
 
-    def get_graph(self, request, category, **kwargs):  
+    def get_graph(self, request, category, **kwargs):
         items = self.graph()
         bindings = {'category': ontology[category]}
         if not request.user.has_perm('rdflib_django.view_all_annotations'):
@@ -304,3 +307,23 @@ def get_graph(self, request, category, **kwargs):
                     break
                 [user_items.add(triple) for triple in items.triples((s, None, None))]
         return user_items
+
+
+class SemanticQueryViewSet(
+    CreateModelMixin, ListModelMixin, RetrieveModelMixin,
+    GenericViewSet,
+):
+    queryset = SemanticQuery.objects.all()
+
+    def get_queryset(self):
+        if self.action == 'list':
+            if self.request.user.is_anonymous:
+                return self.queryset.none()
+            return self.queryset.filter(creator=self.request.user)
+        return self.queryset
+
+    def get_serializer_class(self):
+        if self.action == 'retrieve':
+            return SemanticQuerySerializerFull
+        else:
+            return SemanticQuerySerializer

backend/readit/urls.py

@@ -25,13 +25,15 @@
 from nlp_ontology import NLP_ONTOLOGY_ROUTE
 from sources import SOURCES_ROUTE
 from items import ITEMS_ROUTE
+from items.views import SemanticQueryViewSet
 from sparql import SPARQL_ROUTE
 from .index import index, specRunner
 from .utils import decode_and_proxy
 from feedback.views import FeedbackViewSet
 
 api_router = routers.DefaultRouter()  # register viewsets with this router
 api_router.register(r'feedback', FeedbackViewSet, basename='feedback')
+api_router.register(r'query', SemanticQueryViewSet, basename='query')
 
 urlpatterns = [
     path('admin/', admin.site.urls),

frontend/src/aspects/exploration.ts

@@ -1,15 +1,15 @@
 import { partial, isString } from 'lodash';
 
-import channel from '../explorer/explorer-radio';
+import explorerChannel from '../explorer/explorer-radio';
 import * as act from '../explorer/route-actions';
+import SuggestionsPanel from '../panel-suggestions/suggestions-view';
+import semChannel from '../semantic-search/radio';
+import deparam from '../utilities/deparam';
 import router from '../global/exploration-router';
 import mainRouter from '../global/main-router';
 import explorer from '../global/explorer-view';
 import controller from '../global/explorer-controller';
 import welcomeView from '../global/welcome-view';
-import semanticSearchView from '../global/semantic-search';
-import SuggestionsPanel from '../panel-suggestions/suggestions-view';
-import deparam from '../utilities/deparam';
 
 const browserHistory = window.history;
 let suggestionsPanel: SuggestionsPanel;
@@ -30,6 +30,7 @@ function deepRoute(obtainAction, resetAction) {
 const sourceRoute = partial(deepRoute, act.getSource);
 const itemRoute = partial(deepRoute, act.getItem);
 const queryRoute = partial(deepRoute, deparam);
+const semRoute = partial(deepRoute, act.getQuery);
 function annoRoute(resetAction) {
     return (sourceSerial, itemSerial) => explorer.scrollOrAction(
         browserHistory.state,
@@ -58,9 +59,10 @@ router.on({
     'route:item:external:edit':     itemRoute(act.itemWithEditExternal),
     'route:item:annotations':       itemRoute(act.itemWithOccurrences),
     'route:search:results:sources': queryRoute(act.searchResultsSources),
+    'route:search:results:semantic': semRoute(act.searchResultsSemantic),
 });
 
-channel.on({
+explorerChannel.on({
     'sourceview:showAnnotations': controller.reopenSourceAnnotations,
     'sourceview:hideAnnotations': controller.unlistSourceAnnotations,
     'sourceview:textSelected': controller.selectText,
@@ -84,14 +86,17 @@ channel.on({
     'searchResultList:itemClicked': controller.openSearchResult,
     'searchResultList:itemClosed': controller.closeToRight,
 }, controller);
-channel.on('currentRoute', (route, panel) => {
+explorerChannel.on('currentRoute', (route, panel) => {
     router.navigate(route);
     // Amend the state that Backbone.history just pushed with the cid of the
     // panel.
     browserHistory.replaceState(panel.cid, document.title);
 });
 
-welcomeView.on({'search:start': controller.resetSourceListFromSearchResults}, controller);
-welcomeView.on({'suggestions:show': controller.showSuggestionsPanel}, controller);
+semChannel.on('presentQuery', welcomeView.presentSemanticQuery, welcomeView);
 
-semanticSearchView.on('search', controller.resetSemanticSearch, controller);
+welcomeView.on({
+    'search:textual': controller.resetSourceListFromSearchResults,
+    'search:semantic': controller.resetSemanticSearch,
+    'suggestions:show': controller.showSuggestionsPanel,
+}, controller);

frontend/src/aspects/navigation.ts

@@ -12,7 +12,6 @@ import explorationRouter from '../global/exploration-router';
 import userFsm from '../global/user-fsm';
 import explorerView from '../global/explorer-view';
 import notFoundView from '../global/notfound-view';
-import semanticSearchView from '../global/semantic-search';
 
 history.once('route notfound', () => {
     menuView.render().$el.appendTo('#header');
@@ -57,7 +56,6 @@ menuView.on('feedback', () => feedbackView.render().$el.appendTo('body'));
 
 feedbackView.on('close', () => feedbackView.$el.detach());
 
-welcomeView.on('search:start', () => userFsm.handle('explore'));
+welcomeView.on('search:textual', () => userFsm.handle('explore'));
+welcomeView.on('search:semantic', () => userFsm.handle('explore'));
 welcomeView.on('suggestions:show', () => userFsm.handle('explore'));
-
-semanticSearchView.on('search', () => userFsm.handle('explore'));

frontend/src/core/model.ts

@@ -59,8 +59,10 @@ export default class Model extends BackboneModel {
 extend(Model.prototype, {
     sync: syncWithCSRF,
     url: function() {
+        const superUrl = BackboneModel.prototype.url.apply(this);
+        if (this.isNew()) return superUrl;
         // Django requires the trailing slash, so add it.
-        return BackboneModel.prototype.url.apply(this) + '/';
+        return superUrl + '/';
     },
 });
 

frontend/src/explorer/explorer-event-controller.ts

@@ -32,6 +32,7 @@ import {
     isOntologyClass,
 } from '../utilities/linked-data-utilities';
 import { itemsForSourceQuery } from '../sparql/compile-query';
+import SemanticQuery from '../semantic-search/model';
 import modelToQuery from '../semantic-search/modelToQuery';
 
 interface ExplorerEventController extends Events { }
@@ -87,12 +88,16 @@ class ExplorerEventController {
         this.explorerView.reset(sourceListPanel);
     }
 
-    resetSemanticSearch(model: Model): SearchResultListView {
-        const query = modelToQuery(model);
+    resetSemanticSearch(model: SemanticQuery): SearchResultListView {
         const items = new ItemGraph();
-        items.sparqlQuery(query);
+        model.when(
+            'query',
+            (model, query) => items.sparqlQuery(modelToQuery(query))
+        );
+        if (model.isNew()) model.save();
         const collection = new FlatItemCollection(items);
         const resultsView = new SearchResultListView({
+            model,
             collection,
             selectable: false,
         });

frontend/src/explorer/route-actions.ts

@@ -4,6 +4,8 @@ import { Namespace } from '../common-rdf/vocabulary';
 import ldChannel from '../common-rdf/radio';
 import Node from '../common-rdf/node';
 import FlatItem from '../common-adapters/flat-item-model';
+import semChannel from '../semantic-search/radio';
+import SemanticQuery from '../semantic-search/model';
 
 import Controller from './explorer-event-controller';
 
@@ -16,6 +18,12 @@ function obtainer<T extends readonly string[]>(namespace: Namespace<T>) {
 export const getSource = obtainer(source);
 export const getItem = obtainer(itemNs);
 
+export function getQuery(serial: string) {
+    const model = semChannel.request('userQueries').add({ id: serial });
+    model.fetch();
+    return model;
+}
+
 export function sourceWithoutAnnotations(control: Controller, node: Node) {
     return control.resetSource(node, false);
 }
@@ -69,3 +77,9 @@ export function itemWithOccurrences(control: Controller, node: Node) {
 export function searchResultsSources(control: Controller, queryParams: any) {
     return control.resetSourceListFromSearchResults(queryParams);
 }
+
+export
+function searchResultsSemantic(control: Controller, model: SemanticQuery) {
+    model.when('query', () => semChannel.trigger('presentQuery', model));
+    control.resetSemanticSearch(model);
+}

frontend/src/explorer/route-patterns.ts

@@ -11,5 +11,5 @@ export default {
     'item:external:edit':     'explore/item/:serial/external/edit',
     'item:annotations':       'explore/item/:serial/annotations',
     'search:results:sources': 'explore/sources?*queryParams',
-    'search:results:semantic': 'explore/query',
+    'search:results:semantic': 'explore/query/:serial',
 };

frontend/src/explorer/utilities-test.ts

@@ -27,6 +27,12 @@ describe('explorer utilities', function() {
             expectRoute.call(this, handler, 'explore/item/20');
         });
 
+        it('permits plain serial numbers', function() {
+            this.mockPanel.model.id = 20;
+            const handler = announceRoute('item', ['model', 'id']);
+            expectRoute.call(this, handler, 'explore/item/20');
+        });
+
         it('permits plain routes', function() {
             const handler = announceRoute('explore');
             expectRoute.call(this, handler, 'explore');

frontend/src/explorer/utilities.ts

@@ -22,7 +22,8 @@ export function announceRoute(route: string, path?: string[]) {
      * @fires Events#currentRoute
      */
     return function(): void {
-        const serial = getLabelFromId(get(this, path, ''));
+        const pathResult = get(this, path, '');
+        const serial = getLabelFromId(pathResult) || pathResult;
         const route = pattern.replace(':serial', serial);
 
         /**