WebDAV.h

Go to the documentation of this file.

/*
 *     ____             _________                __                _     
 *    / __ \___  ____ _/ /_  __(_)___ ___  ___  / /   ____  ____ _(_)____
 *   / /_/ / _ \/ __ `/ / / / / / __ `__ \/ _ \/ /   / __ \/ __ `/ / ___/
 *  / _, _/  __/ /_/ / / / / / / / / / / /  __/ /___/ /_/ / /_/ / / /__  
 * /_/ |_|\___/\__,_/_/ /_/ /_/_/ /_/ /_/\___/_____/\____/\__, /_/\___/  
 *                                                       /____/          
 *
 *                  Barracuda Embedded Web-Server
 *
 ****************************************************************************
 *                            HEADER
 *
 *   $Id: WebDAV.h 5978 2026-09-11 16:13:48Z wini $
 *
 *   COPYRIGHT:  Real Time Logic LLC, 2006-2008
 *
 *   This software is copyrighted by and is the sole property of Real
 *   Time Logic LLC.  All rights, title, ownership, or other interests in
 *   the software remain the property of Real Time Logic LLC.  This
 *   software may only be used in accordance with the terms and
 *   conditions stipulated in the corresponding license agreement under
 *   which the software has been supplied.  Any unauthorized use,
 *   duplication, transmission, distribution, or disclosure of this
 *   software is expressly forbidden.
 *                                                                        
 *   This Copyright notice may not be removed or modified without prior
 *   written consent of Real Time Logic LLC.
 *                                                                         
 *   Real Time Logic LLC. reserves the right to modify this software
 *   without notice.
 *
 *               http://www.realtimelogic.com
 ****************************************************************************
 *
 *
 */
 
#ifndef __WebDAV_h
#define __WebDAV_h
 
#include <SingleList.h>
#include "HttpUpload.h"
 
struct WebDAV;
 
#ifndef __DOXYGEN__
typedef struct
{
      SplayTree lTree; /* Lock node tree. */
      SingleList lList; /* Lock node list. */
      struct WebDAV* webDAV;
      char* lockDir;
      char* lockDirFn;
      U32 nextLockFileNumber;
      U32 locksLeft; /* Max number of allowed locks left to allocate. */
} LockContainer;
#endif
 
 
 
typedef struct WebDAV
#ifdef __cplusplus
: public HttpDir
{ 
      WebDAV(IoIntf* io,
             int maxUploads,
             const char* dirName, 
             const char* lockDir,
             U32 maxNumberOfLocks=10,
             AllocatorIntf* alloc=0,
             S8 priority=0);
 
      ~WebDAV();
 
#if 0
}
#endif
#else
{
   HttpDir super; /* Inherits from HttpDir. */
#endif
   HttpUploadCbIntf uploadCb;
   LockContainer lock;
   HttpUpload upload;
   IoIntf* io;
   AllocatorIntf* alloc;
   char* vdRootPath;
   size_t vdRootPathLen;
   BaBool ioReadOnly; /* TRUE if the IoIntf is read only. */
   BaBool ioMoveDir; /* TRUE if the IoIntf can move directories. */
} WebDAV;
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
BA_API void WebDAV_constructor(
   WebDAV* o,
   IoIntf* io,
   int maxUploads,
   const char* dirName, 
   const char* lockDir,
   U32 maxNumberOfLocks,
   AllocatorIntf* alloc,
   S8 priority);
 
BA_API void WebDAV_destructor(WebDAV* o);
 
#define WebDAV_setAuthenticator(o, authenticator, realm) \
   HttpDir_setAuthenticator((HttpDir*)o, authenticator, realm)
 
typedef struct
{
      /* 0:is-locked, 1:lock, 2:unlock, 3:lock-owner,
      */
      int action; 
      BaTime lockTime; /* in val for action 1 */
      const char* name; /* in val: the file */
      const char* owner; /* in val for action 1 */
      ResIntfPtr fp; /* out val: the owner XML file */
} WebDAVLockMgr;
 
 
BA_API int WebDAV_lockmgr(WebDAV* o, WebDAVLockMgr* mgr);
 
 
 
#ifdef __cplusplus
}
inline WebDAV::WebDAV(IoIntf* io,
                      int maxUploads,
                      const char* dirName, 
                      const char* lockDir,
                      U32 maxNumberOfLocks,
                      AllocatorIntf* alloc,
                      S8 priority) {
   WebDAV_constructor(this,io,maxUploads,dirName, lockDir,
                      maxNumberOfLocks, alloc,priority);
}
 
inline WebDAV::~WebDAV(){
   WebDAV_destructor(this);
}
#endif
 
#endif /* __WebDAV_h */