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

"""Helpers functions for updating different kinds of models in datastore.

"""

__authors__ = [

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

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

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

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

  ]

from google.appengine.ext import db

from django.utils.translation import ugettext_lazy

from soc.logic import dicts

from soc.logic import out_of_band

class Error(Exception):

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

  """

  pass

class Logic:

  """Base logic for entity classes.

  The BaseLogic class functions specific to Entity classes by relying

  on the the child-classes to implement _model, _name and _key_name

  """

  def __init__(self, model, base_model=None,

               name=None, skip_properties=None):

    """Defines the name, key_name and model for this entity.

    """

    self._model = model

    self._base_model = base_model

    if name:

      self._name = name

    else:

      self._name =  self._model.__name__

    if skip_properties:

      self._skip_properties = skip_properties

    else:

      self._skip_properties = []

  def _updateField(self, model, name, value):

    """Hook called when a field is updated.

    Base classes should override if any special actions need to be

    taken when a field is updated. The field is not updated if the

    method does not return a True value.

    """

    return True

  def _keyName(self, **kwargs):

    """Returns the KeyName constructed from kwargs for this type of entity.

    The KeyName is in the following format:

    entity.name:<key_value1>:<key_value2>:...:<key_valueN>

    """

    # get the KeyFieldNames for this entity

    key_field_names = self.getKeyFieldNames()

    # check if all given KeyFieldNames are valid for this entity

    if not all(key in key_field_names for key in kwargs.keys()):

      raise Error("Some of the provided arguments are not key fields")

    # check if all key_field_names for this entity are present in kwargs

    if not all(field in kwargs.keys() for field in key_field_names):

      raise Error("Not all the required key fields are present")

    # check if all kwargs.values() are non-false

    if not all(kwargs.values()):

      raise Error("Not all KeyValues are non-false")

    # construct the KeyValues in the order given by getKeyFieldNames()

    keyvalues = []

    for key_field_name in key_field_names:

      keyvalues.append(kwargs[key_field_name])

    # construct the KeyName in the appropriate format

    return "%s:%s" % (self._name, '/'.join(keyvalues))

  def getFullModelClassName(self):

    """Returns fully-qualified model module.class name string.

    """ 

    return '%s.%s' % (self._model.__module__, self._model.__name__)

  def getKeyValues(self, entity):

    """Exctracts the key values from entity and returns them.

    Args:

      entity: the entity from which to extract the key values

    """

    raise NotImplementedError

  def getSuffixValues(self, entity):

    """Returns an array with the public values of the Key Fields.

    Defaults to getKeyValues

    If any of the Key Fields should not be made public, this method

    should return their public counterparts instead.

    Args:

      entity: the entity for which to construct the suffix 

    """

    return self.getKeyValues(entity)

  def getKeyValuesFromFields(self, fields):

    """Exctracts the key values from a dict and returns them.

    Args:

      fields: the dict from which to extract the key values

    """

    raise NotImplementedError

  def getKeyFieldNames(self):

    """Returns an array with the names of the Key Fields.

    """

    raise NotImplementedError

  def getKeySuffix(self, entity):

    """Returns a suffix for the specified entity or None if no entity specified.

    Args:

      entity: the entity for which to get the suffix

    """

    if not entity:

      return None

    key_values = self.getSuffixValues(entity)

    suffix = '/'.join(key_values)

    return suffix

  def getKeyFieldsFromDict(self, dictionary):

    """Does any required massaging and filtering of dictionary.

    The resulting dictionary contains just the key names, and has any

    required translations/modifications performed.

    Args:

      dictionary: The arguments to massage

    """

    keys = self.getKeyFieldNames()

    values = self.getKeyValuesFromFields(dictionary)

    key_fields = dicts.zip(keys, values)

    return key_fields

  def getFromKeyName(self, key_name):

    """"Returns entity for key_name or None if not found.

-

-    Args:

-      key_name: key name of entity

    """

    return self._model.get_by_key_name(key_name)

  def getFromFields(self, **kwargs):

    """Returns the entity for the specified key names, or None if not found.

    Args:

      **kwargs: the fields of the entity that uniquely identifies it

    """

    key_name = self.getKeyNameForFields(kwargs)

    if key_name:

      entity = self._model.get_by_key_name(key_name)

    else:

      entity = None

    return entity

  def getIfFields(self, fields):

    """Returns entity for supplied link ID if one exists.

    Args:

      fields: the fields of the entity that uniquely identifies it

    Returns:

      * None if a field is false.

      * Entity for supplied fields

    Raises:

      out_of_band.ErrorResponse if link ID is not false, but no entity

      with the supplied link ID exists in the Datastore.

    """

    if not all(fields.values()):

      # exit without error, to let view know that link_id was not supplied

      return None

    entity = self.getFromFields(**fields)

    if entity:

      # an entity exist for this link_id, so return that entity

      return entity

    format_text = ugettext_lazy('"%(key)s" is "%(value)s"')

    msg_pairs = [format_text % {'key': key, 'value': value}

      for key, value in fields.iteritems()]

    joined_pairs = ' and '.join(msg_pairs)

    msg = ugettext_lazy(

      'There is no "%(name)s" where %(pairs)s.') % {

        'name': self._name, 'pairs': joined_pairs}

    # else: fields were supplied, but there is no Entity that has it

    raise out_of_band.ErrorResponse(msg, status=404)

  def getKeyNameForFields(self, fields):

    """Return a Datastore key_name for a Entity from the specified fields.

    Args:

      fields: the fields of the entity that uniquely identifies it

    """

    if not all(fields.values()):

      return None

    return self._keyName(**fields)

  def getForLimitAndOffset(self, limit, offset=0):

    """Returns entities for given offset and limit or None if not found.

    Args:

      limit: max amount of entities to return

      offset: optional number of results to skip first; default zero.

    """

    query = self._model.all()

    return query.fetch(limit, offset)

  def getForFields(self, properties, unique=False, limit=1000, offset=0):

    """Returns all entities that have the specified properties.

    Args:

      properties: the properties that the entity should have

      unique: if set, only the first item from the resultset will be returned

      limit: max amount of entities to return

      offset: optional number of results to skip first; default zero.

    """

    if not properties:

      raise Error("Properties did not contain any values")

    format_text = '%(key)s = :%(key)s'

    msg_pairs = [format_text % {'key': key} for key in properties.iterkeys()]

    joined_pairs = ' AND '.join(msg_pairs)

    condition = 'WHERE %s' % joined_pairs

    query = self._model.gql(condition, **properties)

    if unique:

      return query.get()

    return query.fetch(limit, offset)

  def buildTypedQueryString(self):

    """Returns a GQL query string compatible with PolyModel.

    """

    return ''.join(self._buildTypedQueryParts())

  def _buildTypedQueryParts(self):

    if self._base_model:

      return [

          'SELECT * FROM ', self._base_model.__name__,

          " WHERE inheritance_line = '", self.getFullModelClassName(), "'"]

    return ['SELECT * FROM ', self._model.__name__]

  def buildOrderedQueryString(self, order_by=None):

    """Returns a an ordered GQL query string compatible with PolyModel.

    Args:

      order_by: optional field name by which to order the query results;

        default is None, in which case no ORDER BY clause is placed in

        the query string

    """

    return ''.join(self._buildOrderedQueryParts(order_by=order_by))

  def _buildOrderedQueryParts(self, order_by=None):

    query_str_parts = self._buildTypedQueryParts()

    if order_by:

      query_str_parts.extend([' ORDER BY ', order_by])

    return query_str_parts

  def getEntitiesForLimitAndOffset(self, limit, offset=0, order_by=None):

    """Returns entities for given offset and limit or None if not found.

    Args:

      limit: max amount of entities to return

      offset: optional offset in entities list which defines first entity to

        return; default is zero (first entity)

    """

    query_string = self.buildOrderedQueryString(order_by=order_by)

    query = db.GqlQuery(query_string)

    return query.fetch(limit, offset)

  def getNearestEntities(self, fields_to_try):

    """Get entities just before and just after the described entity.

    Args:

      fields_to_try: ordered list of key/value pairs that "describe"

        the desired entity (which may not necessarily exist), where key is

        the name of the field, and value is an instance of that field

        used in the comparison; if value is None, that field is skipped

    Returns:

      a two-tuple: ([nearest_entities], 'field_name')

      nearest_entities: list of entities being those just before and just

        after the (possibly non-existent) entity identified by the first

        of the supplied (non-None) fields

          OR

        possibly None if query had no results for the supplied field

        that was used.

    """

    # SELECT * FROM base_class WHERE inheritance_line = 'derived_class'

    typed_query_parts = self._buildTypedQueryParts()

    if self._base_model:

      typed_query_parts.append(' AND %s > :1')

    else:

      typed_query_parts.append(' WHERE %s > :1')

    typed_query_fmt = ''.join(typed_query_parts)

    for field, value in fields_to_try:

      if value is None:

        # skip this not-supplied field

        continue

      query = db.GqlQuery(typed_query_fmt % field, value)

      return query.fetch(1), field

    # all fields exhausted, and all had None values

    return (None, None)

  def findNearestEntitiesOffset(width, fields_to_try):

    """Finds offset of beginning of a range of entities around the nearest.

    Args:

      width: the width of the "found" window around the nearest User found

      fields_to_try:  see getNearestEntities()

    Returns:

      an offset into the list of entities that is width/2 less than the

      offset of the first entity returned by getNearestEntities(), or zero

      if that offset would be less than zero

        OR

      None if there are no nearest entities or the offset of the beginning of

      the range cannot be found for some reason 

    """

    # find entity "nearest" to supplied fields

    nearest_entities, field = self.getNearestEntities(fields_to_try)

    if not nearest_entities:

      # no "nearest" entity, so indicate that with None

      return None

    nearest_entity = nearest_entities[0]

    # start search for beginning of nearest Users range at offset zero

    offset = 0

    entities = self.getEntitiesForLimitAndOffset(width, offset=offset)

    while True:

      for entity in entities:

        if getattr(nearest_entity, field) == getattr(entity, field):

          # nearest User found in current search range, so return a range start

          return max(0, (offset - (width/2)))

        offset = offset + 1

      # nearest User was not in the current search range, so fetch the next set

      entities = self.getEntitiesForLimitAndOffset(width, offset=offset)

      if not entities:

        # nearest User never found, so indicate that with None

        break

    return None

  def updateModelProperties(self, model, model_properties):

    """Update existing model entity using supplied model properties.

    Args:

      model: a model entity

      model_properties: keyword arguments that correspond to model entity

        properties and their values

    Returns:

      The original model entity with any supplied properties changed.

    """

    def update():

      return self._unsafeUpdateModelProperties(model, model_properties)

    return db.run_in_transaction(update)

  def _unsafeUpdateModelProperties(self, model, model_properties):

    """See updateModelProperties.

    Like updateModelProperties(), but not run within a transaction.

    """

    properties = model.properties()

    for prop in properties.values():

      name = prop.name

      if not name in self._skip_properties and name in model_properties:

        value = model_properties[prop.name]

        if self._updateField(model, name, value):

          prop.__set__(model, value)

    model.put()

    return model

  def updateOrCreateFromKeyName(self, properties, key_name):

    """Update existing entity, or create new one with supplied properties.

    Args:

      properties: dict with entity properties and their values

      key_name: the key_name of the entity that uniquely identifies it

    Returns:

      the entity corresponding to the key_name, with any supplied

      properties changed, or a new entity now associated with the

      supplied key_name and properties.

    """

    entity = self.getFromKeyName(key_name)

    if not entity:

      # entity did not exist, so create one in a transaction

      entity = self._model.get_or_insert(key_name, **properties)

    # there is no way to be sure if get_or_insert() returned a new entity or

    # got an existing one due to a race, so update with properties anyway,

    # in a transaction

    return self.updateModelProperties(entity, properties)

  def updateOrCreateFromFields(self, properties, fields):

    """Like updateOrCreateFromKeyName, but resolves fields to a key_name first.

    """

    # attempt to retrieve the existing entity

    key_name  = self.getKeyNameForFields(fields)

    return self.updateOrCreateFromKeyName(properties, key_name)

  def isDeletable(self, entity):

    """Returns whether the specified entity can be deleted.

    Args:

      entity: an existing entity in datastore

    """