source: main/waeup.kofa/trunk/src/waeup/kofa/hostels/container.py @ 14052

## $Id: container.py 13483 2015-11-19 10:24:46Z henrik $
##
## Copyright (C) 2011 Uli Fouquet & Henrik Bettermann
## 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##
"""
Containers which contain hostels.
"""
import grok
import pytz
from datetime import datetime
from zope.catalog.interfaces import ICatalog
from zope.component import queryUtility, getUtility, ComponentLookupError
from waeup.kofa.hostels.interfaces import (
    IHostelsContainer, IHostel, IHostelsUtils)
from waeup.kofa.utils.logger import Logger
from waeup.kofa.utils.helpers import attrs_to_fields

class HostelsContainer(grok.Container, Logger):
    """This is a container for all kind of hostels.
    """
    grok.implements(IHostelsContainer)
    grok.provides(IHostelsContainer)

    def __init__(self):
        super(HostelsContainer, self).__init__()
        return

    def addHostel(self, hostel):
        """Add a hostel.
        """
        if not IHostel.providedBy(hostel):
            raise TypeError(
                'HostelsContainers contain only IHostel instances')
        self[hostel.hostel_id] = hostel
        return

    def clearAllHostels(self):
        """Clear all hostels.
        """
        for hostel in self.values():
            hostel.clearHostel()
        return

    def releaseExpiredAllocations(self, n=7):
        """Release bed if bed allocation has expired. Allocation expires
        after `n` days if maintenance fee has not been paid.
        """
        cat = queryUtility(ICatalog, name='beds_catalog')
        results = cat.searchResults(owner=(None, None))
        released = []
        for bed in results:
            student_id = bed.releaseBedIfMaintenanceNotPaid(n=n)
            if student_id:
                released.append('%s (%s)' % (bed.bed_id,student_id))
        return released

    @property
    def expired(self):
        # Check if application has started ...
        if not self.startdate or (
            self.startdate > datetime.now(pytz.utc)):
            return True
        # ... or ended
        if not self.enddate or (
            self.enddate < datetime.now(pytz.utc)):
            return True
        return False

    @property
    def statistics(self):
        try:
          statistics = getUtility(
              IHostelsUtils).getBedStatistics()
        except ComponentLookupError:  # happens in unit tests
            return
        return statistics

    logger_name = 'waeup.kofa.${sitename}.hostels'
    logger_filename = 'hostels.log'

    def writeLogMessage(self, view, message):
        ob_class = view.__implemented__.__name__.replace('waeup.kofa.','')
        self.logger.info(
            '%s - %s - %s' % (ob_class, self.__name__, message))
        return

HostelsContainer = attrs_to_fields(HostelsContainer)