nextcloud/lib/files/storage/common.php

291 lines
7.3 KiB
PHP
Raw Normal View History

<?php
/**
2012-09-07 20:30:48 +04:00
* Copyright (c) 2012 Robin Appelman <icewind@owncloud.com>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace OC\Files\Storage;
/**
2012-08-29 10:38:33 +04:00
* Storage backend class for providing common filesystem operation methods
* which are not storage-backend specific.
*
2012-09-07 20:30:48 +04:00
* \OC\Files\Storage\Common is never used directly; it is extended by all other
2012-08-29 10:38:33 +04:00
* storage backends, where its methods may be overridden, and additional
* (backend-specific) methods are defined.
*
2012-09-07 20:30:48 +04:00
* Some \OC\Files\Storage\Common methods call functions which are first defined
* in classes which extend it, e.g. $this->stat() .
*/
2012-09-07 20:30:48 +04:00
abstract class Common extends \OC\Files\Storage\Storage {
2012-09-07 17:22:01 +04:00
public function __construct($parameters) {}
2012-09-13 00:50:10 +04:00
// abstract public function getId();
// abstract public function mkdir($path);
// abstract public function rmdir($path);
// abstract public function opendir($path);
2012-09-07 17:22:01 +04:00
public function is_dir($path) {
return $this->filetype($path)=='dir';
}
2012-09-07 17:22:01 +04:00
public function is_file($path) {
return $this->filetype($path)=='file';
}
// abstract public function stat($path);
// abstract public function filetype($path);
public function filesize($path) {
2012-09-07 17:22:01 +04:00
if($this->is_dir($path)) {
return 0;//by definition
}else{
$stat = $this->stat($path);
return $stat['size'];
}
}
public function isCreatable($path) {
return $this->isUpdatable($path);
}
// abstract public function isReadable($path);
// abstract public function isUpdatable($path);
public function isDeletable($path) {
return $this->isUpdatable($path);
}
public function isSharable($path) {
return $this->isReadable($path);
}
public function getPermissions($path){
$permissions = 0;
if($this->isCreatable($path)){
$permissions |= OCP\Share::PERMISSION_CREATE;
}
if($this->isReadable($path)){
$permissions |= OCP\Share::PERMISSION_READ;
}
if($this->isUpdatable($path)){
$permissions |= OCP\Share::PERMISSION_UPDATE;
}
if($this->isDeletable($path)){
$permissions |= OCP\Share::PERMISSION_DELETE;
}
if($this->isSharable($path)){
$permissions |= OCP\Share::PERMISSION_SHARE;
}
return $permissions;
}
// abstract public function file_exists($path);
public function filectime($path) {
$stat = $this->stat($path);
return $stat['ctime'];
}
public function filemtime($path) {
$stat = $this->stat($path);
return $stat['mtime'];
}
public function fileatime($path) {
$stat = $this->stat($path);
return $stat['atime'];
}
public function file_get_contents($path) {
$handle = $this->fopen($path, "r");
2012-09-07 17:22:01 +04:00
if(!$handle) {
return false;
}
$size=$this->filesize($path);
2012-09-07 17:22:01 +04:00
if($size==0) {
return '';
}
return fread($handle, $size);
}
public function file_put_contents($path,$data) {
$handle = $this->fopen($path, "w");
return fwrite($handle, $data);
}
// abstract public function unlink($path);
2012-09-07 17:22:01 +04:00
public function rename($path1,$path2) {
if($this->copy($path1,$path2)) {
return $this->unlink($path1);
}else{
return false;
}
}
public function copy($path1,$path2) {
$source=$this->fopen($path1,'r');
$target=$this->fopen($path2,'w');
2012-09-07 20:30:48 +04:00
$count=\OC_Helper::streamCopy($source,$target);
return $count>0;
}
// abstract public function fopen($path,$mode);
/**
* @brief Deletes all files and folders recursively within a directory
* @param $directory The directory whose contents will be deleted
* @param $empty Flag indicating whether directory will be emptied
* @returns true/false
*
2012-08-29 10:38:33 +04:00
* @note By default the directory specified by $directory will be
* deleted together with its contents. To avoid this set $empty to true
*/
public function deleteAll( $directory, $empty = false ) {
2012-08-29 10:38:33 +04:00
// strip leading slash
if( substr( $directory, 0, 1 ) == "/" ) {
2012-08-29 10:38:33 +04:00
$directory = substr( $directory, 1 );
2012-08-29 10:38:33 +04:00
}
2012-08-29 10:38:33 +04:00
// strip trailing slash
if( substr( $directory, -1) == "/" ) {
2012-08-29 10:38:33 +04:00
$directory = substr( $directory, 0, -1 );
2012-08-29 10:38:33 +04:00
}
2012-08-29 10:38:33 +04:00
if ( !$this->file_exists( \OCP\USER::getUser() . '/' . $directory ) || !$this->is_dir( \OCP\USER::getUser() . '/' . $directory ) ) {
2012-08-29 10:38:33 +04:00
return false;
2012-08-29 10:38:33 +04:00
} elseif( !$this->is_readable( \OCP\USER::getUser() . '/' . $directory ) ) {
2012-08-29 10:38:33 +04:00
return false;
2012-08-29 10:38:33 +04:00
} else {
2012-08-29 10:38:33 +04:00
$directoryHandle = $this->opendir( \OCP\USER::getUser() . '/' . $directory );
2012-08-29 10:38:33 +04:00
while ( $contents = readdir( $directoryHandle ) ) {
2012-08-29 10:38:33 +04:00
if ( $contents != '.' && $contents != '..') {
2012-08-29 10:38:33 +04:00
$path = $directory . "/" . $contents;
2012-08-29 10:38:33 +04:00
if ( $this->is_dir( $path ) ) {
2012-08-29 10:38:33 +04:00
deleteAll( $path );
2012-08-29 10:38:33 +04:00
} else {
2012-08-29 10:38:33 +04:00
$this->unlink( \OCP\USER::getUser() .'/' . $path ); // TODO: make unlink use same system path as is_dir
2012-08-29 10:38:33 +04:00
}
}
2012-08-29 10:38:33 +04:00
}
2012-08-29 10:38:33 +04:00
//$this->closedir( $directoryHandle ); // TODO: implement closedir in OC_FSV
if ( $empty == false ) {
2012-08-29 10:38:33 +04:00
if ( !$this->rmdir( $directory ) ) {
2012-08-29 10:38:33 +04:00
return false;
2012-08-29 10:38:33 +04:00
}
2012-08-29 10:38:33 +04:00
}
2012-08-29 10:38:33 +04:00
return true;
}
2012-08-29 10:38:33 +04:00
}
2012-09-07 17:22:01 +04:00
public function getMimeType($path) {
if(!$this->file_exists($path)) {
return false;
}
2012-09-07 17:22:01 +04:00
if($this->is_dir($path)) {
return 'httpd/unix-directory';
}
$source=$this->fopen($path,'r');
2012-09-07 17:22:01 +04:00
if(!$source) {
return false;
}
$head=fread($source,8192);//8kb should suffice to determine a mimetype
2012-09-07 17:22:01 +04:00
if($pos=strrpos($path,'.')) {
$extension=substr($path,$pos);
}else{
$extension='';
}
2012-09-07 20:30:48 +04:00
$tmpFile=\OC_Helper::tmpFile($extension);
file_put_contents($tmpFile,$head);
2012-09-07 20:30:48 +04:00
$mime=\OC_Helper::getMimeType($tmpFile);
unlink($tmpFile);
return $mime;
}
2012-09-07 17:22:01 +04:00
public function hash($type,$path,$raw = false) {
$tmpFile=$this->getLocalFile();
$hash=hash($type,$tmpFile,$raw);
unlink($tmpFile);
return $hash;
}
// abstract public function free_space($path);
2012-09-07 17:22:01 +04:00
public function search($query) {
return $this->searchInDir($query);
}
2012-09-07 17:22:01 +04:00
public function getLocalFile($path) {
2012-02-28 15:06:34 +04:00
return $this->toTmpFile($path);
}
2012-09-07 17:22:01 +04:00
private function toTmpFile($path) {//no longer in the storage api, still usefull here
$source=$this->fopen($path,'r');
2012-09-07 17:22:01 +04:00
if(!$source) {
return false;
}
2012-09-07 17:22:01 +04:00
if($pos=strrpos($path,'.')) {
$extension=substr($path,$pos);
}else{
$extension='';
}
2012-09-07 20:30:48 +04:00
$tmpFile=\OC_Helper::tmpFile($extension);
2012-02-28 15:06:34 +04:00
$target=fopen($tmpFile,'w');
2012-09-07 20:30:48 +04:00
\OC_Helper::streamCopy($source,$target);
return $tmpFile;
}
2012-09-07 17:22:01 +04:00
public function getLocalFolder($path) {
2012-09-07 20:30:48 +04:00
$baseDir=\OC_Helper::tmpFolder();
2012-08-19 04:30:33 +04:00
$this->addLocalFolder($path,$baseDir);
return $baseDir;
}
2012-09-07 17:22:01 +04:00
private function addLocalFolder($path,$target) {
if($dh=$this->opendir($path)) {
while($file=readdir($dh)) {
if($file!=='.' and $file!=='..') {
if($this->is_dir($path.'/'.$file)) {
2012-08-19 04:30:33 +04:00
mkdir($target.'/'.$file);
$this->addLocalFolder($path.'/'.$file,$target.'/'.$file);
}else{
$tmp=$this->toTmpFile($path.'/'.$file);
rename($tmp,$target.'/'.$file);
}
}
}
}
}
// abstract public function touch($path, $mtime=null);
2012-09-07 17:22:01 +04:00
protected function searchInDir($query,$dir='') {
$files=array();
$dh=$this->opendir($dir);
2012-09-07 17:22:01 +04:00
if($dh) {
while($item=readdir($dh)) {
if ($item == '.' || $item == '..') continue;
2012-09-07 17:22:01 +04:00
if(strstr(strtolower($item),strtolower($query))!==false) {
$files[]=$dir.'/'.$item;
}
2012-09-07 17:22:01 +04:00
if($this->is_dir($dir.'/'.$item)) {
$files=array_merge($files,$this->searchInDir($query,$dir.'/'.$item));
}
}
}
return $files;
}
2012-06-15 18:43:24 +04:00
/**
* check if a file or folder has been updated since $time
* @param int $time
* @return bool
*/
2012-09-07 17:22:01 +04:00
public function hasUpdated($path,$time) {
2012-06-15 18:43:24 +04:00
return $this->filemtime($path)>$time;
}
}