diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 55 |
1 files changed, 30 insertions, 25 deletions
@@ -116,31 +116,36 @@ OPERATION and forwards their combined contents. CAVEATS - Apache::Inject::Filter uses a regular expression to determine the proper - location of the injected header. It supports all valid HTML. However, it - does not parse embedded CSS and JavaScript, which means that it is - *possible* to construct an example where it will fail: - - <script> - /* this looks like the closing tag for script: </script> */ - /* this looks like an opening tag for a new element: <title> */ - </script> - <body> - This is where the header <i>should</i> be inserted. - <script> - /* this looks like the closing tag for the title: </title> - This is where the header is <i>actually</i> inserted. - */ - </script> - </body> - - This specific type of document, however, is *incredibly* unlikely. In - this case, an ad-hoc solution is simpler, more efficient and more - maintainable than a general one. - - On FreeBSD, you may need to enable the accf_http kernel module in order - for the tests to work. Note that Apache::Inject works fine without the - module; it is only the tests that require it. + * Apache::Inject::Filter uses a regular expression to determine the + proper location of the injected header. It supports all valid HTML. + However, it does not parse embedded CSS and JavaScript, which means + that it is *possible* to construct an example where it will fail: + + <script> + /* this looks like the closing tag for script: </script> */ + /* this looks like an opening tag for a new element: <title> */ + </script> + <body> + This is where the header <i>should</i> be inserted. + <script> + /* this looks like the closing tag for the title: </title> + This is where the header is <i>actually</i> inserted. + */ + </script> + </body> + + This specific type of document, however, is *incredibly* unlikely. + In this case, an ad-hoc solution is simpler, more efficient and more + maintainable than a general one. + + * Because of how Apache filters work, Inject may fail to find the end + of the <head> if the <head> is very long (in my experience over 7000 + characters). If this happens, it will decline the request, and the + contents will be served as though Inject had not been enabled. + + * On FreeBSD, you may need to enable the accf_http kernel module in + order for the tests to work. Note that Apache::Inject works fine + without the module; it is only the tests that require it. DIAGNOSTICS Apache::Inject and Apache::Inject::Filter log all errors and warnings to |