/** @file
Parser: scripting and CGI main.
Copyright (c) 2001-2026 Art. Lebedev Studio (https://www.artlebedev.com)
Authors: Konstantin Morshnev <moko@design.ru>, Alexandr Petrosian <paf@design.ru>
*/
volatile const char * IDENT_PARSER3_C="$Id: parser3.C,v 1.368 2026/04/25 13:38:46 moko Exp $";
#include "pa_config_includes.h"
#include "pa_sapi.h"
#include "classes.h"
#include "pa_common.h"
#include "pa_request.h"
#include "pa_version.h"
#include "pa_threads.h"
#include "pa_vconsole.h"
#include "pa_sapi_info.h"
#ifdef _MSC_VER
#include <crtdbg.h>
#include <windows.h>
#include <direct.h>
extern "C" HANDLE WINAPI GC_CreateThread(LPSECURITY_ATTRIBUTES, DWORD, LPTHREAD_START_ROUTINE, LPVOID, DWORD, LPDWORD);
#else
extern "C" int GC_pthread_create(pthread_t *, const pthread_attr_t *, void *(*)(void *), void * /* arg */);
#endif
// defines
// comment remove me after debugging
//#define PA_DEBUG_CGI_ENTRY_EXIT
#if defined(_MSC_VER) && !defined(_DEBUG)
# define PA_SUPPRESS_SYSTEM_EXCEPTION
#endif
// consts
#define REDIRECT_PREFIX "REDIRECT_"
#define PARSER_CONFIG_ENV_NAME "CGI_PARSER_CONFIG"
#define PARSER_LOG_ENV_NAME "CGI_PARSER_LOG"
SAPI_Info sapi_console;
SAPI_Info_CGI sapi_cgi;
static SAPI_Info *sapi_info = &sapi_cgi;
static THREAD_LOCAL SAPI_Info *sapi_info_4log = NULL; // global for correct send error in die()
const char* parser3_mode = "cgi"; // $status:mode
static const char* filespec_to_process = 0; // [file]
static const char* httpd_host_port = 0; // -p option
static const char* config_filespec = 0; // -f option or from env or next to the executable if exists
static const char* log_filespec = 0; // -l option
static bool mail_received = false; // -m option? [asked to parse incoming message to $mail:received]
static const char* parser3_filespec = 0; // argv[0]
static char** argv_extra = NULL;
// for error logging
static THREAD_LOCAL Request_info *request_info_4log = NULL; // global for correct log() reporting
static const char* filespec_4log = NULL; // null only if system-wide auto.p used
template <typename T> static T *dir_pos(T *fname){
T *result=NULL;
while (fname=strpbrk(fname, "/\\")){
result=fname;
fname++;
}
return result;
}
const char *parser3_log_filespec() { // $status:log-filename
const char* slog=log_filespec;
if(!slog)
slog=getenv(PARSER_LOG_ENV_NAME);
if(!slog)
slog=getenv(REDIRECT_PREFIX PARSER_LOG_ENV_NAME);
if(!slog) {
static char log_spec[MAX_STRING + 12 /* '/parser3.log' */];
pa_strncpy(log_spec, filespec_4log, MAX_STRING);
if(char* log_dir_pos=dir_pos(log_spec)){
strcpy(log_dir_pos, "/parser3.log");
} else {
// no path, just filename
strcpy(log_spec, "./parser3.log");
}
slog=log_spec;
}
return slog;
}
// SAPI
static void pa_log(const char* fmt, va_list args) {
// use no memory [so that we could log out-of-memory error]
const char* slog=parser3_log_filespec();
FILE *f=strcmp(slog,"-") ? fopen(slog, "at") : stderr;
// fallback to stderr
if(!f)
f=stderr;
setbuf(f, 0); // stderr stream is unbuffered by default, but still...
// prefix
time_t t=time(0);
if(const char* stamp=ctime(&t)) { // never saw that
if(size_t len=strlen(stamp)) // saw once stamp being =""
fprintf(f, "[%.*s] [%u] ", (int)len-1, stamp, (unsigned int)pa_get_thread_id() );
}
// message
char buf[MAX_LOG_STRING];
size_t size=vsnprintf(buf, MAX_LOG_STRING, fmt, args);
size=remove_crlf(buf, buf+size);
fwrite(buf, size, 1, f);
if(request_info_4log && request_info_4log->method) {
fprintf(f, " [uri=%s, method=%s, cl=%lu]\n", request_info_4log->uri ? request_info_4log->uri : "<unknown>", request_info_4log->method, (unsigned long)request_info_4log->content_length);
} else
fputs(" [no request info]\n", f);
if(f!=stderr)
fclose(f);
else
fflush(f);
}
void pa_log(const char* fmt, ...) {
va_list args;
va_start(args,fmt);
pa_log(fmt, args);
va_end(args);
}
// appends to parser3.log located next to the config file if openable, to stderr otherwize
void SAPI::log(SAPI_Info&, const char* fmt, ...) {
va_list args;
va_start(args,fmt);
pa_log(fmt, args);
va_end(args);
}
void SAPI::die(const char* fmt, ...) {
va_list args;
// logging first, first vsnprintf
va_start(args,fmt);
pa_log(fmt, args);
va_end(args);
// inform user, second vsnprintf
va_start(args, fmt);
char message[MAX_STRING];
vsnprintf(message, MAX_STRING, fmt, args);
SAPI::send_error(sapi_info_4log ? *sapi_info_4log : *sapi_info, message);
exit(1);
// va_end(args);
}
void SAPI::send_error(SAPI_Info& info, const char *exception_cstr, const char *status){
info.send_error(exception_cstr, status);
}
char* SAPI::Env::get(SAPI_Info& info, const char* name) {
return info.get_env(name);
}
bool SAPI::Env::set(SAPI_Info& info, const char* name, const char* value) {
return info.set_env(name, value);
}
const char* const *SAPI::Env::get(SAPI_Info& info) {
return info.get_env();
}
size_t SAPI::read_post(SAPI_Info& info, char* buf, size_t max_bytes) {
return info.read_post(buf, max_bytes);
}
void SAPI::add_header_attribute(SAPI_Info& info, const char* dont_store_key, const char* dont_store_value) {
info.add_header(dont_store_key, dont_store_value);
}
void SAPI::send_headers(SAPI_Info& info) {
info.send_headers();
}
void SAPI::clear_headers(SAPI_Info& info) {
info.clear_headers();
}
size_t SAPI::send_body(SAPI_Info& info, const void *buf, size_t size) {
return info.send_body(buf, size);
}
static const char* full_disk_path(const char* file_name = "") {
char* result;
if(file_name[0]=='/'
#ifdef WIN32
|| file_name[0] && file_name[1]==':'
#endif
){
result=pa_strdup(file_name);
} else {
char cwd[MAX_STRING];
result=pa_strcat(getcwd(cwd, MAX_STRING) ? cwd : "", "/", file_name);
}
#ifdef WIN32
back_slashes_to_slashes(result);
#endif
return result;
}
static void log_signal(const char* signal_name) {
pa_log("%s received %s processing request", signal_name, request ? "while" : "before or after");
}
#ifdef SIGPIPE
#define SIGPIPE_NAME "SIGPIPE"
static const String sigpipe_name(SIGPIPE_NAME);
static void SIGPIPE_handler(int /*sig*/){
Value* sigpipe=0;
if(request)
sigpipe=request->main_class.get_element(sigpipe_name);
if(sigpipe && sigpipe->as_bool())
log_signal(SIGPIPE_NAME);
if(request)
request->set_skip(Request::SKIP_INTERRUPTED);
}
#endif
// requires pa_thread_request() in entry_exists() under Windows
static const char* locate_config(const char* config_filespec_option, const char* executable_path){
filespec_4log=config_filespec_option;
if(!filespec_4log)
filespec_4log=getenv(PARSER_CONFIG_ENV_NAME);
if(!filespec_4log)
filespec_4log=getenv(REDIRECT_PREFIX PARSER_CONFIG_ENV_NAME);
if(!filespec_4log){
const char* exec_dir_pos = dir_pos(executable_path);
#ifdef SYSTEM_CONFIG_FILE
if(exec_dir_pos){
#endif
// next to the executable
if(!exec_dir_pos || (exec_dir_pos==executable_path+1 && *executable_path=='.')){
// when just parser3 or ./parser3 full path should be used to avoid "parser already configured"
filespec_4log=full_disk_path(AUTO_FILE_NAME);
} else {
filespec_4log=pa_strcat(pa_strdup(executable_path, exec_dir_pos - executable_path), "/" AUTO_FILE_NAME);
}
if(entry_exists(filespec_4log))
return filespec_4log;
#ifdef SYSTEM_CONFIG_FILE
}
if(entry_exists(SYSTEM_CONFIG_FILE)){
filespec_4log=NULL;
return SYSTEM_CONFIG_FILE;
}
#endif
return NULL;
}
return filespec_4log;
}
#ifdef WIN32
static const char* maybe_reconstruct_IIS_status_in_qs(const char* original) {
// 404;http://servername/page[?param=value...]
// ';' should be urlencoded by HTTP standard, so we shouldn't get it from browser
// and can consider that as an indication that this is IIS way to report errors
if(original && isdigit((unsigned char)original[0]) && isdigit((unsigned char)original[1]) && isdigit((unsigned char)original[2]) && original[3]==';'){
size_t original_len=strlen(original);
char* reconstructed=new(PointerFreeGC) char[original_len +12/*IIS-STATUS=&*/ +14/*IIS-DOCUMENT=&*/ +1];
char* cur=reconstructed;
memcpy(cur, "IIS-STATUS=", 11); cur+=11;
memcpy(cur, original, 3); cur+=3;
*cur++='&';
const char* qmark_at=strchr(original, '?');
memcpy(cur, "IIS-DOCUMENT=", 13); cur+=13;
{
size_t value_len=(qmark_at ? qmark_at-original : original_len)-4;
memcpy(cur, original+4, value_len); cur+=value_len;
}
if(qmark_at) {
*cur++='&';
strcpy(cur, qmark_at+1/*skip ? itself*/);
} else
*cur=0;
return reconstructed;
}
return original;
}
static const char* maybe_back_slashes_to_slashes(const char* original){
char *result=pa_strdup(original);
back_slashes_to_slashes(result);
return result;
}
#define MAYBE_RECONSTRUCT_IIS_STATUS_IN_QS(s) maybe_reconstruct_IIS_status_in_qs(s)
#define MAYBE_BACK_SLASHES_TO_SLASHES(s) maybe_back_slashes_to_slashes(s)
#else
#define MAYBE_RECONSTRUCT_IIS_STATUS_IN_QS(s) s
#define MAYBE_BACK_SLASHES_TO_SLASHES(s) s
#endif
class RequestController {
public:
RequestController(Request* r){
request=r;
}
~RequestController(){
request=0;
}
};
class RequestInfoController {
public:
RequestInfoController(Request_info* rinfo, SAPI_Info* sinfo){
request_info_4log=rinfo;
sapi_info_4log=sinfo;
}
~RequestInfoController(){
request_info_4log=0;
sapi_info_4log=0;
}
};
/** httpd support */
static const String httpd_class_name("httpd");
static void config_handler(SAPI_Info &info) {
Request_info request_info;
RequestInfoController ric(&request_info, &info);
request_info.document_root = full_disk_path();
request_info.uri = "";
request_info.argv = argv_extra;
// prepare to process request
Request r(info, request_info, String::Language(String::L_HTML|String::L_OPTIMIZE_BIT));
// only once
config_filespec = locate_config(config_filespec, parser3_filespec);
// process main auto.p only
r.core(config_filespec, false, String::Empty);
}
static void connection_handler(SAPI_Info_HTTPD &info, HTTPD_Connection &connection) {
Request_info request_info;
RequestInfoController ric(&request_info, &info);
try {
if(!connection.read_header())
return; // ignore "void" connections
info.populate_env();
request_info.document_root = full_disk_path();
request_info.path_translated = filespec_to_process;
request_info.method = connection.method();
request_info.query_string = connection.query();
request_info.uri = request_info.strip_absolute_uri(connection.uri());
request_info.content_type = connection.content_type();
request_info.content_length = (size_t)connection.content_length();
request_info.cookie = info.get_env("HTTP_COOKIE");
request_info.mail_received = false;
request_info.argv = argv_extra;
// prepare to process request
Request r(info, request_info, String::Language(String::L_HTML|String::L_OPTIMIZE_BIT));
// process the request
r.core(config_filespec, strcasecmp(request_info.method, "HEAD")==0, main_method_name, &httpd_class_name);
} catch(const Exception& e) { // exception in connection handling
SAPI::log(info, "%s", e.comment());
const char* status = info.exception_http_status(e.type());
if(*status)
SAPI::send_error(info, e.comment(), status);
}
}
#ifdef _MSC_VER
DWORD WINAPI connection_thread(void *arg){
#else
static void *connection_thread(void *arg){
#endif
HTTPD_Connection &connection=*(HTTPD_Connection*)arg;
SAPI_Info_HTTPD info(connection);
try {
connection_handler(info, connection);
} catch(const Exception& e) { // exception in send_error
pa_log("%s", e.comment());
}
delete(&connection);
return 0;
}
static void httpd_mode() {
config_handler(*sapi_info);
SOCKET sock = HTTPD_Server::bind(httpd_host_port);
#ifdef SIGPIPE
signal(SIGPIPE, SIG_IGN);
#endif
while(1){
#ifndef _MSC_VER
pid_t pid=1;
if(HTTPD_Server::mode == HTTPD_Server::PARALLEL)
while (waitpid((pid_t)(-1), 0, WNOHANG) > 0);
#endif
try {
HTTPD_Connection connection;
if(!connection.accept(sock, 500))
continue;
switch (HTTPD_Server::mode) {
case HTTPD_Server::MULTITHREADED:
#ifdef _MSC_VER
if (!GC_CreateThread(0, 0, connection_thread, new HTTPD_Connection(connection), 0, 0))
throw Exception("httpd.fork", 0, "thread creation failed");
connection.sock=INVALID_SOCKET;
break;
#else
#ifdef HAVE_TLS
pthread_t thread;
pthread_attr_t attr;
pthread_attr_init(&attr);
pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
if(int result=GC_pthread_create(&thread, &attr, connection_thread, new HTTPD_Connection(connection)))
throw Exception("httpd.fork", 0, "thread creation failed (%d)", result);
connection.sock=INVALID_SOCKET;
break;
#endif
case HTTPD_Server::PARALLEL:
pid=fork();
if(pid<0)
throw Exception("httpd.fork", 0, "fork failed: %s (%d)", strerror(errno), errno);
if(pid>0)
continue; // parent should close connection.sock as well
#endif
case HTTPD_Server::SEQUENTIAL: // and fork child
SAPI_Info_HTTPD info(connection);
connection_handler(info, connection);
}
// closing connection socket in HTTPD_Connection destructor
} catch(const Exception& e) { // exception in accept or send_error
pa_log("%s", e.comment());
}
#ifndef _MSC_VER
if(pid==0) // fork child
exit(0);
#endif
}
}
/** main workhorse */
static void real_parser_handler(bool cgi) {
// init libraries
pa_globals_init();
if(httpd_host_port){
httpd_mode();
}
const char* request_method=getenv("REQUEST_METHOD");
if(!filespec_to_process){
SAPI::send_error(*sapi_info, "Parser/" PARSER_VERSION);
exit(1);
}
// global request info
Request_info request_info;
RequestInfoController ric(&request_info, sapi_info);
request_info.path_translated = filespec_to_process;
request_info.method = request_method ? request_method : "GET";
request_info.query_string = MAYBE_RECONSTRUCT_IIS_STATUS_IN_QS(getenv("QUERY_STRING"));
if(cgi) {
// obligatory
const char* path_info=getenv("PATH_INFO");
if(!path_info)
SAPI::die("parser3: illegal CGI call (missing PATH_INFO)");
request_info.document_root = getenv("DOCUMENT_ROOT");
if(!request_info.document_root) {
// IIS or fcgiwrap minimalistic setup
ssize_t prefix_len = strlen(filespec_to_process) - strlen(path_info);
if(prefix_len < 0 || strcmp(filespec_to_process + prefix_len, path_info) != 0)
SAPI::die("parser3: illegal CGI call (invalid PATH_INFO in reinventing DOCUMENT_ROOT)");
char* document_root = new(PointerFreeGC) char[prefix_len + 1/*0*/];
memcpy(document_root, filespec_to_process, prefix_len); document_root[prefix_len] = 0;
request_info.document_root = document_root;
}
request_info.uri = request_info.strip_absolute_uri(getenv("REQUEST_URI"));
if(request_info.uri) { // apache & others stuck to standards
// another obligatory
const char* script_name = getenv("SCRIPT_NAME");
if(!script_name)
SAPI::die("parser3: illegal CGI call (missing SCRIPT_NAME)");
/*
http://parser3/env.html?123 =OK
$request:uri=/env.html?123
REQUEST_URI='/env.html?123'
SCRIPT_NAME='/cgi-bin/parser3'
PATH_INFO='/env.html'
http://parser3/cgi-bin/parser3/env.html?123 =ERROR
$request:uri=/cgi-bin/parser3/env.html?123
REQUEST_URI='/cgi-bin/parser3/env.html?123'
SCRIPT_NAME='/cgi-bin/parser3'
PATH_INFO='/env.html'
*/
size_t script_name_len = strlen(script_name);
size_t uri_len = strlen(request_info.uri);
if(strncmp(request_info.uri, script_name, script_name_len)==0 && script_name_len != uri_len) // under IIS they are the same
SAPI::die("parser3: illegal CGI call (REQUEST_URI starts with SCRIPT_NAME)");
} else { // fcgiwrap minimalistic setup
request_info.uri = request_info.query_string && *request_info.query_string ? pa_strcat(path_info, "?", request_info.query_string) : path_info;
}
} else{
request_info.document_root = full_disk_path();
request_info.uri = "";
}
request_info.content_type = getenv("CONTENT_TYPE");
request_info.content_length = cgi ? (size_t)pa_atoul(getenv("CONTENT_LENGTH")) : 0; // only SAPI_Info_CGI can read POST
request_info.cookie = getenv("HTTP_COOKIE");
request_info.mail_received = mail_received;
request_info.argv = argv_extra;
#ifdef PA_DEBUG_CGI_ENTRY_EXIT
pa_log("request_info: method=%s, uri=%s, q=%s, dr=%s, pt=%s", request_info.method, request_info.uri, request_info.query_string, request_info.document_root, request_info.path_translated);
#endif
// prepare to process request
Request r(*sapi_info, request_info, cgi ? String::Language(String::L_HTML|String::L_OPTIMIZE_BIT) : String::L_AS_IS);
{
// initing ::request ptr for signal handlers
RequestController rc(&r);
// process the request
r.core(locate_config(config_filespec, parser3_filespec), strcasecmp(request_info.method, "HEAD")==0);
// clearing ::request in RequestController destructor to prevent signal handlers from accessing invalid memory
}
// finalize libraries
pa_globals_done();
}
#ifdef PA_SUPPRESS_SYSTEM_EXCEPTION
static const Exception call_real_parser_handler__do_PEH_return_it(bool cgi) {
try {
real_parser_handler(cgi);
} catch(const Exception& e) {
return e;
}
return Exception();
}
static void call_real_parser_handler__supress_system_exception(bool cgi) {
Exception parser_exception;
LPEXCEPTION_POINTERS system_exception=0;
__try {
parser_exception=call_real_parser_handler__do_PEH_return_it(cgi);
} __except ( (system_exception=GetExceptionInformation()), EXCEPTION_EXECUTE_HANDLER) {
if(system_exception)
if(_EXCEPTION_RECORD *er=system_exception->ExceptionRecord)
throw Exception("system", 0, "0x%08X at 0x%08X", er->ExceptionCode, er->ExceptionAddress);
else
throw Exception("system", 0, "<no exception record>");
else
throw Exception("system", 0, "<no exception information>");
}
if(parser_exception)
throw Exception(parser_exception);
}
#define REAL_PARSER_HANDLER call_real_parser_handler__supress_system_exception
#else
#define REAL_PARSER_HANDLER real_parser_handler
#endif
static void usage(const char* message=NULL) {
if(message){
fprintf(stderr, message, parser3_filespec);
}
printf(
"Parser/%s\n"
"Copyright (c) 2001-2026 Art. Lebedev Studio (https://www.artlebedev.com)\n"
"Authors: Konstantin Morshnev <moko@design.ru>, Alexandr Petrosian <paf@design.ru>\n"
"\n"
"Usage: %s [options] [file]\n"
"Options are:\n"
#ifdef WITH_MAILRECEIVE
" -m Parse mail, put received letter to $mail:received\n"
#endif
" -f config_file Use this config file (/path/to/auto.p)\n"
" -l log_file Use this log file (/path/to/parser3.log)\n"
" -p [host:]port Start web server on this port\n"
" -h Display usage information (this message)\n",
PARSER_VERSION,
parser3_filespec ? parser3_filespec : "parser3" );
exit(EINVAL);
}
#define ARG_REQUIRED \
if(c[1] || !*(++carg)){ \
fprintf(stderr, "%s: option '%c' requires an argument\n", parser3_filespec, *c); \
usage(); \
}
int main(int argc, char *argv[]) {
#ifdef PA_DEBUG_CGI_ENTRY_EXIT
pa_log("main: entry");
#endif
if(!argc || !argv[0])
usage();
parser3_filespec = MAYBE_BACK_SLASHES_TO_SLASHES(argv[0]);
umask(2);
// were we started as CGI?
bool cgi=(getenv("SERVER_SOFTWARE") || getenv("SERVER_NAME") || getenv("GATEWAY_INTERFACE") || getenv("REQUEST_METHOD")) && !getenv("PARSER_VERSION");
if(!cgi){
sapi_info = &sapi_console;
parser3_mode = "console";
}
#ifdef SIGPIPE
signal(SIGPIPE, SIGPIPE_handler);
#endif
char* raw_filespec_to_process = NULL;
if(cgi) {
raw_filespec_to_process=getenv("PATH_TRANSLATED");
argv_extra=argv + 1;
} else {
char** carg = argv + 1;
for(;*carg; carg++){
if((*carg)[0] != '-')
break;
for(char* c=(*carg)+1; *c; c++){
switch (*c) {
case 'h':
usage();
break;
case 'f':
ARG_REQUIRED;
config_filespec=*carg;
break;
case 'l':
ARG_REQUIRED;
log_filespec=*carg;
break;
case 'p':
ARG_REQUIRED;
httpd_host_port=*carg;
parser3_mode="httpd";
break;
#ifdef WITH_MAILRECEIVE
case 'm':
mail_received=true;
parser3_mode="mail";
break;
#endif
default:
fprintf(stderr, "%s: invalid option '%c'\n", parser3_filespec, *c);
usage();
break;
}
}
}
if (*carg) {
raw_filespec_to_process=*carg;
} else {
if(!httpd_host_port)
usage("%s: file not specified\n");
}
if (httpd_host_port && mail_received)
usage("%s: -p and -m options should not be used together\n");
argv_extra=carg;
}
#ifdef _MSC_VER
setmode(fileno(stdin), _O_BINARY);
setmode(fileno(stdout), _O_BINARY);
setmode(fileno(stderr), _O_BINARY);
#endif
#if defined(_MSC_VER) && defined(_DEBUG)
// Get current flag
int tmpFlag = _CrtSetDbgFlag( _CRTDBG_REPORT_FLAG );
// Turn on leak-checking bit
tmpFlag |= _CRTDBG_LEAK_CHECK_DF;
// Set flag to the new value
_CrtSetDbgFlag( tmpFlag );
_CrtSetReportMode( _CRT_WARN, _CRTDBG_MODE_FILE );
_CrtSetReportFile( _CRT_WARN, _CRTDBG_FILE_STDERR );
#endif
try { // global try
if(raw_filespec_to_process && *raw_filespec_to_process){
filespec_to_process=full_disk_path(raw_filespec_to_process);
}
REAL_PARSER_HANDLER(cgi);
} catch(const Exception& e) { // exception in config_handler
SAPI::log(*sapi_info, "%s", e.comment());
SAPI::send_error(*sapi_info, e.comment(), strcmp(e.type(), "file.missing") ? "500" : "404");
}
#ifdef PA_DEBUG_CGI_ENTRY_EXIT
pa_log("main: successful return");
#endif
return sapi_info->http_response_code < 100 ? sapi_info->http_response_code : 0;
}
E-mail: