1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2008 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
# Module: dispatch.login
22
# Provides services for checking logins and presenting the login page.
26
from mod_python import Session
29
from ivle import (util, db, caps, forumutil)
30
from ivle.auth import authenticate, autherror
33
"""Determines whether the user is logged in or not (looking at sessions),
34
and if not, presents the login page. Returns a User object, or None
37
If the user was already logged in, nothing is written to req. Returns
38
the User object for the logged in user.
40
If the user was not logged in, but manages to authenticate due to
41
included postdata with a valid username/password, throws a redirect
42
back to the same page (to avoid leaving POSTDATA in the browser).
44
If the user is not logged in, or fails to authenticate, a full page is
45
written to req. Returns None. The caller should immediately terminate.
47
# Get the user details from the session, if already logged in
48
# (None means not logged in yet)
49
login_details = get_user_details(req)
51
# Check the session to see if someone is logged in. If so, go with it.
52
# No security is required here. You must have already been authenticated
53
# in order to get a 'login_name' variable in the session.
54
if login_details is not None and login_details.state == "enabled":
55
# Only allow users to authenticate if their account is ENABLED
60
# Check if there is any postdata containing login information
61
if login_details is None and req.method == 'POST':
62
fields = req.get_fieldstorage()
63
username = fields.getfirst('user')
64
password = fields.getfirst('pass')
65
if username is not None:
66
# From this point onwards, we will be showing an error message
70
badlogin = "No password supplied."
74
authenticate.authenticate(username.value, password.value)
75
# NOTE: Can't catch AuthError, since each module throws a
76
# different identity of AuthError.
77
except Exception, msg:
79
if login_details is None:
80
# Must have got an error. Do not authenticate.
82
elif login_details.pass_expired():
83
badlogin = "Your password has expired."
84
elif login_details.acct_expired():
85
badlogin = "Your account has expired."
87
# Success - Set the session and redirect to avoid POSTDATA
88
session = req.get_session()
89
session['user'] = login_details
91
db.DB().update_user(username.value,
92
last_login = time.localtime())
93
req.add_cookie(forumutil.make_forum_cookie(login_details))
94
req.throw_redirect(req.uri)
96
# Present the HTML login page
97
req.content_type = "text/html"
99
req.write_html_head_foot = True
101
# User is not logged in or their account is not enabled.
102
if login_details is not None:
103
# Only possible if no errors occured thus far
104
if login_details.state == "no_agreement":
105
# User has authenticated but has not accepted the TOS.
106
# Present them with the TOS page.
107
# First set their username for display at the top, but make sure
108
# the apps tabs are not displayed
109
req.user = login_details
110
# IMPORTANT NOTE FOR HACKERS: You can't simply disable this check
111
# if you are not planning to display a TOS page - the TOS
112
# acceptance process actually calls usermgt to create the user
113
# jails and related stuff.
114
present_tos(req, login_details.fullname)
116
elif login_details.state == "disabled":
117
# User has authenticated but their account is disabled
118
badlogin = "Your account has been disabled."
119
elif login_details.state == "pending":
120
# FIXME: this isn't quite the right answer, but it
121
# should be more robust in the short term.
122
session = req.get_session()
125
db.DB().update_user(login_details.login, state='no_agreement')
126
req.throw_redirect(req.uri)
128
# Write the HTML for the login page
129
# If badlogin, display an error message indicating a failed login
130
req.write("""<div id="ivle_padding">
131
<p>Welcome to the Informatics Virtual Learning Environment.
132
Please log in to access your files and assessment.</p>
134
if badlogin is not None:
135
req.write("""<p class="error">%s</p>
137
req.write("""<form action="" method="post">
139
<tr><td>Username:</td><td><input name="user" type="text" /></td></tr>
140
<tr><td>Password:</td><td><input name="pass" type="password" /></td></tr>
141
<tr><td colspan="2"><input type="submit" value="Login" /></td></tr>
145
# Write the "Message of the Day" document, if it exists.
147
req.sendfile(ivle.conf.motd_path)
150
req.write('</div>\n')
154
def get_user_details(req):
155
"""Gets the name of the logged in user, without presenting a login box
156
or attempting to authenticate.
157
Returns None if there is no user logged in.
159
session = req.get_session()
161
# Check the session to see if someone is logged in. If so, go with it.
162
# No security is required here. You must have already been authenticated
163
# in order to get a 'login_name' variable in the session.
165
return session['user']
169
def present_tos(req, fullname):
170
"""Present the Terms of Service screen to the user (who has just logged in
171
for the first time and needs to accept these before being admitted into
174
req.title = "Terms of Service"
175
# Include the JavaScript for the "makeuser" Ajax stuff
177
"media/common/json2.js",
178
"media/common/util.js",
179
"media/common/tos.js",
181
req.write("""<div id="ivle_padding">
182
<p>Welcome, <b>%s</b>.</p>
183
<p>As this is the first time you have logged into IVLE, you are required to
184
accept these Terms of Service before using the system.</p>
185
<p>You will be allowed to re-read these terms at any time from the "Help"
189
# Write out the text of the license
190
util.send_terms_of_service(req)
192
<div id="tos_acceptbuttons">
193
<p>Please click "I Accept" to indicate that you have read and understand these
194
terms, or click "I Decline" to log out of IVLE.</p>
196
<input type="button" value="I Accept" onclick="accept_license()" />
197
<input type="button" value="I Decline" onclick="decline_license()" />
added
removed
ivle/dispatch/login.py
