karmaworld/apps/notes/models.py

   1 #!/usr/bin/env python
   2 # -*- coding:utf8 -*-
   3 # Copyright (C) 2012  FinalsClub Foundation
   4
   5 """
   6     Models for the notes django app.
   7     Contains only the minimum for handling files and their representation
   8 """
   9 import datetime
  10
  11 from django.conf import settings
  12 from django.core.files.storage import FileSystemStorage
  13 from django.db import models
  14 from django.template import defaultfilters
  15 from lxml.html import fromstring, tostring
  16 from oauth2client.client import Credentials
  17 from taggit.managers import TaggableManager
  18
  19 from karmaworld.apps.courses.models import Course
  20
  21 try:
  22     from secrets.drive import GOOGLE_USER
  23 except:
  24     GOOGLE_USER = u'admin@karmanotes.org'
  25
  26 fs = FileSystemStorage(location=settings.MEDIA_ROOT)
  27
  28 class Note(models.Model):
  29     """ A django model representing an uploaded file and associated metadata.
  30     """
  31     UNKNOWN_FILE = '???'
  32     FILE_TYPE_CHOICES = (
  33         ('doc', 'MS Word compatible file (.doc, .docx, .rtf, .odf)'),
  34         ('img', 'Scan or picture of notes'),
  35         ('pdf', 'PDF file'),
  36         (UNKNOWN_FILE, 'Unknown file'),
  37     )
  38
  39     course          = models.ForeignKey(Course)
  40     # Tagging system
  41     tags            = TaggableManager(blank=True)
  42
  43     name            = models.CharField(max_length=255, blank=True, null=True)
  44     slug            = models.SlugField(max_length=255, null=True)
  45     year            = models.IntegerField(blank=True, null=True,
  46                         default=datetime.datetime.utcnow().year)
  47     desc            = models.TextField(max_length=511, blank=True, null=True)
  48     uploaded_at     = models.DateTimeField(null=True, default=datetime.datetime.utcnow)
  49
  50     file_type       = models.CharField(max_length=15,
  51                             choices=FILE_TYPE_CHOICES,
  52                             default=UNKNOWN_FILE,
  53                             blank=True, null=True)
  54
  55     # Upload files to MEDIA_ROOT/notes/YEAR/MONTH/DAY, 2012/10/30/filename
  56     # FIXME: because we are adding files by hand in tasks.py, upload_to is being ignored for media files
  57     note_file       = models.FileField(
  58                             storage=fs,
  59                             upload_to="notes/%Y/%m/%j/",
  60                             blank=True, null=True)
  61
  62     ## post gdrive conversion data
  63     embed_url       = models.URLField(max_length=1024, blank=True, null=True)
  64     download_url    = models.URLField(max_length=1024, blank=True, null=True)
  65     # for word processor documents
  66     html            = models.TextField(blank=True, null=True)
  67     text            = models.TextField(blank=True, null=True)
  68
  69
  70     class Meta:
  71         """ Sort files by most recent first """
  72         ordering = ['-uploaded_at']
  73
  74
  75     def __unicode__(self):
  76         return u"{0}: {1} -- {2}".format(self.file_type, self.name, self.uploaded_at)
  77
  78     def save(self, *args, **kwargs):
  79         """ override built-in save to ensure contextual self.name """
  80         # TODO: If self.name isn't set, generate one based on uploaded_name
  81         # if we fail to set the Note.name earlier than this, use the saved filename
  82
  83         # only generate a slug if the name has been set, and slug hasn't
  84         if not self.slug and self.name:
  85             slug = defaultfilters.slugify(self.name)
  86             cursor = Note.objects.filter(slug=slug)
  87             # If there are no other notes with this slug, then the slug does not need an id
  88             if cursor.count() == 0:
  89                 self.slug = slug
  90             else:
  91                 super(Note, self).save(*args, **kwargs) # generate self.id
  92                 self.slug = defaultfilters.slugify("%s %s" % (self.name, self.id))
  93             super(Note, self).save(*args, **kwargs)
  94
  95         # Check if Note.uploaded_at is after Course.updated_at
  96         if self.uploaded_at and self.uploaded_at > self.course.updated_at:
  97             self.course.updated_at = self.uploaded_at
  98             # if it is, update Course.updated_at
  99             self.course.save()
 100
 101         super(Note, self).save(*args, **kwargs)
 102
 103     def get_absolute_url(self):
 104         """ Resolve note url, use 'note' route and slug if slug
 105             otherwise use note.id
 106         """
 107         if self.slug is not None:
 108             # return a url ending in slug
 109             return u"/{0}/{1}/{2}".format(self.course.school.slug, self.course.slug, self.slug)
 110         else:
 111             # return a url ending in id
 112             return u"/{0}/{1}/{2}".format(self.course.school.slug, self.course.slug, self.id)
 113
 114     def sanitize_html(self, save=True):
 115         """ if self contains html, find all <a> tags and add target=_blank
 116             takes self
 117             returns True/False on succ/fail and error or count
 118         """
 119         # build a tag sanitizer
 120         def add_attribute_target(tag):
 121             tag.attrib['target'] = '_blank'
 122
 123         # if no html, return false
 124         if not self.html:
 125             return False, "Note has no html"
 126
 127         _html = fromstring(self.html)
 128         a_tags = _html.findall('.//a') # recursively find all a tags in document tree
 129         # if there are a tags
 130         if a_tags > 1:
 131             #apply the add attribute function
 132             map(add_attribute_target, a_tags)
 133             self.html = _html
 134             if save:
 135                 self.save()
 136             return True, len(a_tags)
 137
 138
 139
 140 class DriveAuth(models.Model):
 141     """ stored google drive authentication and refresh token
 142         used for interacting with google drive """
 143
 144     email = models.EmailField(default=GOOGLE_USER)
 145     credentials = models.TextField() # JSON of Oauth2Credential object
 146     stored_at = models.DateTimeField(auto_now=True)
 147
 148
 149     @staticmethod
 150     def get(email=GOOGLE_USER):
 151         """ Staticmethod for getting the singleton DriveAuth object """
 152         # FIXME: this is untested
 153         return DriveAuth.objects.filter(email=email).reverse()[0]
 154
 155
 156     def store(self, creds):
 157         """ Transform an existing credentials object to a db serialized """
 158         self.email = creds.id_token['email']
 159         self.credentials = creds.to_json()
 160         self.save()
 161
 162
 163     def transform_to_cred(self):
 164         """ take stored credentials and produce a Credentials object """
 165         return Credentials.new_from_json(self.credentials)
 166
 167
 168     def __unicode__(self):
 169         return u'Gdrive auth for %s created/updated at %s' % \
 170                     (self.email, self.stored_at)