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 = strdup(_("This program was unable to connect or stay connected to the Citadel server.  Please report this problem to your system administrator."));
  54         h->response_body_length = strlen(h->response_body);
  55 }
  56
  57
  58 /*
  59  * Tell the client to authenticate using HTTP-AUTH (RFC 2617)
  60  */
  61 void request_http_authenticate(struct http_transaction *h)
  62 {
  63         h->response_code = 401;
  64         h->response_string = strdup("Unauthorized");
  65         add_response_header(h, strdup("WWW-Authenticate"), strdup("Basic realm=\"Citadel Server\""));
  66 }
  67
  68
  69 /*
  70  * Easy and fun utility function to throw a redirect.
  71  */
  72 void http_redirect(struct http_transaction *h, char *to_where)
  73 {
  74         syslog(LOG_DEBUG, "Redirecting to: %s", to_where);
  75         h->response_code = 302;
  76         h->response_string = strdup("Moved Temporarily");
  77         add_response_header(h, strdup("Location"), strdup(to_where));
  78         add_response_header(h, strdup("Content-type"), strdup("text/plain"));
  79         h->response_body = strdup(to_where);
  80         h->response_body_length = strlen(h->response_body);
  81 }
  82
  83
  84 /*
  85  * perform_request() is the entry point for *every* HTTP transaction.
  86  */
  87 void perform_request(struct http_transaction *h)
  88 {
  89         struct ctdlsession *c;
  90
  91         // Determine which code path to take based on the beginning of the URI.
  92         // This is implemented as a series of strncasecmp() calls rather than a
  93         // lookup table in order to make the code more readable.
  94
  95         if (IsEmptyStr(h->uri)) {                               // Sanity check
  96                 do_404(h);
  97                 return;
  98         }
  99
 100         // Right about here is where we should try to handle anything that doesn't start
 101         // with the /ctdl/ prefix.
 102         // Root (/) ...
 103
 104         if ( (!strcmp(h->uri, "/")) && (!strcasecmp(h->method, "GET")) ) {
 105                 http_redirect(h, "/ctdl/s/index.html");
 106                 return;
 107         }
 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
 129         // Anything below this line:
 130         //      1. Is in the format of /ctdl/?/*
 131         //      2. Requires a connection to a Citadel server.
 132
 133         c = connect_to_citadel(h);
 134         if (c == NULL) {
 135                 do_502(h);
 136                 return;
 137         }
 138
 139         // WebDAV methods like OPTIONS and PROPFIND *require* a logged-in session,
 140         // even if the Citadel server allows anonymous access.
 141         if (IsEmptyStr(c->auth)) {
 142                 if (       (!strcasecmp(h->method, "OPTIONS"))
 143                         || (!strcasecmp(h->method, "PROPFIND"))
 144                         || (!strcasecmp(h->method, "REPORT"))
 145                         || (!strcasecmp(h->method, "DELETE"))
 146                 ) {
 147                         request_http_authenticate(h);
 148                         disconnect_from_citadel(c);
 149                         return;
 150                 }
 151         }
 152
 153         // Break down the URI by path and send the request to the appropriate part of the program.
 154         //
 155         switch(h->uri[6]) {
 156                 case 'a':                                       // /ctdl/a/ == RESTful path to admin functions
 157                         ctdl_a(h, c);
 158                         break;
 159                 case 'c':                                       // /ctdl/c/ == misc Citadel server commands
 160                         ctdl_c(h, c);
 161                         break;
 162                 case 'r':                                       // /ctdl/r/ == RESTful path to rooms
 163                         ctdl_r(h, c);
 164                         break;
 165                 case 'u':                                       // /ctdl/u/ == RESTful path to users
 166                         do_404(h);
 167                         break;
 168                 default:
 169                         do_404(h);
 170         }
 171
 172         // Are we in an authenticated session?  If so, set a cookie so we stay logged in.
 173         if (!IsEmptyStr(c->auth)) {
 174                 char koekje[AUTH_MAX];
 175                 char *exp = http_datestring(time(NULL) + (86400 * 30));
 176                 snprintf(koekje, AUTH_MAX, "wcauth=%s; path=/ctdl/; Expires=%s", c->auth, exp);
 177                 free(exp);
 178                 add_response_header(h, strdup("Set-Cookie"), strdup(koekje));
 179         }
 180
 181         // During development we are foiling the browser cache completely.  In production we'll be more selective.
 182         add_response_header(h, strdup("Cache-Control"), strdup("no-store, must-revalidate"));
 183         add_response_header(h, strdup("Pragma"), strdup("no-cache"));
 184         add_response_header(h, strdup("Expires"), strdup("0"));
 185
 186         // Unbind from our Citadel server connection.
 187         disconnect_from_citadel(c);
 188 }