Moved classes from reddav.php into own files.

Finished moving classes out from include/reddav.php into own files. Also
continued with namespace for RedDAV.
Improved some docs and added some todos and fixmes.

1 files changed, 275 insertions, 0 deletions

diff --git a/include/RedDAV/RedFile.php b/include/RedDAV/RedFile.php
new file mode 100644
index 000000000..32dbc17e5
--- /dev/null
+++ b/include/RedDAV/RedFile.php
@@ -0,0 +1,275 @@
+<?php
+
+namespace RedMatrix\RedDAV;
+
+use Sabre\DAV;
+
+/**
+ * @brief This class represents a file in DAV.
+ *
+ * It provides all functions to work with files in Red's cloud through DAV protocol.
+ *
+ * @extends \Sabre\DAV\Node
+ * @implements \Sabre\DAV\IFile
+ *
+ * @link http://github.com/friendica/red
+ * @license http://opensource.org/licenses/mit-license.php The MIT License (MIT)
+ */
+class RedFile extends DAV\Node implements DAV\IFile {
+
+	/**
+	 * The file from attach table.
+	 *
+	 * @var array
+	 *  data
+	 *  flags
+	 *  filename (string)
+	 *  filetype (string)
+	 */
+	private $data;
+	/**
+	 * @see \Sabre\DAV\Auth\Backend\BackendInterface
+	 * @var \RedMatrix\RedDAV\RedBasicAuth
+	 */
+	private $auth;
+	/**
+	 * @var string
+	 */
+	private $name;
+
+	/**
+	 * Sets up the node, expects a full path name.
+	 *
+	 * @param string $name
+	 * @param array $data from attach table
+	 * @param &$auth
+	 */
+	public function __construct($name, $data, &$auth) {
+		$this->name = $name;
+		$this->data = $data;
+		$this->auth = $auth;
+
+		logger('RedFile::__construct(): ' . print_r($this->data, true), LOGGER_DATA);
+	}
+
+	/**
+	 * @brief Returns the name of the file.
+	 *
+	 * @return string
+	 */
+	public function getName() {
+		logger('RedFile::getName(): ' . basename($this->name), LOGGER_DEBUG);
+		return basename($this->name);
+	}
+
+	/**
+	 * @brief Renames the file.
+	 *
+	 * @throw Sabre\DAV\Exception\Forbidden
+	 * @param string $name The new name of the file.
+	 * @return void
+	 */
+	public function setName($newName) {
+		logger('RedFile::setName(): ' . basename($this->name) . ' -> ' . $newName, LOGGER_DEBUG);
+
+		if ((! $newName) || (! $this->auth->owner_id) || (! perm_is_allowed($this->auth->owner_id, $this->auth->observer, 'write_storage'))) {
+			throw new DAV\Exception\Forbidden('Permission denied.');
+		}
+
+		$newName = str_replace('/', '%2F', $newName);
+
+		$r = q("UPDATE attach SET filename = '%s' WHERE hash = '%s' AND id = %d LIMIT 1",
+			dbesc($this->data['filename']),
+			intval($this->data['id'])
+		);
+	}
+
+	/**
+	 * @brief Updates the data of the file.
+	 *
+	 * @param resource $data
+	 * @return void
+	 */
+	public function put($data) {
+		logger('RedFile::put(): ' . basename($this->name), LOGGER_DEBUG);
+		$size = 0;
+
+		// @todo only 3 values are needed
+		$c = q("SELECT * FROM channel WHERE channel_id = %d AND NOT (channel_pageflags & %d) LIMIT 1",
+			intval($this->auth->owner_id),
+			intval(PAGE_REMOVED)
+		);
+
+		$r = q("SELECT flags, folder, data FROM attach WHERE hash = '%s' AND uid = %d LIMIT 1",
+			dbesc($this->data['hash']),
+			intval($c[0]['channel_id'])
+		);
+		if ($r) {
+			if ($r[0]['flags'] & ATTACH_FLAG_OS) {
+				$f = 'store/' . $this->auth->owner_nick . '/' . (($r[0]['data']) ? $r[0]['data'] : '');
+				// @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);
+			} else {
+				$r = q("UPDATE attach SET data = '%s' WHERE hash = '%s' AND uid = %d LIMIT 1",
+					dbesc(stream_get_contents($data)),
+					dbesc($this->data['hash']),
+					intval($this->data['uid'])
+				);
+				$r = q("SELECT length(data) AS fsize FROM attach WHERE hash = '%s' AND uid = %d LIMIT 1",
+					dbesc($this->data['hash']),
+					intval($this->data['uid'])
+				);
+				if ($r) {
+					$size = $r[0]['fsize'];
+				}
+			}
+		}
+
+		// returns now()
+		$edited = datetime_convert();
+
+		$d = q("UPDATE attach SET filesize = '%s', edited = '%s' WHERE hash = '%s' AND uid = %d LIMIT 1",
+			dbesc($size),
+			dbesc($edited),
+			dbesc($this->data['hash']),
+			intval($c[0]['channel_id'])
+		);
+
+		// update the folder's lastmodified timestamp
+		$e = q("UPDATE attach SET edited = '%s' WHERE hash = '%s' AND uid = %d LIMIT 1",
+			dbesc($edited),
+			dbesc($r[0]['folder']),
+			intval($c[0]['channel_id'])
+		);
+
+		// @todo do we really want to remove the whole file if an update fails
+		// because of maxfilesize or quota?
+		// There is an Exception "InsufficientStorage" or "PaymentRequired" for
+		// our service class from SabreDAV we could use.
+
+		$maxfilesize = get_config('system', 'maxfilesize');
+		if (($maxfilesize) && ($size > $maxfilesize)) {
+			attach_delete($c[0]['channel_id'], $this->data['hash']);
+			return;
+		}
+
+		$limit = service_class_fetch($c[0]['channel_id'], 'attach_upload_limit');
+		if ($limit !== false) {
+			$x = q("select sum(filesize) as total from attach where aid = %d ",
+				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);
+				attach_delete($c[0]['channel_id'], $this->data['hash']);
+				return;
+			}
+		}
+	}
+
+	/**
+	 * @brief Returns the raw data.
+	 *
+	 * @return string
+	 */
+	public function get() {
+		logger('RedFile::get(): ' . 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']),
+			intval($this->data['uid'])
+		);
+		if ($r) {
+			// @todo this should be a global definition
+			$unsafe_types = array('text/html', 'text/css', 'application/javascript');
+
+			if (in_array($r[0]['filetype'], $unsafe_types)) {
+				header('Content-disposition: attachment; filename="' . $r[0]['filename'] . '"');
+				header('Content-type: text/plain');
+			}
+
+			if ($r[0]['flags'] & ATTACH_FLAG_OS ) {
+				$f = 'store/' . $this->auth->owner_nick . '/' . (($this->os_path) ? $this->os_path . '/' : '') . $r[0]['data'];
+				return fopen($f, 'rb');
+			}
+			return $r[0]['data'];
+		}
+	}
+
+	/**
+	 * @brief 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 mixed
+	 */
+	public function getETag() {
+		$ret = null;
+		if ($this->data['hash']) {
+			$ret = '"' . $this->data['hash'] . '"';
+		}
+		return $ret;
+	}
+
+	/**
+	 * @brief Returns the mime-type for a file.
+	 *
+	 * If null is returned, we'll assume application/octet-stream
+	 *
+	 * @return mixed
+	 */
+	public function getContentType() {
+		// @todo this should be a global definition.
+		$unsafe_types = array('text/html', 'text/css', 'application/javascript');
+		if (in_array($this->data['filetype'], $unsafe_types)) {
+			return 'text/plain';
+		}
+		return $this->data['filetype'];
+	}
+
+	/**
+	 * @brief Returns the size of the node, in bytes.
+	 *
+	 * @return int
+	 */
+	public function getSize() {
+		return $this->data['filesize'];
+	}
+
+	/**
+	 * @brief Returns the last modification time for the file, as a unix
+	 *        timestamp.
+	 *
+	 * @return int last modification time in UNIX timestamp
+	 */
+	public function getLastModified() {
+		return datetime_convert('UTC', 'UTC', $this->data['edited'], 'U');
+	}
+
+	/**
+	 * @brief Delete the file.
+	 *
+	 * @throw Sabre\DAV\Exception\Forbidden
+	 * @return void
+	 */
+	public function delete() {
+		logger('RedFile::delete(): ' . 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.');
+		}
+
+		if ($this->auth->owner_id !== $this->auth->channel_id) {
+			if (($this->auth->observer !== $this->data['creator']) || ($this->data['flags'] & ATTACH_FLAG_DIR)) {
+				throw new DAV\Exception\Forbidden('Permission denied.');
+			}
+		}
+
+		attach_delete($this->auth->owner_id, $this->data['hash']);
+	}
+}
\ No newline at end of file