Adds button to switch between informing / not informing the user when…

… revoking a reservation. Fixes #10

docs/HISTORY.txt

@@ -2,6 +2,11 @@
 Changelog
 =========
 
+1.0.14 (unreleased)
+-------------------
+
+- Adds the ability to remove a reservation without sending an email.
+
 1.0.13
 ------
 

seantis/reservation/db.py

@@ -1016,15 +1016,17 @@ def deny_reservation(self, token):
         notify(ReservationDeniedEvent(reservation, self.language))
 
     @serialized
-    def revoke_reservation(self, token, reason):
+    def revoke_reservation(self, token, reason, send_email=True):
         """ Revoke a reservation and inform the user of that."""
 
         reason = reason or u''
 
         # sending the email first is no problem as it won't work if
         # an exception triggers later in the request
         reservation = self.reservation_by_token(token).one()
-        notify(ReservationRevokedEvent(reservation, self.language, reason))
+        notify(ReservationRevokedEvent(
+            reservation, self.language, reason, send_email
+        ))
 
         self.remove_reservation(token)
 

seantis/reservation/events.py

@@ -41,9 +41,10 @@ class ReservationDeniedEvent(ReservationBaseEvent):
 class ReservationRevokedEvent(ReservationBaseEvent):
     implements(IReservationRevokedEvent)
 
-    def __init__(self, reservation, language, reason):
+    def __init__(self, reservation, language, reason, send_email):
         super(ReservationRevokedEvent, self).__init__(reservation, language)
         self.reason = reason
+        self.send_email = send_email
 
 
 class ReservationsConfirmedEvent(object):

seantis/reservation/interfaces.py

@@ -765,6 +765,14 @@ class IGroupReservation(Interface):
 class IRevokeReservation(IReservationIdForm):
     """ For the reservation revocation form. """
 
+    send_email = schema.Bool(
+        title=_(u"Send Email"),
+        description=_(
+            u"Send an email to the reservee informing him of the revocation"
+        ),
+        default=True
+    )
+
     reason = schema.Text(
         title=_(u'Reason'),
         description=_(

seantis/reservation/js/formgroups.js

@@ -271,6 +271,17 @@ seantis.formgroups.init = function(el) {
         }
     });
 
+    add({
+        name: "send_email",
+        trigger: find('#form-widgets-send_email-0'),
+        fields: [
+            find('#formfield-form-widgets-reason')
+        ],
+        on_is_enabled: function(trigger) {
+            return trigger.is(':checked');
+        }
+    })
+
     seantis.formgroups.add_utility_links();
     seantis.formgroups.add_recurrency_helper();
     seantis.formgroups.autoselect_days();

seantis/reservation/locales/de/LC_MESSAGES/seantis.reservation.po

@@ -1,7 +1,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2013-09-27 08:57+0000\n"
+"POT-Creation-Date: 2013-10-04 08:02+0000\n"
 "PO-Revision-Date: 2012-09-06 11:33+0100\n"
 "Last-Translator: Fabian Reinhard <fabian.reinhard@seantis.ch>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -14,7 +14,7 @@ msgstr ""
 "Preferred-Encodings: utf-8 latin1\n"
 "Domain: DOMAIN\n"
 
-#: ./reports/latest_reservations.py:54
+#: ./reports/latest_reservations.py:37
 msgid "${days} days ago, at ${time}"
 msgstr "Vor ${days} Tagen, um ${time}"
 
@@ -62,7 +62,7 @@ msgstr "Es existiert bereits eine Einteilung für den gewählten Zeitraum"
 msgid "A pending reservation would be affected by the requested change"
 msgstr "Ein offene Reservierung wäre durch die Änderung betroffen"
 
-#: ./mail.py:486
+#: ./mail.py:489
 msgid "Add email template"
 msgstr "Email Vorlage hinzufügen"
 
@@ -207,7 +207,7 @@ msgid "Defines the minimum length of any given reservation as well as the alignm
 msgstr "Definiert die Mindestlänge der Reservationen für diese Einteilung, sowie die automatische Anpassung der Start- bzw. Endzeit. Ein Raster von 30 Minuten bedeuted beispielsweise, dass die Einteilung nur um xx:00 Uhr und xx:30 Uhr beginnen kann."
 
 #: ./allocate.py:297
-#: ./mail.py:495
+#: ./mail.py:498
 #: ./reports/monthly_report.py:220
 msgid "Delete"
 msgstr "Löschen"
@@ -251,7 +251,7 @@ msgid "Do you want to reserve the following allocations?"
 msgstr "Möchten Sie die folgenden Einteilungen reservieren?"
 
 #: ./allocate.py:244
-#: ./mail.py:494
+#: ./mail.py:497
 #: ./resource.py:342
 msgid "Edit"
 msgstr "Bearbeiten"
@@ -301,7 +301,7 @@ msgstr "Email Betreff für Reservationen in der Warteliste"
 msgid "Email Subject for Revoked Reservations"
 msgstr "Email Betreff für Abgesagte Reservationen"
 
-#: ./mail.py:89
+#: ./mail.py:92
 #: ./profiles/default/types/seantis.reservation.emailtemplate.xml
 msgid "Email Template"
 msgstr "Email Vorlage"
@@ -540,7 +540,7 @@ msgstr "Ohne"
 msgid "One Person Waiting"
 msgstr "Eine Person wartet"
 
-#: ./interfaces.py:770
+#: ./interfaces.py:778
 msgid "Optional reason for the revocation. Sent to the reservee. e.g. 'Your reservation has to be cancelled because the lecturer is ill'."
 msgstr "Optionaler Grund für die Absage. Wird an den Reservierenden gesendet. Z.B. 'Ihre Reservation muss abesagt werden weil der Dozent krank ist'."
 
@@ -575,7 +575,7 @@ msgstr "Kontingent muss zwischen 1 und 1000 liegen"
 msgid "Raster"
 msgstr "Raster"
 
-#: ./interfaces.py:769
+#: ./interfaces.py:777
 msgid "Reason"
 msgstr "Grund"
 
@@ -665,7 +665,7 @@ msgstr "Reservierung erfolgreich abgeschlossen"
 msgid "Reservations can't be made for more than 24 hours at a time"
 msgstr "Reservationen können nicht über mehr als 24 Stunden gemacht werden"
 
-#: ./reports/latest_reservations.py:29
+#: ./reports/latest_reservations.py:56
 msgid "Reservations in the last 30 days"
 msgstr "Reservationen in den letzten 30 Tagen"
 
@@ -704,7 +704,7 @@ msgstr "Reservation absagen"
 msgid "Sa"
 msgstr "Sa"
 
-#: ./mail.py:438
+#: ./mail.py:441
 #: ./reserve.py:861
 #: ./timeframe.py:83
 msgid "Save"
@@ -734,6 +734,14 @@ msgstr "Ausgewählte Ansicht"
 msgid "Selected view when opening the calendar."
 msgstr "Ansicht die beim Öffnen des Kalenders angezeigt wird."
 
+#: ./interfaces.py:769
+msgid "Send Email"
+msgstr "Email senden"
+
+#: ./interfaces.py:770
+msgid "Send an email to the reservee informing him of the revocation"
+msgstr "Informiere den Benutzer der die Reservation gemacht hat"
+
 #: ./settings.py:40
 msgid "Send emails about made, approved and denied reservations to the user that made the reservation."
 msgstr "Sende Emails zu gemachten, zugelassenen und abgelehnten Reservationen zu dem Benutzer der die Reservation gemacht hat."
@@ -887,7 +895,7 @@ msgstr "${nb} Reservationen werden gerade eingegeben."
 msgid "There is one reservation being entered for this resource."
 msgstr "Eine Reservation wird gerade eingegeben."
 
-#: ./mail.py:423
+#: ./mail.py:426
 msgid "There's already an Email template in the same folder for the same language"
 msgstr "Es besteht bereits eine Email Vorlage mit dieser Sprache in diesem Order"
 
@@ -908,7 +916,7 @@ msgstr "Belegungsperioden"
 msgid "Timetable"
 msgstr "Zeitachse"
 
-#: ./reports/latest_reservations.py:45
+#: ./reports/latest_reservations.py:28
 msgid "Today, at ${time}"
 msgstr "Heute, um ${time}"
 
@@ -966,7 +974,7 @@ msgstr "Ganztägig"
 msgid "Yes"
 msgstr "Ja"
 
-#: ./reports/latest_reservations.py:50
+#: ./reports/latest_reservations.py:33
 msgid "Yesterday, at ${time}"
 msgstr "Gestern, um ${time}"
 

seantis/reservation/locales/seantis.reservation.pot

@@ -4,7 +4,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2013-09-27 08:57+0000\n"
+"POT-Creation-Date: 2013-10-04 08:02+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI +ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -17,7 +17,7 @@ msgstr ""
 "Preferred-Encodings: utf-8 latin1\n"
 "Domain: seantis.reservation\n"
 
-#: ./reports/latest_reservations.py:54
+#: ./reports/latest_reservations.py:37
 msgid "${days} days ago, at ${time}"
 msgstr ""
 
@@ -65,7 +65,7 @@ msgstr ""
 msgid "A pending reservation would be affected by the requested change"
 msgstr ""
 
-#: ./mail.py:486
+#: ./mail.py:489
 msgid "Add email template"
 msgstr ""
 
@@ -210,7 +210,7 @@ msgid "Defines the minimum length of any given reservation as well as the alignm
 msgstr ""
 
 #: ./allocate.py:297
-#: ./mail.py:495
+#: ./mail.py:498
 #: ./reports/monthly_report.py:220
 msgid "Delete"
 msgstr ""
@@ -254,7 +254,7 @@ msgid "Do you want to reserve the following allocations?"
 msgstr ""
 
 #: ./allocate.py:244
-#: ./mail.py:494
+#: ./mail.py:497
 #: ./resource.py:342
 msgid "Edit"
 msgstr ""
@@ -304,7 +304,7 @@ msgstr ""
 msgid "Email Subject for Revoked Reservations"
 msgstr ""
 
-#: ./mail.py:89
+#: ./mail.py:92
 #: ./profiles/default/types/seantis.reservation.emailtemplate.xml
 msgid "Email Template"
 msgstr ""
@@ -543,7 +543,7 @@ msgstr ""
 msgid "One Person Waiting"
 msgstr ""
 
-#: ./interfaces.py:770
+#: ./interfaces.py:778
 msgid "Optional reason for the revocation. Sent to the reservee. e.g. 'Your reservation has to be cancelled because the lecturer is ill'."
 msgstr ""
 
@@ -578,7 +578,7 @@ msgstr ""
 msgid "Raster"
 msgstr ""
 
-#: ./interfaces.py:769
+#: ./interfaces.py:777
 msgid "Reason"
 msgstr ""
 
@@ -668,7 +668,7 @@ msgstr ""
 msgid "Reservations can't be made for more than 24 hours at a time"
 msgstr ""
 
-#: ./reports/latest_reservations.py:29
+#: ./reports/latest_reservations.py:56
 msgid "Reservations in the last 30 days"
 msgstr ""
 
@@ -707,7 +707,7 @@ msgstr ""
 msgid "Sa"
 msgstr ""
 
-#: ./mail.py:438
+#: ./mail.py:441
 #: ./reserve.py:861
 #: ./timeframe.py:83
 msgid "Save"
@@ -737,6 +737,14 @@ msgstr ""
 msgid "Selected view when opening the calendar."
 msgstr ""
 
+#: ./interfaces.py:769
+msgid "Send Email"
+msgstr ""
+
+#: ./interfaces.py:770
+msgid "Send an email to the reservee informing him of the revocation"
+msgstr ""
+
 #: ./settings.py:40
 msgid "Send emails about made, approved and denied reservations to the user that made the reservation."
 msgstr ""
@@ -890,7 +898,7 @@ msgstr ""
 msgid "There is one reservation being entered for this resource."
 msgstr ""
 
-#: ./mail.py:423
+#: ./mail.py:426
 msgid "There's already an Email template in the same folder for the same language"
 msgstr ""
 
@@ -911,7 +919,7 @@ msgstr ""
 msgid "Timetable"
 msgstr ""
 
-#: ./reports/latest_reservations.py:45
+#: ./reports/latest_reservations.py:28
 msgid "Today, at ${time}"
 msgstr ""
 
@@ -969,7 +977,7 @@ msgstr ""
 msgid "Yes"
 msgstr ""
 
-#: ./reports/latest_reservations.py:50
+#: ./reports/latest_reservations.py:33
 msgid "Yesterday, at ${time}"
 msgstr ""
 

seantis/reservation/mail.py

@@ -78,6 +78,9 @@ def on_reservation_revoked(event):
     if not settings.get('send_email_to_reservees', True):
         return
 
+    if not event.send_email:
+        return
+
     send_reservation_mail(
         event.reservation, 'reservation_revoked', event.language,
         to_managers=False, revocation_reason=event.reason

seantis/reservation/reserve.py

@@ -753,7 +753,7 @@ def revoke(self, data):
 
         def revoke():
             self.scheduler.revoke_reservation(
-                data['reservation'], data['reason']
+                data['reservation'], data['reason'], data['send_email']
             )
             self.flash(_(u'Reservation revoked'))
 

seantis/reservation/tests/test_db.py

@@ -1039,6 +1039,16 @@ def assert_data_in_mail(message, assert_as=True):
         self.assertTrue(u'no-reason' in mail.messages[0])
         mail.messages = []
 
+        # unless it should not be sent
+        token = sc.reserve(
+            reservation_email,
+            dates, data=data, session_id=session_id
+        )
+        sc.approve_reservation(token)
+        mail.messages = []
+        sc.revoke_reservation(token, u'', send_email=False)
+        self.assertEqual(len(mail.messages), 0)
+
         sc.remove_allocation(allocation.id)
 
         # make multiple reservations in one session to different email

setup.py

@@ -3,7 +3,7 @@
 
 name = "seantis.reservation"
 description = "Plone addon to reserve stuff in a calendar."
-version = '1.0.13'
+version = '1.0.14'
 
 zug_require = [
     'ftw.contentmenu',