1
/* Licensed to the Apache Software Foundation (ASF) under one or more
2
* contributor license agreements. See the NOTICE file distributed with
3
* this work for additional information regarding copyright ownership.
4
* The ASF licenses this file to You under the Apache License, Version 2.0
5
* (the "License"); you may not use this file except in compliance with
6
* the License. You may obtain a copy of the License at
8
* http://www.apache.org/licenses/LICENSE-2.0
10
* Unless required by applicable law or agreed to in writing, software
11
* distributed under the License is distributed on an "AS IS" BASIS,
12
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
* See the License for the specific language governing permissions and
14
* limitations under the License.
18
* http_script: keeps all script-related ramblings together.
20
* Compliant to CGI/1.1 spec
22
* Adapted by rst from original NCSA code by Rob McCool
24
* Apache adds some new env vars; REDIRECT_URL and REDIRECT_QUERY_STRING for
25
* custom error responses, and DOCUMENT_ROOT because we found it useful.
26
* It also adds SERVER_ADMIN - useful for scripts to know who to mail when
31
#include "apr_strings.h"
32
#include "apr_thread_proc.h" /* for RLIMIT stuff */
33
#include "apr_optional.h"
34
#include "apr_buckets.h"
38
#define APR_WANT_STRFUNC
39
#define APR_WANT_MEMFUNC
44
#include "util_filter.h"
45
#include "ap_config.h"
47
#include "http_config.h"
48
#include "http_request.h"
49
#include "http_core.h"
50
#include "http_protocol.h"
51
#include "http_main.h"
53
#include "util_script.h"
58
module AP_MODULE_DECLARE_DATA cgi_module;
60
static APR_OPTIONAL_FN_TYPE(ap_register_include_handler) *cgi_pfn_reg_with_ssi;
61
static APR_OPTIONAL_FN_TYPE(ap_ssi_get_tag_and_value) *cgi_pfn_gtv;
62
static APR_OPTIONAL_FN_TYPE(ap_ssi_parse_string) *cgi_pfn_ps;
63
static APR_OPTIONAL_FN_TYPE(ap_cgi_build_command) *cgi_build_command;
65
/* Read and discard the data in the brigade produced by a CGI script */
66
static void discard_script_output(apr_bucket_brigade *bb);
68
/* KLUDGE --- for back-combatibility, we don't have to check ExecCGI
69
* in ScriptAliased directories, which means we need to know if this
70
* request came through ScriptAlias or not... so the Alias module
71
* leaves a note for us.
74
static int is_scriptaliased(request_rec *r)
76
const char *t = apr_table_get(r->notes, "alias-forced-type");
77
return t && (!strcasecmp(t, "cgi-script"));
80
/* Configuration stuff */
82
#define DEFAULT_LOGBYTES 10385760
83
#define DEFAULT_BUFBYTES 1024
91
static void *create_cgi_config(apr_pool_t *p, server_rec *s)
94
(cgi_server_conf *) apr_pcalloc(p, sizeof(cgi_server_conf));
97
c->logbytes = DEFAULT_LOGBYTES;
98
c->bufbytes = DEFAULT_BUFBYTES;
103
static void *merge_cgi_config(apr_pool_t *p, void *basev, void *overridesv)
105
cgi_server_conf *base = (cgi_server_conf *) basev,
106
*overrides = (cgi_server_conf *) overridesv;
108
return overrides->logname ? overrides : base;
111
static const char *set_scriptlog(cmd_parms *cmd, void *dummy, const char *arg)
113
server_rec *s = cmd->server;
114
cgi_server_conf *conf = ap_get_module_config(s->module_config,
117
conf->logname = ap_server_root_relative(cmd->pool, arg);
119
if (!conf->logname) {
120
return apr_pstrcat(cmd->pool, "Invalid ScriptLog path ",
127
static const char *set_scriptlog_length(cmd_parms *cmd, void *dummy,
130
server_rec *s = cmd->server;
131
cgi_server_conf *conf = ap_get_module_config(s->module_config,
134
conf->logbytes = atol(arg);
138
static const char *set_scriptlog_buffer(cmd_parms *cmd, void *dummy,
141
server_rec *s = cmd->server;
142
cgi_server_conf *conf = ap_get_module_config(s->module_config,
145
conf->bufbytes = atoi(arg);
149
static const command_rec cgi_cmds[] =
151
AP_INIT_TAKE1("ScriptLog", set_scriptlog, NULL, RSRC_CONF,
152
"the name of a log for script debugging info"),
153
AP_INIT_TAKE1("ScriptLogLength", set_scriptlog_length, NULL, RSRC_CONF,
154
"the maximum length (in bytes) of the script debug log"),
155
AP_INIT_TAKE1("ScriptLogBuffer", set_scriptlog_buffer, NULL, RSRC_CONF,
156
"the maximum size (in bytes) to record of a POST request"),
160
static int log_scripterror(request_rec *r, cgi_server_conf * conf, int ret,
161
apr_status_t rv, char *error)
163
apr_file_t *f = NULL;
165
char time_str[APR_CTIME_LEN];
166
int log_flags = rv ? APLOG_ERR : APLOG_ERR;
168
ap_log_rerror(APLOG_MARK, log_flags, rv, r,
169
"%s: %s", error, r->filename);
171
/* XXX Very expensive mainline case! Open, then getfileinfo! */
172
if (!conf->logname ||
173
((apr_stat(&finfo, conf->logname,
174
APR_FINFO_SIZE, r->pool) == APR_SUCCESS) &&
175
(finfo.size > conf->logbytes)) ||
176
(apr_file_open(&f, conf->logname,
177
APR_APPEND|APR_WRITE|APR_CREATE, APR_OS_DEFAULT,
178
r->pool) != APR_SUCCESS)) {
182
/* "%% [Wed Jun 19 10:53:21 1996] GET /cgi-bin/printenv HTTP/1.0" */
183
apr_ctime(time_str, apr_time_now());
184
apr_file_printf(f, "%%%% [%s] %s %s%s%s %s\n", time_str, r->method, r->uri,
185
r->args ? "?" : "", r->args ? r->args : "", r->protocol);
186
/* "%% 500 /usr/local/apache/cgi-bin */
187
apr_file_printf(f, "%%%% %d %s\n", ret, r->filename);
189
apr_file_printf(f, "%%error\n%s\n", error);
195
/* Soak up stderr from a script and redirect it to the error log.
197
static apr_status_t log_script_err(request_rec *r, apr_file_t *script_err)
199
char argsbuffer[HUGE_STRING_LEN];
203
while ((rv = apr_file_gets(argsbuffer, HUGE_STRING_LEN,
204
script_err)) == APR_SUCCESS) {
205
newline = strchr(argsbuffer, '\n');
209
ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
216
static int log_script(request_rec *r, cgi_server_conf * conf, int ret,
217
char *dbuf, const char *sbuf, apr_bucket_brigade *bb,
218
apr_file_t *script_err)
220
const apr_array_header_t *hdrs_arr = apr_table_elts(r->headers_in);
221
const apr_table_entry_t *hdrs = (const apr_table_entry_t *) hdrs_arr->elts;
222
char argsbuffer[HUGE_STRING_LEN];
223
apr_file_t *f = NULL;
231
char time_str[APR_CTIME_LEN];
233
/* XXX Very expensive mainline case! Open, then getfileinfo! */
234
if (!conf->logname ||
235
((apr_stat(&finfo, conf->logname,
236
APR_FINFO_SIZE, r->pool) == APR_SUCCESS) &&
237
(finfo.size > conf->logbytes)) ||
238
(apr_file_open(&f, conf->logname,
239
APR_APPEND|APR_WRITE|APR_CREATE, APR_OS_DEFAULT,
240
r->pool) != APR_SUCCESS)) {
241
/* Soak up script output */
242
discard_script_output(bb);
243
log_script_err(r, script_err);
247
/* "%% [Wed Jun 19 10:53:21 1996] GET /cgi-bin/printenv HTTP/1.0" */
248
apr_ctime(time_str, apr_time_now());
249
apr_file_printf(f, "%%%% [%s] %s %s%s%s %s\n", time_str, r->method, r->uri,
250
r->args ? "?" : "", r->args ? r->args : "", r->protocol);
251
/* "%% 500 /usr/local/apache/cgi-bin" */
252
apr_file_printf(f, "%%%% %d %s\n", ret, r->filename);
254
apr_file_puts("%request\n", f);
255
for (i = 0; i < hdrs_arr->nelts; ++i) {
258
apr_file_printf(f, "%s: %s\n", hdrs[i].key, hdrs[i].val);
260
if ((r->method_number == M_POST || r->method_number == M_PUT) &&
262
apr_file_printf(f, "\n%s\n", dbuf);
265
apr_file_puts("%response\n", f);
266
hdrs_arr = apr_table_elts(r->err_headers_out);
267
hdrs = (const apr_table_entry_t *) hdrs_arr->elts;
269
for (i = 0; i < hdrs_arr->nelts; ++i) {
272
apr_file_printf(f, "%s: %s\n", hdrs[i].key, hdrs[i].val);
276
apr_file_printf(f, "%s\n", sbuf);
279
for (e = APR_BRIGADE_FIRST(bb);
280
e != APR_BRIGADE_SENTINEL(bb);
281
e = APR_BUCKET_NEXT(e))
283
if (APR_BUCKET_IS_EOS(e)) {
286
rv = apr_bucket_read(e, &buf, &len, APR_BLOCK_READ);
287
if (rv != APR_SUCCESS || (len == 0)) {
291
apr_file_puts("%stdout\n", f);
294
apr_file_write(f, buf, &len);
295
apr_file_puts("\n", f);
298
if (apr_file_gets(argsbuffer, HUGE_STRING_LEN, script_err) == APR_SUCCESS) {
299
apr_file_puts("%stderr\n", f);
300
apr_file_puts(argsbuffer, f);
301
while (apr_file_gets(argsbuffer, HUGE_STRING_LEN,
302
script_err) == APR_SUCCESS) {
303
apr_file_puts(argsbuffer, f);
305
apr_file_puts("\n", f);
308
apr_brigade_destroy(bb);
309
apr_file_close(script_err);
316
/* This is the special environment used for running the "exec cmd="
317
* variety of SSI directives.
319
static void add_ssi_vars(request_rec *r)
321
apr_table_t *e = r->subprocess_env;
323
if (r->path_info && r->path_info[0] != '\0') {
326
apr_table_setn(e, "PATH_INFO", ap_escape_shell_cmd(r->pool,
329
pa_req = ap_sub_req_lookup_uri(ap_escape_uri(r->pool, r->path_info),
331
if (pa_req->filename) {
332
apr_table_setn(e, "PATH_TRANSLATED",
333
apr_pstrcat(r->pool, pa_req->filename,
334
pa_req->path_info, NULL));
336
ap_destroy_sub_req(pa_req);
340
char *arg_copy = apr_pstrdup(r->pool, r->args);
342
apr_table_setn(e, "QUERY_STRING", r->args);
343
ap_unescape_url(arg_copy);
344
apr_table_setn(e, "QUERY_STRING_UNESCAPED",
345
ap_escape_shell_cmd(r->pool, arg_copy));
349
static void cgi_child_errfn(apr_pool_t *pool, apr_status_t err,
350
const char *description)
352
apr_file_t *stderr_log;
355
apr_file_open_stderr(&stderr_log, pool);
356
/* Escape the logged string because it may be something that
357
* came in over the network.
359
apr_file_printf(stderr_log,
362
apr_strerror(err, errbuf, sizeof(errbuf)),
363
#ifndef AP_UNSAFE_ERROR_LOG_UNESCAPED
364
ap_escape_logitem(pool,
367
#ifndef AP_UNSAFE_ERROR_LOG_UNESCAPED
373
static apr_status_t run_cgi_child(apr_file_t **script_out,
374
apr_file_t **script_in,
375
apr_file_t **script_err,
377
const char * const argv[],
380
cgi_exec_info_t *e_info)
382
const char * const *env;
383
apr_procattr_t *procattr;
385
apr_status_t rc = APR_SUCCESS;
387
#if defined(RLIMIT_CPU) || defined(RLIMIT_NPROC) || \
388
defined(RLIMIT_DATA) || defined(RLIMIT_VMEM) || defined (RLIMIT_AS)
390
core_dir_config *conf = ap_get_module_config(r->per_dir_config,
396
/* Under OS/2 need to use device con. */
397
FILE *dbg = fopen("con", "w");
399
FILE *dbg = fopen("/dev/tty", "w");
404
RAISE_SIGSTOP(CGI_CHILD);
406
fprintf(dbg, "Attempting to exec %s as CGI child (argv0 = %s)\n",
407
r->filename, argv[0]);
410
env = (const char * const *)ap_create_environment(p, r->subprocess_env);
413
fprintf(dbg, "Environment: \n");
414
for (i = 0; env[i]; ++i)
415
fprintf(dbg, "'%s'\n", env[i]);
418
/* Transmute ourselves into the script.
419
* NB only ISINDEX scripts get decoded arguments.
421
if (((rc = apr_procattr_create(&procattr, p)) != APR_SUCCESS) ||
422
((rc = apr_procattr_io_set(procattr,
425
e_info->err_pipe)) != APR_SUCCESS) ||
426
((rc = apr_procattr_dir_set(procattr,
427
ap_make_dirstr_parent(r->pool,
428
r->filename))) != APR_SUCCESS) ||
430
((rc = apr_procattr_limit_set(procattr, APR_LIMIT_CPU,
431
conf->limit_cpu)) != APR_SUCCESS) ||
433
#if defined(RLIMIT_DATA) || defined(RLIMIT_VMEM) || defined(RLIMIT_AS)
434
((rc = apr_procattr_limit_set(procattr, APR_LIMIT_MEM,
435
conf->limit_mem)) != APR_SUCCESS) ||
438
((rc = apr_procattr_limit_set(procattr, APR_LIMIT_NPROC,
439
conf->limit_nproc)) != APR_SUCCESS) ||
441
((rc = apr_procattr_cmdtype_set(procattr,
442
e_info->cmd_type)) != APR_SUCCESS) ||
444
((rc = apr_procattr_detach_set(procattr,
445
e_info->detached)) != APR_SUCCESS) ||
446
((rc = apr_procattr_addrspace_set(procattr,
447
e_info->addrspace)) != APR_SUCCESS) ||
448
((rc = apr_procattr_child_errfn_set(procattr, cgi_child_errfn)) != APR_SUCCESS)) {
449
/* Something bad happened, tell the world. */
450
ap_log_rerror(APLOG_MARK, APLOG_ERR, rc, r,
451
"couldn't set child process attributes: %s", r->filename);
454
procnew = apr_pcalloc(p, sizeof(*procnew));
455
rc = ap_os_create_privileged_process(r, procnew, command, argv, env,
458
if (rc != APR_SUCCESS) {
459
/* Bad things happened. Everyone should have cleaned up. */
460
ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_TOCLIENT, rc, r,
461
"couldn't create child process: %d: %s", rc,
462
apr_filepath_name_get(r->filename));
465
apr_pool_note_subprocess(p, procnew, APR_KILL_AFTER_TIMEOUT);
467
*script_in = procnew->out;
470
apr_file_pipe_timeout_set(*script_in, r->server->timeout);
472
if (e_info->prog_type == RUN_AS_CGI) {
473
*script_out = procnew->in;
476
apr_file_pipe_timeout_set(*script_out, r->server->timeout);
478
*script_err = procnew->err;
481
apr_file_pipe_timeout_set(*script_err, r->server->timeout);
492
static apr_status_t default_build_command(const char **cmd, const char ***argv,
493
request_rec *r, apr_pool_t *p,
494
cgi_exec_info_t *e_info)
496
int numwords, x, idx;
498
const char *args = NULL;
500
if (e_info->process_cgi) {
502
/* Do not process r->args if they contain an '=' assignment
504
if (r->args && r->args[0] && !ap_strchr_c(r->args, '=')) {
513
/* count the number of keywords */
514
for (x = 0, numwords = 2; args[x]; x++) {
515
if (args[x] == '+') {
520
/* Everything is - 1 to account for the first parameter
521
* which is the program name.
523
if (numwords > APACHE_ARG_MAX - 1) {
524
numwords = APACHE_ARG_MAX - 1; /* Truncate args to prevent overrun */
526
*argv = apr_palloc(p, (numwords + 2) * sizeof(char *));
528
for (x = 1, idx = 1; x < numwords; x++) {
529
w = ap_getword_nulls(p, &args, '+');
531
(*argv)[idx++] = ap_escape_shell_cmd(p, w);
538
static void discard_script_output(apr_bucket_brigade *bb)
545
for (e = APR_BRIGADE_FIRST(bb);
546
e != APR_BRIGADE_SENTINEL(bb);
547
e = APR_BUCKET_NEXT(e))
549
if (APR_BUCKET_IS_EOS(e)) {
552
rv = apr_bucket_read(e, &buf, &len, APR_BLOCK_READ);
553
if (rv != APR_SUCCESS) {
559
#if APR_FILES_AS_SOCKETS
561
/* A CGI bucket type is needed to catch any output to stderr from the
562
* script; see PR 22030. */
563
static const apr_bucket_type_t bucket_type_cgi;
565
struct cgi_bucket_data {
566
apr_pollset_t *pollset;
570
/* Create a CGI bucket using pipes from script stdout 'out'
571
* and stderr 'err', for request 'r'. */
572
static apr_bucket *cgi_bucket_create(request_rec *r,
573
apr_file_t *out, apr_file_t *err,
574
apr_bucket_alloc_t *list)
576
apr_bucket *b = apr_bucket_alloc(sizeof(*b), list);
579
struct cgi_bucket_data *data = apr_palloc(r->pool, sizeof *data);
582
b->free = apr_bucket_free;
584
b->type = &bucket_type_cgi;
585
b->length = (apr_size_t)(-1);
588
/* Create the pollset */
589
rv = apr_pollset_create(&data->pollset, 2, r->pool, 0);
590
AP_DEBUG_ASSERT(rv == APR_SUCCESS);
592
fd.desc_type = APR_POLL_FILE;
593
fd.reqevents = APR_POLLIN;
595
fd.desc.f = out; /* script's stdout */
596
fd.client_data = (void *)1;
597
rv = apr_pollset_add(data->pollset, &fd);
598
AP_DEBUG_ASSERT(rv == APR_SUCCESS);
600
fd.desc.f = err; /* script's stderr */
601
fd.client_data = (void *)2;
602
rv = apr_pollset_add(data->pollset, &fd);
603
AP_DEBUG_ASSERT(rv == APR_SUCCESS);
610
/* Create a duplicate CGI bucket using given bucket data */
611
static apr_bucket *cgi_bucket_dup(struct cgi_bucket_data *data,
612
apr_bucket_alloc_t *list)
614
apr_bucket *b = apr_bucket_alloc(sizeof(*b), list);
616
b->free = apr_bucket_free;
618
b->type = &bucket_type_cgi;
619
b->length = (apr_size_t)(-1);
625
/* Handle stdout from CGI child. Duplicate of logic from the _read
626
* method of the real APR pipe bucket implementation. */
627
static apr_status_t cgi_read_stdout(apr_bucket *a, apr_file_t *out,
628
const char **str, apr_size_t *len)
634
*len = APR_BUCKET_BUFF_SIZE;
635
buf = apr_bucket_alloc(*len, a->list); /* XXX: check for failure? */
637
rv = apr_file_read(out, buf, len);
639
if (rv != APR_SUCCESS && rv != APR_EOF) {
640
apr_bucket_free(buf);
645
struct cgi_bucket_data *data = a->data;
648
/* Change the current bucket to refer to what we read */
649
a = apr_bucket_heap_make(a, buf, *len, apr_bucket_free);
651
h->alloc_len = APR_BUCKET_BUFF_SIZE; /* note the real buffer size */
653
APR_BUCKET_INSERT_AFTER(a, cgi_bucket_dup(data, a->list));
656
apr_bucket_free(buf);
657
a = apr_bucket_immortal_make(a, "", 0);
663
/* Read method of CGI bucket: polls on stderr and stdout of the child,
664
* sending any stderr output immediately away to the error log. */
665
static apr_status_t cgi_bucket_read(apr_bucket *b, const char **str,
666
apr_size_t *len, apr_read_type_e block)
668
struct cgi_bucket_data *data = b->data;
669
apr_interval_time_t timeout;
673
timeout = block == APR_NONBLOCK_READ ? 0 : data->r->server->timeout;
676
const apr_pollfd_t *results;
679
rv = apr_pollset_poll(data->pollset, timeout, &num, &results);
680
if (APR_STATUS_IS_TIMEUP(rv)) {
682
ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, data->r,
683
"Timeout waiting for output from CGI script %s",
691
else if (APR_STATUS_IS_EINTR(rv)) {
694
else if (rv != APR_SUCCESS) {
695
ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, data->r,
696
"poll failed waiting for CGI child");
700
for (; num; num--, results++) {
701
if (results[0].client_data == (void *)1) {
703
rv = cgi_read_stdout(b, results[0].desc.f, str, len);
704
if (APR_STATUS_IS_EOF(rv)) {
710
apr_status_t rv2 = log_script_err(data->r, results[0].desc.f);
711
if (APR_STATUS_IS_EOF(rv2)) {
712
apr_pollset_remove(data->pollset, &results[0]);
722
static const apr_bucket_type_t bucket_type_cgi = {
723
"CGI", 5, APR_BUCKET_DATA,
724
apr_bucket_destroy_noop,
726
apr_bucket_setaside_notimpl,
727
apr_bucket_split_notimpl,
728
apr_bucket_copy_notimpl
733
static int cgi_handler(request_rec *r)
736
apr_size_t dbpos = 0;
741
apr_file_t *script_out = NULL, *script_in = NULL, *script_err = NULL;
742
apr_bucket_brigade *bb;
745
int seen_eos, child_stopped_reading;
747
cgi_server_conf *conf;
749
cgi_exec_info_t e_info;
750
conn_rec *c = r->connection;
752
if(strcmp(r->handler, CGI_MAGIC_TYPE) && strcmp(r->handler, "cgi-script"))
755
is_included = !strcmp(r->protocol, "INCLUDED");
757
p = r->main ? r->main->pool : r->pool;
759
argv0 = apr_filepath_name_get(r->filename);
760
nph = !(strncmp(argv0, "nph-", 4));
761
conf = ap_get_module_config(r->server->module_config, &cgi_module);
763
if (!(ap_allow_options(r) & OPT_EXECCGI) && !is_scriptaliased(r))
764
return log_scripterror(r, conf, HTTP_FORBIDDEN, 0,
765
"Options ExecCGI is off in this directory");
766
if (nph && is_included)
767
return log_scripterror(r, conf, HTTP_FORBIDDEN, 0,
768
"attempt to include NPH CGI script");
770
if (r->finfo.filetype == 0)
771
return log_scripterror(r, conf, HTTP_NOT_FOUND, 0,
772
"script not found or unable to stat");
773
if (r->finfo.filetype == APR_DIR)
774
return log_scripterror(r, conf, HTTP_FORBIDDEN, 0,
775
"attempt to invoke directory as script");
777
if ((r->used_path_info == AP_REQ_REJECT_PATH_INFO) &&
778
r->path_info && *r->path_info)
780
/* default to accept */
781
return log_scripterror(r, conf, HTTP_NOT_FOUND, 0,
782
"AcceptPathInfo off disallows user's path");
785
if (!ap_suexec_enabled) {
786
if (!ap_can_exec(&r->finfo))
787
return log_scripterror(r, conf, HTTP_FORBIDDEN, 0,
788
"file permissions deny server execution");
792
ap_add_common_vars(r);
795
e_info.process_cgi = 1;
796
e_info.cmd_type = APR_PROGRAM;
798
e_info.in_pipe = APR_CHILD_BLOCK;
799
e_info.out_pipe = APR_CHILD_BLOCK;
800
e_info.err_pipe = APR_CHILD_BLOCK;
801
e_info.prog_type = RUN_AS_CGI;
805
e_info.addrspace = 0;
807
/* build the command line */
808
if ((rv = cgi_build_command(&command, &argv, r, p, &e_info)) != APR_SUCCESS) {
809
ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,
810
"don't know how to spawn child process: %s",
812
return HTTP_INTERNAL_SERVER_ERROR;
815
/* run the script in its own process */
816
if ((rv = run_cgi_child(&script_out, &script_in, &script_err,
817
command, argv, r, p, &e_info)) != APR_SUCCESS) {
818
ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,
819
"couldn't spawn child process: %s", r->filename);
820
return HTTP_INTERNAL_SERVER_ERROR;
823
/* Transfer any put/post args, CERN style...
824
* Note that we already ignore SIGPIPE in the core server.
826
bb = apr_brigade_create(r->pool, c->bucket_alloc);
828
child_stopped_reading = 0;
830
dbuf = apr_palloc(r->pool, conf->bufbytes + 1);
836
rv = ap_get_brigade(r->input_filters, bb, AP_MODE_READBYTES,
837
APR_BLOCK_READ, HUGE_STRING_LEN);
839
if (rv != APR_SUCCESS) {
843
for (bucket = APR_BRIGADE_FIRST(bb);
844
bucket != APR_BRIGADE_SENTINEL(bb);
845
bucket = APR_BUCKET_NEXT(bucket))
850
if (APR_BUCKET_IS_EOS(bucket)) {
855
/* We can't do much with this. */
856
if (APR_BUCKET_IS_FLUSH(bucket)) {
860
/* If the child stopped, we still must read to EOS. */
861
if (child_stopped_reading) {
866
apr_bucket_read(bucket, &data, &len, APR_BLOCK_READ);
868
if (conf->logname && dbpos < conf->bufbytes) {
871
if ((dbpos + len) > conf->bufbytes) {
872
cursize = conf->bufbytes - dbpos;
877
memcpy(dbuf + dbpos, data, cursize);
881
/* Keep writing data to the child until done or too much time
882
* elapses with no progress or an error occurs.
884
rv = apr_file_write_full(script_out, data, len, NULL);
886
if (rv != APR_SUCCESS) {
887
/* silly script stopped reading, soak up remaining message */
888
child_stopped_reading = 1;
891
apr_brigade_cleanup(bb);
898
/* Is this flush really needed? */
899
apr_file_flush(script_out);
900
apr_file_close(script_out);
902
AP_DEBUG_ASSERT(script_in != NULL);
904
apr_brigade_cleanup(bb);
906
#if APR_FILES_AS_SOCKETS
907
apr_file_pipe_timeout_set(script_in, 0);
908
apr_file_pipe_timeout_set(script_err, 0);
910
b = cgi_bucket_create(r, script_in, script_err, c->bucket_alloc);
912
b = apr_bucket_pipe_create(script_in, c->bucket_alloc);
914
APR_BRIGADE_INSERT_TAIL(bb, b);
915
b = apr_bucket_eos_create(c->bucket_alloc);
916
APR_BRIGADE_INSERT_TAIL(bb, b);
918
/* Handle script return... */
920
const char *location;
921
char sbuf[MAX_STRING_LEN];
924
if ((ret = ap_scan_script_header_err_brigade(r, bb, sbuf))) {
925
ret = log_script(r, conf, ret, dbuf, sbuf, bb, script_err);
927
/* Set our status. */
930
/* Pass EOS bucket down the filter chain. */
931
apr_brigade_cleanup(bb);
932
b = apr_bucket_eos_create(c->bucket_alloc);
933
APR_BRIGADE_INSERT_TAIL(bb, b);
934
ap_pass_brigade(r->output_filters, bb);
939
location = apr_table_get(r->headers_out, "Location");
941
if (location && r->status == 200) {
942
/* For a redirect whether internal or not, discard any
943
* remaining stdout from the script, and log any remaining
944
* stderr output, as normal. */
945
discard_script_output(bb);
946
apr_brigade_destroy(bb);
947
apr_file_pipe_timeout_set(script_err, r->server->timeout);
948
log_script_err(r, script_err);
951
if (location && location[0] == '/' && r->status == 200) {
952
/* This redirect needs to be a GET no matter what the original
955
r->method = apr_pstrdup(r->pool, "GET");
956
r->method_number = M_GET;
958
/* We already read the message body (if any), so don't allow
959
* the redirected request to think it has one. We can ignore
960
* Transfer-Encoding, since we used REQUEST_CHUNKED_ERROR.
962
apr_table_unset(r->headers_in, "Content-Length");
964
ap_internal_redirect_handler(location, r);
967
else if (location && r->status == 200) {
968
/* XX Note that if a script wants to produce its own Redirect
969
* body, it now has to explicitly *say* "Status: 302"
971
return HTTP_MOVED_TEMPORARILY;
974
rv = ap_pass_brigade(r->output_filters, bb);
977
struct ap_filter_t *cur;
979
/* get rid of all filters up through protocol... since we
980
* haven't parsed off the headers, there is no way they can
984
cur = r->proto_output_filters;
985
while (cur && cur->frec->ftype < AP_FTYPE_CONNECTION) {
988
r->output_filters = r->proto_output_filters = cur;
990
rv = ap_pass_brigade(r->output_filters, bb);
993
/* don't soak up script output if errors occurred writing it
994
* out... otherwise, we prolong the life of the script when the
995
* connection drops or we stopped sending output for some other
997
if (rv == APR_SUCCESS && !r->connection->aborted) {
998
apr_file_pipe_timeout_set(script_err, r->server->timeout);
999
log_script_err(r, script_err);
1002
apr_file_close(script_err);
1004
return OK; /* NOT r->status, even if it has changed. */
1007
/*============================================================================
1008
*============================================================================
1009
* This is the beginning of the cgi filter code moved from mod_include. This
1010
* is the code required to handle the "exec" SSI directive.
1011
*============================================================================
1012
*============================================================================*/
1013
static apr_status_t include_cgi(include_ctx_t *ctx, ap_filter_t *f,
1014
apr_bucket_brigade *bb, char *s)
1016
request_rec *r = f->r;
1017
request_rec *rr = ap_sub_req_lookup_uri(s, r, f->next);
1020
if (rr->status != HTTP_OK) {
1021
ap_destroy_sub_req(rr);
1022
return APR_EGENERAL;
1025
/* No hardwired path info or query allowed */
1026
if ((rr->path_info && rr->path_info[0]) || rr->args) {
1027
ap_destroy_sub_req(rr);
1028
return APR_EGENERAL;
1030
if (rr->finfo.filetype != APR_REG) {
1031
ap_destroy_sub_req(rr);
1032
return APR_EGENERAL;
1035
/* Script gets parameters of the *document*, for back compatibility */
1036
rr->path_info = r->path_info; /* hard to get right; see mod_cgi.c */
1039
/* Force sub_req to be treated as a CGI request, even if ordinary
1040
* typing rules would have called it something else.
1042
ap_set_content_type(rr, CGI_MAGIC_TYPE);
1045
rr_status = ap_run_sub_req(rr);
1046
if (ap_is_HTTP_REDIRECT(rr_status)) {
1047
const char *location = apr_table_get(rr->headers_out, "Location");
1052
location = ap_escape_html(rr->pool, location);
1053
buffer = apr_pstrcat(ctx->pool, "<a href=\"", location, "\">",
1054
location, "</a>", NULL);
1056
APR_BRIGADE_INSERT_TAIL(bb, apr_bucket_pool_create(buffer,
1057
strlen(buffer), ctx->pool,
1058
f->c->bucket_alloc));
1062
ap_destroy_sub_req(rr);
1067
static apr_status_t include_cmd(include_ctx_t *ctx, ap_filter_t *f,
1068
apr_bucket_brigade *bb, const char *command)
1070
cgi_exec_info_t e_info;
1072
apr_file_t *script_out = NULL, *script_in = NULL, *script_err = NULL;
1074
request_rec *r = f->r;
1078
e_info.process_cgi = 0;
1079
e_info.cmd_type = APR_SHELLCMD;
1080
e_info.detached = 0;
1081
e_info.in_pipe = APR_NO_PIPE;
1082
e_info.out_pipe = APR_FULL_BLOCK;
1083
e_info.err_pipe = APR_NO_PIPE;
1084
e_info.prog_type = RUN_AS_SSI;
1087
e_info.next = f->next;
1088
e_info.addrspace = 0;
1090
if ((rv = cgi_build_command(&command, &argv, r, r->pool,
1091
&e_info)) != APR_SUCCESS) {
1092
ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,
1093
"don't know how to spawn cmd child process: %s",
1098
/* run the script in its own process */
1099
if ((rv = run_cgi_child(&script_out, &script_in, &script_err,
1100
command, argv, r, r->pool,
1101
&e_info)) != APR_SUCCESS) {
1102
ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,
1103
"couldn't spawn child process: %s", r->filename);
1107
APR_BRIGADE_INSERT_TAIL(bb, apr_bucket_pipe_create(script_in,
1108
f->c->bucket_alloc));
1111
/* We can't close the pipe here, because we may return before the
1112
* full CGI has been sent to the network. That's okay though,
1113
* because we can rely on the pool to close the pipe for us.
1118
static apr_status_t handle_exec(include_ctx_t *ctx, ap_filter_t *f,
1119
apr_bucket_brigade *bb)
1122
char *tag_val = NULL;
1123
request_rec *r = f->r;
1124
char *file = r->filename;
1125
char parsed_string[MAX_STRING_LEN];
1128
ap_log_rerror(APLOG_MARK,
1129
(ctx->flags & SSI_FLAG_PRINTING)
1130
? APLOG_ERR : APLOG_WARNING,
1131
0, r, "missing argument for exec element in %s",
1135
if (!(ctx->flags & SSI_FLAG_PRINTING)) {
1140
SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
1144
if (ctx->flags & SSI_FLAG_NO_EXEC) {
1145
ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "exec used but not allowed "
1146
"in %s", r->filename);
1147
SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
1152
cgi_pfn_gtv(ctx, &tag, &tag_val, SSI_VALUE_DECODED);
1153
if (!tag || !tag_val) {
1157
if (!strcmp(tag, "cmd")) {
1160
cgi_pfn_ps(ctx, tag_val, parsed_string, sizeof(parsed_string),
1161
SSI_EXPAND_LEAVE_NAME);
1163
rv = include_cmd(ctx, f, bb, parsed_string);
1164
if (rv != APR_SUCCESS) {
1165
ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "execution failure "
1166
"for parameter \"%s\" to tag exec in file %s",
1168
SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
1172
else if (!strcmp(tag, "cgi")) {
1175
cgi_pfn_ps(ctx, tag_val, parsed_string, sizeof(parsed_string),
1176
SSI_EXPAND_DROP_NAME);
1178
rv = include_cgi(ctx, f, bb, parsed_string);
1179
if (rv != APR_SUCCESS) {
1180
ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "invalid CGI ref "
1181
"\"%s\" in %s", tag_val, file);
1182
SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
1187
ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "unknown parameter "
1188
"\"%s\" to tag exec in %s", tag, file);
1189
SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
1198
/*============================================================================
1199
*============================================================================
1200
* This is the end of the cgi filter code moved from mod_include.
1201
*============================================================================
1202
*============================================================================*/
1205
static int cgi_post_config(apr_pool_t *p, apr_pool_t *plog,
1206
apr_pool_t *ptemp, server_rec *s)
1208
cgi_pfn_reg_with_ssi = APR_RETRIEVE_OPTIONAL_FN(ap_register_include_handler);
1209
cgi_pfn_gtv = APR_RETRIEVE_OPTIONAL_FN(ap_ssi_get_tag_and_value);
1210
cgi_pfn_ps = APR_RETRIEVE_OPTIONAL_FN(ap_ssi_parse_string);
1212
if ((cgi_pfn_reg_with_ssi) && (cgi_pfn_gtv) && (cgi_pfn_ps)) {
1213
/* Required by mod_include filter. This is how mod_cgi registers
1214
* with mod_include to provide processing of the exec directive.
1216
cgi_pfn_reg_with_ssi("exec", handle_exec);
1219
/* This is the means by which unusual (non-unix) os's may find alternate
1220
* means to run a given command (e.g. shebang/registry parsing on Win32)
1222
cgi_build_command = APR_RETRIEVE_OPTIONAL_FN(ap_cgi_build_command);
1223
if (!cgi_build_command) {
1224
cgi_build_command = default_build_command;
1229
static void register_hooks(apr_pool_t *p)
1231
static const char * const aszPre[] = { "mod_include.c", NULL };
1232
ap_hook_handler(cgi_handler, NULL, NULL, APR_HOOK_MIDDLE);
1233
ap_hook_post_config(cgi_post_config, aszPre, NULL, APR_HOOK_REALLY_FIRST);
1236
module AP_MODULE_DECLARE_DATA cgi_module =
1238
STANDARD20_MODULE_STUFF,
1239
NULL, /* dir config creater */
1240
NULL, /* dir merger --- default is to override */
1241
create_cgi_config, /* server config */
1242
merge_cgi_config, /* merge server config */
1243
cgi_cmds, /* command apr_table_t */
1244
register_hooks /* register hooks */
added
removed
modules/generators/mod_cgi.c
