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

#!/usr/bin/env python2.5
#
# 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 Homepage Application.
"""


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

from soc.logic.exceptions import AccessViolation
from soc.views.helper import lists
from soc.logic.helper import timeline as timeline_helper
from soc.views.template import Template
from soc.views.helper import url as url_helper
from soc.views.helper import url_patterns
from soc.views.helper.access_checker import isSet

from soc.modules.gsoc.logic import project as project_logic
from soc.modules.gsoc.models.project import GSoCProject
from soc.modules.gsoc.views.base import RequestHandler
from soc.modules.gsoc.views.helper.url_patterns import url


class Apply(Template):
  """Apply template.
  """

  def __init__(self, data, current_timeline):
    self.data = data
    self.current_timeline = current_timeline

  def context(self):
    organization = self.data.organization
    r = self.data.redirect

    context = {
        'request_data': self.data,
        'current_timeline': self.current_timeline,
        'organization': organization,
    }

    if not self.data.profile:
      suffix = '?org=' + self.data.organization.link_id

      if self.data.timeline.studentsAnnounced():
        return context

      if self.data.timeline.studentSignup():
        context['student_apply_block'] = True
        profile_link = r.createProfile('student').urlOf('create_gsoc_profile')
        context['student_profile_link'] = profile_link + suffix
      else:
        context['mentor_apply_block'] = True

      profile_link = r.createProfile('mentor').urlOf('create_gsoc_profile')
      context['mentor_profile_link'] = profile_link + suffix
      return context

    if self.data.student_info:
      if self.data.timeline.studentSignup():
        context['student_apply_block'] = True
        submit_proposal_link = r.organization().urlOf('submit_gsoc_proposal')
        context['submit_proposal_link'] = submit_proposal_link

      return context

    context['mentor_apply_block'] = True

    if self.data.orgAdminFor(organization):
      context['role'] = 'an administrator'
      return context

    if self.data.mentorFor(organization):
      context['role'] = 'a mentor'
      return context

    if self.data.appliedTo(organization):
      context['mentor_applied'] = True
      return context

    invited_role = self.data.invitedTo(organization)

    if invited_role == 'mentor':
      context['invited_role'] = 'a mentor'
      return context

    if invited_role == 'org_admin':
      context['invited_role'] = 'an administrator'
      return context

    request_mentor_link = r.organization().urlOf('gsoc_request')
    context['mentor_request_link'] = request_mentor_link
    return context

  def templatePath(self):
    return "v2/modules/gsoc/org_home/_apply.html"


class Contact(Template):
  """Organization Contact template.
  """

  def __init__(self, data):
    self.data = data

  def context(self):
    return {
        'facebook_link': self.data.organization.facebook,
        'twitter_link': self.data.organization.twitter,
        'blogger_link': self.data.organization.blog,
        'pub_mailing_list_link': self.data.organization.pub_mailing_list,
        'irc_channel_link': self.data.organization.irc_channel,
        'google_plus_link': self.data.organization.google_plus
    }

  def templatePath(self):
    return "v2/modules/gsoc/_connect_with_us.html"


class ProjectList(Template):
  """Template for list of student projects accepted under the organization.
  """

  def __init__(self, request, data):
    self.request = request
    self.data = data

    r = data.redirect
    list_config = lists.ListConfiguration(add_key_column=False)
    list_config.addColumn('key', 'Key', (lambda ent, *args: "%s/%s" % (
        ent.parent().key().name(), ent.key().id())), hidden=True)
    list_config.addColumn('student', 'Student',
                          lambda entity, *args: entity.parent().name())
    list_config.addSimpleColumn('title', 'Title')
    list_config.addColumn(
        'mentors', 'Mentor',
        lambda entity, m, *args: [m[i].name() for i in entity.mentors])
    list_config.setDefaultSort('student')
    list_config.setRowAction(lambda e, *args, **kwargs:
        r.project(id=e.key().id_or_name(), student=e.parent().link_id).
        urlOf('gsoc_project_details'))
    self._list_config = list_config

  def context(self):
    list = lists.ListConfigurationResponse(
        self.data, self._list_config, idx=0,
        description='List of projects accepted into %s' % (
            self.data.organization.name))

    return {
        'lists': [list],
        }

  def getListData(self):
    """Returns the list data as requested by the current request.

    If the lists as requested is not supported by this component None is
    returned.
    """
    idx = lists.getListIndex(self.request)
    if idx == 0:
      list_query = project_logic.getAcceptedProjectsQuery(
          program=self.data.program, org=self.data.organization)

      starter = lists.keyStarter
      prefetcher = lists.listModelPrefetcher(
          GSoCProject, [],  ['mentors'], parent=True)

      response_builder = lists.RawQueryContentResponseBuilder(
          self.request, self._list_config, list_query,
          starter, prefetcher=prefetcher)
      return response_builder.build()
    else:
      return None

  def templatePath(self):
    return "v2/modules/gsoc/org_home/_project_list.html"


class OrgHome(RequestHandler):
  """View methods for Organization Home page.
  """

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

  def djangoURLPatterns(self):
    """Returns the list of tuples for containing URL to view method mapping.
    """

    return [
        url(r'org/%s$' % url_patterns.ORG, self,
            name='gsoc_org_home'),
        url(r'org/show/%s$' % url_patterns.ORG, self),
        url(r'org/home/%s$' % url_patterns.ORG, self),
        django_url(r'^org/show/%s$' % url_patterns.ORG, self),
        django_url(r'^org/home/%s$' % url_patterns.ORG, self),
    ]

  def checkAccess(self):
    """Access checks for GSoC Organization Homepage.
    """
    pass

  def jsonContext(self):
    """Handler for JSON requests.
    """
    assert isSet(self.data.organization)
    list_content = ProjectList(self.request, self.data).getListData()

    if not list_content:
      raise AccessViolation(
          'You do not have access to this data')
    return list_content.content()


  def _getJSONMapData(self):
    """Constructs the JSON for Google Maps on organization home page.

    Returns:
      A JSON object containing map data.
    """
    r = self.data.redirect

    students = {}
    mentors = {}
    student_projects = {}

    # get the query object which returns the Keys for project entities
    # for the given organization
    projects = project_logic.getAcceptedProjectsForOrg(
        self.data.organization)

    # Construct a dictionary of mentors and students. For each mentor construct
    # a list of 3-tuples containing student name, project title and url.
    # And for each student a list of 3 tuples containing mentor name, project
    # title and url. Only students and mentors who have agreed to publish their
    # locations will be in the dictionary.
    for project in projects:
      student = project.parent()
      student_key = str(student.key())

      # TODO(SRabbelier): also display secondary mentors
      mentor = project.mentors[0]
      mentor_key = str(mentor.key())

      project_key_object = project.key()
      project_key = str(project_key_object)
      project_link = r.project(
          id=project_key_object.id_or_name(),
          student=student.link_id).urlOf(
              'gsoc_project_details')

      # store the project data in the projects dictionary
      student_projects[project_key] = {
         'title': project.title,
         'link': project_link,
         'student_key': student_key,
         'student_name': student.name(),
         'mentor_key': mentor_key,
         'mentor_name': mentor.name()
         }

      if mentor.publish_location:
        if mentor_key not in mentors:
          # we have not stored the information of this mentor yet
          mentors[mentor_key] = {
              'name': mentor.name(),
              'lat': mentor.latitude,
              'lng': mentor.longitude,
              'projects': []
              }

        # add this project to the mentor's list
        mentors[mentor_key]['projects'].append(project_key)

      if student.publish_location:
        if student_key not in students:
          # new student, store the name and location
          students[student_key] = {
              'name': student.name(),
              'lat': student.latitude,
              'lng': student.longitude,
              'projects': [],
              }

        # append the current project to the known student's list of projects
        students[student_key]['projects'].append(project_key)

    # combine the people and projects data into one JSON object
    data = {
        'mentors': mentors,
        'students': students,
        'projects': student_projects
        }

    return simplejson.dumps(data)

  def context(self):
    """Handler to for GSoC Organization Home page HTTP get request.
    """
    current_timeline = self.getCurrentTimeline(
        self.data.program_timeline, self.data.org_app)

    assert isSet(self.data.organization)
    organization = self.data.organization

    context = {
        'page_name': '%s - Homepage' % organization.short_name,
        'organization': organization,
        'contact': Contact(self.data),
        'apply': Apply(self.data, current_timeline),
    }

    ideas = organization.ideas

    if organization.ideas:
      context['ideas_link'] = ideas
      context['ideas_link_trimmed'] = url_helper.trim_url_to(ideas, 50)

    if self.data.orgAdminFor(organization):
      r = self.redirect
      r.organization(organization)
      context['edit_link'] =  r.urlOf('edit_gsoc_org_profile')
      context['invite_admin_link'] = r.invite('org_admin').urlOf('gsoc_invite')
      context['invite_mentor_link'] = r.invite('mentor').urlOf('gsoc_invite')

      if (self.data.program.allocations_visible and
          self.data.timeline.beforeStudentsAnnounced()):
        context['slot_transfer_link'] = r.organization(organization).urlOf(
            'gsoc_slot_transfer')

    if self.data.timeline.studentsAnnounced():
      context['students_announced'] = True

      context['project_list'] = ProjectList(self.request, self.data)

      # TODO: Map needs to be rewritten to work with new mentors property
      # obtain a json object that contains the organization home page map data
      #context['org_map_data'] = self._getJSONMapData()

    return context

  def getCurrentTimeline(self, timeline, org_app):
    """Return where we are currently on the timeline.
    """
    if timeline_helper.isActivePeriod(org_app, 'survey'):
      return 'org_signup_period'
    elif timeline_helper.isActivePeriod(timeline, 'student_signup'):
      return 'student_signup_period'
    elif timeline_helper.isActivePeriod(timeline, 'program'):
      return 'program_period'

    return 'offseason'