AhmadMayahi\Vision\Support\File

Complexity

Total Complexity

27

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	toVisionFile()	0	21	5
A	getLocalPathname()	0	19	5
A	__construct()	0	2	1
A	getStreamFilePath()	0	10	2
A	getTempDir()	0	3	1
A	isGoogleStoragePath()	0	3	2
A	createTempFile()	0	3	1
A	isResource()	0	3	1
A	isLocalFile()	0	3	2
A	saveStream()	0	4	2
A	getContents()	0	16	5

<?php

declare(strict_types=1);

namespace AhmadMayahi\Vision\Support;

use AhmadMayahi\Vision\Contracts\File as FileContract;
use AhmadMayahi\Vision\Exceptions\FileException;
use AhmadMayahi\Vision\Exceptions\UnsupportedFileTypeException;
use Exception;
use SplFileInfo;
use SplFileObject;

class File implements FileContract
{
    /**
     * @param string|resource|SplFileInfo|SplFileObject $file Input file
     * @param null|string $tempDirPath Full path to temporary directory
     */
    public function __construct(private $file, private ?string $tempDirPath = null)
    {
    }

    /**
     * Generates vision compatible to be used as a file input in Google\Cloud\Vision\V1\ImageAnnotatorClient
     *
     * @return resource|string
     * @throws FileException
     */
    public function toVisionFile()
    {
        if (is_resource($this->file)) {
            return $this->file;
        }

        if ($this->file instanceof SplFileInfo) {
            $fileObj = $this->file->openFile();

            return (string) $fileObj->fread($this->file->getSize());
        }

        if ($this->isGoogleStoragePath()) {
            return (string) $this->file;
        }

        if (file_exists($this->file)) {
            return (string) file_get_contents($this->file);
        }

        throw new FileException('File not found or not compatible!');
    }

    public function getLocalPathname(): string
    {
        if ($this->isGoogleStoragePath()) {
            throw new Exception('Google Storage is not supported for this operation!');
        }

        if (is_resource($this->file)) {
            return $this->getStreamFilePath();
        }

        if ($this->file instanceof SplFileInfo) {
            return $this->file->getPathname();
        }

        if (file_exists($this->file)) {
            return $this->file;
        }

        throw new FileException('Cannot get the local file path');
    }

    public function getStreamFilePath(): string
    {
        if (false === $this->isResource()) {
            throw new FileException('File is not resource!');
        }

        $tempFile = $this->createTempFile();
        $this->saveStream($tempFile);

        return $tempFile;
    }

    private function createTempFile(): string
    {
        return tempnam($this->getTempDir(), sha1(uniqid()));
    }

    private function saveStream(string $tempFile)
    {
        if (false === file_put_contents($tempFile, stream_get_contents($this->file))) {
            throw new FileException('Could not write teo temp file: '.$tempFile);
        }
    }

    public function getContents()
    {
        if ($this->isGoogleStoragePath()) {
            throw new UnsupportedFileTypeException('Google Storage is not supported!');
        }

        if ($this->isLocalFile()) {
            return file_get_contents($this->file);
        }

        if (is_resource($this->file)) {
            return stream_get_contents($this->file);
        }

        if ($this->file instanceof SplFileInfo) {
            return file_get_contents($this->file->getPathname());
        }
    }

    public function isGoogleStoragePath(): bool
    {
        return is_string($this->file) && str_starts_with($this->file, 'gs://');
    }

    public function isResource(): bool
    {
        return is_resource($this->file);
    }

    public function isLocalFile(): bool
    {
        return is_string($this->file) && file_exists($this->file);
    }

    private function getTempDir(): string
    {
        return $this->tempDirPath ?? sys_get_temp_dir();
    }
}