Merge pull request #109 from adamspd/90-allow-clients-to-reschedule-their-appointment-by-themselves

Allow clients to reschedule their appointment by themselves

Author: adamspd

appointment/admin.py

@@ -9,8 +9,8 @@
 from django import forms
 from django.contrib import admin
 
-from .models import (
-    Appointment, AppointmentRequest, Config, DayOff, EmailVerificationCode, Service, StaffMember, WorkingHours)
+from .models import (Appointment, AppointmentRequest, AppointmentRescheduleHistory, Config, DayOff,
+                     EmailVerificationCode, Service, StaffMember, WorkingHours)
 
 
 @admin.register(Service)
@@ -76,3 +76,18 @@ class WorkingHoursAdmin(admin.ModelAdmin):
     list_display = ('staff_member', 'day_of_week', 'start_time', 'end_time')
     search_fields = ('day_of_week',)
     list_filter = ('day_of_week', 'start_time', 'end_time')
+
+
+@admin.register(AppointmentRescheduleHistory)
+class AppointmentRescheduleHistoryAdmin(admin.ModelAdmin):
+    list_display = (
+        'appointment_request', 'date', 'start_time',
+        'end_time', 'staff_member', 'reason_for_rescheduling', 'created_at'
+    )
+    search_fields = (
+        'appointment_request__id_request', 'staff_member__user__first_name',
+        'staff_member__user__last_name', 'reason_for_rescheduling'
+    )
+    list_filter = ('appointment_request__service', 'date', 'created_at')
+    date_hierarchy = 'created_at'
+    ordering = ('-created_at',)

appointment/forms.py

@@ -11,7 +11,10 @@
 from phonenumber_field.formfields import PhoneNumberField
 from phonenumber_field.widgets import PhoneNumberPrefixWidget
 
-from .models import Appointment, AppointmentRequest, DayOff, Service, StaffMember, WorkingHours
+from .models import (
+    Appointment, AppointmentRequest, AppointmentRescheduleHistory, DayOff, Service, StaffMember,
+    WorkingHours
+)
 from .utils.db_helpers import get_user_model
 
 
@@ -21,6 +24,15 @@ class Meta:
         fields = ('date', 'start_time', 'end_time', 'service', 'staff_member')
 
 
+class ReschedulingForm(forms.ModelForm):
+    class Meta:
+        model = AppointmentRescheduleHistory
+        fields = ['reason_for_rescheduling']
+        widgets = {
+            'reason_for_rescheduling': forms.Textarea(attrs={'rows': 4, 'placeholder': 'Reason for rescheduling...'}),
+        }
+
+
 class AppointmentForm(forms.ModelForm):
     phone = PhoneNumberField(widget=PhoneNumberPrefixWidget(initial='US'))
 

appointment/models.py

@@ -16,6 +16,7 @@
 from django.core.validators import MaxLengthValidator, MinLengthValidator, MinValueValidator
 from django.db import models
 from django.urls import reverse
+from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
 from phonenumber_field.modelfields import PhoneNumberField
 
@@ -70,6 +71,14 @@ class Service(models.Model):
     image = models.ImageField(upload_to='services/', blank=True, null=True)
     currency = models.CharField(max_length=3, default='USD', validators=[MaxLengthValidator(3), MinLengthValidator(3)])
     background_color = models.CharField(max_length=50, null=True, blank=True, default="")
+    reschedule_limit = models.PositiveIntegerField(
+        default=0,
+        help_text=_("Maximum number of times an appointment can be rescheduled.")
+    )
+    allow_rescheduling = models.BooleanField(
+        default=False,
+        help_text=_("Indicates whether appointments for this service can be rescheduled.")
+    )
 
     # meta data
     created_at = models.DateTimeField(auto_now_add=True)
@@ -88,6 +97,8 @@ def save(self, *args, **kwargs):
         # price shouldn't be negative
         if self.price < 0:
             raise ValidationError(_("Price cannot be negative"))
+        if self.down_payment < 0:
+            raise ValidationError(_("Down payment cannot be negative"))
         if self.background_color == "":
             self.background_color = generate_rgb_color()
         return super().save(*args, **kwargs)
@@ -287,6 +298,7 @@ class AppointmentRequest(models.Model):
     staff_member = models.ForeignKey(StaffMember, on_delete=models.SET_NULL, null=True)
     payment_type = models.CharField(max_length=4, choices=PAYMENT_TYPES, default='full')
     id_request = models.CharField(max_length=100, blank=True, null=True)
+    reschedule_attempts = models.PositiveIntegerField(default=0)
 
     # meta data
     created_at = models.DateTimeField(auto_now_add=True)
@@ -301,7 +313,6 @@ def clean(self):
                 raise ValueError(_("Start time must be before end time"))
             if self.start_time == self.end_time:
                 raise ValueError(_("Start time and end time cannot be the same"))
-
         # Check for valid date
         try:
             # This will raise a ValueError if the date is not valid
@@ -359,6 +370,76 @@ def is_a_paid_service(self):
     def accepts_down_payment(self):
         return self.service.accepts_down_payment()
 
+    def can_be_rescheduled(self):
+        return self.reschedule_attempts < self.service.reschedule_limit
+
+    def increment_reschedule_attempts(self):
+        self.reschedule_attempts += 1
+        self.save(update_fields=['reschedule_attempts'])
+
+    def get_reschedule_history(self):
+        return self.reschedule_histories.all().order_by('-created_at')
+
+
+class AppointmentRescheduleHistory(models.Model):
+    appointment_request = models.ForeignKey(
+        'AppointmentRequest',
+        on_delete=models.CASCADE, related_name='reschedule_histories'
+    )
+    date = models.DateField(help_text=_("The previous date of the appointment before it was rescheduled."))
+    start_time = models.TimeField(
+        help_text=_("The previous start time of the appointment before it was rescheduled.")
+    )
+    end_time = models.TimeField(
+        help_text=_("The previous end time of the appointment before it was rescheduled.")
+    )
+    staff_member = models.ForeignKey(
+        StaffMember, on_delete=models.SET_NULL, null=True,
+        help_text=_("The previous staff member of the appointment before it was rescheduled.")
+    )
+    reason_for_rescheduling = models.TextField(
+        blank=True, null=True,
+        help_text=_("Reason for the appointment reschedule.")
+    )
+    reschedule_status = models.CharField(
+        max_length=10,
+        choices=[('pending', 'Pending'), ('confirmed', 'Confirmed')],
+        default='pending',
+        help_text=_("Indicates the status of the reschedule action.")
+    )
+    id_request = models.CharField(max_length=100, blank=True, null=True)
+
+    # meta data
+    created_at = models.DateTimeField(auto_now_add=True, help_text=_("The date and time the reschedule was recorded."))
+    updated_at = models.DateTimeField(auto_now=True, help_text=_("The date and time the reschedule was confirmed."))
+
+    class Meta:
+        verbose_name = _("Appointment Reschedule History")
+        verbose_name_plural = _("Appointment Reschedule Histories")
+        ordering = ['-created_at']
+
+    def __str__(self):
+        return f"Reschedule history for {self.appointment_request} from {self.date}"
+
+    def save(self, *args, **kwargs):
+        # if no id_request is provided, generate one
+        if self.id_request is None:
+            self.id_request = f"{get_timestamp()}{generate_random_id()}"
+        # date should not be in the past
+        if self.date < datetime.date.today():
+            raise ValidationError(_("Date cannot be in the past"))
+        try:
+            datetime.datetime.strptime(str(self.date), '%Y-%m-%d')
+        except ValueError:
+            raise ValidationError(_("The date is not valid"))
+        return super().save(*args, **kwargs)
+
+    def still_valid(self):
+        # if more than 5 minutes have passed, it is no longer valid
+        now = timezone.now()  # This is offset-aware to match self.created_at
+        delta = now - self.created_at
+        return delta.total_seconds() < 300
+
 
 class Appointment(models.Model):
     """
@@ -578,8 +659,19 @@ class Config(models.Model):
         default="",
         help_text=_("Name of your website."),
     )
-    app_offered_by_label = models.CharField(max_length=255, default=_("Offered by"),
-                                            help_text=_("Label for `Offered by` on the appointment page"))
+    app_offered_by_label = models.CharField(
+        max_length=255,
+        default=_("Offered by"),
+        help_text=_("Label for `Offered by` on the appointment page")
+    )
+    default_reschedule_limit = models.PositiveIntegerField(
+        default=3,
+        help_text=_("Default maximum number of times an appointment can be rescheduled across all services.")
+    )
+    allow_staff_change_on_reschedule = models.BooleanField(
+        default=True,
+        help_text=_("Allows clients to change the staff member when rescheduling an appointment.")
+    )
 
     # meta data
     created_at = models.DateTimeField(auto_now_add=True)

appointment/services.py

@@ -23,7 +23,8 @@
 from appointment.utils.db_helpers import (
     Appointment, AppointmentRequest, EmailVerificationCode, Service, StaffMember, WorkingHours, calculate_slots,
     calculate_staff_slots, check_day_off_for_staff, create_and_save_appointment, create_new_user,
-    day_off_exists_for_date_range, exclude_booked_slots, get_all_appointments, get_all_staff_members,
+    day_off_exists_for_date_range, exclude_booked_slots, exclude_pending_reschedules, get_all_appointments,
+    get_all_staff_members,
     get_appointment_by_id, get_appointments_for_date_and_time, get_staff_member_appointment_list,
     get_staff_member_from_user_id_or_logged_in, get_times_from_config, get_user_by_email,
     get_working_hours_for_staff_and_day, parse_name, update_appointment_reminder, working_hours_exist)
@@ -304,7 +305,7 @@ def get_working_hours_and_days_off_context(request, btn_txt, form_name, form, us
     return context
 
 
-def save_appointment(appt, client_name, client_email, start_time, phone_number, client_address, service_id,
+def save_appointment(appt, client_name, client_email, start_time, phone_number, client_address, service_id, request,
                      want_reminder=False, additional_info=None):
     """Save an appointment's details.
     :return: The modified appointment.
@@ -329,7 +330,7 @@ def save_appointment(appt, client_name, client_email, start_time, phone_number,
 
     # Update reminder here
     update_appointment_reminder(appointment=appt, new_date=appt_request.date, new_start_time=start_time,
-                                want_reminder=want_reminder)
+                                want_reminder=want_reminder, request=request)
 
     appt_request.service = service
     appt_request.start_time = start_time
@@ -345,12 +346,13 @@ def save_appointment(appt, client_name, client_email, start_time, phone_number,
     return appt
 
 
-def save_appt_date_time(appt_start_time, appt_date, appt_id):
+def save_appt_date_time(appt_start_time, appt_date, appt_id, request):
     """Save the date and time of an appointment request.
 
     :param appt_start_time: The start time of the appointment request.
     :param appt_date: The date of the appointment request.
     :param appt_id: The ID of the appointment to modify.
+    :param request: The request object.
     :return: The modified appointment.
     """
     appt = Appointment.objects.get(id=appt_id)
@@ -373,7 +375,8 @@ def save_appt_date_time(appt_start_time, appt_date, appt_id):
         appt_date_obj = appt_date
 
     # Update reminder here
-    update_appointment_reminder(appointment=appt, new_date=appt_date_obj, new_start_time=appt_start_time_obj)
+    update_appointment_reminder(appointment=appt, new_date=appt_date_obj, new_start_time=appt_start_time_obj,
+                                request=request)
 
     # Modify and save appointment request details
     appt_request = appt.appointment_request
@@ -422,6 +425,7 @@ def get_available_slots_for_staff(date, staff_member):
 
     slot_duration = datetime.timedelta(minutes=staff_member.get_slot_duration())
     slots = calculate_staff_slots(date, staff_member)
+    slots = exclude_pending_reschedules(slots, staff_member, date)
     appointments = get_appointments_for_date_and_time(date, working_hours_dict['start_time'],
                                                       working_hours_dict['end_time'], staff_member)
     slots = exclude_booked_slots(appointments, slots, slot_duration)
@@ -594,7 +598,7 @@ def create_new_appointment(data, request):
         'additional_info': data.get("additional_info", ""),
         'paid': False
     }
-    appointment = create_and_save_appointment(appointment_request, client_data, appointment_data)
+    appointment = create_and_save_appointment(appointment_request, client_data, appointment_data, request)
     appointment_list = convert_appointment_to_json(request, [appointment])
 
     return json_response("Appointment created successfully.", custom_data={'appt': appointment_list})
@@ -613,7 +617,8 @@ def update_existing_appointment(data, request):
             client_address=data.get("client_address"),
             service_id=data.get("service_id"),
             want_reminder=want_reminder,
-            additional_info=data.get("additional_info")
+            additional_info=data.get("additional_info"),
+            request=request,
         )
         appointments_json = convert_appointment_to_json(request, [appt])[0]
         return json_response(appt_updated_successfully, custom_data={'appt': appointments_json})

appointment/settings.py

@@ -65,6 +65,6 @@ def check_q_cluster():
         for warning in missing_conf:
             logger.warning(warning)
         return False
-    print(f"Mising conf: {missing_conf}")
+    print(f"Missing conf: {missing_conf}")
     # Both 'django_q' is installed and 'Q_CLUSTER' is configured
     return True

appointment/static/img/dog-family-colored-doodle-drawing.webp

@@ -2,12 +2,13 @@ const calendarEl = document.getElementById('calendar');
 let nextAvailableDateSelector = $('.djangoAppt_next-available-date')
 const body = $('body');
 let nonWorkingDays = [];
-let selectedDate = null;
+let selectedDate = rescheduledDate || null;
 let staffId = $('#staff_id').val() || null;
 let previouslySelectedCell = null;
 
 const calendar = new FullCalendar.Calendar(calendarEl, {
     initialView: 'dayGridMonth',
+    initialDate: selectedDate,
     headerToolbar: {
         left: 'title',
         right: 'prev,today,next',
@@ -43,6 +44,9 @@ const calendar = new FullCalendar.Calendar(calendarEl, {
         selectedDate = info.dateStr;
         getAvailableSlots(info.dateStr, staffId);
     },
+    datesSet: function (info) {
+        highlightSelectedDate();
+    },
     selectAllow: function (info) {
         const day = info.start.getDay();  // Get the day of the week (0 for Sunday, 6 for Saturday)
         if (nonWorkingDays.includes(day)) {
@@ -64,10 +68,20 @@ calendar.setOption('locale', locale);
 $(document).ready(function () {
     staffId = $('#staff_id').val() || null;
     calendar.render();
-    const currentDate = moment.tz(timezone).format('YYYY-MM-DD');
+    const currentDate = rescheduledDate || moment.tz(timezone).format('YYYY-MM-DD');
     getAvailableSlots(currentDate, staffId);
 });
 
+function highlightSelectedDate() {
+    setTimeout(function () {
+        const dateCell = document.querySelector(`.fc-daygrid-day[data-date='${selectedDate}']`);
+        if (dateCell) {
+            dateCell.classList.add('selected-cell');
+            previouslySelectedCell = dateCell;
+        }
+    }, 10);
+}
+
 body.on('click', '.djangoAppt_btn-request-next-slot', function () {
     const serviceId = $(this).data('service-id');
     requestNextAvailableSlot(serviceId);
@@ -91,13 +105,22 @@ body.on('click', '.btn-submit-appointment', function () {
         const date = formattedDate.toISOString().slice(0, 10);
         const endTimeDate = new Date(formattedDate.getTime() + serviceDuration * 60000);
         const endTime = formatTime(endTimeDate);
-
+        const reasonForRescheduling = $('#reason_for_rescheduling').val();
         const form = $('.appointment-form');
-
+        let formAction = rescheduledDate ? appointmentRescheduleURL : appointmentRequestSubmitURL;
+        form.attr('action', formAction);
+        if (!form.find('input[name="appointment_request_id"]').length) {
+            form.append($('<input>', {
+                type: 'hidden',
+                name: 'appointment_request_id',
+                value: appointmentRequestId
+            }));
+        }
         form.append($('<input>', {type: 'hidden', name: 'date', value: date}));
         form.append($('<input>', {type: 'hidden', name: 'start_time', value: startTime}));
         form.append($('<input>', {type: 'hidden', name: 'end_time', value: endTime}));
         form.append($('<input>', {type: 'hidden', name: 'service', value: serviceId}));
+        form.append($('<input>', {type: 'hidden', name: 'reason_for_rescheduling', value: reasonForRescheduling}));
         form.submit();
     } else {
         const warningContainer = $('.warning-message');
@@ -197,7 +220,7 @@ function getAvailableSlots(selectedDate, staffId = null) {
     // Check if 'staffId' is 'none', null, or undefined and display an error message
     if (staffId === 'none' || staffId === null || staffId === undefined) {
         console.log('No staff ID provided, displaying error message.');
-        const errorMessage = $('<p class="djangoAppt_no-availability-text">'+ noStaffMemberSelectedTxt + '</p>');
+        const errorMessage = $('<p class="djangoAppt_no-availability-text">' + noStaffMemberSelectedTxt + '</p>');
         errorMessageContainer.append(errorMessage);
         // Optionally disable the "submit" button here
         $('.btn-submit-appointment').attr('disabled', 'disabled');