[bugfix] prevent auto complete search outside the given context

BCDH · Nov 22, 2023 · a2344d7 · a2344d7
1 parent 217bb3a
commit a2344d7
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 6 deletions.
diff --git a/src/main/java/org/humanistika/oxygen/tei/completer/GUI/newSuggestionForm.java b/src/main/java/org/humanistika/oxygen/tei/completer/GUI/newSuggestionForm.java
@@ -19,10 +19,12 @@
  */
 package org.humanistika.oxygen.tei.completer.GUI;
 
+import com.evolvedbinary.xpath.parser.ast.Expr;
 import org.humanistika.oxygen.tei.completer.SuggestedAutocomplete;
 import org.humanistika.oxygen.tei.completer.TeiCompleter;
 import org.humanistika.oxygen.tei.completer.configuration.beans.AutoComplete;
 import ro.sync.contentcompletion.xml.CIValue;
+import ro.sync.contentcompletion.xml.WhatPossibleValuesHasAttributeContext;
 
 import javax.annotation.Nullable;
 import javax.swing.*;
@@ -34,24 +36,29 @@
 import java.util.List;
 import java.util.concurrent.atomic.AtomicBoolean;
 
+import static org.humanistika.oxygen.tei.completer.XPathUtil.isSubset;
+import static org.humanistika.oxygen.tei.completer.XPathUtil.parseXPath;
+
 /**
  *
  * @author younes
  */
 public class newSuggestionForm extends javax.swing.JDialog {
     private TeiCompleter teiCompleter;
     private TeiCompleter.AutoCompleteContext autoCompleteContext;
+    private WhatPossibleValuesHasAttributeContext context;
     private SuggestedAutocomplete suggestedAutocomplete = null;
 
     private ArrayList<SuggestedAutocomplete> results = new ArrayList<>();
 
     /**
      * Creates new form JDialogForm
      */
-    public newSuggestionForm(java.awt.Frame parent, final TeiCompleter teiCompleter, final TeiCompleter.AutoCompleteContext autoCompleteContext) {
+    public newSuggestionForm(java.awt.Frame parent, final TeiCompleter teiCompleter, final TeiCompleter.AutoCompleteContext autoCompleteContext, final WhatPossibleValuesHasAttributeContext context) {
         super(parent, ModalityType.DOCUMENT_MODAL);
         this.teiCompleter = teiCompleter;
         this.autoCompleteContext = autoCompleteContext;
+        this.context = context;
         initComponents();
         customLabels();
     }
@@ -244,7 +251,21 @@ private void fetchjButtonActionPerformed(java.awt.event.ActionEvent evt) {//GEN-
         // get the auto complete suggestions based on the user input
         final List<CIValue> suggestions = new ArrayList<>();
 
+        final String elemXPath = context.computeContextXPathExpression();
+        final String attrXPath = elemXPath + "/@" + context.getAttributeName();
+        Expr attributeExpr;
+        try {
+            attributeExpr = parseXPath(attrXPath);
+        } catch (Exception e) {
+            return;
+        }
+
+
         for (final AutoComplete autoComplete : teiCompleter.getConfiguration().getAutoCompletes()) {
+            //check if attributeExpr addresses a subset of autoCompleteXPaths.attributeXPath
+            final TeiCompleter.AutoCompleteXPaths autoCompleteXPaths = teiCompleter.getXPaths(autoComplete);
+            if (!isSubset(attributeExpr, autoCompleteXPaths.getAttributeXPath())) continue;
+
             suggestions.addAll(teiCompleter.requestAutoComplete(autoComplete, selection, dependent));
         }
 
@@ -391,7 +412,21 @@ protected Object doInBackground() throws Exception {
             // get the auto complete suggestions based on the user input
             final List<CIValue> suggestions = new ArrayList<>();
 
+            final String elemXPath = context.computeContextXPathExpression();
+            final String attrXPath = elemXPath + "/@" + context.getAttributeName();
+            Expr attributeExpr;
+            try {
+                attributeExpr = parseXPath(attrXPath);
+            } catch (Exception e) {
+                throw new Exception(e);
+            }
+
+
             for (final AutoComplete autoComplete : teiCompleter.getConfiguration().getAutoCompletes()) {
+                //check if attributeExpr addresses a subset of autoCompleteXPaths.attributeXPath
+                final TeiCompleter.AutoCompleteXPaths autoCompleteXPaths = teiCompleter.getXPaths(autoComplete);
+                if (!isSubset(attributeExpr, autoCompleteXPaths.getAttributeXPath())) continue;
+
                 suggestions.addAll(teiCompleter.requestAutoComplete(autoComplete, selection, dependent));
             }
 

diff --git a/src/main/java/org/humanistika/oxygen/tei/completer/TeiCompleter.java b/src/main/java/org/humanistika/oxygen/tei/completer/TeiCompleter.java
@@ -103,7 +103,7 @@ public List<CIValue> filterAttributeValues(final List<CIValue> list, final WhatP
 
             if(autoCompleteSuggestions != null) {
                 // the value needs to be prefixed with a space character to bump it to the top of the list
-                list.add(new CustomCIValue("\uD83D\uDC49 Custom lookup...", this, autoCompleteSuggestions.autoCompleteContext));
+                list.add(new CustomCIValue("\uD83D\uDC49 Custom lookup...", this, autoCompleteSuggestions.autoCompleteContext, context));
             }
 
         }
@@ -235,7 +235,7 @@ private AuthenticationType asClientFactoryAuthenticationType(@Nullable final Aut
         }
     }
 
-    protected class AutoCompleteXPaths {
+    public class AutoCompleteXPaths {
         private final Expr attributeXPath;
 
         public AutoCompleteXPaths(final Expr attributeXPath) {
@@ -247,7 +247,7 @@ public Expr getAttributeXPath() {
         }
     }
 
-    protected AutoCompleteXPaths getXPaths(final AutoComplete autoComplete) {
+    public AutoCompleteXPaths getXPaths(final AutoComplete autoComplete) {
         synchronized(cachedAutoCompleteXPaths) {
             AutoCompleteXPaths autoCompleteXPaths = cachedAutoCompleteXPaths.get(autoComplete);
             if(autoCompleteXPaths == null) {
@@ -414,11 +414,14 @@ public List<CIValue> filterElementValues(final List<CIValue> list, final Context
     public class CustomCIValue extends CIValue {
         private TeiCompleter teiCompleter;
         private AutoCompleteContext autoCompleteContext;
+
+        private WhatPossibleValuesHasAttributeContext context;
         private String suggestion;
-        public CustomCIValue(String s, final TeiCompleter teiCompleter, final AutoCompleteContext autoCompleteContext) {
+        public CustomCIValue(String s, final TeiCompleter teiCompleter, final AutoCompleteContext autoCompleteContext, final WhatPossibleValuesHasAttributeContext context) {
             super(s);
             this.teiCompleter = teiCompleter;
             this.autoCompleteContext = autoCompleteContext;
+            this.context = context;
         }
 
         @Override
@@ -436,7 +439,7 @@ private SuggestedAutocomplete promptUserForNewSuggestion() {
             final KeyboardFocusManager keyboardFocusManager = KeyboardFocusManager.getCurrentKeyboardFocusManager();
             final Component comp = keyboardFocusManager.getFocusOwner();
             final Frame parentFrame = getParentFrame(comp);
-            final newSuggestionForm newSuggestionForm = new newSuggestionForm(parentFrame, teiCompleter, autoCompleteContext);
+            final newSuggestionForm newSuggestionForm = new newSuggestionForm(parentFrame, teiCompleter, autoCompleteContext, context);