From 247166f28b81e53c1ebd90285969ca92b67a872f Mon Sep 17 00:00:00 2001 From: msquare Date: Fri, 11 Nov 2016 16:34:23 +0100 Subject: improve code of user settings --- includes/model/User_model.php | 65 ++++++- includes/pages/user_settings.php | 371 ++++++++++++++++++--------------------- includes/sys_template.php | 6 +- includes/view/User_view.php | 86 +++++++-- 4 files changed, 315 insertions(+), 213 deletions(-) (limited to 'includes') diff --git a/includes/model/User_model.php b/includes/model/User_model.php index 4d7bbb65..d3597f54 100644 --- a/includes/model/User_model.php +++ b/includes/model/User_model.php @@ -41,7 +41,8 @@ function User_update($user) { `Hometown`='" . sql_escape($user['Hometown']) . "', `got_voucher`='" . sql_escape($user['got_voucher']) . "', `arrival_date`='" . sql_escape($user['arrival_date']) . "', - `planned_arrival_date`='" . sql_escape($user['planned_arrival_date']) . "' + `planned_arrival_date`='" . sql_escape($user['planned_arrival_date']) . "', + `planned_departure_date`='" . sql_escape($user['planned_departure_date']) . "' WHERE `UID`='" . sql_escape($user['UID']) . "'"); } @@ -162,6 +163,68 @@ function User_validate_Nick($nick) { return preg_replace("/([^a-z0-9üöäß. _+*-]{1,})/ui", '', $nick); } +/** + * Validate the planned arrival date + * + * @param int $planned_arrival_date + * Unix timestamp + * @return ValidationResult + */ +function User_validate_planned_arrival_date($planned_arrival_date) { + if ($planned_arrival_date == null) { + // null is not okay + return new ValidationResult(false, time()); + } + $event_config = EventConfig(); + if ($event_config == null) { + // Nothing to validate against + return new ValidationResult(true, $planned_arrival_date); + } + if (isset($event_config['buildup_start_date']) && $planned_arrival_date < $event_config['buildup_start_date']) { + // Planned arrival can not be before buildup start date + return new ValidationResult(false, $event_config['buildup_start_date']); + } + if (isset($event_config['teardown_end_date']) && $planned_arrival_date > $event_config['teardown_end_date']) { + // Planned arrival can not be after teardown end date + return new ValidationResult(false, $event_config['teardown_end_date']); + } + return new ValidationResult(true, $planned_arrival_date); +} + +/** + * Validate the planned departure date + * + * @param int $planned_arrival_date + * Unix timestamp + * @param int $planned_departure_date + * Unix timestamp + * @return ValidationResult + */ +function User_validate_planned_departure_date($planned_arrival_date, $planned_departure_date) { + if ($planned_departure_date == null) { + // null is okay + return new ValidationResult(true, null); + } + if ($planned_arrival_date > $planned_departure_date) { + // departure cannot be before arrival + return new ValidationResult(false, $planned_arrival_date); + } + $event_config = EventConfig(); + if ($event_config == null) { + // Nothing to validate against + return new ValidationResult(true, $planned_departure_date); + } + if (isset($event_config['buildup_start_date']) && $planned_departure_date < $event_config['buildup_start_date']) { + // Planned arrival can not be before buildup start date + return new ValidationResult(false, $event_config['buildup_start_date']); + } + if (isset($event_config['teardown_end_date']) && $planned_departure_date > $event_config['teardown_end_date']) { + // Planned arrival can not be after teardown end date + return new ValidationResult(false, $event_config['teardown_end_date']); + } + return new ValidationResult(true, $planned_departure_date); +} + /** * Returns user by id. * diff --git a/includes/pages/user_settings.php b/includes/pages/user_settings.php index b92f7bd3..600550d4 100644 --- a/includes/pages/user_settings.php +++ b/includes/pages/user_settings.php @@ -4,219 +4,196 @@ function settings_title() { return _("Settings"); } -function user_settings() { - global $enable_tshirt_size, $tshirt_sizes, $themes, $locales; - global $user; +/** + * Change user main attributes (name, dates, etc.) + * + * @param User $user_source + * The user + */ +function user_settings_main($user_source, $tshirt_sizes) { + $valid = true; - $msg = ""; - $nick = $user['Nick']; - $lastname = $user['Name']; - $prename = $user['Vorname']; - $age = $user['Alter']; - $tel = $user['Telefon']; - $dect = $user['DECT']; - $mobile = $user['Handy']; - $mail = $user['email']; - $email_shiftinfo = $user['email_shiftinfo']; - $email_by_human_allowed = $user['email_by_human_allowed']; - $jabber = $user['jabber']; - $hometown = $user['Hometown']; - $tshirt_size = $user['Size']; - $selected_theme = $user['color']; - $selected_language = $user['Sprache']; - $planned_arrival_date = $user['planned_arrival_date']; - $planned_departure_date = $user['planned_departure_date']; - - if (isset($_REQUEST['submit'])) { - $valid = true; - - if (isset($_REQUEST['mail']) && strlen(strip_request_item('mail')) > 0) { - $mail = strip_request_item('mail'); - if (! check_email($mail)) { - $valid = false; - $msg .= error(_("E-mail address is not correct."), true); - } - } else { + if (isset($_REQUEST['mail']) && strlen(strip_request_item('mail')) > 0) { + $user_source['email'] = strip_request_item('mail'); + if (! check_email($user_source['email'])) { $valid = false; - $msg .= error(_("Please enter your e-mail."), true); + error(_("E-mail address is not correct.")); } - - $email_shiftinfo = isset($_REQUEST['email_shiftinfo']); - $email_by_human_allowed = isset($_REQUEST['email_by_human_allowed']); - - if (isset($_REQUEST['jabber']) && strlen(strip_request_item('jabber')) > 0) { - $jabber = strip_request_item('jabber'); - if (! check_email($jabber)) { - $valid = false; - $msg .= error(_("Please check your jabber account information."), true); - } + } else { + $valid = false; + error(_("Please enter your e-mail.")); + } + + $user_source['email_shiftinfo'] = isset($_REQUEST['email_shiftinfo']); + $user_source['email_by_human_allowed'] = isset($_REQUEST['email_by_human_allowed']); + + if (isset($_REQUEST['jabber']) && strlen(strip_request_item('jabber')) > 0) { + $user_source['jabber'] = strip_request_item('jabber'); + if (! check_email($user_source['jabber'])) { + $valid = false; + error(_("Please check your jabber account information.")); } - - if (isset($_REQUEST['tshirt_size']) && isset($tshirt_sizes[$_REQUEST['tshirt_size']])) { - $tshirt_size = $_REQUEST['tshirt_size']; - } elseif ($enable_tshirt_size) { + } + + if (isset($_REQUEST['tshirt_size']) && isset($tshirt_sizes[$_REQUEST['tshirt_size']])) { + $user_source['Size'] = $_REQUEST['tshirt_size']; + } elseif ($enable_tshirt_size) { + $valid = false; + } + + if (isset($_REQUEST['planned_arrival_date']) && $tmp = parse_date("Y-m-d", $_REQUEST['planned_arrival_date'])) { + $result = User_validate_planned_arrival_date($tmp); + $user_source['planned_arrival_date'] = $result->getValue(); + if (! $result->isValid()) { $valid = false; + error(_("Please enter your planned date of arrival. It should be after the buildup start date and before teardown end date.")); } - - if (isset($_REQUEST['planned_arrival_date']) && $tmp = parse_date("Y-m-d", $_REQUEST['planned_arrival_date'])) { - $planned_arrival_date = $tmp; - } else { + } + + if (isset($_REQUEST['planned_departure_date']) && $tmp = parse_date("Y-m-d", $_REQUEST['planned_departure_date'])) { + $result = User_validate_planned_departure_date($user_source['planned_arrival_date'], $tmp); + $user_source['planned_departure_date'] = $result->getValue(); + if (! $result->isValid()) { $valid = false; - $msg .= error(_("Please enter your planned date of arrival."), true); + error(_("Please enter your planned date of departure. It should be after your planned arrival date and after buildup start date and before teardown end date.")); } + } + + // Trivia + if (isset($_REQUEST['lastname'])) { + $user_source['Name'] = strip_request_item('lastname'); + } + if (isset($_REQUEST['prename'])) { + $user_source['Vorname'] = strip_request_item('prename'); + } + if (isset($_REQUEST['age']) && preg_match("/^[0-9]{0,4}$/", $_REQUEST['age'])) { + $user_source['Alter'] = strip_request_item('age'); + } + if (isset($_REQUEST['tel'])) { + $user_source['Telefon'] = strip_request_item('tel'); + } + if (isset($_REQUEST['dect'])) { + $user_source['DECT'] = strip_request_item('dect'); + } + if (isset($_REQUEST['mobile'])) { + $user_source['Handy'] = strip_request_item('mobile'); + } + if (isset($_REQUEST['hometown'])) { + $user_source['Hometown'] = strip_request_item('hometown'); + } + + if ($valid) { + User_update($user_source); + success(_("Settings saved.")); + redirect(page_link_to('user_settings')); + } +} + +/** + * Change user password. + * + * @param User $user_source + * The user + */ +function user_settings_password($user_source) { + $valid = true; + + if (! isset($_REQUEST['password']) || ! verify_password($_REQUEST['password'], $user_source['Passwort'], $user_source['UID'])) { + error(_("-> not OK. Please try again.")); + } elseif (strlen($_REQUEST['new_password']) < MIN_PASSWORD_LENGTH) { + error(_("Your password is to short (please use at least 6 characters).")); + } elseif ($_REQUEST['new_password'] != $_REQUEST['new_password2']) { + error(_("Your passwords don't match.")); + } elseif (set_password($user_source['UID'], $_REQUEST['new_password'])) { + success(_("Password saved.")); + } else { + error(_("Failed setting password.")); + } + redirect(page_link_to('user_settings')); +} + +/** + * Change user theme + * + * @param User $user_sources + * The user + * @param array $themes + * List of available themes + */ +function user_settings_theme($user_sources, $themes) { + $valid = true; + + if (isset($_REQUEST['theme']) && isset($themes[$_REQUEST['theme']])) { + $user_source['color'] = $_REQUEST['theme']; + } else { + $valid = false; + } + + if ($valid) { + sql_query("UPDATE `User` SET `color`='" . sql_escape($user_source['color']) . "' WHERE `UID`='" . sql_escape($user_source['UID']) . "'"); - if (isset($_REQUEST['planned_departure_date']) && $_REQUEST['planned_departure_date'] != '') { - if ($tmp = parse_date("Y-m-d", $_REQUEST['planned_departure_date'])) { - $planned_departure_date = $tmp; - } else { - $valid = false; - $msg .= error(_("Please enter your planned date of departure."), true); - } - } else { - $planned_departure_date = null; - } + success(_("Theme changed.")); + redirect(page_link_to('user_settings')); + } +} + +/** + * Change use locale + * + * @param User $user_source + * The user + * @param array $locales + * List of available locales + */ +function user_settings_locale($user_source, $locales) { + $valid = true; + + if (isset($_REQUEST['language']) && isset($locales[$_REQUEST['language']])) { + $user_source['Sprache'] = $_REQUEST['language']; + } else { + $valid = false; + } + + if ($valid) { + sql_query("UPDATE `User` SET `Sprache`='" . sql_escape($user_source['Sprache']) . "' WHERE `UID`='" . sql_escape($user_source['UID']) . "'"); + $_SESSION['locale'] = $user_source['Sprache']; - // Trivia - if (isset($_REQUEST['lastname'])) { - $lastname = strip_request_item('lastname'); - } - if (isset($_REQUEST['prename'])) { - $prename = strip_request_item('prename'); - } - if (isset($_REQUEST['age']) && preg_match("/^[0-9]{0,4}$/", $_REQUEST['age'])) { - $age = strip_request_item('age'); - } - if (isset($_REQUEST['tel'])) { - $tel = strip_request_item('tel'); - } - if (isset($_REQUEST['dect'])) { - $dect = strip_request_item('dect'); - } - if (isset($_REQUEST['mobile'])) { - $mobile = strip_request_item('mobile'); - } - if (isset($_REQUEST['hometown'])) { - $hometown = strip_request_item('hometown'); + success("Language changed."); + redirect(page_link_to('user_settings')); + } +} + +/** + * Main user settings page/controller + */ +function user_settings() { + global $enable_tshirt_size, $tshirt_sizes, $themes, $locales; + global $user; + + $buildup_start_date = null; + $teardown_end_date = null; + $event_config = EventConfig(); + if ($event_config != null) { + if (isset($event_config['buildup_start_date'])) { + $buildup_start_date = $event_config['buildup_start_date']; } - - if ($valid) { - sql_query(" - UPDATE `User` SET - `Nick`='" . sql_escape($nick) . "', - `Vorname`='" . sql_escape($prename) . "', - `Name`='" . sql_escape($lastname) . "', - `Alter`='" . sql_escape($age) . "', - `Telefon`='" . sql_escape($tel) . "', - `DECT`='" . sql_escape($dect) . "', - `Handy`='" . sql_escape($mobile) . "', - `email`='" . sql_escape($mail) . "', - `email_shiftinfo`=" . sql_bool($email_shiftinfo) . ", - `email_by_human_allowed`=" . sql_bool($email_by_human_allowed) . ", - `jabber`='" . sql_escape($jabber) . "', - `Size`='" . sql_escape($tshirt_size) . "', - `Hometown`='" . sql_escape($hometown) . "', - `planned_arrival_date`='" . sql_escape($planned_arrival_date) . "', - `planned_departure_date`=" . sql_null($planned_departure_date) . " - WHERE `UID`='" . sql_escape($user['UID']) . "'"); - - success(_("Settings saved.")); - redirect(page_link_to('user_settings')); + if (isset($event_config['teardown_end_date'])) { + $teardown_end_date = $event_config['teardown_end_date']; } + } + + $user_source = $user; + + if (isset($_REQUEST['submit'])) { + user_settings_main($user_source, $tshirt_sizes); } elseif (isset($_REQUEST['submit_password'])) { - $valid = true; - - if (! isset($_REQUEST['password']) || ! verify_password($_REQUEST['password'], $user['Passwort'], $user['UID'])) { - $msg .= error(_("-> not OK. Please try again."), true); - } elseif (strlen($_REQUEST['new_password']) < MIN_PASSWORD_LENGTH) { - $msg .= error(_("Your password is to short (please use at least 6 characters)."), true); - } elseif ($_REQUEST['new_password'] != $_REQUEST['new_password2']) { - $msg .= error(_("Your passwords don't match."), true); - } elseif (set_password($user['UID'], $_REQUEST['new_password'])) { - success(_("Password saved.")); - } else { - error(_("Failed setting password.")); - } - redirect(page_link_to('user_settings')); + user_settings_password($user_source); } elseif (isset($_REQUEST['submit_theme'])) { - $valid = true; - - if (isset($_REQUEST['theme']) && isset($themes[$_REQUEST['theme']])) { - $selected_theme = $_REQUEST['theme']; - } else { - $valid = false; - } - - if ($valid) { - sql_query("UPDATE `User` SET `color`='" . sql_escape($selected_theme) . "' WHERE `UID`='" . sql_escape($user['UID']) . "'"); - - success(_("Theme changed.")); - redirect(page_link_to('user_settings')); - } + user_settings_theme($user_sources, $themes); } elseif (isset($_REQUEST['submit_language'])) { - $valid = true; - - if (isset($_REQUEST['language']) && isset($locales[$_REQUEST['language']])) { - $selected_language = $_REQUEST['language']; - } else { - $valid = false; - } - - if ($valid) { - sql_query("UPDATE `User` SET `Sprache`='" . sql_escape($selected_language) . "' WHERE `UID`='" . sql_escape($user['UID']) . "'"); - $_SESSION['locale'] = $selected_language; - - success("Language changed."); - redirect(page_link_to('user_settings')); - } + user_settings_locale($user_source, $locales); } - return page_with_title(settings_title(), [ - $msg, - msg(), - div('row', [ - div('col-md-6', [ - form([ - form_info('', _("Here you can change your user details.")), - form_info(entry_required() . ' = ' . _("Entry required!")), - form_text('nick', _("Nick"), $nick, true), - form_text('lastname', _("Last name"), $lastname), - form_text('prename', _("First name"), $prename), - form_date('planned_arrival_date', _("Planned date of arrival") . ' ' . entry_required(), $planned_arrival_date, time()), - form_date('planned_departure_date', _("Planned date of departure"), $planned_departure_date, time()), - form_text('age', _("Age"), $age), - form_text('tel', _("Phone"), $tel), - form_text('dect', _("DECT"), $dect), - form_text('mobile', _("Mobile"), $mobile), - form_text('mail', _("E-Mail") . ' ' . entry_required(), $mail), - form_checkbox('email_shiftinfo', _("The engelsystem is allowed to send me an email (e.g. when my shifts change)"), $email_shiftinfo), - form_checkbox('email_by_human_allowed', _("Humans are allowed to send me an email (e.g. for ticket vouchers)"), $email_by_human_allowed), - form_text('jabber', _("Jabber"), $jabber), - form_text('hometown', _("Hometown"), $hometown), - $enable_tshirt_size ? form_select('tshirt_size', _("Shirt size"), $tshirt_sizes, $tshirt_size) : '', - form_info('', _('Please visit the angeltypes page to manage your angeltypes.')), - form_submit('submit', _("Save")) - ]) - ]), - div('col-md-6', [ - form([ - form_info(_("Here you can change your password.")), - form_password('password', _("Old password:")), - form_password('new_password', _("New password:")), - form_password('new_password2', _("Password confirmation:")), - form_submit('submit_password', _("Save")) - ]), - form([ - form_info(_("Here you can choose your color settings:")), - form_select('theme', _("Color settings:"), $themes, $selected_theme), - form_submit('submit_theme', _("Save")) - ]), - form([ - form_info(_("Here you can choose your language:")), - form_select('language', _("Language:"), $locales, $selected_language), - form_submit('submit_language', _("Save")) - ]) - ]) - ]) - ]); + return User_settings_view($user_source, $locales, $themes, $buildup_start_date, $teardown_end_date, $enable_tshirt_size, $tshirt_sizes); } ?> diff --git a/includes/sys_template.php b/includes/sys_template.php index 6c1727a4..5d450493 100644 --- a/includes/sys_template.php +++ b/includes/sys_template.php @@ -151,10 +151,11 @@ function form_spinner($name, $label, $value) { * Earliest possible date * @return HTML */ -function form_date($name, $label, $value, $start_date = '') { +function form_date($name, $label, $value, $start_date = '', $end_date = '') { $dom_id = $name . '-date'; $value = is_numeric($value) ? date('Y-m-d', $value) : ''; $start_date = is_numeric($start_date) ? date('Y-m-d', $start_date) : ''; + $end_date = is_numeric($end_date) ? date('Y-m-d', $end_date) : ''; return form_element($label, '
' . glyph('th') . ' @@ -165,7 +166,8 @@ function form_date($name, $label, $value, $start_date = '') { language: "' . locale_short() . '", todayBtn: "linked", format: "yyyy-mm-dd", - startDate: "' . $start_date . '" + startDate: "' . $start_date . '", + endDate: "' . $end_date . '" }); }); diff --git a/includes/view/User_view.php b/includes/view/User_view.php index 5bef0828..7d677f33 100644 --- a/includes/view/User_view.php +++ b/includes/view/User_view.php @@ -19,6 +19,66 @@ $tshirt_sizes = [ 'XL-G' => "XL Girl" ]; +/** + * Renders user settings page + * + * @param User $user_source + * The user + * @param array $locales + * Available languages + * @param array $themes + * Available themes + */ +function User_settings_view($user_source, $locales, $themes, $buildup_start_date, $teardown_end_date, $enable_tshirt_size, $tshirt_sizes) { + return page_with_title(settings_title(), [ + msg(), + div('row', [ + div('col-md-6', [ + form([ + form_info('', _("Here you can change your user details.")), + form_info(entry_required() . ' = ' . _("Entry required!")), + form_text('nick', _("Nick"), $user_source['Nick'], true), + form_text('lastname', _("Last name"), $user_source['Name']), + form_text('prename', _("First name"), $user_source['Vorname']), + form_date('planned_arrival_date', _("Planned date of arrival") . ' ' . entry_required(), $user_source['planned_arrival_date'], $buildup_start_date, $teardown_end_date), + form_date('planned_departure_date', _("Planned date of departure"), $user_source['planned_departure_date'], $buildup_start_date, $teardown_end_date), + form_text('age', _("Age"), $user_source['Alter']), + form_text('tel', _("Phone"), $user_source['Telefon']), + form_text('dect', _("DECT"), $user_source['DECT']), + form_text('mobile', _("Mobile"), $user_source['Handy']), + form_text('mail', _("E-Mail") . ' ' . entry_required(), $user_source['email']), + form_checkbox('email_shiftinfo', _("The engelsystem is allowed to send me an email (e.g. when my shifts change)"), $user_source['email_shiftinfo']), + form_checkbox('email_by_human_allowed', _("Humans are allowed to send me an email (e.g. for ticket vouchers)"), $user_source['email_by_human_allowed']), + form_text('jabber', _("Jabber"), $user_source['jabber']), + form_text('hometown', _("Hometown"), $user_source['Hometown']), + $enable_tshirt_size ? form_select('tshirt_size', _("Shirt size"), $tshirt_sizes, $user_source['Size']) : '', + form_info('', _('Please visit the angeltypes page to manage your angeltypes.')), + form_submit('submit', _("Save")) + ]) + ]), + div('col-md-6', [ + form([ + form_info(_("Here you can change your password.")), + form_password('password', _("Old password:")), + form_password('new_password', _("New password:")), + form_password('new_password2', _("Password confirmation:")), + form_submit('submit_password', _("Save")) + ]), + form([ + form_info(_("Here you can choose your color settings:")), + form_select('theme', _("Color settings:"), $themes, $user_source['color']), + form_submit('submit_theme', _("Save")) + ]), + form([ + form_info(_("Here you can choose your language:")), + form_select('language', _("Language:"), $locales, $user_source['Sprache']), + form_submit('submit_language', _("Save")) + ]) + ]) + ]) + ]); +} + /** * Displays the welcome message to the user and shows a login form. */ @@ -112,24 +172,24 @@ function Users_view($users, $order_by, $arrived_count, $active_count, $force_act 'actions' => '' . count($users) . '' ]; - return page_with_title(_('All users'), [ + return page_with_title(_("All users"), [ msg(), buttons([ - button(page_link_to('register'), glyph('plus') . _('New user')) + button(page_link_to('register'), glyph('plus') . _("New user")) ]), table([ - 'Nick' => Users_table_header_link('Nick', _('Nick'), $order_by), - 'Vorname' => Users_table_header_link('Vorname', _('Prename'), $order_by), - 'Name' => Users_table_header_link('Name', _('Name'), $order_by), - 'DECT' => Users_table_header_link('DECT', _('DECT'), $order_by), - 'Gekommen' => Users_table_header_link('Gekommen', _('Arrived'), $order_by), - 'got_voucher' => Users_table_header_link('got_voucher', _('Voucher'), $order_by), + 'Nick' => Users_table_header_link('Nick', _("Nick"), $order_by), + 'Vorname' => Users_table_header_link('Vorname', _("Prename"), $order_by), + 'Name' => Users_table_header_link('Name', _("Name"), $order_by), + 'DECT' => Users_table_header_link('DECT', _("DECT"), $order_by), + 'Gekommen' => Users_table_header_link('Gekommen', _("Arrived"), $order_by), + 'got_voucher' => Users_table_header_link('got_voucher', _("Voucher"), $order_by), 'freeloads' => _('Freeloads'), - 'Aktiv' => Users_table_header_link('Aktiv', _('Active'), $order_by), - 'force_active' => Users_table_header_link('force_active', _('Forced'), $order_by), - 'Tshirt' => Users_table_header_link('Tshirt', _('T-Shirt'), $order_by), - 'Size' => Users_table_header_link('Size', _('Size'), $order_by), - 'lastLogIn' => Users_table_header_link('lastLogIn', _('Last login'), $order_by), + 'Aktiv' => Users_table_header_link('Aktiv', _("Active"), $order_by), + 'force_active' => Users_table_header_link('force_active', _("Forced"), $order_by), + 'Tshirt' => Users_table_header_link('Tshirt', _("T-Shirt"), $order_by), + 'Size' => Users_table_header_link('Size', _("Size"), $order_by), + 'lastLogIn' => Users_table_header_link('lastLogIn', _("Last login"), $order_by), 'actions' => '' ], $users) ]); -- cgit v1.2.3-54-g00ecf