cherrypy-foundation 1.0.0a20__tar.gz → 1.0.1__tar.gz

{cherrypy_foundation-1.0.0a20 → cherrypy_foundation-1.0.1}/.gitlab-ci.yml

@@ -48,6 +48,18 @@ selenium:
 trixie:
   <<: *tox
 
+trixie-backports:
+  <<: *tox
+
+wrap-and-sort:
+  stage: test
+  image: buildpack-deps:stable
+  script:
+  - apt update
+  - apt -y --no-install-recommends install devscripts python3-debian
+  - CHANGES=$(wrap-and-sort -astN)
+  - if [[ ! -z "$CHANGES" ]]; then echo "$CHANGES"; exit 1; fi
+
 package:py3:
   stage: package
   needs: []

cherrypy_foundation-1.0.1/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include src/cherrypy_foundation/components *.html *.jinja *.css *.js *.woff *.woff2 *.map *.png

{cherrypy_foundation-1.0.0a20/src/cherrypy_foundation.egg-info → cherrypy_foundation-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cherrypy-foundation
-Version: 1.0.0a20
+Version: 1.0.1
 Summary: Cherrypy-foundation
 Author-email: Patrik Dufresne <patrik@ikus-soft.com>
 License: GPLv3

{cherrypy_foundation-1.0.0a20 → cherrypy_foundation-1.0.1}/debian/control

@@ -6,18 +6,14 @@ Build-Depends:
  debhelper-compat (= 13),
  dh-python,
  dh-sequence-python3,
- pybuild-plugin-pyproject,
- python3,
- python3-all-dev,
- python3-pip,
- python3-setuptools,
- python3-setuptools-scm,
-# Optional dependencies to execute the test test.
  chromium-driver <!nocheck>,
  libjs-bootstrap5 <!nocheck>,
  libjs-jquery <!nocheck>,
  libjs-jquery-datatables <!nocheck>,
  libjs-jquery-datatables-extensions <!nocheck>,
+ pybuild-plugin-pyproject,
+ python3,
+ python3-all-dev,
  python3-apscheduler <!nocheck>,
  python3-argon2 <!nocheck>,
  python3-babel <!nocheck>,
@@ -27,10 +23,13 @@ Build-Depends:
  python3-ldap3 <!nocheck>,
  python3-oauthlib <!nocheck>,
  python3-parameterized <!nocheck>,
- python3-pytest <!nocheck>, 
+ python3-pip,
+ python3-pytest <!nocheck>,
  python3-requests <!nocheck>,
  python3-requests-oauthlib <!nocheck>,
  python3-selenium <!nocheck>,
+ python3-setuptools,
+ python3-setuptools-scm,
  python3-sqlalchemy <!nocheck>,
  python3-tz <!nocheck>,
  python3-wtforms <!nocheck>,
@@ -47,8 +46,8 @@ Depends:
  libjs-jquery,
  libjs-jquery-datatables,
  libjs-jquery-datatables-extensions,
- ${python3:Depends},
  ${misc:Depends},
+ ${python3:Depends},
 Suggests:
  python3-apscheduler,
  python3-argon2,

{cherrypy_foundation-1.0.0a20 → cherrypy_foundation-1.0.1}/debian/copyright

@@ -2,7 +2,7 @@ Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 Upstream-Name: cherrypy-foundation
 Upstream-Contact: Patrik Dufresne <patrik@ikus-soft.com>
 Source: https://gitlab.com/ikus-soft/cherrypy-foundation/-/tags
-Files-Excluded: 
+Files-Excluded:
  src/cherrypy_foundation/components/vendor
 
 Files: *

{cherrypy_foundation-1.0.0a20 → cherrypy_foundation-1.0.1}/src/cherrypy_foundation/plugins/ldap.py

@@ -77,8 +77,8 @@ class LdapPlugin(SimplePlugin):
     """
     Used this plugin to authenticate user against an LDAP server.
 
-    `authenticate(username, password)` return None if the credentials are not
-    valid. Otherwise it return a tuple or username and extra attributes.
+    `authenticate(login, password)` return None if the credentials are not
+    valid. Otherwise it return a tuple or login and extra attributes.
     The extra attribute may contains `_fullname` and `_email`.
     """
 
@@ -89,7 +89,7 @@ class LdapPlugin(SimplePlugin):
     scope = 'subtree'
     tls = False
     user_filter = '(objectClass=*)'
-    username_attribute = ['uid']
+    login_attribute = ['uid']
     required_group = None
     group_attribute = 'member'
     group_attribute_is_dn = False
@@ -133,14 +133,14 @@ class LdapPlugin(SimplePlugin):
         self.stop()
         self.start()
 
-    def authenticate(self, username, password):
+    def authenticate(self, login, password):
         """
         Check if the given credential as valid according to LDAP.
         Return False if invalid.
         Return None if the plugin is unavailable to validate credentials or if the plugin is disabled.
-        Return tuple (<username>, <attributes>) if the credentials are valid.
+        Return tuple (<login>, <attributes>) if the credentials are valid.
         """
-        assert isinstance(username, str)
+        assert isinstance(login, str)
         assert isinstance(password, str)
 
         if not hasattr(self, '_pool'):
@@ -150,14 +150,14 @@ class LdapPlugin(SimplePlugin):
         with self._pool as conn:
             try:
                 # Search the LDAP server for user's DN.
-                safe_username = _safe(username)
-                attr_filter = ''.join([f'({_safe(attr)}={safe_username})' for attr in self.username_attribute])
+                safe_login = _safe(login)
+                attr_filter = ''.join([f'({_safe(attr)}={safe_login})' for attr in self.login_attribute])
                 search_filter = f"(&{self.user_filter}(|{attr_filter}))"
                 response = self._search(conn, search_filter)
                 if not response:
-                    cherrypy.log(f"lookup failed username={username} reason=not_found", context='LDAP')
+                    cherrypy.log(f"lookup failed login={login} reason=not_found", context='LDAP')
                     return False
-                cherrypy.log(f"lookup successful username={username}", context='LDAP')
+                cherrypy.log(f"lookup successful login={login}", context='LDAP')
                 user_dn = response[0]['dn']
 
                 # Use a separate connection to validate credentials
@@ -171,18 +171,18 @@ class LdapPlugin(SimplePlugin):
                 )
                 if not login_conn.bind():
                     cherrypy.log(
-                        f'ldap authentication failed username={username} reason=wrong_password',
+                        f'ldap authentication failed login={login} reason=wrong_password',
                         context='LDAP',
                         severity=logging.WARNING,
                     )
                     return False
 
-                # Get username
+                # Get user's login
                 attrs = response[0]['attributes']
-                new_username = first_attribute(attrs, self.username_attribute)
-                if not new_username:
+                new_login = first_attribute(attrs, self.login_attribute[0])
+                if not new_login:
                     cherrypy.log(
-                        f"object missing username attribute user_dn={user_dn} attribute={self.username_attribute}",
+                        f"object missing login attribute user_dn={user_dn} attribute={self.login_attribute[0]}",
                         context='LDAP',
                         severity=logging.WARNING,
                     )
@@ -192,7 +192,7 @@ class LdapPlugin(SimplePlugin):
                 if self.required_group:
                     if not isinstance(self.required_group, list):
                         self.required_group = [self.required_group]
-                    user_value = user_dn if self.group_attribute_is_dn else new_username
+                    user_value = user_dn if self.group_attribute_is_dn else new_login
                     group_filter = '(&(%s=%s)(|%s)%s)' % (
                         _safe(self.group_attribute),
                         _safe(user_value),
@@ -201,13 +201,13 @@ class LdapPlugin(SimplePlugin):
                     )
                     # Search LDAP Server for matching groups.
                     cherrypy.log(
-                        f"group check start username={user_value} required_groups={' '.join(self.required_group)}",
+                        f"group check start login={user_value} required_groups={' '.join(self.required_group)}",
                         context='LDAP',
                     )
                     response = self._search(conn, group_filter, attributes=['cn'])
                     if not response:
                         cherrypy.log(
-                            f"group check failed username={user_value} required_groups={' '.join(self.required_group)}",
+                            f"group check failed login={user_value} required_groups={' '.join(self.required_group)}",
                             context='LDAP',
                         )
                         return False
@@ -220,13 +220,11 @@ class LdapPlugin(SimplePlugin):
                     firstname = first_attribute(attrs, self.firstname_attribute, '')
                     lastname = first_attribute(attrs, self.lastname_attribute, '')
                     attrs['fullname'] = ' '.join([name for name in [firstname, lastname] if name])
-                return (new_username, attrs)
+                return (new_login, attrs)
             except LDAPInvalidCredentialsResult:
                 return False
             except LDAPException:
-                cherrypy.log(
-                    f"unexpected error username={username}", context='LDAP', severity=logging.ERROR, traceback=True
-                )
+                cherrypy.log(f"unexpected error login={login}", context='LDAP', severity=logging.ERROR, traceback=True)
             return None
 
     def search(self, filter, attributes=ldap3.ALL_ATTRIBUTES, search_base=None, paged_size=None):

{cherrypy_foundation-1.0.0a20 → cherrypy_foundation-1.0.1}/src/cherrypy_foundation/sessions.py

@@ -1,20 +1,4 @@
-# Session timeout tool for cherrypy
-# Copyright (C) 2012-2026 IKUS Software
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-# BFH Science Self-Service Portal
+# Cherrypy-foundation
 # Copyright (C) 2025-2026 IKUS Software
 #
 # This program is free software: you can redistribute it and/or modify
@@ -29,6 +13,10 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+
+import logging
+import os
 import time
 from contextlib import contextmanager
 
@@ -38,7 +26,6 @@ from cherrypy.lib import locking
 from cherrypy.lib.sessions import FileSession as CPFileSession
 
 
-# Issue in cherrypy: https://github.com/cherrypy/cherrypy/issues/2065
 class FileSession(CPFileSession):
     """
     Override implementation of cherrpy file session to improve file locking.
@@ -46,6 +33,8 @@ class FileSession(CPFileSession):
 
     def acquire_lock(self, path=None):
         """Acquire an exclusive lock on the currently-loaded session data."""
+        # See Issue https://github.com/cherrypy/cherrypy/issues/2065
+
         if path is None:
             path = self._get_file_path()
         path += self.LOCK_SUFFIX
@@ -62,6 +51,28 @@ class FileSession(CPFileSession):
         if self.debug:
             cherrypy.log('Lock acquired.', 'TOOLS.SESSIONS')
 
+    def clean_up(self):
+        """Also clean-up left over lock files."""
+        # See Issue https://github.com/cherrypy/cherrypy/issues/1855
+
+        # Clean-up session files.
+        CPFileSession.clean_up(self)
+
+        # Then clean-up any orphane lock files.
+        suffix_len = len(self.LOCK_SUFFIX)
+        files = os.listdir(self.storage_path)
+        lock_files = [
+            fname for fname in files if fname.startswith(self.SESSION_PREFIX) and fname.endswith(self.LOCK_SUFFIX)
+        ]
+        for fname in lock_files:
+            session_file = fname[:-suffix_len]
+            if session_file not in files:
+                filepath = os.path.join(self.storage_path, fname)
+                try:
+                    os.unlink(filepath)
+                except Exception as e:
+                    cherrypy.log(f'Error deleting {filepath}: {e}', 'TOOLS.SESSIONS', severity=logging.WARNING)
+
 
 @contextmanager
 def session_lock():

cherrypy_foundation-1.0.1/src/cherrypy_foundation/tests/test_sessions.py

@@ -0,0 +1,89 @@
+# Cherrypy-foundation
+# Copyright (C) 2026 IKUS Software
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+import os
+import tempfile
+
+import cherrypy
+from cherrypy.test import helper
+
+from cherrypy_foundation.sessions import FileSession, session_lock
+
+
+@cherrypy.tools.sessions(on=True, locking='explicit', storage_class=FileSession)
+class Root:
+
+    @cherrypy.expose
+    def index(self, value='OK'):
+        if value:
+            with session_lock() as s:
+                s['value'] = value
+        return s['value']
+
+
+class FileSessionTest(helper.CPWebCase):
+    interactive = False
+
+    @classmethod
+    def setup_class(cls):
+        cls.tempdir = tempfile.TemporaryDirectory(prefix='cherrypy-foundation-', suffix='-file-session-test')
+        cls.storage_path = cls.tempdir.name
+        super().setup_class()
+
+    @classmethod
+    def teardown_class(cls):
+        cls.tempdir.cleanup()
+        super().teardown_class()
+
+    @classmethod
+    def setup_server(cls):
+        cherrypy.config.update(
+            {
+                'tools.sessions.storage_path': cls.storage_path,
+            }
+        )
+        cherrypy.tree.mount(Root(), '/')
+
+    @property
+    def _session_id(self):
+        """Return session id from cookie."""
+        if hasattr(self, 'cookies') and self.cookies:
+            for unused, value in self.cookies:
+                for part in value.split(';'):
+                    key, unused, value = part.partition('=')
+                    if key == 'session_id':
+                        return value
+
+    def test_get_page(self):
+        # Given a page with session enabled
+        # When the page get queried
+        self.getPage("/")
+        # Then a session is created with a id
+        self.assertStatus(200)
+        self.assertTrue(self._session_id)
+        # Then this session is created on disk.
+        s = FileSession(id=self._session_id, storage_path=self.storage_path)
+        self.assertTrue(s._exists())
+        # When session timeout and get clean-up
+        s.acquire_lock()
+        s.load()
+        s.timeout = 0
+        s.save()
+        s.clean_up()
+        # Then session get deleted
+        self.assertFalse(s._exists())
+        # Lock file also get deleted.
+        self.assertFalse(os.path.exists(s._get_file_path() + FileSession.LOCK_SUFFIX))

{cherrypy_foundation-1.0.0a20 → cherrypy_foundation-1.0.1}/src/cherrypy_foundation/tools/jinja2.py

@@ -20,6 +20,7 @@ import time
 
 import cherrypy
 import jinja2
+from markupsafe import Markup
 
 # Sentinel value
 _UNDEFINED = object()
@@ -27,6 +28,8 @@ _UNDEFINED = object()
 # Capture epoch time to invalidate cache of static file.
 _cache_invalidate = int(time.time())
 
+_JINJAX_TOKEN = '@@JINJAX-CATALOG-TOKEN@@'
+
 
 class Jinja2Tool(cherrypy.Tool):
     """
@@ -41,12 +44,47 @@ class Jinja2Tool(cherrypy.Tool):
         Replace the placeholder token in the rendered HTML with the fully
         formatted asset tags, then reset asset state for the next render.
         """
-        assets_html = catalog._format_collected_assets()
-        assets_html = str(assets_html).replace('<script type="module" ', '<script ')
-        catalog._emit_assets_later = False
-        catalog.collected_css = []
-        catalog.collected_js = []
-        return str(html).replace(catalog._assets_placeholder, assets_html)
+        # Skip this step if render_assets() has not been called.
+        if hasattr(catalog, '_emit_assets_later') and getattr(catalog, '_emit_assets_later') is False:
+            return html
+
+        # Render Js and Css collected assets
+        if hasattr(catalog, '_format_collected_assets'):
+            # JinjaX > 0.60
+            catalog._emit_assets_later = False
+            assets_html = catalog._format_collected_assets()
+            assets_html = str(assets_html).replace('<script type="module" ', '<script ')
+            return str(html).replace(catalog._assets_placeholder, assets_html)
+        else:
+            # JinjaX<=0.60
+            html_css = []
+            rendered_urls = set()
+
+            for url in catalog.collected_css:
+                if url == _JINJAX_TOKEN:
+                    continue
+                if not url.startswith(("http://", "https://")):
+                    full_url = f"{catalog.root_url}{url}"
+                else:
+                    full_url = url
+
+                if full_url not in rendered_urls:
+                    html_css.append(f'<link rel="stylesheet" href="{full_url}">')
+                    rendered_urls.add(full_url)
+
+            html_js = []
+            for url in catalog.collected_js:
+                if not url.startswith(("http://", "https://")):
+                    full_url = f"{catalog.root_url}{url}"
+                else:
+                    full_url = url
+
+                if full_url not in rendered_urls:
+                    html_js.append(f'<script src="{full_url}"></script>')
+                    rendered_urls.add(full_url)
+
+            assets_html = Markup("\n".join(html_css + html_js))
+            return str(html).replace(f'<link rel="stylesheet" href="/static/components/{_JINJAX_TOKEN}">', assets_html)
 
     def _wrap_handler(self, env, template, extra_processor=None, debug=False):
 
@@ -147,11 +185,23 @@ class Jinja2Tool(cherrypy.Tool):
             tmpl = env.select_template(names)
         else:
             tmpl = env.get_template(template)
+
+        # Monkey patch JinjaX catalog.render_assets() for JinjaX <= 0.60
+        catalog = env.globals.get('catalog')
+        if catalog:
+            catalog.collected_css = []
+            catalog.collected_js = []
+            if not hasattr(catalog, '_assets_placeholder'):
+                # JinjaX <= 0.60
+                # Leave a token to be replace.
+                catalog.collected_css = [_JINJAX_TOKEN]
+
+        # Render template
         out = tmpl.render(context)
 
-        # With JinjaX > 0.60 render explicitly here.
-        if 'catalog' in env.globals and getattr(env.globals['catalog'], '_emit_assets_later', False):
-            return self._finalize_assets(catalog=env.globals['catalog'], html=out)
+        # With JinjaX finalise render_assets().
+        if catalog:
+            return self._finalize_assets(catalog=catalog, html=out)
         return out
 
 

{cherrypy_foundation-1.0.0a20 → cherrypy_foundation-1.0.1}/src/cherrypy_foundation/tools/tests/test_jinja2.py

@@ -124,6 +124,7 @@ class Jinja2Test(helper.CPWebCase, SeleniumUnitTest):
         # Then the page return without error
         self.assertStatus(200)
         # Then the page is render dynamically using page context
+        self.assertInBody('<script src="/static/components/LocaleSelection.js"></script>')
         if expected_lang == 'fr':
             self.assertInBody('lang="fr"')
             self.assertInBody('français')

{cherrypy_foundation-1.0.0a20 → cherrypy_foundation-1.0.1/src/cherrypy_foundation.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cherrypy-foundation
-Version: 1.0.0a20
+Version: 1.0.1
 Summary: Cherrypy-foundation
 Author-email: Patrik Dufresne <patrik@ikus-soft.com>
 License: GPLv3

{cherrypy_foundation-1.0.0a20 → cherrypy_foundation-1.0.1}/src/cherrypy_foundation.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 .gitignore
 .gitlab-ci.yml
 LICENSE.md
+MANIFEST.in
 README.md
 pyproject.toml
 sonar-project.properties
@@ -9,7 +10,6 @@ debian/TODO
 debian/changelog
 debian/control
 debian/copyright
-debian/python3-cherrypy-foundation.links
 debian/rules
 debian/source/format
 debian/upstream/metadata
@@ -129,6 +129,7 @@ src/cherrypy_foundation/tests/test_flash.py
 src/cherrypy_foundation/tests/test_form.py
 src/cherrypy_foundation/tests/test_logging.py
 src/cherrypy_foundation/tests/test_passwd.py
+src/cherrypy_foundation/tests/test_sessions.py
 src/cherrypy_foundation/tests/test_url.py
 src/cherrypy_foundation/tests/templates/test_flash.html
 src/cherrypy_foundation/tests/templates/test_form.html

{cherrypy_foundation-1.0.0a20 → cherrypy_foundation-1.0.1}/tox.ini

@@ -30,11 +30,15 @@ deps =
   trixie: wtforms==3.2.1
   trixie: CherryPy==18.10.0
   trixie: Jinja2==3.1.6
-  #trixie: jinjax==0.57 Trixie required backported version
+  trixie: jinjax==0.57
 extras = test
 commands =
   pytest -v --debug --ignore=debian --override-ini junit_family=xunit1 --junit-xml=xunit.xml --cov=cherrypy_foundation --cov-report xml:coverage.xml
 
+[testenv:trixie-backports]
+deps_extra =
+    jinjax==0.60
+
 [testenv:doc]
 deps =
   sphinx