<?php defined('BASEPATH') or exit('No direct script access allowed'); /* ---------------------------------------------------------------------------- * Easy!Appointments - Online Appointment Scheduler * * @package EasyAppointments * @author A.Tselegidis <alextselegidis@gmail.com> * @copyright Copyright (c) Alex Tselegidis * @license https://opensource.org/licenses/GPL-3.0 - GPLv3 * @link https://easyappointments.org * @since v1.0.0 * ---------------------------------------------------------------------------- */ /** * Booking controller. * * Handles the booking related operations. * * Notice: This file used to have the booking page related code which since v1.5 has now moved to the Booking.php * controller for improved consistency. * * @package Controllers */ class Booking extends EA_Controller { /** * Booking constructor. */ public function __construct() { parent::__construct(); $this->load->model('appointments_model'); $this->load->model('providers_model'); $this->load->model('admins_model'); $this->load->model('secretaries_model'); $this->load->model('categories_model'); $this->load->model('services_model'); $this->load->model('customers_model'); $this->load->model('settings_model'); $this->load->model('consents_model'); $this->load->library('timezones'); $this->load->library('synchronization'); $this->load->library('notifications'); $this->load->library('availability'); $this->load->library('webhooks_client'); } /** * Render the booking page. * * This method creates the appointment book wizard. */ public function index() { if ( ! is_app_installed()) { redirect('installation'); return; } $company_name = setting('company_name'); $company_logo = setting('company_logo'); $company_color = setting('company_color'); $disable_booking = setting('disable_booking'); $google_analytics_code = setting('google_analytics_code'); $matomo_analytics_url = setting('matomo_analytics_url'); if ($disable_booking) { $disable_booking_message = setting('disable_booking_message'); html_vars([ 'show_message' => TRUE, 'page_title' => lang('page_title') . ' ' . $company_name, 'message_title' => lang('booking_is_disabled'), 'message_text' => $disable_booking_message, 'message_icon' => base_url('assets/img/error.png'), 'google_analytics_code' => $google_analytics_code, 'matomo_analytics_url' => $matomo_analytics_url ]); $this->load->view('pages/booking_message'); return; } $available_services = $this->services_model->get_available_services(TRUE); $available_providers = $this->providers_model->get_available_providers(TRUE); foreach ($available_providers as &$available_provider) { // Only expose the required provider data. $this->providers_model->only($available_provider, [ 'id', 'first_name', 'last_name', 'services', 'timezone' ]); } $date_format = setting('date_format'); $time_format = setting('time_format'); $first_weekday = setting('first_weekday'); $display_first_name = setting('display_first_name'); $require_first_name = setting('require_first_name'); $display_last_name = setting('display_last_name'); $require_last_name = setting('require_last_name'); $display_email = setting('display_email'); $require_email = setting('require_email'); $display_phone_number = setting('display_phone_number'); $require_phone_number = setting('require_phone_number'); $display_address = setting('display_address'); $require_address = setting('require_address'); $display_city = setting('display_city'); $require_city = setting('require_city'); $display_zip_code = setting('display_zip_code'); $require_zip_code = setting('require_zip_code'); $display_notes = setting('display_notes'); $require_notes = setting('require_notes'); $display_cookie_notice = setting('display_cookie_notice'); $cookie_notice_content = setting('cookie_notice_content'); $display_terms_and_conditions = setting('display_terms_and_conditions'); $terms_and_conditions_content = setting('terms_and_conditions_content'); $display_privacy_policy = setting('display_privacy_policy'); $privacy_policy_content = setting('privacy_policy_content'); $display_any_provider = setting('display_any_provider'); $display_login_button = setting('display_login_button'); $display_delete_personal_information = setting('display_delete_personal_information'); $book_advance_timeout = setting('book_advance_timeout'); $theme = request('theme', setting('theme', 'default')); if (empty($theme) || ! file_exists(__DIR__ . '/../../assets/css/themes/' . $theme . '.min.css')) { $theme = 'default'; } $timezones = $this->timezones->to_array(); $grouped_timezones = $this->timezones->to_grouped_array(); $appointment_hash = html_vars('appointment_hash'); if ( ! empty($appointment_hash)) { // Load the appointments data and enable the manage mode of the booking page. $manage_mode = TRUE; $results = $this->appointments_model->get(['hash' => $appointment_hash]); if (empty($results)) { html_vars([ 'show_message' => TRUE, 'page_title' => lang('page_title') . ' ' . $company_name, 'message_title' => lang('appointment_not_found'), 'message_text' => lang('appointment_does_not_exist_in_db'), 'message_icon' => base_url('assets/img/error.png'), 'google_analytics_code' => $google_analytics_code, 'matomo_analytics_url' => $matomo_analytics_url ]); $this->load->view('pages/booking_message'); return; } // Make sure the appointment can still be rescheduled. $start_datetime = strtotime($results[0]['start_datetime']); $limit = strtotime('+' . $book_advance_timeout . ' minutes', strtotime('now')); if ($start_datetime < $limit) { $hours = floor($book_advance_timeout / 60); $minutes = ($book_advance_timeout % 60); html_vars([ 'show_message' => TRUE, 'page_title' => lang('page_title') . ' ' . $company_name, 'message_title' => lang('appointment_locked'), 'message_text' => strtr(lang('appointment_locked_message'), [ '{$limit}' => sprintf('%02d:%02d', $hours, $minutes) ]), 'message_icon' => base_url('assets/img/error.png'), 'google_analytics_code' => $google_analytics_code, 'matomo_analytics_url' => $matomo_analytics_url ]); $this->load->view('pages/booking_message'); return; } $appointment = $results[0]; $provider = $this->providers_model->find($appointment['id_users_provider']); $customer = $this->customers_model->find($appointment['id_users_customer']); $customer_token = md5(uniqid(mt_rand(), TRUE)); // Cache the token for 10 minutes. $this->cache->save('customer-token-' . $customer_token, $customer['id'], 600); } else { $manage_mode = FALSE; $customer_token = FALSE; $appointment = NULL; $provider = NULL; $customer = NULL; } script_vars([ 'manage_mode' => $manage_mode, 'available_services' => $available_services, 'available_providers' => $available_providers, 'date_format' => $date_format, 'time_format' => $time_format, 'first_weekday' => $first_weekday, 'display_cookie_notice' => $display_cookie_notice, 'display_any_provider' => setting('display_any_provider'), 'future_booking_limit' => setting('future_booking_limit'), 'appointment_data' => $appointment, 'provider_data' => $provider, 'customer_data' => $customer, ]); html_vars([ 'available_services' => $available_services, 'available_providers' => $available_providers, 'theme' => $theme, 'company_name' => $company_name, 'company_logo' => $company_logo, 'company_color' => $company_color === '#ffffff' ? '' : $company_color, 'date_format' => $date_format, 'time_format' => $time_format, 'first_weekday' => $first_weekday, 'display_first_name' => $display_first_name, 'require_first_name' => $require_first_name, 'display_last_name' => $display_last_name, 'require_last_name' => $require_last_name, 'display_email' => $display_email, 'require_email' => $require_email, 'display_phone_number' => $display_phone_number, 'require_phone_number' => $require_phone_number, 'display_address' => $display_address, 'require_address' => $require_address, 'display_city' => $display_city, 'require_city' => $require_city, 'display_zip_code' => $display_zip_code, 'require_zip_code' => $require_zip_code, 'display_notes' => $display_notes, 'require_notes' => $require_notes, 'display_cookie_notice' => $display_cookie_notice, 'cookie_notice_content' => $cookie_notice_content, 'display_terms_and_conditions' => $display_terms_and_conditions, 'terms_and_conditions_content' => $terms_and_conditions_content, 'display_privacy_policy' => $display_privacy_policy, 'privacy_policy_content' => $privacy_policy_content, 'display_any_provider' => $display_any_provider, 'display_login_button' => $display_login_button, 'display_delete_personal_information' => $display_delete_personal_information, 'google_analytics_code' => $google_analytics_code, 'matomo_analytics_url' => $matomo_analytics_url, 'timezones' => $timezones, 'grouped_timezones' => $grouped_timezones, 'manage_mode' => $manage_mode, 'customer_token' => $customer_token, 'appointment_data' => $appointment, 'provider_data' => $provider, 'customer_data' => $customer, ]); $this->load->view('pages/booking'); } /** * Render the booking page and display the selected appointment. * * This method will call the "index" callback to handle the page rendering. * * @param string $appointment_hash */ public function reschedule(string $appointment_hash) { html_vars(['appointment_hash' => $appointment_hash]); $this->index(); } /** * Get the available appointment hours for the selected date. * * This method answers to an AJAX request. It calculates the available hours for the given service, provider and * date. */ public function get_available_hours() { try { $provider_id = request('provider_id'); $service_id = request('service_id'); $selected_date = request('selected_date'); // Do not continue if there was no provider selected (more likely there is no provider in the system). if (empty($provider_id)) { json_response(); return; } // If manage mode is TRUE then the following we should not consider the selected appointment when // calculating the available time periods of the provider. $exclude_appointment_id = request('manage_mode') ? request('appointment_id') : NULL; // If the user has selected the "any-provider" option then we will need to search for an available provider // that will provide the requested service. $service = $this->services_model->find($service_id); if ($provider_id === ANY_PROVIDER) { $providers = $this->providers_model->get(); $available_hours = []; foreach ($providers as $provider) { if ( ! in_array($service_id, $provider['services'])) { continue; } $provider_available_hours = $this->availability->get_available_hours($selected_date, $service, $provider, $exclude_appointment_id); $available_hours = array_merge($available_hours, $provider_available_hours); } $available_hours = array_unique(array_values($available_hours)); sort($available_hours); $response = $available_hours; } else { $provider = $this->providers_model->find($provider_id); $response = $this->availability->get_available_hours($selected_date, $service, $provider, $exclude_appointment_id); } json_response($response); } catch (Throwable $e) { json_exception($e); } } /** * Search for any provider that can handle the requested service. * * This method will return the database ID of the provider with the most available periods. * * @param int $service_id Service ID * @param string $date Selected date (Y-m-d). * @param string|null $hour Selected hour (H:i). * * @return int|null Returns the ID of the provider that can provide the service at the selected date. * * @throws Exception */ protected function search_any_provider(int $service_id, string $date, string $hour = NULL): ?int { $available_providers = $this->providers_model->get_available_providers(TRUE); $service = $this->services_model->find($service_id); $provider_id = NULL; $max_hours_count = 0; foreach ($available_providers as $provider) { foreach ($provider['services'] as $provider_service_id) { if ($provider_service_id == $service_id) { // Check if the provider is available for the requested date. $available_hours = $this->availability->get_available_hours($date, $service, $provider); if (count($available_hours) > $max_hours_count && (empty($hour) || in_array($hour, $available_hours))) { $provider_id = $provider['id']; $max_hours_count = count($available_hours); } } } } return $provider_id; } /** * Register the appointment to the database. */ public function register() { try { $post_data = request('post_data'); $captcha = request('captcha'); $appointment = $post_data['appointment']; $customer = $post_data['customer']; $manage_mode = filter_var($post_data['manage_mode'], FILTER_VALIDATE_BOOLEAN); if ( ! array_key_exists('address', $customer)) { $customer['address'] = ''; } if ( ! array_key_exists('city', $customer)) { $customer['city'] = ''; } if ( ! array_key_exists('zip_code', $customer)) { $customer['zip_code'] = ''; } if ( ! array_key_exists('notes', $customer)) { $customer['notes'] = ''; } if ( ! array_key_exists('phone_number', $customer)) { $customer['address'] = ''; } // Check appointment availability before registering it to the database. $appointment['id_users_provider'] = $this->check_datetime_availability(); if ( ! $appointment['id_users_provider']) { throw new RuntimeException(lang('requested_hour_is_unavailable')); } $provider = $this->providers_model->find($appointment['id_users_provider']); $service = $this->services_model->find($appointment['id_services']); $require_captcha = (bool)setting('require_captcha'); $captcha_phrase = session('captcha_phrase'); // Validate the CAPTCHA string. if ($require_captcha && strtoupper($captcha_phrase) !== strtoupper($captcha)) { json_response([ 'captcha_verification' => FALSE ]); return; } if ($this->customers_model->exists($customer)) { $customer['id'] = $this->customers_model->find_record_id($customer); } if (empty($appointment['location']) && ! empty($service['location'])) { $appointment['location'] = $service['location']; } if (empty($appointment['color']) && ! empty($service['color'])) { $appointment['color'] = $service['color']; } $customer_ip = $this->input->ip_address(); // Create the consents (if needed). $consent = [ 'first_name' => $customer['first_name'] ?? '-', 'last_name' => $customer['last_name'] ?? '-', 'email' => $customer['email'] ?? '-', 'ip' => $customer_ip, ]; if (setting('display_terms_and_conditions')) { $consent['type'] = 'terms-and-conditions'; $this->consents_model->save($consent); } if (setting('display_privacy_policy')) { $consent['type'] = 'privacy-policy'; $this->consents_model->save($consent); } // Save customer language (the language which is used to render the booking page). $customer['language'] = session('language') ?? config('language'); $this->customers_model->only($customer, [ 'id', 'first_name', 'last_name', 'email', 'phone_number', 'address', 'city', 'state', 'zip_code', 'timezone', 'language', ]); $customer_id = $this->customers_model->save($customer); $customer = $this->customers_model->find($customer_id); $appointment['id_users_customer'] = $customer_id; $appointment['is_unavailability'] = FALSE; $appointment['color'] = $service['color']; $appointment_status_options_json = setting('appointment_status_options', '[]'); $appointment_status_options = json_decode($appointment_status_options_json, TRUE) ?? []; $appointment['status'] = $appointment_status_options[0] ?? NULL; $this->appointments_model->only($appointment, [ 'id', 'start_datetime', 'end_datetime', 'location', 'notes', 'color', 'status', 'is_unavailability', 'id_users_provider', 'id_users_customer', 'id_services', ]); $appointment_id = $this->appointments_model->save($appointment); $appointment = $this->appointments_model->find($appointment_id); $settings = [ 'company_name' => setting('company_name'), 'company_link' => setting('company_link'), 'company_email' => setting('company_email'), 'date_format' => setting('date_format'), 'time_format' => setting('time_format') ]; $this->synchronization->sync_appointment_saved($appointment, $service, $provider, $customer, $settings); $this->notifications->notify_appointment_saved($appointment, $service, $provider, $customer, $settings, $manage_mode); $this->webhooks_client->trigger(WEBHOOK_APPOINTMENT_SAVE, $appointment); $response = [ 'appointment_id' => $appointment['id'], 'appointment_hash' => $appointment['hash'] ]; json_response($response); } catch (Throwable $e) { json_exception($e); } } /** * Check whether the provider is still available in the selected appointment date. * * It is possible that two or more customers select the same appointment date and time concurrently. The app won't * allow this to happen, so one of the two will eventually get the selected date and the other one will have * to choose for another one. * * Use this method just before the customer confirms the appointment registration. If the selected date was reserved * in the meanwhile, the customer must be prompted to select another time. * * @return int|null Returns the ID of the provider that is available for the appointment. * * @throws Exception */ protected function check_datetime_availability(): ?int { $post_data = request('post_data'); $appointment = $post_data['appointment']; $appointment_start = new DateTime($appointment['start_datetime']); $date = $appointment_start->format('Y-m-d'); $hour = $appointment_start->format('H:i'); if ($appointment['id_users_provider'] === ANY_PROVIDER) { $appointment['id_users_provider'] = $this->search_any_provider($appointment['id_services'], $date, $hour); return $appointment['id_users_provider']; } $service = $this->services_model->find($appointment['id_services']); $exclude_appointment_id = $appointment['id'] ?? NULL; $provider = $this->providers_model->find($appointment['id_users_provider']); $available_hours = $this->availability->get_available_hours($date, $service, $provider, $exclude_appointment_id); $is_still_available = FALSE; $appointment_hour = date('H:i', strtotime($appointment['start_datetime'])); foreach ($available_hours as $available_hour) { if ($appointment_hour === $available_hour) { $is_still_available = TRUE; break; } } return $is_still_available ? $appointment['id_users_provider'] : NULL; } /** * Get Unavailable Dates * * Get an array with the available dates of a specific provider, service and month of the year. Provide the * "provider_id", "service_id" and "selected_date" as GET parameters to the request. The "selected_date" parameter * must have the "Y-m-d" format. * * Outputs a JSON string with the unavailability dates. that are unavailability. */ public function get_unavailable_dates() { try { $provider_id = request('provider_id'); $service_id = request('service_id'); $appointment_id = request('appointment_id'); $manage_mode = filter_var(request('manage_mode'), FILTER_VALIDATE_BOOLEAN); $selected_date_string = request('selected_date'); $selected_date = new DateTime($selected_date_string); $number_of_days_in_month = (int)$selected_date->format('t'); $unavailable_dates = []; $provider_ids = $provider_id === ANY_PROVIDER ? $this->search_providers_by_service($service_id) : [$provider_id]; $exclude_appointment_id = $manage_mode ? $appointment_id : NULL; // Get the service record. $service = $this->services_model->find($service_id); for ($i = 1; $i <= $number_of_days_in_month; $i++) { $current_date = new DateTime($selected_date->format('Y-m') . '-' . $i); if ($current_date < new DateTime(date('Y-m-d 00:00:00'))) { // Past dates become immediately unavailability. $unavailable_dates[] = $current_date->format('Y-m-d'); continue; } // Finding at least one slot of availability. foreach ($provider_ids as $current_provider_id) { $provider = $this->providers_model->find($current_provider_id); $available_hours = $this->availability->get_available_hours( $current_date->format('Y-m-d'), $service, $provider, $exclude_appointment_id ); if ( ! empty($available_hours)) { break; } } // No availability amongst all the provider. if (empty($available_hours)) { $unavailable_dates[] = $current_date->format('Y-m-d'); } } if (count($unavailable_dates) === $number_of_days_in_month) { json_response([ 'is_month_unavailable' => TRUE, ]); return; } json_response($unavailable_dates); } catch (Throwable $e) { json_exception($e); } } /** * Search for any provider that can handle the requested service. * * This method will return the database ID of the providers affected to the requested service. * * @param int $service_id The requested service ID. * * @return array Returns the ID of the provider that can provide the requested service. */ protected function search_providers_by_service(int $service_id): array { $available_providers = $this->providers_model->get_available_providers(TRUE); $provider_list = []; foreach ($available_providers as $provider) { foreach ($provider['services'] as $provider_service_id) { if ($provider_service_id === $service_id) { // Check if the provider is affected to the selected service. $provider_list[] = $provider['id']; } } } return $provider_list; } }