| 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 mg_globals |
| 24 | from mediagoblin.db import migrations |
| 25 | from mediagoblin.db.util import ASCENDING, DESCENDING, ObjectId |
| 26 | |
| 27 | ################### |
| 28 | # Custom validators |
| 29 | ################### |
| 30 | |
| 31 | ######## |
| 32 | # Models |
| 33 | ######## |
| 34 | |
| 35 | |
| 36 | class User(Document): |
| 37 | __collection__ = 'users' |
| 38 | |
| 39 | structure = { |
| 40 | 'username': unicode, |
| 41 | 'email': unicode, |
| 42 | 'created': datetime.datetime, |
| 43 | 'plugin_data': dict, # plugins can dump stuff here. |
| 44 | 'pw_hash': unicode, |
| 45 | 'email_verified': bool, |
| 46 | 'status': unicode, |
| 47 | 'verification_key': unicode, |
| 48 | 'is_admin': bool, |
| 49 | 'url' : unicode, |
| 50 | 'bio' : unicode |
| 51 | } |
| 52 | |
| 53 | required_fields = ['username', 'created', 'pw_hash', 'email'] |
| 54 | |
| 55 | default_values = { |
| 56 | 'created': datetime.datetime.utcnow, |
| 57 | 'email_verified': False, |
| 58 | 'status': u'needs_email_verification', |
| 59 | 'verification_key': lambda: unicode(uuid.uuid4()), |
| 60 | 'is_admin': False} |
| 61 | |
| 62 | migration_handler = migrations.UserMigration |
| 63 | |
| 64 | def check_login(self, password): |
| 65 | """ |
| 66 | See if a user can login with this password |
| 67 | """ |
| 68 | return auth_lib.bcrypt_check_password( |
| 69 | password, self['pw_hash']) |
| 70 | |
| 71 | |
| 72 | class MediaEntry(Document): |
| 73 | __collection__ = 'media_entries' |
| 74 | |
| 75 | structure = { |
| 76 | 'uploader': ObjectId, |
| 77 | 'title': unicode, |
| 78 | 'slug': unicode, |
| 79 | 'created': datetime.datetime, |
| 80 | 'description': unicode, # May contain markdown/up |
| 81 | 'description_html': unicode, # May contain plaintext, or HTML |
| 82 | 'media_type': unicode, |
| 83 | 'media_data': dict, # extra data relevant to this media_type |
| 84 | 'plugin_data': dict, # plugins can dump stuff here. |
| 85 | 'tags': [unicode], |
| 86 | 'state': unicode, |
| 87 | |
| 88 | # For now let's assume there can only be one main file queued |
| 89 | # at a time |
| 90 | 'queued_media_file': [unicode], |
| 91 | |
| 92 | # A dictionary of logical names to filepaths |
| 93 | 'media_files': dict, |
| 94 | |
| 95 | # The following should be lists of lists, in appropriate file |
| 96 | # record form |
| 97 | 'attachment_files': list, |
| 98 | |
| 99 | # This one should just be a single file record |
| 100 | 'thumbnail_file': [unicode]} |
| 101 | |
| 102 | required_fields = [ |
| 103 | 'uploader', 'created', 'media_type', 'slug'] |
| 104 | |
| 105 | default_values = { |
| 106 | 'created': datetime.datetime.utcnow, |
| 107 | 'state': u'unprocessed'} |
| 108 | |
| 109 | migration_handler = migrations.MediaEntryMigration |
| 110 | |
| 111 | def get_comments(self): |
| 112 | return self.db.MediaComment.find({ |
| 113 | 'media_entry': self['_id']}).sort('created', DESCENDING) |
| 114 | |
| 115 | def main_mediafile(self): |
| 116 | pass |
| 117 | |
| 118 | def generate_slug(self): |
| 119 | self['slug'] = util.slugify(self['title']) |
| 120 | |
| 121 | duplicate = mg_globals.database.media_entries.find_one( |
| 122 | {'slug': self['slug']}) |
| 123 | |
| 124 | if duplicate: |
| 125 | self['slug'] = "%s-%s" % (self['_id'], self['slug']) |
| 126 | |
| 127 | def url_for_self(self, urlgen): |
| 128 | """ |
| 129 | Generate an appropriate url for ourselves |
| 130 | |
| 131 | Use a slug if we have one, else use our '_id'. |
| 132 | """ |
| 133 | uploader = self.uploader() |
| 134 | |
| 135 | if self.get('slug'): |
| 136 | return urlgen( |
| 137 | 'mediagoblin.user_pages.media_home', |
| 138 | user=uploader['username'], |
| 139 | media=self['slug']) |
| 140 | else: |
| 141 | return urlgen( |
| 142 | 'mediagoblin.user_pages.media_home', |
| 143 | user=uploader['username'], |
| 144 | media=unicode(self['_id'])) |
| 145 | |
| 146 | def url_to_prev(self, urlgen): |
| 147 | """ |
| 148 | Provide a url to the previous entry from this user, if there is one |
| 149 | """ |
| 150 | cursor = self.db.MediaEntry.find({'_id' : {"$gt": self['_id']}, |
| 151 | 'uploader': self['uploader'], |
| 152 | 'state': 'processed'}).sort( |
| 153 | '_id', ASCENDING).limit(1) |
| 154 | if cursor.count(): |
| 155 | return urlgen('mediagoblin.user_pages.media_home', |
| 156 | user=self.uploader()['username'], |
| 157 | media=unicode(cursor[0]['slug'])) |
| 158 | |
| 159 | def url_to_next(self, urlgen): |
| 160 | """ |
| 161 | Provide a url to the next entry from this user, if there is one |
| 162 | """ |
| 163 | cursor = self.db.MediaEntry.find({'_id' : {"$lt": self['_id']}, |
| 164 | 'uploader': self['uploader'], |
| 165 | 'state': 'processed'}).sort( |
| 166 | '_id', DESCENDING).limit(1) |
| 167 | |
| 168 | if cursor.count(): |
| 169 | return urlgen('mediagoblin.user_pages.media_home', |
| 170 | user=self.uploader()['username'], |
| 171 | media=unicode(cursor[0]['slug'])) |
| 172 | |
| 173 | def uploader(self): |
| 174 | return self.db.User.find_one({'_id': self['uploader']}) |
| 175 | |
| 176 | |
| 177 | class MediaComment(Document): |
| 178 | __collection__ = 'media_comments' |
| 179 | |
| 180 | structure = { |
| 181 | 'media_entry': ObjectId, |
| 182 | 'author': ObjectId, |
| 183 | 'created': datetime.datetime, |
| 184 | 'content': unicode, |
| 185 | 'content_html': unicode} |
| 186 | |
| 187 | required_fields = [ |
| 188 | 'media_entry', 'author', 'created', 'content'] |
| 189 | |
| 190 | default_values = { |
| 191 | 'created': datetime.datetime.utcnow} |
| 192 | |
| 193 | def media_entry(self): |
| 194 | return self.db.MediaEntry.find_one({'_id': self['media_entry']}) |
| 195 | |
| 196 | def author(self): |
| 197 | return self.db.User.find_one({'_id': self['author']}) |
| 198 | |
| 199 | REGISTER_MODELS = [ |
| 200 | MediaEntry, |
| 201 | User, |
| 202 | MediaComment] |
| 203 | |
| 204 | |
| 205 | def register_models(connection): |
| 206 | """ |
| 207 | Register all models in REGISTER_MODELS with this connection. |
| 208 | """ |
| 209 | connection.register(REGISTER_MODELS) |
| 210 | |