/*************************************************************************
* (C) 2012 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
* by Michael Pounov <misho@elwix.org>
*
* $Author: misho $
* $Id: aitwww.h,v 1.3.4.1 2012/07/31 11:56:16 misho Exp $
*
**************************************************************************
The ELWIX and AITNET software is distributed under the following
terms:
All of the documentation and software included in the ELWIX and AITNET
Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
by Michael Pounov <misho@elwix.org>. 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. All advertising materials mentioning features or use of this software
must display the following acknowledgement:
This product includes software developed by Michael Pounov <misho@elwix.org>
ELWIX - Embedded LightWeight unIX and its contributors.
4. Neither the name of AITNET nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY AITNET 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 REGENTS 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.
*/
#ifndef __AITWWW_H
#define __AITWWW_H
#include <sys/types.h>
#include <sys/queue.h>
#include <sys/uio.h>
/* URL staff ... */
typedef struct _tagURLItem {
int vallen;
char *value;
} url_Item_t;
struct tagIOURL {
unsigned char url_line[BUFSIZ];
url_Item_t url_tech;
url_Item_t url_user;
url_Item_t url_pass;
url_Item_t url_host;
url_Item_t url_port;
url_Item_t url_path;
url_Item_t url_args;
char *url_reserved;
};
struct tagReqXML {
unsigned char xml_line[BUFSIZ];
url_Item_t xml_namespace;
union {
url_Item_t container;
url_Item_t path;
} xml_node;
url_Item_t xml_data;
url_Item_t xml_attribute;
url_Item_t xml_value;
};
/* CGI variables */
struct tagCGI {
char *cgi_name;
char *cgi_value;
SLIST_ENTRY(tagCGI) cgi_node;
};
typedef SLIST_HEAD(, tagCGI) cgi_t;
struct tagMIME;
typedef SLIST_HEAD(, tagMIME) mime_t;
struct tagMIME {
cgi_t mime_header;
struct iovec mime_body;
struct iovec mime_prolog;
struct iovec mime_epilog;
mime_t *mime_attach;
SLIST_ENTRY(tagMIME) mime_node;
};
typedef int (*list_cb_t)(struct tagCGI *, void *);
// www_GetErrno() Get error code of last operation
inline int www_GetErrno();
// www_GetError() Get error text of last operation
inline const char *www_GetError();
/*
* www_initCGI() - Init CGI program
*
* return: NULL error or allocated cgi session
*/
cgi_t *www_initCGI(void);
/*
* www_closeCGI() - Close and free all CGI resources
*
* @cgi = Inited cgi session
* return: none
*/
void www_closeCGI(cgi_t ** __restrict cgi);
/*
* www_parseQuery() - Parse CGI query string
*
* @str = String
* return: NULL error or allocated cgi session
*/
cgi_t *www_parseQuery(const char *str);
/*
* www_parseMultiPart() - Parse Multi part POST CGI query string
*
* @str = String
* @ctlen = Content length
* @ct = Content type
* return: NULL error or allocated cgi session
*/
cgi_t *www_parseMultiPart(const char *str, int ctlen, const char *ct);
/*
* www_getValue() - Get Value from CGI session
*
* @cgi = Inited cgi session
* @name = Name of cgi variable
* return: NULL not found or !=NULL value
*/
inline const char *www_getValue(cgi_t * __restrict cgi, const char *name);
/*
* www_addValue() - Add new or update if exists CGI variable
*
* @cgi = Inited cgi session
* @name = Name of cgi variable
* @value = Value of cgi variable
* return: -1 error, 0 add new one or 1 updated variable
*/
int www_addValue(cgi_t * __restrict cgi, const char *name, const char *value);
/*
* www_delPair() - Delete CGI variable from session
*
* @cgi = Inited cgi session
* @name = Name of cgi variable
* return: -1 error, 0 not found or 1 deleted ok
*/
int www_delPair(cgi_t * __restrict cgi, const char *name);
/*
* www_listPairs() - Walk over CGI session variables
*
* @cgi = Cgi session
* @func = If !=NULL call function for each element
* @arg = Optional argument pass through callback
* return: -1 error or >-1 number of elements
*/
inline int www_listPairs(cgi_t * __restrict cgi, list_cb_t func, void *arg);
/*
* www_header() - Output initial html header
*
* @output = file handle
* return: <1 error or >0 writed bytes
*/
inline int www_header(FILE *output);
/*
* www_parseAttributes() - Parse attributes
*
* @ct = Content type
* return: NULL error or !=NULL attributes
*/
inline cgi_t *www_parseAttributes(const char **ct);
/*
* www_freeAttributes() - Free attributes
*
* @attr = Attributes
* return: none
*/
inline void www_freeAttributes(cgi_t ** __restrict attr);
/*
* www_getAttribute() - Get attribute by name
*
* @attr = Attributes
* @name = Name of attribute
* return: NULL not found or !=NULL attribute value
*/
inline const char *www_getAttribute(cgi_t * __restrict attr, const char *name);
/*
* www_cmp() - Compare two string
*
* @ct = content text from www
* @s = string
* return: 0 are equal or !0 are different
*/
int www_cmp(const char *ct, const char *s);
/*
* www_cmptype() - Compare context type
*
* @ct = content text from www
* @type = content type
* return: 0 are equal or !0 are different
*/
int www_cmptype(const char *ct, const char *type);
/*
* www_getpair() - Get AV pair from WWW query string
*
* @str = query string
* @delim = delimiter
* return: NULL error or AV pair, must be free() after use!
*/
char *www_getpair(char ** __restrict str, const char *delim);
/*
* www_x2c() - Hex from string to digit
*
* @str = string
* return: digit
*/
inline char www_x2c(const char *str);
/*
* www_unescape() - Unescape/decode WWW query string to host string
*
* @str = string
* return: none
*/
inline void www_unescape(char * __restrict str);
/*
* www_URLGet() - Parse and get data from input URL
*
* @csURL = Input URL line
* @url = Output parsed URL
* return: 0 error format not find tech:// and return URL like path;
* -1 error:: can`t read; >0 ok, up bits for known elements
*/
int www_URLGet(const char *csURL, struct tagIOURL *url);
/*
* www_URLGetFile() - Get file from parsed URL
*
* @url = Input parsed URL
* @psValue = Return filename, if not specified file in url path, replace with /
* @valLen = Size of psValue array
* return: -1 error:: can`t read; 0 ok
*/
int www_URLGetFile(struct tagIOURL *url, char * __restrict psValue, int valLen);
/*
* www_XMLGet() - Parse and get data from input XML request string
* [ns:]container[|attribute[=value]][?data]
*
* @csXML = Input XML request line
* @xml = Output parsed XML request
* return: 0 error format incorrect, -1 error:: can`t read; >0 ok readed elements bits
*/
int www_XMLGet(const char *csXML, struct tagReqXML *xml);
#endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>