setup_process::pass()

Complexity

Conditions	34
Paths	13585

Size

Total Lines	154
Code Lines	84

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

<?php
	function pass(array $setup_info,$method='new',$DEBUG=False,$force_en=False,$preset_config=array())
	{
		unset($force_en);	// no longer used

		if(!$method)
		{
			return False;
		}

		// update to 16.x with no api installed yet
		if ($method == 'upgrade' && !isset($setup_info['api']['currentver']))
		{
			// remove api dependency
			unset($setup_info['phpgwapi']['depends']['api']);

			$pass['phpgwapi'] = $setup_info['phpgwapi'];

$pass was never initialized. Although not strictly required by PHP, it is generally a good practice to add $pass = array(); before regardless.

			$pass['emailadmin'] = $setup_info['emailadmin'];
			$pass['api'] = $setup_info['api'];

			// mark api as already installed in version 14.3.907
			$setup_info['api']['version'] = $setup_info['api']['currentversion'] = '14.3.907';
			$GLOBALS['egw_setup']->register_app('api', 99, $setup_info);
			$setup_info['api']['version'] = $pass['api']['version'];
		}
		// new install or upgrade after 16.x api is installed
		else
		{
			$pass['api'] = $setup_info['api'];
			if (file_exists(EGW_SERVER_ROOT.'/phpgwapi') && is_readable(EGW_SERVER_ROOT.'/phpgwapi'))
			{
				$pass['phpgwapi'] = $setup_info['phpgwapi'];
			}
			// ignore emailadmin, it's only there for updates
			unset($setup_info['emailadmin']);
		}
		$pass['admin']    = $setup_info['admin'];
		$pass['preferences'] = $setup_info['preferences'];
		if (file_exists(EGW_SERVER_ROOT.'/etemplate'))
		{
			$pass['etemplate'] = $setup_info['etemplate'];	// helps to minimize passes, as many apps depend on it
		}
		$this->api_version_target = $setup_info['api']['version'];

		$i = 1;
		$passed = array();
		$passing = array();
		$pass_string = implode (':', array_keys($pass));
		$passing_string = implode (':', array_keys($passing));
		while($pass_string != $passing_string)
		{
			$passing = array();
			if($DEBUG) { echo '<br>process->pass(): #' . $i . ' for ' . $method . ' processing' . "\n"; }

			// Check current versions and dependencies
			$setup_info = $GLOBALS['egw_setup']->detection->check_depends(
				$GLOBALS['egw_setup']->detection->compare_versions(
					$GLOBALS['egw_setup']->detection->get_db_versions($setup_info), true));

			// stuff the rest of the apps, but only those with available upgrades
			foreach($setup_info as $key => $value)
			{
				// check if app is either installed or supports the used database
				if (!isset($value['currentver']) && isset($value['only_db']) && (
					is_array($value['only_db']) && !in_array($GLOBALS['egw_setup']->db->Type,$value['only_db']) ||
					!is_array($value['only_db']) && $GLOBALS['egw_setup']->db->Type != $value['only_db']))
				{
					continue;	// app does not support this db-type, dont try installing it
				}
				if(/*$value['name'] != 'phpgwapi' &&*/ $value['status'] == 'U')
				{
					if($passed[$value['name']]['status'] != 'F' && $passed[$value['name']]['status'] != 'C')
					{
						$pass[$value['name']] = $setup_info[$value['name']];
					}
				}
			}

			switch($method)
			{
				case 'new':
					if (empty($GLOBALS['egw_info']['server']['temp_dir']))
					{
						$GLOBALS['egw_info']['server']['temp_dir'] = sys_get_temp_dir();
					}
					/* Create tables and insert new records for each app in this list */
					$passing_c = $this->current($pass,$DEBUG);
					if (isset($pass['api'])) $this->save_minimal_config($preset_config);
					$passing = $this->default_records($passing_c,$DEBUG);
					break;
				case 'upgrade':
					/* Run upgrade scripts on each app in the list */
					$passing = $this->upgrade($pass,$DEBUG);
					//_debug_array($pass);exit;
					break;
				default:
					/* What the heck are you doing? */
					return False;
			}

			$pass = array();
			foreach($passing as $key => $value)
			{
				if($value['status'] == 'C')
				{
					$passed[$value['name']] = $passing[$value['name']];
					if($DEBUG) { echo '<br>process->pass(): '.$passed[$value['name']]['name'] . ' install completed'."\n"; }
				}
				elseif($value['status'] == 'F')
				{
					$setup_info[$value['name']] = $passing[$value['name']];
					if($DEBUG) { echo '<br>process->pass(): '.$setup_info[$value['name']]['name'] . ' install failed'."\n"; }
				}
				elseif($value['status'] == 'D')
				{
					$pass[$value['name']] = $setup_info[$value['name']];
					if($DEBUG) { echo '<br>process->pass(): '.$pass[$value['name']]['name'] . ' fails dependency check on this pass'."\n"; }
				}
				else
				{
					$tmp = $passing[$value['name']]['name'];
					if($DEBUG) { echo '<br>process->pass(): '.$tmp . ' skipped on this pass'."\n"; }
				}
			}

			$i++;
			if($i == 20) /* Then oops it broke */
			{
				echo '<br>Setup failure: excess looping in process->pass():'."\n";
				echo '<br>Pass:<br>'."\n";
				_debug_array($pass);
				echo '<br>Passed:<br>'."\n";
				_debug_array($passed);
				exit;

Using exit here is not recommended.

			}
			$pass_string = implode (':', array_keys($pass));
			$passing_string = implode (':', array_keys($passing));
		}

		// remove all apps which should be automatic deinstalled
		if (($deinstall = setup_cmd::check_autodeinstall()))
		{
			$this->remove($deinstall, $setup_info, $DEBUG);
		}

		try {
			// flush instance cache: also registers hooks and flushes image cache
			Api\Cache::flush(Api\Cache::INSTANCE);
		}
		catch(Exception $e) {
			unset($e);
			// ignore exception, as during a new install, there's no cache configured and therefore no need to unset
		}
		/* now return the list */
		return array_merge($setup_info,$passed);
	}