feat: allow to extend .user.ini on update

When running nextcloud with a web hoster it might be necessary
to extend .user.ini after each update (e.g. adding memory_limit).
To automate this step, an additional config entry may be provided
in config.php that specifies the lines to be added to .user.ini.

If the config option 'user_ini_additional_lines' exists, the provided
value (string or array of strings) will be added to .user.ini.

Signed-off-by: Mathias Koehrer <koehrer08@koehrer-mail.de>

Author: makoehr

index.php

@@ -27,8 +27,6 @@ class LogException extends \Exception {
 }
 
 
-use CurlHandle;
-
 class Updater {
 	private string $nextcloudDir;
 	private array $configValues = [];
@@ -280,7 +278,6 @@ private function getExpectedElementsList(): array {
 			'COPYING-AGPL',
 			'occ',
 			'db_structure.xml',
-			'REUSE.toml',
 		];
 		return array_merge($expected, $this->getAppDirectories());
 	}
@@ -520,7 +517,20 @@ private function getUpdateServerResponse(): array {
 		$this->silentLog('[info] updateURL: ' . $updateURL);
 
 		// Download update response
-		$curl = $this->getCurl($updateURL);
+		$curl = curl_init();
+		curl_setopt_array($curl, [
+			CURLOPT_RETURNTRANSFER => 1,
+			CURLOPT_URL => $updateURL,
+			CURLOPT_USERAGENT => 'Nextcloud Updater',
+		]);
+
+		if ($this->getConfigOption('proxy') !== null) {
+			curl_setopt_array($curl, [
+				CURLOPT_PROXY => $this->getConfigOptionString('proxy'),
+				CURLOPT_PROXYUSERPWD => $this->getConfigOptionString('proxyuserpwd'),
+				CURLOPT_HTTPPROXYTUNNEL => $this->getConfigOption('proxy') ? 1 : 0,
+			]);
+		}
 
 		/** @var false|string $response */
 		$response = curl_exec($curl);
@@ -555,20 +565,19 @@ private function getUpdateServerResponse(): array {
 	 *
 	 * @throws \Exception
 	 */
-	public function downloadUpdate(?string $url = null): void {
+	public function downloadUpdate(): void {
 		$this->silentLog('[info] downloadUpdate()');
 
-		if ($url) {
-			// If a URL is provided, use it directly
-			$downloadURLs = [$url];
-		} else {
-			// Otherwise, get the download URLs from the update server
-			$downloadURLs = $this->getDownloadURLs();
+		$response = $this->getUpdateServerResponse();
+		if (!isset($response['url']) || !is_string($response['url'])) {
+			throw new \Exception('Response from update server is missing url');
 		}
 
-		$this->silentLog('[info] will try to download archive from: ' . implode(', ', $downloadURLs));
-
 		$storageLocation = $this->getUpdateDirectoryLocation() . '/updater-' . $this->getConfigOptionMandatoryString('instanceid') . '/downloads/';
+		$saveLocation = $storageLocation . basename($response['url']);
+		$this->previousProgress = 0;
+
+		$ch = curl_init($response['url']);
 
 		if (!file_exists($storageLocation)) {
 			$state = mkdir($storageLocation, 0750, true);
@@ -583,64 +592,22 @@ public function downloadUpdate(?string $url = null): void {
 				$this->silentLog('[info] extracted Archive location exists');
 				$this->recursiveDelete($storageLocation . 'nextcloud/');
 			}
-		}
-
-		foreach ($downloadURLs as $url) {
-			$this->previousProgress = 0;
-			$saveLocation = $storageLocation . basename($url);
-			if ($this->downloadArchive($url, $saveLocation)) {
-				return;
-			}
-		}
-
-		throw new \Exception('All downloads failed. See updater logs for more information.');
-	}
-
-	private function getDownloadURLs(): array {
-		$response = $this->getUpdateServerResponse();
-		$downloadURLs = [];
-		if (!isset($response['downloads']) || !is_array($response['downloads'])) {
-			if (isset($response['url']) && is_string($response['url'])) {
-				// Compatibility with previous verison of updater_server
-				$ext = pathinfo($response['url'], PATHINFO_EXTENSION);
-				$response['downloads'] = [
-					$ext => [$response['url']]
-				];
-			} else {
-				throw new \Exception('Response from update server is missing download URLs');
-			}
-		}
-		foreach ($response['downloads'] as $format => $urls) {
-			if (!$this->isAbleToDecompress($format)) {
-				continue;
-			}
-			foreach ($urls as $url) {
-				if (!is_string($url)) {
-					continue;
-				}
-				$downloadURLs[] = $url;
+			// see if there's an existing incomplete download to resume
+			if (is_file($saveLocation)) {
+				$size = filesize($saveLocation);
+				$range = $size . '-';
+				curl_setopt($ch, CURLOPT_RANGE, $range);
+				$this->silentLog('[info] previous download found; resuming from ' . $this->formatBytes($size));
 			}
 		}
 
-		if (empty($downloadURLs)) {
-			throw new \Exception('Your PHP install is not able to decompress any archive. Try to install modules like zip or bzip.');
-		}
-
-		return array_unique($downloadURLs);
-
-	}
-
-	private function getCurl(string $url): CurlHandle {
-		$ch = curl_init($url);
-		if ($ch === false) {
-			throw new \Exception('Fail to open cUrl handler');
-		}
-
+		$fp = fopen($saveLocation, 'a');
 		curl_setopt_array($ch, [
 			CURLOPT_RETURNTRANSFER => true,
+			CURLOPT_NOPROGRESS => false,
+			CURLOPT_PROGRESSFUNCTION => [$this, 'downloadProgressCallback'],
+			CURLOPT_FILE => $fp,
 			CURLOPT_USERAGENT => 'Nextcloud Updater',
-			CURLOPT_FOLLOWLOCATION => 1,
-			CURLOPT_MAXREDIRS => 2,
 		]);
 
 		if ($this->getConfigOption('proxy') !== null) {
@@ -651,61 +618,47 @@ private function getCurl(string $url): CurlHandle {
 			]);
 		}
 
-		return $ch;
-	}
-
-	private function downloadArchive(string $fromUrl, string $toLocation): bool {
-		$ch = $this->getCurl($fromUrl);
-
-		// see if there's an existing incomplete download to resume
-		if (is_file($toLocation)) {
-			$size = (int)filesize($toLocation);
-			$range = $size . '-';
-			curl_setopt($ch, CURLOPT_RANGE, $range);
-			$this->silentLog('[info] previous download found; resuming from ' . $this->formatBytes($size));
-		}
-
-		$fp = fopen($toLocation, 'ab');
-		if ($fp === false) {
-			throw new \Exception('Fail to open file in ' . $toLocation);
-		}
-
-		curl_setopt_array($ch, [
-			CURLOPT_NOPROGRESS => false,
-			CURLOPT_PROGRESSFUNCTION => [$this, 'downloadProgressCallback'],
-			CURLOPT_FILE => $fp,
-		]);
-
 		if (curl_exec($ch) === false) {
 			throw new \Exception('Curl error: ' . curl_error($ch));
 		}
-
 		$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
 		if ($httpCode !== 200 && $httpCode !== 206) {
-			fclose($fp);
-			unlink($toLocation);
-			$this->silentLog('[warn] fail to download archive from ' . $fromUrl . '. Error: ' . $httpCode . ' ' . curl_error($ch));
-			curl_close($ch);
+			$statusCodes = [
+				400 => 'Bad request',
+				401 => 'Unauthorized',
+				403 => 'Forbidden',
+				404 => 'Not Found',
+				500 => 'Internal Server Error',
+				502 => 'Bad Gateway',
+				503 => 'Service Unavailable',
+				504 => 'Gateway Timeout',
+			];
+
+			$message = 'Download failed';
+			if (is_int($httpCode) && isset($statusCodes[$httpCode])) {
+				$message .= ' - ' . $statusCodes[$httpCode] . ' (HTTP ' . $httpCode . ')';
+			} else {
+				$message .= ' - HTTP status code: ' . (string)$httpCode;
+			}
 
-			return false;
+			$curlErrorMessage = curl_error($ch);
+			if (!empty($curlErrorMessage)) {
+				$message .= ' - curl error message: ' . $curlErrorMessage;
+			}
+
+			$message .= ' - URL: ' . htmlentities($response['url']);
+
+			throw new \Exception($message);
+		} else {
+			// download succeeded
+			$info = curl_getinfo($ch);
+			$this->silentLog('[info] download stats: size=' . $this->formatBytes((int)$info['size_download']) . ' bytes; total_time=' . round($info['total_time'], 2) . ' secs; avg speed=' . $this->formatBytes((int)$info['speed_download']) . '/sec');
 		}
-		// download succeeded
-		$info = curl_getinfo($ch);
-		$this->silentLog('[info] download stats: size=' . $this->formatBytes((int)$info['size_download']) . ' bytes; total_time=' . round($info['total_time'], 2) . ' secs; avg speed=' . $this->formatBytes((int)$info['speed_download']) . '/sec');
 
 		curl_close($ch);
 		fclose($fp);
 
 		$this->silentLog('[info] end of downloadUpdate()');
-		return true;
-	}
-
-	/**
-	 * Check if PHP is able to decompress archive format
-	 */
-	private function isAbleToDecompress(string $ext): bool {
-		// Only zip is supported for now
-		return $ext === 'zip' && extension_loaded($ext);
 	}
 
 	private function downloadProgressCallback(\CurlHandle $resource, int $download_size, int $downloaded, int $upload_size, int $uploaded): void {
@@ -722,7 +675,7 @@ private function downloadProgressCallback(\CurlHandle $resource, int $download_s
 	}
 
 	private function formatBytes(int $bytes, int $precision = 2): string {
-		$units = ['B', 'KiB', 'MiB', 'GiB', 'TiB'];
+		$units = ['B', 'KB', 'MB', 'GB', 'TB'];
 
 		$bytes = max($bytes, 0);
 		$pow = floor(($bytes ? log($bytes) : 0) / log(1024));
@@ -744,34 +697,28 @@ private function getDownloadedFilePath(): string {
 
 		$filesInStorageLocation = scandir($storageLocation);
 		$files = array_values(array_filter($filesInStorageLocation, function (string $path) {
-			// Match files with - in the name and extension (*-*.*)
-			return preg_match('/^.*-.*\..*$/i', $path);
+			return $path !== '.' && $path !== '..';
 		}));
 		// only the downloaded archive
 		if (count($files) !== 1) {
 			throw new \Exception('There are more files than the downloaded archive in the downloads/ folder.');
 		}
-		return $storageLocation . $files[0];
+		return $storageLocation . '/' . $files[0];
 	}
 
 	/**
 	 * Verifies the integrity of the downloaded file
 	 *
 	 * @throws \Exception
 	 */
-	public function verifyIntegrity(?string $urlOverride = null): void {
+	public function verifyIntegrity(): void {
 		$this->silentLog('[info] verifyIntegrity()');
 
 		if ($this->getCurrentReleaseChannel() === 'daily') {
 			$this->silentLog('[info] current channel is "daily" which is not signed. Skipping verification.');
 			return;
 		}
 
-		if ($urlOverride) {
-			$this->silentLog('[info] custom download url provided, cannot verify signature');
-			return;
-		}
-
 		$response = $this->getUpdateServerResponse();
 		if (empty($response['signature'])) {
 			throw new \Exception('No signature specified for defined update');
@@ -1059,7 +1006,7 @@ private function moveWithExclusions(string $dataLocation, array $excludedElement
 						throw new \Exception('Could not mkdir ' . $this->nextcloudDir . '/' . dirname($fileName));
 					}
 				}
-				$state = @rename($path, $this->nextcloudDir . '/' . $fileName);
+				$state = rename($path, $this->nextcloudDir . '/' . $fileName);
 				if ($state === false) {
 					throw new \Exception(
 						sprintf(
@@ -1129,6 +1076,20 @@ public function finalize(): void {
 			throw new \Exception('Could not rmdir .step');
 		}
 
+		/* Check if there is the need to extend .user.ini */
+		$user_ini_additional_lines = $this->getConfigOption('user_ini_additional_lines');
+		if ($user_ini_additional_lines) {
+			$this->silentLog('[info] Extend .user.ini');
+			if (is_array($user_ini_additional_lines)) {
+				$user_ini_additional_lines = implode(PHP_EOL, $user_ini_additional_lines);
+			}
+
+			$result = file_put_contents($this->nextcloudDir . '/.user.ini', PHP_EOL . '; Additional settings from config.php:' . PHP_EOL . $user_ini_additional_lines . PHP_EOL, FILE_APPEND);
+			if ($result === false) {
+				throw new \Exception('Could not append to .user.ini');
+			}
+		}
+
 		if (function_exists('opcache_reset')) {
 			$this->silentLog('[info] call opcache_reset()');
 			opcache_reset();