views.py 10.4 KB
Newer Older
1
from go.models import URL, RegisteredUser
Jean Michel Rouly's avatar
Jean Michel Rouly committed
2
from go.forms import URLForm, SignupForm
3
from datetime import timedelta
4
from django.conf import settings
5
from django.http import Http404, HttpResponseServerError
6
from django.utils import timezone
Jean Michel Rouly's avatar
Jean Michel Rouly committed
7
from django.contrib.auth.models import User
8
from django.core.exceptions import PermissionDenied, ValidationError
9
from django.core.mail import send_mail
10
11
from django.contrib.auth import REDIRECT_FIELD_NAME
from django.contrib.auth.decorators import user_passes_test, login_required
Jean Michel Rouly's avatar
Jean Michel Rouly committed
12
from django.shortcuts import render, get_object_or_404, redirect
13
import os
14

Jean Michel Rouly's avatar
Jean Michel Rouly committed
15
16
17
18
19
20
21

##############################################################################
"""
Define useful helper methods here.
"""


22
def is_approved( user ):
Jean Michel Rouly's avatar
Jean Michel Rouly committed
23
24
25
26
27
    """
    This function checks if a user account has a corresponding RegisteredUser,
    thus checking if the user is registered.
    """

28
    try:
29
        registered = RegisteredUser.objects.get( username=user.username )
30
        return registered.approved
31
32
33
    except RegisteredUser.DoesNotExist:
        return False

Jean Michel Rouly's avatar
Jean Michel Rouly committed
34

35
36
37
38
39
40
41
42
43
44
45
46
47
def is_registered(user):
    """
    This function checks if a user account has a corresponding RegisteredUser,
    thus checking if the user is registered.
    """

    try:
        registered = RegisteredUser.objects.get( username=user.username )
        return True
    except RegisteredUser.DoesNotExist:
        return False


Jean Michel Rouly's avatar
Jean Michel Rouly committed
48
49
50
51
52
53
##############################################################################
"""
Define error page handling here.
"""


54
def error_404(request):
Jean Michel Rouly's avatar
Jean Michel Rouly committed
55
56
57
58
    """
    Error 404 view, in case a url is not found.
    """

59
60
61
62
63
    return render(request, '404.html', {
    },
    )

def error_500(request):
Jean Michel Rouly's avatar
Jean Michel Rouly committed
64
65
66
67
    """
    Error 500 view, in case a server error occurs.
    """

68
69
70
71
    return render(request, '500.html', {
    },
    )

Jean Michel Rouly's avatar
Jean Michel Rouly committed
72
73
74
75
76
77
##############################################################################
"""
Define user views here.
"""


Jean Michel Rouly's avatar
Jean Michel Rouly committed
78
def index(request):
Jean Michel Rouly's avatar
Jean Michel Rouly committed
79
80
81
82
83
84
85
    """
    This view handles the homepage that the user is presented with when
    they request '/'. If they're not logged in, they're redirected to
    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.
    """
Jean Michel Rouly's avatar
Jean Michel Rouly committed
86

87
88
89
90
    # If the user is not authenticated, show them a public landing page.
    if not request.user.is_authenticated():
        return render(request, 'public_landing.html')

Jean Michel Rouly's avatar
Jean Michel Rouly committed
91
    # If the user isn't registered, don't give them any leeway.
92
    if not is_approved(request.user):
93
94
        return render(request, 'not_registered.html')

95
96
97
98
99
100
    url_form = URLForm() # unbound form

    if request.method == 'POST':
        url_form = URLForm( request.POST ) # bind dat form
        if url_form.is_valid():

Jean Michel Rouly's avatar
Jean Michel Rouly committed
101
102
            # We don't commit the url object yet because we need to add its
            # owner, and parse its date field.
103
104
105
            url = url_form.save(commit=False)
            url.owner = request.user

Jean Michel Rouly's avatar
Jean Michel Rouly committed
106
            # If the user entered a short url, it's already been validated,
Jean Michel Rouly's avatar
Jean Michel Rouly committed
107
108
            # so accept it. If they did not, however, then generate a
            # random one and use that instead.
109
            short = url_form.cleaned_data.get('short').strip()
110
111
112
            if len(short) > 0:
                url.short = short
            else:
113
114
115
116
117
118
119
120
121
122
                # 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 HttpResponseServerError(
                        render(request, '500.html', {})
                    )
                else:
                    url.short = random_short
123

Jean Michel Rouly's avatar
Jean Michel Rouly committed
124
125
126
            # 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.
127
            expires = url_form.cleaned_data.get('expires')
128
129
130
131
132
133
134
135
136
137

            if expires == URLForm.DAY:
                url.expires = timezone.now() + timedelta(days=1)
            elif expires == URLForm.WEEK:
                url.expires = timezone.now() + timedelta(weeks=1)
            elif expires == URLForm.MONTH:
                url.expires = timezone.now() + timedelta(weeks=3)
            else:
                pass # leave the field NULL

Jean Michel Rouly's avatar
Jean Michel Rouly committed
138
139
            # Make sure that our new URL object is clean, then save it and
            # let's redirect to view this baby.
140
141
            url.full_clean()
            url.save()
Jean Michel Rouly's avatar
Jean Michel Rouly committed
142
            return redirect('view', url.short)
143
144
145

    return render(request, 'index.html', {
        'form': url_form,
Jean Michel Rouly's avatar
Jean Michel Rouly committed
146
147
148
    },
    )

Jean Michel Rouly's avatar
Jean Michel Rouly committed
149

Jean Michel Rouly's avatar
Jean Michel Rouly committed
150
def view(request, short):
Jean Michel Rouly's avatar
Jean Michel Rouly committed
151
152
153
154
155
    """
    This view allows the user to view details about a URL. Note that they
    do not need to be logged in to view info.
    """

Jean Michel Rouly's avatar
Jean Michel Rouly committed
156
    domain = "//%s" % request.META.get('HTTP_HOST') + "/"
157

Jean Michel Rouly's avatar
Jean Michel Rouly committed
158
    url = get_object_or_404(URL, short__iexact = short)
159

Jean Michel Rouly's avatar
Jean Michel Rouly committed
160
    return render(request, 'view.html', {
161
        'url': url,
162
        'domain' : domain,
163
164
165
    },
    )

Jean Michel Rouly's avatar
Jean Michel Rouly committed
166

167
@login_required
168
def my_links(request):
Jean Michel Rouly's avatar
Jean Michel Rouly committed
169
170
171
172
173
    """
    This view displays all the information about all of your URLs. You
    obviously need to be logged in to view your URLs.
    """

174
    if not is_approved(request.user):
175
        return render(request, 'not_registered.html')
Jean Michel Rouly's avatar
Jean Michel Rouly committed
176

177
    urls = URL.objects.filter( owner = request.user )
178

Jean Michel Rouly's avatar
Jean Michel Rouly committed
179
    domain = "//%s" % request.META.get('HTTP_HOST') + "/"
180

181
    return render(request, 'my_links.html', {
182
        'urls' : urls,
183
        'domain' : domain,
184
185
186
    },
    )

Jean Michel Rouly's avatar
Jean Michel Rouly committed
187

188
@login_required
189
def delete(request, short):
Jean Michel Rouly's avatar
Jean Michel Rouly committed
190
191
192
193
194
    """
    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.
    """

195
    if not is_approved(request.user):
196
        return render(request, 'not_registered.html')
Jean Michel Rouly's avatar
Jean Michel Rouly committed
197

Jean Michel Rouly's avatar
Jean Michel Rouly committed
198
    url = get_object_or_404(URL, short__iexact = short )
199
200
    if url.owner == request.user:
        url.delete()
201
202
        return redirect('my_links')
    else:
203
        raise PermissionDenied()
204

Jean Michel Rouly's avatar
Jean Michel Rouly committed
205

206
@login_required
Jean Michel Rouly's avatar
Jean Michel Rouly committed
207
def signup(request):
Jean Michel Rouly's avatar
Jean Michel Rouly committed
208
209
210
211
212
    """
    This view presents the user with a registration form. You can register
    yourself, or another person.

    """
213
214
215
216
217
218
219
220
221
222
223
224
225
    if is_registered(request.user) and not request.user.is_staff:
        return render(request, 'signup.html', {
            'registered': True,
        },
        )

    signup_form = SignupForm(initial={'username': request.user.username})
    # Non-staff have the username field read-only and pre-filled
    if request.user.is_staff:
        signup_form = SignupForm()
    else:
        signup_form = SignupForm(initial={'username': request.user.username})
        signup_form.fields['username'].widget.attrs['readonly'] = 'readonly'
Jean Michel Rouly's avatar
Jean Michel Rouly committed
226
227

    if request.method == 'POST':
228
229
230
        signup_form = SignupForm(request.POST, initial={'approved': False,
            'username': request.user.username})

231
        if signup_form.is_valid():
232
233
234
235
236
            # Prevent hax: if not staff, force the username back to the request username.
            if not request.user.is_staff:
                username = request.user.username
            else:
                username = signup_form.cleaned_data.get('username')
237
238
            full_name = signup_form.cleaned_data.get('full_name')
            description = signup_form.cleaned_data.get('description')
239

240
241
242
243
244
245
246
            # Only send mail if we've defined the mailserver
            if settings.EMAIL_HOST and settings.EMAIL_PORT:
                send_mail('Signup from %s' % (username), '%s signed up at %s\n'
                    'Username: %s\nMessage: %s\nPlease attend to this request at '
                    'your earliest convenience.' % (str(full_name),
                    str(timezone.now()).strip(), str(username), str(description)),
                    settings.EMAIL_FROM, [settings.EMAIL_TO])
247

248
249
            signup_form.save()

250
            return redirect('registered')
Jean Michel Rouly's avatar
Jean Michel Rouly committed
251

Jean Michel Rouly's avatar
Jean Michel Rouly committed
252
    return render(request, 'signup.html', {
253
        'form': signup_form,
254
        'registered': False,
Jean Michel Rouly's avatar
Jean Michel Rouly committed
255
256
    },
    )
Jean Michel Rouly's avatar
Jean Michel Rouly committed
257

Jean Michel Rouly's avatar
Jean Michel Rouly committed
258

Jean Michel Rouly's avatar
Jean Michel Rouly committed
259
def redirection(request, short):
Jean Michel Rouly's avatar
Jean Michel Rouly committed
260
261
262
    """
    This view redirects a user based on the short URL they requested.
    """
Jean Michel Rouly's avatar
Jean Michel Rouly committed
263

Jean Michel Rouly's avatar
Jean Michel Rouly committed
264
    url = get_object_or_404( URL, short__iexact = short )
Jean Michel Rouly's avatar
Jean Michel Rouly committed
265
    url.clicks = url.clicks + 1
266
267
268
269
270
271
272

    if 'qr' in request.GET:
        url.qrclicks += 1

    if 'social' in request.GET:
        url.socialclicks += 1

Jean Michel Rouly's avatar
Jean Michel Rouly committed
273
    url.save()
274

Jean Michel Rouly's avatar
Jean Michel Rouly committed
275
276
277
278
279
    """
    Include server-side tracking because there is no template displayed to
    the user which would include javascript tracking.
    """

280
281
    from piwikapi.tracking import PiwikTracker
    from django.conf import settings
282
    # First, if PIWIK variables are undefined, don't try to push
283
    if settings.PIWIK_SITE_ID != "" and settings.PIWIK_URL != "":
284
285
286
287
288
289
290
        try:
            piwiktracker = PiwikTracker(settings.PIWIK_SITE_ID, request)
            piwiktracker.set_api_url(settings.PIWIK_URL)
            piwiktracker.do_track_page_view('Redirect to %s' % url.target)
        # Second, if we do get an error, don't let that keep us from redirecting
        except:
            pass
291
292

    return redirect( url.target )
Jean Michel Rouly's avatar
Jean Michel Rouly committed
293
294


295
296
297
298
299
300
301
302
303
304
305
306
307
def staff_member_required(view_func, redirect_field_name=REDIRECT_FIELD_NAME, login_url='about'):
    """
    Decorator for views that checks that the user is logged in and is a staff
    member, displaying the login page if necessary.
    """
    return user_passes_test(
        lambda u: u.is_active and u.is_staff,
        login_url=login_url,
        redirect_field_name=redirect_field_name
    )(view_func)


@staff_member_required
Chris Reffett's avatar
Chris Reffett committed
308
def useradmin(request):
309
310
311
312
313
    """
    This view is a simplified admin panel, so that staff don't need to log in
    to approve links
    """
    if request.POST:
314
        userlist = request.POST.getlist('username')
315
        if '_approve' in request.POST:
316
317
318
319
            for name in userlist:
                toapprove = RegisteredUser.objects.get(username=name)
                toapprove.approved = True
                toapprove.save()
320
        elif '_deny' in request.POST:
321
322
323
            for name in userlist:
                todeny = RegisteredUser.objects.get(username=name)
                todeny.delete()
324
    need_approval = RegisteredUser.objects.filter(approved=False)
Chris Reffett's avatar
Chris Reffett committed
325
    return render(request, 'useradmin.html',{
326
327
328
329
330
        'need_approval': need_approval
    },
    )


Jean Michel Rouly's avatar
Jean Michel Rouly committed
331
332
333
334
335
336
337
338
339
340
341
##############################################################################
"""
Define static user views here.
"""


def about(request):
    return render(request, 'about.html', {
    },
    )

342
343
344
345
def registered(request):
    return render(request, 'registered.html', {
    },
    )