603 lines
22 KiB
Python
603 lines
22 KiB
Python
#
|
|
# Copyright (c) 2013 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
|
|
#
|
|
|
|
"""
|
|
Interfaces for organizational stuff like persons, addresses, tasks, services...
|
|
"""
|
|
|
|
from zope import schema
|
|
from zope.schema.vocabulary import SimpleVocabulary, SimpleTerm
|
|
from zope.interface import Interface, Attribute
|
|
from zope.i18nmessageid import MessageFactory
|
|
|
|
from cybertools.composer.schema.factory import Email
|
|
from cybertools.tracking.interfaces import ITrack
|
|
from cybertools.util.jeep import Jeep, Term
|
|
from cybertools.util.util import KeywordVocabulary
|
|
|
|
_ = MessageFactory('cybertools.organize')
|
|
|
|
|
|
# schema fields
|
|
|
|
class SimpleList(schema.List): pass
|
|
|
|
class LinesList(schema.List): pass
|
|
|
|
|
|
# persons, addresses, ...
|
|
|
|
salutations = ((None, u''),
|
|
('m', _(u'Mr')),
|
|
('f', _(u'Mrs')))
|
|
|
|
|
|
class IPerson(Interface):
|
|
""" Resembles a human being with a name (first and last name),
|
|
a birth date, and a set of addresses.
|
|
"""
|
|
|
|
salutation = schema.Choice(
|
|
title=_(u'Salutation'),
|
|
description=_(u'Salutation in letter.'),
|
|
vocabulary=KeywordVocabulary(salutations),
|
|
default=None,
|
|
required=False)
|
|
|
|
academicTitle = schema.TextLine(
|
|
title=_(u'Academic Title'),
|
|
description=_(u'Academic title or name affix.'),
|
|
required=False)
|
|
|
|
firstName = schema.TextLine(
|
|
title=_(u'First Name'),
|
|
description=_(u'The first name.'),
|
|
required=False,)
|
|
lastName = schema.TextLine(
|
|
title=_(u'Last Name'),
|
|
description=_(u'The last name or surname.'),)
|
|
email = Email(title=_(u'E-Mail Address'),
|
|
description=_(u'The standard email address of the person.'),)
|
|
#phoneNumbers = SimpleList(
|
|
phoneNumbers = schema.List(
|
|
value_type=schema.TextLine(),
|
|
default=[],
|
|
title=_(u'Phone Numbers'),
|
|
description=_(u'Note one or more phone numbers here.'),
|
|
required=False,)
|
|
birthDate = schema.Date(
|
|
title=_(u'Date of Birth'),
|
|
description=_(u'The date of birth - should be a '
|
|
'datetime.date object.'),
|
|
required=False,)
|
|
birthDate.hideTime = True
|
|
|
|
age = schema.Int(
|
|
title=_(u'Age'),
|
|
description=_(u'The current age in full years'),
|
|
readonly=True)
|
|
|
|
addresses = Attribute('A mapping whose values provide the IAddress '
|
|
'interface')
|
|
|
|
|
|
class IAddress(Interface):
|
|
""" A postal address of a person or institution.
|
|
"""
|
|
|
|
street = schema.TextLine(
|
|
title=_(u'Street, number'),
|
|
description=_(u'Street and number'),
|
|
required=False,)
|
|
zipcode = schema.TextLine(
|
|
title=_(u'ZIP code'),
|
|
description=_(u'ZIP code, postal code'),
|
|
required=False,)
|
|
city = schema.TextLine(
|
|
title=_(u'City'),
|
|
description=_(u'Name of the city'),
|
|
required=True,)
|
|
country = schema.TextLine(
|
|
title=_(u'Country code'),
|
|
description=_(u'International two-letter country code'),
|
|
required=False,)
|
|
lines = schema.List(
|
|
value_type=schema.TextLine(),
|
|
default=[],
|
|
title=_(u'Additional lines'),
|
|
description=_(u'Additional address lines'),
|
|
required=False,)
|
|
|
|
|
|
# tasks
|
|
|
|
class ITask(Interface):
|
|
""" A task has a start date, an optional end date, and is usually
|
|
assigned to one or more persons.
|
|
"""
|
|
|
|
start = schema.Date(
|
|
title=_(u'Start date'),
|
|
description=_(u'The date when the task should start'),
|
|
required=False,)
|
|
end = schema.Date(
|
|
title=_(u'End date'),
|
|
description=_(u'The date until that the task should be '
|
|
'finished'),
|
|
required=False,)
|
|
|
|
|
|
# services
|
|
|
|
serviceManagerViews = SimpleVocabulary((
|
|
SimpleTerm('', '', u'Default view'),
|
|
SimpleTerm('events_overview.html', 'events_overview.html', u'Events overview'),
|
|
SimpleTerm('redirect_registration.html', 'redirect_registration.html',
|
|
u'Redirect to registration')
|
|
))
|
|
|
|
class IServiceManager(Interface):
|
|
""" A manager or container for a set of services.
|
|
"""
|
|
|
|
start = schema.Date(
|
|
title=_(u'Start date/time'),
|
|
description=_(u'The start date/time for providing services.'),
|
|
required=False,)
|
|
end = schema.Date(
|
|
title=_(u'End date/time'),
|
|
description=_(u'The end date/time for providing services.'),
|
|
required=False,)
|
|
viewName = schema.Choice(
|
|
title=_(u'View name'),
|
|
description=_(u'Select the name of a specialized view to be used '
|
|
'for presenting this object for visitors.'),
|
|
vocabulary=serviceManagerViews,
|
|
default='',
|
|
required=False,)
|
|
allowRegWithNumber = schema.Bool(
|
|
title=_(u'Allow registration with number'),
|
|
description=_(u'When this field is checked more than one '
|
|
'object (participant) may be assigned with one '
|
|
'registration by entering a corresponding number.'),
|
|
required=False,)
|
|
allowDirectRegistration = schema.Bool(
|
|
title=_(u'Allow direct registration'),
|
|
description=_(u'When this field is checked participants '
|
|
'may register themselves directly on the page '
|
|
'with the service description; otherwise registration '
|
|
'is only possible on a registration template.'),
|
|
required=False,)
|
|
senderEmail = schema.TextLine(
|
|
title=_(u'Sender email'),
|
|
description=_(u'Email address that will be used as sender '
|
|
'address of confirmation and feedback messages.'),
|
|
required=False,)
|
|
|
|
services = Attribute('A collection of services managed by this object.')
|
|
|
|
def getServices():
|
|
""" Return a collection of all services directly assigned
|
|
to this service manager.
|
|
"""
|
|
|
|
def getAllServices():
|
|
""" Return a collection of all services belonging
|
|
to this service manager.
|
|
"""
|
|
|
|
def isActive():
|
|
""" Return True if object is active, e.g. based on effective/expiration
|
|
dates or workflow state.
|
|
"""
|
|
|
|
|
|
class IServiceGroup(Interface):
|
|
""" A group of related services or a general service definition,
|
|
e.g. a regular bus service or a series of trainings.
|
|
"""
|
|
|
|
services = Attribute('A collection of services belonging to this object.')
|
|
|
|
def isActive():
|
|
""" Return True if object is active, e.g. based on effective/expiration
|
|
dates or workflow state.
|
|
"""
|
|
|
|
serviceCategories = SimpleVocabulary((
|
|
SimpleTerm('event', 'event', u'Event'),
|
|
SimpleTerm('transport', 'transport', u'Transport'),
|
|
))
|
|
|
|
class IService(Interface):
|
|
""" A service that clients may register with.
|
|
"""
|
|
|
|
title = Attribute('A descriptive but short title')
|
|
|
|
description = schema.Text(
|
|
title=_(u'Description'),
|
|
description=_(u'A brief description of the item.'),
|
|
required=False,)
|
|
category = schema.Choice(
|
|
title=_(u'Category'),
|
|
description=_(u'The type of '
|
|
'this service, e.g. an event or a transport.'),
|
|
vocabulary=serviceCategories,
|
|
default='event',
|
|
required=False,)
|
|
bookable = schema.Bool(
|
|
title=_(u'May people register for this service'),
|
|
description=_(u'When this field is checked participants '
|
|
u'may directly register for this service.'),
|
|
default=True,
|
|
required=False,)
|
|
allowRegWithNumber = schema.Bool(
|
|
title=_(u'Allow registration with number'),
|
|
description=_(u'When this field is checked more than one '
|
|
u'object (participant) may be assigned with one '
|
|
u'registration by entering a corresponding number.'),
|
|
required=False,)
|
|
presetRegistrationField = schema.Bool(
|
|
title=_(u'Preset Registration Field'),
|
|
description=_(u'Check this field if the field for the number '
|
|
u'of registrations should have a default of 1 '
|
|
u'(instead of 0) or the corresponding checkbox '
|
|
u'should be checked by default. This is only useful '
|
|
u'if the service manager contains only a single service.'),
|
|
required=False,
|
|
default=False)
|
|
allowDirectRegistration = schema.Bool(
|
|
title=_(u'Allow direct registration'),
|
|
description=_(u'When this field is checked participants '
|
|
u'may register themselves directly on the page '
|
|
u'with the service description; otherwise registration '
|
|
u'is only possible on a registration template.'),
|
|
required=False,)
|
|
externalId = schema.TextLine(
|
|
title=_(u'External ID'),
|
|
description=_(u'Identifier in external system or code number.'),
|
|
required=False,)
|
|
cost = schema.Float(
|
|
title=_(u'Cost'),
|
|
description=_(u'Cost or prizing information.'),
|
|
required=False,)
|
|
capacity = schema.Int(
|
|
title=_(u'Capacity'),
|
|
description=_(u'The capacity (maximum number of clients) '
|
|
u'of this service; a negative number means: '
|
|
u'no restriction, i.e. unlimited capacity.'),
|
|
required=False,)
|
|
waitingList = schema.Bool(
|
|
title=_(u'Waiting list'),
|
|
description=_(u'Check this field if participants beyond the '
|
|
u'capacity of the service should be kept in a '
|
|
u'waiting list.'),
|
|
required=False,)
|
|
location = schema.TextLine(
|
|
title=_(u'Location information'),
|
|
description=_(u'Basic location information or '
|
|
u'start point for transport services.'),
|
|
required=False,)
|
|
locationUrl = schema.TextLine(
|
|
title=_(u'URL for location'),
|
|
description=_(u'Web address (URL) with more information '
|
|
u'about the location.'),
|
|
required=False,)
|
|
location2 = schema.TextLine(
|
|
title=_(u'Location information (2)'),
|
|
description=_(u'Additional location information or '
|
|
u'end point for transport services.'),
|
|
required=False,)
|
|
location2Url = schema.TextLine(
|
|
title=_(u'URL for location (2)'),
|
|
description=_(u'Web address (URL) with more information '
|
|
u'about the location.'),
|
|
required=False,)
|
|
webAddress = schema.TextLine(
|
|
title=_(u'Web address'),
|
|
description=_(u'Web address (URL) for more information '
|
|
u'about the service.'),
|
|
required=False,)
|
|
info = schema.TextLine(
|
|
title=_(u'Additional information'),
|
|
description=_(u'Name/title of a document or web page that '
|
|
u'offers additional information.'),
|
|
required=False,)
|
|
infoUrl = schema.TextLine(
|
|
title=_(u'URL for additional information'),
|
|
description=_(u'Web address (URL) of a document or web page that '
|
|
u'offers additional information.'),
|
|
required=False,)
|
|
|
|
availableCapacity = Attribute('Available capacity, i.e. number of seats '
|
|
'still available; a negative number means: '
|
|
'no restriction, i.e. unlimited capacity; '
|
|
'read-only')
|
|
|
|
allowRegWithNumber.default_method = 'getAllowRegWithNumberFromManager'
|
|
allowDirectRegistration.default_method = 'getAllowDirectRegistrationFromManager'
|
|
|
|
token = Attribute('A name unique within the manager of this service '
|
|
'used for identifying the service e.g. in forms.')
|
|
serviceGroup = Attribute('The service group this object is an instance of.')
|
|
classification = Attribute('A sequence of tokenized terms characterizing '
|
|
'this service within a hierarchy of concepts.')
|
|
|
|
serviceProviders = Attribute('A collection of one or more service providers.')
|
|
resources = Attribute('A collection of one or more resources.')
|
|
registrations = Attribute('A collection of client registrations.')
|
|
|
|
def isActive():
|
|
""" Return True if object is active, e.g. based on effective/expiration
|
|
dates or workflow state.
|
|
"""
|
|
|
|
def register(client):
|
|
""" Register a client with this service. Return an IRegistration
|
|
object if the registration is successful, otherwise
|
|
(e.g. if the service's capacity is exhausted) return None.
|
|
"""
|
|
|
|
def unregister(client):
|
|
""" Remove the client from this service's registrations.
|
|
"""
|
|
|
|
def getSubservices():
|
|
""" Return a collection of immediate sub-services.
|
|
"""
|
|
|
|
def addSubservice(service):
|
|
""" Add the service given as a sub-service to this service.
|
|
"""
|
|
|
|
def removeSubservice(service):
|
|
""" Remove the sub-service given.
|
|
"""
|
|
|
|
def getParentService():
|
|
""" Return the immediate parent service if present, or None otherwise.
|
|
"""
|
|
|
|
def getServiceCollections():
|
|
""" Return a collection of service collection this service is assgned to.
|
|
"""
|
|
|
|
|
|
collectionTypes = SimpleVocabulary((
|
|
SimpleTerm('day', 'day', u'Day'),
|
|
SimpleTerm('track', 'track', u'Track'),
|
|
))
|
|
|
|
class IServiceCollection(IService):
|
|
""" A service that provides a substructure element of a compound service,
|
|
e.g. a conference track or a conference day.
|
|
"""
|
|
|
|
collectionType = schema.Choice(
|
|
title=_(u'Type'),
|
|
description=_(u'The type of '
|
|
'this service collection, e.g. a day or a track.'),
|
|
vocabulary=collectionTypes,
|
|
default='day',
|
|
required=False,)
|
|
|
|
def getAssignedServices():
|
|
""" Return a collection of services assigned to this collection.
|
|
"""
|
|
|
|
def assignService(service):
|
|
""" Assign a service to this collection.
|
|
"""
|
|
|
|
def deassignService(service):
|
|
""" Remove a service from this collection.
|
|
"""
|
|
|
|
|
|
class IScheduledService(IService):
|
|
""" A service that starts at a certain date/time and
|
|
usually ends a certain time later.
|
|
"""
|
|
|
|
start = schema.Date(
|
|
title=_(u'Start date/time'),
|
|
description=_(u'The date/time when the service starts'),
|
|
required=False,)
|
|
end = schema.Date(
|
|
title=_(u'End date/time'),
|
|
description=_(u'The date/time when the service ends'),
|
|
required=False,)
|
|
|
|
start.default_method = 'getStartFromManager'
|
|
end.default_method = 'getEndFromManager'
|
|
|
|
duration = Attribute('Time delta between start and end date/time.')
|
|
|
|
|
|
class IClient(Interface):
|
|
""" An fairly abstract interface for objects to be used as clients
|
|
for services.
|
|
"""
|
|
|
|
manager = Attribute('The object that cares for this client.')
|
|
|
|
|
|
class IClientFactory(Interface):
|
|
""" Creates client objects.
|
|
"""
|
|
|
|
def __call__(data):
|
|
""" Creates and returns a client object built from the
|
|
data set provided.
|
|
"""
|
|
|
|
|
|
class IRegistration(Interface):
|
|
""" Information about the registration of a client with a service.
|
|
"""
|
|
|
|
client = Attribute('The client registered.')
|
|
service = Attribute('The service the client is registered for.')
|
|
timeStamp = Attribute('An integer denoting the time of registration.')
|
|
number = Attribute('The number of objects (e.g. persons) registered '
|
|
'- usually == 1.')
|
|
numberWaiting = Attribute('The number of objects registered that are '
|
|
'on the waiting list.')
|
|
|
|
|
|
class IRegistrationTemplate(Interface):
|
|
""" A content object controlling access to service registrations
|
|
of a certain client.
|
|
|
|
The client should be accessed via an IClientRegistrations adapter.
|
|
"""
|
|
|
|
categories = schema.List(
|
|
title=_(u'Categories'),
|
|
description=_(u'A list of categories of services '
|
|
'that should be shown on this template.'),
|
|
default=[],
|
|
required=False,)
|
|
|
|
categories.vocabulary = serviceCategories
|
|
|
|
manager = Attribute('The service manager this object belongs to.')
|
|
services = Attribute('A collection of services to which this '
|
|
'object provides access. This may be all or part '
|
|
'of the services managed by the manager.')
|
|
|
|
|
|
class IClientRegistrations(Interface):
|
|
""" Provides access to a client object and allows to manage its service
|
|
registrations.
|
|
"""
|
|
|
|
template = Attribute('A regstration template that is used '
|
|
'for controlling the registration process.')
|
|
|
|
def register(services):
|
|
""" Register the client for the services given.
|
|
"""
|
|
|
|
def unregister(services):
|
|
""" Remove the client from the services given.
|
|
"""
|
|
|
|
def getRegistrations():
|
|
""" Return the client's service registrations.
|
|
"""
|
|
|
|
|
|
class IResource(Interface):
|
|
""" A resource is needed by a service to be able to work, e.g. a
|
|
room or a bus. A resource may have a limited capacity so that
|
|
at a certain time it may only be used by services to a certain
|
|
extent.
|
|
"""
|
|
|
|
|
|
class IServiceProvider(Interface):
|
|
""" A party, that is responsible for providing a service.
|
|
"""
|
|
|
|
|
|
# jobs
|
|
|
|
class IJobManager(Interface):
|
|
""" Collects and executes jobs.
|
|
"""
|
|
|
|
def process():
|
|
""" Do what has to be done...
|
|
"""
|
|
|
|
|
|
# work
|
|
|
|
class IWorkItem(ITrack):
|
|
""" A single piece of work, started and finished at a certain time,
|
|
done by exactly one party (usually a person).
|
|
"""
|
|
|
|
# index attributes
|
|
task = Attribute('The task this work item belongs to, identified by '
|
|
'its name or ID.')
|
|
run = Attribute('Used for recurring tasks: identifies the run '
|
|
'(execution instance) of the task the work item belongs to.')
|
|
party = Attribute('Whoever does the work, usually a person, identified '
|
|
'by its name or ID.')
|
|
state = Attribute('The current state the work item is in.')
|
|
# standard attributes
|
|
workItemType = Attribute('The type of the work item '
|
|
'(work, event, deadline).')
|
|
title = Attribute('A short text characterizing the work item.')
|
|
description = Attribute('A note about what has to be done, and why...')
|
|
deadline = Attribute('When the work has to be finished.')
|
|
start = Attribute('When the work was started.')
|
|
end = Attribute('When the work was finished.')
|
|
duration = Attribute('How long it took to finish the work.')
|
|
effort = Attribute('How much effort (time units) it took '
|
|
'to finish the work.')
|
|
comment = Attribute('A note about what has been done, and why...')
|
|
# work item handling
|
|
creator = Attribute('The party that has set up the work item.')
|
|
created = Attribute('The timeStamp of the initial creation '
|
|
'of the work item.')
|
|
newTask = Attribute('Optional: a new task that has been created based '
|
|
'on this work item.')
|
|
|
|
def setData(**kw):
|
|
""" Set initial work item data (if allowed by the current state);
|
|
values not given will be derived if appropriate.
|
|
"""
|
|
|
|
def doAction(action, **kw):
|
|
""" Execute an action.
|
|
|
|
Actions are usually a sequence of transitions together with
|
|
setting some properties depending on the action and
|
|
the starting state.
|
|
|
|
Available actions are: plan, delegate, accept, start, finish,
|
|
cancel, continue, transfer.
|
|
"""
|
|
|
|
|
|
class IWorkItems(Interface):
|
|
""" A collection (manager, container) of work items.
|
|
"""
|
|
|
|
def __getitem__(key):
|
|
""" Return the work item identified by the key given.
|
|
"""
|
|
|
|
def __iter__():
|
|
""" Return an iterator of all work items.
|
|
"""
|
|
|
|
def query(**criteria):
|
|
""" Search for tracks. Possible criteria are: task, party, run,
|
|
timeFrom, timeTo.
|
|
"""
|
|
|
|
def add(task, party, run=0, **kw):
|
|
""" Create and register a work item; return it. Additional properties
|
|
may be specified via keyword arguments.
|
|
"""
|
|
|