nextcloud/lib/private/Files/Storage/Flysystem.php

258 lines
5.6 KiB
PHP
Raw Normal View History

2015-06-12 19:44:48 +03:00
<?php
/**
2016-01-12 17:02:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
2016-07-22 10:45:36 +03:00
*
* @author Robin Appelman <robin@icewind.nl>
*
2015-10-05 21:54:56 +03:00
* @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-06-12 19:44:48 +03:00
*/
namespace OC\Files\Storage;
use Icewind\Streams\CallbackWrapper;
use Icewind\Streams\IteratorDirectory;
use League\Flysystem\AdapterInterface;
use League\Flysystem\FileNotFoundException;
use League\Flysystem\Filesystem;
use League\Flysystem\Plugin\GetWithMetadata;
2015-07-03 14:57:39 +03:00
/**
* Generic adapter between flysystem adapters and owncloud's storage system
*
* To use: subclass and call $this->buildFlysystem with the flysystem adapter of choice
*/
2015-06-12 19:44:48 +03:00
abstract class Flysystem extends Common {
/**
* @var Filesystem
*/
protected $flysystem;
/**
* @var string
*/
protected $root = '';
2015-07-03 14:57:39 +03:00
/**
* Initialize the storage backend with a flyssytem adapter
*
* @param \League\Flysystem\AdapterInterface $adapter
*/
2015-06-12 19:44:48 +03:00
protected function buildFlySystem(AdapterInterface $adapter) {
$this->flysystem = new Filesystem($adapter);
$this->flysystem->addPlugin(new GetWithMetadata());
}
protected function buildPath($path) {
$fullPath = \OC\Files\Filesystem::normalizePath($this->root . '/' . $path);
return ltrim($fullPath, '/');
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function file_get_contents($path) {
return $this->flysystem->read($this->buildPath($path));
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function file_put_contents($path, $data) {
return $this->flysystem->put($this->buildPath($path), $data);
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function file_exists($path) {
return $this->flysystem->has($this->buildPath($path));
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function unlink($path) {
if ($this->is_dir($path)) {
return $this->rmdir($path);
}
try {
return $this->flysystem->delete($this->buildPath($path));
} catch (FileNotFoundException $e) {
return false;
}
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function rename($source, $target) {
if ($this->file_exists($target)) {
$this->unlink($target);
}
return $this->flysystem->rename($this->buildPath($source), $this->buildPath($target));
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function copy($source, $target) {
if ($this->file_exists($target)) {
$this->unlink($target);
}
return $this->flysystem->copy($this->buildPath($source), $this->buildPath($target));
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function filesize($path) {
if ($this->is_dir($path)) {
return 0;
} else {
return $this->flysystem->getSize($this->buildPath($path));
}
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function mkdir($path) {
if ($this->file_exists($path)) {
return false;
}
return $this->flysystem->createDir($this->buildPath($path));
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function filemtime($path) {
return $this->flysystem->getTimestamp($this->buildPath($path));
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function rmdir($path) {
try {
return @$this->flysystem->deleteDir($this->buildPath($path));
} catch (FileNotFoundException $e) {
return false;
}
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function opendir($path) {
try {
$content = $this->flysystem->listContents($this->buildPath($path));
} catch (FileNotFoundException $e) {
return false;
}
$names = array_map(function ($object) {
return $object['basename'];
}, $content);
return IteratorDirectory::wrap($names);
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function fopen($path, $mode) {
$fullPath = $this->buildPath($path);
$useExisting = true;
switch ($mode) {
case 'r':
case 'rb':
try {
return $this->flysystem->readStream($fullPath);
} catch (FileNotFoundException $e) {
return false;
}
case 'w':
case 'w+':
2015-06-12 19:44:48 +03:00
case 'wb':
case 'wb+':
2015-06-12 19:44:48 +03:00
$useExisting = false;
case 'a':
case 'ab':
case 'r+':
case 'a+':
case 'x':
case 'x+':
case 'c':
case 'c+':
//emulate these
if ($useExisting and $this->file_exists($path)) {
if (!$this->isUpdatable($path)) {
return false;
}
$tmpFile = $this->getCachedFile($path);
} else {
if (!$this->isCreatable(dirname($path))) {
return false;
}
$tmpFile = \OCP\Files::tmpFile();
}
$source = fopen($tmpFile, $mode);
return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath) {
$this->flysystem->putStream($fullPath, fopen($tmpFile, 'r'));
unlink($tmpFile);
});
}
return false;
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function touch($path, $mtime = null) {
if ($this->file_exists($path)) {
return false;
} else {
$this->file_put_contents($path, '');
return true;
}
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function stat($path) {
$info = $this->flysystem->getWithMetadata($this->buildPath($path), ['timestamp', 'size']);
return [
'mtime' => $info['timestamp'],
'size' => $info['size']
];
}
2015-07-03 14:57:39 +03:00
/**
* {@inheritdoc}
*/
2015-06-12 19:44:48 +03:00
public function filetype($path) {
if ($path === '' or $path === '/' or $path === '.') {
return 'dir';
}
try {
$info = $this->flysystem->getMetadata($this->buildPath($path));
} catch (FileNotFoundException $e) {
return false;
}
return $info['type'];
}
}