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 from karmaworld.settings.manual_unique_together import auto_add_check_unique_together
  16
  17
  18 class School(models.Model):
  19     """ A grouping that contains many courses """
  20     name        = models.CharField(max_length=255)
  21     slug        = models.SlugField(max_length=150, null=True)
  22     location    = models.CharField(max_length=255, blank=True, null=True)
  23     url         = models.URLField(max_length=511, blank=True)
  24     # Facebook keeps a unique identifier for all schools
  25     facebook_id = models.BigIntegerField(blank=True, null=True)
  26     # United States Department of Education institution_id
  27     usde_id     = models.BigIntegerField(blank=True, null=True)
  28     file_count  = models.IntegerField(default=0)
  29     priority    = models.BooleanField(default=0)
  30     alias       = models.CharField(max_length=255, null=True, blank=True)
  31
  32     class Meta:
  33         """ Sort School by file_count descending, name abc=> """
  34         ordering = ['-file_count','-priority', 'name']
  35
  36
  37     def __unicode__(self):
  38         return self.name
  39
  40     def save(self, *args, **kwargs):
  41         """ Save school and generate a slug if one doesn't exist """
  42         if not self.slug:
  43             self.slug = defaultfilters.slugify(self.name)
  44         super(School, self).save(*args, **kwargs)
  45
  46     @staticmethod
  47     def autocomplete_search_fields():
  48         return ("name__icontains",)
  49
  50     def update_note_count(self):
  51         """ Update the School.file_count by summing the
  52             contained course.file_count
  53         """
  54         self.file_count = sum([course.file_count for course in self.course_set.all()])
  55         self.save()
  56
  57     def update_related_note_count(self):
  58         """ Runs the update_note_count function on all related course
  59             objects, then generates the self.file_count
  60         """
  61         for course in self.course_set.all():
  62             course.update_note_count()
  63         self.update_note_count()
  64
  65
  66 class Course(models.Model):
  67     """ First class object that contains many notes.Note objects """
  68     # Core metadata
  69     name        = models.CharField(max_length=255)
  70     slug        = models.SlugField(max_length=150, null=True)
  71     school      = models.ForeignKey(School) # Should this be optional ever?
  72     file_count  = models.IntegerField(default=0)
  73
  74     desc        = models.TextField(max_length=511, blank=True, null=True)
  75     url         = models.URLField(max_length=511, blank=True, null=True)
  76     academic_year   = models.IntegerField(blank=True, null=True,
  77                         default=datetime.datetime.now().year)
  78
  79     instructor_name     = models.CharField(max_length=255, blank=True, null=True)
  80     instructor_email    = models.EmailField(blank=True, null=True)
  81
  82     updated_at      = models.DateTimeField(default=datetime.datetime.utcnow)
  83
  84     created_at      = models.DateTimeField(auto_now_add=True)
  85
  86
  87     class Meta:
  88         ordering = ['-file_count', 'school', 'name']
  89         unique_together = ('school', 'name', 'instructor_name')
  90         verbose_name = 'course'
  91         verbose_name_plural = 'courses'
  92
  93     def __unicode__(self):
  94         return u"{0}: {1}".format(self.name, self.school)
  95
  96     def get_absolute_url(self):
  97         """ return url based on school slug and self slug """
  98         return u"/{0}/{1}".format(self.school.slug, self.slug)
  99
 100     def save(self, *args, **kwargs):
 101         """ Save school and generate a slug if one doesn't exist """
 102         super(Course, self).save(*args, **kwargs) # generate a self.id
 103         if not self.slug:
 104             self.slug = defaultfilters.slugify("%s %s" % (self.name, self.id))
 105             self.save() # Save the slug
 106
 107     def get_updated_at_string(self):
 108         """ return the formatted style for datetime strings """
 109         return self.updated_at.strftime("%I%p // %a %b %d %Y")
 110
 111     @staticmethod
 112     def autocomplete_search_fields():
 113         return ("name__icontains",)
 114
 115     def update_note_count(self):
 116         """ Update self.file_count by summing the note_set """
 117         self.file_count = self.note_set.count()
 118         self.save()
 119
 120 # Enforce unique constraints even when we're using a database like
 121 # SQLite that doesn't understand them
 122 auto_add_check_unique_together(Course)
 123