add missing sections.py
This commit is contained in:
bkfox
240
cms/sections.py
Normal file
240
cms/sections.py
Normal file
@ -0,0 +1,240 @@
|
||||
"""
|
||||
Define different Section css_class that can be used by views.Sections;
|
||||
"""
|
||||
import re
|
||||
|
||||
from django.templatetags.static import static
|
||||
from django.template.loader import render_to_string
|
||||
from django.views.generic.base import View
|
||||
from django.utils.html import escape
|
||||
from django.utils.translation import ugettext as _, ugettext_lazy
|
||||
|
||||
from honeypot.decorators import check_honeypot
|
||||
|
||||
from aircox.cms.forms import CommentForm
|
||||
|
||||
|
||||
class Section(View):
|
||||
"""
|
||||
On the contrary to Django's views, we create an instance of the view
|
||||
only once, when the server is run.
|
||||
|
||||
Attributes are not changed once they have been set, and are related
|
||||
to Section configuration/rendering. However, some data are considered
|
||||
as temporary, and are reset at each rendering, using given arguments.
|
||||
|
||||
! Important Note: values given for rendering are considered as safe
|
||||
HTML in templates.
|
||||
|
||||
Attributes:
|
||||
* template_name: template to use for rendering
|
||||
* tag: container's tags
|
||||
* css_class: css classes of the container
|
||||
* attr: HTML attributes of the container
|
||||
* hide_empty: if true, section is not rendered when content is empty
|
||||
|
||||
* title: title of the section
|
||||
* header: header of the section
|
||||
* footer: footer of the section
|
||||
|
||||
* object_required: if true and not object has been given, gets angry
|
||||
* object: (can be persistent) related object
|
||||
|
||||
"""
|
||||
template_name = 'aircox/cms/content_object.html'
|
||||
|
||||
tag = 'div'
|
||||
css_class = ''
|
||||
attrs = ''
|
||||
hide_empty = False
|
||||
title = ''
|
||||
header = ''
|
||||
footer = ''
|
||||
object = None
|
||||
|
||||
def __init__ (self, *args, **kwargs):
|
||||
super().__init__(*args, **kwargs)
|
||||
self.css_class += ' section'
|
||||
|
||||
def get_content(self):
|
||||
return ''
|
||||
|
||||
def get_context_data(self):
|
||||
return {
|
||||
'view': self,
|
||||
'tag': self.tag,
|
||||
'css_class': self.css_class,
|
||||
'attrs': self.attrs,
|
||||
'title': self.title,
|
||||
'header': self.header,
|
||||
'footer': self.footer,
|
||||
'content': self.get_content(),
|
||||
'object': self.object,
|
||||
}
|
||||
|
||||
def get(self, request, object=None, **kwargs):
|
||||
if not self.object:
|
||||
self.object = object
|
||||
|
||||
self.request = request
|
||||
self.kwargs = kwargs
|
||||
|
||||
context = self.get_context_data()
|
||||
# if not context['content'] and self.hide_empty:
|
||||
# return ''
|
||||
return render_to_string(self.template_name, context, request=request)
|
||||
|
||||
|
||||
class Image(Section):
|
||||
"""
|
||||
Render an image using the relative url or relative to self.object.
|
||||
|
||||
Attributes:
|
||||
* url: relative image url
|
||||
* rel_attr: name of the attribute of self.object to use
|
||||
"""
|
||||
url = None
|
||||
rel_attr = 'image'
|
||||
|
||||
def get_content(self, **kwargs):
|
||||
if self.url is None:
|
||||
image = getattr(self.object, self.rel_attr)
|
||||
return '<img src="{}">'.format(image.url) if image else ''
|
||||
return '<img src="{}">'.format(static(self.url))
|
||||
|
||||
|
||||
class Content(Section):
|
||||
"""
|
||||
Render content using the self.content or relative to self.object.
|
||||
|
||||
Attributes:
|
||||
* content: raw HTML code to render
|
||||
* rel_attr: name of the attribute of self.object to use
|
||||
"""
|
||||
content = None
|
||||
rel_attr = 'content'
|
||||
|
||||
def get_content(self):
|
||||
if self.content is None:
|
||||
# FIXME: markdown?
|
||||
content = getattr(self.object, self.rel_attr)
|
||||
content = escape(content)
|
||||
content = re.sub(r'(^|\n\n)((\n?[^\n])+)', r'<p>\2</p>', content)
|
||||
content = re.sub(r'\n', r'<br>', content)
|
||||
return content
|
||||
return str(self.content)
|
||||
|
||||
|
||||
class ListItem:
|
||||
"""
|
||||
Used to render items in simple lists and lists of posts.
|
||||
|
||||
In list of posts, it is used when an object is not a post but
|
||||
behaves like it.
|
||||
"""
|
||||
title = None
|
||||
content = None
|
||||
author = None
|
||||
date = None
|
||||
image = None
|
||||
detail_url = None
|
||||
|
||||
css_class = None
|
||||
attrs = None
|
||||
|
||||
def __init__ (self, post = None, **kwargs):
|
||||
if post:
|
||||
self.update_from(post)
|
||||
self.__dict__.update(**kwargs)
|
||||
|
||||
def update_from(self, post):
|
||||
"""
|
||||
Update empty fields using the given post
|
||||
"""
|
||||
for i in self.__class__.__dict__.keys():
|
||||
if i[0] == '_':
|
||||
continue
|
||||
if hasattr(post, i) and not getattr(self, i):
|
||||
setattr(self, i, getattr(post, i))
|
||||
if not self.detail_url and hasattr(post, 'detail_url'):
|
||||
self.detail_url = post.detail_url()
|
||||
|
||||
|
||||
class List(Section):
|
||||
"""
|
||||
Common interface for list configuration.
|
||||
|
||||
Attributes:
|
||||
* object_list: force an object list to be used
|
||||
* url: url to the list in full page
|
||||
* message_empty: message to print when list is empty (if not hiding)
|
||||
|
||||
* fields: fields of the items to render
|
||||
* image_size: size of the images
|
||||
* truncate: number of words to keep in content (0 = full content)
|
||||
"""
|
||||
template_name = 'aircox/cms/list.html'
|
||||
|
||||
object_list = None
|
||||
url = None
|
||||
message_empty = _('nothing')
|
||||
|
||||
fields = [ 'date', 'time', 'image', 'title', 'content' ]
|
||||
image_size = '64x64'
|
||||
truncate = 64
|
||||
|
||||
def __init__ (self, items = None, *args, **kwargs):
|
||||
"""
|
||||
If posts is given, create the object_list with instances
|
||||
of ListItem.
|
||||
"""
|
||||
super().__init__(*args, **kwargs)
|
||||
self.css_class += ' list'
|
||||
if items:
|
||||
self.object_list = [
|
||||
ListItem(item) for item in items
|
||||
]
|
||||
|
||||
def get_object_list(self):
|
||||
return self.object_list
|
||||
|
||||
def get_context_data(self):
|
||||
context = super().get_context_data()
|
||||
context.update({
|
||||
'base_template': 'aircox/cms/section.html',
|
||||
'list': self,
|
||||
'object_list': self.object_list or self.get_object_list(),
|
||||
})
|
||||
return context
|
||||
|
||||
|
||||
class Comments(List):
|
||||
"""
|
||||
Section used to render comment form and comments list. It only render
|
||||
the form if the comments are enabled on the target object.
|
||||
|
||||
It does not handle comment posts, this is directly done at the
|
||||
level of the detail view.
|
||||
"""
|
||||
css_class="comments"
|
||||
truncate = 0
|
||||
fields = [ 'date', 'time', 'author', 'content' ]
|
||||
|
||||
def get_object_list(self):
|
||||
qs = self.object.get_comments().filter(published=True). \
|
||||
order_by('-date')
|
||||
return [ ListItem(post=comment, css_class="comment",
|
||||
attrs={ 'id': comment.id })
|
||||
for comment in qs ]
|
||||
|
||||
def get_context_data(self):
|
||||
context = super().get_context_data()
|
||||
post = self.object
|
||||
context.update({
|
||||
'base_template': 'aircox/cms/comments.html',
|
||||
'comment_form': CommentForm() \
|
||||
if hasattr(post, 'allow_comments') and post.allow_comments \
|
||||
else None
|
||||
})
|
||||
return context
|
||||
|
||||
Reference in New Issue
Block a user