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