Merge branch 'release/5.0.1'

Author: GrahamDumpleton

.github/workflows/main.yml

@@ -16,10 +16,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13-dev"]
     steps:
       - uses: "actions/checkout@v4"
-      - uses: "actions/setup-python@v4"
+      - uses: "actions/setup-python@v5"
         with:
           python-version: "${{ matrix.python-version }}"
       - name: "Update package details"
@@ -29,7 +29,7 @@ jobs:
       - name: "Build mod_wsgi packages"
         run: ./package.sh && ls -las dist
       - name: "Store built packages"
-        uses: actions/upload-artifact@v3
+        uses: "actions/upload-artifact@v4"
         with:
           name: dist ${{ matrix.python-version }}
           path: dist/*
@@ -42,14 +42,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13-dev"]
     steps:
       - uses: "actions/checkout@v4"
-      - uses: "actions/setup-python@v4"
+      - uses: "actions/setup-python@v5"
         with:
           python-version: "${{ matrix.python-version }}"
       - name: "Download built packages"
-        uses: actions/download-artifact@v3
+        uses: "actions/download-artifact@v4"
         with:
             name: dist ${{ matrix.python-version }}
             path: dist
@@ -66,7 +66,7 @@ jobs:
       - name: "Uninstall mod_wsgi"
         run: pip uninstall --yes mod_wsgi
       - name: "Install mod_wsgi-standalone"
-        run: python -m pip install --verbose dist/mod_wsgi-standalone-[0-9].*.tar.gz
+        run: python -m pip install --verbose dist/mod_wsgi[-_]standalone-[0-9].*.tar.gz
       - name: "Run mod_wsgi-express test #2"
         run: scripts/run-single-test.sh
       - name: "Uninstall mod_wsgi-standalone"

README-standalone.rst

@@ -22,8 +22,7 @@ installed, with it using the version of Apache installed by the
 This method of installation is only suitable for where you want to use
 ``mod_wsgi-express``. It cannot be used to build mod_wsgi for use with
 your system Apache installation. This installation method will not
-work on Windows, and also currently fails on macOS because the Apache
-Runtime (APR) library, has not been updated to latest macOS versions.
+work on Windows.
 
 When installing mod_wsgi using this method, except that you will install
 the ``mod_wsgi-standalone`` package instead of the ``mod_wsgi`` package,

configure.ac

@@ -1,6 +1,6 @@
 dnl  vim: set sw=4 expandtab :
 dnl
-dnl  Copyright 2007-2023 GRAHAM DUMPLETON
+dnl  Copyright 2007-2024 GRAHAM DUMPLETON
 dnl 
 dnl  Licensed under the Apache License, Version 2.0 (the "License");
 dnl  you may not use this file except in compliance with the License.

docs/conf.py

@@ -41,7 +41,7 @@
 
 # General information about the project.
 project = u'mod_wsgi'
-copyright = u'2007-2023, Graham Dumpleton'
+copyright = u'2007-2024, Graham Dumpleton'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

docs/configuration-directives/WSGIDaemonProcess.rst

@@ -375,6 +375,12 @@ Options which can be supplied to the ``WSGIDaemonProcess`` directive are:
     to handle more requests, restarting of the process will be delayed
     if possible.
 
+    Note that when a process is restarted due to a request timeout, if the
+    Apache ``LogLevel`` is set to ``info`` or higher, or ``wsgi:info`` applied
+    for ``LogLevel```, messages will be logged to the Apache error log file for
+    the request which gives the Python stack trace for any request handler
+    threads so you can work out where the request is blocking.
+
 .. _deadlock-timeout:
 
 **deadlock-timeout=sss**

docs/configuration-directives/WSGIDestroyInterpreter.rst

@@ -0,0 +1,25 @@
+======================
+WSGIDestroyInterpreter
+======================
+
+:Description: Enable/disable cleanup of Python interpreter.
+:Syntax: ``WSGIDestroyInterpreter On|Off``
+:Default: ``WSGIDestroyInterpreter On``
+:Context: server config
+
+The ``WSGIDestroyInterpreter`` directive is used to control whether the Python
+interpreter is destroyed when processes are shutdown or restarted. By default
+the Python interpreter is destroyed when the process is shutdown or restarted.
+
+This directive was added due to changes in Python 3.9 where the Python cleanup
+behaviour was changed such that it would wait on daemon threads to complete.
+This could cause cleanup of the Python interpreter to hang in the some cases
+where threads were created external to Python, as is the case where Python is
+embedded in a C program such as mod_wsgi with Apache.
+
+This problem of hanging when cleanup of the Python interpreter was attempted
+was especially noticeable when using mod_wsgi to host Trac.
+
+Note that it is not known whether versions of Python newer than 3.9 still have
+this problem or whether further changes were made in Python interpreter cleanup
+code.

docs/configuration-directives/WSGIErrorOverride.rst

@@ -0,0 +1,18 @@
+=================
+WSGIErrorOverride
+=================
+
+:Description: Enable/disable use of Apache error documents.
+:Syntax: ``WSGIErrorOverride On|Off``
+:Default: ``WSGIErrorOverride Off``
+:Context: server config, virtual host, directory, .htaccess
+
+The ``WSGIErrorOverride`` directive when set to ``On``, and the WSGI application
+is running in daemon mode, will result in Apache error documents being used
+rather than those passed back by the WSGI application. This allows error
+documents to match any web site that the WSGI application may be integrated as a
+part of. This feature is akin to the ``ProxyErrorOverride`` directive of Apache
+but for mod_wsgi only.
+
+Note that this directive has no effect when the WSGI application is running in
+embedded mode.

docs/configuration-directives/WSGIMapHEADToGET.rst

@@ -0,0 +1,23 @@
+================
+WSGIMapHEADToGET
+================
+
+:Description: Enable/disable mapping of HEAD request to GET.
+:Syntax: ``WSGIMapHEADToGET On|Off|Auto``
+:Default: ``WSGIMapHEADToGET Auto``
+:Context: server config, virtual host, directory, .htaccess
+
+The ``WSGIMapHEADToGET`` directive controls the behaviour of automatically
+mapping any ``HEAD`` request to a ``GET`` request when an Apache output filter
+is registered that may want to see the complete response in order to generate
+correct response headers.
+
+The directive can be set to be either ``Auto`` (the default), ``On`` which
+will always map a ``HEAD`` to ``GET`` even if no output filters detected and
+``Off`` to always preserve the original request method type.
+
+The directive may be required where a WSGI application tries to optimize and
+avoid doing work for a ``HEAD`` request by not actually generating a response
+so that complete response headers can still be generated. By doing this the
+WSGI application can break Apache filters for caching, so the mapping of
+``HEAD`` to ``GET`` can be required to avoid problems.

docs/configuration.rst

@@ -14,8 +14,11 @@ Configuration
    configuration-directives/WSGICaseSensitivity
    configuration-directives/WSGIChunkedRequest
    configuration-directives/WSGIDaemonProcess
+   configuration-directives/WSGIDestroyInterpreter
+   configuration-directives/WSGIErrorOverride
    configuration-directives/WSGIImportScript
    configuration-directives/WSGILazyInitialization
+   configuration-directives/WSGIMapHEADToGET
    configuration-directives/WSGIPassAuthorization
    configuration-directives/WSGIProcessGroup
    configuration-directives/WSGIPythonEggs

docs/installation.rst

@@ -5,10 +5,10 @@ Installation
 The mod_wsgi package can be installed from source code or may also be
 available as a pre built binary package as part of your Linux distribution.
 
-Do be aware though that Linux distributions generally ship out of date
-versions of mod_wsgi and for long term support (LTS) versions of Linux can
-be anything up to about 5 years old. Those older versions are not supported
-in any way even though they are part of a so called LTS version of Linux.
+Do be aware though that Linux distributions can sometimes ship out of date
+versions of mod_wsgi, especially for long term support (LTS) versions of Linux.
+Those older versions are not supported in any way even though they are part of a
+so called LTS version of Linux.
 
 If you want support and want to ensure you have the most up to date and
 bug free version of mod_wsgi, you should consider building and installing
@@ -20,6 +20,7 @@ operating systems such as Linux and MacOS X see:
   * :doc:`user-guides/quick-installation-guide`
   * :doc:`user-guides/installation-on-macosx`
 
-If you are on Windows, you should instead use:
+For a simpler way of running a Python WSGI application using mod_wsgi, also
+checkout ``mod_wsgi-express``, details of which can currently be found at:
 
-  * https://github.com/GrahamDumpleton/mod_wsgi/blob/develop/win32/README.rst
+   https://pypi.python.org/pypi/mod_wsgi