xref: /plugin/struct/meta/SchemaBuilder.php (revision b3e0ad6d60af0e0736b7a73fc4da7a3a2e2f65a4) 
1<?php
2
3namespace dokuwiki\plugin\struct\meta;
4
5/**
6 * Class SchemaBuilder
7 *
8 * This class builds and updates the schema definitions for our tables. This includes CREATEing and ALTERing
9 * the actual data tables as well as updating the meta information in our meta data tables.
10 *
11 * To use, simply instantiate a new object of the Builder and run the build() method on it.
12 *
13 * Note: even though data tables use a data_ prefix in the database, this prefix is internal only and should
14 *       never be passed as $table anywhere!
15 *
16 * @package dokuwiki\plugin\struct\meta
17 */
18class SchemaBuilder {
19
20    /**
21     * @var array The posted new data for the schema
22     * @see Schema::AdminEditor()
23     */
24    protected $data = array();
25
26    /**
27     * @var string The table name associated with the schema
28     */
29    protected $table = '';
30
31    /**
32     * @var Schema the previously valid schema for this table
33     */
34    protected $oldschema;
35
36    /** @var int the ID of the newly created schema */
37    protected $newschemaid = 0;
38
39    /** @var \helper_plugin_struct_db */
40    protected $helper;
41
42    /** @var \helper_plugin_sqlite|null  */
43    protected $sqlite;
44
45    /** @var int the time for which this schema should be created - default to time() can be overriden for tests */
46    protected $time = 0;
47
48    /**
49     * SchemaBuilder constructor.
50     *
51     * @param string $table The table's name
52     * @param array $data The defining of the table (basically what get's posted in the schema editor form)
53     * @see Schema::AdminEditor()
54     */
55    public function __construct($table, $data) {
56        $this->table = $table;
57        $this->data = $data;
58        $this->oldschema = new Schema($table, 0, $data['islookup']);
59
60        $this->helper = plugin_load('helper', 'struct_db');
61        $this->sqlite = $this->helper->getDB();
62    }
63
64    /**
65     * Create the new schema
66     *
67     * @param int $time when to create this schema 0 for now
68     * @return bool|int the new schema id on success
69     */
70    public function build($time=0) {
71        $this->time = $time;
72        $this->fixLabelUniqueness();
73
74        $this->sqlite->query('BEGIN TRANSACTION');
75        $ok = true;
76        // create the data table if new schema
77        if(!$this->oldschema->getId()) {
78            if($this->oldschema->isLookup()) {
79                $ok = $this->newLookupTable();
80            } else {
81                $ok = $this->newDataTable();
82            }
83        }
84
85        // create a new schema
86        $ok = $ok && $this->newSchema();
87
88        // update column info
89        $ok = $ok && $this->updateColumns();
90        $ok = $ok && $this->addColumns();
91
92        if (!$ok) {
93            $this->sqlite->query('ROLLBACK TRANSACTION');
94            return false;
95        }
96        $this->sqlite->query('COMMIT TRANSACTION');
97
98        return $this->newschemaid;
99    }
100
101    /**
102     * Makes sure all labels in the schema to save are unique
103     */
104    protected function fixLabelUniqueness() {
105        $labels = array();
106
107        if(isset($this->data['cols'])) foreach($this->data['cols'] as $idx => $column) {
108            $this->data['cols'][$idx]['label'] = $this->fixLabel($column['label'], $labels);
109        }
110
111        if(isset($this->data['new'])) foreach($this->data['new'] as $idx => $column) {
112            $this->data['new'][$idx]['label'] = $this->fixLabel($column['label'], $labels);
113        }
114    }
115
116    /**
117     * Creates a unique label from the given one
118     *
119     * @param string $wantedlabel
120     * @param array $labels list of already assigned labels (will be filled)
121     * @return string
122     */
123    protected function fixLabel($wantedlabel, &$labels) {
124        $wantedlabel = trim($wantedlabel);
125        $fixedlabel = $wantedlabel;
126        $idx = 1;
127        while(isset($labels[utf8_strtolower($fixedlabel)])) {
128            $fixedlabel = $wantedlabel.$idx++;
129        }
130        // did we actually do a rename? apply it.
131        if($fixedlabel != $wantedlabel) {
132            msg(sprintf($this->helper->getLang('duplicate_label'), $wantedlabel, $fixedlabel), -1);
133            $this->data['cols']['label'] = $fixedlabel;
134        }
135        $labels[utf8_strtolower($fixedlabel)] = 1;
136        return $fixedlabel;
137    }
138
139    /**
140     * Creates a new schema
141     *
142     * @todo use checksum or other heuristic to see if we really need a new schema OTOH we probably need one nearly always!?
143     */
144    protected function newSchema() {
145        if(!$this->time) $this->time = time();
146
147        $sql = "INSERT INTO schemas (tbl, ts, islookup) VALUES (?, ?, ?)";
148        $this->sqlite->query($sql, $this->table, $this->time, (int) $this->oldschema->isLookup());
149        $res = $this->sqlite->query('SELECT last_insert_rowid()');
150        $this->newschemaid = $this->sqlite->res2single($res);
151        $this->sqlite->res_close($res);
152        if(!$this->newschemaid) return false;
153        return true;
154    }
155
156    /**
157     * Updates all the existing column infos and adds them to the new schema
158     */
159    protected function updateColumns() {
160        foreach($this->oldschema->getColumns() as $column) {
161            $oldEntry = $column->getType()->getAsEntry();
162            $oldTid   = $column->getTid();
163            $newEntry = $oldEntry;
164            $newTid   = $oldTid;
165            $sort = $column->getSort();
166            if(isset($this->data['cols'][$column->getColref()])){
167                // todo I'm not too happy with this hardcoded here - we should probably have a list of fields at one place
168                $newEntry['config'] = $this->data['cols'][$column->getColref()]['config'];
169                $newEntry['label'] = $this->data['cols'][$column->getColref()]['label'];
170                $newEntry['ismulti'] = $this->data['cols'][$column->getColref()]['ismulti'];
171                $newEntry['class'] = $this->data['cols'][$column->getColref()]['class'];
172                $sort = $this->data['cols'][$column->getColref()]['sort'];
173                $enabled = (bool) $this->data['cols'][$column->getColref()]['isenabled'];
174
175                // when the type definition has changed, we create a new one
176                if(array_diff_assoc($oldEntry, $newEntry)) {
177                    $ok = $this->sqlite->storeEntry('types', $newEntry);
178                    if(!$ok) return false;
179                    $res = $this->sqlite->query('SELECT last_insert_rowid()');
180                    if(!$res) return false;
181                    $newTid = $this->sqlite->res2single($res);
182                    $this->sqlite->res_close($res);
183                    if ($oldEntry['ismulti'] == false && $newEntry['ismulti'] == '1') {
184                        $this->migrateSingleToMulti($this->oldschema->getTable(), $column->getColref());
185                    }
186                }
187            } else {
188                $enabled = false; // no longer there for some reason
189            }
190
191            // add this type to the schema columns
192            $schemaEntry = array(
193                'sid' => $this->newschemaid,
194                'colref' => $column->getColref(),
195                'enabled' => $enabled,
196                'tid' => $newTid,
197                'sort' => $sort
198            );
199            $ok = $this->sqlite->storeEntry('schema_cols', $schemaEntry);
200            if(!$ok) return false;
201        }
202        return true;
203    }
204
205    private function migrateSingleToMulti($table, $colref) {
206        $sqlSelect = "SELECT pid, rev, col$colref AS value FROM data_$table WHERE latest = 1";
207        $res = $this->sqlite->query($sqlSelect);
208        $valueSet = $this->sqlite->res2arr($res);
209        $this->sqlite->res_close($res);
210        $valueString = array();
211        foreach ($valueSet as $values) {
212            if (blank($values['value']) || trim($values['value']) == '') {
213                continue;
214            }
215            $valueString[] = "($colref, '$values[pid]', $values[rev], 1, '$values[value]')";
216        }
217        if (empty($valueString)) {
218            return;
219        }
220        $valueString = join(',', $valueString);
221        $sqlInsert = "INSERT OR REPLACE INTO multi_$table (colref, pid, rev, row, value) VALUES $valueString";
222        $this->sqlite->query($sqlInsert);
223    }
224
225    /**
226     * Adds new columns to the new schema
227     *
228     * @return bool
229     */
230    protected function addColumns() {
231        if(!isset($this->data['new'])) return true;
232
233        $colref = count($this->oldschema->getColumns())+1;
234
235        foreach($this->data['new'] as $column) {
236            if(!$column['isenabled']) continue; // we do not add a disabled column
237
238            // todo this duplicates the hardcoding as in  the function above
239            $newEntry = array();
240            $newEntry['config'] = $column['config'];
241            $newEntry['label'] = $column['label'];
242            $newEntry['ismulti'] = $column['ismulti'];
243            $newEntry['class'] = $column['class'];
244            $sort = $column['sort'];
245
246
247            // only save if the column got a name
248            if(!$newEntry['label']) continue;
249
250            // add new column to the data table
251            if(!$this->addDataTableColumn($colref)) {
252                return false;
253            }
254
255            // save the type
256            $ok = $this->sqlite->storeEntry('types', $newEntry);
257            if(!$ok) return false;
258            $res = $this->sqlite->query('SELECT last_insert_rowid()');
259            if(!$res) return false;
260            $newTid = $this->sqlite->res2single($res);
261            $this->sqlite->res_close($res);
262
263
264            // add this type to the schema columns
265            $schemaEntry = array(
266                'sid' => $this->newschemaid,
267                'colref' => $colref,
268                'enabled' => true,
269                'tid' => $newTid,
270                'sort' => $sort
271            );
272            $ok = $this->sqlite->storeEntry('schema_cols', $schemaEntry);
273            if(!$ok) return false;
274            $colref++;
275        }
276
277        return true;
278    }
279
280    /**
281     * Create a completely new data table with no columns yet also create the appropriate
282     * multi value table for the schema
283     *
284     * @todo how do we want to handle indexes?
285     * @return bool
286     */
287    protected function newDataTable() {
288        $ok = true;
289
290        $tbl = 'data_' . $this->table;
291        $sql = "CREATE TABLE $tbl (
292                    pid NOT NULL,
293                    rev INTEGER NOT NULL,
294                    latest BOOLEAN NOT NULL DEFAULT 0,
295                    PRIMARY KEY(pid, rev)
296                )";
297        $ok = $ok && (bool) $this->sqlite->query($sql);
298
299        $tbl = 'multi_' . $this->table;
300        $sql = "CREATE TABLE $tbl (
301                    colref INTEGER NOT NULL,
302                    pid NOT NULL,
303                    rev INTEGER NOT NULL,
304                    row INTEGER NOT NULL,
305                    value,
306                    PRIMARY KEY(colref, pid, rev, row)
307                );";
308        $ok = $ok && (bool) $this->sqlite->query($sql);
309
310        return $ok;
311    }
312
313    /**
314     * Creates a new lookup table with no columns
315     *
316     * This is basically the same as @see newDataTable() but sets
317     * different primary keys and types
318     *
319     * @return bool
320     */
321    protected function newLookupTable() {
322        $ok = true;
323
324        $tbl = 'data_' . $this->table;
325        $sql = "CREATE TABLE $tbl (
326                    pid INTEGER PRIMARY KEY,
327                    rev INTEGER NOT NULL DEFAULT 0,
328                    latest BOOLEAN NOT NULL DEFAULT 1
329                )";
330        $ok = $ok && (bool) $this->sqlite->query($sql);
331
332        $tbl = 'multi_' . $this->table;
333        $sql = "CREATE TABLE $tbl (
334                    colref INTEGER NOT NULL,
335                    pid INTEGER NOT NULL,
336                    rev INTEGER NOT NULL DEFAULT 0,
337                    row INTEGER NOT NULL,
338                    value,
339                    PRIMARY KEY(colref, pid, row)
340                );";
341        $ok = $ok && (bool) $this->sqlite->query($sql);
342
343        return $ok;
344    }
345
346    /**
347     * Add an additional column to the existing data table
348     *
349     * @param int $index the new column index to add
350     * @return bool
351     */
352    protected function addDataTableColumn($index) {
353        $tbl = 'data_' . $this->table;
354        $sql = " ALTER TABLE $tbl ADD COLUMN col$index DEFAULT ''";
355        if(! $this->sqlite->query($sql)) {
356            return false;
357        }
358        return true;
359    }
360
361}
362