views.py 22 KB
Newer Older
1 2 3 4
"""
go/views.py
"""

5
# Future Imports
David Haynes's avatar
David Haynes committed
6 7
from __future__ import (absolute_import, division, print_function,
                        unicode_literals)
8

David Haynes's avatar
David Haynes committed
9 10 11
# Python stdlib imports
from datetime import timedelta

12
# Django Imports
13
from django.conf import settings
David Haynes's avatar
David Haynes committed
14 15 16 17
from django.contrib.auth import REDIRECT_FIELD_NAME
from django.contrib.auth.decorators import login_required, user_passes_test
from django.core.exceptions import PermissionDenied  # ValidationError
from django.core.mail import EmailMessage, send_mail
18
from django.http import HttpResponseServerError  # Http404
19
from django.http import HttpResponseRedirect
David Haynes's avatar
David Haynes committed
20
from django.shortcuts import get_object_or_404, redirect, render
21
from django.utils import timezone
David Haynes's avatar
David Haynes committed
22 23

# Other imports
24
from ratelimit.decorators import ratelimit
25

26
# App Imports
David Haynes's avatar
David Haynes committed
27
from go.forms import SignupForm, URLForm
28
from go.models import URL, RegisteredUser
David Haynes's avatar
David Haynes committed
29

30

David Haynes's avatar
David Haynes committed
31
def index(request):
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
    """
    If a user is logged in, this view displays all the information about all
    of their URLs. Otherwise, it will show the public landing page
    """

    # If the user is not authenticated, show them a public landing page.
    if not request.user.is_authenticated():
        return render(request, 'public_landing.html')
    # Do not display this page to unapproved users
    if not request.user.registereduser.approved:
        return render(request, 'not_registered.html')

    # Get the current domain info
    domain = "%s://%s" % (request.scheme, request.META.get('HTTP_HOST')) + "/"

    # Grab a list of all the URL's that are currently owned by the user
    urls = URL.objects.filter(owner=request.user.registereduser)

50
    # Render my_links passing the list of URL's and Domain to the template
51 52 53 54
    return render(request, 'core/index.html', {
        'urls': urls,
        'domain': domain,
    })
Jean Michel Rouly's avatar
Jean Michel Rouly committed
55

56
@login_required
Zach Knox's avatar
Zach Knox committed
57
def new_link(request):
58
    """
David Haynes's avatar
David Haynes committed
59
    This view handles the homepage that the user is presented with when
60
    they request '/newLink'. If they're not logged in, they're redirected to
David Haynes's avatar
David Haynes committed
61 62 63
    login. If they're logged in but not registered, they're given the
    not_registered error page. If they are logged in AND registered, they
    get the URL registration form.
64 65
    """

David Haynes's avatar
David Haynes committed
66
    # If the user isn't approved, then display the you're not approved page.
67
    if not request.user.registereduser.approved:
68
        if request.user.registereduser.blocked:
Zosman's avatar
Zosman committed
69
            return render(request, 'banned.html')
70
        else:
Zosman's avatar
Zosman committed
71
            return render(request, 'not_registered.html')
72

73

David Haynes's avatar
David Haynes committed
74
    # Initialize a URL form
75
    url_form = URLForm(host=request.META.get('HTTP_HOST'))  # unbound form
76

David Haynes's avatar
David Haynes committed
77 78
    # If a POST request is received, then the user has submitted a form and it's
    # time to parse the form and create a new URL object
79
    if request.method == 'POST':
80 81
        # Now we initialize the form again but this time we have the POST
        # request
82
        url_form = URLForm(request.POST, host=request.META.get('HTTP_HOST'))
83 84 85

        # Django will check the form to make sure it's valid
        if url_form.is_valid():
86
            # Call our post method to assemble our new URL object
87
            res = post(request, url_form)
88

89 90
            # If there is a 500 error returned, handle it
            if res == 500:
91
                return HttpResponseServerError(render(request, '500.html'))
92

93
            # Redirect to the shiny new URL
94
            return redirect('view', res.short)
95

96 97 98
        # Else, there is an error, redisplay the form with the validation errors
        else:
            # Render index.html passing the form to the template
99
            return render(request, 'core/new_link.html', {
100
                'form': url_form,
101
            })
102

103

David Haynes's avatar
David Haynes committed
104
    # Render index.html passing the form to the template
Zach Knox's avatar
Zach Knox committed
105
    return render(request, 'core/new_link.html', {
106
        'form': url_form,
107
    })
Jean Michel Rouly's avatar
Jean Michel Rouly committed
108

109
@login_required
Zach Knox's avatar
Zach Knox committed
110
def my_links(request):
111 112 113 114 115 116 117 118 119 120
    """
    for compatibility, just in case
    shows the same thing as /, but requires login to be consistent with
    /newLink
    """
    if not request.user.registereduser.approved:
        if request.user.registereduser.blocked:
            return render(request, 'banned.html')
        else:
            return render(request, 'not_registered.html')
Zach Knox's avatar
Zach Knox committed
121 122
    return index(request)

David Haynes's avatar
David Haynes committed
123
# Rate limits are completely arbitrary
124 125
@ratelimit(key='user', rate='3/m', method='POST', block=True)
@ratelimit(key='user', rate='25/d', method='POST', block=True)
126
def post(request, url_form):
127
    """
128
    Helper function that handles POST requests for the URL creation
129 130
    """

131 132
    # We don't commit the url object yet because we need to add its
    # owner, and parse its date field.
133
    url = url_form.save(commit=False)
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
    url.owner = request.user.registereduser

    # If the user entered a short url, it's already been validated,
    # so accept it. If they did not, however, then generate a
    # random one and use that instead.
    short = url_form.cleaned_data.get('short').strip()

    # Check if a short URL was entered
    if len(short) > 0:
        url.short = short
    else:
        # If the user didn't enter a short url, generate a random
        # one. However, if a random one can't be generated, return
        # a 500 server error.
        random_short = URL.generate_valid_short()

        if random_short is None:
            return 500
152
        else:
153 154 155 156 157 158 159 160 161
            url.short = random_short

    # Grab the expiration field value. It's currently an unsable
    # string value, so we need to parse it into a datetime object
    # relative to right now.
    expires = url_form.cleaned_data.get('expires')

    # Determine what the expiration date is
    if expires == URLForm.DAY:
162
        url.expires = timezone.now() + timedelta(days=1)
163
    elif expires == URLForm.WEEK:
164
        url.expires = timezone.now() + timedelta(weeks=1)
165
    elif expires == URLForm.MONTH:
166
        url.expires = timezone.now() + timedelta(weeks=3)
167 168 169 170 171 172 173 174 175 176
    elif expires == URLForm.CUSTOM:
        url.expires = url_form.cleaned_data.get('expires_custom')
    else:
        pass  # leave the field NULL

    # Make sure that our new URL object is clean, then save it and
    # let's redirect to view this baby.
    url.full_clean()
    url.save()
    return url
177

David Haynes's avatar
David Haynes committed
178
def view(request, short):
179
    """
180 181
    This view allows the user to "view details" about a URL. Note that they
    do not need to be logged in to view this information.
182
    """
Jean Michel Rouly's avatar
Jean Michel Rouly committed
183

David Haynes's avatar
David Haynes committed
184
    # Get the current domain info
Nicholas Anderson's avatar
Nicholas Anderson committed
185
    domain = "%s://%s" % (request.scheme, request.META.get('HTTP_HOST')) + "/"
186

David Haynes's avatar
David Haynes committed
187
    # Get the URL that is being requested
188
    url = get_object_or_404(URL, short__iexact=short)
189

David Haynes's avatar
David Haynes committed
190
    # Render view.html passing the specified URL and Domain to the template
Jean Michel Rouly's avatar
Jean Michel Rouly committed
191
    return render(request, 'view.html', {
192
        'url': url,
193
        'domain': domain,
194
    })
195

David Haynes's avatar
David Haynes committed
196 197 198 199 200 201 202 203 204 205
@login_required
def edit(request, short):
    """
    This view allows a logged in user to edit the details of a Go link that they
    own. They can modify any value that they wish. If `short` is modified then
    we will need to create a new link and copy over stats from the previous.
    """

    # Do not allow unapproved users to edit links
    if not request.user.registereduser.approved:
David Haynes's avatar
David Haynes committed
206 207 208 209 210
        if request.user.registereduser.blocked:
            return render(request, 'banned.html')
        else:
            return render(request, 'not_registered.html')

David Haynes's avatar
David Haynes committed
211 212 213 214 215 216

    # Get the URL that is going to be edited
    url = get_object_or_404(URL, short__iexact=short)

    # If the RegisteredUser is the owner of the URL
    if url.owner == request.user.registereduser:
217

218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
        # If a POST request is received, then the user has submitted a form and it's
        # time to parse the form and edit that URL object
        if request.method == 'POST':
            # Now we initialize the form again but this time we have the POST
            # request
            url_form = URLForm(request.POST, host=request.META.get('HTTP_HOST'))

            # Django will check the form to make sure it's valid
            if url_form.is_valid():
                return redirect('view', None)

            # Else, there is an error, redisplay the form with the validation errors
            else:
                # Render index.html passing the form to the template
                return render(request, 'core/edit_link.html', {
                    'form': url_form
                })
        else:
David Haynes's avatar
David Haynes committed
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
            # Initial data set here
            if url.expires != None:
                # Initialize a URL form with an expire date
                url_form = URLForm(host=request.META.get('HTTP_HOST'), initial={
                    'target': url.target,
                    'short': url.short,
                    'expires': 'Custom Date',
                    'expires_custom': url.expires
                })  # unbound form
            else:
                # Initialize a URL form without an expire date
                url_form = URLForm(host=request.META.get('HTTP_HOST'), initial={
                    'target': url.target,
                    'short': url.short,
                    'expires': 'Never',
                })  # unbound form

253 254 255 256
            # Render index.html passing the form to the template
            return render(request, 'core/edit_link.html', {
                'form': url_form
            })
257

David Haynes's avatar
David Haynes committed
258
        # redirect to my_links
259
        # return redirect('my_links')
David Haynes's avatar
David Haynes committed
260 261 262 263
    else:
        # do not allow them to edit
        raise PermissionDenied()

David Haynes's avatar
David Haynes committed
264 265
@login_required
def delete(request, short):
266
    """
David Haynes's avatar
David Haynes committed
267 268
    This view deletes a URL if you have the permission to. User must be
    logged in and registered, and must also be the owner of the URL.
269
    """
Jean Michel Rouly's avatar
Jean Michel Rouly committed
270

David Haynes's avatar
David Haynes committed
271
    # Do not allow unapproved users to delete links
272
    if not request.user.registereduser.approved:
273
        return render(request, 'not_registered.html')
Jean Michel Rouly's avatar
Jean Michel Rouly committed
274

David Haynes's avatar
David Haynes committed
275
    # Get the URL that is going to be deleted
276
    url = get_object_or_404(URL, short__iexact=short)
David Haynes's avatar
David Haynes committed
277 278

    # If the RegisteredUser is the owner of the URL
279
    if url.owner == request.user.registereduser:
David Haynes's avatar
David Haynes committed
280
        # remove the URL
281
        url.delete()
David Haynes's avatar
David Haynes committed
282
        # redirect to my_links
283 284
        return redirect('my_links')
    else:
David Haynes's avatar
David Haynes committed
285
        # do not allow them to delete
286
        raise PermissionDenied()
287

288
@login_required
Jean Michel Rouly's avatar
Jean Michel Rouly committed
289
def signup(request):
290
    """
291 292
    This view presents the user with a registration form. You can register
    yourself.
293 294
    """

295
    # Do not display signup page to registered or approved users
296
    if request.user.registereduser.blocked:
297
        return render(request, 'banned.html')
298
    elif request.user.registereduser.approved:
David Haynes's avatar
David Haynes committed
299
        return redirect('/')
300
    elif request.user.registereduser.registered:
David Haynes's avatar
David Haynes committed
301
        return redirect('registered')
302

David Haynes's avatar
David Haynes committed
303
    # Initialize our signup form
304 305 306 307 308 309
    signup_form = SignupForm(
        request,
        initial={
            'full_name': request.user.first_name + " " + request.user.last_name
        }
    )
David Haynes's avatar
David Haynes committed
310 311

    # Set the full_name field to readonly since CAS will fill that in for them
312
    signup_form.fields['full_name'].widget.attrs['readonly'] = 'readonly'
Jean Michel Rouly's avatar
Jean Michel Rouly committed
313

David Haynes's avatar
David Haynes committed
314 315
    # If a POST request is received, then the user has submitted a form and it's
    # time to parse the form and create a new RegisteredUser
Jean Michel Rouly's avatar
Jean Michel Rouly committed
316
    if request.method == 'POST':
David Haynes's avatar
David Haynes committed
317 318
        # Now we initialize the form again but this time we have the POST
        # request
319 320 321 322 323 324
        signup_form = SignupForm(
            request, request.POST, instance=request.user.registereduser,
            initial={
                'full_name': request.user.first_name + " " + request.user.last_name
            }
        )
David Haynes's avatar
David Haynes committed
325 326

        # set the readonly flag again for good measure
327
        signup_form.fields['full_name'].widget.attrs['readonly'] = 'readonly'
328

David Haynes's avatar
David Haynes committed
329
        # Django will check the form to make sure it's valid
330
        if signup_form.is_valid():
David Haynes's avatar
David Haynes committed
331
            # Grab data from the form and store into variables
332
            description = signup_form.cleaned_data.get('description')
333
            full_name = signup_form.cleaned_data.get('full_name')
334
            organization = signup_form.cleaned_data.get('organization')
335

336 337
            # Only send mail if we've defined the mailserver
            if settings.EMAIL_HOST and settings.EMAIL_PORT:
root's avatar
root committed
338
                user_mail = request.user.username + settings.EMAIL_DOMAIN
339
                # Email sent to notify Admins
340
                to_admin = EmailMessage(
341
                    'Signup from %s' % (request.user.registereduser.user),
342 343 344 345 346
                    ######################
                    '%s signed up at %s\n\n'
                    'Username: %s\n'
                    'Organization: %s\n\n'
                    'Message: %s\n\n'
347 348
                    'You can contact the user directly by replying to this email or '
                    'reply all to contact the user and notfiy the mailing list.\n'
349 350
                    'Please head to go.gmu.edu/useradmin to approve or '
                    'deny this application.'
351 352 353 354 355
                    %(
                        str(full_name), str(timezone.now()).strip(),
                        str(request.user.registereduser.user), str(organization),
                        str(description)
                    ),
356 357
                    ######################
                    settings.EMAIL_FROM,
358
                    [settings.EMAIL_TO],
359 360 361
                    reply_to=[user_mail]
                )
                to_admin.send()
362
                # Confirmation email sent to Users
363
                send_mail(
364 365 366 367 368 369 370 371 372 373 374 375 376
                    'We have received your Go application!',
                    ######################
                    'Hey there %s,\n\n'
                    'The Go admins have received your application and are '
                    'currently in the process of reviewing it.\n\n'
                    'You will receive another email when you have been '
                    'approved.\n\n'
                    '- Go Admins'
                    % (str(full_name)),
                    ######################
                    settings.EMAIL_FROM,
                    [user_mail]
                )
377

David Haynes's avatar
David Haynes committed
378 379
            # Make sure that our new RegisteredUser object is clean, then save
            # it and let's redirect to tell the user they have registered.
380
            signup_form.save()
381
            return redirect('registered')
Jean Michel Rouly's avatar
Jean Michel Rouly committed
382

David Haynes's avatar
David Haynes committed
383 384
    # render signup.html passing along the form and the current registered
    # status
385
    return render(request, 'core/signup.html', {
386
        'form': signup_form,
387
        'registered': False,
388
    })
Jean Michel Rouly's avatar
Jean Michel Rouly committed
389

David Haynes's avatar
David Haynes committed
390
def redirection(request, short):
391
    """
David Haynes's avatar
David Haynes committed
392
    This view redirects a user based on the short URL they requested.
393
    """
Jean Michel Rouly's avatar
Jean Michel Rouly committed
394

David Haynes's avatar
David Haynes committed
395 396
    # Get the current domain info
    domain = "%s://%s" % (request.scheme, request.META.get('HTTP_HOST')) + "/"
Jean Michel Rouly's avatar
Jean Michel Rouly committed
397

David Haynes's avatar
David Haynes committed
398
    # Get the URL object that relates to the requested Go link
399
    url = get_object_or_404(URL, short__iexact=short)
David Haynes's avatar
David Haynes committed
400 401
    # Increment our clicks by one
    url.clicks += 1
402

David Haynes's avatar
David Haynes committed
403
    # If the user is trying to make a Go link to itself, we 404 them
404
    if url.target == domain + short:
405
        return redirect('404.html')
406

David Haynes's avatar
David Haynes committed
407
    # If the user is coming from a QR request then increment qrclicks
408 409 410
    if 'qr' in request.GET:
        url.qrclicks += 1

David Haynes's avatar
David Haynes committed
411
    # If the user is coming from a social media request then increment qrclicks
412 413 414
    if 'social' in request.GET:
        url.socialclicks += 1

David Haynes's avatar
David Haynes committed
415
    # Save our data and redirect the user towards thier destination
Jean Michel Rouly's avatar
Jean Michel Rouly committed
416
    url.save()
417
    return redirect(url.target)
Jean Michel Rouly's avatar
Jean Michel Rouly committed
418

419 420
def staff_member_required(view_func, redirect_field_name=REDIRECT_FIELD_NAME, login_url='/'):
    """
David Haynes's avatar
David Haynes committed
421 422
    Decorator function for views that checks that the user is logged in and is
    a staff member, displaying the login page if necessary.
423 424
    """

425 426
    return user_passes_test(
        lambda u: u.is_active and u.is_staff,
427 428
        login_url=login_url,
        redirect_field_name=redirect_field_name
429 430
    )(view_func)

David Haynes's avatar
David Haynes committed
431 432
@staff_member_required
def useradmin(request):
433
    """
David Haynes's avatar
David Haynes committed
434 435
    This view is a simplified admin panel, so that staff don't need to log in
    to approve links
436
    """
David Haynes's avatar
David Haynes committed
437 438

    # If we receive a POST request
439
    if request.POST:
David Haynes's avatar
David Haynes committed
440
        # Get a list of the potential victims (users)
441
        userlist = request.POST.getlist('username')
David Haynes's avatar
David Haynes committed
442
        # If we're approving users
443
        if '_approve' in request.POST:
444
            for name in userlist:
445 446 447
                to_approve = RegisteredUser.objects.get(user__username__exact=name)
                to_approve.approved = True
                to_approve.save()
David Haynes's avatar
David Haynes committed
448 449

                # Send an email letting them know they are approved
450
                if settings.EMAIL_HOST and settings.EMAIL_PORT:
451
                    user_mail = to_approve.user.username + settings.EMAIL_DOMAIN
452 453 454 455 456 457 458 459
                    send_mail(
                        'Your Account has been Approved!',
                        ######################
                        'Hey there %s,\n\n'
                        'The Go admins have reviewed your application and have '
                        'approved you to use Go!\n\n'
                        'Head over to go.gmu.edu to create your first address.\n\n'
                        '- Go Admins'
460
                        % (str(to_approve.full_name)),
461 462 463 464
                        ######################
                        settings.EMAIL_FROM,
                        [user_mail]
                    )
Zosman's avatar
Zosman committed
465

David Haynes's avatar
David Haynes committed
466
        # If we're denying users
467
        elif '_deny' in request.POST:
468
            for name in userlist:
469
                to_deny = RegisteredUser.objects.get(user__username__exact=name)
470
                if settings.EMAIL_HOST and settings.EMAIL_PORT:
471
                    user_mail = to_deny.user.username + settings.EMAIL_DOMAIN
David Haynes's avatar
David Haynes committed
472
                    # Send an email letting them know they are denied
473 474 475 476 477 478 479 480 481
                    send_mail(
                        'Your Account has been Denied!',
                        ######################
                        'Hey there %s,\n\n'
                        'The Go admins have reviewed your application and have '
                        'decided to not approve you to use Go.\n\n'
                        'Please reach out to srct@gmu.edu to appeal '
                        'this decision.\n\n'
                        '- Go Admins'
482
                        % (str(to_deny.full_name)),
483 484 485 486
                        ######################
                        settings.EMAIL_FROM,
                        [user_mail]
                    )
David Haynes's avatar
David Haynes committed
487
                # Delete their associated RegisteredUsers
488
                to_deny.user.delete()
489
                return HttpResponseRedirect('useradmin')
Zosman's avatar
Zosman committed
490

491
        # If we're blocking users
Zosman's avatar
draft 1  
Zosman committed
492 493
        elif '_block' in request.POST:
            for name in userlist:
494
                to_block = RegisteredUser.objects.get(user__username__exact=name)
Zosman's avatar
draft 1  
Zosman committed
495
                if settings.EMAIL_HOST and settings.EMAIL_PORT:
496
                    user_mail = to_block.user.username + settings.EMAIL_DOMAIN
Zosman's avatar
draft 1  
Zosman committed
497 498 499 500 501 502 503 504 505
                    send_mail(
                        'Your Account has been Blocked!',
                        ######################
                        'Hey there %s,\n\n'
                        'The Go admins have reviewed your application and have '
                        'blocked you from using Go.\n\n'
                        'Please reach out to srct@gmu.edu to appeal '
                        'this decision.\n\n'
                        '- Go Admins'
506
                        % (str(to_block.full_name)),
Zosman's avatar
draft 1  
Zosman committed
507 508 509 510
                        ######################
                        settings.EMAIL_FROM,
                        [user_mail]
                    )
511 512 513 514
                to_block.blocked = True
                to_block.approved = False
                to_block.registered = False
                to_block.save()
Zosman's avatar
Zosman committed
515

516
        # If we're un-blocking users
517 518
        elif '_unblock' in request.POST:
            for name in userlist:
519
                to_un_block = RegisteredUser.objects.get(user__username__exact=name)
520
                if settings.EMAIL_HOST and settings.EMAIL_PORT:
521
                    user_mail = to_un_block.user.username + settings.EMAIL_DOMAIN
522
                    send_mail(
523
                        'Your Account has been Un-Blocked!',
524 525 526
                        ######################
                        'Hey there %s,\n\n'
                        'The Go admins have reviewed your application and have '
527
                        'Un-Blocked you from using Go.\n\n'
528
                        'If you wish to continue Go use please register again. \n\n'
529 530
                        'Congratulations! '
                        '- Go Admins'
531
                        % (str(to_un_block.full_name)),
532 533 534 535
                        ######################
                        settings.EMAIL_FROM,
                        [user_mail]
                    )
536 537
                to_un_block.blocked = False
                to_un_block.save()
538
                return HttpResponseRedirect('useradmin')
539

540
        # If we're removing existing users
541 542
        elif '_remove' in request.POST:
            for name in userlist:
543
                to_remove = RegisteredUser.objects.get(user__username__exact=name)
544
                if settings.EMAIL_HOST and settings.EMAIL_PORT:
545
                    user_mail = to_remove.user.username + settings.EMAIL_DOMAIN
546 547 548 549 550 551 552 553
                    send_mail(
                        'Your Account has been Deleted!',
                        ######################
                        'Hey there %s,\n\n'
                        'The Go admins have decided to remove you from Go. \n\n'
                        'Please reach out to srct@gmu.edu to appeal '
                        'this decision.\n\n'
                        '- Go Admins'
554
                        % (str(to_remove.full_name)),
555 556 557 558
                        ######################
                        settings.EMAIL_FROM,
                        [user_mail]
                    )
559
                to_remove.user.delete()
560
                return HttpResponseRedirect('useradmin')
561

562
    # Get a list of all RegisteredUsers that need to be approved
563 564
    need_approval = RegisteredUser.objects.filter(registered=True).filter(
        approved=False).filter(blocked=False)
Zosman's avatar
Zosman committed
565
    # Get a list of all RegisteredUsers that are currently users
566 567
    current_users = RegisteredUser.objects.filter(approved=True).filter(
        registered=True).filter(blocked=False)
Zosman's avatar
Zosman committed
568
    # Get a list of all RegisteredUsers that are blocked
569
    blocked_users = RegisteredUser.objects.filter(blocked=True)
570

David Haynes's avatar
David Haynes committed
571
    # Pass that list to the template
572
    return render(request, 'admin/useradmin.html', {
573 574 575
        'need_approval': need_approval,
        'current_users': current_users,
        'blocked_users': blocked_users
David Haynes's avatar
David Haynes committed
576
    })