egroupware_official/phpgwapi/inc/functions.inc.php

<?php
/**
 * eGroupWare API loader
 *
 * Rewritten by RalfBecker@outdoor-training.de to store the eGW enviroment
 * (egw-object and egw_info-array) in a php-session and restore it from
 * there instead of creating it completly new on each page-request.
 * The enviroment gets now created by the egw-class
 * 
 * This file was originaly written by Dan Kuykendall and Joseph Engo
 * Copyright (C) 2000, 2001 Dan Kuykendall
 *
 * @link http://www.egroupware.org
 * @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
 * @package api
 * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
 * @version $Id$
 */

error_reporting(E_ALL & ~E_NOTICE);
magic_quotes_runtime(false);

$egw_min_php_version = '5.1';
if (!function_exists('version_compare') || version_compare(PHP_VERSION,$egw_min_php_version) < 0)
{
	die("eGroupWare requires PHP $egw_min_php_version or greater.<br />Please contact your System Administrator to upgrade PHP!");
}
// check if eGW's pear repository is installed and prefer it over the other ones
if (is_dir(EGW_SERVER_ROOT.'/egw-pear'))	
{
	set_include_path(EGW_SERVER_ROOT.'/egw-pear'.PATH_SEPARATOR.get_include_path());
	//echo "<p align=right>include_path='".get_include_path()."'</p>\n";
}

if (!defined('EGW_API_INC')) define('EGW_API_INC',PHPGW_API_INC);	// this is to support the header upgrade

/* Make sure the header.inc.php is current. */
if (!isset($GLOBALS['egw_domain']) || $GLOBALS['egw_info']['server']['versions']['header'] < $GLOBALS['egw_info']['server']['versions']['current_header'])
{
	echo '<center><b>You need to update your header.inc.php file to version '.
	$GLOBALS['egw_info']['server']['versions']['current_header'].
	' by running <a href="setup/manageheader.php">setup/headeradmin</a>.</b></center>';
	exit;
}

/* Make sure the developer is following the rules. */
if (!isset($GLOBALS['egw_info']['flags']['currentapp']))
{
	echo "<p><b>!!! YOU DO NOT HAVE YOUR \$GLOBALS['egw_info']['flags']['currentapp'] SET !!!<br>\n";
	echo '!!! PLEASE CORRECT THIS SITUATION !!!</b></p>';
}

include(EGW_API_INC.'/common_functions.inc.php');

if (extension_loaded('memcache') && ini_get('session.save_handler') == 'memcache')
{
	include(EGW_API_INC.'/memcache.inc.php');
}
// check if we can restore the eGW enviroment from the php-session
if ($GLOBALS['egw_info']['server']['sessions_type'] == 'php4-restore' && $_REQUEST['sessionid'])
{
	session_name('sessionid');
	ini_set('session.use_cookies',0);	// disable the automatic use of cookies, as it uses the path / by default
	session_id($_REQUEST['sessionid']);
	session_start();

	if ($GLOBALS['egw_info']['flags']['currentapp'] != 'login' && $GLOBALS['egw_info']['flags']['currentapp'] != 'logout')
	{
		if (is_array($_SESSION['egw_info_cache']) && is_array($_SESSION['egw_included_files']) && $_SESSION['egw_object_cache'])
		{
			// marking the context as restored from the session, used by session->verify to not read the date from the db again
			$GLOBALS['egw_info']['flags']['restored_from_session'] = true;

			// restoring the egw_info-array
			$flags = $GLOBALS['egw_info']['flags'];
			$GLOBALS['egw_info'] = $_SESSION['egw_info_cache'];
			$GLOBALS['egw_info']['flags'] = $flags;
			unset($flags);

			// including the necessary class-definitions
			foreach($_SESSION['egw_included_files'] as $file)
			{
				//echo "<p>about to include $file</p>\n";
				include_once($file);

				if (basename($file) == 'class.egw_framework.inc.php') break;	// the rest is not needed and makes only problems
			}
			$GLOBALS['egw'] = unserialize($_SESSION['egw_object_cache']);
			
			if (is_object($GLOBALS['egw']))
			{
				$GLOBALS['egw']->wakeup2();	// adapt the restored egw-object/enviroment to this request (eg. changed current app)

				//printf("<p style=\"position: absolute; right: 0px; top: 0px;\">egw-enviroment restored in %d ms</p>\n",1000*(perfgetmicrotime()-$GLOBALS['egw_info']['flags']['page_start_time']));
				if (is_object($GLOBALS['egw']->translation)) return;	// exit this file, as the rest of the file creates a new egw-object and -enviroment
			}
			// egw object could NOT be restored from the session, create a new one
			unset($GLOBALS['egw']);
			$GLOBALS['egw_info'] = array('flags'=>$GLOBALS['egw_info']['flags']);
			unset($GLOBALS['egw_info']['flags']['restored_from_session']);
			unset($_SESSION['egw_info_cache']);
			unset($_SESSION['egw_included_files']);
			unset($_SESSION['egw_object_cache']);
		}
		//echo "<p>could not restore egw_info and the egw-object!!!</p>\n";
	}
	else	// destroy the session-cache if called by login or logout
	{
		unset($_SESSION['egw_info_cache']);
		unset($_SESSION['egw_included_files']);
		unset($_SESSION['egw_object_cache']);
	}
}
print_debug('sane environment','messageonly','api');

/****************************************************************************\
* Multi-Domain support                                                       *
\****************************************************************************/

if (!isset($GLOBALS['egw_info']['server']['default_domain']) ||	// allow to overwrite the default domain
	!isset($GLOBALS['egw_domain'][$GLOBALS['egw_info']['server']['default_domain']]))
{
	if(isset($GLOBALS['egw_domain'][$_SERVER['SERVER_NAME']]))
	{
		$GLOBALS['egw_info']['server']['default_domain'] = $_SERVER['SERVER_NAME'];
	}
	else
	{
		$domain_part = explode('.',$_SERVER['SERVER_NAME']);
		array_shift($domain_part);
		$domain_part = implode('.',$domain_part);
		if(isset($GLOBALS['egw_domain'][$domain_part]))
		{
			$GLOBALS['egw_info']['server']['default_domain'] = $domain_part;
		}
		else
		{
			reset($GLOBALS['egw_domain']);
			list($GLOBALS['egw_info']['server']['default_domain']) = each($GLOBALS['egw_domain']);
		}
		unset($domain_part);
	}
}
if (isset($_POST['login']))	// on login
{
	$GLOBALS['login'] = $_POST['login'];
	if (strpos($GLOBALS['login'],'@') === False || count($GLOBALS['egw_domain']) == 1)
	{
		$GLOBALS['login'] .= '@' . get_var('logindomain',array('POST'),$GLOBALS['egw_info']['server']['default_domain']);
	}
	$parts = explode('@',$GLOBALS['login']);
	$GLOBALS['egw_info']['user']['domain'] = array_pop($parts);
}
else	// on "normal" pageview
{
	$GLOBALS['egw_info']['user']['domain'] = get_var('domain',array('GET','COOKIE'),false);
}
if (@isset($GLOBALS['egw_domain'][$GLOBALS['egw_info']['user']['domain']]))
{
	$GLOBALS['egw_info']['server']['db_host'] = $GLOBALS['egw_domain'][$GLOBALS['egw_info']['user']['domain']]['db_host'];
	$GLOBALS['egw_info']['server']['db_port'] = $GLOBALS['egw_domain'][$GLOBALS['egw_info']['user']['domain']]['db_port'];
	$GLOBALS['egw_info']['server']['db_name'] = $GLOBALS['egw_domain'][$GLOBALS['egw_info']['user']['domain']]['db_name'];
	$GLOBALS['egw_info']['server']['db_user'] = $GLOBALS['egw_domain'][$GLOBALS['egw_info']['user']['domain']]['db_user'];
	$GLOBALS['egw_info']['server']['db_pass'] = $GLOBALS['egw_domain'][$GLOBALS['egw_info']['user']['domain']]['db_pass'];
	$GLOBALS['egw_info']['server']['db_type'] = $GLOBALS['egw_domain'][$GLOBALS['egw_info']['user']['domain']]['db_type'];
}
else
{
	$GLOBALS['egw_info']['server']['db_host'] = $GLOBALS['egw_domain'][$GLOBALS['egw_info']['server']['default_domain']]['db_host'];
	$GLOBALS['egw_info']['server']['db_port'] = $GLOBALS['egw_domain'][$GLOBALS['egw_info']['server']['default_domain']]['db_port'];
	$GLOBALS['egw_info']['server']['db_name'] = $GLOBALS['egw_domain'][$GLOBALS['egw_info']['server']['default_domain']]['db_name'];
	$GLOBALS['egw_info']['server']['db_user'] = $GLOBALS['egw_domain'][$GLOBALS['egw_info']['server']['default_domain']]['db_user'];
	$GLOBALS['egw_info']['server']['db_pass'] = $GLOBALS['egw_domain'][$GLOBALS['egw_info']['server']['default_domain']]['db_pass'];
	$GLOBALS['egw_info']['server']['db_type'] = $GLOBALS['egw_domain'][$GLOBALS['egw_info']['server']['default_domain']]['db_type'];
}
print_debug('domain',@$GLOBALS['egw_info']['user']['domain'],'api');

// the egw-object instanciates all sub-classes (eg. $GLOBALS['egw']->db) and the egw_info array
$GLOBALS['egw'] =& CreateObject('phpgwapi.egw',array_keys($GLOBALS['egw_domain']));

if ($GLOBALS['egw_info']['flags']['currentapp'] != 'login')
{
	if (!$GLOBALS['egw_info']['server']['show_domain_selectbox'])
	{
		unset ($GLOBALS['egw_domain']); // we kill this for security reasons
	}
	//printf("<p style=\"position: absolute; right: 0px; top: 0px;\">egw-enviroment new created in %d ms</p>\n",1000*(perfgetmicrotime()-$GLOBALS['egw_info']['flags']['page_start_time']));
}

// saving the the egw_info array and the egw-object in the session
if ($GLOBALS['egw_info']['server']['sessions_type'] == 'php4-restore' && $GLOBALS['egw_info']['flags']['currentapp'] != 'login')
{
	$_SESSION['egw_info_cache'] = $GLOBALS['egw_info'];
	unset($_SESSION['egw_info_cache']['flags']);	// dont save the flags, they change on each request

	// exclude 1: caller, 2: the header.inc.php, 3: phpgwapi/setup/setup.inc.php, 4: phpgwapi/inc/functions.inc.php (this file) 
	$_SESSION['egw_included_files'] = array();
	foreach(array_slice(get_included_files(),4) as $file)
	{
		switch(basename($file))
		{
			case 'head.inc.php':	// needs EGW_TEMPLATE_DIR and is included anyway by common::egw_header()
			case 'functions.inc.php': // not needed/wanted at all
				break;
			default:
				$_SESSION['egw_included_files'][] = $file;
		}
	}
	$_SESSION['egw_object_cache'] = serialize($GLOBALS['egw']);
}

/**
 * php5 autoload function for eGroupWare understanding the following naming schema:
 *	1. new (prefered) nameing schema: app_class_something loading app/inc/class.class_something.inc.php
 *	2. API classe: classname loading phpgwapi/inc/class.classname.inc.php
 *	3. eTemplate classes: classname loading etemplate/inc/class.classname.inc.php
 *	4. classes of the current app: classname loading $GLOBALS['egw_info']['flags']['currentapp']/inc/class.classname.inc.php
 *
 * @param string $class name of class to load
 */
function __autoload($class)
{
	list($app) = explode('_',$class);
	
	// classes using the new naming schema app_class_name, eg. admin_cmd
	if (file_exists($file = EGW_INCLUDE_ROOT.'/'.$app.'/inc/class.'.$class.'.inc.php') ||
		// eGW api classes using the old naming schema, eg. html
		file_exists($file = EGW_API_INC.'/inc/class.'.$class.'.inc.php') ||
		// eGW eTemplate classes using the old naming schema, eg. etemplate
		file_exists($file = EGW_INCLUDE_ROOT.'/etemplate/inc/class.'.$class.'.inc.php') ||
		// classes of the current application using the old naming schema
		file_exists($file = EGW_INCLUDE_ROOT.'/'.$GLOBALS['egw_info']['flags']['currentapp'].'/inc/class.'.$class.'.inc.php'))
	{
		//error_log("autoloaded class $class from $file");
		include_once($file);
	}
}