ElkArte\Packages\Packages::action_install2()

Complexity

Conditions	28
Paths	5094

Size

Total Lines	214
Code Lines	92

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

<?php
	public function action_install2(): void
	{
		global $txt, $context, $modSettings;

		// Make sure we don't install this addon twice.
		checkSubmitOnce('check');
		checkSession();

		// If there's no package file, what are we installing?
		$this->_filename = $this->_req->getQuery('package', 'trim');
		if (empty($this->_filename))
		{
			redirectexit('action=admin;area=packages');
		}

		// And if the file does not exist, there is a problem
		if (!$this->fileFunc->fileExists(BOARDDIR . '/packages/' . $this->_filename))
		{
			throw new Exception('package_no_file', false);
		}

		// If this is an uninstallation, we'll have an id.
		$this->install_id = $this->_req->getQuery('pid', 'intval', 0);

		// Installing in themes will require some help
		require_once(SUBSDIR . '/Themes.subs.php');

		$this->_uninstalling = $this->_req->query->sa === 'uninstall2';

		// Load up the package FTP information?
		$chmod_control = new PackageChmod();
		$chmod_control->createChmodControl(
			[],
			[
				'destination_url' => getUrl('admin', ['action' => 'admin', 'area' => 'packages', 'sa' => $this->_req->query->sa, 'package' => $this->_req->query->package])
			]
		);

		// Make sure the temp directory exists and is empty!
		if ($this->fileFunc->isDir(BOARDDIR . '/packages/temp'))
		{
			deltree(BOARDDIR . '/packages/temp', false);
		}
		else
		{
			$this->_create_temp_dir();
		}

		// Let the unpacker do the work.
		$this->_extract_files_temp();

		// Are we installing this into any custom themes?
		$custom_themes = $this->_getCustomThemes();

		// Now load up the paths of the themes that we need to know about.
		$this->theme_paths = getThemesPathbyID($custom_themes);

		// Is there any theme copying that we want to take place?
		$themes_installed = $this->_installThemes();

		// Get the package info...
		$packageInfo = getPackageInfo($this->_filename);
		if (!is_array($packageInfo))
		{
			throw new Exception($packageInfo);
		}

		$packageInfo['filename'] = $this->_filename;

		$context['base_path'] = $this->_base_path;
		$context['extracted_files'] = $this->_extracted_files;

		// Create a backup file to roll back to! (but if they do this more than once, don't run it a zillion times.)
		if (!empty($modSettings['package_make_full_backups']) && (!isset($_SESSION['last_backup_for']) || $_SESSION['last_backup_for'] != $this->_filename . ($this->_uninstalling ? '$$' : '$')))
		{
			$_SESSION['last_backup_for'] = $this->_filename . ($this->_uninstalling ? '$$' : '$');

			package_create_backup(($this->_uninstalling ? 'backup_' : 'before_') . strtok($this->_filename, '.'));
		}

		// The addon isn't installed... unless proven otherwise.
		$this->_is_installed = false;

		// Is it actually installed?
		$package_installed = isPackageInstalled($packageInfo['id'], $this->install_id);

		// Fetch the installation status and action log
		$install_log = $this->_get_package_actions($package_installed, $packageInfo, false);

		// Set up the details for the sub template, breadcrumbs, etc.
		$context['breadcrumbs'][count($context['breadcrumbs']) - 1] = [
			'url' => getUrl('admin', ['action' => 'admin', 'area' => 'packages', 'sa' => 'browse']),
			'name' => $this->_uninstalling ? $txt['uninstall'] : $txt['extracting']
		];
		$context['page_title'] .= ' - ' . ($this->_uninstalling ? $txt['uninstall'] : $txt['extracting']);
		$context['sub_template'] = 'extract_package';
		$context['filename'] = $this->_filename;
		$context['install_finished'] = false;
		$context['is_installed'] = $this->_is_installed;
		$context['uninstalling'] = $this->_uninstalling;
		$context['extract_type'] = $packageInfo['type'] ?? 'modification';

		// We're gonna be needing the table db functions! ...Sometimes.
		$table_installer = db_table();

		// @todo Make a log of any errors that occurred and output them?
		if (!empty($install_log))
		{
			$pka = new PackageActions(new EventManager());
			$pka->setUser(User::$info);
			$pka->install_init($install_log, $this->_uninstalling, $this->_base_path, $this->theme_paths, $themes_installed);
			$failed_steps = $pka->failed_steps;
			$themes_installed = $pka->themes_installed;

			package_flush_cache();

			// First, ensure this change doesn't get removed by putting a stake in the ground (So to speak).
			package_put_contents(BOARDDIR . '/packages/installed.list', time());

			// See if this is already installed
			$is_upgrade = false;
			$old_db_changes = [];
			$package_check = isPackageInstalled($packageInfo['id']);

			// Change the installed state as required.
			if (!empty($package_check['install_state']))
			{
				if ($this->_uninstalling)
				{
					setPackageState($package_check['package_id'], $this->install_id);
				}
				else
				{
					// not uninstalling so must be an upgrade
					$is_upgrade = true;
					$old_db_changes = empty($package_check['db_changes']) ? [] : $package_check['db_changes'];
				}
			}

			// Assuming we're not uninstalling, add the entry.
			if (!$this->_uninstalling)
			{
				// Any db changes from an older version?
				$table_log = $table_installer->package_log();

				if (!empty($old_db_changes))
				{
					$db_package_log = empty($table_log) ? $old_db_changes : array_merge($old_db_changes, $table_log);
				}
				else
				{
					$db_package_log = $table_log;
				}

				// If there are some database changes we might want to remove then filter them out.
				if (!empty($db_package_log))
				{
					// We're really just checking for entries which are creating table AND add columns (etc.).
					$tables = [];
					usort($db_package_log, fn(array $a, array $b): int => $this->_sort_table_first($a, $b));
					foreach ($db_package_log as $k => $log)
					{
						if ($log[0] === 'remove_table')
						{
							$tables[] = $log[1];
						}
						elseif (in_array($log[1], $tables, true))
						{
							unset($db_package_log[$k]);
						}
					}

					$package_installed['db_changes'] = serialize($db_package_log);
				}
				else
				{
					$package_installed['db_changes'] = '';
				}

				// What themes did we actually install?
				$themes_installed = array_unique($themes_installed);
				$themes_installed = implode(',', $themes_installed);

				// What failed steps?
				$failed_step_insert = serialize($failed_steps);

				// Credits tag?
				$credits_tag = (empty($pka->credits_tag)) ? '' : serialize($pka->credits_tag);

				// Add to the log packages
				addPackageLog($packageInfo, $failed_step_insert, $themes_installed, $package_installed['db_changes'], $is_upgrade, $credits_tag);
			}

			$context['install_finished'] = true;
		}

		// If there are database changes - and they want them removed - let's do it last!
		$this->removeDatabaseChanges($package_installed, $table_installer);

		// Clean house... get rid of the evidence ;).
		if ($this->fileFunc->isDir(BOARDDIR . '/packages/temp'))
		{
			deltree(BOARDDIR . '/packages/temp');
		}

		// Log what we just did.
		logAction($this->_uninstalling ? 'uninstall_package' : (empty($is_upgrade) ? 'install_package' : 'upgrade_package'), ['package' => Util::htmlspecialchars($packageInfo['name']), 'version' => Util::htmlspecialchars($packageInfo['version'])], 'admin');

		// Just in case, let's clear the whole cache to avoid anything going up the swanny.
		Cache::instance()->clean();

		// Restore file permissions?
		$chmod_control = new PackageChmod();
		$chmod_control->createChmodControl([], [], true);
	}