karmaworld/apps/courses/models.py

   1 #!/usr/bin/env python
   2 # -*- coding:utf8 -*-
   3 # Copyright (C) 2012  FinalsClub Foundation
   4
   5 """
   6     Models for the courses django app.
   7     Handles courses, and their related models
   8     Courses are the first class object, they contain notes.
   9     Courses have a manytoone relation to schools.
  10 """
  11 import datetime
  12
  13 from django.db import models
  14 from django.template import defaultfilters
  15
  16 class School(models.Model):
  17     """ A grouping that contains many courses """
  18     name        = models.CharField(max_length=255)
  19     slug        = models.SlugField(null=True)
  20     location    = models.CharField(max_length=255, blank=True, null=True)
  21     url         = models.URLField(max_length=511, blank=True)
  22     # Facebook keeps a unique identifier for all schools
  23     facebook_id = models.BigIntegerField(blank=True, null=True)
  24     file_count  = models.IntegerField(default=0)
  25
  26     class Meta:
  27         """ Sort School by file_count descending, name abc=> """
  28         ordering = ['-file_count', 'name']
  29
  30
  31     def __unicode__(self):
  32         return self.name
  33
  34     def save(self, *args, **kwargs):
  35         """ Save school and generate a slug if one doesn't exist """
  36         if not self.slug:
  37             self.slug = defaultfilters.slugify(self.name)
  38         super(School, self).save(*args, **kwargs)
  39
  40     def update_note_count(self):
  41         """ Update the School.file_count by summing the
  42             contained course.file_count
  43         """
  44         self.file_count = sum([course.file_count for course in self.course_set.all()])
  45         self.save()
  46
  47     def update_related_note_count(self):
  48         """ Runs the update_note_count function on all related course
  49             objects, then generates the self.file_count
  50         """
  51         for course in self.course_set.all():
  52             course.update_note_count()
  53         self.update_note_count()
  54
  55
  56 class Course(models.Model):
  57     """ First class object that contains many notes.Note objects """
  58     # Core metadata
  59     name        = models.CharField(max_length=255)
  60     slug        = models.SlugField(null=True)
  61     school      = models.ForeignKey(School) # Should this be optional ever?
  62     file_count  = models.IntegerField(default=0)
  63
  64     desc        = models.TextField(max_length=511, blank=True, null=True)
  65     url         = models.URLField(max_length=511, blank=True, null=True)
  66     academic_year   = models.IntegerField(blank=True, null=True,
  67                         default=datetime.datetime.now().year)
  68
  69     instructor_name     = models.CharField(max_length=255, blank=True, null=True)
  70     instructor_email    = models.EmailField(blank=True, null=True)
  71
  72     updated_at      = models.DateTimeField(default=datetime.datetime.utcnow)
  73
  74     created_at      = models.DateTimeField(auto_now_add=True)
  75
  76
  77     class Meta:
  78         ordering = ['-file_count', 'school', 'name']
  79
  80     def __unicode__(self):
  81         return u"{0}: {1}".format(self.name, self.school)
  82
  83     def get_absolute_url(self):
  84         """ Not implemented yet """
  85         return u"/{0}/{1}".format(self.school.slug, self.slug)
  86
  87     def save(self, *args, **kwargs):
  88         """ Save school and generate a slug if one doesn't exist """
  89         if not self.slug:
  90             self.slug = defaultfilters.slugify(self.name)
  91         super(Course, self).save(*args, **kwargs)
  92
  93     def update_note_count(self):
  94         self.file_count = self.note_set.count()
  95         self.save()