upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-02-20 00:12:30 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 38

Move to strong typing in OC\Archive

Browse source 
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
This commit is contained in:
Côme Chilliet 2022-02-24 17:04:09 +01:00
parent 153eca8ef0
commit 77644cb674
No known key found for this signature in database
GPG key ID: A3E2F658B28C760A
3 changed files with 78 additions and 155 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
lib/private/Archive/Archive.php
View file

@ -30,98 +30,84 @@
namespace OC\Archive;
abstract class Archive {
/**
* @param string $source
*/
abstract public function __construct($source);
abstract public function __construct(string $source);
/**
* add an empty folder to the archive
* @param string $path
* @return bool
*/
abstract public function addFolder($path);
abstract public function addFolder(string $path): bool;
/**
* add a file to the archive
* @param string $path
* @param string $source either a local file or string data
* @return bool
*/
abstract public function addFile($path, $source = '');
abstract public function addFile(string $path, string $source = ''): bool;
/**
* rename a file or folder in the archive
* @param string $source
* @param string $dest
* @return bool
*/
abstract public function rename($source, $dest);
abstract public function rename(string $source, string $dest): bool;
/**
* get the uncompressed size of a file in the archive
* @param string $path
* @return int|false
*/
abstract public function filesize($path);
abstract public function filesize(string $path);
/**
* get the last modified time of a file in the archive
* @param string $path
* @return int|false
*/
abstract public function mtime($path);
abstract public function mtime(string $path);
/**
* get the files in a folder
* @param string $path
* @return array
*/
abstract public function getFolder($path);
abstract public function getFolder(string $path): array;
/**
* get all files in the archive
* @return array
*/
abstract public function getFiles();
abstract public function getFiles(): array;
/**
* get the content of a file
* @param string $path
* @return string|false
*/
abstract public function getFile($path);
abstract public function getFile(string $path);
/**
* extract a single file from the archive
* @param string $path
* @param string $dest
* @return bool success
*/
abstract public function extractFile($path, $dest);
abstract public function extractFile(string $path, string $dest): bool;
/**
* extract the archive
* @param string $dest
* @return bool
*/
abstract public function extract($dest);
abstract public function extract(string $dest): bool;
/**
* check if a file or folder exists in the archive
* @param string $path
* @return bool
*/
abstract public function fileExists($path);
abstract public function fileExists(string $path): bool;
/**
* remove a file or folder from the archive
* @param string $path
* @return bool
*/
abstract public function remove($path);
abstract public function remove(string $path): bool;
/**
* get a file handler
* @param string $path
* @param string $mode
* @return bool|resource
*/
abstract public function getStream($path, $mode);
abstract public function getStream(string $path, string $mode);
/**
* add a folder and all its content
* @param string $path
* @param string $source
* @return void
*/
public function addRecursive($path, $source) {
public function addRecursive(string $path, string $source): void {
$dh = opendir($source);
if (is_resource($dh)) {
$this->addFolder($path);

84
lib/private/Archive/TAR.php
View file

@ -58,10 +58,7 @@ class TAR extends Archive {
*/
private $path;
/**
* @param string $source
*/
public function __construct($source) {
public function __construct(string $source) {
$types = [null, 'gz', 'bz2'];
$this->path = $source;
$this->tar = new \Archive_Tar($source, $types[self::getTarType($source)]);
@ -69,11 +66,8 @@ class TAR extends Archive {
/**
* try to detect the type of tar compression
*
* @param string $file
* @return integer
*/
public static function getTarType($file) {
public static function getTarType(string $file): int {
if (strpos($file, '.')) {
$extension = substr($file, strrpos($file, '.'));
switch ($extension) {
@ -95,11 +89,8 @@ class TAR extends Archive {
/**
* add an empty folder to the archive
*
* @param string $path
* @return bool
*/
public function addFolder($path) {
public function addFolder(string $path): bool {
$tmpBase = \OC::$server->getTempManager()->getTemporaryFolder();
$path = rtrim($path, '/') . '/';
if ($this->fileExists($path)) {
@ -123,11 +114,9 @@ class TAR extends Archive {
/**
* add a file to the archive
*
* @param string $path
* @param string $source either a local file or string data
* @return bool
*/
public function addFile($path, $source = '') {
public function addFile(string $path, string $source = ''): bool {
if ($this->fileExists($path)) {
$this->remove($path);
}
@ -142,12 +131,8 @@ class TAR extends Archive {
/**
* rename a file or folder in the archive
*
* @param string $source
* @param string $dest
* @return bool
*/
public function rename($source, $dest) {
public function rename(string $source, string $dest): bool {
//no proper way to delete, rename entire archive, rename file and remake archive
$tmp = \OC::$server->getTempManager()->getTemporaryFolder();
$this->tar->extract($tmp);
@ -162,11 +147,7 @@ class TAR extends Archive {
return true;
}
/**
* @param string $file
* @return array|null
*/
private function getHeader($file) {
private function getHeader(string $file): ?array {
if (!$this->cachedHeaders) {
$this->cachedHeaders = $this->tar->listContent();
}
@ -185,10 +166,9 @@ class TAR extends Archive {
/**
* get the uncompressed size of a file in the archive
*
* @param string $path
* @return int|false
*/
public function filesize($path) {
public function filesize(string $path) {
$stat = $this->getHeader($path);
return $stat['size'] ?? false;
}
@ -196,21 +176,17 @@ class TAR extends Archive {
/**
* get the last modified time of a file in the archive
*
* @param string $path
* @return int|false
*/
public function mtime($path) {
public function mtime(string $path) {
$stat = $this->getHeader($path);
return $stat['mtime'] ?? false;
}
/**
* get the files in a folder
*
* @param string $path
* @return array
*/
public function getFolder($path) {
public function getFolder(string $path): array {
$files = $this->getFiles();
$folderContent = [];
$pathLength = strlen($path);
@ -233,10 +209,8 @@ class TAR extends Archive {
/**
* get all files in the archive
*
* @return array
*/
public function getFiles() {
public function getFiles(): array {
if ($this->fileList) {
return $this->fileList;
}
@ -254,10 +228,9 @@ class TAR extends Archive {
/**
* get the content of a file
*
* @param string $path
* @return string|false
*/
public function getFile($path) {
public function getFile(string $path) {
$string = $this->tar->extractInString($path);
if (is_string($string)) {
return $string;
@ -268,12 +241,8 @@ class TAR extends Archive {
/**
* extract a single file from the archive
*
* @param string $path
* @param string $dest
* @return bool
*/
public function extractFile($path, $dest) {
public function extractFile(string $path, string $dest): bool {
$tmp = \OC::$server->getTempManager()->getTemporaryFolder();
if (!$this->fileExists($path)) {
return false;
@ -292,21 +261,15 @@ class TAR extends Archive {
/**
* extract the archive
*
* @param string $dest
* @return bool
*/
public function extract($dest) {
public function extract(string $dest): bool {
return $this->tar->extract($dest);
}
/**
* check if a file or folder exists in the archive
*
* @param string $path
* @return bool
*/
public function fileExists($path) {
public function fileExists(string $path): bool {
$files = $this->getFiles();
if ((array_search($path, $files) !== false) or (array_search($path . '/', $files) !== false)) {
return true;
@ -328,11 +291,8 @@ class TAR extends Archive {
/**
* remove a file or folder from the archive
*
* @param string $path
* @return bool
*/
public function remove($path) {
public function remove(string $path): bool {
if (!$this->fileExists($path)) {
return false;
}
@ -352,13 +312,12 @@ class TAR extends Archive {
/**
* get a file handler
*
* @param string $path
* @param string $mode
* @return bool|resource
*/
public function getStream($path, $mode) {
if (strrpos($path, '.') !== false) {
$ext = substr($path, strrpos($path, '.'));
public function getStream(string $path, string $mode) {
$lastPoint = strrpos($path, '.');
if ($lastPoint !== false) {
$ext = substr($path, $lastPoint);
} else {
$ext = '';
}
@ -380,11 +339,8 @@ class TAR extends Archive {
/**
* write back temporary files
* @param string $tmpFile
* @param string $path
* @return void
*/
public function writeBack($tmpFile, $path) {
public function writeBack(string $tmpFile, string $path): void {
$this->addFile($path, $tmpFile);
unlink($tmpFile);
}

77
lib/private/Archive/ZIP.php
View file

@ -45,10 +45,7 @@ class ZIP extends Archive {
*/
private $path;
/**
* @param string $source
*/
public function __construct($source) {
public function __construct(string $source) {
$this->path = $source;
$this->zip = new \ZipArchive();
if ($this->zip->open($source, \ZipArchive::CREATE)) {
@ -56,21 +53,21 @@ class ZIP extends Archive {
\OC::$server->get(LoggerInterface::class)->warning('Error while opening archive '.$source, ['app' => 'files_archive']);
}
}
/**
* add an empty folder to the archive
* @param string $path
* @return bool
*/
public function addFolder($path) {
public function addFolder(string $path): bool {
return $this->zip->addEmptyDir($path);
}
/**
* add a file to the archive
* @param string $path
* @param string $source either a local file or string data
* @return bool
*/
public function addFile($path, $source = '') {
public function addFile(string $path, string $source = ''): bool {
if ($source and $source[0] == '/' and file_exists($source)) {
$result = $this->zip->addFile($source, $path);
} else {
@ -82,40 +79,37 @@ class ZIP extends Archive {
}
return $result;
}
/**
* rename a file or folder in the archive
* @param string $source
* @param string $dest
* @return bool
*/
public function rename($source, $dest) {
public function rename(string $source, string $dest): bool {
$source = $this->stripPath($source);
$dest = $this->stripPath($dest);
return $this->zip->renameName($source, $dest);
}
/**
* get the uncompressed size of a file in the archive
* @param string $path
* @return int|false
*/
public function filesize($path) {
public function filesize(string $path) {
$stat = $this->zip->statName($path);
return $stat['size'] ?? false;
}
/**
* get the last modified time of a file in the archive
* @param string $path
* @return int|false
*/
public function mtime($path) {
public function mtime(string $path) {
return filemtime($this->path);
}
/**
* get the files in a folder
* @param string $path
* @return array
*/
public function getFolder($path) {
public function getFolder(string $path): array {
$files = $this->getFiles();
$folderContent = [];
$pathLength = strlen($path);
@ -128,11 +122,11 @@ class ZIP extends Archive {
}
return $folderContent;
}
/**
* get all files in the archive
* @return array
*/
public function getFiles() {
public function getFiles(): array {
$fileCount = $this->zip->numFiles;
$files = [];
for ($i = 0;$i < $fileCount;$i++) {
@ -140,62 +134,56 @@ class ZIP extends Archive {
}
return $files;
}
/**
* get the content of a file
* @param string $path
* @return string|false
*/
public function getFile($path) {
public function getFile(string $path) {
return $this->zip->getFromName($path);
}
/**
* extract a single file from the archive
* @param string $path
* @param string $dest
* @return bool
*/
public function extractFile($path, $dest) {
public function extractFile(string $path, string $dest): bool {
$fp = $this->zip->getStream($path);
if ($fp === false) {
return false;
}
return file_put_contents($dest, $fp) !== false;
}
/**
* extract the archive
* @param string $dest
* @return bool
*/
public function extract($dest) {
public function extract(string $dest): bool {
return $this->zip->extractTo($dest);
}
/**
* check if a file or folder exists in the archive
* @param string $path
* @return bool
*/
public function fileExists($path) {
public function fileExists(string $path): bool {
return ($this->zip->locateName($path) !== false) or ($this->zip->locateName($path.'/') !== false);
}
/**
* remove a file or folder from the archive
* @param string $path
* @return bool
*/
public function remove($path) {
public function remove(string $path): bool {
if ($this->fileExists($path.'/')) {
return $this->zip->deleteName($path.'/');
} else {
return $this->zip->deleteName($path);
}
}
/**
* get a file handler
* @param string $path
* @param string $mode
* @return bool|resource
*/
public function getStream($path, $mode) {
public function getStream(string $path, string $mode) {
if ($mode == 'r' or $mode == 'rb') {
return $this->zip->getStream($path);
} else {
@ -221,20 +209,13 @@ class ZIP extends Archive {
/**
* write back temporary files
* @param string $tmpFile
* @param string $path
* @return void
*/
public function writeBack($tmpFile, $path) {
public function writeBack(string $tmpFile, string $path): void {
$this->addFile($path, $tmpFile);
unlink($tmpFile);
}
/**
* @param string $path
* @return string
*/
private function stripPath($path) {
private function stripPath(string $path): string {
if (!$path || $path[0] == '/') {
return substr($path, 1);
} else {