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-uploadedfilesystem.php
193 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 | |
| 9 | /** |
| 10 | * A filesystem implementation that reads from an uploaded directory tree structure. |
| 11 | * This is useful for handling file uploads through the REST API where files are |
| 12 | * sent as part of a directory tree structure. |
| 13 | */ |
| 14 | class UploadedFilesystem implements Filesystem { |
| 15 | |
| 16 | use Mixin\ReadOnlyFilesystem; |
| 17 | use Mixin\GetContentsViaReadStream; |
| 18 | |
| 19 | /** |
| 20 | * @var array The directory tree structure |
| 21 | */ |
| 22 | private $tree; |
| 23 | |
| 24 | /** |
| 25 | * @var REST_Request The request object containing uploaded files |
| 26 | */ |
| 27 | private $request; |
| 28 | |
| 29 | /** |
| 30 | * @var Filesystem The filesystem to read the uploaded files from. |
| 31 | */ |
| 32 | private $uploads_fs; |
| 33 | |
| 34 | /** |
| 35 | * Create a new UploadedFilesystem instance. |
| 36 | * |
| 37 | * @param REST_Request $request The request object containing uploaded files |
| 38 | * @param string $tree_parameter_name The name of the parameter containing the tree structure |
| 39 | * @param array $options The options array { |
| 40 | * |
| 41 | * @return UploadedFilesystem The new instance |
| 42 | * @var Filesystem $uploads_fs Optional. The filesystem to read the uploaded files from. |
| 43 | * } |
| 44 | */ |
| 45 | public static function create( $request, $tree_parameter_name, $options = array() ) { |
| 46 | return new ChrootLayer( |
| 47 | new UploadedFilesystem( $request, $tree_parameter_name, $options ), |
| 48 | '/' |
| 49 | ); |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * @param REST_Request $request The request object containing uploaded files |
| 54 | * @param string $tree_parameter_name The name of the parameter containing the tree structure |
| 55 | * @param array $options The options array |
| 56 | * |
| 57 | * @internal |
| 58 | * Use the static create() method instead. |
| 59 | */ |
| 60 | private function __construct( $request, $tree_parameter_name, $options = array() ) { |
| 61 | $tree_json = $request->get_param( $tree_parameter_name ); |
| 62 | if ( ! $tree_json ) { |
| 63 | throw new FilesystemException( 'Invalid file tree structure' ); |
| 64 | } |
| 65 | |
| 66 | $tree = json_decode( $tree_json, true ); |
| 67 | if ( ! $tree ) { |
| 68 | throw new FilesystemException( 'Invalid JSON structure' ); |
| 69 | } |
| 70 | |
| 71 | if ( ! isset( $tree['type'] ) || 'directory' !== $tree['type'] || ! isset( $tree['name'] ) || '' !== $tree['name'] ) { |
| 72 | $tree = array( |
| 73 | 'type' => 'directory', |
| 74 | 'name' => '', |
| 75 | 'children' => $tree, |
| 76 | ); |
| 77 | } |
| 78 | |
| 79 | $this->request = $request; |
| 80 | $this->tree = $tree; |
| 81 | $this->uploads_fs = $options['uploads_fs'] ?? LocalFilesystem::create( '/' ); |
| 82 | } |
| 83 | |
| 84 | public function ls( $parent_path = '/' ) { |
| 85 | $parent_path = '/' . ltrim( wp_unix_path_resolve_dots( $parent_path ), '/' ); |
| 86 | $node = $this->find_node( $parent_path ); |
| 87 | if ( ! $node || 'directory' !== $node['type'] ) { |
| 88 | return array(); |
| 89 | } |
| 90 | |
| 91 | return array_map( |
| 92 | function ( $child ) { |
| 93 | return $child['name']; |
| 94 | }, |
| 95 | $node['children'] ?? array() |
| 96 | ); |
| 97 | } |
| 98 | |
| 99 | public function is_dir( $path ) { |
| 100 | $node = $this->find_node( $path ); |
| 101 | |
| 102 | return $node && 'directory' === $node['type']; |
| 103 | } |
| 104 | |
| 105 | public function is_file( $path ) { |
| 106 | $node = $this->find_node( $path ); |
| 107 | |
| 108 | return $node && 'file' === $node['type']; |
| 109 | } |
| 110 | |
| 111 | public function exists( $path ) { |
| 112 | return null !== $this->find_node( $path ); |
| 113 | } |
| 114 | |
| 115 | public function mkdir( $path, $options = array() ) { |
| 116 | throw new FilesystemException( 'Not implemented' ); |
| 117 | } |
| 118 | |
| 119 | public function rm( $path ) { |
| 120 | throw new FilesystemException( 'Not implemented' ); |
| 121 | } |
| 122 | |
| 123 | public function rmdir( $path, $options = array() ) { |
| 124 | throw new FilesystemException( 'Not implemented' ); |
| 125 | } |
| 126 | |
| 127 | public function open_read_stream( $path ): ByteReadStream { |
| 128 | $node = $this->find_node( $path ); |
| 129 | if ( ! $node || 'file' !== $node['type'] ) { |
| 130 | throw new FilesystemException( |
| 131 | sprintf( 'File not found: %s', $path ) |
| 132 | ); |
| 133 | } |
| 134 | |
| 135 | // Handle file content from request. |
| 136 | if ( ! isset( $node['content'] ) || ! is_string( $node['content'] ) ) { |
| 137 | $node['content'] = ''; |
| 138 | } |
| 139 | |
| 140 | if ( 0 === strpos( $node['content'], '@file:' ) ) { |
| 141 | $file_key = substr( $node['content'], 6 ); |
| 142 | $uploaded_file = $this->request->get_file_params()[ $file_key ] ?? null; |
| 143 | |
| 144 | if ( ! $uploaded_file || UPLOAD_ERR_OK !== $uploaded_file['error'] ) { |
| 145 | throw new FilesystemException( |
| 146 | sprintf( 'File upload error: %s', $uploaded_file['error'] ) |
| 147 | ); |
| 148 | } |
| 149 | |
| 150 | return $this->uploads_fs->open_read_stream( $uploaded_file['tmp_name'] ); |
| 151 | } |
| 152 | |
| 153 | // Handle inline content. |
| 154 | return new MemoryPipe( $node['content'] ); |
| 155 | } |
| 156 | |
| 157 | /** |
| 158 | * Find a node in the tree by its path |
| 159 | * |
| 160 | * @param string $path The path to find |
| 161 | * |
| 162 | * @return array|null The node if found, null otherwise |
| 163 | */ |
| 164 | private function find_node( $path ) { |
| 165 | $path = trim( $path, '/' ); |
| 166 | if ( '' === $path ) { |
| 167 | return $this->tree; |
| 168 | } |
| 169 | |
| 170 | $parts = explode( '/', $path ); |
| 171 | $current = $this->tree; |
| 172 | foreach ( $parts as $part ) { |
| 173 | $found = false; |
| 174 | foreach ( $current['children'] as $node ) { |
| 175 | if ( $node['name'] === $part ) { |
| 176 | $found = true; |
| 177 | $current = $node; |
| 178 | break; |
| 179 | } |
| 180 | } |
| 181 | if ( ! $found ) { |
| 182 | return null; |
| 183 | } |
| 184 | } |
| 185 | |
| 186 | return $current; |
| 187 | } |
| 188 | |
| 189 | public function get_meta(): array { |
| 190 | return array(); |
| 191 | } |
| 192 | } |
| 193 |