Return to file.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / libpdel / http / servlet

Annotation of embedaddon/libpdel/http/servlet/file.h, revision 1.1

1.1     ! misho       1: 
        !             2: /*
        !             3:  * Copyright (c) 2001-2002 Packet Design, LLC.
        !             4:  * All rights reserved.
        !             5:  * 
        !             6:  * Subject to the following obligations and disclaimer of warranty,
        !             7:  * use and redistribution of this software, in source or object code
        !             8:  * forms, with or without modifications are expressly permitted by
        !             9:  * Packet Design; provided, however, that:
        !            10:  * 
        !            11:  *    (i)  Any and all reproductions of the source or object code
        !            12:  *         must include the copyright notice above and the following
        !            13:  *         disclaimer of warranties; and
        !            14:  *    (ii) No rights are granted, in any manner or form, to use
        !            15:  *         Packet Design trademarks, including the mark "PACKET DESIGN"
        !            16:  *         on advertising, endorsements, or otherwise except as such
        !            17:  *         appears in the above copyright notice or in the software.
        !            18:  * 
        !            19:  * THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
        !            20:  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
        !            21:  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
        !            22:  * THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
        !            23:  * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
        !            24:  * OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
        !            25:  * OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
        !            26:  * OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
        !            27:  * RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
        !            28:  * LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
        !            29:  * OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
        !            30:  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
        !            31:  * DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
        !            32:  * USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
        !            33:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        !            34:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
        !            35:  * THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
        !            36:  * THE POSSIBILITY OF SUCH DAMAGE.
        !            37:  *
        !            38:  * Author: Archie Cobbs <archie@freebsd.org>
        !            39:  */
        !            40: 
        !            41: #ifndef _PDEL_HTTP_SERVLET_FILE_H_
        !            42: #define _PDEL_HTTP_SERVLET_FILE_H_
        !            43: 
        !            44: struct http_servlet_file_info;
        !            45: 
        !            46: /*
        !            47:  * Optional 'screener' function that tells whether a file in
        !            48:  * the hierarchy should be visible or not. If not supplied,
        !            49:  * all normal (and symlinked to normal) files will be visible.
        !            50:  *
        !            51:  * The "path" is the filesystem pathname to the file.
        !            52:  *
        !            53:  * Returns non-zero to hide the file, else zero to publish.
        !            54:  */
        !            55: typedef int    http_servlet_file_hide_t(
        !            56:                        const struct http_servlet_file_info *info,
        !            57:                        struct http_request *req, struct http_response *resp,
        !            58:                        const char *path);
        !            59: 
        !            60: /* Info required for this servlet */
        !            61: struct http_servlet_file_info {
        !            62:        const char      *docroot;       /* document root, or NULL for cwd */
        !            63:        u_char          allow_escape;   /* allow url to escape docroot */
        !            64:        const char      *filename;      /* filename, or NULL to use url */
        !            65:        const char      *prefix;        /* url prefix to strip, or NULL */
        !            66:        const char      *mime_type;     /* mime type, or NULL to guess */
        !            67:        const char      *mime_encoding; /* mime encoding (only if mime_type) */
        !            68:        http_logger_t   *logger;        /* http error logger */
        !            69: 
        !            70:        /* Set this to hide certain files */
        !            71:        http_servlet_file_hide_t        *hide;
        !            72: 
        !            73:        /* Fill in this struct to enable processing of '*.tmpl' as templates */
        !            74:        struct http_servlet_tmpl_tinfo  tinfo;
        !            75: };
        !            76: 
        !            77: __BEGIN_DECLS
        !            78: 
        !            79: /*
        !            80:  * Create a new file servlet.
        !            81:  *
        !            82:  * NOTE: the 'info' structure is not copied; it must remain
        !            83:  * usable as long as the servlet exists.
        !            84:  */
        !            85: extern struct  http_servlet *http_servlet_file_create(
        !            86:                        const struct http_servlet_file_info *info);
        !            87: 
        !            88: /*
        !            89:  * General purpose function for pushing out the contents of a file
        !            90:  * into an HTTP response.
        !            91:  */
        !            92: extern void    http_servlet_file_serve(const char *path, http_logger_t *logger,
        !            93:                        struct http_request *req, struct http_response *resp);
        !            94: 
        !            95: __END_DECLS
        !            96: 
        !            97: #endif /* _PDEL_HTTP_SERVLET_FILE_H_ */