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.defaults import patterns, include, url
   9 from django.views.generic.simple import direct_to_template
  10
  11 from karmaworld.apps.courses.models import Course
  12 from karmaworld.apps.courses.views import AboutView
  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
  19 from karmaworld.apps.notes.views import RawNoteDetailView
  20 from karmaworld.apps.notes.views import PDFView
  21 from karmaworld.apps.document_upload.views import save_fp_upload
  22
  23 # See: https://docs.djangoproject.com/en/dev/ref/contrib/admin/#hooking-adminsite-instances-into-your-urlconf
  24 admin.autodiscover()
  25
  26 # reused named regex capture groups
  27 SLUG = r'(?P<{0}slug>[-A-Za-z0-9_]+)'
  28
  29 """
  30 # ex: SLUG.format('')  :> (?P<slug>[-A-Za-z0-9_]+)
  31 # ex: SLUG.format('school_')  :> (?P<school_slug>[-A-Za-z0-9_]+)
  32
  33   ex: course url
  34   url(r'^' + SLUG.format('school_') + '/' + SLUG.format('') + '/'
  35         CourseDetailView.as_view(), name='course_detail'),
  36
  37   (?P<school_slug>[^/]+)/(?P<course_slug>[^/]+)/(?P<pk>[\d^/]+)$', \
  38         NoteView.as_view(), name='note_detail_pk'),
  39 """
  40
  41 SCHOOL_SLUG = r'(?P<school_slug>[-A-Za-z0-9_]+)'
  42 COURSE_SLUG = r'(?P<course_slug>[-A-Za-z0-9_]+)'
  43 NOTE_SLUG   = r'(?P<slug>[-A-Za-z0-9_]+)'
  44
  45 # See: https://docs.djangoproject.com/en/dev/topics/http/urls/
  46 urlpatterns = patterns('',
  47     ## Administrative URLpatterns
  48     # Admin panel and documentation:
  49     url(r'^admin/doc/', include('django.contrib.admindocs.urls')),
  50     url(r'^admin/', include(admin.site.urls)),
  51     # Grappelli django-admin improvment suite
  52     url(r'^grappelli/', include('grappelli.urls')),
  53
  54     ## Single-serving page URLpatterns
  55     url(r'^terms/$', direct_to_template, { 'template': 'terms.html' }, name='terms'),
  56     url(r'^about/$', AboutView.as_view(), name='about'),
  57
  58     # VIEW for viewing a Note's gdrive generated html, used as iframe
  59     url(r'^raw/(?P<pk>\d+)$', RawNoteDetailView.as_view(), name='note_raw'),
  60     #url(r'^pdfview$', PDFView.as_view(), name='pdf'),
  61     url(r'^pdfview/(?P<pk>\d+)$', PDFView.as_view(), name='pdf'),
  62
  63     # Media handling
  64     url(r'^media/(?P<path>.*)$', 'django.views.static.serve',
  65             {'document_root': settings.MEDIA_ROOT, }),
  66
  67     # Filepicker upload
  68     url(r'^api/upload$', save_fp_upload, name='upload_post'),
  69     # VIEW for displaying a single Course
  70     url(r'^' + SLUG.format('school_') + '/' + SLUG.format('') + '$',
  71         CourseDetailView.as_view(), name='course_detail'),
  72
  73     ## NOTE MODEL
  74     # Valid url cases to the Note page
  75     # a: school/course/id
  76     # b: school/course/id/slug
  77     # c: s../c../slug
  78     # note file as id, for notes without titles yet
  79     url(r'^(?P<school_slug>[^/]+)/(?P<course_slug>[^/]+)/(?P<pk>[\d^/]+)$', \
  80         NoteView.as_view(), name='note_detail_pk'),
  81     # note file by note.slug
  82     url(r'^' + SLUG.format('school_') + '/' + SLUG.format('course_') +'/'+ SLUG.format('') +'$',
  83         NoteView.as_view(), name='note_detail'),
  84     #url(r'^(?P<school_slug>[^/]+)/(?P<course_slug>[^/]+)/(?P<slug>[^/]+)$', \
  85     #    NoteView.as_view(), name='note_detail'),
  86
  87     # ---- JSON views ----#
  88     # return json list of schools
  89     url(r'^school/list/$', school_list, name='json_school_list'),
  90     # return json list of courses for a given school
  91     url(r'^school/course/list/$', school_course_list, name='json_school_course_list'),
  92     # return json list of instructors for a given school and course
  93     url(r'^school/course/instructors/list/$', school_course_instructor_list, name='json_school_course_instructor_list'),
  94     # ---- end JSON views ----#
  95
  96     url(r'^$', CourseListView.as_view(model=Course), name='home'),
  97 )