Changeset 1d92bf2 in OpenWorkouts-current for ow/models

Timestamp:

Dec 16, 2018, 1:07:04 AM (5 years ago)

Author:

borja <borja@…>

Branches:

current, feature/docs, master

Children:

6560b8f

Parents:

929097a

Message:

(#37) Allow login using email address instead of username:

• Use user uids as keys in the root folder for referencing user objects (instead of username)

• Use uids for referencing users all over the place (auth, permissions, traversal urls, etc)

• Replaced the username concept with nickname. This nickname will be used as a shortcut to access "public profile" pages for users

• Reworked lots of basic methods in the OpenWorkouts root object (s/username/nickname, marked as properties some methods like users, emails, etc)

• Added new add_user() and delete_user() helpers to the OpenWorkouts root object

• Modified views to match the new OpenWorkouts root helpers

• Fixed bug in the dashboard redirect view, causing an endless loop if an authenticated user does not exist anymore when loading a page.

• Lots of tests fixes, adaptations and catch up.

Location:

ow/models

Files:

• root.py (modified) (4 diffs)
• user.py (modified) (1 diff)

ow/models/root.py

@@ -3 +3 @@
 from repoze.folder import Folder
 from repoze.catalog.indexes.field import CatalogFieldIndex
+from repoze.catalog.query import Eq
 
 from pyramid.security import Allow, Everyone
 
 from ow.models.user import User
-from ow.catalog import get_catalog
+from ow.catalog import (
+    get_catalog,
+    install_catalog,
+    reindex_object,
+    remove_from_catalog,
+    resources_from_query_results
+)
 
 
@@ -14 +21 @@
     Root object, contains basically all the users, and in turn
     the users contain their workouts.
+
+    Users are stored in a dict-like structure, using a string containing
+    the user id (uid) as a key, and the User object as the value.
     """
 
@@ -20 +30 @@
     __acl__ = [
                (Allow, Everyone, 'view'),
-               (Allow, 'group:admins', 'edit')
+               (Allow, 'admins', 'edit')
               ]
+
+    def __init__(self, **kw):
+        install_catalog(self)
+        super(OpenWorkouts, self).__init__(**kw)
 
     def _get_catalog_indexes(self):
         indexes = {
+            'email': CatalogFieldIndex('email'),
             'sport': CatalogFieldIndex('sport'),
         }
         return indexes
 
-    def all_usernames(self):
+    def reindex(self, obj):
         """
-        Return all available usernames
+        Reindex the given object in the catalog
         """
-        return self.keys()
+        reindex_object(self.catalog, obj)
 
-    def lowercase_usernames(self):
+    def query(self, query):
         """
-        Return all available usernames in lower case. Useful for
-        username uniqueness validation on signup
+        Execute the given query on the catalog, returning the results
+        (generator with events found or empty list if no results were found)
         """
-        return [name.lower() for name in self.keys()]
+        catalog = get_catalog(self)
+        number, results = catalog.query(query)
+        if number:
+            return resources_from_query_results(catalog, results, self)
+        return []
 
+    def add_user(self, user):
+        self.add(str(user.uid), user)
+        self.reindex(user)
+
+    def del_user(self, user):
+        remove_from_catalog(self.catalog, user)
+        self.remove(str(user.uid))
+
+    def get_user_by_uid(self, uid):
+        return self.get(str(uid), None)
+
+    def get_user_by_email(self, email):
+        if email is not None:
+            # for some reason, when searching for None
+            # the catalog will return all users
+            res = self.query(Eq('email', email))
+            if res:
+                return next(res)
+        return None
+
+    @property
+    def users(self):
+        """
+        Return all user objects
+        """
+        return [user for user in self.values() if isinstance(user, User)]
+
+    @property
+    def all_nicknames(self):
+        """
+        Return all available nicknames
+        """
+        return [user.nickname for user in self.users if user.nickname]
+
+    @property
+    def lowercase_nicknames(self):
+        """
+        Return all available nicknames in lower case. Useful for
+        nickname uniqueness validation on signup
+        """
+        return [nick.lower() for nick in self.all_nicknames]
+
+    @property
     def emails(self):
         """
         Return all emails currently in use by users
         """
-        return [u.email for u in self.users()]
+        return [user.email for user in self.users]
 
+    @property
     def lowercase_emails(self):
         """
@@ -54 +117 @@
         against the currently used addresses
         """
-        return [u.email.lower() for u in self.users()]
-
-    def users(self):
-        """
-        Return all user objects
-        """
-        return [u for u in self.values() if isinstance(u, User)]
-
-    def get_user(self, uid):
-        return self.get(uid, None)
-
-    def add_user(self, uid, **kw):
-        u = User(**kw)
-        self[uid] = u
+        return [email.lower() for email in self.emails]
 
     @property
     def sports(self):
-        catalog = get_catalog(self)
-        return [s for s in catalog['sport']._fwd_index]
+        return [s for s in self.catalog['sport']._fwd_index]
 
     @property

ow/models/user.py

@@ -23 +23 @@
     def __init__(self, **kw):
         self.uid = kw.get('uid', uuid1())
+        self.nickname = kw.get('nickname', '')
         self.firstname = kw.get('firstname', '')
         self.lastname = kw.get('lastname', '')