You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

555 lines
13 KiB
PHTML

12 years ago
<?php
use Engelsystem\Database\DB;
use Engelsystem\ValidationResult;
/**
* User model
*/
/**
* Delete a user
*
8 years ago
* @param int $user_id
* @return bool
*/
8 years ago
function User_delete($user_id)
{
DB::delete('DELETE FROM `User` WHERE `UID`=?', [$user_id]);
return DB::getStm()->errorCode() == '00000';
}
/**
* Update user.
*
* @param array $user
* @return bool
*/
8 years ago
function User_update($user)
{
return (bool)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`=?
',
[
$user['Nick'],
$user['Name'],
$user['Vorname'],
$user['Alter'],
$user['Telefon'],
$user['DECT'],
$user['Handy'],
$user['email'],
(bool)$user['email_shiftinfo'],
(bool)$user['email_by_human_allowed'],
$user['jabber'],
$user['Size'],
$user['Gekommen'],
$user['Aktiv'],
(bool)$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'],
]
);
}
/**
* Counts all forced active users.
*
* @return int
*/
8 years ago
function User_force_active_count()
{
$result = DB::select('SELECT COUNT(*) FROM `User` WHERE `force_active` = 1');
$result = array_shift($result);
if (empty($result)) {
return 0;
}
return (int)array_shift($result);
}
/**
* @return int
*/
8 years ago
function User_active_count()
{
$result = DB::select('SELECT COUNT(*) FROM `User` WHERE `Aktiv` = 1');
$result = array_shift($result);
if (empty($result)) {
return 0;
}
return (int)array_shift($result);
}
/**
* @return int
*/
8 years ago
function User_got_voucher_count()
{
$result = DB::select('SELECT SUM(`got_voucher`) FROM `User`');
$result = array_shift($result);
if (empty($result)) {
return 0;
}
return (int)array_shift($result);
}
/**
* @return int
*/
8 years ago
function User_arrived_count()
{
$result = DB::select('SELECT COUNT(*) FROM `User` WHERE `Gekommen` = 1');
$result = array_shift($result);
if (empty($result)) {
return 0;
}
return (int)array_shift($result);
}
/**
* @return int
*/
8 years ago
function User_tshirts_count()
{
$result = DB::select('SELECT COUNT(*) FROM `User` WHERE `Tshirt` = 1');
$result = array_shift($result);
if (empty($result)) {
return 0;
}
return (int)array_shift($result);
}
/**
* Returns all column names for sorting in an array.
*
* @return array
*/
8 years ago
function User_sortable_columns()
{
return [
8 years ago
'Nick',
'Name',
'Vorname',
'Alter',
'DECT',
'email',
'Size',
'Gekommen',
'Aktiv',
'force_active',
'Tshirt',
'lastLogIn'
];
}
/**
* Get all users, ordered by Nick by default or by given param.
*
8 years ago
* @param string $order_by
* @return array|false
*/
8 years ago
function Users($order_by = 'Nick')
{
$result = DB::select(sprintf('
SELECT *
FROM `User`
ORDER BY `%s` ASC
',
trim(DB::getPdo()->quote($order_by), '\'')
));
if (DB::getStm()->errorCode() != '00000') {
return false;
}
return $result;
}
/**
* Returns true if user is freeloader
*
* @param array $user
* @return bool
*/
8 years ago
function User_is_freeloader($user)
{
global $user;
8 years ago
return count(ShiftEntries_freeloaded_by_user($user)) >= config('max_freeloadable_shifts');
}
/**
* Returns all users that are not member of given angeltype.
*
* @param array $angeltype Angeltype
* @return array
*/
8 years ago
function Users_by_angeltype_inverted($angeltype)
{
$result = 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']
]
);
if (DB::getStm()->errorCode() != '00000') {
engelsystem_error('Unable to load users.');
8 years ago
}
return $result;
}
11 years ago
/**
* Returns all members of given angeltype.
*
* @param array $angeltype
* @return array
*/
8 years ago
function Users_by_angeltype($angeltype)
{
$result = DB::select('
SELECT
`User`.*,
`UserAngelTypes`.`id` AS `user_angeltype_id`,
`UserAngelTypes`.`confirm_user_id`,
`UserAngelTypes`.`supporter`,
`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']
]
);
if (DB::getStm()->errorCode() != '00000') {
engelsystem_error('Unable to load members.');
8 years ago
}
return $result;
}
11 years ago
/**
* Returns User id array
*
* @return array
11 years ago
*/
8 years ago
function User_ids()
{
return DB::select('SELECT `UID` FROM `User`');
11 years ago
}
/**
* Strip unwanted characters from a users nick.
*
8 years ago
* @param string $nick
* @return string
*/
8 years ago
function User_validate_Nick($nick)
{
return preg_replace('/([^\wüöäß. +*-]{1,})/ui', '', $nick);
}
/**
* Validate user email address.
*
* @param string $mail
* The email address to validate
* @return ValidationResult
*/
8 years ago
function User_validate_mail($mail)
{
$mail = strip_item($mail);
return new ValidationResult(check_email($mail), $mail);
}
/**
* Validate user jabber address
*
* @param string $jabber
* Jabber-ID to validate
* @return ValidationResult
*/
8 years ago
function User_validate_jabber($jabber)
{
$jabber = strip_item($jabber);
if ($jabber == '') {
// Empty is ok
8 years ago
return new ValidationResult(true, '');
8 years ago
}
return new ValidationResult(check_email($jabber), $jabber);
}
/**
* Validate the planned arrival date
*
* @param int $planned_arrival_date Unix timestamp
* @return ValidationResult
*/
8 years ago
function User_validate_planned_arrival_date($planned_arrival_date)
{
if ($planned_arrival_date == null) {
// null is not okay
8 years ago
return new ValidationResult(false, time());
8 years ago
}
$event_config = EventConfig();
if ($event_config == null) {
// Nothing to validate against
8 years ago
return new ValidationResult(true, $planned_arrival_date);
8 years ago
}
if (isset($event_config['buildup_start_date']) && $planned_arrival_date < $event_config['buildup_start_date']) {
// Planned arrival can not be before buildup start date
8 years ago
return new ValidationResult(false, $event_config['buildup_start_date']);
8 years ago
}
if (isset($event_config['teardown_end_date']) && $planned_arrival_date > $event_config['teardown_end_date']) {
// Planned arrival can not be after teardown end date
8 years ago
return new ValidationResult(false, $event_config['teardown_end_date']);
8 years ago
}
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
*/
8 years ago
function User_validate_planned_departure_date($planned_arrival_date, $planned_departure_date)
{
if ($planned_departure_date == null) {
// null is okay
8 years ago
return new ValidationResult(true, null);
8 years ago
}
if ($planned_arrival_date > $planned_departure_date) {
// departure cannot be before arrival
8 years ago
return new ValidationResult(false, $planned_arrival_date);
8 years ago
}
$event_config = EventConfig();
if ($event_config == null) {
// Nothing to validate against
8 years ago
return new ValidationResult(true, $planned_departure_date);
8 years ago
}
if (isset($event_config['buildup_start_date']) && $planned_departure_date < $event_config['buildup_start_date']) {
// Planned arrival can not be before buildup start date
8 years ago
return new ValidationResult(false, $event_config['buildup_start_date']);
8 years ago
}
if (isset($event_config['teardown_end_date']) && $planned_departure_date > $event_config['teardown_end_date']) {
// Planned arrival can not be after teardown end date
8 years ago
return new ValidationResult(false, $event_config['teardown_end_date']);
8 years ago
}
return new ValidationResult(true, $planned_departure_date);
}
12 years ago
/**
* Returns user by id.
11 years ago
*
* @param int $user_id UID
* @return array|null
12 years ago
*/
8 years ago
function User($user_id)
{
$user_source = DB::select('SELECT * FROM `User` WHERE `UID`=? LIMIT 1', [$user_id]);
if (DB::getStm()->errorCode() != '00000') {
engelsystem_error('Unable to load user.');
8 years ago
}
if (empty($user_source)) {
return null;
8 years ago
}
return array_shift($user_source);
12 years ago
}
/**
* Returns User by api_key.
11 years ago
*
* @param string $api_key
* User api key
* @return array|null Matching user, null on error
*/
8 years ago
function User_by_api_key($api_key)
{
$user = DB::select('SELECT * FROM `User` WHERE `api_key`=? LIMIT 1', [$api_key]);
if (DB::getStm()->errorCode() != '00000') {
engelsystem_error('Unable to find user by api key.');
8 years ago
}
if (empty($user)) {
8 years ago
return null;
}
8 years ago
return $user[0];
}
/**
* Returns User by email.
*
8 years ago
* @param string $email
* @return array|null Matching user, null or false on error
*/
8 years ago
function User_by_email($email)
{
$user = DB::select('SELECT * FROM `User` WHERE `email`=? LIMIT 1', [$email]);
if (DB::getStm()->errorCode() != '00000') {
engelsystem_error('Unable to load user.');
8 years ago
}
if (empty($user)) {
8 years ago
return null;
}
return array_shift($user);
}
/**
* Returns User by password token.
*
8 years ago
* @param string $token
* @return array|null Matching user, null or false on error
*/
8 years ago
function User_by_password_recovery_token($token)
{
$user = DB::select('SELECT * FROM `User` WHERE `password_recovery_token`=? LIMIT 1', [$token]);
if (DB::getStm()->errorCode() != '00000') {
engelsystem_error('Unable to load user.');
8 years ago
}
if (empty($user)) {
8 years ago
return null;
}
return array_shift($user);
}
/**
* Generates a new api key for given user.
11 years ago
*
* @param array $user
* @param bool $log
* @return bool
*/
8 years ago
function User_reset_api_key(&$user, $log = true)
{
$user['api_key'] = md5($user['Nick'] . time() . rand());
8 years ago
DB::update('
UPDATE `User`
SET `api_key`=?
WHERE `UID`=?
LIMIT 1
',
[
$user['api_key'],
$user['UID']
]
);
if (DB::getStm()->errorCode() != '00000') {
8 years ago
return false;
}
8 years ago
if ($log) {
engelsystem_log(sprintf('API key resetted (%s).', User_Nick_render($user)));
8 years ago
}
return true;
}
/**
* Generates a new password recovery token for given user.
*
* @param array $user
* @return string
*/
8 years ago
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'],
]
);
if (DB::getStm()->errorCode() != '00000') {
engelsystem_error('Unable to generate password recovery token.');
8 years ago
}
engelsystem_log('Password recovery for ' . User_Nick_render($user) . ' started.');
8 years ago
return $user['password_recovery_token'];
}
/**
* @param array $user
* @return float
*/
8 years ago
function User_get_eligable_voucher_count(&$user)
{
$voucher_settings = config('voucher_settings');
8 years ago
$shifts_done = count(ShiftEntries_finished_by_user($user));
8 years ago
8 years ago
$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;
}
8 years ago
8 years ago
return $elegible_vouchers;
}