* modules/generators/mod_cgid.c (sock_readhdr): Only set up control
[apache-httpd.git] / modules / generators / mod_cgid.c
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
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 /*
18  * http_script: keeps all script-related ramblings together.
19  *
20  * Compliant to cgi/1.1 spec
21  *
22  * Adapted by rst from original NCSA code by Rob McCool
23  *
24  * This modules uses a httpd core function (ap_add_common_vars) to add some new env vars, 
25  * like REDIRECT_URL and REDIRECT_QUERY_STRING for custom error responses and DOCUMENT_ROOT.
26  * It also adds SERVER_ADMIN - useful for scripts to know who to mail when they fail.
27  * 
28  */
29
30 #include "apr_lib.h"
31 #include "apr_strings.h"
32 #include "apr_general.h"
33 #include "apr_file_io.h"
34 #include "apr_portable.h"
35 #include "apr_buckets.h"
36 #include "apr_optional.h"
37 #include "apr_signal.h"
38
39 #define APR_WANT_STRFUNC
40 #include "apr_want.h"
41
42 #if APR_HAVE_SYS_SOCKET_H
43 #include <sys/socket.h>
44 #endif
45 #if APR_HAVE_UNISTD_H
46 #include <unistd.h>
47 #endif
48 #if APR_HAVE_SYS_TYPES_H
49 #include <sys/types.h>
50 #endif
51
52 #include "util_filter.h"
53 #include "httpd.h"
54 #include "http_config.h"
55 #include "http_request.h"
56 #include "http_core.h"
57 #include "http_protocol.h"
58 #include "http_main.h"
59 #include "http_log.h"
60 #include "util_script.h"
61 #include "ap_mpm.h"
62 #include "mpm_common.h"
63 #include "mod_suexec.h"
64 #include "../filters/mod_include.h"
65
66 #include "mod_core.h"
67
68
69 /* ### should be tossed in favor of APR */
70 #include <sys/stat.h>
71 #include <sys/un.h> /* for sockaddr_un */
72
73 #if APR_HAVE_STRUCT_RLIMIT
74 #if defined (RLIMIT_CPU) || defined (RLIMIT_NPROC) || defined (RLIMIT_DATA) || defined(RLIMIT_VMEM) || defined(RLIMIT_AS)
75 #define AP_CGID_USE_RLIMIT
76 #endif
77 #endif
78
79 module AP_MODULE_DECLARE_DATA cgid_module;
80
81 static int cgid_start(apr_pool_t *p, server_rec *main_server, apr_proc_t *procnew);
82 static int cgid_init(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *main_server);
83 static int handle_exec(include_ctx_t *ctx, ap_filter_t *f, apr_bucket_brigade *bb);
84
85 static APR_OPTIONAL_FN_TYPE(ap_register_include_handler) *cgid_pfn_reg_with_ssi;
86 static APR_OPTIONAL_FN_TYPE(ap_ssi_get_tag_and_value) *cgid_pfn_gtv;
87 static APR_OPTIONAL_FN_TYPE(ap_ssi_parse_string) *cgid_pfn_ps;
88
89 static apr_pool_t *pcgi = NULL;
90 static pid_t daemon_pid;
91 static int daemon_should_exit = 0;
92 static server_rec *root_server = NULL;
93 static apr_pool_t *root_pool = NULL;
94 static const char *sockname;
95 static struct sockaddr_un *server_addr;
96 static apr_socklen_t server_addr_len;
97 static pid_t parent_pid;
98 static ap_unix_identity_t empty_ugid = { (uid_t)-1, (gid_t)-1, -1 };
99
100 typedef struct { 
101     apr_interval_time_t timeout;
102 } cgid_dirconf;
103
104 /* The APR other-child API doesn't tell us how the daemon exited
105  * (SIGSEGV vs. exit(1)).  The other-child maintenance function
106  * needs to decide whether to restart the daemon after a failure
107  * based on whether or not it exited due to a fatal startup error
108  * or something that happened at steady-state.  This exit status
109  * is unlikely to collide with exit signals.
110  */
111 #define DAEMON_STARTUP_ERROR 254
112
113 /* Read and discard the data in the brigade produced by a CGI script */
114 static void discard_script_output(apr_bucket_brigade *bb);
115
116 /* This doer will only ever be called when we are sure that we have
117  * a valid ugid.
118  */
119 static ap_unix_identity_t *cgid_suexec_id_doer(const request_rec *r)
120 {
121     return (ap_unix_identity_t *)
122                         ap_get_module_config(r->request_config, &cgid_module);
123 }
124
125 /* KLUDGE --- for back-combatibility, we don't have to check ExecCGI
126  * in ScriptAliased directories, which means we need to know if this
127  * request came through ScriptAlias or not... so the Alias module
128  * leaves a note for us.
129  */
130
131 static int is_scriptaliased(request_rec *r)
132 {
133     const char *t = apr_table_get(r->notes, "alias-forced-type");
134     return t && (!strcasecmp(t, "cgi-script"));
135 }
136
137 /* Configuration stuff */
138
139 #define DEFAULT_LOGBYTES 10385760
140 #define DEFAULT_BUFBYTES 1024
141 #define DEFAULT_SOCKET "cgisock"
142
143 #define CGI_REQ    1
144 #define SSI_REQ    2
145 #define GETPID_REQ 3 /* get the pid of script created for prior request */
146
147 #define ERRFN_USERDATA_KEY         "CGIDCHILDERRFN"
148
149 /* DEFAULT_CGID_LISTENBACKLOG controls the max depth on the unix socket's
150  * pending connection queue.  If a bunch of cgi requests arrive at about
151  * the same time, connections from httpd threads/processes will back up
152  * in the queue while the cgid process slowly forks off a child to process
153  * each connection on the unix socket.  If the queue is too short, the
154  * httpd process will get ECONNREFUSED when trying to connect.
155  */
156 #ifndef DEFAULT_CGID_LISTENBACKLOG
157 #define DEFAULT_CGID_LISTENBACKLOG 100
158 #endif
159
160 /* DEFAULT_CONNECT_ATTEMPTS controls how many times we'll try to connect
161  * to the cgi daemon from the thread/process handling the cgi request.
162  * Generally we want to retry when we get ECONNREFUSED since it is
163  * probably because the listen queue is full.  We need to try harder so
164  * the client doesn't see it as a 503 error.
165  *
166  * Set this to 0 to continually retry until the connect works or Apache
167  * terminates.
168  */
169 #ifndef DEFAULT_CONNECT_ATTEMPTS
170 #define DEFAULT_CONNECT_ATTEMPTS  15
171 #endif
172
173 #ifndef DEFAULT_CONNECT_STARTUP_DELAY
174 #define DEFAULT_CONNECT_STARTUP_DELAY 60
175 #endif
176
177 typedef struct {
178     const char *logname;
179     long logbytes;
180     int bufbytes;
181 } cgid_server_conf;
182
183 #ifdef AP_CGID_USE_RLIMIT
184 typedef struct {
185 #ifdef RLIMIT_CPU
186     int    limit_cpu_set;
187     struct rlimit limit_cpu;
188 #endif
189 #if defined (RLIMIT_DATA) || defined (RLIMIT_VMEM) || defined(RLIMIT_AS)
190     int    limit_mem_set;
191     struct rlimit limit_mem;
192 #endif
193 #ifdef RLIMIT_NPROC
194     int    limit_nproc_set;
195     struct rlimit limit_nproc;
196 #endif
197
198 } cgid_rlimit_t;
199 #endif
200
201 typedef struct {
202     int req_type; /* request type (CGI_REQ, SSI_REQ, etc.) */
203     unsigned long conn_id; /* connection id; daemon uses this as a hash value
204                             * to find the script pid when it is time for that
205                             * process to be cleaned up
206                             */
207     pid_t ppid;            /* sanity check for config problems leading to
208                             * wrong cgid socket use
209                             */
210     int env_count;
211     ap_unix_identity_t ugid;
212     apr_size_t filename_len;
213     apr_size_t argv0_len;
214     apr_size_t uri_len;
215     apr_size_t args_len;
216     int loglevel; /* to stuff in server_rec */
217
218 #ifdef AP_CGID_USE_RLIMIT
219     cgid_rlimit_t limits;
220 #endif
221 } cgid_req_t;
222
223 /* This routine is called to create the argument list to be passed
224  * to the CGI script.  When suexec is enabled, the suexec path, user, and
225  * group are the first three arguments to be passed; if not, all three
226  * must be NULL.  The query info is split into separate arguments, where
227  * "+" is the separator between keyword arguments.
228  *
229  * Do not process the args if they containing an '=' assignment.
230  */
231 static char **create_argv(apr_pool_t *p, char *path, char *user, char *group,
232                           char *av0, const char *args)
233 {
234     int x, numwords;
235     char **av;
236     char *w;
237     int idx = 0;
238
239     if (!(*args) || ap_strchr_c(args, '=')) {
240         numwords = 0;
241     }
242     else {
243         /* count the number of keywords */
244
245         for (x = 0, numwords = 1; args[x]; x++) {
246             if (args[x] == '+') {
247                 ++numwords;
248             }
249         }
250     }
251
252     if (numwords > APACHE_ARG_MAX - 5) {
253         numwords = APACHE_ARG_MAX - 5;  /* Truncate args to prevent overrun */
254     }
255     av = (char **) apr_pcalloc(p, (numwords + 5) * sizeof(char *));
256
257     if (path) {
258         av[idx++] = path;
259     }
260     if (user) {
261         av[idx++] = user;
262     }
263     if (group) {
264         av[idx++] = group;
265     }
266
267     av[idx++] = apr_pstrdup(p, av0);
268
269     for (x = 1; x <= numwords; x++) {
270         w = ap_getword_nulls(p, &args, '+');
271         ap_unescape_url(w);
272         av[idx++] = ap_escape_shell_cmd(p, w);
273     }
274     av[idx] = NULL;
275     return av;
276 }
277
278 #if APR_HAS_OTHER_CHILD
279 static void cgid_maint(int reason, void *data, apr_wait_t status)
280 {
281     apr_proc_t *proc = data;
282     int mpm_state;
283     int stopping;
284
285     switch (reason) {
286         case APR_OC_REASON_DEATH:
287             apr_proc_other_child_unregister(data);
288             /* If apache is not terminating or restarting,
289              * restart the cgid daemon
290              */
291             stopping = 1; /* if MPM doesn't support query,
292                            * assume we shouldn't restart daemon
293                            */
294             if (ap_mpm_query(AP_MPMQ_MPM_STATE, &mpm_state) == APR_SUCCESS &&
295                 mpm_state != AP_MPMQ_STOPPING) {
296                 stopping = 0;
297             }
298             if (!stopping) {
299                 if (status == DAEMON_STARTUP_ERROR) {
300                     ap_log_error(APLOG_MARK, APLOG_CRIT, 0, ap_server_conf, APLOGNO(01238)
301                                  "cgid daemon failed to initialize");
302                 }
303                 else {
304                     ap_log_error(APLOG_MARK, APLOG_ERR, 0, ap_server_conf, APLOGNO(01239)
305                                  "cgid daemon process died, restarting");
306                     cgid_start(root_pool, root_server, proc);
307                 }
308             }
309             break;
310         case APR_OC_REASON_RESTART:
311             /* don't do anything; server is stopping or restarting */
312             apr_proc_other_child_unregister(data);
313             break;
314         case APR_OC_REASON_LOST:
315             /* Restart the child cgid daemon process */
316             apr_proc_other_child_unregister(data);
317             cgid_start(root_pool, root_server, proc);
318             break;
319         case APR_OC_REASON_UNREGISTER:
320             /* we get here when pcgi is cleaned up; pcgi gets cleaned
321              * up when pconf gets cleaned up
322              */
323             kill(proc->pid, SIGHUP); /* send signal to daemon telling it to die */
324
325             /* Remove the cgi socket, we must do it here in order to try and
326              * guarantee the same permissions as when the socket was created.
327              */
328             if (unlink(sockname) < 0 && errno != ENOENT) {
329                 ap_log_error(APLOG_MARK, APLOG_ERR, errno, ap_server_conf, APLOGNO(01240)
330                              "Couldn't unlink unix domain socket %s",
331                              sockname);
332             }
333             break;
334     }
335 }
336 #endif
337
338 static apr_status_t close_unix_socket(void *thefd)
339 {
340     int fd = (int)((long)thefd);
341
342     return close(fd);
343 }
344
345 /* Read from the socket dealing with incomplete messages and signals.
346  * Returns 0 on success or errno on failure.  Stderr fd passed as
347  * auxiliary data from other end is written to *errfd, or else stderr
348  * fileno if not present. */
349 static apr_status_t sock_readhdr(int fd, int *errfd, void *vbuf, size_t buf_size)
350 {
351     int rc;
352 #ifndef HAVE_CGID_FDPASSING
353     char *buf = vbuf;
354     size_t bytes_read = 0;
355
356     if (errfd) *errfd = 0;
357     
358     do {
359         do {
360             rc = read(fd, buf + bytes_read, buf_size - bytes_read);
361         } while (rc < 0 && errno == EINTR);
362         switch(rc) {
363         case -1:
364             return errno;
365         case 0: /* unexpected */
366             return ECONNRESET;
367         default:
368             bytes_read += rc;
369         }
370     } while (bytes_read < buf_size);
371
372    
373 #else /* with FD passing */
374     struct msghdr msg = {0};
375     struct iovec vec = {vbuf, buf_size};
376     struct cmsghdr *cmsg;
377     union {  /* union to ensure alignment */
378         struct cmsghdr cm;
379         char buf[CMSG_SPACE(sizeof(int))];
380     } u;
381     
382     msg.msg_iov = &vec;
383     msg.msg_iovlen = 1;
384
385     if (errfd) {
386         msg.msg_control = u.buf;
387         msg.msg_controllen = sizeof(u.buf);
388         *errfd = 0;
389     }
390     
391     /* use MSG_WAITALL to skip loop on truncated reads */
392     do {
393         rc = recvmsg(fd, &msg, MSG_WAITALL);
394     } while (rc < 0 && errno == EINTR);
395
396     if (rc == 0) {
397         return ECONNRESET;
398     }
399     else if (rc < 0) {
400         return errno;
401     }
402     else if (rc != buf_size) {
403         /* MSG_WAITALL should ensure the recvmsg blocks until the
404          * entire length is read, but let's be paranoid. */
405         return APR_INCOMPLETE;
406     }
407
408     if (errfd
409         && (cmsg = CMSG_FIRSTHDR(&msg)) != NULL
410         && cmsg->cmsg_len == CMSG_LEN(sizeof(*errfd))
411         && cmsg->cmsg_level == SOL_SOCKET
412         && cmsg->cmsg_type == SCM_RIGHTS) {
413         *errfd = *((int *) CMSG_DATA(cmsg));
414     }
415 #endif
416     
417     return APR_SUCCESS;
418 }
419
420 /* As sock_readhdr but without auxiliary fd passing. */
421 static apr_status_t sock_read(int fd, void *vbuf, size_t buf_size)
422 {
423     return sock_readhdr(fd, NULL, vbuf, buf_size);
424 }
425
426 /* deal with signals
427  */
428 static apr_status_t sock_write(int fd, const void *buf, size_t buf_size)
429 {
430     int rc;
431
432     do {
433         rc = write(fd, buf, buf_size);
434     } while (rc < 0 && errno == EINTR);
435     if (rc < 0) {
436         return errno;
437     }
438
439     return APR_SUCCESS;
440 }
441
442 static apr_status_t sock_writev(int fd, int auxfd, request_rec *r, int count, ...)
443 {
444     va_list ap;
445     int rc;
446     struct iovec *vec;
447     int i;
448
449     vec = (struct iovec *)apr_palloc(r->pool, count * sizeof(struct iovec));
450     va_start(ap, count);
451     for (i = 0; i < count; i++) {
452         vec[i].iov_base = va_arg(ap, caddr_t);
453         vec[i].iov_len  = va_arg(ap, apr_size_t);
454     }
455     va_end(ap);
456
457 #ifndef HAVE_CGID_FDPASSING
458     do {
459         rc = writev(fd, vec, count);
460     } while (rc < 0 && errno == EINTR);
461 #else
462     {
463         struct msghdr msg = { 0 };
464         struct cmsghdr *cmsg;
465         union { /* union for alignment */
466             char buf[CMSG_SPACE(sizeof(int))];
467             struct cmsghdr align;
468         } u;
469
470         msg.msg_iov = vec;
471         msg.msg_iovlen = count;
472
473         if (auxfd) {
474             msg.msg_control = u.buf;
475             msg.msg_controllen = sizeof(u.buf);
476
477             cmsg = CMSG_FIRSTHDR(&msg);
478             cmsg->cmsg_level = SOL_SOCKET;
479             cmsg->cmsg_type = SCM_RIGHTS;
480             cmsg->cmsg_len = CMSG_LEN(sizeof(int));
481             *((int *) CMSG_DATA(cmsg)) = auxfd;
482         }
483
484         do {
485             rc = sendmsg(fd, &msg, 0);
486         } while (rc < 0 && errno == EINTR);
487     }
488 #endif
489     
490     if (rc < 0) {
491         return errno;
492     }
493
494     return APR_SUCCESS;
495 }
496
497 static apr_status_t get_req(int fd, request_rec *r, char **argv0, char ***env,
498                             int *errfd, cgid_req_t *req)
499 {
500     int i;
501     char **environ;
502     core_request_config *temp_core;
503     void **rconf;
504     apr_status_t stat;
505
506     r->server = apr_pcalloc(r->pool, sizeof(server_rec));
507
508     /* read the request header */
509     stat = sock_readhdr(fd, errfd, req, sizeof(*req));
510     if (stat != APR_SUCCESS) {
511         return stat;
512     }
513     r->server->log.level = req->loglevel;
514     if (req->req_type == GETPID_REQ) {
515         /* no more data sent for this request */
516         return APR_SUCCESS;
517     }
518
519     /* handle module indexes and such */
520     rconf = (void **)ap_create_request_config(r->pool);
521
522     temp_core = (core_request_config *)apr_palloc(r->pool, sizeof(core_module));
523     rconf[AP_CORE_MODULE_INDEX] = (void *)temp_core;
524     r->request_config = (ap_conf_vector_t *)rconf;
525     ap_set_module_config(r->request_config, &cgid_module, (void *)&req->ugid);
526
527     /* Read the filename, argv0, uri, and args */
528     r->filename = apr_pcalloc(r->pool, req->filename_len + 1);
529     *argv0 = apr_pcalloc(r->pool, req->argv0_len + 1);
530     r->uri = apr_pcalloc(r->pool, req->uri_len + 1);
531     if ((stat = sock_read(fd, r->filename, req->filename_len)) != APR_SUCCESS ||
532         (stat = sock_read(fd, *argv0, req->argv0_len)) != APR_SUCCESS ||
533         (stat = sock_read(fd, r->uri, req->uri_len)) != APR_SUCCESS) {
534         return stat;
535     }
536
537     r->args = apr_pcalloc(r->pool, req->args_len + 1); /* empty string if no args */
538     if (req->args_len) {
539         if ((stat = sock_read(fd, r->args, req->args_len)) != APR_SUCCESS) {
540             return stat;
541         }
542     }
543
544     /* read the environment variables */
545     environ = apr_pcalloc(r->pool, (req->env_count + 2) *sizeof(char *));
546     for (i = 0; i < req->env_count; i++) {
547         apr_size_t curlen;
548
549         if ((stat = sock_read(fd, &curlen, sizeof(curlen))) != APR_SUCCESS) {
550             return stat;
551         }
552         environ[i] = apr_pcalloc(r->pool, curlen + 1);
553         if ((stat = sock_read(fd, environ[i], curlen)) != APR_SUCCESS) {
554             return stat;
555         }
556     }
557     *env = environ;
558
559 #ifdef AP_CGID_USE_RLIMIT
560     if ((stat = sock_read(fd, &(req->limits), sizeof(cgid_rlimit_t))) != APR_SUCCESS)
561          return stat;
562 #endif
563
564     return APR_SUCCESS;
565 }
566
567 static apr_status_t send_req(int fd, apr_file_t *errpipe, request_rec *r,
568                              char *argv0, char **env, int req_type)
569 {
570     int i;
571     cgid_req_t req = {0};
572     apr_status_t stat;
573     ap_unix_identity_t * ugid = ap_run_get_suexec_identity(r);
574     core_dir_config *core_conf = ap_get_core_module_config(r->per_dir_config);
575     int errfd;
576
577
578     if (ugid == NULL) {
579         req.ugid = empty_ugid;
580     } else {
581         memcpy(&req.ugid, ugid, sizeof(ap_unix_identity_t));
582     }
583
584     req.req_type = req_type;
585     req.ppid = parent_pid;
586     req.conn_id = r->connection->id;
587     for (req.env_count = 0; env[req.env_count]; req.env_count++) {
588         continue;
589     }
590     req.filename_len = strlen(r->filename);
591     req.argv0_len = strlen(argv0);
592     req.uri_len = strlen(r->uri);
593     req.args_len = r->args ? strlen(r->args) : 0;
594     req.loglevel = r->server->log.level;
595
596     if (errpipe)
597         apr_os_file_get(&errfd, errpipe);
598     else
599         errfd = 0;
600     
601     /* Write the request header */
602     if (req.args_len) {
603         stat = sock_writev(fd, errfd, r, 5,
604                            &req, sizeof(req),
605                            r->filename, req.filename_len,
606                            argv0, req.argv0_len,
607                            r->uri, req.uri_len,
608                            r->args, req.args_len);
609     } else {
610         stat = sock_writev(fd, errfd, r, 4,
611                            &req, sizeof(req),
612                            r->filename, req.filename_len,
613                            argv0, req.argv0_len,
614                            r->uri, req.uri_len);
615     }
616
617     if (stat != APR_SUCCESS) {
618         return stat;
619     }
620
621     /* write the environment variables */
622     for (i = 0; i < req.env_count; i++) {
623         apr_size_t curlen = strlen(env[i]);
624
625         if ((stat = sock_writev(fd, 0, r, 2, &curlen, sizeof(curlen),
626                                 env[i], curlen)) != APR_SUCCESS) {
627             return stat;
628         }
629     }
630 #if defined(RLIMIT_CPU) && defined(AP_CGID_USE_RLIMIT)
631     if (core_conf->limit_cpu) {
632         req.limits.limit_cpu = *(core_conf->limit_cpu);
633         req.limits.limit_cpu_set = 1;
634     }
635     else {
636         req.limits.limit_cpu_set = 0;
637     }
638 #endif
639
640 #if defined(AP_CGID_USE_RLIMIT) && (defined(RLIMIT_DATA) || defined(RLIMIT_VMEM) || defined(RLIMIT_AS))
641     if (core_conf->limit_mem) {
642         req.limits.limit_mem = *(core_conf->limit_mem);
643         req.limits.limit_mem_set = 1;
644     }
645     else {
646         req.limits.limit_mem_set = 0;
647     }
648
649 #endif
650
651 #if defined(RLIMIT_NPROC) && defined(AP_CGID_USE_RLIMIT)
652     if (core_conf->limit_nproc) {
653         req.limits.limit_nproc = *(core_conf->limit_nproc);
654         req.limits.limit_nproc_set = 1;
655     }
656     else {
657         req.limits.limit_nproc_set = 0;
658     }
659 #endif
660
661 #ifdef AP_CGID_USE_RLIMIT
662     if ( (stat = sock_write(fd, &(req.limits), sizeof(cgid_rlimit_t))) != APR_SUCCESS)
663         return stat;
664 #endif
665
666     return APR_SUCCESS;
667 }
668
669 static void daemon_signal_handler(int sig)
670 {
671     if (sig == SIGHUP) {
672         ++daemon_should_exit;
673     }
674 }
675
676 /* Callback executed in the forked child process if exec of the CGI
677  * script fails.  For the fd-passing case, output to stderr goes to
678  * the client (request handling thread) and is logged via
679  * ap_log_rerror there.  For the non-fd-passing case, the "fake"
680  * request_rec passed via userdata is used to log. */
681 static void cgid_child_errfn(apr_pool_t *pool, apr_status_t err,
682                              const char *description)
683 {
684     void *vr;
685
686     apr_pool_userdata_get(&vr, ERRFN_USERDATA_KEY, pool);
687     if (vr) {
688         request_rec *r = vr;
689         
690         /* sure we got r, but don't call ap_log_rerror() because we don't
691          * have r->headers_in and possibly other storage referenced by
692          * ap_log_rerror()
693          */
694         ap_log_error(APLOG_MARK, APLOG_ERR, err, r->server, APLOGNO(01241) "%s", description);
695     }
696     else {
697         const char *logstr;
698         
699         logstr = apr_psprintf(pool, APLOGNO(01241) "error spawning CGI child: %s (%pm)\n",
700                               description, &err);
701         fputs(logstr, stderr);
702         fflush(stderr);
703     }
704 }
705
706 static int cgid_server(void *data)
707 {
708     int sd, sd2, rc;
709     mode_t omask;
710     apr_pool_t *ptrans;
711     server_rec *main_server = data;
712     apr_hash_t *script_hash = apr_hash_make(pcgi);
713     apr_status_t rv;
714
715     apr_pool_create(&ptrans, pcgi);
716
717     apr_signal(SIGCHLD, SIG_IGN);
718     apr_signal(SIGHUP, daemon_signal_handler);
719
720     /* Close our copy of the listening sockets */
721     ap_close_listeners();
722
723     /* cgid should use its own suexec doer */
724     ap_hook_get_suexec_identity(cgid_suexec_id_doer, NULL, NULL,
725                                 APR_HOOK_REALLY_FIRST);
726     apr_hook_sort_all();
727
728     if ((sd = socket(AF_UNIX, SOCK_STREAM, 0)) < 0) {
729         ap_log_error(APLOG_MARK, APLOG_ERR, errno, main_server, APLOGNO(01242)
730                      "Couldn't create unix domain socket");
731         return errno;
732     }
733
734     omask = umask(0077); /* so that only Apache can use socket */
735     rc = bind(sd, (struct sockaddr *)server_addr, server_addr_len);
736     umask(omask); /* can't fail, so can't clobber errno */
737     if (rc < 0) {
738         ap_log_error(APLOG_MARK, APLOG_ERR, errno, main_server, APLOGNO(01243)
739                      "Couldn't bind unix domain socket %s",
740                      sockname);
741         return errno;
742     }
743
744     /* Not all flavors of unix use the current umask for AF_UNIX perms */
745     rv = apr_file_perms_set(sockname, APR_FPROT_UREAD|APR_FPROT_UWRITE|APR_FPROT_UEXECUTE);
746     if (rv != APR_SUCCESS) {
747         ap_log_error(APLOG_MARK, APLOG_CRIT, rv, main_server, APLOGNO(01244)
748                      "Couldn't set permissions on unix domain socket %s",
749                      sockname);
750         return rv;
751     }
752
753     if (listen(sd, DEFAULT_CGID_LISTENBACKLOG) < 0) {
754         ap_log_error(APLOG_MARK, APLOG_ERR, errno, main_server, APLOGNO(01245)
755                      "Couldn't listen on unix domain socket");
756         return errno;
757     }
758
759     if (!geteuid()) {
760         if (chown(sockname, ap_unixd_config.user_id, -1) < 0) {
761             ap_log_error(APLOG_MARK, APLOG_ERR, errno, main_server, APLOGNO(01246)
762                          "Couldn't change owner of unix domain socket %s",
763                          sockname);
764             return errno;
765         }
766     }
767
768     apr_pool_cleanup_register(pcgi, (void *)((long)sd),
769                               close_unix_socket, close_unix_socket);
770
771     /* if running as root, switch to configured user/group */
772     if ((rc = ap_run_drop_privileges(pcgi, ap_server_conf)) != 0) {
773         return rc;
774     }
775
776     while (!daemon_should_exit) {
777         int errfileno;
778         char *argv0 = NULL;
779         char **env = NULL;
780         const char * const *argv;
781         apr_int32_t in_pipe;
782         apr_int32_t out_pipe;
783         apr_int32_t err_pipe;
784         apr_cmdtype_e cmd_type;
785         request_rec *r;
786         apr_procattr_t *procattr = NULL;
787         apr_proc_t *procnew = NULL;
788         apr_file_t *inout;
789         cgid_req_t cgid_req;
790         apr_status_t stat;
791         void *key;
792         apr_socklen_t len;
793         struct sockaddr_un unix_addr;
794
795         apr_pool_clear(ptrans);
796
797         len = sizeof(unix_addr);
798         sd2 = accept(sd, (struct sockaddr *)&unix_addr, &len);
799         if (sd2 < 0) {
800 #if defined(ENETDOWN)
801             if (errno == ENETDOWN) {
802                 /* The network has been shut down, no need to continue. Die gracefully */
803                 ++daemon_should_exit;
804             }
805 #endif
806             if (errno != EINTR) {
807                 ap_log_error(APLOG_MARK, APLOG_ERR, errno,
808                              (server_rec *)data, APLOGNO(01247)
809                              "Error accepting on cgid socket");
810             }
811             continue;
812         }
813
814         r = apr_pcalloc(ptrans, sizeof(request_rec));
815         procnew = apr_pcalloc(ptrans, sizeof(*procnew));
816         r->pool = ptrans;
817         stat = get_req(sd2, r, &argv0, &env, &errfileno, &cgid_req);
818         if (stat != APR_SUCCESS) {
819             ap_log_error(APLOG_MARK, APLOG_ERR, stat,
820                          main_server, APLOGNO(01248)
821                          "Error reading request on cgid socket");
822             close(sd2);
823             continue;
824         }
825
826         if (cgid_req.ppid != parent_pid) {
827             ap_log_error(APLOG_MARK, APLOG_CRIT, 0, main_server, APLOGNO(01249)
828                          "CGI request received from wrong server instance; "
829                          "see ScriptSock directive");
830             close(sd2);
831             continue;
832         }
833
834         if (cgid_req.req_type == GETPID_REQ) {
835             pid_t pid;
836             apr_status_t rv;
837
838             pid = (pid_t)((long)apr_hash_get(script_hash, &cgid_req.conn_id, sizeof(cgid_req.conn_id)));
839             rv = sock_write(sd2, &pid, sizeof(pid));
840             if (rv != APR_SUCCESS) {
841                 ap_log_error(APLOG_MARK, APLOG_ERR, rv,
842                              main_server, APLOGNO(01250)
843                              "Error writing pid %" APR_PID_T_FMT " to handler", pid);
844             }
845             close(sd2);
846             continue;
847         }
848
849         if (errfileno == 0) {
850             errfileno = STDERR_FILENO;
851         }
852         else {
853             ap_log_error(APLOG_MARK, APLOG_DEBUG, rv, main_server,
854                           "using passed fd %d as stderr", errfileno);
855             /* Limit the received fd lifetime to pool lifetime */
856             apr_pool_cleanup_register(ptrans, (void *)((long)errfileno),
857                                       close_unix_socket, close_unix_socket);
858         }
859         apr_os_file_put(&r->server->error_log, &errfileno, 0, r->pool);
860         apr_os_file_put(&inout, &sd2, 0, r->pool);
861
862         if (cgid_req.req_type == SSI_REQ) {
863             in_pipe  = APR_NO_PIPE;
864             out_pipe = APR_FULL_BLOCK;
865             err_pipe = APR_NO_PIPE;
866             cmd_type = APR_SHELLCMD;
867         }
868         else {
869             in_pipe  = APR_CHILD_BLOCK;
870             out_pipe = APR_CHILD_BLOCK;
871             err_pipe = APR_CHILD_BLOCK;
872             cmd_type = APR_PROGRAM;
873         }
874
875         if (((rc = apr_procattr_create(&procattr, ptrans)) != APR_SUCCESS) ||
876             ((cgid_req.req_type == CGI_REQ) &&
877              (((rc = apr_procattr_io_set(procattr,
878                                         in_pipe,
879                                         out_pipe,
880                                         err_pipe)) != APR_SUCCESS) ||
881               /* XXX apr_procattr_child_*_set() is creating an unnecessary
882                * pipe between this process and the child being created...
883                * It is cleaned up with the temporary pool for this request.
884                */
885               ((rc = apr_procattr_child_err_set(procattr, r->server->error_log, NULL)) != APR_SUCCESS) ||
886               ((rc = apr_procattr_child_in_set(procattr, inout, NULL)) != APR_SUCCESS))) ||
887             ((rc = apr_procattr_child_out_set(procattr, inout, NULL)) != APR_SUCCESS) ||
888             ((rc = apr_procattr_dir_set(procattr,
889                                   ap_make_dirstr_parent(r->pool, r->filename))) != APR_SUCCESS) ||
890             ((rc = apr_procattr_cmdtype_set(procattr, cmd_type)) != APR_SUCCESS) ||
891 #ifdef AP_CGID_USE_RLIMIT
892 #ifdef RLIMIT_CPU
893         (  (cgid_req.limits.limit_cpu_set) && ((rc = apr_procattr_limit_set(procattr, APR_LIMIT_CPU,
894                                       &cgid_req.limits.limit_cpu)) != APR_SUCCESS)) ||
895 #endif
896 #if defined(RLIMIT_DATA) || defined(RLIMIT_VMEM) || defined(RLIMIT_AS)
897         ( (cgid_req.limits.limit_mem_set) && ((rc = apr_procattr_limit_set(procattr, APR_LIMIT_MEM,
898                                       &cgid_req.limits.limit_mem)) != APR_SUCCESS)) ||
899 #endif
900 #ifdef RLIMIT_NPROC
901         ( (cgid_req.limits.limit_nproc_set) && ((rc = apr_procattr_limit_set(procattr, APR_LIMIT_NPROC,
902                                       &cgid_req.limits.limit_nproc)) != APR_SUCCESS)) ||
903 #endif
904 #endif
905
906             ((rc = apr_procattr_child_errfn_set(procattr, cgid_child_errfn)) != APR_SUCCESS)) {
907             /* Something bad happened, tell the world.
908              * ap_log_rerror() won't work because the header table used by
909              * ap_log_rerror() hasn't been replicated in the phony r
910              */
911             ap_log_error(APLOG_MARK, APLOG_ERR, rc, r->server, APLOGNO(01251)
912                          "couldn't set child process attributes: %s", r->filename);
913
914             procnew->pid = 0; /* no process to clean up */
915             close(sd2);
916         }
917         else {
918             if (errfileno == STDERR_FILENO) {
919                 /* Used by cgid_child_errfn without fd-passing. */
920                 apr_pool_userdata_set(r, ERRFN_USERDATA_KEY, apr_pool_cleanup_null, ptrans);
921             }
922
923             argv = (const char * const *)create_argv(r->pool, NULL, NULL, NULL, argv0, r->args);
924
925            /* We want to close sd2 for the new CGI process too.
926             * If it is left open it'll make ap_pass_brigade() block
927             * waiting for EOF if CGI forked something running long.
928             * close(sd2) here should be okay, as CGI channel
929             * is already dup()ed by apr_procattr_child_{in,out}_set()
930             * above.
931             */
932             close(sd2);
933
934             if (memcmp(&empty_ugid, &cgid_req.ugid, sizeof(empty_ugid))) {
935                 /* We have a valid identity, and can be sure that
936                  * cgid_suexec_id_doer will return a valid ugid
937                  */
938                 rc = ap_os_create_privileged_process(r, procnew, argv0, argv,
939                                                      (const char * const *)env,
940                                                      procattr, ptrans);
941             } else {
942                 rc = apr_proc_create(procnew, argv0, argv,
943                                      (const char * const *)env,
944                                      procattr, ptrans);
945             }
946
947             if (rc != APR_SUCCESS) {
948                 /* Bad things happened. Everyone should have cleaned up.
949                  * ap_log_rerror() won't work because the header table used by
950                  * ap_log_rerror() hasn't been replicated in the phony r
951                  */
952                 ap_log_error(APLOG_MARK, APLOG_ERR, rc, r->server, APLOGNO(01252)
953                              "couldn't create child process: %d: %s", rc,
954                              apr_filepath_name_get(r->filename));
955
956                 procnew->pid = 0; /* no process to clean up */
957             }
958         }
959
960         /* If the script process was created, remember the pid for
961          * later cleanup.  If the script process wasn't created, clear
962          * out any prior pid with the same key.
963          *
964          * We don't want to leak storage for the key, so only allocate
965          * a key if the key doesn't exist yet in the hash; there are
966          * only a limited number of possible keys (one for each
967          * possible thread in the server), so we can allocate a copy
968          * of the key the first time a thread has a cgid request.
969          * Note that apr_hash_set() only uses the storage passed in
970          * for the key if it is adding the key to the hash for the
971          * first time; new key storage isn't needed for replacing the
972          * existing value of a key.
973          */
974
975         if (apr_hash_get(script_hash, &cgid_req.conn_id, sizeof(cgid_req.conn_id))) {
976             key = &cgid_req.conn_id;
977         }
978         else {
979             key = apr_pmemdup(pcgi, &cgid_req.conn_id, sizeof(cgid_req.conn_id));
980         }
981         apr_hash_set(script_hash, key, sizeof(cgid_req.conn_id),
982                      (void *)((long)procnew->pid));
983     }
984     return -1; /* should be <= 0 to distinguish from startup errors */
985 }
986
987 static int cgid_start(apr_pool_t *p, server_rec *main_server,
988                       apr_proc_t *procnew)
989 {
990
991     daemon_should_exit = 0; /* clear setting from previous generation */
992     if ((daemon_pid = fork()) < 0) {
993         ap_log_error(APLOG_MARK, APLOG_ERR, errno, main_server, APLOGNO(01253)
994                      "mod_cgid: Couldn't spawn cgid daemon process");
995         return DECLINED;
996     }
997     else if (daemon_pid == 0) {
998         if (pcgi == NULL) {
999             apr_pool_create(&pcgi, p);
1000         }
1001         exit(cgid_server(main_server) > 0 ? DAEMON_STARTUP_ERROR : -1);
1002     }
1003     procnew->pid = daemon_pid;
1004     procnew->err = procnew->in = procnew->out = NULL;
1005     apr_pool_note_subprocess(p, procnew, APR_KILL_AFTER_TIMEOUT);
1006 #if APR_HAS_OTHER_CHILD
1007     apr_proc_other_child_register(procnew, cgid_maint, procnew, NULL, p);
1008 #endif
1009     return OK;
1010 }
1011
1012 static int cgid_pre_config(apr_pool_t *pconf, apr_pool_t *plog,
1013                            apr_pool_t *ptemp)
1014 {
1015     sockname = ap_append_pid(pconf, DEFAULT_SOCKET, ".");
1016     return OK;
1017 }
1018
1019 static int cgid_init(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp,
1020                      server_rec *main_server)
1021 {
1022     apr_proc_t *procnew = NULL;
1023     const char *userdata_key = "cgid_init";
1024     int ret = OK;
1025     void *data;
1026
1027     root_server = main_server;
1028     root_pool = p;
1029
1030     apr_pool_userdata_get(&data, userdata_key, main_server->process->pool);
1031     if (!data) {
1032         procnew = apr_pcalloc(main_server->process->pool, sizeof(*procnew));
1033         procnew->pid = -1;
1034         procnew->err = procnew->in = procnew->out = NULL;
1035         apr_pool_userdata_set((const void *)procnew, userdata_key,
1036                      apr_pool_cleanup_null, main_server->process->pool);
1037         return ret;
1038     }
1039     else {
1040         procnew = data;
1041     }
1042
1043     if (ap_state_query(AP_SQ_MAIN_STATE) != AP_SQ_MS_CREATE_PRE_CONFIG) {
1044         char *tmp_sockname;
1045
1046         parent_pid = getpid();
1047         tmp_sockname = ap_runtime_dir_relative(p, sockname);
1048         if (strlen(tmp_sockname) > sizeof(server_addr->sun_path) - 1) {
1049             tmp_sockname[sizeof(server_addr->sun_path)] = '\0';
1050             ap_log_error(APLOG_MARK, APLOG_ERR, 0, main_server, APLOGNO(01254)
1051                         "The length of the ScriptSock path exceeds maximum, "
1052                         "truncating to %s", tmp_sockname);
1053         }
1054         sockname = tmp_sockname;
1055
1056         server_addr_len = APR_OFFSETOF(struct sockaddr_un, sun_path) + strlen(sockname);
1057         server_addr = (struct sockaddr_un *)apr_palloc(p, server_addr_len + 1);
1058         server_addr->sun_family = AF_UNIX;
1059         strcpy(server_addr->sun_path, sockname);
1060
1061         ret = cgid_start(p, main_server, procnew);
1062         if (ret != OK ) {
1063             return ret;
1064         }
1065         cgid_pfn_reg_with_ssi = APR_RETRIEVE_OPTIONAL_FN(ap_register_include_handler);
1066         cgid_pfn_gtv          = APR_RETRIEVE_OPTIONAL_FN(ap_ssi_get_tag_and_value);
1067         cgid_pfn_ps           = APR_RETRIEVE_OPTIONAL_FN(ap_ssi_parse_string);
1068
1069         if ((cgid_pfn_reg_with_ssi) && (cgid_pfn_gtv) && (cgid_pfn_ps)) {
1070             /* Required by mod_include filter. This is how mod_cgid registers
1071              *   with mod_include to provide processing of the exec directive.
1072              */
1073             cgid_pfn_reg_with_ssi("exec", handle_exec);
1074         }
1075     }
1076     return ret;
1077 }
1078
1079 static void *create_cgid_config(apr_pool_t *p, server_rec *s)
1080 {
1081     cgid_server_conf *c =
1082     (cgid_server_conf *) apr_pcalloc(p, sizeof(cgid_server_conf));
1083
1084     c->logname = NULL;
1085     c->logbytes = DEFAULT_LOGBYTES;
1086     c->bufbytes = DEFAULT_BUFBYTES;
1087     return c;
1088 }
1089
1090 static void *merge_cgid_config(apr_pool_t *p, void *basev, void *overridesv)
1091 {
1092     cgid_server_conf *base = (cgid_server_conf *) basev, *overrides = (cgid_server_conf *) overridesv;
1093
1094     return overrides->logname ? overrides : base;
1095 }
1096
1097 static void *create_cgid_dirconf(apr_pool_t *p, char *dummy)
1098 {
1099     cgid_dirconf *c = (cgid_dirconf *) apr_pcalloc(p, sizeof(cgid_dirconf));
1100     return c;
1101 }
1102
1103 static const char *set_scriptlog(cmd_parms *cmd, void *dummy, const char *arg)
1104
1105 {
1106     server_rec *s = cmd->server;
1107     cgid_server_conf *conf = ap_get_module_config(s->module_config,
1108                                                   &cgid_module);
1109
1110     conf->logname = ap_server_root_relative(cmd->pool, arg);
1111
1112     if (!conf->logname) {
1113         return apr_pstrcat(cmd->pool, "Invalid ScriptLog path ",
1114                            arg, NULL);
1115     }
1116     return NULL;
1117 }
1118
1119 static const char *set_scriptlog_length(cmd_parms *cmd, void *dummy, const char *arg)
1120 {
1121     server_rec *s = cmd->server;
1122     cgid_server_conf *conf = ap_get_module_config(s->module_config,
1123                                                   &cgid_module);
1124
1125     conf->logbytes = atol(arg);
1126     return NULL;
1127 }
1128
1129 static const char *set_scriptlog_buffer(cmd_parms *cmd, void *dummy, const char *arg)
1130 {
1131     server_rec *s = cmd->server;
1132     cgid_server_conf *conf = ap_get_module_config(s->module_config,
1133                                                   &cgid_module);
1134
1135     conf->bufbytes = atoi(arg);
1136     return NULL;
1137 }
1138
1139 static const char *set_script_socket(cmd_parms *cmd, void *dummy, const char *arg)
1140 {
1141     const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1142     if (err != NULL) {
1143         return err;
1144     }
1145
1146     /* Make sure the pid is appended to the sockname */
1147     sockname = ap_append_pid(cmd->pool, arg, ".");
1148     sockname = ap_runtime_dir_relative(cmd->pool, sockname);
1149
1150     if (!sockname) {
1151         return apr_pstrcat(cmd->pool, "Invalid ScriptSock path",
1152                            arg, NULL);
1153     }
1154
1155     return NULL;
1156 }
1157 static const char *set_script_timeout(cmd_parms *cmd, void *dummy, const char *arg)
1158 {
1159     cgid_dirconf *dc = dummy;
1160
1161     if (ap_timeout_parameter_parse(arg, &dc->timeout, "s") != APR_SUCCESS) { 
1162         return "CGIDScriptTimeout has wrong format";
1163     }
1164  
1165     return NULL;
1166 }
1167 static const command_rec cgid_cmds[] =
1168 {
1169     AP_INIT_TAKE1("ScriptLog", set_scriptlog, NULL, RSRC_CONF,
1170                   "the name of a log for script debugging info"),
1171     AP_INIT_TAKE1("ScriptLogLength", set_scriptlog_length, NULL, RSRC_CONF,
1172                   "the maximum length (in bytes) of the script debug log"),
1173     AP_INIT_TAKE1("ScriptLogBuffer", set_scriptlog_buffer, NULL, RSRC_CONF,
1174                   "the maximum size (in bytes) to record of a POST request"),
1175     AP_INIT_TAKE1("ScriptSock", set_script_socket, NULL, RSRC_CONF,
1176                   "the name of the socket to use for communication with "
1177                   "the cgi daemon."),
1178     AP_INIT_TAKE1("CGIDScriptTimeout", set_script_timeout, NULL, RSRC_CONF | ACCESS_CONF,
1179                   "The amount of time to wait between successful reads from "
1180                   "the CGI script, in seconds."),
1181                   
1182     {NULL}
1183 };
1184
1185 static int log_scripterror(request_rec *r, cgid_server_conf * conf, int ret,
1186                            apr_status_t rv, char *error)
1187 {
1188     apr_file_t *f = NULL;
1189     struct stat finfo;
1190     char time_str[APR_CTIME_LEN];
1191     int log_flags = rv ? APLOG_ERR : APLOG_ERR;
1192
1193     /* Intentional no APLOGNO */
1194     /* Callee provides APLOGNO in error text */
1195     ap_log_rerror(APLOG_MARK, log_flags, rv, r,
1196                 "%s: %s", error, r->filename);
1197
1198     /* XXX Very expensive mainline case! Open, then getfileinfo! */
1199     if (!conf->logname ||
1200         ((stat(conf->logname, &finfo) == 0)
1201          && (finfo.st_size > conf->logbytes)) ||
1202          (apr_file_open(&f, conf->logname,
1203                   APR_APPEND|APR_WRITE|APR_CREATE, APR_OS_DEFAULT, r->pool) != APR_SUCCESS)) {
1204         return ret;
1205     }
1206
1207     /* "%% [Wed Jun 19 10:53:21 1996] GET /cgid-bin/printenv HTTP/1.0" */
1208     apr_ctime(time_str, apr_time_now());
1209     apr_file_printf(f, "%%%% [%s] %s %s%s%s %s\n", time_str, r->method, r->uri,
1210             r->args ? "?" : "", r->args ? r->args : "", r->protocol);
1211     /* "%% 500 /usr/local/apache/cgid-bin */
1212     apr_file_printf(f, "%%%% %d %s\n", ret, r->filename);
1213
1214     apr_file_printf(f, "%%error\n%s\n", error);
1215
1216     apr_file_close(f);
1217     return ret;
1218 }
1219
1220 /* Soak up stderr from a script and redirect it to the error log.
1221  * TODO: log_scripterror() and this could move to cgi_common.h. */
1222 static apr_status_t log_script_err(request_rec *r, apr_file_t *script_err)
1223 {
1224     char argsbuffer[HUGE_STRING_LEN];
1225     char *newline;
1226     apr_status_t rv;
1227     cgid_server_conf *conf = ap_get_module_config(r->server->module_config, &cgid_module);
1228
1229     while ((rv = apr_file_gets(argsbuffer, HUGE_STRING_LEN,
1230                                script_err)) == APR_SUCCESS) {
1231
1232         newline = strchr(argsbuffer, '\n');
1233         if (newline) {
1234             char *prev = newline - 1;
1235             if (prev >= argsbuffer && *prev == '\r') {
1236                 newline = prev;
1237             }
1238
1239             *newline = '\0';
1240         }
1241         log_scripterror(r, conf, r->status, 0, argsbuffer);
1242     }
1243
1244     return rv;
1245 }
1246
1247 static int log_script(request_rec *r, cgid_server_conf * conf, int ret,
1248                       char *dbuf, const char *sbuf, apr_bucket_brigade *bb,
1249                       apr_file_t *script_err)
1250 {
1251     const apr_array_header_t *hdrs_arr = apr_table_elts(r->headers_in);
1252     const apr_table_entry_t *hdrs = (apr_table_entry_t *) hdrs_arr->elts;
1253     char argsbuffer[HUGE_STRING_LEN];
1254     apr_file_t *f = NULL;
1255     apr_bucket *e;
1256     const char *buf;
1257     apr_size_t len;
1258     apr_status_t rv;
1259     int first;
1260     int i;
1261     struct stat finfo;
1262     char time_str[APR_CTIME_LEN];
1263
1264     /* XXX Very expensive mainline case! Open, then getfileinfo! */
1265     if (!conf->logname ||
1266         ((stat(conf->logname, &finfo) == 0)
1267          && (finfo.st_size > conf->logbytes)) ||
1268          (apr_file_open(&f, conf->logname,
1269                   APR_APPEND|APR_WRITE|APR_CREATE, APR_OS_DEFAULT, r->pool) != APR_SUCCESS)) {
1270         /* Soak up script output */
1271         discard_script_output(bb);
1272         if (script_err) {
1273             while (apr_file_gets(argsbuffer, HUGE_STRING_LEN,
1274                                  script_err) == APR_SUCCESS)
1275                 continue;
1276         }
1277         return ret;
1278     }
1279
1280     /* "%% [Wed Jun 19 10:53:21 1996] GET /cgid-bin/printenv HTTP/1.0" */
1281     apr_ctime(time_str, apr_time_now());
1282     apr_file_printf(f, "%%%% [%s] %s %s%s%s %s\n", time_str, r->method, r->uri,
1283             r->args ? "?" : "", r->args ? r->args : "", r->protocol);
1284     /* "%% 500 /usr/local/apache/cgid-bin" */
1285     apr_file_printf(f, "%%%% %d %s\n", ret, r->filename);
1286
1287     apr_file_puts("%request\n", f);
1288     for (i = 0; i < hdrs_arr->nelts; ++i) {
1289         if (!hdrs[i].key)
1290             continue;
1291         apr_file_printf(f, "%s: %s\n", hdrs[i].key, hdrs[i].val);
1292     }
1293     if ((r->method_number == M_POST || r->method_number == M_PUT)
1294         && *dbuf) {
1295         apr_file_printf(f, "\n%s\n", dbuf);
1296     }
1297
1298     apr_file_puts("%response\n", f);
1299     hdrs_arr = apr_table_elts(r->err_headers_out);
1300     hdrs = (const apr_table_entry_t *) hdrs_arr->elts;
1301
1302     for (i = 0; i < hdrs_arr->nelts; ++i) {
1303         if (!hdrs[i].key)
1304             continue;
1305         apr_file_printf(f, "%s: %s\n", hdrs[i].key, hdrs[i].val);
1306     }
1307
1308     if (sbuf && *sbuf)
1309         apr_file_printf(f, "%s\n", sbuf);
1310
1311     first = 1;
1312
1313     for (e = APR_BRIGADE_FIRST(bb);
1314          e != APR_BRIGADE_SENTINEL(bb);
1315          e = APR_BUCKET_NEXT(e))
1316     {
1317         if (APR_BUCKET_IS_EOS(e)) {
1318             break;
1319         }
1320         rv = apr_bucket_read(e, &buf, &len, APR_BLOCK_READ);
1321         if (rv != APR_SUCCESS || (len == 0)) {
1322             break;
1323         }
1324         if (first) {
1325             apr_file_puts("%stdout\n", f);
1326             first = 0;
1327         }
1328         apr_file_write_full(f, buf, len, NULL);
1329         apr_file_puts("\n", f);
1330     }
1331
1332     if (script_err) {
1333         if (apr_file_gets(argsbuffer, HUGE_STRING_LEN,
1334                           script_err) == APR_SUCCESS) {
1335             apr_file_puts("%stderr\n", f);
1336             apr_file_puts(argsbuffer, f);
1337             while (apr_file_gets(argsbuffer, HUGE_STRING_LEN,
1338                                  script_err) == APR_SUCCESS)
1339                 apr_file_puts(argsbuffer, f);
1340             apr_file_puts("\n", f);
1341         }
1342     }
1343
1344     if (script_err) {
1345         apr_file_close(script_err);
1346     }
1347
1348     apr_file_close(f);
1349     return ret;
1350 }
1351
1352 #ifdef HAVE_CGID_FDPASSING
1353 /* Pull in CGI bucket implementation. */
1354 #include "cgi_common.h"
1355 #endif
1356
1357 static int connect_to_daemon(int *sdptr, request_rec *r,
1358                              cgid_server_conf *conf)
1359 {
1360     int sd;
1361     int connect_tries;
1362     int connect_errno;
1363     apr_interval_time_t sliding_timer;
1364
1365     connect_tries = 0;
1366     sliding_timer = 100000; /* 100 milliseconds */
1367     while (1) {
1368         connect_errno = 0;
1369         ++connect_tries;
1370         if ((sd = socket(AF_UNIX, SOCK_STREAM, 0)) < 0) {
1371             return log_scripterror(r, conf, HTTP_INTERNAL_SERVER_ERROR, errno,
1372                                    APLOGNO(01255) "unable to create socket to cgi daemon");
1373         }
1374         if (connect(sd, (struct sockaddr *)server_addr, server_addr_len) < 0) {
1375             /* Save errno for later */
1376             connect_errno = errno;
1377             /* ECONNREFUSED means the listen queue is full; ENOENT means that
1378              * the cgid server either hasn't started up yet, or we're pointing
1379              * at the wrong socket file */
1380             if ((errno == ECONNREFUSED || errno == ENOENT) && 
1381                  connect_tries < DEFAULT_CONNECT_ATTEMPTS) {
1382                 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, errno, r, APLOGNO(01256)
1383                               "connect #%d to cgi daemon failed, sleeping before retry",
1384                               connect_tries);
1385                 close(sd);
1386                 apr_sleep(sliding_timer);
1387                 if (sliding_timer < apr_time_from_sec(2)) {
1388                     sliding_timer *= 2;
1389                 }
1390             }
1391             else {
1392                 close(sd);
1393                 return log_scripterror(r, conf, HTTP_SERVICE_UNAVAILABLE, errno, APLOGNO(01257)
1394                                        "unable to connect to cgi daemon after multiple tries");
1395             }
1396         }
1397         else {
1398             apr_pool_cleanup_register(r->pool, (void *)((long)sd),
1399                                       close_unix_socket, apr_pool_cleanup_null);
1400             break; /* we got connected! */
1401         }
1402
1403         /* If we didn't find the socket but the server was not recently restarted,
1404          * chances are there's something wrong with the cgid daemon
1405          */
1406         if (connect_errno == ENOENT &&
1407             apr_time_sec(apr_time_now() - ap_scoreboard_image->global->restart_time) > 
1408                 DEFAULT_CONNECT_STARTUP_DELAY) {
1409             return log_scripterror(r, conf, HTTP_SERVICE_UNAVAILABLE, connect_errno, 
1410                                    apr_pstrcat(r->pool, APLOGNO(02833) "ScriptSock ", sockname, " does not exist", NULL));
1411         }
1412
1413         /* gotta try again, but make sure the cgid daemon is still around */
1414         if (connect_errno != ENOENT && kill(daemon_pid, 0) != 0) {
1415             return log_scripterror(r, conf, HTTP_SERVICE_UNAVAILABLE, connect_errno, APLOGNO(01258)
1416                                    "cgid daemon is gone; is Apache terminating?");
1417         }
1418     }
1419     *sdptr = sd;
1420     return OK;
1421 }
1422
1423 static void discard_script_output(apr_bucket_brigade *bb)
1424 {
1425     apr_bucket *e;
1426     const char *buf;
1427     apr_size_t len;
1428     apr_status_t rv;
1429
1430     for (e = APR_BRIGADE_FIRST(bb);
1431          e != APR_BRIGADE_SENTINEL(bb);
1432          e = APR_BUCKET_NEXT(e))
1433     {
1434         if (APR_BUCKET_IS_EOS(e)) {
1435             break;
1436         }
1437         rv = apr_bucket_read(e, &buf, &len, APR_BLOCK_READ);
1438         if (rv != APR_SUCCESS) {
1439             break;
1440         }
1441     }
1442 }
1443
1444 /****************************************************************
1445  *
1446  * Actual cgid handling...
1447  */
1448
1449 struct cleanup_script_info {
1450     request_rec *r;
1451     cgid_server_conf *conf;
1452     pid_t pid;
1453 };
1454
1455 static apr_status_t dead_yet(pid_t pid, apr_interval_time_t max_wait)
1456 {
1457     apr_interval_time_t interval = 10000; /* 10 ms */
1458     apr_interval_time_t total = 0;
1459
1460     do {
1461 #ifdef _AIX
1462         /* On AIX, for processes like mod_cgid's script children where
1463          * SIGCHLD is ignored, kill(pid,0) returns success for up to
1464          * one second after the script child exits, based on when a
1465          * daemon runs to clean up unnecessary process table entries.
1466          * getpgid() can report the proper info (-1/ESRCH) immediately.
1467          */
1468         if (getpgid(pid) < 0) {
1469 #else
1470         if (kill(pid, 0) < 0) {
1471 #endif
1472             return APR_SUCCESS;
1473         }
1474         apr_sleep(interval);
1475         total = total + interval;
1476         if (interval < 500000) {
1477             interval *= 2;
1478         }
1479     } while (total < max_wait);
1480     return APR_EGENERAL;
1481 }
1482
1483 static apr_status_t cleanup_nonchild_process(request_rec *r, pid_t pid)
1484 {
1485     kill(pid, SIGTERM); /* in case it isn't dead yet */
1486     if (dead_yet(pid, apr_time_from_sec(3)) == APR_SUCCESS) {
1487         return APR_SUCCESS;
1488     }
1489     ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01259)
1490                   "CGI process %" APR_PID_T_FMT " didn't exit, sending SIGKILL",
1491                   pid);
1492     kill(pid, SIGKILL);
1493     if (dead_yet(pid, apr_time_from_sec(3)) == APR_SUCCESS) {
1494         return APR_SUCCESS;
1495     }
1496     ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01260)
1497                   "CGI process %" APR_PID_T_FMT " didn't exit, sending SIGKILL again",
1498                   pid);
1499     kill(pid, SIGKILL);
1500
1501     return APR_EGENERAL;
1502 }
1503
1504 static apr_status_t get_cgi_pid(request_rec *r,  cgid_server_conf *conf, pid_t *pid) { 
1505     cgid_req_t req = {0};
1506     apr_status_t stat;
1507     int rc, sd;
1508
1509     rc = connect_to_daemon(&sd, r, conf);
1510     if (rc != OK) {
1511         return APR_EGENERAL;
1512     }
1513
1514     req.req_type = GETPID_REQ;
1515     req.ppid = parent_pid;
1516     req.conn_id = r->connection->id;
1517
1518     stat = sock_write(sd, &req, sizeof(req));
1519     if (stat != APR_SUCCESS) {
1520         return stat;
1521     }
1522
1523     /* wait for pid of script */
1524     stat = sock_read(sd, pid, sizeof(*pid));
1525     if (stat != APR_SUCCESS) {
1526         return stat;
1527     }
1528
1529     if (pid == 0) {
1530         ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01261)
1531                       "daemon couldn't find CGI process for connection %lu",
1532                       r->connection->id);
1533         return APR_EGENERAL;
1534     }
1535
1536     return APR_SUCCESS;
1537 }
1538
1539
1540 static apr_status_t cleanup_script(void *vptr)
1541 {
1542     struct cleanup_script_info *info = vptr;
1543     return cleanup_nonchild_process(info->r, info->pid);
1544 }
1545
1546 static int cgid_handler(request_rec *r)
1547 {
1548     conn_rec *c = r->connection;
1549     int retval, nph, dbpos;
1550     char *argv0, *dbuf;
1551     apr_bucket_brigade *bb;
1552     apr_bucket *b;
1553     cgid_server_conf *conf;
1554     int is_included;
1555     int seen_eos, child_stopped_reading;
1556     int sd;
1557     char **env;
1558     apr_file_t *tempsock, *script_err, *errpipe_out;
1559     struct cleanup_script_info *info;
1560     apr_status_t rv;
1561     cgid_dirconf *dc;
1562     apr_interval_time_t timeout;
1563
1564     if (strcmp(r->handler, CGI_MAGIC_TYPE) && strcmp(r->handler, "cgi-script")) {
1565         return DECLINED;
1566     }
1567
1568     conf = ap_get_module_config(r->server->module_config, &cgid_module);
1569     dc = ap_get_module_config(r->per_dir_config, &cgid_module);
1570
1571     timeout = dc->timeout > 0 ? dc->timeout : r->server->timeout;
1572     is_included = !strcmp(r->protocol, "INCLUDED");
1573
1574     if ((argv0 = strrchr(r->filename, '/')) != NULL) {
1575         argv0++;
1576     }
1577     else {
1578         argv0 = r->filename;
1579     }
1580
1581     nph = !(strncmp(argv0, "nph-", 4));
1582
1583     argv0 = r->filename;
1584
1585     if (!(ap_allow_options(r) & OPT_EXECCGI) && !is_scriptaliased(r)) {
1586         return log_scripterror(r, conf, HTTP_FORBIDDEN, 0, APLOGNO(01262)
1587                 "Options ExecCGI is off in this directory");
1588     }
1589
1590     if (nph && is_included) {
1591         return log_scripterror(r, conf, HTTP_FORBIDDEN, 0, APLOGNO(01263)
1592                 "attempt to include NPH CGI script");
1593     }
1594
1595 #if defined(OS2) || defined(WIN32)
1596 #error mod_cgid does not work on this platform.  If you teach it to, look
1597 #error at mod_cgi.c for required code in this path.
1598 #else
1599     if (r->finfo.filetype == APR_NOFILE) {
1600         return log_scripterror(r, conf, HTTP_NOT_FOUND, 0, APLOGNO(01264)
1601                 "script not found or unable to stat");
1602     }
1603 #endif
1604     if (r->finfo.filetype == APR_DIR) {
1605         return log_scripterror(r, conf, HTTP_FORBIDDEN, 0, APLOGNO(01265)
1606                 "attempt to invoke directory as script");
1607     }
1608
1609     if ((r->used_path_info == AP_REQ_REJECT_PATH_INFO) &&
1610         r->path_info && *r->path_info)
1611     {
1612         /* default to accept */
1613         return log_scripterror(r, conf, HTTP_NOT_FOUND, 0, APLOGNO(01266)
1614                                "AcceptPathInfo off disallows user's path");
1615     }
1616     /*
1617     if (!ap_suexec_enabled) {
1618         if (!ap_can_exec(&r->finfo))
1619             return log_scripterror(r, conf, HTTP_FORBIDDEN, 0, APLOGNO(01267)
1620                                    "file permissions deny server execution");
1621     }
1622     */
1623
1624 #ifdef HAVE_CGID_FDPASSING
1625     rv = apr_file_pipe_create(&script_err, &errpipe_out, r->pool);
1626     if (rv) {
1627         return log_scripterror(r, conf, HTTP_SERVICE_UNAVAILABLE, rv, APLOGNO(10176)
1628                                "could not create pipe for stderr");
1629     }
1630 #else
1631     script_err = NULL;
1632     errpipe_out = NULL;
1633 #endif
1634     
1635     /*
1636      * httpd core function used to add common environment variables like
1637      * DOCUMENT_ROOT. 
1638      */
1639     ap_add_common_vars(r);
1640     ap_add_cgi_vars(r);
1641     env = ap_create_environment(r->pool, r->subprocess_env);
1642
1643     if ((retval = connect_to_daemon(&sd, r, conf)) != OK) {
1644         return retval;
1645     }
1646
1647     rv = send_req(sd, errpipe_out, r, argv0, env, CGI_REQ);
1648     if (rv != APR_SUCCESS) {
1649         ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01268)
1650                      "write to cgi daemon process");
1651     }
1652
1653     /* The write-end of the pipe is only used by the server, so close
1654      * it here. */
1655     if (errpipe_out) apr_file_close(errpipe_out);
1656     
1657     info = apr_palloc(r->pool, sizeof(struct cleanup_script_info));
1658     info->conf = conf;
1659     info->r = r;
1660     rv = get_cgi_pid(r, conf, &(info->pid));
1661
1662     if (APR_SUCCESS == rv){  
1663         apr_pool_cleanup_register(r->pool, info,
1664                               cleanup_script,
1665                               apr_pool_cleanup_null);
1666     }
1667     else { 
1668         ap_log_rerror(APLOG_MARK, APLOG_DEBUG, rv, r, "error determining cgi PID");
1669     }
1670
1671     /* We are putting the socket discriptor into an apr_file_t so that we can
1672      * use a pipe bucket to send the data to the client.  APR will create
1673      * a cleanup for the apr_file_t which will close the socket, so we'll
1674      * get rid of the cleanup we registered when we created the socket.
1675      */
1676
1677     apr_os_pipe_put_ex(&tempsock, &sd, 1, r->pool);
1678     apr_file_pipe_timeout_set(tempsock, timeout);
1679     apr_pool_cleanup_kill(r->pool, (void *)((long)sd), close_unix_socket);
1680
1681     /* Transfer any put/post args, CERN style...
1682      * Note that we already ignore SIGPIPE in the core server.
1683      */
1684     bb = apr_brigade_create(r->pool, r->connection->bucket_alloc);
1685     seen_eos = 0;
1686     child_stopped_reading = 0;
1687     dbuf = NULL;
1688     dbpos = 0;
1689     if (conf->logname) {
1690         dbuf = apr_palloc(r->pool, conf->bufbytes + 1);
1691     }
1692     do {
1693         apr_bucket *bucket;
1694
1695         rv = ap_get_brigade(r->input_filters, bb, AP_MODE_READBYTES,
1696                             APR_BLOCK_READ, HUGE_STRING_LEN);
1697
1698         if (rv != APR_SUCCESS) {
1699             ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01270)
1700                           "Error reading request entity data");
1701             return ap_map_http_request_error(rv, HTTP_BAD_REQUEST);
1702         }
1703
1704         for (bucket = APR_BRIGADE_FIRST(bb);
1705              bucket != APR_BRIGADE_SENTINEL(bb);
1706              bucket = APR_BUCKET_NEXT(bucket))
1707         {
1708             const char *data;
1709             apr_size_t len;
1710
1711             if (APR_BUCKET_IS_EOS(bucket)) {
1712                 seen_eos = 1;
1713                 break;
1714             }
1715
1716             /* We can't do much with this. */
1717             if (APR_BUCKET_IS_FLUSH(bucket)) {
1718                 continue;
1719             }
1720
1721             /* If the child stopped, we still must read to EOS. */
1722             if (child_stopped_reading) {
1723                 continue;
1724             }
1725
1726             /* read */
1727             apr_bucket_read(bucket, &data, &len, APR_BLOCK_READ);
1728
1729             if (conf->logname && dbpos < conf->bufbytes) {
1730                 int cursize;
1731
1732                 if ((dbpos + len) > conf->bufbytes) {
1733                     cursize = conf->bufbytes - dbpos;
1734                 }
1735                 else {
1736                     cursize = len;
1737                 }
1738                 memcpy(dbuf + dbpos, data, cursize);
1739                 dbpos += cursize;
1740             }
1741
1742             /* Keep writing data to the child until done or too much time
1743              * elapses with no progress or an error occurs.
1744              */
1745             rv = apr_file_write_full(tempsock, data, len, NULL);
1746
1747             if (rv != APR_SUCCESS) {
1748                 /* silly script stopped reading, soak up remaining message */
1749                 child_stopped_reading = 1;
1750                 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,  APLOGNO(02651)
1751                               "Error writing request body to script %s", 
1752                               r->filename);
1753
1754             }
1755         }
1756         apr_brigade_cleanup(bb);
1757     }
1758     while (!seen_eos);
1759
1760     if (conf->logname) {
1761         dbuf[dbpos] = '\0';
1762     }
1763
1764     /* we're done writing, or maybe we didn't write at all;
1765      * force EOF on child's stdin so that the cgi detects end (or
1766      * absence) of data
1767      */
1768     shutdown(sd, 1);
1769
1770     bb = apr_brigade_create(r->pool, c->bucket_alloc);
1771 #ifdef HAVE_CGID_FDPASSING
1772     b = cgi_bucket_create(r, dc->timeout, tempsock, script_err, c->bucket_alloc);
1773     if (b == NULL)
1774         return HTTP_INTERNAL_SERVER_ERROR; /* should call log_scripterror() w/ _UNAVAILABLE? */
1775 #else
1776     b = apr_bucket_pipe_create(tempsock, c->bucket_alloc);
1777 #endif
1778     APR_BRIGADE_INSERT_TAIL(bb, b);
1779     b = apr_bucket_eos_create(c->bucket_alloc);
1780     APR_BRIGADE_INSERT_TAIL(bb, b);
1781
1782     /* Handle script return... */
1783     if (!nph) {
1784         const char *location;
1785         char sbuf[MAX_STRING_LEN];
1786         int ret;
1787
1788         if ((ret = ap_scan_script_header_err_brigade_ex(r, bb, sbuf,
1789                                                         APLOG_MODULE_INDEX)))
1790         {
1791             ret = log_script(r, conf, ret, dbuf, sbuf, bb, script_err);
1792
1793             /*
1794              * ret could be HTTP_NOT_MODIFIED in the case that the CGI script
1795              * does not set an explicit status and ap_meets_conditions, which
1796              * is called by ap_scan_script_header_err_brigade, detects that
1797              * the conditions of the requests are met and the response is
1798              * not modified.
1799              * In this case set r->status and return OK in order to prevent
1800              * running through the error processing stack as this would
1801              * break with mod_cache, if the conditions had been set by
1802              * mod_cache itself to validate a stale entity.
1803              * BTW: We circumvent the error processing stack anyway if the
1804              * CGI script set an explicit status code (whatever it is) and
1805              * the only possible values for ret here are:
1806              *
1807              * HTTP_NOT_MODIFIED          (set by ap_meets_conditions)
1808              * HTTP_PRECONDITION_FAILED   (set by ap_meets_conditions)
1809              * HTTP_INTERNAL_SERVER_ERROR (if something went wrong during the
1810              * processing of the response of the CGI script, e.g broken headers
1811              * or a crashed CGI process).
1812              */
1813             if (ret == HTTP_NOT_MODIFIED) {
1814                 r->status = ret;
1815                 return OK;
1816             }
1817
1818             return ret;
1819         }
1820
1821         location = apr_table_get(r->headers_out, "Location");
1822
1823         if (location && location[0] == '/' && r->status == 200) {
1824
1825             /* Soak up all the script output */
1826             discard_script_output(bb);
1827             apr_brigade_destroy(bb);
1828             if (script_err) {
1829                 apr_file_pipe_timeout_set(script_err, timeout);
1830                 log_script_err(r, script_err);
1831             }
1832             
1833             /* This redirect needs to be a GET no matter what the original
1834              * method was.
1835              */
1836             r->method = "GET";
1837             r->method_number = M_GET;
1838
1839             /* We already read the message body (if any), so don't allow
1840              * the redirected request to think it has one. We can ignore
1841              * Transfer-Encoding, since we used REQUEST_CHUNKED_ERROR.
1842              */
1843             apr_table_unset(r->headers_in, "Content-Length");
1844
1845             ap_internal_redirect_handler(location, r);
1846             return OK;
1847         }
1848         else if (location && r->status == 200) {
1849             /* XXX: Note that if a script wants to produce its own Redirect
1850              * body, it now has to explicitly *say* "Status: 302"
1851              */
1852             discard_script_output(bb);
1853             apr_brigade_destroy(bb);
1854             return HTTP_MOVED_TEMPORARILY;
1855         }
1856
1857         rv = ap_pass_brigade(r->output_filters, bb);
1858         if (rv != APR_SUCCESS) { 
1859             ap_log_rerror(APLOG_MARK, APLOG_TRACE1, rv, r,
1860                           "Failed to flush CGI output to client");
1861         }
1862     }
1863
1864     if (nph) {
1865         struct ap_filter_t *cur;
1866
1867         /* get rid of all filters up through protocol...  since we
1868          * haven't parsed off the headers, there is no way they can
1869          * work
1870          */
1871
1872         cur = r->proto_output_filters;
1873         while (cur && cur->frec->ftype < AP_FTYPE_CONNECTION) {
1874             cur = cur->next;
1875         }
1876         r->output_filters = r->proto_output_filters = cur;
1877
1878         rv = ap_pass_brigade(r->output_filters, bb);
1879     }
1880
1881     /* don't soak up script output if errors occurred writing it
1882      * out...  otherwise, we prolong the life of the script when the
1883      * connection drops or we stopped sending output for some other
1884      * reason */
1885     if (script_err && rv == APR_SUCCESS && !r->connection->aborted) {
1886         apr_file_pipe_timeout_set(script_err, timeout);
1887         log_script_err(r, script_err);
1888     }
1889
1890     if (script_err) apr_file_close(script_err);
1891
1892     return OK; /* NOT r->status, even if it has changed. */
1893 }
1894
1895
1896
1897
1898 /*============================================================================
1899  *============================================================================
1900  * This is the beginning of the cgi filter code moved from mod_include. This
1901  *   is the code required to handle the "exec" SSI directive.
1902  *============================================================================
1903  *============================================================================*/
1904 static apr_status_t include_cgi(include_ctx_t *ctx, ap_filter_t *f,
1905                                 apr_bucket_brigade *bb, char *s)
1906 {
1907     request_rec *r = f->r;
1908     request_rec *rr = ap_sub_req_lookup_uri(s, r, f->next);
1909     int rr_status;
1910
1911     if (rr->status != HTTP_OK) {
1912         ap_destroy_sub_req(rr);
1913         return APR_EGENERAL;
1914     }
1915
1916     /* No hardwired path info or query allowed */
1917     if ((rr->path_info && rr->path_info[0]) || rr->args) {
1918         ap_destroy_sub_req(rr);
1919         return APR_EGENERAL;
1920     }
1921     if (rr->finfo.filetype != APR_REG) {
1922         ap_destroy_sub_req(rr);
1923         return APR_EGENERAL;
1924     }
1925
1926     /* Script gets parameters of the *document*, for back compatibility */
1927     rr->path_info = r->path_info;       /* hard to get right; see mod_cgi.c */
1928     rr->args = r->args;
1929
1930     /* Force sub_req to be treated as a CGI request, even if ordinary
1931      * typing rules would have called it something else.
1932      */
1933     ap_set_content_type(rr, CGI_MAGIC_TYPE);
1934
1935     /* Run it. */
1936     rr_status = ap_run_sub_req(rr);
1937     if (ap_is_HTTP_REDIRECT(rr_status)) {
1938         const char *location = apr_table_get(rr->headers_out, "Location");
1939
1940         if (location) {
1941             char *buffer;
1942
1943             location = ap_escape_html(rr->pool, location);
1944             buffer = apr_pstrcat(ctx->pool, "<a href=\"", location, "\">",
1945                                  location, "</a>", NULL);
1946
1947             APR_BRIGADE_INSERT_TAIL(bb, apr_bucket_pool_create(buffer,
1948                                     strlen(buffer), ctx->pool,
1949                                     f->c->bucket_alloc));
1950         }
1951     }
1952
1953     ap_destroy_sub_req(rr);
1954
1955     return APR_SUCCESS;
1956 }
1957
1958 /* This is the special environment used for running the "exec cmd="
1959  *   variety of SSI directives.
1960  */
1961 static void add_ssi_vars(request_rec *r)
1962 {
1963     apr_table_t *e = r->subprocess_env;
1964
1965     if (r->path_info && r->path_info[0] != '\0') {
1966         request_rec *pa_req;
1967
1968         apr_table_setn(e, "PATH_INFO", ap_escape_shell_cmd(r->pool, r->path_info));
1969
1970         pa_req = ap_sub_req_lookup_uri(ap_escape_uri(r->pool, r->path_info), r, NULL);
1971         if (pa_req->filename) {
1972             apr_table_setn(e, "PATH_TRANSLATED",
1973                            apr_pstrcat(r->pool, pa_req->filename, pa_req->path_info, NULL));
1974         }
1975         ap_destroy_sub_req(pa_req);
1976     }
1977
1978     if (r->args) {
1979         char *arg_copy = apr_pstrdup(r->pool, r->args);
1980
1981         apr_table_setn(e, "QUERY_STRING", r->args);
1982         ap_unescape_url(arg_copy);
1983         apr_table_setn(e, "QUERY_STRING_UNESCAPED", ap_escape_shell_cmd(r->pool, arg_copy));
1984     }
1985 }
1986
1987 static int include_cmd(include_ctx_t *ctx, ap_filter_t *f,
1988                        apr_bucket_brigade *bb, char *command)
1989 {
1990     char **env;
1991     int sd;
1992     int retval;
1993     apr_file_t *tempsock = NULL;
1994     request_rec *r = f->r;
1995     cgid_server_conf *conf = ap_get_module_config(r->server->module_config,
1996                                                   &cgid_module);
1997     cgid_dirconf *dc = ap_get_module_config(r->per_dir_config, &cgid_module);
1998
1999     struct cleanup_script_info *info;
2000     apr_status_t rv;
2001
2002     add_ssi_vars(r);
2003     env = ap_create_environment(r->pool, r->subprocess_env);
2004
2005     if ((retval = connect_to_daemon(&sd, r, conf)) != OK) {
2006         return retval;
2007     }
2008
2009     send_req(sd, NULL, r, command, env, SSI_REQ);
2010
2011     info = apr_palloc(r->pool, sizeof(struct cleanup_script_info));
2012     info->conf = conf;
2013     info->r = r;
2014     rv = get_cgi_pid(r, conf, &(info->pid));
2015     if (APR_SUCCESS == rv) {             
2016         /* for this type of request, the script is invoked through an
2017          * intermediate shell process...  cleanup_script is only able
2018          * to knock out the shell process, not the actual script
2019          */
2020         apr_pool_cleanup_register(r->pool, info,
2021                                   cleanup_script,
2022                                   apr_pool_cleanup_null);
2023     }
2024     else { 
2025         ap_log_rerror(APLOG_MARK, APLOG_DEBUG, rv, r, "error determining cgi PID (for SSI)");
2026     }
2027
2028     apr_pool_cleanup_register(r->pool, info,
2029                               cleanup_script,
2030                               apr_pool_cleanup_null);
2031
2032     /* We are putting the socket discriptor into an apr_file_t so that we can
2033      * use a pipe bucket to send the data to the client.  APR will create
2034      * a cleanup for the apr_file_t which will close the socket, so we'll
2035      * get rid of the cleanup we registered when we created the socket.
2036      */
2037     apr_os_pipe_put_ex(&tempsock, &sd, 1, r->pool);
2038     if (dc->timeout > 0) {
2039         apr_file_pipe_timeout_set(tempsock, dc->timeout);
2040     }
2041     else {
2042         apr_file_pipe_timeout_set(tempsock, r->server->timeout);
2043     }
2044
2045     apr_pool_cleanup_kill(r->pool, (void *)((long)sd), close_unix_socket);
2046
2047     APR_BRIGADE_INSERT_TAIL(bb, apr_bucket_pipe_create(tempsock,
2048                             f->c->bucket_alloc));
2049     ctx->flush_now = 1;
2050
2051     return APR_SUCCESS;
2052 }
2053
2054 static apr_status_t handle_exec(include_ctx_t *ctx, ap_filter_t *f,
2055                                 apr_bucket_brigade *bb)
2056 {
2057     char *tag     = NULL;
2058     char *tag_val = NULL;
2059     request_rec *r = f->r;
2060     char *file = r->filename;
2061     char parsed_string[MAX_STRING_LEN];
2062
2063     if (!ctx->argc) {
2064         ap_log_rerror(APLOG_MARK,
2065                       (ctx->flags & SSI_FLAG_PRINTING)
2066                           ? APLOG_ERR : APLOG_WARNING,
2067                       0, r, APLOGNO(03196)
2068                       "missing argument for exec element in %s", r->filename);
2069     }
2070
2071     if (!(ctx->flags & SSI_FLAG_PRINTING)) {
2072         return APR_SUCCESS;
2073     }
2074
2075     if (!ctx->argc) {
2076         SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
2077         return APR_SUCCESS;
2078     }
2079
2080     if (ctx->flags & SSI_FLAG_NO_EXEC) {
2081         ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01271) "exec used but not allowed "
2082                       "in %s", r->filename);
2083         SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
2084         return APR_SUCCESS;
2085     }
2086
2087     while (1) {
2088         cgid_pfn_gtv(ctx, &tag, &tag_val, SSI_VALUE_DECODED);
2089         if (!tag || !tag_val) {
2090             break;
2091         }
2092
2093         if (!strcmp(tag, "cmd")) {
2094             apr_status_t rv;
2095
2096             cgid_pfn_ps(ctx, tag_val, parsed_string, sizeof(parsed_string),
2097                         SSI_EXPAND_LEAVE_NAME);
2098
2099             rv = include_cmd(ctx, f, bb, parsed_string);
2100             if (rv != APR_SUCCESS) {
2101                 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01272)
2102                               "execution failure for parameter \"%s\" "
2103                               "to tag exec in file %s", tag, r->filename);
2104                 SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
2105                 break;
2106             }
2107         }
2108         else if (!strcmp(tag, "cgi")) {
2109             apr_status_t rv;
2110
2111             cgid_pfn_ps(ctx, tag_val, parsed_string, sizeof(parsed_string),
2112                         SSI_EXPAND_DROP_NAME);
2113
2114             rv = include_cgi(ctx, f, bb, parsed_string);
2115             if (rv != APR_SUCCESS) {
2116                 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01273) "invalid CGI ref "
2117                               "\"%s\" in %s", tag_val, file);
2118                 SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
2119                 break;
2120             }
2121         }
2122         else {
2123             ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01274) "unknown parameter "
2124                           "\"%s\" to tag exec in %s", tag, file);
2125             SSI_CREATE_ERROR_BUCKET(ctx, f, bb);
2126             break;
2127         }
2128     }
2129
2130     return APR_SUCCESS;
2131 }
2132 /*============================================================================
2133  *============================================================================
2134  * This is the end of the cgi filter code moved from mod_include.
2135  *============================================================================
2136  *============================================================================*/
2137
2138
2139 static void register_hook(apr_pool_t *p)
2140 {
2141     static const char * const aszPre[] = { "mod_include.c", NULL };
2142
2143     ap_hook_pre_config(cgid_pre_config, NULL, NULL, APR_HOOK_MIDDLE);
2144     ap_hook_post_config(cgid_init, aszPre, NULL, APR_HOOK_MIDDLE);
2145     ap_hook_handler(cgid_handler, NULL, NULL, APR_HOOK_MIDDLE);
2146 }
2147
2148 AP_DECLARE_MODULE(cgid) = {
2149     STANDARD20_MODULE_STUFF,
2150     create_cgid_dirconf, /* dir config creater */
2151     NULL, /* dir merger --- default is to override */
2152     create_cgid_config, /* server config */
2153     merge_cgid_config, /* merge server config */
2154     cgid_cmds, /* command table */
2155     register_hook /* register_handlers */
2156 };
2157