granicus.if.org Git - apache/blob - modules/mappers/mod_actions.c

   1 /* ====================================================================
   2  * The Apache Software License, Version 1.1
   3  *
   4  * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
   5  * reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the
  17  *    distribution.
  18  *
  19  * 3. The end-user documentation included with the redistribution,
  20  *    if any, must include the following acknowledgment:
  21  *       "This product includes software developed by the
  22  *        Apache Software Foundation (http://www.apache.org/)."
  23  *    Alternately, this acknowledgment may appear in the software itself,
  24  *    if and wherever such third-party acknowledgments normally appear.
  25  *
  26  * 4. The names "Apache" and "Apache Software Foundation" must
  27  *    not be used to endorse or promote products derived from this
  28  *    software without prior written permission. For written
  29  *    permission, please contact apache@apache.org.
  30  *
  31  * 5. Products derived from this software may not be called "Apache",
  32  *    nor may "Apache" appear in their name, without prior written
  33  *    permission of the Apache Software Foundation.
  34  *
  35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46  * SUCH DAMAGE.
  47  * ====================================================================
  48  *
  49  * This software consists of voluntary contributions made by many
  50  * individuals on behalf of the Apache Software Foundation.  For more
  51  * information on the Apache Software Foundation, please see
  52  * <http://www.apache.org/>.
  53  *
  54  * Portions of this software are based upon public domain software
  55  * originally written at the National Center for Supercomputing Applications,
  56  * University of Illinois, Urbana-Champaign.
  57  */
  58
  59 /*
  60  * mod_actions.c: executes scripts based on MIME type or HTTP method
  61  *
  62  * by Alexei Kosut; based on mod_cgi.c, mod_mime.c and mod_includes.c,
  63  * adapted by rst from original NCSA code by Rob McCool
  64  *
  65  * Usage instructions:
  66  *
  67  * Action mime/type /cgi-bin/script
  68  *
  69  * will activate /cgi-bin/script when a file of content type mime/type is
  70  * requested. It sends the URL and file path of the requested document using
  71  * the standard CGI PATH_INFO and PATH_TRANSLATED environment variables.
  72  *
  73  * Script PUT /cgi-bin/script
  74  *
  75  * will activate /cgi-bin/script when a request is received with the
  76  * HTTP method "PUT".  The available method names are defined in httpd.h.
  77  * If the method is GET, the script will only be activated if the requested
  78  * URI includes query information (stuff after a ?-mark).
  79  */
  80
  81 #include "apr_strings.h"
  82 #include "ap_config.h"
  83 #include "httpd.h"
  84 #include "http_config.h"
  85 #include "http_request.h"
  86 #include "http_core.h"
  87 #include "http_protocol.h"
  88 #include "http_main.h"
  89 #include "http_log.h"
  90 #include "util_script.h"
  91
  92 typedef struct {
  93     apr_table_t *action_types;       /* Added with Action... */
  94     const char *scripted[METHODS];   /* Added with Script... */
  95     int configured;  /* True if Action or Script has been
  96                       * called at least once
  97                       */
  98 } action_dir_config;
  99
 100 module AP_MODULE_DECLARE_DATA actions_module;
 101
 102 static void *create_action_dir_config(apr_pool_t *p, char *dummy)
 103 {
 104     action_dir_config *new =
 105     (action_dir_config *) apr_pcalloc(p, sizeof(action_dir_config));
 106
 107     new->action_types = apr_table_make(p, 4);
 108
 109     return new;
 110 }
 111
 112 static void *merge_action_dir_configs(apr_pool_t *p, void *basev, void *addv)
 113 {
 114     action_dir_config *base = (action_dir_config *) basev;
 115     action_dir_config *add = (action_dir_config *) addv;
 116     action_dir_config *new = (action_dir_config *) apr_palloc(p,
 117                                   sizeof(action_dir_config));
 118     int i;
 119
 120     new->action_types = apr_table_overlay(p, add->action_types,
 121                                        base->action_types);
 122
 123     for (i = 0; i < METHODS; ++i) {
 124         new->scripted[i] = add->scripted[i] ? add->scripted[i]
 125                                             : base->scripted[i];
 126     }
 127
 128     new->configured = (base->configured || add->configured);
 129     return new;
 130 }
 131
 132 static const char *add_action(cmd_parms *cmd, void *m_v,
 133                               const char *type, const char *script)
 134 {
 135     action_dir_config *m = (action_dir_config *)m_v;
 136     apr_table_setn(m->action_types, type, script);
 137     m->configured = 1;
 138     return NULL;
 139 }
 140
 141 static const char *set_script(cmd_parms *cmd, void *m_v,
 142                               const char *method, const char *script)
 143 {
 144     action_dir_config *m = (action_dir_config *)m_v;
 145     int methnum;
 146
 147     methnum = ap_method_number_of(method);
 148     if (methnum == M_TRACE)
 149         return "TRACE not allowed for Script";
 150     else if (methnum == M_INVALID)
 151         return "Unknown method type for Script";
 152     else
 153         m->scripted[methnum] = script;
 154
 155     m->configured = 1;
 156     return NULL;
 157 }
 158
 159 static const command_rec action_cmds[] =
 160 {
 161     AP_INIT_TAKE2("Action", add_action, NULL, OR_FILEINFO,
 162                   "a media type followed by a script name"),
 163     AP_INIT_TAKE2("Script", set_script, NULL, ACCESS_CONF | RSRC_CONF,
 164                   "a method followed by a script name"),
 165     {NULL}
 166 };
 167
 168 static int action_handler(request_rec *r)
 169 {
 170     action_dir_config *conf = (action_dir_config *)
 171         ap_get_module_config(r->per_dir_config, &actions_module);
 172     const char *t, *action;
 173     const char *script;
 174     int i;
 175
 176     if (!conf->configured) {
 177         return DECLINED;
 178     }
 179
 180     /* Note that this handler handles _all_ types, so handler is unchecked */
 181
 182     /* Set allowed stuff */
 183     for (i = 0; i < METHODS; ++i) {
 184         if (conf->scripted[i])
 185             r->allowed |= (AP_METHOD_BIT << i);
 186     }
 187
 188     /* First, check for the method-handling scripts */
 189     if (r->method_number == M_GET) {
 190         if (r->args)
 191             script = conf->scripted[M_GET];
 192         else
 193             script = NULL;
 194     }
 195     else {
 196         script = conf->scripted[r->method_number];
 197     }
 198
 199     /* Check for looping, which can happen if the CGI script isn't */
 200     if (script && r->prev && r->prev->prev)
 201         return DECLINED;
 202
 203     /* Second, check for actions (which override the method scripts) */
 204     action = r->handler ? r->handler :
 205         ap_field_noparam(r->pool, r->content_type);
 206     if ((t = apr_table_get(conf->action_types,
 207                        action ? action : ap_default_type(r)))) {
 208         script = t;
 209         if (r->finfo.filetype == 0) {
 210             ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
 211                         "File does not exist: %s", r->filename);
 212             return HTTP_NOT_FOUND;
 213         }
 214     }
 215
 216     if (script == NULL)
 217         return DECLINED;
 218
 219     ap_internal_redirect_handler(apr_pstrcat(r->pool, script,
 220                                              ap_escape_uri(r->pool, r->uri),
 221                                              r->args ? "?" : NULL,
 222                                              r->args, NULL), r);
 223     return OK;
 224 }
 225
 226 static void register_hooks(apr_pool_t *p)
 227 {
 228     ap_hook_handler(action_handler,NULL,NULL,APR_HOOK_LAST);
 229 }
 230
 231 module AP_MODULE_DECLARE_DATA actions_module =
 232 {
 233     STANDARD20_MODULE_STUFF,
 234     create_action_dir_config,   /* dir config creater */
 235     merge_action_dir_configs,   /* dir merger --- default is to override */
 236     NULL,                       /* server config */
 237     NULL,                       /* merge server config */
 238     action_cmds,                /* command apr_table_t */
 239     register_hooks              /* register hooks */
 240 };