feba5c5287
After a bit of discussion, we decided to drop the pre-rendered html from the database and render it on the fly. In another step, we will use some proper caching method to cache this stuff. This commit affects the MediaComment.content_html part.
117 lines
3.6 KiB
Python
117 lines
3.6 KiB
Python
# GNU MediaGoblin -- federated, autonomous media hosting
|
|
# Copyright (C) 2011, 2012 MediaGoblin contributors. See AUTHORS.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
"""
|
|
This module contains some Mixin classes for the db objects.
|
|
|
|
A bunch of functions on the db objects are really more like
|
|
"utility functions": They could live outside the classes
|
|
and be called "by hand" passing the appropiate reference.
|
|
They usually only use the public API of the object and
|
|
rarely use database related stuff.
|
|
|
|
These functions now live here and get "mixed in" into the
|
|
real objects.
|
|
"""
|
|
|
|
from mediagoblin.auth import lib as auth_lib
|
|
from mediagoblin.tools import common, licenses
|
|
from mediagoblin.tools.text import cleaned_markdown_conversion
|
|
|
|
|
|
class UserMixin(object):
|
|
def check_login(self, password):
|
|
"""
|
|
See if a user can login with this password
|
|
"""
|
|
return auth_lib.bcrypt_check_password(
|
|
password, self.pw_hash)
|
|
|
|
@property
|
|
def bio_html(self):
|
|
return cleaned_markdown_conversion(self.bio)
|
|
|
|
|
|
class MediaEntryMixin(object):
|
|
@property
|
|
def description_html(self):
|
|
"""
|
|
Rendered version of the description, run through
|
|
Markdown and cleaned with our cleaning tool.
|
|
"""
|
|
return cleaned_markdown_conversion(self.description)
|
|
|
|
def get_display_media(self, media_map,
|
|
fetch_order=common.DISPLAY_IMAGE_FETCHING_ORDER):
|
|
"""
|
|
Find the best media for display.
|
|
|
|
Args:
|
|
- media_map: a dict like
|
|
{u'image_size': [u'dir1', u'dir2', u'image.jpg']}
|
|
- fetch_order: the order we should try fetching images in
|
|
|
|
Returns:
|
|
(media_size, media_path)
|
|
"""
|
|
media_sizes = media_map.keys()
|
|
|
|
for media_size in common.DISPLAY_IMAGE_FETCHING_ORDER:
|
|
if media_size in media_sizes:
|
|
return media_map[media_size]
|
|
|
|
def main_mediafile(self):
|
|
pass
|
|
|
|
@property
|
|
def slug_or_id(self):
|
|
return (self.slug or self._id)
|
|
|
|
def url_for_self(self, urlgen, **extra_args):
|
|
"""
|
|
Generate an appropriate url for ourselves
|
|
|
|
Use a slug if we have one, else use our '_id'.
|
|
"""
|
|
uploader = self.get_uploader
|
|
|
|
return urlgen(
|
|
'mediagoblin.user_pages.media_home',
|
|
user=uploader.username,
|
|
media=self.slug_or_id,
|
|
**extra_args)
|
|
|
|
def get_fail_exception(self):
|
|
"""
|
|
Get the exception that's appropriate for this error
|
|
"""
|
|
if self['fail_error']:
|
|
return common.import_component(self['fail_error'])
|
|
|
|
def get_license_data(self):
|
|
"""Return license dict for requested license"""
|
|
return licenses.SUPPORTED_LICENSES[self.license or ""]
|
|
|
|
|
|
class MediaCommentMixin(object):
|
|
@property
|
|
def content_html(self):
|
|
"""
|
|
the actual html-rendered version of the comment displayed.
|
|
Run through Markdown and the HTML cleaner.
|
|
"""
|
|
return cleaned_markdown_conversion(self.content)
|