258 lines
10 KiB
PHP
258 lines
10 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".
|
|
*
|
|
********************************************************************************/
|
|
if ( PHP_SAPI != 'cli' ) {
|
|
echo "This script can only be called from the Command Line.\n";
|
|
exit;
|
|
}
|
|
require_once( dirname( __FILE__ ) . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'classes' . DIRECTORY_SEPARATOR . 'modules' . DIRECTORY_SEPARATOR . 'api' . DIRECTORY_SEPARATOR . 'client' . DIRECTORY_SEPARATOR . 'TimeTrexClientAPI.class.php' );
|
|
|
|
//Example: php export_report.php -server "http://192.168.1.1/timetrex/api/soap/api.php" -username myusername -password mypass -report UserSummaryReport -template "by_employee+contact" /tmp/employee_list.csv csv
|
|
// php export_report.php -server "http://192.168.1.1/timetrex/api/soap/api.php" -username myusername -password mypass -report UserSummaryReport -time_period last_year /tmp/employee_list.csv csv
|
|
// php export_report.php -server "http://192.168.1.1/timetrex/api/soap/api.php" -username myusername -password mypass -report UserSummaryReport -time_period custom_date -filter start_date=01-Jan-19,end_date=31-Jan-19 /tmp/employee_list.csv csv
|
|
// php export_report.php -server "http://192.168.1.1/timetrex/api/soap/api.php" -username myusername -password mypass -report UserSummaryReport -time_period custom_date -filter date_stamp="\=>29-Jun-19 & <\=29-Jun-19" /tmp/employee_list.csv csv
|
|
// php export_report.php -server "http://192.168.1.1/timetrex/api/json/api.php" -username myusername -password mypass -report PayrollExportReport -saved_report MySavedReport /tmp/payroll_export.csv payroll_export
|
|
if ( $argc < 3 || in_array( $argv[1], [ '--help', '-help', '-h', '-?' ] ) ) {
|
|
$help_output = "Usage: export_report.php [OPTIONS] [output file] [file format]\n";
|
|
$help_output .= "\n";
|
|
$help_output .= " Options:\n";
|
|
$help_output .= " -server <URL> URL to API server\n";
|
|
$help_output .= " -username <username> API username\n";
|
|
$help_output .= " -password <password> API password\n";
|
|
$help_output .= " -api_key <key> API key to use instead of username/password\n";
|
|
$help_output .= " -report <report> Report to export (ie: TimesheetDetailReport,TimesheetSummaryReport,ScheduleSummaryReport,UserSummaryReport,PayStubSummaryReport)\n";
|
|
$help_output .= " -saved_report <name> Name of saved report\n";
|
|
$help_output .= " -template <template> Name of template\n";
|
|
$help_output .= " -time_period <name> Time Period for report\n";
|
|
$help_output .= " -filter <name>=<value>,<name>=<value> Other filter options\n";
|
|
|
|
echo $help_output;
|
|
} else {
|
|
//Handle command line arguments
|
|
$last_arg = count( $argv ) - 1;
|
|
|
|
if ( in_array( '-n', $argv ) ) {
|
|
$dry_run = true;
|
|
} else {
|
|
$dry_run = false;
|
|
}
|
|
|
|
if ( in_array( '-server', $argv ) ) {
|
|
$api_url = trim( $argv[array_search( '-server', $argv ) + 1] );
|
|
} else {
|
|
$api_url = false;
|
|
}
|
|
|
|
if ( in_array( '-username', $argv ) ) {
|
|
$username = trim( $argv[array_search( '-username', $argv ) + 1] );
|
|
} else {
|
|
$username = false;
|
|
}
|
|
|
|
if ( in_array( '-password', $argv ) ) {
|
|
$password = trim( $argv[array_search( '-password', $argv ) + 1] );
|
|
} else {
|
|
$password = false;
|
|
}
|
|
|
|
if ( in_array( '-api_key', $argv ) ) {
|
|
$api_key = trim( $argv[array_search( '-api_key', $argv ) + 1] );
|
|
} else {
|
|
$api_key = false;
|
|
}
|
|
|
|
if ( in_array( '-report', $argv ) ) {
|
|
$report = trim( $argv[array_search( '-report', $argv ) + 1] );
|
|
} else {
|
|
$report = false;
|
|
}
|
|
|
|
if ( in_array( '-template', $argv ) ) {
|
|
$template = trim( $argv[array_search( '-template', $argv ) + 1] );
|
|
} else {
|
|
$template = false;
|
|
}
|
|
|
|
if ( in_array( '-saved_report', $argv ) ) {
|
|
$saved_report = trim( $argv[array_search( '-saved_report', $argv ) + 1] );
|
|
} else {
|
|
$saved_report = false;
|
|
}
|
|
|
|
if ( in_array( '-time_period', $argv ) ) {
|
|
$time_period = trim( $argv[array_search( '-time_period', $argv ) + 1] );
|
|
} else {
|
|
$time_period = false;
|
|
}
|
|
|
|
if ( in_array( '-filter', $argv ) ) {
|
|
//Allow handling escapted deliminters so we can handle date ranges like: >=01-Jan-18 without the "=" being treated as a different name/value pair.
|
|
$other_filter = preg_split( '~(?<!\\\)' . preg_quote( ',', '~' ) . '~', trim( $argv[array_search( '-filter', $argv ) + 1] ) );
|
|
if ( is_array( $other_filter ) ) {
|
|
foreach ( $other_filter as $tmp_other_filter ) {
|
|
//$split_other_filter = explode('=', $tmp_other_filter);
|
|
$split_other_filter = preg_split( '~(?<!\\\)' . preg_quote( '=', '~' ) . '~', $tmp_other_filter );
|
|
if ( isset( $split_other_filter[0] ) && isset( $split_other_filter[1] ) ) {
|
|
$split_other_filter[1] = str_replace( '\=', '=', $split_other_filter[1] ); //Unescape deliminter
|
|
if ( isset( $override_filter[$split_other_filter[0]] ) ) { //Handle array of data.
|
|
$override_filter[$split_other_filter[0]][] = $split_other_filter[1];
|
|
} else {
|
|
$override_filter[$split_other_filter[0]] = $split_other_filter[1];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
$override_filter = false;
|
|
}
|
|
|
|
$output_file = null;
|
|
if ( isset( $argv[$last_arg - 1] ) && $argv[$last_arg - 1] != '' ) {
|
|
$output_file = $argv[$last_arg - 1];
|
|
}
|
|
|
|
$file_format = 'csv';
|
|
if ( isset( $argv[$last_arg] ) && $argv[$last_arg] != '' ) {
|
|
$file_format = $argv[$last_arg];
|
|
}
|
|
|
|
if ( !isset( $output_file ) ) {
|
|
echo "Output File not set!\n";
|
|
exit;
|
|
}
|
|
|
|
$TIMETREX_URL = $api_url;
|
|
|
|
if ( isset( $api_key ) && $api_key != '' ) {
|
|
$TIMETREX_SESSION_ID = $api_key;
|
|
$api_session = new TimeTrexClientAPI();
|
|
//if ( $api_session->isLoggedIn() == false ) {
|
|
// echo "API Key is incorrect!\n";
|
|
// exit( 1 );
|
|
//}
|
|
} else {
|
|
$api_session = new TimeTrexClientAPI();
|
|
$api_session->Login( $username, $password );
|
|
if ( $TIMETREX_SESSION_ID == false ) {
|
|
echo "API Username/Password is incorrect!\nIf multifactor authentication is enabled, login to TimeTrex and go to Profile -> Security / Passwords, More (...) -> Register API Key.\n";
|
|
exit( 1 );
|
|
}
|
|
//echo "Session ID: $TIMETREX_SESSION_ID\n";
|
|
}
|
|
|
|
if ( $report != '' ) {
|
|
$report_obj = new TimeTrexClientAPI( $report );
|
|
|
|
$config = [];
|
|
|
|
if ( $saved_report != '' ) {
|
|
$saved_report_obj = new TimeTrexClientAPI( 'UserReportData' );
|
|
//Make sure we limit to this to the report script, otherwise the user could choose the wrong script/report but the right saved report name and the settings won't match.
|
|
$saved_report_result = $saved_report_obj->getUserReportData( [ 'filter_data' => [ 'name' => trim( $saved_report ) ] ] );
|
|
$saved_report_data = $saved_report_result->getResult();
|
|
if ( is_array( $saved_report_data ) && isset( $saved_report_data[0] ) && isset( $saved_report_data[0]['data'] ) ) {
|
|
if ( strtolower( $saved_report_data[0]['script'] ) != strtolower( $report ) ) {
|
|
echo "ERROR: Saved report: ". $saved_report ." exists for another report of type: ". $saved_report_data[0]['script'] .". Please try that instead.\n";
|
|
exit( 1 );
|
|
} else {
|
|
$config = $saved_report_data[0]['data']['config'];
|
|
}
|
|
} else {
|
|
echo "ERROR: Saved report not found...\n";
|
|
exit( 1 );
|
|
}
|
|
} else if ( $template != '' ) {
|
|
$config_result = $report_obj->getTemplate( $template );
|
|
$config = $config_result->getResult();
|
|
}
|
|
|
|
if ( $time_period != '' ) {
|
|
$config['time_period']['time_period'] = $time_period;
|
|
}
|
|
|
|
|
|
$form_config_result = $report_obj->getCompanyFormConfig();
|
|
if ( is_object( $form_config_result ) && $form_config_result->isValid() == true ) {
|
|
$tmp_form_config = $form_config_result->getResult();
|
|
if ( is_array( $tmp_form_config) ) {
|
|
$config['form'] = $form_config_result->getResult();
|
|
}
|
|
}
|
|
|
|
|
|
if ( isset( $override_filter ) && is_array( $override_filter ) ) {
|
|
$config = array_merge( $config, $override_filter );
|
|
}
|
|
//var_dump($config);
|
|
|
|
|
|
$result = $report_obj->getReport( $config, strtolower( $file_format ) );
|
|
if ( is_object( $result ) ) {
|
|
$retval = $result->getResult();
|
|
if ( is_array( $retval ) ) {
|
|
if ( isset( $retval['file_name'] ) && $output_file == '' ) {
|
|
$output_file = $retval['file_name'];
|
|
}
|
|
file_put_contents( $output_file, base64_decode( $retval['data'] ) );
|
|
} else {
|
|
//Check for exception and show user. Likely caused by invalid report name specified.
|
|
if ( $retval === false && $result->getCode() == 'EXCEPTION' ) {
|
|
echo "ERROR: Exception running report: ". $result->getDescription() ."...\n";
|
|
exit( 1 );
|
|
}
|
|
//var_dump( $retval );
|
|
//echo "ERROR: No report data...\n";
|
|
//exit( 1 );
|
|
|
|
//When using JSON API, the server might send a raw file to download, so just save it directly into it.
|
|
file_put_contents( $output_file, $retval );
|
|
}
|
|
} else {
|
|
echo "ERROR: Request failed, no object returned...\n";
|
|
exit ( 1 );
|
|
}
|
|
} else {
|
|
echo "ERROR: No report specified...\n";
|
|
exit( 1 );
|
|
}
|
|
}
|
|
?>
|