granicus.if.org Git - apache/blob - modules/http/http_request.c

   1 /* Copyright 1999-2005 The Apache Software Foundation or its licensors, as
   2  * applicable.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /*
  18  * http_request.c: functions to get and process requests
  19  *
  20  * Rob McCool 3/21/93
  21  *
  22  * Thoroughly revamped by rst for Apache.  NB this file reads
  23  * best from the bottom up.
  24  *
  25  */
  26
  27 #include "apr_strings.h"
  28 #include "apr_file_io.h"
  29 #include "apr_fnmatch.h"
  30
  31 #define APR_WANT_STRFUNC
  32 #include "apr_want.h"
  33
  34 #define CORE_PRIVATE
  35 #include "ap_config.h"
  36 #include "httpd.h"
  37 #include "http_config.h"
  38 #include "http_request.h"
  39 #include "http_core.h"
  40 #include "http_protocol.h"
  41 #include "http_log.h"
  42 #include "http_main.h"
  43 #include "util_filter.h"
  44 #include "util_charset.h"
  45 #include "scoreboard.h"
  46
  47 #include "mod_core.h"
  48
  49 #if APR_HAVE_STDARG_H
  50 #include <stdarg.h>
  51 #endif
  52
  53 /*****************************************************************
  54  *
  55  * Mainline request processing...
  56  */
  57
  58 /* XXX A cleaner and faster way to do this might be to pass the request_rec
  59  * down the filter chain as a parameter.  It would need to change for
  60  * subrequest vs. main request filters; perhaps the subrequest filter could
  61  * make the switch.
  62  */
  63 static void update_r_in_filters(ap_filter_t *f,
  64                                 request_rec *from,
  65                                 request_rec *to)
  66 {
  67     while (f) {
  68         if (f->r == from) {
  69             f->r = to;
  70         }
  71         f = f->next;
  72     }
  73 }
  74
  75 AP_DECLARE(void) ap_die(int type, request_rec *r)
  76 {
  77     int error_index = ap_index_of_response(type);
  78     char *custom_response = ap_response_code_string(r, error_index);
  79     int recursive_error = 0;
  80     request_rec *r_1st_err = r;
  81
  82     if (type == AP_FILTER_ERROR) {
  83         return;
  84     }
  85
  86     if (type == DONE) {
  87         ap_finalize_request_protocol(r);
  88         return;
  89     }
  90
  91     /*
  92      * The following takes care of Apache redirects to custom response URLs
  93      * Note that if we are already dealing with the response to some other
  94      * error condition, we just report on the original error, and give up on
  95      * any attempt to handle the other thing "intelligently"...
  96      */
  97     if (r->status != HTTP_OK) {
  98         recursive_error = type;
  99
 100         while (r_1st_err->prev && (r_1st_err->prev->status != HTTP_OK))
 101             r_1st_err = r_1st_err->prev;  /* Get back to original error */
 102
 103         if (r_1st_err != r) {
 104             /* The recursive error was caused by an ErrorDocument specifying
 105              * an internal redirect to a bad URI.  ap_internal_redirect has
 106              * changed the filter chains to point to the ErrorDocument's
 107              * request_rec.  Back out those changes so we can safely use the
 108              * original failing request_rec to send the canned error message.
 109              *
 110              * ap_send_error_response gets rid of existing resource filters
 111              * on the output side, so we can skip those.
 112              */
 113             update_r_in_filters(r_1st_err->proto_output_filters, r, r_1st_err);
 114             update_r_in_filters(r_1st_err->input_filters, r, r_1st_err);
 115         }
 116
 117         custom_response = NULL; /* Do NOT retry the custom thing! */
 118     }
 119
 120     r->status = type;
 121
 122     /*
 123      * This test is done here so that none of the auth modules needs to know
 124      * about proxy authentication.  They treat it like normal auth, and then
 125      * we tweak the status.
 126      */
 127     if (HTTP_UNAUTHORIZED == r->status && PROXYREQ_PROXY == r->proxyreq) {
 128         r->status = HTTP_PROXY_AUTHENTICATION_REQUIRED;
 129     }
 130
 131     /* If we don't want to keep the connection, make sure we mark that the
 132      * connection is not eligible for keepalive.  If we want to keep the
 133      * connection, be sure that the request body (if any) has been read.
 134      */
 135     if (ap_status_drops_connection(r->status)) {
 136         r->connection->keepalive = AP_CONN_CLOSE;
 137     }
 138
 139     /*
 140      * Two types of custom redirects --- plain text, and URLs. Plain text has
 141      * a leading '"', so the URL code, here, is triggered on its absence
 142      */
 143
 144     if (custom_response && custom_response[0] != '"') {
 145
 146         if (ap_is_url(custom_response)) {
 147             /*
 148              * The URL isn't local, so lets drop through the rest of this
 149              * apache code, and continue with the usual REDIRECT handler.
 150              * But note that the client will ultimately see the wrong
 151              * status...
 152              */
 153             r->status = HTTP_MOVED_TEMPORARILY;
 154             apr_table_setn(r->headers_out, "Location", custom_response);
 155         }
 156         else if (custom_response[0] == '/') {
 157             const char *error_notes;
 158             r->no_local_copy = 1;       /* Do NOT send HTTP_NOT_MODIFIED for
 159                                          * error documents! */
 160             /*
 161              * This redirect needs to be a GET no matter what the original
 162              * method was.
 163              */
 164             apr_table_setn(r->subprocess_env, "REQUEST_METHOD", r->method);
 165
 166             /*
 167              * Provide a special method for modules to communicate
 168              * more informative (than the plain canned) messages to us.
 169              * Propagate them to ErrorDocuments via the ERROR_NOTES variable:
 170              */
 171             if ((error_notes = apr_table_get(r->notes,
 172                                              "error-notes")) != NULL) {
 173                 apr_table_setn(r->subprocess_env, "ERROR_NOTES", error_notes);
 174             }
 175             r->method = apr_pstrdup(r->pool, "GET");
 176             r->method_number = M_GET;
 177             ap_internal_redirect(custom_response, r);
 178             return;
 179         }
 180         else {
 181             /*
 182              * Dumb user has given us a bad url to redirect to --- fake up
 183              * dying with a recursive server error...
 184              */
 185             recursive_error = HTTP_INTERNAL_SERVER_ERROR;
 186             ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
 187                         "Invalid error redirection directive: %s",
 188                         custom_response);
 189         }
 190     }
 191     ap_send_error_response(r_1st_err, recursive_error);
 192 }
 193
 194 static void check_pipeline(conn_rec *c)
 195 {
 196     /* ### is zero correct? that means "read one line" */
 197     if (c->keepalive != AP_CONN_CLOSE) {
 198         apr_bucket_brigade *bb = apr_brigade_create(c->pool, c->bucket_alloc);
 199         if (ap_get_brigade(c->input_filters, bb, AP_MODE_EATCRLF,
 200                        APR_NONBLOCK_READ, 0) != APR_SUCCESS) {
 201             c->data_in_input_filters = 0;  /* we got APR_EOF or an error */
 202         }
 203         else {
 204             c->data_in_input_filters = 1;
 205         }
 206     }
 207 }
 208
 209
 210 void ap_process_async_request(request_rec *r)
 211 {
 212     int access_status;
 213     apr_bucket_brigade *bb;
 214     apr_bucket *b;
 215     conn_rec *c = r->connection;
 216
 217     /* Give quick handlers a shot at serving the request on the fast
 218      * path, bypassing all of the other Apache hooks.
 219      *
 220      * This hook was added to enable serving files out of a URI keyed
 221      * content cache ( e.g., Mike Abbott's Quick Shortcut Cache,
 222      * described here: http://oss.sgi.com/projects/apache/mod_qsc.html )
 223      *
 224      * It may have other uses as well, such as routing requests directly to
 225      * content handlers that have the ability to grok HTTP and do their
 226      * own access checking, etc (e.g. servlet engines).
 227      *
 228      * Use this hook with extreme care and only if you know what you are
 229      * doing.
 230      */
 231     if (ap_extended_status)
 232         ap_time_process_request(r->connection->sbh, START_PREQUEST);
 233     access_status = ap_run_quick_handler(r, 0);  /* Not a look-up request */
 234     if (access_status == DECLINED) {
 235         access_status = ap_process_request_internal(r);
 236         if (access_status == OK) {
 237             access_status = ap_invoke_handler(r);
 238         }
 239     }
 240
 241     if (access_status == DONE) {
 242         /* e.g., something not in storage like TRACE */
 243         access_status = OK;
 244     }
 245
 246     if (access_status == OK) {
 247         ap_finalize_request_protocol(r);
 248     }
 249     else {
 250         r->status = HTTP_OK;
 251         ap_die(access_status, r);
 252     }
 253
 254     /* Send an EOR bucket through the output filter chain.  When
 255      * this bucket is destroyed, the request will be logged and
 256      * its pool will be freed
 257      */
 258     bb = apr_brigade_create(r->connection->pool, r->connection->bucket_alloc);
 259     b = ap_bucket_eor_create(r->connection->bucket_alloc, r);
 260     APR_BRIGADE_INSERT_HEAD(bb, b);
 261     ap_pass_brigade(r->connection->output_filters, bb);
 262
 263     /* From here onward, it is no longer safe to reference r
 264      * or r->pool, because r->pool may have been destroyed
 265      * already by the EOR bucket's cleanup function.
 266      */
 267
 268     c->cs->state = CONN_STATE_WRITE_COMPLETION;
 269     check_pipeline(c);
 270     if (ap_extended_status)
 271         ap_time_process_request(c->sbh, STOP_PREQUEST);
 272 }
 273
 274 void ap_process_request(request_rec *r)
 275 {
 276     apr_bucket_brigade *bb;
 277     apr_bucket *b;
 278     conn_rec *c = r->connection;
 279
 280     ap_process_async_request(r);
 281
 282     if (!c->data_in_input_filters) {
 283         bb = apr_brigade_create(c->pool, c->bucket_alloc);
 284         b = apr_bucket_flush_create(c->bucket_alloc);
 285         APR_BRIGADE_INSERT_HEAD(bb, b);
 286         ap_pass_brigade(c->output_filters, bb);
 287     }
 288     if (ap_extended_status) {
 289         ap_time_process_request(c->sbh, STOP_PREQUEST);
 290     }
 291 }
 292
 293 static apr_table_t *rename_original_env(apr_pool_t *p, apr_table_t *t)
 294 {
 295     const apr_array_header_t *env_arr = apr_table_elts(t);
 296     const apr_table_entry_t *elts = (const apr_table_entry_t *) env_arr->elts;
 297     apr_table_t *new = apr_table_make(p, env_arr->nalloc);
 298     int i;
 299
 300     for (i = 0; i < env_arr->nelts; ++i) {
 301         if (!elts[i].key)
 302             continue;
 303         apr_table_setn(new, apr_pstrcat(p, "REDIRECT_", elts[i].key, NULL),
 304                   elts[i].val);
 305     }
 306
 307     return new;
 308 }
 309
 310 static request_rec *internal_internal_redirect(const char *new_uri,
 311                                                request_rec *r) {
 312     int access_status;
 313     request_rec *new;
 314
 315     if (ap_is_recursion_limit_exceeded(r)) {
 316         ap_die(HTTP_INTERNAL_SERVER_ERROR, r);
 317         return NULL;
 318     }
 319
 320     new = (request_rec *) apr_pcalloc(r->pool, sizeof(request_rec));
 321
 322     new->connection = r->connection;
 323     new->server     = r->server;
 324     new->pool       = r->pool;
 325
 326     /*
 327      * A whole lot of this really ought to be shared with http_protocol.c...
 328      * another missing cleanup.  It's particularly inappropriate to be
 329      * setting header_only, etc., here.
 330      */
 331
 332     new->method          = r->method;
 333     new->method_number   = r->method_number;
 334     new->allowed_methods = ap_make_method_list(new->pool, 2);
 335     ap_parse_uri(new, new_uri);
 336
 337     new->request_config = ap_create_request_config(r->pool);
 338
 339     new->per_dir_config = r->server->lookup_defaults;
 340
 341     new->prev = r;
 342     r->next   = new;
 343
 344     /* Must have prev and next pointers set before calling create_request
 345      * hook.
 346      */
 347     ap_run_create_request(new);
 348
 349     /* Inherit the rest of the protocol info... */
 350
 351     new->the_request = r->the_request;
 352
 353     new->allowed         = r->allowed;
 354
 355     new->status          = r->status;
 356     new->assbackwards    = r->assbackwards;
 357     new->header_only     = r->header_only;
 358     new->protocol        = r->protocol;
 359     new->proto_num       = r->proto_num;
 360     new->hostname        = r->hostname;
 361     new->request_time    = r->request_time;
 362     new->main            = r->main;
 363
 364     new->headers_in      = r->headers_in;
 365     new->headers_out     = apr_table_make(r->pool, 12);
 366     new->err_headers_out = r->err_headers_out;
 367     new->subprocess_env  = rename_original_env(r->pool, r->subprocess_env);
 368     new->notes           = apr_table_make(r->pool, 5);
 369     new->allowed_methods = ap_make_method_list(new->pool, 2);
 370
 371     new->htaccess        = r->htaccess;
 372     new->no_cache        = r->no_cache;
 373     new->expecting_100   = r->expecting_100;
 374     new->no_local_copy   = r->no_local_copy;
 375     new->read_length     = r->read_length;     /* We can only read it once */
 376     new->vlist_validator = r->vlist_validator;
 377
 378     new->proto_output_filters  = r->proto_output_filters;
 379     new->proto_input_filters   = r->proto_input_filters;
 380
 381     new->output_filters  = new->proto_output_filters;
 382     new->input_filters   = new->proto_input_filters;
 383
 384     if (new->main) {
 385         /* Add back the subrequest filter, which we lost when
 386          * we set output_filters to include only the protocol
 387          * output filters from the original request.
 388          */
 389         ap_add_output_filter_handle(ap_subreq_core_filter_handle,
 390                                     NULL, new, new->connection);
 391     }
 392
 393     update_r_in_filters(new->input_filters, r, new);
 394     update_r_in_filters(new->output_filters, r, new);
 395
 396     apr_table_setn(new->subprocess_env, "REDIRECT_STATUS",
 397                    apr_itoa(r->pool, r->status));
 398
 399     /*
 400      * XXX: hmm.  This is because mod_setenvif and mod_unique_id really need
 401      * to do their thing on internal redirects as well.  Perhaps this is a
 402      * misnamed function.
 403      */
 404     if ((access_status = ap_run_post_read_request(new))) {
 405         ap_die(access_status, new);
 406         return NULL;
 407     }
 408
 409     return new;
 410 }
 411
 412 /* XXX: Is this function is so bogus and fragile that we deep-6 it? */
 413 AP_DECLARE(void) ap_internal_fast_redirect(request_rec *rr, request_rec *r)
 414 {
 415     /* We need to tell POOL_DEBUG that we're guaranteeing that rr->pool
 416      * will exist as long as r->pool.  Otherwise we run into troubles because
 417      * some values in this request will be allocated in r->pool, and others in
 418      * rr->pool.
 419      */
 420     apr_pool_join(r->pool, rr->pool);
 421     r->proxyreq = rr->proxyreq;
 422     r->no_cache = (r->no_cache && rr->no_cache);
 423     r->no_local_copy = (r->no_local_copy && rr->no_local_copy);
 424     r->mtime = rr->mtime;
 425     r->uri = rr->uri;
 426     r->filename = rr->filename;
 427     r->canonical_filename = rr->canonical_filename;
 428     r->path_info = rr->path_info;
 429     r->args = rr->args;
 430     r->finfo = rr->finfo;
 431     r->handler = rr->handler;
 432     ap_set_content_type(r, rr->content_type);
 433     r->content_encoding = rr->content_encoding;
 434     r->content_languages = rr->content_languages;
 435     r->per_dir_config = rr->per_dir_config;
 436     /* copy output headers from subrequest, but leave negotiation headers */
 437     r->notes = apr_table_overlay(r->pool, rr->notes, r->notes);
 438     r->headers_out = apr_table_overlay(r->pool, rr->headers_out,
 439                                        r->headers_out);
 440     r->err_headers_out = apr_table_overlay(r->pool, rr->err_headers_out,
 441                                            r->err_headers_out);
 442     r->subprocess_env = apr_table_overlay(r->pool, rr->subprocess_env,
 443                                           r->subprocess_env);
 444
 445     r->output_filters = rr->output_filters;
 446     r->input_filters = rr->input_filters;
 447
 448     if (r->main) {
 449         ap_add_output_filter_handle(ap_subreq_core_filter_handle,
 450                                     NULL, r, r->connection);
 451     }
 452     else if (r->output_filters->frec == ap_subreq_core_filter_handle) {
 453         ap_remove_output_filter(r->output_filters);
 454         r->output_filters = r->output_filters->next;
 455     }
 456
 457     /* If any filters pointed at the now-defunct rr, we must point them
 458      * at our "new" instance of r.  In particular, some of rr's structures
 459      * will now be bogus (say rr->headers_out).  If a filter tried to modify
 460      * their f->r structure when it is pointing to rr, the real request_rec
 461      * will not get updated.  Fix that here.
 462      */
 463     update_r_in_filters(r->input_filters, rr, r);
 464     update_r_in_filters(r->output_filters, rr, r);
 465 }
 466
 467 AP_DECLARE(void) ap_internal_redirect(const char *new_uri, request_rec *r)
 468 {
 469     request_rec *new = internal_internal_redirect(new_uri, r);
 470     int access_status;
 471
 472     /* ap_die was already called, if an error occured */
 473     if (!new) {
 474         return;
 475     }
 476
 477     access_status = ap_run_quick_handler(new, 0);  /* Not a look-up request */
 478     if (access_status == DECLINED) {
 479         access_status = ap_process_request_internal(new);
 480         if (access_status == OK) {
 481             access_status = ap_invoke_handler(new);
 482         }
 483     }
 484     if (access_status == OK) {
 485         ap_finalize_request_protocol(new);
 486     }
 487     else {
 488         ap_die(access_status, new);
 489     }
 490 }
 491
 492 /* This function is designed for things like actions or CGI scripts, when
 493  * using AddHandler, and you want to preserve the content type across
 494  * an internal redirect.
 495  */
 496 AP_DECLARE(void) ap_internal_redirect_handler(const char *new_uri, request_rec *r)
 497 {
 498     int access_status;
 499     request_rec *new = internal_internal_redirect(new_uri, r);
 500
 501     /* ap_die was already called, if an error occured */
 502     if (!new) {
 503         return;
 504     }
 505
 506     if (r->handler)
 507         ap_set_content_type(new, r->content_type);
 508     access_status = ap_process_request_internal(new);
 509     if (access_status == OK) {
 510         if ((access_status = ap_invoke_handler(new)) != 0) {
 511             ap_die(access_status, new);
 512             return;
 513         }
 514         ap_finalize_request_protocol(new);
 515     }
 516     else {
 517         ap_die(access_status, new);
 518     }
 519 }
 520
 521 AP_DECLARE(void) ap_allow_methods(request_rec *r, int reset, ...)
 522 {
 523     const char *method;
 524     va_list methods;
 525
 526     /*
 527      * Get rid of any current settings if requested; not just the
 528      * well-known methods but any extensions as well.
 529      */
 530     if (reset) {
 531         ap_clear_method_list(r->allowed_methods);
 532     }
 533
 534     va_start(methods, reset);
 535     while ((method = va_arg(methods, const char *)) != NULL) {
 536         ap_method_list_add(r->allowed_methods, method);
 537     }
 538     va_end(methods);
 539 }
 540
 541 AP_DECLARE(void) ap_allow_standard_methods(request_rec *r, int reset, ...)
 542 {
 543     int method;
 544     va_list methods;
 545     apr_int64_t mask;
 546
 547     /*
 548      * Get rid of any current settings if requested; not just the
 549      * well-known methods but any extensions as well.
 550      */
 551     if (reset) {
 552         ap_clear_method_list(r->allowed_methods);
 553     }
 554
 555     mask = 0;
 556     va_start(methods, reset);
 557     while ((method = va_arg(methods, int)) != -1) {
 558         mask |= (AP_METHOD_BIT << method);
 559     }
 560     va_end(methods);
 561
 562     r->allowed_methods->method_mask |= mask;
 563 }