Merge https://github.com/friendica/red into pending_merge

4 files changed, 70 insertions, 56 deletions

diff --git a/include/RedDAV/RedBasicAuth.php b/include/RedDAV/RedBasicAuth.php
index c1da73da1..2f86d4f82 100644
--- a/include/RedDAV/RedBasicAuth.php
+++ b/include/RedDAV/RedBasicAuth.php
@@ -46,7 +46,7 @@ class RedBasicAuth extends DAV\Auth\Backend\AbstractBasic {
 	/**
 	 *
 	 * @see RedBrowser::set_writeable()
-	 * @var DAV\Browser\Plugin
+	 * @var \Sabre\DAV\Browser\Plugin
 	 */
 	public $browser;
 	/**
@@ -85,7 +85,7 @@ class RedBasicAuth extends DAV\Auth\Backend\AbstractBasic {
 	 */
 	protected function validateUserPass($username, $password) {
 		if (trim($password) === '+++') {
-			logger('(DAV): RedBasicAuth::validateUserPass(): guest ' . $username);
+			logger('guest: ' . $username);
 			return true;
 		}
 
@@ -112,13 +112,14 @@ class RedBasicAuth extends DAV\Auth\Backend\AbstractBasic {
 				foreach ($x as $record) {
 					if (($record['account_flags'] == ACCOUNT_OK) || ($record['account_flags'] == ACCOUNT_UNVERIFIED)
 					&& (hash('whirlpool', $record['account_salt'] . $password) === $record['account_password'])) {
-						logger('(DAV) RedBasicAuth: password verified for ' . $username);
+						logger('password verified for ' . $username);
 						return $this->setAuthenticated($r[0]);
 					}
 				}
 			}
 		}
-		logger('(DAV) RedBasicAuth: password failed for ' . $username);
+		logger('password failed for ' . $username);
+		// @TODO add security logger
 		return false;
 	}
 
@@ -186,23 +187,23 @@ class RedBasicAuth extends DAV\Auth\Backend\AbstractBasic {
 	 * @brief Set browser plugin for SabreDAV.
 	 *
 	 * @see RedBrowser::set_writeable()
-	 * @param DAV\Browser\Plugin $browser
+	 * @param \Sabre\DAV\Browser\Plugin $browser
 	 */
 	public function setBrowserPlugin($browser) {
 		$this->browser = $browser;
 	}
 
 	/**
-	 * Prints out all RedBasicAuth variables to logger().
+	 * @brief Prints out all RedBasicAuth variables to logger().
 	 *
 	 * @return void
 	 */
 	public function log() {
-		logger('dav: auth: channel_name ' . $this->channel_name, LOGGER_DATA);
-		logger('dav: auth: channel_id ' . $this->channel_id, LOGGER_DATA);
-		logger('dav: auth: channel_hash ' . $this->channel_hash, LOGGER_DATA);
-		logger('dav: auth: observer ' . $this->observer, LOGGER_DATA);
-		logger('dav: auth: owner_id ' . $this->owner_id, LOGGER_DATA);
-		logger('dav: auth: owner_nick ' . $this->owner_nick, LOGGER_DATA);
+		logger('channel_name ' . $this->channel_name, LOGGER_DATA);
+		logger('channel_id ' . $this->channel_id, LOGGER_DATA);
+		logger('channel_hash ' . $this->channel_hash, LOGGER_DATA);
+		logger('observer ' . $this->observer, LOGGER_DATA);
+		logger('owner_id ' . $this->owner_id, LOGGER_DATA);
+		logger('owner_nick ' . $this->owner_nick, LOGGER_DATA);
 	}
 }
\ No newline at end of file
diff --git a/include/RedDAV/RedBrowser.php b/include/RedDAV/RedBrowser.php
index 1f2550ac1..6ec5c978d 100644
--- a/include/RedDAV/RedBrowser.php
+++ b/include/RedDAV/RedBrowser.php
@@ -262,6 +262,14 @@ class RedBrowser extends DAV\Browser\Plugin {
 		construct_page(get_app());
 	}
 
+	/**
+	 * @brief Returns a human readable formatted string for filesizes.
+	 *
+	 * Don't we need such a functionality in other places, too?
+	 *
+	 * @param int $size filesize in bytes
+	 * @return string
+	 */
 	function userReadableSize($size) {
 		$ret = "";
 		if (is_numeric($size)) {
diff --git a/include/RedDAV/RedDirectory.php b/include/RedDAV/RedDirectory.php
index 72b0fe789..a46b77f5f 100644
--- a/include/RedDAV/RedDirectory.php
+++ b/include/RedDAV/RedDirectory.php
@@ -49,7 +49,7 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 	 * @param RedBasicAuth &$auth_plugin
 	 */
 	public function __construct($ext_path, &$auth_plugin) {
-		logger('RedDirectory::__construct() ' . $ext_path, LOGGER_DATA);
+		//logger('directory ' . $ext_path, LOGGER_DATA);
 		$this->ext_path = $ext_path;
 		// remove "/cloud" from the beginning of the path
 		$this->red_path = ((strpos($ext_path, '/cloud') === 0) ? substr($ext_path, 6) : $ext_path);
@@ -66,19 +66,19 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 	}
 
 	private function log() {
-		logger('RedDirectory::log() ext_path ' . $this->ext_path, LOGGER_DATA);
-		logger('RedDirectory::log() os_path ' . $this->os_path, LOGGER_DATA);
-		logger('RedDirectory::log() red_path ' . $this->red_path, LOGGER_DATA);
+		logger('ext_path ' . $this->ext_path, LOGGER_DATA);
+		logger('os_path  ' . $this->os_path, LOGGER_DATA);
+		logger('red_path ' . $this->red_path, LOGGER_DATA);
 	}
 
 	/**
 	 * @brief Returns an array with all the child nodes.
 	 *
-	 * @throws DAV\Exception\Forbidden
-	 * @return array DAV\INode[]
+	 * @throw \Sabre\DAV\Exception\Forbidden
+	 * @return array \Sabre\DAV\INode[]
 	 */
 	public function getChildren() {
-		logger('RedDirectory::getChildren() called for ' . $this->ext_path, LOGGER_DATA);
+		//logger('children for ' . $this->ext_path, LOGGER_DATA);
 		$this->log();
 
 		if (get_config('system', 'block_public') && (! $this->auth->channel_id) && (! $this->auth->observer)) {
@@ -97,12 +97,12 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 	 * @brief Returns a child by name.
 	 *
 	 *
-	 * @throw DAV\Exception\Forbidden
-	 * @throw DAV\Exception\NotFound
+	 * @throw \Sabre\DAV\Exception\Forbidden
+	 * @throw \Sabre\DAV\Exception\NotFound
 	 * @param string $name
 	 */
 	public function getChild($name) {
-		logger('RedDirectory::getChild(): ' . $name, LOGGER_DATA);
+		logger($name, LOGGER_DATA);
 
 		if (get_config('system', 'block_public') && (! $this->auth->channel_id) && (! $this->auth->observer)) {
 			throw new DAV\Exception\Forbidden('Permission denied.');
@@ -130,7 +130,7 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 	 * @return string
 	 */
 	public function getName() {
-		logger('RedDirectory::getName() returns: ' . basename($this->red_path), LOGGER_DATA);
+		//logger(basename($this->red_path), LOGGER_DATA);
 		return (basename($this->red_path));
 	}
 
@@ -139,20 +139,20 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 	 *
 	 * @todo handle duplicate directory name
 	 *
-	 * @throw DAV\Exception\Forbidden
+	 * @throw \Sabre\DAV\Exception\Forbidden
 	 * @param string $name The new name of the directory.
 	 * @return void
 	 */
 	public function setName($name) {
-		logger('RedDirectory::setName(): ' . basename($this->red_path) . ' -> ' . $name, LOGGER_DATA);
+		logger('old name ' . basename($this->red_path) . ' -> ' . $name, LOGGER_DATA);
 
 		if ((! $name) || (! $this->auth->owner_id)) {
-			logger('RedDirectory::setName(): permission denied');
+			logger('permission denied ' . $name);
 			throw new DAV\Exception\Forbidden('Permission denied.');
 		}
 
 		if (! perm_is_allowed($this->auth->owner_id, $this->auth->observer, 'write_storage')) {
-			logger('RedDirectory::setName(): permission denied');
+			logger('permission denied '. $name);
 			throw new DAV\Exception\Forbidden('Permission denied.');
 		}
 
@@ -177,21 +177,21 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 	 * After successful creation of the file, you may choose to return the ETag
 	 * of the new file here.
 	 *
-	 * @throws DAV\Exception\Forbidden
+	 * @throw \Sabre\DAV\Exception\Forbidden
 	 * @param string $name Name of the file
 	 * @param resource|string $data Initial payload
 	 * @return null|string ETag
 	 */
 	public function createFile($name, $data = null) {
-		logger('RedDirectory::createFile(): ' . $name, LOGGER_DATA);
+		logger($name, LOGGER_DEBUG);
 
 		if (! $this->auth->owner_id) {
-			logger('RedDirectory::createFile(): permission denied');
+			logger('permission denied ' . $name);
 			throw new DAV\Exception\Forbidden('Permission denied.');
 		}
 
 		if (! perm_is_allowed($this->auth->owner_id, $this->auth->observer, 'write_storage')) {
-			logger('RedDirectory::createFile(): permission denied');
+			logger('permission denied ' . $name);
 			throw new DAV\Exception\Forbidden('Permission denied.');
 		}
 
@@ -203,7 +203,7 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 		);
 
 		if (! $c) {
-			logger('RedDirectory::createFile(): no channel');
+			logger('no channel');
 			throw new DAV\Exception\Forbidden('Permission denied.');
 		}
 
@@ -237,7 +237,7 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 		$size = file_put_contents($f, $data);
 		// delete attach entry if file_put_contents() failed
 		if ($size === false) {
-			logger('RedDirectory::createFile(): file_put_contents() failed for ' . $name, LOGGER_DEBUG);
+			logger('file_put_contents() failed to ' . $f);
 			attach_delete($c[0]['channel_id'], $hash);
 			return;
 		}
@@ -273,7 +273,7 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 				intval($c[0]['channel_account_id'])
 			);
 			if (($x) && ($x[0]['total'] + $size > $limit)) {
-				logger('reddav: service class limit exceeded for ' . $c[0]['channel_name'] . ' total usage is ' . $x[0]['total'] . ' limit is ' . $limit);
+				logger('service class limit exceeded for ' . $c[0]['channel_name'] . ' total usage is ' . $x[0]['total'] . ' limit is ' . $limit);
 				attach_delete($c[0]['channel_id'], $hash);
 				return;
 			}
@@ -287,7 +287,7 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 	 * @return void
 	 */
 	public function createDirectory($name) {
-		logger('RedDirectory::createDirectory(): ' . $name, LOGGER_DEBUG);
+		logger($name, LOGGER_DEBUG);
 
 		if ((! $this->auth->owner_id) || (! perm_is_allowed($this->auth->owner_id, $this->auth->observer, 'write_storage'))) {
 			throw new DAV\Exception\Forbidden('Permission denied.');
@@ -301,7 +301,7 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 		if ($r) {
 			$result = attach_mkdir($r[0], $this->auth->observer, array('filename' => $name, 'folder' => $this->folder_hash));
 			if (! $result['success']) {
-				logger('RedDirectory::createDirectory(): ' . print_r($result, true), LOGGER_DEBUG);
+				logger('error ' . print_r($result, true), LOGGER_DEBUG);
 			}
 		}
 	}
@@ -310,31 +310,33 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 	 * @brief Checks if a child exists.
 	 *
 	 * @param string $name
+	 *  The name to check if it exists.
 	 * @return boolean
 	 */
 	public function childExists($name) {
 		// On /cloud we show a list of available channels.
 		// @todo what happens if no channels are available?
 		if ($this->red_path === '/' && $name === 'cloud') {
-			logger('RedDirectory::childExists() /cloud: true', LOGGER_DATA);
+			//logger('We are at /cloud show a channel list', LOGGER_DEBUG);
 			return true;
 		}
 
 		$x = RedFileData($this->ext_path . '/' . $name, $this->auth, true);
-		logger('RedFileData returns: ' . print_r($x, true), LOGGER_DATA);
+		//logger('RedFileData returns: ' . print_r($x, true), LOGGER_DATA);
 		if ($x)
 			return true;
+
 		return false;
 	}
 
 	/**
 	 * @todo add description of what this function does.
 	 *
-	 * @throw DAV\Exception\NotFound
+	 * @throw \Sabre\DAV\Exception\NotFound
 	 * @return void
 	 */
 	function getDir() {
-		logger('RedDirectory::getDir(): ' . $this->ext_path, LOGGER_DEBUG);
+		//logger($this->ext_path, LOGGER_DEBUG);
 		$this->auth->log();
 
 		$file = $this->ext_path;
@@ -356,7 +358,7 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 		if (! $path_arr)
 			return;
 
-		logger('RedDirectory::getDir(): path: ' . print_r($path_arr, true), LOGGER_DATA);
+		logger('paths: ' . print_r($path_arr, true), LOGGER_DATA);
 
 		$channel_name = $path_arr[0];
 
@@ -367,7 +369,6 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 
 		if (! $r) {
 			throw new DAV\Exception\NotFound('The file with name: ' . $channel_name . ' could not be found.');
-			return;
 		}
 
 		$channel_id = $r[0]['channel_id'];
@@ -397,12 +398,11 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 		}
 		$this->folder_hash = $folder;
 		$this->os_path = $os_path;
-		return;
 	}
 
 	/**
 	 * @brief Returns the last modification time for the directory, as a UNIX
-	 *        timestamp.
+	 * timestamp.
 	 *
 	 * It looks for the last edited file in the folder. If it is an empty folder
 	 * it returns the lastmodified time of the folder itself, to prevent zero
@@ -429,7 +429,8 @@ class RedDirectory extends DAV\Node implements DAV\ICollection, DAV\IQuota {
 	/**
 	 * @brief Return quota usage.
 	 *
-	 * Do guests relly see the used/free values from filesystem of the complete store directory?
+	 * @fixme Should guests relly see the used/free values from filesystem of the
+	 * complete store directory?
 	 *
 	 * @return array with used and free values in bytes.
 	 */
diff --git a/include/RedDAV/RedFile.php b/include/RedDAV/RedFile.php
index 32dbc17e5..f96790631 100644
--- a/include/RedDAV/RedFile.php
+++ b/include/RedDAV/RedFile.php
@@ -49,7 +49,7 @@ class RedFile extends DAV\Node implements DAV\IFile {
 		$this->data = $data;
 		$this->auth = $auth;
 
-		logger('RedFile::__construct(): ' . print_r($this->data, true), LOGGER_DATA);
+		//logger(print_r($this->data, true), LOGGER_DATA);
 	}
 
 	/**
@@ -58,7 +58,7 @@ class RedFile extends DAV\Node implements DAV\IFile {
 	 * @return string
 	 */
 	public function getName() {
-		logger('RedFile::getName(): ' . basename($this->name), LOGGER_DEBUG);
+		//logger(basename($this->name), LOGGER_DATA);
 		return basename($this->name);
 	}
 
@@ -70,9 +70,10 @@ class RedFile extends DAV\Node implements DAV\IFile {
 	 * @return void
 	 */
 	public function setName($newName) {
-		logger('RedFile::setName(): ' . basename($this->name) . ' -> ' . $newName, LOGGER_DEBUG);
+		logger('old name ' . basename($this->name) . ' -> ' . $newName, LOGGER_DATA);
 
 		if ((! $newName) || (! $this->auth->owner_id) || (! perm_is_allowed($this->auth->owner_id, $this->auth->observer, 'write_storage'))) {
+			logger('permission denied '. $newName);
 			throw new DAV\Exception\Forbidden('Permission denied.');
 		}
 
@@ -91,7 +92,7 @@ class RedFile extends DAV\Node implements DAV\IFile {
 	 * @return void
 	 */
 	public function put($data) {
-		logger('RedFile::put(): ' . basename($this->name), LOGGER_DEBUG);
+		logger('put file: ' . basename($this->name), LOGGER_DEBUG);
 		$size = 0;
 
 		// @todo only 3 values are needed
@@ -110,7 +111,7 @@ class RedFile extends DAV\Node implements DAV\IFile {
 				// @todo check return value and set $size directly
 				@file_put_contents($f, $data);
 				$size = @filesize($f);
-				logger('RedFile::put(): filename: ' . $f . ' size: ' . $size, LOGGER_DEBUG);
+				logger('filename: ' . $f . ' size: ' . $size, LOGGER_DEBUG);
 			} else {
 				$r = q("UPDATE attach SET data = '%s' WHERE hash = '%s' AND uid = %d LIMIT 1",
 					dbesc(stream_get_contents($data)),
@@ -161,7 +162,7 @@ class RedFile extends DAV\Node implements DAV\IFile {
 				intval($c[0]['channel_account_id'])
 			);
 			if (($x) && ($x[0]['total'] + $size > $limit)) {
-				logger('RedFile::put(): service class limit exceeded for ' . $c[0]['channel_name'] . ' total usage is ' . $x[0]['total'] . ' limit is ' . $limit);
+				logger('service class limit exceeded for ' . $c[0]['channel_name'] . ' total usage is ' . $x[0]['total'] . ' limit is ' . $limit);
 				attach_delete($c[0]['channel_id'], $this->data['hash']);
 				return;
 			}
@@ -174,7 +175,7 @@ class RedFile extends DAV\Node implements DAV\IFile {
 	 * @return string
 	 */
 	public function get() {
-		logger('RedFile::get(): ' . basename($this->name), LOGGER_DEBUG);
+		logger('get file ' . basename($this->name), LOGGER_DEBUG);
 
 		$r = q("SELECT data, flags, filename, filetype FROM attach WHERE hash = '%s' AND uid = %d LIMIT 1",
 			dbesc($this->data['hash']),
@@ -206,7 +207,7 @@ class RedFile extends DAV\Node implements DAV\IFile {
 	 *
 	 * Return null if the ETag can not effectively be determined.
 	 *
-	 * @return mixed
+	 * @return null|string
 	 */
 	public function getETag() {
 		$ret = null;
@@ -236,6 +237,7 @@ class RedFile extends DAV\Node implements DAV\IFile {
 	 * @brief Returns the size of the node, in bytes.
 	 *
 	 * @return int
+	 *  filesize in bytes
 	 */
 	public function getSize() {
 		return $this->data['filesize'];
@@ -254,11 +256,13 @@ class RedFile extends DAV\Node implements DAV\IFile {
 	/**
 	 * @brief Delete the file.
 	 *
-	 * @throw Sabre\DAV\Exception\Forbidden
-	 * @return void
+	 * This method checks the permissions and then calls attach_delete() function
+	 * to actually remove the file.
+	 *
+	 * @throw \Sabre\DAV\Exception\Forbidden
 	 */
 	public function delete() {
-		logger('RedFile::delete(): ' . basename($this->name), LOGGER_DEBUG);
+		logger('delete file ' . basename($this->name), LOGGER_DEBUG);
 
 		if ((! $this->auth->owner_id) || (! perm_is_allowed($this->auth->owner_id, $this->auth->observer, 'write_storage'))) {
 			throw new DAV\Exception\Forbidden('Permission denied.');