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

"""

__authors__ = [

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

  ]

import datetime

import time

from django import forms

from django import http

from django.utils.translation import ugettext

from soc.logic import cleaning

from soc.logic import dicts

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 student as student_logic

from soc.logic.models import user as user_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 dynaform

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 student as student_view

import soc.logic.models.student_proposal

class View(base.View):

  """View methods for the Student Proposal 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['create'] = ['checkIsDeveloper']

    rights['edit'] = [('checkCanStudentPropose', ['scope_path', False]),

        ('checkRoleAndStatusForStudentProposal',

            [['proposer'], ['active'], ['new', 'pending', 'invalid']])]

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

    rights['show'] = [

        ('checkRoleAndStatusForStudentProposal',

            [['proposer', 'org_admin', 'mentor', 'host'], 

            ['active', 'inactive'], 

            ['new', 'pending', 'accepted', 'rejected', 'invalid']])]

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

    rights['list_orgs'] = [

        ('checkIsStudent', ['scope_path', ['active']]),

        ('checkCanStudentPropose', ['scope_path', False])]

    rights['list_self'] = [

        ('checkIsStudent', ['scope_path', ['active', 'inactive']])]

    rights['apply'] = [

        ('checkIsStudent', ['scope_path', ['active']]),

        ('checkCanStudentPropose', ['scope_path', True])]

    rights['review'] = [('checkRoleAndStatusForStudentProposal',

            [['org_admin', 'mentor', 'host'], 

            ['active'], ['new', 'pending', 'invalid']])]

    new_params = {}

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

    new_params['rights'] = rights

    new_params['name'] = "Student Proposal"

    new_params['url_name'] = "student_proposal"

    new_params['sidebar_grouping'] = 'Students'

    new_params['scope_view'] = student_view

    new_params['scope_redirect'] = redirects.getCreateRedirect

    new_params['no_create_with_key_fields'] = True

    patterns = [

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

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

        'Create a new %(name)s'),

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

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

        'List my %(name_plural)s'),

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

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

        'List my %(name_plural)s'),

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

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

        'Review %(name)s'),

    ]

    new_params['extra_django_patterns'] = patterns

    new_params['extra_dynaexclude'] = ['org', 'program', 'score',

                                       'status', 'mentor', 'link_id',

                                       'possible_mentors']

    new_params['create_extra_dynaproperties'] = {

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

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

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

            required=True),

        'organization': forms.CharField(label='Organization Link ID',

            required=True),

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

        'clean_content': cleaning.clean_html_content('content'),

        'clean_organization': cleaning.clean_link_id('organization'),

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

        'clean': cleaning.validate_student_proposal('organization',

            'scope_path', student_logic, org_logic),

        }

    new_params['edit_extra_dynaproperties'] = {

        'organization': forms.CharField(label='Organization Link ID',

            widget=widgets.ReadOnlyInput),

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

        }

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

    new_params['review_template'] = 'soc/student_proposal/review.html'

    params = dicts.merge(params, new_params)

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

    # create the special form for students

    dynafields = [

        {'name': 'organization',

         'base': forms.CharField,

         'label': 'Organization Link ID',

         'widget': widgets.ReadOnlyInput(),

         'required': False,

         },

        ]

    dynaproperties = params_helper.getDynaFields(dynafields)

    student_create_form = dynaform.extendDynaForm(

        dynaform=self._params['create_form'],

        dynaproperties=dynaproperties)

    params['student_create_form'] = student_create_form

    # create the special form for public review

    dynafields = [

        {'name': 'comment',

         'base': forms.CharField,

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

         'label': 'Comment',

         'required': False,

         },

         ]

    dynaproperties = params_helper.getDynaFields(dynafields)

    dynaproperties['clean_comment'] = cleaning.clean_html_content('comment')

    public_review_form = dynaform.newDynaForm(dynamodel=None, 

        dynabase=helper.forms.BaseForm, dynainclude=None, 

        dynaexclude=None, dynaproperties=dynaproperties)

    params['public_review_form'] = public_review_form

    # create the special form for mentors

    dynafields = [

        {'name': 'score',

         'base': forms.ChoiceField,

         'label': 'Score',

         'initial': 0,

         'required': False,

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

         'example_text':

             'A score will only be assigned if the review is private!',

         'choices': [(-4,'-4: Wow. This. Sucks.'),

                     (-3,'-3: Needs a lot of work'),

                     (-2,'-2: This is bad'),

                     (-1,'-1: I dont like this'),

                     (0,'0: No score'),

                     (1,'1: Might have potential'),

                     (2,'2: Good'),

                     (3,'3: Almost there'),

                     (4,'4: Made. Of. Awesome.')]

        },

        {'name': 'comment',

         'base': forms.CharField,

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

         'label': 'Comment',

         'required': False,

         },

        {'name': 'public',

         'base': forms.BooleanField,

         'label': 'Review visible to Student',

         'initial': False,

         'required': False,

         'help_text': 'By ticking this box the score will not be assigned, '

             'and the review will be visible to the student.',

         },

         ]

    dynaproperties = params_helper.getDynaFields(dynafields)

    dynaproperties['clean_comment'] = cleaning.clean_html_content('comment')

    mentor_review_form = dynaform.newDynaForm(dynamodel=None, 

        dynabase=helper.forms.BaseForm, dynainclude=None, 

        dynaexclude=None, dynaproperties=dynaproperties)

    params['mentor_review_form'] = mentor_review_form

    # TODO see if autocomplete can be used for mentor field

    dynafields = [

      {'name': 'rank',

         'base': forms.IntegerField,

         'label': 'Set to rank',

         'help_text':

             'Set this proposal to the given rank (ignores the given score)',

         'example_text': 'A rank will only be assigned if the '

            'review is private!',

         'min_value': 1,

         'required': False,

         'passthrough': ['min_value', 'required', 'help_text'],

      },

      {'name': 'mentor',

       'label': 'Assign Mentor (Link ID)',

       'required': False,

       'help_text': 'Fill in the Link ID of the Mentor '

           'you would like to assign to this Proposal. '

           'Leave this box empty if you don\'t want any mentor assigned.',

      },

      ]

    dynaproperties = params_helper.getDynaFields(dynafields)

    dynaproperties['clean_comment'] = cleaning.clean_html_content('comment')

    admin_review_form = dynaform.extendDynaForm(dynaform=mentor_review_form, 

        dynaproperties=dynaproperties)

    params['admin_review_form'] = admin_review_form

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

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

    """

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

    form.fields['organization'].initial = entity.org.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)

    if not entity:

      # creating a new application so set the program and org field

      fields['program'] = fields['scope'].scope

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

                'link_id': fields['organization']}

      fields['org'] = org_logic.logic.getForFields(filter, unique=True)

    # explicitly change the last_modified_on since the content has been edited

    fields['last_modified_on'] = datetime.datetime.now()

  @decorators.merge_params

  @decorators.check_access

  def public(self, request, access_type,

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

    """View in which the student can see and reply to the comments on the

       Student Proposal.

    For params see base.view.Public().

    """

    context = helper.responses.getUniversalContext(request)

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

    context['page_name'] = page_name

    try:

      entity = self._logic.getFromKeyFieldsOr404(kwargs)

    except out_of_band.Error, error:

      return helper.responses.errorResponse(

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

    context['entity'] = entity

    context['entity_type'] = params['name']

    context['entity_type_url'] = params['url_name']

    if request.method == 'POST':

      return self.publicPost(request, context, params, entity, **kwargs)

    else: # request.method == 'GET'

      return self.publicGet(request, context, params, entity, **kwargs)

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

    """Handles the POST request for the entity's public page.

    Args:

        entity: the student proposal entity

        rest: see base.View.public()

    """

    # populate the form using the POST data

    form = params['public_review_form'](request.POST)

    if not form.is_valid():

      # get some entity specific context

      self.updatePublicContext(context, entity, params)

      # return the invalid form response

      return self._constructResponse(request, entity=entity, context=context,

          form=form, params=params, template=params['public_template'])

    # get the commentary

    fields = form.cleaned_data

    comment = fields['comment']

    if comment:

      # create a new public review containing the comment

      user_entity = user_logic.logic.getForCurrentAccount()

      if user_entity.key() == entity.scope.user.key():

        # student is posting

        reviewer = entity.scope

      else:

        # check if the person commenting is an org_admin

        # or a mentor for the given proposal

        fields = {'user': user_entity,

                  'scope': entity.org,

                  'status': 'active',

                  }

        reviewer = org_admin_logic.logic.getForFields(fields, unique=True)

        if not reviewer:

          # no org_admin found, maybe it's a mentor?

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

      # create the review (reviewer might be None 

      # if a Host or Developer is posting)

      self._createReviewFor(entity, reviewer, comment, is_public=True)

    # redirect to the same page

    return http.HttpResponseRedirect('')

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

    """Handles the GET request for the entity's public page.

    Args:

        entity: the student proposal entity

        rest see base.View.public()

    """

    from soc.logic.models.review_follower import logic as review_follower_logic

    get_dict = request.GET

    if get_dict.get('subscription') and (

      get_dict['subscription'] in ['on', 'off']):

      subscription = get_dict['subscription']

      # get the current user

      user_entity = user_logic.logic.getForCurrentAccount()

      # create the fields that should be in the ReviewFollower entity

      fields = {'link_id': user_entity.link_id,

                'scope': entity,

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

                'user': user_entity

               }

      # get the keyname for the ReviewFollower entity

      key_name = review_follower_logic.getKeyNameFromFields(fields)

      # determine if we should set subscribed_public to True or False

      if subscription == 'on':

        fields['subscribed_public'] = True

      elif subscription == 'off':

        fields['subscribed_public'] = False

      # update the ReviewFollower

      review_follower_logic.updateOrCreateFromKeyName(fields, key_name)

    # get some entity specific context

    self.updatePublicContext(context, entity, params)

    context['form'] = params['public_review_form']()

    template = params['public_template']

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

  def updatePublicContext(self, context, entity, params):

    """Updates the context for the public page with information from the entity.

    Args:

      context: the context that should be updated

      entity: a student proposal_entity used to set context

      params: dict with params for the view using this context

    """

    from soc.logic.models.review import logic as review_logic

    from soc.logic.models.review_follower import logic as review_follower_logic

    student_entity = entity.scope

    context['student'] = student_entity

    context['student_name'] = student_entity.name()

    user_entity = user_logic.logic.getForCurrentAccount()

    # check if the current user is the student

    if user_entity.key() == student_entity.user.key():

      # show the proposal edit link

      context['edit_link'] = redirects.getEditRedirect(entity, params)

    # check if the current user is subscribed to this proposal's public reviews

    fields = {'user': user_entity,

        'scope': entity,

        'subscribed_public': True}

    context['is_subscribed'] = review_follower_logic.getForFields(fields,

                                                                  unique=True)

    context['public_reviews'] = review_logic.getReviewsForEntity(entity,

        is_public=True, order=['created'])

  @decorators.merge_params

  @decorators.check_access

  def apply(self, request, access_type,

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

    """Special view used to prepopulate the form with the organization

       contributors template.

       For params see base.View.public()

    """

    get_dict = request.GET

    if get_dict.get('organization'):

      # organization chosen, prepopulate with template

      # get the organization

      student_entity = student_logic.logic.getFromKeyName(kwargs['scope_path'])

      program_entity = student_entity.scope

      filter = {'link_id': get_dict['organization'],

                'scope': program_entity}

      org_entity = org_logic.logic.getForFields(filter, unique=True)

      if org_entity:

        # organization found use special form

        params['create_form'] = params['student_create_form']

        kwargs['content'] = org_entity.contrib_template

    # Create page is an edit page with no key fields

    empty_kwargs = {}

    fields = self._logic.getKeyFieldNames()

    for field in fields:

      empty_kwargs[field] = None

    return super(View, self).edit(request, access_type, page_name=page_name,

                     params=params, seed=kwargs, **empty_kwargs)

  @decorators.merge_params

  @decorators.check_access