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