support Grid(search_queries=None)

Author: mdipierro

apps/_scaffold/settings.py

@@ -104,15 +104,16 @@
     "mode": "ad",  # Microsoft Active Directory
     "server": "mydc.domain.com",  # FQDN or IP of one Domain Controller
     "base_dn": "cn=Users,dc=domain,dc=com",  # base dn, i.e. where the users are located
-
     # the following are only needed if you want to use groups
     "group_member_attrib": "member",  # for AD, attribute that contains the user DN in the group
     "bind_dn": "CN=LdapBindUser,CN=users,DC=test,DC=local",  # bind user DN
     "bind_pw": "P@ssw0rd",  # bind user password
     "group_dn": "DC=test,DC=local",  # group DN, where the groups are located, default = base_dn
-    "allowed_groups": ["allowed_login_group"],  # list of groups that are allowed to log in, default = everyone
+    "allowed_groups": [
+        "allowed_login_group"
+    ],  # list of groups that are allowed to log in, default = everyone
     "denied_login_popup": True,  # show an error at login if not in allowed groups
-                                 # default = False
+    # default = False
 }
 
 # i18n settings

py4web/utils/auth.py

@@ -708,7 +708,9 @@ def login(self, email, password):
                         and getattr(plugin, "mode", None) == "ad"
                         and getattr(plugin, "last_user_mail", None)
                     ):
-                        self.logger.debug(f"Using AD email from LDAP plugin: {plugin.last_user_mail}")
+                        self.logger.debug(
+                            f"Using AD email from LDAP plugin: {plugin.last_user_mail}"
+                        )
                         user_info["email"] = plugin.last_user_mail
                     elif "@" in email:
                         self.logger.debug(f"Using email from login: {email}")
@@ -1331,11 +1333,15 @@ def login(auth):
                     and getattr(plugin, "mode", None) == "ad"
                     and getattr(plugin, "last_user_mail", None)
                 ):
-                    auth.logger.debug(f"AuthAPI.login: Using AD email from LDAP plugin: {plugin.last_user_mail}")
+                    auth.logger.debug(
+                        f"AuthAPI.login: Using AD email from LDAP plugin: {plugin.last_user_mail}"
+                    )
                     # save the real email from AD to database
                     data["email"] = plugin.last_user_mail
                 else:
-                    auth.logger.debug(f"AuthAPI.login: Not using AD email, plugin_name={plugin_name}, mode={getattr(plugin, 'mode', None)}, last_user_mail={getattr(plugin, 'last_user_mail', None)}")
+                    auth.logger.debug(
+                        f"AuthAPI.login: Not using AD email, plugin_name={plugin_name}, mode={getattr(plugin, 'mode', None)}, last_user_mail={getattr(plugin, 'last_user_mail', None)}"
+                    )
                 if auth.db:
                     auth.logger.debug(
                         f"AuthAPI.login: Calling get_or_register_user with data={data}"

py4web/utils/auth_plugins/ldap_plugin.py

@@ -271,11 +271,11 @@ def check_credentials(self, username, password):
         try:
             allowed_groups = self.allowed_groups
             if allowed_groups and mode == "ad":
-                if not self.is_user_in_allowed_groups(
-                    username
-                ):
-                    logger.warning(f"[{username}] refused login because not in allowed groups!")
-                    
+                if not self.is_user_in_allowed_groups(username):
+                    logger.warning(
+                        f"[{username}] refused login because not in allowed groups!"
+                    )
+
                     return False
             con = self._init_ldap()
             if mode == "ad":
@@ -314,12 +314,18 @@ def check_credentials(self, username, password):
                 )[0][1]
 
                 # set last_user_mail from ldap result for further use
-                if 'mail' in result and result['mail']:
-                    self.last_user_mail = str(result['mail'][0].decode() if isinstance(result['mail'][0], bytes) else result['mail'][0])
+                if "mail" in result and result["mail"]:
+                    self.last_user_mail = str(
+                        result["mail"][0].decode()
+                        if isinstance(result["mail"][0], bytes)
+                        else result["mail"][0]
+                    )
                 else:
                     self.last_user_mail = None
                 logger.info(f"Login result: {result}")
-                logger.debug(f"LDAPPlugin: Set last_user_mail to {self.last_user_mail} for {username}")
+                logger.debug(
+                    f"LDAPPlugin: Set last_user_mail to {self.last_user_mail} for {username}"
+                )
                 if not isinstance(result, dict):
                     # result should be a dict in the form
                     # {'sAMAccountName': [username_bare]}
@@ -564,7 +570,9 @@ def is_user_in_allowed_groups(self, username, password=None):
         for group in allowed_groups:
             if group in self.groups:
                 # Match
-                logger.debug(f"[{str(username)}] allowed login because in allowed groups")
+                logger.debug(
+                    f"[{str(username)}] allowed login because in allowed groups"
+                )
                 return True
         # No match
         logger.warning(f"[{str(username)}] denied login because not in allowed groups")

py4web/utils/grid.py

@@ -444,7 +444,7 @@ def __init__(
         self,
         query,
         search_form=None,
-        search_queries=None,
+        search_queries="auto",
         columns=None,
         field_id=None,
         show_id=None,
@@ -478,7 +478,7 @@ def __init__(
         :param path: The part of the URL to be parsed by this grid
         :param query: the query used to filter the data
         :param search_form: py4web FORM to be included as the search form
-        :param search_queries: future use - pass a dict of name and a search query
+        :param search_queries: future use - pass a list of search quereis, or "auto" or None
         :param columns: list of columns to display on the list page, if blank, glean tablename from first query
         :              and use all fields of that table
         :param field_id: the id field of the primary table for the grid - if there are multiple tables (joined)
@@ -723,7 +723,7 @@ def _handle_mode_select(self):
         query = self.query
 
         # use the default search for the table (we have to do this here because need self.table)
-        if self.param.search_queries is None:
+        if self.param.search_queries == "auto":
             self.param.search_queries = [make_default_search_query(self.table)]
 
         # apply the search query
@@ -1271,6 +1271,7 @@ def _make_table(self):
                     kind="grid-new-button",
                 )
             )
+
         if self.param.header_elements and len(self.param.header_elements) > 0:
             for element in self.param.header_elements:
                 element = maybe_call(element)