Plone addon to reserve stuff in a calendar.
Not a replacement for Outlook or Google Calendar, but a system to manage reservations on the backend and to provide them on the frontend.
Originally developed together with the municipality of Zug, Switzerland this Addon aims to combine differing reservation systems into one flexible solution.
It does so by providing a way to deal with the following usecases:
- Manage meeting rooms in a company. Users reserve the rooms themselves without an authority confirming/denying their reservations.
- Manage nursery spots. Parents apply for a spot in the nursery for their kid. Someone at the nursery goes through the applicants and decides who gets the spot. Parents may add an application to the waitinglist.
- Manage community facilities. Citizens see the availability of facilities online and call the municipality to reserve a facility. The management is done internally (maybe through an already existing software). The addon is only used for display.
- Python 2.7
- Plone 4.3+ ( Plone 4.1 and 4.2 had to be dropped, sorry )
- Linux / Posix ( Windows may or may not work )
- Postgresql 9.1+ ( Older versions DO NOT work! )
- 1024MB+ RAM
seantis.reservation is tested using IE8+, Chrome, Firefox. IE7 is not supported! Note also that IE8 and IE9 only work right if the Plone site is in production mode. The reason for it is that those browsers ignore every stylesheet after the 32th. In production these stylesheets are merged.
These are the things seantis.reservation currently doesn’t do, or doesn’t do well:
- Multilanguage. It is perfectly fine to run seantis.reservation in the language of your choice, though you might have to do some translations for yourself. However, you might find the ability to run the site in multiple languages (where the language is set on a per-request basis) to be lacking or with rough edges. It should mostly work but we cannot guarantee it or tell you that we tested this well.
- Timezones. We currently do not store a timezone with the resource. Therefore comparing different resources of different timezones is a no go.
- Recurrence. Though it is possible to create reservations with simple daily recurrence, it is not possible to modify them, so if you create 1000 recurrences and you make a mistake you have to delete all or adjust them each.
The setup instructions assume an Ubuntu / Debian Server installation as well as basic knowledge of Plone.
Install required packages
sudo apt-get install git-core sudo apt-get install libxml2 libxml2-dev sudo apt-get install libxslt1.1 libxslt1-dev sudo apt-get install python2.7 python2.7-dev
Run the installer
sudo apt-get install postgresql-9.1 sudo apt-get install postgresql-9.1-dev
If the dev package cannot be found try
sudo apt-get install postgresql-server-dev-all
Create a database user (replace your_password with your own). This password is needed later!
sudo -u postgres psql -c "CREATE USER reservation WITH PASSWORD 'your_password'"
Create the reservations database
sudo -u postgres psql -c "CREATE DATABASE reservations ENCODING 'UTF8' TEMPLATE template0"
Grant the required privileges to the reservation user
sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE reservations to reservation"
Download the buildout configs to the folder which will hold your Plone installation.
wget -qO - https://raw.github.com/seantis/seantis.reservation/master/buildout/buildouts.sh | bash
Or if you don’t have wget (like on OSX):
curl https://raw.github.com/seantis/seantis.reservation/master/buildout/buildouts.sh | bash
Edit your database connection settings in the database.cfg file.
Download the boostrap script
Again, alternatively with curl
curl http://downloads.buildout.org/1/bootstrap.py > bootstrap.py
Bootstrap your environment
Run the installation (and get that coffee machine cracking)
If everything went well you may now start your instance
The tests are run against a Postgres Database. This should be a database used for this purpose only. Therefore you should first create said database
sudo -u postgres psql -c "CREATE USER test WITH PASSWORD 'test'"
Create the test database
sudo -u postgres psql -c "CREATE DATABASE test ENCODING 'UTF8' TEMPLATE template0"
Grant the required privileges to the test user
sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE test to test"
To get the test script you should run the development buildout
bin/buildout -c develop.cfg
After that you need to tell the test script which database to use
cd src/seantis.reservation/seantis/reservation cp test_database.py.example test_database.py
You tell it by editing test_database.py and adding a testdsn like this
testdsn = "postgresql+psycopg2://test:test@localhost:5432/test"
You may then run the tests as follows
bin/test -s seantis.reservation
Creating a Reservation Plone Site
Create the Site
Having started your instance, navigate to the plone root:
It should say ‘Plone is up and running’. On this site click “Create new Plone site” If you used the develop.cfg the username and password are “admin” and “admin”.
Obviously you do not want to use develop.cfg in production!
On the “Create a Plone site” form, you should enter name and title of your plone site, followed by checking the box of the following Add-On:
Seantis Reservation - for default plone theme
Having done that, click “Create Plone Site”
Create Resource Folder
On your freshly minted Plone Site, click on “Add new…” and choose “Folder”. Use any name you like.
Add a Resource
In the newly created folder, click on “Display” and choose “Resource Listing”.
This will turn the folder into a view designed for displaying Resources.
After changing the view click on “Add new…” and choose “Resource”. Enter any name you like.
You should now see a calendar in which you can create allocations that may be reserved. One level up, in the folder view, you may add more resources and compare them. Of course there is more to learn, but this is the basic setup of the Seantis Reservation module.
To really understand seantis.reservation it is important to understand a few core concepts:
Resources are Dxterity content types who display a calendar and interact with the core of seantis.reservation. They are heavy on the UI side of things, while being nothing more than a foreign key in the database.
Everyone familiar with Outlook or Google Calendar knows that one can just click on an empty spot and add a new reservation.
In seantis.reservation this is not the case. In this module, a spot that may be reserved must be marked as such first. This is called an allocation.
The idea is to allocate time which may be reserved. It is like declaring time that should be managed by reservations. Outlook and Google Calendar implicitly see all time as allocated and under their management.
One reason for this is the fact that only through limiting the available time we can calculate meaningful utilization numbers. Another reason is that some periods of time may be overbooked, other times may not, or generally speaking: some timeperiods are different than others.
Allocations therefore define how periods of time may be reserved. They may not overlap for any given resource and they are independent of Plone and part of the SQL database model.
When reserving an allocation or a part of an allocation, reserved slots are generated. They ensure that no reservation is ever granted twice by accident.
Reserved slots may start every 5 minutes. At 5.35 or 5.40 for example, but not at 5.36 or 5.39. When reserving 45 minutes of an allocation, many reserved slots are spawned and aligned. Their primary keys then ensure on a low level basis that no overlaps occur.
For a much needed example:
Resource: 1234 Allocation: 09:00 - 10:00 => reserve 1234, 09:30 - 10:00 Reserved Slots: 1234 09:30 1234 09:35 1234 09:40 1234 09:45 1234 09:50 1234 09:55 => try to reserve 1234, 09:30 - 10:00 again Reserved Slot 1234, 09:30 already exists
Of course there are a number of optimizations to ensure that we don’t generated millions of reserved slots. But this is basically it.
Reservations exist in two states: Pending and Approved.
Pending reservations are reservations on a waitinglist. Users have submitted them, but nobody has confirmed them. They have therefore no reserved slot associated with them.
Approved reservations are reservations who are associated with reserved slots and are therefore confirmed and binding.
Note that it is possible in the UI side of seantis.reservation to go from pending to confirmed automatically. This is called auto-approval.
Why is Database X not an option? / Why does Postgresql < 9.1 not work?
seantis.reservation relies on a Postgresql feature introduced in 9.1 called “Serialized Transactions”. Serialized transactions are transactions that, run on multiuser systems, are guaranteed to behave like they are run on a singleuser system.
In other words, serialized transactions make it much easier to ensure that the data stays sane even when multiple write transactions are run concurrently.
Other databases, like Oracle, also support this feature and it would be possible to support those databases as well. Patches welcome.
Note that MySQL has serialized transactions with InnoDB, but the documentation does not make any clear guarantees and there is a debate going on:
Why did you choose SQL anyway? Why not use the ZODB? Why not insert your favorite NoSQL DB here?
- If a reservation is granted to you, noone else must get the same grant. Primary keys and transactions are a natural fit to ensure that.
- Our data model is heavily structured and needs to be validated against a schema.
- All clients must have the same data at all time. Not just eventually.
- Complicated queries must be easy to develop as reporting matters.
- The core of seantis.reservation should eventually be independent of Zope/Plone.
Why / How is my allocation colored? My allocation is green, but it should be orange/red!
Basically colors are assigned to events based on their availability:
75-100% : Green / Available
1-74% : Orange / Partly Available
0% : Unavailable
The availability is calculated by taking the total time available and dividing it by the time reserved. If an allocation is set to be approved automatically (the default) a 0% availability also means that no new reservations can be made.
If an allcation is set to be approved manually, there’s automatically an unlimited waitinglist. Reservations to that waitinglist can be made at any time - unless the allocation setting is changed - and the number of people in the waitinglist is shown on the allcation itself.
- Adds the ability to define green/orange/red thresholds in the controlpanel. Fixes #158. [href]
- Adds the ability to view formdata that cannot be written anymore. This can happen if the custom forms are changed after the data has been written. Fixes #150. [href]
- Limits the width of the day view, to improve the accessibility of the menu. Fixes #157. [href]
- Adds a fast way to switch to another view from the allocation menu. Fixes #153. [href]
- Exceptions occurring in forms now include the correct stacktrace. [href]
- Export filenames now include the year and the month. Fixes #155. [href]
- Adds shading (avilability indicator) to the calendar legend. Fixes #154. [href]
- Adds unicode check/cross marks for approve/deny/revoke, to increase legibility. [href]
- Adds thank-you page shown after submitting a reservation. Each resource may have a custom text which is shown under the thank you note. Closes #138. [href]
- Refetch less agressively to make the interface ‘calmer’. Only actions by the user which change something trigger a refresh now. Clicking on the cancel button of an overlay for example won’t reload the events anymore. [href]
- The date is now correctly localized in all the views as well as the calendar. Fixes #142. [href]
- Renames “Reservation Quota” (eng) to “Number of Reservations”. Fixes #143. [href]
- Availability partitions are now more visible. Fixes #149. [href]
- Allocations which are not completely displayed on the calendar now show correct availability partitions. Fixes #145. [href]
- Correctly handles partly-available whole-day allocations. Fixes #129. [href]
- No longer raise an exception to the user if a nonexistant reservation is removed from ‘your reservations’. Fixes #123. [href]
- Adds new reservation-assistant role which may view but not edit submitted reservation data. [href]
- Fixes overlay js failing if loaded after jquery tools. [href]
- Slims down the session handling code. [href]
- The messages shown when reserving/confirming a reservation have been reworked to be more informative. [href]
- If an overlay fails to load the remote address after a click, an error is shown. [href]
- Email addresses are now verified and stored without leading or trailing space. Fixes #127. [href]
- Shows an error when displaying or submitting the reservation confirm form, if no reservation can be confirmed. Fixes #128. [href]
- Fixes inability to reserve a group reservation. Closes #124. [href]
- Fixes a major Heisenbug occurring in testing using the latest SQLAlchemy release. [href]
- Adds next/previous 30 days to latest reservations report. [href]
- Adds month/year filter to the export. Fixes #101. [href]
- Replaces the export list view with a form where the export type, format and other options can be chosen. [href]
- Improves print style for single reservation view. Fixes #109. [href]
- Adds seantis.reservation specific browserlayer. [href]
- Adds xlsx as output format to exports. [href]
- Adds option to define one global manager email address. Fixes #69. [href]
- Start treating sqlalchemy warnings during tests as errors. [href]
- Adds a link to the reservation to the manager email. Fixes #117. [href]
- Adds the reservation quota to the reservation confirmation mail. Fixes #111. [href]
- No longer send reservee emails to the reservation manager. Fixes #118. [href]
- Richtextfields may now be exported to excel/csv/json. HTML is converted into text when this is done. [href]
- Dates in the excel/csv/json export are now uniformly exported in ISO8601. Fixes #116. [href]
- Reservation data is now stored more transparently. This has no effect for users, but it ensures better data integrity in the future. Fixes #119. [href]
- Integrates seantis.plonetools. [href]
- Make sure that the exposure checking method doesn’t trip up if the resource may not be viewed and is therefore None. Fixes #114. [href]
- No longer throws an exception if the allocation cannot be found. Returns a 404 instead. Fixes #112. [href]
- The print link is now shown in the monthly_report. Fixes #33. [href]
- Custom e-mail templates now show a translated template upon creation, if the translation is available. Fixes #92. [href]
- Adds quota to email templates. Closes #41. [href]
- Clarify the received reservations email helptext, ensuring that it’s clear that this mail is sent in all cases. Closes #95. [href]
- Ensures that different logged in users don’t see each others reservations. [deiferni]
- Fixes throttling being triggered on invalid reservations. Throttling should only be active if the reservation is actually made.
- Adds the ability to define pre-reservation script which may trigger validation errors on the reservation form.
- Adds the ability to print single reservations.
- Adds the ability to remove a reservation without sending an email.
- Adds a new ‘latest reservations’ report, showing reservations done in the last 30 days.
- Removing expired sessions no longer results in orphan reserved slots. Existing orphan reserved slots are removed by the upgrade step.
- Exceptions in the ‘your-reservations’ form are now handled correctly, resulting in properly displayed errors.
- The date and start-/end-time are now properly disabled on the form if they may not be edited.
- Fixes ‘continue’ button not working on group forms
- Fixes radio-buttons and check-boxes not showing up on group forms
- Fixes a minor style issue in the teamraum theme
- Fixes ‘your-reservations’ from bugging out if a date before 1900 is entered
- Fixes being unable to confirm ‘your-reservations’ outside the resource.
- Adds a new view for exports which initially offers the existing reservations export and a new ‘compact’ export.
- Adds created / modified columns to reservation exports.
- Having different resources with different formsets no longer leads to errors when trying to do multiple reservations.
- Increases the maximum allocation quota from 100 to 1000
- Fixes typo in English text.
- Improves German texts.
Removes potentially dangerous orphan removal from settings panel.
All reservation records stored in Postgres belonging to a certain resource are now wiped if said resource is deleted.
The exception is the removal of a plone site through the ZMI. Though it is possible to intercept that event it is not entirely save to discard all resources that are part of plone site being deleted. It is namely possible that those have the same uuid as another existing resource of another site.
To clean these kind of data zombies it might be good to create a tool with which reservations before a given date are wiped or archived.
This is however not a priority as it is recommended to have a separate database for each site anyway and until there’s a high volume reservations site in existance this won’t ever be a problem. Postgres can handle unused records.
Stops allocation.mirror_of from potentially being NULL.
Fixes a bug where reservations could be added to waitinglists on allocations that were not meant to have a waitinglist.
Fixes typo in German translation
Adds the ability to edit the formdata of a reservation through the management or the report interface
Adds the ability to define Manager Formsests which are the same as Default Formsets but can only be edited by someone with the appropriate permission.
With these formsets and the ability to edit the formdata it’s possible to create simple ways to organize reservations. A manager formset could be added with a checkbox “paid” for example, along a normal formset with the address.
Each reservation will then have an address filled by the user and a “paid”-checkbox. The reservee cannot see or change this checkbox, but the manager can do so once the reservee has actually paid whatever he was supposed to.
The initial values of those manager-only fields are defined throught the Dexterity-Schema editor.
Fixes missing translations in certain cases (locale.js is now more robust)
Uses ajax on the monthly report to load reservation changes
- Adds whole-day flag to reservations export
- Adds quota to reservations export
- Adds the ability to show/hide the timetable in the monthly report
- Keep filter state between months in monthly report
- Adds basic support for plonetheme.teamraum
- Fixes German translation typo
- Adds email sent to managers when a new reservation was automatically approved
- Focuses on first input when switching tabs in wizard forms
- Fixes crash in JSON Encoder
- Fixes some tiny issues
- Initial release