This repository has been archived by the owner on Jan 16, 2019. It is now read-only.
/
webserver.py
executable file
·503 lines (418 loc) · 16.4 KB
/
webserver.py
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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
""" The web-api server. """
import os
import re
from datetime import datetime
import signal
import sys
import pytz
from uuid import uuid4
from functools import wraps
from flask import Flask, request, session, url_for, redirect,\
render_template, abort, Response
from werkzeug import check_password_hash, generate_password_hash
from flask_limiter import Limiter
from cachemanager import CacheManager
from settingsmanager import SettingsManager as settings
from model.user import User
from model.status import Status
from model.shared import db
# Init the application
app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:////etc/microblog/microblog.db'
limiter = Limiter(app)
db.init_app(app)
app.debug = True
app.secret_key = settings.get('secret')
CacheManager(cache_location=settings.get('cache_location'))
if not app.debug:
import logging
from logging import FileHandler
file_handler = FileHandler('error.log')
file_handler.setLevel(logging.WARNING)
from logging import Formatter
file_handler.setFormatter(Formatter(
'%(asctime)s %(levelname)s: %(message)s '
'[in %(pathname)s:%(lineno)d]'))
app.logger.addHandler(file_handler)
for handler in app.logger.handlers:
limiter.logger.addHandler(handler)
def login_required(f):
@wraps(f)
def decorated_function(*args, **kwargs):
if 'user_id' not in session:
return redirect(url_for('get_login'))
return f(*args, **kwargs)
return decorated_function
def user_for_username(username):
for _, user_dict in settings.get('registered_users').iteritems():
if user_dict['username'] == username:
return user_dict
####################################################################
########################### URL Mappings ###########################
####################################################################
# Home
@app.route('/', methods=['GET'])
def home():
""" Shows the user's timeline or if no user is logged in it
will redirect to the user's public timeline (their most
recent posts) for public viewing. """
# Not logged in and multi-user mode.
if 'user_id' not in session and not settings.get('single_user_mode'):
return render_template('welcome.html')
# Not logged in and single-user mode.
elif 'user_id' not in session and settings.get('single_user_mode'):
user_id = settings.get('single_user_id')
username = settings.get_user(user_id)['username']
return redirect(url_for('get_user_profile', username=username))
# Logged in
elif 'user_id' in session:
user_id = session['user_id']
# Single-user mode, but no user yet.
elif settings.get('single_user_mode') and settings.get('single_user_id') is None:
return redirect(url_for('get_register'))
# Single-user mode, user exists.
else:
user_id = settings.get('single_user_id')
link = settings.get('registered_users').get(user_id).get('feed_location')
user = User(local_url=link)
posts = user.home_timeline()
auth = True if 'user_id' in session else False
return render_template('timeline.html', posts=posts, user=user,
page_type='timeline', auth=auth)
# Login/Registration
@app.route('/register', methods=['GET'])
def get_register():
""" Displays the reg page."""
if 'user_id' in session:
return redirect(url_for('home'))
elif settings.get('single_user_id') is not None:
return redirect(url_for('get_login'))
else:
return render_template('registration.html')
@app.route('/register', methods=['POST'])
def post_register():
""" Registers a new user. """
error = ''
user_full_name = request.form['full_name']
username = request.form['username']
password = request.form['password']
password_confirm = request.form['password_confirm']
email = request.form['email']
# User is already logged in.
if 'user_id' in session:
return redirect(url_for('home'))
# No more users can register.
elif settings.get('single_user_mode') \
and len(settings.get('registered_users')) > 0:
error = 'No more users can register at this time.'
# Username is alredy registered.
users = settings.get('registered_users')
username_taken = True if \
len([uid for uid, ud, in users.iteritems() if ud.get('username') == username]) > 0 \
else False
if username_taken:
return redirect(url_for('get_login'))
# Register the new user.
if username is None:
error = 'No username provided.'
elif len(username) < 8 or len(username) > 25:
error = 'Username is not the correct length. \
Please enter a username between 8-25 characters.'
elif re.search('[^a-zA-Z0-9\_]', username) is not None:
error = 'Usernames can only contain letters an numbers.'
elif re.search('\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}\b', email) is not None:
error = 'Please enter a valid email address.'
elif password is None or password_confirm is None:
error = 'You must fill in your password.'
elif password != request.form['password_confirm']:
error = 'Passwords do not match.'
elif len(password) < 8 or re.search('[a-zA-Z0-9]', password) is None:
error = 'Your password must be at least 8 characters long and \
must be a combination of numbers and letters. Special\
characters are allowed and encouraged.'
else:
new_user, feed_location, blocks_location, follows_location = User.create(username)
if settings.get('single_user_mode'):
settings.add('single_user_id', new_user.user_id)
domain = settings.get('domain')
new_user.profile = 'http://{0}/{1}'.format(domain, new_user.username)
new_user.link = 'http://{0}/{1}/feed.xml'.format(domain, new_user.username)
new_user.follows_url = 'http://{0}/{1}/follows.xml'.format(domain, new_user.username)
new_user.blocks_url = 'http://{0}/{1}/blocks.xml'.format(domain, new_user.username)
new_user.message_url = 'http://{0}/{1}/message.'.format(domain, new_user.username)
new_user.language = 'en'
# Update the settings.
pwd_hash = generate_password_hash(password)
settings.add_user(username=new_user.username,
pwd_hash=pwd_hash,
user_id=new_user.user_id,
feed_location=feed_location,
blocks_location=blocks_location,
follows_location=follows_location)
session['user_id'] = new_user.user_id
return redirect(url_for('home'))
return render_template('registration.html', error=error)
@app.route('/login', methods=['GET'])
def get_login():
""" Display the login page if they aren't already logged in. """
if 'user_id' in session:
return redirect(url_for('home'))
else:
return render_template('login.html', error='')
@app.route('/login', methods=['POST'])
def do_login():
""" Logs the user in. """
error = ''
username = request.form['username']
password = request.form['password']
username_and_ids = { ud['username']: uid for uid, ud in settings.get('registered_users').iteritems() }
if username not in username_and_ids.keys():
error = 'Invalid username'
pwd_hash = settings.get_user(username_and_ids[username]).get('pwd_hash')
if not check_password_hash(pwd_hash, password):
error = 'Invalid password'
else:
session['user_id'] = username_and_ids[username]
return redirect(url_for('home'))
return render_template('login.html', error=error)
@app.route('/logout', methods=['GET'])
@login_required
def logout():
""" Logs the user out. """
session.pop('user_id', None)
return redirect(url_for('home'))
# Account Management
# TODO This still doesn't work
@app.route('/account', methods=['GET'])
@login_required
def get_account():
""" Allows the user to make changes to their profile. """
user_id = session['user_id']
location = settings.get_user(user_id)['feed_location']
user = User(local_url=location)
return render_template('account.html', user=user)
@app.route('/account', methods=['POST'])
@login_required
def post_account():
# Flask apparently throws 400 errors if POST form data isn't present.
# Full name
user_id = session['user_id']
location = settings.get_user(user_id)['feed_location']
user = User(local_url=location)
if request.form.get('full_name_changed') == 'true':
user.full_name = request.form['full_name']
# Username
if request.form.get('username_changed') == 'true':
username= request.form['username']
if len(username) > 0:
user.username = username
# Bio
if request.form.get('bio_changed') == 'true':
user.description = request.form['bio']
# Email
if request.form.get('email_changed') == 'true':
email = request.form['email']
user_dict = settings.get_user(user_id)
user_dict['email'] = email
settings.add_user(user_dict)
# Password
if request.form.get('password_changed') == 'true':
password = request.form['password']
password_confirm = request.form['password_confirm']
if password == password_confirm:
user_dict = settings.get_user(user_id)
user_dict['pwd_hash'] = generate_password_hash(password)
settings.add_user(user_dict)
# Language
if request.form.get('language_changed') == 'true':
user.language = request.form['language']
return render_template('account.html', user=user, error='Your settings have been saved.')
# Browsing
@app.route('/<username>', methods=['GET'])
def get_user_profile(username):
""" Get the profile of the given user."""
user = None
user_dict = user_for_username(username)
if user_dict is not None:
user = User(local_url=user_dict['feed_location'])
else:
# User is remote.
# TODO
pass
auth = True if 'user_id' in session else False
return render_template('profile.html', user=user, posts=user.user_timeline(),
page_type='profile', auth=auth)
@app.route('/<username>/follows', methods=['GET'])
def get_user_follows(username):
""" Display a list of the users that a given user follows. """
user = None
user_dict = user_for_username(username)
if user_dict is not None:
user = User(local_url=user_dict['feed_location'])
else:
# User is remote.
# TODO
pass
auth = True if 'user_id' in session else False
return render_template('follows.html', user=user, follows=user.follows,
page_type='following', auth=auth)
@app.route('/<username>/blocks', methods=['GET'])
def get_user_blocks(username):
""" Display a list of the users that a given user has blocked. """
user = None
user_dict = user_for_username(username)
if user_dict is not None:
user = User(local_url=user_dict['feed_location'])
else:
# User is remote.
# TODO
pass
auth = True if 'user_id' in session else False
return render_template('blocks.html', user=user, blocks=user.blocks,
page_type='blocking', auth=auth)
@app.route('/<username>/status/<status_id>', methods=['GET'])
@login_required
def get_user_status(username, status_id):
""" Get a given status by a given user. """
user = None
user_dict = user_for_username(username)
if user_dict is not None:
user = User(local_url=user_dict['feed_location'])
else:
# TODO
pass
posts = user.user_timeline()
posts = [post for post in posts if post.guid == status_id]
if len(posts) > 0:
post = posts[0]
return render_template('individual_post.html', user=user, status=post)
else:
# TODO 404
pass
@app.route('/<username>/status/<status_id>/reply', methods=['POST'])
def post_reply(username, status_id):
""" Accepts incoming replies on behalf of users and queues them.
Returns 201 if created properly, or 403 if not allowed.
"""
# TODO
pass
# Private Messages
@app.route('/<username>/message', methods=['GET'])
def get_messages():
""" Retrieves the list of private messages for a given user.
If the user in question is not logged in, returns 401.
"""
# TODO
pass
@app.route('/<username>/message', methods=['POST'])
def post_messages():
""" Accepts incoming messages from the public on behalf of
a user. Adds those messages to the database and returns 201
if accepted, or 403 if not allowed.
"""
# TODO
pass
# Status and Profile Handlers
# TODO REFACTOR
@app.route('/add_status', methods=['POST'])
@login_required
@limiter.limit('100 per 15 minute')
def post_status():
""" Adds a new post to the feed. """
form = request.form
status = Status()
status.description = form['status_text']
# Reply or Repost
repost = form.get('repost')
reply = form.get('reply')
if repost or reply:
status.reposted_user_id = form['user_id']
status.reposted_user_link = form['user_link']
if repost:
status.reposted_status_id = form['status_id']
status.reposted_status_pubdate = form['status_pubdate']
my_user_id = session['user_id']
my_user_dict = settings.get_user(my_user_id)
user = User(local_url=my_user_dict['feed_location'])
guid = uuid4().hex[-12:]
reply_url = '{0}/status/{1}/reply'.format(user.profile, guid)
status = Status({
'description': status_text,
'pubdate': datetime.now(pytz.UTC),
'guid': guid,
'reply': reply_url
})
user.add_post(status)
return redirect(url_for('home'))
@app.route('/follow', methods=['POST'])
@login_required
@limiter.limit('50 per 15 minutes')
def post_follow():
""" Adds a new follow to the user's list. """
user_link = request.form['follow-url']
if user_link != '':
user_id = session.get('user_id')
user_dict = settings.get_user(user_id)
user = User(local_url=user_dict['feed_location'])
user.follow(user_link=user_link)
return redirect(url_for('home'))
@app.route('/unfollow', methods=['POST'])
@login_required
@limiter.limit('50 per 15 minutes')
def post_unfollow():
""" Unfollows a given user. """
user_link = request.form['user_link']
username = request.form['username']
user_id = request.form['user_id']
my_user_id = session.get('user_id')
user_dict = settings.get_user(my_user_id)
user = User(local_url=user_dict['feed_location'])
user.unfollow(user_link=user_link, user_name=username, user_id=user_id)
return redirect(url_for('home'))
@app.route('/block', methods=['POST'])
@login_required
@limiter.limit('50 per 15 minutes')
def post_block():
""" Adds a new follow to the user's list. """
user_link = request.form['follow-url']
if user_link != '':
user_id = session.get('user_id')
user_dict = settings.get_user(user_id)
user = User(local_url=user_dict['feed_location'])
user.block(user_link=user_link)
return redirect(url_for('home'))
@app.route('/unblock', methods=['POST'])
@login_required
@limiter.limit('50 per 15 minutes')
def post_unblock():
""" Unfollows a given user. """
user_link = request.form['user_link']
username = request.form['username']
user_id = request.form['user_id']
my_user_id = session.get('user_id')
user_dict = settings.get_user(my_user_id)
user = User(local_url=user_dict['feed_location'])
user.unblock(user_link=user_link, user_name=username, user_id=user_id)
return redirect(url_for('home'))
# XML File Getters
@app.route('/<username>/feed.xml', methods=['GET'])
def feed(username):
""" This just returns the user's XML feed. """
location = user_for_username(username)['feed_location']
with open(location) as f:
return Response(f.read(), mimetype='text/xml')
@app.route('/<username>/blocks.xml', methods=['GET'])
def blocks(username):
""" Returns the user's block list. """
location = user_for_username(username)['blocks_location']
with open(location) as f:
return Response(f.read(), mimetype='text/xml')
@app.route('/<username>/follows.xml', methods=['GET'])
def follows(username):
""" Returns the user's block list. """
location = user_for_username(username)['follows_location']
with open(location) as f:
return Response(f.read(), mimetype='text/xml')
if __name__ == '__main__':
# Start up the app
app.run(threaded=True)