ACE/apps/JAWS/clients/WebSTONE/src/nsapi-includes/base/util.h

   1 /*
   2  * Copyright (c) 1994, 1995.  Netscape Communications Corporation.  All
   3  * rights reserved.
   4  *
   5  * Use of this software is governed by the terms of the license agreement for
   6  * the Netscape Communications or Netscape Comemrce Server between the
   7  * parties.
   8  */
   9
  10
  11 /* ------------------------------------------------------------------------ */
  12
  13
  14 /*
  15  * util.h: A hodge podge of utility functions and standard functions which
  16  *         are unavailable on certain systems
  17  *
  18  * Rob McCool
  19  */
  20
  21
  22 #ifndef HTTPD_UTIL_H
  23 #define HTTPD_UTIL_H
  24
  25 #include "buffer.h"    /* filebuf for getline */
  26
  27 #include <time.h>      /* struct tm */
  28
  29
  30 /* ------------------------------ Prototypes ------------------------------ */
  31
  32
  33 /*
  34  * getline scans in buf until it finds a LF or CRLF, storing the string in
  35  * l. It will terminate the string and return:
  36  *
  37  *  0 when done, with the scanned line (minus CR or LF) in l
  38  *  1 upon EOF, with the scanned line (minus CR or LF) in l
  39  * -1 on error with the error description in l (uses lineno for information)
  40  */
  41
  42 int util_getline(filebuf *buf, int lineno, int maxlen, char *l);
  43
  44
  45 /*
  46  * can_exec returns 1 if you can execute the file described by finfo, and
  47  * 0 if you can't.
  48  */
  49
  50 #ifdef XP_UNIX
  51 #include <sys/stat.h>
  52 #include <sys/types.h>
  53
  54 int util_can_exec(struct stat *finfo, uid_t uid, gid_t gid);
  55
  56 #endif /* XP_UNIX */
  57 /*
  58  * env_create creates a new environment with the given env, with n new
  59  * entries, and places the current position that you should add your
  60  * entries with at pos.
  61  *
  62  * If env is NULL, it will allocate a new one. If not, it will reallocate
  63  * that one.
  64  */
  65
  66 char **util_env_create(char **env, int n, int *pos);
  67
  68 /*
  69  * util_env_str allocates a string from the given name and value and
  70  * returns it. It does not check for things like = signs in name.
  71  */
  72
  73 char *util_env_str(char *name, char *value);
  74
  75 /*
  76  * env_replace replaces the occurrence of the given variable with the
  77  * value you give.
  78  */
  79
  80 void util_env_replace(char **env, char *name, char *value);
  81
  82 /*
  83  * util_env_free frees an environment.
  84  */
  85
  86 void util_env_free(char **env);
  87
  88 /*
  89  * util_env_find looks through env for the named string. Returns the
  90  * corresponding value if the named string is found, or NULL if not.
  91  */
  92 char *util_env_find(char **env, char *name);
  93
  94
  95 /*
  96  * hostname gets the local hostname. Returns NULL if it can't find a FQDN.
  97  * You are free to realloc or free this string.
  98  */
  99
 100 char *util_hostname();
 101
 102
 103 /*
 104  * chdir2path changes the current directory to the one that the file
 105  * path is in. path should point to a file. Caveat: path must be a writable
 106  * string. It won't get modified permanently.
 107  */
 108
 109 int util_chdir2path(char *path);
 110
 111 /*
 112  * is_mozilla checks if the given user-agent is mozilla, of at least
 113  * the given major and minor revisions. These are strings to avoid
 114  * ambiguities like 1.56 > 1.5
 115  */
 116
 117 int util_is_mozilla(char *ua, char *major, char *minor);
 118
 119 /*
 120  * is_url will return 1 if the given string seems to be a URL, or will
 121  * return 0 otherwise.
 122  *
 123  * Because of stupid news URLs, this will return 1 if the string has
 124  * all alphabetic characters up to the first colon and will not check for
 125  * the double slash.
 126  */
 127
 128 int util_is_url(char *url);
 129
 130 /*
 131  * util_later_than checks the date in the string ims, and if that date is
 132  * later than or equal to the one in the tm struct lms, then it returns 1.
 133  *
 134  * Handles RFC 822, 850, and ctime formats.
 135  */
 136
 137 int util_later_than(struct tm *lms, char *ims);
 138
 139
 140 /*
 141  * util_uri_is_evil returns 1 if a URL has ../ or // in it.
 142  */
 143 int util_uri_is_evil(char *t);
 144
 145 /*
 146  * util_uri_parse gets rid of /../, /./, and //.
 147  *
 148  * Assumes that either the string starts with a /, or the string will
 149  * not .. right off of its beginning.  As such, ../foo.gif will
 150  * not be changed, although /../foo.gif will become /foo.gif.
 151  */
 152
 153 void util_uri_parse(char *uri);
 154
 155 /*
 156  * util_uri_unescape unescapes the given URI in place (% conversions only).
 157  */
 158
 159 void util_uri_unescape(char *s);
 160
 161 /*
 162  * util_uri_escape escapes any nasty chars in s and copies the string into d.
 163  * If d is NULL, it will allocate and return a properly sized string.
 164  * Warning: does not check bounds on a given d.
 165  *
 166  * util_url_escape does the same thing but does it for a url, i.e. ?:+ is
 167  * not escaped.
 168  */
 169
 170 char *util_uri_escape(char *d, char *s);
 171 char *util_url_escape(char *d, char *s);
 172
 173 /*
 174  * util_sh_escape places a \ in front of any shell-special characters.
 175  * Returns a newly-allocated copy of the string.
 176  */
 177
 178 char *util_sh_escape(char *s);
 179
 180 /*
 181  * util_itoa converts the given integer to a string into a.
 182  */
 183
 184 int util_itoa(int i, char *a);
 185
 186 /*
 187  * util_vsprintf and util_sprintf are simplified clones of the System V
 188  * vsprintf and sprintf routines.
 189  *
 190  * Returns the number of characters printed. Only handles %d and %s,
 191  * does not handle any width or precision.
 192  */
 193
 194 #include <stdarg.h>
 195
 196 int util_vsprintf(char *s, register char *fmt, va_list args);
 197 int util_sprintf(char *s, char *fmt, ...);
 198
 199 /* These routines perform bounds checks. */
 200 int util_vsnprintf(char *s, int n, register char *fmt, va_list args);
 201 int util_snprintf(char *s, int n, char *fmt, ...);
 202
 203 #endif