Change base URL to canonical

saaste · Mar 17, 2024 · 970c0d4 · 970c0d4
1 parent f4aa01b
commit 970c0d4
Show file tree

Hide file tree

Showing 10 changed files with 34 additions and 27 deletions.
diff --git a/components/bookmark_add_form.html b/components/bookmark_add_form.html
@@ -1,5 +1,5 @@
 {{ define "bookmark_add_form" }}
-<form method="post" action="{{ .BaseURL}}/admin/bookmarks/add" id="bookmark-form">
+<form method="post" action="{{ .BaseURL}}admin/bookmarks/add" id="bookmark-form">
     <div class="input-group">
         <label for="url">URL (required)</label>
         <div class="input-group horizontal">

diff --git a/components/bookmark_delete_form.html b/components/bookmark_delete_form.html
@@ -1,5 +1,5 @@
 {{ define "bookmark_delete_form" }}
-<form method="post" action="{{ .BaseURL}}/admin/bookmarks/{{ .Bookmark.ID }}/delete">
+<form method="post" action="{{ .BaseURL}}admin/bookmarks/{{ .Bookmark.ID }}/delete">
     <p>Are you sure you want to delete the following bookmark?</p>
 
     <div class="info-box">

diff --git a/components/bookmark_edit_form.html b/components/bookmark_edit_form.html
@@ -1,5 +1,5 @@
 {{ define "bookmark_edit_form" }}
-<form method="post" action="{{ .BaseURL}}/admin/bookmarks/{{ .Bookmark.ID }}" id="bookmark-form">
+<form method="post" action="{{ .BaseURL}}admin/bookmarks/{{ .Bookmark.ID }}" id="bookmark-form">
     <div class="input-group">
         <label for="url">URL (required)</label>
         <input type="text" name="url" id="url" value="{{ .Bookmark.URL }}" required aria-required="true" />

diff --git a/components/login_form.html b/components/login_form.html
@@ -1,5 +1,5 @@
 {{ define "login_form" }}
-<form method="post" action="{{ .BaseURL }}/login">
+<form method="post" action="{{ .BaseURL }}login">
     <div class="input-group">
         <label for="password">Password</label>
         <div class="input-group horizontal">

diff --git a/config.yml.example b/config.yml.example
@@ -14,7 +14,7 @@ author_name: ""
 # Author's email address. Shown in feeds
 author_email: ""
 
-# Base URL of the site
+# Base URL of the site with a trailing slash (e.g https://example.com/)
 base_url: http://localhost:8000                 
 
 # Password required for managing bookmarks
@@ -49,7 +49,7 @@ template: default
 # Use Gotify notifications
 gotify_enabled: false
 
-# Gotify base url
+# Gotify base url with a trailing slash (e.g. https://example.com/push/)
 # gotify_url: https://mygotifyinstance.com
 
 # Gotify app token

diff --git a/config/config.go b/config/config.go
@@ -1,7 +1,9 @@
 package config
 
 import (
+	"fmt"
 	"os"
+	"strings"
 
 	"gopkg.in/yaml.v3"
 )
@@ -44,5 +46,10 @@ func LoadConfig() (*AppConfig, error) {
 
 	appConfig.AppVersion = appVersion
 
+	// Validate base URL
+	if !strings.HasSuffix(appConfig.BaseURL, "/") {
+		return nil, fmt.Errorf("base URL must have a trailing slash")
+	}
+
 	return appConfig, nil
 }
diff --git a/handlers/admin_handlers.go b/handlers/admin_handlers.go
@@ -15,7 +15,7 @@ import (
 func (h *Handler) HandlePrivateBookmarks(w http.ResponseWriter, r *http.Request) {
 	isAuthenticated := h.isAuthenticated(r)
 	if !isAuthenticated {
-		http.Redirect(w, r, fmt.Sprintf("%s/login", h.appConf.BaseURL), http.StatusFound)
+		http.Redirect(w, r, fmt.Sprintf("%slogin", h.appConf.BaseURL), http.StatusFound)
 		return
 	}
 
@@ -45,7 +45,7 @@ func (h *Handler) HandlePrivateBookmarks(w http.ResponseWriter, r *http.Request)
 func (h *Handler) HandleBrokenBookmarks(w http.ResponseWriter, r *http.Request) {
 	isAuthenticated := h.isAuthenticated(r)
 	if !isAuthenticated {
-		http.Redirect(w, r, fmt.Sprintf("%s/login", h.appConf.BaseURL), http.StatusFound)
+		http.Redirect(w, r, fmt.Sprintf("%slogin", h.appConf.BaseURL), http.StatusFound)
 		return
 	}
 
@@ -72,7 +72,7 @@ func (h *Handler) HandleBrokenBookmarks(w http.ResponseWriter, r *http.Request)
 func (h *Handler) HandleBookmarkAdd(w http.ResponseWriter, r *http.Request) {
 	isAuthenticated := h.isAuthenticated(r)
 	if !isAuthenticated {
-		http.Redirect(w, r, fmt.Sprintf("%s/login", h.appConf.BaseURL), http.StatusFound)
+		http.Redirect(w, r, fmt.Sprintf("%slogin", h.appConf.BaseURL), http.StatusFound)
 		return
 	}
 
@@ -130,7 +130,7 @@ func (h *Handler) HandleBookmarkAdd(w http.ResponseWriter, r *http.Request) {
 func (h *Handler) HandleBookmarkEdit(w http.ResponseWriter, r *http.Request) {
 	isAuthenticated := h.isAuthenticated(r)
 	if !isAuthenticated {
-		http.Redirect(w, r, fmt.Sprintf("%s/login", h.appConf.BaseURL), http.StatusFound)
+		http.Redirect(w, r, fmt.Sprintf("%slogin", h.appConf.BaseURL), http.StatusFound)
 		return
 	}
 
@@ -209,7 +209,7 @@ func (h *Handler) HandleBookmarkEdit(w http.ResponseWriter, r *http.Request) {
 func (h *Handler) HandleBookmarkDelete(w http.ResponseWriter, r *http.Request) {
 	isAuthenticated := h.isAuthenticated(r)
 	if !isAuthenticated {
-		http.Redirect(w, r, fmt.Sprintf("%s/login", h.appConf.BaseURL), http.StatusFound)
+		http.Redirect(w, r, fmt.Sprintf("%slogin", h.appConf.BaseURL), http.StatusFound)
 		return
 	}
 

diff --git a/notifications/gotify_test.go b/notifications/gotify_test.go
@@ -45,7 +45,7 @@ func TestSendGotifyMessage(t *testing.T) {
 	}{
 		{
 			testName:    "Successful send",
-			gotifyURL:   "https://example.org",
+			gotifyURL:   "https://example.org/",
 			gotifyToken: "test-token",
 			clientResponse: &http.Response{
 				StatusCode: http.StatusOK,
@@ -54,7 +54,7 @@ func TestSendGotifyMessage(t *testing.T) {
 		},
 		{
 			testName:    "Invalid HTTP status from server",
-			gotifyURL:   "https://example.org",
+			gotifyURL:   "https://example.org/",
 			gotifyToken: "test-token",
 			clientResponse: &http.Response{
 				StatusCode: http.StatusInternalServerError,
@@ -65,7 +65,7 @@ func TestSendGotifyMessage(t *testing.T) {
 		},
 		{
 			testName:      "Client error",
-			gotifyURL:     "https://example.org",
+			gotifyURL:     "https://example.org/",
 			gotifyToken:   "test-token",
 			clientDoError: fmt.Errorf("mock error"),
 			expectedError: "sending a request failed: mock error",
@@ -78,7 +78,7 @@ func TestSendGotifyMessage(t *testing.T) {
 		},
 		{
 			testName:      "Missing gotify token",
-			gotifyURL:     "https://example.org",
+			gotifyURL:     "https://example.org/",
 			gotifyToken:   "",
 			expectedError: "notifications are disabled because Gotify is not configured",
 		},

diff --git a/templates/default/base.html b/templates/default/base.html
@@ -18,14 +18,14 @@
             <h1><a href="{{ .BaseURL }}">{{ .SiteName }}</a></h1>
             <nav>
                 {{ if .IsAuthenticated }}
-                <a href="{{ .BaseURL }}/admin/bookmarks/add">Add Bookmark</a> |
-                <a href="{{ .BaseURL }}/admin/bookmarks">Private Bookmarks</a> |
+                <a href="{{ .BaseURL }}admin/bookmarks/add">Add Bookmark</a> |
+                <a href="{{ .BaseURL }}admin/bookmarks">Private Bookmarks</a> |
                 {{ if .BrokenBookmarksExist }}
-                <a href="{{ .BaseURL }}/admin/bookmarks/broken" class="warning">Broken Bookmarks</a> |
+                <a href="{{ .BaseURL }}admin/bookmarks/broken" class="warning">Broken Bookmarks</a> |
                 {{ end}}
-                <a href="{{ .BaseURL }}/logout">Log out</a>
+                <a href="{{ .BaseURL }}logout">Log out</a>
                 {{ else }}
-                <a href="{{ .BaseURL }}/login">Log in</a>
+                <a href="{{ .BaseURL }}login">Log in</a>
                 {{ end }}
             </nav>
         </header>

diff --git a/templates/default/index.html b/templates/default/index.html
@@ -17,7 +17,7 @@ <h2>Search</h2>
     <div class="header">
         <h2>{{ .Title }}</h2>
         {{ if .Bookmarks }}
-        <a href='{{ feedUrl "rss" }}'><img src="{{ .BaseURL }}/assets/feed.png" class="icon" alt="RSS feed icon" title="RSS feed"></a>
+        <a href='{{ feedUrl "rss" }}'><img src="{{ .BaseURL }}assets/feed.png" class="icon" alt="RSS feed icon" title="RSS feed"></a>
         {{ end }}
     </div>
 
@@ -29,8 +29,8 @@ <h2>{{ .Title }}</h2>
                 <h3><a href="{{ .URL }}" target="_blank" rel="noopener noreferrer">{{ .Title }}</a></h3>
                 {{ if $.IsAuthenticated }}
                 <div>
-                    {{ if eq .IsWorking false }}<img src="{{ $.BaseURL }}/assets/warning.png" class="icon" alt="Exclamation point icon" title="Bookmark is broken">{{ end }}
-                    {{ if eq .IsPrivate true }}<img src="{{ $.BaseURL }}/assets/lock.png" class="icon" alt="Lock icon" title="Bookmark is private">{{ end }}
+                    {{ if eq .IsWorking false }}<img src="{{ $.BaseURL }}assets/warning.png" class="icon" alt="Exclamation point icon" title="Bookmark is broken">{{ end }}
+                    {{ if eq .IsPrivate true }}<img src="{{ $.BaseURL }}assets/lock.png" class="icon" alt="Lock icon" title="Bookmark is private">{{ end }}
                 </div>
                 {{ end }}
             </div>
@@ -44,14 +44,14 @@ <h3><a href="{{ .URL }}" target="_blank" rel="noopener noreferrer">{{ .Title }}<
                 <div class="tags">
                     Tags:
                     {{ range .Tags }}
-                        <a href="{{ $.BaseURL}}/tags/{{ . }}">{{ . }}</a>
+                        <a href="{{ $.BaseURL}}tags/{{ . }}">{{ . }}</a>
                     {{ end }}
                 </div>
                 {{ end}}
                 {{ if $.IsAuthenticated }}
                 <div class="actions">
-                    <a href="{{ $.BaseURL }}/admin/bookmarks/{{ .ID }}">Edit</a>
-                    <a href="{{ $.BaseURL }}/admin/bookmarks/{{ .ID }}/delete">Delete</a>
+                    <a href="{{ $.BaseURL }}admin/bookmarks/{{ .ID }}">Edit</a>
+                    <a href="{{ $.BaseURL }}admin/bookmarks/{{ .ID }}/delete">Delete</a>
                 </div>
                 {{ end }}
             </div>
@@ -84,7 +84,7 @@ <h3><a href="{{ .URL }}" target="_blank" rel="noopener noreferrer">{{ .Title }}<
     <h2>Tags</h2>
     <ul>
         {{ range .Tags }}
-        <li><a href="{{ $.BaseURL}}/tags/{{ . }}">{{ . }}</a></li>    
+        <li><a href="{{ $.BaseURL}}tags/{{ . }}">{{ . }}</a></li>    
         {{ end }}
     </ul>
 </section>