app/soc/modules/gsoc/views/document.py

# Copyright 2011 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.

"""Module containing the views for GSoC documents page."""

from django.conf.urls.defaults import url as django_url

from melange.request import exception
from soc.views import document
from soc.views.base_templates import ProgramSelect
from soc.views.helper import url_patterns
from soc.views.helper.access_checker import isSet

from soc.modules.gsoc.views.base import GSoCRequestHandler
from soc.modules.gsoc.views import forms
from soc.modules.gsoc.views.helper.url_patterns import url
from soc.modules.gsoc.views.helper import url_patterns as gsoc_url_patterns


class GSoCDocumentForm(forms.GSoCModelForm, document.DocumentForm):
  """Django form for creating documents."""

  Meta = document.DocumentForm.Meta


class EditDocumentPage(GSoCRequestHandler):
  """Encapsulate all the methods required to edit documents.
  """

  def templatePath(self):
    return 'modules/gsoc/document/base.html'

  def djangoURLPatterns(self):
    return [
        url(r'document/edit/%s$' % gsoc_url_patterns.DOCUMENT, self,
            name='edit_gsoc_document'),
        url(r'document/edit/%s$' % gsoc_url_patterns.ORG_DOCUMENT, self,
            name='edit_gsoc_document'),
    ]

  def checkAccess(self, data, check, mutator):
    mutator.documentKeyNameFromKwargs()

    assert isSet(data.key_name)

    check.canEditDocument()

  def context(self, data, check, mutator):
    form = GSoCDocumentForm(data.POST or None, instance=data.document)

    if data.document:
      page_name = 'Edit %s' % data.document.title
    else:
      page_name = 'Create new Document'

    return {
        'page_name': page_name,
        'document_form': form,
    }

  def post(self, data, check, mutator):
    """Handler for HTTP POST request."""
    form = GSoCDocumentForm(data.POST or None, instance=data.document)
    validated_document = document.validateForm(data, form)
    if validated_document:
      data.redirect.document(validated_document)
      # TODO(nathaniel): Redirection to self?
      return data.redirect.to('edit_gsoc_document')
    else:
      # TODO(nathaniel): problematic self-use.
      return self.get(data, check, mutator)


class DocumentPage(GSoCRequestHandler):
  """Encapsulate all the methods required to show documents."""

  def templatePath(self):
    return 'modules/gsoc/base.html'

  def djangoURLPatterns(self):
    return [
        url(r'document/show/%s$' % gsoc_url_patterns.DOCUMENT, self,
            name='show_gsoc_document'),
        url(r'document/show/%s$' % gsoc_url_patterns.ORG_DOCUMENT, self,
            name='show_gsoc_document'),
        django_url(r'^document/show/%s$' % gsoc_url_patterns.DOCUMENT,
                   self),
        django_url(r'^document/show/%s$' % gsoc_url_patterns.ORG_DOCUMENT,
                   self),
    ]

  def checkAccess(self, data, check, mutator):
    mutator.documentKeyNameFromKwargs()

    if not data.document:
      raise exception.NotFound(
          message="No such document: '%s'" % data.key_name)

    check.canViewDocument()

  def context(self, data, check, mutator):
    return {
        'tmpl': document.Document(data, data.document),
        'page_name': data.document.title,
    }


class EventsPage(GSoCRequestHandler):
  """Encapsulates all the methods required to show the events page."""

  def templatePath(self):
    return 'modules/gsoc/document/events.html'

  def djangoURLPatterns(self):
    return [
        url(r'events/%s$' % url_patterns.PROGRAM, self,
            name='gsoc_events')
    ]

  def checkAccess(self, data, check, mutator):
    data.document = data.program.events_page
    check.canViewDocument()

  def context(self, data, check, mutator):
    return {
        'document': data.program.events_page,
        'frame_url': data.program.events_frame_url,
        'page_name': 'Events and Timeline',
    }


class GSoCDocumentList(document.DocumentList):
  """Template for list of documents."""

  def __init__(self, data):
    super(GSoCDocumentList, self).__init__(data, 'edit_gsoc_document')

  def templatePath(self):
    return 'modules/gsoc/document/_document_list.html'


class DocumentListPage(GSoCRequestHandler):
  """View for the list documents page."""

  def templatePath(self):
    return 'modules/gsoc/document/document_list.html'

  def djangoURLPatterns(self):
    return [
        url(r'documents/%s$' % url_patterns.PROGRAM, self,
            name='list_gsoc_documents'),
    ]

  def checkAccess(self, data, check, mutator):
    check.isHost()

  def jsonContext(self, data, check, mutator):
    list_content = GSoCDocumentList(data).getListData()
    if list_content:
      return list_content.content()
    else:
      raise exception.Forbidden(message='You do not have access to this data')

  def context(self, data, check, mutator):
    return {
        'page_name': "Documents for %s" % data.program.name,
        'document_list': GSoCDocumentList(data),
        'program_select': ProgramSelect(data, 'list_gsoc_documents'),
    }