app/soc/views/site.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 for the site global pages."""

import httplib
import os

from google.appengine.api import users

from django import http
from django.conf.urls.defaults import url as django_url
from django.forms import widgets as django_widgets
from django.utils.translation import ugettext

from melange.request import access
from melange.request import exception
from soc.logic import cleaning
from soc.logic import links
from soc.logic import site as site_logic
from soc.models import document
from soc.models import site
from soc.views import base
from soc.views import forms as views_forms
from soc.views import template
from soc.views.helper import request_data


DEF_NO_DEVELOPER = ugettext(
    'This page is only accessible to developers.')

CI_PROGRAM_IMAGE_PATH = '/images/gci/logo/landing-page-%s.png'
SOC_PROGRAM_IMAGE_PATH = '/images/gsoc/logo/landing-page-%s.png'


def getProgramMap():
  # TODO(nathaniel): Magic string? This isn't a program.
  choices = [('', '-----')]

  # TODO(nathaniel): Eliminate the circularity behind this non-top-level
  # import.
  from soc.modules import callback
  choices += callback.getCore().getProgramMap()
  return choices


class SiteForm(views_forms.ModelForm):
  """Django form for the site settings."""

  class Meta:
    model = site.Site
    exclude = ['xsrf_secret_key']
    # NOTE(nathaniel): There aren't really no choices, it's just that we
    # can't know what the choices are at module-load-time. For the moment
    # we have to set the available choices below in EditSitePage.context.
    widgets = {'active_program': django_widgets.Select(choices=[])}

  def clean_tos(self):
    return '' if self.cleaned_data['tos'] is None else self.cleaned_data['tos']

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

  clean_noreply_email = cleaning.clean_empty_field('noreply_email')


class EditSitePage(base.RequestHandler):
  """View for the participant profile."""

  # TODO(nathaniel): This page should use something like a "site admin
  # access checker" - there should be no pages accessible only to
  # developers.
  access_checker = access.DEVELOPER_ACCESS_CHECKER

  def djangoURLPatterns(self):
    return [
        django_url(r'^site/edit$', self, name='edit_site_settings'),
    ]

  def jsonContext(self, data, check, mutator):
    entities = document.Document.all().filter('prefix', 'site')

    json_data = [{'key': str(i.key()),
                  'link_id': i.link_id,
                  'label': i.title}
                 for i in entities]

    return {'data': json_data}

  def templatePath(self):
    # TODO: make this specific to the current active program
    return 'soc/site/base.html'

  def context(self, data, check, mutator):
    # TODO: suboptimal
    from soc.modules.gsoc.views.forms import GSoCBoundField
    site_form = SiteForm(
        GSoCBoundField, data=data.POST or None, instance=data.site)

    # NOTE(nathaniel): This is an unfortunate workaround for the fact
    # that in its current form the SiteForm class will only ever present
    # to the user those choices that were discoverable at module-load time.
    site_form.fields['active_program'].widget = django_widgets.Select(
        choices=getProgramMap())

    return {
        'app_version': os.environ.get('CURRENT_VERSION_ID', '').split('.')[0],
        'page_name': 'Edit site settings',
        'site_form': site_form,
    }

  def validate(self, data):
    from soc.modules.gsoc.views.forms import GSoCBoundField
    site_form = SiteForm(
        GSoCBoundField, data=data.POST, instance=data.site)

    if site_form.is_valid():
      site_form.save()
      return True
    else:
      return False

  def post(self, data, check, mutator):
    """Handler for HTTP POST request."""
    post_accepted = self.validate(data)
    context = self.context(data, check, mutator)
    template_path = self.templatePath()
    response_content = self.renderer.render(data, template_path, context)
    return http.HttpResponse(
        status=httplib.OK if post_accepted else httplib.BAD_REQUEST,
        content=response_content)


class SiteHomepage(base.RequestHandler):
  """View for the site home page."""

  def djangoURLPatterns(self):
    return [
        django_url(r'^$', self, name='site_home'),
        django_url(r'^(login)$', self, name='login'),
        django_url(r'^(logout)$', self, name='logout'),
    ]

  def __call__(self, request, *args, **kwargs):
    """Custom call implementation that avoids looking up unneeded data."""
    try:
      data, _, _ = self.initializer.initialize(request, args, kwargs)

      self.checkMaintenanceMode(data)

      action = args[0] if args else ''

      if action == 'login':
        return data.redirect.toUrl(users.create_login_url('/'))
      elif action == 'logout':
        return data.redirect.toUrl(users.create_logout_url('/'))
      else:
        settings = site_logic.singleton()
        program = settings.active_program
        if program:
          program_url = self.linker.program(program, program.homepage_url_name)
          return http.HttpResponseRedirect(program_url)
        else:
          return data.redirect.to('edit_site_settings')
    except exception.UserError as user_error:
      return self.error_handler.handleUserError(user_error, data)
    except exception.ServerError as server_error:
      return self.error_handler.handleServerError(server_error, data)


class ProgramSection(template.Template):
  """Template that displays a program on the landing page."""

  def __init__(self, data, program, image_path):
    """Initializes new instance of this class for the specified program.

    Args:
      data: request_data.RequestData for the current request.
      program: program entity.
      image_path: path to the static file with a logo image to be put
        on the landing page.
    """
    super(ProgramSection, self).__init__(data)
    self._program = program
    self._image_path = image_path

  def templatePath(self):
    """See template.Template.templatePath for specification."""
    return 'melange/landing_page/_program_section.html'

  def isActive(self):
    """Tells whether the program in this section is currently active or not.

    Returns:
      bool indication whether the program is currently active or not.
    """
    return  request_data.TimelineHelper(
        self._program.timeline, None).programActive()

  def context(self):
    """See template.Template.context for specification."""
    homepage_url = links.LINKER.program(
        self._program, self._program.homepage_url_name)

    return {
        'program': self._program,
        'homepage_url': homepage_url,
        'is_active': self.isActive(),
        'image_path': self._image_path,
        }


class ContactUsSection(template.Template):
  """Template that displays contact information on the landing page."""

  def templatePath(self):
    """See template.Template.templatePath for specification."""
    return 'melange/landing_page/_contact_us_section.html'

  def isAnyContactChannelSet(self):
    """Tells whether there is at least one contact channel set for the site.

    Returns:
      True if at least one contact channel is defined; False otherwise.
    """
    return (self.data.site.blog or self.data.site.google_plus or
        self.data.site.irc_channel or self.data.site.mailing_list)

  def context(self):
    """See template.Template.context for specification."""
    return {
        'blog': self.data.site.blog,
        'google_plus': self.data.site.google_plus,
        'irc_channel': self.data.site.irc_channel,
        'mailing_list': self.data.site.mailing_list,
        }


class LandingPage(base.RequestHandler):
  """View with the landing page that is displayed when user visits
  the main URL for the application.
  """
  # TODO(daniel): it should be changed to All Allowed Checker
  access_checker = access.DEVELOPER_ACCESS_CHECKER

  def djangoURLPatterns(self):
    """See base.RequestHandler.getDjangoURLPatterns for specification."""
    # TODO(daniel): this should be changed to '/' when the page is public
    return [django_url(r'^landing_page$', self, name='landing_page')]

  def templatePath(self):
    """See base.RequestHandler.templatePath for specification."""
    return 'melange/landing_page/landing_page.html'

  def context(self, data, check, mutator):
    """See base.RequestHandler.context for specification."""
    # TODO(daniel): these models should not be imported directly here
    from soc.modules.gsoc.models import program as soc_program_model
    from soc.modules.gci.models import program as ci_program_model

    program_sections = []

    if data.site.latest_gsoc:
      latest_soc = soc_program_model.GSoCProgram.get_by_key_name(
          data.site.latest_gsoc)
      if latest_soc:
        program_sections.append(
            ProgramSection(data, latest_soc,
                SOC_PROGRAM_IMAGE_PATH % latest_soc.program_id))

    if data.site.latest_gci:
      latest_ci = ci_program_model.GCIProgram.get_by_key_name(
          data.site.latest_gci)
      if latest_ci:
        program_sections.append(
            ProgramSection(
                data, latest_ci, CI_PROGRAM_IMAGE_PATH % latest_ci.program_id))

    if len(program_sections) == 1:
      # do not bother to show landing page if there is only one active program
      # just redirect to the corresponding home page instead
      raise exception.Redirect(program_sections[0].context()['homepage_url'])
    else:
      active_programs_counter = len([
          program_section for program_section in program_sections
              if program_section.isActive()])

      contact_us_section = ContactUsSection(data)

      return {
          'active_programs_counter': active_programs_counter,
          'contact_us_section': contact_us_section,
          'program_sections': program_sections,
          }