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

"""Redirect related methods.
"""

__authors__ = [
  '"Daniel Hans" <daniel.m.hans@gmail.com>',
  '"Sverre Rabbelier" <sverre@rabbelier.nl>',
  '"Lennard de Rijk" <ljvderijk@gmail.com>',
  ]


from google.appengine.ext import db


# TODO: Maybe redirects should become a class?
# Then the program specific redirects may inherit from this class.
# It is easier to maintain imports, as a view does not need to
# import both redirects and gsoc/redirects modules.
def getApplyRedirect(entity, params):
  """Returns the apply redirect for the specified entity.
  """

  result ='/%s/apply/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result


def getInviteRedirect(entity, params):
  """Returns the invitation redirect for the specified entity.
  """

  result ='/%s/invite/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result


def getCreateRedirect(entity, params):
  """Returns the create redirect for the specified entity.
  """

  result ='/%s/create/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result


def getEditRedirect(entity, params):
  """Returns the edit redirect for the specified entity.
  """

  return '/%s/edit/%s' % (
      params['url_name'], entity.key().id_or_name())


def getPublicRedirect(entity, params):
  """Returns the public redirect for the specified entity.
  """

  return '/%s/show/%s' % (
      params['url_name'], entity.key().id_or_name())


def getAdminRedirect(entity, params):
  """Returns the public redirect for the specified entity.
  """

  return '/%s/admin/%s' % (
      params['url_name'], entity.key().id_or_name())


def getListRedirect(entity, params):
  """Returns the public redirect for the specified entity.
  """

  return '/%s/list/%s' % (
      params['url_name'], entity.key().id_or_name())


def getPublicListRedirect(entity, params):
  """Returns the public redirect for the specified entity.
  """

  return '/%s/list_public/%s' % (
      params['url_name'], entity.key().id_or_name())


def getExportRedirect(entity, params):
  """Returns the export redirect for the specified entity.
  """

  return '/%s/export/%s' % (
      params['url_name'], entity.key().id_or_name())


def getHomeRedirect(entity, params):
  """Returns the home redirect for the specified entity.
  """

  return '/%s/home/%s' % (
      params['url_name'], entity.key().id_or_name())


def getReviewRedirect(entity, params):
  """Returns the redirect to review the specified entity.
  """

  return '/%s/review/%s' % (
      params['url_name'], entity.key().id_or_name())


def getReviewOverviewRedirect(entity, params):
  """Returns the redirect to the Review Overview page for Org Applications.

  Args:
    entity: OrgAppSurvey entity
    params: Org App View params
  """

  return '/%s/review_overview/%s' % (
      params['url_name'], entity.key().id_or_name())


def getCreateRequestRedirect(entity, params):
  """Returns the create request redirect for the specified entity.
  """

  result ='/request/create/%s/%s/%s' % (
      params['group_scope'], params['url_name'], entity.key().id_or_name())

  return result


def getRequestRedirectForRole(entity, role_name):
  """Returns the redirect to create a request for a specific role.
  """

  result ='/%s/request/%s' % (
      role_name, entity.key().id_or_name())

  return result


def getInviteRedirectForRole(entity, role_name):
  """Returns the redirect to create an invite for a specific role.
  """

  result ='/%s/invite/%s' % (
      role_name, entity.key().id_or_name())

  return result


def getListProposalsRedirect(entity, params):
  """Returns the redirect for the List page for the given
  Org entity and Org View params.
  """

  result = '/%s/list_proposals/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result


def getAcceptedOrgsRedirect(entity, params):
  """Returns the redirect for the List of accepted orgs.
  """

  result = '/%s/accepted_orgs/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result


def getListProjectsRedirect(entity, params):
  """Returns the redirect for the List Projects page for the given entity.
  """

  result = '/%s/list_projects/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result


def getListRequestsRedirect(entity, params):
  """Returns the redirect for the List Requests paged for the given
  Group entity and Group View params.
  """

  result = '/%s/list_requests/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result


def getListSelfRedirect(entity, params):
  """Returns the redirect for list_self access type.
  """

  result = '/%s/list_self/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result


def getListRolesRedirect(entity, params):
  """Returns the redirect for the List Roles paged for the given
  Group entity and Group View params.
  """

  result = '/%s/list_roles/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result


def getListParticipantsRedirect(entity, params):
  """Returns the redirect for the List of all participants in a program.
  """

  result = '/%s/list_participants/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result


def getWithdrawRedirect(entity, params):
  """Returns the redirect for withdraw_project access type.
  """

  result = '/%s/withdraw/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result


def getUserRolesRedirect(_, __):
  """Returns the redirect to the users Roles page.
  """

  return '/user/roles'


def getProcessRequestRedirect(entity, _):
  """Returns the redirect for processing the specified request entity.
  """

  from soc.views.models.role import ROLE_VIEWS

  role_view = ROLE_VIEWS[entity.role]

  result = '/%s/process_request/%s' % (
      role_view.getParams()['url_name'], entity.key().id_or_name())

  return result


def getManageRedirect(entity, params):
  """Returns the redirect for managing the given entity.
  """

  result = '/%s/manage/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result


def getManageOverviewRedirect(entity, params):
  """Returns the redirect for the manage overview view of the given entity.
  """

  result = '/%s/manage_overview/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result


def getOverviewRedirect(entity, params):
  """Returns the redirect for the manage overview view of the given entity.
  """

  result = '/%s/overview/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result


def getSelectRedirect(params):
  """Returns the pick redirect for the specified entity.
  """

  if params.get('args'):
    return '/%(url_name)s/pick?%(args)s' % params
  else:
    return '/%(url_name)s/pick' % params


def getInviteAcceptedRedirect(entity, _):
  """Returns the redirect for accepting an invite.
  """

  from soc.views.models.role import ROLE_VIEWS

  role_params = ROLE_VIEWS[entity.role].getParams()

  return '/%s/accept_invite/%s' % (
      role_params['url_name'], entity.key().id_or_name())


def getInviteProcessRedirect(entity, _):
  """Returns the redirect for processing an invite.
  """

  return '/request/process_invite/%s' % (
      entity.key().id_or_name())


def getApplicantRedirect(entity, params):
  """Returns the redirect for processing accepted Applications.
  """

  return '/%s/applicant/%s?id=%s' % (
      params['url_name'], params['program'].key().id_or_name(),
      entity.key().id_or_name())

def getStudentPrivateRedirect(entity, params):
  """Returns private redirect for the specified entity. 
  """

  return '/%s/private/%s' % (
      params['url_name'], entity.key().id_or_name())

def getStudentEditRedirect(entity, params):
  """Returns the redirect for Students to edit their Projects.
  """

  return '/%s/st_edit/%s' % (
      params['url_name'], entity.key().id_or_name())

def getProposalCommentRedirect(entity, params):
  """Returns comment redirect for the specified student proposal.
  """

  return '/%s/comment/%s' % (
      params['url_name'], entity.key().id_or_name()) 

def getStudentProposalRedirect(entity, params):
  """Returns the student proposal redirect for the given org and student.
  """

  result ='/%s/apply/%s?organization=%s' % (
      params['url_name'], params['student_key'], entity.link_id)

  return result


def getShowDuplicatesRedirect(entity, params):
  """Returns the show duplicates redirect for the specified entity.
  """

  return'/%s/show_duplicates/%s' % (
      params['url_name'], entity.key().name())


def getSlotsRedirect(entity, params):
  """Returns the slots redirect for the specified entity.
  """

  return'/%s/slots/%s' % (
      params['url_name'], entity.key().id_or_name())


def getAssignSlotsRedirect(entity, params):
  """Returns the assign slots redirect for the specified entity.
  """

  return'/%s/assign_slots/%s' % (
      params['url_name'], entity.key().id_or_name())


def getCreateDocumentRedirect(entity, prefix):
  """Returns the redirect for new documents.
  """

  return '/document/create/%s/%s' % (prefix, entity.key().id_or_name())


def getListDocumentsRedirect(entity, prefix):
  """Returns the redirect for listing documents.
  """

  return '/document/list/%s/%s' % (prefix, entity.key().id_or_name())


def getCreateSurveyRedirect(entity, prefix, url_name):
  """Returns the redirect for new surveys.
  """

  return '/%s/create/%s/%s' % (url_name, prefix, entity.key().id_or_name())


def getListSurveysRedirect(entity, prefix, url_name):
  """Returns the redirect for listing surveys.
  """

  return '/%s/list/%s/%s' % (url_name, prefix, entity.key().id_or_name())


def getTakeSurveyRedirect(entity, info):
  """Returns the redirect for taking a Survey.

  Args:
      entity: a Survey entity
      info: a dictionary contain a survey and params entry
  """

  survey_entity = entity
  params = info

  return '/%s/take/%s' % (params['url_name'],
                          survey_entity.key().id_or_name())


def getReviewOrgAppSurvey(survey_record, info):
  """Returns redirect to retake a OrgAppSurvey.

  Args:
    survey_record: OrgAppRecord entity
    info: a dictionary with survey and url_name entry
  """

  return '/%s/review/%s?id=%s' % (
      info['url_name'], info['survey'].key().id_or_name(),
      survey_record.key().id_or_name())


def getRetakeOrgAppSurveyRedirect(survey_record, info):
  """Returns redirect to retake a OrgAppSurvey.

  Args:
    survey_record: OrgAppRecord entity
    info: a dictionary with survey and url_name entry
  """

  return '/%s/take/%s?id=%s' % (
      info['url_name'], info['survey'].key().id_or_name(),
      survey_record.key().id_or_name())


def getTakeProjectSurveyRedirect(entity, info):
  """Returns the redirect for taking a Survey for the given Student Project.

  Args:
      entity: a StudentProject entity
      info: a dictionary contain a survey and params entry
  """

  survey_entity = info['survey']
  params = info['params']

  return '/%s/take/%s?project=%s' % (params['url_name'],
                                     survey_entity.key().id_or_name(),
                                     entity.key().id_or_name())


def getViewSurveyRecordRedirect(entity, params):
  """Returns the redirect for view a Survey Record
  for the given Survey Record.

  Args:
      entity: a Survey Record entity
      params: params for a Survey view
  """

  return '/%s/record/%s?id=%s' % (
      params['url_name'],
      entity.survey.key().id_or_name(),
      entity.key().id_or_name())


def getEditGradingRecordRedirect(entity, params):
  """Returns the redirect for editing a given GradingRecord.
  """

  return '/%s/edit_record/%s?id=%s' % (
      params['url_name'],
      entity.grading_survey_group.key().id_or_name(),
      entity.key().id_or_name())


def getViewRecordsRedirect(entity, params):
  """Returns the redirect to view all GradingRecords for one
  GradingSurveyGroup.
  """
  return '/%s/records/%s?' % (
      params['url_name'],
      entity.key().id_or_name())


def getToSRedirect(presence):
  """Returns link to 'show' the ToS Document if it exists, None otherwise.

  Args:
    presence: Presence entity that may or may not have a tos property
  """
  if not presence:
    return None

  try:
    tos_doc = presence.tos
  except db.Error:
    return None

  if not tos_doc:
    return None

  return getPublicRedirect(tos_doc, {'url_name': 'document'})


def getSubscribeRedirect(entity, params):
  """Redirects to subscription XML doc for an entity.
  """
  return'/%s/subscribe/%s' % (
      params['url_name'], entity.key().name())


def getManageStatisticsRedirect(entity, params):
  """Returns redirect for managing statistic view.
  """

  result = '/%s/manage_stats/%s' % (
      params['url_name'], entity.key().id_or_name())

  return result

def getCreateProfileRedirect(params):
  """Returns the create profile redirect for creating link id for the user.
  """

  result ='/%s/create_profile' % (
      params['url_name'])

  return result

def getEditProfileRedirect(params):
  """Returns the edit profile redirect for editing the profile details.
  """

  result ='/%s/edit_profile' % (
      params['url_name'])

  return result

def getRolesRedirect(params):
  """Returns the edit profile redirect for editing the profile details.
  """

  result ='/%s/roles' % (
      params['url_name'])

  return result

def getRequestsRedirect(params):
  """Returns the edit profile redirect for editing the profile details.
  """

  result ='/%s/requests' % (
      params['url_name'])

  return result

def getStudentApplyRedirect(entity, params):
  """Returns the student application for redirect for students to create
  their new profiles.
  """

  return '/%s/apply/%s' % (params['url_name'], entity.key().id_or_name())

def getDownloadBlobRedirectWithGet(entity, params, **kwargs):
  """Returns download blob redirect for the given blob entity.

  This redirect is slightly different than other redirects because we
  construct the URL with the GET arguments here. This is done instead
  of the standard URL scheme because the Blob keys generated by Appengine
  can have any characters which may not be able to be defined by a
  standard Django regex.

  Args:
    entity: the BlobInfo entity which contains the blob key
    params: dictionary containing url_name prefix
    kwargs: a list of key-word arguments all of which are converted to
        get query parameters
  """

  base_redirect = '/%s/download_blob' % (params['url_name'])

  scope_path = kwargs.pop('scope_path', None)

  if scope_path:
    base_redirect = '%s/%s' % (base_redirect, scope_path)

  redirect_to = '%s?key=%s' % (base_redirect, entity.key())
  redirect_to = '&'.join([redirect_to] + [
      '='.join([k, kwargs[k]]) for k in kwargs])

  return redirect_to
