trusted_user.py 11.6 KB
Newer Older
1
2
3
import html
import logging
import re
4
5
import typing

Kevin Morris's avatar
Kevin Morris committed
6
from datetime import datetime
7
from http import HTTPStatus
Kevin Morris's avatar
Kevin Morris committed
8

9
from fastapi import APIRouter, Form, HTTPException, Request
10
from fastapi.responses import RedirectResponse, Response
Kevin Morris's avatar
Kevin Morris committed
11
12
from sqlalchemy import and_, or_

13
from aurweb import db, l10n, models
Kevin Morris's avatar
Kevin Morris committed
14
15
from aurweb.auth import account_type_required, auth_required
from aurweb.models.account_type import DEVELOPER, TRUSTED_USER, TRUSTED_USER_AND_DEV
16
from aurweb.templates import make_context, make_variable_context, render_template
Kevin Morris's avatar
Kevin Morris committed
17
18

router = APIRouter()
19
logger = logging.getLogger(__name__)
Kevin Morris's avatar
Kevin Morris committed
20
21
22
23
24
25
26
27
28
29
30
31

# Some TU route specific constants.
ITEMS_PER_PAGE = 10  # Paged table size.
MAX_AGENDA_LENGTH = 75  # Agenda table column length.

# A set of account types that will approve a user for TU actions.
REQUIRED_TYPES = {
    TRUSTED_USER,
    DEVELOPER,
    TRUSTED_USER_AND_DEV
}

32
33
34
35
36
37
38
39
40
41
42
ADDVOTE_SPECIFICS = {
    # This dict stores a vote duration and quorum for a proposal.
    # When a proposal is added, duration is added to the current
    # timestamp.
    # "addvote_type": (duration, quorum)
    "add_tu": (7 * 24 * 60 * 60, 0.66),
    "remove_tu": (7 * 24 * 60 * 60, 0.75),
    "remove_inactive_tu": (5 * 24 * 60 * 60, 0.66),
    "bylaws": (7 * 24 * 60 * 60, 0.75)
}

Kevin Morris's avatar
Kevin Morris committed
43
44

@router.get("/tu")
45
@auth_required(True, redirect="/tu")
Kevin Morris's avatar
Kevin Morris committed
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
@account_type_required(REQUIRED_TYPES)
async def trusted_user(request: Request,
                       coff: int = 0,  # current offset
                       cby: str = "desc",  # current by
                       poff: int = 0,  # past offset
                       pby: str = "desc"):  # past by
    context = make_context(request, "Trusted User")

    current_by, past_by = cby, pby
    current_off, past_off = coff, poff

    context["pp"] = pp = ITEMS_PER_PAGE
    context["prev_len"] = MAX_AGENDA_LENGTH

    ts = int(datetime.utcnow().timestamp())

    if current_by not in {"asc", "desc"}:
        # If a malicious by was given, default to desc.
        current_by = "desc"
    context["current_by"] = current_by

    if past_by not in {"asc", "desc"}:
        # If a malicious by was given, default to desc.
        past_by = "desc"
    context["past_by"] = past_by

72
73
74
    current_votes = db.query(models.TUVoteInfo).filter(
        models.TUVoteInfo.End > ts).order_by(
        models.TUVoteInfo.Submitted.desc())
Kevin Morris's avatar
Kevin Morris committed
75
76
77
78
79
80
    context["current_votes_count"] = current_votes.count()
    current_votes = current_votes.limit(pp).offset(current_off)
    context["current_votes"] = reversed(current_votes.all()) \
        if current_by == "asc" else current_votes.all()
    context["current_off"] = current_off

81
82
83
    past_votes = db.query(models.TUVoteInfo).filter(
        models.TUVoteInfo.End <= ts).order_by(
        models.TUVoteInfo.Submitted.desc())
Kevin Morris's avatar
Kevin Morris committed
84
85
86
87
88
89
90
91
92
93
    context["past_votes_count"] = past_votes.count()
    past_votes = past_votes.limit(pp).offset(past_off)
    context["past_votes"] = reversed(past_votes.all()) \
        if past_by == "asc" else past_votes.all()
    context["past_off"] = past_off

    # TODO
    # We order last votes by TUVote.VoteID and User.Username.
    # This is really bad. We should add a Created column to
    # TUVote of type Timestamp and order by that instead.
94
95
96
97
98
99
100
101
    last_votes_by_tu = db.query(models.TUVote).filter(
        and_(models.TUVote.VoteID == models.TUVoteInfo.ID,
             models.TUVoteInfo.End <= ts,
             models.TUVote.UserID == models.User.ID,
             or_(models.User.AccountTypeID == 2,
                 models.User.AccountTypeID == 4))
    ).group_by(models.User.ID).order_by(
        models.TUVote.VoteID.desc(), models.User.Username.asc())
Kevin Morris's avatar
Kevin Morris committed
102
103
104
105
106
    context["last_votes_by_tu"] = last_votes_by_tu.all()

    context["current_by_next"] = "asc" if current_by == "desc" else "desc"
    context["past_by_next"] = "asc" if past_by == "desc" else "desc"

107
108
109
110
111
112
    context["q"] = {
        "coff": current_off,
        "cby": current_by,
        "poff": past_off,
        "pby": past_by
    }
Kevin Morris's avatar
Kevin Morris committed
113
114

    return render_template(request, "tu/index.html", context)
115
116
117
118
119


def render_proposal(request: Request,
                    context: dict,
                    proposal: int,
120
121
122
                    voteinfo: models.TUVoteInfo,
                    voters: typing.Iterable[models.User],
                    vote: models.TUVote,
123
124
125
126
                    status_code: HTTPStatus = HTTPStatus.OK):
    """ Render a single TU proposal. """
    context["proposal"] = proposal
    context["voteinfo"] = voteinfo
127
    context["voters"] = voters.all()
128
129
130
131
132
133
134
135
136

    participation = voteinfo.ActiveTUs / voteinfo.total_votes() \
        if voteinfo.total_votes() else 0
    context["participation"] = participation

    accepted = (voteinfo.Yes > voteinfo.ActiveTUs / 2) or \
        (participation > voteinfo.Quorum and voteinfo.Yes > voteinfo.No)
    context["accepted"] = accepted

137
    can_vote = voters.filter(models.TUVote.User == request.user).first() is None
138
139
140
141
142
143
144
145
146
147
148
149
150
    context["can_vote"] = can_vote

    if not voteinfo.is_running():
        context["error"] = "Voting is closed for this proposal."

    context["vote"] = vote
    context["has_voted"] = vote is not None

    return render_template(request, "tu/show.html", context,
                           status_code=status_code)


@router.get("/tu/{proposal}")
151
@auth_required(True, redirect="/tu/{proposal}")
152
153
154
155
156
@account_type_required(REQUIRED_TYPES)
async def trusted_user_proposal(request: Request, proposal: int):
    context = await make_variable_context(request, "Trusted User")
    proposal = int(proposal)

157
158
    voteinfo = db.query(models.TUVoteInfo).filter(
        models.TUVoteInfo.ID == proposal).first()
159
    if not voteinfo:
160
        raise HTTPException(status_code=HTTPStatus.NOT_FOUND)
161

162
163
164
165
166
    voters = db.query(models.User).join(models.TUVote).filter(
        models.TUVote.VoteID == voteinfo.ID)
    vote = db.query(models.TUVote).filter(
        and_(models.TUVote.UserID == request.user.ID,
             models.TUVote.VoteID == voteinfo.ID)).first()
167
168
169
170
171
172
173
174
175
176
177
178
179

    if not request.user.is_trusted_user():
        context["error"] = "Only Trusted Users are allowed to vote."
    elif voteinfo.User == request.user.Username:
        context["error"] = "You cannot vote in an proposal about you."
    elif vote is not None:
        context["error"] = "You've already voted for this proposal."

    context["vote"] = vote
    return render_proposal(request, context, proposal, voteinfo, voters, vote)


@router.post("/tu/{proposal}")
180
@auth_required(True, redirect="/tu/{proposal}")
181
182
183
184
185
186
187
@account_type_required(REQUIRED_TYPES)
async def trusted_user_proposal_post(request: Request,
                                     proposal: int,
                                     decision: str = Form(...)):
    context = await make_variable_context(request, "Trusted User")
    proposal = int(proposal)  # Make sure it's an int.

188
189
    voteinfo = db.query(models.TUVoteInfo).filter(
        models.TUVoteInfo.ID == proposal).first()
190
    if not voteinfo:
191
        raise HTTPException(status_code=HTTPStatus.NOT_FOUND)
192

193
194
195
196
197
    voters = db.query(models.User).join(models.TUVote).filter(
        models.TUVote.VoteID == voteinfo.ID)
    vote = db.query(models.TUVote).filter(
        and_(models.TUVote.UserID == request.user.ID,
             models.TUVote.VoteID == voteinfo.ID)).first()
198
199
200
201
202
203
204
205

    status_code = HTTPStatus.OK
    if not request.user.is_trusted_user():
        context["error"] = "Only Trusted Users are allowed to vote."
        status_code = HTTPStatus.UNAUTHORIZED
    elif voteinfo.User == request.user.Username:
        context["error"] = "You cannot vote in an proposal about you."
        status_code = HTTPStatus.BAD_REQUEST
206
    elif vote is not None:
207
208
209
210
211
212
213
214
215
216
217
218
219
        context["error"] = "You've already voted for this proposal."
        status_code = HTTPStatus.BAD_REQUEST

    if status_code != HTTPStatus.OK:
        return render_proposal(request, context, proposal,
                               voteinfo, voters, vote,
                               status_code=status_code)

    if decision in {"Yes", "No", "Abstain"}:
        # Increment whichever decision was given to us.
        setattr(voteinfo, decision, getattr(voteinfo, decision) + 1)
    else:
        return Response("Invalid 'decision' value.",
220
                        status_code=HTTPStatus.BAD_REQUEST)
221

222
    with db.begin():
223
        vote = db.create(models.TUVote, User=request.user, VoteInfo=voteinfo)
224
        voteinfo.ActiveTUs += 1
225
226
227

    context["error"] = "You've already voted for this proposal."
    return render_proposal(request, context, proposal, voteinfo, voters, vote)
228
229
230


@router.get("/addvote")
231
@auth_required(True, redirect="/addvote")
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
@account_type_required({"Trusted User", "Trusted User & Developer"})
async def trusted_user_addvote(request: Request,
                               user: str = str(),
                               type: str = "add_tu",
                               agenda: str = str()):
    context = await make_variable_context(request, "Add Proposal")

    if type not in ADDVOTE_SPECIFICS:
        context["error"] = "Invalid type."
        type = "add_tu"  # Default it.

    context["user"] = user
    context["type"] = type
    context["agenda"] = agenda

    return render_template(request, "addvote.html", context)


@router.post("/addvote")
251
@auth_required(True, redirect="/addvote")
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
@account_type_required({TRUSTED_USER, TRUSTED_USER_AND_DEV})
async def trusted_user_addvote_post(request: Request,
                                    user: str = Form(default=str()),
                                    type: str = Form(default=str()),
                                    agenda: str = Form(default=str())):
    # Build a context.
    context = await make_variable_context(request, "Add Proposal")

    context["type"] = type
    context["user"] = user
    context["agenda"] = agenda

    def render_addvote(context, status_code):
        """ Simplify render_template a bit for this test. """
        return render_template(request, "addvote.html", context, status_code)

    # Alright, get some database records, if we can.
    if type != "bylaws":
270
271
        user_record = db.query(models.User).filter(
            models.User.Username == user).first()
272
273
274
275
        if user_record is None:
            context["error"] = "Username does not exist."
            return render_addvote(context, HTTPStatus.NOT_FOUND)

276
277
        voteinfo = db.query(models.TUVoteInfo).filter(
            models.TUVoteInfo.User == user).count()
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
        if voteinfo:
            _ = l10n.get_translator_for_request(request)
            context["error"] = _(
                "%s already has proposal running for them.") % (
                html.escape(user),)
            return render_addvote(context, HTTPStatus.BAD_REQUEST)

    if type not in ADDVOTE_SPECIFICS:
        context["error"] = "Invalid type."
        context["type"] = type = "add_tu"  # Default for rendering.
        return render_addvote(context, HTTPStatus.BAD_REQUEST)

    if not agenda:
        context["error"] = "Proposal cannot be empty."
        return render_addvote(context, HTTPStatus.BAD_REQUEST)

    # Gather some mapped constants and the current timestamp.
    duration, quorum = ADDVOTE_SPECIFICS.get(type)
    timestamp = int(datetime.utcnow().timestamp())

298
    # TODO: Review this. Is this even necessary?
299
300
301
302
303
    # Remove <script> and <style> tags.
    agenda = re.sub(r'<[/]?script.*>', '', agenda)
    agenda = re.sub(r'<[/]?style.*>', '', agenda)

    # Create a new TUVoteInfo (proposal)!
304
    with db.begin():
305
        voteinfo = db.create(models.TUVoteInfo,
306
307
308
309
310
                             User=user,
                             Agenda=agenda,
                             Submitted=timestamp, End=timestamp + duration,
                             Quorum=quorum,
                             Submitter=request.user)
311
312
313

    # Redirect to the new proposal.
    return RedirectResponse(f"/tu/{voteinfo.ID}",
314
                            status_code=HTTPStatus.SEE_OTHER)