HttpResRdr.h

Go to the documentation of this file.

/*
 *     ____             _________                __                _
 *    / __ \___  ____ _/ /_  __(_)___ ___  ___  / /   ____  ____ _(_)____
 *   / /_/ / _ \/ __ `/ / / / / / __ `__ \/ _ \/ /   / __ \/ __ `/ / ___/
 *  / _, _/  __/ /_/ / / / / / / / / / / /  __/ /___/ /_/ / /_/ / / /__
 * /_/ |_|\___/\__,_/_/ /_/ /_/_/ /_/ /_/\___/_____/\____/\__, /_/\___/
 *                                                       /____/
 *
 *                  Barracuda Embedded Web-Server
 *
 ****************************************************************************
 *                            HEADER
 *
 *   $Id: HttpResRdr.h 6056 2026-09-20 05:09:33Z wini $
 *
 *   COPYRIGHT:  Real Time Logic LLC, 2006 - 2026
 *
 *   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 _HttpResRdr_h
#define _HttpResRdr_h
 
#include "IoIntf.h"
#include "BaServerLib.h"
#include "HttpServer.h"
 
 
struct HttpRdFilter;
typedef void (*HttpRdFilter_Service)(struct HttpRdFilter* o,
                                     const char* name,
                                     IoStat* st,
                                     HttpCommand* cmd);
 
typedef struct HttpRdFilter
{
      DoubleLink super;
      HttpRdFilter_Service serviceFp;
      const char* ext; /* File Extension */
} HttpRdFilter;
 
BA_API void HttpRdFilter_constructor(
   HttpRdFilter* o, const char* ext, HttpRdFilter_Service serviceFp);
 
BA_API void HttpRdFilter_destructor(HttpRdFilter* o);
 
/* Designed for LSP function dir:header(table)
   The key and value indexes point to the key and value embedded as
   part of the memory region below the struct.
*/
typedef struct {
   U16 keyIx;
   U16 valIx;
} HttpResRdrHeader;
 
 
typedef struct HttpResRdr
#ifdef __cplusplus
: public HttpDir
{
      HttpResRdr() {}
      HttpResRdr(IoIntf* io, const char* dirName,
                  AllocatorIntf* alloc=0, S8 priority=0);
 
      HttpResRdr(IoIntf* io, const char* domain, const char* p404,
                 AllocatorIntf* alloc=0, S8 priority=0);
 
      int insertPrologDir(HttpDir* dir);
 
      ~HttpResRdr();
 
      int installFilter(HttpRdFilter* filter);
 
      void  setMaxAge(BaTime maxAge);
 
      static void sendFile(
         IoIntf* io,const char* name, IoStat* st, HttpCommand* cmd);
 
      IoIntf* getIo();
#if 0
}
#endif
#else
{
      HttpDir super; /* Inherits from HttpDir */
#endif
      DoubleList filterList;
      AllocatorIntf* alloc;
      IoIntf* io;
      HttpDir_Service superServiceFunc;
      HttpDir* prologDirRoot;
      HttpResRdrHeader* headers;
      const char* domain;
      const char* p404;
      BaTime maxAge;
      int maxFilterLen;
} HttpResRdr;
 
 
#ifdef __cplusplus
extern "C" {
#endif
BA_API void HttpResRdr_constructor(
   HttpResRdr* o, IoIntf* io, const char* dirName,
   AllocatorIntf* alloc, S8 priority);
BA_API void HttpResRdr_constructor2(
   HttpResRdr* o,IoIntf* io,const char* domain,
   const char* p404,AllocatorIntf* alloc,
   S8 priority);
BA_API int HttpResRdr_insertPrologDir(HttpResRdr* o, HttpDir* dir);
BA_API void HttpResRdr_destructor(HttpResRdr* o);
BA_API int HttpResRdr_installFilter(HttpResRdr* o, HttpRdFilter* filter);
#define HttpResRdr_setMaxAge(o, maxAgeMA) (o)->maxAge=maxAgeMA
#define HttpResRdr_setAuthenticator(o, authenticator, realm) \
   HttpDir_setAuthenticator((HttpDir*)o, authenticator, realm)
BA_API void HttpResRdr_sendFile(IoIntf* io,const char* name,
   IoStat* st,HttpCommand* cmd);
/* Shared resource/WebDAV helpers. Metadata is not a content revision, so the
   NUL-terminated tag is weak; buf must hold HttpResRdr_ETagSize bytes. */
#define HttpResRdr_ETagSize 38
BA_API void HttpResRdr_fmtETag(char* buf, const IoStat* st);
/* Return 0 to proceed or an HTTP status (304/400/412). st is NULL for a
   nonexistent target; the caller performs normal method/access checks first. */
BA_API int HttpResRdr_checkPreconditions(HttpRequest* req, const IoStat* st);
BA_API void set_deflategzip(IoIntf_DeflateGzip ptr);
BA_API IoIntf_DeflateGzip get_deflategzip(void);
BA_API void HttpResRdr_setHeader(HttpResRdr* o, HttpResRdrHeader* headers);
 
 
#define HttpResRdr_getIo(o) (o)->io
#ifdef __cplusplus
}
inline HttpResRdr::HttpResRdr(IoIntf* io, const char* domain, const char* p404,
                              AllocatorIntf* alloc, S8 priority) {
   HttpResRdr_constructor2(this, io, domain, p404, alloc, priority);
}
inline HttpResRdr::HttpResRdr(IoIntf* io, const char* dirName,
                              AllocatorIntf* alloc, S8 priority) {
   HttpResRdr_constructor(this, io, dirName, alloc, priority);
}
 
inline int HttpResRdr::insertPrologDir(HttpDir* dir) {
   return HttpResRdr_insertPrologDir(this, dir);
}
 
inline HttpResRdr::~HttpResRdr(){
   HttpResRdr_destructor(this);
}
inline int HttpResRdr::installFilter(HttpRdFilter* filter){
   return HttpResRdr_installFilter(this, filter);
}
inline void  HttpResRdr::setMaxAge(BaTime maxAge){
   HttpResRdr_setMaxAge(this, maxAge);
}
inline void HttpResRdr::sendFile(
   IoIntf* io, const char* name, IoStat* st, HttpCommand* cmd){
   HttpResRdr_sendFile(io,name,st,cmd);
}
inline IoIntf* HttpResRdr::getIo() {
   return HttpResRdr_getIo(this);
}
#endif
 
 
#endif