| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334 |
- <?php
- declare(strict_types=1);
- namespace League\Flysystem;
- use function sprintf;
- class MountManager implements FilesystemOperator
- {
- /**
- * @var array<string, FilesystemOperator>
- */
- private $filesystems = [];
- /**
- * MountManager constructor.
- *
- * @param array<string,FilesystemOperator> $filesystems
- */
- public function __construct(array $filesystems = [])
- {
- $this->mountFilesystems($filesystems);
- }
- public function fileExists(string $location): bool
- {
- /** @var FilesystemOperator $filesystem */
- [$filesystem, $path] = $this->determineFilesystemAndPath($location);
- try {
- return $filesystem->fileExists($path);
- } catch (UnableToCheckFileExistence $exception) {
- throw UnableToCheckFileExistence::forLocation($location, $exception);
- }
- }
- public function read(string $location): string
- {
- /** @var FilesystemOperator $filesystem */
- [$filesystem, $path] = $this->determineFilesystemAndPath($location);
- try {
- return $filesystem->read($path);
- } catch (UnableToReadFile $exception) {
- throw UnableToReadFile::fromLocation($location, $exception->reason(), $exception);
- }
- }
- public function readStream(string $location)
- {
- /** @var FilesystemOperator $filesystem */
- [$filesystem, $path] = $this->determineFilesystemAndPath($location);
- try {
- return $filesystem->readStream($path);
- } catch (UnableToReadFile $exception) {
- throw UnableToReadFile::fromLocation($location, $exception->reason(), $exception);
- }
- }
- public function listContents(string $location, bool $deep = self::LIST_SHALLOW): DirectoryListing
- {
- /** @var FilesystemOperator $filesystem */
- [$filesystem, $path, $mountIdentifier] = $this->determineFilesystemAndPath($location);
- return
- $filesystem
- ->listContents($path, $deep)
- ->map(
- function (StorageAttributes $attributes) use ($mountIdentifier) {
- return $attributes->withPath(sprintf('%s://%s', $mountIdentifier, $attributes->path()));
- }
- );
- }
- public function lastModified(string $location): int
- {
- /** @var FilesystemOperator $filesystem */
- [$filesystem, $path] = $this->determineFilesystemAndPath($location);
- try {
- return $filesystem->lastModified($path);
- } catch (UnableToRetrieveMetadata $exception) {
- throw UnableToRetrieveMetadata::lastModified($location, $exception->reason(), $exception);
- }
- }
- public function fileSize(string $location): int
- {
- /** @var FilesystemOperator $filesystem */
- [$filesystem, $path] = $this->determineFilesystemAndPath($location);
- try {
- return $filesystem->fileSize($path);
- } catch (UnableToRetrieveMetadata $exception) {
- throw UnableToRetrieveMetadata::fileSize($location, $exception->reason(), $exception);
- }
- }
- public function mimeType(string $location): string
- {
- /** @var FilesystemOperator $filesystem */
- [$filesystem, $path] = $this->determineFilesystemAndPath($location);
- try {
- return $filesystem->mimeType($path);
- } catch (UnableToRetrieveMetadata $exception) {
- throw UnableToRetrieveMetadata::mimeType($location, $exception->reason(), $exception);
- }
- }
- public function visibility(string $location): string
- {
- /** @var FilesystemOperator $filesystem */
- [$filesystem, $path] = $this->determineFilesystemAndPath($location);
- try {
- return $filesystem->visibility($path);
- } catch (UnableToRetrieveMetadata $exception) {
- throw UnableToRetrieveMetadata::visibility($location, $exception->reason(), $exception);
- }
- }
- public function write(string $location, string $contents, array $config = []): void
- {
- /** @var FilesystemOperator $filesystem */
- [$filesystem, $path] = $this->determineFilesystemAndPath($location);
- try {
- $filesystem->write($path, $contents, $config);
- } catch (UnableToWriteFile $exception) {
- throw UnableToWriteFile::atLocation($location, $exception->reason(), $exception);
- }
- }
- public function writeStream(string $location, $contents, array $config = []): void
- {
- /** @var FilesystemOperator $filesystem */
- [$filesystem, $path] = $this->determineFilesystemAndPath($location);
- $filesystem->writeStream($path, $contents, $config);
- }
- public function setVisibility(string $path, string $visibility): void
- {
- /** @var FilesystemOperator $filesystem */
- [$filesystem, $path] = $this->determineFilesystemAndPath($path);
- $filesystem->setVisibility($path, $visibility);
- }
- public function delete(string $location): void
- {
- /** @var FilesystemOperator $filesystem */
- [$filesystem, $path] = $this->determineFilesystemAndPath($location);
- try {
- $filesystem->delete($path);
- } catch (UnableToDeleteFile $exception) {
- throw UnableToDeleteFile::atLocation($location, '', $exception);
- }
- }
- public function deleteDirectory(string $location): void
- {
- /** @var FilesystemOperator $filesystem */
- [$filesystem, $path] = $this->determineFilesystemAndPath($location);
- try {
- $filesystem->deleteDirectory($path);
- } catch (UnableToDeleteDirectory $exception) {
- throw UnableToDeleteDirectory::atLocation($location, '', $exception);
- }
- }
- public function createDirectory(string $location, array $config = []): void
- {
- /** @var FilesystemOperator $filesystem */
- [$filesystem, $path] = $this->determineFilesystemAndPath($location);
- try {
- $filesystem->createDirectory($path, $config);
- } catch (UnableToCreateDirectory $exception) {
- throw UnableToCreateDirectory::dueToFailure($location, $exception);
- }
- }
- public function move(string $source, string $destination, array $config = []): void
- {
- /** @var FilesystemOperator $sourceFilesystem */
- /* @var FilesystemOperator $destinationFilesystem */
- [$sourceFilesystem, $sourcePath] = $this->determineFilesystemAndPath($source);
- [$destinationFilesystem, $destinationPath] = $this->determineFilesystemAndPath($destination);
- $sourceFilesystem === $destinationFilesystem ? $this->moveInTheSameFilesystem(
- $sourceFilesystem,
- $sourcePath,
- $destinationPath,
- $source,
- $destination
- ) : $this->moveAcrossFilesystems($source, $destination);
- }
- public function copy(string $source, string $destination, array $config = []): void
- {
- /** @var FilesystemOperator $sourceFilesystem */
- /* @var FilesystemOperator $destinationFilesystem */
- [$sourceFilesystem, $sourcePath] = $this->determineFilesystemAndPath($source);
- [$destinationFilesystem, $destinationPath] = $this->determineFilesystemAndPath($destination);
- $sourceFilesystem === $destinationFilesystem ? $this->copyInSameFilesystem(
- $sourceFilesystem,
- $sourcePath,
- $destinationPath,
- $source,
- $destination
- ) : $this->copyAcrossFilesystem(
- $config['visibility'] ?? null,
- $sourceFilesystem,
- $sourcePath,
- $destinationFilesystem,
- $destinationPath,
- $source,
- $destination
- );
- }
- private function mountFilesystems(array $filesystems): void
- {
- foreach ($filesystems as $key => $filesystem) {
- $this->guardAgainstInvalidMount($key, $filesystem);
- /* @var string $key */
- /* @var FilesystemOperator $filesystem */
- $this->mountFilesystem($key, $filesystem);
- }
- }
- /**
- * @param mixed $key
- * @param mixed $filesystem
- */
- private function guardAgainstInvalidMount($key, $filesystem): void
- {
- if ( ! is_string($key)) {
- throw UnableToMountFilesystem::becauseTheKeyIsNotValid($key);
- }
- if ( ! $filesystem instanceof FilesystemOperator) {
- throw UnableToMountFilesystem::becauseTheFilesystemWasNotValid($filesystem);
- }
- }
- private function mountFilesystem(string $key, FilesystemOperator $filesystem): void
- {
- $this->filesystems[$key] = $filesystem;
- }
- /**
- * @param string $path
- *
- * @return array{0:FilesystemOperator, 1:string}
- */
- private function determineFilesystemAndPath(string $path): array
- {
- if (strpos($path, '://') < 1) {
- throw UnableToResolveFilesystemMount::becauseTheSeparatorIsMissing($path);
- }
- /** @var string $mountIdentifier */
- /** @var string $mountPath */
- [$mountIdentifier, $mountPath] = explode('://', $path, 2);
- if ( ! array_key_exists($mountIdentifier, $this->filesystems)) {
- throw UnableToResolveFilesystemMount::becauseTheMountWasNotRegistered($mountIdentifier);
- }
- return [$this->filesystems[$mountIdentifier], $mountPath, $mountIdentifier];
- }
- private function copyInSameFilesystem(
- FilesystemOperator $sourceFilesystem,
- string $sourcePath,
- string $destinationPath,
- string $source,
- string $destination
- ): void {
- try {
- $sourceFilesystem->copy($sourcePath, $destinationPath);
- } catch (UnableToCopyFile $exception) {
- throw UnableToCopyFile::fromLocationTo($source, $destination, $exception);
- }
- }
- private function copyAcrossFilesystem(
- ?string $visibility,
- FilesystemOperator $sourceFilesystem,
- string $sourcePath,
- FilesystemOperator $destinationFilesystem,
- string $destinationPath,
- string $source,
- string $destination
- ): void {
- try {
- $visibility = $visibility ?? $sourceFilesystem->visibility($sourcePath);
- $stream = $sourceFilesystem->readStream($sourcePath);
- $destinationFilesystem->writeStream($destinationPath, $stream, compact('visibility'));
- } catch (UnableToRetrieveMetadata | UnableToReadFile | UnableToWriteFile $exception) {
- throw UnableToCopyFile::fromLocationTo($source, $destination, $exception);
- }
- }
- private function moveInTheSameFilesystem(
- FilesystemOperator $sourceFilesystem,
- string $sourcePath,
- string $destinationPath,
- string $source,
- string $destination
- ): void {
- try {
- $sourceFilesystem->move($sourcePath, $destinationPath);
- } catch (UnableToMoveFile $exception) {
- throw UnableToMoveFile::fromLocationTo($source, $destination, $exception);
- }
- }
- private function moveAcrossFilesystems(string $source, string $destination): void
- {
- try {
- $this->copy($source, $destination);
- $this->delete($source);
- } catch (UnableToCopyFile | UnableToDeleteFile $exception) {
- throw UnableToMoveFile::fromLocationTo($source, $destination, $exception);
- }
- }
- }
|