Add support for the nginx X-Accel-Redirect header

[samm@…]

Hi,

I am using X-Accel-Redirect with Trac in FastCGI mode by changing header name in the api.py. I am recommending to make this header name configurable or to add use_x_accel_redirect variable in the config. I can provide patch for this change. On the nginx side appropriate location looks like that:

    # serve attachments  by nginx directly
    location /data/trac/files/attachments/ {
        internal;
        alias /data/trac/files/attachments/;
    }

[Jun Omae]

X-Sendfile header via apache with mod_xsendfile has been implemented in #7894.

PatchWelcome.

[samm@…]

patch to send X-Accel-Redirect for nginx

[anonymous]

I added patch to support X-Accel-Redirect on trunk. Please let me know if you need anything else, thank you.

[samm@…]

Updated patch

[anonymous]

Patch tested with Trac 1.0.4 with nginx/1.6.2 and seems to work correctly. It would be great to see it in the 1.0.5 to avoid local patches on upgrade :)

[Jun Omae]

Thanks for the patch. However, it doesn't seem that works well, e.g. missing to add use_xaccelredirect to Request.callbacks like tags/trac-1.0.5/trac/web/main.py#L169​. I'll post revised patch.

[Ryan J Ollos]

Replying to jomae:

X-Sendfile header via apache with mod_xsendfile has been implemented in #7894.

Also, previous discussion about X-Accel-Redirect in comment:10:ticket:7894.

[Ryan J Ollos]

Seems like the getattr in [11071#file0] shouldn't really be needed since the attribute is set in the callbacks.

[Jun Omae]

Proposed changes in jomae.git@t11981, adding [trac] xsendfile_header option which specifies the header to use if X-Sendfile feature is enabled. If Nginx is used, set X-Accel-Redirect to the option.

[Ryan J Ollos]

The changes look good to me. It might be a good idea to mention the value to use with Nginx in the option comment.

[Jun Omae]

Thanks for the reviewing. Added mention to the option's document in [69f003e3c/jomae.git].

I'll push it later.

[samm@…]

Thanks! I will test proposed patch today and will tell if it works correctly.

[samm@…]

I am getting 500 error with text

Trac detected an internal error:
AssertionError: Header names must be strings

I used

use_xsendfile = true
xsendfile_header = X-Accel-Redirect

[samm@…]

This is traceback:

Python Traceback
Most recent call last:
    File "/usr/lib/python2.6/site-packages/trac/web/main.py", line 520, in _dispatch_request
    File "/usr/lib/python2.6/site-packages/trac/web/main.py", line 226, in dispatch
    File "/usr/lib/python2.6/site-packages/trac/attachment.py", line 531, in process_request
    File "/usr/lib/python2.6/site-packages/trac/attachment.py", line 886, in _render_view
    File "/usr/lib/python2.6/site-packages/trac/web/api.py", line 628, in send_file
    File "/usr/lib/python2.6/site-packages/trac/web/api.py", line 462, in end_headers
    File "/usr/lib/python2.6/site-packages/trac/web/_fcgi.py", line 1250, in start_response 

[samm@…]

also local variables

exc_info 	None
headers_sent 	[]
headers_set 	[]
name 	u'X-Accel-Redirect'
response_headers 	[('ETag', 'W/"samm2/Sun, 27 Sep 2009 10:49:41 GMT/True"'), ...
status 	'200 Ok'

[anonymous]

I been able to fix this by replacing line

xsendfile_header = getattr(self, 'xsendfile_header', None)

with

xsendfile_header = getattr(self, 'xsendfile_header', None).encode("ascii")

[Ryan J Ollos]

The following patch may be a simple fix, though I'm not surprised comment:15 would also work:

trac/web/main.py

@@ -335 +335 @@
         return self.use_xsendfile
 
     def _get_xsendfile_header(self, req):
-        return self.xsendfile_header
+        return str(self.xsendfile_header)
 
     def _pre_process_request(self, req, chosen_handler):
         for filter_ in self.filters:

[samm@…]

Just tested - patch from comment:16 also works fine, thanks.

[Jun Omae]

Sorry, I've tested with only tracd. Updated jomae.git@t11981. In [a2bd1cb9/jomae.git], converts to str using to_utf8() and validates to use only valid characters in the option.

[Jun Omae]

Committed in [13972] and merged to trunk in [13973].

[Jun Omae]

I noticed breakage of unit tests on Windows. Fixed in [13986:13987].