class BlogPage(AbstractFilterPage):
content = StreamField([
('full_width_text', organisms.FullWidthText()),
('info_unit_group', organisms.InfoUnitGroup()),
('expandable', organisms.Expandable()),
('well', organisms.Well()),
('video_player', organisms.VideoPlayer()),
('email_signup', organisms.EmailSignUp()),
('feedback', v1_blocks.Feedback()),
])
edit_handler = AbstractFilterPage.generate_edit_handler(
content_panel=StreamFieldPanel('content'))
template = 'blog/blog_page.html'
objects = PageManager()
search_fields = AbstractFilterPage.search_fields + [
index.SearchField('content')
]
def get_context(self, request, *args, **kwargs):
context = super(BlogPage, self).get_context(request, *args, **kwargs)
context['rss_feed'] = get_appropriate_rss_feed_url_for_page(
self, request=request)
return context
class SublandingFilterablePage(FilterableFeedPageMixin,
FilterableListMixin,
CFGOVPage):
header = StreamField([
('hero', molecules.Hero()),
], blank=True)
content = StreamField([
('text_introduction', molecules.TextIntroduction()),
('full_width_text', organisms.FullWidthText()),
('filter_controls', organisms.FilterControls()),
('featured_content', molecules.FeaturedContent()),
('feedback', v1_blocks.Feedback()),
])
# General content tab
content_panels = CFGOVPage.content_panels + [
StreamFieldPanel('header'),
StreamFieldPanel('content'),
]
# Tab handler interface
edit_handler = TabbedInterface([
ObjectList(content_panels, heading='General Content'),
ObjectList(CFGOVPage.sidefoot_panels, heading='Sidebar'),
ObjectList(CFGOVPage.settings_panels, heading='Configuration'),
])
template = 'sublanding-page/index.html'
objects = PageManager()
class LearnPage(AbstractFilterPage):
content = StreamField([
('full_width_text', organisms.FullWidthText()),
('info_unit_group', organisms.InfoUnitGroup()),
('expandable_group', organisms.ExpandableGroup()),
('contact_expandable_group', organisms.ContactExpandableGroup()),
('expandable', organisms.Expandable()),
('well', organisms.Well()),
('call_to_action', molecules.CallToAction()),
('email_signup', organisms.EmailSignUp()),
('video_player', organisms.VideoPlayer()),
('audio_player', organisms.AudioPlayer()),
('table_block', organisms.AtomicTableBlock(
table_options={'renderer': 'html'}
)),
('feedback', v1_blocks.Feedback()),
], blank=True)
edit_handler = AbstractFilterPage.generate_edit_handler(
content_panel=StreamFieldPanel('content')
)
template = 'learn-page/index.html'
objects = PageManager()
search_fields = AbstractFilterPage.search_fields + [
index.SearchField('content')
]
class PayingForCollegeContent(blocks.StreamBlock):
"""A base content block for PFC pages."""
full_width_text = organisms.FullWidthText()
info_unit_group = organisms.InfoUnitGroup()
expandable_group = organisms.ExpandableGroup()
expandable = organisms.Expandable()
well = organisms.Well()
raw_html_block = blocks.RawHTMLBlock(label='Raw HTML block')
class BrowseFilterableContent(StreamBlock):
"""Defines the StreamField blocks for BrowseFilterablePage content.
Pages can have at most one filterable list.
"""
full_width_text = organisms.FullWidthText()
filter_controls = organisms.FilterableList()
feedback = v1_blocks.Feedback()
class Meta:
block_counts = {
'filter_controls': {'max_num': 1},
}
class BlogPage(AbstractFilterPage):
content = StreamField([
('full_width_text', organisms.FullWidthText()),
('image_text_50_50_group', organisms.ImageText5050Group()),
('feedback', v1_blocks.Feedback()),
('email_signup', organisms.EmailSignUp()),
('expandable', organisms.Expandable()),
])
edit_handler = AbstractFilterPage.generate_edit_handler(
content_panel=StreamFieldPanel('content'))
template = 'blog/blog_page.html'
objects = PageManager()
class DocumentDetailPage(AbstractFilterPage):
content = StreamField([
('full_width_text', organisms.FullWidthText()),
('expandable', organisms.Expandable()),
('expandable_group', organisms.ExpandableGroup()),
('table_block',
organisms.AtomicTableBlock(table_options={'renderer': 'html'})),
('feedback', v1_blocks.Feedback()),
],
blank=True)
edit_handler = AbstractFilterPage.generate_edit_handler(
content_panel=StreamFieldPanel('content'))
template = 'document-detail/index.html'
objects = PageManager()
class BlogPage(AbstractFilterPage):
content = StreamField([
('full_width_text', organisms.FullWidthText()),
('info_unit_group', organisms.InfoUnitGroup()),
('expandable', organisms.Expandable()),
('well', organisms.Well()),
('email_signup', organisms.EmailSignUp()),
('feedback', v1_blocks.Feedback()),
])
edit_handler = AbstractFilterPage.generate_edit_handler(
content_panel=StreamFieldPanel('content'))
template = 'blog/blog_page.html'
objects = PageManager()
search_fields = AbstractFilterPage.search_fields + [
index.SearchField('content')
]
class SublandingFilterableContent(StreamBlock):
"""Defines the StreamField blocks for SublandingFilterablePage content.
Pages can have at most one filterable list.
"""
text_introduction = molecules.TextIntroduction()
full_width_text = organisms.FullWidthText()
filter_controls = organisms.FilterableList()
featured_content = organisms.FeaturedContent()
feedback = v1_blocks.Feedback()
class Meta:
block_counts = {
'filter_controls': {
'max_num': 1
},
}
class BrowseFilterablePage(FilterableFeedPageMixin,
FilterableListMixin,
CFGOVPage):
header = StreamField([
('text_introduction', molecules.TextIntroduction()),
('featured_content', molecules.FeaturedContent()),
])
content = StreamField([
('full_width_text', organisms.FullWidthText()),
('filter_controls', organisms.FilterControls()),
('feedback', v1_blocks.Feedback()),
])
secondary_nav_exclude_sibling_pages = models.BooleanField(default=False)
# General content tab
content_panels = CFGOVPage.content_panels + [
StreamFieldPanel('header'),
StreamFieldPanel('content'),
]
sidefoot_panels = CFGOVPage.sidefoot_panels + [
FieldPanel('secondary_nav_exclude_sibling_pages'),
]
# Tab handler interface
edit_handler = TabbedInterface([
ObjectList(content_panels, heading='General Content'),
ObjectList(sidefoot_panels, heading='SideFoot'),
ObjectList(CFGOVPage.settings_panels, heading='Configuration'),
])
template = 'browse-filterable/index.html'
objects = PageManager()
@property
def page_js(self):
return (
super(BrowseFilterablePage, self).page_js
+ ['secondary-navigation.js']
)
class ConferenceRegistrationForm(AbstractFormBlock):
heading = blocks.CharBlock(
required=False,
help_text=('Note: Additional form field options will appear in '
'Preview and Publish modes.'))
code = blocks.CharBlock(label='GovDelivery Code')
sessions = blocks.ListBlock(blocks.CharBlock(label='Session'),
label='Sessions attending')
capacity = atoms.IntegerBlock(help_text=(
'Enter an integer that will be the conference attendance limit.'))
success_message = blocks.RichTextBlock(help_text=(
'Enter a message that will be shown on successful registration.'))
at_capacity_message = organisms.FullWidthText(help_text=(
'Enter a message that will be shown when the event is at capacity.'))
failure_message = blocks.CharBlock(
help_text=('Enter a message that will be shown if the GovDelivery '
'subscription fails.'))
class Meta:
handler = 'data_research.handlers.ConferenceRegistrationHandler'
template = '_includes/conference-registration-form.html'
class EnforcementActionPage(AbstractFilterPage):
sidebar_header = models.CharField(
default='Action details',
max_length=100
)
court = models.CharField(default='', max_length=150, blank=True)
institution_type = models.CharField(max_length=50, choices=[
('Nonbank', 'Nonbank'),
('Bank', 'Bank')
])
content = StreamField([
('full_width_text', organisms.FullWidthText()),
('expandable', organisms.Expandable()),
('expandable_group', organisms.ExpandableGroup()),
('notification', molecules.Notification()),
('table_block', organisms.AtomicTableBlock(
table_options={'renderer': 'html'})),
('feedback', v1_blocks.Feedback()),
], blank=True)
content_panels = [
StreamFieldPanel('header'),
StreamFieldPanel('content')
]
metadata_panels = [
MultiFieldPanel([
FieldPanel('sidebar_header'),
FieldPanel('court'),
FieldPanel('institution_type'),
FieldPanel('date_filed'),
FieldPanel('tags', 'Tags'),
], heading='Basic Metadata'),
MultiFieldPanel([
InlinePanel(
'docket_numbers',
label="Docket Number",
min_num=1
),
], heading='Docket Number'),
MultiFieldPanel([
InlinePanel('statuses', label="Enforcement Status", min_num=1),
], heading='Enforcement Status'),
MultiFieldPanel([
InlinePanel('categories', label="Categories",
min_num=1, max_num=2),
], heading='Categories'),
]
settings_panels = [
MultiFieldPanel(CFGOVPage.promote_panels, 'Settings'),
MultiFieldPanel([
FieldPanel('preview_title'),
FieldPanel('preview_subheading'),
FieldPanel('preview_description'),
FieldPanel('secondary_link_url'),
FieldPanel('secondary_link_text'),
ImageChooserPanel('preview_image'),
], heading='Page Preview Fields', classname='collapsible'),
FieldPanel('authors', 'Authors'),
MultiFieldPanel([
FieldPanel('date_published'),
FieldPanel('comments_close_by'),
], 'Relevant Dates', classname='collapsible'),
MultiFieldPanel(Page.settings_panels, 'Scheduled Publishing'),
FieldPanel('language', 'Language'),
]
edit_handler = TabbedInterface([
ObjectList(
AbstractFilterPage.content_panels + content_panels,
heading='General Content'
),
ObjectList(metadata_panels, heading='Metadata'),
ObjectList(CFGOVPage.sidefoot_panels, heading='Sidebar'),
ObjectList(settings_panels, heading='Configuration')
])
template = 'enforcement-action/index.html'
objects = PageManager()
search_fields = AbstractFilterPage.search_fields + [
index.SearchField('content')
]
class RegulationPage(RoutablePageMixin, SecondaryNavigationJSMixin, CFGOVPage):
"""A routable page for serving an eregulations page by Section ID."""
objects = PageManager()
parent_page_types = ['regulations3k.RegulationLandingPage']
subpage_types = []
template = 'regulations3k/browse-regulation.html'
header = StreamField([
('text_introduction', molecules.TextIntroduction()),
],
blank=True)
content = StreamField([
('info_unit_group', organisms.InfoUnitGroup()),
('full_width_text', organisms.FullWidthText()),
],
null=True,
blank=True)
regulation = models.ForeignKey(Part,
blank=True,
null=True,
on_delete=models.PROTECT,
related_name='page')
content_panels = CFGOVPage.content_panels + [
StreamFieldPanel('header'),
StreamFieldPanel('content'),
FieldPanel('regulation', Part),
]
secondary_nav_exclude_sibling_pages = models.BooleanField(default=False)
sidefoot_panels = CFGOVPage.sidefoot_panels + [
FieldPanel('secondary_nav_exclude_sibling_pages'),
]
edit_handler = TabbedInterface([
ObjectList(content_panels, heading='General Content'),
ObjectList(sidefoot_panels, heading='Sidebar'),
ObjectList(CFGOVPage.settings_panels, heading='Configuration'),
])
def can_serve_draft_versions(self, request):
perms = request.user.get_all_permissions()
if (request.user.is_superuser
or getattr(request, 'served_by_wagtail_sharing', False)
or 'regulations3k.change_section' in perms):
return True
return False
def get_versions_query(self, request):
versions = self.regulation.versions
if not self.can_serve_draft_versions(request):
versions = versions.filter(draft=False)
return versions
def get_effective_version(self, request, date_str=None):
""" Get the requested effective version if the user has permission """
query_filter = {}
if date_str is None:
query_filter['effective_date__lte'] = date.today()
else:
query_filter['effective_date'] = date_str
draft_permission = self.can_serve_draft_versions(request)
if not draft_permission:
query_filter['draft'] = False
effective_version = self.regulation.versions.filter(
**query_filter).order_by('-effective_date').first()
if effective_version is None:
raise Http404
return effective_version
def get_section_query(self, request=None, effective_version=None):
"""Query set for Sections in this regulation's effective version."""
if effective_version is None:
effective_version = self.get_effective_version(request)
return Section.objects.filter(subpart__version=effective_version)
def get_context(self, request, *args, **kwargs):
context = super(RegulationPage,
self).get_context(request, *args, **kwargs)
context.update({
'regulation':
self.regulation,
'current_version':
self.get_effective_version(request),
'breadcrumb_items':
self.get_breadcrumbs(request, *args, **kwargs),
'search_url':
(self.get_parent().url + 'search-regulations/results/?regs=' +
self.regulation.part_number),
'num_versions':
self.get_versions_query(request).count(),
})
return context
def get_breadcrumbs(self, request, section=None, **kwargs):
crumbs = super(RegulationPage, self).get_breadcrumbs(request)
if section is not None:
crumbs = crumbs + [
{
'href':
self.url + self.reverse_subpage(
'index',
kwargs={
k: v
for k, v in kwargs.items() if k == 'date_str'
}),
'title':
str(section.subpart.version.part),
},
]
return crumbs
def get_urls_for_version(self, effective_version, section=None):
base_url = self.get_full_url()
versions_url = urljoin(base_url, 'versions') + '/'
if effective_version.live_version:
# This is the current version
version_url = base_url
else:
# It's a past or future version, URLs have the date str
date_str = str(effective_version.effective_date)
version_url = urljoin(base_url, date_str) + '/'
yield version_url
if section is not None:
yield urljoin(version_url, section.label) + '/'
else:
sections = self.get_section_query(
effective_version=effective_version)
yield version_url
yield versions_url
for section in sections.all():
yield urljoin(version_url, section.label) + '/'
def render_interp(self, context, raw_contents, **kwargs):
template = get_template('regulations3k/inline_interps.html')
# Extract the title from the raw regdown
section_title_match = re.search(r'#+\s?(?P<section_title>.*)\s',
raw_contents)
if section_title_match is not None:
context.update({'section_title': section_title_match.group(1)})
span = section_title_match.span()
raw_contents = raw_contents[:span[0]] + raw_contents[span[1]:]
context.update({'contents': regdown(raw_contents)})
context.update(kwargs)
return template.render(context)
@route(r'^(?:(?P<date_str>[0-9]{4}-[0-9]{2}-[0-9]{2})/)?$', name="index")
def index_route(self, request, date_str=None):
request.is_preview = getattr(request, 'is_preview', False)
effective_version = self.get_effective_version(request,
date_str=date_str)
section_query = self.get_section_query(
effective_version=effective_version)
sections = list(section_query.all())
context = self.get_context(request)
context.update({
'requested_version':
effective_version,
'sections':
sections,
'get_secondary_nav_items':
partial(get_secondary_nav_items,
sections=sections,
date_str=date_str),
})
if date_str is not None:
context['date_str'] = date_str
return TemplateResponse(request, self.get_template(request), context)
@route(r'^versions/(?:(?P<section_label>' + label_re_str + r')/)?$',
name="versions")
def versions_page(self, request, section_label=None):
section_query = self.get_section_query(request=request)
sections = list(section_query.all())
context = self.get_context(request, sections=sections)
versions = [{
'effective_date':
v.effective_date,
'date_str':
str(v.effective_date),
'sections':
self.get_section_query(effective_version=v).all(),
'draft':
v.draft
} for v in self.get_versions_query(request).order_by('-effective_date')
]
context.update({
'versions':
versions,
'section_label':
section_label,
'get_secondary_nav_items':
partial(get_secondary_nav_items, sections=sections),
})
return TemplateResponse(request, self.template, context)
@route(r'^(?:(?P<date_str>[0-9]{4}-[0-9]{2}-[0-9]{2})/)?'
r'(?P<section_label>' + label_re_str + r')/$',
name="section")
def section_page(self, request, date_str=None, section_label=None):
""" Render a section of the currently effective regulation """
effective_version = self.get_effective_version(request,
date_str=date_str)
section_query = self.get_section_query(
effective_version=effective_version)
next_version = self.get_versions_query(request).filter(
effective_date__gt=effective_version.effective_date).first()
kwargs = {}
if date_str is not None:
kwargs['date_str'] = date_str
try:
section = section_query.get(label=section_label)
except Section.DoesNotExist:
return redirect(self.url +
self.reverse_subpage("index", kwargs=kwargs))
sections = list(section_query.all())
current_index = sections.index(section)
context = self.get_context(request,
section,
sections=sections,
**kwargs)
content = regdown(
section.contents,
url_resolver=get_url_resolver(self, date_str=date_str),
contents_resolver=get_contents_resolver(effective_version),
render_block_reference=partial(self.render_interp, context))
next_section = get_next_section(sections, current_index)
previous_section = get_previous_section(sections, current_index)
context.update({
'requested_version':
effective_version,
'next_version':
next_version,
'section':
section,
'content':
content,
'get_secondary_nav_items':
partial(get_secondary_nav_items,
sections=sections,
date_str=date_str),
'next_section':
next_section,
'next_url':
get_section_url(self, next_section, date_str=date_str),
'previous_section':
previous_section,
'previous_url':
get_section_url(self, previous_section, date_str=date_str),
})
return TemplateResponse(request, self.template, context)
class BrowsePage(CFGOVPage):
header = StreamField([
('text_introduction', molecules.TextIntroduction()),
('featured_content', organisms.FeaturedContent()),
],
blank=True)
content = StreamField([
('full_width_text', organisms.FullWidthText()),
('info_unit_group', organisms.InfoUnitGroup()),
('expandable_group', organisms.ExpandableGroup()),
('expandable', organisms.Expandable()),
('well', organisms.Well()),
('video_player', organisms.VideoPlayer()),
('snippet_list', organisms.ResourceList()),
('table_block',
organisms.AtomicTableBlock(table_options={'renderer': 'html'})),
('feedback', v1_blocks.Feedback()),
('raw_html_block', blocks.RawHTMLBlock(label='Raw HTML block')),
('conference_registration_form', ConferenceRegistrationForm()),
('chart_block', organisms.ChartBlock()),
('mortgage_chart_block', organisms.MortgageChartBlock()),
('mortgage_map_block', organisms.MortgageMapBlock()),
('mortgage_downloads_block', MortgageDataDownloads()),
('data_snapshot', organisms.DataSnapshot()),
('job_listing_table', JobListingTable()),
('bureau_structure', organisms.BureauStructure()),
('yes_checklist', YESChecklist()),
],
blank=True)
secondary_nav_exclude_sibling_pages = models.BooleanField(default=False)
share_and_print = models.BooleanField(
default=False,
help_text="Include share and print buttons above page content.")
# General content tab
content_panels = CFGOVPage.content_panels + [
StreamFieldPanel('header'),
FieldPanel('share_and_print'),
StreamFieldPanel('content'),
]
sidefoot_panels = CFGOVPage.sidefoot_panels + [
FieldPanel('secondary_nav_exclude_sibling_pages'),
]
# Tab handler interface
edit_handler = TabbedInterface([
ObjectList(content_panels, heading='General Content'),
ObjectList(sidefoot_panels, heading='Sidebar'),
ObjectList(CFGOVPage.settings_panels, heading='Configuration'),
])
template = 'browse-basic/index.html'
objects = PageManager()
search_fields = CFGOVPage.search_fields + [
index.SearchField('content'),
index.SearchField('header')
]
@property
def page_js(self):
return (super(BrowsePage, self).page_js + ['secondary-navigation.js'])
def get_context(self, request, *args, **kwargs):
context = super(BrowsePage, self).get_context(request, *args, **kwargs)
context.update({'get_secondary_nav_items': get_secondary_nav_items})
return context
class SublandingPage(CFGOVPage):
header = StreamField([
('hero', molecules.Hero()),
], blank=True)
content = StreamField([
('text_introduction', molecules.TextIntroduction()),
('featured_content', molecules.FeaturedContent()),
('info_unit_group', organisms.InfoUnitGroup()),
('image_text_25_75_group', organisms.ImageText2575Group()),
('image_text_50_50_group', organisms.ImageText5050Group()),
('full_width_text', organisms.FullWidthText()),
('half_width_link_blob_group', organisms.HalfWidthLinkBlobGroup()),
('third_width_link_blob_group', organisms.ThirdWidthLinkBlobGroup()),
('post_preview_snapshot', organisms.PostPreviewSnapshot()),
('well', organisms.Well()),
('table', organisms.Table(editable=False)),
('table_block',
organisms.AtomicTableBlock(table_options={'renderer': 'html'})),
('contact', organisms.MainContactInfo()),
('formfield_with_button', molecules.FormFieldWithButton()),
('reg_comment', organisms.RegComment()),
('feedback', v1_blocks.Feedback()),
('snippet_list', organisms.SnippetList()),
],
blank=True)
sidebar_breakout = StreamField([
('slug', blocks.CharBlock(icon='title')),
('heading', blocks.CharBlock(icon='title')),
('paragraph', blocks.RichTextBlock(icon='edit')),
('breakout_image',
blocks.StructBlock([
('image', ImageChooserBlock()),
('is_round',
blocks.BooleanBlock(required=False, default=True,
label='Round?')),
('icon', blocks.CharBlock(help_text='Enter icon class name.')),
('heading',
blocks.CharBlock(required=False, label='Introduction Heading')),
('body',
blocks.TextBlock(required=False, label='Introduction Body')),
],
heading='Breakout Image',
icon='image')),
('related_posts', organisms.RelatedPosts()),
('job_listing_list', JobListingList()),
],
blank=True)
# General content tab
content_panels = CFGOVPage.content_panels + [
StreamFieldPanel('header'),
StreamFieldPanel('content'),
]
sidebar_panels = [
StreamFieldPanel('sidebar_breakout'),
] + CFGOVPage.sidefoot_panels
# Tab handler interface
edit_handler = TabbedInterface([
ObjectList(content_panels, heading='General Content'),
ObjectList(sidebar_panels, heading='Sidebar'),
ObjectList(CFGOVPage.settings_panels, heading='Configuration'),
])
template = 'sublanding-page/index.html'
objects = PageManager()
def get_browsefilterable_posts(self, limit):
filter_pages = [
p.specific for p in self.get_appropriate_descendants()
if 'FilterablePage' in p.specific_class.__name__
and 'archive' not in p.title.lower()
]
posts_list = []
for page in filter_pages:
eligible_children = AbstractFilterPage.objects.live().filter(
CFGOVPage.objects.child_of_q(page))
form = FilterableListForm(filterable_pages=eligible_children)
for post in form.get_page_set():
posts_list.append(post)
return sorted(posts_list, key=lambda p: p.date_published,
reverse=True)[:limit]
class EnforcementActionPage(AbstractFilterPage):
public_enforcement_action = models.CharField(max_length=150, blank=True)
initial_filing_date = models.DateField(null=True, blank=True)
settled_or_contested_at_filing = models.CharField(max_length=10,
choices=[('Settled',
'Settled'),
('Contested',
'Contested')],
blank=True)
court = models.CharField(default='', max_length=150, blank=True)
content = StreamField([
('full_width_text', organisms.FullWidthText()),
('expandable', organisms.Expandable()),
('expandable_group', organisms.ExpandableGroup()),
('notification', molecules.Notification()),
('table_block',
organisms.AtomicTableBlock(table_options={'renderer': 'html'})),
('feedback', v1_blocks.Feedback()),
],
blank=True)
content_panels = [StreamFieldPanel('header'), StreamFieldPanel('content')]
metadata_panels = [
FieldPanel('public_enforcement_action'),
FieldPanel('initial_filing_date'),
InlinePanel('defendant_types', label='Defendant/Respondent Type'),
InlinePanel('categories', label="Forum", min_num=1, max_num=2),
FieldPanel('court'),
InlinePanel('docket_numbers', label="Docket Number", min_num=1),
FieldPanel('settled_or_contested_at_filing'),
InlinePanel('statuses', label="Status", min_num=1),
InlinePanel('products', label="Products"),
InlinePanel('at_risk_groups', label="At Risk Groups"),
InlinePanel('statutes', label="Statutes/Regulations"),
InlinePanel('enforcement_dispositions', label='Final Disposition'),
]
settings_panels = [
MultiFieldPanel(CFGOVPage.promote_panels, 'Settings'),
MultiFieldPanel([
FieldPanel('preview_title'),
FieldPanel('preview_subheading'),
FieldPanel('preview_description'),
FieldPanel('secondary_link_url'),
FieldPanel('secondary_link_text'),
ImageChooserPanel('preview_image'),
],
heading='Page Preview Fields',
classname='collapsible'),
FieldPanel('authors', 'Authors'),
MultiFieldPanel([
FieldPanel('date_published'),
FieldPanel('comments_close_by'),
],
'Relevant Dates',
classname='collapsible'),
MultiFieldPanel(Page.settings_panels, 'Scheduled Publishing'),
FieldPanel('language', 'Language'),
MultiFieldPanel(CFGOVPage.archive_panels, 'Archive'),
]
edit_handler = TabbedInterface([
ObjectList(AbstractFilterPage.content_panels + content_panels,
heading='General Content'),
ObjectList(metadata_panels, heading='Metadata'),
ObjectList(CFGOVPage.sidefoot_panels, heading='Sidebar'),
ObjectList(settings_panels, heading='Configuration')
])
template = 'enforcement-action/index.html'
objects = PageManager()
search_fields = AbstractFilterPage.search_fields + [
index.SearchField('content')
]
@classmethod
def all_actions(cls):
# Return the collection of all Enforcement Action Pages.
# Exclude any pages in the Trash or otherwise not a child of the
# EnforcementActionsFilterPage.
try:
# TODO: find a less hacky way to get only the pages in the
# correct part of the page tree
pg_id = 1327
parent_page = Page.objects.get(id=pg_id)
query = cls.objects.child_of(parent_page)
except (Page.DoesNotExist):
query = cls.objects
query = query.filter(initial_filing_date__isnull=False)
query = query.live().order_by('-initial_filing_date')
return query
def get_context(self, request):
context = super(EnforcementActionPage, self).get_context(request)
dispositions = self.enforcement_dispositions.all()
context.update({
'total_consumer_relief':
sum(disp.final_order_consumer_redress +
disp.final_order_other_consumer_relief
for disp in dispositions),
'total_cmp':
sum(disp.final_order_civil_money_penalty for disp in dispositions),
'defendant_types': [
d.get_defendant_type_display()
for d in self.defendant_types.all()
],
'statutes': [s.statute for s in self.statutes.all()],
'products': [p.product for p in self.products.all()],
'at_risk_groups':
[g.at_risk_group for g in self.at_risk_groups.all()]
})
return context
class RegulationPage(RoutablePageMixin, SecondaryNavigationJSMixin, CFGOVPage):
"""A routable page for serving an eregulations page by Section ID."""
objects = PageManager()
parent_page_types = ['regulations3k.RegulationLandingPage']
subpage_types = []
template = 'regulations3k/browse-regulation.html'
header = StreamField([
('text_introduction', molecules.TextIntroduction()),
],
blank=True)
content = StreamField([
('info_unit_group', organisms.InfoUnitGroup()),
('full_width_text', organisms.FullWidthText()),
],
null=True,
blank=True)
regulation = models.ForeignKey(Part,
blank=True,
null=True,
on_delete=models.PROTECT,
related_name='page')
content_panels = CFGOVPage.content_panels + [
StreamFieldPanel('header'),
StreamFieldPanel('content'),
FieldPanel('regulation', Part),
]
secondary_nav_exclude_sibling_pages = models.BooleanField(default=False)
sidefoot_panels = CFGOVPage.sidefoot_panels + [
FieldPanel('secondary_nav_exclude_sibling_pages'),
]
edit_handler = TabbedInterface([
ObjectList(content_panels, heading='General Content'),
ObjectList(sidefoot_panels, heading='Sidebar'),
ObjectList(CFGOVPage.settings_panels, heading='Configuration'),
])
def get_effective_version(self, request, date_str):
""" Get the requested effective version if the user has permission """
effective_version = self.regulation.versions.get(
effective_date=date_str)
if effective_version.draft:
page_perms = self.permissions_for_user(request.user)
if not page_perms.can_edit():
raise PermissionDenied
return effective_version
def get_section_query(self, effective_version=None):
"""Query set for Sections in this regulation's effective version."""
if effective_version is None:
effective_version = self.regulation.effective_version
return Section.objects.filter(subpart__version=effective_version)
def get_context(self, request, *args, **kwargs):
context = super(RegulationPage,
self).get_context(request, *args, **kwargs)
context.update({
'regulation': self.regulation,
'breadcrumb_items': self.get_breadcrumbs(request)
})
return context
def get_breadcrumbs(self, request, section=None):
crumbs = super(RegulationPage, self).get_breadcrumbs(request)
if section is not None:
crumbs = crumbs + [
{
'href': self.url,
'title': str(section.subpart.version.part),
},
]
return crumbs
def render_interp(self, context, raw_contents, **kwargs):
template = get_template('regulations3k/inline_interps.html')
# Extract the title from the raw regdown
section_title_match = re.search(r'#+\s?(?P<section_title>.*)\s',
raw_contents)
if section_title_match is not None:
context.update({'section_title': section_title_match.group(1)})
span = section_title_match.span()
raw_contents = raw_contents[:span[0]] + raw_contents[span[1]:]
context.update({'contents': regdown(raw_contents)})
context.update(kwargs)
return template.render(context)
@route(r'^((?P<date_str>[0-9]{4}-[0-9]{2}-[0-9]{2})/)?$')
def index_route(self, request, date_str=None, *args, **kwargs):
request.is_preview = getattr(request, 'is_preview', False)
if date_str is not None:
effective_version = self.get_effective_version(request, date_str)
section_query = self.get_section_query(
effective_version=effective_version)
else:
section_query = self.get_section_query()
sections = list(section_query.all())
context = self.get_context(request, *args, **kwargs)
context.update({
'get_secondary_nav_items':
partial(get_reg_nav_items, sections=sections, date_str=date_str),
})
return TemplateResponse(request,
self.get_template(request, *args, **kwargs),
context)
@route(r'^(?:(?P<date_str>[0-9]{4}-[0-9]{2}-[0-9]{2})/)?'
r'(?P<section_label>[0-9A-Za-z-]+)/$',
name="section")
def section_page(self, request, date_str=None, section_label=None):
""" Render a section of the currently effective regulation """
if date_str is not None:
effective_version = self.get_effective_version(request, date_str)
section_query = self.get_section_query(
effective_version=effective_version)
else:
section_query = self.get_section_query()
sections = list(section_query.all())
section = section_query.get(label=section_label)
current_index = sections.index(section)
context = self.get_context(request, sections=sections)
content = regdown(section.contents,
url_resolver=get_url_resolver(self),
contents_resolver=get_contents_resolver(self),
render_block_reference=partial(
self.render_interp, context))
context.update({
'version':
self.regulation.effective_version,
'content':
content,
'get_secondary_nav_items':
partial(get_reg_nav_items, sections=sections, date_str=date_str),
'next_section':
get_next_section(sections, current_index),
'previous_section':
get_previous_section(sections, current_index),
'section':
section,
'breadcrumb_items':
self.get_breadcrumbs(request, section),
'search_url':
(self.get_parent().url + 'search-regulations/results/?regs=' +
self.regulation.part_number)
})
return TemplateResponse(request, self.template, context)
class SublandingPage(CFGOVPage):
portal_topic = models.ForeignKey(
'v1.PortalTopic',
blank=True,
null=True,
related_name='portal_pages',
on_delete=models.SET_NULL,
help_text='Select a topic if this is a MONEY TOPICS portal page.')
header = StreamField([
('hero', molecules.Hero()),
], blank=True)
content = StreamField([
('text_introduction', molecules.TextIntroduction()),
('notification', molecules.Notification()),
('featured_content', organisms.FeaturedContent()),
('full_width_text', organisms.FullWidthText()),
('info_unit_group', organisms.InfoUnitGroup()),
('well', organisms.Well()),
('snippet_list', organisms.ResourceList()),
('post_preview_snapshot', organisms.PostPreviewSnapshot()),
('contact', organisms.MainContactInfo()),
('table_block',
organisms.AtomicTableBlock(table_options={'renderer': 'html'})),
('reg_comment', organisms.RegComment()),
('feedback', v1_blocks.Feedback()),
],
blank=True)
sidebar_breakout = StreamField([
('slug', blocks.CharBlock(icon='title')),
('heading', blocks.CharBlock(icon='title')),
('paragraph', blocks.RichTextBlock(icon='edit')),
('breakout_image',
blocks.StructBlock([
('image', ImageChooserBlock()),
('is_round',
blocks.BooleanBlock(required=False, default=True,
label='Round?')),
('icon', blocks.CharBlock(help_text='Enter icon class name.')),
('heading',
blocks.CharBlock(required=False, label='Introduction Heading')),
('body',
blocks.TextBlock(required=False, label='Introduction Body')),
],
heading='Breakout Image',
icon='image')),
('related_posts', organisms.RelatedPosts()),
('job_listing_list', JobListingList()),
],
blank=True)
# General content tab
content_panels = CFGOVPage.content_panels + [
StreamFieldPanel('header'),
StreamFieldPanel('content'),
FieldPanel('portal_topic'),
]
sidebar_panels = [
StreamFieldPanel('sidebar_breakout'),
] + CFGOVPage.sidefoot_panels
# Tab handler interface
edit_handler = TabbedInterface([
ObjectList(content_panels, heading='General Content'),
ObjectList(sidebar_panels, heading='Sidebar'),
ObjectList(CFGOVPage.settings_panels, heading='Configuration'),
])
template = 'sublanding-page/index.html'
objects = PageManager()
search_fields = CFGOVPage.search_fields + [
index.SearchField('content'),
index.SearchField('header')
]
def get_browsefilterable_posts(self, limit):
filter_pages = [
p.specific for p in self.get_appropriate_descendants()
if 'FilterablePage' in p.specific_class.__name__
and 'archive' not in p.title.lower()
]
posts_list = []
for page in filter_pages:
posts_list.extend(AbstractFilterPage.objects.live().filter(
CFGOVPage.objects.child_of_q(page)))
return sorted(posts_list, key=lambda p: p.date_published,
reverse=True)[:limit]
