Initial AppData

* Introduce simpleFS
* Introduce IAppData
* Introduce AppData Factory to get your AppData folder
* Update FileDisplayResponse

* AppData implements a ISimpleRoot but lazy. So only if an apps starts
  to access data will stuff get initialized

Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>

5 files changed, 287 insertions, 4 deletions

diff --git a/lib/public/AppFramework/Http/FileDisplayResponse.php b/lib/public/AppFramework/Http/FileDisplayResponse.php
index 22171e2b379..03a6fbec2dd 100644
--- a/lib/public/AppFramework/Http/FileDisplayResponse.php
+++ b/lib/public/AppFramework/Http/FileDisplayResponse.php
@@ -23,7 +23,6 @@
 namespace OCP\AppFramework\Http;
 
 use OCP\AppFramework\Http;
-use OCP\Files\File;
 
 /**
  * Class FileDisplayResponse
@@ -33,18 +32,18 @@ use OCP\Files\File;
  */
 class FileDisplayResponse extends Response implements ICallbackResponse {
 
-	/** @var File */
+	/** @var \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile */
 	private $file;
 
 	/**
 	 * FileDisplayResponse constructor.
 	 *
-	 * @param File $file
+	 * @param \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile $file
 	 * @param int $statusCode
 	 * @param array $headers
 	 * @since 9.2.0
 	 */
-	public function __construct(File $file, $statusCode=Http::STATUS_OK,
+	public function __construct($file, $statusCode=Http::STATUS_OK,
 								$headers=[]) {
 		$this->file = $file;
 		$this->setStatus($statusCode);
diff --git a/lib/public/Files/IAppData.php b/lib/public/Files/IAppData.php
new file mode 100644
index 00000000000..92e54fee366
--- /dev/null
+++ b/lib/public/Files/IAppData.php
@@ -0,0 +1,36 @@
+<?php
+/**
+ * @copyright 2016 Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program 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 program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+namespace OCP\Files;
+
+use OCP\Files\SimpleFS\ISimpleRoot;
+
+/**
+ * Interface IAppData
+ *
+ * @package OCP\Files
+ * @since 9.2.0
+ * @internal This interface is experimental and might change for NC12
+ */
+interface IAppData extends ISimpleRoot  {
+	
+}
diff --git a/lib/public/Files/SimpleFS/ISimpleFile.php b/lib/public/Files/SimpleFS/ISimpleFile.php
new file mode 100644
index 00000000000..efd682e7855
--- /dev/null
+++ b/lib/public/Files/SimpleFS/ISimpleFile.php
@@ -0,0 +1,100 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program 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 program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+namespace OCP\Files\SimpleFS;
+
+use OCP\Files\NotPermittedException;
+
+/**
+ * Interface ISimpleFile
+ *
+ * @package OCP\Files\SimpleFS
+ * @since 9.2.0
+ * @internal This interface is experimental and might change for NC12
+ */
+interface ISimpleFile {
+
+	/**
+	 * Get the name
+	 *
+	 * @return string
+	 * @since 9.2.0
+	 */
+	public function getName();
+
+	/**
+	 * Get the size in bytes
+	 *
+	 * @return int
+	 * @since 9.2.0
+	 */
+	public function getSize();
+
+	/**
+	 * Get the ETag
+	 *
+	 * @return string
+	 * @since 9.2.0
+	 */
+	public function getETag();
+
+	/**
+	 * Get the last modification time
+	 *
+	 * @return int
+	 * @since 9.2.0
+	 */
+	public function getMTime();
+
+	/**
+	 * Get the content
+	 *
+	 * @return string
+	 * @since 9.2.0
+	 */
+	public function getContent();
+
+	/**
+	 * Overwrite the file
+	 *
+	 * @param string $data
+	 * @throws NotPermittedException
+	 * @since 9.2.0
+	 */
+	public function putContent($data);
+
+	/**
+	 * Delete the file
+	 *
+	 * @throws NotPermittedException
+	 * @since 9.2.0
+	 */
+	public function delete();
+
+	/**
+	 * Get the MimeType
+	 *
+	 * @return string
+	 * @since 9.2.0
+	 */
+	public function getMimeType();
+}
diff --git a/lib/public/Files/SimpleFS/ISimpleFolder.php b/lib/public/Files/SimpleFS/ISimpleFolder.php
new file mode 100644
index 00000000000..c8d7f060fbe
--- /dev/null
+++ b/lib/public/Files/SimpleFS/ISimpleFolder.php
@@ -0,0 +1,87 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program 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 program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+namespace OCP\Files\SimpleFS;
+
+use OCP\Files\NotFoundException;
+use OCP\Files\NotPermittedException;
+
+/**
+ * Interface ISimpleFolder
+ *
+ * @package OCP\Files\SimpleFS
+ * @since 9.2.0
+ * @internal This interface is experimental and might change for NC12
+ */
+interface ISimpleFolder {
+	/**
+	 * Get all the files in a folder
+	 *
+	 * @return ISimpleFile[]
+	 * @since 9.2.0
+	 */
+	public function getDirectoryListing();
+
+	/**
+	 * Check if a file with $name exists
+	 *
+	 * @param string $name
+	 * @return bool
+	 * @since 9.2.0
+	 */
+	public function fileExists($name);
+
+	/**
+	 *
+	 * @param string $name
+	 * @return ISimpleFile
+	 * @throws NotFoundException
+	 * @since 9.2.0
+	 */
+	public function getFile($name);
+
+	/**
+	 * Creates a new file with $name in the folder
+	 *
+	 * @param string $name
+	 * @return ISimpleFile
+	 * @throws NotPermittedException
+	 * @since 9.2.0
+	 */
+	public function newFile($name);
+
+	/**
+	 * Remove the folder and all the files in it
+	 *
+	 * @throws NotPermittedException
+	 * @since 9.2.0
+	 */
+	public function delete();
+
+	/**
+	 * Get the folder name
+	 *
+	 * @return string
+	 * @since 9.2.0
+	 */
+	public function getName();
+}
diff --git a/lib/public/Files/SimpleFS/ISimpleRoot.php b/lib/public/Files/SimpleFS/ISimpleRoot.php
new file mode 100644
index 00000000000..a9b00540eb2
--- /dev/null
+++ b/lib/public/Files/SimpleFS/ISimpleRoot.php
@@ -0,0 +1,61 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016 Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program 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 program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+namespace OCP\Files\SimpleFS;
+
+use OCP\Files\NotFoundException;
+
+/**
+ * Interface ISimpleRoot
+ *
+ * @package OCP\Files\SimpleFS
+ * @since 9.2.0
+ * @internal This interface is experimental and might change for NC12
+ */
+interface ISimpleRoot {
+	/**
+	 * Get the folder with name $name
+	 *
+	 * @param string $name
+	 * @return ISimpleFolder
+	 * @throws NotFoundException
+	 * @since 9.2.0
+	 */
+	public function getFolder($name);
+
+	/**
+	 * Get all the Folders
+	 *
+	 * @return ISimpleFolder[]
+	 * @since 9.2.0
+	 */
+	public function getDirectoryListing();
+
+	/**
+	 * Create a new folder named $name
+	 *
+	 * @param string $name
+	 * @return ISimpleFolder
+	 * @since 9.2.0
+	 */
+	public function newFolder($name);
+}