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
|
<?php
/**
* Set of functions used to build YAML dumps of tables
*/
declare(strict_types=1);
namespace PhpMyAdmin\Plugins\Export;
use PhpMyAdmin\DatabaseInterface;
use PhpMyAdmin\FieldMetadata;
use PhpMyAdmin\Plugins\ExportPlugin;
use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyMainGroup;
use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyRootGroup;
use PhpMyAdmin\Properties\Options\Items\HiddenPropertyItem;
use PhpMyAdmin\Properties\Plugins\ExportPluginProperties;
use function __;
use function array_key_exists;
use function is_numeric;
use function str_replace;
use const PHP_EOL;
/**
* Handles the export for the YAML format
*/
class ExportYaml extends ExportPlugin
{
/**
* @psalm-return non-empty-lowercase-string
*/
public function getName(): string
{
return 'yaml';
}
protected function setProperties(): ExportPluginProperties
{
$exportPluginProperties = new ExportPluginProperties();
$exportPluginProperties->setText('YAML');
$exportPluginProperties->setExtension('yml');
$exportPluginProperties->setMimeType('text/yaml');
$exportPluginProperties->setForceFile(true);
$exportPluginProperties->setOptionsText(__('Options'));
// create the root group that will be the options field for
// $exportPluginProperties
// this will be shown as "Format specific options"
$exportSpecificOptions = new OptionsPropertyRootGroup('Format Specific Options');
// general options main group
$generalOptions = new OptionsPropertyMainGroup('general_opts');
// create primary items and add them to the group
$leaf = new HiddenPropertyItem('structure_or_data');
$generalOptions->addProperty($leaf);
// add the main group to the root group
$exportSpecificOptions->addProperty($generalOptions);
// set the options for the export plugin property item
$exportPluginProperties->setOptions($exportSpecificOptions);
return $exportPluginProperties;
}
/**
* Outputs export header
*/
public function exportHeader(): bool
{
$this->export->outputHandler('%YAML 1.1' . PHP_EOL . '---' . PHP_EOL);
return true;
}
/**
* Outputs export footer
*/
public function exportFooter(): bool
{
$this->export->outputHandler('...' . PHP_EOL);
return true;
}
/**
* Outputs database header
*
* @param string $db Database name
* @param string $dbAlias Aliases of db
*/
public function exportDBHeader($db, $dbAlias = ''): bool
{
return true;
}
/**
* Outputs database footer
*
* @param string $db Database name
*/
public function exportDBFooter($db): bool
{
return true;
}
/**
* Outputs CREATE DATABASE statement
*
* @param string $db Database name
* @param string $exportType 'server', 'database', 'table'
* @param string $dbAlias Aliases of db
*/
public function exportDBCreate($db, $exportType, $dbAlias = ''): bool
{
return true;
}
/**
* Outputs the content of a table in JSON format
*
* @param string $db database name
* @param string $table table name
* @param string $errorUrl the url to go back in case of error
* @param string $sqlQuery SQL query for obtaining data
* @param array $aliases Aliases of db/table/columns
*/
public function exportData(
$db,
$table,
$errorUrl,
$sqlQuery,
array $aliases = []
): bool {
$db_alias = $db;
$table_alias = $table;
$this->initAlias($aliases, $db_alias, $table_alias);
$result = $GLOBALS['dbi']->query(
$sqlQuery,
DatabaseInterface::CONNECT_USER,
DatabaseInterface::QUERY_UNBUFFERED
);
$columns_cnt = $result->numFields();
$fieldsMeta = $GLOBALS['dbi']->getFieldsMeta($result);
$columns = [];
foreach ($fieldsMeta as $i => $field) {
$col_as = $field->name;
if (! empty($aliases[$db]['tables'][$table]['columns'][$col_as])) {
$col_as = $aliases[$db]['tables'][$table]['columns'][$col_as];
}
$columns[$i] = $col_as;
}
$record_cnt = 0;
while ($record = $result->fetchRow()) {
$record_cnt++;
// Output table name as comment if this is the first record of the table
if ($record_cnt == 1) {
$buffer = '# ' . $db_alias . '.' . $table_alias . PHP_EOL;
$buffer .= '-' . PHP_EOL;
} else {
$buffer = '-' . PHP_EOL;
}
for ($i = 0; $i < $columns_cnt; $i++) {
if (! array_key_exists($i, $record)) {
continue;
}
if ($record[$i] === null) {
$buffer .= ' ' . $columns[$i] . ': null' . PHP_EOL;
continue;
}
$isNotString = isset($fieldsMeta[$i]) && $fieldsMeta[$i]->isNotType(FieldMetadata::TYPE_STRING);
if (is_numeric($record[$i]) && $isNotString) {
$buffer .= ' ' . $columns[$i] . ': ' . $record[$i] . PHP_EOL;
continue;
}
$record[$i] = str_replace(
[
'\\',
'"',
"\n",
"\r",
],
[
'\\\\',
'\"',
'\n',
'\r',
],
$record[$i]
);
$buffer .= ' ' . $columns[$i] . ': "' . $record[$i] . '"' . PHP_EOL;
}
if (! $this->export->outputHandler($buffer)) {
return false;
}
}
return true;
}
/**
* Outputs result raw query in YAML format
*
* @param string $errorUrl the url to go back in case of error
* @param string $sqlQuery the rawquery to output
*/
public function exportRawQuery(string $errorUrl, string $sqlQuery): bool
{
return $this->exportData('', '', $errorUrl, $sqlQuery);
}
}
|
