235 lines
8.6 KiB
PHP
235 lines
8.6 KiB
PHP
<?php
|
|
/*********************************************************************************
|
|
*
|
|
* TimeTrex is a Workforce Management program developed by
|
|
* TimeTrex Software Inc. Copyright (C) 2003 - 2021 TimeTrex Software Inc.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it under
|
|
* the terms of the GNU Affero General Public License version 3 as published by
|
|
* the Free Software Foundation with the addition of the following permission
|
|
* added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
|
|
* WORK IN WHICH THE COPYRIGHT IS OWNED BY TIMETREX, TIMETREX DISCLAIMS THE
|
|
* WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
|
|
* details.
|
|
*
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License along
|
|
* with this program; if not, see http://www.gnu.org/licenses or write to the Free
|
|
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
* 02110-1301 USA.
|
|
*
|
|
*
|
|
* You can contact TimeTrex headquarters at Unit 22 - 2475 Dobbin Rd. Suite
|
|
* #292 West Kelowna, BC V4T 2E9, Canada or at email address info@timetrex.com.
|
|
*
|
|
*
|
|
* The interactive user interfaces in modified source and object code versions
|
|
* of this program must display Appropriate Legal Notices, as required under
|
|
* Section 5 of the GNU Affero General Public License version 3.
|
|
*
|
|
*
|
|
* In accordance with Section 7(b) of the GNU Affero General Public License
|
|
* version 3, these Appropriate Legal Notices must retain the display of the
|
|
* "Powered by TimeTrex" logo. If the display of the logo is not reasonably
|
|
* feasible for technical reasons, the Appropriate Legal Notices must display
|
|
* the words "Powered by TimeTrex".
|
|
*
|
|
********************************************************************************/
|
|
|
|
require_once( dirname( __FILE__ ) . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'global.inc.php' );
|
|
require_once( dirname( __FILE__ ) . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'CLI.inc.php' );
|
|
|
|
if ( $argc < 1 || ( isset( $argv[1] ) && in_array( $argv[1], [ '--help', '-help', '-h', '-?' ] ) ) ) {
|
|
$help_output = "Usage: recalculate_timesheet.php [options] [company_id]\n";
|
|
$help_output .= " -start_date Start Date to recalculate\n";
|
|
$help_output .= " -end_date End Date to recalculate\n";
|
|
$help_output .= " -user_id User to recalculate\n";
|
|
$help_output .= " -disable_exceptions Disable recalculating exceptions\n";
|
|
$help_output .= " -n Dry-run\n";
|
|
echo $help_output;
|
|
} else {
|
|
function recalculateTimeSheet( $company_id, $user_id, $date_stamps, $dry_run, $disable_exceptions = false ) {
|
|
$flags = [
|
|
'meal' => true,
|
|
'undertime_absence' => true, //Needs to calculate undertime absences, otherwise it won't update accruals.
|
|
'break' => true,
|
|
'holiday' => true,
|
|
'schedule_absence' => true, //Required to calculate absences created from the schedule that may be causing duplicate entries in the accrual.
|
|
'absence' => true,
|
|
'regular' => true,
|
|
'overtime' => true,
|
|
'premium' => true,
|
|
'accrual' => true,
|
|
|
|
'exception' => true,
|
|
//Exception options
|
|
'exception_premature' => false, //Calculates premature exceptions
|
|
'exception_future' => false, //Calculates exceptions in the future.
|
|
|
|
//Calculate policies for future dates.
|
|
'future_dates' => false, //Calculates dates in the future.
|
|
];
|
|
|
|
if ( $disable_exceptions == true ) {
|
|
$flags['exception'] = false;
|
|
}
|
|
|
|
$ulf = new UserListFactory();
|
|
if ( $user_id != '' ) {
|
|
$ulf->getById( $user_id );
|
|
} elseif ( $company_id != '' ) {
|
|
$ulf->getByCompanyId( $company_id );
|
|
} else {
|
|
echo "ERROR! No user or company_id specified, unable to recalculate!\n";
|
|
return false;
|
|
}
|
|
|
|
if ( $ulf->getRecordCount() > 0 ) {
|
|
foreach ( $ulf as $user_obj ) {
|
|
$user_obj->StartTransaction(); //Try to keep transactions are short lived as possible.
|
|
|
|
if ( $user_obj->getStatus() == 20 ) {
|
|
continue;
|
|
}
|
|
|
|
$user_obj_prefs = $user_obj->getUserPreferenceObject();
|
|
if ( is_object( $user_obj_prefs ) ) {
|
|
$user_obj_prefs->setTimeZonePreferences();
|
|
} else {
|
|
//Use system timezone.
|
|
TTDate::setTimeZone();
|
|
}
|
|
echo ' Employee: ' . $user_obj->getUserName() . ' - ' . date( 'r' ) . "\n";
|
|
Debug::text( 'User Name: ' . $user_obj->getUserName() . ' ID: ' . $user_obj->getID(), __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
//Calculate pre-mature exceptions, so pre-mature Missing Out Punch exceptions arn't made active until they are ready.
|
|
//Don't calculate future exceptions though.
|
|
$cp = TTNew( 'CalculatePolicy' );
|
|
$cp->setFlag( $flags );
|
|
$cp->setUserObject( $user_obj );
|
|
$cp->addPendingCalculationDate( $date_stamps );
|
|
$cp->calculate(); //This sets timezone itself.
|
|
$cp->Save();
|
|
|
|
if ( $dry_run == true ) {
|
|
$user_obj->FailTransaction();
|
|
}
|
|
$user_obj->CommitTransaction();
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
//Handle command line arguments
|
|
$last_arg = count( $argv ) - 1;
|
|
|
|
$background_process_lock_file_name = $argv[$last_arg];
|
|
|
|
//Create lock file for background pooling.
|
|
$bg_lock_file = new LockFile( $background_process_lock_file_name );
|
|
$bg_lock_file->create();
|
|
|
|
//Create lock file so the same clock isn't being synchronized more then once at a time.
|
|
$lock_file = new LockFile( $config_vars['cache']['dir'] . DIRECTORY_SEPARATOR . 'RecalculateTimeSheet' . md5( serialize( $argv ) ). '.lock' );
|
|
Debug::text( 'Attempting to recalculate timesheet... Background Lock File Name: ' . $background_process_lock_file_name, __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
if ( function_exists( 'proc_nice' ) ) {
|
|
proc_nice( 19 ); //Low priority.
|
|
}
|
|
|
|
if ( in_array( '-start_date', $argv ) ) {
|
|
$start_date = trim( $argv[array_search( '-start_date', $argv ) + 1] );
|
|
} else {
|
|
$start_date = time();
|
|
}
|
|
if ( in_array( '-end_date', $argv ) ) {
|
|
$end_date = trim( $argv[array_search( '-end_date', $argv ) + 1] );
|
|
} else {
|
|
$end_date = $start_date;
|
|
}
|
|
|
|
if ( in_array( '-user_id', $argv ) ) {
|
|
$filter_user_id = trim( $argv[array_search( '-user_id', $argv ) + 1] );
|
|
} else {
|
|
$filter_user_id = null;
|
|
}
|
|
|
|
if ( in_array( '-disable_exceptions', $argv ) ) {
|
|
$disable_exceptions = true;
|
|
} else {
|
|
$disable_exceptions = false;
|
|
}
|
|
|
|
if ( in_array( '-n', $argv ) ) {
|
|
$dry_run = true;
|
|
echo "Using DryRun!\n";
|
|
} else {
|
|
$dry_run = false;
|
|
}
|
|
|
|
if ( isset( $argv[$last_arg] ) && $argv[$last_arg] != '' && TTUUID::isUUID( $argv[$last_arg] ) ) {
|
|
$company_id = $argv[$last_arg];
|
|
}
|
|
|
|
//Disable debug output for performance improvements.
|
|
Debug::setBufferOutput( false );
|
|
Debug::setEnable( false );
|
|
Debug::setEnableDisplay( false );
|
|
Debug::setVerbosity( 0 );
|
|
|
|
//Disable audit logging for performance improvements.
|
|
$config_vars['other']['disable_audit_log_detail'] = TRUE;
|
|
$config_vars['other']['disable_audit_log'] = TRUE;
|
|
|
|
$date_stamps = TTDate::getDateArray( strtotime( $start_date ), strtotime( $end_date ) );
|
|
|
|
//Force flush after each output line.
|
|
ob_implicit_flush( true );
|
|
ob_end_flush();
|
|
|
|
//TTDate::setTimeZone( 'UTC' ); //Always force the timezone to be set.
|
|
|
|
if ( $lock_file->exists() == false ) {
|
|
if ( $lock_file->create() == true ) {
|
|
if ( $filter_user_id != '' ) {
|
|
recalculateTimeSheet( null, $filter_user_id, $date_stamps, $dry_run, $disable_exceptions );
|
|
} else {
|
|
$clf = new CompanyListFactory();
|
|
if ( $company_id != '' ) {
|
|
$clf->getById( $company_id );
|
|
} else {
|
|
$clf->getAll();
|
|
}
|
|
|
|
if ( $clf->getRecordCount() > 0 ) {
|
|
foreach ( $clf as $c_obj ) {
|
|
if ( $c_obj->getStatus() != 30 ) {
|
|
Debug::text( 'Company: ' . $c_obj->getName() . ' ID: ' . $c_obj->getID(), __FILE__, __LINE__, __METHOD__, 10 );
|
|
echo 'Company: ' . $c_obj->getName() . ' ID: ' . $c_obj->getID() . "\n";
|
|
//Check to see if there any absence entries that are linked to an accrual, but the accrual record does not exist.
|
|
|
|
echo ' Recalculating TimeSheets from ' . date( 'r', strtotime( $start_date ) ) . ' to ' . date( 'r', strtotime( $end_date ) ) . "\n";
|
|
recalculateTimeSheet( $c_obj->getId(), $filter_user_id, $date_stamps, $dry_run, $disable_exceptions );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
Debug::text( 'Skipping... Unable to create lock file...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
}
|
|
$lock_file->delete();
|
|
}
|
|
|
|
//Delete background pool lock file.
|
|
$bg_lock_file->delete();
|
|
}
|
|
echo "Done...\n";
|
|
Debug::WriteToLog();
|
|
Debug::Display();
|
|
?>
|