nextcloud/lib/private/Archive/Archive.php

141 lines
3.6 KiB
PHP
Raw Normal View History

<?php
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2016-05-26 20:56:05 +03:00
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
2015-03-26 13:44:34 +03:00
* @author Christopher Schäpers <kondou@ts.unde.re>
2016-07-21 18:07:57 +03:00
* @author Joas Schilling <coding@schilljs.com>
2015-03-26 13:44:34 +03:00
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
2016-05-26 20:56:05 +03:00
* @author Lukas Reschke <lukas@statuscode.ch>
2015-03-26 13:44:34 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2016-07-21 18:07:57 +03:00
* @author Roeland Jago Douma <roeland@famdouma.nl>
2015-03-26 13:44:34 +03:00
* @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/>
2015-03-26 13:44:34 +03:00
*
*/
namespace OC\Archive;
abstract class Archive {
2014-04-21 17:44:54 +04:00
/**
* @param $source
*/
public abstract function __construct($source);
/**
* add an empty folder to the archive
* @param string $path
* @return bool
*/
public abstract function addFolder($path);
/**
* add a file to the archive
* @param string $path
2014-04-21 17:44:54 +04:00
* @param string $source either a local file or string data
* @return bool
*/
public abstract function addFile($path, $source='');
/**
* rename a file or folder in the archive
* @param string $source
* @param string $dest
* @return bool
*/
public abstract function rename($source, $dest);
/**
* get the uncompressed size of a file in the archive
* @param string $path
* @return int
*/
public abstract function filesize($path);
/**
* get the last modified time of a file in the archive
* @param string $path
* @return int
*/
public abstract function mtime($path);
/**
* get the files in a folder
* @param string $path
* @return array
*/
public abstract function getFolder($path);
/**
2013-07-16 07:56:52 +04:00
* get all files in the archive
* @return array
*/
public abstract function getFiles();
/**
* get the content of a file
* @param string $path
* @return string
*/
public abstract function getFile($path);
/**
* extract a single file from the archive
* @param string $path
* @param string $dest
* @return bool
*/
public abstract function extractFile($path, $dest);
2012-03-29 00:31:45 +04:00
/**
* extract the archive
* @param string $dest
2012-03-29 00:31:45 +04:00
* @return bool
*/
public abstract function extract($dest);
/**
* check if a file or folder exists in the archive
* @param string $path
* @return bool
*/
public abstract function fileExists($path);
/**
* remove a file or folder from the archive
* @param string $path
* @return bool
*/
public abstract function remove($path);
/**
* get a file handler
* @param string $path
* @param string $mode
* @return resource
*/
public abstract function getStream($path, $mode);
2012-08-18 03:17:28 +04:00
/**
2013-07-16 07:56:52 +04:00
* add a folder and all its content
2012-08-18 03:17:28 +04:00
* @param string $path
* @param string $source
2012-08-18 03:17:28 +04:00
*/
public function addRecursive($path, $source) {
$dh = opendir($source);
if (is_resource($dh)) {
2012-08-18 03:17:28 +04:00
$this->addFolder($path);
while (($file = readdir($dh)) !== false) {
if ($file === '.' || $file === '..') {
2012-08-18 03:17:28 +04:00
continue;
}
if (is_dir($source.'/'.$file)) {
2012-10-05 14:39:43 +04:00
$this->addRecursive($path.'/'.$file, $source.'/'.$file);
} else {
2012-10-05 14:39:43 +04:00
$this->addFile($path.'/'.$file, $source.'/'.$file);
2012-08-18 03:17:28 +04:00
}
}
}
}
}