1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 <?php
/* --------------------------------------------------------------
AbstractFileStorage.inc.php 2016-04-20
Gambio GmbH
http://www.gambio.de
Copyright (c) 2016 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Class AbstractFileStorage
*
* @category System
* @package Shared
* @subpackage Storage
*/
abstract class AbstractFileStorage
{
/**
* Storage Directory.
*
* @var \WritableDirectory
*/
protected $storageDirectory;
/**
* AbstractFileStorage constructor.
*
* @param \WritableDirectory $storageDirectory
*/
public function __construct(WritableDirectory $storageDirectory)
{
$this->storageDirectory = $storageDirectory;
}
/**
* Import File
*
* Saves an image to a writable directory.
*
* @param \ExistingFile $sourceFile The source file to import.
* @param \FilenameStringType $preferredFilename The preferred name of the file to be saved.
*
* @throws \InvalidArgumentException
*
* @return string The created filename
*/
public function importFile(ExistingFile $sourceFile, FilenameStringType $preferredFilename)
{
$this->_validateFile($sourceFile);
$this->_validateFilename($preferredFilename);
$uniqueFilename = $preferredFilename;
if($this->fileExists($preferredFilename))
{
$uniqueFilename = new FilenameStringType($this->_createAndReturnNewFilename($preferredFilename));
}
copy($sourceFile->getFilePath(),
$this->storageDirectory->getDirPath() . DIRECTORY_SEPARATOR . $uniqueFilename->asString());
return $uniqueFilename->asString();
}
/**
* Rename File
*
* Renames an existing image file.
*
* @param FilenameStringType $oldName The old name of the file.
* @param FilenameStringType $newName The new name of the file.
*
* @throws InvalidArgumentException If the file that should be renamed does not exists.
* @throws InvalidArgumentException If a file with the preferred name already exists.
*
* @return AbstractFileStorage Same instance for chained method calls.
*/
public function renameFile(FilenameStringType $oldName, FilenameStringType $newName)
{
if(!$this->fileExists($oldName))
{
throw new InvalidArgumentException($oldName->asString() . ' does not exist in '
. $this->storageDirectory->getDirPath());
}
if($this->fileExists($newName))
{
throw new InvalidArgumentException($newName->asString() . ' already exists in '
. $this->storageDirectory->getDirPath());
}
$this->_validateFilename($newName);
rename($this->storageDirectory->getDirPath() . DIRECTORY_SEPARATOR . $oldName->asString(),
$this->storageDirectory->getDirPath() . DIRECTORY_SEPARATOR . $newName->asString());
return $this;
}
/**
* File Exists
*
* Checks if the provided file exists.
*
* @param \FilenameStringType $filename The filename of the file to be checked.
*
* @return bool
*/
public function fileExists(FilenameStringType $filename)
{
$filepath = $this->storageDirectory->getDirPath() . DIRECTORY_SEPARATOR . $filename->asString();
return file_exists($filepath) && !is_dir($filepath);
}
/**
* Delete File
*
* Deletes an existing file.
*
* @param \FilenameStringType $filename The file to delete.
*
* @return AbstractFileStorage Same instance for chained method calls.
*/
public function deleteFile(FilenameStringType $filename)
{
if($this->fileExists($filename))
{
unlink($this->storageDirectory->getDirPath() . DIRECTORY_SEPARATOR . $filename->asString());
}
return $this;
}
/**
* Validates the provided file.
*
* @param \ExistingFile $sourceFile The file to validate.
*
* @throws \InvalidArgumentException
*
* @return AbstractFileStorage Same instance for chained method calls.
*/
abstract protected function _validateFile(ExistingFile $sourceFile);
/**
* Validates the provided filename.
*
* @param \FilenameStringType $filename The filename to validate.
*
* @throws \InvalidArgumentException
*
* @return AbstractFileStorage Same instance for chained method calls.
*/
abstract protected function _validateFilename(FilenameStringType $filename);
/**
* Create and Return the New Filename
*
* Checks whether the provided preferred filename already exists and generates one,
* with appending the next available number, which does not already exist.
*
* @param \FilenameStringType $existingFilename The existing filename to change.
*
* @throws \InvalidArgumentException
*
* @return string The created filename
*/
protected function _createAndReturnNewFilename(FilenameStringType $existingFilename)
{
$nextAvailableNumber = 0;
do
{
$extensionPosition = strrpos($existingFilename->asString(), '.');
$filenameWithoutExtension = substr($existingFilename->asString(), 0, $extensionPosition);
$filenameExtensionInclDot = substr($existingFilename->asString(), $extensionPosition);
$newFilename = $filenameWithoutExtension . '_' . $nextAvailableNumber
. $filenameExtensionInclDot;
$newFilenameObject = new FilenameStringType($newFilename);
$nextAvailableNumber++;
}
while($this->fileExists($newFilenameObject));
return $newFilenameObject->asString();
}
}