362 lines
15 KiB
PHP
362 lines
15 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".
|
||
|
|
*
|
||
|
|
********************************************************************************/
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @package API\Users
|
||
|
|
*/
|
||
|
|
class APIUserReportData extends APIFactory {
|
||
|
|
protected $main_class = 'UserReportDataFactory';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* APIUserReportData constructor.
|
||
|
|
*/
|
||
|
|
public function __construct() {
|
||
|
|
parent::__construct(); //Make sure parent constructor is always called.
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get user data for one or more users.
|
||
|
|
* @param array $data filter data
|
||
|
|
* @param bool $disable_paging
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function getUserReportData( $data = null, $disable_paging = false ) {
|
||
|
|
|
||
|
|
$data = $this->initializeFilterAndPager( $data, $disable_paging );
|
||
|
|
|
||
|
|
//Only allow getting report data for currently logged in user.
|
||
|
|
$data['filter_data']['user_id'] = $this->getCurrentUserObject()->getId();
|
||
|
|
|
||
|
|
//This is done so that users can set a saved report on payroll remittance agency event and then other users can run the tax wizard with that same saved report.
|
||
|
|
if ( isset( $data['filter_data']['id'] ) && $this->getPermissionObject()->Check( 'pay_stub', 'add' ) && $this->getPermissionObject()->Check( 'pay_stub', 'edit' ) ) {
|
||
|
|
//FIXME: perhaps add additional checks that the id is specified in a payroll remittance agency event.
|
||
|
|
unset( $data['filter_data']['user_id'] );
|
||
|
|
}
|
||
|
|
|
||
|
|
Debug::Arr( $data, 'Getting User Report Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
$ugdlf = TTnew( 'UserReportDataListFactory' ); /** @var UserReportDataListFactory $ugdlf */
|
||
|
|
$ugdlf->getAPISearchByCompanyIdAndArrayCriteria( $this->getCurrentCompanyObject()->getId(), $data['filter_data'], $data['filter_items_per_page'], $data['filter_page'], null, $data['filter_sort'] );
|
||
|
|
Debug::Text( 'Record Count: ' . $ugdlf->getRecordCount(), __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
if ( $ugdlf->getRecordCount() > 0 ) {
|
||
|
|
$this->setPagerObject( $ugdlf );
|
||
|
|
|
||
|
|
$retarr = [];
|
||
|
|
foreach ( $ugdlf as $ugd_obj ) {
|
||
|
|
$retarr[] = $ugd_obj->getObjectAsArray( $data['filter_columns'] );
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->returnHandler( $retarr );
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->returnHandler( true );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set user data for one or more users.
|
||
|
|
* @param array $data user data
|
||
|
|
* @param bool $validate_only
|
||
|
|
* @param bool $ignore_warning
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function setUserReportData( $data, $validate_only = false, $ignore_warning = true ) {
|
||
|
|
if ( !is_array( $data ) ) {
|
||
|
|
return $this->returnHandler( false );
|
||
|
|
}
|
||
|
|
$validate_only = (bool)$validate_only;
|
||
|
|
$ignore_warning = (bool)$ignore_warning;
|
||
|
|
|
||
|
|
[ $data, $total_records ] = $this->convertToMultipleRecords( $data );
|
||
|
|
Debug::Text( 'Received data for: ' . $total_records . ' Users', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
Debug::Arr( $data, 'Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
if ( $validate_only == true ) {
|
||
|
|
Debug::Text( 'Validating Only!', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
$permission_children_ids = false;
|
||
|
|
} else {
|
||
|
|
//Get Permission Hierarchy Children first, as this can be used for viewing, or editing.
|
||
|
|
$permission_children_ids = $this->getPermissionChildren();
|
||
|
|
}
|
||
|
|
|
||
|
|
$validator_stats = [ 'total_records' => $total_records, 'valid_records' => 0 ];
|
||
|
|
$validator = $save_result = []; $key = false;
|
||
|
|
if ( is_array( $data ) && $total_records > 0 ) {
|
||
|
|
foreach ( $data as $key => $row ) {
|
||
|
|
$row['company_id'] = $this->getCurrentUserObject()->getCompany();
|
||
|
|
|
||
|
|
if ( !isset( $row['user_id'] )
|
||
|
|
|| !( $this->getPermissionObject()->Check( 'user', 'view' ) || ( $this->getPermissionObject()->Check( 'user', 'view_child' ) && $this->getPermissionObject()->isChild( $row['user_id'], $permission_children_ids ) === true ) ) ) {
|
||
|
|
//Force user_id to currently logged in user.
|
||
|
|
Debug::Text( 'Forcing user_id...', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
$row['user_id'] = $this->getCurrentUserObject()->getId();
|
||
|
|
}
|
||
|
|
|
||
|
|
$primary_validator = new Validator();
|
||
|
|
// The value of auto_refresh is directly placed into a <script> block and must be sanitized to an int. Note htmlspecialchars would not offer protection here.
|
||
|
|
if ( isset( $row['data']['config']['other']['auto_refresh'] ) ) {
|
||
|
|
$row['data']['config']['other']['auto_refresh'] = (int)$primary_validator->stripNonNumeric( trim( $row['data']['config']['other']['auto_refresh'] ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
$lf = TTnew( 'UserReportDataListFactory' ); /** @var UserReportDataListFactory $lf */
|
||
|
|
$lf->StartTransaction();
|
||
|
|
if ( isset( $row['id'] ) && $row['id'] != '' && $row['id'] != TTUUID::getZeroID() ) {
|
||
|
|
//Modifying existing object.
|
||
|
|
//Get user object, so we can only modify just changed data for specific records if needed.
|
||
|
|
$lf->getByUserIdAndId( $row['user_id'], $row['id'] );
|
||
|
|
if ( $lf->getRecordCount() == 1 ) {
|
||
|
|
//Object exists, check edit permissions
|
||
|
|
$lf = $lf->getCurrent(); //Make the current $lf variable the current object, otherwise getDataDifferences() fails to function.
|
||
|
|
$row = array_merge( $lf->getObjectAsArray(), $row );
|
||
|
|
} else {
|
||
|
|
//Object doesn't exist.
|
||
|
|
$primary_validator->isTrue( 'id', false, TTi18n::gettext( 'Edit permission denied, employee does not exist' ) );
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
//Adding new object, check ADD permissions.
|
||
|
|
//$primary_validator->isTrue( 'permission', $this->getPermissionObject()->Check('user', 'add'), TTi18n::gettext('Add permission denied') );
|
||
|
|
|
||
|
|
//If the user sets the Saved Report navigation dropdown box to "-- NONE --" a zero UUID will come through as the 'id', so clear that out so it saves properly.
|
||
|
|
unset( $row['id'] );
|
||
|
|
}
|
||
|
|
Debug::Arr( $row, 'User Report Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
$is_valid = $primary_validator->isValid();
|
||
|
|
if ( $is_valid == true ) { //Check to see if all permission checks passed before trying to save data.
|
||
|
|
Debug::Text( 'Attempting to save User Report Data...', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
//Force Company ID to current company.
|
||
|
|
$row['company_id'] = $this->getCurrentCompanyObject()->getId();
|
||
|
|
|
||
|
|
$lf->setObjectFromArray( $row );
|
||
|
|
|
||
|
|
//$lf->setUser( $this->getCurrentUserObject()->getId() ); //Need to be able support copying reports to other users.
|
||
|
|
|
||
|
|
$lf->Validator->setValidateOnly( $validate_only );
|
||
|
|
|
||
|
|
$is_valid = $lf->isValid( $ignore_warning );
|
||
|
|
if ( $is_valid == true ) {
|
||
|
|
Debug::Text( 'Saving User Data...', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
if ( $validate_only == true ) {
|
||
|
|
$save_result[$key] = true;
|
||
|
|
} else {
|
||
|
|
$save_result[$key] = $lf->Save();
|
||
|
|
}
|
||
|
|
$validator_stats['valid_records']++;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( $is_valid == false ) {
|
||
|
|
Debug::Text( 'Data is Invalid...', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
$lf->FailTransaction(); //Just rollback this single record, continue on to the rest.
|
||
|
|
|
||
|
|
$validator[$key] = $this->setValidationArray( [ $primary_validator, $lf ] );
|
||
|
|
} else if ( $validate_only == true ) {
|
||
|
|
//Always fail transaction when valididate only is used, as is saved to different tables immediately.
|
||
|
|
$lf->FailTransaction();
|
||
|
|
}
|
||
|
|
|
||
|
|
$lf->CommitTransaction();
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->handleRecordValidationResults( $validator, $validator_stats, $key, $save_result );
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->returnHandler( false );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Validate user data for one or more users.
|
||
|
|
* @param array $data user data
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function validateUserReportData( $data ) {
|
||
|
|
return $this->setUserReportData( $data, true );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete one or more users.
|
||
|
|
* @param array $data user data
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function deleteUserReportData( $data ) {
|
||
|
|
Debug::Arr( $data, 'DataA: ', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
if ( !is_array( $data ) ) {
|
||
|
|
$data = [ $data ];
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( !is_array( $data ) ) {
|
||
|
|
return $this->returnHandler( false );
|
||
|
|
}
|
||
|
|
|
||
|
|
Debug::Text( 'Received data for: ' . count( $data ) . ' Users', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
Debug::Arr( $data, 'Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
$total_records = count( $data );
|
||
|
|
$validator = $save_result = []; $key = false;
|
||
|
|
$validator_stats = [ 'total_records' => $total_records, 'valid_records' => 0 ];
|
||
|
|
if ( is_array( $data ) && $total_records > 0 ) {
|
||
|
|
foreach ( $data as $key => $id ) {
|
||
|
|
$primary_validator = new Validator();
|
||
|
|
$lf = TTnew( 'UserReportDataListFactory' ); /** @var UserReportDataListFactory $lf */
|
||
|
|
$lf->StartTransaction();
|
||
|
|
if ( $id != '' ) {
|
||
|
|
//Modifying existing object.
|
||
|
|
//Get user object, so we can only modify just changed data for specific records if needed.
|
||
|
|
$lf->getByUserIdAndId( $this->getCurrentUserObject()->getId(), $id );
|
||
|
|
if ( $lf->getRecordCount() == 1 ) {
|
||
|
|
//Object exists
|
||
|
|
Debug::Text( 'User Report Data Exists, deleting record: ' . $id, __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
$lf = $lf->getCurrent();
|
||
|
|
} else {
|
||
|
|
//Object doesn't exist.
|
||
|
|
$primary_validator->isTrue( 'id', false, TTi18n::gettext( 'Delete permission denied, report data does not exist' ) );
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
$primary_validator->isTrue( 'id', false, TTi18n::gettext( 'Delete permission denied, report data does not exist' ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
//Debug::Arr($lf, 'AData: ', __FILE__, __LINE__, __METHOD__, 10);
|
||
|
|
|
||
|
|
$is_valid = $primary_validator->isValid();
|
||
|
|
if ( $is_valid == true ) { //Check to see if all permission checks passed before trying to save data.
|
||
|
|
Debug::Text( 'Attempting to delete user report data...', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
$lf->setDeleted( true );
|
||
|
|
|
||
|
|
$is_valid = $lf->isValid();
|
||
|
|
if ( $is_valid == true ) {
|
||
|
|
Debug::Text( 'User Deleted...', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
$save_result[$key] = $lf->Save();
|
||
|
|
$validator_stats['valid_records']++;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( $is_valid == false ) {
|
||
|
|
Debug::Text( 'User Report Data is Invalid...', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
$lf->FailTransaction(); //Just rollback this single record, continue on to the rest.
|
||
|
|
|
||
|
|
$validator[$key] = $this->setValidationArray( [ $primary_validator, $lf ] );
|
||
|
|
}
|
||
|
|
|
||
|
|
$lf->CommitTransaction();
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->handleRecordValidationResults( $validator, $validator_stats, $key, $save_result );
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->returnHandler( false );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Share or copy report to other users.
|
||
|
|
* @param array $user_report_data_ids User Report Data row IDs
|
||
|
|
* @param array $destination_user_ids User IDs to copy reports to
|
||
|
|
* @return array|bool
|
||
|
|
*/
|
||
|
|
function shareUserReportData( $user_report_data_ids, $destination_user_ids ) {
|
||
|
|
if ( !is_array( $user_report_data_ids ) ) {
|
||
|
|
$user_report_data_ids = [ $user_report_data_ids ];
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( !is_array( $destination_user_ids ) ) {
|
||
|
|
$destination_user_ids = [ $destination_user_ids ];
|
||
|
|
}
|
||
|
|
|
||
|
|
Debug::Arr( $user_report_data_ids, 'User Report Data IDs: ', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
Debug::Arr( $destination_user_ids, 'Destination User IDs: ', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
$src_rows = $this->stripReturnHandler( $this->getUserReportData( [ 'filter_data' => [ 'id' => $user_report_data_ids ] ] ) );
|
||
|
|
if ( is_array( $src_rows ) && count( $src_rows ) > 0 ) {
|
||
|
|
Debug::Arr( $src_rows, 'SRC Rows: ', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
$dst_rows = [];
|
||
|
|
|
||
|
|
$x = 0;
|
||
|
|
foreach ( $src_rows as $key => $row ) {
|
||
|
|
unset( $src_rows[$key]['id'], $src_rows[$key]['created_date'], $src_rows[$key]['created_by'] ); //Clear fields that can't be copied
|
||
|
|
$src_rows[$key]['name'] = Misc::generateShareName( $this->getCurrentUserObject()->getFullName(), $row['name'] ); //Generate unique name
|
||
|
|
|
||
|
|
$description = null;
|
||
|
|
if ( isset( $row['description'] ) && $row['description'] != '' ) {
|
||
|
|
$description = $row['description'] . "\n";
|
||
|
|
}
|
||
|
|
$src_rows[$key]['description'] = $description . TTi18n::getText( 'Report shared by' ) . ' ' . $this->getCurrentUserObject()->getFullName() . ' ' . TTi18n::getText( 'on' ) . ' ' . TTDate::getDate( 'DATE+TIME', time() );
|
||
|
|
|
||
|
|
//Do not copy over is_default value so that users cannot set default for other users.
|
||
|
|
$src_rows[$key]['is_default'] = false;
|
||
|
|
|
||
|
|
//Should we copy any schedules that go along with each saved report? This could cause a lot of issues with mass emails being sent out without intention.
|
||
|
|
|
||
|
|
$urdf = TTnew( 'UserReportDataFactory' ); /** @var UserReportDataFactory $urdf */
|
||
|
|
|
||
|
|
//Copy to destination users.
|
||
|
|
if ( is_array( $destination_user_ids ) ) {
|
||
|
|
foreach ( $destination_user_ids as $destination_user_id ) {
|
||
|
|
$dst_rows[$x] = $src_rows[$key];
|
||
|
|
$dst_rows[$x]['user_id'] = $destination_user_id;
|
||
|
|
|
||
|
|
$ulf = TTnew( 'UserListFactory' ); /** @var UserListFactory $ulf */
|
||
|
|
$ulf->getByIdAndCompanyId( $destination_user_id, $this->getCurrentUserObject()->getCompany() );
|
||
|
|
if ( $ulf->getRecordCount() == 1 ) {
|
||
|
|
TTLog::addEntry( TTUUID::castUUID( $row['id'] ), 500, TTi18n::getText( 'Shared report with' ) . ': ' . $ulf->getCurrent()->getFullName( false, true ), null, $urdf->getTable() );
|
||
|
|
}
|
||
|
|
|
||
|
|
$x++;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
unset( $src_rows );
|
||
|
|
Debug::Arr( $dst_rows, 'DST Rows: ', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
return $this->setUserReportData( $dst_rows ); //Save copied rows
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->returnHandler( false );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
?>
|