From 0ca118fdc3c39c0e7adf9285e074e5878a0ca1c1 Mon Sep 17 00:00:00 2001
From: Gergely Nagy <forgejo@gergo.csillger.hu>
Date: Sun, 4 Feb 2024 09:43:59 +0100
Subject: [PATCH] admin: "Self Check" should only show for some db types

The "Self Check" menu essentially runs the collation check that is also
performed at startup, and displays the results. This is only a thing for
MariaDB/MySQL and MSSQL. As such, the menu item should only be available
for these database types.

Signed-off-by: Gergely Nagy <forgejo@gergo.csillger.hu>
---
 routers/web/web.go                     |  4 +++-
 templates/admin/navbar.tmpl            |  2 ++
 tests/integration/db_collation_test.go | 25 +++++++++++++++++++++++++
 3 files changed, 30 insertions(+), 1 deletion(-)

diff --git a/routers/web/web.go b/routers/web/web.go
index f9611b5f4b..4b666faf63 100644
--- a/routers/web/web.go
+++ b/routers/web/web.go
@@ -676,7 +676,9 @@ func registerRoutes(m *web.Route) {
 		m.Get("", admin.Dashboard)
 		m.Post("", web.Bind(forms.AdminDashboardForm{}), admin.DashboardPost)
 
-		m.Get("/self_check", admin.SelfCheck)
+		if setting.Database.Type.IsMySQL() || setting.Database.Type.IsMSSQL() {
+			m.Get("/self_check", admin.SelfCheck)
+		}
 
 		m.Group("/config", func() {
 			m.Get("", admin.Config)
diff --git a/templates/admin/navbar.tmpl b/templates/admin/navbar.tmpl
index fa79f0f759..f23bdee124 100644
--- a/templates/admin/navbar.tmpl
+++ b/templates/admin/navbar.tmpl
@@ -4,9 +4,11 @@
 		<a class="{{if .PageIsAdminDashboard}}active {{end}}item" href="{{AppSubUrl}}/admin">
 			{{ctx.Locale.Tr "admin.dashboard"}}
 		</a>
+		{{if or .DatabaseType.IsMySQL .DatabaseType.IsMSSQL}}
 		<a class="{{if .PageIsAdminSelfCheck}}active {{end}}item" href="{{AppSubUrl}}/admin/self_check">
 			{{ctx.Locale.Tr "admin.self_check"}}
 		</a>
+		{{end}}
 		<details class="item toggleable-item" {{if or .PageIsAdminUsers .PageIsAdminEmails .PageIsAdminOrganizations .PageIsAdminAuthentications}}open{{end}}>
 			<summary>{{ctx.Locale.Tr "admin.identity_access"}}</summary>
 			<div class="menu">
diff --git a/tests/integration/db_collation_test.go b/tests/integration/db_collation_test.go
index f81529d582..ab93c105cf 100644
--- a/tests/integration/db_collation_test.go
+++ b/tests/integration/db_collation_test.go
@@ -1,9 +1,11 @@
 // Copyright 2023 The Gitea Authors. All rights reserved.
+// Copyright 2024 The Forgejo Authors c/o Codeberg e.V.. All rights reserved.
 // SPDX-License-Identifier: MIT
 
 package integration
 
 import (
+	"net/http"
 	"testing"
 	"time"
 
@@ -21,6 +23,29 @@ type TestCollationTbl struct {
 	Txt string `xorm:"VARCHAR(10) UNIQUE"`
 }
 
+func TestDatabaseCollationSelfCheckUI(t *testing.T) {
+	defer tests.PrepareTestEnv(t)()
+
+	assertSelfCheckExists := func(exists bool) {
+		expectedHTTPResponse := http.StatusOK
+		if !exists {
+			expectedHTTPResponse = http.StatusNotFound
+		}
+		session := loginUser(t, "user1")
+		req := NewRequest(t, "GET", "/admin/self_check")
+		resp := session.MakeRequest(t, req, expectedHTTPResponse)
+		htmlDoc := NewHTMLParser(t, resp.Body)
+
+		htmlDoc.AssertElement(t, "a.item[href*='/admin/self_check']", exists)
+	}
+
+	if setting.Database.Type.IsMySQL() || setting.Database.Type.IsMSSQL() {
+		assertSelfCheckExists(true)
+	} else {
+		assertSelfCheckExists(false)
+	}
+}
+
 func TestDatabaseCollation(t *testing.T) {
 	x := db.GetEngine(db.DefaultContext).(*xorm.Engine)