webcit-ng/request.c

   1 /*
   2  * This module sits directly above the HTTP layer.  By the time we get here,
   3  * an HTTP request has been fully received and parsed.  Control is passed up
   4  * to this layer to actually perform the request.  We then fill in the response
   5  * and pass control back down to the HTTP layer to output the response back to
   6  * the client.
   7  *
   8  * Copyright (c) 1996-2018 by the citadel.org team
   9  *
  10  * This program is open source software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License version 3.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  */
  18
  19 #include "webcit.h"
  20
  21
  22 /*
  23  * Not found!  Wowzers.
  24  */
  25 void do_404(struct http_transaction *h)
  26 {
  27         h->response_code = 404;
  28         h->response_string = strdup("NOT FOUND");
  29         add_response_header(h, strdup("Content-type"), strdup("text/plain"));
  30         h->response_body = strdup("404 NOT FOUND\r\n");
  31         h->response_body_length = strlen(h->response_body);
  32 }
  33
  34
  35 /*
  36  * Precondition failed (such as if-match)
  37  */
  38 void do_412(struct http_transaction *h)
  39 {
  40         h->response_code = 412;
  41         h->response_string = strdup("PRECONDITION FAILED");
  42 }
  43
  44
  45 /*
  46  * We throw an HTTP error "502 bad gateway" when we need to connect to Citadel, but can't.
  47  */
  48 void do_502(struct http_transaction *h)
  49 {
  50         h->response_code = 502;
  51         h->response_string = strdup("bad gateway");
  52         add_response_header(h, strdup("Content-type"), strdup("text/plain"));
  53         h->response_body =
  54             strdup(_
  55                    ("This program was unable to connect or stay connected to the Citadel server.  Please report this problem to your system administrator."));
  56         h->response_body_length = strlen(h->response_body);
  57 }
  58
  59
  60 /*
  61  * Tell the client to authenticate using HTTP-AUTH (RFC 2617)
  62  */
  63 void request_http_authenticate(struct http_transaction *h)
  64 {
  65         h->response_code = 401;
  66         h->response_string = strdup("Unauthorized");
  67         add_response_header(h, strdup("WWW-Authenticate"), strdup("Basic realm=\"Citadel Server\""));
  68 }
  69
  70
  71 /*
  72  * Easy and fun utility function to throw a redirect.
  73  */
  74 void http_redirect(struct http_transaction *h, char *to_where)
  75 {
  76         syslog(LOG_DEBUG, "Redirecting to: %s", to_where);
  77         h->response_code = 302;
  78         h->response_string = strdup("Moved Temporarily");
  79         add_response_header(h, strdup("Location"), strdup(to_where));
  80         add_response_header(h, strdup("Content-type"), strdup("text/plain"));
  81         h->response_body = strdup(to_where);
  82         h->response_body_length = strlen(h->response_body);
  83 }
  84
  85
  86 /*
  87  * perform_request() is the entry point for *every* HTTP transaction.
  88  */
  89 void perform_request(struct http_transaction *h)
  90 {
  91         struct ctdlsession *c;
  92
  93         // Determine which code path to take based on the beginning of the URI.
  94         // This is implemented as a series of strncasecmp() calls rather than a
  95         // lookup table in order to make the code more readable.
  96
  97         if (IsEmptyStr(h->uri)) {       // Sanity check
  98                 do_404(h);
  99                 return;
 100         }
 101         // Right about here is where we should try to handle anything that doesn't start
 102         // with the /ctdl/ prefix.
 103         // Root (/) ...
 104
 105         if ((!strcmp(h->uri, "/")) && (!strcasecmp(h->method, "GET"))) {
 106                 http_redirect(h, "/ctdl/s/index.html");
 107                 return;
 108         }
 109         // Legacy URI patterns (/readnew?gotoroom=xxx&start_reading_at=yyy) ...
 110         // Direct room name (/my%20blog) ...
 111
 112         // Everything below this line is strictly REST URI patterns.
 113
 114         if (strncasecmp(h->uri, HKEY("/ctdl/"))) {      // Reject non-REST
 115                 do_404(h);
 116                 return;
 117         }
 118
 119         if (!strncasecmp(h->uri, HKEY("/ctdl/s/"))) {   // Static content
 120                 output_static(h);
 121                 return;
 122         }
 123
 124         if (h->uri[7] != '/') {
 125                 do_404(h);
 126                 return;
 127         }
 128         // Anything below this line:
 129         //      1. Is in the format of /ctdl/?/*
 130         //      2. Requires a connection to a Citadel server.
 131
 132         c = connect_to_citadel(h);
 133         if (c == NULL) {
 134                 do_502(h);
 135                 return;
 136         }
 137         // WebDAV methods like OPTIONS and PROPFIND *require* a logged-in session,
 138         // even if the Citadel server allows anonymous access.
 139         if (IsEmptyStr(c->auth)) {
 140                 if ((!strcasecmp(h->method, "OPTIONS"))
 141                     || (!strcasecmp(h->method, "PROPFIND"))
 142                     || (!strcasecmp(h->method, "REPORT"))
 143                     || (!strcasecmp(h->method, "DELETE"))
 144                     ) {
 145                         request_http_authenticate(h);
 146                         disconnect_from_citadel(c);
 147                         return;
 148                 }
 149         }
 150         // Break down the URI by path and send the request to the appropriate part of the program.
 151         //
 152         switch (h->uri[6]) {
 153         case 'a':               // /ctdl/a/ == RESTful path to admin functions
 154                 ctdl_a(h, c);
 155                 break;
 156         case 'c':               // /ctdl/c/ == misc Citadel server commands
 157                 ctdl_c(h, c);
 158                 break;
 159         case 'r':               // /ctdl/r/ == RESTful path to rooms
 160                 ctdl_r(h, c);
 161                 break;
 162         case 'u':               // /ctdl/u/ == RESTful path to users
 163                 do_404(h);
 164                 break;
 165         default:
 166                 do_404(h);
 167         }
 168
 169         // Are we in an authenticated session?  If so, set a cookie so we stay logged in.
 170         if (!IsEmptyStr(c->auth)) {
 171                 char koekje[AUTH_MAX];
 172                 char *exp = http_datestring(time(NULL) + (86400 * 30));
 173                 snprintf(koekje, AUTH_MAX, "wcauth=%s; path=/ctdl/; Expires=%s", c->auth, exp);
 174                 free(exp);
 175                 add_response_header(h, strdup("Set-Cookie"), strdup(koekje));
 176         }
 177         // During development we are foiling the browser cache completely.  In production we'll be more selective.
 178         add_response_header(h, strdup("Cache-Control"), strdup("no-store, must-revalidate"));
 179         add_response_header(h, strdup("Pragma"), strdup("no-cache"));
 180         add_response_header(h, strdup("Expires"), strdup("0"));
 181
 182         // Unbind from our Citadel server connection.
 183         disconnect_from_citadel(c);
 184 }