From ef6d169d1c18bfb85c93e571588e885e3016a340 Mon Sep 17 00:00:00 2001
From: Chuck Hagenbuch <chuck@horde.org>
Date: Thu, 26 Mar 2009 16:41:07 -0400
Subject: [PATCH] stub out more of the Horde_Vfs structure, including ideas for
 file Uris, the db adapter organization, and a download controller

---
 .../Vfs/app/controllers/DownloadController.php     |  6 ++++
 framework/Vfs/lib/Horde/Vfs/Adapter/Db/Base.php    | 18 ++++++++++++
 framework/Vfs/lib/Horde/Vfs/Adapter/Db/Chunked.php | 17 +++++++++++
 framework/Vfs/lib/Horde/Vfs/Adapter/Db/File.php    | 17 +++++++++++
 framework/Vfs/lib/Horde/Vfs/Adapter/Db/S3.php      | 16 ++++++++++
 framework/Vfs/lib/Horde/Vfs/Base.php               | 13 +++++++++
 framework/Vfs/lib/Horde/Vfs/Directory.php          | 21 +++++++++++++
 framework/Vfs/lib/Horde/Vfs/DirectoryIterator.php  | 13 +++++++++
 framework/Vfs/lib/Horde/Vfs/File.php               | 34 ++++++++++++++++++++++
 9 files changed, 155 insertions(+)
 create mode 100644 framework/Vfs/app/controllers/DownloadController.php

diff --git a/framework/Vfs/app/controllers/DownloadController.php b/framework/Vfs/app/controllers/DownloadController.php
new file mode 100644
index 000000000..65b7ad5e8
--- /dev/null
+++ b/framework/Vfs/app/controllers/DownloadController.php
@@ -0,0 +1,6 @@
+<?php
+/**
+ */
+class Horde_Vfs_DownloadController extends Horde_Controller_Base
+{
+}
diff --git a/framework/Vfs/lib/Horde/Vfs/Adapter/Db/Base.php b/framework/Vfs/lib/Horde/Vfs/Adapter/Db/Base.php
index e69de29bb..8d76881b6 100644
--- a/framework/Vfs/lib/Horde/Vfs/Adapter/Db/Base.php
+++ b/framework/Vfs/lib/Horde/Vfs/Adapter/Db/Base.php
@@ -0,0 +1,18 @@
+<?php
+/**
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+
+/**
+ * This Db base class manages the horde_vfs_metadata table for the various Db
+ * backends (Chunked, File, S3). The metadata table holds the filesystem
+ * representation in the database, but actual file contents are not stored
+ * thre. A subclass is needed to provide actual file storage.
+ *
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+abstract class Horde_Vfs_Adapter_Db_Base
+{
+}
diff --git a/framework/Vfs/lib/Horde/Vfs/Adapter/Db/Chunked.php b/framework/Vfs/lib/Horde/Vfs/Adapter/Db/Chunked.php
index e69de29bb..e83d5108a 100644
--- a/framework/Vfs/lib/Horde/Vfs/Adapter/Db/Chunked.php
+++ b/framework/Vfs/lib/Horde/Vfs/Adapter/Db/Chunked.php
@@ -0,0 +1,17 @@
+<?php
+/**
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+
+/**
+ * A file-backed Vfs adapter that uses a database for the filesystem tree and
+ * metadata, and stores file contents in chunks in a separate blob table. Large
+ * files can be split between many chunks; small files just take one.
+ *
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+class Horde_Vfs_Adapter_Db_Chunked extends Horde_Vfs_Adapter_Db_Base
+{
+}
diff --git a/framework/Vfs/lib/Horde/Vfs/Adapter/Db/File.php b/framework/Vfs/lib/Horde/Vfs/Adapter/Db/File.php
index e69de29bb..ee3846dc8 100644
--- a/framework/Vfs/lib/Horde/Vfs/Adapter/Db/File.php
+++ b/framework/Vfs/lib/Horde/Vfs/Adapter/Db/File.php
@@ -0,0 +1,17 @@
+<?php
+/**
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+
+/**
+ * A file-backed Vfs adapter that uses a database for the filesystem tree and
+ * metadata, but stores content using the operating system's filesystem
+ * (probably local, but could be NFS or another distributed fs).
+ *
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+class Horde_Vfs_Adapter_Db_File extends Horde_Vfs_Adapter_Db_Base
+{
+}
diff --git a/framework/Vfs/lib/Horde/Vfs/Adapter/Db/S3.php b/framework/Vfs/lib/Horde/Vfs/Adapter/Db/S3.php
index e69de29bb..e81ac11c9 100644
--- a/framework/Vfs/lib/Horde/Vfs/Adapter/Db/S3.php
+++ b/framework/Vfs/lib/Horde/Vfs/Adapter/Db/S3.php
@@ -0,0 +1,16 @@
+<?php
+/**
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+
+/**
+ * A file-backed Vfs adapter that uses a database for the filesystem tree and
+ * metadata, and stores file contents on Amazon's S3.
+ *
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+class Horde_Vfs_Adapter_Db_S3 extends Horde_Vfs_Adapter_Db_Base
+{
+}
diff --git a/framework/Vfs/lib/Horde/Vfs/Base.php b/framework/Vfs/lib/Horde/Vfs/Base.php
index e69de29bb..918d437c0 100644
--- a/framework/Vfs/lib/Horde/Vfs/Base.php
+++ b/framework/Vfs/lib/Horde/Vfs/Base.php
@@ -0,0 +1,13 @@
+<?php
+/**
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+
+/**
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+class Horde_Vfs_Base
+{
+}
diff --git a/framework/Vfs/lib/Horde/Vfs/Directory.php b/framework/Vfs/lib/Horde/Vfs/Directory.php
index e69de29bb..b4e01fef1 100644
--- a/framework/Vfs/lib/Horde/Vfs/Directory.php
+++ b/framework/Vfs/lib/Horde/Vfs/Directory.php
@@ -0,0 +1,21 @@
+<?php
+/**
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+
+/**
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+class Horde_Vfs_Directory implements IteratorAggregate
+{
+    /**
+     * @return Horde_Vfs_DirectoryIterator
+     */
+    public function getIterator()
+    {
+        return new Horde_Vfs_DirectoryIterator($this);
+    }
+
+}
diff --git a/framework/Vfs/lib/Horde/Vfs/DirectoryIterator.php b/framework/Vfs/lib/Horde/Vfs/DirectoryIterator.php
index e69de29bb..b8097128a 100644
--- a/framework/Vfs/lib/Horde/Vfs/DirectoryIterator.php
+++ b/framework/Vfs/lib/Horde/Vfs/DirectoryIterator.php
@@ -0,0 +1,13 @@
+<?php
+/**
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+
+/**
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+class Horde_Vfs_DirectoryIterator implements Iterator
+{
+}
diff --git a/framework/Vfs/lib/Horde/Vfs/File.php b/framework/Vfs/lib/Horde/Vfs/File.php
index e69de29bb..60cffdc9d 100644
--- a/framework/Vfs/lib/Horde/Vfs/File.php
+++ b/framework/Vfs/lib/Horde/Vfs/File.php
@@ -0,0 +1,34 @@
+<?php
+/**
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+
+/**
+ * @category Horde
+ * @package  Horde_Vfs
+ */
+class Horde_Vfs_File
+{
+    /**
+     * Return a URL that a file can be accessed from. For example, an S3 URL, or
+     * a local file with vfs-direct and filesystem backends, or a passthrough
+     * script using the DownloadController.
+     *
+     * @return string
+     */
+    public function getUri()
+    {
+    }
+
+    /**
+     * Return a UUID for this file.
+     *
+     * @TODO useful? Could be used for indexing, for private URLs, for primary
+     * keys in Horde_Content, ...?
+     */
+    public function getUuid()
+    {
+    }
+
+}
-- 
2.11.0