allow preset filters and related schemas for cloud

This refactors the cloud aggregation to make use of the
SearchSQLBuilder, this in turn allows for reusing much but not all of
the default parameter handling.

By allowing joins (on pid) and setting filters we can output clouds
based on the same data as a shown aggregation.

Author: splitbrain

lang/en/lang.php

@@ -81,7 +81,6 @@
 $lang['Exception no sqlite']   = 'The struct plugin requires the sqlite plugin. Please install and enable it.';
 $lang['Exception column not in table'] = 'There is no column %s in schema %s.';
 $lang['Exception datefilter']  = 'The filter: \'<code>$Date(%s)$</code>\' contains an unsupported value.';
-$lang['Warning: no filters for cloud'] = 'Filters are not supported for struct clouds.';
 $lang['sort']                  = 'Sort by this column';
 $lang['next']                  = 'Next page';
 $lang['prev']                  = 'Previous page';

meta/SearchCloud.php

@@ -14,48 +14,40 @@ class SearchCloud extends SearchConfig
     protected $limit = '';
 
     /**
-     * Transform the set search parameters into a statement
+     * We do not have pagination in clouds, so we can work with a limit within SQL
      *
-     * @return array ($sql, $opts) The SQL and parameters to execute
+     * @param int $limit
      */
-    public function getSQL()
+    public function setLimit($limit)
     {
-        if (!$this->columns) throw new StructException('nocolname');
-
-        $QB = new QueryBuilder();
-        reset($this->schemas);
-        $schema = current($this->schemas);
-        $datatable = 'data_' . $schema->getTable();
-
-        $QB->addTable($datatable);
-
-        // add conditional page clauses if pid has a value
-        $subAnd = $QB->filters()->whereSubAnd();
-        $subAnd->whereAnd("$datatable.pid = ''");
-
-        $subOr = $subAnd->whereSubOr();
-        $subOr->whereAnd("GETACCESSLEVEL($datatable.pid) > 0");
-        $subOr->whereAnd("PAGEEXISTS($datatable.pid) = 1");
-        $subOr->whereSubOr()
-            ->whereAnd('ASSIGNED == 1')
-            ->whereSubOr()
-                ->whereAnd("$datatable.rid > 0")
-                ->whereAnd("ASSIGNED IS NULL");
-
-        // add conditional schema assignment check
-        $QB->addLeftJoin(
-            $datatable,
-            'schema_assignments',
-            '',
-            "$datatable.pid != ''
-                    AND $datatable.pid = schema_assignments.pid
-                    AND schema_assignments.tbl = '{$schema->getTable()}'"
-        );
-
-        $QB->filters()->whereAnd("$datatable.latest = 1");
-        $QB->filters()->where('AND', 'tag IS NOT \'\'');
+        $this->limit = " LIMIT $limit";
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function runSQLBuilder()
+    {
+        $sqlBuilder = new SearchSQLBuilder();
+        $sqlBuilder->setSelectLatest($this->selectLatest);
+        $sqlBuilder->addSchemas($this->schemas, false);
+        $this->addTagSelector($sqlBuilder);
+        $sqlBuilder->getQueryBuilder()->addGroupByStatement('tag');
+        $sqlBuilder->getQueryBuilder()->addOrderBy('count DESC');
+        $sqlBuilder->addFilters($this->filter);
+        return $sqlBuilder;
+    }
+
+    /**
+     * Add the tag selector to the SQLBuilder
+     */
+    protected function addTagSelector(SearchSQLBuilder $builder)
+    {
+        $QB = $builder->getQueryBuilder();
 
         $col = $this->columns[0];
+        $datatable = "data_{$col->getTable()}";
+
         if ($col->isMulti()) {
             $multitable = "multi_{$col->getTable()}";
             $MN = $QB->generateTableAlias('M');
@@ -77,23 +69,8 @@ public function getSQL()
             $colname = $datatable . '.' . $col->getColName();
         }
         $QB->addSelectStatement("COUNT($colname)", 'count');
-        $QB->addSelectColumn('schema_assignments', 'assigned', 'ASSIGNED');
-        $QB->addGroupByStatement('tag');
-        $QB->addOrderBy('count DESC');
-
-        [$sql, $opts] = $QB->getSQL();
-        return [$sql . $this->limit, $opts];
     }
 
-    /**
-     * We do not have pagination in clouds, so we can work with a limit within SQL
-     *
-     * @param int $limit
-     */
-    public function setLimit($limit)
-    {
-        $this->limit = " LIMIT $limit";
-    }
 
     /**
      * Execute this search and return the result

meta/SearchSQLBuilder.php

@@ -27,8 +27,9 @@ public function __construct()
      * Add the schemas to the query
      *
      * @param Schema[] $schemas Schema names to query
+     * @param bool $selectMeta Select meta columns (pid, rid, rev, assigned)
      */
-    public function addSchemas($schemas)
+    public function addSchemas($schemas, $selectMeta = true)
     {
         // basic tables
         $first_table = '';
@@ -60,12 +61,14 @@ public function addSchemas($schemas)
                     AND schema_assignments.tbl = '{$schema->getTable()}'"
                 );
 
-                $this->qb->addSelectColumn($datatable, 'rid');
-                $this->qb->addSelectColumn($datatable, 'pid', 'PID');
-                $this->qb->addSelectColumn($datatable, 'rev');
-                $this->qb->addSelectColumn('schema_assignments', 'assigned', 'ASSIGNED');
-                $this->qb->addGroupByColumn($datatable, 'pid');
-                $this->qb->addGroupByColumn($datatable, 'rid');
+                if ($selectMeta) {
+                    $this->qb->addSelectColumn($datatable, 'rid');
+                    $this->qb->addSelectColumn($datatable, 'pid', 'PID');
+                    $this->qb->addSelectColumn($datatable, 'rev');
+                    $this->qb->addSelectColumn('schema_assignments', 'assigned', 'ASSIGNED');
+                    $this->qb->addGroupByColumn($datatable, 'pid');
+                    $this->qb->addGroupByColumn($datatable, 'rid');
+                }
 
                 $first_table = $datatable;
             }

syntax/cloud.php

@@ -88,9 +88,6 @@ public function render($mode, Doku_Renderer $renderer, $data)
     {
         if ($mode != 'xhtml') return false;
         if (!$data) return false;
-        if (!empty($data['filter'])) {
-            msg($this->getLang('Warning: no filters for cloud'), -1);
-        }
         global $INFO, $conf;
         try {
             $search = new SearchCloud($data);