class-sqlitefilesystem.php — Jetpack – WP Security, Backup, Speed, & Growth 16.1-beta.2

jetpack / vendor / wp-php-toolkit / filesystem / class-sqlitefilesystem.php

jetpack / vendor / wp-php-toolkit / filesystem Last commit date

ByteStream 6 days ago Layer 6 days ago Mixin 6 days ago Path 6 days ago Visitor 6 days ago LICENSE.md 6 days ago README.md 6 days ago class-filesystemexception.php 6 days ago class-inmemoryfilesystem.php 6 days ago class-localfilesystem.php 6 days ago class-sqlitefilesystem.php 6 days ago class-uploadedfilesystem.php 6 days ago composer.json 6 days ago functions.php 6 days ago interface-filesystem.php 6 days ago

class-sqlitefilesystem.php

410 lines

1	<?php
2
3	namespace WordPress\Filesystem;
4
5	use Exception;
6	use SQLite3;
7	use WordPress\ByteStream\MemoryPipe;
8	use WordPress\ByteStream\ReadStream\ByteReadStream;
9	use WordPress\Filesystem\Layer\ChrootLayer;
10	use WordPress\Filesystem\Mixin\BufferedWriteStreamViaPutContents;
11	use WordPress\Filesystem\Mixin\CopyRecursiveViaStreaming;
12	use WordPress\Filesystem\Mixin\MkdirRecursive;
13
14	/**
15	* Stores files in SQLite database.
16	*/
17	class SQLiteFilesystem implements Filesystem {
18
19	use BufferedWriteStreamViaPutContents;
20	use MkdirRecursive;
21	use CopyRecursiveViaStreaming;
22
23	private $db;
24	private $transaction_level = 0;
25
26	public static function create( $db_path = ':memory:' ) {
27	return new ChrootLayer(
28	new SQLiteFilesystem( $db_path ),
29	'/'
30	);
31	}
32
33	public function get_root(): string {
34	return '/';
35	}
36
37	private function __construct( $db_path ) {
38	$this->db = new SQLite3( $db_path );
39	$this->db->exec(
40	'
41	CREATE TABLE IF NOT EXISTS files (
42	path TEXT PRIMARY KEY,
43	type TEXT NOT NULL,
44	contents BLOB
45	);
46	CREATE TABLE IF NOT EXISTS directory_entries (
47	parent_path TEXT,
48	name TEXT,
49	PRIMARY KEY (parent_path, name)
50	);
51	'
52	);
53
54	// Create root directory if it doesn't exist.
55	$stmt = $this->db->prepare( 'INSERT OR IGNORE INTO files (path, type) VALUES (?, ?)' );
56	$stmt->bindValue( 1, '/', SQLITE3_TEXT );
57	$stmt->bindValue( 2, 'dir', SQLITE3_TEXT );
58	$stmt->execute();
59	}
60
61	public function ls( $path = '/' ) {
62	$stmt = $this->db->prepare(
63	'
64	SELECT name FROM directory_entries
65	WHERE parent_path = ?
66	'
67	);
68	$stmt->bindValue( 1, $path, SQLITE3_TEXT );
69	$result = $stmt->execute();
70
71	$entries = array();
72	while ( $row = $result->fetchArray( SQLITE3_ASSOC ) ) {
73	$entries[] = $row['name'];
74	}
75
76	return $entries;
77	}
78
79	public function is_dir( $path ) {
80	$stmt = $this->db->prepare(
81	'
82	SELECT type FROM files
83	WHERE path = ? AND type = ?
84	'
85	);
86	$stmt->bindValue( 1, $path, SQLITE3_TEXT );
87	$stmt->bindValue( 2, 'dir', SQLITE3_TEXT );
88	$result = $stmt->execute();
89
90	return false !== $result->fetchArray();
91	}
92
93	public function is_file( $path ) {
94	$stmt = $this->db->prepare(
95	'
96	SELECT type FROM files
97	WHERE path = ? AND type = ?
98	'
99	);
100	$stmt->bindValue( 1, $path, SQLITE3_TEXT );
101	$stmt->bindValue( 2, 'file', SQLITE3_TEXT );
102	$result = $stmt->execute();
103
104	return false !== $result->fetchArray();
105	}
106
107	public function exists( $path ) {
108	$stmt = $this->db->prepare(
109	'
110	SELECT 1 FROM files
111	WHERE path = ?
112	'
113	);
114	$stmt->bindValue( 1, $path, SQLITE3_TEXT );
115	$result = $stmt->execute();
116
117	return false !== $result->fetchArray();
118	}
119
120	public function open_read_stream( $path ): ByteReadStream {
121	return new MemoryPipe( $this->get_contents( $path ) );
122	}
123
124	public function get_contents( $path ) {
125	if ( ! $this->is_file( $path ) ) {
126	throw new FilesystemException(
127	sprintf( 'File not found: %s', $path )
128	);
129	}
130	$stmt = $this->db->prepare( 'SELECT contents FROM files WHERE path = ?' );
131	$stmt->bindValue( 1, $path, SQLITE3_TEXT );
132	$result = $stmt->execute();
133	$row = $result->fetchArray( SQLITE3_ASSOC );
134
135	return $row['contents'];
136	}
137
138	public function rename( $from_path, $to_path, $options = array() ) {
139	if ( ! $this->exists( $from_path ) ) {
140	throw new FilesystemException(
141	sprintf( 'File not found: %s', $from_path )
142	);
143	}
144
145	$parent = wp_unix_dirname( $to_path );
146	if ( ! $this->is_dir( $parent ) ) {
147	throw new FilesystemException(
148	sprintf( 'Parent directory not found: %s', $parent )
149	);
150	}
151
152	try {
153	$this->in_transaction(
154	function () use ( $from_path, $to_path ) {
155	// Update the file path.
156	$stmt = $this->db->prepare( 'UPDATE files SET path = ? WHERE path = ?' );
157	$stmt->bindValue( 1, $to_path, SQLITE3_TEXT );
158	$stmt->bindValue( 2, $from_path, SQLITE3_TEXT );
159	$stmt->execute();
160
161	// Update directory entries.
162	$old_parent = wp_unix_dirname( $from_path );
163	$parent = wp_unix_dirname( $to_path );
164
165	$stmt = $this->db->prepare(
166	'
167	DELETE FROM directory_entries
168	WHERE parent_path = ? AND name = ?
169	'
170	);
171	$stmt->bindValue( 1, $old_parent, SQLITE3_TEXT );
172	$stmt->bindValue( 2, basename( $from_path ), SQLITE3_TEXT );
173	$stmt->execute();
174
175	$stmt = $this->db->prepare(
176	'
177	INSERT INTO directory_entries (parent_path, name)
178	VALUES (?, ?)
179	'
180	);
181	$stmt->bindValue( 1, $parent, SQLITE3_TEXT );
182	$stmt->bindValue( 2, basename( $to_path ), SQLITE3_TEXT );
183	$stmt->execute();
184	}
185	);
186
187	return true;
188	} catch ( Exception $e ) {
189	throw new FilesystemException(
190	sprintf( 'Failed to rename file: %s to %s', $from_path, $to_path ),
191	0,
192	$e
193	);
194	}
195	}
196
197	public function mkdir_single( $path, $options = array() ) {
198	if ( $this->exists( $path ) ) {
199	throw new FilesystemException(
200	sprintf( 'Directory already exists: %s', $path )
201	);
202	}
203
204	$parent = wp_unix_dirname( $path );
205	if ( ! $this->is_dir( $parent ) ) {
206	throw new FilesystemException(
207	sprintf( 'Parent directory not found: %s', $parent )
208	);
209	}
210
211	try {
212	$this->in_transaction(
213	function () use ( $path ) {
214	$parent = wp_unix_dirname( $path );
215
216	$stmt = $this->db->prepare(
217	'
218	INSERT INTO files (path, type)
219	VALUES (?, ?)
220	'
221	);
222	$stmt->bindValue( 1, $path, SQLITE3_TEXT );
223	$stmt->bindValue( 2, 'dir', SQLITE3_TEXT );
224	$stmt->execute();
225
226	$stmt = $this->db->prepare(
227	'
228	INSERT INTO directory_entries (parent_path, name)
229	VALUES (?, ?)
230	'
231	);
232	$stmt->bindValue( 1, $parent, SQLITE3_TEXT );
233	$stmt->bindValue( 2, basename( $path ), SQLITE3_TEXT );
234	$stmt->execute();
235	}
236	);
237
238	return true;
239	} catch ( Exception $e ) {
240	throw new FilesystemException(
241	sprintf( 'Failed to create directory: %s', $path ),
242	0,
243	$e
244	);
245	}
246	}
247
248	public function rm( $path ) {
249	if ( ! $this->is_file( $path ) ) {
250	throw new FilesystemException(
251	sprintf( 'File not found: %s', $path )
252	);
253	}
254
255	try {
256	$this->in_transaction(
257	function () use ( $path ) {
258	$parent = wp_unix_dirname( $path );
259
260	$stmt = $this->db->prepare( 'DELETE FROM files WHERE path = ?' );
261	$stmt->bindValue( 1, $path, SQLITE3_TEXT );
262	$stmt->execute();
263
264	$stmt = $this->db->prepare(
265	'
266	DELETE FROM directory_entries
267	WHERE parent_path = ? AND name = ?
268	'
269	);
270	$stmt->bindValue( 1, $parent, SQLITE3_TEXT );
271	$stmt->bindValue( 2, basename( $path ), SQLITE3_TEXT );
272	$stmt->execute();
273	}
274	);
275	} catch ( Exception $e ) {
276	throw new FilesystemException(
277	sprintf( 'Failed to remove file: %s', $path ),
278	0,
279	$e
280	);
281	}
282	}
283
284	public function rmdir( $path, $options = array() ) {
285	$recursive = $options['recursive'] ?? false;
286	if ( ! $this->is_dir( $path ) ) {
287	throw new FilesystemException(
288	sprintf( 'Directory not found: %s', $path )
289	);
290	}
291
292	try {
293	$this->in_transaction(
294	function () use ( $path, $options, $recursive ) {
295	if ( $recursive ) {
296	$path = rtrim( $path, '/' );
297	foreach ( $this->ls( $path ) as $child ) {
298	$child_path = wp_join_unix_paths( $path, $child );
299	if ( $this->is_dir( $child_path ) ) {
300	$this->rmdir( $child_path, $options );
301	} else {
302	$this->rm( $child_path );
303	}
304	}
305	}
306
307	$parent = wp_unix_dirname( $path );
308
309	$stmt = $this->db->prepare( 'DELETE FROM files WHERE path = ?' );
310	$stmt->bindValue( 1, $path, SQLITE3_TEXT );
311	$stmt->execute();
312
313	$stmt = $this->db->prepare(
314	'
315	DELETE FROM directory_entries
316	WHERE parent_path = ? AND name = ?
317	'
318	);
319	$stmt->bindValue( 1, $parent, SQLITE3_TEXT );
320	$stmt->bindValue( 2, basename( $path ), SQLITE3_TEXT );
321	$stmt->execute();
322	}
323	);
324	} catch ( Exception $e ) {
325	throw new FilesystemException(
326	sprintf( 'Failed to remove directory: %s', $path ),
327	0,
328	$e
329	);
330	}
331	}
332
333	public function put_contents( $path, $data, $options = array() ) {
334	$parent = wp_unix_dirname( $path );
335	if ( ! $this->is_dir( $parent ) ) {
336	throw new FilesystemException(
337	sprintf( 'Parent directory not found: %s', $parent )
338	);
339	}
340
341	try {
342	$this->in_transaction(
343	function () use ( $path, $data ) {
344	$parent = wp_unix_dirname( $path );
345
346	$stmt = $this->db->prepare(
347	'
348	INSERT OR REPLACE INTO files (path, type, contents)
349	VALUES (?, ?, ?)
350	'
351	);
352	$stmt->bindValue( 1, $path, SQLITE3_TEXT );
353	$stmt->bindValue( 2, 'file', SQLITE3_TEXT );
354	$stmt->bindValue( 3, $data, SQLITE3_BLOB );
355	$stmt->execute();
356
357	$stmt = $this->db->prepare(
358	'
359	INSERT OR REPLACE INTO directory_entries (parent_path, name)
360	VALUES (?, ?)
361	'
362	);
363	$stmt->bindValue( 1, $parent, SQLITE3_TEXT );
364	$stmt->bindValue( 2, basename( $path ), SQLITE3_TEXT );
365	$stmt->execute();
366	}
367	);
368
369	return true;
370	} catch ( Exception $e ) {
371	throw new FilesystemException(
372	sprintf( 'Failed to put contents: %s', $path ),
373	0,
374	$e
375	);
376	}
377	}
378
379	private function in_transaction( $callback ) {
380	$current_level = $this->transaction_level++;
381	try {
382	if ( 0 === $current_level ) {
383	$this->db->exec( 'BEGIN TRANSACTION' );
384	try {
385	$callback();
386	$this->db->exec( 'COMMIT' );
387	} catch ( Exception $e ) {
388	$this->db->exec( 'ROLLBACK' );
389	throw $e;
390	}
391	} else {
392	$this->db->exec( 'SAVEPOINT level_' . $current_level );
393	try {
394	$callback();
395	$this->db->exec( 'RELEASE SAVEPOINT level_' . $current_level );
396	} catch ( Exception $e ) {
397	$this->db->exec( 'ROLLBACK TO SAVEPOINT level_' . $current_level );
398	throw $e;
399	}
400	}
401	} finally {
402	--$this->transaction_level;
403	}
404	}
405
406	public function get_meta(): array {
407	return array();
408	}
409	}
410