package/uhttpd/src/uhttpd-utils.h

   1 /*
   2  * uhttpd - Tiny single-threaded httpd - Utility header
   3  *
   4  *   Copyright (C) 2010-2012 Jo-Philipp Wich <xm@subsignal.org>
   5  *
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  */
  18
  19 #ifndef _UHTTPD_UTILS_
  20
  21 #include <stdarg.h>
  22 #include <fcntl.h>
  23 #include <pwd.h>
  24 #include <sys/stat.h>
  25
  26 #ifdef HAVE_SHADOW
  27 #include <shadow.h>
  28 #endif
  29
  30 #define min(x, y) (((x) < (y)) ? (x) : (y))
  31 #define max(x, y) (((x) > (y)) ? (x) : (y))
  32
  33 #define array_size(x) \
  34         (sizeof(x) / sizeof(x[0]))
  35
  36 #define foreach_header(i, h) \
  37         for( i = 0; (i + 1) < (sizeof(h) / sizeof(h[0])) && h[i]; i += 2 )
  38
  39 #define fd_cloexec(fd) \
  40         fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC)
  41
  42 #define fd_nonblock(fd) \
  43         fcntl(fd, F_SETFL, fcntl(fd, F_GETFL) | O_NONBLOCK)
  44
  45 #define ensure_out(x) \
  46         do { if((x) < 0) goto out; } while(0)
  47
  48 #define ensure_ret(x) \
  49         do { if((x) < 0) return -1; } while(0)
  50
  51
  52 struct path_info {
  53         char *root;
  54         char *phys;
  55         char *name;
  56         char *info;
  57         char *query;
  58         int redirected;
  59         struct stat stat;
  60 };
  61
  62
  63 const char * sa_straddr(void *sa);
  64 const char * sa_strport(void *sa);
  65 int sa_port(void *sa);
  66 int sa_rfc1918(void *sa);
  67
  68 char *strfind(char *haystack, int hslen, const char *needle, int ndlen);
  69
  70 bool uh_socket_wait(int fd, int sec, bool write);
  71
  72 int uh_raw_send(int fd, const char *buf, int len, int seconds);
  73 int uh_raw_recv(int fd, char *buf, int len, int seconds);
  74 int uh_tcp_send(struct client *cl, const char *buf, int len);
  75 int uh_tcp_send_lowlevel(struct client *cl, const char *buf, int len);
  76 int uh_tcp_recv(struct client *cl, char *buf, int len);
  77 int uh_tcp_recv_lowlevel(struct client *cl, char *buf, int len);
  78
  79 int uh_http_sendhf(struct client *cl, int code, const char *summary,
  80                                    const char *fmt, ...);
  81
  82 #define uh_http_response(cl, code, message) \
  83         uh_http_sendhf(cl, code, message, message)
  84
  85 int uh_http_sendc(struct client *cl, const char *data, int len);
  86
  87 int uh_http_sendf(
  88         struct client *cl, struct http_request *req,
  89         const char *fmt, ...
  90 );
  91
  92 int uh_http_send(
  93         struct client *cl, struct http_request *req,
  94         const char *buf, int len
  95 );
  96
  97
  98 int uh_urldecode(char *buf, int blen, const char *src, int slen);
  99 int uh_urlencode(char *buf, int blen, const char *src, int slen);
 100 int uh_b64decode(char *buf, int blen, const unsigned char *src, int slen);
 101
 102
 103 struct auth_realm * uh_auth_add(char *path, char *user, char *pass);
 104
 105 int uh_auth_check(
 106         struct client *cl, struct http_request *req, struct path_info *pi
 107 );
 108
 109
 110 struct path_info * uh_path_lookup(struct client *cl, const char *url);
 111
 112 struct listener * uh_listener_add(int sock, struct config *conf);
 113 struct listener * uh_listener_lookup(int sock);
 114
 115 struct client * uh_client_add(int sock, struct listener *serv);
 116 struct client * uh_client_lookup(int sock);
 117
 118 #define uh_client_error(cl, code, status, ...) do { \
 119         uh_http_sendhf(cl, code, status, __VA_ARGS__);  \
 120         uh_client_shutdown(cl);                         \
 121 } while(0)
 122
 123 void uh_client_shutdown(struct client *cl);
 124 void uh_client_remove(struct client *cl);
 125
 126 #define uh_client_gc() uh_client_remove(NULL)
 127
 128
 129 #ifdef HAVE_CGI
 130 struct interpreter * uh_interpreter_add(const char *extn, const char *path);
 131 struct interpreter * uh_interpreter_lookup(const char *path);
 132 #endif
 133
 134 #endif