-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Expand file tree
/
Copy pathNormalization.php
More file actions
1067 lines (976 loc) · 39.7 KB
/
Normalization.php
File metadata and controls
1067 lines (976 loc) · 39.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
declare(strict_types=1);
namespace PhpMyAdmin;
use PhpMyAdmin\ConfigStorage\Relation;
use PhpMyAdmin\Dbal\DatabaseInterface;
use PhpMyAdmin\Html\Generator;
use PhpMyAdmin\Indexes\Index;
use PhpMyAdmin\Query\Compatibility;
use function __;
use function _pgettext;
use function array_merge;
use function array_pop;
use function array_unique;
use function count;
use function explode;
use function htmlspecialchars;
use function implode;
use function in_array;
use function is_array;
use function json_encode;
use function mb_strtoupper;
use function sort;
use function sprintf;
use function str_replace;
use function trim;
/**
* Set of functions used for normalization
*/
class Normalization
{
private readonly Config $config;
public function __construct(
private DatabaseInterface $dbi,
private Relation $relation,
private Transformations $transformations,
public Template $template,
) {
$this->config = Config::getInstance();
}
/**
* build the html for columns of $colTypeCategory category
* in form of given $listType in a table
*
* @param string $db current database
* @param string $table current table
* @param string $colTypeCategory supported all|Numeric|String|Spatial
* |Date and time using the _pgettext() format
* @param string $listType type of list to build, supported dropdown|checkbox
*
* @return string HTML for list of columns in form of given list types
*/
public function getHtmlForColumnsList(
string $db,
string $table,
string $colTypeCategory = 'all',
string $listType = 'dropdown',
): string {
$columnTypeList = [];
if ($colTypeCategory !== 'all') {
$types = $this->dbi->types->getColumns();
$columnTypeList = $types[$colTypeCategory];
if (! is_array($columnTypeList)) {
$columnTypeList = [];
}
}
$this->dbi->selectDb($db);
$columns = $this->dbi->getColumns($db, $table);
$selectColHtml = '';
foreach ($columns as $def) {
$column = $def->field;
$extractedColumnSpec = Util::extractColumnSpec($def->type);
if (
$columnTypeList !== [] && ! in_array(mb_strtoupper(
$extractedColumnSpec['type'],
), $columnTypeList, true)
) {
continue;
}
if ($listType === 'checkbox') {
$selectColHtml .= '<input type="checkbox" value="'
. htmlspecialchars($column) . '">'
. htmlspecialchars($column) . ' [ '
. htmlspecialchars($def->type) . ' ]<br>';
} else {
$selectColHtml .= '<option value="' . htmlspecialchars($column)
. '">' . htmlspecialchars($column)
. ' [ ' . htmlspecialchars($def->type) . ' ]'
. '</option>';
}
}
return $selectColHtml;
}
/**
* get the html of the form to add the new column to given table
*
* @param int $numFields number of columns to add
* @param string $db current database
* @param string $table current table
* @param mixed[] $columnMeta array containing default values for the fields
*
* @return string HTML
*/
public function getHtmlForCreateNewColumn(
UserPrivileges $userPrivileges,
int $numFields,
string $db,
string $table,
array $columnMeta = [],
): string {
$relationParameters = $this->relation->getRelationParameters();
$contentCells = [];
$availableMime = [];
$mimeMap = [];
if ($relationParameters->browserTransformationFeature !== null && $this->config->config->BrowseMIME) {
$mimeMap = $this->transformations->getMime($db, $table);
$availableMime = $this->transformations->getAvailableMimeTypes();
}
$commentsMap = $this->relation->getComments($db, $table);
/** @infection-ignore-all */
for ($columnNumber = 0; $columnNumber < $numFields; $columnNumber++) {
$contentCells[$columnNumber] = [
'column_number' => $columnNumber,
'column_meta' => $columnMeta,
'type_upper' => '',
'length_values_input_size' => 8,
'length' => '',
'extracted_columnspec' => [],
'submit_attribute' => null,
'comments_map' => $commentsMap,
'fields_meta' => null,
'is_backup' => true,
'move_columns' => [],
'available_mime' => $availableMime,
'mime_map' => $mimeMap,
];
}
$charsets = Charsets::getCharsets($this->dbi, $this->config->selectedServer['DisableIS']);
$collations = Charsets::getCollations($this->dbi, $this->config->selectedServer['DisableIS']);
$charsetsList = [];
foreach ($charsets as $charset) {
$collationsList = [];
foreach ($collations[$charset->getName()] as $collation) {
$collationsList[] = ['name' => $collation->getName(), 'description' => $collation->getDescription()];
}
$charsetsList[] = [
'name' => $charset->getName(),
'description' => $charset->getDescription(),
'collations' => $collationsList,
];
}
return $this->template->render('columns_definitions/table_fields_definitions', [
'is_backup' => true,
'fields_meta' => null,
'relation_parameters' => $relationParameters,
'content_cells' => $contentCells,
'change_column' => $_POST['change_column'] ?? $_GET['change_column'] ?? null,
'is_virtual_columns_supported' => Compatibility::isVirtualColumnsSupported(
$this->dbi,
$this->dbi->getVersion(),
),
'browse_mime' => $this->config->config->BrowseMIME,
'supports_stored_keyword' => Compatibility::supportsStoredKeywordForVirtualColumns(
$this->dbi,
$this->dbi->getVersion(),
),
'server_version' => $this->dbi->getVersion(),
'max_rows' => $this->config->config->maxRows,
'char_editing' => $this->config->config->CharEditing,
'attribute_types' => $this->dbi->types->getAttributes(),
'privs_available' => $userPrivileges->column && $userPrivileges->isReload,
'max_length' => $this->dbi->getVersion() >= 50503 ? 1024 : 255,
'charsets' => $charsetsList,
]);
}
/**
* build the html for step 1.1 of normalization
*
* @param string $db current database
* @param string $table current table
* @param string $normalizedTo up to which step normalization will go,
* possible values 1nf|2nf|3nf
*
* @return string HTML for step 1.1
*/
public function getHtmlFor1NFStep1(string $db, string $table, string $normalizedTo): string
{
$step = 1;
$stepTxt = __('Make all columns atomic');
$html = '<h3>' . __('First step of normalization (1NF)') . '</h3>';
$html .= '<div class="card" id="mainContent" data-normalizeto="' . $normalizedTo . '">'
. '<div class="card-header">' . __('Step 1.') . $step . ' ' . $stepTxt . '</div>'
. '<div class="card-body">'
. '<h4>' . __(
'Do you have any column which can be split into more than one column?'
. ' For example: address can be split into street, city, country and zip.',
)
. "<br>(<a class='central_columns_dialog' data-maxrows='25' "
. "data-pick=false href='#'> "
. __('Show me the central list of columns that are not already in this table') . ' </a>)</h4>'
. "<p class='cm-em'>" . __(
'Select a column which can be split into more '
. 'than one (on select of \'no such column\', it\'ll move to next step).',
)
. '</p>'
. "<div id='extra'>"
. "<select id='selectNonAtomicCol' name='makeAtomic'>"
. '<option selected disabled>'
. __('Select one…') . '</option>'
. "<option value='no_such_col'>" . __('No such column') . '</option>'
. $this->getHtmlForColumnsList(
$db,
$table,
_pgettext('string types', 'String'),
)
. '</select>'
. '<span>' . __('split into ')
. "</span><input id='numField' type='number' value='2'>"
. '<input type="submit" class="btn btn-primary" id="splitGo" value="' . __('Go') . '"></div>'
. "<div id='newCols'></div>"
. '</div><div class="card-footer"></div>'
. '</div>';
$html .= $this->template->render('modals/index_dialog_modal');
return $html;
}
/**
* build the html contents of various html elements in step 1.2
*
* @param string $db current database
* @param string $table current table
*
* @return array{legendText: string, headText: string, subText: string, hasPrimaryKey: string, extra: string}
*/
public function getHtmlContentsFor1NFStep2(string $db, string $table): array
{
$step = 2;
$stepTxt = __('Have a primary key');
$primary = Index::getPrimary($this->dbi, $table, $db);
$hasPrimaryKey = '0';
$legendText = __('Step 1.') . $step . ' ' . $stepTxt;
$extra = '';
if ($primary !== null) {
$headText = __('Primary key already exists.');
$subText = __('Taking you to next step…');
$hasPrimaryKey = '1';
} else {
$headText = __(
'There is no primary key; please add one.<br>'
. 'Hint: A primary key is a column '
. '(or combination of columns) that uniquely identify all rows.',
);
$subText = '<a href="#" id="createPrimaryKey">'
. Generator::getIcon(
'b_index_add',
__(
'Add a primary key on existing column(s)',
),
)
. '</a>';
$extra = __('If it\'s not possible to make existing column combinations as primary key') . '<br>'
. '<a href="#" id="addNewPrimary">'
. __('+ Add a new primary key column') . '</a>';
}
return [
'legendText' => $legendText,
'headText' => $headText,
'subText' => $subText,
'hasPrimaryKey' => $hasPrimaryKey,
'extra' => $extra,
];
}
/**
* build the html contents of various html elements in step 1.4
*
* @param string $db current database
* @param string $table current table
*
* @return array{legendText: string, headText: string, subText: string, extra: string} HTML contents for step 1.4
*/
public function getHtmlContentsFor1NFStep4(string $db, string $table): array
{
$step = 4;
$stepTxt = __('Remove redundant columns');
$legendText = __('Step 1.') . $step . ' ' . $stepTxt;
$headText = __(
'Do you have a group of columns which on combining gives an existing'
. ' column? For example, if you have first_name, last_name and'
. ' full_name then combining first_name and last_name gives full_name'
. ' which is redundant.',
);
$subText = __(
'Check the columns which are redundant and click on remove. '
. "If no redundant column, click on 'No redundant column'",
);
$extra = $this->getHtmlForColumnsList($db, $table, 'all', 'checkbox') . '<br>'
. '<input class="btn btn-secondary" type="submit" id="removeRedundant" value="'
. __('Remove selected') . '">'
. '<input class="btn btn-secondary" type="submit" id="noRedundantColumn" value="'
. __('No redundant column') . '">';
return ['legendText' => $legendText, 'headText' => $headText, 'subText' => $subText, 'extra' => $extra];
}
/**
* build the html contents of various html elements in step 1.3
*
* @param string $db current database
* @param string $table current table
*
* @return array{legendText: string, headText: string, subText: string, extra: string, primary_key: false|string}
*/
public function getHtmlContentsFor1NFStep3(string $db, string $table): array
{
$step = 3;
$stepTxt = __('Move repeating groups');
$legendText = __('Step 1.') . $step . ' ' . $stepTxt;
$headText = __(
'Do you have a group of two or more columns that are closely '
. 'related and are all repeating the same attribute? For example, '
. 'a table that holds data on books might have columns such as book_id, '
. 'author1, author2, author3 and so on which form a '
. 'repeating group. In this case a new table (book_id, author) should '
. 'be created.',
);
$subText = __(
'Check the columns which form a repeating group. If no such group, click on \'No repeating group\'',
);
$extra = $this->getHtmlForColumnsList($db, $table, 'all', 'checkbox') . '<br>'
. '<input class="btn btn-secondary" type="submit" id="moveRepeatingGroup" value="'
. __('Done') . '">'
. '<input class="btn btn-secondary" type="submit" value="' . __('No repeating group')
. '" id="noRepeatingGroup">';
$primary = Index::getPrimary($this->dbi, $table, $db);
$primarycols = $primary === null ? [] : $primary->getColumns();
$pk = [];
foreach ($primarycols as $col) {
$pk[] = $col->getName();
}
return [
'legendText' => $legendText,
'headText' => $headText,
'subText' => $subText,
'extra' => $extra,
'primary_key' => json_encode($pk),
];
}
/**
* build html contents for 2NF step 2.1
*
* @param string $db current database
* @param string $table current table
*
* @return array{legendText: string, headText: string, subText: string, extra: string, primary_key: string}
*/
public function getHtmlFor2NFstep1(string $db, string $table): array
{
$legendText = __('Step 2.') . '1 ' . __('Find partial dependencies');
$primary = Index::getPrimary($this->dbi, $table, $db);
$primarycols = $primary === null ? [] : $primary->getColumns();
$pk = [];
$subText = '';
$selectPkForm = '';
$extra = '';
foreach ($primarycols as $col) {
$pk[] = $col->getName();
$selectPkForm .= '<input type="checkbox" name="pd" value="'
. htmlspecialchars($col->getName()) . '">'
. htmlspecialchars($col->getName());
}
$key = implode(', ', $pk);
if (count($primarycols) > 1) {
$this->dbi->selectDb($db);
$columns = $this->dbi->getColumnNames($db, $table);
if (count($pk) === count($columns)) {
$headText = sprintf(
__(
'No partial dependencies possible as '
. 'no non-primary column exists since primary key ( %1$s ) '
. 'is composed of all the columns in the table.',
),
htmlspecialchars($key),
) . '<br>';
$extra = '<h3>' . __('Table is already in second normal form.')
. '</h3>';
} else {
$headText = sprintf(
__(
'The primary key ( %1$s ) consists of more than one column '
. 'so we need to find the partial dependencies.',
),
htmlspecialchars($key),
) . '<br>' . __('Please answer the following question(s) carefully to obtain a correct normalization.')
. '<br><a href="#" id="showPossiblePd">' . __(
'+ Show me the possible partial dependencies based on data in the table',
) . '</a>';
$subText = __(
'For each column below, '
. 'please select the <b>minimal set</b> of columns among given set '
. 'whose values combined together are sufficient'
. ' to determine the value of the column.',
);
$cnt = 0;
foreach ($columns as $column) {
if (in_array($column, $pk, true)) {
continue;
}
$cnt++;
$extra .= '<b>' . sprintf(
__('\'%1$s\' depends on:'),
htmlspecialchars($column),
) . '</b><br>';
$extra .= '<form id="pk_' . $cnt . '" data-colname="'
. htmlspecialchars($column) . '" class="smallIndent">'
. $selectPkForm . '</form><br><br>';
}
}
} else {
$headText = sprintf(
__(
'No partial dependencies possible as the primary key ( %1$s ) has just one column.',
),
htmlspecialchars($key),
) . '<br>';
$extra = '<h3>' . __('Table is already in second normal form.') . '</h3>';
}
return [
'legendText' => $legendText,
'headText' => $headText,
'subText' => $subText,
'extra' => $extra,
'primary_key' => $key,
];
}
/**
* build the html for showing the tables to have in order to put current table in 2NF
*
* @param mixed[] $partialDependencies array containing all the dependencies
* @param string $table current table
*
* @return string HTML
*/
public function getHtmlForNewTables2NF(array $partialDependencies, string $table): string
{
$html = '<p><b>' . sprintf(
__(
'In order to put the '
. 'original table \'%1$s\' into Second normal form we need '
. 'to create the following tables:',
),
htmlspecialchars($table),
) . '</b></p>';
$tableName = $table;
$i = 1;
foreach ($partialDependencies as $key => $dependents) {
$html .= '<p><input type="text" name="' . htmlspecialchars($key)
. '" value="' . htmlspecialchars($tableName) . '">'
. '( <u>' . htmlspecialchars($key) . '</u>'
. (count($dependents) > 0 ? ', ' : '')
. htmlspecialchars(implode(', ', $dependents)) . ' )';
$i++;
$tableName = 'table' . $i;
}
return $html;
}
/**
* create/alter the tables needed for 2NF
*
* @param mixed[] $partialDependencies array containing all the partial dependencies
* @param object $tablesName name of new tables
* @param string $table current table
* @param string $db current database
*
* @return array{legendText: string, headText: string, queryError: bool, extra: Message}
*/
public function createNewTablesFor2NF(
array $partialDependencies,
object $tablesName,
string $table,
string $db,
): array {
$dropCols = false;
$nonPKCols = [];
$queries = [];
$error = false;
$headText = '<h3>' . sprintf(
__('The second step of normalization is complete for table \'%1$s\'.'),
htmlspecialchars($table),
) . '</h3>';
if (count($partialDependencies) === 1) {
return ['legendText' => __('End of step'), 'headText' => $headText, 'queryError' => false];
}
$message = '';
$this->dbi->selectDb($db);
foreach ($partialDependencies as $key => $dependents) {
if ($tablesName->$key != $table) {
$keys = explode(', ', $key);
$quotedKeys = [];
foreach ($keys as $eachKey) {
$quotedKeys[] = Util::backquote($eachKey);
}
$backquotedKey = implode(', ', $quotedKeys);
$quotedDependents = [];
foreach ($dependents as $dependent) {
$quotedDependents[] = Util::backquote($dependent);
}
$queries[] = 'CREATE TABLE ' . Util::backquote($tablesName->$key)
. ' SELECT DISTINCT ' . $backquotedKey
. (count($dependents) > 0 ? ', ' : '')
. implode(',', $quotedDependents)
. ' FROM ' . Util::backquote($table) . ';';
$queries[] = 'ALTER TABLE ' . Util::backquote($tablesName->$key)
. ' ADD PRIMARY KEY(' . $backquotedKey . ');';
$nonPKCols = array_merge($nonPKCols, $dependents);
} else {
$dropCols = true;
}
}
if ($dropCols) {
$query = 'ALTER TABLE ' . Util::backquote($table);
foreach ($nonPKCols as $col) {
$query .= ' DROP ' . Util::backquote($col) . ',';
}
$query = trim($query, ', ');
$query .= ';';
$queries[] = $query;
} else {
$queries[] = 'DROP TABLE ' . Util::backquote($table);
}
foreach ($queries as $query) {
if (! $this->dbi->tryQuery($query)) {
$message = Message::error(__('Error in processing!'));
$message->addMessage(
Message::rawError($this->dbi->getError()),
'<br><br>',
);
$error = true;
break;
}
}
return [
'legendText' => __('End of step'),
'headText' => $headText,
'queryError' => $error,
'extra' => $message,
];
}
/**
* build the html for showing the new tables to have in order
* to put given tables in 3NF
*
* @param object $dependencies containing all the dependencies
* @param mixed[] $tables tables formed after 2NF and need to convert to 3NF
* @param string $db current database
*
* @return array{html:string, newTables:mixed[], success:true} containing html and the list of new tables
*/
public function getHtmlForNewTables3NF(object $dependencies, array $tables, string $db): array
{
$html = '';
$i = 1;
$newTables = [];
foreach ($tables as $table => $arrDependson) {
if (count(array_unique($arrDependson)) === 1) {
continue;
}
$primary = Index::getPrimary($this->dbi, $table, $db);
$primarycols = $primary === null ? [] : $primary->getColumns();
$pk = [];
foreach ($primarycols as $col) {
$pk[] = $col->getName();
}
$html .= '<p><b>' . sprintf(
__(
'In order to put the '
. 'original table \'%1$s\' into Third normal form we need '
. 'to create the following tables:',
),
htmlspecialchars($table),
) . '</b></p>';
$tableName = $table;
$columnList = [];
foreach ($arrDependson as $key) {
$dependents = $dependencies->$key;
if ($key == $table) {
$key = implode(', ', $pk);
}
$tmpTableCols = array_merge(explode(', ', $key), $dependents);
sort($tmpTableCols);
if (in_array($tmpTableCols, $columnList)) {
continue;
}
$columnList[] = $tmpTableCols;
$html .= '<p><input type="text" name="'
. htmlspecialchars($tableName)
. '" value="' . htmlspecialchars($tableName) . '">'
. '( <u>' . htmlspecialchars($key) . '</u>'
. (count($dependents) > 0 ? ', ' : '')
. htmlspecialchars(implode(', ', $dependents)) . ' )';
$newTables[$table][$tableName] = ['pk' => $key, 'nonpk' => implode(', ', $dependents)];
$i++;
$tableName = 'table' . $i;
}
}
return ['html' => $html, 'newTables' => $newTables, 'success' => true];
}
/**
* create new tables or alter existing to get 3NF
*
* @param mixed[] $newTables list of new tables to be created
* @param string $db current database
*
* @return array{legendText: string, headText: string, queryError: string|false, extra?: string}
*/
public function createNewTablesFor3NF(array $newTables, string $db): array
{
$queries = [];
$dropCols = false;
$error = false;
$headText = '<h3>' . __('The third step of normalization is complete.') . '</h3>';
if ($newTables === []) {
return ['legendText' => __('End of step'), 'headText' => $headText, 'queryError' => false];
}
$message = '';
$this->dbi->selectDb($db);
foreach ($newTables as $originalTable => $tablesList) {
foreach ($tablesList as $table => $cols) {
if ($table != $originalTable) {
$pkArray = explode(', ', $cols['pk']);
$quotedPkArray = [];
foreach ($pkArray as $pk) {
$quotedPkArray[] = Util::backquote($pk);
}
$quotedPk = implode(', ', $quotedPkArray);
$nonpkArray = explode(', ', $cols['nonpk']);
$quotedNonpkArray = [];
foreach ($nonpkArray as $nonpk) {
$quotedNonpkArray[] = Util::backquote($nonpk);
}
$quotedNonpk = implode(', ', $quotedNonpkArray);
$queries[] = 'CREATE TABLE ' . Util::backquote($table)
. ' SELECT DISTINCT ' . $quotedPk
. ', ' . $quotedNonpk
. ' FROM ' . Util::backquote($originalTable) . ';';
$queries[] = 'ALTER TABLE ' . Util::backquote($table)
. ' ADD PRIMARY KEY(' . $quotedPk . ');';
} else {
$dropCols = $cols;
}
}
if ($dropCols) {
$columns = $this->dbi->getColumnNames($db, $originalTable);
$colPresent = array_merge(
explode(', ', $dropCols['pk']),
explode(', ', $dropCols['nonpk']),
);
$query = 'ALTER TABLE ' . Util::backquote($originalTable);
foreach ($columns as $col) {
if (in_array($col, $colPresent, true)) {
continue;
}
$query .= ' DROP ' . Util::backquote($col) . ',';
}
$query = trim($query, ', ');
$query .= ';';
$queries[] = $query;
} else {
$queries[] = 'DROP TABLE ' . Util::backquote($originalTable);
}
$dropCols = false;
}
foreach ($queries as $query) {
if (! $this->dbi->tryQuery($query)) {
$message = Message::error(__('Error in processing!'));
$message->addMessage(
Message::rawError($this->dbi->getError()),
'<br><br>',
);
$error = true;
break;
}
}
return [
'legendText' => __('End of step'),
'headText' => $headText,
'queryError' => $error,
'extra' => $message,
];
}
/**
* move the repeating group of columns to a new table
*
* @param string $repeatingColumns comma separated list of repeating group columns
* @param string $primaryColumns comma separated list of column in primary key
* of $table
* @param string $newTable name of the new table to be created
* @param string $newColumn name of the new column in the new table
* @param string $table current table
* @param string $db current database
*
* @return array{queryError: bool, message: Message}
*/
public function moveRepeatingGroup(
string $repeatingColumns,
string $primaryColumns,
string $newTable,
string $newColumn,
string $table,
string $db,
): array {
$repeatingColumnsArr = explode(', ', $repeatingColumns);
$primaryColumnsArray = explode(',', $primaryColumns);
$columns = [];
foreach ($primaryColumnsArray as $column) {
$columns[] = Util::backquote($column);
}
$primaryColumns = implode(',', $columns);
$query1 = 'CREATE TABLE ' . Util::backquote($newTable);
$query2 = 'ALTER TABLE ' . Util::backquote($table);
$message = Message::success(
sprintf(
__('Selected repeating group has been moved to the table \'%s\''),
htmlspecialchars($table),
),
);
$first = true;
$error = false;
foreach ($repeatingColumnsArr as $repeatingColumn) {
if (! $first) {
$query1 .= ' UNION ';
}
$first = false;
$quotedRepeatingColumn = Util::backquote($repeatingColumn);
$query1 .= ' SELECT ' . $primaryColumns . ',' . $quotedRepeatingColumn
. ' as ' . Util::backquote($newColumn)
. ' FROM ' . Util::backquote($table);
$query2 .= ' DROP ' . $quotedRepeatingColumn . ',';
}
$query2 = trim($query2, ',');
$queries = [$query1, $query2];
$this->dbi->selectDb($db);
foreach ($queries as $query) {
if (! $this->dbi->tryQuery($query)) {
$message = Message::error(__('Error in processing!'));
$message->addMessage(
Message::rawError($this->dbi->getError()),
'<br><br>',
);
$error = true;
break;
}
}
return ['queryError' => $error, 'message' => $message];
}
/**
* build html for 3NF step 1 to find the transitive dependencies
*
* @param string $db current database
* @param mixed[] $tables tables formed after 2NF and need to process for 3NF
*
* @return array{legendText: string, headText: string, subText: string, extra: string}
*/
public function getHtmlFor3NFstep1(string $db, array $tables): array
{
$legendText = __('Step 3.') . '1 ' . __('Find transitive dependencies');
$extra = '';
$headText = __('Please answer the following question(s) carefully to obtain a correct normalization.');
$subText = __(
'For each column below, '
. 'please select the <b>minimal set</b> of columns among given set '
. 'whose values combined together are sufficient'
. ' to determine the value of the column.<br>'
. 'Note: A column may have no transitive dependency, '
. 'in that case you don\'t have to select any.',
);
$cnt = 0;
$this->dbi->selectDb($db);
foreach ($tables as $table) {
$primary = Index::getPrimary($this->dbi, $table, $db);
$primarycols = $primary === null ? [] : $primary->getColumns();
$selectTdForm = '';
$pk = [];
foreach ($primarycols as $col) {
$pk[] = $col->getName();
}
$columns = $this->dbi->getColumnNames($db, $table);
if (count($columns) - count($pk) <= 1) {
continue;
}
foreach ($columns as $column) {
if (in_array($column, $pk, true)) {
continue;
}
$selectTdForm .= '<input type="checkbox" name="pd" value="'
. htmlspecialchars($column) . '">'
. '<span>' . htmlspecialchars($column) . '</span>';
}
foreach ($columns as $column) {
if (in_array($column, $pk, true)) {
continue;
}
$cnt++;
$extra .= '<b>' . sprintf(
__('\'%1$s\' depends on:'),
htmlspecialchars($column),
)
. '</b><br>';
$extra .= '<form id="td_' . $cnt . '" data-colname="'
. htmlspecialchars($column) . '" data-tablename="'
. htmlspecialchars($table) . '" class="smallIndent">'
. $selectTdForm
. '</form><br><br>';
}
}
if ($extra === '') {
$headText = __(
'No Transitive dependencies possible as the table doesn\'t have any non primary key columns',
);
$subText = '';
$extra = '<h3>' . __('Table is already in Third normal form!') . '</h3>';
}
return ['legendText' => $legendText, 'headText' => $headText, 'subText' => $subText, 'extra' => $extra];
}
/**
* find all the possible partial dependencies based on data in the table.
*
* @param string $table current table
* @param string $db current database
*
* @return string HTML containing the list of all the possible partial dependencies
*/
public function findPartialDependencies(string $table, string $db): string
{
$dependencyList = [];
$this->dbi->selectDb($db);
$columnNames = $this->dbi->getColumnNames($db, $table);
$columns = [];
foreach ($columnNames as $column) {
$columns[] = Util::backquote($column);
}
$totalRows = (int) $this->dbi->fetchValue(
'SELECT COUNT(*) FROM (SELECT * FROM '
. Util::backquote($table) . ' LIMIT 500) as dt;',
);
$primary = Index::getPrimary($this->dbi, $table, $db);
$primarycols = $primary === null ? [] : $primary->getColumns();
$pk = [];
foreach ($primarycols as $col) {
$pk[] = Util::backquote($col->getName());
}
$partialKeys = $this->getAllCombinationPartialKeys($pk);
$distinctValCount = $this->findDistinctValuesCount(
array_unique(
array_merge($columns, $partialKeys),
),
$table,
);
foreach ($columns as $column) {
if (in_array($column, $pk, true)) {
continue;
}
foreach ($partialKeys as $partialKey) {
if (
! $partialKey
|| ! $this->checkPartialDependency(
$partialKey,
$column,
$table,
$distinctValCount[$partialKey],
$distinctValCount[$column],
$totalRows,
)
) {
continue;
}
$dependencyList[$partialKey][] = $column;
}
}
$html = __('This list is based on a subset of the table\'s data and is not necessarily accurate. ')
. '<div class="dependencies_box">';
foreach ($dependencyList as $dependon => $colList) {
$html .= '<span class="d-block">'
. '<input type="button" class="btn btn-secondary pickPd" value="' . __('Pick') . '">'
. '<span class="determinants">'
. htmlspecialchars(str_replace('`', '', (string) $dependon)) . '</span> -> '
. '<span class="dependents">'
. htmlspecialchars(str_replace('`', '', implode(', ', $colList)))
. '</span>'
. '</span>';
}
if ($dependencyList === []) {
$html .= '<p class="d-block m-1">'
. __('No partial dependencies found!') . '</p>';
}
$html .= '</div>';
return $html;
}
/**
* check whether a particular column is dependent on given subset of primary key
*
* @param string $partialKey the partial key, subset of primary key,
* each column in key supposed to be backquoted
* @param string $column backquoted column on whose dependency being checked
* @param string $table current table
* @param int $pkCnt distinct value count for given partial key
* @param int $colCnt distinct value count for given column
* @param int $totalRows total distinct rows count of the table
*/
private function checkPartialDependency(
string $partialKey,
string $column,
string $table,
int $pkCnt,
int $colCnt,
int $totalRows,
): bool {
$query = 'SELECT '
. 'COUNT(DISTINCT ' . $partialKey . ',' . $column . ') as pkColCnt '
. 'FROM (SELECT * FROM ' . Util::backquote($table)
. ' LIMIT 500) as dt;';
$pkColCnt = (int) $this->dbi->fetchValue($query);
if ($pkCnt !== 0 && $pkCnt === $colCnt && $colCnt === $pkColCnt) {
return true;