engelsystem/includes/model/User_model.php

484 lines
11 KiB
PHP
Raw Normal View History

2012-12-26 14:02:27 +01:00
<?php
use Engelsystem\Database\DB;
2016-11-18 08:20:17 +01:00
use Engelsystem\ValidationResult;
2014-09-28 14:50:08 +02:00
/**
* User model
*/
/**
* Delete a user
*
2017-01-02 03:57:23 +01:00
* @param int $user_id
*/
2017-01-02 03:57:23 +01:00
function User_delete($user_id)
{
DB::delete('DELETE FROM `User` WHERE `UID`=?', [$user_id]);
}
2014-12-26 01:49:59 +01:00
/**
* Update user.
2014-12-26 19:26:53 +01:00
*
2017-01-03 03:22:48 +01:00
* @param array $user
2014-12-26 01:49:59 +01:00
*/
2017-01-02 03:57:23 +01:00
function User_update($user)
{
2017-07-23 11:46:54 +02:00
DB::update('
UPDATE `User` SET
`Nick`=?,
`Name`=?,
`Vorname`=?,
`Alter`=?,
`Telefon`=?,
`DECT`=?,
`Handy`=?,
`email`=?,
`email_shiftinfo`=?,
`email_by_human_allowed`=?,
`jabber`=?,
`Size`=?,
`Gekommen`=?,
`Aktiv`=?,
`force_active`=?,
`Tshirt`=?,
`color`=?,
`Sprache`=?,
`Hometown`=?,
`got_voucher`=?,
`arrival_date`=?,
`planned_arrival_date`=?,
`planned_departure_date`=?
WHERE `UID`=?
2017-01-21 19:37:42 +01:00
',
[
$user['Nick'],
$user['Name'],
$user['Vorname'],
$user['Alter'],
$user['Telefon'],
$user['DECT'],
$user['Handy'],
$user['email'],
2017-11-19 13:17:34 +01:00
(int)$user['email_shiftinfo'],
(int)$user['email_by_human_allowed'],
$user['jabber'],
$user['Size'],
$user['Gekommen'],
$user['Aktiv'],
2017-11-19 13:17:34 +01:00
(int)$user['force_active'],
$user['Tshirt'],
$user['color'],
$user['Sprache'],
$user['Hometown'],
$user['got_voucher'],
$user['arrival_date'],
$user['planned_arrival_date'],
$user['planned_departure_date'],
$user['UID'],
]
);
2014-12-26 01:49:59 +01:00
}
2014-09-28 15:01:02 +02:00
/**
* Counts all forced active users.
2017-01-03 03:22:48 +01:00
*
* @return int
2014-09-28 15:01:02 +02:00
*/
2017-01-02 03:57:23 +01:00
function User_force_active_count()
{
$result = DB::selectOne('SELECT COUNT(*) FROM `User` WHERE `force_active` = 1');
if (empty($result)) {
return 0;
}
return (int)array_shift($result);
2014-09-28 15:01:02 +02:00
}
2017-01-03 03:22:48 +01:00
/**
* @return int
2017-01-03 03:22:48 +01:00
*/
2017-01-02 03:57:23 +01:00
function User_active_count()
{
$result = DB::selectOne('SELECT COUNT(*) FROM `User` WHERE `Aktiv` = 1');
if (empty($result)) {
return 0;
}
return (int)array_shift($result);
2014-09-28 15:01:02 +02:00
}
2017-01-03 03:22:48 +01:00
/**
* @return int
2017-01-03 03:22:48 +01:00
*/
2017-01-02 03:57:23 +01:00
function User_got_voucher_count()
{
$result = DB::selectOne('SELECT SUM(`got_voucher`) FROM `User`');
if (empty($result)) {
return 0;
}
return (int)array_shift($result);
2014-12-26 01:49:59 +01:00
}
2017-01-03 03:22:48 +01:00
/**
* @return int
2017-01-03 03:22:48 +01:00
*/
2017-01-02 03:57:23 +01:00
function User_arrived_count()
{
$result = DB::selectOne('SELECT COUNT(*) FROM `User` WHERE `Gekommen` = 1');
if (empty($result)) {
return 0;
}
return (int)array_shift($result);
2014-09-28 15:01:02 +02:00
}
2017-01-03 03:22:48 +01:00
/**
* @return int
2017-01-03 03:22:48 +01:00
*/
2017-01-02 03:57:23 +01:00
function User_tshirts_count()
{
$result = DB::selectOne('SELECT COUNT(*) FROM `User` WHERE `Tshirt` = 1');
if (empty($result)) {
return 0;
}
return (int)array_shift($result);
2014-09-28 15:01:02 +02:00
}
/**
* Returns all column names for sorting in an array.
2017-01-03 03:22:48 +01:00
*
* @return array
2014-09-28 15:01:02 +02:00
*/
2017-01-02 03:57:23 +01:00
function User_sortable_columns()
{
return [
2017-01-02 15:43:36 +01:00
'Nick',
'Name',
'Vorname',
'Alter',
'DECT',
'email',
'Size',
'Gekommen',
'Aktiv',
'force_active',
'Tshirt',
'lastLogIn'
];
2014-09-28 15:01:02 +02:00
}
2014-09-28 14:50:08 +02:00
/**
* Get all users, ordered by Nick by default or by given param.
2014-09-28 15:01:02 +02:00
*
2017-01-02 03:57:23 +01:00
* @param string $order_by
* @return array
2014-09-28 14:50:08 +02:00
*/
2017-01-02 03:57:23 +01:00
function Users($order_by = 'Nick')
{
return DB::select(sprintf('
SELECT *
FROM `User`
ORDER BY `%s` ASC
',
trim(DB::getPdo()->quote($order_by), '\'')
));
2014-09-28 14:50:08 +02:00
}
2014-08-23 01:55:18 +02:00
/**
* Returns true if user is freeloader
*
2017-01-03 03:22:48 +01:00
* @param array $user
* @return bool
2014-08-23 01:55:18 +02:00
*/
2017-01-02 03:57:23 +01:00
function User_is_freeloader($user)
{
global $user;
2017-01-02 15:43:36 +01:00
return count(ShiftEntries_freeloaded_by_user($user)) >= config('max_freeloadable_shifts');
2014-08-23 01:55:18 +02:00
}
/**
* Returns all users that are not member of given angeltype.
*
2017-01-03 03:22:48 +01:00
* @param array $angeltype Angeltype
* @return array
*/
2017-01-02 03:57:23 +01:00
function Users_by_angeltype_inverted($angeltype)
{
return DB::select('
SELECT `User`.*
FROM `User`
LEFT JOIN `UserAngelTypes`
ON (`User`.`UID`=`UserAngelTypes`.`user_id` AND `angeltype_id`=?)
WHERE `UserAngelTypes`.`id` IS NULL
ORDER BY `Nick`
',
[
$angeltype['id']
]
);
}
2013-10-13 00:52:44 +02:00
/**
* Returns all members of given angeltype.
*
2017-01-03 03:22:48 +01:00
* @param array $angeltype
* @return array
*/
2017-01-02 03:57:23 +01:00
function Users_by_angeltype($angeltype)
{
return DB::select('
SELECT
`User`.*,
`UserAngelTypes`.`id` AS `user_angeltype_id`,
`UserAngelTypes`.`confirm_user_id`,
`UserAngelTypes`.`supporter`,
2017-08-30 00:07:01 +02:00
(`UserDriverLicenses`.`user_id` IS NOT NULL) AS `wants_to_drive`,
`UserDriverLicenses`.*
FROM `User`
JOIN `UserAngelTypes` ON `User`.`UID`=`UserAngelTypes`.`user_id`
LEFT JOIN `UserDriverLicenses` ON `User`.`UID`=`UserDriverLicenses`.`user_id`
WHERE `UserAngelTypes`.`angeltype_id`=?
ORDER BY `Nick`
',
[
$angeltype['id']
]
);
}
2013-12-29 15:08:21 +01:00
/**
* Returns User id array
2017-01-03 03:22:48 +01:00
*
* @return array
2013-12-29 15:08:21 +01:00
*/
2017-01-02 03:57:23 +01:00
function User_ids()
{
return DB::select('SELECT `UID` FROM `User`');
2013-12-29 15:08:21 +01:00
}
2013-12-27 19:45:50 +01:00
/**
* Strip unwanted characters from a users nick.
*
2017-01-02 03:57:23 +01:00
* @param string $nick
2017-01-03 03:22:48 +01:00
* @return string
2013-12-27 19:45:50 +01:00
*/
2017-01-02 03:57:23 +01:00
function User_validate_Nick($nick)
{
return preg_replace('/([^\wüöäß. +*-]{1,})/ui', '', $nick);
2013-12-27 19:45:50 +01:00
}
/**
* Validate user email address.
*
* @param string $mail
* The email address to validate
* @return ValidationResult
*/
2017-01-02 03:57:23 +01:00
function User_validate_mail($mail)
{
$mail = strip_item($mail);
return new ValidationResult(check_email($mail), $mail);
}
2016-11-14 19:10:29 +01:00
/**
* Validate user jabber address
*
* @param string $jabber
* Jabber-ID to validate
* @return ValidationResult
*/
2017-01-02 03:57:23 +01:00
function User_validate_jabber($jabber)
{
$jabber = strip_item($jabber);
if ($jabber == '') {
// Empty is ok
2017-01-02 15:43:36 +01:00
return new ValidationResult(true, '');
2017-01-02 03:57:23 +01:00
}
return new ValidationResult(check_email($jabber), $jabber);
2016-11-14 19:10:29 +01:00
}
2016-11-11 16:34:23 +01:00
/**
* Validate the planned arrival date
*
2017-01-03 03:22:48 +01:00
* @param int $planned_arrival_date Unix timestamp
2016-11-11 16:34:23 +01:00
* @return ValidationResult
*/
2017-01-02 03:57:23 +01:00
function User_validate_planned_arrival_date($planned_arrival_date)
{
if ($planned_arrival_date == null) {
// null is not okay
2017-01-02 15:43:36 +01:00
return new ValidationResult(false, time());
2017-01-02 03:57:23 +01:00
}
$event_config = EventConfig();
if ($event_config == null) {
// Nothing to validate against
2017-01-02 15:43:36 +01:00
return new ValidationResult(true, $planned_arrival_date);
2017-01-02 03:57:23 +01:00
}
if (isset($event_config['buildup_start_date']) && $planned_arrival_date < $event_config['buildup_start_date']) {
// Planned arrival can not be before buildup start date
2017-01-02 15:43:36 +01:00
return new ValidationResult(false, $event_config['buildup_start_date']);
2017-01-02 03:57:23 +01:00
}
if (isset($event_config['teardown_end_date']) && $planned_arrival_date > $event_config['teardown_end_date']) {
// Planned arrival can not be after teardown end date
2017-01-02 15:43:36 +01:00
return new ValidationResult(false, $event_config['teardown_end_date']);
2017-01-02 03:57:23 +01:00
}
return new ValidationResult(true, $planned_arrival_date);
2016-11-11 16:34:23 +01:00
}
/**
* Validate the planned departure date
*
* @param int $planned_arrival_date
* Unix timestamp
* @param int $planned_departure_date
* Unix timestamp
* @return ValidationResult
*/
2017-01-02 03:57:23 +01:00
function User_validate_planned_departure_date($planned_arrival_date, $planned_departure_date)
{
if ($planned_departure_date == null) {
// null is okay
2017-01-02 15:43:36 +01:00
return new ValidationResult(true, null);
2017-01-02 03:57:23 +01:00
}
if ($planned_arrival_date > $planned_departure_date) {
// departure cannot be before arrival
2017-01-02 15:43:36 +01:00
return new ValidationResult(false, $planned_arrival_date);
2017-01-02 03:57:23 +01:00
}
$event_config = EventConfig();
if ($event_config == null) {
// Nothing to validate against
2017-01-02 15:43:36 +01:00
return new ValidationResult(true, $planned_departure_date);
2017-01-02 03:57:23 +01:00
}
if (isset($event_config['buildup_start_date']) && $planned_departure_date < $event_config['buildup_start_date']) {
// Planned arrival can not be before buildup start date
2017-01-02 15:43:36 +01:00
return new ValidationResult(false, $event_config['buildup_start_date']);
2017-01-02 03:57:23 +01:00
}
if (isset($event_config['teardown_end_date']) && $planned_departure_date > $event_config['teardown_end_date']) {
// Planned arrival can not be after teardown end date
2017-01-02 15:43:36 +01:00
return new ValidationResult(false, $event_config['teardown_end_date']);
2017-01-02 03:57:23 +01:00
}
return new ValidationResult(true, $planned_departure_date);
2016-11-11 16:34:23 +01:00
}
2012-12-26 14:02:27 +01:00
/**
* Returns user by id.
2013-10-13 00:52:44 +02:00
*
2017-01-03 03:22:48 +01:00
* @param int $user_id UID
* @return array|null
2012-12-26 14:02:27 +01:00
*/
2017-01-02 03:57:23 +01:00
function User($user_id)
{
return DB::selectOne('SELECT * FROM `User` WHERE `UID`=? LIMIT 1', [$user_id]);
2012-12-26 14:02:27 +01:00
}
/**
* Returns User by api_key.
2013-10-13 00:52:44 +02:00
*
* @param string $api_key
* User api key
* @return array|null Matching user, null if not found
*/
2017-01-02 03:57:23 +01:00
function User_by_api_key($api_key)
{
return DB::selectOne('SELECT * FROM `User` WHERE `api_key`=? LIMIT 1', [$api_key]);
}
2013-12-26 13:34:48 +01:00
/**
* Returns User by email.
*
2017-01-02 03:57:23 +01:00
* @param string $email
2017-01-03 03:22:48 +01:00
* @return array|null Matching user, null or false on error
2013-12-26 13:34:48 +01:00
*/
2017-01-02 03:57:23 +01:00
function User_by_email($email)
{
return DB::selectOne('SELECT * FROM `User` WHERE `email`=? LIMIT 1', [$email]);
2013-12-26 13:34:48 +01:00
}
/**
* Returns User by password token.
*
2017-01-02 03:57:23 +01:00
* @param string $token
* @return array|null Matching user, null when not found
2013-12-26 13:34:48 +01:00
*/
2017-01-02 03:57:23 +01:00
function User_by_password_recovery_token($token)
{
return DB::selectOne('SELECT * FROM `User` WHERE `password_recovery_token`=? LIMIT 1', [$token]);
2013-12-26 13:34:48 +01:00
}
/**
* Generates a new api key for given user.
2013-10-13 00:52:44 +02:00
*
2017-01-03 03:22:48 +01:00
* @param array $user
* @param bool $log
*/
2017-01-02 03:57:23 +01:00
function User_reset_api_key(&$user, $log = true)
{
$user['api_key'] = md5($user['Nick'] . time() . rand());
2017-01-22 01:02:52 +01:00
DB::update('
UPDATE `User`
SET `api_key`=?
WHERE `UID`=?
LIMIT 1
',
[
$user['api_key'],
$user['UID']
]
);
2017-01-03 03:22:48 +01:00
2017-01-02 03:57:23 +01:00
if ($log) {
2017-01-03 14:12:17 +01:00
engelsystem_log(sprintf('API key resetted (%s).', User_Nick_render($user)));
2017-01-02 03:57:23 +01:00
}
}
2013-12-26 13:34:48 +01:00
/**
* Generates a new password recovery token for given user.
*
2017-01-03 03:22:48 +01:00
* @param array $user
* @return string
2013-12-26 13:34:48 +01:00
*/
2017-01-02 03:57:23 +01:00
function User_generate_password_recovery_token(&$user)
{
$user['password_recovery_token'] = md5($user['Nick'] . time() . rand());
DB::update('
UPDATE `User`
SET `password_recovery_token`=?
WHERE `UID`=?
LIMIT 1
',
[
$user['password_recovery_token'],
$user['UID'],
]
);
2017-01-03 14:12:17 +01:00
engelsystem_log('Password recovery for ' . User_Nick_render($user) . ' started.');
2017-01-02 03:57:23 +01:00
return $user['password_recovery_token'];
2013-12-26 13:34:48 +01:00
}
2017-01-03 03:22:48 +01:00
/**
* @param array $user
* @return float
*/
2017-01-02 03:57:23 +01:00
function User_get_eligable_voucher_count(&$user)
{
$voucher_settings = config('voucher_settings');
2017-01-02 03:57:23 +01:00
$shifts_done = count(ShiftEntries_finished_by_user($user));
2017-01-02 15:43:36 +01:00
2017-01-02 03:57:23 +01:00
$earned_vouchers = $user['got_voucher'] - $voucher_settings['initial_vouchers'];
$elegible_vouchers = $shifts_done / $voucher_settings['shifts_per_voucher'] - $earned_vouchers;
if ($elegible_vouchers < 0) {
return 0;
}
2017-01-02 15:43:36 +01:00
2017-01-02 03:57:23 +01:00
return $elegible_vouchers;
}