← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/webapp/admin/user.py

  • Committer: William Grant
  • Date: 2010-02-03 04:13:06 UTC
  • mto: This revision was merged to the branch mainline in revision 1467.
  • Revision ID: grantw@unimelb.edu.au-20100203041306-mms3mre4r07gxt16
Replace the Packaging document with a general Releases one, and cover both source tarball and Ubuntu package releases.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/admin/user.py
21
21
import formencode.validators
22
22
from genshi.filters import HTMLFormFiller
23
23
 
24
 
from ivle.database import User
25
 
import ivle.date
26
 
from ivle.pulldown_subj import enrol_user
27
24
from ivle.webapp import ApplicationRoot
28
 
from ivle.webapp.base.forms import BaseFormView, URLNameValidator
 
25
from ivle.webapp.base.rest import JSONRESTView, require_permission
29
26
from ivle.webapp.base.xhtml import XHTMLView
30
27
from ivle.webapp.base.plugins import ViewPlugin, MediaPlugin
31
28
from ivle.webapp.admin.publishing import root_to_user, user_url
 
29
from ivle.database import User
 
30
import ivle.database
 
31
import ivle.date
 
32
import ivle.util
32
33
 
33
34
 
34
35
class UsersView(XHTMLView):
35
36
    """A list of all IVLE users."""
36
37
    template = 'templates/users.html'
37
 
    tab = 'users'
38
 
    breadcrumb_text = 'Users'
39
38
 
40
39
    def authorize(self, req):
41
 
        return req.user and req.user.admin
 
40
        return req.user.admin
42
41
 
43
42
    def populate(self, req, ctx):
44
43
        ctx['req'] = req
45
44
        ctx['users'] = req.store.find(User).order_by(User.login)
46
45
 
47
46
 
 
47
# List of fields returned as part of the user JSON dictionary
 
48
# (as returned by the get_user action)
 
49
user_fields_list = (
 
50
    "login", "state", "unixid", "email", "nick", "fullname",
 
51
    "admin", "studentid", "acct_exp", "pass_exp", "last_login",
 
52
    "svn_pass"
 
53
)
 
54
 
 
55
class UserRESTView(JSONRESTView):
 
56
    """
 
57
    A REST interface to the user object.
 
58
    """
 
59
 
 
60
    @require_permission('view')
 
61
    def GET(self, req):
 
62
        # XXX Check Caps
 
63
        user = ivle.util.object_to_dict(user_fields_list, self.context)
 
64
        # Convert time stamps to nice strings
 
65
        for k in 'pass_exp', 'acct_exp', 'last_login':
 
66
            if user[k] is not None:
 
67
                user[k] = unicode(user[k])
 
68
 
 
69
        user['local_password'] = self.context.passhash is not None
 
70
        return user
 
71
 
48
72
class UserEditSchema(formencode.Schema):
49
73
    nick = formencode.validators.UnicodeString(not_empty=True)
50
74
    email = formencode.validators.Email(not_empty=False,
51
75
                                        if_missing=None)
52
76
 
53
 
class UserEditView(BaseFormView):
 
77
class UserEditView(XHTMLView):
54
78
    """A form to change a user's details."""
55
79
    template = 'templates/user-edit.html'
56
 
    tab = 'users'
 
80
    tab = 'settings'
57
81
    permission = 'edit'
58
82
 
59
 
    @property
60
 
    def validator(self):
61
 
        return UserEditSchema()
62
 
 
63
 
    def get_default_data(self, req):
64
 
        return {'nick': self.context.nick,
65
 
                'email': self.context.email
66
 
                }
67
 
 
68
 
    def save_object(self, req, data):
69
 
        self.context.nick = data['nick']
70
 
        self.context.email = unicode(data['email']) if data['email'] \
71
 
                             else None
72
 
        return self.context
 
83
    def filter(self, stream, ctx):
 
84
        return stream | HTMLFormFiller(data=ctx['data'])
73
85
 
74
86
    def populate(self, req, ctx):
75
 
        super(UserEditView, self).populate(req, ctx)
 
87
        if req.method == 'POST':
 
88
            data = dict(req.get_fieldstorage())
 
89
            try:
 
90
                validator = UserEditSchema()
 
91
                data = validator.to_python(data, state=req)
 
92
                self.context.nick = data['nick']
 
93
                self.context.email = unicode(data['email']) if data['email'] \
 
94
                                     else None
 
95
                req.store.commit()
 
96
                req.throw_redirect(req.uri)
 
97
            except formencode.Invalid, e:
 
98
                errors = e.unpack_errors()
 
99
        else:
 
100
            data = {'nick': self.context.nick,
 
101
                    'email': self.context.email
 
102
                   }
 
103
            errors = {}
 
104
 
76
105
        ctx['format_datetime'] = ivle.date.make_date_nice
77
106
        ctx['format_datetime_short'] = ivle.date.format_datetime_for_paragraph
78
107
 
 
108
        ctx['req'] = req
 
109
        ctx['user'] = self.context
 
110
        ctx['data'] = data
 
111
        ctx['errors'] = errors
79
112
 
80
113
class UserAdminSchema(formencode.Schema):
81
114
    admin = formencode.validators.StringBoolean(if_missing=False)
82
 
    disabled = formencode.validators.StringBoolean(if_missing=False)
83
115
    fullname = formencode.validators.UnicodeString(not_empty=True)
84
116
    studentid = formencode.validators.UnicodeString(not_empty=False,
85
117
                                                    if_missing=None
86
118
                                                    )
87
119
 
88
 
class UserAdminView(BaseFormView):
 
120
class UserAdminView(XHTMLView):
89
121
    """A form for admins to change more of a user's details."""
90
122
    template = 'templates/user-admin.html'
91
 
    tab = 'users'
 
123
    tab = 'settings'
92
124
 
93
125
    def authorize(self, req):
94
126
        """Only allow access if the requesting user is an admin."""
95
 
        return req.user and req.user.admin
96
 
 
97
 
    @property
98
 
    def validator(self):
99
 
        return UserAdminSchema()
100
 
 
101
 
    def get_default_data(self, req):
102
 
        return {'admin': self.context.admin,
103
 
                'disabled': self.context.state == u'disabled',
104
 
                'fullname': self.context.fullname,
105
 
                'studentid': self.context.studentid,
106
 
                }
107
 
 
108
 
    def save_object(self, req, data):
109
 
        if self.context is req.user:
110
 
            # Admin checkbox is disabled -- assume unchanged
111
 
            data['admin'] = self.context.admin
112
 
            data['disabled'] = self.context.state == u'disabled'
 
127
        return req.user.admin
 
128
 
 
129
    def filter(self, stream, ctx):
 
130
        return stream | HTMLFormFiller(data=ctx['data'])
 
131
 
 
132
    def populate(self, req, ctx):
 
133
        if req.method == 'POST':
 
134
            data = dict(req.get_fieldstorage())
 
135
            try:
 
136
                validator = UserAdminSchema()
 
137
                data = validator.to_python(data, state=req)
 
138
 
 
139
                self.context.admin = data['admin']
 
140
                self.context.fullname = data['fullname'] \
 
141
                                        if data['fullname'] else None
 
142
                self.context.studentid = data['studentid'] \
 
143
                                         if data['studentid'] else None
 
144
                req.store.commit()
 
145
                req.throw_redirect(req.uri)
 
146
            except formencode.Invalid, e:
 
147
                errors = e.unpack_errors()
113
148
        else:
114
 
            self.context.admin = data['admin']
115
 
            if self.context.state in (u'enabled', u'disabled'):
116
 
                self.context.state = (u'disabled' if data['disabled']
117
 
                        else u'enabled')
118
 
        self.context.fullname = data['fullname'] \
119
 
                                if data['fullname'] else None
120
 
        self.context.studentid = data['studentid'] \
121
 
                                 if data['studentid'] else None
122
 
        return self.context
123
 
 
124
 
    def populate(self, req, ctx):
125
 
        super(UserAdminView, self).populate(req, ctx)
126
 
 
127
 
        # Disable the admin checkbox if editing oneself
128
 
        ctx['disable_admin'] = self.context is req.user
 
149
            data = {'admin': self.context.admin,
 
150
                    'fullname': self.context.fullname,
 
151
                    'studentid': self.context.studentid,
 
152
                   }
 
153
            errors = {}
 
154
 
 
155
        ctx['req'] = req
 
156
        ctx['user'] = self.context
 
157
        ctx['data'] = data
 
158
        ctx['errors'] = errors
129
159
 
130
160
class PasswordChangeView(XHTMLView):
131
161
    """A form to change a user's password, with knowledge of the old one."""
132
162
    template = 'templates/user-password-change.html'
133
 
    tab = 'users'
 
163
    tab = 'settings'
134
164
    permission = 'edit'
135
165
 
136
166
    def authorize(self, req):
164
194
class PasswordResetView(XHTMLView):
165
195
    """A form to reset a user's password, without knowledge of the old one."""
166
196
    template = 'templates/user-password-reset.html'
167
 
    tab = 'users'
 
197
    tab = 'settings'
168
198
 
169
199
    def authorize(self, req):
170
200
        """Only allow access if the requesting user is an admin."""
171
 
        return req.user and req.user.admin
 
201
        return req.user.admin
172
202
 
173
203
    def populate(self, req, ctx):
174
204
        error = None
186
216
        ctx['user'] = self.context
187
217
        ctx['error'] = error
188
218
 
189
 
 
190
 
class UserNewSchema(formencode.Schema):
191
 
    login = URLNameValidator() # XXX: Validate uniqueness.
192
 
    admin = formencode.validators.StringBoolean(if_missing=False)
193
 
    fullname = formencode.validators.UnicodeString(not_empty=True)
194
 
    studentid = formencode.validators.UnicodeString(not_empty=False,
195
 
                                                    if_missing=None
196
 
                                                    )
197
 
    email = formencode.validators.Email(not_empty=False,
198
 
                                        if_missing=None)
199
 
 
200
 
 
201
 
class UserNewView(BaseFormView):
202
 
    """A form for admins to create new users."""
203
 
    template = 'templates/user-new.html'
204
 
    tab = 'users'
205
 
 
206
 
    def authorize(self, req):
207
 
        """Only allow access if the requesting user is an admin."""
208
 
        return req.user and req.user.admin
209
 
 
210
 
    @property
211
 
    def validator(self):
212
 
        return UserNewSchema()
213
 
 
214
 
    def get_default_data(self, req):
215
 
        return {}
216
 
 
217
 
    def save_object(self, req, data):
218
 
        data['nick'] = data['fullname']
219
 
        data['email'] = unicode(data['email']) if data['email'] else None
220
 
        userobj = User(**data)
221
 
        req.store.add(userobj)
222
 
        enrol_user(req.config, req.store, userobj)
223
 
 
224
 
        return userobj
225
 
 
226
 
 
227
219
class Plugin(ViewPlugin, MediaPlugin):
228
220
    """
229
221
    The Plugin class for the user plugin.
231
223
 
232
224
    forward_routes = (root_to_user,)
233
225
    reverse_routes = (user_url,)
234
 
    views = [(ApplicationRoot, ('users', '+index'), UsersView),
235
 
             (ApplicationRoot, ('users', '+new'), UserNewView),
236
 
             (User, '+index', UserEditView),
237
 
             (User, '+admin', UserAdminView),
238
 
             (User, '+changepassword', PasswordChangeView),
239
 
             (User, '+resetpassword', PasswordResetView),
 
226
    views = [(ApplicationRoot, 'users', UsersView),
 
227
             (ivle.database.User, '+index', UserEditView),
 
228
             (ivle.database.User, '+admin', UserAdminView),
 
229
             (ivle.database.User, '+changepassword', PasswordChangeView),
 
230
             (ivle.database.User, '+resetpassword', PasswordResetView),
 
231
             (ivle.database.User, '+index', UserRESTView, 'api'),
240
232
             ]
241
233
 
242
 
    tabs = [
243
 
        ('users', 'Users', 'Display and edit all users',
244
 
         'users.png', 'users', 90, True)
245
 
    ]
246
 
 
247
234
    public_forward_routes = forward_routes
248
235
    public_reverse_routes = reverse_routes
249
236