Repository navigation
Expand file tree
/
Copy pathDB_Command_SQLite.php
More file actions
619 lines (500 loc) · 17.8 KB
/
Copy pathDB_Command_SQLite.php
File metadata and controls
619 lines (500 loc) · 17.8 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
<?php
use WP_CLI\Formatter;
use WP_CLI\Utils;
/**
* SQLite-specific database operations for DB_Command.
*
* This trait provides SQLite-specific implementations for database operations
* that would otherwise use MySQL/MariaDB binaries.
*/
trait DB_Command_SQLite {
/**
* Check if sqlite3 CLI binary is available.
*
* @return bool True if sqlite3 is available, false otherwise.
*/
protected function is_sqlite3_available() {
static $available = null;
if ( null === $available ) {
$result = \WP_CLI\Process::create( Utils\force_env_on_nix_systems( 'sqlite3' ) . ' --version', null, null )->run();
$available = 0 === $result->return_code;
}
return $available;
}
/**
* Check if SQLite is being used.
*
* @return bool True if SQLite is detected, false otherwise.
*/
protected function is_sqlite() {
// Check if DB_ENGINE constant is defined and set to 'sqlite'.
if ( defined( 'DB_ENGINE' ) && 'sqlite' === DB_ENGINE ) {
return true;
}
// Check if the SQLite drop-in is loaded by looking for SQLITE_DB_DROPIN_VERSION constant.
if ( defined( 'SQLITE_DB_DROPIN_VERSION' ) ) {
return true;
}
// Check if db.php drop-in exists and contains SQLite markers.
$wp_content_dir = defined( 'WP_CONTENT_DIR' ) ? WP_CONTENT_DIR : ABSPATH . 'wp-content';
$db_dropin_path = $wp_content_dir . '/db.php';
if ( file_exists( $db_dropin_path ) ) {
$db_dropin_contents = file_get_contents( $db_dropin_path );
if ( false !== $db_dropin_contents && false !== strpos( $db_dropin_contents, 'SQLITE_DB_DROPIN_VERSION' ) ) {
return true;
}
}
return false;
}
/**
* Get the path to the SQLite database file.
*
* @return string|false Path to SQLite database file, or false if not found.
*/
protected function get_sqlite_db_path() {
if ( defined( 'DB_PATH' ) ) {
if ( ':memory:' === DB_PATH ) {
WP_CLI::error( 'This command does not support in-memory SQLite databases.' );
}
return DB_PATH;
}
// Check for FQDB constant (fully qualified database path).
if ( defined( 'FQDB' ) ) {
if ( ':memory:' === FQDB ) {
WP_CLI::error( 'This command does not support in-memory SQLite databases.' );
}
return FQDB;
}
$wp_content_dir = defined( 'WP_CONTENT_DIR' ) ? WP_CONTENT_DIR : ABSPATH . 'wp-content';
// Check for FQDBDIR and construct path.
$db_dir = defined( 'FQDBDIR' ) ? FQDBDIR : $wp_content_dir . '/database';
$db_file = defined( 'DB_FILE' ) ? DB_FILE : '.ht.sqlite';
$db_path = rtrim( $db_dir, '/' ) . '/' . ltrim( $db_file, '/' );
// If the file exists, return it.
if ( file_exists( $db_path ) ) {
return $db_path;
}
// Try alternative common locations.
$alt_paths = [
$wp_content_dir . '/database/.ht.sqlite',
$wp_content_dir . '/.ht.sqlite',
ABSPATH . '.ht.sqlite',
];
foreach ( $alt_paths as $alt_path ) {
if ( file_exists( $alt_path ) ) {
return $alt_path;
}
}
// Return the default expected path even if it doesn't exist yet.
return $db_path;
}
/**
* Create SQLite database.
*/
protected function sqlite_create() {
$db_path = $this->get_sqlite_db_path();
if ( ! $db_path ) {
WP_CLI::error( 'Could not determine the database path.' );
}
$db_dir = dirname( $db_path );
if ( ! is_dir( $db_dir ) ) {
if ( ! mkdir( $db_dir, 0755, true ) ) {
WP_CLI::error( "Could not create directory: {$db_dir}" );
}
}
if ( file_exists( $db_path ) ) {
WP_CLI::error( 'Database already exists.' );
}
if ( ! $this->is_sqlite3_available() ) {
WP_CLI::error( 'The sqlite3 CLI binary is required but not found. Please install SQLite3.' );
}
$command = Utils\esc_cmd( 'sqlite3 %s %s', $db_path, '' );
WP_CLI::debug( "Running shell command: {$command}", 'db' );
$result = \WP_CLI\Process::create( $command, null, null )->run();
if ( 0 !== $result->return_code ) {
WP_CLI::error( 'Could not create database' );
}
WP_CLI::success( 'Database created.' );
}
/**
* Drop SQLite database.
*/
protected function sqlite_drop() {
$db_path = $this->get_sqlite_db_path();
if ( ! $db_path ) {
WP_CLI::error( 'Could not determine the database path.' );
}
if ( ! file_exists( $db_path ) ) {
WP_CLI::error( 'Database does not exist.' );
}
global $wpdb;
if ( $wpdb instanceof \wpdb ) {
$wpdb->close();
}
if ( ! @unlink( $db_path ) ) {
WP_CLI::error( "Could not delete database file: {$db_path}" );
}
WP_CLI::success( 'Database dropped.' );
}
/**
* Reset SQLite database.
*/
protected function sqlite_reset() {
$db_path = $this->get_sqlite_db_path();
if ( ! $db_path ) {
WP_CLI::error( 'Could not determine the database path.' );
}
// Delete if exists.
if ( file_exists( $db_path ) ) {
global $wpdb;
if ( $wpdb instanceof \wpdb ) {
$wpdb->close();
}
if ( ! @unlink( $db_path ) ) {
WP_CLI::error( "Could not delete database file: {$db_path}" );
}
}
// Create directory if needed.
$db_dir = dirname( $db_path );
if ( ! is_dir( $db_dir ) ) {
if ( ! mkdir( $db_dir, 0755, true ) ) {
WP_CLI::error( "Could not create directory: {$db_dir}" );
}
}
if ( ! $this->is_sqlite3_available() ) {
WP_CLI::error( 'The sqlite3 CLI binary is required but not found. Please install SQLite3.' );
}
$command = Utils\esc_cmd( 'sqlite3 %s %s', $db_path, '' );
WP_CLI::debug( "Running shell command: {$command}", 'db' );
$result = \WP_CLI\Process::create( $command, null, null )->run();
if ( 0 !== $result->return_code ) {
WP_CLI::error( 'Could not create database' );
}
WP_CLI::success( 'Database reset.' );
}
/**
* Execute a query against the SQLite database.
*
* @param string $query SQL query to execute.
* @param array $assoc_args Associative arguments.
*/
protected function sqlite_query( $query, $assoc_args = [] ) {
global $wpdb;
if ( ! isset( $wpdb ) || ! $wpdb instanceof \WP_SQLite_DB ) {
WP_CLI::error( 'SQLite database not available.' );
}
/*
* Strip redundant trailing semicolons and whitespace.
*
* The MySQL client silently ignores the empty statements they produce,
* whereas the SQLite drop-in parses them as a multi-query and bails out
* with "Multi-query is not supported.". Trim them for parity.
*/
$query = rtrim( $query, "; \t\n\r\0\x0B" );
if ( '' === $query ) {
WP_CLI::error( 'No query specified.' );
}
$skip_column_names = Utils\get_flag_value( $assoc_args, 'skip-column-names', false );
try {
$is_row_modifying_query = preg_match( '/\b(UPDATE|DELETE|INSERT|REPLACE)\b/i', $query );
if ( $is_row_modifying_query ) {
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$affected_rows = $wpdb->query( $query );
if ( false === $affected_rows ) {
// phpcs:ignore WordPress.WP.AlternativeFunctions.strip_tags_strip_tags
WP_CLI::error( 'Query failed: ' . strip_tags( $wpdb->last_error ) );
}
WP_CLI::success( "Query succeeded. Rows affected: {$affected_rows}" );
} else {
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$results = $wpdb->get_results( $query, ARRAY_A );
if ( $wpdb->last_error ) {
// phpcs:ignore WordPress.WP.AlternativeFunctions.strip_tags_strip_tags
WP_CLI::error( 'Query failed: ' . strip_tags( $wpdb->last_error ) );
}
if ( empty( $results ) ) {
// No results to display.
return;
}
// Display results using the Formatter class.
$headers = array_keys( $results[0] );
$this->display_query_results( $headers, $results, $skip_column_names );
}
} catch ( Exception $e ) {
WP_CLI::error( 'Query failed: ' . $e->getMessage() );
}
}
/**
* Display query results using the Formatter class.
*
* @param array $headers Column headers.
* @param array $rows Data rows.
* @param bool $skip_column_names Whether to skip displaying column names.
*/
protected function display_query_results( $headers, $rows, $skip_column_names = false ) {
if ( $skip_column_names ) {
// Display rows without headers - just the values.
foreach ( $rows as $row ) {
WP_CLI::line( implode( "\t", array_values( $row ) ) );
}
} else {
// Use the Formatter class to display results as a table.
$assoc_args = [];
$formatter = new Formatter( $assoc_args, $headers );
$formatter->display_items( $rows );
}
}
/**
* Export SQLite database.
*
* @param string $file Output file path.
* @param array $assoc_args Associative arguments.
*/
protected function sqlite_export( $file, $assoc_args ) {
$db_path = $this->get_sqlite_db_path();
if ( ! $db_path ) {
WP_CLI::error( 'Could not determine the database path.' );
}
if ( ! file_exists( $db_path ) ) {
WP_CLI::error( 'Database does not exist.' );
}
if ( ! $this->is_sqlite3_available() ) {
WP_CLI::error( 'The sqlite3 binary could not be found. Please install sqlite3 to use the export command.' );
}
$temp_db = tempnam( sys_get_temp_dir(), 'temp.db' );
if ( false === $temp_db ) {
WP_CLI::error( 'Could not create temporary database file for export.' );
}
$temp_db = str_replace( '\\', '/', $temp_db );
if ( ! copy( $db_path, $temp_db ) ) {
// Clean up temporary file if the copy operation fails.
unlink( $temp_db );
WP_CLI::error( 'Could not copy database to temporary file for export.' );
}
$exclude_tables = [];
// When passing --tables, exclude everything *except* the tables requested.
if ( isset( $assoc_args['tables'] ) ) {
$include_tables = explode( ',', trim( $assoc_args['tables'], ',' ) );
unset( $assoc_args['tables'] );
// Use the sqlite3 binary to fetch all table names
$query = "SELECT name FROM sqlite_master WHERE type='table' AND name NOT LIKE 'sqlite_%';";
// Build the command safely
$command = 'sqlite3 ' . escapeshellarg( $temp_db ) . ' ' . escapeshellarg( $query );
WP_CLI::debug( "Running shell command: {$command}", 'db' );
$result = \WP_CLI\Process::create( $command, null, null )->run();
if ( 0 !== $result->return_code ) {
WP_CLI::error( 'Could not export database' );
}
$all_tables = array_map( 'trim', explode( "\n", $result->stdout ) );
$all_tables = array_filter( $all_tables );
$exclude_tables = array_diff( $all_tables, $include_tables );
}
if ( isset( $assoc_args['exclude_tables'] ) ) {
$exclude_tables = explode( ',', trim( $assoc_args['exclude_tables'], ',' ) );
unset( $assoc_args['exclude_tables'] );
}
// Always exclude this one created by the drop-in.
$exclude_tables[] = '_mysql_data_types_cache';
$exclude_tables = array_unique( array_filter( $exclude_tables ) );
// Build DROP TABLE statements with safely-escaped identifiers.
$drop_statements = array();
foreach ( $exclude_tables as $table ) {
$escaped_identifier = '"' . str_replace( '"', '""', $table ) . '"';
$drop_statements[] = sprintf( 'DROP TABLE %s;', $escaped_identifier );
}
$init_file = tempnam( sys_get_temp_dir(), 'export_init' );
if ( false === $init_file ) {
if ( file_exists( $temp_db ) ) {
unlink( $temp_db );
}
WP_CLI::error( 'Failed to create temporary SQLite init file for export.' );
}
$init_file = str_replace( '\\', '/', $init_file );
$init_contents = '';
if ( ! empty( $drop_statements ) ) {
$init_contents .= implode( "\n", $drop_statements ) . "\n";
}
$init_contents .= ".dump\n";
$bytes_written = file_put_contents( $init_file, $init_contents );
if ( false === $bytes_written ) {
if ( file_exists( $init_file ) ) {
unlink( $init_file );
}
if ( file_exists( $temp_db ) ) {
unlink( $temp_db );
}
WP_CLI::error( 'Could not export database' );
}
$command = Utils\esc_cmd( 'sqlite3 -init %s %s .exit', $init_file, $temp_db );
WP_CLI::debug( "Running shell command: {$command}", 'db' );
$result = \WP_CLI\Process::create( $command, null, null )->run();
if ( file_exists( $init_file ) ) {
unlink( $init_file );
}
if ( 0 !== $result->return_code ) {
if ( file_exists( $temp_db ) ) {
unlink( $temp_db );
}
WP_CLI::error( 'Could not export database' );
}
$stdout = ( '-' === $file );
if ( $stdout ) {
WP_CLI::line( $result->stdout );
} elseif ( false === file_put_contents( $file, $result->stdout ) ) {
// Clean up temporary file and surface a clear error if the export cannot be written.
if ( file_exists( $temp_db ) ) {
unlink( $temp_db );
}
WP_CLI::error( "Could not write exported database to '{$file}'. Please check that the path is writable." );
}
unlink( $temp_db );
if ( ! $stdout ) {
if ( isset( $assoc_args['porcelain'] ) ) {
WP_CLI::line( $file );
} else {
WP_CLI::success( "Exported to '{$file}'." );
}
}
}
/**
* Import SQL into SQLite database.
*
* @param string $file Input file path.
* @param array $assoc_args Associative arguments.
*/
protected function sqlite_import( $file, $assoc_args ) {
$db_path = $this->get_sqlite_db_path();
if ( ! $db_path ) {
WP_CLI::error( 'Could not determine the database path.' );
}
$db_path = str_replace( '\\', '/', $db_path );
if ( ! file_exists( $db_path ) ) {
WP_CLI::error( 'Database does not exist.' );
}
if ( ! $this->is_sqlite3_available() ) {
WP_CLI::error( 'The sqlite3 CLI binary could not be found. Please ensure it is installed and available on your PATH.' );
}
if ( '-' === $file ) {
$contents = file_get_contents( 'php://stdin' );
if ( false === $contents ) {
WP_CLI::error( 'Failed to read from stdin.' );
}
$file = 'STDIN';
} elseif ( ! is_readable( $file ) ) {
WP_CLI::error( sprintf( 'Import file missing or not readable: %s', $file ) );
} else {
$contents = (string) file_get_contents( $file );
}
if ( preg_match( '/^[ \t]*\.(?![0-9])/m', $contents ) ) {
WP_CLI::error( 'SQLite dot-commands are not allowed in import files.' );
}
// Ignore errors about unique constraints and existing indexes.
$contents = str_replace( 'INSERT INTO', 'INSERT OR IGNORE INTO', $contents );
$contents = preg_replace( '/\bCREATE TABLE (?!IF NOT EXISTS\b)/i', 'CREATE TABLE IF NOT EXISTS ', $contents );
$contents = preg_replace( '/\bCREATE TRIGGER (?!IF NOT EXISTS\b)/i', 'CREATE TRIGGER IF NOT EXISTS ', (string) $contents );
$contents = preg_replace( '/\bCREATE VIEW (?!IF NOT EXISTS\b)/i', 'CREATE VIEW IF NOT EXISTS ', (string) $contents );
$contents = preg_replace( '/\bCREATE INDEX (?!IF NOT EXISTS\b)/i', 'CREATE INDEX IF NOT EXISTS ', (string) $contents );
$contents = preg_replace( '/\bCREATE UNIQUE INDEX (?!IF NOT EXISTS\b)/i', 'CREATE UNIQUE INDEX IF NOT EXISTS ', (string) $contents );
$import_file = tempnam( sys_get_temp_dir(), 'temp.db' );
if ( false === $import_file ) {
WP_CLI::error( 'Failed to create a temporary file for SQLite import.' );
}
$import_file = str_replace( '\\', '/', $import_file );
$bytes_written = file_put_contents( $import_file, $contents );
if ( false === $bytes_written ) {
if ( file_exists( $import_file ) ) {
unlink( $import_file );
}
WP_CLI::error( sprintf( 'Failed to write SQLite import data to temporary file: %s', $import_file ) );
}
// Build sqlite3 command.
$command_parts = [ 'sqlite3' ];
if ( ! Utils\get_flag_value( $assoc_args, 'skip-optimization' ) ) {
$command_parts[] = '-cmd';
$command_parts[] = 'PRAGMA foreign_keys=OFF;';
$command_parts[] = '-cmd';
$command_parts[] = 'PRAGMA ignore_check_constraints=ON;';
$command_parts[] = '-cmd';
$command_parts[] = 'PRAGMA synchronous=OFF;';
$command_parts[] = '-cmd';
$command_parts[] = 'PRAGMA journal_mode=MEMORY;';
}
$command_parts[] = '-init';
$command_parts[] = $import_file;
$command_parts[] = $db_path;
// Build a properly escaped string command. Process::create() requires a string, not an array.
$command = Utils\esc_cmd(
implode( ' ', array_fill( 0, count( $command_parts ), '%s' ) ),
...$command_parts
);
// Pass .exit to quit interactive mode after running -init.
$command .= ' ' . escapeshellarg( '.exit' );
WP_CLI::debug( "Running shell command: {$command}", 'db' );
$result = \WP_CLI\Process::create( $command, null, null )->run();
unlink( $import_file );
if ( 0 !== $result->return_code ) {
WP_CLI::error( 'Could not import database.' );
}
WP_CLI::success( sprintf( "Imported from '%s'.", $file ) );
}
/**
* Get SQLite database size.
*
* @return int Database file size in bytes, or 0 if not found.
*/
protected function sqlite_size() {
$db_path = $this->get_sqlite_db_path();
if ( ! $db_path || ! file_exists( $db_path ) ) {
return 0;
}
$size = filesize( $db_path );
if ( false === $size ) {
return 0;
}
return $size;
}
/**
* Load WordPress db.php drop-in if SQLite is detected.
*
* This should be called early in commands that run at after_wp_config_load.
*/
protected function maybe_load_sqlite_dropin() {
if ( ! $this->is_sqlite() ) {
return;
}
// Check if already loaded.
if ( defined( 'SQLITE_DB_DROPIN_VERSION' ) ) {
return;
}
$wp_content_dir = defined( 'WP_CONTENT_DIR' ) ? WP_CONTENT_DIR : ABSPATH . 'wp-content';
$db_dropin_path = $wp_content_dir . '/db.php';
if ( ! file_exists( $db_dropin_path ) ) {
return;
}
// Constants used in wp-includes/functions.php
if ( ! defined( 'WPINC' ) ) {
// phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedConstantFound
define( 'WPINC', 'wp-includes' );
}
if ( ! defined( 'WP_CONTENT_DIR' ) ) {
define( 'WP_CONTENT_DIR', ABSPATH . 'wp-content' );
}
// Load required WordPress files if not already loaded.
if ( ! function_exists( 'add_action' ) ) {
$required_files = [
ABSPATH . WPINC . '/compat.php',
ABSPATH . WPINC . '/plugin.php',
// Defines `wp_debug_backtrace_summary()` as used by wpdb.
ABSPATH . WPINC . '/functions.php',
ABSPATH . WPINC . '/class-wpdb.php',
];
foreach ( $required_files as $required_file ) {
if ( file_exists( $required_file ) ) {
require_once $required_file;
}
}
}
// Load the db.php drop-in.
require_once $db_dropin_path;
}
}