aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Archive/TAR.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Archive/TAR.php')
-rw-r--r--lib/private/Archive/TAR.php173
1 files changed, 58 insertions, 115 deletions
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;
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 18:30:13 +0000