karmaworld/urls.py

   1 #!/usr/bin/env python
   2 # -*- coding:utf8 -*-
   3 # Copyright (C) 2012  FinalsClub Foundation
   4 """ Controller for the KarmaNotes website """
   5
   6 from django.contrib import admin
   7 from django.conf import settings
   8 from django.conf.urls import patterns, include, url
   9 from django.views.generic.base import TemplateView
  10
  11 from karmaworld.apps.courses.models import Course
  12 from karmaworld.apps.courses.views import AboutView, flag_course, edit_course
  13 from karmaworld.apps.courses.views import CourseDetailView
  14 from karmaworld.apps.courses.views import CourseListView
  15 from karmaworld.apps.courses.views import school_list
  16 from karmaworld.apps.courses.views import school_course_list
  17 from karmaworld.apps.courses.views import school_course_instructor_list
  18 from karmaworld.apps.notes.views import NoteView, thank_note, NoteSearchView, flag_note, downloaded_note, edit_note_tags
  19 from karmaworld.apps.moderation import moderator
  20 from karmaworld.apps.document_upload.views import save_fp_upload
  21 from karmaworld.apps.quizzes.views import QuizView, KeywordEditView, quiz_answer, get_keywords, \
  22     set_delete_keyword
  23 from karmaworld.apps.users.views import ProfileView
  24
  25 # See: https://docs.djangoproject.com/en/dev/ref/contrib/admin/#hooking-adminsite-instances-into-your-urlconf
  26
  27
  28 admin.autodiscover()
  29
  30 # reused named regex capture groups
  31 SLUG = r'(?P<{0}slug>[-A-Za-z0-9_]+)'
  32
  33 """
  34 # ex: SLUG.format('')  :> (?P<slug>[-A-Za-z0-9_]+)
  35 # ex: SLUG.format('school_')  :> (?P<school_slug>[-A-Za-z0-9_]+)
  36
  37   ex: course url
  38   url(r'^' + SLUG.format('school_') + '/' + SLUG.format('') + '/'
  39         CourseDetailView.as_view(), name='course_detail'),
  40
  41   (?P<school_slug>[^/]+)/(?P<course_slug>[^/]+)/(?P<pk>[\d^/]+)$', \
  42         NoteView.as_view(), name='note_detail_pk'),
  43 """
  44
  45 SCHOOL_SLUG = r'(?P<school_slug>[-A-Za-z0-9_]+)'
  46 COURSE_SLUG = r'(?P<course_slug>[-A-Za-z0-9_]+)'
  47 NOTE_SLUG   = r'(?P<slug>[-A-Za-z0-9_]+)'
  48
  49 # See: https://docs.djangoproject.com/en/dev/topics/http/urls/
  50 urlpatterns = patterns('',
  51     ## Administrative URLpatterns
  52     # Admin panel and documentation:
  53     url(r'^admin/doc/', include('django.contrib.admindocs.urls')),
  54     url(r'^admin/', include(admin.site.urls)),
  55     # Grappelli django-admin improvment suite
  56     url(r'^grappelli/', include('grappelli.urls')),
  57     # Moderator panel and documentation:
  58     url(r'^moderator/doc/', include('django.contrib.admindocs.urls')),
  59     url(r'^moderator/', include(moderator.site.urls)),
  60
  61     ## Single-serving page URLpatterns
  62     url(r'^terms/$', TemplateView.as_view(template_name='terms.html'), name='terms'),
  63     url(r'^about/$', AboutView.as_view(), name='about'),
  64
  65     # All Auth
  66     url(r'^accounts/', include('allauth.urls')),
  67     url(r'^accounts/profile/', ProfileView.as_view(), name='accounts_profile'),
  68
  69     # Media handling
  70     url(r'^media/(?P<path>.*)$', 'django.views.static.serve',
  71             {'document_root': settings.MEDIA_ROOT, }),
  72
  73     # Filepicker upload
  74     url(r'^api/upload$', save_fp_upload, name='upload_post'),
  75
  76     # ---- JSON views ----#
  77     # return json list of schools
  78     url(r'^school/list/$', school_list, name='json_school_list'),
  79     # return json list of courses for a given school
  80     url(r'^school/course/list/$', school_course_list, name='json_school_course_list'),
  81     # return json list of instructors for a given school and course
  82     url(r'^school/course/instructors/list/$', school_course_instructor_list, name='json_school_course_instructor_list'),
  83     # ---- end JSON views ----#
  84
  85     url(r'^search/$', NoteSearchView.as_view(), name='note_search'),
  86
  87     # VIEW for displaying a single Course
  88     url(r'^course/' + SLUG.format('') + '/$',
  89         CourseDetailView.as_view(), name='course_detail'),
  90
  91     ## NOTE MODEL
  92     # Ajax endpoint to thank a note
  93     url(r'^ajax/note/thank/(?P<pk>[\d]+)/$', thank_note, name='thank_note'),
  94     # Ajax endpoint to flag a note
  95     url(r'^ajax/note/flag/(?P<pk>[\d]+)/$', flag_note, name='flag_note'),
  96     # Ajax endpoint to update a notes tags
  97     url(r'^ajax/note/tags/(?P<pk>[\d]+)/$', edit_note_tags, name='edit_note_tags'),
  98     # Ajax endpoint to record that somebody downloaded a note
  99     url(r'^ajax/note/downloaded/(?P<pk>[\d]+)/$', downloaded_note, name='downloaded_note'),
 100     # Ajax endpoint to flag a course
 101     url(r'^ajax/course/flag/(?P<pk>[\d]+)/$', flag_course, name='flag_course'),
 102     # Ajax endpoint to edit a course
 103     url(r'^ajax/course/edit/(?P<pk>[\d]+)/$', edit_course, name='edit_course'),
 104
 105     # Check if a quiz answer is correct
 106     url(r'^ajax/quiz/check/$', quiz_answer, name='quiz_answer'),
 107
 108     url(r'^ajax/annotations/annotations$', set_delete_keyword, name='set_keyword'),
 109     url(r'^ajax/annotations/search/$', get_keywords, name='get_keywords'),
 110
 111     # Valid url cases to the Note page
 112     # a: school/course/id
 113     # b: school/course/id/slug
 114     # c: s../c../slug
 115     # note file as id, for notes without titles yet
 116     url(r'^note/(?P<school_slug>[^/]+)/(?P<course_slug>[^/]+)/(?P<pk>[\d^/]+)$', \
 117         NoteView.as_view(), name='note_detail_pk'),
 118     # note file by note.slug
 119     url(r'^note/' + SLUG.format('school_') + '/' + SLUG.format('course_') +'/'+ SLUG.format('') +'$',
 120         NoteView.as_view(), name='note_detail'),
 121
 122     # Quizzes
 123     url(r'^quiz/(?P<pk>[\d]+)/$',
 124         QuizView.as_view(), name='quiz'),
 125     url(r'^keywords/' + SLUG.format('') + '/$',
 126         KeywordEditView.as_view(), name='keyword_edit'),
 127
 128     url(r'^$', CourseListView.as_view(model=Course), name='home'),
 129 )