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.notes.views import RawNoteDetailView
  20 from karmaworld.apps.moderation import moderator
  21 from karmaworld.apps.document_upload.views import save_fp_upload
  22 from karmaworld.apps.users.views import ProfileView
  23
  24 # See: https://docs.djangoproject.com/en/dev/ref/contrib/admin/#hooking-adminsite-instances-into-your-urlconf
  25
  26
  27 admin.autodiscover()
  28
  29 # reused named regex capture groups
  30 SLUG = r'(?P<{0}slug>[-A-Za-z0-9_]+)'
  31
  32 """
  33 # ex: SLUG.format('')  :> (?P<slug>[-A-Za-z0-9_]+)
  34 # ex: SLUG.format('school_')  :> (?P<school_slug>[-A-Za-z0-9_]+)
  35
  36   ex: course url
  37   url(r'^' + SLUG.format('school_') + '/' + SLUG.format('') + '/'
  38         CourseDetailView.as_view(), name='course_detail'),
  39
  40   (?P<school_slug>[^/]+)/(?P<course_slug>[^/]+)/(?P<pk>[\d^/]+)$', \
  41         NoteView.as_view(), name='note_detail_pk'),
  42 """
  43
  44 SCHOOL_SLUG = r'(?P<school_slug>[-A-Za-z0-9_]+)'
  45 COURSE_SLUG = r'(?P<course_slug>[-A-Za-z0-9_]+)'
  46 NOTE_SLUG   = r'(?P<slug>[-A-Za-z0-9_]+)'
  47
  48 # See: https://docs.djangoproject.com/en/dev/topics/http/urls/
  49 urlpatterns = patterns('',
  50     ## Administrative URLpatterns
  51     # Admin panel and documentation:
  52     url(r'^admin/doc/', include('django.contrib.admindocs.urls')),
  53     url(r'^admin/', include(admin.site.urls)),
  54     # Grappelli django-admin improvment suite
  55     url(r'^grappelli/', include('grappelli.urls')),
  56     # Moderator panel and documentation:
  57     url(r'^moderator/doc/', include('django.contrib.admindocs.urls')),
  58     url(r'^moderator/', include(moderator.site.urls)),
  59
  60     ## Single-serving page URLpatterns
  61     url(r'^terms/$', TemplateView.as_view(template_name='terms.html'), name='terms'),
  62     url(r'^about/$', AboutView.as_view(), name='about'),
  63
  64     # All Auth
  65     url(r'^accounts/', include('allauth.urls')),
  66     url(r'^accounts/profile/', ProfileView.as_view(), name='accounts_profile'),
  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
  75     # ---- JSON views ----#
  76     # return json list of schools
  77     url(r'^school/list/$', school_list, name='json_school_list'),
  78     # return json list of courses for a given school
  79     url(r'^school/course/list/$', school_course_list, name='json_school_course_list'),
  80     # return json list of instructors for a given school and course
  81     url(r'^school/course/instructors/list/$', school_course_instructor_list, name='json_school_course_instructor_list'),
  82     # ---- end JSON views ----#
  83
  84     url(r'^search/$', NoteSearchView.as_view(), name='note_search'),
  85
  86     # VIEW for displaying a single Course
  87     url(r'^course/' + SLUG.format('') + '/$',
  88         CourseDetailView.as_view(), name='course_detail'),
  89
  90     ## NOTE MODEL
  91     # Ajax endpoint to thank a note
  92     url(r'^ajax/note/thank/(?P<pk>[\d]+)/$', thank_note, name='thank_note'),
  93     # Ajax endpoint to flag a note
  94     url(r'^ajax/note/flag/(?P<pk>[\d]+)/$', flag_note, name='flag_note'),
  95     # Ajax endpoint to update a notes tags
  96     url(r'^ajax/note/tags/(?P<pk>[\d]+)/$', edit_note_tags, name='edit_note_tags'),
  97     # Ajax endpoint to record that somebody downloaded a note
  98     url(r'^ajax/note/downloaded/(?P<pk>[\d]+)/$', downloaded_note, name='downloaded_note'),
  99     # Ajax endpoint to flag a course
 100     url(r'^ajax/course/flag/(?P<pk>[\d]+)/$', flag_course, name='flag_course'),
 101     # Ajax endpoint to edit a course
 102     url(r'^ajax/course/edit/(?P<pk>[\d]+)/$', edit_course, name='edit_course'),
 103
 104     # Valid url cases to the Note page
 105     # a: school/course/id
 106     # b: school/course/id/slug
 107     # c: s../c../slug
 108     # note file as id, for notes without titles yet
 109     url(r'^(?P<school_slug>[^/]+)/(?P<course_slug>[^/]+)/(?P<pk>[\d^/]+)$', \
 110         NoteView.as_view(), name='note_detail_pk'),
 111     # note file by note.slug
 112     url(r'^' + SLUG.format('school_') + '/' + SLUG.format('course_') +'/'+ SLUG.format('') +'$',
 113         NoteView.as_view(), name='note_detail'),
 114     #url(r'^(?P<school_slug>[^/]+)/(?P<course_slug>[^/]+)/(?P<slug>[^/]+)$', \
 115     #    NoteView.as_view(), name='note_detail'),
 116
 117     url(r'^$', CourseListView.as_view(model=Course), name='home'),
 118 )