FreshRSS/lib/lib_install.php

<?php
declare(strict_types=1);

FreshRSS_SystemConfiguration::register('default_system', join_path(FRESHRSS_PATH, 'config.default.php'));
FreshRSS_UserConfiguration::register('default_user', join_path(FRESHRSS_PATH, 'config-user.default.php'));

/**
 * GMP is needed to convert entry identifiers to the Google Reader format on 32-bit PHP.
 *
 * @return 'ok'|'ko'|null
 */
function gmpRequirementStatus(int $integerSize = PHP_INT_SIZE, ?bool $gmpLoaded = null): ?string {
	if ($integerSize >= 8) {
		return null;
	}

	return ($gmpLoaded ?? extension_loaded('gmp')) ? 'ok' : 'ko';
}

/**
 * @param 'mysql'|'pgsql'|'sqlite'|'' $dbType
 * @return array<string,'ok'|'ko'|'warn'>
 */
function checkRequirements(string $dbType = '', bool $checkPhp = true, bool $checkFiles = true): array {
	$php = version_compare(PHP_VERSION, FRESHRSS_MIN_PHP_VERSION) >= 0;
	$curl = extension_loaded('curl');	// TODO: We actually require cURL >= 7.52 for CURLPROXY_HTTPS
	$pdo_mysql = extension_loaded('pdo_mysql');
	$pdo_sqlite = extension_loaded('pdo_sqlite');
	$pdo_pgsql = extension_loaded('pdo_pgsql');
	switch ($dbType) {
		case 'mysql':
			$pdo_sqlite = $pdo_pgsql = true;
			$pdo = $pdo_mysql;
			break;
		case 'sqlite':
			$pdo_mysql = $pdo_pgsql = true;
			$pdo = $pdo_sqlite;
			break;
		case 'pgsql':
			$pdo_mysql = $pdo_sqlite = true;
			$pdo = $pdo_pgsql;
			break;
		case '':
			$pdo = $pdo_mysql || $pdo_sqlite || $pdo_pgsql;
			break;
		default:
			throw new InvalidArgumentException('Invalid database type!');
	}
	$pdo &= class_exists('PDO');
	$pcre = extension_loaded('pcre');
	$ctype = extension_loaded('ctype');
	$fileinfo = extension_loaded('fileinfo');
	$dom = class_exists('DOMDocument');
	$xml = function_exists('xml_parser_create');
	$json = function_exists('json_encode');
	$intl = extension_loaded('intl');
	$mbstring = extension_loaded('mbstring');
	$zip = extension_loaded('zip');
	$gmp = gmpRequirementStatus();
	$data = is_dir(DATA_PATH) && touch(DATA_PATH . '/index.html');	// is_writable() is not reliable for a folder on NFS
	$cache = is_dir(CACHE_PATH) && touch(CACHE_PATH . '/index.html');
	$tmp = is_dir(TMP_PATH) && is_writable(TMP_PATH);
	$users = is_dir(USERS_PATH) && touch(USERS_PATH . '/index.html');
	$favicons = is_dir(DATA_PATH) && touch(DATA_PATH . '/favicons/index.html');
	$tokens = is_dir(DATA_PATH) && touch(DATA_PATH . '/tokens/index.html');
	// An unknown or incorrect document root might web-expose folders such as `./data`.
	// An empty `DOCUMENT_ROOT` outside of a Web server context (e.g. CLI, cron) is ignored because `realpath('')` resolves to the current directory.
	$documentRoot = $_SERVER['DOCUMENT_ROOT'] ?? null;
	$docRootPath = is_string($documentRoot) && $documentRoot !== '' ? realpath($documentRoot) : false;
	$docRootOk = $documentRoot === '' || ($docRootPath !== false && $docRootPath === realpath(PUBLIC_PATH));

	$result = [];
	if ($checkPhp) {
		$result += [
			'php' => $php ? 'ok' : 'ko',
			'pdo' => $pdo ? 'ok' : 'ko',
			'pdo-sqlite' => $pdo_sqlite ? 'ok' : ($dbType === 'sqlite' ? 'ko' : 'warn'),
			'pdo-pgsql' => ($dbType === 'pgsql' && !$pdo_pgsql) ? 'ko' : null,
			'pdo-mysql' => ($dbType === 'mysql' && !$pdo_mysql) ? 'ko' : null,
			'dom' => $dom ? 'ok' : 'ko',
			'xml' => $xml ? 'ok' : 'ko',
			'curl' => $curl ? 'ok' : 'ko',
			'pcre' => $pcre ? 'ok' : 'ko',
			'ctype' => $ctype ? 'ok' : 'ko',
			'json' => $json ? 'ok' : 'ko',
			'mbstring' => $mbstring ? 'ok' : 'warn',
			'intl' => $intl ? 'ok' : 'warn',
			'zip' => $zip ? 'ok' : 'warn',
			'fileinfo' => $fileinfo ? 'ok' : 'warn',
			'gmp' => $gmp,
		];
	}

	if ($checkFiles) {
		$result += [
			'data' => $data ? 'ok' : 'ko',
			'cache' => $cache ? 'ok' : 'ko',
			'tmp' => $tmp ? 'ok' : 'ko',
			'users' => $users ? 'ok' : 'ko',
			'favicons' => $favicons ? 'ok' : 'ko',
			'tokens' => $tokens ? 'ok' : 'ko',
			'docroot' => $docRootOk ? 'ok' : 'warn',
		];
	}

	if ($checkPhp && $checkFiles) {
		$result['all'] = $php && $curl && $json && $pdo && $pcre && $ctype && $dom && $xml && $gmp !== 'ko' &&
			$data && $cache && $tmp && $users && $favicons && $tokens ? 'ok' : 'ko';
	}

	$result = array_filter($result, static fn($v) => $v !== null);
	return $result;
}

function generateSalt(): string {
	return hash('sha256', uniqid(more_entropy: true) . implode('', stat(__FILE__) ?: []) . random_bytes(32));
}

/**
 * @throws FreshRSS_Context_Exception
 */
function initDb(): string {
	$db = FreshRSS_Context::systemConf()->db;
	if (empty($db['pdo_options'])) {
		$db['pdo_options'] = [];
	}
	$db['pdo_options'][PDO::ATTR_ERRMODE] = PDO::ERRMODE_EXCEPTION;
	FreshRSS_Context::systemConf()->db = $db;	//TODO: Remove this Minz limitation "Indirect modification of overloaded property"

	if (empty($db['type'])) {
		$db['type'] = 'sqlite';
	}

	//Attempt to auto-create database if it does not already exist
	if ($db['type'] !== 'sqlite') {
		Minz_ModelPdo::$usesSharedPdo = false;
		$dbBase = $db['base'] ?? '';
		//For first connection, use default database for PostgreSQL, empty database for MySQL / MariaDB:
		$db['base'] = $db['type'] === 'pgsql' ? 'postgres' : '';
		FreshRSS_Context::systemConf()->db = $db;
		try {
			//First connection without database name to create the database
			$databaseDAO = FreshRSS_Factory::createDatabaseDAO();
		} catch (Exception $ex) {
			$databaseDAO = null;
		}
		//Restore final database parameters for auto-creation and for future connections
		$db['base'] = $dbBase;
		FreshRSS_Context::systemConf()->db = $db;
		if ($databaseDAO != null) {
			//Perform database auto-creation
			$databaseDAO->create();
		}
	}

	//New connection with the database name
	$databaseDAO = FreshRSS_Factory::createDatabaseDAO();
	Minz_ModelPdo::$usesSharedPdo = true;
	return $databaseDAO->testConnection();
}

function setupMigrations(): bool {
	$migrations_path = APP_PATH . '/migrations';
	$migrations_version_path = DATA_PATH . '/applied_migrations.txt';

	$migrator = new Minz_Migrator($migrations_path);
	$versions = implode("\n", $migrator->versions());
	return @file_put_contents($migrations_version_path, $versions) !== false;
}