nextcloud/apps/dav/lib/Connector/Sabre/Node.php

410 lines
9.7 KiB
PHP
Raw Normal View History

2011-07-20 17:53:34 +04:00
<?php
/**
2016-07-21 17:49:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2016-05-26 20:56:05 +03:00
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
2015-02-18 20:28:24 +03:00
* @author Bart Visscher <bartv@thisnet.nl>
2016-05-26 20:56:05 +03:00
* @author Björn Schießle <bjoern@schiessle.org>
2015-02-18 20:28:24 +03:00
* @author Jakob Sack <mail@jakobsack.de>
* @author Joas Schilling <coding@schilljs.com>
2015-02-18 20:28:24 +03:00
* @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>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2016-07-21 17:49:16 +03:00
* @author Roeland Jago Douma <roeland@famdouma.nl>
2015-02-18 20:28:24 +03:00
* @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
* @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
*
*/
namespace OCA\DAV\Connector\Sabre;
2016-03-31 22:25:23 +03:00
use OC\Files\Mount\MoveableMount;
use OC\Files\View;
use OCA\DAV\Connector\Sabre\Exception\InvalidPath;
use OCP\Files\FileInfo;
use OCP\Files\StorageNotAvailableException;
use OCP\Share\Exceptions\ShareNotFound;
use OCP\Share\IManager;
use OCP\Share;
use OCP\Share\IShare;
2015-02-18 20:28:24 +03:00
abstract class Node implements \Sabre\DAV\INode {
/**
* @var \OC\Files\View
*/
protected $fileView;
2011-07-20 17:53:34 +04:00
/**
* The path to the current node
*
* @var string
*/
protected $path;
/**
* node properties cache
*
* @var array
*/
protected $property_cache = null;
2011-07-20 17:53:34 +04:00
/**
* @var \OCP\Files\FileInfo
*/
protected $info;
/**
* @var IManager
*/
protected $shareManager;
2011-07-20 17:53:34 +04:00
/**
* Sets up the node, expects a full path name
2015-07-22 16:12:36 +03:00
*
* @param \OC\Files\View $view
* @param \OCP\Files\FileInfo $info
* @param IManager $shareManager
2011-07-20 17:53:34 +04:00
*/
public function __construct(View $view, FileInfo $info, IManager $shareManager = null) {
$this->fileView = $view;
$this->path = $this->fileView->getRelativePath($info->getPath());
$this->info = $info;
if ($shareManager) {
$this->shareManager = $shareManager;
} else {
$this->shareManager = \OC::$server->getShareManager();
}
2011-07-20 17:53:34 +04:00
}
protected function refreshInfo() {
$this->info = $this->fileView->getFileInfo($this->path);
}
2011-07-20 17:53:34 +04:00
/**
* Returns the name of the node
2015-07-22 16:12:36 +03:00
*
2011-07-20 17:53:34 +04:00
* @return string
*/
public function getName() {
return $this->info->getName();
2011-07-20 17:53:34 +04:00
}
/**
* Returns the full path
*
* @return string
*/
public function getPath() {
return $this->path;
}
2011-07-20 17:53:34 +04:00
/**
* Renames the node
2015-07-22 16:12:36 +03:00
*
2011-07-20 17:53:34 +04:00
* @param string $name The new name
* @throws \Sabre\DAV\Exception\BadRequest
* @throws \Sabre\DAV\Exception\Forbidden
2011-07-20 17:53:34 +04:00
*/
public function setName($name) {
// rename is only allowed if the update privilege is granted
if (!$this->info->isUpdateable()) {
throw new \Sabre\DAV\Exception\Forbidden();
}
list($parentPath,) = \Sabre\Uri\split($this->path);
list(, $newName) = \Sabre\Uri\split($name);
2011-07-20 17:53:34 +04:00
// verify path of the target
$this->verifyPath();
2011-07-20 17:53:34 +04:00
$newPath = $parentPath . '/' . $newName;
2011-07-23 00:30:45 +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
$this->refreshInfo();
2011-07-20 17:53:34 +04:00
}
public function setPropertyCache($property_cache) {
$this->property_cache = $property_cache;
}
2011-07-20 17:53:34 +04:00
/**
* Returns the last modification time, as a unix timestamp
2015-07-22 16:12:36 +03: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();
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
* 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.
*/
public function touch($mtime) {
$mtime = $this->sanitizeMtime($mtime);
$this->fileView->touch($this->path, $mtime);
$this->refreshInfo();
}
2011-07-22 18:21:29 +04: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
*/
public function getETag() {
return '"' . $this->info->getEtag() . '"';
2011-07-22 18:21:29 +04:00
}
/**
* Sets the ETag
*
* @param string $etag
*
* @return int file id of updated file or -1 on failure
*/
public function setETag($etag) {
return $this->fileView->putFileInfo($this->path, array('etag' => $etag));
}
2011-07-22 18:21:29 +04:00
/**
* Returns the size of the node, in bytes
*
* @return integer
2011-07-22 18:21:29 +04:00
*/
public function getSize() {
return $this->info->getSize();
2011-07-22 18:21:29 +04:00
}
/**
* Returns the cache's file id
*
* @return int
*/
public function getId() {
return $this->info->getId();
}
/**
* @return string|null
*/
public function getFileId() {
if ($this->info->getId()) {
$instanceId = \OC_Util::getInstanceId();
$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;
}
/**
* @return integer
*/
public function getInternalFileId() {
return $this->info->getId();
}
/**
* @param string $user
* @return int
*/
public function getSharePermissions($user) {
// check of we access a federated share
if ($user !== null) {
try {
$share = $this->shareManager->getShareByToken($user);
return $share->getPermissions();
} catch (ShareNotFound $e) {
// ignore
}
}
try {
$storage = $this->info->getStorage();
} catch (StorageNotAvailableException $e) {
$storage = null;
}
if ($storage && $storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) {
/** @var \OCA\Files_Sharing\SharedStorage $storage */
2016-04-15 10:02:01 +03:00
$permissions = (int)$storage->getShare()->getPermissions();
} else {
$permissions = $this->info->getPermissions();
}
/*
* We can always share non moveable mount points with DELETE and UPDATE
* Eventually we need to do this properly
*/
$mountpoint = $this->info->getMountPoint();
if (!($mountpoint instanceof MoveableMount)) {
2016-03-31 22:25:23 +03:00
$mountpointpath = $mountpoint->getMountPoint();
if (substr($mountpointpath, -1) === '/') {
$mountpointpath = substr($mountpointpath, 0, -1);
}
if (!$mountpoint->getOption('readonly', false) && $mountpointpath === $this->info->getPath()) {
2016-03-31 22:25:23 +03:00
$permissions |= \OCP\Constants::PERMISSION_DELETE | \OCP\Constants::PERMISSION_UPDATE;
}
}
/*
* Files can't have create or delete permissions
*/
if ($this->info->getType() === \OCP\Files\FileInfo::TYPE_FILE) {
$permissions &= ~(\OCP\Constants::PERMISSION_CREATE | \OCP\Constants::PERMISSION_DELETE);
}
return $permissions;
}
/**
* @param string $user
* @return string
*/
public function getNoteFromShare($user) {
if ($user == null) {
return '';
}
$types = [
Share::SHARE_TYPE_USER,
Share::SHARE_TYPE_GROUP,
Share::SHARE_TYPE_CIRCLE,
Share::SHARE_TYPE_ROOM
];
foreach ($types as $shareType) {
$shares = $this->shareManager->getSharedWith($user, $shareType, $this, -1);
foreach ($shares as $share) {
$note = $share->getNote();
if($share->getShareOwner() !== $user && !empty($note)) {
return $note;
}
}
}
return '';
}
/**
* @return string
*/
public function getDavPermissions() {
2015-07-22 16:12:36 +03:00
$p = '';
if ($this->info->isShared()) {
$p .= 'S';
}
if ($this->info->isShareable()) {
$p .= 'R';
}
if ($this->info->isMounted()) {
$p .= 'M';
}
if ($this->info->isReadable()) {
$p .= 'G';
}
if ($this->info->isDeletable()) {
$p .= 'D';
}
if ($this->info->isUpdateable()) {
$p .= 'NV'; // Renameable, Moveable
}
if ($this->info->getType() === \OCP\Files\FileInfo::TYPE_FILE) {
if ($this->info->isUpdateable()) {
$p .= 'W';
}
} else {
if ($this->info->isCreatable()) {
$p .= 'CK';
}
}
return $p;
}
public function getOwner() {
return $this->info->getOwner();
}
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-07-22 16:12:36 +03:00
/**
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
*/
public function acquireLock($type) {
$this->fileView->lockFile($this->path, $type);
}
/**
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
*/
public function releaseLock($type) {
$this->fileView->unlockFile($this->path, $type);
}
/**
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
*/
public function changeLock($type) {
$this->fileView->changeLock($this->path, $type);
}
public function getFileInfo() {
return $this->info;
}
protected function sanitizeMtime($mtimeFromRequest) {
// In PHP 5.X "is_numeric" returns true for strings in hexadecimal
// notation. This is no longer the case in PHP 7.X, so this check
// ensures that strings with hexadecimal notations fail too in PHP 5.X.
$isHexadecimal = is_string($mtimeFromRequest) && preg_match('/^\s*0[xX]/', $mtimeFromRequest);
if ($isHexadecimal || !is_numeric($mtimeFromRequest)) {
throw new \InvalidArgumentException('X-OC-MTime header must be an integer (unix timestamp).');
}
return (int)$mtimeFromRequest;
}
2011-07-20 17:53:34 +04:00
}