Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F62472069
webuser.py
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Subscribers
None
File Metadata
Details
File Info
Storage
Attached
Created
Mon, May 13, 10:52
Size
35 KB
Mime Type
text/x-python
Expires
Wed, May 15, 10:52 (2 d)
Engine
blob
Format
Raw Data
Handle
17650852
Attached To
R3600 invenio-infoscience
webuser.py
View Options
# -*- coding: utf-8 -*-
##
## $Id$
##
## This file is part of CDS Invenio.
## Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008 CERN.
##
## CDS Invenio is free software; you can redistribute it and/or
## modify it under the terms of the GNU General Public License as
## published by the Free Software Foundation; either version 2 of the
## License, or (at your option) any later version.
##
## CDS Invenio is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with CDS Invenio; if not, write to the Free Software Foundation, Inc.,
## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
"""
This file implements all methods necessary for working with users and
sessions in CDS Invenio. Contains methods for logging/registration
when a user log/register into the system, checking if it is a guest
user or not.
At the same time this presents all the stuff it could need with
sessions managements, working with websession.
It also contains Apache-related user authentication stuff.
"""
__revision__
=
"$Id$"
try
:
from
mod_python
import
apache
except
ImportError
:
pass
import
marshal
from
zlib
import
compress
,
decompress
from
socket
import
gethostbyname
import
time
import
os
import
crypt
import
socket
import
smtplib
import
re
import
random
import
base64
from
invenio.config
import
\
CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS
,
\
CFG_ACCESS_CONTROL_LEVEL_GUESTS
,
\
CFG_ACCESS_CONTROL_LEVEL_SITE
,
\
CFG_ACCESS_CONTROL_LIMIT_REGISTRATION_TO_DOMAIN
,
\
CFG_ACCESS_CONTROL_NOTIFY_ADMIN_ABOUT_NEW_ACCOUNTS
,
\
CFG_ACCESS_CONTROL_NOTIFY_USER_ABOUT_NEW_ACCOUNT
,
\
CFG_APACHE_GROUP_FILE
,
\
CFG_APACHE_PASSWORD_FILE
,
\
adminemail
,
\
cdslang
,
\
cdsname
,
\
cdsnameintl
,
\
supportemail
,
\
sweburl
,
\
CFG_TMPDIR
,
\
CFG_VERSION
,
\
weburl
from
invenio
import
session
,
websession
from
invenio.dbquery
import
run_sql
,
OperationalError
,
\
serialize_via_marshal
,
deserialize_via_marshal
from
invenio.websession
import
pSession
,
pSessionMapping
from
invenio.session
import
SessionError
from
invenio.access_control_config
import
*
from
invenio.access_control_admin
import
acc_find_user_role_actions
,
acc_get_role_id
from
invenio.access_control_mailcookie
import
mail_cookie_create_mail_activation
from
invenio.access_control_firerole
import
acc_firerole_check_user
,
load_role_definition
from
invenio.messages
import
gettext_set_language
from
invenio.mailutils
import
send_email
from
invenio.errorlib
import
register_exception
from
invenio.webgroup_dblayer
import
get_groups
from
invenio.external_authentication
import
InvenioWebAccessExternalAuthError
import
invenio.template
tmpl
=
invenio
.
template
.
load
(
'websession'
)
re_invalid_nickname
=
re
.
compile
(
""".*[,'@]+.*"""
)
# pylint: disable-msg=C0301
def
createGuestUser
():
"""Create a guest user , insert into user null values in all fields
createGuestUser() -> GuestUserID
"""
if
CFG_ACCESS_CONTROL_LEVEL_GUESTS
==
0
:
try
:
return
run_sql
(
"insert into user (email, note) values ('', '1')"
)
except
OperationalError
:
return
None
else
:
try
:
return
run_sql
(
"insert into user (email, note) values ('', '0')"
)
except
OperationalError
:
return
None
def
page_not_authorized
(
req
,
referer
=
''
,
uid
=
''
,
text
=
''
,
navtrail
=
''
,
ln
=
cdslang
,
navmenuid
=
""
):
"""Show error message when user is not authorized to do something.
@param referer: in case the displayed message propose a login link, this
is the url to return to after logging in.
@param uid: the uid of the user. If not specified it is guessed from req.
@param text: the message to be displayed. If not specified it will be
guessed from the context.
"""
from
invenio.webpage
import
page
_
=
gettext_set_language
(
ln
)
if
not
CFG_ACCESS_CONTROL_LEVEL_SITE
:
title
=
CFG_WEBACCESS_MSGS
[
5
]
if
not
uid
:
uid
=
getUid
(
req
)
try
:
res
=
run_sql
(
"SELECT email FROM user WHERE id=
%s
AND note=1"
%
uid
)
if
res
and
res
[
0
][
0
]:
if
text
:
body
=
text
else
:
body
=
"
%s
%s
"
%
(
CFG_WEBACCESS_WARNING_MSGS
[
9
]
%
res
[
0
][
0
],
(
"
%s
%s
"
%
(
CFG_WEBACCESS_MSGS
[
0
]
%
referer
,
CFG_WEBACCESS_MSGS
[
1
])))
else
:
if
text
:
body
=
text
else
:
if
CFG_ACCESS_CONTROL_LEVEL_GUESTS
==
1
:
body
=
CFG_WEBACCESS_MSGS
[
3
]
else
:
body
=
CFG_WEBACCESS_WARNING_MSGS
[
4
]
+
CFG_WEBACCESS_MSGS
[
2
]
except
OperationalError
,
e
:
body
=
_
(
"Database problem"
)
+
': '
+
str
(
e
)
elif
CFG_ACCESS_CONTROL_LEVEL_SITE
==
1
:
title
=
CFG_WEBACCESS_MSGS
[
8
]
body
=
"
%s
%s
"
%
(
CFG_WEBACCESS_MSGS
[
7
],
CFG_WEBACCESS_MSGS
[
2
])
elif
CFG_ACCESS_CONTROL_LEVEL_SITE
==
2
:
title
=
CFG_WEBACCESS_MSGS
[
6
]
body
=
"
%s
%s
"
%
(
CFG_WEBACCESS_MSGS
[
4
],
CFG_WEBACCESS_MSGS
[
2
])
return
page
(
title
=
title
,
uid
=
getUid
(
req
),
body
=
body
,
navtrail
=
navtrail
,
req
=
req
,
navmenuid
=
navmenuid
)
def
getApacheUser
(
req
):
"""Return the ApacheUser taking it from the cookie of the request."""
sm
=
session
.
MPSessionManager
(
pSession
,
pSessionMapping
())
try
:
s
=
sm
.
get_session
(
req
)
except
SessionError
:
sm
.
revoke_session_cookie
(
req
)
s
=
sm
.
get_session
(
req
)
apache_user
=
s
.
getApacheUser
()
sm
.
maintain_session
(
req
,
s
)
return
apache_user
def
getUid
(
req
):
"""Return user ID taking it from the cookie of the request.
Includes control mechanism for the guest users, inserting in
the database table when need be, raising the cookie back to the
client.
User ID is set to 0 when client refuses cookie or we are in the
read-only site operation mode.
User ID is set to -1 when we are in the permission denied site
operation mode.
getUid(req) -> userId
"""
if
CFG_ACCESS_CONTROL_LEVEL_SITE
==
1
:
return
0
if
CFG_ACCESS_CONTROL_LEVEL_SITE
==
2
:
return
-
1
guest
=
0
sm
=
session
.
MPSessionManager
(
pSession
,
pSessionMapping
())
try
:
s
=
sm
.
get_session
(
req
)
except
SessionError
:
sm
.
revoke_session_cookie
(
req
)
s
=
sm
.
get_session
(
req
)
userId
=
s
.
getUid
()
if
userId
==
-
1
:
# first time, so create a guest user
s
.
setUid
(
createGuestUser
())
userId
=
s
.
getUid
()
guest
=
1
sm
.
maintain_session
(
req
,
s
)
if
guest
==
0
:
guest
=
isGuestUser
(
userId
)
if
guest
:
if
CFG_ACCESS_CONTROL_LEVEL_GUESTS
==
0
:
return
userId
elif
CFG_ACCESS_CONTROL_LEVEL_GUESTS
>=
1
:
return
-
1
else
:
res
=
run_sql
(
"SELECT note FROM user WHERE id=
%s
"
%
userId
)
if
CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS
==
0
:
return
userId
elif
CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS
>=
1
and
res
and
res
[
0
][
0
]
in
[
1
,
"1"
]:
return
userId
else
:
return
-
1
def
setApacheUser
(
req
,
apache_user
):
"""It sets the apache_user into the session, and raise the cookie to the client.
"""
sm
=
session
.
MPSessionManager
(
pSession
,
pSessionMapping
())
try
:
s
=
sm
.
get_session
(
req
)
except
SessionError
:
sm
.
revoke_session_cookie
(
req
)
s
=
sm
.
get_session
(
req
)
s
.
setApacheUser
(
apache_user
)
sm
.
maintain_session
(
req
,
s
)
return
apache_user
def
setUid
(
req
,
uid
):
"""It sets the userId into the session, and raise the cookie to the client.
"""
sm
=
session
.
MPSessionManager
(
pSession
,
pSessionMapping
())
try
:
s
=
sm
.
get_session
(
req
)
except
SessionError
:
sm
.
revoke_session_cookie
(
req
)
s
=
sm
.
get_session
(
req
)
s
.
setUid
(
uid
)
sm
.
maintain_session
(
req
,
s
)
return
uid
def
get_user_info
(
uid
,
ln
=
cdslang
):
"""Get infos for a given user.
@param uid: user id (int)
@return tuple: (uid, nickname, display_name)
"""
_
=
gettext_set_language
(
ln
)
query
=
"""SELECT id, nickname
FROM user
WHERE id=%i"""
res
=
run_sql
(
query
%
uid
)
if
res
:
if
res
[
0
]:
user
=
list
(
res
[
0
])
if
user
[
1
]:
user
.
append
(
user
[
1
])
else
:
user
[
1
]
=
str
(
user
[
0
])
user
.
append
(
_
(
"user"
)
+
' #'
+
str
(
user
[
0
]))
return
tuple
(
user
)
return
(
uid
,
''
,
_
(
"N/A"
))
def
isGuestUser
(
uid
):
"""It Checks if the userId corresponds to a guestUser or not
isGuestUser(uid) -> boolean
"""
out
=
1
try
:
res
=
run_sql
(
"select email from user where id=
%s
"
,
(
uid
,))
if
res
:
if
res
[
0
][
0
]:
out
=
0
except
OperationalError
:
pass
return
out
def
isUserSubmitter
(
user_info
):
"""Return True if the user is a submitter for something; False otherwise."""
u_email
=
get_email
(
user_info
[
'uid'
])
res
=
run_sql
(
"select email from sbmSUBMISSIONS where email=
%s
"
,
(
u_email
,))
return
len
(
res
)
>
0
def
isUserReferee
(
user_info
):
"""Return True if the user is a referee for something; False otherwise."""
from
invenio.access_control_engine
import
acc_authorize_action
res
=
run_sql
(
"select sdocname from sbmDOCTYPE"
)
for
row
in
res
:
doctype
=
row
[
0
]
categ
=
"*"
(
auth_code
,
auth_message
)
=
acc_authorize_action
(
user_info
,
"referee"
,
doctype
=
doctype
,
categ
=
categ
)
if
auth_code
==
0
:
return
1
res2
=
run_sql
(
"select sname from sbmCATEGORIES where doctype=
%s
"
,
(
doctype
,))
for
row2
in
res2
:
categ
=
row2
[
0
]
(
auth_code
,
auth_message
)
=
acc_authorize_action
(
user_info
,
"referee"
,
doctype
=
doctype
,
categ
=
categ
)
if
auth_code
==
0
:
return
1
return
0
def
isUserAdmin
(
user_info
):
"""Return True if the user has some admin rights; False otherwise."""
return
acc_find_user_role_actions
(
user_info
)
def
nickname_valid_p
(
nickname
):
"""Check whether wanted NICKNAME supplied by the user is valid.
At the moment we just check whether it is not empty, does not
contain blanks or @, is not equal to `guest', etc.
This check relies on re_invalid_nickname regexp (see above)
Return 1 if nickname is okay, return 0 if it is not.
"""
if
nickname
and
\
not
(
nickname
.
startswith
(
' '
)
or
nickname
.
endswith
(
' '
))
and
\
nickname
.
lower
()
!=
'guest'
:
if
not
re_invalid_nickname
.
match
(
nickname
):
return
1
return
0
def
email_valid_p
(
email
):
"""Check whether wanted EMAIL address supplied by the user is valid.
At the moment we just check whether it contains '@' and whether
it doesn't contain blanks. We also check the email domain if
CFG_ACCESS_CONTROL_LIMIT_REGISTRATION_TO_DOMAIN is set.
Return 1 if email is okay, return 0 if it is not.
"""
if
(
email
.
find
(
"@"
)
<=
0
)
or
(
email
.
find
(
" "
)
>
0
):
return
0
elif
CFG_ACCESS_CONTROL_LIMIT_REGISTRATION_TO_DOMAIN
:
if
not
email
.
endswith
(
CFG_ACCESS_CONTROL_LIMIT_REGISTRATION_TO_DOMAIN
):
return
0
return
1
def
confirm_email
(
email
):
"""Confirm the email. It returns None when there are problems, otherwise
it return the uid involved."""
if
CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS
==
0
:
activated
=
1
elif
CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS
==
1
:
activated
=
0
elif
CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS
>=
2
:
return
-
1
run_sql
(
'UPDATE user SET note=
%s
where email=
%s
'
,
(
activated
,
email
))
res
=
run_sql
(
'SELECT id FROM user where email=
%s
'
,
(
email
,
))
if
res
:
if
CFG_ACCESS_CONTROL_NOTIFY_ADMIN_ABOUT_NEW_ACCOUNTS
:
sendNewAdminAccountWarning
(
email
,
adminemail
)
return
res
[
0
][
0
]
else
:
return
None
def
registerUser
(
req
,
email
,
passw
,
nickname
,
register_without_nickname
=
False
,
login_method
=
None
,
ln
=
cdslang
):
"""Register user with the desired values of NICKNAME, EMAIL and
PASSW.
If REGISTER_WITHOUT_NICKNAME is set to True, then ignore
desired NICKNAME and do not set any. This is suitable for
external authentications so that people can login without
having to register an internal account first.
Return 0 if the registration is successful, 1 if email is not
valid, 2 if nickname is not valid, 3 if email is already in the
database, 4 if nickname is already in the database, 5 when
users cannot register themselves because of the site policy, 6 when the
site is having problem contacting the user.
If login_method is None or is equal to the key corresponding to local
authentication, then CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS is taken
in account for deciding the behaviour about registering.
"""
# is email valid?
email
=
email
.
lower
()
if
not
email_valid_p
(
email
):
return
1
_
=
gettext_set_language
(
ln
)
# is email already taken?
res
=
run_sql
(
"SELECT email FROM user WHERE email=
%s
"
,
(
email
,))
if
len
(
res
)
>
0
:
return
3
if
register_without_nickname
:
# ignore desired nick and use default empty string one:
nickname
=
""
else
:
# is nickname valid?
if
not
nickname_valid_p
(
nickname
):
return
2
# is nickname already taken?
res
=
run_sql
(
"SELECT nickname FROM user WHERE nickname=
%s
"
,
(
nickname
,))
if
len
(
res
)
>
0
:
return
4
activated
=
1
# By default activated
if
not
login_method
or
not
CFG_EXTERNAL_AUTHENTICATION
[
login_method
][
0
]:
# local login
if
CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS
>=
2
:
return
5
elif
CFG_ACCESS_CONTROL_NOTIFY_USER_ABOUT_NEW_ACCOUNT
:
activated
=
2
# Email confirmation required
elif
CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS
>=
1
:
activated
=
0
# Administrator confirmation required
if
CFG_ACCESS_CONTROL_NOTIFY_USER_ABOUT_NEW_ACCOUNT
:
address_activation_key
=
mail_cookie_create_mail_activation
(
email
)
ip_address
=
req
.
connection
.
remote_host
or
req
.
connection
.
remote_ip
try
:
if
not
send_email
(
supportemail
,
email
,
_
(
"Account registration at
%s
"
)
%
cdsnameintl
.
get
(
ln
,
cdsname
),
tmpl
.
tmpl_account_address_activation_email_body
(
email
,
address_activation_key
,
ip_address
,
ln
)):
return
1
except
(
smtplib
.
SMTPException
,
socket
.
error
):
return
6
# okay, go on and register the user:
user_preference
=
get_default_user_preferences
()
uid
=
run_sql
(
"INSERT INTO user (nickname, email, password, note, settings, last_login) "
"VALUES (
%s
,
%s
,AES_ENCRYPT(email,
%s
),
%s
,
%s
, NOW())"
,
(
nickname
,
email
,
passw
,
activated
,
serialize_via_marshal
(
user_preference
)))
if
activated
==
1
:
# Ok we consider the user as logged in :-)
setUid
(
req
,
uid
)
return
0
def
updateDataUser
(
uid
,
email
,
nickname
):
"""
Update user data. Used when a user changed his email or password
or nickname.
"""
email
=
email
.
lower
()
if
email
==
'guest'
:
return
0
if
CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS
<
2
:
run_sql
(
"update user set email=
%s
where id=
%s
"
,
(
email
,
uid
))
if
nickname
and
nickname
!=
''
:
run_sql
(
"update user set nickname=
%s
where id=
%s
"
,
(
nickname
,
uid
))
return
1
def
updatePasswordUser
(
uid
,
password
):
"""Update the password of a user."""
if
CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS
<
3
:
run_sql
(
"update user set password=AES_ENCRYPT(email,
%s
) where id=
%s
"
,
(
password
,
uid
))
return
1
def
loginUser
(
req
,
p_un
,
p_pw
,
login_method
):
"""It is a first simple version for the authentication of user. It returns the id of the user,
for checking afterwards if the login is correct
"""
# p_un passed may be an email or a nickname:
p_email
=
get_email_from_username
(
p_un
)
# go on with the old stuff based on p_email:
if
not
CFG_EXTERNAL_AUTHENTICATION
.
has_key
(
login_method
):
return
([],
p_email
,
p_pw
,
12
)
if
CFG_EXTERNAL_AUTHENTICATION
[
login_method
][
0
]:
# External Authenthication
try
:
p_email
=
CFG_EXTERNAL_AUTHENTICATION
[
login_method
][
0
]
.
auth_user
(
p_email
,
p_pw
,
req
)
if
p_email
:
p_email
=
p_email
.
lower
()
else
:
raise
InvenioWebAccessExternalAuthError
except
InvenioWebAccessExternalAuthError
:
return
([],
p_email
,
p_pw
,
15
)
if
p_email
:
# Authenthicated externally
query_result
=
run_sql
(
"SELECT id from user where email=
%s
"
,
(
p_email
,))
if
not
query_result
:
# First time user
p_pw_local
=
int
(
random
.
random
()
*
1000000
)
p_nickname
=
''
if
CFG_EXTERNAL_AUTHENTICATION
[
login_method
][
0
]
.
enforce_external_nicknames
:
try
:
# Let's discover the external nickname!
p_nickname
=
CFG_EXTERNAL_AUTHENTICATION
[
login_method
][
0
]
.
fetch_user_nickname
(
p_email
,
p_pw
,
req
)
except
(
AttributeError
,
NotImplementedError
):
pass
res
=
registerUser
(
req
,
p_email
,
p_pw_local
,
p_nickname
,
register_without_nickname
=
p_nickname
==
''
,
login_method
=
login_method
)
if
res
==
4
or
res
==
2
:
# The nickname was already taken
res
=
registerUser
(
req
,
p_email
,
p_pw_local
,
''
,
register_without_nickname
=
True
,
login_method
=
login_method
)
elif
res
==
0
:
# Everything was ok, with or without nickname.
query_result
=
run_sql
(
"SELECT id from user where email=
%s
"
,
(
p_email
,))
elif
res
==
6
:
# error in contacting the user via email
return
([],
p_email
,
p_pw_local
,
19
)
else
:
return
([],
p_email
,
p_pw_local
,
13
)
try
:
groups
=
CFG_EXTERNAL_AUTHENTICATION
[
login_method
][
0
]
.
fetch_user_groups_membership
(
p_email
,
p_pw
,
req
)
# groups is a dictionary {group_name : group_description,}
new_groups
=
{}
for
key
,
value
in
groups
.
items
():
new_groups
[
key
+
" ["
+
str
(
login_method
)
+
"]"
]
=
value
groups
=
new_groups
except
(
AttributeError
,
NotImplementedError
):
pass
except
InvenioWebAccessExternalAuthError
:
return
([],
p_email
,
p_pw
,
16
)
else
:
# Groups synchronization
if
groups
!=
0
:
userid
=
query_result
[
0
][
0
]
from
invenio.webgroup
import
synchronize_external_groups
synchronize_external_groups
(
userid
,
groups
,
login_method
)
user_prefs
=
get_user_preferences
(
query_result
[
0
][
0
])
if
CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS
>=
4
:
# Let's prevent the user to switch login_method
if
user_prefs
.
has_key
(
"login_method"
)
and
\
user_prefs
[
"login_method"
]
!=
login_method
:
return
([],
p_email
,
p_pw
,
11
)
user_prefs
[
"login_method"
]
=
login_method
# Cleaning external settings
for
key
in
user_prefs
.
keys
():
if
key
.
startswith
(
'EXTERNAL_'
):
del
user_prefs
[
key
]
try
:
# Importing external settings
new_prefs
=
CFG_EXTERNAL_AUTHENTICATION
[
login_method
][
0
]
.
fetch_user_preferences
(
p_email
,
p_pw
,
req
)
for
key
,
value
in
new_prefs
.
items
():
user_prefs
[
'EXTERNAL_'
+
key
]
=
value
except
(
AttributeError
,
NotImplementedError
):
pass
except
InvenioWebAccessExternalAuthError
:
return
([],
p_email
,
p_pw
,
16
)
# Storing settings
set_user_preferences
(
query_result
[
0
][
0
],
user_prefs
)
else
:
return
([],
p_un
,
p_pw
,
10
)
else
:
# Internal Authenthication
if
not
p_pw
:
p_pw
=
''
query_result
=
run_sql
(
"SELECT id,email,note from user where email=
%s
and password=AES_ENCRYPT(email,
%s
)"
,
(
p_email
,
p_pw
,))
if
query_result
:
#FIXME drop external groups and settings
note
=
query_result
[
0
][
2
]
if
note
==
'1'
:
# Good account
preferred_login_method
=
get_user_preferences
(
query_result
[
0
][
0
])[
'login_method'
]
p_email
=
query_result
[
0
][
1
]
.
lower
()
if
login_method
!=
preferred_login_method
:
if
CFG_EXTERNAL_AUTHENTICATION
.
has_key
(
preferred_login_method
):
return
([],
p_email
,
p_pw
,
11
)
elif
note
==
'2'
:
# Email address need to be confirmed by user
return
([],
p_email
,
p_pw
,
17
)
elif
note
==
'0'
:
# Account need to be confirmed by administrator
return
([],
p_email
,
p_pw
,
18
)
else
:
return
([],
p_email
,
p_pw
,
14
)
# Login successful! Updating the last access time
run_sql
(
"UPDATE user SET last_login=NOW() WHERE email=
%s
"
,
(
p_email
,
))
return
(
query_result
,
p_email
,
p_pw
,
0
)
def
drop_external_settings
(
userId
):
"""Drop the external (EXTERNAL_) settings of userid."""
prefs
=
get_user_preferences
(
userId
)
for
key
in
prefs
.
keys
():
if
key
.
startswith
(
'EXTERNAL_'
):
del
prefs
[
key
]
set_user_preferences
(
userId
,
prefs
)
def
logoutUser
(
req
):
"""It logout the user of the system, creating a guest user.
"""
getUid
(
req
)
sm
=
session
.
MPSessionManager
(
pSession
,
pSessionMapping
())
try
:
s
=
sm
.
get_session
(
req
)
except
SessionError
:
sm
.
revoke_session_cookie
(
req
)
s
=
sm
.
get_session
(
req
)
id1
=
createGuestUser
()
s
.
setUid
(
id1
)
sm
.
maintain_session
(
req
,
s
)
return
id1
def
username_exists_p
(
username
):
"""Check if USERNAME exists in the system. Username may be either
nickname or email.
Return 1 if it does exist, 0 if it does not.
"""
if
username
==
""
:
# return not exists if asked for guest users
return
0
res
=
run_sql
(
"SELECT email FROM user WHERE email=
%s
"
,
(
username
,))
+
\
run_sql
(
"SELECT email FROM user WHERE nickname=
%s
"
,
(
username
,))
if
len
(
res
)
>
0
:
return
1
return
0
def
emailUnique
(
p_email
):
"""Check if the email address only exists once. If yes, return userid, if not, -1
"""
query_result
=
run_sql
(
"select id, email from user where email=
%s
"
,
(
p_email
,))
if
len
(
query_result
)
==
1
:
return
query_result
[
0
][
0
]
elif
len
(
query_result
)
==
0
:
return
0
return
-
1
def
nicknameUnique
(
p_nickname
):
"""Check if the nickname only exists once. If yes, return userid, if not, -1
"""
query_result
=
run_sql
(
"select id, nickname from user where nickname=
%s
"
,
(
p_nickname
,))
if
len
(
query_result
)
==
1
:
return
query_result
[
0
][
0
]
elif
len
(
query_result
)
==
0
:
return
0
return
-
1
def
update_Uid
(
req
,
p_email
):
"""It updates the userId of the session. It is used when a guest user is logged in succesfully in the system
with a given email and password
"""
query_ID
=
int
(
run_sql
(
"select id from user where email=
%s
"
,
(
p_email
,))[
0
][
0
])
setUid
(
req
,
query_ID
)
return
query_ID
def
sendNewAdminAccountWarning
(
newAccountEmail
,
sendTo
,
ln
=
cdslang
):
"""Send an email to the address given by sendTo about the new account newAccountEmail."""
_
=
gettext_set_language
(
ln
)
sub
=
_
(
"New account on"
)
+
" '
%s
'"
%
cdsname
if
CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS
==
1
:
sub
+=
" - "
+
_
(
"PLEASE ACTIVATE"
)
body
=
_
(
"A new account has been created on"
)
+
" '
%s
'"
%
cdsname
if
CFG_ACCESS_CONTROL_LEVEL_ACCOUNTS
==
1
:
body
+=
_
(
" and is awaiting activation"
)
body
+=
":
\n\n
"
body
+=
_
(
" Username/Email"
)
+
":
%s
\n\n
"
%
newAccountEmail
body
+=
_
(
"You can approve or reject this account request at"
)
+
":
%s
/admin/webaccess/webaccessadmin.py/manageaccounts
\n
"
%
weburl
return
send_email
(
supportemail
,
sendTo
,
subject
=
sub
,
content
=
body
)
def
sendNewUserAccountWarning
(
newAccountEmail
,
sendTo
,
password
,
ln
=
cdslang
):
"""Send an email to the address given by sendTo about the new account newAccountEmail."""
_
=
gettext_set_language
(
ln
)
sub
=
_
(
"Your account created on"
)
+
" '
%s
'"
%
cdsname
body
=
_
(
"You have created a new account on"
)
+
" '
%s
'
\n\n
"
%
cdsname
body
+=
_
(
" Username/Email:"
)
+
"
%s
\n
"
%
newAccountEmail
body
+=
_
(
" Password:"
)
+
"
%s
\n\n
"
%
(
"*"
*
len
(
password
))
return
send_email
(
supportemail
,
sendTo
,
subject
=
sub
,
content
=
body
)
def
get_email
(
uid
):
"""Return email address of the user uid. Return string 'guest' in case
the user is not found."""
out
=
"guest"
res
=
run_sql
(
"SELECT email FROM user WHERE id=
%s
"
,
(
uid
,),
1
)
if
res
and
res
[
0
][
0
]:
out
=
res
[
0
][
0
]
.
lower
()
return
out
def
get_email_from_username
(
username
):
"""Return email address of the user corresponding to USERNAME.
The username may be either nickname or email. Return USERNAME
untouched if not found in the database or if found several
matching entries.
"""
if
username
==
''
:
return
''
out
=
username
res
=
run_sql
(
"SELECT email FROM user WHERE email=
%s
"
,
(
username
,),
1
)
+
\
run_sql
(
"SELECT email FROM user WHERE nickname=
%s
"
,
(
username
,),
1
)
if
res
and
len
(
res
)
==
1
:
out
=
res
[
0
][
0
]
.
lower
()
return
out
#def get_password(uid):
#"""Return password of the user uid. Return None in case
#the user is not found."""
#out = None
#res = run_sql("SELECT password FROM user WHERE id=%s", (uid,), 1)
#if res and res[0][0] != None:
#out = res[0][0]
#return out
def
get_nickname
(
uid
):
"""Return nickname of the user uid. Return None in case
the user is not found."""
out
=
None
res
=
run_sql
(
"SELECT nickname FROM user WHERE id=
%s
"
,
(
uid
,),
1
)
if
res
and
res
[
0
][
0
]:
out
=
res
[
0
][
0
]
return
out
def
get_nickname_or_email
(
uid
):
"""Return nickname (preferred) or the email address of the user uid.
Return string 'guest' in case the user is not found."""
out
=
"guest"
res
=
run_sql
(
"SELECT nickname, email FROM user WHERE id=
%s
"
,
(
uid
,),
1
)
if
res
and
res
[
0
]:
if
res
[
0
][
0
]:
out
=
res
[
0
][
0
]
elif
res
[
0
][
1
]:
out
=
res
[
0
][
1
]
.
lower
()
return
out
def
create_userinfobox_body
(
req
,
uid
,
language
=
"en"
):
"""Create user info box body for user UID in language LANGUAGE."""
if
req
:
if
req
.
subprocess_env
.
has_key
(
'HTTPS'
)
\
and
req
.
subprocess_env
[
'HTTPS'
]
==
'on'
:
url_referer
=
sweburl
+
req
.
unparsed_uri
else
:
url_referer
=
weburl
+
req
.
unparsed_uri
if
'/youraccount/logout'
in
url_referer
:
url_referer
=
''
else
:
url_referer
=
weburl
try
:
return
tmpl
.
tmpl_create_userinfobox
(
ln
=
language
,
url_referer
=
url_referer
,
guest
=
isGuestUser
(
uid
),
username
=
get_nickname_or_email
(
uid
),
submitter
=
True
,
# FIXME isUserSubmitter(uid),
referee
=
True
,
# FIXME isUserReferee(req),
admin
=
True
# FIXME isUserAdmin(req),
)
except
OperationalError
:
return
""
def
list_registered_users
():
"""List all registered users."""
return
run_sql
(
"SELECT id,email FROM user where email!=''"
)
def
list_users_in_role
(
role
):
"""List all users of a given role (see table accROLE)
@param role: role of user (string)
@return list of uids
"""
res
=
run_sql
(
"""SELECT uacc.id_user
FROM user_accROLE uacc JOIN accROLE acc
ON uacc.id_accROLE=acc.id
WHERE acc.name=%s"""
,
(
role
,))
if
res
:
return
map
(
lambda
x
:
int
(
x
[
0
]),
res
)
return
[]
def
list_users_in_roles
(
role_list
):
"""List all users of given roles (see table accROLE)
@param role_list: list of roles [string]
@return list of uids
"""
if
not
(
type
(
role_list
)
is
list
or
type
(
role_list
)
is
tuple
):
role_list
=
[
role_list
]
query
=
"""SELECT DISTINCT(uacc.id_user)
FROM user_accROLE uacc JOIN accROLE acc
ON uacc.id_accROLE=acc.id
"""
query_addons
=
""
query_params
=
()
if
len
(
role_list
)
>
0
:
query_params
=
role_list
query_addons
=
" WHERE "
for
role
in
role_list
[:
-
1
]:
query_addons
+=
"acc.name=
%s
OR "
query_addons
+=
"acc.name=
%s
"
res
=
run_sql
(
query
+
query_addons
,
query_params
)
if
res
:
return
map
(
lambda
x
:
int
(
x
[
0
]),
res
)
return
[]
def
get_user_preferences
(
uid
):
pref
=
run_sql
(
"SELECT id, settings FROM user WHERE id=
%s
"
,
(
uid
,))
if
pref
:
try
:
return
deserialize_via_marshal
(
pref
[
0
][
1
])
except
:
pass
return
get_default_user_preferences
()
# empty dict mean no preferences
def
set_user_preferences
(
uid
,
pref
):
assert
(
type
(
pref
)
==
type
({}))
run_sql
(
"UPDATE user SET settings=
%s
WHERE id=
%s
"
,
(
serialize_via_marshal
(
pref
),
uid
))
def
get_default_user_preferences
():
user_preference
=
{
'login_method'
:
''
}
for
system
in
CFG_EXTERNAL_AUTHENTICATION
.
keys
():
if
CFG_EXTERNAL_AUTHENTICATION
[
system
][
1
]:
user_preference
[
'login_method'
]
=
system
break
return
user_preference
def
collect_user_info
(
req
):
"""Given the mod_python request object rec or a uid it returns a dictionary
containing at least the keys uid, nickname, email, groups, plus any external keys in
the user preferences (collected at login time and built by the different
external authentication plugins) and if the mod_python request object is
provided, also the remote_ip, remote_host, referer, agent fields.
If the user is authenticated with Apache should provide also
apache_user and apache_group.
"""
user_info
=
{
'remote_ip'
:
''
,
'remote_host'
:
''
,
'referer'
:
''
,
'uri'
:
''
,
'agent'
:
''
,
'apache_user'
:
''
,
'apache_group'
:
[],
'uid'
:
-
1
,
'nickname'
:
''
,
'email'
:
''
,
'group'
:
[],
'guest'
:
'1'
}
try
:
if
req
is
None
:
uid
=
-
1
elif
type
(
req
)
in
(
type
(
1
),
type
(
1L
)):
## req is infact a user identification
uid
=
req
elif
type
(
req
)
is
dict
:
## req is by mistake already a user_info
try
:
assert
(
req
.
has_key
(
'uid'
))
assert
(
req
.
has_key
(
'email'
))
assert
(
req
.
has_key
(
'nickname'
))
except
AssertionError
:
## mmh... misuse of collect_user_info. Better warn the admin!
register_exception
(
alert_admin
=
True
)
user_info
.
update
(
req
)
return
user_info
else
:
uid
=
getUid
(
req
)
user_info
[
'remote_ip'
]
=
gethostbyname
(
req
.
connection
.
remote_ip
)
user_info
[
'remote_host'
]
=
req
.
connection
.
remote_host
or
''
user_info
[
'referer'
]
=
req
.
headers_in
.
get
(
'Referer'
,
''
)
user_info
[
'uri'
]
=
req
.
unparsed_uri
or
''
user_info
[
'agent'
]
=
req
.
headers_in
.
get
(
'User-Agent'
,
'N/A'
)
try
:
user_info
[
'apache_user'
]
=
getApacheUser
(
req
)
if
user_info
[
'apache_user'
]:
user_info
[
'apache_group'
]
=
auth_apache_user_in_groups
(
user_info
[
'apache_user'
])
except
AttributeError
:
pass
user_info
[
'uid'
]
=
uid
user_info
[
'nickname'
]
=
get_nickname
(
uid
)
or
''
user_info
[
'email'
]
=
get_email
(
uid
)
or
''
user_info
[
'group'
]
=
[]
user_info
[
'guest'
]
=
str
(
isGuestUser
(
uid
))
if
uid
:
user_info
[
'group'
]
=
[
group
[
1
]
for
group
in
get_groups
(
uid
)]
prefs
=
get_user_preferences
(
uid
)
if
prefs
:
for
key
,
value
in
prefs
.
items
():
user_info
[
key
.
lower
()]
=
value
except
Exception
,
e
:
register_exception
()
return
user_info
## --- follow some functions for Apache user/group authentication
def
auth_apache_user_p
(
user
,
password
,
apache_password_file
=
CFG_APACHE_PASSWORD_FILE
):
"""Check whether user-supplied credentials correspond to valid
Apache password data file."""
try
:
if
not
apache_password_file
.
startswith
(
"/"
):
apache_password_file
=
CFG_TMPDIR
+
"/"
+
apache_password_file
dummy
,
pipe_output
=
os
.
popen2
([
"grep"
,
"^"
+
user
+
":"
,
apache_password_file
],
'r'
)
line
=
pipe_output
.
readlines
()[
0
]
password_apache
=
line
.
strip
()
.
split
(
":"
)[
1
]
except
:
# no pw found, so return not-allowed status
return
False
salt
=
password_apache
[:
2
]
return
crypt
.
crypt
(
password
,
salt
)
==
password_apache
def
auth_apache_user_in_groups
(
user
,
apache_group_file
=
CFG_APACHE_GROUP_FILE
):
"""Return list of Apache groups to which Apache user belong."""
out
=
[]
try
:
if
not
apache_group_file
.
startswith
(
"/"
):
apache_group_file
=
CFG_TMPDIR
+
"/"
+
apache_group_file
dummy
,
pipe_output
=
os
.
popen2
([
"grep"
,
user
,
apache_group_file
],
'r'
)
for
line
in
pipe_output
.
readlines
():
out
.
append
(
line
.
strip
()
.
split
(
":"
)[
0
])
except
:
# no groups found, so return empty list
pass
return
out
def
http_get_credentials
(
req
):
if
req
.
headers_in
.
has_key
(
"Authorization"
):
try
:
s
=
req
.
headers_in
[
"Authorization"
][
6
:]
s
=
base64
.
decodestring
(
s
)
user
,
passwd
=
s
.
split
(
":"
,
1
)
except
(
ValueError
,
base64
.
binascii
.
Error
,
base64
.
binascii
.
Incomplete
):
raise
apache
.
SERVER_RETURN
,
apache
.
HTTP_BAD_REQUEST
return
(
user
,
passwd
)
return
(
None
,
None
)
def
http_check_credentials
(
req
,
role
):
"""Retrieve Apache password and check user credential with the
check_auth function. If this function returns True check if the user
is enabled to the given role. If this is True, return, otherwise
popup a new apache login box.
"""
authorized
=
False
while
True
:
if
req
.
headers_in
.
has_key
(
"Authorization"
):
try
:
s
=
req
.
headers_in
[
"Authorization"
][
6
:]
s
=
base64
.
decodestring
(
s
)
user
,
passwd
=
s
.
split
(
":"
,
1
)
except
(
ValueError
,
base64
.
binascii
.
Error
,
base64
.
binascii
.
Incomplete
):
raise
apache
.
SERVER_RETURN
,
apache
.
HTTP_BAD_REQUEST
authorized
=
auth_apache_user_p
(
user
,
passwd
)
if
authorized
:
setApacheUser
(
req
,
user
)
authorized
=
acc_firerole_check_user
(
collect_user_info
(
req
),
load_role_definition
(
acc_get_role_id
(
role
)))
setApacheUser
(
req
,
''
)
if
not
authorized
:
# note that Opera supposedly doesn't like spaces around "=" below
s
=
'Basic realm="
%s
"'
%
role
req
.
err_headers_out
[
"WWW-Authenticate"
]
=
s
raise
apache
.
SERVER_RETURN
,
apache
.
HTTP_UNAUTHORIZED
else
:
setApacheUser
(
req
,
user
)
return
Event Timeline
Log In to Comment