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-inmemoryfilesystem.php
207 lines
| 1 | <?php |
| 2 | |
| 3 | namespace WordPress\Filesystem; |
| 4 | |
| 5 | use WordPress\ByteStream\MemoryPipe; |
| 6 | use WordPress\ByteStream\ReadStream\ByteReadStream; |
| 7 | use WordPress\Filesystem\Layer\ChrootLayer; |
| 8 | use WordPress\Filesystem\Mixin\Interfaces\InternalizedWriteStream; |
| 9 | |
| 10 | /** |
| 11 | * Represents an in-memory filesystem. |
| 12 | */ |
| 13 | class InMemoryFilesystem implements Filesystem, InternalizedWriteStream { |
| 14 | |
| 15 | use Mixin\InternalizeWriteStream; |
| 16 | use Mixin\GetContentsViaReadStream; |
| 17 | use Mixin\MkdirRecursive; |
| 18 | use Mixin\CopyRecursiveViaStreaming; |
| 19 | |
| 20 | private $last_write_stream_id = 0; |
| 21 | private $write_streams = array(); |
| 22 | private $files = array(); |
| 23 | |
| 24 | public static function create() { |
| 25 | return new ChrootLayer( |
| 26 | new InMemoryFilesystem(), |
| 27 | '/' |
| 28 | ); |
| 29 | } |
| 30 | |
| 31 | private function __construct() { |
| 32 | $this->files['/'] = array( |
| 33 | 'type' => 'dir', |
| 34 | 'contents' => array(), |
| 35 | ); |
| 36 | } |
| 37 | |
| 38 | protected function get_root(): string { |
| 39 | return '/'; |
| 40 | } |
| 41 | |
| 42 | public function ls( $dir = '/' ) { |
| 43 | if ( ! isset( $this->files[ $dir ] ) || 'dir' !== $this->files[ $dir ]['type'] ) { |
| 44 | throw new FilesystemException( |
| 45 | sprintf( 'Directory not found: %s', $dir ) |
| 46 | ); |
| 47 | } |
| 48 | |
| 49 | return array_keys( $this->files[ $dir ]['contents'] ); |
| 50 | } |
| 51 | |
| 52 | public function is_dir( $path ) { |
| 53 | return isset( $this->files[ $path ] ) && 'dir' === $this->files[ $path ]['type']; |
| 54 | } |
| 55 | |
| 56 | public function is_file( $path ) { |
| 57 | return isset( $this->files[ $path ] ) && 'file' === $this->files[ $path ]['type']; |
| 58 | } |
| 59 | |
| 60 | public function exists( $path ) { |
| 61 | return isset( $this->files[ $path ] ); |
| 62 | } |
| 63 | |
| 64 | public function open_read_stream( $path ): ByteReadStream { |
| 65 | if ( ! $this->is_file( $path ) ) { |
| 66 | throw new FilesystemException( |
| 67 | sprintf( 'File not found: %s', $path ) |
| 68 | ); |
| 69 | } |
| 70 | |
| 71 | return new MemoryPipe( $this->files[ $path ]['contents'] ); |
| 72 | } |
| 73 | |
| 74 | public function rename( $old_path, $new_path, $options = array() ) { |
| 75 | if ( ! $this->exists( $old_path ) ) { |
| 76 | throw new FilesystemException( |
| 77 | sprintf( 'File not found: %s', $old_path ) |
| 78 | ); |
| 79 | } |
| 80 | |
| 81 | $parent = wp_unix_dirname( $new_path ); |
| 82 | if ( ! $this->is_dir( $parent ) ) { |
| 83 | throw new FilesystemException( |
| 84 | sprintf( 'Parent directory not found: %s', $parent ) |
| 85 | ); |
| 86 | } |
| 87 | |
| 88 | $this->files[ $new_path ] = $this->files[ $old_path ]; |
| 89 | unset( $this->files[ $old_path ] ); |
| 90 | |
| 91 | return true; |
| 92 | } |
| 93 | |
| 94 | public function mkdir_single( $path, $options = array() ) { |
| 95 | if ( $this->exists( $path ) ) { |
| 96 | throw new FilesystemException( |
| 97 | sprintf( 'Directory already exists: %s', $path ) |
| 98 | ); |
| 99 | } |
| 100 | |
| 101 | $parent = wp_unix_dirname( $path ); |
| 102 | if ( ! $this->is_dir( $parent ) ) { |
| 103 | throw new FilesystemException( |
| 104 | sprintf( 'Parent directory not found: %s', $parent ) |
| 105 | ); |
| 106 | } |
| 107 | |
| 108 | $this->files[ $path ] = array( |
| 109 | 'type' => 'dir', |
| 110 | 'contents' => array(), |
| 111 | ); |
| 112 | $this->files[ $parent ]['contents'][ basename( $path ) ] = true; |
| 113 | |
| 114 | return true; |
| 115 | } |
| 116 | |
| 117 | public function rm( $path ) { |
| 118 | if ( ! $this->is_file( $path ) ) { |
| 119 | throw new FilesystemException( |
| 120 | sprintf( 'File not found: %s', $path ) |
| 121 | ); |
| 122 | } |
| 123 | |
| 124 | $parent = wp_unix_dirname( $path ); |
| 125 | unset( $this->files[ $parent ]['contents'][ basename( $path ) ] ); |
| 126 | unset( $this->files[ $path ] ); |
| 127 | |
| 128 | return true; |
| 129 | } |
| 130 | |
| 131 | public function rmdir( $path, $options = array() ) { |
| 132 | $recursive = $options['recursive'] ?? false; |
| 133 | if ( ! $this->is_dir( $path ) ) { |
| 134 | throw new FilesystemException( |
| 135 | sprintf( 'Directory not found: %s', $path ) |
| 136 | ); |
| 137 | } |
| 138 | |
| 139 | if ( $recursive ) { |
| 140 | $path = rtrim( $path, '/' ); |
| 141 | foreach ( $this->ls( $path ) as $child ) { |
| 142 | if ( $this->is_dir( $path . '/' . $child ) ) { |
| 143 | $this->rmdir( $path . '/' . $child, $options ); |
| 144 | } else { |
| 145 | $this->rm( $path . '/' . $child ); |
| 146 | } |
| 147 | } |
| 148 | } |
| 149 | |
| 150 | $parent = wp_unix_dirname( $path ); |
| 151 | unset( $this->files[ $parent ]['contents'][ basename( $path ) ] ); |
| 152 | unset( $this->files[ $path ] ); |
| 153 | |
| 154 | return true; |
| 155 | } |
| 156 | |
| 157 | public function put_contents( $path, $data, $options = array() ) { |
| 158 | $parent = wp_unix_dirname( $path ); |
| 159 | if ( ! $this->is_dir( $parent ) ) { |
| 160 | throw new FilesystemException( |
| 161 | sprintf( 'Parent directory not found: %s', $parent ) |
| 162 | ); |
| 163 | } |
| 164 | |
| 165 | $this->files[ $path ] = array( |
| 166 | 'type' => 'file', |
| 167 | 'contents' => $data, |
| 168 | ); |
| 169 | $this->files[ $parent ]['contents'][ basename( $path ) ] = true; |
| 170 | |
| 171 | return true; |
| 172 | } |
| 173 | |
| 174 | protected function write_stream_internal_open( string $path ): int { |
| 175 | $this->put_contents( $path, '' ); |
| 176 | $stream_id = $this->last_write_stream_id++; |
| 177 | $this->write_streams[ $stream_id ] = $path; |
| 178 | |
| 179 | return $stream_id; |
| 180 | } |
| 181 | |
| 182 | public function write_stream_append_bytes( int $stream_id, $data ): bool { |
| 183 | if ( ! isset( $this->write_streams[ $stream_id ] ) ) { |
| 184 | throw new FilesystemException( |
| 185 | sprintf( 'Cannot append bytes to a write stream that is not open' ) |
| 186 | ); |
| 187 | } |
| 188 | $path = $this->write_streams[ $stream_id ]; |
| 189 | $this->files[ $path ]['contents'] .= $data; |
| 190 | |
| 191 | return true; |
| 192 | } |
| 193 | |
| 194 | public function write_stream_close( int $stream_id ): void { |
| 195 | if ( ! isset( $this->write_streams[ $stream_id ] ) ) { |
| 196 | throw new FilesystemException( |
| 197 | sprintf( 'Cannot close a write stream that is not open' ) |
| 198 | ); |
| 199 | } |
| 200 | unset( $this->write_streams[ $stream_id ] ); |
| 201 | } |
| 202 | |
| 203 | public function get_meta(): array { |
| 204 | return array(); |
| 205 | } |
| 206 | } |
| 207 |