##############################################################################
#
# Copyright (c) 2002-2013 Nexedi SA and Contributors. All Rights Reserved.
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsibility of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# guarantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
##############################################################################

from AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions
from Products.ERP5Type.Accessor.Constant import PropertyGetter as ConstantGetter
from Products.ERP5.Document.PresencePeriod import PresencePeriod

class GroupCalendarAssignment(PresencePeriod):
  # CMF Type Definition
  meta_type = 'ERP5 Group Calendar Assignment'
  portal_type = 'Group Calendar Assignment'

  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  # XXX GroupCalendarAssignment are not a delivery, but we enable this to be able
  # to search them by date in the module.
  isDelivery = ConstantGetter('isDelivery', value=True)

  security.declareProtected(Permissions.AccessContentsInformation,
                           'getPeriodList')
  def getPeriodList(self):
    """Returns the list of periods covered by this group calendar assignment.

    The periods returned by this method are defined by:
     - quantity
     - resource
     - start and stop dates
    and optionally a periodicity definition, as defined by product/ERP5/mixin/periodicity_mixin.py

    This can be scriptable using a type based method, for example to disable some non applicable periods.

    The default implementation will consider all the periods from the associated group calendar,
    only for the time frame of this calendar assignment.
    """
    period_list = []

    method = self._getTypeBasedMethod("getPeriodList")
    if method is None:
      group_calendar = self.getSpecialiseValue()
      if group_calendar is not None:
        start_date = self.getStartDate()
        stop_date = self.getStopDate()
        period_list = []
        for period in group_calendar.objectValues(
            portal_type=self.getPortalCalendarPeriodTypeList()):
          period_list.append(
            period.asContext(
              start_date=max(period.getStartDate(start_date), start_date),
              periodicity_stop_date=min(
                period.getPeriodicityStopDate(stop_date), stop_date))
          )
    else:
      period_list = method()
    return period_list

  def _getDatePeriodDataList(self):
    result = []
    start_date = self.getStartDate()
    stop_date = self.getStopDate()
    if not(None in (self.getDestinationUid(), start_date, stop_date)):
      period_list = self.getPeriodList()
      for period in period_list:
        for date_period_data in period._getDatePeriodDataList():
          if date_period_data['start_date'].greaterThanEqualTo(start_date):
            if stop_date is None or date_period_data['stop_date'].lessThanEqualTo(
                stop_date):
              result.append(date_period_data)
    return result