Add SQLite database application ID and new consistent file extension

Author: zaerl

composer.json

@@ -65,7 +65,7 @@
 		],
 		"wp-test-php": [
 			"@wp-test-ensure-env @no_additional_args",
-			"rm -rf wordpress/src/wp-content/database/.ht.sqlite @no_additional_args",
+			"rm -rf wordpress/src/wp-content/database/.ht.sqlite.php @no_additional_args",
 			"npm --prefix wordpress run test:php -- @additional_args"
 		],
 		"wp-test-e2e": [
@@ -74,7 +74,7 @@
 		],
 		"wp-test-clean": [
 			"npm --prefix wordpress run env:clean",
-			"rm -rf wordpress/src/wp-content/database/.ht.sqlite"
+			"rm -rf wordpress/src/wp-content/database/.ht.sqlite.php"
 		]
 	}
 }

constants.php

@@ -48,10 +48,20 @@
 	if ( defined( 'DB_FILE' ) ) {
 		define( 'FQDB', FQDBDIR . DB_FILE );
 	} else {
-		define( 'FQDB', FQDBDIR . '.ht.sqlite' );
+		define( 'FQDB', FQDBDIR . '.ht.sqlite.php' );
 	}
 }
 
+/**
+ * The application ID identifying an SQLite database created by this driver.
+ *
+ * This value is stored in the SQLite database file header and can be used to
+ * identify databases managed by this driver.
+ *
+ * See: https://www.sqlite.org/pragma.html#pragma_application_id
+ */
+define( 'SQLITE_DB_APPLICATION_ID', 3948349 );
+
 // Allow enabling the SQLite AST driver via environment variable.
 if ( ! defined( 'WP_SQLITE_AST_DRIVER' ) && isset( $_ENV['WP_SQLITE_AST_DRIVER'] ) && 'true' === $_ENV['WP_SQLITE_AST_DRIVER'] ) {
 	define( 'WP_SQLITE_AST_DRIVER', true );

tests/WP_SQLite_Driver_Tests.php

@@ -51,6 +51,11 @@ private function assertQueryError( $sql, $error_message ) {
 		$this->assertSame( $error_message, $exception->getMessage() );
 	}
 
+	public function testApplicationID() {
+		$app_id = $this->sqlite->query( 'PRAGMA application_id' )->fetchColumn();
+		$this->assertSame( SQLITE_DB_APPLICATION_ID, (int) $app_id );
+	}
+
 	public function testRegexp() {
 		$this->assertQuery(
 			"INSERT INTO _options (option_name, option_value) VALUES ('rss_0123456789abcdef0123456789abcdef', '1');"

tests/WP_SQLite_Translator_Tests.php

@@ -57,6 +57,11 @@ private function assertQuery( $sql, $error_substring = null ) {
 		return $retval;
 	}
 
+	public function testApplicationID() {
+		$app_id = $this->sqlite->query( 'PRAGMA application_id' )->fetchColumn();
+		$this->assertSame( SQLITE_DB_APPLICATION_ID, (int) $app_id );
+	}
+
 	public function testRegexp() {
 		$this->assertQuery(
 			"INSERT INTO _options (option_name, option_value) VALUES ('rss_0123456789abcdef0123456789abcdef', '1');"

tests/bootstrap.php

@@ -1,6 +1,12 @@
 <?php
 
+// Configure the test environment.
+error_reporting( E_ALL );
+define( 'FQDB', ':memory:' );
+define( 'FQDBDIR', __DIR__ . '/../testdb' );
+
 require_once __DIR__ . '/wp-sqlite-schema.php';
+require_once __DIR__ . '/../constants.php';
 require_once __DIR__ . '/../wp-pdo-mysql-on-sqlite.php';
 require_once __DIR__ . '/../wp-includes/sqlite/class-wp-sqlite-query-rewriter.php';
 require_once __DIR__ . '/../wp-includes/sqlite/class-wp-sqlite-lexer.php';
@@ -14,11 +20,6 @@
 	define( 'WP_SQLITE_UNSAFE_ENABLE_UNSUPPORTED_VERSIONS', true );
 }
 
-// Configure the test environment.
-error_reporting( E_ALL );
-define( 'FQDB', ':memory:' );
-define( 'FQDBDIR', __DIR__ . '/../testdb' );
-
 // Polyfill WPDB globals.
 $GLOBALS['table_prefix'] = 'wptests_';
 $GLOBALS['wpdb']         = new class() {

wp-includes/sqlite-ast/class-wp-sqlite-connection.php

@@ -96,6 +96,9 @@ public function __construct( array $options ) {
 		if ( $journal_mode && in_array( $journal_mode, self::SQLITE_JOURNAL_MODES, true ) ) {
 			$this->query( 'PRAGMA journal_mode = ' . $journal_mode );
 		}
+
+		// Set the application ID to identify this as a WordPress SQLite database.
+		$this->query( 'PRAGMA application_id = ' . SQLITE_DB_APPLICATION_ID );
 	}
 
 	/**

wp-includes/sqlite/class-wp-sqlite-db.php

@@ -306,6 +306,24 @@ public function db_connect( $allow_bail = true ) {
 		if ( isset( $GLOBALS['@pdo'] ) ) {
 			$pdo = $GLOBALS['@pdo'];
 		}
+
+		// Migrate the database file from the legacy default name (".ht.sqlite") to
+		// the new default name (".ht.sqlite.php"). This only runs when using the
+		// default file name and the new file does not already exist.
+		if ( ! defined( 'DB_FILE' ) && ! file_exists( FQDB ) ) {
+			$old_db_path = FQDBDIR . '.ht.sqlite';
+
+			if ( file_exists( $old_db_path ) ) {
+				rename( $old_db_path, FQDB );
+
+				foreach ( array( '-wal', '-shm' ) as $suffix ) {
+					if ( file_exists( $old_db_path . $suffix ) ) {
+						rename( $old_db_path . $suffix, FQDB . $suffix );
+					}
+				}
+			}
+		}
+
 		if ( defined( 'WP_SQLITE_AST_DRIVER' ) && WP_SQLITE_AST_DRIVER ) {
 			if ( null === $this->dbname || '' === $this->dbname ) {
 				$this->bail(

wp-includes/sqlite/class-wp-sqlite-translator.php

@@ -427,6 +427,9 @@ public function __construct( $pdo = null ) {
 		if ( defined( 'SQLITE_JOURNAL_MODE' ) && in_array( SQLITE_JOURNAL_MODE, $valid_journal_modes, true ) ) {
 			$this->pdo->query( 'PRAGMA journal_mode = ' . SQLITE_JOURNAL_MODE );
 		}
+
+		// Set the application ID to identify this as a WordPress SQLite database.
+		$this->pdo->query( 'PRAGMA application_id = ' . SQLITE_DB_APPLICATION_ID );
 	}
 
 	/**