mediagoblin/models.py

   1 # GNU MediaGoblin -- federated, autonomous media hosting
   2 # Copyright (C) 2011 Free Software Foundation, Inc
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU Affero General Public License as published by
   6 # the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU Affero General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Affero General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 import datetime, uuid
  18
  19 from mongokit import Document, Set
  20
  21 from mediagoblin import util
  22 from mediagoblin.auth import lib as auth_lib
  23 from mediagoblin import globals as mediagoblin_globals
  24
  25 ###################
  26 # Custom validators
  27 ###################
  28
  29 ########
  30 # Models
  31 ########
  32
  33
  34 class User(Document):
  35     __collection__ = 'users'
  36
  37     structure = {
  38         'username': unicode,
  39         'email': unicode,
  40         'created': datetime.datetime,
  41         'plugin_data': dict, # plugins can dump stuff here.
  42         'pw_hash': unicode,
  43         'email_verified': bool,
  44         'status': unicode,
  45         'verification_key': unicode,
  46         'is_admin': bool,
  47         }
  48
  49     required_fields = ['username', 'created', 'pw_hash', 'email']
  50
  51     default_values = {
  52         'created': datetime.datetime.utcnow,
  53         'email_verified': False,
  54         'status': u'needs_email_verification',
  55         'verification_key': lambda: unicode(uuid.uuid4()),
  56         'is_admin': False}
  57
  58     def check_login(self, password):
  59         """
  60         See if a user can login with this password
  61         """
  62         return auth_lib.bcrypt_check_password(
  63             password, self['pw_hash'])
  64
  65
  66 class MediaEntry(Document):
  67     __collection__ = 'media_entries'
  68
  69     structure = {
  70         'uploader': User,
  71         'title': unicode,
  72         'slug': unicode,
  73         'created': datetime.datetime,
  74         'description': unicode,
  75         'media_type': unicode,
  76         'media_data': dict, # extra data relevant to this media_type
  77         'plugin_data': dict, # plugins can dump stuff here.
  78         'tags': [unicode],
  79         'state': unicode,
  80
  81         # For now let's assume there can only be one main file queued
  82         # at a time
  83         'queued_media_file': [unicode],
  84
  85         # A dictionary of logical names to filepaths
  86         'media_files': dict,
  87
  88         # The following should be lists of lists, in appropriate file
  89         # record form
  90         'attachment_files': list,
  91
  92         # This one should just be a single file record
  93         'thumbnail_file': [unicode]}
  94
  95     required_fields = [
  96         'uploader', 'created', 'media_type']
  97
  98     default_values = {
  99         'created': datetime.datetime.utcnow,
 100         'state': u'unprocessed'}
 101
 102     # Actually we should referene uniqueness by uploader, but we
 103     # should fix http://bugs.foocorp.net/issues/340 first.
 104     # indexes = [
 105     #     {'fields': ['uploader', 'slug'],
 106     #      'unique': True}]
 107
 108     def main_mediafile(self):
 109         pass
 110
 111     def generate_slug(self):
 112         self['slug'] = util.slugify(self['title'])
 113
 114         duplicate = mediagoblin_globals.database.media_entries.find_one(
 115             {'slug': self['slug']})
 116
 117         if duplicate:
 118             self['slug'] = "%s-%s" % (self['_id'], self['slug'])
 119
 120 REGISTER_MODELS = [MediaEntry, User]
 121
 122
 123 def register_models(connection):
 124     """
 125     Register all models in REGISTER_MODELS with this connection.
 126     """
 127     connection.register(REGISTER_MODELS)
 128