Add is_featured boolean property to the Work model, so that Works can be
designated as "featured" items in various places in the UI. This will be
used to allow Sponsors, Programs, and Organizations to select Documents that
should be included in their sidebar menus.
Perhaps featured "site" Documents, such as site-wide Terms of Service,
should probably be listed below the "User (sign-out)" menu, since the User
will have to read and agree to these before being allowed to use the site.
A collapsable Javascript sidebar is probably going to be needed soon...
Patch by: Todd Larsen
Review by: to-be-reviewed
#!/usr/bin/python2.5
#
# Copyright 2008 the Melange authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Site-wide Melange home page views.
public: how the general public sees the site home page of a Melange
site
edit: site settings view for logged-in Developers
"""
__authors__ = [
'"Pawel Solyga" <pawel.solyga@gmail.com>',
]
from google.appengine.api import users
from google.appengine.ext import db
from django import forms
from django import http
from django import shortcuts
from soc.logic import models
from soc.logic import out_of_band
from soc.logic import validate
from soc.logic.models import document
from soc.logic.site import id_user
from soc.views import simple
from soc.views import helper
from soc.views.helper import access
import soc.logic.models.site_settings
import soc.models.document
import soc.models.site_settings
import soc.views.helper.forms
import soc.views.helper.responses
import soc.views.helper.templates
import soc.views.helper.widgets
import soc.views.out_of_band
class DocumentForm(helper.forms.DbModelForm):
content = forms.fields.CharField(widget=helper.widgets.TinyMCE())
class Meta:
"""Inner Meta class that defines some behavior for the form.
"""
#: db.Model subclass for which the form will gather information
model = soc.models.document.Document
#: list of model fields which will *not* be gathered by the form
exclude = ['partial_path', 'link_name',
'user', 'modified', 'created', 'inheritance_line']
class SiteSettingsForm(helper.forms.DbModelForm):
"""Django form displayed when creating or editing Site Settings.
"""
class Meta:
"""Inner Meta class that defines some behavior for the form.
"""
#: db.Model subclass for which the form will gather information
model = soc.models.site_settings.SiteSettings
#: list of model fields which will *not* be gathered by the form
exclude = ['inheritance_line', 'home']
def clean_feed_url(self):
feed_url = self.cleaned_data.get('feed_url')
if feed_url == '':
# feed url not supplied (which is OK), so do not try to validate it
return None
if not validate.isFeedURLValid(feed_url):
raise forms.ValidationError('This URL is not a valid ATOM or RSS feed.')
return feed_url
DEF_SITE_SETTINGS_PATH = 'site'
DEF_SITE_HOME_DOC_LINK_NAME = 'home'
DEF_SITE_HOME_PUBLIC_TMPL = 'soc/site/home/public.html'
def public(request, template=DEF_SITE_HOME_PUBLIC_TMPL):
"""How the "general public" sees the Melange site home page.
Args:
request: the standard django request object.
template: the template path to use for rendering the template.
Returns:
A subclass of django.http.HttpResponse with generated template.
"""
# create default template context for use with any templates
context = helper.responses.getUniversalContext(request)
site_settings = soc.logic.models.site_settings.logic.getFromFields(
path=DEF_SITE_SETTINGS_PATH)
if site_settings:
context['site_settings'] = site_settings
# check if ReferenceProperty to home Document is valid
try:
site_doc = site_settings.home
except db.Error:
site_doc = None
if site_doc:
site_doc.content = helper.templates.unescape(site_doc.content)
context['site_document'] = site_doc
return helper.responses.respond(request, template, context=context)
DEF_SITE_HOME_EDIT_TMPL = 'soc/site/home/edit.html'
def edit(request, template=DEF_SITE_HOME_EDIT_TMPL):
"""View for Developer to edit content of Melange site home page.
Args:
request: the standard django request object.
template: the template path to use for rendering the template.
Returns:
A subclass of django.http.HttpResponse with generated template.
"""
try:
access.checkIsDeveloper(request)
except soc.views.out_of_band.AccessViolationResponse, alt_response:
return alt_response.response()
# create default template context for use with any templates
context = helper.responses.getUniversalContext(request)
settings_form = None
document_form = None
if request.method == 'POST':
document_form = DocumentForm(request.POST)
settings_form = SiteSettingsForm(request.POST)
if document_form.is_valid() and settings_form.is_valid():
link_name = DEF_SITE_HOME_DOC_LINK_NAME
partial_path=DEF_SITE_SETTINGS_PATH
logged_in_id = users.get_current_user()
user = models.user.logic.getFromFields(email=logged_in_id.email())
properties = {
'title': document_form.cleaned_data.get('title'),
'short_name': document_form.cleaned_data.get('short_name'),
'abstract': document_form.cleaned_data.get('abstract'),
'content': document_form.cleaned_data.get('content'),
'link_name': link_name,
'partial_path': partial_path,
'id': logged_in_id,
'user': user,
}
site_doc = document.logic.updateOrCreateFromFields(
properties, partial_path=partial_path, link_name=link_name)
feed_url = settings_form.cleaned_data.get('feed_url')
site_settings = models.site_settings.logic.updateOrCreateFromFields(
{'feed_url': feed_url, 'home': site_doc}, path=DEF_SITE_SETTINGS_PATH)
context['notice'] = 'Site Settings saved.'
else: # request.method == 'GET'
# try to fetch SiteSettings entity by unique key_name
site_settings = models.site_settings.logic.getFromFields(
path=DEF_SITE_SETTINGS_PATH)
if site_settings:
# populate form with the existing SiteSettings entity
settings_form = SiteSettingsForm(instance=site_settings)
# check if ReferenceProperty to home Document is valid
try:
site_doc = site_settings.home
except db.Error:
site_doc = None
else:
# no SiteSettings entity exists for this key_name, so show a blank form
settings_form = SiteSettingsForm()
site_doc = None
if site_doc:
# populate form with the existing Document entity
document_form = DocumentForm(instance=site_doc)
else:
# no Document entity exists for this key_name, so show a blank form
document_form = DocumentForm()
context.update({'document_form': document_form,
'settings_form': settings_form })
return helper.responses.respond(request, template, context)