#!/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.

"""Views for Student Project.

"""

__authors__ = [

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

  ]

import logging

import time

from django import forms

from django import http

from soc.logic import cleaning

from soc.logic import dicts

from soc.logic.models import mentor as mentor_logic

from soc.logic.models.organization import logic as org_logic

from soc.logic.models.org_admin import logic as org_admin_logic

from soc.logic.models import student as student_logic

from soc.logic.models.student_project import logic as project_logic

from soc.views import out_of_band

from soc.views.helper import access

from soc.views.helper import decorators

from soc.views.helper import dynaform

from soc.views.helper import forms as forms_helper

from soc.views.helper import lists

from soc.views.helper import params as params_helper

from soc.views.helper import redirects

from soc.views.helper import responses

from soc.views.helper import widgets

from soc.views.models import base

from soc.views.models import organization as org_view

import soc.logic.models.student_project

class View(base.View):

  """View methods for the Student Project model.

  """

  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['create'] = ['checkIsDeveloper']

    rights['edit'] = ['checkIsDeveloper']

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

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

    rights['list'] = ['checkIsDeveloper']

    rights['manage'] = [('checkHasActiveRoleForScope',

                         org_admin_logic),

        ('checkStudentProjectHasStatus', [['accepted']])]

    rights['manage_overview'] = [('checkHasActiveRoleForScope',

                         org_admin_logic)]

    # TODO: lack of better name here!

    rights['st_edit'] = ['checkIsMyStudentProject',

        ('checkStudentProjectHasStatus',

            [['accepted', 'completed']])

        ]

    new_params = {}

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

    new_params['rights'] = rights

    new_params['name'] = "Student Project"

    new_params['url_name'] = "student_project"

    new_params['sidebar_grouping'] = 'Students'

    new_params['scope_view'] = org_view

    new_params['scope_redirect'] = redirects.getCreateRedirect

    new_params['no_create_with_key_fields'] = True

    new_params['extra_dynaexclude'] = ['program', 'status', 'link_id',

                                       'mentor', 'additional_mentors',

                                       'student', 'passed_evaluations',

                                       'failed_evaluations']

    new_params['create_extra_dynaproperties'] = {

        'scope_path': forms.CharField(widget=forms.HiddenInput,

            required=True),

        'public_info': forms.fields.CharField(required=True,

            widget=widgets.FullTinyMCE(attrs={'rows': 25, 'cols': 100})),

        'student_id': forms.CharField(label='Student Link ID',

            required=True),

        'mentor_id': forms.CharField(label='Mentor Link ID',

            required=True),

        'clean_abstract': cleaning.clean_content_length('abstract'),

        'clean_public_info': cleaning.clean_html_content('public_info'),

        'clean_student': cleaning.clean_link_id('student'),

        'clean_mentor': cleaning.clean_link_id('mentor'),

        'clean_additional_info': cleaning.clean_url('additional_info'),

        'clean_feed_url': cleaning.clean_feed_url,

        'clean': cleaning.validate_student_project('scope_path',

            'mentor_id', 'student_id')

        }

    new_params['edit_extra_dynaproperties'] = {

        'link_id': forms.CharField(widget=forms.HiddenInput),

        }

    patterns = [

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

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

        'Overview of %(name_plural)s to Manage for'),

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

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

        'Manage %(name)s'),

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

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

        'Edit my %(name)s'),

    ]

    new_params['extra_django_patterns'] = patterns

    new_params['edit_template'] = 'soc/student_project/edit.html'

    new_params['manage_template'] = 'soc/student_project/manage.html'

    params = dicts.merge(params, new_params)

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

    # create the form that students will use to edit their projects

    dynaproperties = {

        'public_info': forms.fields.CharField(required=True,

            widget=widgets.FullTinyMCE(attrs={'rows': 25, 'cols': 100})),

        'clean_abstract': cleaning.clean_content_length('abstract'),

        'clean_public_info': cleaning.clean_html_content('public_info'),

        'clean_additional_info': cleaning.clean_url('additional_info'),

        'clean_feed_url': cleaning.clean_feed_url,

        }

    student_edit_form = dynaform.newDynaForm(

        dynabase = self._params['dynabase'],

        dynamodel = self._params['logic'].getModel(),

        dynaexclude = self._params['create_dynaexclude'],

        dynaproperties = dynaproperties,

    )

    self._params['student_edit_form'] = student_edit_form

  def _editGet(self, request, entity, form):

    """See base.View._editGet().

    """

    form.fields['link_id'].initial = entity.link_id

    form.fields['student_id'].initial = entity.student.link_id

    form.fields['mentor_id'].initial = entity.mentor.link_id

    return super(View, self)._editGet(request, entity, form)

  def _editPost(self, request, entity, fields):

    """See base.View._editPost().

    """

    if not entity:

      fields['link_id'] = 't%i' % (int(time.time()*100))

    else:

      fields['link_id'] = entity.link_id

    # fill in the scope via call to super

    super(View, self)._editPost(request, entity, fields)

    # editing a project so set the program, student and mentor field

    if entity:

      organization = entity.scope

    else:

      organization = fields['scope']

    fields['program'] = organization.scope

    filter = {'scope': fields['program'],

              'link_id': fields['student_id']}

    fields['student'] = student_logic.logic.getForFields(filter, unique=True)

    filter = {'scope': organization,

              'link_id': fields['mentor_id'],

              'status': 'active'}

    fields['mentor'] = mentor_logic.logic.getForFields(filter, unique=True)

  def _public(self, request, entity, context):

    """Adds the names of all additional mentors to the context.

    For params see base.View._public()

    """

    additional_mentors = entity.additional_mentors

    if not additional_mentors:

      context['additional_mentors'] = []

    else:

      mentor_names = []

      for mentor_key in additional_mentors:

        additional_mentor = mentor_logic.logic.getFromKeyName(

            mentor_key.id_or_name())

        mentor_names.append(additional_mentor.name())

      context['additional_mentors'] = ', '.join(mentor_names)

  @decorators.merge_params

  @decorators.check_access

  def manage(self, request, access_type,

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

    """View that allows Organization Admins to manage their Student Projects.

    For params see base.View().public()

    """

    try:

      entity = self._logic.getFromKeyFieldsOr404(kwargs)

    except out_of_band.Error, error:

      return responses.errorResponse(

          error, request, template=params['error_public'])

    get_dict = request.GET

    if 'remove' in get_dict:

      # get the mentor to remove

      fields = {'link_id': get_dict['remove'],

                'scope': entity.scope}

      mentor = mentor_logic.logic.getForFields(fields, unique=True)

      additional_mentors = entity.additional_mentors

      # pylint: disable-msg=E1103

      if additional_mentors and mentor.key() in additional_mentors:

        # remove the mentor from the additional mentors list

        additional_mentors.remove(mentor.key())

        fields = {'additional_mentors': additional_mentors}

        project_logic.updateEntityProperties(entity, fields)

      # redirect to the same page without GET arguments

      redirect = request.path

      return http.HttpResponseRedirect(redirect)

    template = params['manage_template']

    # get the context for this webpage

    context = responses.getUniversalContext(request)

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

    context['page_name'] = "%s '%s' from %s" % (page_name, entity.title,

                                                entity.student.name())

    context['entity'] = entity

    # get all mentors for this organization

    fields = {'scope': entity.scope,

              'status': 'active'}

    mentors = mentor_logic.logic.getForFields(fields)

    choices = [(mentor.link_id,'%s (%s)' %(mentor.name(), mentor.link_id))

                  for mentor in mentors]

    # create the form that org admins will use to reassign a mentor

    dynafields = [

        {'name': 'mentor_id',

         'base': forms.ChoiceField,

         'label': 'Primary Mentor',

         'required': True,

         'passthrough': ['required', 'choices', 'label'],

         'choices': choices,

        },]

    dynaproperties = params_helper.getDynaFields(dynafields)

    mentor_edit_form = dynaform.newDynaForm(

        dynabase = params['dynabase'],

        dynaproperties = dynaproperties,

    )

    params['mentor_edit_form'] = mentor_edit_form

    additional_mentors = entity.additional_mentors

    # we want to show the names of the additional mentors in the context

    # therefore they need to be resolved to entities first

    additional_mentors_context = []

    for mentor_key in additional_mentors:

      mentor_entity = mentor_logic.logic.getFromKeyName(

          mentor_key.id_or_name())

      additional_mentors_context.append(mentor_entity)

    context['additional_mentors'] = additional_mentors_context

    # all mentors who are not already an additional mentor or

    # the primary mentor are allowed to become an additional mentor

    possible_additional_mentors = [m for m in mentors if 

        (m.key() not in additional_mentors) 

        and (m.key() != entity.mentor.key())]

    # create the information to be shown on the additional mentor form

    additional_mentor_choices = [

        (mentor.link_id,'%s (%s)' %(mentor.name(), mentor.link_id))

        for mentor in possible_additional_mentors]

    dynafields = [

        {'name': 'mentor_id',

         'base': forms.ChoiceField,

         'label': 'Co-Mentor',

         'required': True,

         'passthrough': ['required', 'choices', 'label'],

         'choices': additional_mentor_choices,

        },]

    dynaproperties = params_helper.getDynaFields(dynafields)

    additional_mentor_form = dynaform.newDynaForm(

        dynabase = params['dynabase'],

        dynaproperties = dynaproperties,

    )

    params['additional_mentor_form'] = additional_mentor_form

    if request.POST:

      return self.managePost(request, template, context, params, entity,

                             **kwargs)

    else: #request.GET

      return self.manageGet(request, template, context, params, entity,

                            **kwargs)

  def manageGet(self, request, template, context, params, entity, **kwargs):

    """Handles the GET request for the project's manage page.

    Args:

        template: the template used for this view

        entity: the student project entity

        rest: see base.View.public()

    """

    # populate form with the current mentor

    initial = {'mentor_id': entity.mentor.link_id}

    context['mentor_edit_form'] = params['mentor_edit_form'](initial=initial)

    context['additional_mentor_form'] = params['additional_mentor_form']()

    return responses.respond(request, template, context)

  def managePost(self, request, template, context, params, entity, **kwargs):

    """Handles the POST request for the project's manage page.

    Args:

        template: the template used for this view

        entity: the student project entity

        rest: see base.View.public()

    """

    post_dict = request.POST

    if 'set_mentor' in post_dict:

      form = params['mentor_edit_form'](post_dict)

      return self._manageSetMentor(request, template, context, params, entity,

                                   form)

    elif 'add_additional_mentor' in post_dict:

      form = params['additional_mentor_form'](post_dict)

      return self._manageAddAdditionalMentor(request, template, context,

                                             params, entity, form)

    else:

      # unexpected error return the normal page

      logging.warning('Unexpected POST data found')

      return self.manageGet(request, template, context, params, entity)

  def _manageSetMentor(self, request, template, context, params, entity, form):

    """Handles the POST request for changing a Projects's mentor.

    Args:

        template: the template used for this view

        entity: the student project entity

        form: instance of the form used to set the mentor

        rest: see base.View.public()

    """

    if not form.is_valid():

      context['mentor_edit_form'] = form

      # add an a fresh additional mentors form

      context['additional_mentor_form'] = params['additional_mentor_form']()

      return responses.respond(request, template, context)

    _, fields = forms_helper.collectCleanedFields(form)

    # get the mentor from the form

    fields = {'link_id': fields['mentor_id'],

              'scope': entity.scope,

              'status': 'active'}

    mentor = mentor_logic.logic.getForFields(fields, unique=True)

    # update the project with the assigned mentor

    fields = {'mentor': mentor}

    additional_mentors = entity.additional_mentors

    # pylint: disable-msg=E1103

    if additional_mentors and mentor.key() in additional_mentors:

      # remove the mentor that is now becoming the primary mentor

      additional_mentors.remove(mentor.key())

      fields['additional_mentors'] = additional_mentors

    # update the project with the new mentor and possible 

    # new set of additional mentors

    project_logic.updateEntityProperties(entity, fields)

    # redirect to the same page

    redirect = request.path

    return http.HttpResponseRedirect(redirect)

  def _manageAddAdditionalMentor(self, request, template, 

                                 context, params, entity, form):

    """Handles the POST request for changing a Projects's additional mentors.

    Args:

        template: the template used for this view

        entity: the student project entity

        form: instance of the form used to add an additional mentor

        rest: see base.View.public()

    """

    if not form.is_valid():

      context['additional_mentor_form'] = form

      # add a fresh edit mentor form

      initial = {'mentor_id': entity.mentor.link_id}

      context['mentor_edit_form'] = params['mentor_edit_form'](initial=initial)

      return responses.respond(request, template, context)

    _, fields = forms_helper.collectCleanedFields(form)

    # get the mentor from the form

    fields = {'link_id': fields['mentor_id'],

              'scope': entity.scope,

              'status': 'active'}

    mentor = mentor_logic.logic.getForFields(fields, unique=True)

    # add this mentor to the additional mentors

    if not entity.additional_mentors:

      additional_mentors = [mentor.key()]

    else:

      additional_mentors = entity.additional_mentors

      additional_mentors.append(mentor.key())

    fields = {'additional_mentors': additional_mentors}

    project_logic.updateEntityProperties(entity, fields)

    # redirect to the same page

    redirect = request.path

    return http.HttpResponseRedirect(redirect)

  @decorators.merge_params

  @decorators.check_access

  def manageOverview(self, request, access_type,

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

    """View that allows Organization Admins to see an overview of 

       their Organization's Student Projects.

    For params see base.View().public()

    """

    # make sure the organization exists

    org_entity = org_logic.getFromKeyNameOr404(kwargs['scope_path'])

    fields = {'scope': org_entity}

    # get the context for this webpage

    context = responses.getUniversalContext(request)

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

    context['page_name'] = '%s %s' % (page_name, org_entity.name)