summaryrefslogtreecommitdiff
path: root/sphinx/web/admin.py
blob: 12004475b6c972576e207b29ff97065a0d33b47f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# -*- coding: utf-8 -*-
"""
    sphinx.web.admin
    ~~~~~~~~~~~~~~~~

    Admin application parts.

    :copyright: 2007-2008 by Georg Brandl, Armin Ronacher.
    :license: BSD.
"""

from sphinx.web.util import render_template
from sphinx.web.wsgiutil import Response, RedirectResponse, NotFound
from sphinx.web.database import Comment


class AdminPanel(object):
    """
    Provide the admin functionallity.
    """

    def __init__(self, app):
        self.app = app
        self.env = app.env
        self.userdb = app.userdb

    def dispatch(self, req, page):
        """
        Dispatch the requests for the current user in the admin panel.
        """
        is_logged_in = req.user is not None
        if is_logged_in:
            privileges = self.userdb.privileges[req.user]
            is_master_admin = 'master' in privileges
            can_change_password = 'frozenpassword' not in privileges
        else:
            privileges = set()
            can_change_password = is_master_admin = False

        # login and logout
        if page == 'login':
            return self.do_login(req)
        elif not is_logged_in:
            return RedirectResponse('@admin/login/')
        elif page == 'logout':
            return self.do_logout(req)

        # account maintance
        elif page == 'change_password' and can_change_password:
            return self.do_change_password(req)
        elif page == 'manage_users' and is_master_admin:
            return self.do_manage_users(req)

        # moderate comments
        elif page.split('/')[0] == 'moderate_comments':
            return self.do_moderate_comments(req, page[18:])

        # missing page
        elif page != '':
            raise NotFound()
        return Response(render_template(req, 'admin/index.html', {
            'is_master_admin':      is_master_admin,
            'can_change_password':  can_change_password
        }))

    def do_login(self, req):
        """
        Display login form and do the login procedure.
        """
        if req.user is not None:
            return RedirectResponse('@admin/')
        login_failed = False
        if req.method == 'POST':
            if req.form.get('cancel'):
                return RedirectResponse('')
            username = req.form.get('username')
            password = req.form.get('password')
            if self.userdb.check_password(username, password):
                req.login(username)
                return RedirectResponse('@admin/')
            login_failed = True
        return Response(render_template(req, 'admin/login.html', {
            'login_failed': login_failed
        }))

    def do_logout(self, req):
        """
        Log the user out.
        """
        req.logout()
        return RedirectResponse('@admin/login/')

    def do_change_password(self, req):
        """
        Allows the user to change his password.
        """
        change_failed = change_successful = False
        if req.method == 'POST':
            if req.form.get('cancel'):
                return RedirectResponse('@admin/')
            pw = req.form.get('pw1')
            if pw and pw == req.form.get('pw2'):
                self.userdb.set_password(req.user, pw)
                self.userdb.save()
                change_successful = True
            else:
                change_failed = True
        return Response(render_template(req, 'admin/change_password.html', {
            'change_failed':        change_failed,
            'change_successful':    change_successful
        }))

    def do_manage_users(self, req):
        """
        Manage other user accounts. Requires master privileges.
        """
        add_user_mode = False
        user_privileges = {}
        users = sorted((user, []) for user in self.userdb.users)
        to_delete = set()
        generated_user = generated_password = None
        user_exists = False

        if req.method == 'POST':
            for item in req.form.getlist('delete'):
                try:
                    to_delete.add(item)
                except ValueError:
                    pass
            for name, item in req.form.iteritems():
                if name.startswith('privileges-'):
                    user_privileges[name[11:]] = [x.strip() for x
                                                  in item.split(',')]
            if req.form.get('cancel'):
                return RedirectResponse('@admin/')
            elif req.form.get('add_user'):
                username = req.form.get('username')
                if username:
                    if username in self.userdb.users:
                        user_exists = username
                    else:
                        generated_password = self.userdb.add_user(username)
                        self.userdb.save()
                        generated_user = username
                else:
                    add_user_mode = True
            elif req.form.get('aborted'):
                return RedirectResponse('@admin/manage_users/')

        users = {}
        for user in self.userdb.users:
            if user not in user_privileges:
                users[user] = sorted(self.userdb.privileges[user])
            else:
                users[user] = user_privileges[user]

        new_users = users.copy()
        for user in to_delete:
            new_users.pop(user, None)

        self_destruction = req.user not in new_users or \
                           'master' not in new_users[req.user]

        if req.method == 'POST' and (not to_delete or
           (to_delete and req.form.get('confirmed'))) and \
           req.form.get('update'):
            old_users = self.userdb.users.copy()
            for user in old_users:
                if user not in new_users:
                    del self.userdb.users[user]
                else:
                    self.userdb.privileges[user].clear()
                    self.userdb.privileges[user].update(new_users[user])
            self.userdb.save()
            return RedirectResponse('@admin/manage_users/')

        return Response(render_template(req, 'admin/manage_users.html', {
            'users':                users,
            'add_user_mode':        add_user_mode,
            'to_delete':            to_delete,
            'ask_confirmation':     req.method == 'POST' and to_delete \
                                    and not self_destruction,
            'generated_user':       generated_user,
            'generated_password':   generated_password,
            'self_destruction':     self_destruction,
            'user_exists':          user_exists
        }))

    def do_moderate_comments(self, req, url):
        """
        Comment moderation panel.
        """
        if url == 'recent_comments':
            details_for = None
            recent_comments = Comment.get_recent(20)
        else:
            details_for = url and self.env.get_real_filename(url) or None
            recent_comments = None
        to_delete = set()
        edit_detail = None

        if 'edit' in req.args:
            try:
                edit_detail = Comment.get(int(req.args['edit']))
            except ValueError:
                pass

        if req.method == 'POST':
            for item in req.form.getlist('delete'):
                try:
                    to_delete.add(int(item))
                except ValueError:
                    pass
            if req.form.get('cancel'):
                return RedirectResponse('@admin/')
            elif req.form.get('confirmed'):
                for comment_id in to_delete:
                    try:
                        Comment.get(comment_id).delete()
                    except ValueError:
                        pass
                return RedirectResponse(req.path)
            elif req.form.get('aborted'):
                return RedirectResponse(req.path)
            elif req.form.get('edit') and not to_delete:
                if 'delete_this' in req.form:
                    try:
                        to_delete.add(req.form['delete_this'])
                    except ValueError:
                        pass
                else:
                    try:
                        edit_detail = c = Comment.get(int(req.args['edit']))
                    except ValueError:
                        pass
                    else:
                        if req.form.get('view'):
                            return RedirectResponse(c.url)
                        c.author = req.form.get('author', '')
                        c.author_mail = req.form.get('author_mail', '')
                        c.title = req.form.get('title', '')
                        c.comment_body = req.form.get('comment_body', '')
                        c.save()
                        self.app.cache.pop(edit_detail.associated_page, None)
                    return RedirectResponse(req.path)

        return Response(render_template(req, 'admin/moderate_comments.html', {
            'pages_with_comments': [{
                'page_id':      page_id,
                'title':        page_id,        #XXX: get title somehow
                'has_details':  details_for == page_id,
                'comments':     comments
            } for page_id, comments in Comment.get_overview(details_for)],
            'recent_comments':  recent_comments,
            'to_delete':        to_delete,
            'ask_confirmation': req.method == 'POST' and to_delete,
            'edit_detail':      edit_detail
        }))