cherrypy-foundation 1.0.0a21__py3-none-any.whl → 1.0.1__py3-none-any.whl

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/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/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.0a21.dist-info → cherrypy_foundation-1.0.1.dist-info}/METADATA

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

{cherrypy_foundation-1.0.0a21.dist-info → cherrypy_foundation-1.0.1.dist-info}/RECORD

@@ -84,7 +84,7 @@ cherrypy_foundation/components/vendor/typeahead/jquery.typeahead.min.css,sha256=
 cherrypy_foundation/components/vendor/typeahead/jquery.typeahead.min.js,sha256=eFBtgouYdW587kYINWsjkN-UR8GVWAG_fQe1fpJfjOw,47828
 cherrypy_foundation/plugins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cherrypy_foundation/plugins/db.py,sha256=S2OqujZ-D_TxUM6NbQW7XGDt8eGDup1Wbhf0XCcYSbs,10108
-cherrypy_foundation/plugins/ldap.py,sha256=j2KxkkHZ8PJxywRpkHQHXi1o6ZSiAdMVvTWC1vpXEvU,9970
+cherrypy_foundation/plugins/ldap.py,sha256=Y0gUD5CcFaUAI7SSPIlrlr4IkQ1QePX2--qfZrIBlbo,9861
 cherrypy_foundation/plugins/restapi.py,sha256=1W1mmVh-rIzg_mcFaNQZZXpqF7eN7VhRL9oTEiQOr-w,2843
 cherrypy_foundation/plugins/scheduler.py,sha256=m2XLM7euRjC5bkU4NILvwnRo0w6NWRwmCI19iEiQlE0,10777
 cherrypy_foundation/plugins/smtp.py,sha256=7qZv0VrQxi7gNoVdRds0F6Ya9pyo3LlZ12uFaVpAsms,7658
@@ -109,7 +109,7 @@ cherrypy_foundation/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJW
 cherrypy_foundation/tools/auth.py,sha256=WRXiZdRXJcd4uZFDb8DAGX-ySqiYytdWyjiQiLZb9Vo,9935
 cherrypy_foundation/tools/auth_mfa.py,sha256=hDwfKc2zFY3bxOm1JRLLFQRXVPL9atBQ-PEwQTEQUww,9579
 cherrypy_foundation/tools/i18n.py,sha256=f4m9fc2FKtcdUpXgnLXzhoipn4oLDuHY94Vv3KPSfp0,17126
-cherrypy_foundation/tools/jinja2.py,sha256=hTiOepdb7kyDEqCK4NH2O-v1lrgPGNX4VV3AWZ-OsAc,5967
+cherrypy_foundation/tools/jinja2.py,sha256=StEKv7nWtnCwGoOGYzIKtcPkEsRGPg1TtsjdyK_VW0Q,7834
 cherrypy_foundation/tools/ratelimit.py,sha256=C_bGzkx9waIJlpK-X6_SH8r1rP0I_xr0wLnGZhSEGEo,8742
 cherrypy_foundation/tools/secure_headers.py,sha256=XqmjU5MCK8fTacQ2uTUiODYN4uaa9cCGfQJZVnp4J4g,3921
 cherrypy_foundation/tools/sessions_timeout.py,sha256=M54IpRc3c4rUH0Cbri363O6GhD89EmzrjqvWeul8khc,7484
@@ -117,7 +117,7 @@ cherrypy_foundation/tools/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm
 cherrypy_foundation/tools/tests/test_auth.py,sha256=qQxCs8uCgu3C2Of9DRWplpCLLB7zSiJkrV4F9muLkJg,3414
 cherrypy_foundation/tools/tests/test_auth_mfa.py,sha256=qYIlw4tDQUi9R7nPwph6UpMsThWDN1EYW-FrrOF_grQ,15111
 cherrypy_foundation/tools/tests/test_i18n.py,sha256=6lHV3kxriRI5jo-YMnxzKKDFtLhogUrqK7D4X2-m42U,10758
-cherrypy_foundation/tools/tests/test_jinja2.py,sha256=3r96jcm68Jtw_hGwpQOlT8Jao6upPSnwENaScluL-7E,5545
+cherrypy_foundation/tools/tests/test_jinja2.py,sha256=8BsxpwLQkoSJCS1cQi5a_wZMu9Zdry4JDKBAUxy7pz0,5636
 cherrypy_foundation/tools/tests/test_ratelimit.py,sha256=BZn2lhbuaVeIPq80eUn-SFu0mMN3Mb4ttwVoXbozWUA,3431
 cherrypy_foundation/tools/tests/test_secure_headers.py,sha256=Iu3X7u6VJpWOmuNMv1qZFh0oPWdLZAdoJppRyuTV148,7769
 cherrypy_foundation/tools/tests/components/Button.jinja,sha256=uSLp1GpEIgZNXK_GWglu0E_a1c3jHpDLI66MRfMqGhE,95
@@ -129,8 +129,8 @@ cherrypy_foundation/tools/tests/locales/fr/LC_MESSAGES/messages.po,sha256=6_Sk9I
 cherrypy_foundation/tools/tests/templates/test_jinja2.html,sha256=s1bHmy-lyf0YW0t-LOx3ugILV2kqFoBNYxziWgrZbo0,216
 cherrypy_foundation/tools/tests/templates/test_jinjax.html,sha256=NImzIW0mUHxilFd61PSoxFC-yu1nayEVwv-5zlgD9yo,179
 cherrypy_foundation/tools/tests/templates/test_jinjax_i18n.html,sha256=yre8j7HBjpTQZHpM0PuB3ASGD3O4vKkJ-y72Fm6STgY,771
-cherrypy_foundation-1.0.0a21.dist-info/licenses/LICENSE.md,sha256=trSLYs5qlaow_bBwsLTRKpmTXsXzFksM_YUCMqrgAJQ,35149
-cherrypy_foundation-1.0.0a21.dist-info/METADATA,sha256=iAkKOmpDqv05F3r7I44szCpJbFck3F6ik0f1qvvUqek,3551
-cherrypy_foundation-1.0.0a21.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-cherrypy_foundation-1.0.0a21.dist-info/top_level.txt,sha256=B1vQPTLYhpKJ6W0JkRCWyAf8RPcnwJWdYxixv75-4ew,20
-cherrypy_foundation-1.0.0a21.dist-info/RECORD,,
+cherrypy_foundation-1.0.1.dist-info/licenses/LICENSE.md,sha256=trSLYs5qlaow_bBwsLTRKpmTXsXzFksM_YUCMqrgAJQ,35149
+cherrypy_foundation-1.0.1.dist-info/METADATA,sha256=pNbkEH_cQBF1jXYE3ejQPDcXTJ6HGPiKRcqcmk7ndVw,3548
+cherrypy_foundation-1.0.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+cherrypy_foundation-1.0.1.dist-info/top_level.txt,sha256=B1vQPTLYhpKJ6W0JkRCWyAf8RPcnwJWdYxixv75-4ew,20
+cherrypy_foundation-1.0.1.dist-info/RECORD,,