Commit | Line | Data |
---|---|---|
8e1e744d | 1 | # GNU MediaGoblin -- federated, autonomous media hosting |
e5572c60 ML |
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 | ||
db1a438f | 17 | import datetime, uuid |
4ad5af85 | 18 | |
d232e0f6 | 19 | from mongokit import Document, Set |
4329be14 | 20 | |
0546833c | 21 | from mediagoblin import util |
4ad5af85 | 22 | from mediagoblin.auth import lib as auth_lib |
0546833c | 23 | from mediagoblin import globals as mediagoblin_globals |
757f37a5 CAW |
24 | from mediagoblin.db import migrations |
25 | from mediagoblin.db.util import ObjectId | |
d232e0f6 | 26 | |
7bf3f5db CAW |
27 | ################### |
28 | # Custom validators | |
29 | ################### | |
30 | ||
31 | ######## | |
32 | # Models | |
33 | ######## | |
34 | ||
35 | ||
d232e0f6 | 36 | class User(Document): |
73a6e206 CAW |
37 | __collection__ = 'users' |
38 | ||
d232e0f6 CAW |
39 | structure = { |
40 | 'username': unicode, | |
24181820 | 41 | 'email': unicode, |
d232e0f6 CAW |
42 | 'created': datetime.datetime, |
43 | 'plugin_data': dict, # plugins can dump stuff here. | |
44 | 'pw_hash': unicode, | |
24181820 | 45 | 'email_verified': bool, |
4d75522b | 46 | 'status': unicode, |
18cf34d4 CAW |
47 | 'verification_key': unicode, |
48 | 'is_admin': bool, | |
d232e0f6 CAW |
49 | } |
50 | ||
db5912e3 | 51 | required_fields = ['username', 'created', 'pw_hash', 'email'] |
fc9bb821 CAW |
52 | |
53 | default_values = { | |
24181820 | 54 | 'created': datetime.datetime.utcnow, |
4d75522b | 55 | 'email_verified': False, |
db1a438f | 56 | 'status': u'needs_email_verification', |
18cf34d4 CAW |
57 | 'verification_key': lambda: unicode(uuid.uuid4()), |
58 | 'is_admin': False} | |
fc9bb821 | 59 | |
4ad5af85 CAW |
60 | def check_login(self, password): |
61 | """ | |
62 | See if a user can login with this password | |
63 | """ | |
64 | return auth_lib.bcrypt_check_password( | |
65 | password, self['pw_hash']) | |
66 | ||
b93a6a22 AM |
67 | def generate_new_verification_key(self): |
68 | """ | |
69 | Create a new verification key, overwriting the old one. | |
70 | """ | |
71 | ||
72 | self['verification_key'] = unicode(uuid.uuid4()) | |
73 | self.save(validate=False) | |
74 | ||
d232e0f6 | 75 | |
4d75522b CAW |
76 | class MediaEntry(Document): |
77 | __collection__ = 'media_entries' | |
78 | ||
79 | structure = { | |
757f37a5 | 80 | 'uploader': ObjectId, |
4d75522b | 81 | 'title': unicode, |
1013bdaf | 82 | 'slug': unicode, |
4d75522b CAW |
83 | 'created': datetime.datetime, |
84 | 'description': unicode, | |
85 | 'media_type': unicode, | |
86 | 'media_data': dict, # extra data relevant to this media_type | |
87 | 'plugin_data': dict, # plugins can dump stuff here. | |
74ae6b11 CAW |
88 | 'tags': [unicode], |
89 | 'state': unicode, | |
90 | ||
fa7f9c61 CAW |
91 | # For now let's assume there can only be one main file queued |
92 | # at a time | |
93 | 'queued_media_file': [unicode], | |
94 | ||
95 | # A dictionary of logical names to filepaths | |
96 | 'media_files': dict, | |
97 | ||
74ae6b11 CAW |
98 | # The following should be lists of lists, in appropriate file |
99 | # record form | |
74ae6b11 | 100 | 'attachment_files': list, |
74ae6b11 CAW |
101 | |
102 | # This one should just be a single file record | |
103 | 'thumbnail_file': [unicode]} | |
4d75522b CAW |
104 | |
105 | required_fields = [ | |
b1ae76ae | 106 | 'uploader', 'created', 'media_type', 'slug'] |
4d75522b CAW |
107 | |
108 | default_values = { | |
74ae6b11 CAW |
109 | 'created': datetime.datetime.utcnow, |
110 | 'state': u'unprocessed'} | |
4d75522b | 111 | |
757f37a5 CAW |
112 | migration_handler = migrations.MediaEntryMigration |
113 | ||
b1ae76ae CAW |
114 | indexes = [ |
115 | # Referene uniqueness of slugs by uploader | |
116 | {'fields': ['uploader', 'slug'], | |
117 | 'unique': True}] | |
37af09a2 | 118 | |
4d75522b CAW |
119 | def main_mediafile(self): |
120 | pass | |
121 | ||
0546833c AW |
122 | def generate_slug(self): |
123 | self['slug'] = util.slugify(self['title']) | |
124 | ||
f0545dde CAW |
125 | duplicate = mediagoblin_globals.database.media_entries.find_one( |
126 | {'slug': self['slug']}) | |
0546833c AW |
127 | |
128 | if duplicate: | |
129 | self['slug'] = "%s-%s" % (self['_id'], self['slug']) | |
4d75522b | 130 | |
6926b23d CAW |
131 | def url_for_self(self, urlgen): |
132 | """ | |
133 | Generate an appropriate url for ourselves | |
134 | ||
135 | Use a slug if we have one, else use our '_id'. | |
136 | """ | |
16509be1 CAW |
137 | uploader = self.uploader() |
138 | ||
6926b23d CAW |
139 | if self.get('slug'): |
140 | return urlgen( | |
141 | 'mediagoblin.user_pages.media_home', | |
16509be1 | 142 | user=uploader['username'], |
6926b23d CAW |
143 | media=self['slug']) |
144 | else: | |
145 | return urlgen( | |
146 | 'mediagoblin.user_pages.media_home', | |
16509be1 | 147 | user=uploader['username'], |
6926b23d CAW |
148 | media=unicode(self['_id'])) |
149 | ||
16509be1 CAW |
150 | def uploader(self): |
151 | return self.db.User.find_one({'_id': self['uploader']}) | |
152 | ||
6926b23d | 153 | |
d232e0f6 CAW |
154 | REGISTER_MODELS = [MediaEntry, User] |
155 | ||
4329be14 | 156 | |
d232e0f6 CAW |
157 | def register_models(connection): |
158 | """ | |
159 | Register all models in REGISTER_MODELS with this connection. | |
160 | """ | |
db61f7d1 CAW |
161 | connection.register(REGISTER_MODELS) |
162 |