aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Archive
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Archive')
-rw-r--r--lib/private/Archive/Archive.php113
-rw-r--r--lib/private/Archive/TAR.php173
-rw-r--r--lib/private/Archive/ZIP.php169
3 files changed, 178 insertions, 277 deletions
diff --git a/lib/private/Archive/Archive.php b/lib/private/Archive/Archive.php
index 20d56e50e76..874087fb167 100644
--- a/lib/private/Archive/Archive.php
+++ b/lib/private/Archive/Archive.php
@@ -1,127 +1,90 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Christopher Schäpers <kondou@ts.unde.re>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
-
namespace OC\Archive;
abstract class Archive {
- /**
- * @param $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
*/
- abstract public function filesize($path);
+ abstract public function filesize(string $path): false|int|float;
+
/**
* get the last modified time of a file in the archive
- * @param string $path
- * @return int
+ * @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
+ * @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
*/
- 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
*/
- public function addRecursive($path, $source) {
+ public function addRecursive(string $path, string $source): void {
$dh = opendir($source);
if (is_resource($dh)) {
$this->addFolder($path);
@@ -129,10 +92,10 @@ abstract class Archive {
if ($file === '.' || $file === '..') {
continue;
}
- if (is_dir($source.'/'.$file)) {
- $this->addRecursive($path.'/'.$file, $source.'/'.$file);
+ if (is_dir($source . '/' . $file)) {
+ $this->addRecursive($path . '/' . $file, $source . '/' . $file);
} else {
- $this->addFile($path.'/'.$file, $source.'/'.$file);
+ $this->addFile($path . '/' . $file, $source . '/' . $file);
}
}
}
diff --git a/lib/private/Archive/TAR.php b/lib/private/Archive/TAR.php
index f68813752cc..e08720a75a5 100644
--- a/lib/private/Archive/TAR.php
+++ b/lib/private/Archive/TAR.php
@@ -1,36 +1,10 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Bart Visscher <bartv@thisnet.nl>
- * @author Christopher Schäpers <kondou@ts.unde.re>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Daniel Kesselberg <mail@danielkesselberg.de>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Remco Brenninkmeijer <requist1@starmail.nl>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Robin McCorkell <robin@mccorkell.me.uk>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
-
namespace OC\Archive;
use Icewind\Streams\CallbackWrapper;
@@ -40,19 +14,20 @@ class TAR extends Archive {
public const GZIP = 1;
public const BZIP = 2;
- private $fileList;
- private $cachedHeaders;
-
/**
- * @var \Archive_Tar tar
+ * @var string[]|false
*/
- private $tar = null;
- private $path;
-
+ private $fileList = false;
/**
- * @param string $source
+ * @var array|false
*/
- public function __construct($source) {
+ private $cachedHeaders = false;
+
+ private \Archive_Tar $tar;
+
+ private string $path;
+
+ public function __construct(string $source) {
$types = [null, 'gz', 'bz2'];
$this->path = $source;
$this->tar = new \Archive_Tar($source, $types[self::getTarType($source)]);
@@ -60,11 +35,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) {
@@ -86,11 +58,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)) {
@@ -114,11 +83,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);
}
@@ -133,17 +100,13 @@ 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);
rename($tmp . $source, $tmp . $dest);
- $this->tar = null;
+ $this->tar->_close();
unlink($this->path);
$types = [null, 'gz', 'bz'];
$this->tar = new \Archive_Tar($this->path, $types[self::getTarType($this->path)]);
@@ -153,10 +116,7 @@ class TAR extends Archive {
return true;
}
- /**
- * @param string $file
- */
- private function getHeader($file) {
+ private function getHeader(string $file): ?array {
if (!$this->cachedHeaders) {
$this->cachedHeaders = $this->tar->listContent();
}
@@ -174,33 +134,26 @@ class TAR extends Archive {
/**
* get the uncompressed size of a file in the archive
- *
- * @param string $path
- * @return int
*/
- public function filesize($path) {
+ public function filesize(string $path): false|int|float {
$stat = $this->getHeader($path);
- return $stat['size'];
+ return $stat['size'] ?? false;
}
/**
* get the last modified time of a file in the archive
*
- * @param string $path
- * @return int
+ * @return int|false
*/
- public function mtime($path) {
+ public function mtime(string $path) {
$stat = $this->getHeader($path);
- return $stat['mtime'];
+ 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);
@@ -213,7 +166,7 @@ class TAR extends Archive {
if ($pos = strpos($result, '/')) {
$result = substr($result, 0, $pos + 1);
}
- if (array_search($result, $folderContent) === false) {
+ if (!in_array($result, $folderContent)) {
$folderContent[] = $result;
}
}
@@ -223,15 +176,18 @@ class TAR extends Archive {
/**
* get all files in the archive
- *
- * @return array
*/
- public function getFiles() {
- if ($this->fileList) {
+ public function getFiles(): array {
+ if ($this->fileList !== false) {
return $this->fileList;
}
- if (!$this->cachedHeaders) {
- $this->cachedHeaders = $this->tar->listContent();
+ if ($this->cachedHeaders === false) {
+ $headers = $this->tar->listContent();
+ if (is_array($headers)) {
+ $this->cachedHeaders = $headers;
+ } else {
+ return [];
+ }
}
$files = [];
foreach ($this->cachedHeaders as $header) {
@@ -244,21 +200,22 @@ class TAR extends Archive {
/**
* get the content of a file
*
- * @param string $path
- * @return string
+ * @return string|false
*/
- public function getFile($path) {
- return $this->tar->extractInString($path);
+ public function getFile(string $path) {
+ $string = $this->tar->extractInString($path);
+ /** @var ?string $string */
+ if (is_string($string)) {
+ return $string;
+ } else {
+ return false;
+ }
}
/**
* 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;
@@ -277,23 +234,17 @@ 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)) {
+ if ((in_array($path, $files)) or (in_array($path . '/', $files))) {
return true;
} else {
$folderPath = rtrim($path, '/') . '/';
@@ -313,11 +264,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;
}
@@ -327,7 +275,6 @@ class TAR extends Archive {
$tmp = \OC::$server->getTempManager()->getTemporaryFolder();
$this->tar->extract($tmp);
\OCP\Files::rmdirr($tmp . $path);
- $this->tar = null;
unlink($this->path);
$this->reopen();
$this->tar->createModify([$tmp], '', $tmp);
@@ -337,13 +284,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 = '';
}
@@ -366,7 +312,7 @@ class TAR extends Archive {
/**
* write back temporary files
*/
- public function writeBack($tmpFile, $path) {
+ public function writeBack(string $tmpFile, string $path): void {
$this->addFile($path, $tmpFile);
unlink($tmpFile);
}
@@ -374,11 +320,8 @@ class TAR extends Archive {
/**
* reopen the archive to ensure everything is written
*/
- private function reopen() {
- if ($this->tar) {
- $this->tar->_close();
- $this->tar = null;
- }
+ private function reopen(): void {
+ $this->tar->_close();
$types = [null, 'gz', 'bz'];
$this->tar = new \Archive_Tar($this->path, $types[self::getTarType($this->path)]);
}
@@ -387,7 +330,7 @@ class TAR extends Archive {
* Get error object from archive_tar.
*/
public function getError(): ?\PEAR_Error {
- if ($this->tar instanceof \Archive_Tar && $this->tar->error_object instanceof \PEAR_Error) {
+ if ($this->tar->error_object instanceof \PEAR_Error) {
return $this->tar->error_object;
}
return null;
diff --git a/lib/private/Archive/ZIP.php b/lib/private/Archive/ZIP.php
index 96894bac6e9..61fd25d071d 100644
--- a/lib/private/Archive/ZIP.php
+++ b/lib/private/Archive/ZIP.php
@@ -1,73 +1,49 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Bart Visscher <bartv@thisnet.nl>
- * @author Christopher Schäpers <kondou@ts.unde.re>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Stefan Weil <sw@weilnetz.de>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
-
namespace OC\Archive;
use Icewind\Streams\CallbackWrapper;
-use OCP\ILogger;
+use Psr\Log\LoggerInterface;
class ZIP extends Archive {
/**
* @var \ZipArchive zip
*/
- private $zip = null;
- private $path;
+ private $zip;
/**
- * @param string $source
+ * @var string
*/
- public function __construct($source) {
+ private $path;
+
+ public function __construct(string $source) {
$this->path = $source;
$this->zip = new \ZipArchive();
if ($this->zip->open($source, \ZipArchive::CREATE)) {
} else {
- \OCP\Util::writeLog('files_archive', 'Error while opening archive '.$source, ILogger::WARN);
+ \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 {
@@ -79,40 +55,39 @@ class ZIP extends Archive {
}
return $result;
}
+
/**
* rename a file or folder in the archive
- * @param string $source
- * @param string $dest
- * @return boolean|null
*/
- public function rename($source, $dest) {
+ public function rename(string $source, string $dest): bool {
$source = $this->stripPath($source);
$dest = $this->stripPath($dest);
- $this->zip->renameName($source, $dest);
+ return $this->zip->renameName($source, $dest);
}
+
/**
* get the uncompressed size of a file in the archive
- * @param string $path
- * @return int
*/
- public function filesize($path) {
+ public function filesize(string $path): false|int|float {
$stat = $this->zip->statName($path);
- return $stat['size'];
+ return $stat['size'] ?? false;
}
+
/**
* get the last modified time of a file in the archive
- * @param string $path
- * @return int
+ * @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 {
+ // FIXME: multiple calls on getFolder would traverse
+ // the whole file list over and over again
+ // maybe use a Generator or cache the list ?
$files = $this->getFiles();
$folderContent = [];
$pathLength = strlen($path);
@@ -125,11 +100,37 @@ class ZIP extends Archive {
}
return $folderContent;
}
+
+ /**
+ * Generator that returns metadata of all files
+ *
+ * @return \Generator<array>
+ */
+ public function getAllFilesStat() {
+ $fileCount = $this->zip->numFiles;
+ for ($i = 0;$i < $fileCount;$i++) {
+ yield $this->zip->statIndex($i);
+ }
+ }
+
+ /**
+ * Return stat information for the given path
+ *
+ * @param string path path to get stat information on
+ * @return ?array stat information or null if not found
+ */
+ public function getStat(string $path): ?array {
+ $stat = $this->zip->statName($path);
+ if (!$stat) {
+ return null;
+ }
+ return $stat;
+ }
+
/**
* 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++) {
@@ -137,67 +138,65 @@ class ZIP extends Archive {
}
return $files;
}
+
/**
* get the content of a file
- * @param string $path
- * @return string
+ * @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 boolean|null
*/
- public function extractFile($path, $dest) {
+ public function extractFile(string $path, string $dest): bool {
$fp = $this->zip->getStream($path);
- file_put_contents($dest, $fp);
+ 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) {
- return ($this->zip->locateName($path) !== false) or ($this->zip->locateName($path.'/') !== false);
+ 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) {
- if ($this->fileExists($path.'/')) {
- return $this->zip->deleteName($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 {
//since we can't directly get a writable stream,
//make a temp copy of the file and put it back
//in the archive when the stream is closed
- if (strrpos($path, '.') !== false) {
- $ext = substr($path, strrpos($path, '.'));
+ $lastPoint = strrpos($path, '.');
+ if ($lastPoint !== false) {
+ $ext = substr($path, $lastPoint);
} else {
$ext = '';
}
@@ -215,16 +214,12 @@ class ZIP extends Archive {
/**
* write back temporary files
*/
- 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 {
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-16 07:15:22 +0000