ipsilon/util/user.py

   1 # Copyright (C) 2013  Simo Sorce <simo@redhat.com>
   2 #
   3 # see file 'COPYING' for use and warranty information
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation, either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 from ipsilon.util.data import UserStore
  19 from ipsilon.util.log import Log
  20 import cherrypy
  21 import logging
  22
  23
  24 class Site(object):
  25     def __init__(self, value):
  26         # implement lookup of sites id for link/name
  27         self.link = value
  28         self.name = value
  29
  30
  31 class User(object):
  32     def __init__(self, username):
  33         if username is None:
  34             self.name = None
  35             self._userdata = dict()
  36         else:
  37             self._userdata = self._get_user_data(username)
  38             self.name = username
  39
  40     def _get_user_data(self, username):
  41         store = UserStore()
  42         return store.load_user_preferences(username)
  43
  44     def reset(self):
  45         self.name = None
  46         self._userdata = dict()
  47
  48     @property
  49     def is_anonymous(self):
  50         if self.name:
  51             return False
  52         return True
  53
  54     @property
  55     def is_admin(self):
  56         if 'is_admin' in self._userdata:
  57             if str(self._userdata['is_admin']) == '1':
  58                 return True
  59         return False
  60
  61     @is_admin.setter
  62     def is_admin(self, value):
  63         if value is True:
  64             self._userdata['is_admin'] = '1'
  65         else:
  66             self._userdata['is_admin'] = '0'
  67
  68     @property
  69     def fullname(self):
  70         if 'fullname' in self._userdata:
  71             return self._userdata['fullname']
  72         else:
  73             return self.name
  74
  75     @fullname.setter
  76     def fullname(self, value):
  77         self._userdata['fullname'] = value
  78
  79     @property
  80     def email(self):
  81         if 'email' in self._userdata:
  82             return self._userdata['email']
  83         else:
  84             return None
  85
  86     @property
  87     def sites(self):
  88         if 'sites' in self._userdata:
  89             d = []
  90             for site in self._userdata['sites']:
  91                 d.append(Site(site))
  92         else:
  93             return []
  94
  95     @sites.setter
  96     def sites(self):
  97         # TODO: implement setting sites via the user object ?
  98         raise AttributeError
  99
 100     def save_plugin_data(self, plugin, data):
 101         store = UserStore()
 102         store.save_plugin_data(plugin, self.name, data)
 103
 104     def load_plugin_data(self, plugin):
 105         store = UserStore()
 106         return store.load_plugin_data(plugin, self.name)
 107
 108
 109 class UserSession(Log):
 110     def __init__(self):
 111         self.user = self.get_data('user', 'name')
 112         self.userattrs = self.get_user_attrs()
 113
 114     def get_user(self):
 115         return User(self.user)
 116
 117     def remote_login(self):
 118         if cherrypy.request.login:
 119             self.login(cherrypy.request.login)
 120         else:
 121             self.nuke_data('user')
 122
 123     def login(self, username, userattrs=None):
 124         if self.user == username:
 125             if userattrs and not self.get_user_attrs():
 126                 self.save_user_attrs(userattrs)
 127             return
 128
 129         # REMOTE_USER changed, replace user
 130         self.nuke_data('user')
 131         self.save_data('user', 'name', username)
 132         self.user = username
 133
 134         # Save additional data provided by the login manager
 135         self.nuke_data('userattrs')
 136         if userattrs:
 137             self.save_user_attrs(userattrs)
 138
 139         cherrypy.log('LOGIN SUCCESSFUL: %s' % username)
 140
 141     def logout(self, user):
 142         if user is not None:
 143             if not type(user) is User:
 144                 raise TypeError
 145             # Completely reset user data
 146             cherrypy.log.error('%s %s' % (user.name, user.fullname),
 147                                severity=logging.INFO)
 148             user.reset()
 149
 150         # Destroy current session in all cases
 151         cherrypy.lib.sessions.expire()
 152
 153     def get_user_attrs(self):
 154         userattrs = dict()
 155         if 'userattrs' in cherrypy.session:
 156             userattrs = cherrypy.session['userattrs']
 157         return userattrs
 158
 159     def save_user_attrs(self, userattrs):
 160         cherrypy.session['userattrs'] = userattrs
 161         self.debug('Saved user attrs')
 162         self.userattrs = userattrs
 163
 164     def _get_provider_attr_name(self, provider):
 165         return '%s_data' % provider
 166
 167     def get_provider_data(self, provider):
 168         attr = self._get_provider_attr_name(provider)
 169         data = None
 170         if attr in cherrypy.session:
 171             data = cherrypy.session[attr]
 172         return data
 173
 174     def save_provider_data(self, provider, data):
 175         attr = self._get_provider_attr_name(provider)
 176         cherrypy.session[attr] = data
 177         self.debug('Saved %s provider data' % provider)
 178
 179     def save_data(self, facility, name, data):
 180         """ Save named data in the session so it can be retrieved later """
 181         if facility not in cherrypy.session:
 182             cherrypy.session[facility] = dict()
 183         cherrypy.session[facility][name] = data
 184         self.debug('Saved session data named [%s:%s]' % (facility, name))
 185
 186     def get_data(self, facility, name):
 187         """ Get named data in the session if available """
 188         if facility not in cherrypy.session:
 189             return None
 190         if name not in cherrypy.session[facility]:
 191             return None
 192         return cherrypy.session[facility][name]
 193
 194     def nuke_data(self, facility, name=None):
 195         if facility not in cherrypy.session:
 196             return
 197         if name:
 198             if name not in cherrypy.session[facility]:
 199                 return
 200             cherrypy.session[facility][name] = None
 201             del cherrypy.session[facility][name]
 202             self.debug('Nuked session data named [%s:%s]' % (facility, name))
 203         else:
 204             del cherrypy.session[facility]
 205             self.debug('Nuked session facility [%s]' % (facility,))