util.c revision 9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder/* Licensed to the Apache Software Foundation (ASF) under one or more
e9458b1a7a19a63aa4c179f9ab20f4d50681c168Jens Elkner * contributor license agreements. See the NOTICE file distributed with
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * this work for additional information regarding copyright ownership.
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * The ASF licenses this file to You under the Apache License, Version 2.0
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * (the "License"); you may not use this file except in compliance with
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * the License. You may obtain a copy of the License at
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder *
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * http://www.apache.org/licenses/LICENSE-2.0
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder *
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * Unless required by applicable law or agreed to in writing, software
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * distributed under the License is distributed on an "AS IS" BASIS,
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * See the License for the specific language governing permissions and
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * limitations under the License.
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder */
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder/*
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * util.c: string utility things
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder *
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * 3/21/93 Rob McCool
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * 1995-96 Many changes by the Apache Software Foundation
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder *
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder */
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder/* Debugging aid:
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * #define DEBUG to trace all cfg_open*()/cfg_closefile() calls
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * #define DEBUG_CFG_LINES to trace every line read from the config files
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder */
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include "apr.h"
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include "apr_strings.h"
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include "apr_lib.h"
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#define APR_WANT_STDIO
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#define APR_WANT_STRFUNC
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include "apr_want.h"
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#if APR_HAVE_UNISTD_H
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include <unistd.h>
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#endif
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#if APR_HAVE_NETDB_H
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include <netdb.h> /* for gethostbyname() */
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#endif
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include "ap_config.h"
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include "apr_base64.h"
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include "httpd.h"
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include "http_main.h"
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include "http_log.h"
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include "http_protocol.h"
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include "http_config.h"
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include "util_ebcdic.h"
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#ifdef HAVE_PWD_H
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include <pwd.h>
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#endif
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#ifdef HAVE_GRP_H
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include <grp.h>
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#endif
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder/* A bunch of functions in util.c scan strings looking for certain characters.
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * To make that more efficient we encode a lookup table. The test_char_table
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * is generated automatically by gen_test_char.c.
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder */
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#include "test_char.h"
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder/* we assume the folks using this ensure 0 <= c < 256... which means
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * you need a cast to (unsigned char) first, you can't just plug a
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * char in here and get it to work, because if char is signed then it
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * will first be sign extended.
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder */
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#define TEST_CHAR(c, f) (test_char_table[(unsigned)(c)] & (f))
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder/* Win32/NetWare/OS2 need to check for both forward and back slashes
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * in ap_getparents() and ap_escape_url.
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder */
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#ifdef CASE_BLIND_FILESYSTEM
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#define IS_SLASH(s) ((s == '/') || (s == '\\'))
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#else
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#define IS_SLASH(s) (s == '/')
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder#endif
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder/*
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * Examine a field value (such as a media-/content-type) string and return
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder */
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von SchroederAP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype)
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder{
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder const char *semi;
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder if (intype == NULL) return NULL;
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder semi = ap_strchr_c(intype, ';');
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder if (semi == NULL) {
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder return apr_pstrdup(p, intype);
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder }
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder else {
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder while ((semi > intype) && apr_isspace(semi[-1])) {
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder semi--;
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder }
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder return apr_pstrndup(p, intype, semi - intype);
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder }
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder}
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von SchroederAP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt,
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder int gmt)
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder{
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder apr_size_t retcode;
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder char ts[MAX_STRING_LEN];
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder char tf[MAX_STRING_LEN];
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder apr_time_exp_t xt;
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder if (gmt) {
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder const char *f;
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder char *strp;
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder apr_time_exp_gmt(&xt, t);
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder /* Convert %Z to "GMT" and %z to "+0000";
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * on hosts that do not have a time zone string in struct tm,
081559cfba7150d19604bdeafdc2d9983f7216b3Jonathan von Schroeder * strftime must assume its argument is local time.
*/
for(strp = tf, f = fmt; strp < tf + sizeof(tf) - 6 && (*strp = *f)
; f++, strp++) {
if (*f != '%') continue;
switch (f[1]) {
case '%':
*++strp = *++f;
break;
case 'Z':
*strp++ = 'G';
*strp++ = 'M';
*strp = 'T';
f++;
break;
case 'z': /* common extension */
*strp++ = '+';
*strp++ = '0';
*strp++ = '0';
*strp++ = '0';
*strp = '0';
f++;
break;
}
}
*strp = '\0';
fmt = tf;
}
else {
apr_time_exp_lt(&xt, t);
}
/* check return code? */
apr_strftime(ts, &retcode, MAX_STRING_LEN, fmt, &xt);
ts[MAX_STRING_LEN - 1] = '\0';
return apr_pstrdup(p, ts);
}
/* Roy owes Rob beer. */
/* Rob owes Roy dinner. */
/* These legacy comments would make a lot more sense if Roy hadn't
* replaced the old later_than() routine with util_date.c.
*
* Well, okay, they still wouldn't make any sense.
*/
/* Match = 0, NoMatch = 1, Abort = -1
* Based loosely on sections of wildmat.c by Rich Salz
* Hmmm... shouldn't this really go component by component?
*/
AP_DECLARE(int) ap_strcmp_match(const char *str, const char *expected)
{
int x, y;
for (x = 0, y = 0; expected[y]; ++y, ++x) {
if ((!str[x]) && (expected[y] != '*'))
return -1;
if (expected[y] == '*') {
while (expected[++y] == '*');
if (!expected[y])
return 0;
while (str[x]) {
int ret;
if ((ret = ap_strcmp_match(&str[x++], &expected[y])) != 1)
return ret;
}
return -1;
}
else if ((expected[y] != '?') && (str[x] != expected[y]))
return 1;
}
return (str[x] != '\0');
}
AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *expected)
{
int x, y;
for (x = 0, y = 0; expected[y]; ++y, ++x) {
if (!str[x] && expected[y] != '*')
return -1;
if (expected[y] == '*') {
while (expected[++y] == '*');
if (!expected[y])
return 0;
while (str[x]) {
int ret;
if ((ret = ap_strcasecmp_match(&str[x++], &expected[y])) != 1)
return ret;
}
return -1;
}
else if (expected[y] != '?'
&& apr_tolower(str[x]) != apr_tolower(expected[y]))
return 1;
}
return (str[x] != '\0');
}
/* We actually compare the canonical root to this root, (but we don't
* waste time checking the case), since every use of this function in
* httpd-2.1 tests if the path is 'proper', meaning we've already passed
* it through apr_filepath_merge, or we haven't.
*/
AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir)
{
const char *newpath;
const char *ourdir = dir;
if (apr_filepath_root(&newpath, &dir, 0, p) != APR_SUCCESS
|| strncmp(newpath, ourdir, strlen(newpath)) != 0) {
return 0;
}
return 1;
}
AP_DECLARE(int) ap_is_matchexp(const char *str)
{
register int x;
for (x = 0; str[x]; x++)
if ((str[x] == '*') || (str[x] == '?'))
return 1;
return 0;
}
/*
* Here's a pool-based interface to the POSIX-esque ap_regcomp().
* Note that we return ap_regex_t instead of being passed one.
* The reason is that if you use an already-used ap_regex_t structure,
* the memory that you've already allocated gets forgotten, and
* regfree() doesn't clear it. So we don't allow it.
*/
static apr_status_t regex_cleanup(void *preg)
{
ap_regfree((ap_regex_t *) preg);
return APR_SUCCESS;
}
AP_DECLARE(ap_regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
int cflags)
{
ap_regex_t *preg = apr_palloc(p, sizeof *preg);
if (ap_regcomp(preg, pattern, cflags)) {
return NULL;
}
apr_pool_cleanup_register(p, (void *) preg, regex_cleanup,
apr_pool_cleanup_null);
return preg;
}
AP_DECLARE(void) ap_pregfree(apr_pool_t *p, ap_regex_t *reg)
{
ap_regfree(reg);
apr_pool_cleanup_kill(p, (void *) reg, regex_cleanup);
}
/*
* Similar to standard strstr() but we ignore case in this version.
* Based on the strstr() implementation further below.
*/
AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2)
{
char *p1, *p2;
if (*s2 == '\0') {
/* an empty s2 */
return((char *)s1);
}
while(1) {
for ( ; (*s1 != '\0') && (apr_tolower(*s1) != apr_tolower(*s2)); s1++);
if (*s1 == '\0') {
return(NULL);
}
/* found first character of s2, see if the rest matches */
p1 = (char *)s1;
p2 = (char *)s2;
for (++p1, ++p2; apr_tolower(*p1) == apr_tolower(*p2); ++p1, ++p2) {
if (*p1 == '\0') {
/* both strings ended together */
return((char *)s1);
}
}
if (*p2 == '\0') {
/* second string ended, a match */
break;
}
/* didn't find a match here, try starting at next character in s1 */
s1++;
}
return((char *)s1);
}
/*
* Returns an offsetted pointer in bigstring immediately after
* prefix. Returns bigstring if bigstring doesn't start with
* prefix or if prefix is longer than bigstring while still matching.
* NOTE: pointer returned is relative to bigstring, so we
* can use standard pointer comparisons in the calling function
* (eg: test if ap_stripprefix(a,b) == a)
*/
AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
const char *prefix)
{
const char *p1;
if (*prefix == '\0')
return bigstring;
p1 = bigstring;
while (*p1 && *prefix) {
if (*p1++ != *prefix++)
return bigstring;
}
if (*prefix == '\0')
return p1;
/* hit the end of bigstring! */
return bigstring;
}
/* This function substitutes for $0-$9, filling in regular expression
* submatches. Pass it the same nmatch and pmatch arguments that you
* passed ap_regexec(). pmatch should not be greater than the maximum number
* of subexpressions - i.e. one more than the re_nsub member of ap_regex_t.
*
* input should be the string with the $-expressions, source should be the
* string that was matched against.
*
* It returns the substituted string, or NULL on error.
*
* Parts of this code are based on Henry Spencer's regsub(), from his
* AT&T V8 regexp package.
*/
AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input,
const char *source, size_t nmatch,
ap_regmatch_t pmatch[])
{
const char *src = input;
char *dest, *dst;
char c;
size_t no;
int len;
if (!source)
return NULL;
if (!nmatch)
return apr_pstrdup(p, src);
/* First pass, find the size */
len = 0;
while ((c = *src++) != '\0') {
if (c == '&')
no = 0;
else if (c == '$' && apr_isdigit(*src))
no = *src++ - '0';
else
no = 10;
if (no > 9) { /* Ordinary character. */
if (c == '\\' && (*src == '$' || *src == '&'))
c = *src++;
len++;
}
else if (no < nmatch && pmatch[no].rm_so < pmatch[no].rm_eo) {
len += pmatch[no].rm_eo - pmatch[no].rm_so;
}
}
dest = dst = apr_pcalloc(p, len + 1);
/* Now actually fill in the string */
src = input;
while ((c = *src++) != '\0') {
if (c == '&')
no = 0;
else if (c == '$' && apr_isdigit(*src))
no = *src++ - '0';
else
no = 10;
if (no > 9) { /* Ordinary character. */
if (c == '\\' && (*src == '$' || *src == '&'))
c = *src++;
*dst++ = c;
}
else if (no < nmatch && pmatch[no].rm_so < pmatch[no].rm_eo) {
len = pmatch[no].rm_eo - pmatch[no].rm_so;
memcpy(dst, source + pmatch[no].rm_so, len);
dst += len;
}
}
*dst = '\0';
return dest;
}
/*
* Parse .. so we don't compromise security
*/
AP_DECLARE(void) ap_getparents(char *name)
{
char *next;
int l, w, first_dot;
/* Four paseses, as per RFC 1808 */
/* a) remove ./ path segments */
for (next = name; *next && (*next != '.'); next++) {
}
l = w = first_dot = next - name;
while (name[l] != '\0') {
if (name[l] == '.' && IS_SLASH(name[l + 1])
&& (l == 0 || IS_SLASH(name[l - 1])))
l += 2;
else
name[w++] = name[l++];
}
/* b) remove trailing . path, segment */
if (w == 1 && name[0] == '.')
w--;
else if (w > 1 && name[w - 1] == '.' && IS_SLASH(name[w - 2]))
w--;
name[w] = '\0';
/* c) remove all xx/../ segments. (including leading ../ and /../) */
l = first_dot;
while (name[l] != '\0') {
if (name[l] == '.' && name[l + 1] == '.' && IS_SLASH(name[l + 2])
&& (l == 0 || IS_SLASH(name[l - 1]))) {
register int m = l + 3, n;
l = l - 2;
if (l >= 0) {
while (l >= 0 && !IS_SLASH(name[l]))
l--;
l++;
}
else
l = 0;
n = l;
while ((name[n] = name[m]))
(++n, ++m);
}
else
++l;
}
/* d) remove trailing xx/.. segment. */
if (l == 2 && name[0] == '.' && name[1] == '.')
name[0] = '\0';
else if (l > 2 && name[l - 1] == '.' && name[l - 2] == '.'
&& IS_SLASH(name[l - 3])) {
l = l - 4;
if (l >= 0) {
while (l >= 0 && !IS_SLASH(name[l]))
l--;
l++;
}
else
l = 0;
name[l] = '\0';
}
}
AP_DECLARE(void) ap_no2slash(char *name)
{
char *d, *s;
s = d = name;
#ifdef HAVE_UNC_PATHS
/* Check for UNC names. Leave leading two slashes. */
if (s[0] == '/' && s[1] == '/')
*d++ = *s++;
#endif
while (*s) {
if ((*d++ = *s) == '/') {
do {
++s;
} while (*s == '/');
}
else {
++s;
}
}
*d = '\0';
}
/*
* copy at most n leading directories of s into d
* d should be at least as large as s plus 1 extra byte
* assumes n > 0
* the return value is the ever useful pointer to the trailing \0 of d
*
* MODIFIED FOR HAVE_DRIVE_LETTERS and NETWARE environments,
* so that if n == 0, "/" is returned in d with n == 1
* and s == "e:/test.html", "e:/" is returned in d
* *** See also directory_walk in modules/http/http_request.c
* examples:
* /a/b, 0 ==> / (true for all platforms)
* /a/b, 1 ==> /
* /a/b, 2 ==> /a/
* /a/b, 3 ==> /a/b/
* /a/b, 4 ==> /a/b/
*
* c:/a/b 0 ==> /
* c:/a/b 1 ==> c:/
* c:/a/b 2 ==> c:/a/
* c:/a/b 3 ==> c:/a/b
* c:/a/b 4 ==> c:/a/b
*/
AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n)
{
if (n < 1) {
*d = '/';
*++d = '\0';
return (d);
}
for (;;) {
if (*s == '\0' || (*s == '/' && (--n) == 0)) {
*d = '/';
break;
}
*d++ = *s++;
}
*++d = 0;
return (d);
}
/*
* return the parent directory name including trailing / of the file s
*/
AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s)
{
const char *last_slash = ap_strrchr_c(s, '/');
char *d;
int l;
if (last_slash == NULL) {
return apr_pstrdup(p, "");
}
l = (last_slash - s) + 1;
d = apr_palloc(p, l + 1);
memcpy(d, s, l);
d[l] = 0;
return (d);
}
AP_DECLARE(int) ap_count_dirs(const char *path)
{
register int x, n;
for (x = 0, n = 0; path[x]; x++)
if (path[x] == '/')
n++;
return n;
}
AP_DECLARE(char *) ap_getword_nc(apr_pool_t *atrans, char **line, char stop)
{
return ap_getword(atrans, (const char **) line, stop);
}
AP_DECLARE(char *) ap_getword(apr_pool_t *atrans, const char **line, char stop)
{
const char *pos = *line;
int len;
char *res;
while ((*pos != stop) && *pos) {
++pos;
}
len = pos - *line;
res = (char *)apr_palloc(atrans, len + 1);
memcpy(res, *line, len);
res[len] = 0;
if (stop) {
while (*pos == stop) {
++pos;
}
}
*line = pos;
return res;
}
AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *atrans, char **line)
{
return ap_getword_white(atrans, (const char **) line);
}
AP_DECLARE(char *) ap_getword_white(apr_pool_t *atrans, const char **line)
{
const char *pos = *line;
int len;
char *res;
while (!apr_isspace(*pos) && *pos) {
++pos;
}
len = pos - *line;
res = (char *)apr_palloc(atrans, len + 1);
memcpy(res, *line, len);
res[len] = 0;
while (apr_isspace(*pos)) {
++pos;
}
*line = pos;
return res;
}
AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *atrans, char **line,
char stop)
{
return ap_getword_nulls(atrans, (const char **) line, stop);
}
AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *atrans, const char **line,
char stop)
{
const char *pos = ap_strchr_c(*line, stop);
char *res;
if (!pos) {
res = apr_pstrdup(atrans, *line);
*line += strlen(*line);
return res;
}
res = apr_pstrndup(atrans, *line, pos - *line);
++pos;
*line = pos;
return res;
}
/* Get a word, (new) config-file style --- quoted strings and backslashes
* all honored
*/
static char *substring_conf(apr_pool_t *p, const char *start, int len,
char quote)
{
char *result = apr_palloc(p, len + 2);
char *resp = result;
int i;
for (i = 0; i < len; ++i) {
if (start[i] == '\\' && (start[i + 1] == '\\'
|| (quote && start[i + 1] == quote)))
*resp++ = start[++i];
else
*resp++ = start[i];
}
*resp++ = '\0';
#if RESOLVE_ENV_PER_TOKEN
return (char *)ap_resolve_env(p,result);
#else
return result;
#endif
}
AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line)
{
return ap_getword_conf(p, (const char **) line);
}
AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line)
{
const char *str = *line, *strend;
char *res;
char quote;
while (*str && apr_isspace(*str))
++str;
if (!*str) {
*line = str;
return "";
}
if ((quote = *str) == '"' || quote == '\'') {
strend = str + 1;
while (*strend && *strend != quote) {
if (*strend == '\\' && strend[1] &&
(strend[1] == quote || strend[1] == '\\')) {
strend += 2;
}
else {
++strend;
}
}
res = substring_conf(p, str + 1, strend - str - 1, quote);
if (*strend == quote)
++strend;
}
else {
strend = str;
while (*strend && !apr_isspace(*strend))
++strend;
res = substring_conf(p, str, strend - str, 0);
}
while (*strend && apr_isspace(*strend))
++strend;
*line = strend;
return res;
}
/* Check a string for any ${ENV} environment variable
* construct and replace each them by the value of
* that environment variable, if it exists. If the
* environment value does not exist, leave the ${ENV}
* construct alone; it means something else.
*/
AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word)
{
# define SMALL_EXPANSION 5
struct sll {
struct sll *next;
const char *string;
apr_size_t len;
} *result, *current, sresult[SMALL_EXPANSION];
char *res_buf, *cp;
const char *s, *e, *ep;
unsigned spc;
apr_size_t outlen;
s = ap_strchr_c(word, '$');
if (!s) {
return word;
}
/* well, actually something to do */
ep = word + strlen(word);
spc = 0;
result = current = &(sresult[spc++]);
current->next = NULL;
current->string = word;
current->len = s - word;
outlen = current->len;
do {
/* prepare next entry */
if (current->len) {
current->next = (spc < SMALL_EXPANSION)
? &(sresult[spc++])
: (struct sll *)apr_palloc(p,
sizeof(*current->next));
current = current->next;
current->next = NULL;
current->len = 0;
}
if (*s == '$') {
if (s[1] == '{' && (e = ap_strchr_c(s, '}'))) {
word = getenv(apr_pstrndup(p, s+2, e-s-2));
if (word) {
current->string = word;
current->len = strlen(word);
outlen += current->len;
}
else {
current->string = s;
current->len = e - s + 1;
outlen += current->len;
}
s = e + 1;
}
else {
current->string = s++;
current->len = 1;
++outlen;
}
}
else {
word = s;
s = ap_strchr_c(s, '$');
current->string = word;
current->len = s ? s - word : ep - word;
outlen += current->len;
}
} while (s && *s);
/* assemble result */
res_buf = cp = apr_palloc(p, outlen + 1);
do {
if (result->len) {
memcpy(cp, result->string, result->len);
cp += result->len;
}
result = result->next;
} while (result);
res_buf[outlen] = '\0';
return res_buf;
}
AP_DECLARE(int) ap_cfg_closefile(ap_configfile_t *cfp)
{
#ifdef DEBUG
ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, NULL,
"Done with config file %s", cfp->name);
#endif
return (cfp->close == NULL) ? 0 : cfp->close(cfp->param);
}
static apr_status_t cfg_close(void *param)
{
apr_file_t *cfp = (apr_file_t *) param;
return (apr_file_close(cfp));
}
static int cfg_getch(void *param)
{
char ch;
apr_file_t *cfp = (apr_file_t *) param;
if (apr_file_getc(&ch, cfp) == APR_SUCCESS)
return ch;
return (int)EOF;
}
static void *cfg_getstr(void *buf, size_t bufsiz, void *param)
{
apr_file_t *cfp = (apr_file_t *) param;
apr_status_t rv;
rv = apr_file_gets(buf, bufsiz, cfp);
if (rv == APR_SUCCESS) {
return buf;
}
return NULL;
}
/* Open a ap_configfile_t as FILE, return open ap_configfile_t struct pointer */
AP_DECLARE(apr_status_t) ap_pcfg_openfile(ap_configfile_t **ret_cfg,
apr_pool_t *p, const char *name)
{
ap_configfile_t *new_cfg;
apr_file_t *file = NULL;
apr_finfo_t finfo;
apr_status_t status;
#ifdef DEBUG
char buf[120];
#endif
if (name == NULL) {
ap_log_error(APLOG_MARK, APLOG_ERR, 0, NULL,
"Internal error: pcfg_openfile() called with NULL filename");
return APR_EBADF;
}
status = apr_file_open(&file, name, APR_READ | APR_BUFFERED,
APR_OS_DEFAULT, p);
#ifdef DEBUG
ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, NULL,
"Opening config file %s (%s)",
name, (status != APR_SUCCESS) ?
apr_strerror(status, buf, sizeof(buf)) : "successful");
#endif
if (status != APR_SUCCESS)
return status;
status = apr_file_info_get(&finfo, APR_FINFO_TYPE, file);
if (status != APR_SUCCESS)
return status;
if (finfo.filetype != APR_REG &&
#if defined(WIN32) || defined(OS2) || defined(NETWARE)
strcasecmp(apr_filepath_name_get(name), "nul") != 0) {
#else
strcmp(name, "/dev/null") != 0) {
#endif /* WIN32 || OS2 */
ap_log_error(APLOG_MARK, APLOG_ERR, 0, NULL,
"Access to file %s denied by server: not a regular file",
name);
apr_file_close(file);
return APR_EBADF;
}
#ifdef WIN32
/* Some twisted character [no pun intended] at MS decided that a
* zero width joiner as the lead wide character would be ideal for
* describing Unicode text files. This was further convoluted to
* another MSism that the same character mapped into utf-8, EF BB BF
* would signify utf-8 text files.
*
* Since MS configuration files are all protecting utf-8 encoded
* Unicode path, file and resource names, we already have the correct
* WinNT encoding. But at least eat the stupid three bytes up front.
*/
{
unsigned char buf[4];
apr_size_t len = 3;
status = apr_file_read(file, buf, &len);
if ((status != APR_SUCCESS) || (len < 3)
|| memcmp(buf, "\xEF\xBB\xBF", 3) != 0) {
apr_off_t zero = 0;
apr_file_seek(file, APR_SET, &zero);
}
}
#endif
new_cfg = apr_palloc(p, sizeof(*new_cfg));
new_cfg->param = file;
new_cfg->name = apr_pstrdup(p, name);
new_cfg->getch = (int (*)(void *)) cfg_getch;
new_cfg->getstr = (void *(*)(void *, size_t, void *)) cfg_getstr;
new_cfg->close = (int (*)(void *)) cfg_close;
new_cfg->line_number = 0;
*ret_cfg = new_cfg;
return APR_SUCCESS;
}
/* Allocate a ap_configfile_t handle with user defined functions and params */
AP_DECLARE(ap_configfile_t *) ap_pcfg_open_custom(apr_pool_t *p,
const char *descr,
void *param,
int(*getch)(void *param),
void *(*getstr) (void *buf, size_t bufsiz, void *param),
int(*close_func)(void *param))
{
ap_configfile_t *new_cfg = apr_palloc(p, sizeof(*new_cfg));
#ifdef DEBUG
ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, NULL,
"Opening config handler %s", descr);
#endif
new_cfg->param = param;
new_cfg->name = descr;
new_cfg->getch = getch;
new_cfg->getstr = getstr;
new_cfg->close = close_func;
new_cfg->line_number = 0;
return new_cfg;
}
/* Read one character from a configfile_t */
AP_DECLARE(int) ap_cfg_getc(ap_configfile_t *cfp)
{
register int ch = cfp->getch(cfp->param);
if (ch == LF)
++cfp->line_number;
return ch;
}
/* Read one line from open ap_configfile_t, strip LF, increase line number */
/* If custom handler does not define a getstr() function, read char by char */
AP_DECLARE(int) ap_cfg_getline(char *buf, size_t bufsize, ap_configfile_t *cfp)
{
/* If a "get string" function is defined, use it */
if (cfp->getstr != NULL) {
char *src, *dst;
char *cp;
char *cbuf = buf;
size_t cbufsize = bufsize;
while (1) {
++cfp->line_number;
if (cfp->getstr(cbuf, cbufsize, cfp->param) == NULL)
return 1;
/*
* check for line continuation,
* i.e. match [^\\]\\[\r]\n only
*/
cp = cbuf;
while (cp < cbuf+cbufsize && *cp != '\0')
cp++;
if (cp > cbuf && cp[-1] == LF) {
cp--;
if (cp > cbuf && cp[-1] == CR)
cp--;
if (cp > cbuf && cp[-1] == '\\') {
cp--;
if (!(cp > cbuf && cp[-1] == '\\')) {
/*
* line continuation requested -
* then remove backslash and continue
*/
cbufsize -= (cp-cbuf);
cbuf = cp;
continue;
}
else {
/*
* no real continuation because escaped -
* then just remove escape character
*/
for ( ; cp < cbuf+cbufsize && *cp != '\0'; cp++)
cp[0] = cp[1];
}
}
}
break;
}
/*
* Leading and trailing white space is eliminated completely
*/
src = buf;
while (apr_isspace(*src))
++src;
/* blast trailing whitespace */
dst = &src[strlen(src)];
while (--dst >= src && apr_isspace(*dst))
*dst = '\0';
/* Zap leading whitespace by shifting */
if (src != buf)
for (dst = buf; (*dst++ = *src++) != '\0'; )
;
#ifdef DEBUG_CFG_LINES
ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, NULL, "Read config: %s", buf);
#endif
return 0;
} else {
/* No "get string" function defined; read character by character */
register int c;
register size_t i = 0;
buf[0] = '\0';
/* skip leading whitespace */
do {
c = cfp->getch(cfp->param);
} while (c == '\t' || c == ' ');
if (c == EOF)
return 1;
if(bufsize < 2) {
/* too small, assume caller is crazy */
return 1;
}
while (1) {
if ((c == '\t') || (c == ' ')) {
buf[i++] = ' ';
while ((c == '\t') || (c == ' '))
c = cfp->getch(cfp->param);
}
if (c == CR) {
/* silently ignore CR (_assume_ that a LF follows) */
c = cfp->getch(cfp->param);
}
if (c == LF) {
/* increase line number and return on LF */
++cfp->line_number;
}
if (c == EOF || c == 0x4 || c == LF || i >= (bufsize - 2)) {
/*
* check for line continuation
*/
if (i > 0 && buf[i-1] == '\\') {
i--;
if (!(i > 0 && buf[i-1] == '\\')) {
/* line is continued */
c = cfp->getch(cfp->param);
continue;
}
/* else nothing needs be done because
* then the backslash is escaped and
* we just strip to a single one
*/
}
/* blast trailing whitespace */
while (i > 0 && apr_isspace(buf[i - 1]))
--i;
buf[i] = '\0';
#ifdef DEBUG_CFG_LINES
ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, NULL,
"Read config: %s", buf);
#endif
return 0;
}
buf[i] = c;
++i;
c = cfp->getch(cfp->param);
}
}
}
/* Size an HTTP header field list item, as separated by a comma.
* The return value is a pointer to the beginning of the non-empty list item
* within the original string (or NULL if there is none) and the address
* of field is shifted to the next non-comma, non-whitespace character.
* len is the length of the item excluding any beginning whitespace.
*/
AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len)
{
const unsigned char *ptr = (const unsigned char *)*field;
const unsigned char *token;
int in_qpair, in_qstr, in_com;
/* Find first non-comma, non-whitespace byte */
while (*ptr == ',' || apr_isspace(*ptr))
++ptr;
token = ptr;
/* Find the end of this item, skipping over dead bits */
for (in_qpair = in_qstr = in_com = 0;
*ptr && (in_qpair || in_qstr || in_com || *ptr != ',');
++ptr) {
if (in_qpair) {
in_qpair = 0;
}
else {
switch (*ptr) {
case '\\': in_qpair = 1; /* quoted-pair */
break;
case '"' : if (!in_com) /* quoted string delim */
in_qstr = !in_qstr;
break;
case '(' : if (!in_qstr) /* comment (may nest) */
++in_com;
break;
case ')' : if (in_com) /* end comment */
--in_com;
break;
default : break;
}
}
}
if ((*len = (ptr - token)) == 0) {
*field = (const char *)ptr;
return NULL;
}
/* Advance field pointer to the next non-comma, non-white byte */
while (*ptr == ',' || apr_isspace(*ptr))
++ptr;
*field = (const char *)ptr;
return (const char *)token;
}
/* Retrieve an HTTP header field list item, as separated by a comma,
* while stripping insignificant whitespace and lowercasing anything not in
* a quoted string or comment. The return value is a new string containing
* the converted list item (or NULL if none) and the address pointed to by
* field is shifted to the next non-comma, non-whitespace.
*/
AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field)
{
const char *tok_start;
const unsigned char *ptr;
unsigned char *pos;
char *token;
int addspace = 0, in_qpair = 0, in_qstr = 0, in_com = 0, tok_len = 0;
/* Find the beginning and maximum length of the list item so that
* we can allocate a buffer for the new string and reset the field.
*/
if ((tok_start = ap_size_list_item(field, &tok_len)) == NULL) {
return NULL;
}
token = apr_palloc(p, tok_len + 1);
/* Scan the token again, but this time copy only the good bytes.
* We skip extra whitespace and any whitespace around a '=', '/',
* or ';' and lowercase normal characters not within a comment,
* quoted-string or quoted-pair.
*/
for (ptr = (const unsigned char *)tok_start, pos = (unsigned char *)token;
*ptr && (in_qpair || in_qstr || in_com || *ptr != ',');
++ptr) {
if (in_qpair) {
in_qpair = 0;
*pos++ = *ptr;
}
else {
switch (*ptr) {
case '\\': in_qpair = 1;
if (addspace == 1)
*pos++ = ' ';
*pos++ = *ptr;
addspace = 0;
break;
case '"' : if (!in_com)
in_qstr = !in_qstr;
if (addspace == 1)
*pos++ = ' ';
*pos++ = *ptr;
addspace = 0;
break;
case '(' : if (!in_qstr)
++in_com;
if (addspace == 1)
*pos++ = ' ';
*pos++ = *ptr;
addspace = 0;
break;
case ')' : if (in_com)
--in_com;
*pos++ = *ptr;
addspace = 0;
break;
case ' ' :
case '\t': if (addspace)
break;
if (in_com || in_qstr)
*pos++ = *ptr;
else
addspace = 1;
break;
case '=' :
case '/' :
case ';' : if (!(in_com || in_qstr))
addspace = -1;
*pos++ = *ptr;
break;
default : if (addspace == 1)
*pos++ = ' ';
*pos++ = (in_com || in_qstr) ? *ptr
: apr_tolower(*ptr);
addspace = 0;
break;
}
}
}
*pos = '\0';
return token;
}
/* Find an item in canonical form (lowercase, no extra spaces) within
* an HTTP field value list. Returns 1 if found, 0 if not found.
* This would be much more efficient if we stored header fields as
* an array of list items as they are received instead of a plain string.
*/
AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line,
const char *tok)
{
const unsigned char *pos;
const unsigned char *ptr = (const unsigned char *)line;
int good = 0, addspace = 0, in_qpair = 0, in_qstr = 0, in_com = 0;
if (!line || !tok)
return 0;
do { /* loop for each item in line's list */
/* Find first non-comma, non-whitespace byte */
while (*ptr == ',' || apr_isspace(*ptr))
++ptr;
if (*ptr)
good = 1; /* until proven otherwise for this item */
else
break; /* no items left and nothing good found */
/* We skip extra whitespace and any whitespace around a '=', '/',
* or ';' and lowercase normal characters not within a comment,
* quoted-string or quoted-pair.
*/
for (pos = (const unsigned char *)tok;
*ptr && (in_qpair || in_qstr || in_com || *ptr != ',');
++ptr) {
if (in_qpair) {
in_qpair = 0;
if (good)
good = (*pos++ == *ptr);
}
else {
switch (*ptr) {
case '\\': in_qpair = 1;
if (addspace == 1)
good = good && (*pos++ == ' ');
good = good && (*pos++ == *ptr);
addspace = 0;
break;
case '"' : if (!in_com)
in_qstr = !in_qstr;
if (addspace == 1)
good = good && (*pos++ == ' ');
good = good && (*pos++ == *ptr);
addspace = 0;
break;
case '(' : if (!in_qstr)
++in_com;
if (addspace == 1)
good = good && (*pos++ == ' ');
good = good && (*pos++ == *ptr);
addspace = 0;
break;
case ')' : if (in_com)
--in_com;
good = good && (*pos++ == *ptr);
addspace = 0;
break;
case ' ' :
case '\t': if (addspace || !good)
break;
if (in_com || in_qstr)
good = (*pos++ == *ptr);
else
addspace = 1;
break;
case '=' :
case '/' :
case ';' : if (!(in_com || in_qstr))
addspace = -1;
good = good && (*pos++ == *ptr);
break;
default : if (!good)
break;
if (addspace == 1)
good = (*pos++ == ' ');
if (in_com || in_qstr)
good = good && (*pos++ == *ptr);
else
good = good && (*pos++ == apr_tolower(*ptr));
addspace = 0;
break;
}
}
}
if (good && *pos)
good = 0; /* not good if only a prefix was matched */
} while (*ptr && !good);
return good;
}
/* Retrieve a token, spacing over it and returning a pointer to
* the first non-white byte afterwards. Note that these tokens
* are delimited by semis and commas; and can also be delimited
* by whitespace at the caller's option.
*/
AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line,
int accept_white)
{
const char *ptr = *accept_line;
const char *tok_start;
char *token;
int tok_len;
/* Find first non-white byte */
while (*ptr && apr_isspace(*ptr))
++ptr;
tok_start = ptr;
/* find token end, skipping over quoted strings.
* (comments are already gone).
*/
while (*ptr && (accept_white || !apr_isspace(*ptr))
&& *ptr != ';' && *ptr != ',') {
if (*ptr++ == '"')
while (*ptr)
if (*ptr++ == '"')
break;
}
tok_len = ptr - tok_start;
token = apr_pstrndup(p, tok_start, tok_len);
/* Advance accept_line pointer to the next non-white byte */
while (*ptr && apr_isspace(*ptr))
++ptr;
*accept_line = ptr;
return token;
}
/* find http tokens, see the definition of token from RFC2068 */
AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok)
{
const unsigned char *start_token;
const unsigned char *s;
if (!line)
return 0;
s = (const unsigned char *)line;
for (;;) {
/* find start of token, skip all stop characters, note NUL
* isn't a token stop, so we don't need to test for it
*/
while (TEST_CHAR(*s, T_HTTP_TOKEN_STOP)) {
++s;
}
if (!*s) {
return 0;
}
start_token = s;
/* find end of the token */
while (*s && !TEST_CHAR(*s, T_HTTP_TOKEN_STOP)) {
++s;
}
if (!strncasecmp((const char *)start_token, (const char *)tok,
s - start_token)) {
return 1;
}
if (!*s) {
return 0;
}
}
}
AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line,
const char *tok)
{
int llen, tlen, lidx;
if (!line)
return 0;
llen = strlen(line);
tlen = strlen(tok);
lidx = llen - tlen;
if (lidx < 0 ||
(lidx > 0 && !(apr_isspace(line[lidx - 1]) || line[lidx - 1] == ',')))
return 0;
return (strncasecmp(&line[lidx], tok, tlen) == 0);
}
AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *str)
{
char *cmd;
unsigned char *d;
const unsigned char *s;
cmd = apr_palloc(p, 2 * strlen(str) + 1); /* Be safe */
d = (unsigned char *)cmd;
s = (const unsigned char *)str;
for (; *s; ++s) {
#if defined(OS2) || defined(WIN32)
/*
* Newlines to Win32/OS2 CreateProcess() are ill advised.
* Convert them to spaces since they are effectively white
* space to most applications
*/
if (*s == '\r' || *s == '\n') {
*d++ = ' ';
continue;
}
#endif
if (TEST_CHAR(*s, T_ESCAPE_SHELL_CMD)) {
*d++ = '\\';
}
*d++ = *s;
}
*d = '\0';
return cmd;
}
static char x2c(const char *what)
{
register char digit;
#if !APR_CHARSET_EBCDIC
digit = ((what[0] >= 'A') ? ((what[0] & 0xdf) - 'A') + 10
: (what[0] - '0'));
digit *= 16;
digit += (what[1] >= 'A' ? ((what[1] & 0xdf) - 'A') + 10
: (what[1] - '0'));
#else /*APR_CHARSET_EBCDIC*/
char xstr[5];
xstr[0]='0';
xstr[1]='x';
xstr[2]=what[0];
xstr[3]=what[1];
xstr[4]='\0';
digit = apr_xlate_conv_byte(ap_hdrs_from_ascii,
0xFF & strtol(xstr, NULL, 16));
#endif /*APR_CHARSET_EBCDIC*/
return (digit);
}
/*
* Unescapes a URL, leaving reserved characters intact.
* Returns 0 on success, non-zero on error
* Failure is due to
* bad % escape returns HTTP_BAD_REQUEST
*
* decoding %00 or a forbidden character returns HTTP_NOT_FOUND
*/
static int unescape_url(char *url, const char *forbid, const char *reserved)
{
register int badesc, badpath;
char *x, *y;
badesc = 0;
badpath = 0;
/* Initial scan for first '%'. Don't bother writing values before
* seeing a '%' */
y = strchr(url, '%');
if (y == NULL) {
return OK;
}
for (x = y; *y; ++x, ++y) {
if (*y != '%') {
*x = *y;
}
else {
if (!apr_isxdigit(*(y + 1)) || !apr_isxdigit(*(y + 2))) {
badesc = 1;
*x = '%';
}
else {
char decoded;
decoded = x2c(y + 1);
if ((decoded == '\0')
|| (forbid && ap_strchr_c(forbid, decoded))) {
badpath = 1;
*x = decoded;
y += 2;
}
else if (reserved && ap_strchr_c(reserved, decoded)) {
*x++ = *y++;
*x++ = *y++;
*x = *y;
}
else {
*x = decoded;
y += 2;
}
}
}
}
*x = '\0';
if (badesc) {
return HTTP_BAD_REQUEST;
}
else if (badpath) {
return HTTP_NOT_FOUND;
}
else {
return OK;
}
}
AP_DECLARE(int) ap_unescape_url(char *url)
{
/* Traditional */
#ifdef CASE_BLIND_FILESYSTEM
return unescape_url(url, "/\\", NULL);
#else
return unescape_url(url, "/", NULL);
#endif
}
AP_DECLARE(int) ap_unescape_url_keep2f(char *url)
{
/* AllowEncodedSlashes (corrected) */
return unescape_url(url, NULL, "/");
}
#ifdef NEW_APIS
/* IFDEF these out until they've been thought through.
* Just a germ of an API extension for now
*/
AP_DECLARE(int) ap_unescape_url_proxy(char *url)
{
/* leave RFC1738 reserved characters intact, * so proxied URLs
* don't get mangled. Where does that leave encoded '&' ?
*/
return unescape_url(url, NULL, "/;?");
}
AP_DECLARE(int) ap_unescape_url_reserved(char *url, const char *reserved)
{
return unescape_url(url, NULL, reserved);
}
#endif
AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
apr_port_t port, const request_rec *r)
{
if (ap_is_default_port(port, r)) {
return apr_pstrdup(p, hostname);
}
else {
return apr_psprintf(p, "%s:%u", hostname, port);
}
}
AP_DECLARE(int) ap_unescape_all(char *url)
{
return unescape_url(url, NULL, NULL);
}
/* c2x takes an unsigned, and expects the caller has guaranteed that
* 0 <= what < 256... which usually means that you have to cast to
* unsigned char first, because (unsigned)(char)(x) first goes through
* signed extension to an int before the unsigned cast.
*
* The reason for this assumption is to assist gcc code generation --
* the unsigned char -> unsigned extension is already done earlier in
* both uses of this code, so there's no need to waste time doing it
* again.
*/
static const char c2x_table[] = "0123456789abcdef";
static APR_INLINE unsigned char *c2x(unsigned what, unsigned char prefix,
unsigned char *where)
{
#if APR_CHARSET_EBCDIC
what = apr_xlate_conv_byte(ap_hdrs_to_ascii, (unsigned char)what);
#endif /*APR_CHARSET_EBCDIC*/
*where++ = prefix;
*where++ = c2x_table[what >> 4];
*where++ = c2x_table[what & 0xf];
return where;
}
/*
* escape_path_segment() escapes a path segment, as defined in RFC 1808. This
* routine is (should be) OS independent.
*
* os_escape_path() converts an OS path to a URL, in an OS dependent way. In all
* cases if a ':' occurs before the first '/' in the URL, the URL should be
* prefixed with "./" (or the ':' escaped). In the case of Unix, this means
* leaving '/' alone, but otherwise doing what escape_path_segment() does. For
* efficiency reasons, we don't use escape_path_segment(), which is provided for
* reference. Again, RFC 1808 is where this stuff is defined.
*
* If partial is set, os_escape_path() assumes that the path will be appended to
* something with a '/' in it (and thus does not prefix "./").
*/
AP_DECLARE(char *) ap_escape_path_segment_buffer(char *copy, const char *segment)
{
const unsigned char *s = (const unsigned char *)segment;
unsigned char *d = (unsigned char *)copy;
unsigned c;
while ((c = *s)) {
if (TEST_CHAR(c, T_ESCAPE_PATH_SEGMENT)) {
d = c2x(c, '%', d);
}
else {
*d++ = c;
}
++s;
}
*d = '\0';
return copy;
}
AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *segment)
{
return ap_escape_path_segment_buffer(apr_palloc(p, 3 * strlen(segment) + 1), segment);
}
AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial)
{
char *copy = apr_palloc(p, 3 * strlen(path) + 3);
const unsigned char *s = (const unsigned char *)path;
unsigned char *d = (unsigned char *)copy;
unsigned c;
if (!partial) {
const char *colon = ap_strchr_c(path, ':');
const char *slash = ap_strchr_c(path, '/');
if (colon && (!slash || colon < slash)) {
*d++ = '.';
*d++ = '/';
}
}
while ((c = *s)) {
if (TEST_CHAR(c, T_OS_ESCAPE_PATH)) {
d = c2x(c, '%', d);
}
else {
*d++ = c;
}
++s;
}
*d = '\0';
return copy;
}
/* ap_escape_uri is now a macro for os_escape_path */
AP_DECLARE(char *) ap_escape_html(apr_pool_t *p, const char *s)
{
int i, j;
char *x;
/* first, count the number of extra characters */
for (i = 0, j = 0; s[i] != '\0'; i++)
if (s[i] == '<' || s[i] == '>')
j += 3;
else if (s[i] == '&')
j += 4;
else if (s[i] == '"')
j += 5;
if (j == 0)
return apr_pstrmemdup(p, s, i);
x = apr_palloc(p, i + j + 1);
for (i = 0, j = 0; s[i] != '\0'; i++, j++)
if (s[i] == '<') {
memcpy(&x[j], "&lt;", 4);
j += 3;
}
else if (s[i] == '>') {
memcpy(&x[j], "&gt;", 4);
j += 3;
}
else if (s[i] == '&') {
memcpy(&x[j], "&amp;", 5);
j += 4;
}
else if (s[i] == '"') {
memcpy(&x[j], "&quot;", 6);
j += 5;
}
else
x[j] = s[i];
x[j] = '\0';
return x;
}
AP_DECLARE(char *) ap_escape_logitem(apr_pool_t *p, const char *str)
{
char *ret;
unsigned char *d;
const unsigned char *s;
if (!str) {
return NULL;
}
ret = apr_palloc(p, 4 * strlen(str) + 1); /* Be safe */
d = (unsigned char *)ret;
s = (const unsigned char *)str;
for (; *s; ++s) {
if (TEST_CHAR(*s, T_ESCAPE_LOGITEM)) {
*d++ = '\\';
switch(*s) {
case '\b':
*d++ = 'b';
break;
case '\n':
*d++ = 'n';
break;
case '\r':
*d++ = 'r';
break;
case '\t':
*d++ = 't';
break;
case '\v':
*d++ = 'v';
break;
case '\\':
case '"':
*d++ = *s;
break;
default:
c2x(*s, 'x', d);
d += 3;
}
}
else {
*d++ = *s;
}
}
*d = '\0';
return ret;
}
AP_DECLARE(apr_size_t) ap_escape_errorlog_item(char *dest, const char *source,
apr_size_t buflen)
{
unsigned char *d, *ep;
const unsigned char *s;
if (!source || !buflen) { /* be safe */
return 0;
}
d = (unsigned char *)dest;
s = (const unsigned char *)source;
ep = d + buflen - 1;
for (; d < ep && *s; ++s) {
if (TEST_CHAR(*s, T_ESCAPE_LOGITEM)) {
*d++ = '\\';
if (d >= ep) {
--d;
break;
}
switch(*s) {
case '\b':
*d++ = 'b';
break;
case '\n':
*d++ = 'n';
break;
case '\r':
*d++ = 'r';
break;
case '\t':
*d++ = 't';
break;
case '\v':
*d++ = 'v';
break;
case '\\':
*d++ = *s;
break;
case '"': /* no need for this in error log */
d[-1] = *s;
break;
default:
if (d >= ep - 2) {
ep = --d; /* break the for loop as well */
break;
}
c2x(*s, 'x', d);
d += 3;
}
}
else {
*d++ = *s;
}
}
*d = '\0';
return (d - (unsigned char *)dest);
}
AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *path)
{
apr_finfo_t finfo;
if (apr_stat(&finfo, path, APR_FINFO_TYPE, p) != APR_SUCCESS)
return 0; /* in error condition, just return no */
return (finfo.filetype == APR_DIR);
}
AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *path)
{
apr_finfo_t finfo;
if (apr_stat(&finfo, path, APR_FINFO_LINK | APR_FINFO_TYPE, p) != APR_SUCCESS)
return 0; /* in error condition, just return no */
return (finfo.filetype == APR_DIR);
}
AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *src1,
const char *src2)
{
apr_size_t len1, len2;
char *path;
len1 = strlen(src1);
len2 = strlen(src2);
/* allocate +3 for '/' delimiter, trailing NULL and overallocate
* one extra byte to allow the caller to add a trailing '/'
*/
path = (char *)apr_palloc(a, len1 + len2 + 3);
if (len1 == 0) {
*path = '/';
memcpy(path + 1, src2, len2 + 1);
}
else {
char *next;
memcpy(path, src1, len1);
next = path + len1;
if (next[-1] != '/') {
*next++ = '/';
}
memcpy(next, src2, len2 + 1);
}
return path;
}
/*
* Check for an absoluteURI syntax (see section 3.2 in RFC2068).
*/
AP_DECLARE(int) ap_is_url(const char *u)
{
register int x;
for (x = 0; u[x] != ':'; x++) {
if ((!u[x]) ||
((!apr_isalpha(u[x])) && (!apr_isdigit(u[x])) &&
(u[x] != '+') && (u[x] != '-') && (u[x] != '.'))) {
return 0;
}
}
return (x ? 1 : 0); /* If the first character is ':', it's broken, too */
}
AP_DECLARE(int) ap_ind(const char *s, char c)
{
const char *p = ap_strchr_c(s, c);
if (p == NULL)
return -1;
return p - s;
}
AP_DECLARE(int) ap_rind(const char *s, char c)
{
const char *p = ap_strrchr_c(s, c);
if (p == NULL)
return -1;
return p - s;
}
AP_DECLARE(void) ap_str_tolower(char *str)
{
while (*str) {
*str = apr_tolower(*str);
++str;
}
}
/*
* We must return a FQDN
*/
char *ap_get_local_host(apr_pool_t *a)
{
#ifndef MAXHOSTNAMELEN
#define MAXHOSTNAMELEN 256
#endif
char str[MAXHOSTNAMELEN + 1];
char *server_hostname = NULL;
apr_sockaddr_t *sockaddr;
char *hostname;
if (apr_gethostname(str, sizeof(str) - 1, a) != APR_SUCCESS) {
ap_log_perror(APLOG_MARK, APLOG_STARTUP | APLOG_WARNING, 0, a,
"%s: apr_gethostname() failed to determine ServerName",
ap_server_argv0);
} else {
str[sizeof(str) - 1] = '\0';
if (apr_sockaddr_info_get(&sockaddr, str, APR_UNSPEC, 0, 0, a) == APR_SUCCESS) {
if ( (apr_getnameinfo(&hostname, sockaddr, 0) == APR_SUCCESS) &&
(ap_strchr_c(hostname, '.')) ) {
server_hostname = apr_pstrdup(a, hostname);
return server_hostname;
} else if (ap_strchr_c(str, '.')) {
server_hostname = apr_pstrdup(a, str);
} else {
apr_sockaddr_ip_get(&hostname, sockaddr);
server_hostname = apr_pstrdup(a, hostname);
}
} else {
ap_log_perror(APLOG_MARK, APLOG_STARTUP | APLOG_WARNING, 0, a,
"%s: apr_sockaddr_info_get() failed for %s",
ap_server_argv0, str);
}
}
if (!server_hostname)
server_hostname = apr_pstrdup(a, "127.0.0.1");
ap_log_perror(APLOG_MARK, APLOG_ALERT|APLOG_STARTUP, 0, a,
"%s: Could not reliably determine the server's fully qualified "
"domain name, using %s for ServerName",
ap_server_argv0, server_hostname);
return server_hostname;
}
/* simple 'pool' alloc()ing glue to apr_base64.c
*/
AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded)
{
char *decoded;
int l;
decoded = (char *) apr_palloc(p, 1 + apr_base64_decode_len(bufcoded));
l = apr_base64_decode(decoded, bufcoded);
decoded[l] = '\0'; /* make binary sequence into string */
return decoded;
}
AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string)
{
char *encoded;
int l = strlen(string);
encoded = (char *) apr_palloc(p, 1 + apr_base64_encode_len(l));
l = apr_base64_encode(encoded, string, l);
encoded[l] = '\0'; /* make binary sequence into string */
return encoded;
}
/* we want to downcase the type/subtype for comparison purposes
* but nothing else because ;parameter=foo values are case sensitive.
* XXX: in truth we want to downcase parameter names... but really,
* apache has never handled parameters and such correctly. You
* also need to compress spaces and such to be able to compare
* properly. -djg
*/
AP_DECLARE(void) ap_content_type_tolower(char *str)
{
char *semi;
semi = strchr(str, ';');
if (semi) {
*semi = '\0';
}
ap_str_tolower(str);
if (semi) {
*semi = ';';
}
}
/*
* Given a string, replace any bare " with \" .
*/
AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring)
{
int newlen = 0;
const char *inchr = instring;
char *outchr, *outstring;
/*
* Look through the input string, jogging the length of the output
* string up by an extra byte each time we find an unescaped ".
*/
while (*inchr != '\0') {
newlen++;
if (*inchr == '"') {
newlen++;
}
/*
* If we find a slosh, and it's not the last byte in the string,
* it's escaping something - advance past both bytes.
*/
if ((*inchr == '\\') && (inchr[1] != '\0')) {
inchr++;
newlen++;
}
inchr++;
}
outstring = apr_palloc(p, newlen + 1);
inchr = instring;
outchr = outstring;
/*
* Now copy the input string to the output string, inserting a slosh
* in front of every " that doesn't already have one.
*/
while (*inchr != '\0') {
if ((*inchr == '\\') && (inchr[1] != '\0')) {
*outchr++ = *inchr++;
*outchr++ = *inchr++;
}
if (*inchr == '"') {
*outchr++ = '\\';
}
if (*inchr != '\0') {
*outchr++ = *inchr++;
}
}
*outchr = '\0';
return outstring;
}
/*
* Given a string, append the PID deliminated by delim.
* Usually used to create a pid-appended filepath name
* (eg: /a/b/foo -> /a/b/foo.6726). A function, and not
* a macro, to avoid unistd.h dependency
*/
AP_DECLARE(char *) ap_append_pid(apr_pool_t *p, const char *string,
const char *delim)
{
return apr_psprintf(p, "%s%s%" APR_PID_T_FMT, string,
delim, getpid());
}
/**
* Parse a given timeout parameter string into an apr_interval_time_t value.
* The unit of the time interval is given as postfix string to the numeric
* string. Currently the following units are understood:
*
* ms : milliseconds
* s : seconds
* mi[n] : minutes
* h : hours
*
* If no unit is contained in the given timeout parameter the default_time_unit
* will be used instead.
* @param timeout_parameter The string containing the timeout parameter.
* @param timeout The timeout value to be returned.
* @param default_time_unit The default time unit to use if none is specified
* in timeout_parameter.
* @return Status value indicating whether the parsing was successful or not.
*/
AP_DECLARE(apr_status_t) ap_timeout_parameter_parse(
const char *timeout_parameter,
apr_interval_time_t *timeout,
const char *default_time_unit)
{
char *endp;
const char *time_str;
apr_int64_t tout;
tout = apr_strtoi64(timeout_parameter, &endp, 10);
if (errno) {
return errno;
}
if (!endp || !*endp) {
time_str = default_time_unit;
}
else {
time_str = endp;
}
switch (*time_str) {
/* Time is in seconds */
case 's':
*timeout = (apr_interval_time_t) apr_time_from_sec(tout);
break;
case 'h':
/* Time is in hours */
*timeout = (apr_interval_time_t) apr_time_from_sec(tout * 3600);
break;
case 'm':
switch (*(++time_str)) {
/* Time is in miliseconds */
case 's':
*timeout = (apr_interval_time_t) tout * 1000;
break;
/* Time is in minutes */
case 'i':
*timeout = (apr_interval_time_t) apr_time_from_sec(tout * 60);
break;
default:
return APR_EGENERAL;
}
break;
default:
return APR_EGENERAL;
}
return APR_SUCCESS;
}