Changeset 7895

Timestamp:

Jan 18, 2021, 11:46:25 AM (2 years ago)

Author:

Nicklas Nordborg

Message:

References #2237: Implement extension mechanism for query filtering

Started to work on this. A new action interface QueryFilterAction should be implemented by extensions.

This will probably take effect now for all list pages and item list filters, etc. However, To be really useful for list pages, an extension probably want to pass information also to a related ListColumnAction. For example, the filter implementation will find a list of item ID:s that are used in the query and the column implementation will use cached information to display matched values in the correspoding column.

For this to work, the list pages need to call the new getConfiguredQuery() that also takes a ClientContext parameter. We can probably use the JspContext that is already created in all list pages if we re-order some things in the code.

Location:

trunk/src

Files:

• clients/web/net/sf/basedb/clients/web/Base.java (modified) (3 diffs)
• core/core-extensions.xml (modified) (1 diff)
• core/net/sf/basedb/core/ItemContext.java (modified) (10 diffs)
• core/net/sf/basedb/core/PropertyFilter.java (modified) (3 diffs)
• core/net/sf/basedb/core/query/QueryFilterAction.java (added)
• core/net/sf/basedb/util/extensions/ClientContext.java (modified) (2 diffs)

trunk/src/clients/web/net/sf/basedb/clients/web/Base.java

@@ -74 +74 @@
 import net.sf.basedb.util.ColorGenerator;
 import net.sf.basedb.util.Values;
+import net.sf.basedb.util.extensions.ClientContext;
 import net.sf.basedb.util.filter.Filter;
 import net.sf.basedb.util.filter.StaticFilter;
@@ -1014 +1015 @@
   
   /**
+    @deprecated In 3.18, use {@link #getConfiguredQuery(DbControl, ItemContext, ClientContext, boolean, ItemQuery, ModeInfo)} instead
+  */
+  @Deprecated
+  public static <T extends BasicItem> ItemQuery<T> getConfiguredQuery(DbControl dc, ItemContext cc, boolean autoLeftJoin, ItemQuery<T> query, ModeInfo mode)
+  {
+    return getConfiguredQuery(dc, cc, null, autoLeftJoin, query, mode);
+  }
+  
+  /**
     Configures a query. This method calls {@link ItemContext#configureQuery(DbControl, EntityQuery, boolean)}
     and then adds the following filter:
@@ -1029 +1039 @@
     @param mode Info about the mode the page has. 
     @return The same query, configured according to information in the current context
-    @since 2.8
-  */
-  public static <T extends BasicItem> ItemQuery<T> getConfiguredQuery(DbControl dc, ItemContext cc, boolean autoLeftJoin, ItemQuery<T> query, ModeInfo mode)
-  {
-    cc.configureQuery(dc, query, autoLeftJoin);
+    @since 3.18
+  */
+  public static <T extends BasicItem> ItemQuery<T> getConfiguredQuery(DbControl dc, ItemContext cc, ClientContext context, boolean autoLeftJoin, ItemQuery<T> query, ModeInfo mode)
+  {
+    cc.configureQuery(dc, query, context, autoLeftJoin);
     final String exclude = (String)cc.getObject("exclude");
     if (exclude != null)

trunk/src/core/core-extensions.xml

@@ -167 +167 @@
   </extension-point>
   
+  <extension-point 
+    id="net.sf.basedb.query.entity-query-filter">
+    <action-class>net.sf.basedb.core.query.QueryFilterAction</action-class>
+    <name>Query filters</name>
+    <description>
+      Extension point for implementing extra filter functionality for
+      queries generated by the ItemContext.configureQuery() method. 
+      If the call is initiated from the web client the client context is
+      a JspContext, otherwise it is a ClientContext instance. In both cases
+      the current item is the ItemContext instance. The ItemContext.getQuery()
+      method returns the query that was passed to the configureQuery() method.
+      Factory implementations are recommended to check ItemContext.hasExtensionFilter()
+      before returning actions, and QueryFilterAction implementations should check
+      PropertyFilter.isExtensionFilter().
+    </description>
+  </extension-point>
+  
   <extension 
     id="net.sf.basedb.core.uri.http-connection-manager"

trunk/src/core/net/sf/basedb/core/ItemContext.java

@@ -24 +24 @@
 
 import net.sf.basedb.core.query.Annotations;
+import net.sf.basedb.core.query.QueryFilterAction;
 import net.sf.basedb.core.query.EntityQuery;
 import net.sf.basedb.core.query.Expressions;
@@ -47 +48 @@
 import net.sf.basedb.util.encode.EncodeUtil;
 import net.sf.basedb.util.encode.TabCrLfEncoderDecoder;
+import net.sf.basedb.util.extensions.ClientContext;
+import net.sf.basedb.util.extensions.ExtensionsInvoker;
+import net.sf.basedb.util.extensions.manager.ExtensionsManager;
 import net.sf.basedb.util.filter.Filter;
 import net.sf.basedb.util.jep.Jep;
@@ -814 +818 @@
   
   /**
+    Checks if there is an extension filter with a property
+    starting with !x.prefix.
+    @param prefix The extension prefix to check, or null to check any extension
+    @since 3.18
+  */
+  public boolean hasExtensionFilter(String prefix)
+  {
+    if (propertyFilters == null) return false;
+    prefix = "!x." + (prefix == null ? "" : prefix);
+    for (PropertyFilterPair filterPair : propertyFilters.values())
+    {
+      if (filterPair.getEffectiveFilter().getProperty().startsWith(prefix)) return true;
+    }
+    return false;
+    
+  }
+  
+  /**
     Get the value of a property filter on row 0. 
     @see #getPropertyValue(String, int)
@@ -1519 +1541 @@
     Arrays.asList("£", "&", "!", "¤", "|", "/"));
   
+  public void configureQuery(DbControl dc, EntityQuery query, boolean autoLeftJoin)
+    throws BaseException
+  {
+    configureQuery(dc, query, null, autoLeftJoin);
+  }
+
   /**
     Use the settings in this context to configure a query. 
@@ -1543 +1571 @@
     @param dc The DbControl that will be used to execute the query
     @param query The query to configure
+    @param context Optional ClientContext for filter extensions (if null, a context is automatically created if needed)
     @param autoLeftJoin If true, and the sort property and filters are checked
       for associations to other items, which are automatically left joined to
@@ -1548 +1577 @@
       is experimental)
     @throws BaseException If configuring the query fails.
-    @since 2.8
-  */
-  public void configureQuery(DbControl dc, EntityQuery query, boolean autoLeftJoin)
+    @since 3.18
+  */
+  public void configureQuery(DbControl dc, EntityQuery query, ClientContext context, boolean autoLeftJoin)
     throws BaseException
   {
@@ -1679 +1708 @@
     if (permission != null) query.setItemPermission(permission);
     
+    // Initialise query filter extensions 
+    if (context == null) context = new ClientContext(dc);
+    context.setCurrentItem(this);
+    setQuery(query);
+    ExtensionsManager manager = Application.getExtensionsManager();
+    List<QueryFilterAction> xtFilter = new ArrayList<>();
+    ExtensionsInvoker<QueryFilterAction> invoker = manager.getRegistry().useExtensions(context, 
+      manager.getSettings(), "net.sf.basedb.query.entity-query-filter");
+    invoker.forEach(xtFilter::add);
+    
     // Add property filters
+    QueryRestrictions restrictions = new QueryRestrictions();   
     if (propertyFilters != null)
     {
-      Map<Integer, List<Restriction>> allRestrictions = new HashMap<Integer, List<Restriction>>();
-      Map<Integer, IdListRestriction> rowIdListRestriction = new HashMap<Integer, IdListRestriction>();
+      // 1. Filters per column/row
       for (PropertyFilterPair filterPair : propertyFilters.values())
       {
@@ -1689 +1728 @@
         if (propertyInspector == null || propertyInspector.evaluate(filter.getProperty()))
         {
+          int rowIndex = filter.getRowIndex();
+          RowRestrictions rowRestrictions = restrictions.getRow(rowIndex);
+          Restriction r = null;
           try
           {
-            Restriction r = filter.getRestriction(dc, query);
-            int rowIndex = filter.getRowIndex();
-            if (r instanceof IdListRestriction)
+            // Get restriction from extension
+            for (QueryFilterAction cfa : xtFilter)
             {
-              // Filters that result in a "IdListRestriction" are merged to a single id-list
-              // since that typically will result in a shorter list in the final SQL
-              IdListRestriction rowIdR = rowIdListRestriction.get(rowIndex);
-              if (rowIdR == null)
-              {
-                rowIdListRestriction.put(rowIndex, (IdListRestriction)r);
-              }
-              else
-              {
-                rowIdR.intersect((IdListRestriction)r);
-                r = null;
-              }
+              r = cfa.getColumnRestriction(filter);
+              if (r != null) break;
             }
-            if (r != null)
-            {
-              List<Restriction> rowRestrictions = allRestrictions.get(rowIndex);
-              if (rowRestrictions == null)
-              {
-                rowRestrictions = new ArrayList<Restriction>();
-                allRestrictions.put(rowIndex, rowRestrictions);
-              }
-              rowRestrictions.add(r);
-              // left join if filter property is association 
-              if (autoLeftJoin)
-              {
-                String filterProperty = filter.getProperty();
-                if (filterProperty != null && !NO_AUTO_JOIN_PREFIXES.contains(filterProperty.substring(0,  1)))
-                {
-                  if (filterProperty.startsWith("#") && filterProperty.contains("("))
-                  {
-                    int joinStart = filterProperty.indexOf('(');
-                    int joinEnd = filterProperty.indexOf(')');
-                    filterProperty = filterProperty.substring(joinStart+1, joinEnd)+".foobar"; // 'foobar' is removed in the actual join
-                  }
-                  
-                  int lastDotIndex = filterProperty.lastIndexOf('.');
-                  int firstDotIndex = filterProperty.indexOf('.');
-                  if (lastDotIndex >= 0)
-                  {
-                    filterProperty = filterProperty.substring(0, lastDotIndex);
-                    if (!filterProperty.startsWith("$") || lastDotIndex != firstDotIndex)
-                    {
-                      leftJoins.add(filterProperty);
-                    }
-                  }
-                }
-              }
-            }
+            
+            // Get default restriction
+            if (r == null) r = filter.getRestriction(dc, query);
           }
           catch (Throwable ex)
@@ -1750 +1749 @@
             setMessage(msg + ": " + ex.getMessage());
           }
+          
+          if (r != null) rowRestrictions.addRestriction(r);
+            
+          // left join if filter property is association 
+          if (autoLeftJoin && r != null)
+          {
+            String filterProperty = filter.getProperty();
+            if (filterProperty != null && !NO_AUTO_JOIN_PREFIXES.contains(filterProperty.substring(0,  1)))
+            {
+              if (filterProperty.startsWith("#") && filterProperty.contains("("))
+              {
+                int joinStart = filterProperty.indexOf('(');
+                int joinEnd = filterProperty.indexOf(')');
+                filterProperty = filterProperty.substring(joinStart+1, joinEnd)+".foobar"; // 'foobar' is removed in the actual join
+              }
+              
+              int lastDotIndex = filterProperty.lastIndexOf('.');
+              int firstDotIndex = filterProperty.indexOf('.');
+              if (lastDotIndex >= 0)
+              {
+                filterProperty = filterProperty.substring(0, lastDotIndex);
+                if (!filterProperty.startsWith("$") || lastDotIndex != firstDotIndex)
+                {
+                  leftJoins.add(filterProperty);
+                }
+              }
+            }
+          }
         }
       }
-      if (allRestrictions.size() > 0)
-      {
-        Restriction[] rows = new Restriction[allRestrictions.size()];
-        int rowNo = 0;
-        for (List<Restriction> rowRestrictions : allRestrictions.values())
+      
+      // 2. Let extensions create extra restrictions per row if they want to
+      for (RowRestrictions row : restrictions.rowRestrictions.values())
+      {
+        for (QueryFilterAction act : xtFilter)
         {
-          rows[rowNo] = Restrictions.nullSafeAnd(rowRestrictions);
-          rowNo++;
+          Restriction r = act.getRowRestriction(row.rowIndex);
+          if (r != null) row.addRestriction(r);
         }
-        query.restrict(Restrictions.or(rows));
-      }
+      }
+      
+      // 3. The final restriction from filters is added to the query
+      Restriction finalRestriction = restrictions.getRestriction();
+      if (finalRestriction != null) query.restrict(finalRestriction);
+    }
+
+    // 4. Let extensions create extra restrictions if they want to
+    for (QueryFilterAction act : xtFilter)
+    {
+      Restriction r = act.getQueryRestriction();
+      if (r != null) query.restrict(r);
     }
     
@@ -2288 +2325 @@
   }
   
+  
+  static class QueryRestrictions
+  {
+    Map<Integer, RowRestrictions> rowRestrictions = new HashMap<>();
+    
+    Restriction getRestriction()
+    {
+      List<Restriction> rows = new ArrayList<Restriction>(rowRestrictions.size());
+      for (RowRestrictions row : rowRestrictions.values())
+      {
+        rows.add(row.getRowRestriction());
+      }
+      return Restrictions.nullSafeOr(rows);
+    }
+    
+    RowRestrictions getRow(int rowIndex)
+    {
+      RowRestrictions row = rowRestrictions.get(rowIndex);
+      if (row == null)
+      {
+        row = new RowRestrictions(rowIndex);
+        rowRestrictions.put(rowIndex, row);
+      }
+      return row;
+    }
+  }
+  
+  
+  static class RowRestrictions
+  {
+    final int rowIndex;
+    
+    List<Restriction> restrictions = new ArrayList<>();
+    IdListRestriction rowIdList = null;
+    
+    public RowRestrictions(int rowIndex) 
+    {
+      this.rowIndex = rowIndex;
+    }
+    
+    Restriction getRowRestriction()
+    {
+      return Restrictions.nullSafeAnd(restrictions);
+    }
+    
+    void addRestriction(Restriction r)
+    {
+      if (r instanceof IdListRestriction)
+      {
+        if (rowIdList != null)
+        {
+          rowIdList.intersect((IdListRestriction)r);
+          r = null;
+        }
+        else
+        {
+          rowIdList = (IdListRestriction)r;
+        }
+      }
+      if (r != null) restrictions.add(r);
+    }
+  }
+  
 }

trunk/src/core/net/sf/basedb/core/PropertyFilter.java

@@ -240 +240 @@
   {
     return property;
+  }
+  
+  /**
+    Checks if this filter is an extension filter. An extension
+    filter has a {@link #getProperty()} that starts with
+    "!x.prefix".
+    @param prefix The extension prefix to check, or null to check any extension
+    @since 3.18
+  */
+  public boolean isExtensionFilter(String prefix)
+  {
+    return prefix == null ? property.startsWith("!x.") : property.startsWith("!x."+prefix);
   }
   
@@ -532 +544 @@
     Eg. &experiments(name). The filter is applied as a subquery.
     <p>
-    If the property starts with ! it is another special filter. There is currently 
-    one such filter (since BASE 2.15): !sharedTo.name, which is used to filter 
-    shareable items by the name of users/groups/projects it has been shared to. 
-    The 'name' part can be replaced with any other property that is common for 
-    users, groups and projects (eg. description or id). 
+    If the property starts with ! it is another special filter:
+    <ul>
+    <li>Since BASE 2.15: !sharedTo.name, which is used to filter 
+      shareable items by the name of users/groups/projects it has been shared to. 
+      The 'name' part can be replaced with any other property that is common for 
+      users, groups and projects (eg. description or id). 
+    <li>Since BASE 3.18: !x., which is intended to be handled by extensions. It
+      is ignored by the BASE core code. The rest of the property should be a unique
+      identifier for the extension that is handling the filter.
     <p>
     The property may also start with $@.
@@ -549 +565 @@
     String alias = null;
     Expression indexExpression = null;
+    
+    // Ignore -- expected to be handled by extensions
+    if (property != null && property.startsWith("!x.")) return null;
     
     if (property != null && property.startsWith("$"))

trunk/src/core/net/sf/basedb/util/extensions/ClientContext.java

@@ -160 +160 @@
     @return The current item, or null
   */
-  public Object getCurrentItem()
-  {
-    return item;
+  @SuppressWarnings("unchecked")
+  public <T> T getCurrentItem()
+  {
+    return (T)item;
   }
   
@@ -179 +180 @@
     @return The value, or null
   */
-  public Object getAttribute(String name)
-  {
-    return attributes == null ? null : attributes.get(name);
+  @SuppressWarnings("unchecked")
+  public <T> T getAttribute(String name)
+  {
+    return attributes == null ? null : (T)attributes.get(name);
   }