TimeTrex/classes/modules/core/Environment.class.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 Core
 */
class Environment {

	static protected $template_dir = 'templates';
	static protected $template_compile_dir = 'templates_c';

	/**
	 * Remove duplicate slashes from URLs and file paths.
	 * @param $path
	 * @return mixed
	 */
	static function stripDuplicateSlashes( $path ) {
		if ( strpos( $path, ':' ) === false ) {
			return preg_replace( '/\/+/', '/', $path ); //Handle file paths, including ones that start with duplicate slashes, ie: //tmp/test.php
		} else {
			return preg_replace( '/([^:])(\/{2,})/', '$1/', $path ); //Handle URLs without replacing http:// or https:// at the beginning.
		}
	}

	static function stripBadPathChars( $path ) {
		return str_replace( [ ';', ',', ' ', "\n", "\t", "\r", "\013", "\014" ], '', trim( $path ) ); //Remove bad chars that can't go in cookie paths and just don't make sense in a URL/File path.
	}

	/**
	 * @return string
	 */
	static function getBasePath() {
		return dirname(__FILE__, 4) . DIRECTORY_SEPARATOR; // return directory 4 levels up from this file + seperator as includes expect it
	}

	/**
	 * @return string
	 */
	static function getHostName() {
		return Misc::getHostName( true );
	}

	/**
	 * @return mixed
	 */
	static function getBaseURL() {
		global $config_vars;

		$retval = '/';

		if ( isset( $config_vars['path']['base_url'] ) ) {
			$config_vars['path']['base_url'] = self::stripBadPathChars( $config_vars['path']['base_url'] );
			if ( substr( $config_vars['path']['base_url'], -1 ) != '/' ) {
				$retval = $config_vars['path']['base_url'] . '/'; //Don't use directory separator here
			} else {
				$retval = $config_vars['path']['base_url'];
			}
		}

		return self::stripDuplicateSlashes( $retval );
	}

	/**
	 * Due to how the legacy interface is handled, we need to use the this function to determine the URL to redirect too,
	 * as the base_url needs to be /interface most of the time, for images and such to load properly.
	 * @return mixed
	 */
	static function getDefaultInterfaceBaseURL() {
		return self::getBaseURL();
	}

	/**
	 * @param null $api
	 * @return mixed|string
	 */
	static function getCookieBaseURL( $api = null ) {
		//  "/timetrex/interface"
		//  "/timetrex/api/json"
		//  "/timetrex" <- cookie must go here.
		$retval = str_replace( '\\', '/', dirname( dirname( self::getAPIBaseURL( $api ) ) ) ); //PHP5 compatible. dirname(self::getAPIBaseURL(), 2) only works in PHP7. Also Windows tends to use backslashes in some cases, since this is a URL switch to forward slash always.

		if ( $retval == '' ) {
			$retval = '/';
		}

		return $retval;
	}

	/**
	 * Returns the BASE_URL for the API functions.
	 * @param null $api
	 * @return mixed
	 */
	static function getAPIBaseURL( $api = null ) {
		global $config_vars;

		if ( !isset( $config_vars['path']['base_url'] ) ) {
			$config_vars['path']['base_url'] = '';
		}

		//If "interface" appears in the base URL, replace it with API directory
		$base_url = str_replace( [ '/interface', '/api' ], '', rtrim( self::stripBadPathChars( $config_vars['path']['base_url'] ), '/' ) );

		if ( $api == '' ) {
			if ( defined( 'TIMETREX_LEGACY_SOAP_API' ) && TIMETREX_LEGACY_SOAP_API == true ) {
				return self::stripDuplicateSlashes( $base_url . '/soap/' );
			} else if ( defined( 'TIMETREX_SOAP_API' ) && TIMETREX_SOAP_API == true ) {
				$api = 'soap';
			} else if ( defined( 'TIMETREX_JSON_API' ) && TIMETREX_JSON_API == true ) {
				$api = 'json';
			} else if ( defined( 'TIMETREX_REPORT_API' ) && TIMETREX_REPORT_API == true ) {
				$api = 'report';
			} else {
				$api = 'json'; //If this is called from something like index.php, default to the JSON api.
			}
		}

		$base_url = self::stripDuplicateSlashes( $base_url . '/api/' . $api . '/' );

		return $base_url;
	}

	/**
	 * @param $api
	 * @return string
	 */
	static function getAPIURL( $api ) {
		return self::getAPIBaseURL( $api ) . 'api.php';
	}

	/**
	 * @return string
	 */
	static function getImagesPath() {
		return self::getBasePath() . DIRECTORY_SEPARATOR . 'interface' . DIRECTORY_SEPARATOR . 'images' . DIRECTORY_SEPARATOR;
	}

	/**
	 * @return string
	 */
	static function getImagesURL() {
		return self::getBaseURL() . 'images/';
	}

	/**
	 * @return string
	 */
	static function getStorageBasePath() {
		global $config_vars;

		return $config_vars['path']['storage'] . DIRECTORY_SEPARATOR;
	}

	/**
	 * @return string
	 */
	static function getLogBasePath() {
		global $config_vars;

		return $config_vars['path']['log'] . DIRECTORY_SEPARATOR;
	}

}

?>