~azzar1/unity/add-show-desktop-key

1076 by chadnickbok
Created a new app, logout, which when given a GET
1
# IVLE
2
# Copyright (C) 2007-2009 The University of Melbourne
3
#
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.
8
#
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.
13
#
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
17
1099.1.41 by William Grant
Port www/apps/logout to new framework (in ivle.webapp.security).
18
# Author: Will Grant, Nick Chadwick
19
1099.1.120 by William Grant
Move the login machinery to the new framework.
20
import urllib
21
import datetime
22
try:
23
    import mod_python.Cookie
24
except ImportError:
25
    # This needs to be importable from outside Apache.
26
    pass
27
28
import ivle.util
1099.1.161 by William Grant
Move ivle.dispatch.login.get_user_details() to ivle.webapp.security.
29
import ivle.webapp.security
1099.1.120 by William Grant
Move the login machinery to the new framework.
30
from ivle.auth import authenticate, AuthError
1099.1.41 by William Grant
Port www/apps/logout to new framework (in ivle.webapp.security).
31
from ivle.webapp.base.xhtml import XHTMLView
1099.1.120 by William Grant
Move the login machinery to the new framework.
32
from ivle.webapp.base.plugins import CookiePlugin
33
34
class LoginView(XHTMLView):
35
    '''A view to allow a user to log in.'''
36
    template = 'login.html'
1099.1.129 by William Grant
Allow XHTML views to specify that they cannot have overlays.
37
    allow_overlays = False
1099.1.120 by William Grant
Move the login machinery to the new framework.
38
39
    def authorize(self, req):
40
        return True
41
42
    def populate(self, req, ctx):
43
        fields = req.get_fieldstorage()
44
        nexturl = fields.getfirst('url')
45
46
        if nexturl is None:
47
            nexturl = '/'
48
49
        # We are already logged in. Don't bother logging in again.
1099.1.125 by William Grant
Move the pending/no_agreement handling into the new login machinery.
50
        # Note that req.user is None even if we are 'logged in', if the user is
51
        # invalid.
1099.1.120 by William Grant
Move the login machinery to the new framework.
52
        if req.user is not None:
53
            req.throw_redirect(nexturl)
54
1099.1.209 by William Grant
Don't escape / in paths when they are in +login/+tos URLs.
55
        # Don't give any URL if we want /.
56
        if nexturl == '/':
57
            query_string = ''
58
        else:
59
            query_string = '?url=' + urllib.quote(nexturl, safe="/~")
60
61
        ctx['path'] = ivle.util.make_path('+login') + query_string
1099.1.120 by William Grant
Move the login machinery to the new framework.
62
1099.1.125 by William Grant
Move the pending/no_agreement handling into the new login machinery.
63
        # If this succeeds, the user is invalid.
1099.1.161 by William Grant
Move ivle.dispatch.login.get_user_details() to ivle.webapp.security.
64
        user = ivle.webapp.security.get_user_details(req)
1099.1.125 by William Grant
Move the pending/no_agreement handling into the new login machinery.
65
        if user is not None:
66
            if user.state == "no_agreement":
67
                # Authenticated, but need to accept the ToS. Send them there.
68
                # IMPORTANT NOTE FOR HACKERS: You can't simply disable this
69
                # if you are not planning to display a ToS page - the ToS
70
                # acceptance process actually calls usrmgt to create the user
71
                # jails and related stuff.
1099.1.209 by William Grant
Don't escape / in paths when they are in +login/+tos URLs.
72
                req.throw_redirect(ivle.util.make_path('+tos') + query_string)
1099.1.125 by William Grant
Move the pending/no_agreement handling into the new login machinery.
73
            elif user.state == "pending":
74
                # FIXME: this isn't quite the right answer, but it
75
                # should be more robust in the short term.
76
                session = req.get_session()
77
                session.invalidate()
78
                session.delete()
79
                user.state = u'no_agreement'
80
                req.store.commit()
81
                req.throw_redirect(nexturl)
82
1099.1.120 by William Grant
Move the login machinery to the new framework.
83
        if req.method == "POST":
84
            # While req.user is normally set to get_user_details, it won't set
85
            # it if the account isn't valid. So we get it ourselves.
1099.1.161 by William Grant
Move ivle.dispatch.login.get_user_details() to ivle.webapp.security.
86
            user = ivle.webapp.security.get_user_details(req)
1099.1.120 by William Grant
Move the login machinery to the new framework.
87
88
            badlogin = None
89
90
            username = fields.getfirst('user')
91
            password = fields.getfirst('pass')
92
            if username is not None:
93
                # From this point onwards, we will be showing an error message
94
                # if unsuccessful.
95
                # Authenticate
96
                if password is None:
97
                    badlogin = "No password supplied."
98
                else:
99
                    user = None
100
                    try:
101
                        user = authenticate.authenticate(req.store,
102
                                    username.value, password.value)
103
                    except AuthError, msg:
104
                        badlogin = msg
105
                    if user is None:
106
                        # Must have got an error. Do not authenticate.
1099.1.123 by William Grant
Don't crash when not authenticated, and display an error on password absence.
107
                        # The except: above will have set a message.
1099.1.120 by William Grant
Move the login machinery to the new framework.
108
                        pass
109
                    else:
110
                        # Success - Set the session and redirect to the URL.
111
                        session = req.get_session()
112
                        session['login'] = user.login
113
                        session.save()
114
                        user.last_login = datetime.datetime.now()
115
                        req.store.commit()
116
117
                        # Create cookies for plugins that might request them.
1092.1.59 by William Grant
Move the plugin loading/indexing logic into ivle.config.Config.
118
                        for plugin in req.config.plugin_index[CookiePlugin]:
1099.1.120 by William Grant
Move the login machinery to the new framework.
119
                            for cookie in plugin.cookies:
120
                                # The function can be None if they just need to be
121
                                # deleted at logout.
122
                                if plugin.cookies[cookie] is not None:
123
                                    req.add_cookie(mod_python.Cookie.Cookie(cookie,
124
                                          plugin.cookies[cookie](user), path='/'))
125
126
                        req.throw_redirect(nexturl)
127
1099.1.123 by William Grant
Don't crash when not authenticated, and display an error on password absence.
128
                # We didn't succeed.
129
                # Render the login form with the error message.
130
                ctx['error'] = badlogin
1099.1.120 by William Grant
Move the login machinery to the new framework.
131
1099.1.41 by William Grant
Port www/apps/logout to new framework (in ivle.webapp.security).
132
133
class LogoutView(XHTMLView):
134
    '''A view to log the current session out.'''
135
    template = 'logout.html'
1099.1.129 by William Grant
Allow XHTML views to specify that they cannot have overlays.
136
    allow_overlays = False
1099.1.41 by William Grant
Port www/apps/logout to new framework (in ivle.webapp.security).
137
1099.1.110 by William Grant
Implement an authorization system in the new framework. This breaks the REST
138
    def authorize(self, req):
1099.1.126 by William Grant
Allow any authenticated (even invalid) user to use the logout view.
139
        # This can be used by any authenticated user, even if they haven't
140
        # accepted the ToS yet.
1099.1.161 by William Grant
Move ivle.dispatch.login.get_user_details() to ivle.webapp.security.
141
        return ivle.webapp.security.get_user_details(req) is not None
1099.1.110 by William Grant
Implement an authorization system in the new framework. This breaks the REST
142
1099.1.41 by William Grant
Port www/apps/logout to new framework (in ivle.webapp.security).
143
    def populate(self, req, ctx):
144
        if req.method == "POST":
145
            req.logout()
146
        else:
1099.1.120 by William Grant
Move the login machinery to the new framework.
147
            ctx['path'] =  ivle.util.make_path('+logout')