Suport Non Parsed Headers (nph)
[mod_fastcgi.git] / fcgi_config.c
blob2cd11f16311c90918b62c06b1a51cd234015f7bf
1 /*
2 * $Id: fcgi_config.c,v 1.50 2004/01/07 01:56:00 robs Exp $
3 */
5 #define CORE_PRIVATE
6 #include "fcgi.h"
8 #ifdef APACHE2
10 #include <limits.h>
11 #include "mpm_common.h" /* ap_uname2id, ap_gname2id */
13 #ifdef WIN32
14 #include <direct.h>
15 #else
16 #include <unistd.h>
17 #include "unixd.h"
18 #endif
20 #endif
22 #ifdef WIN32
23 /* warning C4100: unreferenced formal parameter */
24 /* warning C4706: assignment within conditional expression */
25 #pragma warning( disable : 4100 4706 )
26 #endif
28 /*******************************************************************************
29 * Get the next configuration directive argument, & return an in_addr and port.
30 * The arg must be in the form "host:port" where host can be an IP or hostname.
31 * The pool arg should be persistant storage.
33 static const char *get_host_n_port(pool *p, const char **arg,
34 const char **host, u_short *port)
36 char *cvptr, *portStr;
37 long tmp;
39 *host = ap_getword_conf(p, arg);
40 if (**host == '\0')
41 return "\"\"";
43 portStr = strchr(*host, ':');
44 if (portStr == NULL)
45 return "missing port specification";
47 /* Split the host and port portions */
48 *portStr++ = '\0';
50 /* Convert port number */
51 tmp = (u_short) strtol(portStr, &cvptr, 10);
52 if (*cvptr != '\0' || tmp < 1 || tmp > USHRT_MAX)
53 return ap_pstrcat(p, "bad port number \"", portStr, "\"", NULL);
55 *port = (unsigned short) tmp;
57 return NULL;
60 /*******************************************************************************
61 * Get the next configuration directive argument, & return an u_short.
62 * The pool arg should be temporary storage.
64 static const char *get_u_short(pool *p, const char **arg,
65 u_short *num, u_short min)
67 char *ptr;
68 long tmp;
69 const char *txt = ap_getword_conf(p, arg);
71 if (*txt == '\0') {
72 return "\"\"";
75 tmp = strtol(txt, &ptr, 10);
77 if (*ptr != '\0') {
78 return ap_pstrcat(p, "\"", txt, "\" must be a positive integer", NULL);
81 if (tmp < min || tmp > USHRT_MAX) {
82 return ap_psprintf(p, "\"%u\" must be >= %u and < %u", *num, min, USHRT_MAX);
85 *num = (u_short) tmp;
87 return NULL;
90 static const char *get_int(pool *p, const char **arg, int *num, int min)
92 char *cp;
93 const char *val = ap_getword_conf(p, arg);
95 if (*val == '\0')
97 return "\"\"";
100 *num = (int) strtol(val, &cp, 10);
102 if (*cp != '\0')
104 return ap_pstrcat(p, "can't parse ", "\"", val, "\"", NULL);
106 else if (*num < min)
108 return ap_psprintf(p, "\"%d\" must be >= %d", *num, min);
111 return NULL;
114 /*******************************************************************************
115 * Get the next configuration directive argument, & return an u_int.
116 * The pool arg should be temporary storage.
118 static const char *get_u_int(pool *p, const char **arg,
119 u_int *num, u_int min)
121 char *ptr;
122 const char *val = ap_getword_conf(p, arg);
124 if (*val == '\0')
125 return "\"\"";
126 *num = (u_int)strtol(val, &ptr, 10);
128 if (*ptr != '\0')
129 return ap_pstrcat(p, "\"", val, "\" must be a positive integer", NULL);
130 else if (*num < min)
131 return ap_psprintf(p, "\"%u\" must be >= %u", *num, min);
132 return NULL;
135 /*******************************************************************************
136 * Get the next configuration directive argument, & return a float.
137 * The pool arg should be temporary storage.
139 static const char *get_float(pool *p, const char **arg,
140 float *num, float min, float max)
142 char *ptr;
143 const char *val = ap_getword_conf(p, arg);
145 if (*val == '\0')
146 return "\"\"";
147 *num = (float) strtod(val, &ptr);
149 if (*ptr != '\0')
150 return ap_pstrcat(p, "\"", val, "\" is not a floating point number", NULL);
151 if (*num < min || *num > max)
152 return ap_psprintf(p, "\"%f\" is not between %f and %f", *num, min, max);
153 return NULL;
156 const char *fcgi_config_set_env_var(pool *p, char **envp, unsigned int *envc, char * var)
158 if (*envc >= MAX_INIT_ENV_VARS) {
159 return "too many variables, must be <= MAX_INIT_ENV_VARS";
162 if (strchr(var, '=') == NULL) {
163 *(envp + *envc) = ap_pstrcat(p, var, "=", getenv(var), NULL);
165 else {
166 *(envp + *envc) = var;
169 (*envc)++;
171 return NULL;
174 /*******************************************************************************
175 * Get the next configuration directive argument, & add it to an env array.
176 * The pool arg should be permanent storage.
178 static const char *get_env_var(pool *p, const char **arg, char **envp, unsigned int *envc)
180 char * const val = ap_getword_conf(p, arg);
182 if (*val == '\0') {
183 return "\"\"";
186 return fcgi_config_set_env_var(p, envp, envc, val);
189 static const char *get_pass_header(pool *p, const char **arg, array_header **array)
191 const char **header;
193 if (!*array) {
194 *array = ap_make_array(p, 10, sizeof(char*));
197 header = (const char **)ap_push_array(*array);
198 *header = ap_getword_conf(p, arg);
200 return header ? NULL : "\"\"";
203 /*******************************************************************************
204 * Return a "standard" message for common configuration errors.
206 static const char *invalid_value(pool *p, const char *cmd, const char *id,
207 const char *opt, const char *err)
209 return ap_psprintf(p, "%s%s%s: invalid value for %s: %s",
210 cmd, id ? " " : "", id ? id : "", opt, err);
213 /*******************************************************************************
214 * Set/Reset the uid/gid that Apache and the PM will run as. This is ap_user_id
215 * and ap_group_id if we're started as root, and euid/egid otherwise. Also try
216 * to check that the config files don't set the User/Group after a FastCGI
217 * directive is used that depends on it.
219 /*@@@ To be complete, we should save a handle to the server each AppClass is
220 * configured in and at init() check that the user/group is still what we
221 * thought it was. Also the other directives should only be allowed in the
222 * parent Apache server.
224 const char *fcgi_config_set_fcgi_uid_n_gid(int set)
226 static int isSet = 0;
228 #ifndef WIN32
230 uid_t uid = geteuid();
231 gid_t gid = getegid();
233 if (set == 0) {
234 isSet = 0;
235 fcgi_user_id = (uid_t)-1;
236 fcgi_group_id = (gid_t)-1;
237 return NULL;
240 if (uid == 0) {
241 uid = ap_user_id;
244 if (gid == 0) {
245 gid = ap_group_id;
248 if (isSet && (uid != fcgi_user_id || gid != fcgi_group_id)) {
249 return "User/Group commands must preceed FastCGI server definitions";
252 isSet = 1;
253 fcgi_user_id = uid;
254 fcgi_group_id = gid;
256 #endif /* !WIN32 */
258 return NULL;
261 apcb_t fcgi_config_reset_globals(void* dummy)
263 fcgi_config_pool = NULL;
264 fcgi_servers = NULL;
265 fcgi_config_set_fcgi_uid_n_gid(0);
266 fcgi_wrapper = NULL;
267 fcgi_socket_dir = NULL;
269 fcgi_dynamic_total_proc_count = 0;
270 fcgi_dynamic_epoch = 0;
271 fcgi_dynamic_last_analyzed = 0;
273 dynamicMaxProcs = FCGI_DEFAULT_MAX_PROCS;
274 dynamicMinProcs = FCGI_DEFAULT_MIN_PROCS;
275 dynamicMaxClassProcs = FCGI_DEFAULT_MAX_CLASS_PROCS;
276 dynamicKillInterval = FCGI_DEFAULT_KILL_INTERVAL;
277 dynamicUpdateInterval = FCGI_DEFAULT_UPDATE_INTERVAL;
278 dynamicGain = FCGI_DEFAULT_GAIN;
279 dynamicThreshold1 = FCGI_DEFAULT_THRESHOLD_1;
280 dynamicThresholdN = FCGI_DEFAULT_THRESHOLD_N;
281 dynamicPleaseStartDelay = FCGI_DEFAULT_START_PROCESS_DELAY;
282 dynamicAppConnectTimeout = FCGI_DEFAULT_APP_CONN_TIMEOUT;
283 dynamicEnvp = &fcgi_empty_env;
284 dynamicProcessSlack = FCGI_DEFAULT_PROCESS_SLACK;
285 dynamicAutoRestart = FCGI_DEFAULT_RESTART_DYNAMIC;
286 dynamicAutoUpdate = FCGI_DEFAULT_AUTOUPDATE;
287 dynamicListenQueueDepth = FCGI_DEFAULT_LISTEN_Q;
288 dynamicInitStartDelay = DEFAULT_INIT_START_DELAY;
289 dynamicRestartDelay = FCGI_DEFAULT_RESTART_DELAY;
290 dynamicMinServerLife = FCGI_DEFAULT_MIN_SERVER_LIFE;
291 dynamic_pass_headers = NULL;
292 dynamic_idle_timeout = FCGI_DEFAULT_IDLE_TIMEOUT;
293 dynamicFlush = FCGI_FLUSH;
295 #ifndef WIN32
296 /* Close any old pipe (HUP/USR1) */
297 if (fcgi_pm_pipe[0] != -1) {
298 close(fcgi_pm_pipe[0]);
299 fcgi_pm_pipe[0] = -1;
301 if (fcgi_pm_pipe[1] != -1) {
302 close(fcgi_pm_pipe[1]);
303 fcgi_pm_pipe[1] = -1;
305 #endif
307 return APCB_OK;
310 /*******************************************************************************
311 * Create a directory to hold Unix/Domain sockets.
313 const char *fcgi_config_make_dir(pool *tp, char *path)
315 struct stat finfo;
316 const char *err = NULL;
318 /* Is the directory spec'd correctly */
319 if (*path != '/') {
320 return "path is not absolute (it must start with a \"/\")";
322 else {
323 int i = strlen(path) - 1;
325 /* Strip trailing "/"s */
326 while(i > 0 && path[i] == '/') path[i--] = '\0';
329 /* Does it exist? */
330 if (stat(path, &finfo) != 0) {
331 /* No, but maybe we can create it */
332 #ifdef WIN32
333 if (mkdir(path) != 0)
334 #else
335 if (mkdir(path, S_IRWXU) != 0)
336 #endif
338 return ap_psprintf(tp,
339 "doesn't exist and can't be created: %s",
340 strerror(errno));
343 #ifndef WIN32
344 /* If we're root, we're gonna setuid/setgid so we need to chown */
345 if (geteuid() == 0 && chown(path, ap_user_id, ap_group_id) != 0) {
346 return ap_psprintf(tp,
347 "can't chown() to the server (uid %ld, gid %ld): %s",
348 (long)ap_user_id, (long)ap_group_id, strerror(errno));
350 #endif
352 else {
353 /* Yes, is it a directory? */
354 if (!S_ISDIR(finfo.st_mode))
355 return "isn't a directory!";
357 /* Can we RWX in there? */
358 #ifdef WIN32
359 err = fcgi_util_check_access(tp, NULL, &finfo, _S_IREAD | _S_IWRITE | _S_IEXEC, fcgi_user_id, fcgi_group_id);
360 #else
361 err = fcgi_util_check_access(tp, NULL, &finfo, R_OK | W_OK | X_OK,
362 fcgi_user_id, fcgi_group_id);
363 #endif
364 if (err != NULL) {
365 return ap_psprintf(tp,
366 "access for server (uid %ld, gid %ld) failed: %s",
367 (long)fcgi_user_id, (long)fcgi_group_id, err);
370 return NULL;
373 /*******************************************************************************
374 * Create a "dynamic" subdirectory. If the directory
375 * already exists we don't mess with it unless 'wax' is set.
377 #ifndef WIN32
378 const char *fcgi_config_make_dynamic_dir(pool *p, const int wax)
380 const char *err;
381 pool *tp;
383 fcgi_dynamic_dir = ap_pstrcat(p, fcgi_socket_dir, "/dynamic", NULL);
385 if ((err = fcgi_config_make_dir(p, fcgi_dynamic_dir)))
386 return ap_psprintf(p, "can't create dynamic directory \"%s\": %s", fcgi_dynamic_dir, err);
388 /* Don't step on a running server unless its OK. */
389 if (!wax)
390 return NULL;
392 #ifdef APACHE2
394 apr_dir_t * dir;
395 apr_finfo_t finfo;
397 if (apr_pool_create(&tp, p))
398 return "apr_pool_create() failed";
400 if (apr_dir_open(&dir, fcgi_dynamic_dir, tp))
401 return "apr_dir_open() failed";
403 /* delete the contents */
405 while (apr_dir_read(&finfo, APR_FINFO_NAME, dir) == APR_SUCCESS)
407 if (strcmp(finfo.name, ".") == 0 || strcmp(finfo.name, "..") == 0)
408 continue;
410 apr_file_remove(finfo.name, tp);
414 #else /* !APACHE2 */
416 DIR *dp;
417 struct dirent *dirp = NULL;
419 tp = ap_make_sub_pool(p);
421 dp = ap_popendir(tp, fcgi_dynamic_dir);
422 if (dp == NULL) {
423 ap_destroy_pool(tp);
424 return ap_psprintf(p, "can't open dynamic directory \"%s\": %s",
425 fcgi_dynamic_dir, strerror(errno));
428 /* delete the contents */
430 while ((dirp = readdir(dp)) != NULL)
432 if (strcmp(dirp->d_name, ".") == 0 || strcmp(dirp->d_name, "..") == 0)
433 continue;
435 unlink(ap_pstrcat(tp, fcgi_dynamic_dir, "/", dirp->d_name, NULL));
439 #endif /* !APACHE2 */
441 ap_destroy_pool(tp);
443 return NULL;
445 #endif
447 /*******************************************************************************
448 * Change the directory used for the Unix/Domain sockets from the default.
449 * Create the directory and the "dynamic" subdirectory.
451 const char *fcgi_config_set_socket_dir(cmd_parms *cmd, void *dummy, const char *arg)
453 pool * const tp = cmd->temp_pool;
454 const char * const name = cmd->cmd->name;
455 const char *err;
456 char * arg_nc;
458 err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
459 if (err)
461 return err;
464 if (fcgi_socket_dir) {
465 return ap_psprintf(tp, "%s %s: already defined as \"%s\"",
466 name, arg, fcgi_socket_dir);
469 err = fcgi_config_set_fcgi_uid_n_gid(1);
470 if (err != NULL)
471 return ap_psprintf(tp, "%s %s: %s", name, arg, err);
473 if (fcgi_servers != NULL) {
474 return ap_psprintf(tp,
475 "The %s command must preceed static FastCGI server definitions",
476 name);
479 arg_nc = ap_pstrdup(cmd->pool, arg);
481 #ifndef WIN32
483 #ifdef APACHE2
484 if (apr_filepath_merge(&arg_nc, "", arg, 0, cmd->pool))
485 return ap_psprintf(tp, "%s %s: invalid filepath", name, arg);
486 #else
487 arg_nc = ap_os_canonical_filename(cmd->pool, arg_nc);
488 #endif
490 arg_nc = ap_server_root_relative(cmd->pool, arg_nc);
492 #else /* WIN32 */
494 if (strncmp(arg_nc, "\\\\.\\pipe\\", 9) != 0)
495 return ap_psprintf(tp, "%s %s is invalid format",name, arg_nc);
497 #endif
499 fcgi_socket_dir = arg_nc;
501 #ifdef WIN32
502 fcgi_dynamic_dir = ap_pstrcat(cmd->pool, fcgi_socket_dir, "dynamic", NULL);
503 #else
504 err = fcgi_config_make_dir(tp, fcgi_socket_dir);
505 if (err != NULL)
506 return ap_psprintf(tp, "%s %s: %s", name, arg_nc, err);
508 err = fcgi_config_make_dynamic_dir(cmd->pool, 0);
509 if (err != NULL)
510 return ap_psprintf(tp, "%s %s: %s", name, arg_nc, err);
511 #endif
513 return NULL;
516 /*******************************************************************************
517 * Enable, disable, or specify the path to a wrapper used to invoke all
518 * FastCGI applications.
520 const char *fcgi_config_set_wrapper(cmd_parms *cmd, void *dummy, const char *arg)
522 #ifdef WIN32
523 return ap_psprintf(cmd->temp_pool,
524 "the %s directive is not supported on WIN", cmd->cmd->name);
525 #else
527 const char *err = NULL;
528 const char * const name = cmd->cmd->name;
529 pool * const tp = cmd->temp_pool;
530 char * wrapper = NULL;
532 err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
533 if (err)
535 return err;
538 if (fcgi_wrapper)
540 return ap_psprintf(tp, "%s was already set to \"%s\"",
541 name, fcgi_wrapper);
544 err = fcgi_config_set_fcgi_uid_n_gid(1);
545 if (err != NULL)
546 return ap_psprintf(tp, "%s %s: %s", name, arg, err);
548 if (fcgi_servers != NULL) {
549 return ap_psprintf(tp,
550 "The %s command must preceed static FastCGI server definitions", name);
553 if (strcasecmp(arg, "Off") == 0) {
554 fcgi_wrapper = NULL;
555 return NULL;
558 if (strcasecmp(arg, "On") == 0)
560 wrapper = SUEXEC_BIN;
562 else
564 #ifdef APACHE2
565 if (apr_filepath_merge(&wrapper, "", arg, 0, cmd->pool))
566 return ap_psprintf(tp, "%s %s: invalid filepath", name, arg);
567 #else
568 wrapper = ap_os_canonical_filename(cmd->pool, (char *) arg);
569 #endif
571 wrapper = ap_server_root_relative(cmd->pool, wrapper);
574 err = fcgi_util_check_access(tp, wrapper, NULL, X_OK, fcgi_user_id, fcgi_group_id);
575 if (err)
577 return ap_psprintf(tp, "%s: \"%s\" execute access for server "
578 "(uid %ld, gid %ld) failed: %s", name, wrapper,
579 (long) fcgi_user_id, (long) fcgi_group_id, err);
582 fcgi_wrapper = wrapper;
584 return NULL;
585 #endif /* !WIN32 */
588 /*******************************************************************************
589 * Configure a static FastCGI server.
591 const char *fcgi_config_new_static_server(cmd_parms *cmd, void *dummy, const char *arg)
593 fcgi_server *s;
594 pool *p = cmd->pool, *tp = cmd->temp_pool;
595 const char *name = cmd->cmd->name;
596 char *fs_path = ap_getword_conf(p, &arg);
597 const char *option, *err;
599 /* Allocate temp storage for the array of initial environment variables */
600 char **envp = ap_pcalloc(tp, sizeof(char *) * (MAX_INIT_ENV_VARS + 3));
601 unsigned int envc = 0;
603 #ifdef WIN32
604 HANDLE mutex;
605 #endif
607 err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
608 if (err)
610 return err;
613 if (*fs_path == '\0')
614 return "AppClass requires a pathname!?";
616 if ((err = fcgi_config_set_fcgi_uid_n_gid(1)) != NULL)
617 return ap_psprintf(tp, "%s %s: %s", name, fs_path, err);
619 #ifdef APACHE2
620 if (apr_filepath_merge(&fs_path, "", fs_path, 0, p))
621 return ap_psprintf(tp, "%s %s: invalid filepath", name, fs_path);
622 #else
623 fs_path = ap_os_canonical_filename(p, fs_path);
624 #endif
625 fs_path = ap_server_root_relative(p, fs_path);
627 ap_getparents(fs_path);
628 ap_no2slash(fs_path);
630 /* See if we've already got one of these configured */
631 s = fcgi_util_fs_get_by_id(fs_path, fcgi_util_get_server_uid(cmd->server),
632 fcgi_util_get_server_gid(cmd->server));
633 if (s != NULL) {
634 if (fcgi_wrapper) {
635 return ap_psprintf(tp,
636 "%s: redefinition of a previously defined FastCGI "
637 "server \"%s\" with uid=%ld and gid=%ld",
638 name, fs_path, (long) fcgi_util_get_server_uid(cmd->server),
639 (long) fcgi_util_get_server_gid(cmd->server));
641 else {
642 return ap_psprintf(tp,
643 "%s: redefinition of a previously defined FastCGI server \"%s\"",
644 name, fs_path);
648 err = fcgi_util_fs_is_path_ok(tp, fs_path, NULL);
649 if (err != NULL) {
650 return ap_psprintf(tp, "%s: \"%s\" %s", name, fs_path, err);
653 s = fcgi_util_fs_new(p);
654 s->fs_path = fs_path;
655 s->directive = APP_CLASS_STANDARD;
656 s->restartOnExit = TRUE;
657 s->numProcesses = 1;
659 #ifdef WIN32
661 /* TCP FastCGI applications require SystemRoot be present in the environment
662 * Put it in both for consistency to the application */
663 fcgi_config_set_env_var(p, envp, &envc, "SystemRoot");
665 mutex = CreateMutex(NULL, FALSE, fs_path);
667 if (mutex == NULL)
669 ap_log_error(FCGI_LOG_ALERT, fcgi_apache_main_server,
670 "FastCGI: CreateMutex() failed");
671 return "failed to create FastCGI application accept mutex";
674 SetHandleInformation(mutex, HANDLE_FLAG_INHERIT, TRUE);
676 s->mutex_env_string = ap_psprintf(p, "_FCGI_MUTEX_=%ld", mutex);
678 #endif
680 /* Parse directive arguments */
681 while (*arg) {
682 option = ap_getword_conf(tp, &arg);
684 if (strcasecmp(option, "-processes") == 0) {
685 if ((err = get_u_int(tp, &arg, &s->numProcesses, 1)))
686 return invalid_value(tp, name, fs_path, option, err);
688 else if (strcasecmp(option, "-restart-delay") == 0) {
689 if ((err = get_u_int(tp, &arg, &s->restartDelay, 0)))
690 return invalid_value(tp, name, fs_path, option, err);
692 else if (strcasecmp(option, "-init-start-delay") == 0) {
693 if ((err = get_int(tp, &arg, &s->initStartDelay, 0)))
694 return invalid_value(tp, name, fs_path, option, err);
696 else if (strcasecmp(option, "-min-server-life") == 0) {
697 if ((err = get_int(tp, &arg, &s->minServerLife, 0)))
698 return invalid_value(tp, name, NULL, option, err);
700 else if (strcasecmp(option, "-priority") == 0) {
701 if ((err = get_u_int(tp, &arg, &s->processPriority, 0)))
702 return invalid_value(tp, name, fs_path, option, err);
704 else if (strcasecmp(option, "-listen-queue-depth") == 0) {
705 if ((err = get_u_int(tp, &arg, &s->listenQueueDepth, 1)))
706 return invalid_value(tp, name, fs_path, option, err);
708 else if (strcasecmp(option, "-appConnTimeout") == 0) {
709 if ((err = get_u_int(tp, &arg, &s->appConnectTimeout, 0)))
710 return invalid_value(tp, name, fs_path, option, err);
712 else if (strcasecmp(option, "-idle-timeout") == 0) {
713 if ((err = get_u_int(tp, &arg, &s->idle_timeout, 1)))
714 return invalid_value(tp, name, fs_path, option, err);
716 else if (strcasecmp(option, "-port") == 0) {
717 if ((err = get_u_short(tp, &arg, &s->port, 1)))
718 return invalid_value(tp, name, fs_path, option, err);
720 else if (strcasecmp(option, "-socket") == 0) {
721 s->socket_path = ap_getword_conf(tp, &arg);
722 if (*s->socket_path == '\0')
723 return invalid_value(tp, name, fs_path, option, "\"\"");
725 else if (strcasecmp(option, "-initial-env") == 0) {
726 if ((err = get_env_var(p, &arg, envp, &envc)))
727 return invalid_value(tp, name, fs_path, option, err);
729 else if (strcasecmp(option, "-pass-header") == 0) {
730 if ((err = get_pass_header(p, &arg, &s->pass_headers)))
731 return invalid_value(tp, name, fs_path, option, err);
733 else if (strcasecmp(option, "-flush") == 0) {
734 s->flush = 1;
736 else if (strcasecmp(option, "-nph") == 0) {
737 s->nph = 1;
739 else if (strcasecmp(option, "-user") == 0) {
740 #ifdef WIN32
741 return ap_psprintf(tp,
742 "%s %s: the -user option isn't supported on WIN", name, fs_path);
743 #else
744 s->user = ap_getword_conf(tp, &arg);
745 if (*s->user == '\0')
746 return invalid_value(tp, name, fs_path, option, "\"\"");
747 #endif
749 else if (strcasecmp(option, "-group") == 0) {
750 #ifdef WIN32
751 return ap_psprintf(tp,
752 "%s %s: the -group option isn't supported on WIN", name, fs_path);
753 #else
754 s->group = ap_getword_conf(tp, &arg);
755 if (*s->group == '\0')
756 return invalid_value(tp, name, fs_path, option, "\"\"");
757 #endif
759 else {
760 return ap_psprintf(tp, "%s %s: invalid option: %s", name, fs_path, option);
762 } /* while */
764 #ifndef WIN32
765 if (fcgi_wrapper)
767 if (s->group == NULL)
769 s->group = ap_psprintf(tp, "#%ld", fcgi_util_get_server_gid(cmd->server));
772 if (s->user == NULL)
774 s->user = ap_psprintf(p, "#%ld", fcgi_util_get_server_uid(cmd->server));
777 s->uid = ap_uname2id(s->user);
778 s->gid = ap_gname2id(s->group);
780 else if (s->user || s->group)
782 ap_log_error(FCGI_LOG_WARN, cmd->server, "FastCGI: there is no "
783 "fastcgi wrapper set, user/group options are ignored");
786 if ((err = fcgi_util_fs_set_uid_n_gid(p, s, s->uid, s->gid)))
788 return ap_psprintf(tp,
789 "%s %s: invalid user or group: %s", name, fs_path, err);
791 #endif /* !WIN32 */
793 if (s->socket_path != NULL && s->port != 0) {
794 return ap_psprintf(tp,
795 "%s %s: -port and -socket are mutually exclusive options",
796 name, fs_path);
799 /* Move env array to a surviving pool */
800 s->envp = (char **)ap_pcalloc(p, sizeof(char *) * (envc + 4));
801 memcpy(s->envp, envp, sizeof(char *) * envc);
803 /* Initialize process structs */
804 s->procs = fcgi_util_fs_create_procs(p, s->numProcesses);
806 /* Build the appropriate sockaddr structure */
807 if (s->port != 0) {
808 err = fcgi_util_socket_make_inet_addr(p, (struct sockaddr_in **)&s->socket_addr,
809 &s->socket_addr_len, NULL, s->port);
810 if (err != NULL)
811 return ap_psprintf(tp, "%s %s: %s", name, fs_path, err);
812 #ifdef WIN32
813 err = fcgi_util_socket_make_inet_addr(p, (struct sockaddr_in **)&s->dest_addr,
814 &s->socket_addr_len, "localhost", s->port);
815 if (err != NULL)
816 return ap_psprintf(tp, "%s %s: %s", name, fs_path, err);
817 #endif
818 } else {
819 if (s->socket_path == NULL)
820 s->socket_path = fcgi_util_socket_hash_filename(tp, fs_path, s->user, s->group);
822 if (fcgi_socket_dir == NULL)
824 #ifdef WIN32
825 fcgi_socket_dir = DEFAULT_SOCK_DIR;
826 #else
827 fcgi_socket_dir = ap_server_root_relative(p, DEFAULT_SOCK_DIR);
828 #endif
831 s->socket_path = fcgi_util_socket_make_path_absolute(p, s->socket_path, 0);
832 #ifndef WIN32
833 err = fcgi_util_socket_make_domain_addr(p, (struct sockaddr_un **)&s->socket_addr,
834 &s->socket_addr_len, s->socket_path);
835 if (err != NULL)
836 return ap_psprintf(tp, "%s %s: %s", name, fs_path, err);
837 #endif
840 /* Add it to the list of FastCGI servers */
841 fcgi_util_fs_add(s);
843 return NULL;
846 /*******************************************************************************
847 * Configure a static FastCGI server that is started/managed elsewhere.
849 const char *fcgi_config_new_external_server(cmd_parms *cmd, void *dummy, const char *arg)
851 fcgi_server *s;
852 pool * const p = cmd->pool, *tp = cmd->temp_pool;
853 const char * const name = cmd->cmd->name;
854 char *fs_path = ap_getword_conf(p, &arg);
855 const char *option, *err;
857 err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
858 if (err)
860 return err;
863 if (!*fs_path) {
864 return ap_pstrcat(tp, name, " requires a path and either a -socket or -host option", NULL);
867 #ifdef APACHE2
868 if (apr_filepath_merge(&fs_path, "", fs_path, 0, p))
869 return ap_psprintf(tp, "%s %s: invalid filepath", name, fs_path);
870 #else
871 fs_path = ap_os_canonical_filename(p, fs_path);
872 #endif
874 fs_path = ap_server_root_relative(p, fs_path);
876 ap_getparents(fs_path);
877 ap_no2slash(fs_path);
879 /* See if we've already got one of these bettys configured */
880 s = fcgi_util_fs_get_by_id(fs_path, fcgi_util_get_server_uid(cmd->server),
881 fcgi_util_get_server_gid(cmd->server));
882 if (s != NULL) {
883 if (fcgi_wrapper) {
884 return ap_psprintf(tp,
885 "%s: redefinition of a previously defined class \"%s\" "
886 "with uid=%ld and gid=%ld",
887 name, fs_path, (long) fcgi_util_get_server_uid(cmd->server),
888 (long) fcgi_util_get_server_gid(cmd->server));
890 else
892 return ap_psprintf(tp,
893 "%s: redefinition of previously defined class \"%s\"", name, fs_path);
897 s = fcgi_util_fs_new(p);
898 s->fs_path = fs_path;
899 s->directive = APP_CLASS_EXTERNAL;
901 /* Parse directive arguments */
902 while (*arg != '\0') {
903 option = ap_getword_conf(tp, &arg);
905 if (strcasecmp(option, "-host") == 0) {
906 if ((err = get_host_n_port(p, &arg, &s->host, &s->port)))
907 return invalid_value(tp, name, fs_path, option, err);
909 else if (strcasecmp(option, "-socket") == 0) {
910 s->socket_path = ap_getword_conf(tp, &arg);
911 if (*s->socket_path == '\0')
912 return invalid_value(tp, name, fs_path, option, "\"\"");
914 else if (strcasecmp(option, "-appConnTimeout") == 0) {
915 if ((err = get_u_int(tp, &arg, &s->appConnectTimeout, 0)))
916 return invalid_value(tp, name, fs_path, option, err);
918 else if (strcasecmp(option, "-idle-timeout") == 0) {
919 if ((err = get_u_int(tp, &arg, &s->idle_timeout, 1)))
920 return invalid_value(tp, name, fs_path, option, err);
922 else if (strcasecmp(option, "-pass-header") == 0) {
923 if ((err = get_pass_header(p, &arg, &s->pass_headers)))
924 return invalid_value(tp, name, fs_path, option, err);
926 else if (strcasecmp(option, "-flush") == 0) {
927 s->flush = 1;
929 else if (strcasecmp(option, "-user") == 0) {
930 #ifdef WIN32
931 return ap_psprintf(tp,
932 "%s %s: the -user option isn't supported on WIN", name, fs_path);
933 #else
934 s->user = ap_getword_conf(tp, &arg);
935 if (*s->user == '\0')
936 return invalid_value(tp, name, fs_path, option, "\"\"");
937 #endif
939 else if (strcasecmp(option, "-group") == 0) {
940 #ifdef WIN32
941 return ap_psprintf(tp,
942 "%s %s: the -group option isn't supported on WIN", name, fs_path);
943 #else
944 s->group = ap_getword_conf(tp, &arg);
945 if (*s->group == '\0')
946 return invalid_value(tp, name, fs_path, option, "\"\"");
947 #endif
949 else {
950 return ap_psprintf(tp, "%s %s: invalid option: %s", name, fs_path, option);
952 } /* while */
955 #ifndef WIN32
956 if (fcgi_wrapper)
958 if (s->group == NULL)
960 s->group = ap_psprintf(tp, "#%ld", fcgi_util_get_server_gid(cmd->server));
963 if (s->user == NULL)
965 s->user = ap_psprintf(p, "#%ld", fcgi_util_get_server_uid(cmd->server));
968 s->uid = ap_uname2id(s->user);
969 s->gid = ap_gname2id(s->group);
971 else if (s->user || s->group)
973 ap_log_error(FCGI_LOG_WARN, cmd->server, "FastCGI: there is no "
974 "fastcgi wrapper set, user/group options are ignored");
977 if ((err = fcgi_util_fs_set_uid_n_gid(p, s, s->uid, s->gid)))
979 return ap_psprintf(tp,
980 "%s %s: invalid user or group: %s", name, fs_path, err);
982 #endif /* !WIN32 */
984 /* Require one of -socket or -host, but not both */
985 if (s->socket_path != NULL && s->port != 0) {
986 return ap_psprintf(tp,
987 "%s %s: -host and -socket are mutually exclusive options",
988 name, fs_path);
990 if (s->socket_path == NULL && s->port == 0) {
991 return ap_psprintf(tp,
992 "%s %s: -socket or -host option missing", name, fs_path);
995 /* Build the appropriate sockaddr structure */
996 if (s->port != 0) {
997 err = fcgi_util_socket_make_inet_addr(p, (struct sockaddr_in **)&s->socket_addr,
998 &s->socket_addr_len, s->host, s->port);
999 if (err != NULL)
1000 return ap_psprintf(tp, "%s %s: %s", name, fs_path, err);
1001 } else {
1003 if (fcgi_socket_dir == NULL)
1005 #ifdef WIN32
1006 fcgi_socket_dir = DEFAULT_SOCK_DIR;
1007 #else
1008 fcgi_socket_dir = ap_server_root_relative(p, DEFAULT_SOCK_DIR);
1009 #endif
1012 s->socket_path = fcgi_util_socket_make_path_absolute(p, s->socket_path, 0);
1013 #ifndef WIN32
1014 err = fcgi_util_socket_make_domain_addr(p, (struct sockaddr_un **)&s->socket_addr,
1015 &s->socket_addr_len, s->socket_path);
1016 if (err != NULL)
1017 return ap_psprintf(tp, "%s %s: %s", name, fs_path, err);
1018 #endif
1021 /* Add it to the list of FastCGI servers */
1022 fcgi_util_fs_add(s);
1024 return NULL;
1028 *----------------------------------------------------------------------
1030 * fcgi_config_set_config --
1032 * Implements the FastCGI FCGIConfig configuration directive.
1033 * This command adds routines to control the execution of the
1034 * dynamic FastCGI processes.
1037 *----------------------------------------------------------------------
1039 const char *fcgi_config_set_config(cmd_parms *cmd, void *dummy, const char *arg)
1041 pool * const p = cmd->pool;
1042 pool * const tp = cmd->temp_pool;
1043 const char *err, *option;
1044 const char * const name = cmd->cmd->name;
1046 /* Allocate temp storage for an initial environment */
1047 unsigned int envc = 0;
1048 char **envp = (char **)ap_pcalloc(tp, sizeof(char *) * (MAX_INIT_ENV_VARS + 3));
1050 err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1051 if (err)
1053 return err;
1056 /* Parse the directive arguments */
1057 while (*arg) {
1058 option = ap_getword_conf(tp, &arg);
1060 if (strcasecmp(option, "-maxProcesses") == 0) {
1061 if ((err = get_u_int(tp, &arg, &dynamicMaxProcs, 1)))
1062 return invalid_value(tp, name, NULL, option, err);
1064 else if (strcasecmp(option, "-minProcesses") == 0) {
1065 if ((err = get_int(tp, &arg, &dynamicMinProcs, 0)))
1066 return invalid_value(tp, name, NULL, option, err);
1068 else if (strcasecmp(option, "-maxClassProcesses") == 0) {
1069 if ((err = get_int(tp, &arg, &dynamicMaxClassProcs, 1)))
1070 return invalid_value(tp, name, NULL, option, err);
1072 else if (strcasecmp(option, "-killInterval") == 0) {
1073 if ((err = get_u_int(tp, &arg, &dynamicKillInterval, 1)))
1074 return invalid_value(tp, name, NULL, option, err);
1076 else if (strcasecmp(option, "-updateInterval") == 0) {
1077 if ((err = get_u_int(tp, &arg, &dynamicUpdateInterval, 1)))
1078 return invalid_value(tp, name, NULL, option, err);
1080 else if (strcasecmp(option, "-gainValue") == 0) {
1081 if ((err = get_float(tp, &arg, &dynamicGain, 0.0, 1.0)))
1082 return invalid_value(tp, name, NULL, option, err);
1084 else if ((strcasecmp(option, "-singleThreshold") == 0)
1085 || (strcasecmp(option, "-singleThreshhold") == 0))
1087 if ((err = get_int(tp, &arg, &dynamicThreshold1, 0)))
1088 return invalid_value(tp, name, NULL, option, err);
1090 else if ((strcasecmp(option, "-multiThreshold") == 0)
1091 || (strcasecmp(option, "-multiThreshhold") == 0))
1093 if ((err = get_int(tp, &arg, &dynamicThresholdN, 0)))
1094 return invalid_value(tp, name, NULL, option, err);
1096 else if (strcasecmp(option, "-startDelay") == 0) {
1097 if ((err = get_u_int(tp, &arg, &dynamicPleaseStartDelay, 1)))
1098 return invalid_value(tp, name, NULL, option, err);
1100 else if (strcasecmp(option, "-initial-env") == 0) {
1101 if ((err = get_env_var(p, &arg, envp, &envc)))
1102 return invalid_value(tp, name, NULL, option, err);
1104 else if (strcasecmp(option, "-pass-header") == 0) {
1105 if ((err = get_pass_header(p, &arg, &dynamic_pass_headers)))
1106 return invalid_value(tp, name, NULL, option, err);
1108 else if (strcasecmp(option, "-appConnTimeout") == 0) {
1109 if ((err = get_u_int(tp, &arg, &dynamicAppConnectTimeout, 0)))
1110 return invalid_value(tp, name, NULL, option, err);
1112 else if (strcasecmp(option, "-idle-timeout") == 0) {
1113 if ((err = get_u_int(tp, &arg, &dynamic_idle_timeout, 1)))
1114 return invalid_value(tp, name, NULL, option, err);
1116 else if (strcasecmp(option, "-listen-queue-depth") == 0) {
1117 if ((err = get_u_int(tp, &arg, &dynamicListenQueueDepth, 1)))
1118 return invalid_value(tp, name, NULL, option, err);
1120 else if (strcasecmp(option, "-min-server-life") == 0) {
1121 if ((err = get_int(tp, &arg, &dynamicMinServerLife, 0)))
1122 return invalid_value(tp, name, NULL, option, err);
1124 else if (strcasecmp(option, "-restart-delay") == 0) {
1125 if ((err = get_u_int(tp, &arg, &dynamicRestartDelay, 0)))
1126 return invalid_value(tp, name, NULL, option, err);
1128 else if (strcasecmp(option, "-init-start-delay") == 0) {
1129 if ((err = get_u_int(tp, &arg, &dynamicInitStartDelay, 0)))
1130 return invalid_value(tp, name, NULL, option, err);
1132 else if (strcasecmp(option, "-processSlack") == 0) {
1133 if ((err = get_u_int(tp, &arg, &dynamicProcessSlack, 1)))
1134 return invalid_value(tp, name, NULL, option, err);
1136 else if (strcasecmp(option, "-restart") == 0) {
1137 dynamicAutoRestart = 1;
1139 else if (strcasecmp(option, "-autoUpdate") == 0) {
1140 dynamicAutoUpdate = 1;
1142 else if (strcasecmp(option, "-flush") == 0) {
1143 dynamicFlush = TRUE;
1145 else {
1146 return ap_psprintf(tp, "%s: invalid option: %s", name, option);
1148 } /* while */
1150 if (dynamicProcessSlack >= dynamicMaxProcs + 1) {
1151 /* the kill policy would work unexpectedly */
1152 return ap_psprintf(tp,
1153 "%s: processSlack (%u) must be less than maxProcesses (%u) + 1",
1154 name, dynamicProcessSlack, dynamicMaxProcs);
1157 /* Move env array to a surviving pool, leave 2 extra slots for
1158 * WIN32 _FCGI_MUTEX_ and _FCGI_SHUTDOWN_EVENT_ */
1159 dynamicEnvp = (char **)ap_pcalloc(p, sizeof(char *) * (envc + 4));
1160 memcpy(dynamicEnvp, envp, sizeof(char *) * envc);
1162 return NULL;
1165 void *fcgi_config_create_dir_config(pool *p, char *dummy)
1167 fcgi_dir_config *dir_config = ap_pcalloc(p, sizeof(fcgi_dir_config));
1169 dir_config->authenticator_options = FCGI_AUTHORITATIVE;
1170 dir_config->authorizer_options = FCGI_AUTHORITATIVE;
1171 dir_config->access_checker_options = FCGI_AUTHORITATIVE;
1173 return dir_config;
1177 const char *fcgi_config_new_auth_server(cmd_parms * cmd,
1178 void * dircfg, const char *fs_path, const char * compat)
1180 fcgi_dir_config * dir_config = (fcgi_dir_config *) dircfg;
1181 pool * const tp = cmd->temp_pool;
1182 char * auth_server;
1184 #ifdef APACHE2
1185 if (apr_filepath_merge(&auth_server, "", fs_path, 0, cmd->pool))
1186 return ap_psprintf(tp, "%s %s: invalid filepath", cmd->cmd->name, fs_path);
1187 #else
1188 auth_server = (char *) ap_os_canonical_filename(cmd->pool, fs_path);
1189 #endif
1191 auth_server = ap_server_root_relative(cmd->pool, auth_server);
1193 /* Make sure its already configured or at least a candidate for dynamic */
1194 if (fcgi_util_fs_get_by_id(auth_server, fcgi_util_get_server_uid(cmd->server),
1195 fcgi_util_get_server_gid(cmd->server)) == NULL)
1197 const char *err = fcgi_util_fs_is_path_ok(tp, auth_server, NULL);
1198 if (err)
1199 return ap_psprintf(tp, "%s: \"%s\" %s", cmd->cmd->name, auth_server, err);
1202 if (compat && strcasecmp(compat, "-compat"))
1203 return ap_psprintf(cmd->temp_pool, "%s: unknown option: \"%s\"", cmd->cmd->name, compat);
1205 switch((int)cmd->info) {
1206 case FCGI_AUTH_TYPE_AUTHENTICATOR:
1207 dir_config->authenticator = auth_server;
1208 dir_config->authenticator_options |= (compat) ? FCGI_COMPAT : 0;
1209 break;
1210 case FCGI_AUTH_TYPE_AUTHORIZER:
1211 dir_config->authorizer = auth_server;
1212 dir_config->authorizer_options |= (compat) ? FCGI_COMPAT : 0;
1213 break;
1214 case FCGI_AUTH_TYPE_ACCESS_CHECKER:
1215 dir_config->access_checker = auth_server;
1216 dir_config->access_checker_options |= (compat) ? FCGI_COMPAT : 0;
1217 break;
1220 return NULL;
1223 const char *fcgi_config_set_authoritative_slot(cmd_parms * cmd,
1224 void * dir_config, int arg)
1226 int offset = (int)(long)cmd->info;
1228 if (arg)
1229 *((u_char *)dir_config + offset) |= FCGI_AUTHORITATIVE;
1230 else
1231 *((u_char *)dir_config + offset) &= ~FCGI_AUTHORITATIVE;
1233 return NULL;