cybertools/organize/service.py
helmutm 89510875c9 state handling for service registrations
git-svn-id: svn://svn.cy55.de/Zope3/src/cybertools/trunk@2123 fd906abe-77d9-0310-91a1-e0d9ade77398
2007-10-20 16:01:20 +00:00

327 lines
9.7 KiB
Python

#
# Copyright (c) 2007 Helmut Merz helmutm@cy55.de
#
# 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
#
"""
Service management classes.
$Id$
"""
from time import time
from persistent import Persistent
from BTrees.OOBTree import OOBTree
from zope.cachedescriptors.property import Lazy
from zope.component import adapts
from zope import component
from zope.interface import implements, Interface
from cybertools.composer.interfaces import IInstance
from cybertools.composer.rule.base import RuleManager, EventType
from cybertools.composer.schema.interfaces import IClientManager, IClient
from cybertools.stateful.base import StatefulAdapter
from cybertools.stateful.definition import registerStatesDefinition
from cybertools.stateful.definition import StatesDefinition
from cybertools.stateful.definition import State, Transition
from cybertools.util.jeep import Jeep
from cybertools.util.randomname import generateName
from cybertools.organize.interfaces import IServiceManager
from cybertools.organize.interfaces import IService, IScheduledService
from cybertools.organize.interfaces import IRegistration, IRegistrationTemplate
from cybertools.organize.interfaces import IClientRegistrations
class ServiceManager(RuleManager):
implements(IServiceManager, IClientManager)
servicesFactory = Jeep
clientSchemasFactory = Jeep
clientsFactory = OOBTree
rulesFactory = Jeep
services = None
clients = None
rules = None
allowRegWithNumber = False
allowDirectRegistration = True
def __init__(self):
if self.servicesFactory is not None:
self.services = self.servicesFactory()
if self.clientSchemasFactory is not None:
self.clientSchemas = self.clientSchemasFactory()
if self.rulesFactory is not None:
self.rules = self.rulesFactory()
def getServices(self, categories=[]):
return self.services
def getClientSchemas(self):
return self.clientSchemas
@Lazy
def clients(self):
return self.clientsFactory()
def getClients(self):
return self.clients
def addClient(self, client):
name = self.generateClientName(client)
self.clients[name] = client
client.__name__ = name
return name
def generateClientName(self, client):
return generateName(self.checkClientName)
def checkClientName(self, name):
return name not in self.getClients()
def getRules(self):
return self.rules
class Registration(object):
implements(IRegistration)
number = 1
def __init__(self, client, service, number=1):
self.client = client
self.service = service
self.timeStamp = int(time())
self.number = number
class PersistentRegistration(Registration, Persistent):
pass
class Service(object):
implements(IService)
registrationsFactory = OOBTree
registrationFactory = PersistentRegistration
manager = None
category = None
location = ''
allowRegWithNumber = False
allowDirectRegistration = True
def __init__(self, name=None, title=u'', capacity=-1, **kw):
self.name = self.__name__ = name
self.title = title
self.capacity = capacity
if self.registrationsFactory is not None:
self.registrations = self.registrationsFactory()
self.classification = []
for k, v in kw.items():
setattr(self, k, v)
def getName(self):
return self.name
def getManager(self):
return self.manager
def getClassification(self):
return self.classification
def getCategory(self):
return self.category
@property
def token(self):
return self.getToken()
def getToken(self):
return self.name
@property
def availableCapacity(self):
if self.capacity >= 0 and len(self.registrations) >= self.capacity:
return 0
return self.capacity - len(self.registrations)
def register(self, client, number=1):
clientName = client.__name__
if clientName in self.registrations:
reg = self.registrations[clientName]
if number != reg.number:
reg.number = number
#self.registrations[clientName] = reg # persistence hack
return reg
reg = self.registrationFactory(client, self, number)
self.registrations[clientName] = reg
return reg
#if self.availableCapacity:
# TODO: handle case when no capacity available -
# probably on 'submit' transition; UI feedback?
def unregister(self, client):
clientName = client.__name__
if clientName in self.registrations:
del self.registrations[clientName]
# default methods
def getAllowRegWithNumberFromManager(self):
return getattr(self.getManager(), 'allowRegWithNumber', None)
def getAllowDirectRegistrationFromManager(self):
return getattr(self.getManager(), 'allowDirectRegistration', None)
class ScheduledService(Service):
implements(IScheduledService)
start = end = None
# default methods
def getStartFromManager(self):
return getattr(self.getManager(), 'start', None)
def getEndFromManager(self):
return getattr(self.getManager(), 'end', None)
# registration stuff
class RegistrationTemplate(object):
implements(IRegistrationTemplate)
def __init__(self, name=None, manager=None):
self.name = self.__name__ = name
self.manager = self.__parent__ = manager
self.categories = []
@property
def services(self):
return self.getServices()
def getServices(self):
svcs = self.getManager().getServices()
categories = [c.strip() for c in self.categories if c.strip()]
if categories:
svcs = Jeep((key, s) for key, s in svcs.items()
if s.category in categories)
return svcs
def getManager(self):
return self.manager
class ClientRegistrations(object):
implements(IClientRegistrations)
adapts(IClient)
template = None
registrationsAttributeName = '__service_registrations__'
def __init__(self, context):
self.context = context
def register(self, services, numbers=None):
if numbers is None:
numbers = len(services) * [1]
regs = [service.register(self.context, numbers[idx])
for idx, service in enumerate(services)]
old = getattr(self.context, self.registrationsAttributeName, [])
regs.extend(r for r in old if r.service not in services)
setattr(self.context, self.registrationsAttributeName, regs)
def unregister(self, services):
old = getattr(self.context, self.registrationsAttributeName, [])
regs = [r for r in old if r.service not in services]
setattr(self.context, self.registrationsAttributeName, regs)
for service in services:
service.unregister(self.context)
def getRegistrations(self):
regs = getattr(self.context, self.registrationsAttributeName, [])
if self.template is not None:
svcs = self.template.getServices().values()
regs = (r for r in regs if r.service in svcs)
return regs
# registration states
registrationStates = 'organize.service.registration'
registerStatesDefinition(
StatesDefinition(registrationStates,
State('temporary', 'temporary', ('submit', 'cancel',)),
State('submitted', 'submitted',
('change', 'retract', 'setwaiting', 'confirm', 'reject',)),
State('cancelled', 'cancelled', ('submit',)),
State('retracted', 'retracted', ('submit',)),
State('waiting', 'waiting',
('change', 'retract', 'confirm', 'reject',)),
State('confirmed', 'confirmed',
('change', 'retract', 'reject',)),
State('rejected', 'rejected',
('change', 'retract', 'setwaiting', 'confirm',)),
Transition('cancel', 'Cancel registration', 'cancelled'),
Transition('submit', 'Submit registration', 'submitted'),
Transition('change', 'Change registration', 'submitted'),
Transition('retract', 'Retract registration', 'retracted'),
Transition('setwaiting', 'Set on waiting list', 'waiting'),
Transition('confirm', 'Confirm registration', 'confirmed'),
Transition('reject', 'Reject registration', 'rejected'),
initialState='temporary',
))
class StatefulRegistration(StatefulAdapter):
component.adapts(IRegistration)
statesDefinition = registrationStates
# event types for rule-based processing
eventTypes = Jeep((
EventType('service.checkout'),
))
# Zope event handlers
def clientRemoved(obj, event):
""" Handle removal of a client object.
"""
regs = IClientRegistrations(obj)
for r in regs.getRegistrations():
r.service.unregister(obj)
def serviceRemoved(obj, event):
""" Handle removal of a service.
"""
for r in obj.registrations.values():
regs = IClientRegistrations(r.client)
regs.unregister([obj])