Skip to content

M
mongoose
Commit 1cb094e0 authored by Joe Mucchiello's avatar Joe Mucchiello
Browse files
Options

Revert "Add http_error callback" 

This reverts commit 27fe9c8f.
parent 27fe9c8f
Hide whitespace changes
Inline Side-by-side
Showing with 5475 additions and 5479 deletions
mongoose.c
View file @ 1cb094e0
This source diff could not be displayed because it is too large. You can view the blob instead.
mongoose.h
View file @ 1cb094e0
// Copyright (c) 2004-2012 Sergey Lyubka // Copyright (c) 2004-2012 Sergey Lyubka
// //
// Permission is hereby granted, free of charge, to any person obtaining a copy // Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal // of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights // in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is // copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions: // furnished to do so, subject to the following conditions:
// //
// The above copyright notice and this permission notice shall be included in // The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software. // all copies or substantial portions of the Software.
// //
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // 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 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE. // THE SOFTWARE.
#ifndef MONGOOSE_HEADER_INCLUDED #ifndef MONGOOSE_HEADER_INCLUDED
#define MONGOOSE_HEADER_INCLUDED #define MONGOOSE_HEADER_INCLUDED
#include <stdio.h> #include <stdio.h>
#include <stddef.h> #include <stddef.h>
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif // __cplusplus #endif // __cplusplus
struct mg_context; // Handle for the HTTP service itself struct mg_context; // Handle for the HTTP service itself
struct mg_connection; // Handle for the individual connection struct mg_connection; // Handle for the individual connection
// This structure contains information about the HTTP request. // This structure contains information about the HTTP request.
struct mg_request_info { struct mg_request_info {
const char *request_method; // "GET", "POST", etc const char *request_method; // "GET", "POST", etc
const char *uri; // URL-decoded URI const char *uri; // URL-decoded URI
const char *http_version; // E.g. "1.0", "1.1" const char *http_version; // E.g. "1.0", "1.1"
const char *query_string; // URL part after '?', not including '?', or NULL const char *query_string; // URL part after '?', not including '?', or NULL
const char *remote_user; // Authenticated user, or NULL if no auth used const char *remote_user; // Authenticated user, or NULL if no auth used
long remote_ip; // Client's IP address long remote_ip; // Client's IP address
int remote_port; // Client's port int remote_port; // Client's port
int is_ssl; // 1 if SSL-ed, 0 if not int is_ssl; // 1 if SSL-ed, 0 if not
void *user_data; // User data pointer passed to mg_start() void *user_data; // User data pointer passed to mg_start()
int num_headers; // Number of HTTP headers int num_headers; // Number of HTTP headers
struct mg_header { struct mg_header {
const char *name; // HTTP header name const char *name; // HTTP header name
const char *value; // HTTP header value const char *value; // HTTP header value
} http_headers[64]; // Maximum 64 headers } http_headers[64]; // Maximum 64 headers
}; };
// This structure needs to be passed to mg_start(), to let mongoose know // This structure needs to be passed to mg_start(), to let mongoose know
// which callbacks to invoke. For detailed description, see // which callbacks to invoke. For detailed description, see
// https://github.com/valenok/mongoose/blob/master/UserManual.md // https://github.com/valenok/mongoose/blob/master/UserManual.md
struct mg_callbacks { struct mg_callbacks {
int (*begin_request)(struct mg_connection *); int (*begin_request)(struct mg_connection *);
void (*end_request)(const struct mg_connection *, int reply_status_code); void (*end_request)(const struct mg_connection *, int reply_status_code);
int (*log_message)(const struct mg_connection *, const char *message); int (*log_message)(const struct mg_connection *, const char *message);
int (*init_ssl)(void *ssl_context); int (*init_ssl)(void *ssl_context);
int (*websocket_connect)(const struct mg_connection *); int (*websocket_connect)(const struct mg_connection *);
void (*websocket_ready)(struct mg_connection *); void (*websocket_ready)(struct mg_connection *);
int (*websocket_data)(struct mg_connection *); int (*websocket_data)(struct mg_connection *);
const char * (*open_file)(const struct mg_connection *, const char * (*open_file)(const struct mg_connection *,
const char *path, size_t *data_len); const char *path, size_t *data_len);
void (*init_lua)(struct mg_connection *, void *lua_context); void (*init_lua)(struct mg_connection *, void *lua_context);
void (*upload)(struct mg_connection *, const char *file_name); void (*upload)(struct mg_connection *, const char *file_name);
int (*http_error)(struct mg_connection *, int status); };
};
// Start web server.
// Start web server. //
// // Parameters:
// Parameters: // callbacks: mg_callbacks structure with user-defined callbacks.
// callbacks: mg_callbacks structure with user-defined callbacks. // options: NULL terminated list of option_name, option_value pairs that
// options: NULL terminated list of option_name, option_value pairs that // specify Mongoose configuration parameters.
// specify Mongoose configuration parameters. //
// // Side-effects: on UNIX, ignores SIGCHLD and SIGPIPE signals. If custom
// Side-effects: on UNIX, ignores SIGCHLD and SIGPIPE signals. If custom // processing is required for these, signal handlers must be set up
// processing is required for these, signal handlers must be set up // after calling mg_start().
// after calling mg_start(). //
// //
// // Example:
// Example: // const char *options[] = {
// const char *options[] = { // "document_root", "/var/www",
// "document_root", "/var/www", // "listening_ports", "80,443s",
// "listening_ports", "80,443s", // NULL
// NULL // };
// }; // struct mg_context *ctx = mg_start(&my_func, NULL, options);
// struct mg_context *ctx = mg_start(&my_func, NULL, options); //
// // Please refer to http://code.google.com/p/mongoose/wiki/MongooseManual
// Please refer to http://code.google.com/p/mongoose/wiki/MongooseManual // for the list of valid option and their possible values.
// for the list of valid option and their possible values. //
// // Return:
// Return: // web server context, or NULL on error.
// web server context, or NULL on error. struct mg_context *mg_start(const struct mg_callbacks *callbacks,
struct mg_context *mg_start(const struct mg_callbacks *callbacks, void *user_data,
void *user_data, const char **configuration_options);
const char **configuration_options);
// Stop the web server.
// Stop the web server. //
// // Must be called last, when an application wants to stop the web server and
// Must be called last, when an application wants to stop the web server and // release all associated resources. This function blocks until all Mongoose
// release all associated resources. This function blocks until all Mongoose // threads are stopped. Context pointer becomes invalid.
// threads are stopped. Context pointer becomes invalid. void mg_stop(struct mg_context *);
void mg_stop(struct mg_context *);
// Get the value of particular configuration parameter.
// Get the value of particular configuration parameter. // The value returned is read-only. Mongoose does not allow changing
// The value returned is read-only. Mongoose does not allow changing // configuration at run time.
// configuration at run time. // If given parameter name is not valid, NULL is returned. For valid
// If given parameter name is not valid, NULL is returned. For valid // names, return value is guaranteed to be non-NULL. If parameter is not
// names, return value is guaranteed to be non-NULL. If parameter is not // set, zero-length string is returned.
// set, zero-length string is returned. const char *mg_get_option(const struct mg_context *ctx, const char *name);
const char *mg_get_option(const struct mg_context *ctx, const char *name);
// Return array of strings that represent valid configuration options.
// Return array of strings that represent valid configuration options. // For each option, a short name, long name, and default value is returned.
// For each option, a short name, long name, and default value is returned. // Array is NULL terminated.
// Array is NULL terminated. const char **mg_get_valid_option_names(void);
const char **mg_get_valid_option_names(void);
// Add, edit or delete the entry in the passwords file.
// Add, edit or delete the entry in the passwords file. //
// // This function allows an application to manipulate .htpasswd files on the
// This function allows an application to manipulate .htpasswd files on the // fly by adding, deleting and changing user records. This is one of the
// fly by adding, deleting and changing user records. This is one of the // several ways of implementing authentication on the server side. For another,
// several ways of implementing authentication on the server side. For another, // cookie-based way please refer to the examples/chat.c in the source tree.
// cookie-based way please refer to the examples/chat.c in the source tree. //
// // If password is not NULL, entry is added (or modified if already exists).
// If password is not NULL, entry is added (or modified if already exists). // If password is NULL, entry is deleted.
// If password is NULL, entry is deleted. //
// // Return:
// Return: // 1 on success, 0 on error.
// 1 on success, 0 on error. int mg_modify_passwords_file(const char *passwords_file_name,
int mg_modify_passwords_file(const char *passwords_file_name, const char *domain,
const char *domain, const char *user,
const char *user, const char *password);
const char *password);
// Return information associated with the request.
// Return information associated with the request. struct mg_request_info *mg_get_request_info(struct mg_connection *);
struct mg_request_info *mg_get_request_info(struct mg_connection *);
// Send data to the client.
// Send data to the client. // Return:
// Return: // 0 when the connection has been closed
// 0 when the connection has been closed // -1 on error
// -1 on error // number of bytes written on success
// number of bytes written on success int mg_write(struct mg_connection *, const void *buf, size_t len);
int mg_write(struct mg_connection *, const void *buf, size_t len);
#undef PRINTF_FORMAT_STRING
#undef PRINTF_FORMAT_STRING #if _MSC_VER >= 1400
#if _MSC_VER >= 1400 #include <sal.h>
#include <sal.h> #if _MSC_VER > 1400
#if _MSC_VER > 1400 #define PRINTF_FORMAT_STRING(s) _Printf_format_string_ s
#define PRINTF_FORMAT_STRING(s) _Printf_format_string_ s #else
#else #define PRINTF_FORMAT_STRING(s) __format_string s
#define PRINTF_FORMAT_STRING(s) __format_string s #endif
#endif #else
#else #define PRINTF_FORMAT_STRING(s) s
#define PRINTF_FORMAT_STRING(s) s #endif
#endif
#ifdef __GNUC__
#ifdef __GNUC__ #define PRINTF_ARGS(x, y) __attribute__((format(printf, x, y)))
#define PRINTF_ARGS(x, y) __attribute__((format(printf, x, y))) #else
#else #define PRINTF_ARGS(x, y)
#define PRINTF_ARGS(x, y) #endif
#endif
// Send data to the browser using printf() semantics.
// Send data to the browser using printf() semantics. //
// // Works exactly like mg_write(), but allows to do message formatting.
// Works exactly like mg_write(), but allows to do message formatting. // Below are the macros for enabling compiler-specific checks for
// Below are the macros for enabling compiler-specific checks for // printf-like arguments.
// printf-like arguments. int mg_printf(struct mg_connection *,
int mg_printf(struct mg_connection *, PRINTF_FORMAT_STRING(const char *fmt), ...) PRINTF_ARGS(2, 3);
PRINTF_FORMAT_STRING(const char *fmt), ...) PRINTF_ARGS(2, 3);
// Send contents of the entire file together with HTTP headers.
// Send contents of the entire file together with HTTP headers. void mg_send_file(struct mg_connection *conn, const char *path);
void mg_send_file(struct mg_connection *conn, const char *path);
// Read data from the remote end, return number of bytes read.
// Read data from the remote end, return number of bytes read. int mg_read(struct mg_connection *, void *buf, size_t len);
int mg_read(struct mg_connection *, void *buf, size_t len);
// Get the value of particular HTTP header.
// Get the value of particular HTTP header. //
// // This is a helper function. It traverses request_info->http_headers array,
// This is a helper function. It traverses request_info->http_headers array, // and if the header is present in the array, returns its value. If it is
// and if the header is present in the array, returns its value. If it is // not present, NULL is returned.
// not present, NULL is returned. const char *mg_get_header(const struct mg_connection *, const char *name);
const char *mg_get_header(const struct mg_connection *, const char *name);
// Get a value of particular form variable.
// Get a value of particular form variable. //
// // Parameters:
// Parameters: // data: pointer to form-uri-encoded buffer. This could be either POST data,
// data: pointer to form-uri-encoded buffer. This could be either POST data, // or request_info.query_string.
// or request_info.query_string. // data_len: length of the encoded data.
// data_len: length of the encoded data. // var_name: variable name to decode from the buffer
// var_name: variable name to decode from the buffer // dst: destination buffer for the decoded variable
// dst: destination buffer for the decoded variable // dst_len: length of the destination buffer
// dst_len: length of the destination buffer //
// // Return:
// Return: // On success, length of the decoded variable.
// On success, length of the decoded variable. // On error:
// On error: // -1 (variable not found).
// -1 (variable not found). // -2 (destination buffer is NULL, zero length or too small to hold the decoded variable).
// -2 (destination buffer is NULL, zero length or too small to hold the decoded variable). //
// // Destination buffer is guaranteed to be '\0' - terminated if it is not
// Destination buffer is guaranteed to be '\0' - terminated if it is not // NULL or zero length.
// NULL or zero length. int mg_get_var(const char *data, size_t data_len,
int mg_get_var(const char *data, size_t data_len, const char *var_name, char *dst, size_t dst_len);
const char *var_name, char *dst, size_t dst_len);
// Fetch value of certain cookie variable into the destination buffer.
// Fetch value of certain cookie variable into the destination buffer. //
// // Destination buffer is guaranteed to be '\0' - terminated. In case of
// Destination buffer is guaranteed to be '\0' - terminated. In case of // failure, dst[0] == '\0'. Note that RFC allows many occurrences of the same
// failure, dst[0] == '\0'. Note that RFC allows many occurrences of the same // parameter. This function returns only first occurrence.
// parameter. This function returns only first occurrence. //
// // Return:
// Return: // On success, value length.
// On success, value length. // On error:
// On error: // -1 (either "Cookie:" header is not present at all or the requested parameter is not found).
// -1 (either "Cookie:" header is not present at all or the requested parameter is not found). // -2 (destination buffer is NULL, zero length or too small to hold the value).
// -2 (destination buffer is NULL, zero length or too small to hold the value). int mg_get_cookie(const struct mg_connection *,
int mg_get_cookie(const struct mg_connection *, const char *cookie_name, char *buf, size_t buf_len);
const char *cookie_name, char *buf, size_t buf_len);
// Download data from the remote web server.
// Download data from the remote web server. // host: host name to connect to, e.g. "foo.com", or "10.12.40.1".
// host: host name to connect to, e.g. "foo.com", or "10.12.40.1". // port: port number, e.g. 80.
// port: port number, e.g. 80. // use_ssl: wether to use SSL connection.
// use_ssl: wether to use SSL connection. // error_buffer, error_buffer_size: error message placeholder.
// error_buffer, error_buffer_size: error message placeholder. // request_fmt,...: HTTP request.
// request_fmt,...: HTTP request. // Return:
// Return: // On success, valid pointer to the new connection, suitable for mg_read().
// On success, valid pointer to the new connection, suitable for mg_read(). // On error, NULL. error_buffer contains error message.
// On error, NULL. error_buffer contains error message. // Example:
// Example: // char ebuf[100];
// char ebuf[100]; // struct mg_connection *conn;
// struct mg_connection *conn; // conn = mg_download("google.com", 80, 0, ebuf, sizeof(ebuf),
// conn = mg_download("google.com", 80, 0, ebuf, sizeof(ebuf), // "%s", "GET / HTTP/1.0\r\nHost: google.com\r\n\r\n");
// "%s", "GET / HTTP/1.0\r\nHost: google.com\r\n\r\n"); struct mg_connection *mg_download(const char *host, int port, int use_ssl,
struct mg_connection *mg_download(const char *host, int port, int use_ssl, char *error_buffer, size_t error_buffer_size,
char *error_buffer, size_t error_buffer_size, PRINTF_FORMAT_STRING(const char *request_fmt),
PRINTF_FORMAT_STRING(const char *request_fmt), ...) PRINTF_ARGS(6, 7);
...) PRINTF_ARGS(6, 7);
// Close the connection opened by mg_download().
// Close the connection opened by mg_download(). void mg_close_connection(struct mg_connection *conn);
void mg_close_connection(struct mg_connection *conn);
// File upload functionality. Each uploaded file gets saved into a temporary
// File upload functionality. Each uploaded file gets saved into a temporary // file and MG_UPLOAD event is sent.
// file and MG_UPLOAD event is sent. // Return number of uploaded files.
// Return number of uploaded files. int mg_upload(struct mg_connection *conn, const char *destination_dir);
int mg_upload(struct mg_connection *conn, const char *destination_dir);
// Convenience function -- create detached thread.
// Convenience function -- create detached thread. // Return: 0 on success, non-0 on error.
// Return: 0 on success, non-0 on error. typedef void * (*mg_thread_func_t)(void *);
typedef void * (*mg_thread_func_t)(void *); int mg_start_thread(mg_thread_func_t f, void *p);
int mg_start_thread(mg_thread_func_t f, void *p);
// Return builtin mime type for the given file name.
// Return builtin mime type for the given file name. // For unrecognized extensions, "text/plain" is returned.
// For unrecognized extensions, "text/plain" is returned. const char *mg_get_builtin_mime_type(const char *file_name);
const char *mg_get_builtin_mime_type(const char *file_name);
// Return Mongoose version.
// Return Mongoose version. const char *mg_version(void);
const char *mg_version(void);
// MD5 hash given strings.
// MD5 hash given strings. // Buffer 'buf' must be 33 bytes long. Varargs is a NULL terminated list of
// Buffer 'buf' must be 33 bytes long. Varargs is a NULL terminated list of // ASCIIz strings. When function returns, buf will contain human-readable
// ASCIIz strings. When function returns, buf will contain human-readable // MD5 hash. Example:
// MD5 hash. Example: // char buf[33];
// char buf[33]; // mg_md5(buf, "aa", "bb", NULL);
// mg_md5(buf, "aa", "bb", NULL); void mg_md5(char buf[33], ...);
void mg_md5(char buf[33], ...);
#ifdef __cplusplus
#ifdef __cplusplus }
} #endif // __cplusplus
#endif // __cplusplus
#endif // MONGOOSE_HEADER_INCLUDED
#endif // MONGOOSE_HEADER_INCLUDED
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment