1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * util.c: string utility things
21 * 1995-96 Many changes by the Apache Software Foundation
26 * #define DEBUG to trace all cfg_open*()/cfg_closefile() calls
27 * #define DEBUG_CFG_LINES to trace every line read from the config files
31 #include "apr_strings.h"
34 #define APR_WANT_STDIO
35 #define APR_WANT_STRFUNC
41 #if APR_HAVE_PROCESS_H
42 #include <process.h> /* for getpid() on Win32 */
45 #include <netdb.h> /* for gethostbyname() */
48 #include "ap_config.h"
49 #include "apr_base64.h"
51 #include "http_main.h"
53 #include "http_protocol.h"
54 #include "http_config.h"
55 #include "http_core.h"
56 #include "util_ebcdic.h"
57 #include "util_varbuf.h"
65 #ifdef HAVE_SYS_LOADAVG_H
66 #include <sys/loadavg.h>
71 /* A bunch of functions in util.c scan strings looking for certain characters.
72 * To make that more efficient we encode a lookup table. The test_char_table
73 * is generated automatically by gen_test_char.c.
75 #include "test_char.h"
77 /* we assume the folks using this ensure 0 <= c < 256... which means
78 * you need a cast to (unsigned char) first, you can't just plug a
79 * char in here and get it to work, because if char is signed then it
80 * will first be sign extended.
82 #define TEST_CHAR(c, f) (test_char_table[(unsigned)(c)] & (f))
84 /* Win32/NetWare/OS2 need to check for both forward and back slashes
85 * in ap_getparents() and ap_escape_url.
87 #ifdef CASE_BLIND_FILESYSTEM
88 #define IS_SLASH(s) ((s == '/') || (s == '\\'))
91 #define IS_SLASH(s) (s == '/')
95 /* we know core's module_index is 0 */
96 #undef APLOG_MODULE_INDEX
97 #define APLOG_MODULE_INDEX AP_CORE_MODULE_INDEX
101 * Examine a field value (such as a media-/content-type) string and return
102 * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
104 AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype)
108 if (intype == NULL) return NULL;
110 semi = ap_strchr_c(intype, ';');
112 return apr_pstrdup(p, intype);
115 while ((semi > intype) && apr_isspace(semi[-1])) {
118 return apr_pstrndup(p, intype, semi - intype);
122 AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt,
126 char ts[MAX_STRING_LEN];
127 char tf[MAX_STRING_LEN];
134 apr_time_exp_gmt(&xt, t);
135 /* Convert %Z to "GMT" and %z to "+0000";
136 * on hosts that do not have a time zone string in struct tm,
137 * strftime must assume its argument is local time.
139 for(strp = tf, f = fmt; strp < tf + sizeof(tf) - 6 && (*strp = *f)
141 if (*f != '%') continue;
152 case 'z': /* common extension */
166 apr_time_exp_lt(&xt, t);
169 /* check return code? */
170 apr_strftime(ts, &retcode, MAX_STRING_LEN, fmt, &xt);
171 ts[MAX_STRING_LEN - 1] = '\0';
172 return apr_pstrdup(p, ts);
175 /* Roy owes Rob beer. */
176 /* Rob owes Roy dinner. */
178 /* These legacy comments would make a lot more sense if Roy hadn't
179 * replaced the old later_than() routine with util_date.c.
181 * Well, okay, they still wouldn't make any sense.
184 /* Match = 0, NoMatch = 1, Abort = -1
185 * Based loosely on sections of wildmat.c by Rich Salz
186 * Hmmm... shouldn't this really go component by component?
188 AP_DECLARE(int) ap_strcmp_match(const char *str, const char *expected)
192 for (x = 0, y = 0; expected[y]; ++y, ++x) {
193 if ((!str[x]) && (expected[y] != '*'))
195 if (expected[y] == '*') {
196 while (expected[++y] == '*');
201 if ((ret = ap_strcmp_match(&str[x++], &expected[y])) != 1)
206 else if ((expected[y] != '?') && (str[x] != expected[y]))
209 return (str[x] != '\0');
212 AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *expected)
216 for (x = 0, y = 0; expected[y]; ++y, ++x) {
217 if (!str[x] && expected[y] != '*')
219 if (expected[y] == '*') {
220 while (expected[++y] == '*');
225 if ((ret = ap_strcasecmp_match(&str[x++], &expected[y])) != 1)
230 else if (expected[y] != '?'
231 && apr_tolower(str[x]) != apr_tolower(expected[y]))
234 return (str[x] != '\0');
237 /* We actually compare the canonical root to this root, (but we don't
238 * waste time checking the case), since every use of this function in
239 * httpd-2.1 tests if the path is 'proper', meaning we've already passed
240 * it through apr_filepath_merge, or we haven't.
242 AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir)
245 const char *ourdir = dir;
246 if (apr_filepath_root(&newpath, &dir, 0, p) != APR_SUCCESS
247 || strncmp(newpath, ourdir, strlen(newpath)) != 0) {
253 AP_DECLARE(int) ap_is_matchexp(const char *str)
257 for (x = 0; str[x]; x++)
258 if ((str[x] == '*') || (str[x] == '?'))
264 * Here's a pool-based interface to the POSIX-esque ap_regcomp().
265 * Note that we return ap_regex_t instead of being passed one.
266 * The reason is that if you use an already-used ap_regex_t structure,
267 * the memory that you've already allocated gets forgotten, and
268 * regfree() doesn't clear it. So we don't allow it.
271 static apr_status_t regex_cleanup(void *preg)
273 ap_regfree((ap_regex_t *) preg);
277 AP_DECLARE(ap_regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
280 ap_regex_t *preg = apr_palloc(p, sizeof *preg);
281 int err = ap_regcomp(preg, pattern, cflags);
283 if (err == AP_REG_ESPACE)
288 apr_pool_cleanup_register(p, (void *) preg, regex_cleanup,
289 apr_pool_cleanup_null);
294 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, ap_regex_t *reg)
297 apr_pool_cleanup_kill(p, (void *) reg, regex_cleanup);
301 * Similar to standard strstr() but we ignore case in this version.
302 * Based on the strstr() implementation further below.
304 AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2)
312 for ( ; (*s1 != '\0') && (apr_tolower(*s1) != apr_tolower(*s2)); s1++);
316 /* found first character of s2, see if the rest matches */
319 for (++p1, ++p2; apr_tolower(*p1) == apr_tolower(*p2); ++p1, ++p2) {
321 /* both strings ended together */
326 /* second string ended, a match */
329 /* didn't find a match here, try starting at next character in s1 */
336 * Returns an offsetted pointer in bigstring immediately after
337 * prefix. Returns bigstring if bigstring doesn't start with
338 * prefix or if prefix is longer than bigstring while still matching.
339 * NOTE: pointer returned is relative to bigstring, so we
340 * can use standard pointer comparisons in the calling function
341 * (eg: test if ap_stripprefix(a,b) == a)
343 AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
352 while (*p1 && *prefix) {
353 if (*p1++ != *prefix++)
359 /* hit the end of bigstring! */
363 /* This function substitutes for $0-$9, filling in regular expression
364 * submatches. Pass it the same nmatch and pmatch arguments that you
365 * passed ap_regexec(). pmatch should not be greater than the maximum number
366 * of subexpressions - i.e. one more than the re_nsub member of ap_regex_t.
368 * nmatch must be <=AP_MAX_REG_MATCH (10).
370 * input should be the string with the $-expressions, source should be the
371 * string that was matched against.
373 * It returns the substituted string, or NULL if a vbuf is used.
374 * On errors, returns the orig string.
376 * Parts of this code are based on Henry Spencer's regsub(), from his
377 * AT&T V8 regexp package.
380 static apr_status_t regsub_core(apr_pool_t *p, char **result,
381 struct ap_varbuf *vb, const char *input,
382 const char *source, apr_size_t nmatch,
383 ap_regmatch_t pmatch[], apr_size_t maxlen)
385 const char *src = input;
391 AP_DEBUG_ASSERT((result && p && !vb) || (vb && !p && !result));
392 if (!source || nmatch>AP_MAX_REG_MATCH)
396 if (maxlen > 0 && len >= maxlen)
399 *result = apr_pstrmemdup(p, src, len);
403 ap_varbuf_strmemcat(vb, src, len);
408 /* First pass, find the size */
409 while ((c = *src++) != '\0') {
410 if (c == '$' && apr_isdigit(*src))
413 no = AP_MAX_REG_MATCH;
415 if (no >= AP_MAX_REG_MATCH) { /* Ordinary character. */
416 if (c == '\\' && *src)
420 else if (no < nmatch && pmatch[no].rm_so < pmatch[no].rm_eo) {
421 if (APR_SIZE_MAX - len <= pmatch[no].rm_eo - pmatch[no].rm_so)
423 len += pmatch[no].rm_eo - pmatch[no].rm_so;
428 if (len >= maxlen && maxlen > 0)
432 *result = dst = apr_palloc(p, len + 1);
435 if (vb->strlen == AP_VARBUF_UNKNOWN)
436 vb->strlen = strlen(vb->buf);
437 ap_varbuf_grow(vb, vb->strlen + len);
438 dst = vb->buf + vb->strlen;
442 /* Now actually fill in the string */
446 while ((c = *src++) != '\0') {
447 if (c == '$' && apr_isdigit(*src))
450 no = AP_MAX_REG_MATCH;
452 if (no >= AP_MAX_REG_MATCH) { /* Ordinary character. */
453 if (c == '\\' && *src)
457 else if (no < nmatch && pmatch[no].rm_so < pmatch[no].rm_eo) {
458 len = pmatch[no].rm_eo - pmatch[no].rm_so;
459 memcpy(dst, source + pmatch[no].rm_so, len);
469 #ifndef AP_PREGSUB_MAXLEN
470 #define AP_PREGSUB_MAXLEN (HUGE_STRING_LEN * 8)
472 AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input,
473 const char *source, apr_size_t nmatch,
474 ap_regmatch_t pmatch[])
477 apr_status_t rc = regsub_core(p, &result, NULL, input, source, nmatch,
478 pmatch, AP_PREGSUB_MAXLEN);
479 if (rc != APR_SUCCESS)
484 AP_DECLARE(apr_status_t) ap_pregsub_ex(apr_pool_t *p, char **result,
485 const char *input, const char *source,
486 apr_size_t nmatch, ap_regmatch_t pmatch[],
489 apr_status_t rc = regsub_core(p, result, NULL, input, source, nmatch,
491 if (rc != APR_SUCCESS)
497 * Parse .. so we don't compromise security
499 AP_DECLARE(void) ap_getparents(char *name)
504 /* Four paseses, as per RFC 1808 */
505 /* a) remove ./ path segments */
506 for (next = name; *next && (*next != '.'); next++) {
509 l = w = first_dot = next - name;
510 while (name[l] != '\0') {
511 if (name[l] == '.' && IS_SLASH(name[l + 1])
512 && (l == 0 || IS_SLASH(name[l - 1])))
515 name[w++] = name[l++];
518 /* b) remove trailing . path, segment */
519 if (w == 1 && name[0] == '.')
521 else if (w > 1 && name[w - 1] == '.' && IS_SLASH(name[w - 2]))
525 /* c) remove all xx/../ segments. (including leading ../ and /../) */
528 while (name[l] != '\0') {
529 if (name[l] == '.' && name[l + 1] == '.' && IS_SLASH(name[l + 2])
530 && (l == 0 || IS_SLASH(name[l - 1]))) {
531 register int m = l + 3, n;
535 while (l >= 0 && !IS_SLASH(name[l]))
542 while ((name[n] = name[m]))
549 /* d) remove trailing xx/.. segment. */
550 if (l == 2 && name[0] == '.' && name[1] == '.')
552 else if (l > 2 && name[l - 1] == '.' && name[l - 2] == '.'
553 && IS_SLASH(name[l - 3])) {
556 while (l >= 0 && !IS_SLASH(name[l]))
566 AP_DECLARE(void) ap_no2slash(char *name)
572 #ifdef HAVE_UNC_PATHS
573 /* Check for UNC names. Leave leading two slashes. */
574 if (s[0] == '/' && s[1] == '/')
579 if ((*d++ = *s) == '/') {
593 * copy at most n leading directories of s into d
594 * d should be at least as large as s plus 1 extra byte
596 * the return value is the ever useful pointer to the trailing \0 of d
598 * MODIFIED FOR HAVE_DRIVE_LETTERS and NETWARE environments,
599 * so that if n == 0, "/" is returned in d with n == 1
600 * and s == "e:/test.html", "e:/" is returned in d
601 * *** See also directory_walk in modules/http/http_request.c
604 * /a/b, 0 ==> / (true for all platforms)
613 * c:/a/b 3 ==> c:/a/b
614 * c:/a/b 4 ==> c:/a/b
616 AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n)
625 if (*s == '\0' || (*s == '/' && (--n) == 0)) {
637 * return the parent directory name including trailing / of the file s
639 AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s)
641 const char *last_slash = ap_strrchr_c(s, '/');
645 if (last_slash == NULL) {
646 return apr_pstrdup(p, "");
648 l = (last_slash - s) + 1;
649 d = apr_pstrmemdup(p, s, l);
655 AP_DECLARE(int) ap_count_dirs(const char *path)
659 for (x = 0, n = 0; path[x]; x++)
665 AP_DECLARE(char *) ap_getword_nc(apr_pool_t *atrans, char **line, char stop)
667 return ap_getword(atrans, (const char **) line, stop);
670 AP_DECLARE(char *) ap_getword(apr_pool_t *atrans, const char **line, char stop)
672 const char *pos = *line;
676 while ((*pos != stop) && *pos) {
681 res = apr_pstrmemdup(atrans, *line, len);
684 while (*pos == stop) {
693 AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *atrans, char **line)
695 return ap_getword_white(atrans, (const char **) line);
698 AP_DECLARE(char *) ap_getword_white(apr_pool_t *atrans, const char **line)
700 const char *pos = *line;
704 while (!apr_isspace(*pos) && *pos) {
709 res = apr_pstrmemdup(atrans, *line, len);
711 while (apr_isspace(*pos)) {
720 AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *atrans, char **line,
723 return ap_getword_nulls(atrans, (const char **) line, stop);
726 AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *atrans, const char **line,
729 const char *pos = ap_strchr_c(*line, stop);
733 apr_size_t len = strlen(*line);
734 res = apr_pstrmemdup(atrans, *line, len);
739 res = apr_pstrndup(atrans, *line, pos - *line);
748 /* Get a word, (new) config-file style --- quoted strings and backslashes
752 static char *substring_conf(apr_pool_t *p, const char *start, int len,
755 char *result = apr_palloc(p, len + 2);
759 for (i = 0; i < len; ++i) {
760 if (start[i] == '\\' && (start[i + 1] == '\\'
761 || (quote && start[i + 1] == quote)))
762 *resp++ = start[++i];
768 #if RESOLVE_ENV_PER_TOKEN
769 return (char *)ap_resolve_env(p,result);
775 AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line)
777 return ap_getword_conf(p, (const char **) line);
780 AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line)
782 const char *str = *line, *strend;
786 while (*str && apr_isspace(*str))
794 if ((quote = *str) == '"' || quote == '\'') {
796 while (*strend && *strend != quote) {
797 if (*strend == '\\' && strend[1] &&
798 (strend[1] == quote || strend[1] == '\\')) {
805 res = substring_conf(p, str + 1, strend - str - 1, quote);
807 if (*strend == quote)
812 while (*strend && !apr_isspace(*strend))
815 res = substring_conf(p, str, strend - str, 0);
818 while (*strend && apr_isspace(*strend))
824 AP_DECLARE(int) ap_cfg_closefile(ap_configfile_t *cfp)
827 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, NULL, APLOGNO(00551)
828 "Done with config file %s", cfp->name);
830 return (cfp->close == NULL) ? 0 : cfp->close(cfp->param);
833 /* we can't use apr_file_* directly because of linking issues on Windows */
834 static apr_status_t cfg_close(void *param)
836 return apr_file_close(param);
839 static apr_status_t cfg_getch(char *ch, void *param)
841 return apr_file_getc(ch, param);
844 static apr_status_t cfg_getstr(void *buf, apr_size_t bufsiz, void *param)
846 return apr_file_gets(buf, bufsiz, param);
849 /* Open a ap_configfile_t as FILE, return open ap_configfile_t struct pointer */
850 AP_DECLARE(apr_status_t) ap_pcfg_openfile(ap_configfile_t **ret_cfg,
851 apr_pool_t *p, const char *name)
853 ap_configfile_t *new_cfg;
854 apr_file_t *file = NULL;
862 ap_log_error(APLOG_MARK, APLOG_ERR, 0, NULL, APLOGNO(00552)
863 "Internal error: pcfg_openfile() called with NULL filename");
867 status = apr_file_open(&file, name, APR_READ | APR_BUFFERED,
870 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, NULL, APLOGNO(00553)
871 "Opening config file %s (%s)",
872 name, (status != APR_SUCCESS) ?
873 apr_strerror(status, buf, sizeof(buf)) : "successful");
875 if (status != APR_SUCCESS)
878 status = apr_file_info_get(&finfo, APR_FINFO_TYPE, file);
879 if (status != APR_SUCCESS)
882 if (finfo.filetype != APR_REG &&
883 #if defined(WIN32) || defined(OS2) || defined(NETWARE)
884 strcasecmp(apr_filepath_name_get(name), "nul") != 0) {
886 strcmp(name, "/dev/null") != 0) {
887 #endif /* WIN32 || OS2 */
888 ap_log_error(APLOG_MARK, APLOG_ERR, 0, NULL, APLOGNO(00554)
889 "Access to file %s denied by server: not a regular file",
891 apr_file_close(file);
896 /* Some twisted character [no pun intended] at MS decided that a
897 * zero width joiner as the lead wide character would be ideal for
898 * describing Unicode text files. This was further convoluted to
899 * another MSism that the same character mapped into utf-8, EF BB BF
900 * would signify utf-8 text files.
902 * Since MS configuration files are all protecting utf-8 encoded
903 * Unicode path, file and resource names, we already have the correct
904 * WinNT encoding. But at least eat the stupid three bytes up front.
907 unsigned char buf[4];
909 status = apr_file_read(file, buf, &len);
910 if ((status != APR_SUCCESS) || (len < 3)
911 || memcmp(buf, "\xEF\xBB\xBF", 3) != 0) {
913 apr_file_seek(file, APR_SET, &zero);
918 new_cfg = apr_palloc(p, sizeof(*new_cfg));
919 new_cfg->param = file;
920 new_cfg->name = apr_pstrdup(p, name);
921 new_cfg->getch = cfg_getch;
922 new_cfg->getstr = cfg_getstr;
923 new_cfg->close = cfg_close;
924 new_cfg->line_number = 0;
930 /* Allocate a ap_configfile_t handle with user defined functions and params */
931 AP_DECLARE(ap_configfile_t *) ap_pcfg_open_custom(
932 apr_pool_t *p, const char *descr, void *param,
933 apr_status_t (*getc_func) (char *ch, void *param),
934 apr_status_t (*gets_func) (void *buf, apr_size_t bufsize, void *param),
935 apr_status_t (*close_func) (void *param))
937 ap_configfile_t *new_cfg = apr_palloc(p, sizeof(*new_cfg));
938 new_cfg->param = param;
939 new_cfg->name = descr;
940 new_cfg->getch = getc_func;
941 new_cfg->getstr = gets_func;
942 new_cfg->close = close_func;
943 new_cfg->line_number = 0;
947 /* Read one character from a configfile_t */
948 AP_DECLARE(apr_status_t) ap_cfg_getc(char *ch, ap_configfile_t *cfp)
950 apr_status_t rc = cfp->getch(ch, cfp->param);
951 if (rc == APR_SUCCESS && *ch == LF)
956 AP_DECLARE(const char *) ap_pcfg_strerror(apr_pool_t *p, ap_configfile_t *cfp,
959 char buf[MAX_STRING_LEN];
960 if (rc == APR_SUCCESS)
962 return apr_psprintf(p, "Error reading %s at line %d: %s",
963 cfp->name, cfp->line_number,
964 rc == APR_ENOSPC ? "Line too long"
965 : apr_strerror(rc, buf, sizeof(buf)));
968 /* Read one line from open ap_configfile_t, strip LF, increase line number */
969 /* If custom handler does not define a getstr() function, read char by char */
970 static apr_status_t ap_cfg_getline_core(char *buf, apr_size_t bufsize,
971 ap_configfile_t *cfp)
974 /* If a "get string" function is defined, use it */
975 if (cfp->getstr != NULL) {
978 apr_size_t cbufsize = bufsize;
982 rc = cfp->getstr(cbuf, cbufsize, cfp->param);
992 if (rc != APR_SUCCESS) {
997 * check for line continuation,
998 * i.e. match [^\\]\\[\r]\n only
1002 if (cp > cbuf && cp[-1] == LF) {
1004 if (cp > cbuf && cp[-1] == CR)
1006 if (cp > cbuf && cp[-1] == '\\') {
1009 * line continuation requested -
1010 * then remove backslash and continue
1012 cbufsize -= (cp-cbuf);
1017 else if (cp - buf >= bufsize - 1) {
1023 /* No "get string" function defined; read character by character */
1027 /* too small, assume caller is crazy */
1034 rc = cfp->getch(&c, cfp->param);
1035 if (rc == APR_EOF) {
1041 if (rc != APR_SUCCESS)
1045 /* check for line continuation */
1046 if (i > 0 && buf[i-1] == '\\') {
1054 else if (i >= bufsize - 2) {
1065 static int cfg_trim_line(char *buf)
1069 * Leading and trailing white space is eliminated completely
1072 while (apr_isspace(*start))
1074 /* blast trailing whitespace */
1075 end = &start[strlen(start)];
1076 while (--end >= start && apr_isspace(*end))
1078 /* Zap leading whitespace by shifting */
1080 memmove(buf, start, end - start + 2);
1081 #ifdef DEBUG_CFG_LINES
1082 ap_log_error(APLOG_MARK, APLOG_NOTICE, 0, NULL, APLOGNO(00555) "Read config: '%s'", buf);
1084 return end - start + 1;
1087 /* Read one line from open ap_configfile_t, strip LF, increase line number */
1088 /* If custom handler does not define a getstr() function, read char by char */
1089 AP_DECLARE(apr_status_t) ap_cfg_getline(char *buf, apr_size_t bufsize,
1090 ap_configfile_t *cfp)
1092 apr_status_t rc = ap_cfg_getline_core(buf, bufsize, cfp);
1093 if (rc == APR_SUCCESS)
1098 AP_DECLARE(apr_status_t) ap_varbuf_cfg_getline(struct ap_varbuf *vb,
1099 ap_configfile_t *cfp,
1107 if (vb->strlen == AP_VARBUF_UNKNOWN)
1108 vb->strlen = strlen(vb->buf);
1109 if (vb->avail - vb->strlen < 3) {
1110 new_len = vb->avail * 2;
1111 if (new_len > max_len)
1113 else if (new_len < 3)
1115 ap_varbuf_grow(vb, new_len);
1119 rc = ap_cfg_getline_core(vb->buf + vb->strlen, vb->avail - vb->strlen, cfp);
1120 if (rc == APR_ENOSPC || rc == APR_SUCCESS)
1121 vb->strlen += strlen(vb->buf + vb->strlen);
1122 if (rc != APR_ENOSPC)
1124 if (vb->avail >= max_len)
1126 new_len = vb->avail * 2;
1127 if (new_len > max_len)
1129 ap_varbuf_grow(vb, new_len);
1132 if (vb->strlen > max_len)
1134 if (rc == APR_SUCCESS)
1135 vb->strlen = cfg_trim_line(vb->buf);
1139 /* Size an HTTP header field list item, as separated by a comma.
1140 * The return value is a pointer to the beginning of the non-empty list item
1141 * within the original string (or NULL if there is none) and the address
1142 * of field is shifted to the next non-comma, non-whitespace character.
1143 * len is the length of the item excluding any beginning whitespace.
1145 AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len)
1147 const unsigned char *ptr = (const unsigned char *)*field;
1148 const unsigned char *token;
1149 int in_qpair, in_qstr, in_com;
1151 /* Find first non-comma, non-whitespace byte */
1153 while (*ptr == ',' || apr_isspace(*ptr))
1158 /* Find the end of this item, skipping over dead bits */
1160 for (in_qpair = in_qstr = in_com = 0;
1161 *ptr && (in_qpair || in_qstr || in_com || *ptr != ',');
1169 case '\\': in_qpair = 1; /* quoted-pair */
1171 case '"' : if (!in_com) /* quoted string delim */
1174 case '(' : if (!in_qstr) /* comment (may nest) */
1177 case ')' : if (in_com) /* end comment */
1185 if ((*len = (ptr - token)) == 0) {
1186 *field = (const char *)ptr;
1190 /* Advance field pointer to the next non-comma, non-white byte */
1192 while (*ptr == ',' || apr_isspace(*ptr))
1195 *field = (const char *)ptr;
1196 return (const char *)token;
1199 /* Retrieve an HTTP header field list item, as separated by a comma,
1200 * while stripping insignificant whitespace and lowercasing anything not in
1201 * a quoted string or comment. The return value is a new string containing
1202 * the converted list item (or NULL if none) and the address pointed to by
1203 * field is shifted to the next non-comma, non-whitespace.
1205 AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field)
1207 const char *tok_start;
1208 const unsigned char *ptr;
1211 int addspace = 0, in_qpair = 0, in_qstr = 0, in_com = 0, tok_len = 0;
1213 /* Find the beginning and maximum length of the list item so that
1214 * we can allocate a buffer for the new string and reset the field.
1216 if ((tok_start = ap_size_list_item(field, &tok_len)) == NULL) {
1219 token = apr_palloc(p, tok_len + 1);
1221 /* Scan the token again, but this time copy only the good bytes.
1222 * We skip extra whitespace and any whitespace around a '=', '/',
1223 * or ';' and lowercase normal characters not within a comment,
1224 * quoted-string or quoted-pair.
1226 for (ptr = (const unsigned char *)tok_start, pos = (unsigned char *)token;
1227 *ptr && (in_qpair || in_qstr || in_com || *ptr != ',');
1236 case '\\': in_qpair = 1;
1242 case '"' : if (!in_com)
1249 case '(' : if (!in_qstr)
1256 case ')' : if (in_com)
1262 case '\t': if (addspace)
1264 if (in_com || in_qstr)
1271 case ';' : if (!(in_com || in_qstr))
1275 default : if (addspace == 1)
1277 *pos++ = (in_com || in_qstr) ? *ptr
1278 : apr_tolower(*ptr);
1289 /* Find an item in canonical form (lowercase, no extra spaces) within
1290 * an HTTP field value list. Returns 1 if found, 0 if not found.
1291 * This would be much more efficient if we stored header fields as
1292 * an array of list items as they are received instead of a plain string.
1294 AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line,
1297 const unsigned char *pos;
1298 const unsigned char *ptr = (const unsigned char *)line;
1299 int good = 0, addspace = 0, in_qpair = 0, in_qstr = 0, in_com = 0;
1304 do { /* loop for each item in line's list */
1306 /* Find first non-comma, non-whitespace byte */
1308 while (*ptr == ',' || apr_isspace(*ptr))
1312 good = 1; /* until proven otherwise for this item */
1314 break; /* no items left and nothing good found */
1316 /* We skip extra whitespace and any whitespace around a '=', '/',
1317 * or ';' and lowercase normal characters not within a comment,
1318 * quoted-string or quoted-pair.
1320 for (pos = (const unsigned char *)tok;
1321 *ptr && (in_qpair || in_qstr || in_com || *ptr != ',');
1327 good = (*pos++ == *ptr);
1331 case '\\': in_qpair = 1;
1333 good = good && (*pos++ == ' ');
1334 good = good && (*pos++ == *ptr);
1337 case '"' : if (!in_com)
1340 good = good && (*pos++ == ' ');
1341 good = good && (*pos++ == *ptr);
1344 case '(' : if (!in_qstr)
1347 good = good && (*pos++ == ' ');
1348 good = good && (*pos++ == *ptr);
1351 case ')' : if (in_com)
1353 good = good && (*pos++ == *ptr);
1357 case '\t': if (addspace || !good)
1359 if (in_com || in_qstr)
1360 good = (*pos++ == *ptr);
1366 case ';' : if (!(in_com || in_qstr))
1368 good = good && (*pos++ == *ptr);
1370 default : if (!good)
1373 good = (*pos++ == ' ');
1374 if (in_com || in_qstr)
1375 good = good && (*pos++ == *ptr);
1377 good = good && (*pos++ == apr_tolower(*ptr));
1384 good = 0; /* not good if only a prefix was matched */
1386 } while (*ptr && !good);
1392 /* Retrieve a token, spacing over it and returning a pointer to
1393 * the first non-white byte afterwards. Note that these tokens
1394 * are delimited by semis and commas; and can also be delimited
1395 * by whitespace at the caller's option.
1398 AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line,
1401 const char *ptr = *accept_line;
1402 const char *tok_start;
1406 /* Find first non-white byte */
1408 while (*ptr && apr_isspace(*ptr))
1413 /* find token end, skipping over quoted strings.
1414 * (comments are already gone).
1417 while (*ptr && (accept_white || !apr_isspace(*ptr))
1418 && *ptr != ';' && *ptr != ',') {
1425 tok_len = ptr - tok_start;
1426 token = apr_pstrndup(p, tok_start, tok_len);
1428 /* Advance accept_line pointer to the next non-white byte */
1430 while (*ptr && apr_isspace(*ptr))
1438 /* find http tokens, see the definition of token from RFC2068 */
1439 AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok)
1441 const unsigned char *start_token;
1442 const unsigned char *s;
1447 s = (const unsigned char *)line;
1449 /* find start of token, skip all stop characters, note NUL
1450 * isn't a token stop, so we don't need to test for it
1452 while (TEST_CHAR(*s, T_HTTP_TOKEN_STOP)) {
1459 /* find end of the token */
1460 while (*s && !TEST_CHAR(*s, T_HTTP_TOKEN_STOP)) {
1463 if (!strncasecmp((const char *)start_token, (const char *)tok,
1474 AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line,
1477 int llen, tlen, lidx;
1482 llen = strlen(line);
1487 (lidx > 0 && !(apr_isspace(line[lidx - 1]) || line[lidx - 1] == ',')))
1490 return (strncasecmp(&line[lidx], tok, tlen) == 0);
1493 AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *str)
1497 const unsigned char *s;
1499 cmd = apr_palloc(p, 2 * strlen(str) + 1); /* Be safe */
1500 d = (unsigned char *)cmd;
1501 s = (const unsigned char *)str;
1504 #if defined(OS2) || defined(WIN32)
1506 * Newlines to Win32/OS2 CreateProcess() are ill advised.
1507 * Convert them to spaces since they are effectively white
1508 * space to most applications
1510 if (*s == '\r' || *s == '\n') {
1516 if (TEST_CHAR(*s, T_ESCAPE_SHELL_CMD)) {
1526 static char x2c(const char *what)
1528 register char digit;
1530 #if !APR_CHARSET_EBCDIC
1531 digit = ((what[0] >= 'A') ? ((what[0] & 0xdf) - 'A') + 10
1534 digit += (what[1] >= 'A' ? ((what[1] & 0xdf) - 'A') + 10
1536 #else /*APR_CHARSET_EBCDIC*/
1543 digit = apr_xlate_conv_byte(ap_hdrs_from_ascii,
1544 0xFF & strtol(xstr, NULL, 16));
1545 #endif /*APR_CHARSET_EBCDIC*/
1550 * Unescapes a URL, leaving reserved characters intact.
1551 * Returns 0 on success, non-zero on error
1553 * bad % escape returns HTTP_BAD_REQUEST
1555 * decoding %00 or a forbidden character returns HTTP_NOT_FOUND
1558 static int unescape_url(char *url, const char *forbid, const char *reserved)
1560 register int badesc, badpath;
1565 /* Initial scan for first '%'. Don't bother writing values before
1567 y = strchr(url, '%');
1571 for (x = y; *y; ++x, ++y) {
1576 if (!apr_isxdigit(*(y + 1)) || !apr_isxdigit(*(y + 2))) {
1582 decoded = x2c(y + 1);
1583 if ((decoded == '\0')
1584 || (forbid && ap_strchr_c(forbid, decoded))) {
1589 else if (reserved && ap_strchr_c(reserved, decoded)) {
1603 return HTTP_BAD_REQUEST;
1606 return HTTP_NOT_FOUND;
1612 AP_DECLARE(int) ap_unescape_url(char *url)
1615 return unescape_url(url, SLASHES, NULL);
1617 AP_DECLARE(int) ap_unescape_url_keep2f(char *url, int decode_slashes)
1619 /* AllowEncodedSlashes (corrected) */
1620 if (decode_slashes) {
1621 /* no chars reserved */
1622 return unescape_url(url, NULL, NULL);
1624 /* reserve (do not decode) encoded slashes */
1625 return unescape_url(url, NULL, SLASHES);
1629 /* IFDEF these out until they've been thought through.
1630 * Just a germ of an API extension for now
1632 AP_DECLARE(int) ap_unescape_url_proxy(char *url)
1634 /* leave RFC1738 reserved characters intact, * so proxied URLs
1635 * don't get mangled. Where does that leave encoded '&' ?
1637 return unescape_url(url, NULL, "/;?");
1639 AP_DECLARE(int) ap_unescape_url_reserved(char *url, const char *reserved)
1641 return unescape_url(url, NULL, reserved);
1645 AP_DECLARE(int) ap_unescape_urlencoded(char *query)
1649 /* replace plus with a space */
1651 for (slider = query; *slider; slider++) {
1652 if (*slider == '+') {
1658 /* unescape everything else */
1659 return unescape_url(query, NULL, NULL);
1662 AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
1663 apr_port_t port, const request_rec *r)
1665 if (ap_is_default_port(port, r)) {
1666 return apr_pstrdup(p, hostname);
1669 return apr_psprintf(p, "%s:%u", hostname, port);
1673 AP_DECLARE(int) ap_unescape_all(char *url)
1675 return unescape_url(url, NULL, NULL);
1678 /* c2x takes an unsigned, and expects the caller has guaranteed that
1679 * 0 <= what < 256... which usually means that you have to cast to
1680 * unsigned char first, because (unsigned)(char)(x) first goes through
1681 * signed extension to an int before the unsigned cast.
1683 * The reason for this assumption is to assist gcc code generation --
1684 * the unsigned char -> unsigned extension is already done earlier in
1685 * both uses of this code, so there's no need to waste time doing it
1688 static const char c2x_table[] = "0123456789abcdef";
1690 static APR_INLINE unsigned char *c2x(unsigned what, unsigned char prefix,
1691 unsigned char *where)
1693 #if APR_CHARSET_EBCDIC
1694 what = apr_xlate_conv_byte(ap_hdrs_to_ascii, (unsigned char)what);
1695 #endif /*APR_CHARSET_EBCDIC*/
1697 *where++ = c2x_table[what >> 4];
1698 *where++ = c2x_table[what & 0xf];
1703 * escape_path_segment() escapes a path segment, as defined in RFC 1808. This
1704 * routine is (should be) OS independent.
1706 * os_escape_path() converts an OS path to a URL, in an OS dependent way. In all
1707 * cases if a ':' occurs before the first '/' in the URL, the URL should be
1708 * prefixed with "./" (or the ':' escaped). In the case of Unix, this means
1709 * leaving '/' alone, but otherwise doing what escape_path_segment() does. For
1710 * efficiency reasons, we don't use escape_path_segment(), which is provided for
1711 * reference. Again, RFC 1808 is where this stuff is defined.
1713 * If partial is set, os_escape_path() assumes that the path will be appended to
1714 * something with a '/' in it (and thus does not prefix "./").
1717 AP_DECLARE(char *) ap_escape_path_segment_buffer(char *copy, const char *segment)
1719 const unsigned char *s = (const unsigned char *)segment;
1720 unsigned char *d = (unsigned char *)copy;
1724 if (TEST_CHAR(c, T_ESCAPE_PATH_SEGMENT)) {
1736 AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *segment)
1738 return ap_escape_path_segment_buffer(apr_palloc(p, 3 * strlen(segment) + 1), segment);
1741 AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial)
1743 char *copy = apr_palloc(p, 3 * strlen(path) + 3);
1744 const unsigned char *s = (const unsigned char *)path;
1745 unsigned char *d = (unsigned char *)copy;
1749 const char *colon = ap_strchr_c(path, ':');
1750 const char *slash = ap_strchr_c(path, '/');
1752 if (colon && (!slash || colon < slash)) {
1758 if (TEST_CHAR(c, T_OS_ESCAPE_PATH)) {
1770 AP_DECLARE(char *) ap_escape_urlencoded_buffer(char *copy, const char *buffer)
1772 const unsigned char *s = (const unsigned char *)buffer;
1773 unsigned char *d = (unsigned char *)copy;
1777 if (TEST_CHAR(c, T_ESCAPE_URLENCODED)) {
1780 else if (c == ' ') {
1792 AP_DECLARE(char *) ap_escape_urlencoded(apr_pool_t *p, const char *buffer)
1794 return ap_escape_urlencoded_buffer(apr_palloc(p, 3 * strlen(buffer) + 1), buffer);
1797 /* ap_escape_uri is now a macro for os_escape_path */
1799 AP_DECLARE(char *) ap_escape_html2(apr_pool_t *p, const char *s, int toasc)
1804 /* first, count the number of extra characters */
1805 for (i = 0, j = 0; s[i] != '\0'; i++)
1806 if (s[i] == '<' || s[i] == '>')
1808 else if (s[i] == '&')
1810 else if (s[i] == '"')
1812 else if (toasc && !apr_isascii(s[i]))
1816 return apr_pstrmemdup(p, s, i);
1818 x = apr_palloc(p, i + j + 1);
1819 for (i = 0, j = 0; s[i] != '\0'; i++, j++)
1821 memcpy(&x[j], "<", 4);
1824 else if (s[i] == '>') {
1825 memcpy(&x[j], ">", 4);
1828 else if (s[i] == '&') {
1829 memcpy(&x[j], "&", 5);
1832 else if (s[i] == '"') {
1833 memcpy(&x[j], """, 6);
1836 else if (toasc && !apr_isascii(s[i])) {
1837 char *esc = apr_psprintf(p, "&#%3.3d;", (unsigned char)s[i]);
1838 memcpy(&x[j], esc, 6);
1847 AP_DECLARE(char *) ap_escape_logitem(apr_pool_t *p, const char *str)
1851 const unsigned char *s;
1857 ret = apr_palloc(p, 4 * strlen(str) + 1); /* Be safe */
1858 d = (unsigned char *)ret;
1859 s = (const unsigned char *)str;
1862 if (TEST_CHAR(*s, T_ESCAPE_LOGITEM)) {
1898 AP_DECLARE(apr_size_t) ap_escape_errorlog_item(char *dest, const char *source,
1901 unsigned char *d, *ep;
1902 const unsigned char *s;
1904 if (!source || !buflen) { /* be safe */
1908 d = (unsigned char *)dest;
1909 s = (const unsigned char *)source;
1910 ep = d + buflen - 1;
1912 for (; d < ep && *s; ++s) {
1914 if (TEST_CHAR(*s, T_ESCAPE_LOGITEM)) {
1940 case '"': /* no need for this in error log */
1945 ep = --d; /* break the for loop as well */
1958 return (d - (unsigned char *)dest);
1961 AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *path)
1965 if (apr_stat(&finfo, path, APR_FINFO_TYPE, p) != APR_SUCCESS)
1966 return 0; /* in error condition, just return no */
1968 return (finfo.filetype == APR_DIR);
1971 AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *path)
1975 if (apr_stat(&finfo, path, APR_FINFO_LINK | APR_FINFO_TYPE, p) != APR_SUCCESS)
1976 return 0; /* in error condition, just return no */
1978 return (finfo.filetype == APR_DIR);
1981 AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *src1,
1984 apr_size_t len1, len2;
1987 len1 = strlen(src1);
1988 len2 = strlen(src2);
1989 /* allocate +3 for '/' delimiter, trailing NULL and overallocate
1990 * one extra byte to allow the caller to add a trailing '/'
1992 path = (char *)apr_palloc(a, len1 + len2 + 3);
1995 memcpy(path + 1, src2, len2 + 1);
1999 memcpy(path, src1, len1);
2001 if (next[-1] != '/') {
2004 memcpy(next, src2, len2 + 1);
2010 * Check for an absoluteURI syntax (see section 3.2 in RFC2068).
2012 AP_DECLARE(int) ap_is_url(const char *u)
2016 for (x = 0; u[x] != ':'; x++) {
2018 ((!apr_isalpha(u[x])) && (!apr_isdigit(u[x])) &&
2019 (u[x] != '+') && (u[x] != '-') && (u[x] != '.'))) {
2024 return (x ? 1 : 0); /* If the first character is ':', it's broken, too */
2027 AP_DECLARE(int) ap_ind(const char *s, char c)
2029 const char *p = ap_strchr_c(s, c);
2036 AP_DECLARE(int) ap_rind(const char *s, char c)
2038 const char *p = ap_strrchr_c(s, c);
2045 AP_DECLARE(void) ap_str_tolower(char *str)
2048 *str = apr_tolower(*str);
2053 AP_DECLARE(void) ap_str_toupper(char *str)
2056 *str = apr_toupper(*str);
2062 * We must return a FQDN
2064 char *ap_get_local_host(apr_pool_t *a)
2066 #ifndef MAXHOSTNAMELEN
2067 #define MAXHOSTNAMELEN 256
2069 char str[MAXHOSTNAMELEN + 1];
2070 char *server_hostname = NULL;
2071 apr_sockaddr_t *sockaddr;
2074 if (apr_gethostname(str, sizeof(str) - 1, a) != APR_SUCCESS) {
2075 ap_log_perror(APLOG_MARK, APLOG_STARTUP | APLOG_WARNING, 0, a, APLOGNO(00556)
2076 "%s: apr_gethostname() failed to determine ServerName",
2079 str[sizeof(str) - 1] = '\0';
2080 if (apr_sockaddr_info_get(&sockaddr, str, APR_UNSPEC, 0, 0, a) == APR_SUCCESS) {
2081 if ( (apr_getnameinfo(&hostname, sockaddr, 0) == APR_SUCCESS) &&
2082 (ap_strchr_c(hostname, '.')) ) {
2083 server_hostname = apr_pstrdup(a, hostname);
2084 return server_hostname;
2085 } else if (ap_strchr_c(str, '.')) {
2086 server_hostname = apr_pstrdup(a, str);
2088 apr_sockaddr_ip_get(&hostname, sockaddr);
2089 server_hostname = apr_pstrdup(a, hostname);
2092 ap_log_perror(APLOG_MARK, APLOG_STARTUP | APLOG_WARNING, 0, a, APLOGNO(00557)
2093 "%s: apr_sockaddr_info_get() failed for %s",
2094 ap_server_argv0, str);
2098 if (!server_hostname)
2099 server_hostname = apr_pstrdup(a, "127.0.0.1");
2101 ap_log_perror(APLOG_MARK, APLOG_ALERT|APLOG_STARTUP, 0, a, APLOGNO(00558)
2102 "%s: Could not reliably determine the server's fully qualified "
2103 "domain name, using %s. Set the 'ServerName' directive globally "
2104 "to suppress this message",
2105 ap_server_argv0, server_hostname);
2107 return server_hostname;
2110 /* simple 'pool' alloc()ing glue to apr_base64.c
2112 AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded)
2117 decoded = (char *) apr_palloc(p, 1 + apr_base64_decode_len(bufcoded));
2118 l = apr_base64_decode(decoded, bufcoded);
2119 decoded[l] = '\0'; /* make binary sequence into string */
2124 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string)
2127 int l = strlen(string);
2129 encoded = (char *) apr_palloc(p, 1 + apr_base64_encode_len(l));
2130 l = apr_base64_encode(encoded, string, l);
2131 encoded[l] = '\0'; /* make binary sequence into string */
2136 /* we want to downcase the type/subtype for comparison purposes
2137 * but nothing else because ;parameter=foo values are case sensitive.
2138 * XXX: in truth we want to downcase parameter names... but really,
2139 * apache has never handled parameters and such correctly. You
2140 * also need to compress spaces and such to be able to compare
2143 AP_DECLARE(void) ap_content_type_tolower(char *str)
2147 semi = strchr(str, ';');
2152 ap_str_tolower(str);
2160 * Given a string, replace any bare " with \" .
2162 AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring)
2165 const char *inchr = instring;
2166 char *outchr, *outstring;
2169 * Look through the input string, jogging the length of the output
2170 * string up by an extra byte each time we find an unescaped ".
2172 while (*inchr != '\0') {
2174 if (*inchr == '"') {
2178 * If we find a slosh, and it's not the last byte in the string,
2179 * it's escaping something - advance past both bytes.
2181 if ((*inchr == '\\') && (inchr[1] != '\0')) {
2187 outstring = apr_palloc(p, newlen + 1);
2191 * Now copy the input string to the output string, inserting a slosh
2192 * in front of every " that doesn't already have one.
2194 while (*inchr != '\0') {
2195 if ((*inchr == '\\') && (inchr[1] != '\0')) {
2196 *outchr++ = *inchr++;
2197 *outchr++ = *inchr++;
2199 if (*inchr == '"') {
2202 if (*inchr != '\0') {
2203 *outchr++ = *inchr++;
2211 * Given a string, append the PID deliminated by delim.
2212 * Usually used to create a pid-appended filepath name
2213 * (eg: /a/b/foo -> /a/b/foo.6726). A function, and not
2214 * a macro, to avoid unistd.h dependency
2216 AP_DECLARE(char *) ap_append_pid(apr_pool_t *p, const char *string,
2219 return apr_psprintf(p, "%s%s%" APR_PID_T_FMT, string,
2225 * Parse a given timeout parameter string into an apr_interval_time_t value.
2226 * The unit of the time interval is given as postfix string to the numeric
2227 * string. Currently the following units are understood:
2234 * If no unit is contained in the given timeout parameter the default_time_unit
2235 * will be used instead.
2236 * @param timeout_parameter The string containing the timeout parameter.
2237 * @param timeout The timeout value to be returned.
2238 * @param default_time_unit The default time unit to use if none is specified
2239 * in timeout_parameter.
2240 * @return Status value indicating whether the parsing was successful or not.
2242 AP_DECLARE(apr_status_t) ap_timeout_parameter_parse(
2243 const char *timeout_parameter,
2244 apr_interval_time_t *timeout,
2245 const char *default_time_unit)
2248 const char *time_str;
2251 tout = apr_strtoi64(timeout_parameter, &endp, 10);
2255 if (!endp || !*endp) {
2256 time_str = default_time_unit;
2262 switch (*time_str) {
2263 /* Time is in seconds */
2265 *timeout = (apr_interval_time_t) apr_time_from_sec(tout);
2268 /* Time is in hours */
2269 *timeout = (apr_interval_time_t) apr_time_from_sec(tout * 3600);
2272 switch (*(++time_str)) {
2273 /* Time is in milliseconds */
2275 *timeout = (apr_interval_time_t) tout * 1000;
2277 /* Time is in minutes */
2279 *timeout = (apr_interval_time_t) apr_time_from_sec(tout * 60);
2282 return APR_EGENERAL;
2286 return APR_EGENERAL;
2292 * Determine if a request has a request body or not.
2294 * @param r the request_rec of the request
2295 * @return truth value
2297 AP_DECLARE(int) ap_request_has_body(request_rec *r)
2304 has_body = (!r->header_only
2306 || apr_table_get(r->headers_in, "Transfer-Encoding")
2307 || ( (cls = apr_table_get(r->headers_in, "Content-Length"))
2308 && (apr_strtoff(&cl, cls, &estr, 10) == APR_SUCCESS)
2316 AP_DECLARE_NONSTD(apr_status_t) ap_pool_cleanup_set_null(void *data_)
2318 void **ptr = (void **)data_;
2323 AP_DECLARE(apr_status_t) ap_str2_alnum(const char *src, char *dest) {
2325 for ( ; *src; src++, dest++)
2327 if (!apr_isprint(*src))
2329 else if (!apr_isalnum(*src))
2339 AP_DECLARE(apr_status_t) ap_pstr2_alnum(apr_pool_t *p, const char *src,
2342 char *new = apr_palloc(p, strlen(src)+1);
2346 return ap_str2_alnum(src, new);
2350 * Read the body and parse any form found, which must be of the
2351 * type application/x-www-form-urlencoded.
2353 * Name/value pairs are returned in an array, with the names as
2354 * strings with a maximum length of HUGE_STRING_LEN, and the
2355 * values as bucket brigades. This allows values to be arbitrarily
2358 * All url-encoding is removed from both the names and the values
2359 * on the fly. The names are interpreted as strings, while the
2360 * values are interpreted as blocks of binary data, that may
2361 * contain the 0 character.
2363 * In order to ensure that resource limits are not exceeded, a
2364 * maximum size must be provided. If the sum of the lengths of
2365 * the names and the values exceed this size, this function
2366 * will return HTTP_REQUEST_ENTITY_TOO_LARGE.
2368 * An optional number of parameters can be provided, if the number
2369 * of parameters provided exceeds this amount, this function will
2370 * return HTTP_REQUEST_ENTITY_TOO_LARGE. If this value is negative,
2371 * no limit is imposed, and the number of parameters is in turn
2372 * constrained by the size parameter above.
2374 * This function honours any kept_body configuration, and the
2375 * original raw request body will be saved to the kept_body brigade
2376 * if so configured, just as ap_discard_request_body does.
2378 * NOTE: File upload is not yet supported, but can be without change
2379 * to the function call.
2382 /* form parsing stuff */
2393 AP_DECLARE(int) ap_parse_form_data(request_rec *r, ap_filter_t *f,
2394 apr_array_header_t **ptr,
2395 apr_size_t num, apr_size_t usize)
2397 apr_bucket_brigade *bb = NULL;
2399 char buffer[HUGE_STRING_LEN + 1];
2401 apr_size_t offset = 0;
2403 ap_form_type_t state = FORM_NAME, percent = FORM_NORMAL;
2404 ap_form_pair_t *pair = NULL;
2405 apr_array_header_t *pairs = apr_array_make(r->pool, 4, sizeof(ap_form_pair_t));
2412 /* sanity check - we only support forms for now */
2413 ct = apr_table_get(r->headers_in, "Content-Type");
2414 if (!ct || strncasecmp("application/x-www-form-urlencoded", ct, 33)) {
2415 return ap_discard_request_body(r);
2418 if (usize > APR_SIZE_MAX >> 1)
2419 size = APR_SIZE_MAX >> 1;
2424 f = r->input_filters;
2427 bb = apr_brigade_create(r->pool, r->connection->bucket_alloc);
2429 apr_bucket *bucket = NULL, *last = NULL;
2431 int rv = ap_get_brigade(f, bb, AP_MODE_READBYTES,
2432 APR_BLOCK_READ, HUGE_STRING_LEN);
2433 if (rv != APR_SUCCESS) {
2434 apr_brigade_destroy(bb);
2435 return (rv == AP_FILTER_ERROR) ? rv : HTTP_BAD_REQUEST;
2438 for (bucket = APR_BRIGADE_FIRST(bb);
2439 bucket != APR_BRIGADE_SENTINEL(bb);
2440 last = bucket, bucket = APR_BUCKET_NEXT(bucket)) {
2442 apr_size_t len, slide;
2445 apr_bucket_delete(last);
2447 if (APR_BUCKET_IS_EOS(bucket)) {
2451 if (bucket->length == 0) {
2455 rv = apr_bucket_read(bucket, &data, &len, APR_BLOCK_READ);
2456 if (rv != APR_SUCCESS) {
2457 apr_brigade_destroy(bb);
2458 return HTTP_BAD_REQUEST;
2462 while (state != FORM_ABORT && slide-- > 0 && size >= 0 && num != 0) {
2467 else if ('&' == c) {
2471 percent = FORM_PERCENTA;
2474 if (FORM_PERCENTA == percent) {
2478 else if (c >= 'A') {
2481 else if (c >= '0') {
2485 percent = FORM_PERCENTB;
2488 if (FORM_PERCENTB == percent) {
2492 else if (c >= 'A') {
2495 else if (c >= '0') {
2499 percent = FORM_NORMAL;
2504 const char *tmp = apr_pmemdup(r->pool, buffer, offset);
2505 apr_bucket *b = apr_bucket_pool_create(tmp, offset, r->pool, r->connection->bucket_alloc);
2506 APR_BRIGADE_INSERT_TAIL(pair->value, b);
2514 if (offset < HUGE_STRING_LEN) {
2518 pair = (ap_form_pair_t *) apr_array_push(pairs);
2519 pair->name = apr_pstrdup(r->pool, buffer);
2520 pair->value = apr_brigade_create(r->pool, r->connection->bucket_alloc);
2524 buffer[offset++] = c;
2533 if (offset >= HUGE_STRING_LEN) {
2534 const char *tmp = apr_pmemdup(r->pool, buffer, offset);
2535 apr_bucket *b = apr_bucket_pool_create(tmp, offset, r->pool, r->connection->bucket_alloc);
2536 APR_BRIGADE_INSERT_TAIL(pair->value, b);
2539 buffer[offset++] = c;
2549 apr_brigade_cleanup(bb);
2550 } while (!seen_eos);
2552 if (FORM_ABORT == state || size < 0 || num == 0) {
2553 return HTTP_REQUEST_ENTITY_TOO_LARGE;
2555 else if (FORM_VALUE == state && pair && offset > 0) {
2556 const char *tmp = apr_pmemdup(r->pool, buffer, offset);
2557 apr_bucket *b = apr_bucket_pool_create(tmp, offset, r->pool, r->connection->bucket_alloc);
2558 APR_BRIGADE_INSERT_TAIL(pair->value, b);
2565 #define VARBUF_SMALL_SIZE 2048
2566 #define VARBUF_MAX_SIZE (APR_SIZE_MAX - 1 - \
2567 APR_ALIGN_DEFAULT(sizeof(struct ap_varbuf_info)))
2569 struct ap_varbuf_info {
2570 struct apr_memnode_t *node;
2571 apr_allocator_t *allocator;
2574 static apr_status_t varbuf_cleanup(void *info_)
2576 struct ap_varbuf_info *info = info_;
2577 info->node->next = NULL;
2578 apr_allocator_free(info->allocator, info->node);
2582 const char nul = '\0';
2583 static char * const varbuf_empty = (char *)&nul;
2585 AP_DECLARE(void) ap_varbuf_init(apr_pool_t *p, struct ap_varbuf *vb,
2586 apr_size_t init_size)
2588 vb->buf = varbuf_empty;
2590 vb->strlen = AP_VARBUF_UNKNOWN;
2594 ap_varbuf_grow(vb, init_size);
2597 AP_DECLARE(void) ap_varbuf_grow(struct ap_varbuf *vb, apr_size_t new_len)
2599 apr_memnode_t *new_node = NULL;
2600 apr_allocator_t *allocator;
2601 struct ap_varbuf_info *new_info;
2604 AP_DEBUG_ASSERT(vb->strlen == AP_VARBUF_UNKNOWN || vb->avail >= vb->strlen);
2606 if (new_len <= vb->avail)
2609 if (new_len < 2 * vb->avail && vb->avail < VARBUF_MAX_SIZE/2) {
2610 /* at least double the size, to avoid repeated reallocations */
2611 new_len = 2 * vb->avail;
2613 else if (new_len > VARBUF_MAX_SIZE) {
2614 apr_abortfunc_t abort_fn = apr_pool_abort_get(vb->pool);
2615 ap_assert(abort_fn != NULL);
2616 abort_fn(APR_ENOMEM);
2620 new_len++; /* add space for trailing \0 */
2621 if (new_len <= VARBUF_SMALL_SIZE) {
2622 new_len = APR_ALIGN_DEFAULT(new_len);
2623 new = apr_palloc(vb->pool, new_len);
2624 if (vb->avail && vb->strlen != 0) {
2625 AP_DEBUG_ASSERT(vb->buf != NULL);
2626 AP_DEBUG_ASSERT(vb->buf != varbuf_empty);
2627 if (new == vb->buf + vb->avail + 1) {
2628 /* We are lucky: the new memory lies directly after our old
2629 * buffer, we can now use both.
2631 vb->avail += new_len;
2635 /* copy up to vb->strlen + 1 bytes */
2636 memcpy(new, vb->buf, vb->strlen == AP_VARBUF_UNKNOWN ?
2637 vb->avail + 1 : vb->strlen + 1);
2643 vb->avail = new_len - 1;
2648 /* The required block is rather larger. Use allocator directly so that
2649 * the memory can be freed independently from the pool. */
2650 allocator = apr_pool_allocator_get(vb->pool);
2651 if (new_len <= VARBUF_MAX_SIZE)
2652 new_node = apr_allocator_alloc(allocator,
2653 new_len + APR_ALIGN_DEFAULT(sizeof(*new_info)));
2655 apr_abortfunc_t abort_fn = apr_pool_abort_get(vb->pool);
2656 ap_assert(abort_fn != NULL);
2657 abort_fn(APR_ENOMEM);
2660 new_info = (struct ap_varbuf_info *)new_node->first_avail;
2661 new_node->first_avail += APR_ALIGN_DEFAULT(sizeof(*new_info));
2662 new_info->node = new_node;
2663 new_info->allocator = allocator;
2664 new = new_node->first_avail;
2665 AP_DEBUG_ASSERT(new_node->endp - new_node->first_avail >= new_len);
2666 new_len = new_node->endp - new_node->first_avail;
2668 if (vb->avail && vb->strlen != 0)
2669 memcpy(new, vb->buf, vb->strlen == AP_VARBUF_UNKNOWN ?
2670 vb->avail + 1 : vb->strlen + 1);
2674 apr_pool_cleanup_run(vb->pool, vb->info, varbuf_cleanup);
2675 apr_pool_cleanup_register(vb->pool, new_info, varbuf_cleanup,
2676 apr_pool_cleanup_null);
2677 vb->info = new_info;
2679 vb->avail = new_len - 1;
2682 AP_DECLARE(void) ap_varbuf_strmemcat(struct ap_varbuf *vb, const char *str,
2688 ap_varbuf_grow(vb, len);
2689 memcpy(vb->buf, str, len);
2690 vb->buf[len] = '\0';
2694 if (vb->strlen == AP_VARBUF_UNKNOWN)
2695 vb->strlen = strlen(vb->buf);
2696 ap_varbuf_grow(vb, vb->strlen + len);
2697 memcpy(vb->buf + vb->strlen, str, len);
2699 vb->buf[vb->strlen] = '\0';
2702 AP_DECLARE(void) ap_varbuf_free(struct ap_varbuf *vb)
2705 apr_pool_cleanup_run(vb->pool, vb->info, varbuf_cleanup);
2711 AP_DECLARE(char *) ap_varbuf_pdup(apr_pool_t *p, struct ap_varbuf *buf,
2712 const char *prepend, apr_size_t prepend_len,
2713 const char *append, apr_size_t append_len,
2714 apr_size_t *new_len)
2717 struct iovec vec[3];
2720 vec[i].iov_base = (void *)prepend;
2721 vec[i].iov_len = prepend_len;
2724 if (buf->avail && buf->strlen) {
2725 if (buf->strlen == AP_VARBUF_UNKNOWN)
2726 buf->strlen = strlen(buf->buf);
2727 vec[i].iov_base = (void *)buf->buf;
2728 vec[i].iov_len = buf->strlen;
2732 vec[i].iov_base = (void *)append;
2733 vec[i].iov_len = append_len;
2737 return apr_pstrcatv(p, vec, i, new_len);
2744 AP_DECLARE(apr_status_t) ap_varbuf_regsub(struct ap_varbuf *vb,
2748 ap_regmatch_t pmatch[],
2751 return regsub_core(NULL, NULL, vb, input, source, nmatch, pmatch, maxlen);
2754 static const char * const oom_message = "[crit] Memory allocation failed, "
2755 "aborting process." APR_EOL_STR;
2757 AP_DECLARE(void) ap_abort_on_oom()
2759 int written, count = strlen(oom_message);
2760 const char *buf = oom_message;
2762 written = write(STDERR_FILENO, buf, count);
2763 if (written == count)
2769 } while (written >= 0 || errno == EINTR);
2773 AP_DECLARE(void *) ap_malloc(size_t size)
2775 void *p = malloc(size);
2776 if (p == NULL && size != 0)
2781 AP_DECLARE(void *) ap_calloc(size_t nelem, size_t size)
2783 void *p = calloc(nelem, size);
2784 if (p == NULL && nelem != 0 && size != 0)
2789 AP_DECLARE(void *) ap_realloc(void *ptr, size_t size)
2791 void *p = realloc(ptr, size);
2792 if (p == NULL && size != 0)
2797 AP_DECLARE(void) ap_get_sload(ap_sload_t *ld)
2799 int i, j, server_limit, thread_limit;
2803 ap_generation_t mpm_generation;
2805 /* preload errored fields, we overwrite */
2808 ld->bytes_served = 0;
2809 ld->access_count = 0;
2811 ap_mpm_query(AP_MPMQ_GENERATION, &mpm_generation);
2812 ap_mpm_query(AP_MPMQ_HARD_LIMIT_THREADS, &thread_limit);
2813 ap_mpm_query(AP_MPMQ_HARD_LIMIT_DAEMONS, &server_limit);
2815 for (i = 0; i < server_limit; i++) {
2817 ps = ap_get_scoreboard_process(i);
2819 for (j = 0; j < thread_limit; j++) {
2821 worker_score *ws = NULL;
2822 ws = &ap_scoreboard_image->servers[i][j];
2825 if (!ps->quiescing && ps->pid) {
2826 if (res == SERVER_READY && ps->generation == mpm_generation) {
2829 else if (res != SERVER_DEAD &&
2830 res != SERVER_STARTING && res != SERVER_IDLE_KILL &&
2831 ps->generation == mpm_generation) {
2836 if (ap_extended_status && !ps->quiescing && ps->pid) {
2837 if (ws->access_count != 0
2838 || (res != SERVER_READY && res != SERVER_DEAD)) {
2839 ld->access_count += ws->access_count;
2840 ld->bytes_served += ws->bytes_served;
2845 total = busy + ready;
2847 ld->idle = ready * 100 / total;
2848 ld->busy = busy * 100 / total;
2852 AP_DECLARE(void) ap_get_loadavg(ap_loadavg_t *ld)
2854 /* preload errored fields, we overwrite */
2856 ld->loadavg5 = -1.0;
2857 ld->loadavg15 = -1.0;
2864 num = getloadavg(la, 3);
2866 ld->loadavg = (float)la[0];
2869 ld->loadavg5 = (float)la[1];
2872 ld->loadavg15 = (float)la[2];