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

__authors__ = [
    '"Sverre Rabbelier" <sverre@rabbelier.nl>',
    '"Lennard de Rijk" <ljvderijk@gmail.com>',
    '"Pawel Solyga" <pawel.solyga@gmail.com>',
  ]


from google.appengine.api import users

from django import forms
from django.utils.translation import ugettext_lazy

from soc.logic import dicts
from soc.logic.models import sponsor as sponsor_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 redirects
from soc.views.models import base

import soc.models.request
import soc.logic.models.request
import soc.logic.dicts
import soc.views.helper
import soc.views.helper.lists
import soc.views.helper.responses
import soc.views.helper.widgets


class CreateForm(helper.forms.BaseForm):
  """Django form displayed when Developer creates a Request.
  """

  class Meta:
    """Inner Meta class that defines some behavior for the form.
    """
    model = soc.models.request.Request

    #: list of model fields which will *not* be gathered by the form 
    exclude = ['scope', 'scope_path', 'link_id', 'role', 'declined']

  role = forms.CharField(widget=helper.widgets.ReadOnlyInput())

  user = forms.CharField(
      label=soc.models.request.Request.link_id.verbose_name,
      help_text=soc.models.request.Request.link_id.help_text,
      widget=helper.widgets.ReadOnlyInput())

  group = forms.CharField(
      label=soc.models.request.Request.scope.verbose_name,
      help_text=soc.models.request.Request.scope.help_text,
      widget=helper.widgets.ReadOnlyInput())

  def clean_user(self):
    self.cleaned_data['requester'] =  user_logic.logic.getForFields(
        {'link_id': self.cleaned_data['user']}, unique=True)
    return self.cleaned_data['user']

  def clean_group(self):
    self.cleaned_data['to'] = sponsor_logic.logic.getFromFields(
        link_id=self.cleaned_data['group'])
    return self.cleaned_data['group']


class EditForm(CreateForm):
  """Django form displayed when Developer edits a Request.
  """

  pass


class View(base.View):
  """View methods for the Docs 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 = {}
    rights['listSelf'] = [access.checkIsUser]

    new_params = {}
    new_params['rights'] = rights
    new_params['logic'] = soc.logic.models.request.logic

    new_params['name'] = "Request"
    new_params['name_short'] = "Request"
    new_params['name_plural'] = "Requests"
    new_params['url_name'] = "request"
    new_params['module_name'] = "request"

    new_params['edit_form'] = EditForm
    new_params['create_form'] = CreateForm

    new_params['sidebar_defaults'] = [('/%s/list', 'List %(name_plural)s', 'list')]

    new_params['save_message'] = [ugettext_lazy('Request saved.')]

    params = dicts.merge(params, new_params)

    super(View, self).__init__(params=params)
    
    
  def listSelf(self, request, page_name=None, params=None, **kwargs):
    """Displays the unhandled requests for this user.

    Args:
      request: the standard Django HTTP request object
      page_name: the page name displayed in templates as page and header title
      params: a dict with params for this View
      kwargs: not used
    """

    params = dicts.merge(params, self._params)
    params['logic'] = self._logic

    try:
      access.checkAccess('listSelf', request, params['rights'])
    except out_of_band.Error, error:
      return helper.responses.errorResponse(error, request)

    # get the current user
    properties = {'account': users.get_current_user()}
    user_entity = user_logic.logic.getForFields(properties, unique=True)

    # construct the Unhandled Requests list

    # only select the requests for this user that haven't been handled yet
    filter = {'link_id': user_entity.link_id,
              'group_accepted' : True}
    
    uh_params = params.copy()
    uh_params['list_action'] = (redirects.inviteAcceptedRedirect, None)
    uh_params['list_description'] = ugettext_lazy(
        "An overview of your unhandled requests.")

    uh_list = helper.lists.getListContent(
        request, uh_params, filter, 0)

    # construct the Open Requests list
    
    # only select the requests for the user
    # that haven't been accepted by an admin yet
    filter = {'link_id' : user_entity.link_id,
              'group_accepted' : False}
    
    ar_params = params.copy()
    ar_params['list_description'] = ugettext_lazy(
        "List of your pending requests.")
    
    ar_list = helper.lists.getListContent(
        request, ar_params, filter, 1)
    
    # fill contents with all the needed lists
    contents = [uh_list, ar_list]
    
    # call the _list method from base to display the list
    return self._list(request, params, contents, page_name)

  def _editSeed(self, request, seed):
    """See base.View._editGet().
    """

    # fill in the email field with the data from the entity
    seed['user'] = seed['link_id']
    seed['group'] = seed['scope_path']

  def _editGet(self, request, entity, form):
    """See base.View._editGet().
    """

    # fill in the email field with the data from the entity
    form.fields['user'].initial = entity.link_id
    form.fields['group'].initial = entity.scope_path

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

  def _editPost(self, request, entity, fields):
    """See base.View._editPost().
    """

    # fill in the account field with the user created from email
    fields['link_id'] = fields['requester'].link_id
    fields['scope_path'] = fields['to'].link_id
    fields['scope'] = fields['to']

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


view = View()

create = view.create
edit = view.edit
delete = view.delete
list = view.list
list_self = view.listSelf
public = view.public
