app/soc/modules/gci/views/org_score.py

# Copyright 2012 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 GCI organization score page."""

from melange.request import exception
from soc.views.helper import lists
from soc.views.helper import url_patterns
from soc.views.template import Template

from soc.modules.gci.models.score import GCIOrgScore
from soc.modules.gci.templates.org_list import BasicOrgList
from soc.modules.gci.views.base import GCIRequestHandler
from soc.modules.gci.views.helper import url_names
from soc.modules.gci.views.helper.url_patterns import url


class OrgScoresList(Template):
  """Template for the list students with the number of tasks they
  have completed for the specified organization.
  """

  ORG_SCORE_LIST_IDX = 0

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

    list_config = lists.ListConfiguration(add_key_column=False)
    list_config.addPlainTextColumn('key', 'Key', (lambda ent, *args: "%s" % (
        ent.parent().key().id_or_name())), hidden=True)
    list_config.addPlainTextColumn('student', 'Student',
        lambda e, *args: e.parent().name())
    list_config.addNumericalColumn('tasks', 'Tasks',
        lambda e, *args: e.numberOfTasks())
    list_config.setDefaultSort('tasks', 'desc')

    list_config.setRowAction(
        lambda e, *args: r.userOrg(user=e.parent().link_id).urlOf(
            url_names.GCI_STUDENT_TASKS_FOR_ORG))

    self._list_config = list_config

  def context(self):
    description = 'Organization scores for %s' % (
            self.data.organization.name)

    org_scores_list = lists.ListConfigurationResponse(
        self.data, self._list_config, self.ORG_SCORE_LIST_IDX, description)

    return {
        'lists': [org_scores_list],
    }

  def getListData(self):
    idx = lists.getListIndex(self.data.request)
    if idx == self.ORG_SCORE_LIST_IDX:
      q = GCIOrgScore.all()
      q.filter('org', self.data.organization)

      skipper = lambda entity, start: entity.numberOfTasks() <= 0

      response_builder = lists.RawQueryContentResponseBuilder(
          self.data.request, self._list_config, q, lists.keyStarter,
          skipper=skipper)

      return response_builder.build()
    else:
      return None

  def templatePath(self):
    return 'modules/gci/leaderboard/_leaderboard_list.html'


class OrgScoresForOrgzanizationPage(GCIRequestHandler):
  """View for the organizations scores page.
  """

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

  def djangoURLPatterns(self):
    return [
        url(r'org_scores/%s$' % url_patterns.ORG, self,
            name=url_names.GCI_ORG_SCORES),
    ]

  def checkAccess(self, data, check, mutator):
    pass

  def context(self, data, check, mutator):
    return {
        'page_name': "Organization scores for %s" % data.organization.name,
        'org_scores_list': OrgScoresList(data),
    }

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


class OrganizationsForOrgScoreList(BasicOrgList):
  """Lists all organizations that have been accepted for the specified
  program and the row action is to show a list of scores for this organization.
  """

  def _getDescription(self):
    return "Choose an organization for which to display scores."

  def _getRedirect(self):
    def redirect(e, *args):
      # TODO(nathaniel): make this .organization call unnecessary.
      self.data.redirect.organization(organization=e)

      return self.data.redirect.urlOf(url_names.GCI_ORG_SCORES)
    return redirect


class ChooseOrganizationForOrgScorePage(GCIRequestHandler):
  """View with a list of organizations. When a user clicks on one of them,
  he or she is moved to the organization scores for this organization.
  """

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

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

  def checkAccess(self, data, check, mutator):
    # TODO(daniel): check if the program has started
    check.isHost()

  def jsonContext(self, data, check, mutator):
    list_content = OrganizationsForOrgScoreList(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': "Choose an organization for which to display scores.",
        'org_list': OrganizationsForOrgScoreList(data),
        #'program_select': ProgramSelect(data, 'gci_accepted_orgs'),
    }