1 # Copyright (C) 2013 Simo Sorce <simo@redhat.com>
3 # see file 'COPYING' for use and warranty information
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.
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.
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/>.
18 from ipsilon.util.data import UserStore
19 from ipsilon.util.log import Log
24 def __init__(self, value):
25 # implement lookup of sites id for link/name
31 def __init__(self, username):
34 self._userdata = dict()
36 self._userdata = self._get_user_data(username)
39 def _get_user_data(self, username):
41 return store.load_user_preferences(username)
45 self._userdata = dict()
48 def is_anonymous(self):
55 if 'is_admin' in self._userdata:
56 if str(self._userdata['is_admin']) == '1':
61 def is_admin(self, value):
63 self._userdata['is_admin'] = '1'
65 self._userdata['is_admin'] = '0'
69 if 'fullname' in self._userdata:
70 return self._userdata['fullname']
75 def fullname(self, value):
76 self._userdata['fullname'] = value
80 if 'email' in self._userdata:
81 return self._userdata['email']
87 if 'sites' in self._userdata:
89 for site in self._userdata['sites']:
96 # TODO: implement setting sites via the user object ?
99 def save_plugin_data(self, plugin, data):
101 store.save_plugin_data(plugin, self.name, data)
103 def load_plugin_data(self, plugin):
105 return store.load_plugin_data(plugin, self.name)
108 class UserSession(Log):
110 self.user = self.get_data('user', 'name')
111 self.userattrs = self.get_user_attrs()
114 return User(self.user)
116 def remote_login(self):
117 if cherrypy.request.login:
118 self.login(cherrypy.request.login)
120 self.nuke_data('user')
122 def login(self, username, userattrs=None):
123 if self.user == username:
124 if userattrs and not self.get_user_attrs():
125 self.save_user_attrs(userattrs)
128 # REMOTE_USER changed, replace user
129 self.nuke_data('user')
130 self.save_data('user', 'name', username)
133 # Save additional data provided by the login manager
134 self.nuke_data('userattrs')
136 self.save_user_attrs(userattrs)
138 cherrypy.log('LOGIN SUCCESSFUL: %s' % username)
140 def logout(self, user):
142 if not type(user) is User:
144 # Completely reset user data
145 cherrypy.log.error('%s %s' % (user.name, user.fullname))
148 # Destroy current session in all cases
149 cherrypy.lib.sessions.expire()
151 def get_user_attrs(self):
153 if 'userattrs' in cherrypy.session:
154 userattrs = cherrypy.session['userattrs']
157 def save_user_attrs(self, userattrs):
158 cherrypy.session['userattrs'] = userattrs
159 self._debug('Saved user attrs')
160 self.userattrs = userattrs
162 def _get_provider_attr_name(self, provider):
163 return '%s_data' % provider
165 def get_provider_data(self, provider):
166 attr = self._get_provider_attr_name(provider)
168 if attr in cherrypy.session:
169 data = cherrypy.session[attr]
172 def save_provider_data(self, provider, data):
173 attr = self._get_provider_attr_name(provider)
174 cherrypy.session[attr] = data
175 self._debug('Saved %s provider data' % provider)
177 def save_data(self, facility, name, data):
178 """ Save named data in the session so it can be retrieved later """
179 if facility not in cherrypy.session:
180 cherrypy.session[facility] = dict()
181 cherrypy.session[facility][name] = data
182 self._debug('Saved session data named [%s:%s]' % (facility, name))
184 def get_data(self, facility, name):
185 """ Get named data in the session if available """
186 if facility not in cherrypy.session:
188 if name not in cherrypy.session[facility]:
190 return cherrypy.session[facility][name]
192 def nuke_data(self, facility, name=None):
193 if facility not in cherrypy.session:
196 if name not in cherrypy.session[facility]:
198 cherrypy.session[facility][name] = None
199 del cherrypy.session[facility][name]
200 self._debug('Nuked session data named [%s:%s]' % (facility, name))
202 del cherrypy.session[facility]
203 self._debug('Nuked session facility [%s]' % (facility,))