This repository was archived by the owner on Feb 3, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 19
Expand file tree
/
Copy path__init__.py
More file actions
387 lines (339 loc) · 12.2 KB
/
__init__.py
File metadata and controls
387 lines (339 loc) · 12.2 KB
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
"""
File name: __init__.py
Author: Nicholas Mercadante
Contributors: Devin Matte, Max Meinhold, Joe Abbate
"""
import os
import subprocess
from datetime import datetime
import requests
from flask import Flask, render_template, request, flash, session, make_response, abort, redirect
from flask_migrate import Migrate
from flask_pyoidc.flask_pyoidc import OIDCAuthentication
from flask_sqlalchemy import SQLAlchemy
from sqlalchemy import func
app = Flask(__name__)
# look for a config file to associate with a db/port/ip/servername
if os.path.exists(os.path.join(os.getcwd(), "config.py")):
app.config.from_pyfile(os.path.join(os.getcwd(), "config.py"))
else:
app.config.from_pyfile(os.path.join(os.getcwd(), "config.env.py"))
#var representing the quote database the app is connected to
db = SQLAlchemy(app)
migrate = Migrate(app, db)
app.logger.info('SQLAlchemy pointed at ' + repr(db.engine.url))
# Disable SSL certificate verification warning
requests.packages.urllib3.disable_warnings()
# Disable SQLAlchemy modification tracking
app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
auth = OIDCAuthentication(app,
issuer=app.config['OIDC_ISSUER'],
client_registration_info=app.config['OIDC_CLIENT_CONFIG'])
app.secret_key = 'submission' # allows message flashing, var not actually used
from .ldap import get_all_members, is_member_of_group
from .mail import send_quote_notification_email, send_report_email
from .models import Quote, Vote, Report
def get_metadata():
"""
Provide metadata to page
UUID, UID, Git Version, Plug, and admin permissions obtained
"""
uuid = str(session["userinfo"].get("sub", ""))
uid = str(session["userinfo"].get("preferred_username", ""))
version = subprocess.check_output(
['git', 'rev-parse', '--short', 'HEAD']
).decode('utf-8').rstrip()
plug = request.cookies.get('plug')
metadata = {
"uuid": uuid,
"uid": uid,
"version": version,
"plug": plug,
"is_admin" : is_member_of_group(uid, 'eboard') or is_member_of_group(uid, 'rtp')
}
return metadata
@app.route('/', methods=['GET'])
@auth.oidc_auth
def main():
"""
Root Website, presents submission page
"""
metadata = get_metadata()
all_members = get_all_members()
return render_template('bootstrap/main.html', metadata=metadata, all_members=all_members)
@app.route('/settings', methods=['GET'])
@auth.oidc_auth
def settings():
"""
Presents settings page
"""
metadata = get_metadata()
return render_template('bootstrap/settings.html', metadata=metadata)
@app.route('/vote', methods=['POST'])
@auth.oidc_auth
def make_vote():
"""
Called by JS to add vote to DB
"""
# submitter will grab UN from OIDC when linked to it
submitter = session['userinfo'].get('preferred_username', '')
quote = request.form['quote_id']
direction = request.form['direction']
existing_vote = Vote.query.filter_by(voter=submitter, quote_id=quote).first()
if existing_vote is None:
vote = Vote(quote, submitter, direction)
db.session.add(vote)
db.session.commit()
return '200'
if existing_vote.direction != direction:
existing_vote.direction = direction
existing_vote.updated_time = datetime.now()
db.session.commit()
return '200'
return '201'
@app.route('/settings', methods=['POST'])
@auth.oidc_auth
def update_settings():
"""
Update settings from settings page
"""
metadata = get_metadata()
resp = make_response(render_template('bootstrap/settings.html', metadata=metadata))
if request.form['plug'] == "off":
resp.set_cookie('plug', 'False')
else:
resp.set_cookie('plug', 'True', expires=0)
return resp
# run when the form submission button is clicked
@app.route('/submit', methods=['POST'])
@auth.oidc_auth
def submit():
"""
Submit quote from main page, add to DB
"""
#submitter will grab UN from OIDC when linked to it
submitter = session['userinfo'].get('preferred_username', '')
metadata = get_metadata()
all_members = get_all_members()
quote = request.form['quoteString']
# standardises quotes and validates input
quote = quote.strip("""'"\t\n """)
speaker = request.form['nameString']
# check for quote duplicate
quote_check = Quote.query.filter(Quote.quote == quote).first()
# checks for empty quote or submitter
if quote == '' or speaker == '':
flash('Empty quote or speaker field, try again!', 'error')
return render_template(
'bootstrap/main.html',
metadata=metadata,
all_members=all_members
), 200
if submitter == speaker:
flash('You can\'t quote yourself! Come on', 'error')
return render_template(
'bootstrap/main.html',
metadata=metadata,
all_members=all_members
), 200
if quote_check is None: # no duplicate quotes, proceed with submission
# create a row for the Quote table
new_quote = Quote(submitter=submitter, quote=quote, speaker=speaker)
db.session.add(new_quote)
db.session.flush()
# upload the quote
db.session.commit()
# Send email to person quoted
if app.config['MAIL_SERVER'] != '':
send_quote_notification_email(speaker)
# create a message to flash for successful submission
flash('Submission Successful!')
# return something to complete submission
return render_template(
'bootstrap/main.html',
metadata=metadata,
all_members=all_members
), 200
# duplicate quote found, bounce the user back to square one
flash('Quote already submitted!', 'warning')
return render_template(
'bootstrap/main.html',
metadata=metadata,
all_members=all_members
), 200
def get_quote_query(speaker: str = "", submitter: str = "", include_hidden: bool = False):
"""Return a query based on the args, with vote count attached to the quotes"""
# Get all the quotes with their votes
quote_query = db.session.query(Quote,
func.sum(Vote.direction).label('votes')).outerjoin(Vote).group_by(Quote)
# Put the most recent first
quote_query = quote_query.order_by(Quote.id.desc())
# Filter hidden quotes
if not include_hidden:
quote_query = quote_query.filter(Quote.hidden == False)
# Filter by speaker and submitter, if applicable
if request.args.get('speaker'):
quote_query = quote_query.filter(Quote.speaker == request.args.get('speaker'))
if request.args.get('submitter'):
quote_query = quote_query.filter(Quote.submitter == request.args.get('submitter'))
return quote_query
# display first 20 stored quotes
@app.route('/storage', methods=['GET'])
@auth.oidc_auth
def default_get():
return redirect("/storage/1")
# display first 20 stored quotes
@app.route('/storage/<page>', methods=['GET'])
@auth.oidc_auth
def get(page):
"""
Show submitted quotes, only showing first 20 initially
"""
metadata = get_metadata()
page = int(page)
query = get_quote_query(speaker = request.args.get('speaker'),
submitter = request.args.get('submitter'))
rows = query.count()
rows = int(rows//20 + bool(rows%20 > 0))
if page > rows or page < 1:
return "Page Out of Bounds", 404
# Get the most recent 20 quotes
quotes = query.offset((page-1)*20).limit(20).all()
#tie any votes the user has made to their uid
user_votes = Vote.query.filter(Vote.voter == metadata['uid']).all()
return render_template(
'bootstrap/storage.html',
quotes=quotes,
metadata=metadata,
user_votes=user_votes,
page=page,
rows=rows,
begin=max(1, page-6),
end=min(page+6, rows) + 1
)
@app.route('/report/<quote_id>', methods=['POST'])
@auth.oidc_auth
def submit_report(quote_id):
"""
Report a quote and notify EBoard/RTP
"""
metadata = get_metadata()
existing_report = Report.query.filter(Report.reporter==metadata['uid'],
Report.quote_id==quote_id).first()
if existing_report:
flash("You already submitted a report for this Quote!")
return redirect('/storage')
new_report = Report(quote_id, metadata['uid'], "Report Reason Not Given")
db.session.add(new_report)
db.session.commit()
if app.config['MAIL_SERVER'] != '':
send_report_email( metadata['uid'], Quote.query.get(quote_id) )
flash("Report Successful!")
return redirect('/storage')
@app.route('/review', methods=['GET'])
@auth.oidc_auth
def review():
"""
Presents page for admins to review reports
and either hide or keep quote
"""
metadata = get_metadata()
if metadata['is_admin']:
# Get all outstanding reports
reports = Report.query.filter(Report.reviewed == False).all()
return render_template(
'bootstrap/admin.html',
reports=reports,
metadata=metadata
)
abort(403)
@app.route('/review/<report_id>/<result>', methods=['POST'])
@auth.oidc_auth
def review_submit(report_id, result):
"""
Called when Admin decides on a quote being hidden or kept
"""
metadata = get_metadata()
report = Report.query.get(report_id)
if not metadata['is_admin']:
abort(403)
if not report:
abort(404)
if report.reviewed:
abort(404)
if result == "keep":
report.reviewed = True
db.session.commit()
flash("Report Completed: Quote Kept")
elif result == "hide":
report.quote.hidden = True
report.reviewed = True
db.session.commit()
flash("Report Completed: Quote Hidden")
else:
abort(400)
return redirect('/review')
@app.route('/hide/<quote_id>', methods=['POST'])
@auth.oidc_auth
def hide(quote_id):
"""
Hides a quote
"""
metadata = get_metadata()
quote = Quote.query.get(quote_id)
if not (metadata['uid'] == quote.submitter or metadata['uid'] == quote.speaker or metadata['is_admin']):
abort(403)
if not quote:
abort(404)
quote.hidden = True
db.session.commit()
flash("Quote Hidden!")
return redirect('/storage')
@app.route('/unhide/<quote_id>', methods=['POST'])
@auth.oidc_auth
def unhide(quote_id):
"""
Gives admins power to unhide a hidden quote
"""
metadata = get_metadata()
quote = Quote.query.get(quote_id)
if not metadata['is_admin']:
abort(403)
if not quote:
abort(404)
quote.hidden = False
db.session.commit()
flash("Quote Unhidden!")
return redirect('/hidden')
@app.route('/hidden', methods=['GET'])
@auth.oidc_auth
def hidden():
"""
Presents hidden quotes to qualified users
Users who submitted a hidden quote or were quoted in a hidden quote will see those only
Admins see all hidden quotes
"""
metadata = get_metadata()
if metadata['is_admin']:
quotes = get_quote_query(include_hidden=True).filter( Quote.hidden ).all()
else:
quotes = get_quote_query(include_hidden=True).filter(
(Quote.speaker == metadata['uid']) | (Quote.submitter == metadata['uid'] )
).filter( Quote.hidden ).all()
return render_template(
'bootstrap/hidden.html',
quotes=quotes,
metadata=metadata
)
@app.errorhandler(403)
def forbidden(e):
return render_template('bootstrap/403.html', metadata=get_metadata()), 403
@app.errorhandler(404)
def forbidden(e):
return render_template('bootstrap/404.html', metadata=get_metadata()), 404
@app.errorhandler(400)
def forbidden(e):
return render_template('bootstrap/400.html', metadata=get_metadata()), 400
@app.errorhandler(409)
def forbidden(e):
return render_template('bootstrap/409.html', metadata=get_metadata()), 409