Changeset cd05ca in indico for indico/MaKaC/plugins/RoomBooking/default/reservation.py

Timestamp:

06/16/10 17:09:17 (3 years ago)

Author:

Jose Benito <jose.benito.gonzalez@…>

Branches:

master, burotel, hello-world-walkthrough, ipv6, new-webex, v0.97-series, v0.98-series, v0.98.2, v0.98.3, v0.98b1, v0.98b2, v0.99, 051b2622c51afb171a1dedb46a0df4fbb0cbd02e, 0da0c1403bae8e51d8229f460181c71b9e6dda72

Children:

3908a4

Parents:

9c186f

git-author:

Ian Rolewicz <ian.rolewicz@…> (04/27/10 12:25:57)

git-committer:

Jose Benito <jose.benito.gonzalez@…> (06/16/10 17:09:17)

Message:

[IMP] Booking Actions History

• fixes #268
• On the details page of a booking, the history of previous actions performed on that booking is displayed for the owner of the room, the people allowed to modify the booking and the administrators.
• Updated the User Guide
• reviewed by jbenito: doc regenerated

File:

• indico/MaKaC/plugins/RoomBooking/default/reservation.py (modified) (7 diffs)

indico/MaKaC/plugins/RoomBooking/default/reservation.py

@@ -26 +26 @@
 from MaKaC.rb_factory import Factory
 from MaKaC.rb_reservation import ReservationBase, RepeatabilityEnum, WeekDayEnum
-from MaKaC.rb_tools import qbeMatch, doesPeriodsOverlap, iterdays, overlap, weekNumber, containsExactly_OR_containsAny
+from MaKaC.rb_tools import qbeMatch, doesPeriodsOverlap, iterdays, overlap, weekNumber, containsExactly_OR_containsAny, fromUTC
 from MaKaC.rb_location import CrossLocationQueries
 from MaKaC.plugins.RoomBooking.default.factory import Factory
@@ -52 +52 @@
         self._excludedDays = []
         self.useVC = []
+        self.resvHistory = ResvHistoryHandler()
 
     def getUseVC( self ):
@@ -59 +60 @@
             self.useVC = []
         return self.useVC
+
+    def getResvHistory( self ):
+        try:
+            return self.resvHistory
+        except:
+            self.resvHistory = ResvHistoryHandler()
+        return self.resvHistory
 
     @staticmethod
@@ -121 +129 @@
         # room, once assigned to reservation, CAN NOT be changed later (index!)
 
-    def indexDayReservations(self):
+    def indexDayReservations( self ):
         self._addToDayReservationsIndex()
         self._p_changed = True
 
-    def unindexDayReservations(self):
+    def unindexDayReservations( self ):
         self._removeFromDayReservationsIndex()
         self._p_changed = True
@@ -396 +404 @@
         return dayD in self.getExcludedDays()
 
+    def createSnapshot( self ):
+        """
+        Creates dynamically a dictionnary of the attributes of the object.
+        This dictionnary will be mainly used to compare the reservation
+        before and after a modification
+        """
+        result = {}
+
+        for attr, val in self.__dict__.iteritems():
+            result[attr] = val
+
+        return result
+
     # Statistical
 
@@ -423 +444 @@
         location = kwargs.get( 'location', Location.getDefaultLocation().friendlyName )
         return Reservation.countReservations( archival = True, location = location )
+
 
     # ==== Private ===================================================
@@ -454 +476 @@
         return self.room.locationName
 
+class ResvHistoryEntry( Persistent ):
+
+    def __init__( self, user, info, emails ):
+        self._timestamp = datetime.utcnow().strftime("%d %b %Y %H:%M")
+        self._responsibleUser = user.getFullName()
+        self._info = info #List of str
+        # Generate list of email addresses to which a notification email was sent,
+        # and adds them to the info if there are any
+        emailAddrs = ""
+        for email in emails :
+            for toAddr in email["toList"] :
+                emailAddrs += (", " + toAddr)
+        if emailAddrs != "":
+            self._info.append("Emails triggered to:<span style='font-family: \"Courier New\"'>" + emailAddrs[1:] +"</span>")
+
+    def getTimestamp( self ):
+        return self._timestamp
+
+    def getResponsibleUser( self ):
+        return self._responsibleUser
+
+    def getInfo( self ):
+        return self._info
+
+
+class ResvHistoryHandler( Persistent ):
+    """
+    Utility class used to record actions performed on a reservation
+    """
+
+    # Dictionnary used to map Reservation attribute names to human-friendly
+    # names
+    _attrNamesMap = {"_utcStartDT"  :   "start date",
+                     "_utcEndDT"    :   "end date",
+                     "repeatability":   "type",
+                     "bookedForName":   "'Booked for' name",
+                     "contactEmail" :   "'Booked for' email",
+                     "contactPhone" :   "'Booked for' phone",
+                     "reason"       :   "reason"
+                     }
+
+    # Dictionnary used to map Reservation attribute names to methods that
+    # will format them into human-friendly strings
+    _attrFormatMap = {"_utcStartDT" :   fromUTC,
+                    "_utcEndDT"     :   fromUTC,
+                    "repeatability" :   lambda x: RepeatabilityEnum.rep2description[x]
+                    }
+
+    def __init__( self ):
+        self._entries = []
+
+    def addHistoryEntry( self, entry ):
+        if entry == None :
+            return False
+        try:
+            self._entries.insert(0, entry )
+        except:
+            self._entries = []
+            self._entries.insert(0, entry )
+        self.notifyModification()
+        return True
+
+#    def clearHistory(self):
+#        self._entries = []
+#        self.notifyModification()
+
+    def getEntries( self ):
+        try :
+            return self._entries
+        except :
+            self._entries = []
+        return self._entries
+
+    def hasHistory( self ):
+        return not(self._entries == None or self._entries == [])
+
+    def notifyModification( self ):
+        self._p_changed=1
+
+
+    def _bookingSnapshotsDiff( self, prevSnapshot, newSnapshot ):
+        """
+        This method compares two "snapshots" of bookings and returns a
+        dictionnary containing the attributes that differs, along with their
+        values
+        """
+        result = {}
+        for attr in newSnapshot.keys() :
+            if attr in prevSnapshot :
+                if prevSnapshot[attr] != newSnapshot[attr] :
+                    result[attr] = {"prev": prevSnapshot[attr],
+                                    "new": newSnapshot[attr]}
+            else :
+                # The attribute was created in the meanwhile
+                result[attr] = {"prev": None, "new": newSnapshot[attr]}
+
+        return result
+
+    def getResvModifInfo(self, info, before, after):
+        """
+        This utility method generates the info of the history entry when
+        a reservation is modified.
+        - info : List of str - The list to fill in with the info
+        - before : dict - Snapshot of the reservation before modification
+        - after : dict - Snapshot of the reservation after modification
+        """
+
+        info.append("Booking modified")
+        # Getting the attributes that changed:
+        attrDiff = self._bookingSnapshotsDiff( before, after )
+        # Create the info strings out of the diffs
+        for attr in attrDiff.keys() :
+            try:
+                attrName = self._attrNamesMap[attr]
+            except KeyError:
+                attrName = attr
+            try:
+                prevValue = self._attrFormatMap[attr](attrDiff[attr]["prev"])
+            except KeyError, AttributeError:
+                prevValue = str(attrDiff[attr]["prev"])
+            try:
+                newValue = self._attrFormatMap[attr](attrDiff[attr]["new"])
+            except KeyError, AttributeError:
+                newValue = str(attrDiff[attr]["new"])
+
+            if prevValue == "" :
+                info.append("The %s was set to '%s'" %(attrName, newValue))
+            elif newValue == "" :
+                info.append("The %s was cleared" %attrName)
+            else :
+                info.append("The %s was changed from '%s' to '%s'" %(attrName, prevValue, newValue))
+
 # ============================================================================
 # ================================== TEST ====================================