envvars.h

Go to the documentation of this file.

#ifndef _PRO_UHTTP_ENVVARS_H_
#define _PRO_UHTTP_ENVVARS_H_

/*
 * Copyright (C) 2012 by egnite GmbH
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the names of
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * For additional information see http://www.ethernut.de/
 */

/*
 * $Id$
 */

#include <isc/list.h>

#include <pro/uhttp/uhttpd.h>


#define HSITEM_DATE_GMT                 1

#define HSITEM_DATE_LOCAL               2

#define HSITEM_DOCUMENT_NAME            3

#define HSITEM_DOCUMENT_ROOT            4

#define HSITEM_HTTP_ACCEPT_ENCODING     5

#define HSITEM_HTTP_CONNECTION          6

#define HSITEM_HTTP_COOKIE              7

#define HSITEM_HTTP_HOST                8

#define HSITEM_HTTP_REFERER             9

#define HSITEM_HTTP_USER_AGENT          10

#define HSITEM_QUERY_STRING             11

#define HSITEM_QUERY_STRING_UNESCAPED   12

#define HSITEM_REQUEST_METHOD           13

#define HSITEM_REQUEST_URI              14

#define HSITEM_SCRIPT_FILENAME          15

#define HSITEM_SCRIPT_NAME              16

typedef const char* (*HTTP_ENV_HANDLER) (HTTPD_SESSION*, const char *name);

typedef const char* (*HTTP_ENVVAR_HANDLER) (HTTPD_SESSION*, int);

typedef struct _HTTP_ENVVAR_ENTRY HTTP_ENVVAR_ENTRY;

struct _HTTP_ENVVAR_ENTRY {
    ISC_LINK(HTTP_ENVVAR_ENTRY) env_link;
    char *env_name;
    HTTP_ENVVAR_HANDLER env_handler;
    int env_index;
    int env_flags;
};

extern int EnvInitDefaults(void);

extern int EnvRegisterVariable(char *name, HTTP_ENVVAR_HANDLER handler, int item);

extern const HTTP_ENVVAR_ENTRY* EnvVarGetEntry(const char *name);

extern const char *EnvHandler(HTTPD_SESSION *hs, const char *name);

extern const char *HttpStreamInfo(HTTPD_SESSION *hs, int item);

extern const char *HttpSessionInfo(HTTPD_SESSION *hs, int item);

#endif