fix: issue2551193 - Fix roundup for removal of cgi and cgitb ...

standard python modules (and FieldStorage/MiniFieldStorage).

Vendor cgi.py and modify imports.

Details:

roundup/anypy/cgi_.py
  import that accesses a working cgi.py. All imports dealing with cgi
  now use cgi_.

roundup/anypy/vendored/cgi.py
  vendored version 2.6 of cgi.py from:
  https://pypi.org/project/legacy-cgi/

CHANGES.txt
  change note added

COPYING.txt
  added license for cgi.py

doc/rest.txt
  change example to use cgi_

doc/upgrading.txt
  doc removal and how to rework local code using cgi.py.

frontends/roundup.cgi
  remove unneeded cgi import

roundup/cgi/actions.py
roundup/cgi/apache.py
roundup/cgi/client.py
roundup/cgi/templating.py
roundup/cgi/TAL/TALGenerator.py
test/db_test_base.py
test/rest_common.py
test/test_cgi.py
  remove import cgi and replace with from roundup.anypy.cgi_ import
  cgi

test/test_actions.py
test/test_templating.py
  modify import to get *FieldStorage

test/test_admin.py
test/test_hyperdbvals.py
test/test_xmlrpc.py
  remove unneeded cgi import

Author: rouilj

CHANGES.txt

@@ -27,6 +27,13 @@ Fixed:
   and 2.4.10 with its new schema filtering method. (John Rouillard)
 - multiple flake8 fixes (John Rouillard)
 - rename loop variable in 'for sendto in sendto:' (John Rouillard)
+- issue2551193 - Fix roundup for removal of cgi and cgitb standard
+  python modules (and FieldStorage/MiniFieldStorage). Replaced imports
+  from cgi to use roundup.anypy.cgi_ which will load the system cgi
+  unless it is missing. Then it will load roundup.anypy.vendored.cgi
+  and make *FieldStroage symbols available. Roundp uses its own
+  cgitb.py and not the system cgitb.py. It looks like it's the
+  precursor to the system cgitb.py. (John Rouillard)
 
 Features:
 

COPYING.txt

@@ -113,3 +113,59 @@ accompanying credits file.
 
 
 Note link for http://www.zope.com/Marks is dead.
+
+Vendored cgi.py module
+----------------------
+
+This module is licensed under the Python Software Foundation License
+Version 2 as it was extracted from the 3.12 Python distribution.
+
+PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
+--------------------------------------------
+
+1. This LICENSE AGREEMENT is between the Python Software Foundation
+   ("PSF"), and the Individual or Organization ("Licensee") accessing
+   and otherwise using this software ("Python") in source or binary
+   form and its associated documentation.
+
+2. Subject to the terms and conditions of this License Agreement, PSF
+   hereby grants Licensee a nonexclusive, royalty-free, world-wide
+   license to reproduce, analyze, test, perform and/or display
+   publicly, prepare derivative works, distribute, and otherwise use
+   Python alone or in any derivative version, provided, however, that
+   PSF's License Agreement and PSF's notice of copyright, i.e.,
+   "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
+   2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
+   2020, 2021, 2022 Python Software Foundation; All Rights Reserved"
+   are retained in Python alone or in any derivative version prepared
+   by Licensee.
+
+3. In the event Licensee prepares a derivative work that is based on
+   or incorporates Python or any part thereof, and wants to make the
+   derivative work available to others as provided herein, then
+   Licensee hereby agrees to include in any such work a brief summary
+   of the changes made to Python.
+
+4. PSF is making Python available to Licensee on an "AS IS" basis.
+   PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  BY
+   WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND DISCLAIMS ANY
+   REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY
+   PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT INFRINGE ANY
+   THIRD PARTY RIGHTS.
+
+5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
+   FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A
+   RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON, OR
+   ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+
+6. This License Agreement will automatically terminate upon a material
+   breach of its terms and conditions.
+
+7. Nothing in this License Agreement shall be deemed to create any
+   relationship of agency, partnership, or joint venture between PSF
+   and Licensee.  This License Agreement does not grant permission to
+   use PSF trademarks or trade name in a trademark sense to endorse or
+   promote products or services of Licensee, or any third party.
+
+8. By copying, installing or otherwise using Python, Licensee agrees
+   to be bound by the terms and conditions of this License Agreement.

doc/rest.txt

@@ -1791,7 +1791,7 @@ section this code adds a new endpoint `/data/@permission/Developer`
 that returns a list of users with the developer role::
 
     from roundup.rest import Routing, RestfulInstance
-    from cgi import MiniFieldStorage
+    from roundup.anypy.cgi_ import MiniFieldStorage
 
     class RestfulInstance(object):
 

doc/upgrading.txt

@@ -126,6 +126,21 @@ details.
 
 .. _`information on configuring the API rate limits`: rest.html#rate-limiting-api-failed-logins
 
+Removal of cgi.py from Python (info)
+------------------------------------
+
+The ``cgi.py`` module will be `removed starting with Python 3.13
+<https://peps.python.org/pep-0594/#cgi>`_. Roundup now `vendors a copy
+<https://pypi.org/project/legacy-cgi/>`_ of ``cgi.py`` and makes it
+and its storage objects available by importing from::
+
+   from roundup.anypy.cgi_ import cgi
+   from roundup.anypy.cgi_ import FieldStorage, MiniFieldStorage
+
+It is unlikey that you will care unless you have done some expert
+level Roundup customization. If you have, use one of the imports above
+if you plan on running on Python 3.13 (expected in 2024) or newer.
+
 .. index:: Upgrading; 2.2.0 to 2.3.0
 
 Migrating from 2.2.0 to 2.3.0

frontends/roundup.cgi

@@ -73,7 +73,7 @@ LOG = DevNull()
 # Set up the error handler
 # 
 try:
-    import traceback, cgi
+    import traceback
     from roundup.cgi import cgitb
 except:
     print("Content-Type: text/plain\n")

roundup/anypy/cgi_.py

@@ -0,0 +1,8 @@
+try:
+  # used for python2 and python 3 < 3.13
+  import cgi as cgi
+  from cgi import FieldStorage, MiniFieldStorage
+except ImportError:
+  # use for python3 >= 3.13
+  from roundup.anypy.vendored import cgi
+  from roundup.anypy.vendored.cgi import FieldStorage, MiniFieldStorage