- Added support for sending as much response as possible in a single

ngx_chain_t instead of always calling the output filter three times.
  This should avoid possible blocking in Nginx code.
- Added warning about using external URLs in subrequest in readme file.
- Factorized out some variable declarations out to function header. Removed
  a shadowed variable.
- Removed some debugging statements.

README.rst

@@ -116,6 +116,15 @@ fancyindex_footer
   If set to an empty string, the default footer supplied by the module will
   be sent.
 
+.. warning:: When inserting custom header/footer a subrequest will be
+   issued so potentially any URL can be used as source for them. Although it
+   will work with external URLs, only using internal ones is supported.
+   External URLs are totally untested and using them will make Nginx_ block
+   while waiting for the subrequest to complete. If you feel like external
+   header/footer is a must-have for you, please
+   `let me know <mailto:adrianperez@udc.es>`__.
+
+
 fancyindex_readme
 ~~~~~~~~~~~~~~~~~
 :Syntax: *fancyindex_readme path*

ngx_http_fancyindex_module.c

@@ -680,10 +680,13 @@ skip_readme_bottom:
 static ngx_int_t
 ngx_http_fancyindex_handler(ngx_http_request_t *r)
 {
-    ngx_buf_t                      *content = NULL;
+    ngx_http_request_t             *sr;
+    ngx_str_t                      *sr_uri;
+    ngx_str_t                       rel_uri;
     ngx_int_t                       rc;
-    ngx_chain_t                     out;
     ngx_http_fancyindex_loc_conf_t *alcf;
+    ngx_chain_t                     out[3] = {
+        { NULL, NULL }, { NULL, NULL}, { NULL, NULL }};
 
 
     if (r->uri.data[r->uri.len - 1] != '/') {
@@ -705,9 +708,11 @@ ngx_http_fancyindex_handler(ngx_http_request_t *r)
         return NGX_DECLINED;
     }
 
-    if ((rc = make_content_buf(r, &content, alcf) != NGX_OK))
+    if ((rc = make_content_buf(r, &out[0].buf, alcf) != NGX_OK))
         return rc;
 
+    out[0].buf->last_in_chain = 1;
+
     r->headers_out.status = NGX_HTTP_OK;
     r->headers_out.content_type_len  = ngx_sizeof_ssz("text/html");
     r->headers_out.content_type.len  = ngx_sizeof_ssz("text/html");
@@ -722,10 +727,7 @@ ngx_http_fancyindex_handler(ngx_http_request_t *r)
 
     if (alcf->header.len > 0) {
         /* URI is configured, make Nginx take care of with a subrequest. */
-        ngx_http_request_t *sr;
+        sr_uri = &alcf->header;
-        ngx_str_t *sr_uri = &alcf->header;
-        ngx_str_t rel_uri;
-        ngx_int_t rc;
 
         if (*sr_uri->data != '/') {
             /* Relative path */
@@ -763,43 +765,46 @@ ngx_http_fancyindex_handler(ngx_http_request_t *r)
     }
     else {
 add_builtin_header:
-        out.next = NULL;
+        ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
-        out.buf  = make_header_buf(r);
+                "http fancyindex: adding built-in header");
-        out.buf->last_in_chain = 1;
+        /* Make space before */
-        out.buf->last_buf = 0;
+        out[1].next = out[0].next;
-
+        out[1].buf  = out[0].buf;
-        rc = ngx_http_output_filter(r, &out);
+        /* Chain header buffer */
-
+        out[0].next = &out[1];
-        if (rc != NGX_OK && rc != NGX_AGAIN) {
+        out[0].buf  = make_header_buf(r);
-            ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
-                    "Header: YOU HIT ME (%i)", rc);
-            return NGX_HTTP_INTERNAL_SERVER_ERROR;
     }
+
+    /* If footer is disabled, chain up footer buffer. */
+    if (alcf->footer.len == 0) {
+        ngx_uint_t last  = (alcf->header.len == 0) ? 2 : 1;
+
+        ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
+                "http fancyindex: adding built-in footer at %i", last);
+
+        out[last-1].next = &out[last];
+        out[last].buf    = make_footer_buf(r);
+
+        out[last-1].buf->last_in_chain = 0;
+        out[last].buf->last_in_chain   = 1;
+        out[last].buf->last_buf        = 1;
+        /* Send everything with a single call :D */
+        return ngx_http_output_filter(r, &out[0]);
     }
 
     /*
-     * Output listing content.
+     * If we reach here, we were asked to send a custom footer. We need to:
+     * partially send whatever is referenced from out[0] and then send the
+     * footer as a subrequest. If the subrequest fails, we should send the
+     * standard footer as well.
      */
-    out.next = NULL;
+    rc = ngx_http_output_filter(r, &out[0]);
-    out.buf = content;
-    out.buf->last_in_chain = 1;
-    out.buf->last_buf = 0;
 
-    rc = ngx_http_output_filter(r, &out);
+    if (rc != NGX_OK && rc != NGX_AGAIN)
-
-    if (rc != NGX_OK && rc != NGX_AGAIN) {
-            ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
-                    "Content: YOU HIT ME (%i)", rc);
         return NGX_HTTP_INTERNAL_SERVER_ERROR;
-    }
 
-    /* Output page footer */
-    if (alcf->footer.len > 0) {
     /* URI is configured, make Nginx take care of with a subrequest. */
-        ngx_http_request_t *sr;
+    sr_uri = &alcf->footer;
-        ngx_str_t *sr_uri = &alcf->footer;
-        ngx_str_t rel_uri;
-        ngx_int_t rc;
 
     if (*sr_uri->data != '/') {
         /* Relative path */
@@ -832,23 +837,12 @@ add_builtin_header:
          * XXX: Should we write a message to the error log just in case
          * we get something different from a 404?
          */
-            goto add_builtin_footer;
+        out[0].next = NULL;
-        }
+        out[0].buf  = make_footer_buf(r);
-    }
+        out[0].buf->last_in_chain = 1;
-    else {
+        out[0].buf->last_buf = 1;
-add_builtin_footer:
+        /* Directly send out the builtin footer */
-        out.next = NULL;
+        return ngx_http_output_filter(r, &out[0]);
-        out.buf  = make_footer_buf(r);
-        out.buf->last_in_chain = 1;
-        out.buf->last_buf = 0;
-
-        rc = ngx_http_output_filter(r, &out);
-
-        if (rc != NGX_OK && rc != NGX_AGAIN) {
-            ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
-                    "Footer: YOU HIT ME (%i)", rc);
-            return NGX_HTTP_INTERNAL_SERVER_ERROR;
-        }
     }
 
     return (r != r->main) ? rc : ngx_http_send_special(r, NGX_HTTP_LAST);