nextcloud/lib/private/connector/sabre/node.php

289 lines
7.8 KiB
PHP
Raw Normal View History

2011-07-20 17:53:34 +04:00
<?php
2012-05-05 20:13:40 +04:00
2011-07-20 17:53:34 +04:00
/**
2012-05-05 20:13:40 +04:00
* ownCloud
2011-07-20 17:53:34 +04:00
*
2012-05-05 20:13:40 +04:00
* @author Jakob Sack
* @copyright 2011 Jakob Sack kde@jakobsack.de
2011-07-22 18:21:29 +04:00
*
2012-05-05 20:13:40 +04:00
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
2011-07-22 18:21:29 +04:00
*
2012-05-05 20:13:40 +04:00
* This library 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 along with this library. If not, see <http://www.gnu.org/licenses/>.
2011-07-22 18:21:29 +04:00
*
*/
2012-05-05 20:13:40 +04:00
2011-07-22 18:21:29 +04:00
abstract class OC_Connector_Sabre_Node implements Sabre_DAV_INode, Sabre_DAV_IProperties {
const GETETAG_PROPERTYNAME = '{DAV:}getetag';
const LASTMODIFIED_PROPERTYNAME = '{DAV:}lastmodified';
/**
* Allow configuring the method used to generate Etags
*
* @var array(class_name, function_name)
*/
public static $ETagFunction = null;
/**
* is kept public to allow overwrite for unit testing
*
* @var \OC\Files\View
*/
public $fileView;
2011-07-20 17:53:34 +04:00
/**
* The path to the current node
*
* @var string
*/
protected $path;
/**
* node fileinfo cache
* @var array
*/
protected $fileinfo_cache;
/**
* node properties cache
* @var array
*/
protected $property_cache = null;
2011-07-20 17:53:34 +04:00
/**
2012-11-28 19:10:58 +04:00
* @brief Sets up the node, expects a full path name
2011-07-20 17:53:34 +04:00
* @param string $path
* @return void
*/
public function __construct($path) {
$this->path = $path;
}
/**
2012-11-28 19:10:58 +04:00
* @brief Returns the name of the node
2011-07-20 17:53:34 +04:00
* @return string
*/
public function getName() {
list(, $name) = Sabre_DAV_URLUtil::splitPath($this->path);
return $name;
}
/**
2012-11-28 19:10:58 +04:00
* @brief Renames the node
2011-07-20 17:53:34 +04:00
* @param string $name The new name
* @return void
*/
public function setName($name) {
$fs = $this->getFS();
2011-07-20 17:53:34 +04:00
// rename is only allowed if the update privilege is granted
if (!$fs->isUpdatable($this->path)) {
throw new \Sabre_DAV_Exception_Forbidden();
}
2011-07-20 17:53:34 +04:00
list($parentPath, ) = Sabre_DAV_URLUtil::splitPath($this->path);
list(, $newName) = Sabre_DAV_URLUtil::splitPath($name);
if (!\OCP\Util::isValidFileName($newName)) {
throw new \Sabre_DAV_Exception_BadRequest();
}
2011-07-20 17:53:34 +04:00
$newPath = $parentPath . '/' . $newName;
2011-07-23 00:30:45 +04:00
$oldPath = $this->path;
$fs->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
2013-02-11 20:44:02 +04:00
$query = OC_DB::prepare( 'UPDATE `*PREFIX*properties` SET `propertypath` = ?'
.' WHERE `userid` = ? AND `propertypath` = ?' );
$query->execute( array( $newPath, OC_User::getUser(), $oldPath ));
2011-07-20 17:53:34 +04:00
}
2012-06-15 19:04:37 +04:00
public function setFileinfoCache($fileinfo_cache)
{
$this->fileinfo_cache = $fileinfo_cache;
}
/**
2012-11-28 19:10:58 +04:00
* @brief Ensure that the fileinfo cache is filled
2013-05-24 04:59:02 +04:00
* @note Uses OC_FileCache or a direct stat
*/
protected function getFileinfoCache() {
if (!isset($this->fileinfo_cache)) {
2012-10-27 01:05:02 +04:00
if ($fileinfo_cache = \OC\Files\Filesystem::getFileInfo($this->path)) {
} else {
2012-10-10 15:18:36 +04:00
$fileinfo_cache = \OC\Files\Filesystem::stat($this->path);
}
$this->fileinfo_cache = $fileinfo_cache;
}
}
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
/**
2012-11-28 19:10:58 +04:00
* @brief Returns the last modification time, as a unix timestamp
2011-07-20 17:53:34 +04:00
* @return int
*/
public function getLastModified() {
$this->getFileinfoCache();
return $this->fileinfo_cache['mtime'];
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) {
2012-10-10 15:18:36 +04:00
\OC\Files\Filesystem::touch($this->path, $mtime);
}
2011-07-22 18:21:29 +04:00
/**
2012-11-28 19:10:58 +04:00
* @brief Updates properties on this node,
2011-07-22 18:21:29 +04:00
* @see Sabre_DAV_IProperties::updateProperties
* @return boolean
2011-07-22 18:21:29 +04:00
*/
public function updateProperties($properties) {
$existing = $this->getProperties(array());
foreach($properties as $propertyName => $propertyValue) {
// If it was null, we need to delete the property
if (is_null($propertyValue)) {
2012-09-07 17:22:01 +04:00
if(array_key_exists( $propertyName, $existing )) {
2013-02-11 20:44:02 +04:00
$query = OC_DB::prepare( 'DELETE FROM `*PREFIX*properties`'
.' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?' );
2011-07-29 23:36:03 +04:00
$query->execute( array( OC_User::getUser(), $this->path, $propertyName ));
2011-07-22 18:21:29 +04:00
}
}
else {
if( strcmp( $propertyName, self::GETETAG_PROPERTYNAME) === 0 ) {
\OC\Files\Filesystem::putFileInfo($this->path, array('etag'=> $propertyValue));
} elseif( strcmp( $propertyName, self::LASTMODIFIED_PROPERTYNAME) === 0 ) {
$this->touch($propertyValue);
} else {
2012-09-07 17:22:01 +04:00
if(!array_key_exists( $propertyName, $existing )) {
2013-02-11 20:44:02 +04:00
$query = OC_DB::prepare( 'INSERT INTO `*PREFIX*properties`'
.' (`userid`,`propertypath`,`propertyname`,`propertyvalue`) VALUES(?,?,?,?)' );
$query->execute( array( OC_User::getUser(), $this->path, $propertyName,$propertyValue ));
} else {
2013-02-11 20:44:02 +04:00
$query = OC_DB::prepare( 'UPDATE `*PREFIX*properties` SET `propertyvalue` = ?'
.' WHERE `userid` = ? AND `propertypath` = ? AND `propertyname` = ?' );
$query->execute( array( $propertyValue,OC_User::getUser(), $this->path, $propertyName ));
}
2011-07-22 18:21:29 +04:00
}
}
}
$this->setPropertyCache(null);
2011-07-22 18:21:29 +04:00
return true;
}
/**
* removes all properties for this node and user
*/
public function removeProperties() {
$query = OC_DB::prepare( 'DELETE FROM `*PREFIX*properties`'
.' WHERE `userid` = ? AND `propertypath` = ?' );
$query->execute( array( OC_User::getUser(), $this->path));
$this->setPropertyCache(null);
}
2011-07-22 18:21:29 +04:00
/**
2012-11-28 19:10:58 +04:00
* @brief Returns a list of properties for this nodes.;
2011-07-22 18:21:29 +04:00
* @param array $properties
* @return array
2013-01-14 23:30:39 +04:00
* @note The properties list is a list of propertynames the client
* requested, encoded as xmlnamespace#tagName, for example:
* http://www.example.org/namespace#author If the array is empty, all
2012-11-28 19:10:58 +04:00
* properties should be returned
2011-07-22 18:21:29 +04:00
*/
public function getProperties($properties) {
if (is_null($this->property_cache)) {
$sql = 'SELECT * FROM `*PREFIX*properties` WHERE `userid` = ? AND `propertypath` = ?';
$result = OC_DB::executeAudited( $sql, array( OC_User::getUser(), $this->path ) );
2011-07-22 18:21:29 +04:00
$this->property_cache = array();
2012-09-07 17:22:01 +04:00
while( $row = $result->fetchRow()) {
$this->property_cache[$row['propertyname']] = $row['propertyvalue'];
}
2013-10-02 18:47:21 +04:00
// Don't call the static getETagPropertyForPath, its result is not cached
$this->getFileinfoCache();
if ($this->fileinfo_cache['etag']) {
$this->property_cache[self::GETETAG_PROPERTYNAME] = '"'.$this->fileinfo_cache['etag'].'"';
} else {
$this->property_cache[self::GETETAG_PROPERTYNAME] = null;
}
2011-07-22 18:21:29 +04:00
}
2012-06-08 18:39:21 +04:00
// if the array was empty, we need to return everything
2012-09-07 17:22:01 +04:00
if(count($properties) == 0) {
return $this->property_cache;
2011-07-22 18:21:29 +04:00
}
2012-08-29 10:38:33 +04:00
2011-07-22 18:21:29 +04:00
$props = array();
foreach($properties as $property) {
if (isset($this->property_cache[$property])) {
$props[$property] = $this->property_cache[$property];
}
2011-07-22 18:21:29 +04:00
}
2011-07-22 18:21:29 +04:00
return $props;
}
/**
* Returns the ETag surrounded by double-quotes for this path.
* @param string $path Path of the file
* @return string|null Returns null if the ETag can not effectively be determined
*/
protected function getETagPropertyForPath($path) {
$data = $this->getFS()->getFileInfo($path);
if (isset($data['etag'])) {
2013-01-12 06:09:58 +04:00
return '"'.$data['etag'].'"';
}
return null;
}
protected function getFS() {
if (is_null($this->fileView)) {
$this->fileView = \OC\Files\Filesystem::getView();
}
return $this->fileView;
}
/**
* @return string|null
*/
public function getFileId()
{
$this->getFileinfoCache();
2013-10-23 18:40:29 +04:00
if (isset($this->fileinfo_cache['fileid'])) {
$instanceId = OC_Util::getInstanceId();
$id = sprintf('%08d', $this->fileinfo_cache['fileid']);
2013-10-25 15:20:29 +04:00
return $id . $instanceId;
2013-10-23 18:40:29 +04:00
}
return null;
}
2011-07-20 17:53:34 +04:00
}