Move user attribute storage into session functions

[cascardo/ipsilon.git] / ipsilon / util / user.py

diff --git a/ipsilon/util/user.py b/ipsilon/util/user.py
index 3b58724..9dc0d65 100755 (executable)
--- a/ipsilon/util/user.py
+++ b/ipsilon/util/user.py
@@ -18,6 +18,9 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from ipsilon.util.data import Store
+from ipsilon.util.log import Log
+import cherrypy
+
 
 class Site(object):
     def __init__(self, value):
@@ -25,6 +28,7 @@ class Site(object):
         self.link = value
         self.name = value
 
+
 class User(object):
     def __init__(self, username):
         if username is None:
@@ -36,7 +40,17 @@ class User(object):
 
     def _get_user_data(self, username):
         store = Store()
-        return store._get_user_preferences(username)
+        return store.get_user_preferences(username)
+
+    def reset(self):
+        self.name = None
+        self._userdata = dict()
+
+    @property
+    def is_anonymous(self):
+        if self.name:
+            return False
+        return True
 
     @property
     def is_admin(self):
@@ -63,6 +77,13 @@ class User(object):
     def fullname(self, value):
         self._userdata['fullname'] = value
 
+    @property
+    def email(self):
+        if 'email' in self._userdata:
+            return self._userdata['email']
+        else:
+            return None
+
     @property
     def sites(self):
         if 'sites' in self._userdata:
@@ -74,6 +95,89 @@ class User(object):
 
     @sites.setter
     def sites(self):
-        #TODO: implement setting sites via the user object ?
+        # TODO: implement setting sites via the user object ?
         raise AttributeError
 
+
+class UserSession(Log):
+    def __init__(self):
+        self.user = self.get_data('user', 'name')
+        self.userattrs = self.get_user_attrs()
+
+    def get_user(self):
+        return User(self.user)
+
+    def remote_login(self):
+        if cherrypy.request.login:
+            self.login(cherrypy.request.login)
+        else:
+            self.nuke_data('user')
+
+    def login(self, username, userattrs=None):
+        if self.user == username:
+            return
+
+        # REMOTE_USER changed, replace user
+        self.nuke_data('user')
+        self.save_data('user', 'name', username)
+        self.user = username
+
+        # Save additional data provided by the login manager
+        self.nuke_data('userattrs')
+        if userattrs:
+            self.save_user_attrs(userattrs)
+
+        cherrypy.log('LOGIN SUCCESSFUL: %s' % username)
+
+    def logout(self, user):
+        if user is not None:
+            if not type(user) is User:
+                raise TypeError
+            # Completely reset user data
+            cherrypy.log.error('%s %s' % (user.name, user.fullname))
+            user.reset()
+
+        # Destroy current session in all cases
+        cherrypy.lib.sessions.expire()
+
+    def get_user_attrs(self):
+        userattrs = dict()
+        if 'userattrs' in cherrypy.session:
+            userattrs = cherrypy.session['userattrs']
+        return userattrs
+
+    def save_user_attrs(self, userattrs):
+        cherrypy.session['userattrs'] = userattrs
+        cherrypy.session.save()
+        self._debug('Saved user attrs')
+        self.userattrs = userattrs
+
+    def save_data(self, facility, name, data):
+        """ Save named data in the session so it can be retrieved later """
+        if facility not in cherrypy.session:
+            cherrypy.session[facility] = dict()
+        cherrypy.session[facility][name] = data
+        cherrypy.session.save()
+        self._debug('Saved session data named [%s:%s]' % (facility, name))
+
+    def get_data(self, facility, name):
+        """ Get named data in the session if available """
+        if facility not in cherrypy.session:
+            return None
+        if name not in cherrypy.session[facility]:
+            return None
+        return cherrypy.session[facility][name]
+
+    def nuke_data(self, facility, name=None):
+        if facility not in cherrypy.session:
+            return
+        if name:
+            if name not in cherrypy.session[facility]:
+                return
+            cherrypy.session[facility][name] = None
+            del cherrypy.session[facility][name]
+            self._debug('Nuked session data named [%s:%s]' % (facility, name))
+        else:
+            del cherrypy.session[facility]
+            self._debug('Nuked session facility [%s]' % (facility,))
+        cherrypy.session.save()