From 2ec8014a8397147941bc8dbe708a1c8f9ede1fa9 Mon Sep 17 00:00:00 2001
From: "Simon L." <szaimen@e.mail.de>
Date: Fri, 26 Apr 2024 15:52:11 +0200
Subject: [PATCH] feat(exception-template): allow to link to specific
 documentation for how to retreive server log

Signed-off-by: Simon L <szaimen@e.mail.de>
---
 config/config.sample.php           | 5 +++++
 core/templates/exception.php       | 3 +++
 lib/private/legacy/OC_Template.php | 2 ++
 3 files changed, 10 insertions(+)

diff --git a/config/config.sample.php b/config/config.sample.php
index f45e7dcc5e0f6..43b230991b322 100644
--- a/config/config.sample.php
+++ b/config/config.sample.php
@@ -2235,6 +2235,11 @@
  */
 'upgrade.cli-upgrade-link' => '',
 
+/**
+ * Allows to modify the exception server logs documentation link in order to link to a different documentation
+ */
+'documentation_url.server_logs' => '',
+
 /**
  * Set this Nextcloud instance to debugging mode
  *
diff --git a/core/templates/exception.php b/core/templates/exception.php
index ee35510b26fa8..2ab461e4ebd69 100644
--- a/core/templates/exception.php
+++ b/core/templates/exception.php
@@ -25,6 +25,9 @@ function print_exception(Throwable $e, \OCP\IL10N $l): void {
 	<p><?php p($l->t('The server was unable to complete your request.')) ?></p>
 	<p><?php p($l->t('If this happens again, please send the technical details below to the server administrator.')) ?></p>
 	<p><?php p($l->t('More details can be found in the server log.')) ?></p>
+	<?php if (isset($_['serverLogsDocumentation ']) && $_['serverLogsDocumentation '] !== ''): ?>
+		<p><a href="<?php print_unescaped($_['serverLogsDocumentation ']) ?>" target="_blank" rel="noopener"><?php p($l->t('See this documentation how to retreive them.')) ?></a></p>
+	<?php endif; ?>
 
 	<h3><?php p($l->t('Technical details')) ?></h3>
 	<ul>
diff --git a/lib/private/legacy/OC_Template.php b/lib/private/legacy/OC_Template.php
index 545d5a73a6311..ad9421913d32c 100644
--- a/lib/private/legacy/OC_Template.php
+++ b/lib/private/legacy/OC_Template.php
@@ -306,6 +306,7 @@ public static function printExceptionErrorPage($exception, $statusCode = 503) {
 		http_response_code($statusCode);
 		try {
 			$debug = \OC::$server->getSystemConfig()->getValue('debug', false);
+			$serverLogsDocumentation = \OC::$server->getSystemConfig()->getValue('documentation_url.server_logs', '');
 			$request = \OC::$server->getRequest();
 			$content = new \OC_Template('', 'exception', 'error', false);
 			$content->assign('errorClass', get_class($exception));
@@ -315,6 +316,7 @@ public static function printExceptionErrorPage($exception, $statusCode = 503) {
 			$content->assign('line', $exception->getLine());
 			$content->assign('exception', $exception);
 			$content->assign('debugMode', $debug);
+			$content->assign('serverLogsDocumentation', $serverLogsDocumentation);
 			$content->assign('remoteAddr', $request->getRemoteAddress());
 			$content->assign('requestID', $request->getId());
 			$content->printPage();