Author: kn
Date: Mon Nov 26 20:54:11 2007
New Revision: 6820
Log:
- Added basic webdav tutorial
Added:
trunk/Webdav/docs/tutorial/
trunk/Webdav/docs/tutorial.txt (with props)
trunk/Webdav/docs/tutorial/backend/
trunk/Webdav/docs/tutorial/basic_path_factory.php (with props)
trunk/Webdav/docs/tutorial/basic_server.php (with props)
trunk/Webdav/docs/tutorial/tutorial_autoload.php (with props)
Added: trunk/Webdav/docs/tutorial.txt
==============================================================================
--- trunk/Webdav/docs/tutorial.txt (added)
+++ trunk/Webdav/docs/tutorial.txt [iso-8859-1] Mon Nov 26 20:54:11 2007
@@ -1,0 +1,154 @@
+======================
+eZ Components - Webdav
+======================
+
+.. contents:: Table of Contents
+ :depth: 2
+
+Introduction
+============
+
+The webdav component enables you to set up a webdav enabled server, to let
+user upload, modify and download files, through HTTP. The current
+implementation is compativle with `RFC 2518`__ but may be extended through
+plugins to also support other standards.
+
+__ http://tools.ietf.org/html/rfc2518
+
+The component is intended to support you by providing access to your data
+through HTTP. The data may be stored in the file system, or any other
+imaginable custom data storage. The data will will be served as a virtual
+directory tree to the user.
+
+Terms
+=====
+
+There are some terms, used in a webdav environment, which slightly differ from
+similar environments.
+
+Collection
+ When it comes to webdav a collection means a set of files and other
+ collections, which may be compared with directories in a normal file
+ system.
+
+Ressource
+ A ressource equals a file, but we use a different term here, to differ
+ between real files on the hard disk, and the virtual ressources (files)
in
+ a webdav share.
+
+Properties
+ There are several default properties, like the odification time, or file
+ size of webdav ressources, but you may also store and modify custom
+ properties on all ressources.
+
+Set up a webdav server
+======================
+
+When you want to set up a basic webdav server, you have to consider two steps:
+
+1) You need to configure the webdav server to work correctly with the incoming
+ requests from webdav clients. This means, when need to set up some
+ rewriting for the request paths, which the client sends, to the paths,
+ which are used in our backend.
+
+2) You need to setup the backend, so it points to the ressources you want to
+ share through webdav.
+
+Path autodetection
+------------------
+
+Using the default path factory, which tries to autodetect your setup and map
+the paths accordingly, you need very few code, to setup your webdav server.
+
+.. include:: tutorial/basic_server.php
+ :literal:
+
+As you can see in the example, we first create a new webdav server instance.
+Then a file backend is created, which just receives the directory as a
+parameter, where your contents are stored.
+
+Finally we call the method handle() on the ezcWebdavServer, which actually
+parses and responds to the request with the created backend as a parameter.
+
+Basic path factory
+------------------
+
+The custom path factory enables you to specify the request path mapping to the
+path of a ressource in the repository. This may be used, if the automatic
+detection does not work properly in your case.
+
+.. include:: tutorial/basic_path_factory.php
+ :literal:
+
+When assigning the new object of ezcWebdavBasicPathFactory the server
+configuration, you provide the base path, which always will be removed from
+the request URLs.
+
+If you need a more specialized mapping of request paths to repository paths,
+you may write your own path factory, by implmenting the ezcWebdavPathFactory
+interface, or extending one of the existing path factories.
+
+Testing the server
+------------------
+
+You may test the server directly with a webdav client of your choice. But the
+most webdav clients provide very bad debugging facilities.
+
+The webdav client with the most verbose error reporting currently is the
+`command line webdav client cadaver`__, where you might get some information,
+then just failing requests.
+
+__ http://www.webdav.org/cadaver/
+
+The second step you should take is to enable error loging, either by catching
+all exceptions from the webdav and log them to a file, or just enable
+log_errors in your php.ini.
+
+You may also access the webdav server with a browser, since webdav is just an
+extension to the HTTP protocol, you should be able to get valid results out of
+this, and also see possible errors. Remember that collections (or directories)
+does not contain anything, and so you won't see anything in your browser for
+them, when everything goes right - but you should still be able to download
+the files in the webdav share.
+
+Writing a custom backend
+========================
+
+The most common way of extending a webdav server is providing a custom backend
+to your data. A backend receives ezcWebdavRequest objects, and generates
+ezcWebdavResponse objects, which are displayed again in a web the current
+client will understand it.
+
+There are basically two ways for you to implement a custom backend. On the one
+hand you may implement all the request object handling yourself, by directly
+extending the ezcWebdavBackend, or you may reuse the existing helper class
+ezcWebdavSimpleBackend.
+
+The simple backend
+------------------
+
+The simple backend, defined in the class ezcWebdavSimpleBackend, already
+implements all request to response mapping, so you only need to implement
+several methodds directly accessing the data in your backend, like the file
+backend does.
+
+The simple backend
+------------------
+
+The simple backend, defined in the class ezcWebdavSimpleBackend, already
+implements all request to response mapping, so you only need to implement
+several methodds directly accessing the data in your backend, like the file
+backend does.
+
+If you need a more fine grained control, or optimzations, you will still need
+to extend the basic ezcWebdavBackend class directly. If you want to implement
+a custom backend you could use the file backend, or the memory backend, mainly
+intended for testing, as an implementation guide.
+
+
+..
+ Local Variables:
+ mode: rst
+ fill-column: 79
+ End:
+ vim: et syn=rst tw=79
Propchange: trunk/Webdav/docs/tutorial.txt
------------------------------------------------------------------------------
svn:eol-style = native
Added: trunk/Webdav/docs/tutorial/basic_path_factory.php
==============================================================================
--- trunk/Webdav/docs/tutorial/basic_path_factory.php (added)
+++ trunk/Webdav/docs/tutorial/basic_path_factory.php [iso-8859-1] Mon Nov 26
20:54:11 2007
@@ -1,0 +1,16 @@
+<?php
+
+require_once 'tutorial_autoload.php';
+
+$server = ezcWebdavServer::getInstance();
+
+$server->configurations->pathFactory =
+ new ezcWebdavBasicPathFactory( '/path/to/webdav' );
+
+$backend = new ezcWebdavFileBackend(
+ dirname( __FILE__ ) . '/backend'
+);
+
+$server->handle( $backend );
+
+?>
Propchange: trunk/Webdav/docs/tutorial/basic_path_factory.php
------------------------------------------------------------------------------
svn:eol-style = native
Added: trunk/Webdav/docs/tutorial/basic_server.php
==============================================================================
--- trunk/Webdav/docs/tutorial/basic_server.php (added)
+++ trunk/Webdav/docs/tutorial/basic_server.php [iso-8859-1] Mon Nov 26
20:54:11 2007
@@ -1,0 +1,12 @@
+<?php
+
+require_once 'tutorial_autoload.php';
+
+$server = ezcWebdavServer::getInstance();
+$backend = new ezcWebdavFileBackend(
+ dirname( __FILE__ ) . '/backend'
+);
+
+$server->handle( $backend );
+
+?>
Propchange: trunk/Webdav/docs/tutorial/basic_server.php
------------------------------------------------------------------------------
svn:eol-style = native
Added: trunk/Webdav/docs/tutorial/tutorial_autoload.php
==============================================================================
--- trunk/Webdav/docs/tutorial/tutorial_autoload.php (added)
+++ trunk/Webdav/docs/tutorial/tutorial_autoload.php [iso-8859-1] Mon Nov 26
20:54:11 2007
@@ -1,0 +1,20 @@
+<?php
+$dir = dirname( dirname( __FILE__ ) );
+$dirParts = explode( '/', $dir );
+switch ( $dirParts[count( $dirParts ) - 3] )
+{
+ case 'doc': require_once 'ezc/Base/base.php'; break; // pear
+ case 'trunk': require_once "$dir/../../Base/src/base.php"; break; // svn
+ default: require_once "$dir/../../Base/src/base.php"; break; // bundle
+}
+
+/**
+ * Autoload ezc classes
+ *
+ * @param string $className
+ */
+function __autoload( $className )
+{
+ ezcBase::autoload( $className );
+}
+?>
Propchange: trunk/Webdav/docs/tutorial/tutorial_autoload.php
------------------------------------------------------------------------------
svn:eol-style = native
--
svn-components mailing list
svn-components@lists.ez.no
http://lists.ez.no/mailman/listinfo/svn-components
