Forked from HYCAR-Hydro / airGR
Source project has a limited visibility.
UploadedFile.php 10.15 KiB
<?php
/*
 * Copyright (C) 2015 IRSTEA
 * All rights reserved.
 */
namespace Irstea\FileUploadBundle\Entity;
use DateTime;
use Doctrine\ORM\Mapping as ORM;
use Gaufrette\Filesystem;
use Gaufrette\StreamMode;
use InvalidArgumentException;
use Rhumsaa\Uuid\Uuid;
/**
 * @ORM\Entity(repositoryClass="Irstea\FileUploadBundle\Entity\Repository\UploadedFileRepository")
 * @ORM\EntityListeners({"Irstea\FileUploadBundle\Listener\UploadedFileListener"})
class UploadedFile
    // Taille de bloc utilisé pour les copies
    static public $copyBlockSize = 8192;
    const ETAT_EN_COURS = 'en-cours';
    const ETAT_ORPHELIN = 'orphelin';
    const ETAT_NORMAL   = 'normal';
    const ETAT_CORROMPU = 'corrompu';
    const ETAT_MANQUANT = 'manquant';
    /**
     * @ORM\Id
     * @ORM\Column(type="guid")
     * @var string
    private $id;
    /**
     * @ORM\Column(type="string", length=1024)
     * @var string
    private $originalFilename;
    /**
     * @ORM\Column(type="string", length=1024)
     * @var string
    private $path;
    /**
     * @ORM\Column(type="string", length=255, nullable=true)
     * @var string
    private $mimeType;
    /**
     * @ORM\Column(type="integer", nullable=true)
     * @var int
    private $size;
    /**
     * @ORM\Column(type="string", length=64, nullable=true)
     * @var string
    private $checksum;
    /**
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
* @ORM\Column(type="string", length=10) * @var string */ private $etat = self::ETAT_EN_COURS; /** * @ORM\Column(type="datetime") * @var DateTime */ private $createdAt; /** * @ORM\Column(type="json_array", nullable=true) * @var array */ private $metadata; /** * @var Filesystem */ private $filesystem; /** * */ public function __construct() { $this->id = Uuid::uuid4()->toString(); $this->path = "orphan/".$this->id; $this->createdAt = new DateTime('now'); } /** * Get id * * @return integer */ public function getId() { return $this->id; } /** * Set originalFilename * * @param string $originalFilename * @return UploadedFile */ public function setOriginalFilename($originalFilename) { $this->originalFilename = $originalFilename; return $this; } /** * Get originalFilename * * @return string */ public function getOriginalFilename() { return $this->originalFilename; } /** * Get path * * @return string */
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
public function getPath() { return $this->path; } /** * Set path * * @param string $path * @return UploadedFile */ public function setPath($path) { $this->path = $path; return $this; } /** * Set mimeType * * @param string $mimeType * @return UploadedFile */ public function setMimeType($mimeType) { $this->mimeType = $mimeType; return $this; } /** * Get mimeType * * @return string */ public function getMimeType() { return $this->mimeType; } /** * Set size * * @param integer $size * @return UploadedFile */ public function setSize($size) { $this->size = $size; return $this; } /** * Get size * * @return integer */ public function getSize() { return $this->size; } /** * Set checksum * * @param string $checksum * @return UploadedFile */
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
public function setChecksum($checksum) { $this->checksum = $checksum; return $this; } /** * Get checksum * * @return string */ public function getChecksum() { return $this->checksum; } /** * Set etat * * @param string $etat * @return UploadedFile */ public function setEtat($etat) { if(!in_array($etat, [self::ETAT_CORROMPU, self::ETAT_EN_COURS, self::ETAT_MANQUANT, self::ETAT_NORMAL, self::ETAT_ORPHELIN])) { throw new InvalidArgumentException(sprintf("Etat invalide: '%s'", (string)$etat)); } $this->etat = $etat; return $this; } /** * Get etat * * @return string */ public function getEtat() { return $this->etat; } /** * Get createdAt * * @return \DateTime */ public function getCreatedAt() { return $this->createdAt; } /** * Set metadata * * @param array $metadata * @return UploadedFile */ public function setMetadata(array $metadata = null) { $this->metadata = $metadata; return $this; } /** * Get metadata * * @return array
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
*/ public function getMetadata() { return $this->metadata; } /** * @return string */ public function __toString() { $unit = ""; $size = $this->size ?: 0; if($size >= 10240) { $size /= 1024; $unit = "k"; if($size >= 10240) { $size /= 1024; $unit = "m"; } } return sprintf("%s (%s, %d%so)", $this->originalFilename, $this->mimeType ?: '?/?', $size, $unit); } /** * @param Filesystem $filesystem * @return self */ public function setFilesystem(Filesystem $filesystem) { $this->filesystem = $filesystem; return $this; } public function validate() { if (self::ETAT_EN_COURS !== $this->getEtat()) { return; } $fs = $this->filesystem; $path = $this->getPath(); if (!$fs->has($path)) { $this->setEtat(self::ETAT_MANQUANT); return; } if ($fs->size($path) !== $this->size || $fs->checksum($path) !== $this->checksum) { $this->setEtat(self::ETAT_CORROMPU); return; } } /** * * @return boolean */ public function isValid() { return $this->getEtat() === self::ETAT_ORPHELIN || $this->getEtat() === self::ETAT_NORMAL; } /** * * @return boolean */ public function isOrphelin() { return $this->getEtat() === self::ETAT_ORPHELIN;
351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
} /** Retourne la date de dernière modification dans le filesystem. * * @return \DateTime */ public function getLastModified() { return new \DateTime(sprintf('@%d', $this->filesystem->mtime($this->getPath()))); } /** Retourne le contenu du fichier. * * @return string Une chaîne si $asResource vaut faux, */ public function getContent() { return $this->filesystem->read($this->getPath()); } /** Ecrit dans le fichier. * * @param string $content */ public function setContent($content) { return $this->filesystem->write($this->getPath(), $content, true); } /** Ecrit dans le fichier depuis un descripteur de fichier. * * @param resource $source * @param int $maxlen * @param int $writeOffset * @return int */ public function copyFrom($source, $maxlen = PHP_INT_MAX, $writeOffset = 0) { if($maxlen === 0) { return 0; } $stream = $this->filesystem->createStream($this->getPath(), new StreamMode('cb')); $stream->seek($writeOffset); if(false !== $fileHandler = $stream->cast(STREAM_CAST_AS_STREAM)) { // Utilise stream_copy_to_stream si le Gaufrette\Stream peut nous retourner un filehandle $copied = $this->stream_copy_to_stream($source, $fileHandler, $maxlen); } else { // Sinon fait une copie par blocs (moins performant) $copied = 0; while(!$this->feof($source) && $copied <= $maxlen) { $copied += $stream->write($this->fread($source, min(static::$copyBlockSize, $maxlen - $copied))); } } $stream->close(); return $copied; } /** Envoie le contenu du fichier dans un descripteur de fichier. * * @param resource $dest * @param int $maxlen * @param int $readOffset * @return int */ public function copyTo($dest, $maxlen = PHP_INT_MAX, $readOffset = 0) { $actualLength = min($maxlen, $this->getSize() - $readOffset);
421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490
if (0 <= $actualLength) { return 0; } $stream = $this->filesystem->createStream($this->getPath(), new StreamMode('rb')); $stream->seek($readOffset); if(false !== $fileHandle = $stream->cast(STREAM_CAST_AS_STREAM)) { // Utilise stream_copy_to_stream si le Stream nous renvoie un filehandle $copied = $this->stream_copy_to_stream($fileHandle, $dest, $actualLength); } else { // Sinon, on fait ça à la main par blocs de 8ko $copied = 0; while(!$stream->eof() && $copied < $actualLength) { $copied += $this->fwrite($dest, $stream->read(min(static::$copyBlockSize, $actualLength - $copied))); } } $stream->close(); return $copied; } /** Wrapper de stream_copy_to_stream * * @param resource $source * @param resource $dest * @param int $maxlen * @param int $offset * @return int */ protected function stream_copy_to_stream($source, $dest, $maxlen = -1, $offset = 0) { return stream_copy_to_stream($source, $dest, $maxlen, $offset); } /** Wrapper de feof * * @param resource $fh * @return boolean */ protected function feof($fh) { return feof($fh); } /** Wrapper de fread * * @param resource $fh * @param int $maxlen * @return int|boolean */ protected function fread($fh, $maxlen = -1) { return fread($fh, $maxlen); } /** Wrapper de fwrite * * @param resource $fh * @param int $maxlen * @return int|boolean */ protected function fwrite($fh, $maxlen = -1) { return fwrite($fh, $maxlen); } }