2011-07-20 17:53:34 +04:00
|
|
|
<?php
|
|
|
|
/**
|
2015-02-18 20:28:24 +03:00
|
|
|
* @author Arthur Schiwon <blizzz@owncloud.com>
|
|
|
|
* @author Bart Visscher <bartv@thisnet.nl>
|
|
|
|
* @author Jakob Sack <mail@jakobsack.de>
|
|
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
|
|
|
* @author Klaas Freitag <freitag@owncloud.com>
|
|
|
|
* @author Markus Goetz <markus@woboq.com>
|
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
|
|
* @author Robin Appelman <icewind@owncloud.com>
|
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
|
|
* @author Vincent Petry <pvince81@owncloud.com>
|
2011-07-20 17:53:34 +04:00
|
|
|
*
|
2015-02-18 20:28:24 +03:00
|
|
|
* @copyright Copyright (c) 2015, ownCloud, Inc.
|
|
|
|
* @license AGPL-3.0
|
2011-07-22 18:21:29 +04:00
|
|
|
*
|
2015-02-18 20:28:24 +03:00
|
|
|
* 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.
|
2011-07-22 18:21:29 +04:00
|
|
|
*
|
2015-02-18 20:28:24 +03:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
2012-05-05 20:13:40 +04:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-02-18 20:28:24 +03:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
2012-05-05 20:13:40 +04:00
|
|
|
*
|
2015-02-18 20:28:24 +03:00
|
|
|
* 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/>
|
2011-07-22 18:21:29 +04:00
|
|
|
*
|
|
|
|
*/
|
2012-10-02 13:44:55 +04:00
|
|
|
|
2015-02-12 14:29:01 +03:00
|
|
|
namespace OC\Connector\Sabre;
|
|
|
|
|
2015-02-18 20:28:24 +03:00
|
|
|
use OC\Connector\Sabre\Exception\InvalidPath;
|
|
|
|
|
|
|
|
|
2015-02-12 14:29:01 +03:00
|
|
|
abstract class Node implements \Sabre\DAV\INode {
|
2012-11-07 17:21:34 +04:00
|
|
|
/**
|
|
|
|
* Allow configuring the method used to generate Etags
|
|
|
|
*
|
|
|
|
* @var array(class_name, function_name)
|
2014-02-25 19:23:09 +04:00
|
|
|
*/
|
2012-11-07 17:21:34 +04:00
|
|
|
public static $ETagFunction = null;
|
|
|
|
|
2013-09-24 17:35:21 +04:00
|
|
|
/**
|
|
|
|
* @var \OC\Files\View
|
|
|
|
*/
|
2014-02-25 19:23:09 +04:00
|
|
|
protected $fileView;
|
2013-09-24 17:35:21 +04:00
|
|
|
|
2011-07-20 17:53:34 +04:00
|
|
|
/**
|
|
|
|
* The path to the current node
|
|
|
|
*
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
protected $path;
|
2013-10-23 18:03:57 +04:00
|
|
|
|
2012-06-15 19:51:56 +04:00
|
|
|
/**
|
|
|
|
* node properties cache
|
2014-02-25 19:23:09 +04:00
|
|
|
*
|
2012-06-15 19:51:56 +04:00
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
protected $property_cache = null;
|
2011-07-20 17:53:34 +04:00
|
|
|
|
2014-02-25 19:23:09 +04:00
|
|
|
/**
|
|
|
|
* @var \OCP\Files\FileInfo
|
|
|
|
*/
|
|
|
|
protected $info;
|
|
|
|
|
2011-07-20 17:53:34 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Sets up the node, expects a full path name
|
2014-02-25 19:23:09 +04:00
|
|
|
* @param \OC\Files\View $view
|
|
|
|
* @param \OCP\Files\FileInfo $info
|
2011-07-20 17:53:34 +04:00
|
|
|
*/
|
2014-02-25 19:23:09 +04:00
|
|
|
public function __construct($view, $info) {
|
|
|
|
$this->fileView = $view;
|
|
|
|
$this->path = $this->fileView->getRelativePath($info->getPath());
|
|
|
|
$this->info = $info;
|
2011-07-20 17:53:34 +04:00
|
|
|
}
|
|
|
|
|
2014-02-25 19:23:09 +04:00
|
|
|
protected function refreshInfo() {
|
|
|
|
$this->info = $this->fileView->getFileInfo($this->path);
|
|
|
|
}
|
2011-07-20 17:53:34 +04:00
|
|
|
|
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Returns the name of the node
|
2011-07-20 17:53:34 +04:00
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getName() {
|
2014-02-25 19:23:09 +04:00
|
|
|
return $this->info->getName();
|
2011-07-20 17:53:34 +04:00
|
|
|
}
|
|
|
|
|
2015-02-12 14:29:01 +03:00
|
|
|
/**
|
|
|
|
* Returns the full path
|
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getPath() {
|
|
|
|
return $this->path;
|
|
|
|
}
|
|
|
|
|
2011-07-20 17:53:34 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Renames the node
|
2011-07-20 17:53:34 +04:00
|
|
|
* @param string $name The new name
|
2014-01-09 17:25:48 +04:00
|
|
|
* @throws \Sabre\DAV\Exception\BadRequest
|
|
|
|
* @throws \Sabre\DAV\Exception\Forbidden
|
2011-07-20 17:53:34 +04:00
|
|
|
*/
|
|
|
|
public function setName($name) {
|
|
|
|
|
2013-09-24 15:26:12 +04:00
|
|
|
// rename is only allowed if the update privilege is granted
|
2014-02-25 19:23:09 +04:00
|
|
|
if (!$this->info->isUpdateable()) {
|
2014-01-09 17:25:48 +04:00
|
|
|
throw new \Sabre\DAV\Exception\Forbidden();
|
2013-09-24 15:26:12 +04:00
|
|
|
}
|
|
|
|
|
2015-02-12 14:29:01 +03:00
|
|
|
list($parentPath,) = \Sabre\HTTP\URLUtil::splitPath($this->path);
|
|
|
|
list(, $newName) = \Sabre\HTTP\URLUtil::splitPath($name);
|
2011-07-20 17:53:34 +04:00
|
|
|
|
2015-02-18 19:44:13 +03:00
|
|
|
// verify path of the target
|
|
|
|
$this->verifyPath();
|
2014-01-13 16:14:05 +04:00
|
|
|
|
2011-07-20 17:53:34 +04:00
|
|
|
$newPath = $parentPath . '/' . $newName;
|
2011-07-23 00:30:45 +04:00
|
|
|
|
2014-02-25 19:23:09 +04:00
|
|
|
$this->fileView->rename($this->path, $newPath);
|
2012-08-29 10:38:33 +04:00
|
|
|
|
2011-07-20 17:53:34 +04:00
|
|
|
$this->path = $newPath;
|
2012-08-29 10:38:33 +04:00
|
|
|
|
2014-02-25 19:23:09 +04:00
|
|
|
$this->refreshInfo();
|
2011-07-20 17:53:34 +04:00
|
|
|
}
|
|
|
|
|
2014-02-25 19:23:09 +04:00
|
|
|
public function setPropertyCache($property_cache) {
|
2012-06-15 19:51:56 +04:00
|
|
|
$this->property_cache = $property_cache;
|
|
|
|
}
|
|
|
|
|
2011-07-20 17:53:34 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Returns the last modification time, as a unix timestamp
|
2014-04-08 13:57:33 +04:00
|
|
|
* @return int timestamp as integer
|
2011-07-20 17:53:34 +04:00
|
|
|
*/
|
|
|
|
public function getLastModified() {
|
2014-04-15 22:03:00 +04:00
|
|
|
$timestamp = $this->info->getMtime();
|
2014-04-08 13:57:33 +04:00
|
|
|
if (!empty($timestamp)) {
|
|
|
|
return (int)$timestamp;
|
|
|
|
}
|
|
|
|
return $timestamp;
|
2011-07-20 17:53:34 +04:00
|
|
|
}
|
|
|
|
|
2012-08-29 10:38:33 +04:00
|
|
|
/**
|
|
|
|
* sets the last modification time of the file (mtime) to the value given
|
2012-02-10 14:30:38 +04:00
|
|
|
* in the second parameter or to now if the second param is empty.
|
|
|
|
* Even if the modification time is set to a custom value the access time is set to now.
|
|
|
|
*/
|
2012-02-14 12:59:54 +04:00
|
|
|
public function touch($mtime) {
|
2014-02-25 19:23:09 +04:00
|
|
|
$this->fileView->touch($this->path, $mtime);
|
|
|
|
$this->refreshInfo();
|
2012-02-10 14:30:38 +04:00
|
|
|
}
|
|
|
|
|
2011-07-22 18:21:29 +04:00
|
|
|
/**
|
2015-02-12 14:29:01 +03:00
|
|
|
* Returns the ETag for a file
|
|
|
|
*
|
|
|
|
* An ETag is a unique identifier representing the current version of the
|
|
|
|
* file. If the file changes, the ETag MUST change. The ETag is an
|
|
|
|
* arbitrary string, but MUST be surrounded by double-quotes.
|
|
|
|
*
|
|
|
|
* Return null if the ETag can not effectively be determined
|
|
|
|
*
|
|
|
|
* @return string
|
2011-07-22 18:21:29 +04:00
|
|
|
*/
|
2015-02-12 14:29:01 +03:00
|
|
|
public function getETag() {
|
|
|
|
return '"' . $this->info->getEtag() . '"';
|
2011-07-22 18:21:29 +04:00
|
|
|
}
|
|
|
|
|
2013-10-22 21:41:26 +04:00
|
|
|
/**
|
2015-02-12 14:29:01 +03:00
|
|
|
* Sets the ETag
|
|
|
|
*
|
|
|
|
* @param string $etag
|
|
|
|
*
|
|
|
|
* @return int file id of updated file or -1 on failure
|
2013-10-22 21:41:26 +04:00
|
|
|
*/
|
2015-02-12 14:29:01 +03:00
|
|
|
public function setETag($etag) {
|
|
|
|
return $this->fileView->putFileInfo($this->path, array('etag' => $etag));
|
2013-10-22 21:41:26 +04:00
|
|
|
}
|
|
|
|
|
2011-07-22 18:21:29 +04:00
|
|
|
/**
|
2015-02-12 14:29:01 +03:00
|
|
|
* Returns the size of the node, in bytes
|
|
|
|
*
|
|
|
|
* @return int|float
|
2011-07-22 18:21:29 +04:00
|
|
|
*/
|
2015-02-12 14:29:01 +03:00
|
|
|
public function getSize() {
|
|
|
|
return $this->info->getSize();
|
2011-07-22 18:21:29 +04:00
|
|
|
}
|
2012-07-21 01:52:47 +04:00
|
|
|
|
2014-12-15 19:49:24 +03:00
|
|
|
/**
|
|
|
|
* Returns the cache's file id
|
|
|
|
*
|
|
|
|
* @return int
|
|
|
|
*/
|
|
|
|
public function getId() {
|
|
|
|
return $this->info->getId();
|
|
|
|
}
|
|
|
|
|
2013-10-23 18:03:57 +04:00
|
|
|
/**
|
2014-02-06 19:30:58 +04:00
|
|
|
* @return string|null
|
2013-10-23 18:03:57 +04:00
|
|
|
*/
|
2014-02-25 19:23:09 +04:00
|
|
|
public function getFileId() {
|
|
|
|
if ($this->info->getId()) {
|
2015-02-12 14:29:01 +03:00
|
|
|
$instanceId = \OC_Util::getInstanceId();
|
2014-02-25 19:23:09 +04:00
|
|
|
$id = sprintf('%08d', $this->info->getId());
|
2013-10-25 15:20:29 +04:00
|
|
|
return $id . $instanceId;
|
2013-10-23 18:40:29 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
return null;
|
2013-10-23 18:03:57 +04:00
|
|
|
}
|
2014-05-02 19:37:16 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return string|null
|
|
|
|
*/
|
|
|
|
public function getDavPermissions() {
|
|
|
|
$p ='';
|
|
|
|
if ($this->info->isShared()) {
|
|
|
|
$p .= 'S';
|
|
|
|
}
|
|
|
|
if ($this->info->isShareable()) {
|
|
|
|
$p .= 'R';
|
|
|
|
}
|
|
|
|
if ($this->info->isMounted()) {
|
|
|
|
$p .= 'M';
|
|
|
|
}
|
2014-05-09 19:18:43 +04:00
|
|
|
if ($this->info->isDeletable()) {
|
|
|
|
$p .= 'D';
|
|
|
|
}
|
|
|
|
if ($this->info->isDeletable()) {
|
2014-06-05 16:39:06 +04:00
|
|
|
$p .= 'NV'; // Renameable, Moveable
|
2014-05-09 19:18:43 +04:00
|
|
|
}
|
2014-05-02 19:37:16 +04:00
|
|
|
if ($this->info->getType() === \OCP\Files\FileInfo::TYPE_FILE) {
|
|
|
|
if ($this->info->isUpdateable()) {
|
|
|
|
$p .= 'W';
|
|
|
|
}
|
|
|
|
} else {
|
2014-09-24 19:50:33 +04:00
|
|
|
if ($this->info->isCreatable()) {
|
2014-05-02 19:37:16 +04:00
|
|
|
$p .= 'CK';
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return $p;
|
|
|
|
}
|
2015-02-18 19:44:13 +03:00
|
|
|
|
|
|
|
protected function verifyPath() {
|
|
|
|
try {
|
|
|
|
$fileName = basename($this->info->getPath());
|
|
|
|
$this->fileView->verifyPath($this->path, $fileName);
|
|
|
|
} catch (\OCP\Files\InvalidPathException $ex) {
|
2015-02-18 20:28:24 +03:00
|
|
|
throw new InvalidPath($ex->getMessage());
|
2015-02-18 19:44:13 +03:00
|
|
|
}
|
|
|
|
}
|
2011-07-20 17:53:34 +04:00
|
|
|
}
|