Merge pull request #612 from cosmocode/publish

annda · web-flow · commit ff40ffd7c6b2 · 2022-09-27T12:12:54.000+02:00
Base for publish status via new structpublish plugin
diff --git a/_test/AccessTableDataReplacement.test.php b/_test/AccessTableDataReplacement.test.php
@@ -185,7 +185,10 @@ public function test_DataFiltersAsSubQuery($inputFilterLines, $expectedFilterWhe
                         AND (ASSIGNED = 1 OR ASSIGNED IS NULL)
                     )
                 )
-            AND data_bar.latest = 1";
+            AND (
+                (IS_PUBLISHER(data_bar.pid) AND data_bar.latest = 1)
+                OR (IS_PUBLISHER(data_bar.pid) IS FALSE AND data_bar.published = 1)
+            )";
 
         $expected_where = $baseWhere . $expectedFilterWhere . " )";
         $this->assertEquals($this->cleanWS($expected_where), $this->cleanWS($where), $msg);
diff --git a/_test/SchemaBuilder.test.php b/_test/SchemaBuilder.test.php
@@ -61,7 +61,8 @@ public function test_build_new()
                     pid TEXT DEFAULT '',
                     rid INTEGER,
                     rev INTEGER,
-                    latest BOOLEAN NOT NULL DEFAULT 0, col1 DEFAULT '', col2 DEFAULT '',
+                    latest BOOLEAN NOT NULL DEFAULT 0,
+                    published BOOLEAN DEFAULT NULL, col1 DEFAULT '', col2 DEFAULT '',
                     PRIMARY KEY(pid, rid, rev)
                 )";
 
diff --git a/_test/Search.test.php b/_test/Search.test.php
@@ -131,6 +131,22 @@ public function test_simple_title()
         $this->assertEquals(array('second data', 'more data', 'even more'), $result[0][2]->getValue());
     }
 
+    public function test_search_published()
+    {
+        $search = new mock\Search();
+        $search->isNotPublisher();
+
+        $search->addSchema('schema1');
+        $search->addColumn('%pageid%');
+        $search->addColumn('first');
+        $search->addColumn('second');
+
+        /** @var meta\Value[][] $result */
+        $result = $search->execute();
+
+        $this->assertEquals(0, count($result), 'result rows');
+    }
+
     public function test_search_lasteditor()
     {
         $search = new mock\Search();
diff --git a/_test/json/bureaucracy.struct.json b/_test/json/bureaucracy.struct.json
@@ -7,7 +7,8 @@
         "allowed editors": "",
         "label": {
             "en": ""
-        }
+        },
+        "internal": false
     },
     "columns": [
         {
diff --git a/_test/json/bureaucracy_lookup.struct.json b/_test/json/bureaucracy_lookup.struct.json
@@ -7,7 +7,8 @@
         "allowed editors": "",
         "label": {
             "en": ""
-        }
+        },
+        "internal": false
     },
     "columns": [
         {
diff --git a/_test/json/schema1.struct.json b/_test/json/schema1.struct.json
@@ -7,7 +7,8 @@
         "allowed editors": "",
         "label": {
             "en": ""
-        }
+        },
+        "internal": false
     },
     "columns": [
         {
diff --git a/_test/json/schema_3.struct.json b/_test/json/schema_3.struct.json
@@ -7,7 +7,8 @@
         "allowed editors": "",
         "label": {
             "en": ""
-        }
+        },
+        "internal": false
     },
     "columns": [
         {
diff --git a/_test/json/wikilookup.struct.json b/_test/json/wikilookup.struct.json
@@ -7,7 +7,8 @@
         "allowed editors": "",
         "label": {
             "en": ""
-        }
+        },
+        "internal": false
     },
     "columns": [
         {
@@ -81,4 +82,4 @@
             }
         }
     ]
-}
+}
diff --git a/_test/mock/Search.php b/_test/mock/Search.php
@@ -13,4 +13,13 @@ class Search extends meta\Search
     public $sortby = array();
 
     public $filter = array();
+
+    /**
+     * Register a dummy function that always returns false
+     */
+    public function isNotPublisher()
+    {
+        $this->dbHelper = new helper_plugin_struct_db;
+        $this->sqlite->create_function('IS_PUBLISHER', [$this->dbHelper, 'IS_PUBLISHER'], -1);
+    }
 }
diff --git a/_test/mock/helper_plugin_struct_db.php b/_test/mock/helper_plugin_struct_db.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace dokuwiki\plugin\struct\test\mock;
+
+class helper_plugin_struct_db extends \helper_plugin_struct_db {
+
+    public function IS_PUBLISHER() // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+    {
+        return false;
+    }
+}
diff --git a/action/migration.php b/action/migration.php
@@ -341,6 +341,37 @@ protected function migration18(helper_plugin_sqlite $sqlite)
         $sqlite->query('COMMIT TRANSACTION');
         return true;
     }
+    /**
+     * Executes Migration 19
+     *
+     * Add "published" column to all existing tables
+     *
+     * @param helper_plugin_sqlite $sqlite
+     * @return bool
+     */
+    protected function migration19(helper_plugin_sqlite $sqlite)
+    {
+        $ok = true;
+        $sqlite->query('BEGIN TRANSACTION');
+
+        /** @noinspection SqlResolve */
+        $sql = "SELECT name FROM sqlite_master WHERE type = 'table' AND (name LIKE 'data_%' OR name LIKE 'multi_%')";
+        $res = $sqlite->query($sql);
+        $tables = $sqlite->res2arr($res);
+        $sqlite->res_close($res);
+
+        foreach ($tables as $row) {
+            $sql = 'ALTER TABLE ? ADD COLUMN published INT DEFAULT NULL';
+            $ok = $ok && $sqlite->query($sql, $row['name']);
+        }
+        if (!$ok) {
+            $sqlite->query('ROLLBACK TRANSACTION');
+            return false;
+        }
+        $sqlite->query('COMMIT TRANSACTION');
+        return true;
+    }
+
 
     /**
      * Returns a select statement to fetch Lookup columns in the current schema
diff --git a/admin/assignments.php b/admin/assignments.php
@@ -141,7 +141,10 @@ public function html()
         echo '<td><input type="text" name="assignment[assign]" /></td>';
         echo '<td>';
         echo '<select name="assignment[tbl]">';
-        foreach (Schema::getAll() as $table) {
+        $schemas = helper_plugin_struct::getSchema();
+        foreach ($schemas as $schema) {
+            if ($schema->isInternal()) continue;
+            $table = $schema->getTable();
             echo '<option value="' . hsc($table) . '">' . hsc($table) . '</option>';
         }
         echo '</select>';
diff --git a/admin/schemas.php b/admin/schemas.php
@@ -156,6 +156,11 @@ public function html()
             echo $this->locale_xhtml('editor_edit');
             echo '<h2>' . sprintf($this->getLang('edithl'), hsc($table)) . '</h2>';
 
+            if ($schema->getConfig()['internal']) {
+                echo $this->getLang('internal');
+                return;
+            }
+
             echo '<ul class="tabs" id="plugin__struct_tabs">';
             /** @noinspection HtmlUnknownAnchorTarget */
             echo '<li class="active"><a href="#plugin__struct_editor">' . $this->getLang('tab_edit') . '</a></li>';
@@ -319,9 +324,11 @@ public function getTOC()
         );
         $toc[] = html_mktocitem($slink, $this->getLang('menu'), 0, '');
 
-        $tables = Schema::getAll();
-        if ($tables) {
-            foreach ($tables as $table) {
+        $schemas = helper_plugin_struct::getSchema();
+        if ($schemas) {
+            foreach ($schemas as $schema) {
+                if ($schema->isInternal()) continue;
+                $table = $schema->getTable();
                 $link = wl(
                     $ID,
                     array(
diff --git a/db/latest.version b/db/latest.version
@@ -1 +1 @@
-18
+19
diff --git a/db/update0019.sql b/db/update0019.sql
@@ -0,0 +1,3 @@
+-- this migration is handled in action/migrations.php in migration19()
+--
+-- it adds 'published' column to all tables (ALTER TABLE)
diff --git a/helper.php b/helper.php
@@ -163,7 +163,7 @@ public static function createPageRevision($page, $summary = '', $minor = false)
      * @return Schema[]
      * @throws StructException
      */
-    public function getSchema($schema = null)
+    public static function getSchema($schema = null)
     {
         if (is_null($schema)) {
             $schemas = Schema::getAll();
diff --git a/helper/db.php b/helper/db.php
@@ -7,6 +7,7 @@
  * @author  Andreas Gohr, Michael Große <dokuwiki@cosmocode.de>
  */
 
+use dokuwiki\Extension\Event;
 use dokuwiki\plugin\struct\meta\StructException;
 
 class helper_plugin_struct_db extends DokuWiki_Plugin
@@ -59,6 +60,18 @@ protected function init()
         // register our JSON function with variable parameters
         // todo this might be useful to be moved into the sqlite plugin
         $this->sqlite->create_function('STRUCT_JSON', array($this, 'STRUCT_JSON'), -1);
+
+        // this function is meant to be overwritten by plugins
+        $this->sqlite->create_function('IS_PUBLISHER', array($this, 'IS_PUBLISHER'), -1);
+
+        // collect and register custom functions from other plugins
+        $functions = [];
+        Event::createAndTrigger('STRUCT_PLUGIN_SQLITE_FUNCTION', $functions);
+        foreach ($functions as $fn) {
+            if (isset($fn['obj']) && isset($fn['name']) && is_callable([$fn['obj'], $fn['name']])) {
+                $this->sqlite->create_function($fn['name'], [$fn['obj'], $fn['name']], -1);
+            }
+        }
     }
 
     /**
@@ -104,6 +117,16 @@ public function STRUCT_JSON() // phpcs:ignore PSR1.Methods.CamelCapsMethodName.N
         $args = func_get_args();
         return json_encode($args);
     }
+
+    /**
+     * This dummy implementation can be overwritten by a plugin
+     *
+     * @return bool
+     */
+    public function IS_PUBLISHER() // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+    {
+        return true;
+    }
 }
 
 // vim:ts=4:sw=4:et:
diff --git a/lang/de/lang.php b/lang/de/lang.php
@@ -15,6 +15,7 @@
 $lang['page schema'] = 'Seiten Schema';
 $lang['lookup schema'] = 'Lookup Schema';
 $lang['edithl'] = 'Bearbeitung von Schema <i>%s</i>';
+$lang['internal'] = 'Dieses interne Schema ist nicht editierbar.';
 $lang['create'] = 'Neues Schema anlegen';
 $lang['schemaname'] = 'Schema-Name:';
 $lang['save'] = 'Speichern';
diff --git a/lang/en/lang.php b/lang/en/lang.php
@@ -14,12 +14,14 @@
 $lang['page schema'] = 'Page Schema:';
 $lang['lookup schema'] = 'Lookup Schema:';
 $lang['edithl'] = 'Editing schema <i>%s</i>';
+$lang['internal'] = 'This internal schema is not editable.';
 $lang['create'] = 'Create new Schema';
 $lang['schemaname'] = 'Schema Name:';
 $lang['save'] = 'Save';
 $lang['createhint'] = 'Please note: schemas can not be renamed later';
 $lang['pagelabel'] = 'Page';
 $lang['rowlabel'] = 'Row #';
+$lang['publishedlabel'] = 'Published';
 $lang['revisionlabel'] = 'Last Updated';
 $lang['userlabel'] = 'Last Editor';
 $lang['summarylabel'] = 'Last Summary';
diff --git a/meta/AccessTable.php b/meta/AccessTable.php
@@ -20,6 +20,7 @@ abstract class AccessTable
     protected $rid;
     protected $labels = [];
     protected $ts = 0;
+    protected $published;
     /** @var \helper_plugin_sqlite */
     protected $sqlite;
 
@@ -169,6 +170,16 @@ public function getRid()
         return $this->rid;
     }
 
+    /**
+     * Published status
+     *
+     * @return int|null
+     */
+    public function getPublished()
+    {
+        return $this->published;
+    }
+
     /**
      * Should remove the current data, by either deleting or ovewriting it
      *
@@ -394,6 +405,7 @@ public function getData()
      *
      * It always returns raw Values!
      *
+     * @return array
      */
     public function getDataArray()
     {
@@ -546,9 +558,10 @@ public function getTimestamp()
 
     /**
      * Return the last time an edit happened for this table for the currently set
-     * time and pid. Used in @return int
+     * time and pid. Used in
      * @see buildGetDataSQL()
      *
+     * @return int
      */
     abstract protected function getLastRevisionTimestamp();
 
diff --git a/meta/AccessTablePage.php b/meta/AccessTablePage.php
@@ -93,7 +93,9 @@ protected function beforeSave()
     }
 
     /**
-     * @inheritDoc
+     * Names of non-input columns to be inserted into SQL query.
+     * Field 'published' is skipped because only plugins use it and
+     * we don't want to interfere with the default NULL value
      */
     protected function getSingleNoninputCols()
     {
diff --git a/meta/PublishedColumn.php b/meta/PublishedColumn.php
@@ -0,0 +1,49 @@
+<?php
+
+namespace dokuwiki\plugin\struct\meta;
+
+use dokuwiki\plugin\struct\types\Decimal;
+
+/**
+ * Published Column
+ */
+class PublishedColumn extends PageColumn
+{
+    /** @noinspection PhpMissingParentConstructorInspection
+     * @param int $sort
+     * @param Decimal $type
+     * @param string $table
+     */
+    public function __construct($sort, Decimal $type, $table)
+    {
+        if ($type->isMulti()) throw new StructException('PublishedColumns can not be multi value types!');
+        Column::__construct($sort, $type, 0, true, $table);
+    }
+
+    /**
+     * @return string
+     */
+    public function getLabel()
+    {
+        return '%published%';
+    }
+
+    /**
+     * @param bool $enforceSingleColumn ignored
+     * @return string
+     */
+    public function getColName($enforceSingleColumn = true)
+    {
+        return 'published';
+    }
+
+    /**
+     * @return string preconfigured label
+     */
+    public function getTranslatedLabel()
+    {
+        /** @var \helper_plugin_struct_config $helper */
+        $helper = plugin_load('helper', 'struct_config');
+        return $helper->getLang('publishedlabel');
+    }
+}
diff --git a/meta/Schema.php b/meta/Schema.php
diff --git a/meta/SchemaBuilder.php b/meta/SchemaBuilder.php
diff --git a/meta/Search.php b/meta/Search.php
diff --git a/remote.php b/remote.php

Original file line number	Diff line number	Diff line change
`@@ -185,7 +185,10 @@ public function test_DataFiltersAsSubQuery($inputFilterLines, $expectedFilterWhe`
`185`	`185`	`AND (ASSIGNED = 1 OR ASSIGNED IS NULL)`
`186`	`186`	`)`
`187`	`187`	`)`
`188`		`- AND data_bar.latest = 1";`
	`188`	`+ AND (`
	`189`	`+ (IS_PUBLISHER(data_bar.pid) AND data_bar.latest = 1)`
	`190`	`+ OR (IS_PUBLISHER(data_bar.pid) IS FALSE AND data_bar.published = 1)`
	`191`	`+ )";`
`189`	`192`
`190`	`193`	`$expected_where = $baseWhere . $expectedFilterWhere . " )";`
`191`	`194`	`$this->assertEquals($this->cleanWS($expected_where), $this->cleanWS($where), $msg);`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,8 @@`
`7`	`7`	`"allowed editors": "",`
`8`	`8`	`"label": {`
`9`	`9`	`"en": ""`
`10`		`- }`
	`10`	`+ },`
	`11`	`+ "internal": false`
`11`	`12`	`},`
`12`	`13`	`"columns": [`
`13`	`14`	`{`
`@@ -81,4 +82,4 @@`
`81`	`82`	`}`
`82`	`83`	`}`
`83`	`84`	`]`
`84`		`-}`
	`85`	`+}`