<?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\Core
*/
class APIAbout extends APIFactory {
protected $main_class = false;
/**
* APIAbout constructor.
*/
public function __construct() {
parent::__construct(); //Make sure parent constructor is always called.
return true;
}
/**
* Get about data .
* @param int $ytd
* @param bool $all_companies
* @return array
*/
function getAboutData( $ytd = 0, $all_companies = false ) {
global $config_vars;
$clf = new CompanyListFactory();
$sslf = new SystemSettingListFactory();
$system_settings = $sslf->getAllArray();
$clf->getByID( PRIMARY_COMPANY_ID );
if ( $clf->getRecordCount() == 1 ) {
$primary_company = $clf->getCurrent();
}
$current_user = $this->getCurrentUserObject();
if ( isset( $primary_company ) && PRIMARY_COMPANY_ID == $current_user->getCompany() ) {
$current_company = $primary_company;
} else {
$current_company = $clf->getByID( $current_user->getCompany() )->getCurrent();
}
//$current_user_prefs = $current_user->getUserPreferenceObject();
$data = $system_settings;
//Only show new version notice if they are ONSITE or PRIMARY company.
if ( ( isset( $data['new_version'] ) && $data['new_version'] == true ) && ( ( DEPLOYMENT_ON_DEMAND == false && $current_company->getId() == 1 ) || ( isset( $config_vars['other']['primary_company_id'] ) && $current_company->getId() == $config_vars['other']['primary_company_id'] ) ) ) {
$data['new_version'] = true;
} else {
$data['new_version'] = false;
}
$data['product_edition'] = Option::getByKey( ( DEPLOYMENT_ON_DEMAND == true ) ? $current_company->getProductEdition() : getTTProductEdition(), $current_company->getOptions( 'product_edition' ) );
$data['application_name'] = APPLICATION_NAME;
$data['organization_url'] = ORGANIZATION_URL;
if ( DEPLOYMENT_ON_DEMAND == false ) {
$data['operating_system'] = php_uname( 's' ) .' '. php_uname( 'r' ) .' '. php_uname( 'v' ) .' '. php_uname( 'm' );
$data['php_version'] = PHP_VERSION;
} else {
$data['operating_system'] = false;
$data['php_version'] = false;
}
//Get Employee counts for this month, and last month
$month_of_year_arr = TTDate::getMonthOfYearArray();
//This month
if ( isset( $ytd ) && $ytd == 1 ) {
$begin_month_epoch = strtotime( '-2 years' );
} else {
$begin_month_epoch = TTDate::getBeginMonthEpoch( ( TTDate::getBeginMonthEpoch( time() ) - 86400 ) );
}
$cuclf = TTnew( 'CompanyUserCountListFactory' ); /** @var CompanyUserCountListFactory $cuclf */
if ( isset( $config_vars['other']['primary_company_id'] ) && $current_company->getId() == $config_vars['other']['primary_company_id'] && $all_companies == true ) {
$cuclf->getTotalMonthlyMinAvgMaxByCompanyStatusAndStartDateAndEndDate( 10, $begin_month_epoch, TTDate::getEndMonthEpoch( time() ), null, null, null, [ 'date_stamp' => 'desc' ] );
} else {
$cuclf->getMonthlyMinAvgMaxByCompanyIdAndStartDateAndEndDate( $current_company->getId(), $begin_month_epoch, TTDate::getEndMonthEpoch( time() ), null, null, null, [ 'date_stamp' => 'desc' ] );
}
Debug::Text( 'Company User Count Rows: ' . $cuclf->getRecordCount(), __FILE__, __LINE__, __METHOD__, 10 );
if ( $cuclf->getRecordCount() > 0 ) {
foreach ( $cuclf as $cuc_obj ) {
$data['user_counts'][] = [
//'label' => $month_of_year_arr[TTDate::getMonth( $begin_month_epoch )] .' '. TTDate::getYear($begin_month_epoch),
'label' => $month_of_year_arr[TTDate::getMonth( TTDate::strtotime( $cuc_obj->getColumn( 'date_stamp' ) ) )] . ' ' . TTDate::getYear( TTDate::strtotime( $cuc_obj->getColumn( 'date_stamp' ) ) ),
'max_active_users' => $cuc_obj->getColumn( 'max_active_users' ),
'max_inactive_users' => $cuc_obj->getColumn( 'max_inactive_users' ),
'max_deleted_users' => $cuc_obj->getColumn( 'max_deleted_users' ),
];
}
}
if ( isset( $data['user_counts'] ) == false ) {
$data['user_counts'] = [];
}
$cjlf = TTnew( 'CronJobListFactory' ); /** @var CronJobListFactory $cjlf */
$cjlf->getMostRecentlyRun();
if ( $cjlf->getRecordCount() > 0 ) {
$cj_obj = $cjlf->getCurrent();
$data['cron'] = [
'last_run_date' => ( $cj_obj->getLastRunDate() == false ) ? TTi18n::getText( 'Never' ) : TTDate::getDate( 'DATE+TIME', $cj_obj->getLastRunDate() ),
];
}
$data['show_license_data'] = false;
$obj_class = "\124\124\114\x69\x63\x65\x6e\x73\x65"; $license = @new $obj_class;
if ( ( ( DEPLOYMENT_ON_DEMAND == false ) || ( isset( $config_vars['other']['primary_company_id'] ) && $current_company->getId() == $config_vars['other']['primary_company_id'] ) ) && getTTProductEdition() >= TT_PRODUCT_PROFESSIONAL ) {
if ( !isset( $system_settings['license'] ) ) {
$system_settings['license'] = null;
}
$data['show_license_data'] = true;
//Set this so the license upload area at least shows up regardles of edition.
$data['license_data'] = [];
$retval = $license->validateLicense( $system_settings['license'] );
if ( $retval == true ) {
$data['license_data'] = [
'organization_name' => $license->getOrganizationName(),
'major_version' => $license->getMajorVersion(),
'minor_version' => $license->getMinorVersion(),
'product_name' => $license->getProductName(),
'active_employee_licenses' => $license->getActiveEmployeeLicenses(),
'issue_date' => TTDate::getDate( 'DATE', $license->getIssueDate() ),
'expire_date' => $license->getExpireDate(),
'expire_date_display' => TTDate::getDate( 'DATE', $license->getExpireDate() ),
'registration_key' => $license->getRegistrationKey(),
'message' => $license->getFullErrorMessage( $retval ),
'retval' => $retval,
];
}
}
$data['system_version'] = $data['system_version'] . ' ( ' . TTDate::getDate( 'DATE+TIME', $data['system_version_install_date'] ) . ' )';
$data['hardware_id'] = $license->getHardwareID();
//Debug::Arr($data, 'Data: ', __FILE__, __LINE__, __METHOD__, 10);
return $this->returnHandler( $data );
}
/**
* @param int $ytd
* @param bool $all_companies
* @return array
*/
function isNewVersionAvailable( $ytd = 0, $all_companies = false ) {
Debug::Text( 'Check For Update!', __FILE__, __LINE__, __METHOD__, 10 );
$current_company = $this->getCurrentCompanyObject();
$data = $this->stripReturnHandler( $this->getAboutData( $ytd, $all_companies ) );
$ttsc = new TimeTrexSoapClient();
//We must ensure that the data is up to date
//Otherwise version check will fail.
$ttsc->sendCompanyData( $current_company->getId(), true );
$ttsc->sendCompanyUserLocationData( $current_company->getId() );
$ttsc->sendCompanyUserCountData( $current_company->getId() );
$ttsc->sendCompanyVersionData( $current_company->getId() );
$current_company->removeCache( 'license', 'system_setting' ); //Clear the cache before attempting to get license again, just in case the cache is corrupted somehow, perhaps due to firewall/proxy blocking the connection, which then gets mistakenly cached.
$obj_class = "\124\124\114\x69\x63\x65\x6e\x73\x65"; $license = @new $obj_class;
$license->getLicenseFile( false ); //Download updated license file if one exists. -- *NOTE: This does not have retry/failover like TimeTrexSoapClient does.
$latest_version = $ttsc->isLatestVersion( $current_company->getId() );
if ( $latest_version == false ) {
SystemSettingFactory::setSystemSetting( 'new_version', 1 );
$data['new_version'] = true;
} else {
SystemSettingFactory::setSystemSetting( 'new_version', 0 );
$data['new_version'] = false;
}
return $this->returnHandler( $data );
}
/**
* @param $toggle
* @return bool
*/
function setSystemDiagnostic( $toggle ) {
//Must at least have permissions to edit a user and be part of primary company.
if ( $this->getCurrentCompanyObject()->getId() !== PRIMARY_COMPANY_ID || !$this->getPermissionObject()->Check( 'company', 'edit_own' ) ) {
return $this->getPermissionObject()->PermissionDenied();
}
SystemDiagnostic::setSystemDiagnostic( $toggle );
return $this->returnHandler( true );
}
/**
* @return bool
*/
function uploadSystemDiagnostic() {
//Must at least have permissions to edit a company and be part of primary company.
if ( $this->getCurrentCompanyObject()->getId() !== PRIMARY_COMPANY_ID || !$this->getPermissionObject()->Check( 'company', 'edit_own' ) ) {
return $this->getPermissionObject()->PermissionDenied();
}
$this->getProgressBarObject()->setDefaultKey( $this->getAPIMessageID() );
$sd_obj = TTnew( 'SystemDiagnostic' ); /** @var SystemDiagnostic $sd_obj */
$sd_obj->setProgressBarObject( $this->getProgressBarObject() ); //Expose progress bar object to system diagnostic object.
$sd_obj->setAPIMessageID( $this->getAPIMessageID() );
$sd_obj->uploadSystemDiagnostic( $this->getCurrentCompanyObject(), false );
return $this->returnHandler( true );
}
/**
* @return string|bool
*/
function testConnectionDiagnostic() {
if ( $this->getCurrentCompanyObject()->getId() !== PRIMARY_COMPANY_ID || !$this->getPermissionObject()->Check( 'company', 'edit_own' ) ) {
return $this->getPermissionObject()->PermissionDenied();
}
$retval = '';
$this->getProgressBarObject()->setDefaultKey( $this->getAPIMessageID() );
$ping_key = uniqid(); //Pass a unique key into the PING() function so we can be 100% certain we have a good connection when its returned.
Debug::Text( 'Checking if connection to license server works... Ping Key: '. $ping_key, __FILE__, __LINE__, __METHOD__, 10 );
$this->getProgressBarObject()->start( $this->getAPIMessageID(), 5, null, TTi18n::getText( 'Checking HTTPS connection on port 443...' ) );
$check_https_port = Misc::isPortOpen( 'www.timetrex.com', 443 );
if ( $check_https_port == true ) {
Debug::Text( ' Port 443 is open...', __FILE__, __LINE__, __METHOD__, 10 );
$this->getProgressBarObject()->set( $this->getAPIMessageID(), 2, TTi18n::getText( 'Checking secure communication port 443...' ) );
$retval .= TTi18n::getText( 'Port 443 is open...' )."<br>\n";
//Do a SOAP ping call.
$ttsc = new TimeTrexSoapClient();
if ( $ttsc->Ping( $ping_key ) == $ping_key ) { //This could automatically fall back to port 80 communication and still succeed.
Debug::Text( ' SOAP Ping() successful! Connection is good!', __FILE__, __LINE__, __METHOD__, 10 );
$this->getProgressBarObject()->set( $this->getAPIMessageID(), 3, TTi18n::getText( 'Connection is good!' ) );
$retval = true;
} else {
//Could be SeLinux blocking the connection?
Debug::Text( ' SOAP Ping() using SSL failed!', __FILE__, __LINE__, __METHOD__, 10 );
$this->getProgressBarObject()->set( $this->getAPIMessageID(), 3, TTi18n::getText( 'Secure communication on port 443 failed!' ) );
$retval .= TTi18n::getText( 'Port 443 is open but communications is blocked or being modified...' )."<br>\n";
}
} else {
$retval .= TTi18n::getText( 'Port 443 is blocked...' )."<br>\n";
Debug::Text( ' Port 443 is blocked!', __FILE__, __LINE__, __METHOD__, 10 );
$this->getProgressBarObject()->set( $this->getAPIMessageID(), 2, TTi18n::getText( 'Communication on port 443 is blocked!' ) );
}
if ( $retval !== true ) {
Debug::Text( ' SSL communications failed, check non-SSL just in case...', __FILE__, __LINE__, __METHOD__, 10 );
$this->getProgressBarObject()->set( $this->getAPIMessageID(), 3, TTi18n::getText( 'Checking connection on port 80...' ) );
$check_http_port = Misc::isPortOpen( 'www.timetrex.com', 80 );
if ( $check_http_port == true ) {
$this->getProgressBarObject()->set( $this->getAPIMessageID(), 4, TTi18n::getText( 'Checking communications on port 80...' ) );
$retval .= TTi18n::getText( 'Port 80 is open...' )."<br>\n";
//Do a SOAP ping call.
$ttsc = new TimeTrexSoapClient();
if ( $ttsc->Ping( $ping_key ) == $ping_key ) {
Debug::Text( ' SOAP Ping() successful! Connection is good!', __FILE__, __LINE__, __METHOD__, 10 );
$this->getProgressBarObject()->set( $this->getAPIMessageID(), 5, TTi18n::getText( 'Connection on port 80 is good!' ) );
$retval .= TTi18n::getText( 'Fallback communication on port 80 succeeded, but secure communication failed...' )."<br>\n";
//$retval = true; //Don't set retval to TRUE has SSL on port 443 still failed.
} else {
Debug::Text( ' SOAP Ping() using non-SSL failed!', __FILE__, __LINE__, __METHOD__, 10 );
$this->getProgressBarObject()->set( $this->getAPIMessageID(), 5, TTi18n::getText( 'Communication on port 80 failed!' ) );
$retval .= TTi18n::getText( 'Communication on port 80 is blocked or has been modified...' )."<br>\n";
}
} else {
$this->getProgressBarObject()->set( $this->getAPIMessageID(), 4, TTi18n::getText( 'Communication on port 80 is blocked!' ) );
$retval .= TTi18n::getText( 'Port 80 is blocked...' )."<br>\n";
}
}
if ( $retval !== true ) {
$retval = TTi18n::getText( 'Connection test failed!' )."<br>\n<br>\n". $retval;
$retval .= "<br>\n<br>\n".TTi18n::getText( 'Please check firewall to ensure outbound HTTPS communication on port 443 is allowed.' );
if ( OPERATING_SYSTEM == 'WIN' ) {
$retval .= "<br>\n".TTi18n::getText( 'Then check security/antivirus systems such as Norton/McAfee/AVG are not blocking outbound HTTP/HTTPS communications.' );
} else {
$retval .= "<br>\n".TTi18n::getText( 'Then check security systems such as seLinux are not blocking outbound HTTP/HTTPS communications.' );
}
}
return $this->returnHandler( $retval );
}
}
?>