. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Services; use Fig\Http\Message\StatusCodeInterface; use Fisharebest\Webtrees\Carbon; use Fisharebest\Webtrees\Exceptions\HttpServerErrorException; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Site; use Fisharebest\Webtrees\Webtrees; use GuzzleHttp\Client; use GuzzleHttp\Exception\RequestException; use Illuminate\Support\Collection; use League\Flysystem\Cached\CachedAdapter; use League\Flysystem\Cached\Storage\Memory; use League\Flysystem\Filesystem; use League\Flysystem\FilesystemInterface; use League\Flysystem\ZipArchive\ZipArchiveAdapter; use ZipArchive; use function rewind; /** * Automatic upgrades. */ class UpgradeService { // Options for fetching files using GuzzleHTTP private const GUZZLE_OPTIONS = [ 'connect_timeout' => 25, 'read_timeout' => 25, 'timeout' => 55, ]; // Transfer stream data in blocks of this number of bytes. private const READ_BLOCK_SIZE = 65535; // Only check the webtrees server once per day. private const CHECK_FOR_UPDATE_INTERVAL = 24 * 60 * 60; // Fetch information about upgrades from here. // Note: earlier versions of webtrees used svn.webtrees.net, so we must maintain both URLs. private const UPDATE_URL = 'https://dev.webtrees.net/build/latest-version.txt'; // If the update server doesn't respond after this time, give up. private const HTTP_TIMEOUT = 3.0; /** @var TimeoutService */ private $timeout_service; /** * UpgradeService constructor. * * @param TimeoutService $timeout_service */ public function __construct(TimeoutService $timeout_service) { $this->timeout_service = $timeout_service; } /** * Unpack webtrees.zip. * * @param string $zip_file * @param string $target_folder * * @return void */ public function extractWebtreesZip(string $zip_file, string $target_folder): void { // The Flysystem ZIP archive adapter is painfully slow, so use the native PHP library. $zip = new ZipArchive(); if ($zip->open($zip_file) === true) { $zip->extractTo($target_folder); $zip->close(); } else { throw new HttpServerErrorException('Cannot read ZIP file. Is it corrupt?'); } } /** * Create a list of all the files in a webtrees .ZIP archive * * @param string $zip_file * * @return Collection */ public function webtreesZipContents(string $zip_file): Collection { $zip_adapter = new ZipArchiveAdapter($zip_file, null, 'webtrees'); $zip_filesystem = new Filesystem(new CachedAdapter($zip_adapter, new Memory())); $paths = new Collection($zip_filesystem->listContents('', true)); return $paths->filter(static function (array $path): bool { return $path['type'] === 'file'; }) ->map(static function (array $path): string { return $path['path']; }); } /** * Fetch a file from a URL and save it in a filesystem. * Use streams so that we can copy files larger than our available memory. * * @param string $url * @param FilesystemInterface $filesystem * @param string $path * * @return int The number of bytes downloaded */ public function downloadFile(string $url, FilesystemInterface $filesystem, string $path): int { // Overwrite any previous/partial/failed download. if ($filesystem->has($path)) { $filesystem->delete($path); } // We store the data in PHP temporary storage. $tmp = fopen('php://temp', 'wb+'); // Read from the URL $client = new Client(); $response = $client->get($url, self::GUZZLE_OPTIONS); $stream = $response->getBody(); // Download the file to temporary storage. while (!$stream->eof()) { fwrite($tmp, $stream->read(self::READ_BLOCK_SIZE)); if ($this->timeout_service->isTimeNearlyUp()) { throw new HttpServerErrorException(I18N::translate('The server’s time limit has been reached.')); } } if (is_resource($stream)) { fclose($stream); } // Copy from temporary storage to the file. $bytes = ftell($tmp); rewind($tmp); $filesystem->writeStream($path, $tmp); fclose($tmp); return $bytes; } /** * Move (copy and delete) all files from one filesystem to another. * * @param FilesystemInterface $source * @param FilesystemInterface $destination * * @return void */ public function moveFiles(FilesystemInterface $source, FilesystemInterface $destination): void { foreach ($source->listContents('', true) as $path) { if ($path['type'] === 'file') { $destination->put($path['path'], $source->read($path['path'])); $source->delete($path['path']); if ($this->timeout_service->isTimeNearlyUp()) { throw new HttpServerErrorException(I18N::translate('The server’s time limit has been reached.')); } } } } /** * Delete files in $destination that aren't in $source. * * @param FilesystemInterface $filesystem * @param Collection $folders_to_clean * @param Collection $files_to_keep * * @return void */ public function cleanFiles(FilesystemInterface $filesystem, Collection $folders_to_clean, Collection $files_to_keep): void { foreach ($folders_to_clean as $folder_to_clean) { foreach ($filesystem->listContents($folder_to_clean, true) as $path) { if ($path['type'] === 'file' && !$files_to_keep->contains($path['path'])) { $filesystem->delete($path['path']); } // If we run out of time, then just stop. if ($this->timeout_service->isTimeNearlyUp()) { return; } } } } /** * @return bool */ public function isUpgradeAvailable(): bool { // If the latest version is unavailable, we will have an empty sting which equates to version 0. return version_compare(Webtrees::VERSION, $this->fetchLatestVersion()) < 0; } /** * What is the latest version of webtrees. * * @return string */ public function latestVersion(): string { $latest_version = $this->fetchLatestVersion(); [$version] = explode('|', $latest_version); return $version; } /** * Where can we download the latest version of webtrees. * * @return string */ public function downloadUrl(): string { $latest_version = $this->fetchLatestVersion(); [, , $url] = explode('|', $latest_version . '||'); return $url; } public function startMaintenanceMode(): void { $message = I18N::translate('This website is being upgraded. Try again in a few minutes.'); file_put_contents(Webtrees::OFFLINE_FILE, $message); } public function endMaintenanceMode(): void { if (file_exists(Webtrees::OFFLINE_FILE)) { unlink(Webtrees::OFFLINE_FILE); } } /** * Check with the webtrees.net server for the latest version of webtrees. * Fetching the remote file can be slow, so check infrequently, and cache the result. * Pass the current versions of webtrees, PHP and MySQL, as the response * may be different for each. The server logs are used to generate * installation statistics which can be found at http://dev.webtrees.net/statistics.html * * @return string */ private function fetchLatestVersion(): string { $last_update_timestamp = (int) Site::getPreference('LATEST_WT_VERSION_TIMESTAMP'); $current_timestamp = Carbon::now()->unix(); if ($last_update_timestamp < $current_timestamp - self::CHECK_FOR_UPDATE_INTERVAL) { try { $client = new Client([ 'timeout' => self::HTTP_TIMEOUT, ]); $response = $client->get(self::UPDATE_URL, [ 'query' => $this->serverParameters(), ]); if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) { Site::setPreference('LATEST_WT_VERSION', $response->getBody()->getContents()); Site::setPreference('LATEST_WT_VERSION_TIMESTAMP', (string) $current_timestamp); } } catch (RequestException $ex) { // Can't connect to the server? // Use the existing information about latest versions. } } return Site::getPreference('LATEST_WT_VERSION'); } /** * The upgrade server needs to know a little about this server. */ private function serverParameters(): array { $operating_system = DIRECTORY_SEPARATOR === '/' ? 'u' : 'w'; return [ 'w' => Webtrees::VERSION, 'p' => PHP_VERSION, 'o' => $operating_system, ]; } }