allow booking separable rooms in courses, closes #639

Closes #639

Merge request studip/studip!4039

7 files changed, 207 insertions, 125 deletions

diff --git a/lib/models/Course.php b/lib/models/Course.php
index 831fe07..d35c6c3 100644
--- a/lib/models/Course.php
+++ b/lib/models/Course.php
@@ -1997,7 +1997,7 @@ class Course extends SimpleORMap implements Range, PrivacyObject, StudipItem, Fe
         }
         $dates->uasort(function($a, $b) {
             return $a->date - $b->date
-                ?: strnatcasecmp($a->getRoomName(), $b->getRoomName());
+                ?: strnatcasecmp($a->getRoomNames(), $b->getRoomNames());
         });
         return $dates;
     }
diff --git a/lib/models/CourseDate.php b/lib/models/CourseDate.php
index 038a120..87a56e8 100644
--- a/lib/models/CourseDate.php
+++ b/lib/models/CourseDate.php
@@ -29,7 +29,7 @@
  * @property User $author belongs_to User
  * @property Course $course belongs_to Course
  * @property SeminarCycleDate|null $cycle belongs_to SeminarCycleDate
- * @property ResourceBooking $room_booking has_one ResourceBooking
+ * @property ResourceBooking[] $room_bookings has_many ResourceBooking
  * @property SimpleORMapCollection<CourseTopic> $topics has_and_belongs_to_many CourseTopic
  * @property SimpleORMapCollection<Statusgruppen> $statusgruppen has_and_belongs_to_many Statusgruppen
  * @property SimpleORMapCollection<User> $dozenten has_and_belongs_to_many User
@@ -89,7 +89,7 @@ class CourseDate extends SimpleORMap implements PrivacyObject, Event
             'class_name'  => SeminarCycleDate::class,
             'foreign_key' => 'metadate_id'
         ];
-        $config['has_one']['room_booking'] = [
+        $config['has_many']['room_bookings'] = [
             'class_name'        => ResourceBooking::class,
             'foreign_key'       => 'termin_id',
             'assoc_foreign_key' => 'range_id',
@@ -225,25 +225,49 @@ class CourseDate extends SimpleORMap implements PrivacyObject, Event
      *
      * @return String containing the room name
      */
-    public function getRoomName()
+    public function getRoomNames()
     {
-        if (Config::get()->RESOURCES_ENABLE && isset($this->room_booking->resource)) {
-            return $this->getRoom()->name;
+        if (Config::get()->RESOURCES_ENABLE) {
+            $room_names = [];
+            foreach ($this->getRooms() as $room) {
+                $room_names[] = $room->getFullName();
+            }
+            if (!empty($room_names)) {
+                return implode(', ', $room_names);
+            }
         }
+        //The room management is disabled or there are no room bookings for this course date.
+        //Maybe a freetext room name exists.
         return $this->raum ?? '';
     }
 
     /**
-     * Returns the assigned room for this date as an object.
+     * Returns the assigned rooms for this date as objects.
      *
-     * @return Resource Either the object or null if no room is assigned
+     * @return Room[] Either the room objects or an empty array if no rooms are assigned.
      */
-    public function getRoom()
-    {
-        if (Config::get()->RESOURCES_ENABLE && !empty($this->room_booking->resource)) {
-           return $this->room_booking->resource->getDerivedClassInstance();
+    public function getRooms() : array
+    {
+        if (Config::get()->RESOURCES_ENABLE) {
+            $rooms = [];
+            foreach ($this->room_bookings as $booking) {
+                $room = $booking->resource->getDerivedClassInstance();
+                if ($room instanceof Room) {
+                    $rooms[] = $room;
+                }
+            }
+            uasort($rooms, function ($a, $b) {
+                if ($a->name < $b->name) {
+                    return -1;
+                } elseif ($a->name > $b->name) {
+                    return 1;
+                } else {
+                    return 0;
+                }
+            });
+            return $rooms;
         }
-        return null;
+        return [];
     }
 
     /**
@@ -271,32 +295,21 @@ class CourseDate extends SimpleORMap implements PrivacyObject, Event
         $this->raum = '';
         $this->store();
 
-        //If there is already a room assigned, "change" the booking.
-        //Otherwise, create a new one.
-        if ($this->room_booking instanceof ResourceBooking) {
-            $this->room_booking->begin            = $this->date;
-            $this->room_booking->end              = $this->end_time;
-            $this->room_booking->resource_id      = $room->id;
-            $this->room_booking->preparation_time = $preparation_time * 60;
-            $this->room_booking->subsequent_time  = $subsequent_time * 60;
-            $this->room_booking->store();
-        } else {
-            $room->createBooking(
-                User::findCurrent(),
-                $this->id,
-                [['begin' => $this->date, 'end' => $this->end_time]],
-                null,
-                0,
-                null,
-                $preparation_time * 60,
-                '',
-                '',
-                ResourceBooking::TYPE_NORMAL,
-                false,
-                '',
-                $subsequent_time * 60
-            );
-        }
+        $room->createBooking(
+            User::findCurrent(),
+            $this->id,
+            [['begin' => $this->date, 'end' => $this->end_time]],
+            null,
+            0,
+            null,
+            $preparation_time,
+            '',
+            '',
+            ResourceBooking::TYPE_NORMAL,
+            false,
+            '',
+            $subsequent_time
+        );
 
         return true;
     }
@@ -354,13 +367,15 @@ class CourseDate extends SimpleORMap implements PrivacyObject, Event
         }
 
         if (in_array($format, ['include-room', 'long-include-room'])) {
-            $room = $this->getRoom();
-            if ($room) {
-                $string = sprintf('%s <a href="%s" target="_blank">%s</a>',
-                    $string,
-                    $room->getActionURL('booking_plan'),
-                    htmlReady($room->name)
-                );
+            $rooms = $this->getRooms();
+            if ($rooms) {
+                foreach ($rooms as $room) {
+                    $string = sprintf('%s <a href="%s" target="_blank">%s</a>',
+                        $string,
+                        $room->getActionURL('booking_plan'),
+                        htmlReady($room->name)
+                    );
+                }
             } elseif ($this->raum) {
                 //Use the freetext room name:
                 $string .= ' ' . $this->raum;
@@ -402,10 +417,18 @@ class CourseDate extends SimpleORMap implements PrivacyObject, Event
 
         $ex_date = new CourseExDate();
         $ex_date->setData($date);
-        if ($room = $this->getRoom()) {
-            $ex_date['resource_id'] = $room->getId();
-        }
         $ex_date->setId($ex_date->getNewId());
+        if ($rooms = $this->getRooms()) {
+            $db = DBManager::get();
+            $stmt = $db->prepare(
+                "INSERT INTO `ex_termin_rooms` (`ex_termin_id`, `room_id`, `mkdate`, `chdate`)
+                VALUES (:date_id, :room_id, UNIX_TIMESTAMP(), UNIX_TIMESTAMP())"
+            );
+            foreach ($rooms as $room) {
+                $stmt->execute(['date_id' => $ex_date->id, 'room_id' => $room->id]);
+            }
+        }
+
 
         if ($ex_date->store()) {
             //Update some (but not all) relations to the date so that they
@@ -441,7 +464,7 @@ class CourseDate extends SimpleORMap implements PrivacyObject, Event
     public function store()
     {
         // load room-booking, if any
-        $this->room_booking;
+        $this->room_bookings;
 
         $cache = \Studip\Cache\Factory::getCache();
         $cache->expire('course/undecorated_data/'. $this->range_id);
@@ -489,8 +512,8 @@ class CourseDate extends SimpleORMap implements PrivacyObject, Event
             $warnings[] = _('Diesem Termin ist ein Thema zugeordnet.');
         }
 
-        if (Config::get()->RESOURCES_ENABLE && $this->getRoom()) {
-            $warnings[] = _('Dieser Termin hat eine Raumbuchung, welche mit dem Termin gelöscht wird.');
+        if (Config::get()->RESOURCES_ENABLE && $this->getRooms()) {
+            $warnings[] = _('Dieser Termin hat Raumbuchungen, die mit dem Termin gelöscht werden.');
         }
 
         return $warnings;
@@ -628,7 +651,7 @@ class CourseDate extends SimpleORMap implements PrivacyObject, Event
 
     public function getLocation(): string
     {
-        return $this->getRoomName();
+        return $this->getRoomNames();
     }
 
     public function getUniqueId(): string
diff --git a/lib/models/CourseExDate.php b/lib/models/CourseExDate.php
index ee38f2f..59a7947 100644
--- a/lib/models/CourseExDate.php
+++ b/lib/models/CourseExDate.php
@@ -97,7 +97,7 @@ class CourseExDate extends SimpleORMap implements PrivacyObject, Event
      *
      * @return String that is always empty
      */
-    public function getRoomName()
+    public function getRoomNames()
     {
         return '';
     }
@@ -107,9 +107,9 @@ class CourseExDate extends SimpleORMap implements PrivacyObject, Event
      *
      * @return null. always. canceled dates need no room.
      */
-    public function getRoom()
+    public function getRooms()
     {
-        return null;
+        return [];
     }
 
     /**
@@ -339,7 +339,7 @@ class CourseExDate extends SimpleORMap implements PrivacyObject, Event
 
     public function getLocation(): string
     {
-        return $this->getRoomName();
+        return $this->getRoomNames();
     }
 
     public function getUniqueId(): string
diff --git a/lib/models/SeminarCycleDate.php b/lib/models/SeminarCycleDate.php
index 4f7b6dc..e400665 100644
--- a/lib/models/SeminarCycleDate.php
+++ b/lib/models/SeminarCycleDate.php
@@ -539,17 +539,19 @@ class SeminarCycleDate extends SimpleORMap
             $date->date = mktime(date('G', strtotime($this->start_time)), date('i', strtotime($this->start_time)), 0, date('m', $tos), date('d', $tos), date('Y', $tos)) + $day * 24 * 60 * 60;
             $date->end_time = mktime(date('G', strtotime($this->end_time)), date('i', strtotime($this->end_time)), 0, date('m', $toe), date('d', $toe), date('Y', $toe)) + $day * 24 * 60 * 60;
 
-            if ($date instanceof CourseDate && !is_null($date->room_booking)) {
+            if ($date instanceof CourseDate && !empty($date->room_bookings)) {
                 //Check if the time range of the date has decreased and did not exceed the
-                //boundaries of the existing room booking. In that case, the room booking is shortened.
-                if ($date->date < $tos || $date->end_time > $toe) {
-                    //The room booking must be deleted.
-                    $date->room_booking->delete();
-                } else {
-                    //The room booking must be shortened.
-                    $date->room_booking->begin = $date->date;
-                    $date->room_booking->end = $date->end_time;
-                    $date->room_booking->store();
+                //boundaries of the existing room booking. In that case, the room bookings are shortened.
+                foreach ($date->room_bookings as $room_booking) {
+                    if ($date->date < $tos || $date->end_time > $toe) {
+                        //The room booking must be deleted.
+                        $room_booking->delete();
+                    } else {
+                        //The room booking must be shortened.
+                        $room_booking->begin = $date->date;
+                        $room_booking->end = $date->end_time;
+                        $room_booking->store();
+                    }
                 }
             }
 
@@ -1037,7 +1039,7 @@ class SeminarCycleDate extends SimpleORMap
         $booked_c = 0;
 
         foreach ($this->dates as $course_date) {
-            if ($course_date->room_booking) {
+            if (count($course_date->room_bookings)) {
                 $booked_c++;
             }
         }
@@ -1088,7 +1090,7 @@ class SeminarCycleDate extends SimpleORMap
             //List the dates that have no room booking:
             $unbooked_dates = [];
             foreach ($this->dates as $course_date) {
-                if (!$course_date->room_booking) {
+                if (empty($course_date->room_bookings)) {
                     $unbooked_dates[] = $course_date;
                 }
             }
diff --git a/lib/models/resources/Resource.php b/lib/models/resources/Resource.php
index 8a7fd06..9730128 100644
--- a/lib/models/resources/Resource.php
+++ b/lib/models/resources/Resource.php
@@ -93,6 +93,13 @@ class Resource extends SimpleORMap implements StudipItem
             'foreign_key' => 'parent_id'
         ];
 
+        $config['has_and_belongs_to_many']['separable_room'] = [
+            'class_name'        => SeparableRoom::class,
+            'thru_table'        => 'separable_room_parts',
+            'thru_key'          => 'room_id',
+            'thru_assoc_key'    => 'separable_room_id'
+        ];
+
         $config['i18n_fields']['description'] = true;
 
         $config['additional_fields']['class_name']        = ['category', 'class_name'];
diff --git a/lib/models/resources/ResourceBooking.php b/lib/models/resources/ResourceBooking.php
index 805cff0..ef98e71 100644
--- a/lib/models/resources/ResourceBooking.php
+++ b/lib/models/resources/ResourceBooking.php
@@ -435,24 +435,7 @@ class ResourceBooking extends SimpleORMap implements PrivacyObject, Studip\Calen
         }
         $this->deleteOverlappingReservations();
 
-        if (parent::store()) {
-            //Check if the booking is bound to a course date.
-            //If this is the case, check for existing bookings
-            //and delete them, so that there is only one booking
-            //for a course date:
-            $course_date_exists = CourseDate::exists($this->range_id);
-            if ($course_date_exists) {
-                self::deleteBySql(
-                    'range_id = :range_id AND id <> :this_id',
-                    [
-                        'this_id' => $this->id,
-                        'range_id' => $this->range_id
-                    ]
-                );
-            }
-            return true;
-        }
-        return false;
+        return parent::store();
     }
 
 
diff --git a/lib/models/resources/ResourceRequest.php b/lib/models/resources/ResourceRequest.php
index 2d08ee7..12a1e41 100644
--- a/lib/models/resources/ResourceRequest.php
+++ b/lib/models/resources/ResourceRequest.php
@@ -983,11 +983,17 @@ class ResourceRequest extends SimpleORMap implements PrivacyObject, Studip\Calen
                     ];
                 }
 
-                $date = CourseDate::find($appointment->appointment_id);
+                $date         = CourseDate::find($appointment->appointment_id);
+                $booked_rooms = [];
+                $booking_ids  = [];
+                foreach ($date->room_bookings as $booking) {
+                    $booked_rooms[] = $booking->resource_id;
+                    $booking_ids[]  = $booking->id;
+                }
                 $interval['range']                 = 'CourseDate';
                 $interval['range_id']              = $appointment->appointment_id;
-                $interval['booked_room']           = $date->room_booking->resource_id ?? '';
-                $interval['booking_id']            = $date->room_booking->id ?? '';
+                $interval['booked_rooms']          = $booked_rooms;
+                $interval['booking_ids']           = $booking_ids;
                 $time_intervals['']['intervals'][] = $interval;
             }
 
@@ -1012,11 +1018,17 @@ class ResourceRequest extends SimpleORMap implements PrivacyObject, Studip\Calen
                 ];
             }
 
-            $date = CourseDate::find($this->termin_id);
-            $interval['range']       = 'CourseDate';
-            $interval['range_id']    = $this->termin_id;
-            $interval['booked_room'] = $date->room_booking->resource_id ?? null;
-            $interval['booking_id']  = $date->room_booking->id ?? null;
+            $date         = CourseDate::find($this->termin_id);
+            $booked_rooms = [];
+            $booking_ids  = [];
+            foreach ($date->room_bookings as $booking) {
+                $booked_rooms[] = $booking->resource_id;
+                $booking_ids[]  = $booking->id;
+            }
+            $interval['range']        = 'CourseDate';
+            $interval['range_id']     = $this->termin_id;
+            $interval['booked_rooms'] = $booked_rooms;
+            $interval['booking_ids']  = $booking_ids;
 
             if (!empty($interval)) {
                 return [
@@ -1050,10 +1062,16 @@ class ResourceRequest extends SimpleORMap implements PrivacyObject, Studip\Calen
                         'end'   => $date->end_time
                     ];
                 }
+                $booked_rooms = [];
+                $booking_ids  = [];
+                foreach ($date->room_bookings as $booking) {
+                    $booked_rooms[] = $booking->resource_id;
+                    $booking_ids[]  = $booking->id;
+                }
                 $interval['range']                                 = 'CourseDate';
                 $interval['range_id']                              = $date->id;
-                $interval['booked_room']                           = $date->room_booking->resource_id ?? null;
-                $interval['booking_id']                            = $date->room_booking->id ?? null;
+                $interval['booked_rooms']                          = $booked_rooms;
+                $interval['booking_ids']                           = $booking_ids;
                 $time_intervals[$this->metadate_id]['intervals'][] = $interval;
             }
             return $time_intervals;
@@ -1081,10 +1099,16 @@ class ResourceRequest extends SimpleORMap implements PrivacyObject, Studip\Calen
                                     'end'   => $date->end_time
                                 ];
                             }
+                            $booked_rooms = [];
+                            $booking_ids  = [];
+                            foreach ($date->room_bookings as $booking) {
+                                $booked_rooms[] = $booking->resource_id;
+                                $booking_ids[]  = $booking->id;
+                            }
                             $interval['range'] = CourseDate::class;
-                            $interval['range_id'] = $date->id;
-                            $interval['booked_room'] = $date->room_booking->resource_id ?? null;
-                            $interval['booking_id'] = $date->room_booking->id ?? null;
+                            $interval['range_id']     = $date->id;
+                            $interval['booked_rooms'] = $booked_rooms;
+                            $interval['booking_ids']  = $booking_ids;
                             $time_intervals[$cycle->id]['intervals'][] = $interval;
                         }
                     }
@@ -1114,10 +1138,17 @@ class ResourceRequest extends SimpleORMap implements PrivacyObject, Studip\Calen
                             'end'   => $date->end_time
                         ];
                     }
+
+                    $booked_rooms = [];
+                    $booking_ids  = [];
+                    foreach ($date->room_bookings as $booking) {
+                        $booked_rooms[] = $booking->resource_id;
+                        $booking_ids[]  = $booking->id;
+                    }
                     $interval['range']                 = 'CourseDate';
                     $interval['range_id']              = $date->id;
-                    $interval['booked_room']           = $date->room_booking->resource_id ?? null;
-                    $interval['booking_id']            = $date->room_booking->id ?? null;
+                    $interval['booked_rooms']          = $booked_rooms;
+                    $interval['booking_ids']           = $booking_ids;
                     $time_intervals['']['intervals'][] = $interval;
                 }
 
@@ -1141,8 +1172,10 @@ class ResourceRequest extends SimpleORMap implements PrivacyObject, Studip\Calen
                     'end'   => $this->end
                 ];
             }
-            $interval['range']    = 'User';
-            $interval['range_id'] = $this->user_id;
+            $interval['range']        = 'User';
+            $interval['range_id']     = $this->user_id;
+            $interval['booked_rooms'] = [];
+            $interval['booking_ids']  = [];
 
             return [
                 '' => [
@@ -1209,11 +1242,16 @@ class ResourceRequest extends SimpleORMap implements PrivacyObject, Studip\Calen
                 }
                 if ($with_range) {
                     $date = CourseDate::find($appointment->appointment_id);
-
-                    $interval['range']       = ResourceRequestAppointment::class;
-                    $interval['range_id']    = $appointment->appointment_id;
-                    $interval['booked_room'] = $date->room_booking->resource_id ?? null;
-                    $interval['booking_id']  = $date->room_booking->id ?? null;
+                    $booked_rooms = [];
+                    $booking_ids  = [];
+                    foreach ($date->room_bookings as $booking) {
+                        $booked_rooms[] = $booking->resource_id;
+                        $booking_ids[]  = $booking->id;
+                    }
+                    $interval['range']        = ResourceRequestAppointment::class;
+                    $interval['range_id']     = $appointment->appointment_id;
+                    $interval['booked_rooms'] = $booked_rooms;
+                    $interval['booking_ids']  = $booking_ids;
 
                 }
                 $time_intervals[] = $interval;
@@ -1235,10 +1273,18 @@ class ResourceRequest extends SimpleORMap implements PrivacyObject, Studip\Calen
                 ];
             }
             if ($with_range) {
-                $interval['range']       = CourseDate::class;
-                $interval['range_id']    = $this->termin_id;
-                $interval['booked_room'] = $this->date->room_booking->resource_id ?? null;
-                $interval['booking_id']  = $this->date->room_booking->id ?? null;
+                if ($this->date->room_bookings) {
+                    $booked_rooms = [];
+                    $booking_ids  = [];
+                    foreach ($this->date->room_bookings as $booking) {
+                        $booked_rooms[] = $booking->resource_id;
+                        $booking_ids[]  = $booking->id;
+                    }
+                }
+                $interval['range']        = CourseDate::class;
+                $interval['range_id']     = $this->termin_id;
+                $interval['booked_rooms'] = $booked_rooms;
+                $interval['booking_ids']  = $booking_ids;
             }
             return [$interval];
         } elseif ($this->metadate_id) {
@@ -1259,10 +1305,19 @@ class ResourceRequest extends SimpleORMap implements PrivacyObject, Studip\Calen
                     ];
                 }
                 if ($with_range) {
-                    $interval['range']       = CourseDate::class;
-                    $interval['range_id']    = $date->id;
-                    $interval['booked_room'] = $date->room_booking->resource_id ?? null;
-                    $interval['booking_id']  = $date->room_booking->id ?? null;
+                    if ($this->date->room_bookings) {
+                        $booked_rooms = [];
+                        $booking_ids  = [];
+                        foreach ($this->date->room_bookings as $booking) {
+                            $booked_rooms[] = $booking->resource_id;
+                            $booking_ids[]  = $booking->id;
+                        }
+                    }
+
+                    $interval['range']        = CourseDate::class;
+                    $interval['range_id']     = $date->id;
+                    $interval['booked_rooms'] = $booked_rooms;
+                    $interval['booking_ids']  = $booking_ids;
                 }
                 $time_intervals[] = $interval;
             }
@@ -1286,10 +1341,19 @@ class ResourceRequest extends SimpleORMap implements PrivacyObject, Studip\Calen
                         ];
                     }
                     if ($with_range) {
-                        $interval['range']       = CourseDate::class;
-                        $interval['range_id']    = $date->id;
-                        $interval['booked_room'] = $date->room_booking->resource_id ?? null;
-                        $interval['booking_id']  = $date->room_booking->id ?? null;
+                        if ($this->date->room_bookings) {
+                            $booked_rooms = [];
+                            $booking_ids  = [];
+                            foreach ($this->date->room_bookings as $booking) {
+                                $booked_rooms[] = $booking->resource_id;
+                                $booking_ids[]  = $booking->id;
+                            }
+                        }
+
+                        $interval['range']        = CourseDate::class;
+                        $interval['range_id']     = $date->id;
+                        $interval['booked_rooms'] = $booked_rooms;
+                        $interval['booking_ids']  = $booking_ids;
                     }
                     $time_intervals[] = $interval;
                 }
@@ -1333,11 +1397,14 @@ class ResourceRequest extends SimpleORMap implements PrivacyObject, Studip\Calen
 
             if ($interval['range'] === 'CourseDate') {
                 $date = call_user_func([$interval['range'], 'find'], $interval['range_id']);
-                if ($date->room_booking) {
-                    $room_obj = Room::find($date->room_booking->resource_id);
-                    if ($room_obj) {
-                        $room = $room_obj->name;
+                if ($date->room_bookings) {
+                    $room_names = [];
+                    foreach ($date->room_bookings as $room_booking) {
+                        if (!empty($room_booking->resource)) {
+                            $room_names[] = $room_booking->resource->name;
+                        }
                     }
+                    $room = implode(', ', $room_names);
                 }
             }