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

"""

__authors__ = [

    '"Augie Fackler" <durin42@gmail.com>',

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

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

  ]

import itertools

from django import forms

from django.utils.translation import ugettext

from soc.logic import cleaning

from soc.logic import dicts

from soc.logic import accounts

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 program as program_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 redirects

from soc.views.helper import widgets

from soc.views.models import group

from soc.views.models import program as program_view

import soc.models.organization

import soc.logic.models.organization

class View(group.View):

  """View methods for the Organization 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:

      original_params: a dict with params for this View

    """

    rights = access.Checker(params)

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

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

    rights['create'] = ['checkIsDeveloper']

    rights['edit'] = [('checkHasActiveRoleForKeyFieldsAsScope',

                           org_admin_logic.logic,),

                      ('checkGroupIsActiveForLinkId', org_logic.logic)]

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

    rights['home'] = ['allow']

    rights['public_list'] = ['allow']

    rights['apply_mentor'] = ['checkIsUser']

    rights['list_requests'] = [('checkHasActiveRoleForKeyFieldsAsScope',

                                org_admin_logic.logic)]

    rights['list_roles'] = [('checkHasActiveRoleForKeyFieldsAsScope',

                             org_admin_logic.logic)]

    rights['applicant'] = [('checkIsApplicationAccepted',

                            org_app_logic.logic)]

    rights['list_proposals'] = [('checkHasAny', [

        [('checkHasActiveRoleForKeyFieldsAsScope', [org_admin_logic.logic]),

         ('checkHasActiveRoleForKeyFieldsAsScope', [mentor_logic.logic])]

        ])]

    new_params = {}

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

    new_params['rights'] = rights

    new_params['scope_view'] = program_view

    new_params['scope_redirect'] = redirects.getCreateRedirect

    new_params['name'] = "Organization"

    new_params['url_name'] = "org"

    new_params['document_prefix'] = "org"

    new_params['sidebar_grouping'] = 'Organizations'

    new_params['public_template'] = 'soc/organization/public.html'

    new_params['list_row'] = 'soc/organization/list/row.html'

    new_params['list_heading'] = 'soc/organization/list/heading.html'

    new_params['application_logic'] = org_app_logic

    new_params['group_applicant_url'] = True

    new_params['sans_link_id_public_list'] = True

    new_params['extra_dynaexclude'] = ['slots']

    patterns = []

    patterns += [

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

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

        "List of all %(name_plural)s you can apply to"),

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

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

        "List of all Student Proposals for this %(name)s"),

        ]

    new_params['extra_django_patterns'] = patterns

    new_params['create_extra_dynaproperties'] = {

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

                                   required=True),

        'description': forms.fields.CharField(

            widget=helper.widgets.FullTinyMCE(

                attrs={'rows': 25, 'cols': 100})),

        'contrib_template': forms.fields.CharField(

            widget=helper.widgets.FullTinyMCE(

                attrs={'rows': 25, 'cols': 100})),

        'clean_description': cleaning.clean_html_content('description'),

        'clean_contrib_template': cleaning.clean_html_content('contrib_template'),

        'clean_ideas': cleaning.clean_url('ideas'),

        'clean': cleaning.validate_new_group('link_id', 'scope_path',

            soc.logic.models.organization, org_app_logic)

        }

    new_params['edit_extra_dynaproperties'] = {

        'clean': cleaning.clean_refs(new_params, ['home_link_id'])

        }

    params = dicts.merge(params, new_params)

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

    # create and store the special form for applicants

    updated_fields = {

        'link_id': forms.CharField(widget=widgets.ReadOnlyInput(),

            required=False),

        'clean_link_id': cleaning.clean_link_id('link_id')

        }

    applicant_create_form = dynaform.extendDynaForm(

        dynaform = self._params['create_form'],

        dynaproperties = updated_fields)

    params['applicant_create_form'] = applicant_create_form

  @decorators.merge_params

  @decorators.check_access

  def applyMentor(self, request, access_type,

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

    """Shows a list of all organizations and you can choose one to

       apply to become a mentor.

    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

      kwargs: the Key Fields for the specified entity

    """

    list_params = params.copy()

    list_params['list_action'] = (redirects.getRequestRedirectForRole, 'mentor')

    list_params['list_description'] = ugettext('Choose an Organization which '

        'you want to become a Mentor for.')

    filter = {'scope_path': kwargs['scope_path'],

              'status' : 'active'}

    return self.list(request, access_type,

        page_name, params=list_params, filter=filter)

  @decorators.merge_params

  @decorators.check_access

  def listProposals(self, request, access_type,

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

    """Lists all proposals for the organization given in kwargs.

    For params see base.View.public().

    """

    from soc.logic.models.ranker_root import logic as ranker_root_logic

    from soc.models import student_proposal

    from soc.views.models import student_proposal as student_proposal_view

    try:

      org_entity = self._logic.getFromKeyFieldsOr404(kwargs)

    except out_of_band.Error, error:

      return helper.responses.errorResponse(

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

    list_params = student_proposal_view.view.getParams().copy()

    ranked_params = list_params.copy()# ranked proposals

    ranked_params['list_row'] = ('soc/%(module_name)s/list/'

        'detailed_row.html' % list_params)

    ranked_params['list_heading'] = ('soc/%(module_name)s/list/'

        'detailed_heading.html' % list_params)

    ranked_params['list_description'] = '%s already under review sent to %s' %(

        ranked_params['name_plural'], org_entity.name)

    ranked_params['list_action'] = (redirects.getReviewRedirect, ranked_params)

    # TODO(ljvderijk) once sorting with IN operator is fixed, 

    # make this list show more

    filter = {'org': org_entity,

              'status': 'pending'}

    # order by descending score

    order = ['-score']

    prop_list = lists.getListContent(

        request, ranked_params, filter, order=order, idx=0)

    proposals = prop_list['data']

    # get a list of scores

    scores = [[proposal.score] for proposal in proposals]

    # retrieve the ranker

    fields = {'link_id': student_proposal.DEF_RANKER_NAME,

                'scope': org_entity}

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

    ranker = ranker_root_logic.getRootFromEntity(ranker_root)

    # retrieve the ranks for these scores

    ranks = [rank+1 for rank in ranker.FindRanks(scores)]

    # link the proposals to the rank

    ranking = dict([i for i in itertools.izip(proposals, ranks)])

    # update the prop_list with the ranking information

    prop_list['info'] = ((lambda item, cache: {'rank': cache[item]}), ranking)

    new_params = list_params.copy() # new proposals

    new_params['list_description'] = 'List of new %s send to %s ' %(

        new_params['name_plural'], org_entity.name)

    new_params['list_action'] = (redirects.getReviewRedirect, new_params)

    filter = {'org': org_entity,

              'status': 'new'}

    new_list = lists.getListContent(

        request, new_params, filter, idx=1)

    # fill contents with all the needed lists

    contents = [prop_list, new_list]

    # call the _list method from base to display the list

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

  @decorators.merge_params

  @decorators.check_access

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

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

    """See base.View.list.

    """

    account = accounts.getCurrentAccount()

    user = user_logic.logic.getForAccount(account) if account else None

    try:

      rights = self._params['rights']

      rights.setCurrentUser(account, user)

      rights.checkIsHost()

      is_host = True

    except out_of_band.Error:

      is_host = False

    new_params = {}

    if is_host:

      new_params['list_action'] = (redirects.getAdminRedirect, params)

    else:

      new_params['list_action'] = (redirects.getPublicRedirect, params)

    # safe to merge them the wrong way around because of @merge_params

    params = dicts.merge(new_params, params)

    new_filter = {}

    new_filter['scope_path'] = kwargs['scope_path']

    new_filter['status'] = 'active'

    filter = dicts.merge(filter, new_filter)

    content = lists.getListContent(request, params, filter)

    contents = [content]

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

  def _getExtraMenuItems(self, role_description, params=None):

    """Used to create the specific Organization menu entries.

    For args see group.View._getExtraMenuItems().

    """

    submenus = []

    group_entity = role_description['group']

    roles = role_description['roles']

    if roles.get('org_admin') or roles.get('mentor'):

      # add a link to view all the student proposals

      submenu = (redirects.getListProposalsRedirect(group_entity, params),

          "View all Student Proposals", 'any_access')

      submenus.append(submenu)

    if roles.get('org_admin'):

      # add a link to the management page

      submenu = (redirects.getListRolesRedirect(group_entity, params),

          "Manage Admins and Mentors", 'any_access')

      submenus.append(submenu)

      # add a link to invite an org admin

      submenu = (redirects.getInviteRedirectForRole(group_entity, 'org_admin'),

          "Invite an Admin", 'any_access')

      submenus.append(submenu)

      # add a link to invite a member

      submenu = (redirects.getInviteRedirectForRole(group_entity, 'mentor'),

          "Invite a Mentor", 'any_access')

      submenus.append(submenu)

      # add a link to the request page

      submenu = (redirects.getListRequestsRedirect(group_entity, params),

          "List Requests and Invites", 'any_access')

      submenus.append(submenu)

      # add a link to the edit page

      submenu = (redirects.getEditRedirect(group_entity, params),

          "Edit Organization Profile", 'any_access')

      submenus.append(submenu)

    if roles.get('org_admin') or roles.get('mentor'):

      submenu = (redirects.getCreateDocumentRedirect(group_entity, 'org'),

          "Create a New Document", 'any_access')

      submenus.append(submenu)

      submenu = (redirects.getListDocumentsRedirect(group_entity, 'org'),

          "List Documents", 'any_access')

      submenus.append(submenu)

    if roles.get('org_admin'):

      # add a link to the resign page

      submenu = (redirects.getManageRedirect(roles['org_admin'],

          {'url_name': 'org_admin'}),

          "Resign as Admin", 'any_access')

      submenus.append(submenu)

      # add a link to the edit page

      submenu = (redirects.getEditRedirect(roles['org_admin'],

          {'url_name': 'org_admin'}),

          "Edit My Admin Profile", 'any_access')

      submenus.append(submenu)

    if roles.get('mentor'):

      # add a link to the resign page

      submenu = (redirects.getManageRedirect(roles['mentor'],

          {'url_name' : 'mentor'}),

          "Resign as Mentor", 'any_access')

      submenus.append(submenu)

      # add a link to the edit page

      submenu = (redirects.getEditRedirect(roles['mentor'],

          {'url_name': 'mentor'}),

          "Edit My Mentor Profile", 'any_access')

      submenus.append(submenu)

    return submenus

view = View()

admin = decorators.view(view.admin)

applicant = decorators.view(view.applicant)

apply_mentor = decorators.view(view.applyMentor)

create = decorators.view(view.create)

delete = decorators.view(view.delete)

edit = decorators.view(view.edit)

home = decorators.view(view.home)

list = decorators.view(view.list)

list_proposals = decorators.view(view.listProposals)

list_public = decorators.view(view.listPublic)

list_requests = decorators.view(view.listRequests)

list_roles = decorators.view(view.listRoles)

public = decorators.view(view.public)

export = decorators.view(view.export)

pick = decorators.view(view.pick)