Add ability to display alert banner on web

Introduces the ability to create a banner for users on the web, using
the YEETFILE_BANNER environment variable. This banner appears for logged
in users only, and can be permanently cleared by the user.

Author: benbusby

README.md

@@ -349,6 +349,7 @@ All environment variables can be defined in a file named `.env` at the root leve
 | YEETFILE_LOCKDOWN | Disables anonymous (not logged in) interactions | 0 | `1` to enable lockdown, `0` to allow anonymous usage |
 | YEETFILE_PROFILING | Enables server profiling on http://localhost:6060 | 0 | `1` to enable, `0` to disable (default) |
 | YEETFILE_ALLOW_INVITES | Allows the YeetFile instance admin to send unique invite codes to email addresses -- must also set `YEETFILE_SERVER_PASSWORD` and setup outgoing email (see [Misc Environment Variables](#misc-environment-variables)) | 0 | `1` to enable, `0` to disable (default) |
+| YEETFILE_BANNER | Can be set to a string value that will appear as an info bannner for any users logged in on the web. | | Any string |
 
 #### Backblaze Environment Variables
 

backend/config/config.go

@@ -52,6 +52,7 @@ var (
 	IsLockedDown   = utils.GetEnvVarBool("YEETFILE_LOCKDOWN", false)
 	InstanceAdmin  = utils.GetEnvVar("YEETFILE_INSTANCE_ADMIN", "")
 	InvitesAllowed = utils.GetEnvVarBool("YEETFILE_ALLOW_INVITES", false)
+	Banner         = utils.GetEnvVar("YEETFILE_BANNER", "")
 )
 
 // =============================================================================

backend/server/html/handlers.go

@@ -43,6 +43,7 @@ func FileVaultPageHandler(w http.ResponseWriter, _ *http.Request, userID string)
 				CSS:       []string{"vault.css"},
 				Config:    config.HTMLConfig,
 				Endpoints: endpoints.HTMLPageEndpoints,
+				Banner:    config.Banner,
 			},
 			StorageUsed:      userStorage.StorageUsed,
 			StorageAvailable: userStorage.StorageAvailable,
@@ -77,6 +78,7 @@ func PassVaultPageHandler(w http.ResponseWriter, _ *http.Request, userID string)
 				CSS:       []string{"vault.css"},
 				Config:    config.HTMLConfig,
 				Endpoints: endpoints.HTMLPageEndpoints,
+				Banner:    config.Banner,
 			},
 			StorageUsed:      int64(passCount),
 			StorageAvailable: int64(maxPassCount),
@@ -123,6 +125,7 @@ func SendPageHandler(w http.ResponseWriter, req *http.Request, _ string) {
 				CSS:       []string{"send.css"},
 				Config:    config.HTMLConfig,
 				Endpoints: endpoints.HTMLPageEndpoints,
+				Banner:    config.Banner,
 			},
 			SendUsed:           sendUsed,
 			SendAvailable:      sendAvailable,
@@ -223,6 +226,7 @@ func AccountPageHandler(w http.ResponseWriter, req *http.Request, userID string)
 				CSS:        []string{"account.css"},
 				Config:     config.HTMLConfig,
 				Endpoints:  endpoints.HTMLPageEndpoints,
+				Banner:     config.Banner,
 			},
 			Email:            obscuredEmail,
 			EmailConfigured:  config.YeetFileConfig.Email.Configured,

backend/server/html/templates/account.html

@@ -161,6 +161,10 @@ <h4 class="no-margin">YeetFile Send</h4>
     <p id="success-message"></p>
   </div>
   {{ end }}
+
+  {{ if .Base.LoggedIn }}
+    {{ template "banner.html" . }}
+  {{ end }}
 </div>
 
 {{ template "two-factor-dialog.html" }}

backend/server/html/templates/banner.html

@@ -0,0 +1,8 @@
+{{ if .Base.Banner }}
+<div id="yeetfile-banner" class="banner">
+  <span id="banner-string">{{ .Base.Banner }}</span>
+  <br><br>
+  <button id="close-banner">Close</button>
+</div>
+<script type="module" src="/static/js/{{ .Base.Config.Version }}/banner.js"></script>
+{{ end }}

backend/server/html/templates/send.html

@@ -142,6 +142,10 @@ <h1>Send</h1>
             — <a href="{{ .Base.Endpoints.Upgrade }}">Upgrade</a>
         {{ end }}
     {{ end }}
+
+    {{ if .Base.LoggedIn }}
+        {{ template "banner.html" . }}
+    {{ end }}
 </div>
 {{ template "footer.html" . }}
 </body>

backend/server/html/templates/templates.go

@@ -45,6 +45,7 @@ type BaseTemplate struct {
 	Version    string
 	Config     config.TemplateConfig
 	Endpoints  endpoints.HTMLEndpoints
+	Banner     string
 }
 
 type Template struct {

backend/server/html/templates/vault.html

@@ -51,6 +51,10 @@ <h1>{{ .VaultName }}</h1>
     <progress max="{{ .StorageAvailable }}" value="{{ .StorageUsed }}" id="storage-bar"></progress>
     <progress id="item-bar"></progress>
     <span id="vault-message"></span>
+
+    {{ if .Base.LoggedIn }}
+        {{ template "banner.html" . }}
+    {{ end }}
 </div>
 
 {{ template "vault-password-dialog.html" false }}

backend/static/css/main.css

@@ -31,6 +31,20 @@ fieldset {
     border: 0 !important;
 }
 
+.banner {
+    display: none;
+    background-color: var(--card-bg-color);
+    padding: 10px;
+    color: var(--text-color);
+    border: 2px solid var(--accent-color) !important;
+    z-index: 100;
+}
+
+.banner button {
+    display: block;
+    margin: auto;
+}
+
 .auto-width {
     width: auto !important;
 }

cli/commands/download/download.go

@@ -11,6 +11,7 @@ import (
 	"yeetfile/cli/utils"
 	"yeetfile/shared"
 	"yeetfile/shared/constants"
+	"yeetfile/shared/endpoints"
 )
 
 var decryptError = errors.New("decryption error")
@@ -34,7 +35,7 @@ type PreparedDownload struct {
 }
 
 func parseLink(link string) DownloadResource {
-	link = strings.Replace(link, "/send/", "/", 1)
+	link = strings.Replace(link, string(endpoints.HTMLSend), "/", 1)
 	linkSegments := strings.Split(link, "/")
 	server := strings.Join(linkSegments[0:len(linkSegments)-1], "/")
 	resource := strings.Split(linkSegments[len(linkSegments)-1], "#")