TimeTrex/maint/calcExceptions.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".
 *
 ********************************************************************************/

/*
 * Calculate Exceptions for the previous day. This helps especially for
 * the "Unscheuled Absence" exception.
 *
 * Run this once a day. AFTER AddUserDate
 */
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' );

//Debug::setVerbosity(5);

$execution_time = time();

$flags = [
	//Since this needs to calculate 'undertime_absence', it pretty much needs to calculate all other policies too.
	//Its less error prone if we calculate them all as well.
	'meal'              => false,
	'undertime_absence' => true, //Required to properly handle undertime absences when no shifts were worked. See comments in CalculatePolicy->calculateUnderTimeAbsencePolicy()
	'break'             => false,
	'holiday'           => false,
	'schedule_absence'  => false,
	'absence'           => false,
	'regular'           => false,
	'overtime'          => false,
	'premium'           => false,
	'accrual'           => false,

	'exception'           => true,
	//Exception options
	'exception_premature' => true, //Calculates premature exceptions, this will automatically disable itself if based on the current time.
	'exception_future'    => false, //Calculates exceptions in the future.

	//Calculate policies for future dates.
	'future_dates'        => false, //Calculates dates in the future.
];

$clf = new CompanyListFactory();
$clf->getByStatusID( [ 10, 20, 23 ], null, [ 'a.id' => 'asc' ] );
$x = 0;
if ( $clf->getRecordCount() > 0 ) {
	foreach ( $clf as $c_obj ) {
		if ( $c_obj->getStatus() != 30 ) {
			$company_start_time = microtime( true );
			Debug::text( 'Company: ' . $c_obj->getName() . ' (' . $c_obj->getId() . ')', __FILE__, __LINE__, __METHOD__, 5 );

			TTDate::setTimeZone(); //Reset timezone to system defaults for each company.

			//Recalculate at least the last two days.
			$start_date = TTDate::getMiddleDayEpoch( ( $execution_time - ( 86400 * 2 ) ) );
			$end_date = TTDate::getMiddleDayEpoch( ( $execution_time - 86400 ) );
			Debug::text( 'X: ' . $x . ' Start Date: ' . TTDate::getDate( 'DATE+TIME', $start_date ) . ' End Date: ' . TTDate::getDate( 'DATE+TIME', $end_date ), __FILE__, __LINE__, __METHOD__, 5 );

			//Get the last time cron ran this script.
			$cjlf = new CronJobListFactory();
			$cjlf->getByName( 'calcExceptions' );
			if ( $cjlf->getRecordCount() > 0 ) {
				foreach ( $cjlf as $cj_obj ) {
					$tmp_start_date = TTDate::getMiddleDayEpoch( $cj_obj->getLastRunDate() );
					if ( $tmp_start_date != '' && $tmp_start_date < $start_date ) {
						$start_date = $tmp_start_date;
						Debug::text( '  CRON Job hasnt run in more then 48hrs, reducing Start Date to: ' . TTDate::getDate( 'DATE+TIME', $start_date ), __FILE__, __LINE__, __METHOD__, 5 );
					}
				}
			}
			unset( $cjlf, $cj_obj, $tmp_start_date );

			//Get maximum shift time for each pay period schedule, so we know how far back
			//we have to recalculate days at the minimum.
			$ppslf = new PayPeriodScheduleListFactory();
			$ppslf->getByCompanyId( $c_obj->getId() );
			if ( $ppslf->getRecordCount() > 0 ) {
				foreach ( $ppslf as $pps_obj ) {
					$tmp_start_date = TTDate::getMiddleDayEpoch( $execution_time ) - $pps_obj->getMaximumShiftTime();
					if ( $tmp_start_date != '' && $tmp_start_date < $start_date ) {
						$start_date = $tmp_start_date;
						Debug::text( '  Maximum Shift Time is greater then 48hrs, reducing Start Date to: ' . TTDate::getDate( 'DATE+TIME', $start_date ), __FILE__, __LINE__, __METHOD__, 5 );
					}
				}
			}
			unset( $ppslf, $pps_obj, $tmp_start_date );

			//Get earliest pre_mature exception in a NON-closed pay period.
			//Cap the limit at going back 90 days. This prevents the case where they open pay periods in the previous year and forget to close them.
			//  If that happens we don't want to start trying to recalculate pay periods from a year ago.
			$elf = new ExceptionListFactory();
			$elf->getByCompanyIDAndTypeAndPayPeriodStatusAndMinimumDateStamp( $c_obj->getId(), 5, [ 10, 12, 15, 30 ], ( $end_date - ( 86400 * 90 ) ), 1, null, null, [ 'a.date_stamp' => 'asc' ] ); //Limit 1
			if ( $elf->getRecordCount() > 0 ) {
				foreach ( $elf as $e_obj ) {
					$tmp_start_date = TTDate::getMiddleDayEpoch( $e_obj->getDateStamp() );
					if ( $tmp_start_date != '' && $tmp_start_date < $start_date ) {
						$start_date = $tmp_start_date;
						Debug::text( '  Pre-Mature exceptions occur before start date, reducing to: ' . TTDate::getDate( 'DATE+TIME', $start_date ) . '(' . $e_obj->getId() . ')', __FILE__, __LINE__, __METHOD__, 5 );
					}
				}
			}
			unset( $elf, $e_obj, $tmp_start_date );

			$date_arr = TTDate::getDateArray( $start_date, $end_date );
			if ( is_array( $date_arr ) ) {
				//Loop over all employees
				$ulf = TTnew( 'UserListFactory' ); /** @var UserListFactory $ulf */
				$ulf->getByCompanyIdAndStatus( $c_obj->getId(), 10 ); //Only active employees
				if ( $ulf->getRecordCount() > 0 ) {
					$system_job_queue_batch_id = TTUUID::generateUUID();
					$i = 0;
					foreach ( $ulf as $u_obj ) {
						//Timezone is set in calculate() function below.

						//Recalculate system time, and exceptions for the day.
						//Because if its a Monday, it will also recalculate the rest of the days in the week.
						//Shouldn't be a big deal though.
						//This isn't needed, since we now do it in AddRecurringScheduleShift, so dock time is
						//applied at the beginning of the day.
						//The problem is that AddRecurringScheduleShift does it, then for the entire day someone with
						//a dock policy shows up as dock time. Some users have complained about this a few times.

						//Reason for doing two days ago is that if someone starts a shift at 11pm, but doesn't end it in
						//time, it still needs to be re-calculated a day later.
						//Could maybe get around this by getting all punches of yesterday, and getting their date_ids
						//and just recalculating those.

						//Enable pre-mature exceptions if we're recalculating just one day ago.
						//Problem is a late shift on say Monday: 2:00PM to 11:00PM won't trigger the exception at 1AM the next day,
						//but by 1AM the following day (2days later) its too late and emails are disabled if enable_premature_exceptions are disabled.
						//**With new CalculatePolicy code we can calculate multiple days in a single pass, so always enable pre-mature exceptions, and they will be disabled automatically in CalculatePolicy if necessary.
						Debug::text( $x . ': (' . $i . '). User: ' . $u_obj->getID() . ' Start Date: ' . TTDate::getDate( 'DATE+TIME', $start_date ) . ' End Date: ' . TTDate::getDate( 'DATE+TIME', $end_date ), __FILE__, __LINE__, __METHOD__, 5 );

						if ( !isset( $config_vars['other']['enable_job_queue'] ) || $config_vars['other']['enable_job_queue'] == true ) {
							SystemJobQueue::Add( TTi18n::getText( 'ReCalculating Exceptions' ), $system_job_queue_batch_id, 'CalculatePolicy', 'reCalculateForJobQueue', [ $u_obj->getID(), 'calcExceptions', $date_arr ], 120 );
						} else {
							$transaction_function = function () use ( $u_obj, $flags, $date_arr ) {
								$cp = TTNew( 'CalculatePolicy' ); /** @var CalculatePolicy $cp */
								$cp->setFlag( $flags );
								$cp->setUserObject( $u_obj );
								$cp->getUserObject()->setTransactionMode( 'REPEATABLE READ' );
								$cp->addPendingCalculationDate( $date_arr );
								$cp->calculate(); //This sets timezone itself.
								$cp->Save();
								$cp->getUserObject()->setTransactionMode(); //Back to default isolation level.

								return true;
							};

							$u_obj->RetryTransaction( $transaction_function, 2, 3 ); //Set retry_sleep this fairly high so real-time punches have a chance to get saved between retries.
						}

						$i++; //User Counter
					}
				}
			}

			$x++; //Company counter

			Debug::text( 'Company: ' . $c_obj->getName() . '(' . $c_obj->getId() . ') Finished In: ' . ( microtime( true ) - $company_start_time ) . 's', __FILE__, __LINE__, __METHOD__, 5 );
		}
	}
}
?>