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

"""Functions for composing Model entity key names.

"""

__authors__ = [

  '"Todd Larsen" <tlarsen@google.com>',

  '"Pawel Solyga" <pawel.solyga@gmail.com>',

  ]

from soc.logic import path_link_name

class Error(Exception):

  """Base class for all exceptions raised by this module."""

  pass

  Args:

    partial_path: the first portion of the path to the Document that uniquely

      identifies it

      appended)

  Raises:

    empty string, etc.)

  """

  path = [partial_path]

  path = path_link_name.combinePath(path)

  if not path:

    raise Error('"path" must be non-False: "%s"' % path)

  return 'Document:%s' % path

  """Returns a SiteSettings key name constructed from a supplied path.

  Raises:

    Error if path is "False" (None, empty string, etc.)

  """

  if not partial_path:

    raise Error('"partial_path" must be non-False: "%s"' % partial_path)

  """Returns a HomeSettings key name constructed from a supplied path.

  Raises:

    Error if path is "False" (None, empty string, etc.)

  """

  if not partial_path:

    raise Error('"partial_path" must be non-False: "%s"' % partial_path)

def nameUser(email):

  """Returns a User key name constructed from a supplied email address.

  Raises:

    Error if email is "False" (None, empty string, etc.)

  """

  if not email:

    raise Error('"email" must be non-False: "%s"' % email)

  return 'User:%s' % email

  Raises:

  """

  Args:

  Raises:

    a "False" path (None, empty string, etc.)

  """

  if not path:

    raise Error('"path" must be non-False: "%s"' % path)

  return 'Group/School:%s' % path

  Args:

  Raises:

    a "False" path (None, empty string, etc.)

  """

  if not path:

    raise Error('"path" must be non-False: "%s"' % path)

  return 'Group/Organization:%s' % path 

  Raises:

  """

  """Placeholder for work namer.

  """

def nameHost(sponsor_ln, user_ln):

  """Placeholder for host namer.

  """

  if not sponsor_ln:

    raise Error('"sponsor_ln" must be non-False: "%s"' % sponsor_ln)

  if not user_ln:

    raise Error('"user_ln" must be non-False: "%s"' % user_ln)

  return 'Host:%s:%s' % (sponsor_ln, user_ln)