app/soc/logic/models/student_proposal.py
author Lennard de Rijk <ljvderijk@gmail.com>
Sun, 08 Mar 2009 17:41:02 +0000
changeset 1753 564f3adf4acf
parent 1624 1fc2089f4bc9
child 1786 d9694a1f1a56
permissions -rw-r--r--
Students who withdraw their proposal will now be removed from the ranker. And therefore don't influence the ranking of other proposals anymore. Patch by: Lennard de Rijk Reviewed by: to-be-reviewed

#!/usr/bin/python2.5
#
# Copyright 2009 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.

"""Student Proposal (Model) query functions.
"""

__authors__ = [
  '"Lennard de Rijk" <ljvderijk@gmail.com>',
  ]


from soc.logic.models import base
from soc.logic.models import student as student_logic
from soc.logic.models.ranker_root import logic as ranker_root_logic
from soc.models import student_proposal

import soc.models.linkable
import soc.models.student_proposal


class Logic(base.Logic):
  """Logic methods for the Student Proposal model.
  """

  def __init__(self, model=soc.models.student_proposal.StudentProposal,
               base_model=soc.models.linkable.Linkable, 
               scope_logic=student_logic):
    """Defines the name, key_name and model for this entity.
    """

    super(Logic, self).__init__(model=model, base_model=base_model,
                                scope_logic=scope_logic)

  def _onCreate(self, entity):
    """Adds this proposal to the organization ranker entity.
    """

    fields = {'link_id': student_proposal.DEF_RANKER_NAME,
              'scope': entity.org}

    ranker_root = ranker_root_logic.getForFields(fields, unique=True)
    ranker = ranker_root_logic.getRootFromEntity(ranker_root) 
    ranker.SetScore(entity.key().name(), [entity.score])

    super(Logic, self)._onCreate(entity)

  def _updateField(self, entity, entity_properties, name):
    """Called when the fields of the student_proposal are updated.

      - Update the ranker if the score changes and keep the score within bounds
      - Remove the entity from the ranker when the status changes to invalid or rejected
    """

    value = entity_properties[name]

    if name == 'score':
      # keep the score within bounds
      min_score, max_score = student_proposal.DEF_SCORE

      value = max(min_score, min(value, max_score-1))
      entity_properties[name] = value

      # update the ranker
      fields = {'link_id': student_proposal.DEF_RANKER_NAME,
                'scope': entity.org}

      ranker_root = ranker_root_logic.getForFields(fields, unique=True)
      ranker = ranker_root_logic.getRootFromEntity(ranker_root)
      ranker.SetScore(entity.key().name(), [value])

    if name == 'status':

      if value in ['invalid', 'rejected'] and entity.status != value:
        # the proposal is going into invalid or rejected state
        # remove the score from the ranker
        fields = {'link_id': student_proposal.DEF_RANKER_NAME,
                  'scope': entity.org}

        ranker_root = ranker_root_logic.getForFields(fields, unique=True)
        ranker = ranker_root_logic.getRootFromEntity(ranker_root)

        # entries in the ranker can be removed by setting the score to None
        ranker.SetScore(entity.key().name(), None)

    return super(Logic, self)._updateField(entity, entity_properties, name)


logic = Logic()