You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@httpd.apache.org by Dean Gaudet <dg...@arctic.org> on 1997/07/08 05:14:43 UTC

[PATCH] mod_simple_dir

There are many reasons that directory indexing might be completely
disabled for a server (security, performance, no need/desire for it
because all directories have index.html).  But you have to carry the full
baggage of mod_dir just to get the "trailing slash redirect" and
DirectoryIndex handling.

This patch changes that.  The two functions are split into two modules,
mod_dir contains all the auto-directory index stuff.  mod_simple_dir
contains the slash-redirect and the DirectoryIndex code. 

I would actually prefer to rename mod_dir to mod_autodir and call the
mod_simple_dir in this patch mod_dir. 

Dean

Index: Configuration.tmpl
===================================================================
RCS file: /export/home/cvs/apache/src/Configuration.tmpl,v
retrieving revision 1.65
diff -u -r1.65 Configuration.tmpl
--- Configuration.tmpl	1997/07/07 18:18:42	1.65
+++ Configuration.tmpl	1997/07/08 03:09:18
@@ -175,11 +175,13 @@
 # Module info_module         mod_info.o
 
 ## mod_include translates server-side include (SSI) statements in text files.
-## mod_dir handles requests on directories and directory indexes.
+## mod_dir handles requests directories which have no index file
+## mod_simple_dir handles requests on directories and directory index files.
 ## mod_cgi handles CGI scripts.
 
 Module includes_module     mod_include.o
 Module dir_module          mod_dir.o
+Module simple_dir_module   mod_simple_dir.o
 Module cgi_module          mod_cgi.o
 
 ## The asis module implemented ".asis" file types, which allow the embedding
Index: mod_dir.c
===================================================================
RCS file: /export/home/cvs/apache/src/mod_dir.c,v
retrieving revision 1.31
diff -u -r1.31 mod_dir.c
--- mod_dir.c	1997/07/05 21:30:22	1.31
+++ mod_dir.c	1997/07/08 03:09:20
@@ -102,7 +102,6 @@
 typedef struct dir_config_struct {
 
     char *default_icon;
-    char *index_names;
     int icon_width;
     int icon_height;
   
@@ -282,10 +281,6 @@
 { "DefaultIcon", set_string_slot,
     (void*)XtOffsetOf(dir_config_rec, default_icon),
     DIR_CMD_PERMS, TAKE1, "an icon URL"},
-{ "DirectoryIndex", set_string_slot,
-    (void*)XtOffsetOf(dir_config_rec, index_names),
-    DIR_CMD_PERMS, RAW_ARGS,
-    "a list of file names" },
 { NULL }
 };
 
@@ -294,7 +289,6 @@
     dir_config_rec *new =
         (dir_config_rec *) pcalloc (p, sizeof(dir_config_rec));
 
-    new->index_names = NULL;
     new->icon_width = 0;
     new->icon_height = 0;
     new->icon_list = make_array (p, 4, sizeof (struct item));
@@ -315,7 +309,6 @@
     dir_config_rec *add = (dir_config_rec *)addv;
 
     new->default_icon = add->default_icon?add->default_icon:base->default_icon;
-    new->index_names = add->index_names? add->index_names: base->index_names;
     new->icon_height = add->icon_height ? add->icon_height : base->icon_height;
     new->icon_width = add->icon_width ? add->icon_width : base->icon_width;
 
@@ -860,81 +853,7 @@
 {
     dir_config_rec *d =
       (dir_config_rec *)get_module_config (r->per_dir_config, &dir_module);
-    const char *names_ptr = d->index_names ? d->index_names : DEFAULT_INDEX;
     int allow_opts = allow_options (r);
-    int error_notfound = 0;
-
-    if (r->uri[0] == '\0' || r->uri[strlen(r->uri)-1] != '/') {
-	char* ifile;
-	if (r->args != NULL)
-        	ifile = pstrcat (r->pool, escape_uri(r->pool, r->uri),
-			"/", "?", r->args, NULL);
-	else
-        	ifile = pstrcat (r->pool, escape_uri(r->pool, r->uri),
-			 "/", NULL);
-
-	table_set (r->headers_out, "Location",
-		   construct_url(r->pool, ifile, r->server)); 
-	return HTTP_MOVED_PERMANENTLY;
-    }
-
-    /* KLUDGE --- make the sub_req lookups happen in the right directory.
-     * Fixing this in the sub_req_lookup functions themselves is difficult,
-     * and would probably break virtual includes...
-     */
-
-    r->filename = pstrcat (r->pool, r->filename, "/", NULL);
-    
-    while (*names_ptr) {
-          
-	char *name_ptr = getword_conf (r->pool, &names_ptr);
-	request_rec *rr = sub_req_lookup_uri (name_ptr, r);
-           
-	if (rr->status == HTTP_OK && rr->finfo.st_mode != 0) {
-	    char* new_uri = escape_uri(r->pool, rr->uri);
-
-	    if (rr->args != NULL)
-		new_uri = pstrcat(r->pool, new_uri, "?", rr->args, NULL);
-	    else if (r->args != NULL)
-		new_uri = pstrcat(r->pool, new_uri, "?", r->args, NULL);
-	
-	    destroy_sub_req (rr);
-	    internal_redirect (new_uri, r);
-	    return OK;
-	}
-
-	/* If the request returned a redirect, propagate it to the client */
-
-	if (is_HTTP_REDIRECT(rr->status) ||
-	    (rr->status == HTTP_NOT_ACCEPTABLE && *names_ptr == '\0')) {
-
-	    error_notfound = rr->status;
-	    r->notes = overlay_tables(r->pool, r->notes, rr->notes);
-	    r->headers_out = overlay_tables(r->pool, r->headers_out,
-	                                            rr->headers_out);
-	    r->err_headers_out = overlay_tables(r->pool, r->err_headers_out,
-	                                                rr->err_headers_out);
-	    destroy_sub_req(rr);
-	    return error_notfound;
-	}
-            
-	/* If the request returned something other than 404 (or 200),
-	 * it means the module encountered some sort of problem. To be
-	 * secure, we should return the error, rather than create
-	 * along a (possibly unsafe) directory index.
-	 *
-	 * So we store the error, and if none of the listed files
-	 * exist, we return the last error response we got, instead
-	 * of a directory listing.
-	 */
-	if (rr->status && rr->status != HTTP_NOT_FOUND && rr->status != HTTP_OK)
-	    error_notfound = rr->status;
-
-        destroy_sub_req (rr);
-    }
-
-    if (error_notfound)
-	return error_notfound;
 
     if (r->method_number != M_GET) return NOT_IMPLEMENTED;
     
Index: mod_simple_dir.c
===================================================================
RCS file: mod_simple_dir.c
diff -N mod_simple_dir.c
--- /dev/null	Mon Jul  7 20:09:00 1997
+++ mod_simple_dir.c	Mon Jul  7 20:09:21 1997
@@ -0,0 +1,216 @@
+/* ====================================================================
+ * Copyright (c) 1995-1997 The Apache Group.  All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer. 
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ *
+ * 3. All advertising materials mentioning features or use of this
+ *    software must display the following acknowledgment:
+ *    "This product includes software developed by the Apache Group
+ *    for use in the Apache HTTP server project (http://www.apache.org/)."
+ *
+ * 4. The names "Apache Server" and "Apache Group" must not be used to
+ *    endorse or promote products derived from this software without
+ *    prior written permission.
+ *
+ * 5. Redistributions of any form whatsoever must retain the following
+ *    acknowledgment:
+ *    "This product includes software developed by the Apache Group
+ *    for use in the Apache HTTP server project (http://www.apache.org/)."
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY
+ * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE APACHE GROUP OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Group and was originally based
+ * on public domain software written at the National Center for
+ * Supercomputing Applications, University of Illinois, Urbana-Champaign.
+ * For more information on the Apache Group and the Apache HTTP server
+ * project, please see <http://www.apache.org/>.
+ *
+ */
+
+/*
+ * mod_simple_dir.c: handle default index files, and trailing-/ redirects
+ */
+
+#include "httpd.h"
+#include "http_config.h"
+#include "http_core.h"
+#include "http_request.h"
+#include "http_protocol.h"
+#include "http_log.h"
+#include "http_main.h"
+#include "util_script.h"
+
+#ifdef WIN32
+#include "nt/readdir.h"
+#endif
+
+module simple_dir_module;
+
+typedef struct simple_dir_config_struct {
+    char *index_names;
+} simple_dir_config_rec;
+
+#define DIR_CMD_PERMS OR_INDEXES
+
+static command_rec simple_dir_cmds[] = {
+{ "DirectoryIndex", set_string_slot,
+    (void*)XtOffsetOf(simple_dir_config_rec, index_names),
+    DIR_CMD_PERMS, RAW_ARGS,
+    "a list of file names" },
+{ NULL }
+};
+
+static void *create_simple_dir_config (pool *p, char *dummy)
+{
+    simple_dir_config_rec *new =
+        (simple_dir_config_rec *) pcalloc (p, sizeof(simple_dir_config_rec));
+
+    new->index_names = NULL;
+    return (void *)new;
+}
+
+static void *merge_simple_dir_configs (pool *p, void *basev, void *addv)
+{
+    simple_dir_config_rec *new=(simple_dir_config_rec*)pcalloc (p, sizeof(simple_dir_config_rec));
+    simple_dir_config_rec *base = (simple_dir_config_rec *)basev;
+    simple_dir_config_rec *add = (simple_dir_config_rec *)addv;
+
+    new->index_names = add->index_names? add->index_names: base->index_names;
+    return new;
+}
+
+static int handle_simple_dir (request_rec *r)
+{
+    simple_dir_config_rec *d =
+      (simple_dir_config_rec *)get_module_config (r->per_dir_config,
+      &simple_dir_module);
+    const char *names_ptr = d->index_names ? d->index_names : DEFAULT_INDEX;
+    int allow_opts = allow_options (r);
+    int error_notfound = 0;
+
+    if (r->uri[0] == '\0' || r->uri[strlen(r->uri)-1] != '/') {
+	char* ifile;
+	if (r->args != NULL)
+        	ifile = pstrcat (r->pool, escape_uri(r->pool, r->uri),
+			"/", "?", r->args, NULL);
+	else
+        	ifile = pstrcat (r->pool, escape_uri(r->pool, r->uri),
+			 "/", NULL);
+
+	table_set (r->headers_out, "Location",
+		   construct_url(r->pool, ifile, r->server)); 
+	return HTTP_MOVED_PERMANENTLY;
+    }
+
+    /* KLUDGE --- make the sub_req lookups happen in the right directory.
+     * Fixing this in the sub_req_lookup functions themselves is difficult,
+     * and would probably break virtual includes...
+     */
+
+    r->filename = pstrcat (r->pool, r->filename, "/", NULL);
+    
+    while (*names_ptr) {
+          
+	char *name_ptr = getword_conf (r->pool, &names_ptr);
+	request_rec *rr = sub_req_lookup_uri (name_ptr, r);
+           
+	if (rr->status == HTTP_OK && rr->finfo.st_mode != 0) {
+	    char* new_uri = escape_uri(r->pool, rr->uri);
+
+	    if (rr->args != NULL)
+		new_uri = pstrcat(r->pool, new_uri, "?", rr->args, NULL);
+	    else if (r->args != NULL)
+		new_uri = pstrcat(r->pool, new_uri, "?", r->args, NULL);
+	
+	    destroy_sub_req (rr);
+	    internal_redirect (new_uri, r);
+	    return OK;
+	}
+
+	/* If the request returned a redirect, propagate it to the client */
+
+	if (is_HTTP_REDIRECT(rr->status) ||
+	    (rr->status == HTTP_NOT_ACCEPTABLE && *names_ptr == '\0')) {
+
+	    error_notfound = rr->status;
+	    r->notes = overlay_tables(r->pool, r->notes, rr->notes);
+	    r->headers_out = overlay_tables(r->pool, r->headers_out,
+	                                            rr->headers_out);
+	    r->err_headers_out = overlay_tables(r->pool, r->err_headers_out,
+	                                                rr->err_headers_out);
+	    destroy_sub_req(rr);
+	    return error_notfound;
+	}
+
+	/* If the request returned something other than 404 (or 200),
+	 * it means the module encountered some sort of problem. To be
+	 * secure, we should return the error, rather than create
+	 * along a (possibly unsafe) directory index.
+	 *
+	 * So we store the error, and if none of the listed files
+	 * exist, we return the last error response we got, instead
+	 * of a directory listing.
+	 */
+	if (rr->status && rr->status != HTTP_NOT_FOUND && rr->status != HTTP_OK)
+	    error_notfound = rr->status;
+
+        destroy_sub_req (rr);
+    }
+
+    if (error_notfound)
+	return error_notfound;
+
+    if (r->method_number != M_GET) return NOT_IMPLEMENTED;
+    
+    /* nothing for us to do, pass on through */
+
+    return DECLINED;
+}
+
+
+static handler_rec simple_dir_handlers[] = {
+{ DIR_MAGIC_TYPE, handle_simple_dir },
+{ NULL }
+};
+
+module simple_dir_module = {
+   STANDARD_MODULE_STUFF,
+   NULL,			/* initializer */
+   create_simple_dir_config,	/* dir config creater */
+   merge_simple_dir_configs,	/* dir merger --- default is to override */
+   NULL,			/* server config */
+   NULL,			/* merge server config */
+   simple_dir_cmds,		/* command table */
+   simple_dir_handlers,		/* handlers */
+   NULL,			/* filename translation */
+   NULL,			/* check_user_id */
+   NULL,			/* check auth */
+   NULL,			/* check access */
+   NULL,			/* type_checker */
+   NULL,			/* fixups */
+   NULL,			/* logger */
+   NULL				/* header parser */
+};




Re: [PATCH] mod_simple_dir

Posted by Paul Sutton <pa...@ukweb.com>.
On Mon, 7 Jul 1997, Dean Gaudet wrote:
> There are many reasons that directory indexing might be completely
> disabled for a server (security, performance, no need/desire for it
> because all directories have index.html).  But you have to carry the full
> baggage of mod_dir just to get the "trailing slash redirect" and
> DirectoryIndex handling.
> 
> This patch changes that.  The two functions are split into two modules,
> mod_dir contains all the auto-directory index stuff.  mod_simple_dir
> contains the slash-redirect and the DirectoryIndex code. 

+1 on the idea. This is great... I never use auto-generated indexes so
I've always wanted to get rid of the auto-index stuff from my servers. 

> I would actually prefer to rename mod_dir to mod_autodir and call the
> mod_simple_dir in this patch mod_dir. 

Yes. But how about mod_dir_autoindex and mod_dir_indexfile to make the
functionality completely clear, although calling the latter just mod_dir
would be fine. 

//pcs


Re: [PATCH] mod_simple_dir

Posted by Alexei Kosut <ak...@organic.com>.
On Mon, 7 Jul 1997, Dean Gaudet wrote:

[...]

> I would actually prefer to rename mod_dir to mod_autodir and call the
> mod_simple_dir in this patch mod_dir. 

"autodir" sounds like a German paper shredder. How about mod_dirindex?
Haven't had time to look at the patch, but +1 on the concept.

-- Alexei Kosut <ak...@organic.com>