1 # GNU MediaGoblin -- federated, autonomous media hosting
2 # Copyright (C) 2011 MediaGoblin contributors. See AUTHORS.
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.
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.
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/>.
19 from mongokit
import Document
21 from mediagoblin
.auth
import lib
as auth_lib
22 from mediagoblin
import mg_globals
23 from mediagoblin
.db
.mongo
import migrations
24 from mediagoblin
.db
.mongo
.util
import ASCENDING
, DESCENDING
, ObjectId
25 from mediagoblin
.tools
.pagination
import Pagination
26 from mediagoblin
.tools
import url
, common
39 A user of MediaGoblin.
42 - username: The username of this user, should be unique to this instance.
43 - email: Email address of this user
44 - created: When the user was created
45 - plugin_data: a mapping of extra plugin information for this User.
46 Nothing uses this yet as we don't have plugins, but someday we
48 - pw_hash: Hashed version of user's password.
49 - email_verified: Whether or not the user has verified their email or not.
50 Most parts of the site are disabled for users who haven't yet.
51 - status: whether or not the user is active, etc. Currently only has two
52 values, 'needs_email_verification' or 'active'. (In the future, maybe
53 we'll change this to a boolean with a key of 'active' and have a
54 separate field for a reason the user's been disabled if that's
55 appropriate... email_verified is already separate, after all.)
56 - verification_key: If the user is awaiting email verification, the user
57 will have to provide this key (which will be encoded in the presented
58 URL) in order to confirm their email as active.
59 - is_admin: Whether or not this user is an administrator or not.
60 - url: this user's personal webpage/website, if appropriate.
61 - bio: biography of this user (plaintext, in markdown)
62 - bio_html: biography of the user converted to proper HTML.
64 __collection__
= 'users'
65 use_dot_notation
= True
70 'created': datetime
.datetime
,
71 'plugin_data': dict, # plugins can dump stuff here.
73 'email_verified': bool,
75 'verification_key': unicode,
78 'bio': unicode, # May contain markdown
79 'bio_html': unicode, # May contain plaintext, or HTML
80 'fp_verification_key': unicode, # forgotten password verification key
81 'fp_token_expire': datetime
.datetime
,
84 required_fields
= ['username', 'created', 'pw_hash', 'email']
87 'created': datetime
.datetime
.utcnow
,
88 'email_verified': False,
89 'status': u
'needs_email_verification',
92 def check_login(self
, password
):
94 See if a user can login with this password
96 return auth_lib
.bcrypt_check_password(
97 password
, self
.pw_hash
)
100 class MediaEntry(Document
):
102 Record of a piece of media.
105 - uploader: A reference to a User who uploaded this.
107 - title: Title of this work
109 - slug: A normalized "slug" which can be used as part of a URL to retrieve
110 this work, such as 'my-works-name-in-slug-form' may be viewable by
111 'http://mg.example.org/u/username/m/my-works-name-in-slug-form/'
112 Note that since URLs are constructed this way, slugs must be unique
113 per-uploader. (An index is provided to enforce that but code should be
114 written on the python side to ensure this as well.)
116 - created: Date and time of when this piece of work was uploaded.
118 - description: Uploader-set description of this work. This can be marked
119 up with MarkDown for slight fanciness (links, boldness, italics,
122 - description_html: Rendered version of the description, run through
123 Markdown and cleaned with our cleaning tool.
125 - media_type: What type of media is this? Currently we only support
128 - media_data: Extra information that's media-format-dependent.
129 For example, images might contain some EXIF data that's not appropriate
130 to other formats. You might store it like:
132 mediaentry.media_data['exif'] = {
133 'manufacturer': 'CASIO',
135 'exposure_time': .659}
137 Alternately for video you might store:
139 # play length in seconds
140 mediaentry.media_data['play_length'] = 340
142 ... so what's appropriate here really depends on the media type.
144 - plugin_data: a mapping of extra plugin information for this User.
145 Nothing uses this yet as we don't have plugins, but someday we
148 - tags: A list of tags. Each tag is stored as a dictionary that has a key
149 for the actual name and the normalized name-as-slug, so ultimately this
151 [{'name': 'Gully Gardens',
152 'slug': 'gully-gardens'},
153 {'name': 'Castle Adventure Time?!",
154 'slug': 'castle-adventure-time'}]
156 - state: What's the state of this file? Active, inactive, disabled, etc...
157 But really for now there are only two states:
158 "unprocessed": uploaded but needs to go through processing for display
159 "processed": processed and able to be displayed
161 - queued_media_file: storage interface style filepath describing a file
162 queued for processing. This is stored in the mg_globals.queue_store
165 - queued_task_id: celery task id. Use this to fetch the task state.
167 - media_files: Files relevant to this that have actually been processed
168 and are available for various types of display. Stored like:
169 {'thumb': ['dir1', 'dir2', 'pic.png'}
171 - attachment_files: A list of "attachment" files, ones that aren't
172 critical to this piece of media but may be usefully relevant to people
173 viewing the work. (currently unused.)
175 - fail_error: path to the exception raised
178 __collection__
= 'media_entries'
179 use_dot_notation
= True
182 'uploader': ObjectId
,
185 'created': datetime
.datetime
,
186 'description': unicode, # May contain markdown/up
187 'description_html': unicode, # May contain plaintext, or HTML
188 'media_type': unicode,
189 'media_data': dict, # extra data relevant to this media_type
190 'plugin_data': dict, # plugins can dump stuff here.
194 # For now let's assume there can only be one main file queued
196 'queued_media_file': [unicode],
197 'queued_task_id': unicode,
199 # A dictionary of logical names to filepaths
202 # The following should be lists of lists, in appropriate file
204 'attachment_files': list,
206 # If things go badly in processing things, we'll store that
208 'fail_error': unicode,
209 'fail_metadata': dict}
212 'uploader', 'created', 'media_type', 'slug']
215 'created': datetime
.datetime
.utcnow
,
216 'state': u
'unprocessed'}
218 def get_comments(self
, ascending
=False):
224 return self
.db
.MediaComment
.find({
225 'media_entry': self
._id
}).sort('created', order
)
227 def get_display_media(self
, media_map
,
228 fetch_order
=common
.DISPLAY_IMAGE_FETCHING_ORDER
):
230 Find the best media for display.
233 - media_map: a dict like
234 {u'image_size': [u'dir1', u'dir2', u'image.jpg']}
235 - fetch_order: the order we should try fetching images in
238 (media_size, media_path)
240 media_sizes
= media_map
.keys()
242 for media_size
in common
.DISPLAY_IMAGE_FETCHING_ORDER
:
243 if media_size
in media_sizes
:
244 return media_map
[media_size
]
246 def main_mediafile(self
):
249 def generate_slug(self
):
250 self
.slug
= url
.slugify(self
.title
)
252 duplicate
= mg_globals
.database
.media_entries
.find_one(
256 self
.slug
= "%s-%s" % (self
._id
, self
.slug
)
258 def url_for_self(self
, urlgen
):
260 Generate an appropriate url for ourselves
262 Use a slug if we have one, else use our '_id'.
264 uploader
= self
.get_uploader
268 'mediagoblin.user_pages.media_home',
269 user
=uploader
.username
,
273 'mediagoblin.user_pages.media_home',
274 user
=uploader
.username
,
275 media
=unicode(self
._id
))
277 def url_to_prev(self
, urlgen
):
279 Provide a url to the previous entry from this user, if there is one
281 cursor
= self
.db
.MediaEntry
.find({'_id': {"$gt": self
._id
},
282 'uploader': self
.uploader
,
283 'state': 'processed'}).sort(
284 '_id', ASCENDING
).limit(1)
286 return media
.url_for_self(urlgen
)
288 def url_to_next(self
, urlgen
):
290 Provide a url to the next entry from this user, if there is one
292 cursor
= self
.db
.MediaEntry
.find({'_id': {"$lt": self
._id
},
293 'uploader': self
.uploader
,
294 'state': 'processed'}).sort(
295 '_id', DESCENDING
).limit(1)
298 return media
.url_for_self(urlgen
)
301 def get_uploader(self
):
302 return self
.db
.User
.find_one({'_id': self
.uploader
})
304 def get_fail_exception(self
):
306 Get the exception that's appropriate for this error
308 if self
['fail_error']:
309 return common
.import_component(self
['fail_error'])
312 class MediaComment(Document
):
314 A comment on a MediaEntry.
317 - media_entry: The media entry this comment is attached to
318 - author: user who posted this comment
319 - created: when the comment was created
320 - content: plaintext (but markdown'able) version of the comment's content.
321 - content_html: the actual html-rendered version of the comment displayed.
322 Run through Markdown and the HTML cleaner.
325 __collection__
= 'media_comments'
326 use_dot_notation
= True
329 'media_entry': ObjectId
,
331 'created': datetime
.datetime
,
333 'content_html': unicode}
336 'media_entry', 'author', 'created', 'content']
339 'created': datetime
.datetime
.utcnow
}
341 def media_entry(self
):
342 return self
.db
.MediaEntry
.find_one({'_id': self
['media_entry']})
345 def get_author(self
):
346 return self
.db
.User
.find_one({'_id': self
['author']})
355 def register_models(connection
):
357 Register all models in REGISTER_MODELS with this connection.
359 connection
.register(REGISTER_MODELS
)