#!/usr/bin/python2.5

#

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

"""Views for Programs.

"""

__authors__ = [

    '"Sverre Rabbelier" <sverre@rabbelier.nl>',

    '"Lennard de Rijk" <ljvderijk@gmail.com>',

  ]

import os

from django import forms

from django import http

from django.utils.translation import ugettext

from soc.logic import allocations

from soc.logic import cleaning

from soc.logic import dicts

from soc.logic.helper import timeline as timeline_helper

from soc.logic.models import host as host_logic

from soc.logic.models import mentor as mentor_logic

from soc.logic.models import organization as org_logic

from soc.logic.models import org_admin as org_admin_logic

from soc.logic.models import org_app as org_app_logic

from soc.logic.models import student_proposal as student_proposal_logic

from soc.logic.models import program as program_logic

from soc.logic.models import student as student_logic

from soc.views import helper

from soc.views import out_of_band

from soc.views.helper import access

from soc.views.helper import decorators

from soc.views.helper import lists

from soc.views.helper import redirects

from soc.views.helper import widgets

from soc.views.models import presence

from soc.views.models import document as document_view

from soc.views.models import sponsor as sponsor_view

from soc.views.sitemap import sidebar

import soc.cache.logic

import soc.logic.models.program

import soc.models.work

class View(presence.View):

  """View methods for the Program model.

  """

  DEF_ACCEPTED_ORGS_MSG_FMT = ugettext("These organizations have"

      " been accepted into %(name)s, but they have not yet completed"

      " their organization profile. You can still learn more about"

      " each organization by visiting the links below.")

  DEF_CREATED_ORGS_MSG_FMT = ugettext("These organizations have been"

      " accepted into %(name)s and have completed their organization"

      " profiles. You can learn more about each organization by"

      " visiting the links below.")

  DEF_SLOTS_ALLOCATION_MSG = ugettext("Use this view to assign slots.")

  def __init__(self, params=None):

    """Defines the fields and methods required for the base View class

    to provide the user with list, public, create, edit and delete views.

    Params:

      params: a dict with params for this View

    """

    rights = access.Checker(params)

    rights['any_access'] = ['allow']

    rights['show'] = ['allow']

    rights['create'] = [('checkSeeded', ['checkHasActiveRoleForScope', 

        host_logic.logic])]

    rights['edit'] = ['checkIsHostForProgram']

    rights['delete'] = ['checkIsDeveloper']

    rights['assign_slots'] = ['checkIsHostForProgram']

    rights['slots'] = ['checkIsHostForProgram']

    rights['show_duplicates'] = ['checkIsHostForProgram']

    rights['assigned_proposals'] = ['checkIsHostForProgram']

    rights['accepted_orgs'] = [('checkisAfterEvent',

        ['accepted_organization_announced_deadline', '__all__'])]

    new_params = {}

    new_params['logic'] = soc.logic.models.program.logic

    new_params['rights'] = rights

    new_params['scope_view'] = sponsor_view

    new_params['scope_redirect'] = redirects.getCreateRedirect

    new_params['name'] = "Program"

    new_params['sidebar_grouping'] = 'Programs'

    new_params['document_prefix'] = "program"

    new_params['extra_dynaexclude'] = ['timeline', 'org_admin_agreement',

        'mentor_agreement', 'student_agreement', 'slots_allocation']

    patterns = []

    patterns += [

        (r'^%(url_name)s/(?P<access_type>assign_slots)/%(key_fields)s$',

          'soc.views.models.%(module_name)s.assign_slots',

          'Assign slots'),

        (r'^%(url_name)s/(?P<access_type>slots)/%(key_fields)s$',

          'soc.views.models.%(module_name)s.slots',

          'Assign slots (JSON)'),

        (r'^%(url_name)s/(?P<access_type>show_duplicates)/%(key_fields)s$',

          'soc.views.models.%(module_name)s.show_duplicates',

          'Show duplicate slot assignments'),

        (r'^%(url_name)s/(?P<access_type>assigned_proposals)/%(key_fields)s$',

          'soc.views.models.%(module_name)s.assigned_proposals',

          "Assigned proposals for multiple organizations"),

        (r'^%(url_name)s/(?P<access_type>accepted_orgs)/%(key_fields)s$',

          'soc.views.models.%(module_name)s.accepted_orgs',

          "List all accepted organizations"),

        ]

    new_params['extra_django_patterns'] = patterns

    new_params['create_dynafields'] = [

        {'name': 'link_id',

         'base': forms.fields.CharField,

         'label': 'Program Link ID',

         },

        ]

    # TODO add clean field to check for uniqueness in link_id and scope_path

    new_params['create_extra_dynaproperties'] = {

        'description': forms.fields.CharField(widget=helper.widgets.TinyMCE(

            attrs={'rows':10, 'cols':40})),

        'accepted_orgs_msg': forms.fields.CharField(

            widget=helper.widgets.TinyMCE(attrs={'rows':10, 'cols':40})),

        'scope_path': forms.CharField(widget=forms.HiddenInput, required=True),

        'workflow': forms.ChoiceField(choices=[('gsoc','Project-based'),

            ('ghop','Task-based')], required=True),

        }

    reference_fields = [

        ('org_admin_agreement_link_id', soc.models.work.Work.link_id.help_text,

         ugettext('Organization Admin Agreement Document link ID')),

        ('mentor_agreement_link_id', soc.models.work.Work.link_id.help_text,

         ugettext('Mentor Agreement Document link ID')),

        ('student_agreement_link_id', soc.models.work.Work.link_id.help_text,

         ugettext('Student Agreement Document link ID')),

        ('home_link_id', soc.models.work.Work.link_id.help_text,

         ugettext('Home page Document link ID')),

        ]

    result = {}

    for key, help_text, label in reference_fields:

      result[key] = widgets.ReferenceField(

          reference_url='document', filter=['__scoped__'],

          filter_fields={'prefix': new_params['document_prefix']},

          required=False, label=label, help_text=help_text)

    result['workflow'] = forms.CharField(widget=widgets.ReadOnlyInput(),

                                         required=True)

    result['clean'] = cleaning.clean_refs(new_params,

                                          [i for i,_,_ in reference_fields])

    new_params['edit_extra_dynaproperties'] = result

    document_references = [

        ('org_admin_agreement_link_id', 'org_admin_agreement',

         lambda x: x.org_admin_agreement),

        ('mentor_agreement_link_id', 'mentor_agreement',

         lambda x: x.mentor_agreement),

        ('student_agreement_link_id', 'student_agreement',

         lambda x: x.student_agreement),

        ]

    new_params['references'] = document_references

    params = dicts.merge(params, new_params, sub_merge=True)

    super(View, self).__init__(params=params)

  def _getAcceptedOrgsList(self, description, params, filter, use_cache):

    """Returns a list with all accepted orgs.

    Args:

      description: the description of the list

      params: the params to use

      filter: the filter to use

      use_cache: whether or not to use the cache

    """

    logic = params['logic']

    order = ['name']

    if not use_cache:

      fun = self._getData

    else:

      # only cache if all profiles are created

      fun =  soc.cache.logic.cache(self._getData)

    entities = fun(logic.getModel(), filter, order, logic)

    result = dicts.rename(params, params['list_params'])

    result['action'] = (redirects.getHomeRedirect, params)

    result['description'] = description

    result['pagination'] = 'soc/list/no_pagination.html'

    result['data'] = entities

    return result

  @decorators.merge_params

  @decorators.check_access

  def acceptedOrgs(self, request, access_type,

                   page_name=None, params=None, filter=None, **kwargs):

    """See base.View.list.

    """

    contents = []

    logic = params['logic']

    program_entity = logic.getFromKeyFieldsOr404(kwargs)

    fmt = {'name': program_entity.name}

    description = self.DEF_ACCEPTED_ORGS_MSG_FMT % fmt

    filter = {

        'status': 'accepted',

        'scope': program_entity,

        }

    from soc.views.models import org_app as org_app_view

    aa_params = org_app_view.view.getParams().copy() # accepted applications

    # define the list redirect action to show the notification

    del aa_params['list_key_order']

    aa_params['list_action'] = (redirects.getHomeRedirect, aa_params)

    aa_params['list_description'] = description

    aa_list = lists.getListContent(request, aa_params, filter, idx=0,

                                   need_content=True)

    if aa_list:

      contents.append(aa_list)

    use_cache = not aa_list # only cache if there are no aa's left

    description = self.DEF_CREATED_ORGS_MSG_FMT % fmt

    filter['status'] = ['new', 'active']

    from soc.views.models.organization import view as org_view

    ao_params = org_view.getParams().copy() # active orgs

    ao_list = self._getAcceptedOrgsList(description, ao_params, filter, use_cache)

    contents.append(ao_list)

    params = params.copy()

    params['list_msg'] = program_entity.accepted_orgs_msg

    return self._list(request, params, contents, page_name)

  @decorators.merge_params

  @decorators.check_access

  def slots(self, request, acces_type, page_name=None, params=None, **kwargs):

    """Returns a JSON object with all orgs allocation.

    Args:

      request: the standard Django HTTP request object

      access_type : the name of the access type which should be checked

      page_name: the page name displayed in templates as page and header title

      params: a dict with params for this View, not used

    """

    from django.utils import simplejson

    program = program_logic.logic.getFromKeyFieldsOr404(kwargs)

    program_slots = program.slots

    filter = {

          'scope': program,

          'status': 'active',

          }

    query = org_logic.logic.getQueryForFields(filter=filter)

    organizations = org_logic.logic.getAll(query)

    locked_slots = adjusted_slots = {}

    if request.method == 'POST' and 'result' in request.POST:

      result = request.POST['result']

      submit = request.GET.get('submit')

      load = request.GET.get('load')

      stored = program.slots_allocation

      if load and stored:

        result = stored

      from_json = simplejson.loads(result)

      locked_slots = dicts.groupDictBy(from_json, 'locked', 'slots')

      if submit:

        program.slots_allocation = result

        program.put()

    orgs = {}

    applications = {}

    max = {}

    for org in organizations:

      orgs[org.link_id] = org

      applications[org.link_id] = org.nr_applications

      max[org.link_id] = min(org.nr_mentors, org.slots_desired)

    max_slots_per_org = program.max_slots

    min_slots_per_org = program.min_slots

    algorithm = 2

    allocator = allocations.Allocator(orgs.keys(), applications, max,

                                      program_slots, max_slots_per_org,

                                      min_slots_per_org, algorithm)

    result = allocator.allocate(locked_slots)

    data = []

    # TODO: remove adjustment here and in the JS

    for link_id, count in result.iteritems():

      org = orgs[link_id]

      data.append({

          'link_id': link_id,

          'slots': count,

          'locked': locked_slots.get(link_id, 0),

          'adjustment': adjusted_slots.get(link_id, 0),

          })

    return self.json(request, data)

  @decorators.merge_params

  @decorators.check_access

  def assignSlots(self, request, access_type, page_name=None,

                  params=None, **kwargs):

    """View that allows to assign slots to orgs.

    """

    from soc.views.models import organization as organization_view

    org_params = organization_view.view.getParams().copy()

    org_params['list_template'] = 'soc/program/allocation/allocation.html'

    org_params['list_heading'] = 'soc/program/allocation/heading.html'

    org_params['list_row'] = 'soc/program/allocation/row.html'

    org_params['list_pagination'] = 'soc/list/no_pagination.html'

    program = program_logic.logic.getFromKeyFieldsOr404(kwargs)

    description = self.DEF_SLOTS_ALLOCATION_MSG

    filter = {

        'scope': program,

        'status': 'active',

        }

    content = self._getAcceptedOrgsList(description, org_params, filter, False)

    contents = [content]

    return_url =  "http://%(host)s%(index)s" % {

      'host' : os.environ['HTTP_HOST'],

      'index': redirects.getSlotsRedirect(program, params)

      }

    context = {

        'total_slots': program.slots,

        'uses_json': True,

        'uses_slot_allocator': True,

        'return_url': return_url,

        }

    return self._list(request, org_params, contents, page_name, context)

  @decorators.merge_params

  @decorators.check_access

  def showDuplicates(self, request, access_type, page_name=None,

                     params=None, **kwargs):

    """View in which a host can see which students have been assigned 

       multiple slots.

    For params see base.view.Public().

    """

    from django.utils import simplejson

    from soc.logic.models.proposal_duplicates import logic as duplicates_logic

    program_entity = program_logic.logic.getFromKeyFieldsOr404(kwargs)

    if request.POST and request.POST.get('result'):

      # store result in the datastore

      fields = {'link_id': program_entity.link_id,

                'scope': program_entity,

                'scope_path': program_entity.key().name(),

                'json_representation' : request.POST['result']

                }

      key_name = duplicates_logic.getKeyNameFromFields(fields)

      duplicates_logic.updateOrCreateFromKeyName(fields, key_name)

      response = simplejson.dumps({'status': 'done'})

      return http.HttpResponse(response)

    context = helper.responses.getUniversalContext(request)

    helper.responses.useJavaScript(context, params['js_uses_all'])

    context['uses_duplicates'] = True

    context['uses_json'] = True

    context['page_name'] = page_name

    # get all orgs for this program who are active and have slots assigned

    fields = {'scope': program_entity,

              'slots >': 0,

              'status': 'active'}

    query = org_logic.logic.getQueryForFields(fields)

    to_json = {

        'nr_of_orgs': query.count(),

        'program_key': program_entity.key().name()}

    json = simplejson.dumps(to_json)

    context['info'] = json

    context['offset_length'] = 10

    fields = {'link_id': program_entity.link_id,

              'scope': program_entity}

    duplicates = duplicates_logic.getForFields(fields, unique=True)

    if duplicates:

      # we have stored information

      context['duplicate_cache_content'] = duplicates.json_representation

      context['date_of_calculation'] = duplicates.calculated_on

    else:

      # no information stored

      context['duplicate_cache_content'] = simplejson.dumps({})

    template = 'soc/program/show_duplicates.html'

    return helper.responses.respond(request, template=template, context=context)

  @decorators.merge_params

  @decorators.check_access

  def assignedProposals(self, request, access_type, page_name=None,

                        params=None, filter=None, **kwargs):

    """Returns a JSON dict containing all the proposals that would have

    a slot assigned for a specific set of orgs.

    The request.GET limit and offset determines how many and which

    organizations should be returned.

    For params see base.View.public().

    Returns: JSON object with a collection of orgs and proposals. Containing

             identification information and contact information.

    """

    get_dict = request.GET

    if not (get_dict.get('limit') and get_dict.get('offset')):

      return self.json(request, {})

    try:

      limit = max(0, int(get_dict['limit']))

      offset = max(0, int(get_dict['offset']))

    except ValueError:

      return self.json(request, {})

    program_entity = program_logic.logic.getFromKeyFieldsOr404(kwargs)

    fields = {'scope': program_entity,