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
functions.php
290 lines
| 1 | <?php |
| 2 | |
| 3 | namespace WordPress\Filesystem; |
| 4 | |
| 5 | use ValueError; |
| 6 | |
| 7 | function ls_recursive( Filesystem $filesystem, $path = '/' ) { |
| 8 | $tree = array(); |
| 9 | foreach ( $filesystem->ls( $path ) as $item ) { |
| 10 | if ( $filesystem->is_dir( $item ) ) { |
| 11 | $tree[] = array( |
| 12 | 'name' => $item, |
| 13 | 'type' => 'dir', |
| 14 | 'children' => ls_recursive( $filesystem, $item ), |
| 15 | ); |
| 16 | } else { |
| 17 | $tree[] = array( |
| 18 | 'name' => $item, |
| 19 | 'type' => 'file', |
| 20 | ); |
| 21 | } |
| 22 | } |
| 23 | |
| 24 | return $tree; |
| 25 | } |
| 26 | |
| 27 | /** |
| 28 | * Copies a file or directory between two Filesystem instances. |
| 29 | * |
| 30 | * @param array $args The arguments to pass to the copy function. { |
| 31 | * @type Filesystem $source_filesystem The source filesystem. |
| 32 | * @type Filesystem $destination_filesystem The destination filesystem. |
| 33 | * @type string $source_path The path to the source file or directory. It must use forward slashes as path separators. |
| 34 | * @type string $destination_path The path to the destination file or directory. It must use forward slashes as path separators. |
| 35 | * @type bool $recursive Whether to copy the file or directory recursively. |
| 36 | * } |
| 37 | */ |
| 38 | function copy_between_filesystems( array $args ) { |
| 39 | $source = $args['source_filesystem']; |
| 40 | $source_path = $args['source_path'] ?? '/'; |
| 41 | $destination = $args['target_filesystem']; |
| 42 | $destination_path = $args['target_path'] ?? '/'; |
| 43 | $recursive = $args['recursive'] ?? true; |
| 44 | |
| 45 | if ( $source->is_file( $source_path ) ) { |
| 46 | $destination_dir = wp_unix_dirname( $destination_path ); |
| 47 | if ( ! $destination->is_dir( $destination_dir ) ) { |
| 48 | $destination->mkdir( |
| 49 | $destination_dir, |
| 50 | array( |
| 51 | 'recursive' => true, |
| 52 | ) |
| 53 | ); |
| 54 | } |
| 55 | |
| 56 | $to_stream = $destination->open_write_stream( $destination_path ); |
| 57 | try { |
| 58 | $from_stream = $source->open_read_stream( $source_path ); |
| 59 | try { |
| 60 | $chunks_written = 0; |
| 61 | while ( ! $from_stream->reached_end_of_data() ) { |
| 62 | $available = $from_stream->pull( 65536 ); |
| 63 | $to_stream->append_bytes( $from_stream->consume( $available ), $to_stream ); |
| 64 | ++$chunks_written; |
| 65 | } |
| 66 | if ( 0 === $chunks_written ) { |
| 67 | // Make sure the file receives at least one chunk. |
| 68 | // so we can be sure it gets created in case the. |
| 69 | // destination filesystem is lazy. |
| 70 | $to_stream->append_bytes( '' ); |
| 71 | } |
| 72 | } finally { |
| 73 | $from_stream->close_reading(); |
| 74 | } |
| 75 | } finally { |
| 76 | $to_stream->close_writing(); |
| 77 | } |
| 78 | } elseif ( $source->is_dir( $source_path ) ) { |
| 79 | if ( ! $recursive ) { |
| 80 | throw new FilesystemException( 'Cannot copy a directory. Set the option `recursive` to true to copy directories recursively.' ); |
| 81 | } |
| 82 | if ( ! $destination->is_dir( $destination_path ) ) { |
| 83 | $destination->mkdir( |
| 84 | $destination_path, |
| 85 | array( |
| 86 | 'recursive' => true, |
| 87 | ) |
| 88 | ); |
| 89 | } |
| 90 | foreach ( $source->ls( $source_path ) as $item ) { |
| 91 | copy_between_filesystems( |
| 92 | array( |
| 93 | 'source_filesystem' => $source, |
| 94 | 'source_path' => wp_join_unix_paths( $source_path, $item ), |
| 95 | 'target_filesystem' => $destination, |
| 96 | 'target_path' => wp_join_unix_paths( $destination_path, $item ), |
| 97 | ) |
| 98 | ); |
| 99 | } |
| 100 | } elseif ( $source->exists( $source_path ) ) { |
| 101 | // For now ignore paths that are neither files nor directories. |
| 102 | // For example, in GitFilesystem that could be a submodule. |
| 103 | return; // No-op, intentionally ignore. |
| 104 | } else { |
| 105 | // When a path does not exist, throw a clear error. |
| 106 | throw new FilesystemException( 'Path does not exist in the source filesystem: ' . $source_path ); |
| 107 | } |
| 108 | } |
| 109 | |
| 110 | /** |
| 111 | * Pipes data from one stream to another. |
| 112 | * |
| 113 | * @param ByteReadStream $from_stream The stream to read from. |
| 114 | * @param ByteWriteStream $to_stream The stream to write to. |
| 115 | * @param int $chunk_size Optional. The size of chunks to read at a time. Default 65536. |
| 116 | * |
| 117 | * @return int The number of chunks written. |
| 118 | * @throws FilesystemException If there's an error during the transfer. |
| 119 | */ |
| 120 | function pipe_stream( $from_stream, $to_stream, $chunk_size = 65536 ) { |
| 121 | $chunks_written = 0; |
| 122 | while ( ! $from_stream->reached_end_of_data() ) { |
| 123 | $available = $from_stream->pull( $chunk_size ); |
| 124 | $to_stream->append_bytes( $from_stream->consume( $available ) ); |
| 125 | ++$chunks_written; |
| 126 | } |
| 127 | |
| 128 | if ( 0 === $chunks_written ) { |
| 129 | // Make sure the file receives at least one chunk |
| 130 | // so we can be sure it gets created in case the |
| 131 | // destination filesystem is lazy. |
| 132 | $to_stream->append_bytes( '' ); |
| 133 | $chunks_written = 1; |
| 134 | } |
| 135 | |
| 136 | return $chunks_written; |
| 137 | } |
| 138 | |
| 139 | |
| 140 | function wp_unix_path_segments( $path ) { |
| 141 | $without_dots = wp_unix_path_resolve_dots( $path ); |
| 142 | $without_slashes = trim( $without_dots, '/' ); |
| 143 | |
| 144 | return explode( '/', $without_slashes ); |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * Joins multiple path segments together into a single path. |
| 149 | * |
| 150 | * Removes any double slashes between path segments. |
| 151 | */ |
| 152 | function wp_join_unix_paths( ...$path_segments ) { |
| 153 | $input_starts_with_slash = null; |
| 154 | |
| 155 | $paths = array(); |
| 156 | foreach ( $path_segments as $path_segment ) { |
| 157 | if ( '' !== $path_segment ) { |
| 158 | $paths[] = $path_segment; |
| 159 | if ( null === $input_starts_with_slash ) { |
| 160 | $input_starts_with_slash = 0 === strncmp( $path_segment, '/', strlen( '/' ) ); |
| 161 | } |
| 162 | } |
| 163 | } |
| 164 | $path = implode( '/', $paths ); |
| 165 | |
| 166 | $result = preg_replace( '#/+#', '/', $path ); |
| 167 | if ( $input_starts_with_slash && 0 !== strncmp( $result, '/', strlen( '/' ) ) ) { |
| 168 | $result = '/' . $result; |
| 169 | } |
| 170 | |
| 171 | return $result; |
| 172 | } |
| 173 | |
| 174 | /** |
| 175 | * Cleans up a path segment. |
| 176 | * |
| 177 | * - Removes the /./ segments |
| 178 | * - Flattens the /../ segments |
| 179 | * |
| 180 | * Example: |
| 181 | * |
| 182 | * wp_unix_path_resolve_dots( 'foo/bar/../baz' ) => '/foo/baz' |
| 183 | * |
| 184 | * @param string $path The file path that needs cleaning up |
| 185 | * @return string The cleaned, absolute path |
| 186 | */ |
| 187 | function wp_unix_path_resolve_dots( $path ) { |
| 188 | // Convert to absolute path. |
| 189 | if ( 0 !== strncmp( $path, '/', strlen( '/' ) ) ) { |
| 190 | $path = '/' . $path; |
| 191 | } |
| 192 | |
| 193 | // Resolve . and .. |
| 194 | $parts = explode( '/', $path ); |
| 195 | $normalized = array(); |
| 196 | foreach ( $parts as $part ) { |
| 197 | if ( '.' === $part || '' === $part ) { |
| 198 | continue; |
| 199 | } |
| 200 | if ( '..' === $part ) { |
| 201 | array_pop( $normalized ); |
| 202 | continue; |
| 203 | } |
| 204 | $normalized[] = $part; |
| 205 | } |
| 206 | |
| 207 | $result = implode( '/', $normalized ); |
| 208 | if ( '.' === $result ) { |
| 209 | $result = ''; |
| 210 | } |
| 211 | return $result; |
| 212 | } |
| 213 | |
| 214 | |
| 215 | /** |
| 216 | * Like sys_get_temp_dir(), but returns a path using forward slashes |
| 217 | * as separators. |
| 218 | */ |
| 219 | function wp_unix_sys_get_temp_dir() { |
| 220 | $path = sys_get_temp_dir(); |
| 221 | if ( '\\' === DIRECTORY_SEPARATOR ) { |
| 222 | $path = str_replace( '\\', '/', $path ); |
| 223 | } |
| 224 | return $path; |
| 225 | } |
| 226 | |
| 227 | /** |
| 228 | * A clone of PHP's dirname() that assumes the path is a Unix path. |
| 229 | * |
| 230 | * Both functions agree on the following: |
| 231 | * |
| 232 | * dirname("/") === wp_unix_dirname("/") === "/" |
| 233 | * dirname("/foo/bar") === wp_unix_dirname("/foo/bar") === "/foo" |
| 234 | * dirname("/foo/bar/") === wp_unix_dirname("/foo/bar/") === "/foo/bar" |
| 235 | * |
| 236 | * However, they disagree on Windows paths: |
| 237 | * |
| 238 | * dirname("C:/") === "C:/" (when ran on windows) |
| 239 | * dirname("C:/") === "." (when ran on unix) |
| 240 | * |
| 241 | * wp_unix_dirname("C:/") === "." (regardless of the OS) |
| 242 | * |
| 243 | * This ensures we get reliable results on all host OSes. |
| 244 | * |
| 245 | * It might seem weird to use unix semantics on windows. However, keep in mind, |
| 246 | * that php-toolkit supports more filesystems than just a local disk and that |
| 247 | * C: is a valid filename on unix. |
| 248 | * |
| 249 | * @param string $path Path to inspect (assumed Unix). |
| 250 | * @param int $levels How many levels to climb (≥ 1). |
| 251 | * @return string |
| 252 | * @throws ValueError on $levels < 1 (keeps parity with PHP 8.x). |
| 253 | */ |
| 254 | function wp_unix_dirname( string $path, int $levels = 1 ): string { |
| 255 | if ( $levels < 1 ) { |
| 256 | throw new ValueError( 'unix_dirname(): $levels must be >= 1' ); |
| 257 | } |
| 258 | |
| 259 | // treat empty string the same way PHP does. |
| 260 | if ( '' === $path ) { |
| 261 | return ''; |
| 262 | } |
| 263 | |
| 264 | // if the path is nothing but slashes, the result is always "/". |
| 265 | if ( strspn( $path, '/' ) === strlen( $path ) ) { |
| 266 | return 1 === $levels ? '/' : wp_unix_dirname( '/', $levels - 1 ); |
| 267 | } |
| 268 | |
| 269 | // strip trailing slashes (but never the single root slash). |
| 270 | $path = rtrim( $path, '/' ); |
| 271 | if ( '' === $path ) { // happens when the original was just "/". |
| 272 | return 1 === $levels ? '/' : wp_unix_dirname( '/', $levels - 1 ); |
| 273 | } |
| 274 | |
| 275 | // locate the last slash. |
| 276 | $slash = strrpos( $path, '/' ); |
| 277 | if ( false === $slash ) { // no slash → current dir. |
| 278 | $path = '.'; |
| 279 | } else { |
| 280 | $path = substr( $path, 0, $slash ); // cut off the basename. |
| 281 | $path = rtrim( $path, '/' ); // collapse duplicate slashes. |
| 282 | if ( '' === $path ) { |
| 283 | $path = '/'; // “/foo” → “/”. |
| 284 | } |
| 285 | } |
| 286 | |
| 287 | // recurse for additional levels. |
| 288 | return $levels > 1 ? wp_unix_dirname( $path, $levels - 1 ) : $path; |
| 289 | } |
| 290 |