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
25 def __init__(self, value):
26 # implement lookup of sites id for link/name
32 def __init__(self, username):
35 self._userdata = dict()
37 self._userdata = self._get_user_data(username)
40 def _get_user_data(self, username):
42 return store.load_user_preferences(username)
46 self._userdata = dict()
49 def is_anonymous(self):
56 if 'is_admin' in self._userdata:
57 if str(self._userdata['is_admin']) == '1':
62 def is_admin(self, value):
64 self._userdata['is_admin'] = '1'
66 self._userdata['is_admin'] = '0'
70 if 'fullname' in self._userdata:
71 return self._userdata['fullname']
76 def fullname(self, value):
77 self._userdata['fullname'] = value
81 if 'email' in self._userdata:
82 return self._userdata['email']
88 if 'sites' in self._userdata:
90 for site in self._userdata['sites']:
97 # TODO: implement setting sites via the user object ?
100 def save_plugin_data(self, plugin, data):
102 store.save_plugin_data(plugin, self.name, data)
104 def load_plugin_data(self, plugin):
106 return store.load_plugin_data(plugin, self.name)
109 class UserSession(Log):
111 self.user = self.get_data('user', 'name')
112 self.userattrs = self.get_user_attrs()
115 return User(self.user)
117 def remote_login(self):
118 if cherrypy.request.login:
119 self.login(cherrypy.request.login)
121 self.nuke_data('user')
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)
129 # REMOTE_USER changed, replace user
130 self.nuke_data('user')
131 self.save_data('user', 'name', username)
134 # Save additional data provided by the login manager
135 self.nuke_data('userattrs')
137 self.save_user_attrs(userattrs)
139 cherrypy.log('LOGIN SUCCESSFUL: %s' % username)
141 def logout(self, user):
143 if not type(user) is User:
145 # Completely reset user data
146 cherrypy.log.error('%s %s' % (user.name, user.fullname),
147 severity=logging.INFO)
150 # Destroy current session in all cases
151 cherrypy.lib.sessions.expire()
153 def get_user_attrs(self):
155 if 'userattrs' in cherrypy.session:
156 userattrs = cherrypy.session['userattrs']
159 def save_user_attrs(self, userattrs):
160 cherrypy.session['userattrs'] = userattrs
161 self.debug('Saved user attrs')
162 self.userattrs = userattrs
164 def _get_provider_attr_name(self, provider):
165 return '%s_data' % provider
167 def get_provider_data(self, provider):
168 attr = self._get_provider_attr_name(provider)
170 if attr in cherrypy.session:
171 data = cherrypy.session[attr]
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)
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))
186 def get_data(self, facility, name):
187 """ Get named data in the session if available """
188 if facility not in cherrypy.session:
190 if name not in cherrypy.session[facility]:
192 return cherrypy.session[facility][name]
194 def nuke_data(self, facility, name=None):
195 if facility not in cherrypy.session:
198 if name not in cherrypy.session[facility]:
200 cherrypy.session[facility][name] = None
201 del cherrypy.session[facility][name]
202 self.debug('Nuked session data named [%s:%s]' % (facility, name))
204 del cherrypy.session[facility]
205 self.debug('Nuked session facility [%s]' % (facility,))