lws-cgi.h

Go to the documentation of this file.

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010 - 2019 Andy Green <andy@warmcat.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

 
enum lws_enum_stdinouterr {
        LWS_STDIN = 0,
        LWS_STDOUT = 1,
        LWS_STDERR = 2,
};
 
enum lws_cgi_hdr_state {
        LCHS_HEADER,
        LCHS_CR1,
        LCHS_LF1,
        LCHS_CR2,
        LCHS_LF2,
        LHCS_RESPONSE,
        LHCS_DUMP_HEADERS,
        LHCS_PAYLOAD,
        LCHS_SINGLE_0A,
};
 
struct lws_cgi_args {
        struct lws **stdwsi; 
        enum lws_enum_stdinouterr ch; 
        unsigned char *data; 
        enum lws_cgi_hdr_state hdr_state; 
        int len; 
};

struct lws_cgi_info {
        struct lws *wsi;
        const char * const *exec_array;
        int script_uri_path_len;
        int timeout_secs;
        const struct lws_protocol_vhost_options *mp_cgienv;
        const char *chroot_path;
        const char *wd;
};
 
#ifdef LWS_WITH_CGI
LWS_VISIBLE LWS_EXTERN int lws_cgi_via_info(struct lws_cgi_info * cgiinfo);

LWS_VISIBLE LWS_EXTERN int
lws_cgi(struct lws *wsi, const char * const *exec_array,
        int script_uri_path_len, int timeout_secs,
        const struct lws_protocol_vhost_options *mp_cgienv);

LWS_VISIBLE LWS_EXTERN int
lws_cgi_write_split_stdout_headers(struct lws *wsi);

LWS_VISIBLE LWS_EXTERN int
lws_cgi_kill(struct lws *wsi);

LWS_VISIBLE LWS_EXTERN struct lws *
lws_cgi_get_stdwsi(struct lws *wsi, enum lws_enum_stdinouterr ch);
 
#endif