webcit-ng/request.c

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