From 41dff3d5bbe4e4efc859bbddc5e5d180e69964a1 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Sat, 15 Mar 2025 14:53:53 +0000 Subject: [PATCH 001/249] user: fix welcome message sent value on NewUserFromAdmin inverted since WelcomeNewUser returns a bool called "failed", rather than one indicating success. --- api-users.go | 2 +- ts/modules/accounts.ts | 19 +++++++++++++++---- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/api-users.go b/api-users.go index e865b27..352366d 100644 --- a/api-users.go +++ b/api-users.go @@ -63,7 +63,7 @@ func (app *appContext) NewUserFromAdmin(gc *gin.Context) { welcomeMessageSentIfNecessary := true if nu.Created { - welcomeMessageSentIfNecessary = app.WelcomeNewUser(nu.User, time.Time{}) + welcomeMessageSentIfNecessary = !app.WelcomeNewUser(nu.User, time.Time{}) } respondUser(nu.Status, nu.Created, welcomeMessageSentIfNecessary, nu.Message, gc) diff --git a/ts/modules/accounts.ts b/ts/modules/accounts.ts index b9da9e5..ab88af0 100644 --- a/ts/modules/accounts.ts +++ b/ts/modules/accounts.ts @@ -103,7 +103,7 @@ class user implements User, SearchableItem { set selected(state: boolean) { this._selected = state; this._check.checked = state; - state ? document.dispatchEvent(this._checkEvent) : document.dispatchEvent(this._uncheckEvent); + state ? document.dispatchEvent(this._checkEvent()) : document.dispatchEvent(this._uncheckEvent()); } get name(): string { return this._username.textContent; } @@ -481,8 +481,8 @@ class user implements User, SearchableItem { ); } - private _checkEvent = new CustomEvent("accountCheckEvent"); - private _uncheckEvent = new CustomEvent("accountUncheckEvent"); + private _checkEvent = () => new CustomEvent("accountCheckEvent", {detail: this.id}); + private _uncheckEvent = () => new CustomEvent("accountUncheckEvent", {detail: this.id}); constructor(user: User) { this._row = document.createElement("tr") as HTMLTableRowElement; @@ -696,7 +696,7 @@ class user implements User, SearchableItem { asElement = (): HTMLTableRowElement => { return this._row; } remove = () => { if (this.selected) { - document.dispatchEvent(this._uncheckEvent); + document.dispatchEvent(this._uncheckEvent()); } this._row.remove(); } @@ -927,6 +927,17 @@ export class accountsList { state ? this._checkCount = count : 0; } + selectAllBetweenIDs = (startID: string, endID: string) => { + let inRange = false; + for (let id of this._ordering) { + if (!(inRange || id == startID)) continue; + inRange = true; + if (!(this._table.contains(this._users[id].asElement()))) continue; + this._users[id].selected = true; + if (id == endID) return; + } + } + add = (u: User) => { let domAccount = new user(u); this._users[u.id] = domAccount; From c5f4098b5b271c8b617870f71013f1d8b9f9011b Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Tue, 13 May 2025 14:01:41 +0100 Subject: [PATCH 002/249] db: add max vlog size setting --- config.go | 2 ++ config/config-base.yaml | 13 +++++++++++++ storage.go | 1 + 3 files changed, 16 insertions(+) diff --git a/config.go b/config.go index c58f425..88b0013 100644 --- a/config.go +++ b/config.go @@ -155,6 +155,8 @@ func (app *appContext) loadConfig() error { app.MustSetValue("ui", "port", "8056") app.MustSetValue("advanced", "tls_port", "8057") + app.MustSetValue("advanced", "value_log_size", "1024") + pwrMethods := []string{"allow_pwr_username", "allow_pwr_email", "allow_pwr_contact_method"} allDisabled := true for _, v := range pwrMethods { diff --git a/config/config-base.yaml b/config/config-base.yaml index ff427d7..1da810b 100644 --- a/config/config-base.yaml +++ b/config/config-base.yaml @@ -330,6 +330,19 @@ sections: requires_restart: true type: password description: Leave blank for no Authentication. + - setting: value_log_note + name: 'Value Log:' + type: note + depends_true: enabled + required: false + description: The Value Log (vlog) file in your config folder is used to ensure data integrity in the database. It can get large, so you can adjust the maximum size. After quitting jfa-go, the file can be deleted safely without data loss. + style: info + - setting: value_log_size + name: Database max vlog size (MiB) + requires_restart: true + type: number + value: 1024 + description: Max size for the database's value log. Lower values may reduce performance. - setting: debug_log_emails name: 'Debug Storage Logging: Emails' requires_restart: true diff --git a/storage.go b/storage.go index 0a4e5cb..f9e503d 100644 --- a/storage.go +++ b/storage.go @@ -175,6 +175,7 @@ func generateLogActions(c *ini.File) map[string]DebugLogAction { func (app *appContext) ConnectDB() { opts := badgerhold.DefaultOptions + opts.Options.ValueLogFileSize = app.config.Section("advanced").Key("value_log_size").MustInt64(1024) * 1024 opts.Dir = app.storage.db_path opts.ValueDir = app.storage.db_path db, err := badgerhold.Open(opts) From d6f5c91d7892bd1fc9009deba973bf1ee978b901 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Tue, 13 May 2025 15:07:55 +0100 Subject: [PATCH 003/249] backups: add more info, keep 1 of each version opt backup's filename format has changed, and includes the commit too now. a Backup struct for going to/from the filename has been added, and the option "keep 1 backup from each version" has been added, leaving the most recent backup from each version always. All pre-this-commit backups are considered the same "old" version. --- api-backups.go | 20 ++--- backups.go | 157 +++++++++++++++++++++++++++++++++---- backups_test.go | 57 ++++++++++++++ config.go | 1 + config/config-base.yaml | 6 ++ discord.go | 2 +- email.go | 2 +- go.mod | 12 +-- go.sum | 20 ++--- html/admin.html | 1 + logmessages/logmessages.go | 1 + main.go | 2 +- models.go | 13 +-- telegram.go | 2 +- ts/modules/settings.ts | 2 + 15 files changed, 248 insertions(+), 50 deletions(-) create mode 100644 backups_test.go diff --git a/api-backups.go b/api-backups.go index 109082e..ca7e28b 100644 --- a/api-backups.go +++ b/api-backups.go @@ -4,8 +4,6 @@ import ( "os" "path/filepath" "sort" - "strings" - "time" "github.com/gin-gonic/gin" lm "github.com/hrfee/jfa-go/logmessages" @@ -33,9 +31,9 @@ func (app *appContext) CreateBackup(gc *gin.Context) { func (app *appContext) GetBackup(gc *gin.Context) { fname := gc.Param("fname") // Hopefully this is enough to ensure the path isn't malicious. Hidden behind bearer auth anyway so shouldn't matter too much I guess. - ok := (strings.HasPrefix(fname, BACKUP_PREFIX) || strings.HasPrefix(fname, BACKUP_UPLOAD_PREFIX+BACKUP_PREFIX)) && strings.HasSuffix(fname, BACKUP_SUFFIX) - t, err := time.Parse(BACKUP_DATEFMT, strings.TrimSuffix(strings.TrimPrefix(strings.TrimPrefix(fname, BACKUP_UPLOAD_PREFIX), BACKUP_PREFIX), BACKUP_SUFFIX)) - if !ok || err != nil || t.IsZero() { + b := Backup{} + err := b.FromString(fname) + if err != nil || b.Date.IsZero() { app.debug.Printf(lm.IgnoreInvalidFilename, fname, err) respondBool(400, false, gc) return @@ -62,7 +60,8 @@ func (app *appContext) GetBackups(gc *gin.Context) { resp.Backups[i].Name = item.Name() fullpath := filepath.Join(path, item.Name()) resp.Backups[i].Path = fullpath - resp.Backups[i].Date = backups.dates[i].Unix() + resp.Backups[i].Date = backups.info[i].Date.Unix() + resp.Backups[i].Commit = backups.info[i].Commit fstat, err := os.Stat(fullpath) if err == nil { resp.Backups[i].Size = fileSize(fstat.Size()) @@ -81,9 +80,9 @@ func (app *appContext) GetBackups(gc *gin.Context) { func (app *appContext) RestoreLocalBackup(gc *gin.Context) { fname := gc.Param("fname") // Hopefully this is enough to ensure the path isn't malicious. Hidden behind bearer auth anyway so shouldn't matter too much I guess. - ok := strings.HasPrefix(fname, BACKUP_PREFIX) && strings.HasSuffix(fname, BACKUP_SUFFIX) - t, err := time.Parse(BACKUP_DATEFMT, strings.TrimSuffix(strings.TrimPrefix(fname, BACKUP_PREFIX), BACKUP_SUFFIX)) - if !ok || err != nil || t.IsZero() { + b := Backup{} + err := b.FromString(fname) + if err != nil || b.Date.IsZero() { app.debug.Printf(lm.IgnoreInvalidFilename, fname, err) respondBool(400, false, gc) return @@ -110,7 +109,8 @@ func (app *appContext) RestoreBackup(gc *gin.Context) { } app.debug.Printf(lm.GetUpload, file.Filename) path := app.config.Section("backups").Key("path").String() - fullpath := filepath.Join(path, BACKUP_UPLOAD_PREFIX+BACKUP_PREFIX+time.Now().Local().Format(BACKUP_DATEFMT)+BACKUP_SUFFIX) + b := Backup{Upload: true} + fullpath := filepath.Join(path, b.String()) gc.SaveUploadedFile(file, fullpath) app.debug.Printf(lm.Write, fullpath) LOADBAK = fullpath diff --git a/backups.go b/backups.go index 6690454..0a1ae57 100644 --- a/backups.go +++ b/backups.go @@ -5,6 +5,7 @@ import ( "os" "path/filepath" "sort" + "strconv" "strings" "time" @@ -12,35 +13,126 @@ import ( ) const ( - BACKUP_PREFIX = "jfa-go-db-" + BACKUP_PREFIX = "jfa-go-db" + BACKUP_COMMIT_PREFIX = "-c-" + BACKUP_DATE_PREFIX = "-d-" BACKUP_UPLOAD_PREFIX = "upload-" BACKUP_DATEFMT = "2006-01-02T15-04-05" BACKUP_SUFFIX = ".bak" ) +type Backup struct { + Date time.Time + Commit string + Upload bool +} + +func (b Backup) IsZero() bool { return b.Date.IsZero() && b.Commit == "" && b.Upload == false } + +func (b Backup) Equals(a Backup) bool { + return a.Date.Equal(b.Date) && a.Commit == b.Commit && a.Upload == b.Upload +} + +// Pre 21/03/25 format: "{BACKUP_PREFIX}{date in BACKUP_DATEFMT}{BACKUP_SUFFIX}" = "jfa-go-db-2006-01-02T15-04-05.bak" +// Post 21/03/25 format: "{BACKUP_PREFIX}-c-{commit}-d-{date in BACKUP_DATEFMT}{BACKUP_SUFFIX}" = "jfa-go-db-c-0b92060-d-2006-01-02T15-04-05.bak" + +func (b Backup) String() string { + t := b.Date + if t.IsZero() { + t = time.Now() + } + out := BACKUP_PREFIX + if b.Upload { + out = BACKUP_UPLOAD_PREFIX + out + } + if b.Commit != "" { + out += BACKUP_COMMIT_PREFIX + b.Commit + } + out += BACKUP_DATE_PREFIX + t.Local().Format(BACKUP_DATEFMT) + BACKUP_SUFFIX + return out +} + +func (b *Backup) FromString(f string) error { + of := f + if strings.HasPrefix(f, BACKUP_UPLOAD_PREFIX) { + b.Upload = true + f = f[len(BACKUP_UPLOAD_PREFIX):] + } + if !strings.HasPrefix(f, BACKUP_PREFIX) { + return fmt.Errorf("file doesn't have correct prefix (\"%s\")", BACKUP_PREFIX) + } + f = f[len(BACKUP_PREFIX):] + if !strings.HasSuffix(f, BACKUP_SUFFIX) { + return fmt.Errorf("file doesn't have correct suffix (\"%s\")", BACKUP_SUFFIX) + } + for range 2 { + if strings.HasPrefix(f, BACKUP_COMMIT_PREFIX) { + f = f[len(BACKUP_COMMIT_PREFIX):] + commitEnd := strings.Index(f, BACKUP_DATE_PREFIX) + if commitEnd == -1 { + commitEnd = strings.Index(f, BACKUP_SUFFIX) + } + if commitEnd == -1 { + return fmt.Errorf("end of commit (\"%s\" or \"%s\") not found in \"%s\"", BACKUP_DATE_PREFIX, BACKUP_PREFIX, f) + } + b.Commit = f[:commitEnd] + f = f[commitEnd:] + } else if strings.HasPrefix(f, BACKUP_DATE_PREFIX) { + f = f[len(BACKUP_DATE_PREFIX):] + dateEnd := strings.Index(f, BACKUP_COMMIT_PREFIX) + if dateEnd == -1 { + dateEnd = strings.Index(f, BACKUP_SUFFIX) + } + if dateEnd == -1 { + return fmt.Errorf("end of date (\"%s\" or \"%s\") not found in \"%s\"", BACKUP_COMMIT_PREFIX, BACKUP_PREFIX, f) + } + t, err := time.Parse(BACKUP_DATEFMT, f[:dateEnd]) + if err != nil { + return err + } + b.Date = t + f = f[dateEnd:] + } + } + if b.Date.IsZero() { + return b.FromOldString(of) + } + return nil +} + +func (b *Backup) FromOldString(f string) error { + t, err := time.Parse(BACKUP_DATEFMT, strings.TrimSuffix(strings.TrimPrefix(strings.TrimPrefix(f, BACKUP_UPLOAD_PREFIX), BACKUP_PREFIX+"-"), BACKUP_SUFFIX)) + if err != nil { + return fmt.Errorf(lm.FailedParseTime, err) + } + b.Date = t + return nil + +} + type BackupList struct { files []os.DirEntry - dates []time.Time + info []Backup count int } func (bl BackupList) Len() int { return len(bl.files) } func (bl BackupList) Swap(i, j int) { bl.files[i], bl.files[j] = bl.files[j], bl.files[i] - bl.dates[i], bl.dates[j] = bl.dates[j], bl.dates[i] + bl.info[i], bl.info[j] = bl.info[j], bl.info[i] } func (bl BackupList) Less(i, j int) bool { // Push non-backup files to the end of the array, // Since they didn't have a date parsed. - if bl.dates[i].IsZero() { + if bl.info[i].Date.IsZero() { return false } - if bl.dates[j].IsZero() { + if bl.info[j].Date.IsZero() { return true } // Sort by oldest first - return bl.dates[j].After(bl.dates[i]) + return bl.info[j].Date.After(bl.info[i].Date) } // Get human-readable file size from f.Size() result. @@ -72,18 +164,19 @@ func (app *appContext) getBackups() *BackupList { } backups := &BackupList{} backups.files = items - backups.dates = make([]time.Time, len(items)) + backups.info = make([]Backup, len(items)) backups.count = 0 for i, item := range items { + // Even though Backup{} can parse and check validity, still check if the file ends in .bak, we don't need to print an error if a file isn't a .bak. if item.IsDir() || !(strings.HasSuffix(item.Name(), BACKUP_SUFFIX)) { continue } - t, err := time.Parse(BACKUP_DATEFMT, strings.TrimSuffix(strings.TrimPrefix(strings.TrimPrefix(item.Name(), BACKUP_UPLOAD_PREFIX), BACKUP_PREFIX), BACKUP_SUFFIX)) - if err != nil { - app.debug.Printf(lm.FailedParseTime, err) + b := Backup{} + if err := b.FromString(item.Name()); err != nil { + app.debug.Printf(lm.FailedParseBackup, item.Name(), err) continue } - backups.dates[i] = t + backups.info[i] = b backups.count++ } return backups @@ -91,17 +184,47 @@ func (app *appContext) getBackups() *BackupList { func (app *appContext) makeBackup() (fileDetails CreateBackupDTO) { toKeep := app.config.Section("backups").Key("keep_n_backups").MustInt(20) - fname := BACKUP_PREFIX + time.Now().Local().Format(BACKUP_DATEFMT) + BACKUP_SUFFIX + keepPreviousVersions := app.config.Section("backups").Key("keep_previous_version_backup").MustBool(true) + + b := Backup{Commit: commit} + fname := b.String() path := app.config.Section("backups").Key("path").String() backups := app.getBackups() if backups == nil { return } toDelete := backups.count + 1 - toKeep + if toDelete > 0 || keepPreviousVersions { + sort.Sort(backups) + } + backupsByCommit := map[string]int{} + if keepPreviousVersions { + // Count backups by commit + for _, b := range backups.info { + if b.IsZero() { + continue + } + // If b.Commit is empty, the backup is pre-versions-in-backup-names. + // Still use the empty string as a key, considering these as a single version. + count, ok := backupsByCommit[b.Commit] + if !ok { + count = 0 + } + count += 1 + backupsByCommit[b.Commit] = count + } + fmt.Printf("remaining:%+v\n", backupsByCommit) + } // fmt.Printf("toDelete: %d, backCount: %d, keep: %d, length: %d\n", toDelete, backups.count, toKeep, len(backups.files)) if toDelete > 0 && toDelete <= backups.count { - sort.Sort(backups) - for _, item := range backups.files[:toDelete] { + for i := range toDelete { + backupsRemaining, ok := backupsByCommit[backups.info[i].Commit] + app.debug.Println("item", backups.files[i], "remaining", backupsRemaining) + if keepPreviousVersions && ok && backupsRemaining <= 1 { + continue + } + + item := backups.files[i] fullpath := filepath.Join(path, item.Name()) err := os.Remove(fullpath) if err != nil { @@ -109,6 +232,10 @@ func (app *appContext) makeBackup() (fileDetails CreateBackupDTO) { return } app.debug.Printf(lm.DeleteOldBackup, fullpath) + if keepPreviousVersions && ok { + backupsRemaining -= 1 + backupsByCommit[backups.info[i].Commit] = backupsRemaining + } } } fullpath := filepath.Join(path, fname) @@ -140,7 +267,7 @@ func (app *appContext) loadPendingBackup() { if LOADBAK == "" { return } - oldPath := filepath.Join(app.dataPath, "db-"+string(time.Now().Unix())+"-pre-"+filepath.Base(LOADBAK)) + oldPath := filepath.Join(app.dataPath, "db-"+strconv.FormatInt(time.Now().Unix(), 10)+"-pre-"+filepath.Base(LOADBAK)) err := os.Rename(app.storage.db_path, oldPath) if err != nil { app.err.Fatalf(lm.FailedMoveOldDB, oldPath, err) diff --git a/backups_test.go b/backups_test.go new file mode 100644 index 0000000..abdcda8 --- /dev/null +++ b/backups_test.go @@ -0,0 +1,57 @@ +package main + +import ( + "testing" + "time" +) + +func testBackupParse(f string, a Backup, t *testing.T) { + b := Backup{} + err := b.FromString(f) + if err != nil { + t.Fatalf("error: %+v", err) + } + if !b.Equals(a) { + t.Fatalf("not equal: %+v != %+v", b, a) + } +} + +func TestBackupParserOld(t *testing.T) { + Q1 := BACKUP_PREFIX + "2023-12-21T21-08-00" + BACKUP_SUFFIX + A1 := Backup{} + A1.Date, _ = time.Parse(BACKUP_DATEFMT, "2023-12-21T21-08-00") + testBackupParse(Q1, A1, t) +} +func TestBackupParserOldUpload(t *testing.T) { + Q2 := BACKUP_UPLOAD_PREFIX + BACKUP_PREFIX + "2023-12-21T21-08-00" + BACKUP_SUFFIX + A2 := Backup{ + Upload: true, + } + A2.Date, _ = time.Parse(BACKUP_DATEFMT, "2023-12-21T21-08-00") + testBackupParse(Q2, A2, t) +} +func TestBackupParserUploadDate(t *testing.T) { + Q3 := BACKUP_UPLOAD_PREFIX + BACKUP_PREFIX + BACKUP_DATE_PREFIX + "2023-12-21T21-08-00" + BACKUP_SUFFIX + A3 := Backup{ + Upload: true, + } + A3.Date, _ = time.Parse(BACKUP_DATEFMT, "2023-12-21T21-08-00") + testBackupParse(Q3, A3, t) +} +func TestBackupParserUploadCommitDate(t *testing.T) { + Q4 := BACKUP_UPLOAD_PREFIX + BACKUP_PREFIX + BACKUP_COMMIT_PREFIX + "testcommit" + BACKUP_DATE_PREFIX + "2023-12-21T21-08-00" + BACKUP_SUFFIX + A4 := Backup{ + Commit: "testcommit", + Upload: true, + } + A4.Date, _ = time.Parse(BACKUP_DATEFMT, "2023-12-21T21-08-00") + testBackupParse(Q4, A4, t) +} +func TestBackupParserDateCommit(t *testing.T) { + Q5 := BACKUP_PREFIX + BACKUP_DATE_PREFIX + "2023-12-21T21-08-00" + BACKUP_COMMIT_PREFIX + "testcommit" + BACKUP_SUFFIX + A5 := Backup{ + Commit: "testcommit", + } + A5.Date, _ = time.Parse(BACKUP_DATEFMT, "2023-12-21T21-08-00") + testBackupParse(Q5, A5, t) +} diff --git a/config.go b/config.go index c58f425..c149084 100644 --- a/config.go +++ b/config.go @@ -141,6 +141,7 @@ func (app *appContext) loadConfig() error { app.MustSetValue("backups", "every_n_minutes", "1440") app.MustSetValue("backups", "path", filepath.Join(app.dataPath, "backups")) app.MustSetValue("backups", "keep_n_backups", "20") + app.MustSetValue("backups", "keep_previous_version_backup", "true") app.config.Section("jellyfin").Key("version").SetValue(version) app.config.Section("jellyfin").Key("device").SetValue("jfa-go") diff --git a/config/config-base.yaml b/config/config-base.yaml index ff427d7..49e4392 100644 --- a/config/config-base.yaml +++ b/config/config-base.yaml @@ -1315,6 +1315,12 @@ sections: value: 20 description: Number of most recent backups to keep. Once this is hit, the oldest backup will be deleted before doing a new one. + - setting: keep_previous_version_backup + name: Keep 1 backup from each previous version + requires_restart: true + type: bool + value: true + description: Always keep the most recent backup for each jfa-go version, incase updates mess things up. If enabled, these aren't counted by the "Number of backups to keep" setting. - section: welcome_email meta: name: Welcome Message diff --git a/discord.go b/discord.go index df102da..96fa4bc 100644 --- a/discord.go +++ b/discord.go @@ -196,7 +196,7 @@ func (d *DiscordDaemon) NewTempInvite(ageSeconds, maxUses int) (inviteURL, iconU var inv *dg.Invite var err error if d.InviteChannel.Name == "" { - d.app.err.Println(lm.FailedCreateDiscordInviteChannel, lm.InviteChannelEmpty) + d.app.err.Printf(lm.FailedCreateDiscordInviteChannel, lm.InviteChannelEmpty) return } if d.InviteChannel.ID == "" { diff --git a/email.go b/email.go index 6fb0fac..82da3f2 100644 --- a/email.go +++ b/email.go @@ -576,7 +576,7 @@ func (emailer *Emailer) resetValues(pwr PasswordReset, app *appContext, noSub bo // Only used in html email. template["pin_code"] = pwr.Pin } else { - app.info.Println(lm.FailedGeneratePWRLink, err) + app.info.Printf(lm.FailedGeneratePWRLink, err) template["pin"] = pwr.Pin } } else { diff --git a/go.mod b/go.mod index 08cbe88..6cd8c7a 100644 --- a/go.mod +++ b/go.mod @@ -1,6 +1,8 @@ module github.com/hrfee/jfa-go -go 1.22.0 +go 1.23.0 + +toolchain go1.24.0 replace github.com/hrfee/jfa-go/docs => ./docs @@ -131,12 +133,12 @@ require ( go.uber.org/multierr v1.11.0 // indirect go.uber.org/zap v1.27.0 // indirect golang.org/x/arch v0.11.0 // indirect - golang.org/x/crypto v0.28.0 // indirect + golang.org/x/crypto v0.35.0 // indirect golang.org/x/exp v0.0.0-20241009180824-f66d83c29e7c // indirect golang.org/x/image v0.21.0 // indirect - golang.org/x/net v0.30.0 // indirect - golang.org/x/sys v0.26.0 // indirect - golang.org/x/text v0.19.0 // indirect + golang.org/x/net v0.36.0 // indirect + golang.org/x/sys v0.30.0 // indirect + golang.org/x/text v0.22.0 // indirect golang.org/x/tools v0.26.0 // indirect google.golang.org/protobuf v1.35.1 // indirect ) diff --git a/go.sum b/go.sum index 2dfb31f..c263bc6 100644 --- a/go.sum +++ b/go.sum @@ -401,8 +401,8 @@ golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8U golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20210421170649-83a5a9bb288b/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= -golang.org/x/crypto v0.28.0 h1:GBDwsMXVQi34v5CCYUm2jkJvu4cbtru2U4TN2PSyQnw= -golang.org/x/crypto v0.28.0/go.mod h1:rmgy+3RHxRZMyY0jjAJShp2zgEdOqj2AO7U0pYmeQ7U= +golang.org/x/crypto v0.35.0 h1:b15kiHdrGCHrP6LvwaQ3c03kgNhhiMgvlhxHQhmg2Xs= +golang.org/x/crypto v0.35.0/go.mod h1:dy7dXNW32cAb/6/PRuTNsix8T+vJAqvuIy5Bli/x0YQ= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20241009180824-f66d83c29e7c h1:7dEasQXItcW1xKJ2+gg5VOiBnqWrJc+rq0DPKyvvdbY= golang.org/x/exp v0.0.0-20241009180824-f66d83c29e7c/go.mod h1:NQtJDoLvd6faHhE7m4T/1IY708gDefGGjR/iUW8yQQ8= @@ -441,8 +441,8 @@ golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= -golang.org/x/net v0.30.0 h1:AcW1SDZMkb8IpzCdQUaIq2sP4sZ4zw+55h6ynffypl4= -golang.org/x/net v0.30.0/go.mod h1:2wGyMJ5iFasEhkwi13ChkO/t1ECNC4X4eBKkVFyYFlU= +golang.org/x/net v0.36.0 h1:vWF2fRbw4qslQsQzgFqZff+BItCvGFQqKzKIzx1rmoA= +golang.org/x/net v0.36.0/go.mod h1:bFmbeoIPfrw4sMHNhb4J9f6+tPziuGjq7Jk/38fxi1I= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -454,8 +454,8 @@ golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJ golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ= -golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.11.0 h1:GGz8+XQP4FvTTrjZPzNKTMFtSXH80RAzG+5ghFPgK9w= +golang.org/x/sync v0.11.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20181228144115-9a3f9b0469bb/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= @@ -483,8 +483,8 @@ golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.26.0 h1:KHjCJyddX0LoSTb3J+vWpupP9p0oznkqVk/IfjymZbo= -golang.org/x/sys v0.26.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc= +golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= @@ -496,8 +496,8 @@ golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= -golang.org/x/text v0.19.0 h1:kTxAhCbGbxhK0IwgSKiMO5awPoDQ0RpfiVYBfK860YM= -golang.org/x/text v0.19.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY= +golang.org/x/text v0.22.0 h1:bofq7m3/HAFvbF51jz3Q9wLg3jkvSPuiZu/pD1XwgtM= +golang.org/x/text v0.22.0/go.mod h1:YRoo4H8PVmsu+E3Ou7cqLVH8oXWIHVoX0jqUWALQhfY= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY= diff --git a/html/admin.html b/html/admin.html index ef75925..bb10c4c 100644 --- a/html/admin.html +++ b/html/admin.html @@ -372,6 +372,7 @@ {{ .strings.name }} {{ .strings.date }} + {{ .strings.version }} {{ .strings.backupDownloadRestore }} diff --git a/logmessages/logmessages.go b/logmessages/logmessages.go index f2b9ea2..fbde1e1 100644 --- a/logmessages/logmessages.go +++ b/logmessages/logmessages.go @@ -200,6 +200,7 @@ const ( DeleteOldBackup = "Deleted old backup \"%s\"" FailedDeleteOldBackup = "Failed to delete old backup \"%s\": %v" CreateBackup = "Created database backup \"%+v\"" + FailedParseBackup = "Failed to parse backup \"%s\": %v" FailedCreateBackup = "Faled to create database backup: %v" MoveOldDB = "Moved existing database to \"%s\"" FailedMoveOldDB = "Failed to move existing database to \"%s\": %v" diff --git a/main.go b/main.go index 04d408f..d2f881c 100644 --- a/main.go +++ b/main.go @@ -171,7 +171,7 @@ func test(app *appContext) { var username string fmt.Scanln(&username) user, err := app.jf.UserByName(username, false) - fmt.Printf("UserByName (%s): code %d err %s", username, err) + fmt.Printf("UserByName (%s): err %v", username, err) out, _ := json.MarshalIndent(user, "", " ") fmt.Print(string(out)) } diff --git a/models.go b/models.go index fd24e2a..97e669b 100644 --- a/models.go +++ b/models.go @@ -39,13 +39,13 @@ type newUserResponse struct { } type deleteUserDTO struct { - Users []string `json:"users" binding:"required"` // List of usernames to delete + Users []string `json:"users" binding:"required"` // List of user IDs. Notify bool `json:"notify"` // Whether to notify users of deletion Reason string `json:"reason"` // Account deletion reason (for notification) } type enableDisableUserDTO struct { - Users []string `json:"users" binding:"required"` // List of usernames to delete + Users []string `json:"users" binding:"required"` // List of userIDs. Enabled bool `json:"enabled"` // True = enable users, False = disable. Notify bool `json:"notify"` // Whether to notify users of deletion Reason string `json:"reason"` // Account deletion reason (for notification) @@ -446,10 +446,11 @@ type GetActivityCountDTO struct { } type CreateBackupDTO struct { - Size string `json:"size"` - Name string `json:"name"` - Path string `json:"path"` - Date int64 `json:"date"` + Size string `json:"size"` + Name string `json:"name"` + Path string `json:"path"` + Date int64 `json:"date"` + Commit string `json:"commit"` } type GetBackupsDTO struct { diff --git a/telegram.go b/telegram.go index b68e91c..c7cf5fb 100644 --- a/telegram.go +++ b/telegram.go @@ -121,7 +121,7 @@ func (t *TelegramDaemon) NewAssignedAuthToken(id string) string { } func (t *TelegramDaemon) run() { - t.app.info.Println(lm.StartDaemon, lm.Telegram) + t.app.info.Printf(lm.StartDaemon, lm.Telegram) u := tg.NewUpdate(0) u.Timeout = 60 updates, err := t.bot.GetUpdatesChan(u) diff --git a/ts/modules/settings.ts b/ts/modules/settings.ts index 01aa5df..c9d1459 100644 --- a/ts/modules/settings.ts +++ b/ts/modules/settings.ts @@ -13,6 +13,7 @@ interface BackupDTO { name: string; path: string; date: number; + commit: string; } interface settingsChangedEvent extends Event { @@ -731,6 +732,7 @@ export class settingsList { tr.innerHTML = ` ${b.name} ${toDateString(new Date(b.date*1000))} + ${b.commit || "?"} From dca83dcc8e3119fe7ec98912205a815e5edb3ab5 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Tue, 13 May 2025 15:24:26 +0100 Subject: [PATCH 004/249] db: reduce default vlog size to 256M --- config.go | 2 +- config/config-base.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/config.go b/config.go index 2426091..ff8a29e 100644 --- a/config.go +++ b/config.go @@ -156,7 +156,7 @@ func (app *appContext) loadConfig() error { app.MustSetValue("ui", "port", "8056") app.MustSetValue("advanced", "tls_port", "8057") - app.MustSetValue("advanced", "value_log_size", "1024") + app.MustSetValue("advanced", "value_log_size", "512") pwrMethods := []string{"allow_pwr_username", "allow_pwr_email", "allow_pwr_contact_method"} allDisabled := true diff --git a/config/config-base.yaml b/config/config-base.yaml index 5fff581..39775d1 100644 --- a/config/config-base.yaml +++ b/config/config-base.yaml @@ -341,7 +341,7 @@ sections: name: Database max vlog size (MiB) requires_restart: true type: number - value: 1024 + value: 256 description: Max size for the database's value log. Lower values may reduce performance. - setting: debug_log_emails name: 'Debug Storage Logging: Emails' From 5cc97eaf17aede747cf5a249f6fc63fc5681296e Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Tue, 13 May 2025 15:32:59 +0100 Subject: [PATCH 005/249] goreleaser: fix deprecations this sucks --- .goreleaser.yml | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/.goreleaser.yml b/.goreleaser.yml index afc3531..d9b5da3 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -74,9 +74,9 @@ builds: - amd64 archives: - id: windows-tray - builds: + ids: - windows-tray - format: zip + formats: [ "zip" ] name_template: >- {{ .ProjectName }}_{{ .Version }}_TrayIcon_ {{- if eq .Os "darwin" }}macOS @@ -84,9 +84,9 @@ archives: {{- if eq .Arch "amd64" }}x86_64 {{- else }}{{ .Arch }}{{ end }} - id: linux-tray - builds: + ids: - linux-tray - format: zip + formats: [ "zip" ] name_template: >- {{ .ProjectName }}_{{ .Version }}_TrayIcon_ {{- if eq .Os "darwin" }}macOS @@ -94,9 +94,9 @@ archives: {{- if eq .Arch "amd64" }}x86_64 {{- else }}{{ .Arch }}{{ end }} - id: notray - builds: + ids: - notray - format: zip + formats: [ "zip" ] name_template: >- {{ .ProjectName }}_{{ .Version }}_ {{- if eq .Os "darwin" }}macOS @@ -104,9 +104,9 @@ archives: {{- if eq .Arch "amd64" }}x86_64 {{- else }}{{ .Arch }}{{ end }} - id: notray-e2ee - builds: + ids: - notray-e2ee - format: zip + formats: [ "zip" ] name_template: >- {{ .ProjectName }}_{{ .Version }}_MatrixE2EE_ {{- if eq .Os "darwin" }}macOS @@ -133,7 +133,7 @@ nfpms: license: MIT vendor: hrfee.dev version_metadata: git - builds: + ids: - notray-e2ee contents: - src: ./LICENSE @@ -161,7 +161,7 @@ nfpms: license: MIT vendor: hrfee.dev version_metadata: git - builds: + ids: - linux-tray contents: - src: ./LICENSE From d710b9ad4deabb3dced5598f121be9f70cce5ca4 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Tue, 13 May 2025 16:58:26 +0100 Subject: [PATCH 006/249] db: fix valuelogfilesize calc for some reason I thought it was in kibibytes? no, its in bytes as it should be. --- storage.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/storage.go b/storage.go index f9e503d..bab57a3 100644 --- a/storage.go +++ b/storage.go @@ -175,7 +175,8 @@ func generateLogActions(c *ini.File) map[string]DebugLogAction { func (app *appContext) ConnectDB() { opts := badgerhold.DefaultOptions - opts.Options.ValueLogFileSize = app.config.Section("advanced").Key("value_log_size").MustInt64(1024) * 1024 + // ValueLogFileSize is in bytes, so multiply by 1e6 + opts.Options.ValueLogFileSize = app.config.Section("advanced").Key("value_log_size").MustInt64(256) * 1e6 opts.Dir = app.storage.db_path opts.ValueDir = app.storage.db_path db, err := badgerhold.Open(opts) From 2d98c6cff4f1a2e5544e3d07c3c552ef63471010 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Tue, 13 May 2025 17:31:09 +0100 Subject: [PATCH 007/249] settings: add email test note just send an announcement to yourself. --- common/common.go | 7 +++++++ config/config-base.yaml | 6 ++++++ jellyseerr/jellyseerr.go | 2 +- 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/common/common.go b/common/common.go index 58d0424..6f33115 100644 --- a/common/common.go +++ b/common/common.go @@ -79,6 +79,13 @@ func GenericErr(status int, err error) error { } } +func GenericErrFromResponse(resp *http.Response, err error) error { + if resp == nil { + return ErrUnknown{code: -2} + } + return GenericErr(resp.StatusCode, err) +} + type ConfigurableTransport interface { // SetTransport sets the http.Transport to use for requests. Can be used to set a proxy. SetTransport(t *http.Transport) diff --git a/config/config-base.yaml b/config/config-base.yaml index 39775d1..d429010 100644 --- a/config/config-base.yaml +++ b/config/config-base.yaml @@ -720,6 +720,12 @@ sections: type: bool value: false description: Disables using the same address on multiple accounts. + - setting: test_note + name: 'Test your settings:' + type: note + depends_true: enabled + required: false + description: Go over to the accounts tab, select your user (ensuring you've assigned it an email address) and send yourself an announcement. - section: mailgun meta: name: Mailgun (Email) diff --git a/jellyseerr/jellyseerr.go b/jellyseerr/jellyseerr.go index f7d52ca..79ddc1c 100644 --- a/jellyseerr/jellyseerr.go +++ b/jellyseerr/jellyseerr.go @@ -87,7 +87,7 @@ func (js *Jellyseerr) req(mode string, uri string, data any, queryParams url.Val } } resp, err := js.httpClient.Do(req) - err = co.GenericErr(resp.StatusCode, err) + err = co.GenericErrFromResponse(resp, err) defer js.timeoutHandler() var responseText string defer resp.Body.Close() From c52ba2162ee7def64c13e2d7e8f672c7c2734b3a Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Tue, 13 May 2025 21:10:40 +0100 Subject: [PATCH 008/249] config: start adding path parameters to change the urls of the admin page, the my account page and of invites. Seems to work, but need to check all the code over and test. --- api-messages.go | 10 +- api-userpage.go | 8 +- config.go | 25 +++- config/config-base.yaml | 27 ++++ email.go | 4 +- html/404.html | 3 +- html/admin.html | 16 +-- html/crash.html | 1 + html/create-success.html | 1 - html/form-base.html | 4 - html/form.html | 1 - html/header.html | 29 ++++- html/invalidCode.html | 1 - html/login-modal.html | 2 +- html/password-reset.html | 3 +- html/setup.html | 1 - html/user.html | 12 +- main.go | 64 +++++----- models.go | 15 +++ router.go | 34 ++--- setup.go | 2 + ts/admin.ts | 8 +- ts/form.ts | 12 +- ts/modules/account-linking.ts | 2 +- ts/modules/accounts.ts | 2 + ts/modules/activity.ts | 12 +- ts/modules/common.ts | 14 ++- ts/modules/discord.ts | 2 + ts/modules/invites.ts | 4 +- ts/modules/login.ts | 4 +- ts/modules/modal.ts | 2 +- ts/modules/pages.ts | 1 + ts/modules/profiles.ts | 2 + ts/modules/search.ts | 2 + ts/modules/settings.ts | 2 + ts/modules/tabs.ts | 4 +- ts/modules/update.ts | 2 + ts/pwr-pin.ts | 2 + ts/setup.ts | 3 +- ts/typings/d.ts | 16 ++- ts/user.ts | 13 +- user-auth.go | 3 +- views.go | 227 ++++++++++++++++------------------ 43 files changed, 336 insertions(+), 266 deletions(-) diff --git a/api-messages.go b/api-messages.go index cb4f67f..e3297b5 100644 --- a/api-messages.go +++ b/api-messages.go @@ -414,7 +414,7 @@ func (app *appContext) TelegramVerified(gc *gin.Context) { respondBool(200, ok, gc) } -// @Summary Returns true/false on whether or not a telegram PIN was verified. Requires invite code. +// @Summary Returns true/false on whether or not a telegram PIN was verified. Requires invite code. NOTE: "/invite" might have been changed in Settings > URL Paths. // @Produce json // @Success 200 {object} boolResponse // @Success 401 {object} boolResponse @@ -438,7 +438,7 @@ func (app *appContext) TelegramVerifiedInvite(gc *gin.Context) { respondBool(200, ok, gc) } -// @Summary Returns true/false on whether or not a discord PIN was verified. Requires invite code. +// @Summary Returns true/false on whether or not a discord PIN was verified. Requires invite code. NOTE: "/invite" might have been changed in Settings > URL Paths. // @Produce json // @Success 200 {object} boolResponse // @Failure 401 {object} boolResponse @@ -462,7 +462,7 @@ func (app *appContext) DiscordVerifiedInvite(gc *gin.Context) { respondBool(200, ok, gc) } -// @Summary Returns a 10-minute, one-use Discord server invite +// @Summary Returns a 10-minute, one-use Discord server invite. NOTE: "/invite" might have been changed in Settings > URL Paths. // @Produce json // @Success 200 {object} DiscordInviteDTO // @Failure 400 {object} boolResponse @@ -489,7 +489,7 @@ func (app *appContext) DiscordServerInvite(gc *gin.Context) { gc.JSON(200, DiscordInviteDTO{invURL, iconURL}) } -// @Summary Generate and send a new PIN to a specified Matrix user. +// @Summary Generate and send a new PIN to a specified Matrix user. NOTE: "/invite" might have been changed in Settings > URL Paths. // @Produce json // @Success 200 {object} boolResponse // @Failure 400 {object} stringResponse @@ -528,7 +528,7 @@ func (app *appContext) MatrixSendPIN(gc *gin.Context) { respondBool(200, true, gc) } -// @Summary Check whether a matrix PIN is valid, and mark the token as verified if so. Requires invite code. +// @Summary Check whether a matrix PIN is valid, and mark the token as verified if so. Requires invite code. NOTE: "/invite" might have been changed in Settings > URL Paths. // @Produce json // @Success 200 {object} boolResponse // @Failure 401 {object} boolResponse diff --git a/api-userpage.go b/api-userpage.go index a7d9b77..f608fbb 100644 --- a/api-userpage.go +++ b/api-userpage.go @@ -164,9 +164,7 @@ func (app *appContext) confirmMyAction(gc *gin.Context, key string) { var target ConfirmationTarget var id string fail := func() { - gcHTML(gc, 404, "404.html", gin.H{ - "cssClass": app.cssClass, - "cssVersion": cssVersion, + app.gcHTML(gc, 404, "404.html", OtherPage, gin.H{ "contactMessage": app.config.Section("ui").Key("contact_message").String(), }) } @@ -201,7 +199,7 @@ func (app *appContext) confirmMyAction(gc *gin.Context, key string) { // Perform an Action if target == NoOp { - gc.Redirect(http.StatusSeeOther, "/my/account") + gc.Redirect(http.StatusSeeOther, PAGES.MyAccount) return } else if target == UserEmailChange { app.modifyEmail(id, claims["email"].(string)) @@ -216,7 +214,7 @@ func (app *appContext) confirmMyAction(gc *gin.Context, key string) { }, gc, true) app.info.Printf(lm.UserEmailAdjusted, gc.GetString("jfId")) - gc.Redirect(http.StatusSeeOther, "/my/account") + gc.Redirect(http.StatusSeeOther, PAGES.MyAccount) return } } diff --git a/config.go b/config.go index ff8a29e..4cb2bb7 100644 --- a/config.go +++ b/config.go @@ -22,6 +22,9 @@ var telegramEnabled = false var discordEnabled = false var matrixEnabled = false +// URL subpaths. Ignore the "Current" field. +var PAGES = PagePaths{} + func (app *appContext) GetPath(sect, key string) (fs.FS, string) { val := app.config.Section(sect).Key(key).MustString("") if strings.HasPrefix(val, "jfa-go:") { @@ -35,6 +38,13 @@ func (app *appContext) MustSetValue(section, key, val string) { app.config.Section(section).Key(key).SetValue(app.config.Section(section).Key(key).MustString(val)) } +func (app *appContext) MustSetURLPath(section, key, val string) { + if !strings.HasPrefix(val, "/") { + val = "/" + val + } + app.MustSetValue(section, key, val) +} + func (app *appContext) loadConfig() error { var err error app.config, err = ini.ShadowLoad(app.configPath) @@ -42,6 +52,13 @@ func (app *appContext) loadConfig() error { return err } + app.MustSetURLPath("url_paths", "admin", "/") + app.MustSetURLPath("url_paths", "user_page", "/my/account") + app.MustSetURLPath("url_paths", "form", "/invite") + PAGES.Admin = app.config.Section("url_paths").Key("admin").MustString("/") + PAGES.MyAccount = app.config.Section("url_paths").Key("user_page").MustString("/my/account") + PAGES.Form = app.config.Section("url_paths").Key("form").MustString("/invite") + app.MustSetValue("jellyfin", "public_server", app.config.Section("jellyfin").Key("server").String()) app.MustSetValue("ui", "redirect_url", app.config.Section("jellyfin").Key("public_server").String()) @@ -58,12 +75,12 @@ func (app *appContext) loadConfig() error { app.config.Section("files").Key(key).SetValue(app.config.Section("files").Key(key).MustString(filepath.Join(app.dataPath, (key + ".db")))) } - app.URLBase = strings.TrimSuffix(app.config.Section("ui").Key("url_base").MustString(""), "/") - if app.URLBase == "/invite" || app.URLBase == "/accounts" || app.URLBase == "/settings" || app.URLBase == "/activity" { - app.err.Printf(lm.BadURLBase, app.URLBase) + PAGES.Base = strings.TrimSuffix(app.config.Section("ui").Key("url_base").MustString(""), "/") + if PAGES.Base == "/invite" || PAGES.Base == "/accounts" || PAGES.Base == "/settings" || PAGES.Base == "/activity" { + app.err.Printf(lm.BadURLBase, PAGES.Base) } app.ExternalURI = strings.TrimSuffix(strings.TrimSuffix(app.config.Section("ui").Key("jfa_url").MustString(""), "/invite"), "/") - if !strings.HasSuffix(app.ExternalURI, app.URLBase) { + if !strings.HasSuffix(app.ExternalURI, PAGES.Base) { app.err.Println(lm.NoURLSuffix) } if app.ExternalURI == "" { diff --git a/config/config-base.yaml b/config/config-base.yaml index d429010..2a17342 100644 --- a/config/config-base.yaml +++ b/config/config-base.yaml @@ -232,6 +232,33 @@ sections: - ["opaque", "Opaque"] value: clear description: Appearance of the Admin login screen. +- section: url_paths + meta: + name: URL Paths + description: Settings for changing where different pages are accessed. + advanced: true + settings: + - setting: admin + name: Admin page subpath + type: text + required: true + requires_restart: true + value: "/" + description: URL subpath the admin page should be at. + - setting: user_page + name: "\"My Account\" subpath" + type: text + required: true + requires_restart: true + value: "/my/account" + description: URL subpath the "My Account" page should be at. + - setting: form + name: Invite subpath + type: text + required: true + requires_restart: true + value: "/invite" + description: URL subpath invites should be on. - section: advanced meta: name: Advanced diff --git a/email.go b/email.go index 82da3f2..5201a33 100644 --- a/email.go +++ b/email.go @@ -329,7 +329,7 @@ func (emailer *Emailer) confirmationValues(code, username, key string, app *appC if code == "" { // Personal email change inviteLink = fmt.Sprintf("%s/my/confirm/%s", inviteLink, url.PathEscape(key)) } else { // Invite email confirmation - inviteLink = fmt.Sprintf("%s/invite/%s?key=%s", inviteLink, code, url.PathEscape(key)) + inviteLink = fmt.Sprintf("%s%s/%s?key=%s", inviteLink, PAGES.Form, code, url.PathEscape(key)) } template["helloUser"] = emailer.lang.Strings.template("helloUser", tmpl{"username": username}) template["confirmationURL"] = inviteLink @@ -393,7 +393,7 @@ func (emailer *Emailer) inviteValues(code string, invite Invite, app *appContext expiry := invite.ValidTill d, t, expiresIn := emailer.formatExpiry(expiry, false, app.datePattern, app.timePattern) message := app.config.Section("messages").Key("message").String() - inviteLink := fmt.Sprintf("%s/invite/%s", app.ExternalURI, code) + inviteLink := fmt.Sprintf("%s%s/%s", app.ExternalURI, PAGES.Form, code) template := map[string]interface{}{ "hello": emailer.lang.InviteEmail.get("hello"), "youHaveBeenInvited": emailer.lang.InviteEmail.get("youHaveBeenInvited"), diff --git a/html/404.html b/html/404.html index 22b0cbb..429ecba 100644 --- a/html/404.html +++ b/html/404.html @@ -1,9 +1,8 @@ - - {{ template "header.html" . }} 404 - jfa-go + {{ template "header.html" . }}
diff --git a/html/admin.html b/html/admin.html index bb10c4c..25630bd 100644 --- a/html/admin.html +++ b/html/admin.html @@ -1,16 +1,7 @@ - Admin - jfa-go @@ -47,7 +37,7 @@
- + diff --git a/html/crash.html b/html/crash.html index 44e4b43..e01329b 100644 --- a/html/crash.html +++ b/html/crash.html @@ -1,6 +1,7 @@ + {{ template "header.html" . }} Crash report diff --git a/html/create-success.html b/html/create-success.html index 19b7660..105424f 100644 --- a/html/create-success.html +++ b/html/create-success.html @@ -1,7 +1,6 @@ - {{ template "header.html" . }} {{ .strings.successHeader }} - jfa-go diff --git a/html/form-base.html b/html/form-base.html index f25bb2e..77e6a36 100644 --- a/html/form-base.html +++ b/html/form-base.html @@ -3,7 +3,6 @@ window.usernameEnabled = {{ .username }}; window.validationStrings = JSON.parse({{ .validationStrings }}); window.invalidPassword = "{{ .strings.reEnterPasswordInvalid }}"; - window.URLBase = "{{ .urlBase }}"; window.code = "{{ .code }}"; window.language = "{{ .langName }}"; window.messages = JSON.parse({{ .notifications }}); @@ -14,16 +13,13 @@ window.userExpiryHours = {{ .userExpiryHours }}; window.userExpiryMinutes = {{ .userExpiryMinutes }}; window.userExpiryMessage = {{ .userExpiryMessage }}; - window.telegramEnabled = {{ .telegramEnabled }}; window.telegramRequired = {{ .telegramRequired }}; window.telegramPIN = "{{ .telegramPIN }}"; window.emailRequired = {{ .emailRequired }}; - window.discordEnabled = {{ .discordEnabled }}; window.discordRequired = {{ .discordRequired }}; window.discordPIN = "{{ .discordPIN }}"; window.discordInviteLink = {{ .discordInviteLink }}; window.discordServerName = "{{ .discordServerName }}"; - window.matrixEnabled = {{ .matrixEnabled }}; window.matrixRequired = {{ .matrixRequired }}; window.matrixUserID = "{{ .matrixUser }}"; window.captcha = {{ .captcha }}; diff --git a/html/form.html b/html/form.html index 5199cad..336d21d 100644 --- a/html/form.html +++ b/html/form.html @@ -1,7 +1,6 @@ - {{ template "header.html" . }} {{ if .passwordReset }} {{ .strings.passwordReset }} diff --git a/html/header.html b/html/header.html index 6af2da8..b857990 100644 --- a/html/header.html +++ b/html/header.html @@ -1,13 +1,32 @@ + - - - - - + + + + + + diff --git a/html/invalidCode.html b/html/invalidCode.html index bc8de0f..611577b 100644 --- a/html/invalidCode.html +++ b/html/invalidCode.html @@ -1,7 +1,6 @@ - {{ template "header.html" . }} Invalid Code - jfa-go diff --git a/html/login-modal.html b/html/login-modal.html index 408e5c7..dde3998 100644 --- a/html/login-modal.html +++ b/html/login-modal.html @@ -15,7 +15,7 @@ {{ $hasTwoCards = 1 }}
{{ .strings.loginNotAdmin }} - {{ .strings.myAccount }} + {{ .strings.myAccount }}
{{ end }} {{ end }} diff --git a/html/password-reset.html b/html/password-reset.html index ebd75fd..4ffd558 100644 --- a/html/password-reset.html +++ b/html/password-reset.html @@ -1,7 +1,6 @@ - {{ template "header.html" . }} {{ .strings.passwordReset }} - jfa-go @@ -40,6 +39,6 @@ {{ .contactMessage }} - + diff --git a/html/setup.html b/html/setup.html index 0d53716..ffed526 100644 --- a/html/setup.html +++ b/html/setup.html @@ -1,7 +1,6 @@ - {{ template "header.html" . }} {{ .lang.Strings.pageTitle }} diff --git a/html/user.html b/html/user.html index 7e7484b..8de812b 100644 --- a/html/user.html +++ b/html/user.html @@ -1,31 +1,21 @@ - {{ template "header.html" . }} {{ .strings.myAccount }} @@ -156,7 +146,7 @@ {{ end }} - + diff --git a/main.go b/main.go index d2f881c..7d1de5a 100644 --- a/main.go +++ b/main.go @@ -103,37 +103,37 @@ type appContext struct { adminUsers []User invalidTokens []string // Keeping jf name because I can't think of a better one - jf *mediabrowser.MediaBrowser - authJf *mediabrowser.MediaBrowser - ombi *OmbiWrapper - js *JellyseerrWrapper - thirdPartyServices []ThirdPartyService - datePattern string - timePattern string - storage Storage - validator Validator - email *Emailer - telegram *TelegramDaemon - discord *DiscordDaemon - matrix *MatrixDaemon - contactMethods []ContactMethodLinker - info, debug, err *logger.Logger - host string - port int - version string - URLBase, ExternalURI, ExternalDomain string - updater *Updater - webhooks *WebhookSender - newUpdate bool // Whether whatever's in update is new. - tag Tag - update Update - proxyEnabled bool - proxyTransport *http.Transport - proxyConfig easyproxy.ProxyConfig - internalPWRs map[string]InternalPWR - pwrCaptchas map[string]Captcha - ConfirmationKeys map[string]map[string]ConfirmationKey // Map of invite code to jwt to request - confirmationKeysLock sync.Mutex + jf *mediabrowser.MediaBrowser + authJf *mediabrowser.MediaBrowser + ombi *OmbiWrapper + js *JellyseerrWrapper + thirdPartyServices []ThirdPartyService + datePattern string + timePattern string + storage Storage + validator Validator + email *Emailer + telegram *TelegramDaemon + discord *DiscordDaemon + matrix *MatrixDaemon + contactMethods []ContactMethodLinker + info, debug, err *logger.Logger + host string + port int + version string + ExternalURI, ExternalDomain string + updater *Updater + webhooks *WebhookSender + newUpdate bool // Whether whatever's in update is new. + tag Tag + update Update + proxyEnabled bool + proxyTransport *http.Transport + proxyConfig easyproxy.ProxyConfig + internalPWRs map[string]InternalPWR + pwrCaptchas map[string]Captcha + ConfirmationKeys map[string]map[string]ConfirmationKey // Map of invite code to jwt to request + confirmationKeysLock sync.Mutex } func generateSecret(length int) (string, error) { @@ -147,7 +147,7 @@ func generateSecret(length int) (string, error) { func test(app *appContext) { fmt.Printf("\n\n----\n\n") - settings := map[string]interface{}{ + settings := map[string]any{ "server": app.jf.Server, "server version": app.jf.ServerInfo.Version, "server name": app.jf.ServerInfo.Name, diff --git a/models.go b/models.go index 97e669b..686effd 100644 --- a/models.go +++ b/models.go @@ -467,3 +467,18 @@ type ContactMethodKey struct { PIN string User ContactMethodUser } + +type PagePaths struct { + // The base subfolder the app is hosted on. + Base string `json:"Base"` + // Those for other pages + Admin string `json:"Admin"` + MyAccount string `json:"MyAccount"` + Form string `json:"Form"` +} + +type PagePathsDTO struct { + PagePaths + // The subdirectory this bit of the app is hosted on (e.g. admin is usually on "/", myacc is usually on "/my/account") + Current string `json:"Current"` +} diff --git a/router.go b/router.go index 9edc32c..e88f49f 100644 --- a/router.go +++ b/router.go @@ -108,8 +108,8 @@ func (app *appContext) loadRouter(address string, debug bool) *gin.Engine { } func (app *appContext) loadRoutes(router *gin.Engine) { - routePrefixes := []string{app.URLBase} - if app.URLBase != "" { + routePrefixes := []string{PAGES.Base} + if PAGES.Base != "" { routePrefixes = append(routePrefixes, "") } @@ -118,7 +118,7 @@ func (app *appContext) loadRoutes(router *gin.Engine) { for _, p := range routePrefixes { router.GET(p+"/lang/:page", app.GetLanguages) router.Use(static.Serve(p+"/", app.webFS)) - router.GET(p+"/", app.AdminPage) + router.GET(p+PAGES.Admin, app.AdminPage) if app.config.Section("password_resets").Key("link_reset").MustBool(false) { router.GET(p+"/reset", app.ResetPassword) @@ -127,39 +127,39 @@ func (app *appContext) loadRoutes(router *gin.Engine) { } } - router.GET(p+"/accounts", app.AdminPage) - router.GET(p+"/settings", app.AdminPage) - router.GET(p+"/activity", app.AdminPage) - router.GET(p+"/accounts/user/:userID", app.AdminPage) - router.GET(p+"/invites/:code", app.AdminPage) + router.GET(p+PAGES.Admin+"/accounts", app.AdminPage) + router.GET(p+PAGES.Admin+"/settings", app.AdminPage) + router.GET(p+PAGES.Admin+"/activity", app.AdminPage) + router.GET(p+PAGES.Admin+"/accounts/user/:userID", app.AdminPage) + router.GET(p+PAGES.Admin+"/invites/:code", app.AdminPage) router.GET(p+"/lang/:page/:file", app.ServeLang) router.GET(p+"/token/login", app.getTokenLogin) router.GET(p+"/token/refresh", app.getTokenRefresh) router.POST(p+"/user/invite", app.NewUserFromInvite) - router.Use(static.Serve(p+"/invite/", app.webFS)) - router.GET(p+"/invite/:invCode", app.InviteProxy) + router.Use(static.Serve(p+PAGES.Form, app.webFS)) + router.GET(p+PAGES.Form+"/:invCode", app.InviteProxy) if app.config.Section("captcha").Key("enabled").MustBool(false) { router.GET(p+"/captcha/gen/:invCode", app.GenCaptcha) router.GET(p+"/captcha/img/:invCode/:captchaID", app.GetCaptcha) router.POST(p+"/captcha/verify/:invCode/:captchaID/:text", app.VerifyCaptcha) } if telegramEnabled { - router.GET(p+"/invite/:invCode/telegram/verified/:pin", app.TelegramVerifiedInvite) + router.GET(p+PAGES.Form+"/:invCode/telegram/verified/:pin", app.TelegramVerifiedInvite) } if discordEnabled { - router.GET(p+"/invite/:invCode/discord/verified/:pin", app.DiscordVerifiedInvite) + router.GET(p+PAGES.Form+"/:invCode/discord/verified/:pin", app.DiscordVerifiedInvite) if app.config.Section("discord").Key("provide_invite").MustBool(false) { - router.GET(p+"/invite/:invCode/discord/invite", app.DiscordServerInvite) + router.GET(p+PAGES.Form+"/:invCode/discord/invite", app.DiscordServerInvite) } } if matrixEnabled { - router.GET(p+"/invite/:invCode/matrix/verified/:userID/:pin", app.MatrixCheckPIN) - router.POST(p+"/invite/:invCode/matrix/user", app.MatrixSendPIN) + router.GET(p+PAGES.Form+"/:invCode/matrix/verified/:userID/:pin", app.MatrixCheckPIN) + router.POST(p+PAGES.Form+"/:invCode/matrix/user", app.MatrixSendPIN) router.POST(p+"/users/matrix", app.MatrixConnect) } if userPageEnabled { - router.GET(p+"/my/account", app.MyUserPage) - router.GET(p+"/my/account/password/reset", app.MyUserPage) + router.GET(p+PAGES.MyAccount, app.MyUserPage) + router.GET(p+PAGES.MyAccount+"/password/reset", app.MyUserPage) router.GET(p+"/my/token/login", app.getUserTokenLogin) router.GET(p+"/my/token/refresh", app.getUserTokenRefresh) router.GET(p+"/my/confirm/:jwt", app.ConfirmMyAction) diff --git a/setup.go b/setup.go index bebba74..5d2f1ab 100644 --- a/setup.go +++ b/setup.go @@ -39,8 +39,10 @@ func (app *appContext) ServeSetup(gc *gin.Context) { respond(500, "Failed to fetch default values", gc) return } + pages := PagePathsDTO{PagePaths: PAGES} gc.HTML(200, "setup.html", gin.H{ "cssVersion": cssVersion, + "pages": pages, "lang": app.storage.lang.Setup[lang], "strings": app.storage.lang.Setup[lang].Strings, "emailLang": app.storage.lang.Email[emailLang], diff --git a/ts/admin.ts b/ts/admin.ts index 814fa37..090a8e4 100644 --- a/ts/admin.ts +++ b/ts/admin.ts @@ -11,6 +11,8 @@ import { _get, _post, notificationBox, whichAnimationEvent, bindManualDropdowns import { Updater } from "./modules/update.js"; import { Login } from "./modules/login.js"; +declare var window: GlobalWindow; + const theme = new ThemeManager(document.getElementById("button-theme")); window.lang = new lang(window.langFile as LangFile); @@ -165,12 +167,12 @@ const defaultTab = tabs[0]; window.tabs = new Tabs(); for (let tab of tabs) { - window.tabs.addTab(tab.id, tab.url, null, tab.reloader); + window.tabs.addTab(tab.id, window.pages.Admin + "/" + tab.url, null, tab.reloader); } let matchedTab = false -for (let tab of tabs) { - if (window.location.pathname.startsWith(window.URLBase + "/" + tab.url)) { +for (const tab of tabs) { + if (window.location.pathname.startsWith(window.pages.Base + window.pages.Current + "/" + tab.url)) { window.tabs.switch(tab.url, true); matchedTab = true; } diff --git a/ts/form.ts b/ts/form.ts index 6552040..7ec413c 100644 --- a/ts/form.ts +++ b/ts/form.ts @@ -6,7 +6,7 @@ import { Validator, ValidatorConf, ValidatorRespDTO } from "./modules/validator. import { Discord, Telegram, Matrix, ServiceConfiguration, MatrixConfiguration } from "./modules/account-linking.js"; import { Captcha, GreCAPTCHA } from "./modules/captcha.js"; -interface formWindow extends Window { +interface formWindow extends GlobalWindow { invalidPassword: string; successModal: Modal; telegramModal: Modal; @@ -59,7 +59,7 @@ if (window.telegramEnabled) { modal: window.telegramModal as Modal, pin: window.telegramPIN, pinURL: "", - verifiedURL: "/invite/" + window.code + "/telegram/verified/", + verifiedURL: window.pages.Form + "/" + window.code + "/telegram/verified/", invalidCodeError: window.messages["errorInvalidPIN"], accountLinkedError: window.messages["errorAccountLinked"], successError: window.messages["verified"], @@ -89,9 +89,9 @@ if (window.discordEnabled) { const discordConf: ServiceConfiguration = { modal: window.discordModal as Modal, pin: window.discordPIN, - inviteURL: window.discordInviteLink ? ("/invite/" + window.code + "/discord/invite") : "", + inviteURL: window.discordInviteLink ? (window.pages.Form + "/" + window.code + "/discord/invite") : "", pinURL: "", - verifiedURL: "/invite/" + window.code + "/discord/verified/", + verifiedURL: window.pages.Form + "/" + window.code + "/discord/verified/", invalidCodeError: window.messages["errorInvalidPIN"], accountLinkedError: window.messages["errorAccountLinked"], successError: window.messages["verified"], @@ -121,8 +121,8 @@ if (window.matrixEnabled) { const matrixConf: MatrixConfiguration = { modal: window.matrixModal as Modal, - sendMessageURL: "/invite/" + window.code + "/matrix/user", - verifiedURL: "/invite/" + window.code + "/matrix/verified/", + sendMessageURL: window.pages.Form + "/" + window.code + "/matrix/user", + verifiedURL: window.pages.Form + "/" + window.code + "/matrix/verified/", invalidCodeError: window.messages["errorInvalidPIN"], accountLinkedError: window.messages["errorAccountLinked"], unknownError: window.messages["errorUnknown"], diff --git a/ts/modules/account-linking.ts b/ts/modules/account-linking.ts index 301c3cb..effc511 100644 --- a/ts/modules/account-linking.ts +++ b/ts/modules/account-linking.ts @@ -1,7 +1,7 @@ import { Modal } from "../modules/modal.js"; import { _get, _post, toggleLoader, addLoader, removeLoader } from "../modules/common.js"; -interface formWindow extends Window { +interface formWindow extends GlobalWindow { invalidPassword: string; successModal: Modal; telegramModal: Modal; diff --git a/ts/modules/accounts.ts b/ts/modules/accounts.ts index ab88af0..c338bfc 100644 --- a/ts/modules/accounts.ts +++ b/ts/modules/accounts.ts @@ -6,6 +6,8 @@ import { DiscordUser, newDiscordSearch } from "../modules/discord.js"; import { Search, SearchConfiguration, QueryType, SearchableItem } from "../modules/search.js"; import { HiddenInputField } from "./ui.js"; +declare var window: GlobalWindow; + const dateParser = require("any-date-parser"); interface User { diff --git a/ts/modules/activity.ts b/ts/modules/activity.ts index d54972f..1049390 100644 --- a/ts/modules/activity.ts +++ b/ts/modules/activity.ts @@ -3,6 +3,8 @@ import { Search, SearchConfiguration, QueryType, SearchableItem } from "../modul import { accountURLEvent } from "../modules/accounts.js"; import { inviteURLEvent } from "../modules/invites.js"; +declare var window: GlobalWindow; + export interface activity { id: string; type: string; @@ -52,8 +54,8 @@ export class Activity implements activity, SearchableItem { link = link.split(split)[0]; } if (link.slice(-1) != "/") { link += "/"; } - // FIXME: I should probably just be using window.URLBase, but incase thats not right, i'll put this warning here - if (link != window.URLBase) console.error(`URL Bases don't match: "${link}" != "${window.URLBase}"`); + // FIXME: I should probably just be using window.pages.Base, but incase thats not right, i'll put this warning here + if (link != window.pages.Base) console.error(`URL Bases don't match: "${link}" != "${window.pages.Base}"`); return link; })(); */ @@ -66,17 +68,17 @@ export class Activity implements activity, SearchableItem { } _genUserLink = (): string => { - return `${this._genUserText()}`; + return `${this._genUserText()}`; } _genSrcUserLink = (): string => { - return `${this._genSrcUserText()}`; + return `${this._genSrcUserText()}`; } private _renderInvText = (): string => { return `${this.value || this.invite_code || "???"}`; } private _genInvLink = (): string => { - return `${this._renderInvText()}`; + return `${this._renderInvText()}`; } diff --git a/ts/modules/common.ts b/ts/modules/common.ts index d87498a..40b5ddd 100644 --- a/ts/modules/common.ts +++ b/ts/modules/common.ts @@ -1,4 +1,4 @@ -declare var window: Window; +declare var window: GlobalWindow; export function toDateString(date: Date): string { const locale = window.language || (window as any).navigator.userLanguage || window.navigator.language; @@ -23,7 +23,7 @@ export function toDateString(date: Date): string { export const _get = (url: string, data: Object, onreadystatechange: (req: XMLHttpRequest) => void, noConnectionError: boolean = false): void => { let req = new XMLHttpRequest(); - if (window.URLBase) { url = window.URLBase + url; } + if (window.pages) { url = window.pages.Base + url; } req.open("GET", url, true); req.responseType = 'json'; req.setRequestHeader("Authorization", "Bearer " + window.token); @@ -42,7 +42,7 @@ export const _get = (url: string, data: Object, onreadystatechange: (req: XMLHtt export const _download = (url: string, fname: string): void => { let req = new XMLHttpRequest(); - if (window.URLBase) { url = window.URLBase + url; } + if (window.pages) { url = window.pages.Base + url; } req.open("GET", url, true); req.responseType = 'blob'; req.setRequestHeader("Authorization", "Bearer " + window.token); @@ -58,7 +58,7 @@ export const _download = (url: string, fname: string): void => { export const _upload = (url: string, formData: FormData): void => { let req = new XMLHttpRequest(); - if (window.URLBase) { url = window.URLBase + url; } + if (window.pages) { url = window.pages.Base + url; } req.open("POST", url, true); req.setRequestHeader("Authorization", "Bearer " + window.token); // req.setRequestHeader('Content-Type', 'multipart/form-data'); @@ -67,7 +67,8 @@ export const _upload = (url: string, formData: FormData): void => { export const _post = (url: string, data: Object, onreadystatechange: (req: XMLHttpRequest) => void, response?: boolean, statusHandler?: (req: XMLHttpRequest) => void, noConnectionError: boolean = false): void => { let req = new XMLHttpRequest(); - req.open("POST", window.URLBase + url, true); + if (window.pages) { url = window.pages.Base + url; } + req.open("POST", url, true); if (response) { req.responseType = 'json'; } @@ -88,7 +89,8 @@ export const _post = (url: string, data: Object, onreadystatechange: (req: XMLHt export function _delete(url: string, data: Object, onreadystatechange: (req: XMLHttpRequest) => void, noConnectionError: boolean = false): void { let req = new XMLHttpRequest(); - req.open("DELETE", window.URLBase + url, true); + if (window.pages) { url = window.pages.Base + url; } + req.open("DELETE", url, true); req.setRequestHeader("Authorization", "Bearer " + window.token); req.setRequestHeader('Content-Type', 'application/json; charset=UTF-8'); req.onreadystatechange = () => { diff --git a/ts/modules/discord.ts b/ts/modules/discord.ts index 89e8a8c..f773ccf 100644 --- a/ts/modules/discord.ts +++ b/ts/modules/discord.ts @@ -1,5 +1,7 @@ import {addLoader, removeLoader, _get} from "../modules/common.js"; +declare var window: GlobalWindow; + export interface DiscordUser { name: string; avatar_url: string; diff --git a/ts/modules/invites.ts b/ts/modules/invites.ts index c9b759c..4c34a90 100644 --- a/ts/modules/invites.ts +++ b/ts/modules/invites.ts @@ -2,6 +2,8 @@ import { _get, _post, _delete, toClipboard, toggleLoader, toDateString } from ". import { DiscordUser, newDiscordSearch } from "../modules/discord.js"; import { reloadProfileNames } from "../modules/profiles.js"; +declare var window: GlobalWindow; + class DOMInvite implements Invite { updateNotify = (checkbox: HTMLInputElement) => { let state: { [code: string]: { [type: string]: boolean } } = {}; @@ -66,7 +68,7 @@ class DOMInvite implements Invite { codeLink = codeLink.split(split)[0]; } if (codeLink.slice(-1) != "/") { codeLink += "/"; } - this._codeLink = codeLink + "invite/" + code; + this._codeLink = codeLink + window.pages.Form + "/" + code; const linkEl = this._codeArea.querySelector("a") as HTMLAnchorElement; if (this.label == "") { linkEl.textContent = code.replace(/-/g, '-'); diff --git a/ts/modules/login.ts b/ts/modules/login.ts index 71cd590..11d09bd 100644 --- a/ts/modules/login.ts +++ b/ts/modules/login.ts @@ -1,6 +1,8 @@ import { Modal } from "../modules/modal.js"; import { toggleLoader, _post, unicodeB64Encode } from "../modules/common.js"; +declare var window: GlobalWindow; + export class Login { loggedIn: boolean = false; private _modal: Modal; @@ -14,7 +16,7 @@ export class Login { constructor(modal: Modal, endpoint: string, appearance: string) { this._endpoint = endpoint; - this._url = window.URLBase + endpoint; + this._url = window.pages.Base + endpoint; if (this._url[this._url.length-1] != '/') this._url += "/"; this._modal = modal; diff --git a/ts/modules/modal.ts b/ts/modules/modal.ts index 77cbb4e..92e3435 100644 --- a/ts/modules/modal.ts +++ b/ts/modules/modal.ts @@ -1,4 +1,4 @@ -declare var window: Window; +declare var window: GlobalWindow; export class Modal implements Modal { modal: HTMLElement; diff --git a/ts/modules/pages.ts b/ts/modules/pages.ts index 686f771..edf21f3 100644 --- a/ts/modules/pages.ts +++ b/ts/modules/pages.ts @@ -73,6 +73,7 @@ export class PageManager { } loadPage (p: Page) { + console.log("loading page with", p.name || this.defaultName, p.title, p.url + window.location.search); window.history.pushState(p.name || this.defaultName, p.title, p.url + window.location.search); } diff --git a/ts/modules/profiles.ts b/ts/modules/profiles.ts index e58fb27..51d6eb3 100644 --- a/ts/modules/profiles.ts +++ b/ts/modules/profiles.ts @@ -1,5 +1,7 @@ import { _get, _post, _delete, toggleLoader } from "../modules/common.js"; +declare var window: GlobalWindow; + export const profileLoadEvent = new CustomEvent("profileLoadEvent"); export const reloadProfileNames = (then?: () => void) => _get("/profiles/names", null, (req: XMLHttpRequest) => { if (req.readyState != 4) return; diff --git a/ts/modules/search.ts b/ts/modules/search.ts index dd01dbe..fa8d1e1 100644 --- a/ts/modules/search.ts +++ b/ts/modules/search.ts @@ -1,5 +1,7 @@ const dateParser = require("any-date-parser"); +declare var window: GlobalWindow; + export interface QueryType { name: string; description?: string; diff --git a/ts/modules/settings.ts b/ts/modules/settings.ts index c9d1459..a1a43f8 100644 --- a/ts/modules/settings.ts +++ b/ts/modules/settings.ts @@ -2,6 +2,8 @@ import { _get, _post, _delete, _download, _upload, toggleLoader, addLoader, remo import { Marked } from "@ts-stack/markdown"; import { stripMarkdown } from "../modules/stripmd.js"; +declare var window: GlobalWindow; + const toBool = (s: string): boolean => { let b = Boolean(s); if (s == "false") b = false; diff --git a/ts/modules/tabs.ts b/ts/modules/tabs.ts index 628ed7e..3f7d78b 100644 --- a/ts/modules/tabs.ts +++ b/ts/modules/tabs.ts @@ -1,5 +1,7 @@ import { PageManager, Page } from "../modules/pages.js"; +declare var window: GlobalWindow; + export interface Tab { page: Page; tabEl: HTMLDivElement; @@ -38,7 +40,7 @@ export class Tabs implements Tabs { tab.page = { name: tabID, title: document.title, /*FIXME: Get actual names from translations*/ - url: window.URLBase + "/" + url, + url: url, show: () => { tab.buttonEl.classList.add("active", "~urge"); tab.tabEl.classList.remove("unfocused"); diff --git a/ts/modules/update.ts b/ts/modules/update.ts index ba2c946..c39fc63 100644 --- a/ts/modules/update.ts +++ b/ts/modules/update.ts @@ -1,6 +1,8 @@ import { _get, _post, toggleLoader, toDateString } from "../modules/common.js"; import { Marked, Renderer } from "@ts-stack/markdown"; +declare var window: GlobalWindow; + interface updateDTO { new: boolean; update: Update; diff --git a/ts/pwr-pin.ts b/ts/pwr-pin.ts index 8774967..a274a58 100644 --- a/ts/pwr-pin.ts +++ b/ts/pwr-pin.ts @@ -1,5 +1,7 @@ import { toClipboard, notificationBox } from "./modules/common.js"; +declare var window: GlobalWindow; + const pin = document.getElementById("pin") as HTMLSpanElement; if (pin) { diff --git a/ts/setup.ts b/ts/setup.ts index 747ed83..d987060 100644 --- a/ts/setup.ts +++ b/ts/setup.ts @@ -3,12 +3,11 @@ import { lang, LangFile, loadLangSelector } from "./modules/lang.js"; import { ThemeManager } from "./modules/theme.js"; import { PageManager } from "./modules/pages.js"; -interface sWindow extends Window { +interface sWindow extends GlobalWindow { messages: {}; } declare var window: sWindow; -window.URLBase = ""; const theme = new ThemeManager(document.getElementById("button-theme")); diff --git a/ts/typings/d.ts b/ts/typings/d.ts index a53a3fb..b19a1c7 100644 --- a/ts/typings/d.ts +++ b/ts/typings/d.ts @@ -12,8 +12,19 @@ interface ArrayConstructor { from(arrayLike: any, mapFn?, thisArg?): Array; } -declare interface Window { - URLBase: string; +declare interface PagePaths { + // The base subfolder the app is hosted on. + Base: string; + // The subdirectory this bit of the app is hosted on (e.g. admin is usually on "/", myacc is usually on "/my/account") + Current: string; + // Those for other pages + Admin: string; + MyAccount: string; + Form: string; +} + +declare interface GlobalWindow extends Window { + pages: PagePaths; modals: Modals; cssFile: string; availableProfiles: string[]; @@ -25,6 +36,7 @@ declare interface Window { matrixEnabled: boolean; ombiEnabled: boolean; jellyseerrEnabled: boolean; + pwrEnabled: boolean; usernameEnabled: boolean; linkResetEnabled: boolean; token: string; diff --git a/ts/user.ts b/ts/user.ts index b72b22b..cceb19e 100644 --- a/ts/user.ts +++ b/ts/user.ts @@ -7,7 +7,7 @@ import { Discord, Telegram, Matrix, ServiceConfiguration, MatrixConfiguration } import { Validator, ValidatorConf, ValidatorRespDTO } from "./modules/validator.js"; import { PageManager } from "./modules/pages.js"; -interface userWindow extends Window { +interface userWindow extends GlobalWindow { jellyfinID: string; username: string; emailRequired: boolean; @@ -18,14 +18,13 @@ interface userWindow extends Window { discordInviteLink: boolean; matrixUserID: string; discordSendPINMessage: string; - pwrEnabled: string; referralsEnabled: boolean; } -const basePath = window.location.pathname.replace("/password/reset", ""); - declare var window: userWindow; +const basePath = window.location.pathname.replace("/password/reset", ""); + const theme = new ThemeManager(document.getElementById("button-theme")); window.lang = new lang(window.langFile as LangFile); @@ -38,7 +37,7 @@ window.token = ""; window.modals = {} as Modals; -let pages = new PageManager({ +const pages = new PageManager({ hideOthersOnPageShow: true, defaultName: "", defaultTitle: document.title, @@ -311,7 +310,7 @@ class ReferralCard { path = path.split(split)[0]; } if (path.slice(-1) != "/") { path += "/"; } - path = path + "invite/" + this._code; + path = path + window.pages.Form + "/" + this._code; u.pathname = path; u.hash = ""; @@ -661,7 +660,7 @@ document.addEventListener("details-reload", () => { expiryCard.expiry = details.expiry; const adminBackButton = document.getElementById("admin-back-button") as HTMLAnchorElement; - adminBackButton.href = window.location.href.replace("my/account", ""); + adminBackButton.href = window.location.href.replace(window.pages.MyAccount, window.pages.Admin); let messageCard = document.getElementById("card-message"); if (details.accounts_admin) { diff --git a/user-auth.go b/user-auth.go index 5af2320..c80e213 100644 --- a/user-auth.go +++ b/user-auth.go @@ -67,7 +67,8 @@ func (app *appContext) getUserTokenLogin(gc *gin.Context) { // host := gc.Request.URL.Hostname() host := app.ExternalDomain uri := "/my" - if strings.HasPrefix(gc.Request.RequestURI, app.URLBase) { + // FIXME: This seems like a bad idea? I think it's to deal with people having Reverse proxy subfolder/URL base set to /accounts. + if strings.HasPrefix(gc.Request.RequestURI, PAGES.Base) { uri = "/accounts/my" } gc.SetCookie("user-refresh", refresh, REFRESH_TOKEN_VALIDITY_SEC, uri, host, true, true) diff --git a/views.go b/views.go index 7542606..be574b4 100644 --- a/views.go +++ b/views.go @@ -32,7 +32,7 @@ func (app *appContext) loadCSSHeader() string { l := len(css) h := "" for i, f := range css { - h += "<" + app.URLBase + "/css/" + f + ">; rel=preload; as=style" + h += "<" + PAGES.Base + "/css/" + f + ">; rel=preload; as=style" if l > 1 && i != (l-1) { h += ", " } @@ -41,18 +41,19 @@ func (app *appContext) loadCSSHeader() string { } func (app *appContext) getURLBase(gc *gin.Context) string { - if strings.HasPrefix(gc.Request.URL.String(), app.URLBase) { + if strings.HasPrefix(gc.Request.URL.String(), PAGES.Base) { // Hack to fix the common URL base /accounts - if app.URLBase == "/accounts" && strings.HasPrefix(gc.Request.URL.String(), "/accounts/user/") { + if PAGES.Base == "/accounts" && strings.HasPrefix(gc.Request.URL.String(), "/accounts/user/") { return "" } - return app.URLBase + return PAGES.Base } return "" } -func gcHTML(gc *gin.Context, code int, file string, templ gin.H) { +func (app *appContext) gcHTML(gc *gin.Context, code int, file string, page Page, templ gin.H) { gc.Header("Cache-Control", "no-cache") + app.BasePageTemplateValues(gc, page, templ) gc.HTML(code, file, templ) } @@ -61,16 +62,14 @@ func (app *appContext) pushResources(gc *gin.Context, page Page) { switch page { case AdminPage: toPush = []string{"/js/admin.js", "/js/theme.js", "/js/lang.js", "/js/modal.js", "/js/tabs.js", "/js/invites.js", "/js/accounts.js", "/js/settings.js", "/js/profiles.js", "/js/common.js"} - break case UserPage: toPush = []string{"/js/user.js", "/js/theme.js", "/js/lang.js", "/js/modal.js", "/js/common.js"} - break default: toPush = []string{} } if pusher := gc.Writer.Pusher(); pusher != nil { for _, f := range toPush { - if err := pusher.Push(app.URLBase+f, nil); err != nil { + if err := pusher.Push(PAGES.Base+f, nil); err != nil { app.debug.Printf(lm.FailedServerPush, err) } } @@ -78,6 +77,48 @@ func (app *appContext) pushResources(gc *gin.Context, page Page) { gc.Header("Link", cssHeader) } +// Returns a gin.H with general values (url base, css version, etc.) +func (app *appContext) BasePageTemplateValues(gc *gin.Context, page Page, base gin.H) { + set := func(k string, v any) { + if _, ok := base[k]; !ok { + base[k] = v + } + } + + pages := PagePathsDTO{ + PagePaths: PAGES, + } + pages.Base = app.getURLBase(gc) + switch page { + case AdminPage: + pages.Current = PAGES.Admin + case FormPage: + pages.Current = PAGES.Form + case UserPage: + pages.Current = PAGES.MyAccount + default: + pages.Current = "/" + } + set("pages", pages) + ombiEnabled := app.config.Section("ombi").Key("enabled").MustBool(false) + jellyseerrEnabled := app.config.Section("jellyseerr").Key("enabled").MustBool(false) + notificationsEnabled, _ := app.config.Section("notifications").Key("enabled").Bool() + set("notifications", notificationsEnabled) + set("cssClass", app.cssClass) + set("cssVersion", cssVersion) + set("emailEnabled", emailEnabled) + set("telegramEnabled", telegramEnabled) + set("discordEnabled", discordEnabled) + set("matrixEnabled", matrixEnabled) + set("ombiEnabled", ombiEnabled) + set("jellyseerrEnabled", jellyseerrEnabled) + // QUIRK: The login modal html template uses this' existence to check if the modal is for the admin or user page. + if page != AdminPage { + set("pwrEnabled", app.config.Section("password_resets").Key("enabled").MustBool(false)) + } + set("referralsEnabled", app.config.Section("user_page").Key("enabled").MustBool(false) && app.config.Section("user_page").Key("referrals").MustBool(false)) +} + type Page int const ( @@ -132,10 +173,6 @@ func (app *appContext) getLang(gc *gin.Context, page Page, chosen string) string func (app *appContext) AdminPage(gc *gin.Context) { app.pushResources(gc, AdminPage) lang := app.getLang(gc, AdminPage, app.storage.lang.chosenAdminLang) - emailEnabled, _ := app.config.Section("invite_emails").Key("enabled").Bool() - notificationsEnabled, _ := app.config.Section("notifications").Key("enabled").Bool() - ombiEnabled := app.config.Section("ombi").Key("enabled").MustBool(false) - jellyseerrEnabled := app.config.Section("jellyseerr").Key("enabled").MustBool(false) jfAdminOnly := app.config.Section("ui").Key("admin_only").MustBool(true) jfAllowAll := app.config.Section("ui").Key("allow_all").MustBool(false) var license string @@ -157,62 +194,36 @@ func (app *appContext) AdminPage(gc *gin.Context) { builtBy = "???" } - gcHTML(gc, http.StatusOK, "admin.html", gin.H{ - "urlBase": app.getURLBase(gc), - "cssClass": app.cssClass, - "cssVersion": cssVersion, - "contactMessage": "", - "emailEnabled": emailEnabled, - "telegramEnabled": telegramEnabled, - "discordEnabled": discordEnabled, - "matrixEnabled": matrixEnabled, - "ombiEnabled": ombiEnabled, - "jellyseerrEnabled": jellyseerrEnabled, - "linkResetEnabled": app.config.Section("password_resets").Key("link_reset").MustBool(false), - "notifications": notificationsEnabled, - "version": version, - "commit": commit, - "buildTime": buildTime, - "builtBy": builtBy, - "buildTags": buildTags, - "username": !app.config.Section("email").Key("no_username").MustBool(false), - "strings": app.storage.lang.Admin[lang].Strings, - "quantityStrings": app.storage.lang.Admin[lang].QuantityStrings, - "language": app.storage.lang.Admin[lang].JSON, - "langName": lang, - "license": license, - "jellyfinLogin": app.jellyfinLogin, - "jfAdminOnly": jfAdminOnly, - "jfAllowAll": jfAllowAll, - "userPageEnabled": app.config.Section("user_page").Key("enabled").MustBool(false), - "showUserPageLink": app.config.Section("user_page").Key("show_link").MustBool(true), - "referralsEnabled": app.config.Section("user_page").Key("enabled").MustBool(false) && app.config.Section("user_page").Key("referrals").MustBool(false), - "loginAppearance": app.config.Section("ui").Key("login_appearance").MustString("clear"), + app.gcHTML(gc, http.StatusOK, "admin.html", AdminPage, gin.H{ + "contactMessage": "", + "linkResetEnabled": app.config.Section("password_resets").Key("link_reset").MustBool(false), + "version": version, + "commit": commit, + "buildTime": buildTime, + "builtBy": builtBy, + "buildTags": buildTags, + "username": !app.config.Section("email").Key("no_username").MustBool(false), + "strings": app.storage.lang.Admin[lang].Strings, + "quantityStrings": app.storage.lang.Admin[lang].QuantityStrings, + "language": app.storage.lang.Admin[lang].JSON, + "langName": lang, + "license": license, + "jellyfinLogin": app.jellyfinLogin, + "jfAdminOnly": jfAdminOnly, + "jfAllowAll": jfAllowAll, + "userPageEnabled": app.config.Section("user_page").Key("enabled").MustBool(false), + "showUserPageLink": app.config.Section("user_page").Key("show_link").MustBool(true), + "loginAppearance": app.config.Section("ui").Key("login_appearance").MustString("clear"), }) } func (app *appContext) MyUserPage(gc *gin.Context) { app.pushResources(gc, UserPage) lang := app.getLang(gc, UserPage, app.storage.lang.chosenUserLang) - emailEnabled, _ := app.config.Section("invite_emails").Key("enabled").Bool() - notificationsEnabled, _ := app.config.Section("notifications").Key("enabled").Bool() - ombiEnabled := app.config.Section("ombi").Key("enabled").MustBool(false) - jellyseerrEnabled := app.config.Section("jellyseerr").Key("enabled").MustBool(false) data := gin.H{ - "urlBase": app.getURLBase(gc), - "cssClass": app.cssClass, - "cssVersion": cssVersion, "contactMessage": app.config.Section("ui").Key("contact_message").String(), - "emailEnabled": emailEnabled, "emailRequired": app.config.Section("email").Key("required").MustBool(false), - "telegramEnabled": telegramEnabled, - "discordEnabled": discordEnabled, - "matrixEnabled": matrixEnabled, - "ombiEnabled": ombiEnabled, - "jellyseerrEnabled": jellyseerrEnabled, - "pwrEnabled": app.config.Section("password_resets").Key("enabled").MustBool(false), "linkResetEnabled": app.config.Section("password_resets").Key("link_reset").MustBool(false), - "notifications": notificationsEnabled, "username": !app.config.Section("email").Key("no_username").MustBool(false), "strings": app.storage.lang.User[lang].Strings, "validationStrings": app.storage.lang.User[lang].validationStringsJSON, @@ -220,7 +231,6 @@ func (app *appContext) MyUserPage(gc *gin.Context) { "langName": lang, "jfLink": app.config.Section("ui").Key("redirect_url").String(), "requirements": app.validator.getCriteria(), - "referralsEnabled": app.config.Section("user_page").Key("enabled").MustBool(false) && app.config.Section("user_page").Key("referrals").MustBool(false), } if telegramEnabled { data["telegramUsername"] = app.telegram.username @@ -264,7 +274,7 @@ func (app *appContext) MyUserPage(gc *gin.Context) { data[name+"MessageContent"] = template.HTML(markdown.ToHTML([]byte(msg.Content), nil, markdownRenderer)) } - gcHTML(gc, http.StatusOK, "user.html", data) + app.gcHTML(gc, http.StatusOK, "user.html", UserPage, data) } func (app *appContext) ResetPassword(gc *gin.Context) { @@ -278,14 +288,9 @@ func (app *appContext) ResetPassword(gc *gin.Context) { app.pushResources(gc, PWRPage) lang := app.getLang(gc, PWRPage, app.storage.lang.chosenPWRLang) data := gin.H{ - "urlBase": app.getURLBase(gc), - "cssClass": app.cssClass, - "cssVersion": cssVersion, "contactMessage": app.config.Section("ui").Key("contact_message").String(), "strings": app.storage.lang.PasswordReset[lang].Strings, "success": false, - "ombiEnabled": app.config.Section("ombi").Key("enabled").MustBool(false), - "jellyseerrEnabled": app.config.Section("jellyseerr").Key("enabled").MustBool(false), "customSuccessCard": false, } pwr, isInternal := app.internalPWRs[pin] @@ -299,6 +304,7 @@ func (app *appContext) ResetPassword(gc *gin.Context) { data["requirements"] = app.validator.getCriteria() data["strings"] = app.storage.lang.PasswordReset[lang].Strings data["validationStrings"] = app.storage.lang.User[lang].validationStringsJSON + // ewwwww, reusing an existing field, FIXME! data["notifications"] = app.storage.lang.User[lang].notificationsJSON data["langName"] = lang data["passwordReset"] = true @@ -309,10 +315,10 @@ func (app *appContext) ResetPassword(gc *gin.Context) { data["reCAPTCHA"] = app.config.Section("captcha").Key("recaptcha").MustBool(false) data["reCAPTCHASiteKey"] = app.config.Section("captcha").Key("recaptcha_site_key").MustString("") data["pwrPIN"] = pin - gcHTML(gc, http.StatusOK, "form-loader.html", data) + app.gcHTML(gc, http.StatusOK, "form-loader.html", PWRPage, data) return } - defer gcHTML(gc, http.StatusOK, "password-reset.html", data) + defer app.gcHTML(gc, http.StatusOK, "password-reset.html", PWRPage, data) // If it's a bot, pretend to be a success so the preview is nice. if isBot { app.debug.Println(lm.IgnoreBotPWR) @@ -413,10 +419,7 @@ func (app *appContext) GetCaptcha(gc *gin.Context) { if !isPWR { inv, ok = app.storage.GetInvitesKey(code) if !ok { - gcHTML(gc, 404, "invalidCode.html", gin.H{ - "urlBase": app.getURLBase(gc), - "cssClass": app.cssClass, - "cssVersion": cssVersion, + app.gcHTML(gc, 404, "invalidCode.html", OtherPage, gin.H{ "contactMessage": app.config.Section("ui").Key("contact_message").String(), }) } @@ -453,10 +456,7 @@ func (app *appContext) GenCaptcha(gc *gin.Context) { } if !ok { - gcHTML(gc, 404, "invalidCode.html", gin.H{ - "urlBase": app.getURLBase(gc), - "cssClass": app.cssClass, - "cssVersion": cssVersion, + app.gcHTML(gc, 404, "invalidCode.html", OtherPage, gin.H{ "contactMessage": app.config.Section("ui").Key("contact_message").String(), }) } @@ -587,10 +587,7 @@ func (app *appContext) VerifyCaptcha(gc *gin.Context) { if !isPWR { inv, ok = app.storage.GetInvitesKey(code) if !ok { - gcHTML(gc, 404, "invalidCode.html", gin.H{ - "urlBase": app.getURLBase(gc), - "cssClass": app.cssClass, - "cssVersion": cssVersion, + app.gcHTML(gc, 404, "invalidCode.html", OtherPage, gin.H{ "contactMessage": app.config.Section("ui").Key("contact_message").String(), }) return @@ -617,10 +614,7 @@ func (app *appContext) VerifyCaptcha(gc *gin.Context) { func (app *appContext) NewUserFromConfirmationKey(invite Invite, key string, lang string, gc *gin.Context) { fail := func() { - gcHTML(gc, 404, "404.html", gin.H{ - "urlBase": app.getURLBase(gc), - "cssClass": app.cssClass, - "cssVersion": cssVersion, + app.gcHTML(gc, 404, "404.html", OtherPage, gin.H{ "contactMessage": app.config.Section("ui").Key("contact_message").String(), }) } @@ -691,10 +685,7 @@ func (app *appContext) NewUserFromConfirmationKey(invite Invite, key string, lan if app.config.Section("ui").Key("auto_redirect").MustBool(false) { gc.Redirect(301, jfLink) } else { - gcHTML(gc, http.StatusOK, "create-success.html", gin.H{ - "urlBase": app.getURLBase(gc), - "cssClass": app.cssClass, - "cssVersion": cssVersion, + app.gcHTML(gc, http.StatusOK, "create-success.html", OtherPage, gin.H{ "strings": app.storage.lang.User[lang].Strings, "successMessage": app.config.Section("ui").Key("success_message").String(), "contactMessage": app.config.Section("ui").Key("contact_message").String(), @@ -725,10 +716,7 @@ func (app *appContext) InviteProxy(gc *gin.Context) { // if app.checkInvite(code, false, "") { invite, ok := app.storage.GetInvitesKey(gc.Param("invCode")) if !ok { - gcHTML(gc, 404, "invalidCode.html", gin.H{ - "urlBase": app.getURLBase(gc), - "cssClass": app.cssClass, - "cssVersion": cssVersion, + app.gcHTML(gc, 404, "invalidCode.html", FormPage, gin.H{ "contactMessage": app.config.Section("ui").Key("contact_message").String(), }) return @@ -747,7 +735,7 @@ func (app *appContext) InviteProxy(gc *gin.Context) { discord := discordEnabled && app.config.Section("discord").Key("show_on_reg").MustBool(true) matrix := matrixEnabled && app.config.Section("matrix").Key("show_on_reg").MustBool(true) - userPageAddress := fmt.Sprintf("%s/my/account", app.ExternalURI) + userPageAddress := app.ExternalURI + PAGES.MyAccount fromUser := "" if invite.ReferrerJellyfinID != "" { @@ -758,9 +746,6 @@ func (app *appContext) InviteProxy(gc *gin.Context) { } data := gin.H{ - "urlBase": app.getURLBase(gc), - "cssClass": app.cssClass, - "cssVersion": cssVersion, "contactMessage": app.config.Section("ui").Key("contact_message").String(), "helpMessage": app.config.Section("ui").Key("help_message").String(), "successMessage": app.config.Section("ui").Key("success_message").String(), @@ -772,28 +757,29 @@ func (app *appContext) InviteProxy(gc *gin.Context) { "username": !app.config.Section("email").Key("no_username").MustBool(false), "strings": app.storage.lang.User[lang].Strings, "validationStrings": app.storage.lang.User[lang].validationStringsJSON, - "notifications": app.storage.lang.User[lang].notificationsJSON, - "code": invite.Code, - "confirmation": app.config.Section("email_confirmation").Key("enabled").MustBool(false), - "userExpiry": invite.UserExpiry, - "userExpiryMonths": invite.UserMonths, - "userExpiryDays": invite.UserDays, - "userExpiryHours": invite.UserHours, - "userExpiryMinutes": invite.UserMinutes, - "userExpiryMessage": app.storage.lang.User[lang].Strings.get("yourAccountIsValidUntil"), - "langName": lang, - "passwordReset": false, - "customSuccessCard": false, - "telegramEnabled": telegram, - "discordEnabled": discord, - "matrixEnabled": matrix, - "emailRequired": app.config.Section("email").Key("required").MustBool(false), - "captcha": app.config.Section("captcha").Key("enabled").MustBool(false), - "reCAPTCHA": app.config.Section("captcha").Key("recaptcha").MustBool(false), - "reCAPTCHASiteKey": app.config.Section("captcha").Key("recaptcha_site_key").MustString(""), - "userPageEnabled": app.config.Section("user_page").Key("enabled").MustBool(false), - "userPageAddress": userPageAddress, - "fromUser": fromUser, + // ewwwww, reusing an existing field, FIXME! + "notifications": app.storage.lang.User[lang].notificationsJSON, + "code": invite.Code, + "confirmation": app.config.Section("email_confirmation").Key("enabled").MustBool(false), + "userExpiry": invite.UserExpiry, + "userExpiryMonths": invite.UserMonths, + "userExpiryDays": invite.UserDays, + "userExpiryHours": invite.UserHours, + "userExpiryMinutes": invite.UserMinutes, + "userExpiryMessage": app.storage.lang.User[lang].Strings.get("yourAccountIsValidUntil"), + "langName": lang, + "passwordReset": false, + "customSuccessCard": false, + "telegramEnabled": telegram, + "discordEnabled": discord, + "matrixEnabled": matrix, + "emailRequired": app.config.Section("email").Key("required").MustBool(false), + "captcha": app.config.Section("captcha").Key("enabled").MustBool(false), + "reCAPTCHA": app.config.Section("captcha").Key("recaptcha").MustBool(false), + "reCAPTCHASiteKey": app.config.Section("captcha").Key("recaptcha_site_key").MustString(""), + "userPageEnabled": app.config.Section("user_page").Key("enabled").MustBool(false), + "userPageAddress": userPageAddress, + "fromUser": fromUser, } if telegram { data["telegramPIN"] = app.telegram.NewAuthToken() @@ -837,15 +823,12 @@ func (app *appContext) InviteProxy(gc *gin.Context) { // pin := "" // for _, token := range app.discord.tokens { // if - gcHTML(gc, http.StatusOK, "form-loader.html", data) + app.gcHTML(gc, http.StatusOK, "form-loader.html", OtherPage, data) } func (app *appContext) NoRouteHandler(gc *gin.Context) { app.pushResources(gc, OtherPage) - gcHTML(gc, 404, "404.html", gin.H{ - "urlBase": app.getURLBase(gc), - "cssClass": app.cssClass, - "cssVersion": cssVersion, + app.gcHTML(gc, 404, "404.html", OtherPage, gin.H{ "contactMessage": app.config.Section("ui").Key("contact_message").String(), }) } From 302c4c189c63adf78218688c18080a32f65db13a Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Wed, 14 May 2025 19:42:50 +0100 Subject: [PATCH 009/249] build: check and re-copy modified config-base --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 6657649..1e4b2be 100644 --- a/Makefile +++ b/Makefile @@ -192,7 +192,7 @@ STATIC_TARGET = $(STATIC_SRC:static/%=$(DATA)/web/%) COPY_SRC = images/banner.svg jfa-go.service LICENSE $(LANG_SRC) $(STATIC_SRC) COPY_TARGET = $(DATA)/jfa-go.service # $(DATA)/LICENSE $(LANG_TARGET) $(STATIC_TARGET) $(DATA)/web/css/$(CSSVERSION)bundle.css -$(COPY_TARGET): $(INLINE_TARGET) $(STATIC_SRC) $(LANG_SRC) +$(COPY_TARGET): $(INLINE_TARGET) $(STATIC_SRC) $(LANG_SRC) $(CONFIG_BASE) $(info copying $(CONFIG_BASE)) cp $(CONFIG_BASE) $(DATA)/ $(info copying crash page) From 0967d471eee5fcd8b2aff37a8f82ecc51f6475d6 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Wed, 14 May 2025 20:08:21 +0100 Subject: [PATCH 010/249] urlpaths: seemingly full functionality various subpath combos seem to work, and trailing slashes from them are trimmed (including for the empty admin path "/", which is now "" by default). --- config.go | 33 ++++++++++++++++++++++----------- config/config-base.yaml | 24 ++++++++++++++++-------- logmessages/logmessages.go | 3 ++- ts/admin.ts | 1 - ts/user.ts | 2 +- 5 files changed, 41 insertions(+), 22 deletions(-) diff --git a/config.go b/config.go index 4cb2bb7..05acb5b 100644 --- a/config.go +++ b/config.go @@ -39,12 +39,19 @@ func (app *appContext) MustSetValue(section, key, val string) { } func (app *appContext) MustSetURLPath(section, key, val string) { - if !strings.HasPrefix(val, "/") { + if !strings.HasPrefix(val, "/") && val != "" { val = "/" + val } app.MustSetValue(section, key, val) } +func FormatSubpath(path string) string { + if path == "/" { + return "" + } + return strings.TrimSuffix(path, "/") +} + func (app *appContext) loadConfig() error { var err error app.config, err = ini.ShadowLoad(app.configPath) @@ -52,15 +59,23 @@ func (app *appContext) loadConfig() error { return err } - app.MustSetURLPath("url_paths", "admin", "/") + // URLs + app.MustSetURLPath("ui", "url_base", "") + app.MustSetURLPath("url_paths", "admin", "") app.MustSetURLPath("url_paths", "user_page", "/my/account") app.MustSetURLPath("url_paths", "form", "/invite") - PAGES.Admin = app.config.Section("url_paths").Key("admin").MustString("/") - PAGES.MyAccount = app.config.Section("url_paths").Key("user_page").MustString("/my/account") - PAGES.Form = app.config.Section("url_paths").Key("form").MustString("/invite") - + PAGES.Base = FormatSubpath(app.config.Section("ui").Key("url_base").String()) + PAGES.Admin = FormatSubpath(app.config.Section("url_paths").Key("admin").String()) + PAGES.MyAccount = FormatSubpath(app.config.Section("url_paths").Key("user_page").String()) + PAGES.Form = FormatSubpath(app.config.Section("url_paths").Key("form").String()) + if !(app.config.Section("user_page").Key("enabled").MustBool(true)) { + PAGES.MyAccount = "disabled" + } + if PAGES.Base == PAGES.Form || PAGES.Base == "/accounts" || PAGES.Base == "/settings" || PAGES.Base == "/activity" { + app.err.Printf(lm.BadURLBase, PAGES.Base) + } + app.info.Printf(lm.SubpathBlockMessage, PAGES.Base, PAGES.Admin, PAGES.MyAccount, PAGES.Form) app.MustSetValue("jellyfin", "public_server", app.config.Section("jellyfin").Key("server").String()) - app.MustSetValue("ui", "redirect_url", app.config.Section("jellyfin").Key("public_server").String()) for _, key := range app.config.Section("files").Keys() { @@ -75,10 +90,6 @@ func (app *appContext) loadConfig() error { app.config.Section("files").Key(key).SetValue(app.config.Section("files").Key(key).MustString(filepath.Join(app.dataPath, (key + ".db")))) } - PAGES.Base = strings.TrimSuffix(app.config.Section("ui").Key("url_base").MustString(""), "/") - if PAGES.Base == "/invite" || PAGES.Base == "/accounts" || PAGES.Base == "/settings" || PAGES.Base == "/activity" { - app.err.Printf(lm.BadURLBase, PAGES.Base) - } app.ExternalURI = strings.TrimSuffix(strings.TrimSuffix(app.config.Section("ui").Key("jfa_url").MustString(""), "/invite"), "/") if !strings.HasSuffix(app.ExternalURI, PAGES.Base) { app.err.Println(lm.NoURLSuffix) diff --git a/config/config-base.yaml b/config/config-base.yaml index 2a17342..1492f70 100644 --- a/config/config-base.yaml +++ b/config/config-base.yaml @@ -194,12 +194,10 @@ sections: value: Your account has been created. Click below to continue to Jellyfin. description: Displayed when a user creates an account. Use the "post-signup card" in the Message editor for more control. - - setting: url_base - name: Reverse Proxy subfolder - requires_restart: true - type: text - description: URL base for when running jfa-go with a reverse proxy in a subfolder. - include preceding /, e.g "/accounts". + - setting: subfolder_note + name: "Reverse proxy-ing to a subfolder?" + type: note + description: "Put the folder (e.g. /accounts) in \"Reverse Proxy subfolder\", and the full URL including it (e.g. https://jellyf.in/accounts) in \"External jfa-go URL\"." - setting: jfa_url name: External jfa-go URL required: true @@ -209,6 +207,12 @@ sections: description: The URL at which the jfa-go root (admin page) is accessible, including the subfolder if you use one. This is necessary because using a reverse proxy means the program has no way of knowing the URL itself. + - setting: url_base + name: Reverse Proxy subfolder + requires_restart: true + type: text + description: URL base for when running jfa-go with a reverse proxy in a subfolder. + include preceding /, e.g "/accounts". - setting: redirect_url name: Form success redirect URL type: text @@ -232,10 +236,14 @@ sections: - ["opaque", "Opaque"] value: clear description: Appearance of the Admin login screen. + - setting: urlpaths_note + name: "URL Paths:" + type: note + description: "Want \"My Account\" at \"/\" or the admin page at \"/admin\"? Enable advanced settings and check the \"URL Paths\" section." - section: url_paths meta: name: URL Paths - description: Settings for changing where different pages are accessed. + description: Settings for changing where different pages are accessed. If you change & forget these, they're printed in the logs on startup. Paths should have a slash at the beginning but not at the end. advanced: true settings: - setting: admin @@ -243,7 +251,7 @@ sections: type: text required: true requires_restart: true - value: "/" + value: "" description: URL subpath the admin page should be at. - setting: user_page name: "\"My Account\" subpath" diff --git a/logmessages/logmessages.go b/logmessages/logmessages.go index fbde1e1..9e8249b 100644 --- a/logmessages/logmessages.go +++ b/logmessages/logmessages.go @@ -212,9 +212,10 @@ const ( InitProxy = "Initialized proxy @ \"%s\"" FailedInitProxy = "Failed to initialize proxy @ \"%s\": %v\nStartup will pause for a bit to grab your attention." NoURLSuffix = `Warning: Given "jfa_url"/"External jfa-go URL" value does not include "url_base" value!` - BadURLBase = `Warning: Given URL Base "%s" may conflict with the applications subpaths.` + BadURLBase = `Warning: Given reverse proxy subfolder "%s" may conflict with the applications subpaths.` NoExternalHost = `No "External jfa-go URL" provided, set one in Settings > General.` LoginWontSave = ` Your login won't save until you do.` + SubpathBlockMessage = `URLs: Root subfolder = "%s", Admin = "%s", My Account = "%s", Invite forms = "%s"` // discord.go StartDaemon = "Started %s daemon" diff --git a/ts/admin.ts b/ts/admin.ts index 090a8e4..6ee213b 100644 --- a/ts/admin.ts +++ b/ts/admin.ts @@ -178,7 +178,6 @@ for (const tab of tabs) { } } // Default tab -// if ((window.URLBase + "/").includes(window.location.pathname)) { if (!matchedTab) { window.tabs.switch("", true); } diff --git a/ts/user.ts b/ts/user.ts index cceb19e..e087066 100644 --- a/ts/user.ts +++ b/ts/user.ts @@ -660,7 +660,7 @@ document.addEventListener("details-reload", () => { expiryCard.expiry = details.expiry; const adminBackButton = document.getElementById("admin-back-button") as HTMLAnchorElement; - adminBackButton.href = window.location.href.replace(window.pages.MyAccount, window.pages.Admin); + adminBackButton.href = window.pages.Base + window.pages.Admin; let messageCard = document.getElementById("card-message"); if (details.accounts_admin) { From f26042a21e673501ede83e7a16784626f027b2cc Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Wed, 14 May 2025 20:23:16 +0100 Subject: [PATCH 011/249] config: change base url-related text --- config/config-base.yaml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/config/config-base.yaml b/config/config-base.yaml index 1492f70..a4a2f9a 100644 --- a/config/config-base.yaml +++ b/config/config-base.yaml @@ -204,7 +204,7 @@ sections: depends_true: enabled type: text value: http://accounts.jellyf.in:8056 - description: The URL at which the jfa-go root (admin page) is accessible, including + description: The URL at which the jfa-go root (usually the admin page) is accessible, including the subfolder if you use one. This is necessary because using a reverse proxy means the program has no way of knowing the URL itself. - setting: url_base @@ -1123,8 +1123,7 @@ sections: type: note depends_true: link_reset required: false - description: Set the "External jfa-go URL" in General so that links to jfa-go - can be made. + description: Set the "External jfa-go URL" in General so that links to jfa-go can be made. - setting: language name: Default reset link language requires_restart: true From acba411c3aeab5ca7e40860799b9b49c2817c750 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Wed, 14 May 2025 21:11:44 +0100 Subject: [PATCH 012/249] build: fix constant re-build of css tailwind command taking part-bundle and turning it into v3bundle didn't do anything when no changes occurred, so v3bundle kept on being left untouched, and therefore with an old timestamp. part-bundle and v3bundle are both deleted before CSS is built, so the tailwind command always generates a new file. --- Makefile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 1e4b2be..6e5b2e8 100644 --- a/Makefile +++ b/Makefile @@ -170,6 +170,7 @@ $(CSS_FULLTARGET): $(TYPESCRIPT_TARGET) $(VARIANTS_TARGET) $(ALL_CSS_SRC) $(wild $(info copying fonts) cp -r node_modules/remixicon/fonts/remixicon.css node_modules/remixicon/fonts/remixicon.woff2 $(DATA)/web/css/ $(info bundling css) + rm -f $(CSS_TARGET) $(CSS_FULLTARGET) $(ESBUILD) --bundle css/base.css --outfile=$(CSS_TARGET) --external:remixicon.css --external:../fonts/hanken* --minify npx tailwindcss -i $(CSS_TARGET) -o $(CSS_FULLTARGET) $(TAILWIND) @@ -206,7 +207,7 @@ $(COPY_TARGET): $(INLINE_TARGET) $(STATIC_SRC) $(LANG_SRC) $(CONFIG_BASE) cp -r lang $(DATA)/ cp LICENSE $(DATA)/ -BUILDDEPS := $(DATA) $(CONFIG_DEFAULT) $(EMAIL_TARGET) $(COPY_TARGET) $(SWAGGER_TARGET) +BUILDDEPS := $(DATA) $(CONFIG_DEFAULT) $(EMAIL_TARGET) $(COPY_TARGET) $(SWAGGER_TARGET) $(INLINE_TARGET) $(CSS_FULLTARGET) $(TYPESCRIPT_TARGET) precompile: $(BUILDDEPS) COMPDEPS = From f1b56268bbd487b59d09da99641a091d3c8e91ad Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Wed, 14 May 2025 21:15:55 +0100 Subject: [PATCH 013/249] setup: fix url-based navigation popstate messages from the browser don't have an event.state, and i don't even know what the overridePopState stuff is trying to do. If event.state is null, try window.location.hash, or the last part of the URL path. --- ts/modules/pages.ts | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/ts/modules/pages.ts b/ts/modules/pages.ts index edf21f3..cc29c9a 100644 --- a/ts/modules/pages.ts +++ b/ts/modules/pages.ts @@ -32,7 +32,15 @@ export class PageManager { private _onpopstate = (event: PopStateEvent) => { let name = event.state; - if (!this.pages.has(event.state)) { + if (name == null) { + // Attempt to use hash from URL, if it isn't there, try the last part of the URL. + if (window.location.hash && window.location.hash.charAt(0) == "#") { + name = window.location.hash.substring(1); + } else { + name = window.location.pathname.split("/").filter(Boolean).at(-1); + } + } + if (!this.pages.has(name)) { name = this.pageList[0] } let success = this.pages.get(name).show(); @@ -73,7 +81,6 @@ export class PageManager { } loadPage (p: Page) { - console.log("loading page with", p.name || this.defaultName, p.title, p.url + window.location.search); window.history.pushState(p.name || this.defaultName, p.title, p.url + window.location.search); } From d2da9048d7cd3ce1a0ca5453ea19a754d19a67f2 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Wed, 14 May 2025 21:16:52 +0100 Subject: [PATCH 014/249] setup: add note about changed url just mentioned that you should check the URL before refreshing if you changed host/port/subfolder/etc. --- html/setup.html | 2 +- lang/setup/en-us.json | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/html/setup.html b/html/setup.html index ffed526..f4f8b02 100644 --- a/html/setup.html +++ b/html/setup.html @@ -557,7 +557,7 @@
{{ .lang.EndPage.finished }} -

{{ .lang.EndPage.restartMessage }}

+

{{ .lang.EndPage.restartMessage }} {{ .lang.EndPage.urlChangedNotice }}

{{ .lang.Strings.back }} diff --git a/lang/setup/en-us.json b/lang/setup/en-us.json index f6031c3..55c13e7 100644 --- a/lang/setup/en-us.json +++ b/lang/setup/en-us.json @@ -34,6 +34,7 @@ "endPage": { "finished": "Finished!", "restartMessage": "Features like Discord/Telegram/Matrix bots, custom Markdown messages, and a user-accessible \"My Account\" page can be found in Settings, so make sure to give it a browse. Click below to restart, then refresh the page.", + "urlChangedNotice": "If you've changed the host, port, subfolder etc. that jfa-go is hosted on, check the URL is right.", "refreshPage": "Refresh" }, "language": { From 632393b88d6eacce092b62098decf98b63c1c2aa Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Wed, 14 May 2025 21:35:08 +0100 Subject: [PATCH 015/249] setup: adjust card width use a container to kinda fix the max-width. Tried this on admin but it messed too much up to bother (the accounts table specifically doesn't like it). --- html/setup.html | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/html/setup.html b/html/setup.html index f4f8b02..404591a 100644 --- a/html/setup.html +++ b/html/setup.html @@ -6,14 +6,14 @@
-
+
{{ template "lang-select.html" . }}
-
+
jfa-go {{ .lang.StartPage.welcome }}

{{ .lang.StartPage.pressStart }}

@@ -22,7 +22,7 @@ {{ .lang.StartPage.start }}
-
+
{{ .lang.Language.title }}

@@ -53,7 +53,7 @@ {{ .lang.Strings.next }}
-
+
{{ .lang.General.title }}
@@ -153,7 +153,7 @@ {{ .lang.Strings.next }}
-
+
{{ .lang.Login.title }}

{{ .lang.Login.description }}

@@ -198,7 +198,7 @@ {{ .lang.Strings.next }}
-
+
{{ .lang.JellyfinEmby.title }}

{{ .lang.JellyfinEmby.description }}

@@ -249,7 +249,7 @@
-
+
{{ .lang.Ombi.title }}

{{ .lang.Ombi.description }}

@@ -291,7 +291,7 @@
-
+
{{ .lang.UserPage.title }}

{{ .lang.UserPage.description }}

@@ -308,7 +308,7 @@
-
+
{{ .lang.Messages.title }}

@@ -403,7 +403,7 @@
-
+
{{ .lang.Notifications.title }}

{{ .lang.Notifications.description }}

@@ -427,7 +427,7 @@
-
+
{{ .lang.InviteEmails.title }}

{{ .lang.InviteEmails.description }}

@@ -446,7 +446,7 @@
- -
+
{{ .lang.PasswordValidation.title }}

{{ .lang.PasswordValidation.description }}

@@ -521,7 +521,7 @@
-
+
{{ .lang.HelpMessages.title }}

{{ .lang.HelpMessages.description }}

@@ -554,10 +554,10 @@
-
+
{{ .lang.EndPage.finished }} -

{{ .lang.EndPage.restartMessage }} {{ .lang.EndPage.urlChangedNotice }}

+

{{ .lang.EndPage.restartMessage }} {{ .lang.EndPage.urlChangedNotice }}

{{ .lang.Strings.back }} From e38ac62ae4469778624775c5a81b3e591bb378da Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Wed, 14 May 2025 22:11:24 +0100 Subject: [PATCH 016/249] settings: fix search with disabled/deprecated sections/settings it was assumed all sections and settings would exist (either in this._sections or on the DOM with the "data-name" attribute). Now it checks they do and just ignores them if not. --- ts/modules/settings.ts | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/ts/modules/settings.ts b/ts/modules/settings.ts index a1a43f8..e927252 100644 --- a/ts/modules/settings.ts +++ b/ts/modules/settings.ts @@ -639,7 +639,7 @@ export class settingsList { } private _showPanel = (name: string) => { - console.log("showing", name); + // console.log("showing", name); for (let n in this._sections) { if (n == name) { this._sections[name].visible = true; @@ -944,8 +944,13 @@ export class settingsList { let firstVisibleSection = ""; for (let section of this._settings.sections) { - - let dependencyCard = this._sections[section.section].asElement().querySelector(".settings-dependency-message"); + // Section might be disabled at build-time (like Updates), or deprecated and so not appear. + if (!(section.section in this._sections)) { + // console.log(`Couldn't find section "${section.section}"`); + continue + } + const sectionElement = this._sections[section.section].asElement(); + let dependencyCard = sectionElement.querySelector(".settings-dependency-message"); if (dependencyCard) dependencyCard.remove(); dependencyCard = null; let dependencyList = null; @@ -964,10 +969,13 @@ export class settingsList { matchedSection = true; } } - const sectionElement = this._sections[section.section].asElement(); for (let setting of section.settings) { if (setting.type == "note") continue; const element = sectionElement.querySelector(`div[data-name="${setting.setting}"]`) as HTMLElement; + // Again, setting might be disabled at build-time (if we have such a mechanism) or deprecated (like the old duplicate 'url_base's) + if (element == null) { + continue; + } // If we match the whole section, don't bother searching settings. if (matchedSection) { From 44e8035ff00400c106369ea81530181447583b2c Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Wed, 14 May 2025 22:46:46 +0100 Subject: [PATCH 017/249] config: add http:// to all urls if needed, fix invite link generation changed invites.ts to generate links using window.Pages entirely, rather than chopping up window.location.href. --- config.go | 27 ++++++++++++++++++++------- ts/modules/activity.ts | 10 ---------- ts/modules/invites.ts | 7 +------ 3 files changed, 21 insertions(+), 23 deletions(-) diff --git a/config.go b/config.go index 05acb5b..53f846f 100644 --- a/config.go +++ b/config.go @@ -45,6 +45,13 @@ func (app *appContext) MustSetURLPath(section, key, val string) { app.MustSetValue(section, key, val) } +func FixFullURL(v string) string { + if !strings.HasPrefix(v, "http://") && !strings.HasPrefix(v, "https://") { + v = "http://" + v + } + return v +} + func FormatSubpath(path string) string { if path == "/" { return "" @@ -52,6 +59,15 @@ func FormatSubpath(path string) string { return strings.TrimSuffix(path, "/") } +func (app *appContext) MustCorrectURL(section, key, value string) { + v := app.config.Section(section).Key(key).String() + if v == "" { + v = value + } + v = FixFullURL(v) + app.config.Section(section).Key(key).SetValue(v) +} + func (app *appContext) loadConfig() error { var err error app.config, err = ini.ShadowLoad(app.configPath) @@ -75,8 +91,10 @@ func (app *appContext) loadConfig() error { app.err.Printf(lm.BadURLBase, PAGES.Base) } app.info.Printf(lm.SubpathBlockMessage, PAGES.Base, PAGES.Admin, PAGES.MyAccount, PAGES.Form) - app.MustSetValue("jellyfin", "public_server", app.config.Section("jellyfin").Key("server").String()) - app.MustSetValue("ui", "redirect_url", app.config.Section("jellyfin").Key("public_server").String()) + + app.MustCorrectURL("jellyfin", "server", "") + app.MustCorrectURL("jellyfin", "public_server", app.config.Section("jellyfin").Key("server").String()) + app.MustCorrectURL("ui", "redirect_url", app.config.Section("jellyfin").Key("public_server").String()) for _, key := range app.config.Section("files").Keys() { if name := key.Name(); name != "html_templates" && name != "lang_files" { @@ -133,11 +151,6 @@ func (app *appContext) loadConfig() error { sc := app.config.Section("discord").Key("start_command").MustString("start") app.config.Section("discord").Key("start_command").SetValue(strings.TrimPrefix(strings.TrimPrefix(sc, "/"), "!")) - jfUrl := app.config.Section("jellyfin").Key("server").String() - if !(strings.HasPrefix(jfUrl, "http://") || strings.HasPrefix(jfUrl, "https://")) { - app.config.Section("jellyfin").Key("server").SetValue("http://" + jfUrl) - } - // Deletion template is good enough for these as well. app.MustSetValue("disable_enable", "disabled_html", "jfa-go:"+"deleted.html") app.MustSetValue("disable_enable", "disabled_text", "jfa-go:"+"deleted.txt") diff --git a/ts/modules/activity.ts b/ts/modules/activity.ts index 1049390..135d50b 100644 --- a/ts/modules/activity.ts +++ b/ts/modules/activity.ts @@ -48,16 +48,6 @@ export class Activity implements activity, SearchableItem { private _delete: HTMLElement; private _ip: HTMLElement; private _act: activity; - /* private _urlBase: string = ((): string => { - let link = window.location.href; - for (let split of ["#", "?", "/activity"]) { - link = link.split(split)[0]; - } - if (link.slice(-1) != "/") { link += "/"; } - // FIXME: I should probably just be using window.pages.Base, but incase thats not right, i'll put this warning here - if (link != window.pages.Base) console.error(`URL Bases don't match: "${link}" != "${window.pages.Base}"`); - return link; - })(); */ _genUserText = (): string => { return `${this._act.username || this._act.user_id.substring(0, 5)}`; diff --git a/ts/modules/invites.ts b/ts/modules/invites.ts index 4c34a90..3982ab5 100644 --- a/ts/modules/invites.ts +++ b/ts/modules/invites.ts @@ -63,12 +63,7 @@ class DOMInvite implements Invite { get code(): string { return this._code; } set code(code: string) { this._code = code; - let codeLink = window.location.href; - for (let split of ["#", "?"]) { - codeLink = codeLink.split(split)[0]; - } - if (codeLink.slice(-1) != "/") { codeLink += "/"; } - this._codeLink = codeLink + window.pages.Form + "/" + code; + this._codeLink = window.pages.Base + window.pages.Form + "/" + code; const linkEl = this._codeArea.querySelector("a") as HTMLAnchorElement; if (this.label == "") { linkEl.textContent = code.replace(/-/g, '-'); From e7f4de220275b357c7c36217475adae68a2ab3d8 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Wed, 14 May 2025 22:55:31 +0100 Subject: [PATCH 018/249] router: fix webFS on form subpath --- router.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/router.go b/router.go index e88f49f..9ab3530 100644 --- a/router.go +++ b/router.go @@ -136,7 +136,7 @@ func (app *appContext) loadRoutes(router *gin.Engine) { router.GET(p+"/token/login", app.getTokenLogin) router.GET(p+"/token/refresh", app.getTokenRefresh) router.POST(p+"/user/invite", app.NewUserFromInvite) - router.Use(static.Serve(p+PAGES.Form, app.webFS)) + router.Use(static.Serve(p+PAGES.Form+"/", app.webFS)) router.GET(p+PAGES.Form+"/:invCode", app.InviteProxy) if app.config.Section("captcha").Key("enabled").MustBool(false) { router.GET(p+"/captcha/gen/:invCode", app.GenCaptcha) From 471021623b0380a1e50119700481ae5df7a6583d Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Wed, 14 May 2025 22:55:34 +0100 Subject: [PATCH 019/249] userpage: fix invite code gen as the admin page, use window.pages to generate link entirely. --- ts/user.ts | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/ts/user.ts b/ts/user.ts index e087066..07bee29 100644 --- a/ts/user.ts +++ b/ts/user.ts @@ -303,14 +303,10 @@ class ReferralCard { get code(): string { return this._code; } set code(c: string) { this._code = c; - + + let u = new URL(window.location.href); - let path = u.pathname; - for (let split of ["account", "my"]) { - path = path.split(split)[0]; - } - if (path.slice(-1) != "/") { path += "/"; } - path = path + window.pages.Form + "/" + this._code; + const path = window.pages.Base + window.pages.Form + "/" + this._code; u.pathname = path; u.hash = ""; From eab33d9f6d95d2c3c9f3da93e53aa829bf09473d Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Wed, 14 May 2025 22:58:37 +0100 Subject: [PATCH 020/249] captcha: fix for custom invite form subpath --- ts/modules/captcha.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/ts/modules/captcha.ts b/ts/modules/captcha.ts index 68fedc1..8c41884 100644 --- a/ts/modules/captcha.ts +++ b/ts/modules/captcha.ts @@ -1,5 +1,7 @@ import { _get, _post } from "./common.js"; +declare var window: GlobalWindow; + export class Captcha { isPWR = false; enabled = true; @@ -51,7 +53,7 @@ export class Captcha { this.captchaID = this.isPWR ? this.code : req.response["id"]; // the Math.random() appearance below is used for PWRs, since they don't have a unique captchaID. The parameter is ignored by the server, but tells the browser to reload the image. document.getElementById("captcha-img").innerHTML = ` - + `; this.input.value = ""; } From 16c5420c6f9308de4780b63bb6a1ba3c590fbd7e Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Thu, 15 May 2025 15:08:32 +0100 Subject: [PATCH 021/249] setup: show internal and external links on finish internal generated from host, port and url_base, external is just jfa_url. Both are shown (if jfa_url is set). --- html/setup.html | 5 +++-- lang/common/en-us.json | 4 +++- lang/setup/en-us.json | 5 +++-- ts/setup.ts | 43 ++++++++++++++++++++++++++++++++++++------ 4 files changed, 46 insertions(+), 11 deletions(-) diff --git a/html/setup.html b/html/setup.html index 404591a..31bd42b 100644 --- a/html/setup.html +++ b/html/setup.html @@ -557,12 +557,13 @@
{{ .lang.EndPage.finished }} -

{{ .lang.EndPage.restartMessage }} {{ .lang.EndPage.urlChangedNotice }}

+

{{ .lang.EndPage.moreFeatures }} {{ .lang.EndPage.restartReload }} {{ .lang.EndPage.ifFailedLoad }}

{{ .lang.Strings.back }} {{ .lang.Strings.submit }} - {{ .lang.EndPage.refreshPage }} + +
diff --git a/lang/common/en-us.json b/lang/common/en-us.json index 34955a7..19f285d 100644 --- a/lang/common/en-us.json +++ b/lang/common/en-us.json @@ -41,7 +41,9 @@ "delete": "Delete", "myAccount": "My Account", "referrals": "Referrals", - "inviteRemainingUses": "Remaining uses" + "inviteRemainingUses": "Remaining uses", + "internal": "Internal", + "external": "External" }, "notifications": { "errorLoginBlank": "The username and/or password were left blank.", diff --git a/lang/setup/en-us.json b/lang/setup/en-us.json index 55c13e7..b2ba28e 100644 --- a/lang/setup/en-us.json +++ b/lang/setup/en-us.json @@ -33,8 +33,9 @@ }, "endPage": { "finished": "Finished!", - "restartMessage": "Features like Discord/Telegram/Matrix bots, custom Markdown messages, and a user-accessible \"My Account\" page can be found in Settings, so make sure to give it a browse. Click below to restart, then refresh the page.", - "urlChangedNotice": "If you've changed the host, port, subfolder etc. that jfa-go is hosted on, check the URL is right.", + "moreFeatures": "Tons more features like Discord/Telegram/Matrix bots and custom Markdown messages can be found in Settings, so make sure to give it a browse.", + "restartReload": "Click below to restart, then access jfa-go at one of the given internal/external URLs.", + "ifFailedLoad": "If it doesn't load, check the application's logs for any clues as to why.", "refreshPage": "Refresh" }, "language": { diff --git a/ts/setup.ts b/ts/setup.ts index d987060..61470b1 100644 --- a/ts/setup.ts +++ b/ts/setup.ts @@ -365,6 +365,33 @@ const checkTheme = () => { settings["ui"]["theme"].onchange = checkTheme; checkTheme(); +const fixFullURL = (v: string): string => { + if (!(v.startsWith("http://")) && !(v.startsWith("https://"))) { + v = "http://" + v; + } + return v; +}; + +const formatSubpath = (v: string): string => { + if (v == "/") return ""; + if (v.charAt(-1) == "/") { v = v.slice(0, -1); } + return v; +} + +const constructNewURLs = (): string[] => { + let local = settings["ui"]["host"].value + ":" + settings["ui"]["port"].value; + if (settings["ui"]["url_base"].value != "") { + local += formatSubpath(settings["ui"]["url_base"].value); + } + local = fixFullURL(local); + let remote = settings["ui"]["jfa_url"].value; + if (remote == "") { + return [local]; + } + remote = fixFullURL(remote); + return [local, remote]; +} + const restartButton = document.getElementById("restart") as HTMLSpanElement; const serialize = () => { toggleLoader(restartButton); @@ -409,12 +436,16 @@ const serialize = () => { } restartButton.parentElement.querySelector("span.back").classList.add("unfocused"); restartButton.classList.add("unfocused"); - const refresh = document.getElementById("refresh") as HTMLSpanElement; - refresh.classList.remove("unfocused"); - refresh.onclick = () => { - let host = window.location.href.split("#")[0].split("?")[0] + settings["ui"]["url_base"].value; - window.location.href = host; - }; + const refreshURLs = constructNewURLs(); + const refreshButtons = [document.getElementById("refresh-internal") as HTMLAnchorElement, document.getElementById("refresh-external") as HTMLAnchorElement]; + ["internal", "external"].forEach((urltype, i) => { + const button = refreshButtons[i]; + button.classList.remove("unfocused"); + button.href = refreshURLs[i]; + button.innerHTML = `${urltype.charAt(0).toUpperCase() + urltype.slice(1)}:${button.href}`; + // skip external if it isn't set + if (refreshURLs.length == 1) return; + }); } }, true, (req: XMLHttpRequest) => { if (req.status == 0) { From 4cc5fd7189c8724bddc52b424dd38799058bf67f Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Thu, 15 May 2025 15:38:35 +0100 Subject: [PATCH 022/249] mediabrowser: bump for parental rating setting fixes #382. --- go.mod | 2 +- go.sum | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/go.mod b/go.mod index 6cd8c7a..6b17a34 100644 --- a/go.mod +++ b/go.mod @@ -43,7 +43,7 @@ require ( github.com/hrfee/jfa-go/logger v0.0.0-20241105225412-da4470bc4fbc github.com/hrfee/jfa-go/logmessages v0.0.0-20241105225412-da4470bc4fbc github.com/hrfee/jfa-go/ombi v0.0.0-20241105225412-da4470bc4fbc - github.com/hrfee/mediabrowser v0.3.24 + github.com/hrfee/mediabrowser v0.3.25 github.com/itchyny/timefmt-go v0.1.6 github.com/lithammer/shortuuid/v3 v3.0.7 github.com/mailgun/mailgun-go/v4 v4.18.1 diff --git a/go.sum b/go.sum index c263bc6..68f46b1 100644 --- a/go.sum +++ b/go.sum @@ -207,6 +207,8 @@ github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/ad github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ= github.com/hrfee/mediabrowser v0.3.24 h1:cT5+X3bZeaSBQFevMYkFIw6JJ8nW7Myvb+11a2/THMA= github.com/hrfee/mediabrowser v0.3.24/go.mod h1:PnHZbdxmbv1wCVdAQyM7nwPwpVj9fdKx2EcET7sAk+U= +github.com/hrfee/mediabrowser v0.3.25 h1:UxpSSTmr5q12gKfeOR2ommvA/xhrP2rxVWmpWjDPRUY= +github.com/hrfee/mediabrowser v0.3.25/go.mod h1:PnHZbdxmbv1wCVdAQyM7nwPwpVj9fdKx2EcET7sAk+U= github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8= github.com/itchyny/timefmt-go v0.1.6 h1:ia3s54iciXDdzWzwaVKXZPbiXzxxnv1SPGFfM/myJ5Q= github.com/itchyny/timefmt-go v0.1.6/go.mod h1:RRDZYC5s9ErkjQvTvvU7keJjxUYzIISJGxm9/mAERQg= From 01a75c3e235dc7e5ed87733e82bc85b4f133e1fe Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Thu, 15 May 2025 16:14:15 +0100 Subject: [PATCH 023/249] settings: add jellyseerr wiki link, clarify API key src An API key is shown in Jellyseerr's setup which is actually for Jellyfin. I (and I imagine other users have) copied it expecting it was for Jellyseerr and was surprised the app didn't work. It's now clarified in the API Key setting description to get it from the first tab in Jellyseerr, and not the "Jellyfin" tab. --- config/config-base.yaml | 3 ++- go.sum | 2 -- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/config/config-base.yaml b/config/config-base.yaml index a4a2f9a..16a021f 100644 --- a/config/config-base.yaml +++ b/config/config-base.yaml @@ -1292,6 +1292,7 @@ sections: on account creation, and to automatically link contact methods (email, discord and telegram). A template must be added to a User Profile for accounts to be created. + wiki_link: https://wiki.jfa-go.com/docs/external-services/jellyseerr/ settings: - setting: enabled name: Enabled @@ -1318,7 +1319,7 @@ sections: requires_restart: true type: text depends_true: enabled - description: API Key. Get this from the first tab in Jellyseerr's settings. + description: API Key. Get this from the first tab in Jellyseerr's settings (NOT the "Jellyfin" tab!) - setting: import_existing name: Import existing users to Jellyseerr requires_restart: true diff --git a/go.sum b/go.sum index 68f46b1..c9c85b6 100644 --- a/go.sum +++ b/go.sum @@ -205,8 +205,6 @@ github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/ad github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg= github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ= -github.com/hrfee/mediabrowser v0.3.24 h1:cT5+X3bZeaSBQFevMYkFIw6JJ8nW7Myvb+11a2/THMA= -github.com/hrfee/mediabrowser v0.3.24/go.mod h1:PnHZbdxmbv1wCVdAQyM7nwPwpVj9fdKx2EcET7sAk+U= github.com/hrfee/mediabrowser v0.3.25 h1:UxpSSTmr5q12gKfeOR2ommvA/xhrP2rxVWmpWjDPRUY= github.com/hrfee/mediabrowser v0.3.25/go.mod h1:PnHZbdxmbv1wCVdAQyM7nwPwpVj9fdKx2EcET7sAk+U= github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8= From 07d02f830245e652a29a369fb59dc5b63320851c Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Thu, 15 May 2025 17:49:06 +0100 Subject: [PATCH 024/249] discord: fix admin-check for /inv it was being checked in the EmailAddress record, only set if Jellyfin login is disabled, or "access jfa-go" is checked for a non-Jellyfin-admin user in Accounts. Instead, i've factored out the actual auth code into a "canAccessAdminPage"-ish function, which is called for this too. Should fix #378. --- auth.go | 43 +++++++++++++++++++++++++++++----------- discord.go | 13 ++++++++---- lang/telegram/en-us.json | 3 ++- 3 files changed, 42 insertions(+), 17 deletions(-) diff --git a/auth.go b/auth.go index 541c97a..1296630 100644 --- a/auth.go +++ b/auth.go @@ -165,6 +165,31 @@ func (app *appContext) decodeValidateLoginHeader(gc *gin.Context, userpage bool) return } +func (app *appContext) canAccessAdminPage(user mediabrowser.User, emailStore EmailAddress) bool { + // 1. "Allow all" is enabled, so simply being a user implies access. + if app.config.Section("ui").Key("allow_all").MustBool(false) && user.ID != "" { + return true + } + // 2. You've been made an "accounts admin" from the accounts tab. + if emailStore.Admin { + return true + } + // 3. (Jellyfin) "Admins only" is enabled, and you're one. + if app.config.Section("ui").Key("admin_only").MustBool(true) && user.ID != "" && user.Policy.IsAdministrator { + return true + } + return false +} + +func (app *appContext) canAccessAdminPageByID(jfID string) bool { + user, err := app.jf.UserByID(jfID, false) + if err != nil { + return false + } + emailStore, _ := app.storage.GetEmailsKey(jfID) + return app.canAccessAdminPage(user, emailStore) +} + func (app *appContext) validateJellyfinCredentials(username, password string, gc *gin.Context, userpage bool) (user mediabrowser.User, ok bool) { ok = false user, err := app.authJf.Authenticate(username, password) @@ -220,18 +245,12 @@ func (app *appContext) getTokenLogin(gc *gin.Context) { return } jfID = user.ID - if !app.config.Section("ui").Key("allow_all").MustBool(false) { - accountsAdmin := false - adminOnly := app.config.Section("ui").Key("admin_only").MustBool(true) - if emailStore, ok := app.storage.GetEmailsKey(jfID); ok { - accountsAdmin = emailStore.Admin - } - accountsAdmin = accountsAdmin || (adminOnly && user.Policy.IsAdministrator) - if !accountsAdmin { - app.authLog(fmt.Sprintf(lm.NonAdminUser, username)) - respond(401, "Unauthorized", gc) - return - } + emailStore, _ := app.storage.GetEmailsKey(jfID) + accountsAdmin := app.canAccessAdminPage(user, emailStore) + if !accountsAdmin { + app.authLog(fmt.Sprintf(lm.NonAdminUser, username)) + respond(401, "Unauthorized", gc) + return } // New users are only added when using jellyfinLogin. userID = shortuuid.New() diff --git a/discord.go b/discord.go index 96fa4bc..df34929 100644 --- a/discord.go +++ b/discord.go @@ -612,11 +612,16 @@ func (d *DiscordDaemon) cmdInvite(s *dg.Session, i *dg.InteractionCreate, lang s //if mins > 0 { // expmin = mins //} - // Check whether requestor is linked to the admin account - requesterEmail, ok := d.app.storage.GetEmailsKey(requester.JellyfinID) - if !(ok && requesterEmail.Admin) { + // We want the same criteria for running this command as accessing the admin page (i.e. an "admin" of some sort) + if !(d.app.canAccessAdminPageByID(requester.JellyfinID)) { d.app.err.Printf(lm.FailedGenerateInvite, fmt.Sprintf(lm.NonAdminUser, requester.JellyfinID)) - // FIXME: add response message + s.InteractionRespond(i.Interaction, &dg.InteractionResponse{ + Type: dg.InteractionResponseChannelMessageWithSource, + Data: &dg.InteractionResponseData{ + Content: d.app.storage.lang.Telegram[lang].Strings.get("noPermission"), + Flags: 64, // Ephemeral + }, + }) return } diff --git a/lang/telegram/en-us.json b/lang/telegram/en-us.json index 4cb03a7..cd3c3ca 100644 --- a/lang/telegram/en-us.json +++ b/lang/telegram/en-us.json @@ -13,6 +13,7 @@ "languageSet": "Language set to {language}.", "discordDMs": "Please check your DMs for a response.", "sentInvite": "Sent invite.", - "sentInviteFailure": "Failed to send invite, check logs." + "sentInviteFailure": "Failed to send invite, check logs.", + "noPermission": "You do not have permissions for this action." } } From 28440a90960f2d7ce7f69cc83d26e33795bfc484 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Thu, 15 May 2025 19:19:51 +0100 Subject: [PATCH 025/249] accounts: add "record count", start searchable user cache RecordCounter class created from that in activityList, and put in accountsList. PageCount-type route standardized and made for /users (/users/count). Created userCache, which regularly generates the respUser list returned by /users. Added a currently dumb POST /users for searching/pagination, GET /users is now just for getting -all- users. go-getted expr, an expression language that seems like it'll be useful for evaluating local searches. We don't store this data in the badger DB, so we can't use the nice query form provided by badgerhold. --- api-activities.go | 6 +-- api-users.go | 62 +++++++++++++++++---- go.mod | 1 + go.sum | 2 + html/admin.html | 7 +-- main.go | 1 + models.go | 14 ++++- router.go | 2 + scripts/account-gen/main.go | 12 +++-- ts/modules/accounts.ts | 30 ++++++++--- ts/modules/activity.ts | 104 +++++++++++++++++++++++------------- ts/typings/d.ts | 4 ++ usercache.go | 35 ++++++++++++ 13 files changed, 213 insertions(+), 67 deletions(-) create mode 100644 usercache.go diff --git a/api-activities.go b/api-activities.go index f4b2581..5ff3b76 100644 --- a/api-activities.go +++ b/api-activities.go @@ -126,8 +126,8 @@ func (app *appContext) GetActivities(gc *gin.Context) { resp := GetActivitiesRespDTO{ Activities: make([]ActivityDTO, len(results)), - LastPage: len(results) != req.Limit, } + resp.LastPage = len(results) != req.Limit for i, act := range results { resp.Activities[i] = ActivityDTO{ @@ -173,12 +173,12 @@ func (app *appContext) DeleteActivity(gc *gin.Context) { // @Summary Returns the total number of activities stored in the database. // @Produce json -// @Success 200 {object} GetActivityCountDTO +// @Success 200 {object} PageCountDTO // @Router /activity/count [get] // @Security Bearer // @tags Activity func (app *appContext) GetActivityCount(gc *gin.Context) { - resp := GetActivityCountDTO{} + resp := PageCountDTO{} var err error resp.Count, err = app.storage.db.Count(&Activity{}, &badgerhold.Query{}) if err != nil { diff --git a/api-users.go b/api-users.go index 849bdfe..60934b1 100644 --- a/api-users.go +++ b/api-users.go @@ -337,8 +337,8 @@ func (app *appContext) PostNewUserFromInvite(nu NewUserData, req ConfirmationKey // FIXME: figure these out in a nicer way? this relies on the current ordering, // which may not be fixed. if discordEnabled { - if req.completeContactMethods[0].User != nil { - discordUser = req.completeContactMethods[0].User.(*DiscordUser) + if req.completeContactMethods[0].User != nil { + discordUser = req.completeContactMethods[0].User.(*DiscordUser) } if telegramEnabled && req.completeContactMethods[1].User != nil { telegramUser = req.completeContactMethods[1].User.(*TelegramUser) @@ -894,7 +894,25 @@ func (app *appContext) userSummary(jfUser mediabrowser.User) respUser { } -// @Summary Get a list of Jellyfin users. +// @Summary Returns the total number of Jellyfin users. +// @Produce json +// @Success 200 {object} PageCountDTO +// @Router /users/count [get] +// @Security Bearer +// @tags Activity +func (app *appContext) GetUserCount(gc *gin.Context) { + resp := PageCountDTO{} + err := app.userCache.Gen(app) + if err != nil { + app.err.Printf(lm.FailedGetUsers, lm.Jellyfin, err) + respond(500, "Couldn't get users", gc) + return + } + resp.Count = uint64(len(app.userCache.Cache)) + gc.JSON(200, resp) +} + +// @Summary Get a list of -all- Jellyfin users. // @Produce json // @Success 200 {object} getUsersDTO // @Failure 500 {object} stringResponse @@ -903,19 +921,43 @@ func (app *appContext) userSummary(jfUser mediabrowser.User) respUser { // @tags Users func (app *appContext) GetUsers(gc *gin.Context) { var resp getUsersDTO - users, err := app.jf.GetUsers(false) - resp.UserList = make([]respUser, len(users)) + // We're sending all users, so this is always true + resp.LastPage = true + err := app.userCache.Gen(app) if err != nil { app.err.Printf(lm.FailedGetUsers, lm.Jellyfin, err) respond(500, "Couldn't get users", gc) return } - i := 0 - for _, jfUser := range users { - user := app.userSummary(jfUser) - resp.UserList[i] = user - i++ + resp.UserList = app.userCache.Cache + gc.JSON(200, resp) +} + +// @Summary Get a paginated, searchable list of Jellyfin users. +// @Produce json +// @Param getUsersReqDTO body getUsersReqDTO true "search / pagination parameters" +// @Success 200 {object} getUsersDTO +// @Failure 500 {object} stringResponse +// @Router /users [post] +// @Security Bearer +// @tags Users +func (app *appContext) SearchUsers(gc *gin.Context) { + req := getUsersReqDTO{} + gc.BindJSON(&req) + + // FIXME: Figure out how to search, sort and paginate []mediabrowser.User! + // Expr! + + var resp getUsersDTO + // We're sending all users, so this is always true + resp.LastPage = true + err := app.userCache.Gen(app) + if err != nil { + app.err.Printf(lm.FailedGetUsers, lm.Jellyfin, err) + respond(500, "Couldn't get users", gc) + return } + resp.UserList = app.userCache.Cache gc.JSON(200, resp) } diff --git a/go.mod b/go.mod index 6b17a34..eb0fcb0 100644 --- a/go.mod +++ b/go.mod @@ -70,6 +70,7 @@ require ( github.com/cloudwego/iasm v0.2.0 // indirect github.com/dgraph-io/ristretto v1.0.0 // indirect github.com/dustin/go-humanize v1.0.1 // indirect + github.com/expr-lang/expr v1.17.3 // indirect github.com/gabriel-vasile/mimetype v1.4.6 // indirect github.com/getlantern/context v0.0.0-20220418194847-3d5e7a086201 // indirect github.com/getlantern/errors v1.0.4 // indirect diff --git a/go.sum b/go.sum index c9c85b6..a12698d 100644 --- a/go.sum +++ b/go.sum @@ -58,6 +58,8 @@ github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymF github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98= github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c= +github.com/expr-lang/expr v1.17.3 h1:myeTTuDFz7k6eFe/JPlep/UsiIjVhG61FMHFu63U7j0= +github.com/expr-lang/expr v1.17.3/go.mod h1:8/vRC7+7HBzESEqt5kKpYXxrxkr31SaO8r40VO/1IT4= github.com/fatih/color v1.10.0/go.mod h1:ELkj/draVOlAH/xkhN6mQ50Qd0MPOk5AAr3maGEBuJM= github.com/fatih/color v1.18.0 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM= github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU= diff --git a/html/admin.html b/html/admin.html index 25630bd..72953a0 100644 --- a/html/admin.html +++ b/html/admin.html @@ -738,6 +738,7 @@
+
{{ .strings.actions }}
{{ .quantityStrings.addUser.Singular }} @@ -838,11 +839,7 @@
-
- - - -
+
diff --git a/main.go b/main.go index 7d1de5a..cb6d2c4 100644 --- a/main.go +++ b/main.go @@ -134,6 +134,7 @@ type appContext struct { pwrCaptchas map[string]Captcha ConfirmationKeys map[string]map[string]ConfirmationKey // Map of invite code to jwt to request confirmationKeysLock sync.Mutex + userCache UserCache } func generateSecret(length int) (string, error) { diff --git a/models.go b/models.go index 686effd..360a2e2 100644 --- a/models.go +++ b/models.go @@ -164,8 +164,18 @@ type respUser struct { ReferralsEnabled bool `json:"referrals_enabled"` } +type PaginatedDTO struct { + LastPage bool `json:"last_page"` +} + +type getUsersReqDTO struct { + Limit int `json:"limit"` + Page int `json:"page"` // zero-indexed +} + type getUsersDTO struct { UserList []respUser `json:"users"` + LastPage bool `json:"last_page"` } type ombiUser struct { @@ -437,11 +447,11 @@ type GetActivitiesDTO struct { } type GetActivitiesRespDTO struct { + PaginatedDTO Activities []ActivityDTO `json:"activities"` - LastPage bool `json:"last_page"` } -type GetActivityCountDTO struct { +type PageCountDTO struct { Count uint64 `json:"count"` } diff --git a/router.go b/router.go index 9ab3530..4fa3952 100644 --- a/router.go +++ b/router.go @@ -183,6 +183,8 @@ func (app *appContext) loadRoutes(router *gin.Engine) { router.POST(p+"/logout", app.Logout) api.DELETE(p+"/users", app.DeleteUsers) api.GET(p+"/users", app.GetUsers) + api.GET(p+"/users/count", app.GetUserCount) + api.POST(p+"/users", app.SearchUsers) api.POST(p+"/user", app.NewUserFromAdmin) api.POST(p+"/users/extend", app.ExtendExpiry) api.DELETE(p+"/users/:id/expiry", app.RemoveExpiry) diff --git a/scripts/account-gen/main.go b/scripts/account-gen/main.go index bc1c528..47faa6f 100644 --- a/scripts/account-gen/main.go +++ b/scripts/account-gen/main.go @@ -15,11 +15,11 @@ import ( var ( names = []string{"Aaron", "Agnes", "Bridget", "Brandon", "Dolly", "Drake", "Elizabeth", "Erika", "Geoff", "Graham", "Haley", "Halsey", "Josie", "John", "Kayleigh", "Luka", "Melissa", "Nasreen", "Paul", "Ross", "Sam", "Talib", "Veronika", "Zaynab"} + COUNT = 3000 ) const ( PASSWORD = "test" - COUNT = 10 ) func main() { @@ -57,6 +57,12 @@ func main() { password = strings.TrimSuffix(password, "\n") } + if countEnv := os.Getenv("COUNT"); countEnv != "" { + COUNT, _ = strconv.Atoi(countEnv) + } + + fmt.Printf("Will generate %d users\n", COUNT) + jf, err := mediabrowser.NewServer( mediabrowser.JellyfinServer, server, @@ -99,7 +105,7 @@ func main() { user, status, err := jf.NewUser(name, PASSWORD) if (status != 200 && status != 201 && status != 204) || err != nil { - log.Fatalf("Failed to create user \"%s\" (%d): %+v\n", name, status, err) + log.Fatalf("Acc no %d: Failed to create user \"%s\" (%d): %+v\n", i, name, status, err) } if rand.Intn(100) > 65 { @@ -112,7 +118,7 @@ func main() { status, err = jf.SetPolicy(user.ID, user.Policy) if (status != 200 && status != 201 && status != 204) || err != nil { - log.Fatalf("Failed to set policy for user \"%s\" (%d): %+v\n", name, status, err) + log.Fatalf("Acc no %d: Failed to set policy for user \"%s\" (%d): %+v\n", i, name, status, err) } if rand.Intn(100) > 20 { diff --git a/ts/modules/accounts.ts b/ts/modules/accounts.ts index c338bfc..2bc902d 100644 --- a/ts/modules/accounts.ts +++ b/ts/modules/accounts.ts @@ -5,6 +5,7 @@ import { stripMarkdown } from "../modules/stripmd.js"; import { DiscordUser, newDiscordSearch } from "../modules/discord.js"; import { Search, SearchConfiguration, QueryType, SearchableItem } from "../modules/search.js"; import { HiddenInputField } from "./ui.js"; +import { RecordCounter } from "./activity.js"; declare var window: GlobalWindow; @@ -702,7 +703,11 @@ class user implements User, SearchableItem { } this._row.remove(); } -} +} + +interface UsersDTO extends paginatedDTO { + users: User[]; +} export class accountsList { private _table = document.getElementById("accounts-list") as HTMLTableSectionElement; @@ -771,6 +776,8 @@ export class accountsList { private _filterArea = document.getElementById("accounts-filter-area"); private _searchOptionsHeader = document.getElementById("accounts-search-options-header"); + private _counter: RecordCounter; + // Whether the "Extend expiry" is extending or setting an expiry. private _settingExpiry = false; @@ -1779,6 +1786,9 @@ export class accountsList { constructor() { this._populateNumbers(); + + this._counter = new RecordCounter(document.getElementById("accounts-record-counter")); + this._users = {}; this._selectAll.checked = false; this._selectAll.onchange = () => { @@ -2035,12 +2045,16 @@ export class accountsList { } reload = (callback?: () => void) => { + this._counter.reset() + this._counter.getTotal("/users/count"); + _get("/users", null, (req: XMLHttpRequest) => { if (req.readyState == 4 && req.status == 200) { + let resp = req.response as UsersDTO; // same method as inviteList.reload() let accountsOnDOM: { [id: string]: boolean } = {}; for (let id in this._users) { accountsOnDOM[id] = true; } - for (let u of (req.response["users"] as User[])) { + for (let u of resp.users) { if (u.id in this._users) { this._users[u.id].update(u); delete accountsOnDOM[u.id]; @@ -2055,10 +2069,10 @@ export class accountsList { // console.log("reload, so sorting by", this._activeSortColumn); this._ordering = this._columns[this._activeSortColumn].sort(this._users); this._search.ordering = this._ordering; - if (!(this._search.inSearch)) { - this.setVisibility(this._ordering, true); - this._notFoundPanel.classList.add("unfocused"); - } else { + + this._counter.loaded = this._ordering.length; + + if (this._search.inSearch) { const results = this._search.search(this._searchBox.value); if (results.length == 0) { this._notFoundPanel.classList.remove("unfocused"); @@ -2066,6 +2080,10 @@ export class accountsList { this._notFoundPanel.classList.add("unfocused"); } this.setVisibility(results, true); + } else { + this._counter.shown = this._counter.loaded; + this.setVisibility(this._ordering, true); + this._notFoundPanel.classList.add("unfocused"); } this._checkCheckCount(); diff --git a/ts/modules/activity.ts b/ts/modules/activity.ts index 135d50b..59ed865 100644 --- a/ts/modules/activity.ts +++ b/ts/modules/activity.ts @@ -346,9 +346,64 @@ export class Activity implements activity, SearchableItem { asElement = () => { return this._card; }; } -interface ActivitiesDTO { +export class RecordCounter { + private _container: HTMLElement; + private _totalRecords: HTMLElement; + private _loadedRecords: HTMLElement; + private _shownRecords: HTMLElement; + private _total: number; + private _loaded: number; + private _shown: number; + constructor(container: HTMLElement) { + this._container = container; + this._container.innerHTML = ` + + + + `; + this._totalRecords = document.getElementsByClassName("records-total")[0] as HTMLElement; + this._loadedRecords = document.getElementsByClassName("records-loaded")[0] as HTMLElement; + this._shownRecords = document.getElementsByClassName("records-shown")[0] as HTMLElement; + this.total = 0; + this.loaded = 0; + this.shown = 0; + } + + reset() { + this.total = 0; + this.loaded = 0; + this.shown = 0; + } + + // Sets the total using a PageCountDTO-returning API endpoint. + getTotal(endpoint: string) { + _get(endpoint, null, (req: XMLHttpRequest) => { + if (req.readyState != 4 || req.status != 200) return; + this.total = req.response["count"] as number; + }); + } + + get total(): number { return this._total; } + set total(v: number) { + this._total = v; + this._totalRecords.textContent = window.lang.var("strings", "totalRecords", `${v}`); + } + + get loaded(): number { return this._loaded; } + set loaded(v: number) { + this._loaded = v; + this._loadedRecords.textContent = window.lang.var("strings", "loadedRecords", `${v}`); + } + + get shown(): number { return this._shown; } + set shown(v: number) { + this._shown = v; + this._shownRecords.textContent = window.lang.var("strings", "shownRecords", `${v}`); + } +} + +interface ActivitiesDTO extends paginatedDTO { activities: activity[]; - last_page: boolean; } export class activityList { @@ -368,31 +423,7 @@ export class activityList { private _keepSearchingDescription = document.getElementById("activity-keep-searching-description"); private _keepSearchingButton = document.getElementById("activity-keep-searching"); - private _totalRecords = document.getElementById("activity-total-records"); - private _loadedRecords = document.getElementById("activity-loaded-records"); - private _shownRecords = document.getElementById("activity-shown-records"); - - private _total: number; - private _loaded: number; - private _shown: number; - - get total(): number { return this._total; } - set total(v: number) { - this._total = v; - this._totalRecords.textContent = window.lang.var("strings", "totalRecords", `${v}`); - } - - get loaded(): number { return this._loaded; } - set loaded(v: number) { - this._loaded = v; - this._loadedRecords.textContent = window.lang.var("strings", "loadedRecords", `${v}`); - } - - get shown(): number { return this._shown; } - set shown(v: number) { - this._shown = v; - this._shownRecords.textContent = window.lang.var("strings", "shownRecords", `${v}`); - } + private _counter: RecordCounter; private _search: Search; private _ascending: boolean; @@ -421,9 +452,8 @@ export class activityList { this._loadAllButton.classList.remove("unfocused"); this._loadAllButton.disabled = false; - this.total = 0; - this.loaded = 0; - this.shown = 0; + this._counter.reset(); + this._counter.getTotal("/activity/count"); // this._page = 0; let limit = 10; @@ -438,10 +468,6 @@ export class activityList { "ascending": this.ascending } - _get("/activity/count", null, (req: XMLHttpRequest) => { - if (req.readyState != 4 || req.status != 200) return; - this.total = req.response["count"] as number; - }); _post("/activity", send, (req: XMLHttpRequest) => { if (req.readyState != 4) return; @@ -467,13 +493,13 @@ export class activityList { this._search.items = this._activities; this._search.ordering = this._ordering; - this.loaded = this._ordering.length; + this._counter.loaded = this._ordering.length; if (this._search.inSearch) { this._search.onSearchBoxChange(true); this._loadAllButton.classList.remove("unfocused"); } else { - this.shown = this.loaded; + this._counter.shown = this._counter.loaded; this.setVisibility(this._ordering, true); this._loadAllButton.classList.add("unfocused"); this._notFoundPanel.classList.add("unfocused"); @@ -526,7 +552,7 @@ export class activityList { // this._search.items = this._activities; // this._search.ordering = this._ordering; - this.loaded = this._ordering.length; + this._counter.loaded = this._ordering.length; if (this._search.inSearch || loadAll) { if (this._lastPage) { @@ -699,6 +725,8 @@ export class activityList { this._activityList = document.getElementById("activity-card-list"); document.addEventListener("activity-reload", this.reload); + this._counter = new RecordCounter(document.getElementById("activity-record-counter")); + let conf: SearchConfiguration = { filterArea: this._filterArea, sortingByButton: this._sortingByButton, @@ -711,7 +739,7 @@ export class activityList { filterList: document.getElementById("activity-filter-list"), // notFoundCallback: this._notFoundCallback, onSearchCallback: (visibleCount: number, newItems: boolean, loadAll: boolean) => { - this.shown = visibleCount; + this._counter.shown = visibleCount; if (this._search.inSearch && !this._lastPage) this._loadAllButton.classList.remove("unfocused"); else this._loadAllButton.classList.add("unfocused"); diff --git a/ts/typings/d.ts b/ts/typings/d.ts index b19a1c7..a4f7f80 100644 --- a/ts/typings/d.ts +++ b/ts/typings/d.ts @@ -155,5 +155,9 @@ interface inviteList { // submitter: HTMLInputElement; // } +interface paginatedDTO { + last_page: boolean; +} + declare var config: Object; declare var modifiedConfig: Object; diff --git a/usercache.go b/usercache.go new file mode 100644 index 0000000..68af907 --- /dev/null +++ b/usercache.go @@ -0,0 +1,35 @@ +package main + +import ( + "sync" + "time" +) + +const ( + // FIXME: Follow mediabrowser, or make tuneable, or both + WEB_USER_CACHE_SYNC = 30 * time.Second +) + +type UserCache struct { + Cache []respUser + LastSync time.Time + Lock sync.Mutex +} + +func (c *UserCache) Gen(app *appContext) error { + if !time.Now().After(c.LastSync.Add(WEB_USER_CACHE_SYNC)) { + return nil + } + users, err := app.jf.GetUsers(false) + if err != nil { + return err + } + c.Lock.Lock() + c.Cache = make([]respUser, len(users)) + for i, jfUser := range users { + c.Cache[i] = app.userSummary(jfUser) + } + c.LastSync = time.Now() + c.Lock.Unlock() + return nil +} From 3067db9c3113c1cba41f52c3ae4dad35740d7e28 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Thu, 15 May 2025 20:08:08 +0100 Subject: [PATCH 026/249] usercache: we'll do it ourselves we don't need expr or anything like that, cmp.Less and vim macros exist. --- go.mod | 1 - go.sum | 2 - usercache.go | 116 ++++++++++++++++++++++++++++++++++++++++++++++++++- 3 files changed, 115 insertions(+), 4 deletions(-) diff --git a/go.mod b/go.mod index eb0fcb0..6b17a34 100644 --- a/go.mod +++ b/go.mod @@ -70,7 +70,6 @@ require ( github.com/cloudwego/iasm v0.2.0 // indirect github.com/dgraph-io/ristretto v1.0.0 // indirect github.com/dustin/go-humanize v1.0.1 // indirect - github.com/expr-lang/expr v1.17.3 // indirect github.com/gabriel-vasile/mimetype v1.4.6 // indirect github.com/getlantern/context v0.0.0-20220418194847-3d5e7a086201 // indirect github.com/getlantern/errors v1.0.4 // indirect diff --git a/go.sum b/go.sum index a12698d..c9c85b6 100644 --- a/go.sum +++ b/go.sum @@ -58,8 +58,6 @@ github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymF github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98= github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c= -github.com/expr-lang/expr v1.17.3 h1:myeTTuDFz7k6eFe/JPlep/UsiIjVhG61FMHFu63U7j0= -github.com/expr-lang/expr v1.17.3/go.mod h1:8/vRC7+7HBzESEqt5kKpYXxrxkr31SaO8r40VO/1IT4= github.com/fatih/color v1.10.0/go.mod h1:ELkj/draVOlAH/xkhN6mQ50Qd0MPOk5AAr3maGEBuJM= github.com/fatih/color v1.18.0 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM= github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU= diff --git a/usercache.go b/usercache.go index 68af907..c04b600 100644 --- a/usercache.go +++ b/usercache.go @@ -1,6 +1,7 @@ package main import ( + "cmp" "sync" "time" ) @@ -17,6 +18,7 @@ type UserCache struct { } func (c *UserCache) Gen(app *appContext) error { + c.Lock.Lock() if !time.Now().After(c.LastSync.Add(WEB_USER_CACHE_SYNC)) { return nil } @@ -24,7 +26,6 @@ func (c *UserCache) Gen(app *appContext) error { if err != nil { return err } - c.Lock.Lock() c.Cache = make([]respUser, len(users)) for i, jfUser := range users { c.Cache[i] = app.userSummary(jfUser) @@ -33,3 +34,116 @@ func (c *UserCache) Gen(app *appContext) error { c.Lock.Unlock() return nil } + +type SortableUserList struct { + Cache []respUser + lessFunc func(a, b *respUser) bool +} + +func (sc *SortableUserList) Len() int { + return len(sc.Cache) +} + +func (sc *SortableUserList) Swap(i, j int) { + sc.Cache[i], sc.Cache[j] = sc.Cache[j], sc.Cache[i] +} + +func (sc *SortableUserList) Less(i, j int) bool { + return sc.lessFunc(&sc.Cache[i], &sc.Cache[j]) +} + +// instead of making a Less for bools, just convert them to integers +// https://0x0f.me/blog/golang-compiler-optimization/ +func bool2int(b bool) int { + var i int + if b { + i = 1 + } else { + i = 0 + } + return i +} + +// Allow sorting by respUser's struct fields (well, it's JSON-representation's fields) +// Ugly I know, but at least cmp.Less exists. +// Done with vim macros, thank god they exist +func SortUsersBy(u []respUser, field string) SortableUserList { + s := SortableUserList{Cache: u} + + switch field { + case "id": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(a.ID, b.ID) + } + + case "name": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(a.Name, b.Name) + } + case "email": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(a.Email, b.Email) + } + case "notify_email": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(bool2int(a.NotifyThroughEmail), bool2int(b.NotifyThroughEmail)) + } + case "last_active": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(a.LastActive, b.LastActive) + } + case "admin": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(bool2int(a.Admin), bool2int(b.Admin)) + } + case "expiry": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(a.Expiry, b.Expiry) + } + case "disabled": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(bool2int(a.Disabled), bool2int(b.Disabled)) + } + case "telegram": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(a.Telegram, b.Telegram) + } + case "notify_telegram": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(bool2int(a.NotifyThroughTelegram), bool2int(b.NotifyThroughTelegram)) + } + case "discord": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(a.Discord, b.Discord) + } + case "discord_id": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(a.DiscordID, b.DiscordID) + } + case "notify_discord": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(bool2int(a.NotifyThroughDiscord), bool2int(b.NotifyThroughDiscord)) + } + case "matrix": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(a.Matrix, b.Matrix) + } + case "notify_matrix": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(bool2int(a.NotifyThroughMatrix), bool2int(b.NotifyThroughMatrix)) + } + case "label": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(a.Label, b.Label) + } + case "accounts_admin": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(bool2int(a.AccountsAdmin), bool2int(b.AccountsAdmin)) + } + case "referrals_enabled": + s.lessFunc = func(a, b *respUser) bool { + return cmp.Less(bool2int(a.ReferralsEnabled), bool2int(b.ReferralsEnabled)) + } + } + return s +} From c5683dbc71e0a1d06568e8b2b29e6d6ec1a9d8bc Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Fri, 16 May 2025 16:50:13 +0100 Subject: [PATCH 027/249] search: factor out date and bool comparison --- api-users.go | 13 +- ts/modules/search.ts | 287 ++++++++++++++++++++++++++++++------------- usercache.go | 21 +++- 3 files changed, 226 insertions(+), 95 deletions(-) diff --git a/api-users.go b/api-users.go index 60934b1..38149f0 100644 --- a/api-users.go +++ b/api-users.go @@ -902,13 +902,13 @@ func (app *appContext) userSummary(jfUser mediabrowser.User) respUser { // @tags Activity func (app *appContext) GetUserCount(gc *gin.Context) { resp := PageCountDTO{} - err := app.userCache.Gen(app) + userList, err := app.userCache.Gen(app) if err != nil { app.err.Printf(lm.FailedGetUsers, lm.Jellyfin, err) respond(500, "Couldn't get users", gc) return } - resp.Count = uint64(len(app.userCache.Cache)) + resp.Count = uint64(len(userList)) gc.JSON(200, resp) } @@ -923,13 +923,14 @@ func (app *appContext) GetUsers(gc *gin.Context) { var resp getUsersDTO // We're sending all users, so this is always true resp.LastPage = true - err := app.userCache.Gen(app) + var err error + resp.UserList, err = app.userCache.Gen(app) if err != nil { app.err.Printf(lm.FailedGetUsers, lm.Jellyfin, err) respond(500, "Couldn't get users", gc) return } - resp.UserList = app.userCache.Cache + app.debug.Printf("sending usercache of length %d", len(resp.UserList)) gc.JSON(200, resp) } @@ -951,13 +952,13 @@ func (app *appContext) SearchUsers(gc *gin.Context) { var resp getUsersDTO // We're sending all users, so this is always true resp.LastPage = true - err := app.userCache.Gen(app) + var err error + resp.UserList, err = app.userCache.Gen(app) if err != nil { app.err.Printf(lm.FailedGetUsers, lm.Jellyfin, err) respond(500, "Couldn't get users", gc) return } - resp.UserList = app.userCache.Cache gc.JSON(200, resp) } diff --git a/ts/modules/search.ts b/ts/modules/search.ts index fa8d1e1..a0a446a 100644 --- a/ts/modules/search.ts +++ b/ts/modules/search.ts @@ -2,6 +2,23 @@ const dateParser = require("any-date-parser"); declare var window: GlobalWindow; +export enum QueryOperator { + Greater = ">", + Lower = "<", + Equal = "=" +} + +export function QueryOperatorToDateText(op: QueryOperator): string { + switch (op) { + case QueryOperator.Greater: + return window.lang.strings("after"); + case QueryOperator.Lower: + return window.lang.strings("before"); + default: + return ""; + } +} + export interface QueryType { name: string; description?: string; @@ -28,6 +45,172 @@ export interface SearchConfiguration { loadMore?: () => void; } +export abstract class Query { + protected _subject: QueryType; + protected _operator: QueryOperator; + protected _card: HTMLElement; + + constructor(subject: QueryType, operator: QueryOperator) { + this._subject = subject; + this._operator = operator; + this._card = document.createElement("span"); + this._card.ariaLabel = window.lang.strings("clickToRemoveFilter"); + } + + set onclick(v: () => void) { + this._card.addEventListener("click", v); + } + + asElement(): HTMLElement { return this._card; } +} + + +export class BoolQuery extends Query { + protected _value: boolean; + constructor(subject: QueryType, value: boolean) { + super(subject, QueryOperator.Equal); + this._value = value; + this._card.classList.add("button", "~" + (this._value ? "positive" : "critical"), "@high", "center", "mx-2", "h-full"); + this._card.innerHTML = ` + ${subject.name} + + `; + } + + public static paramsFromString(valueString: string): [boolean, boolean] { + let isBool = false; + let boolState = false; + if (valueString == "true" || valueString == "yes" || valueString == "t" || valueString == "y") { + isBool = true; + boolState = true; + } else if (valueString == "false" || valueString == "no" || valueString == "f" || valueString == "n") { + isBool = true; + boolState = false; + } + return [boolState, isBool] + } + + get value(): boolean { return this._value; } + + // Ripped from old code. Why it's like this, I don't know + public compare(subjectBool: boolean): boolean { + return ((subjectBool && this._value) || (!subjectBool && !this._value)) + } +} + +export class StringQuery extends Query { + protected _value: string; + constructor(subject: QueryType, value: string) { + super(subject, QueryOperator.Equal); + this._value = value; + this._card.classList.add("button", "~neutral", "@low", "center", "mx-2", "h-full"); + this._card.innerHTML = ` + ${subject.name}: "${this._value}" + `; + } + + get value(): string { return this._value; } +} + +export interface DateAttempt { + year?: number; + month?: number; + day?: number; + hour?: number; + minute?: number +} + +export interface ParsedDate { + attempt: DateAttempt; + date: Date; + text: string; +}; + +const dateGetters: Map number> = (() => { + let m = new Map number>(); + m.set("year", Date.prototype.getFullYear); + m.set("month", Date.prototype.getMonth); + m.set("day", Date.prototype.getDate); + m.set("hour", Date.prototype.getHours); + m.set("minute", Date.prototype.getMinutes); + return m; +})(); +const dateSetters: Map void> = (() => { + let m = new Map void>(); + m.set("year", Date.prototype.setFullYear); + m.set("month", Date.prototype.setMonth); + m.set("day", Date.prototype.setDate); + m.set("hour", Date.prototype.setHours); + m.set("minute", Date.prototype.setMinutes); + return m; +})(); + +export class DateQuery extends Query { + protected _value: ParsedDate; + + constructor(subject: QueryType, operator: QueryOperator, value: ParsedDate) { + super(subject, operator); + this._value = value; + console.log("op:", operator, "date:", value); + this._card.classList.add("button", "~neutral", "@low", "center", "m-2", "h-full"); + let dateText = QueryOperatorToDateText(operator); + this._card.innerHTML = ` + ${subject.name}: ${dateText != "" ? dateText+" " : ""}${value.text} + `; + } + public static paramsFromString(valueString: string): [ParsedDate, QueryOperator, boolean] { + // FIXME: Validate this! + let op = QueryOperator.Equal; + if ((Object.values(QueryOperator) as string[]).includes(valueString.charAt(0))) { + op = valueString.charAt(0) as QueryOperator; + // Trim the operator from the string + valueString = valueString.substring(1); + } + + let out: ParsedDate = { + text: valueString, + // Used just to tell use what fields the user passed. + attempt: dateParser.attempt(valueString), + // note Date.fromString is also provided by dateParser. + date: (Date as any).fromString(valueString) as Date + }; + // Month in Date objects is 0-based, so make our parsed date that way too + if ("month" in out.attempt) out.attempt.month -= 1; + let isValid = true; + if ("invalid" in (out.date as any)) { isValid = false; }; + + return [out, op, isValid]; + } + + get value(): ParsedDate { return this._value; } + + public compare(subjectDate: Date): boolean { + // We want to compare only the fields given in this._value, + // so we copy subjectDate and apply on those fields from this._value. + const temp = new Date(subjectDate.valueOf()); + for (let [field] of dateGetters) { + if (field in this._value.attempt) { + dateSetters.get(field).call( + temp, + dateGetters.get(field).call(this._value.date) + ); + } + } + + if (this._operator == QueryOperator.Equal) { + return subjectDate.getTime() == temp.getTime(); + } else if (this._operator == QueryOperator.Lower) { + return subjectDate < temp; + } + return subjectDate > temp; + } +} + + +// FIXME: Continue taking stuff from search function, making XQuery classes! + + + export interface SearchableItem { matchesSearch: (query: string) => boolean; } @@ -99,33 +282,20 @@ export class Search { const queryFormat = this._c.queries[split[0]]; - if (queryFormat.bool) { - let isBool = false; - let boolState = false; - if (split[1] == "true" || split[1] == "yes" || split[1] == "t" || split[1] == "y") { - isBool = true; - boolState = true; - } else if (split[1] == "false" || split[1] == "no" || split[1] == "f" || split[1] == "n") { - isBool = true; - boolState = false; - } - if (isBool) { - const filterCard = document.createElement("span"); - filterCard.ariaLabel = window.lang.strings("clickToRemoveFilter"); - filterCard.classList.add("button", "~" + (boolState ? "positive" : "critical"), "@high", "center", "mx-2", "h-full"); - filterCard.innerHTML = ` - ${queryFormat.name} - - `; + let formattedQuery = [] - filterCard.addEventListener("click", () => { + if (queryFormat.bool) { + let [boolState, isBool] = BoolQuery.paramsFromString(split[1]); + if (isBool) { + let q = new BoolQuery(queryFormat, boolState); + q.onclick = () => { for (let quote of [`"`, `'`, ``]) { this._c.search.value = this._c.search.value.replace(split[0] + ":" + quote + split[1] + quote, ""); } this._c.search.oninput((null as Event)); - }) + }; - this._c.filterArea.appendChild(filterCard); + this._c.filterArea.appendChild(q.asElement()); // console.log("is bool, state", boolState); // So removing elements doesn't affect us @@ -135,7 +305,7 @@ export class Search { const value = Object.getOwnPropertyDescriptor(Object.getPrototypeOf(u), queryFormat.getter).get.call(u); // console.log("got", queryFormat.getter + ":", value); // Remove from result if not matching query - if (!((value && boolState) || (!value && !boolState))) { + if (!q.compare(value)) { // console.log("not matching, result is", result); result.splice(result.indexOf(id), 1); } @@ -144,22 +314,17 @@ export class Search { } } if (queryFormat.string) { - const filterCard = document.createElement("span"); - filterCard.ariaLabel = window.lang.strings("clickToRemoveFilter"); - filterCard.classList.add("button", "~neutral", "@low", "center", "mx-2", "h-full"); - filterCard.innerHTML = ` - ${queryFormat.name}: "${split[1]}" - `; + const q = new StringQuery(queryFormat, split[1]); - filterCard.addEventListener("click", () => { + q.onclick = () => { for (let quote of [`"`, `'`, ``]) { let regex = new RegExp(split[0] + ":" + quote + split[1] + quote, "ig"); this._c.search.value = this._c.search.value.replace(regex, ""); } this._c.search.oninput((null as Event)); - }) + } - this._c.filterArea.appendChild(filterCard); + this._c.filterArea.appendChild(q.asElement()); let cachedResult = [...result]; for (let id of cachedResult) { @@ -172,39 +337,20 @@ export class Search { continue; } if (queryFormat.date) { - // -1 = Before, 0 = On, 1 = After, 2 = No symbol, assume 0 - let compareType = (split[1][0] == ">") ? 1 : ((split[1][0] == "<") ? -1 : ((split[1][0] == "=") ? 0 : 2)); - let unmodifiedValue = split[1]; - if (compareType != 2) { - split[1] = split[1].substring(1); - } - if (compareType == 2) compareType = 0; - - let attempt: { year?: number, month?: number, day?: number, hour?: number, minute?: number } = dateParser.attempt(split[1]); - // Month in Date objects is 0-based, so make our parsed date that way too - if ("month" in attempt) attempt.month -= 1; - - let date: Date = (Date as any).fromString(split[1]) as Date; - console.log("Read", attempt, "and", date); - if ("invalid" in (date as any)) continue; - - const filterCard = document.createElement("span"); - filterCard.ariaLabel = window.lang.strings("clickToRemoveFilter"); - filterCard.classList.add("button", "~neutral", "@low", "center", "m-2", "h-full"); - filterCard.innerHTML = ` - ${queryFormat.name}: ${(compareType == 1) ? window.lang.strings("after")+" " : ((compareType == -1) ? window.lang.strings("before")+" " : "")}${split[1]} - `; + let [parsedDate, op, isDate] = DateQuery.paramsFromString(split[1]); + if (!isDate) continue; + const q = new DateQuery(queryFormat, op, parsedDate); - filterCard.addEventListener("click", () => { + q.onclick = () => { for (let quote of [`"`, `'`, ``]) { - let regex = new RegExp(split[0] + ":" + quote + unmodifiedValue + quote, "ig"); + let regex = new RegExp(split[0] + ":" + quote + split[1] + quote, "ig"); this._c.search.value = this._c.search.value.replace(regex, ""); } this._c.search.oninput((null as Event)); - }) + } - this._c.filterArea.appendChild(filterCard); + this._c.filterArea.appendChild(q.asElement()); let cachedResult = [...result]; for (let id of cachedResult) { @@ -215,33 +361,8 @@ export class Search { continue; } let value = new Date(unixValue*1000); - - const getterPairs: [string, () => number][] = [["year", Date.prototype.getFullYear], ["month", Date.prototype.getMonth], ["day", Date.prototype.getDate], ["hour", Date.prototype.getHours], ["minute", Date.prototype.getMinutes]]; - // When doing > or <
-
+
+
+ + {{ .strings.searchAllRecords }} +
+
@@ -803,14 +808,23 @@ +
{{ .strings.noResultsFound }} - + {{ .strings.keepSearchingDescription }} +
+ + +
+
+ + +
@@ -825,10 +839,14 @@ -
+
- +
+ + {{ .strings.searchAllRecords }} +
+
diff --git a/lang/admin/en-us.json b/lang/admin/en-us.json index eed6603..ff3dec1 100644 --- a/lang/admin/en-us.json +++ b/lang/admin/en-us.json @@ -136,6 +136,7 @@ "filters": "Filters", "clickToRemoveFilter": "Click to remove this filter.", "clearSearch": "Clear search", + "searchAllRecords": "Search all records (on server)", "actions": "Actions", "searchOptions": "Search Options", "matchText": "Match Text", @@ -190,6 +191,7 @@ "totalRecords": "{n} Total Records", "loadedRecords": "{n} Loaded", "shownRecords": "{n} Shown", + "selectedRecords": "{n} Selected", "backups": "Backups", "backupsDescription": "Backups of the database can be made, restored, or downloaded from here.", "backupsFormatNote": "Only backup files with the standard name format will be shown here. To use any other, upload the backup manually.", diff --git a/models.go b/models.go index 360a2e2..7e6b31c 100644 --- a/models.go +++ b/models.go @@ -168,14 +168,20 @@ type PaginatedDTO struct { LastPage bool `json:"last_page"` } +type PaginatedReqDTO struct { + Limit int `json:"limit"` + Page int `json:"page"` // zero-indexed + SortByField string `json:"sortByField"` + Ascending bool `json:"ascending"` +} + type getUsersReqDTO struct { - Limit int `json:"limit"` - Page int `json:"page"` // zero-indexed + ServerSearchReqDTO } type getUsersDTO struct { - UserList []respUser `json:"users"` - LastPage bool `json:"last_page"` + UserList []*respUser `json:"users"` + LastPage bool `json:"last_page"` } type ombiUser struct { @@ -440,10 +446,9 @@ type ActivityDTO struct { } type GetActivitiesDTO struct { - Type []string `json:"type"` // Types of activity to get. Leave blank for all. - Limit int `json:"limit"` - Page int `json:"page"` // zero-indexed - Ascending bool `json:"ascending"` + // "SortByField" ignores, it's always time. + PaginatedReqDTO + Type []string `json:"type"` // Types of activity to get. Leave blank for all. } type GetActivitiesRespDTO struct { diff --git a/ts/admin.ts b/ts/admin.ts index 6ee213b..45aea1a 100644 --- a/ts/admin.ts +++ b/ts/admin.ts @@ -148,12 +148,16 @@ const tabs: { id: string, url: string, reloader: () => void }[] = [ // Don't keep loading the same item on every tab refresh isAccountURL = false; } + window.onscroll = accounts.detectScroll; }), }, { id: "activity", url: "activity", - reloader: activity.reload + reloader: () => { + activity.reload() + window.onscroll = activity.detectScroll; + }, }, { id: "settings", diff --git a/ts/modules/accounts.ts b/ts/modules/accounts.ts index 2bc902d..a95b14f 100644 --- a/ts/modules/accounts.ts +++ b/ts/modules/accounts.ts @@ -3,9 +3,9 @@ import { templateEmail } from "../modules/settings.js"; import { Marked } from "@ts-stack/markdown"; import { stripMarkdown } from "../modules/stripmd.js"; import { DiscordUser, newDiscordSearch } from "../modules/discord.js"; -import { Search, SearchConfiguration, QueryType, SearchableItem } from "../modules/search.js"; +import { Search, SearchConfiguration, QueryType, SearchableItem, SearchableItems } from "../modules/search.js"; import { HiddenInputField } from "./ui.js"; -import { RecordCounter } from "./activity.js"; +import { PaginatedList } from "./list.js"; declare var window: GlobalWindow; @@ -44,6 +44,117 @@ interface announcementTemplate { } var addDiscord: (passData: string) => void; + +const queries = (): { [field: string]: QueryType } => { return { + "id": { + // We don't use a translation here to circumvent the name substitution feature. + name: "Jellyfin/Emby ID", + getter: "id", + bool: false, + string: true, + date: false + }, + "label": { + name: window.lang.strings("label"), + getter: "label", + bool: true, + string: true, + date: false + }, + "username": { + name: window.lang.strings("username"), + getter: "name", + bool: false, + string: true, + date: false + }, + "name": { + name: window.lang.strings("username"), + getter: "name", + bool: false, + string: true, + date: false, + show: false + }, + "admin": { + name: window.lang.strings("admin"), + getter: "admin", + bool: true, + string: false, + date: false + }, + "disabled": { + name: window.lang.strings("disabled"), + getter: "disabled", + bool: true, + string: false, + date: false + }, + "access-jfa": { + name: window.lang.strings("accessJFA"), + getter: "accounts_admin", + bool: true, + string: false, + date: false, + dependsOnElement: ".accounts-header-access-jfa" + }, + "email": { + name: window.lang.strings("emailAddress"), + getter: "email", + bool: true, + string: true, + date: false, + dependsOnElement: ".accounts-header-email" + }, + "telegram": { + name: "Telegram", + getter: "telegram", + bool: true, + string: true, + date: false, + dependsOnElement: ".accounts-header-telegram" + }, + "matrix": { + name: "Matrix", + getter: "matrix", + bool: true, + string: true, + date: false, + dependsOnElement: ".accounts-header-matrix" + }, + "discord": { + name: "Discord", + getter: "discord", + bool: true, + string: true, + date: false, + dependsOnElement: ".accounts-header-discord" + }, + "expiry": { + name: window.lang.strings("expiry"), + getter: "expiry", + bool: true, + string: false, + date: true, + dependsOnElement: ".accounts-header-expiry" + }, + "last-active": { + name: window.lang.strings("lastActiveTime"), + getter: "last_active", + bool: true, + string: false, + date: true + }, + "referrals-enabled": { + name: window.lang.strings("referrals"), + getter: "referrals_enabled", + bool: true, + string: false, + date: false, + dependsOnElement: ".accounts-header-referrals" + } +}}; + class user implements User, SearchableItem { private _id = ""; @@ -112,7 +223,7 @@ class user implements User, SearchableItem { get name(): string { return this._username.textContent; } set name(value: string) { this._username.textContent = value; } - get admin(): boolean { return this._admin.classList.contains("chip"); } + get admin(): boolean { return !(this._admin.classList.contains("hidden")); } set admin(state: boolean) { if (state) { this._admin.classList.remove("hidden") @@ -472,7 +583,6 @@ class user implements User, SearchableItem { } matchesSearch = (query: string): boolean => { - console.log(this.name, "matches", query, ":", this.name.includes(query)); return ( this.id.includes(query) || this.name.toLowerCase().includes(query) || @@ -536,7 +646,6 @@ class user implements User, SearchableItem { `; this._row.innerHTML = innerHTML; - const emailEditor = ``; this._check = this._row.querySelector("input[type=checkbox].accounts-select-user") as HTMLInputElement; this._accounts_admin = this._row.querySelector("input[type=checkbox].accounts-access-jfa") as HTMLInputElement; this._username = this._row.querySelector(".accounts-username") as HTMLSpanElement; @@ -709,7 +818,9 @@ interface UsersDTO extends paginatedDTO { users: User[]; } -export class accountsList { +interface UsersReqDTO extends PaginatedReqDTO {}; + +export class accountsList extends PaginatedList { private _table = document.getElementById("accounts-list") as HTMLTableSectionElement; private _addUserButton = document.getElementById("accounts-add-user") as HTMLSpanElement; @@ -747,8 +858,6 @@ export class accountsList { private _referralsProfileSelect = document.getElementById("enable-referrals-user-profiles") as HTMLSelectElement; private _referralsInviteSelect = document.getElementById("enable-referrals-user-invites") as HTMLSelectElement; private _referralsExpiry = document.getElementById("enable-referrals-user-expiry") as HTMLInputElement; - private _searchBox = document.getElementById("accounts-search") as HTMLInputElement; - private _search: Search; private _applyHomescreen = document.getElementById("modify-user-homescreen") as HTMLInputElement; private _applyConfiguration = document.getElementById("modify-user-configuration") as HTMLInputElement; @@ -756,9 +865,11 @@ export class accountsList { private _applyJellyseerr = document.getElementById("modify-user-jellyseerr") as HTMLInputElement; private _selectAll = document.getElementById("accounts-select-all") as HTMLInputElement; - private _users: { [id: string]: user }; - private _ordering: string[] = []; - private _checkCount: number = 0; + // private _users: { [id: string]: user }; + // private _ordering: string[] = []; + get users(): { [id: string]: user } { return this._search.items as { [id: string]: user }; } + // set users(v: { [id: string]: user }) { this._search.items = v as SearchableItems; } + // Whether the enable/disable button should enable or not. private _shouldEnable = false; @@ -770,18 +881,13 @@ export class accountsList { // Columns for sorting. private _columns: { [className: string]: Column } = {}; - private _activeSortColumn: string; - - private _sortingByButton = document.getElementById("accounts-sort-by-field") as HTMLButtonElement; - private _filterArea = document.getElementById("accounts-filter-area"); - private _searchOptionsHeader = document.getElementById("accounts-search-options-header"); - - private _counter: RecordCounter; // Whether the "Extend expiry" is extending or setting an expiry. private _settingExpiry = false; - private _count = 30; + private _sortingByButton = document.getElementById("accounts-sort-by-field") as HTMLButtonElement; + + private _maxDayHourMinuteOptions = 30; private _populateNumbers = () => { const fieldIDs = ["months", "days", "hours", "minutes"]; const prefixes = ["extend-expiry-"]; @@ -789,7 +895,7 @@ export class accountsList { for (let j = 0; j < prefixes.length; j++) { const field = document.getElementById(prefixes[j] + fieldIDs[i]); field.textContent = ''; - for (let n = 0; n <= this._count; n++) { + for (let n = 0; n <= this._maxDayHourMinuteOptions; n++) { const opt = document.createElement("option") as HTMLOptionElement; opt.textContent = ""+n; opt.value = ""+n; @@ -798,164 +904,381 @@ export class accountsList { } } } + + constructor() { + super({ + loader: document.getElementById("accounts-loader"), + loadMoreButton: document.getElementById("accounts-load-more") as HTMLButtonElement, + loadAllButton: document.getElementById("accounts-load-all") as HTMLButtonElement, + refreshButton: document.getElementById("accounts-refresh") as HTMLButtonElement, + keepSearchingDescription: document.getElementById("accounts-keep-searching-description"), + keepSearchingButton: document.getElementById("accounts-keep-searching"), + filterArea: document.getElementById("accounts-filter-area"), + searchOptionsHeader: document.getElementById("accounts-search-options-header"), + searchBox: document.getElementById("accounts-search") as HTMLInputElement, + notFoundPanel: document.getElementById("accounts-not-found"), + recordCounter: document.getElementById("accounts-record-counter"), + totalEndpoint: "/users/count", + getPageEndpoint: "/users", + limit: 4, + newElementsFromPage: (resp: paginatedDTO) => { + for (let u of ((resp as UsersDTO).users || [])) { + if (u.id in this.users) { + this.users[u.id].update(u); + } else { + this.add(u); + } + } - showHideSearchOptionsHeader = () => { - const sortingBy = !(this._sortingByButton.parentElement.classList.contains("hidden")); - const hasFilters = this._filterArea.textContent != ""; - console.log("sortingBy", sortingBy, "hasFilters", hasFilters); - if (sortingBy || hasFilters) { - this._searchOptionsHeader.classList.remove("hidden"); + this._search.setOrdering( + this._columns[this._search.sortField].sort(this.users), + this._search.sortField, + this._search.ascending + ); + }, + updateExistingElementsFromPage: (resp: paginatedDTO) => { + let accountsOnDOM: { [id: string]: boolean } = {}; + + for (let id of Object.keys(this.users)) { accountsOnDOM[id] = true; } + for (let u of ((resp as UsersDTO).users || [])) { + if (u.id in accountsOnDOM) { + this.users[u.id].update(u); + delete accountsOnDOM[u.id]; + } else { + this.add(u); + } + } + + // Delete accounts w/ remaining IDs (those not in resp.users) + // console.log("Removing", Object.keys(accountsOnDOM).length, "from DOM"); + for (let id in accountsOnDOM) { + this.users[id].remove() + delete this.users[id]; + } + + this._search.setOrdering( + this._columns[this._search.sortField].sort(this.users), + this._search.sortField, + this._search.ascending + ); + }, + defaultSortField: "name", + pageLoadCallback: (req: XMLHttpRequest) => { + if (req.readyState != 4) return; + // FIXME: Error message + if (req.status != 200) return; + } + }); + this._populateNumbers(); + + let searchConfig: SearchConfiguration = { + filterArea: this._c.filterArea, + sortingByButton: this._sortingByButton, + searchOptionsHeader: this._c.searchOptionsHeader, + notFoundPanel: this._c.notFoundPanel, + filterList: document.getElementById("accounts-filter-list"), + search: this._c.searchBox, + queries: queries(), + setVisibility: this.setVisibility, + clearSearchButtonSelector: ".accounts-search-clear", + serverSearchButtonSelector: ".accounts-search-server", + onSearchCallback: (_0: number, _1: boolean, _2: boolean) => { + this._checkCheckCount(); + }, + searchServer: null, + clearServerSearch: null, + }; + + this.initSearch(searchConfig); + + this._selectAll.checked = false; + this._selectAll.onchange = () => { + this.selectAll = this._selectAll.checked; + }; + document.addEventListener("accounts-reload", () => this.reload()); + document.addEventListener("accountCheckEvent", () => { this._counter.selected++; this._checkCheckCount(); }); + document.addEventListener("accountUncheckEvent", () => { this._counter.selected--; this._checkCheckCount(); }); + this._addUserButton.onclick = () => { + this._populateAddUserProfiles(); + window.modals.addUser.toggle(); + }; + this._addUserForm.addEventListener("submit", this._addUser); + + this._deleteNotify.onchange = () => { + if (this._deleteNotify.checked) { + this._deleteReason.classList.remove("unfocused"); + } else { + this._deleteReason.classList.add("unfocused"); + } + }; + this._modifySettings.onclick = this.modifyUsers; + this._modifySettings.classList.add("unfocused"); + + if (window.ombiEnabled) + this._applyOmbi.parentElement.classList.remove("unfocused"); + else + this._applyOmbi.parentElement.classList.add("unfocused"); + if (window.jellyseerrEnabled) + this._applyJellyseerr.parentElement.classList.remove("unfocused"); + else + this._applyJellyseerr.parentElement.classList.add("unfocused"); + + const checkSource = () => { + const profileSpan = this._modifySettingsProfile.nextElementSibling as HTMLSpanElement; + const userSpan = this._modifySettingsUser.nextElementSibling as HTMLSpanElement; + if (this._modifySettingsProfile.checked) { + this._userSelect.parentElement.classList.add("unfocused"); + this._profileSelect.parentElement.classList.remove("unfocused") + profileSpan.classList.add("@high"); + profileSpan.classList.remove("@low"); + userSpan.classList.remove("@high"); + userSpan.classList.add("@low"); + this._applyOmbi.parentElement.classList.remove("unfocused"); + this._applyJellyseerr.parentElement.classList.remove("unfocused"); + } else { + this._userSelect.parentElement.classList.remove("unfocused"); + this._profileSelect.parentElement.classList.add("unfocused"); + userSpan.classList.add("@high"); + userSpan.classList.remove("@low"); + profileSpan.classList.remove("@high"); + profileSpan.classList.add("@low"); + this._applyOmbi.parentElement.classList.add("unfocused"); + this._applyJellyseerr.parentElement.classList.add("unfocused"); + } + }; + this._modifySettingsProfile.onchange = checkSource; + this._modifySettingsUser.onchange = checkSource; + + if (window.referralsEnabled) { + const profileSpan = this._enableReferralsProfile.nextElementSibling as HTMLSpanElement; + const inviteSpan = this._enableReferralsInvite.nextElementSibling as HTMLSpanElement; + const checkReferralSource = () => { + console.log("States:", this._enableReferralsProfile.checked, this._enableReferralsInvite.checked); + if (this._enableReferralsProfile.checked) { + this._referralsInviteSelect.parentElement.classList.add("unfocused"); + this._referralsProfileSelect.parentElement.classList.remove("unfocused") + profileSpan.classList.add("@high"); + profileSpan.classList.remove("@low"); + inviteSpan.classList.remove("@high"); + inviteSpan.classList.add("@low"); + } else { + this._referralsInviteSelect.parentElement.classList.remove("unfocused"); + this._referralsProfileSelect.parentElement.classList.add("unfocused"); + inviteSpan.classList.add("@high"); + inviteSpan.classList.remove("@low"); + profileSpan.classList.remove("@high"); + profileSpan.classList.add("@low"); + } + }; + profileSpan.onclick = () => { + this._enableReferralsProfile.checked = true; + this._enableReferralsInvite.checked = false; + checkReferralSource(); + }; + inviteSpan.onclick = () => {; + this._enableReferralsInvite.checked = true; + this._enableReferralsProfile.checked = false; + checkReferralSource(); + }; + this._enableReferrals.onclick = () => { + this.enableReferrals(); + profileSpan.onclick(null); + }; + } + + this._deleteUser.onclick = this.deleteUsers; + this._deleteUser.classList.add("unfocused"); + + this._announceButton.onclick = this.announce; + this._announceButton.parentElement.classList.add("unfocused"); + + this._extendExpiry.onclick = () => { this.extendExpiry(); }; + this._removeExpiry.onclick = () => { this.removeExpiry(); }; + this._expiryDropdown.classList.add("unfocused"); + this._extendExpiryDate.classList.add("unfocused"); + + this._extendExpiryTextInput.onkeyup = () => { + this._extendExpiryTextInput.parentElement.parentElement.classList.remove("opacity-60"); + this._extendExpiryFieldInputs.classList.add("opacity-60"); + this._usingExtendExpiryTextInput = true; + this._displayExpiryDate(); + } + + this._extendExpiryTextInput.onclick = () => { + this._extendExpiryTextInput.parentElement.parentElement.classList.remove("opacity-60"); + this._extendExpiryFieldInputs.classList.add("opacity-60"); + this._usingExtendExpiryTextInput = true; + this._displayExpiryDate(); + }; + + this._extendExpiryFieldInputs.onclick = () => { + this._extendExpiryFieldInputs.classList.remove("opacity-60"); + this._extendExpiryTextInput.parentElement.parentElement.classList.add("opacity-60"); + this._usingExtendExpiryTextInput = false; + this._displayExpiryDate(); + }; + + for (let field of ["months", "days", "hours", "minutes"]) { + (document.getElementById("extend-expiry-"+field) as HTMLSelectElement).onchange = () => { + this._extendExpiryFieldInputs.classList.remove("opacity-60"); + this._extendExpiryTextInput.parentElement.parentElement.classList.add("opacity-60"); + this._usingExtendExpiryTextInput = false; + this._displayExpiryDate(); + }; + } + + this._disableEnable.onclick = this.enableDisableUsers; + this._disableEnable.parentElement.classList.add("unfocused"); + + this._enableExpiry.onclick = () => { this.extendExpiry(true); }; + this._enableExpiryNotify.onchange = () => { + if (this._enableExpiryNotify.checked) { + this._enableExpiryReason.classList.remove("unfocused"); + } else { + this._enableExpiryReason.classList.add("unfocused"); + } + }; + + if (!window.usernameEnabled) { + this._addUserName.classList.add("unfocused"); + this._addUserName = this._addUserEmail; + } + + if (!window.linkResetEnabled) { + this._sendPWR.classList.add("unfocused"); } else { - this._searchOptionsHeader.classList.add("hidden"); + this._sendPWR.onclick = this.sendPWR; } + /*if (!window.emailEnabled) { + this._deleteNotify.parentElement.classList.add("unfocused"); + this._deleteNotify.checked = false; + }*/ + + this._announceTextarea.onkeyup = this.loadPreview; + addDiscord = newDiscordSearch(window.lang.strings("linkDiscord"), window.lang.strings("searchDiscordUser"), window.lang.strings("add"), (user: DiscordUser, id: string) => { + _post("/users/discord", {jf_id: id, discord_id: user.id}, (req: XMLHttpRequest) => { + if (req.readyState == 4) { + document.dispatchEvent(new CustomEvent("accounts-reload")); + if (req.status != 200) { + window.notifications.customError("errorConnectDiscord", window.lang.notif("errorFailureCheckLogs")); + return + } + window.notifications.customSuccess("discordConnected", window.lang.notif("accountConnected")); + window.modals.discord.close() + } + }); + }); + + this._announceSaveButton.onclick = this.saveAnnouncement; + const announceVarUsername = document.getElementById("announce-variables-username") as HTMLSpanElement; + announceVarUsername.onclick = () => { + insertText(this._announceTextarea, announceVarUsername.children[0].textContent); + this.loadPreview(); + }; + + const headerNames: string[] = ["username", "access-jfa", "email", "telegram", "matrix", "discord", "expiry", "last-active", "referrals"]; + const headerGetters: string[] = ["name", "accounts_admin", "email", "telegram", "matrix", "discord", "expiry", "last_active", "referrals_enabled"]; + for (let i = 0; i < headerNames.length; i++) { + const header: HTMLTableHeaderCellElement = document.querySelector(".accounts-header-" + headerNames[i]) as HTMLTableHeaderCellElement; + if (header !== null) { + this._columns[headerGetters[i]] = new Column(header, headerGetters[i], Object.getOwnPropertyDescriptor(user.prototype, headerGetters[i]).get); + } + } + + // Start off sorting by username (this._c.defaultSortField) + const defaultSort = () => { + document.dispatchEvent(new CustomEvent("header-click", { detail: this._c.defaultSortField })); + this._columns[this._c.defaultSortField].ascending = true; + this._columns[this._c.defaultSortField].hideIcon(); + this._sortingByButton.parentElement.classList.add("hidden"); + this._search.showHideSearchOptionsHeader(); + }; + + this._sortingByButton.parentElement.addEventListener("click", defaultSort); + + document.addEventListener("header-click", (event: CustomEvent) => { + this._search.setOrdering( + this._columns[event.detail].sort(this.users), + event.detail, + this._columns[event.detail].ascending + ); + this._sortingByButton.innerHTML = this._columns[event.detail].buttonContent; + this._sortingByButton.parentElement.classList.remove("hidden"); + // console.log("ordering by", event.detail, ": ", this._ordering); + if (this._search.inSearch) { + this._search.onSearchBoxChange(); + } else { + this.setVisibility(this._search.ordering, true); + this._c.notFoundPanel.classList.add("unfocused"); + } + this._search.showHideSearchOptionsHeader(); + }); + + defaultSort(); + this._search.showHideSearchOptionsHeader(); + + this._search.generateFilterList(); + + this.registerURLListener(); } - private _queries: { [field: string]: QueryType } = { - "id": { - // We don't use a translation here to circumvent the name substitution feature. - name: "Jellyfin/Emby ID", - getter: "id", - bool: false, - string: true, - date: false - }, - "label": { - name: window.lang.strings("label"), - getter: "label", - bool: true, - string: true, - date: false - }, - "username": { - name: window.lang.strings("username"), - getter: "name", - bool: false, - string: true, - date: false - }, - "name": { - name: window.lang.strings("username"), - getter: "name", - bool: false, - string: true, - date: false, - show: false - }, - "admin": { - name: window.lang.strings("admin"), - getter: "admin", - bool: true, - string: false, - date: false - }, - "disabled": { - name: window.lang.strings("disabled"), - getter: "disabled", - bool: true, - string: false, - date: false - }, - "access-jfa": { - name: window.lang.strings("accessJFA"), - getter: "accounts_admin", - bool: true, - string: false, - date: false, - dependsOnElement: ".accounts-header-access-jfa" - }, - "email": { - name: window.lang.strings("emailAddress"), - getter: "email", - bool: true, - string: true, - date: false, - dependsOnElement: ".accounts-header-email" - }, - "telegram": { - name: "Telegram", - getter: "telegram", - bool: true, - string: true, - date: false, - dependsOnElement: ".accounts-header-telegram" - }, - "matrix": { - name: "Matrix", - getter: "matrix", - bool: true, - string: true, - date: false, - dependsOnElement: ".accounts-header-matrix" - }, - "discord": { - name: "Discord", - getter: "discord", - bool: true, - string: true, - date: false, - dependsOnElement: ".accounts-header-discord" - }, - "expiry": { - name: window.lang.strings("expiry"), - getter: "expiry", - bool: true, - string: false, - date: true, - dependsOnElement: ".accounts-header-expiry" - }, - "last-active": { - name: window.lang.strings("lastActiveTime"), - getter: "last_active", - bool: true, - string: false, - date: true - }, - "referrals-enabled": { - name: window.lang.strings("referrals"), - getter: "referrals_enabled", - bool: true, - string: false, - date: false, - dependsOnElement: ".accounts-header-referrals" - } + reload = (callback?: () => void) => { + this._reload( + (req: XMLHttpRequest) => { + if (req.readyState != 4) return; + if (req.status != 200) return; + if (callback) callback(); + } + ); + this.loadTemplates(); } - private _notFoundPanel: HTMLElement = document.getElementById("accounts-not-found"); + loadMore = (callback?: () => void, loadAll: boolean = false) => { + this._loadMore( + loadAll, + (req: XMLHttpRequest) => { + if (req.readyState != 4) return; + if (req.status != 200) return; + if (callback) callback(); + } + ); + }; get selectAll(): boolean { return this._selectAll.checked; } set selectAll(state: boolean) { let count = 0; - for (let id in this._users) { - if (this._table.contains(this._users[id].asElement())) { // Only select visible elements - this._users[id].selected = state; + for (let id in this.users) { + if (this._table.contains(this.users[id].asElement())) { // Only select visible elements + this.users[id].selected = state; count++; } } this._selectAll.checked = state; this._selectAll.indeterminate = false; - state ? this._checkCount = count : 0; + state ? this._counter.selected = count : 0; } selectAllBetweenIDs = (startID: string, endID: string) => { let inRange = false; - for (let id of this._ordering) { + for (let id of this._search.ordering) { if (!(inRange || id == startID)) continue; inRange = true; - if (!(this._table.contains(this._users[id].asElement()))) continue; - this._users[id].selected = true; + if (!(this._table.contains(this.users[id].asElement()))) continue; + this.users[id].selected = true; if (id == endID) return; } } add = (u: User) => { let domAccount = new user(u); - this._users[u.id] = domAccount; + this.users[u.id] = domAccount; + // console.log("after appending lengths:", Object.keys(this.users).length, Object.keys(this._search.items).length); } private _checkCheckCount = () => { const list = this._collectUsers(); - this._checkCount = list.length; - if (this._checkCount == 0) { + this._counter.selected = list.length; + if (this._counter.selected == 0) { this._selectAll.indeterminate = false; this._selectAll.checked = false; this._modifySettings.classList.add("unfocused"); @@ -971,12 +1294,12 @@ export class accountsList { this._sendPWR.classList.add("unfocused"); } else { let visibleCount = 0; - for (let id in this._users) { - if (this._table.contains(this._users[id].asElement())) { + for (let id in this.users) { + if (this._table.contains(this.users[id].asElement())) { visibleCount++; } } - if (this._checkCount == visibleCount) { + if (this._counter.selected == visibleCount) { this._selectAll.checked = true; this._selectAll.indeterminate = false; } else { @@ -995,27 +1318,27 @@ export class accountsList { let anyNonExpiries = list.length == 0 ? true : false; let allNonExpiries = true; let noContactCount = 0; - let referralState = Number(this._users[list[0]].referrals_enabled); // -1 = hide, 0 = show "enable", 1 = show "disable" + let referralState = Number(this.users[list[0]].referrals_enabled); // -1 = hide, 0 = show "enable", 1 = show "disable" // Only show enable/disable button if all selected have the same state. - this._shouldEnable = this._users[list[0]].disabled + this._shouldEnable = this.users[list[0]].disabled let showDisableEnable = true; for (let id of list) { - if (!anyNonExpiries && !this._users[id].expiry) { + if (!anyNonExpiries && !this.users[id].expiry) { anyNonExpiries = true; this._expiryDropdown.classList.add("unfocused"); } - if (this._users[id].expiry) { + if (this.users[id].expiry) { allNonExpiries = false; } - if (showDisableEnable && this._users[id].disabled != this._shouldEnable) { + if (showDisableEnable && this.users[id].disabled != this._shouldEnable) { showDisableEnable = false; this._disableEnable.parentElement.classList.add("unfocused"); } if (!showDisableEnable && anyNonExpiries) { break; } - if (!this._users[id].lastNotifyMethod()) { + if (!this.users[id].lastNotifyMethod()) { noContactCount++; } - if (window.referralsEnabled && referralState != -1 && Number(this._users[id].referrals_enabled) != referralState) { + if (window.referralsEnabled && referralState != -1 && Number(this.users[id].referrals_enabled) != referralState) { referralState = -1; } } @@ -1074,8 +1397,8 @@ export class accountsList { private _collectUsers = (): string[] => { let list: string[] = []; - for (let id in this._users) { - if (this._table.contains(this._users[id].asElement()) && this._users[id].selected) { list.push(id); } + for (let id in this.users) { + if (this._table.contains(this.users[id].asElement()) && this.users[id].selected) { list.push(id); } } return list; } @@ -1382,7 +1705,7 @@ export class accountsList { let list = this._collectUsers(); let manualUser: user; for (let id of list) { - let user = this._users[id]; + let user = this.users[id]; if (!user.lastNotifyMethod() && !user.email) { manualUser = user; break; @@ -1448,8 +1771,8 @@ export class accountsList { (() => { let innerHTML = ""; - for (let id in this._users) { - innerHTML += ``; + for (let id in this.users) { + innerHTML += ``; } this._userSelect.innerHTML = innerHTML; })(); @@ -1513,7 +1836,7 @@ export class accountsList { let list = this._collectUsers(); // Check if we're disabling or enabling - if (this._users[list[0]].referrals_enabled) { + if (this.users[list[0]].referrals_enabled) { _delete("/users/referral", {"users": list}, (req: XMLHttpRequest) => { if (req.readyState != 4 || req.status != 200) return; window.notifications.customSuccess("disabledReferralsSuccess", window.lang.quantity("appliedSettings", list.length)); @@ -1632,8 +1955,8 @@ export class accountsList { let id = users.length > 0 ? users[0] : ""; if (!id) invalid = true; else { - date = new Date(this._users[id].expiry*1000); - if (this._users[id].expiry == 0) date = new Date(); + date = new Date(this.users[id].expiry*1000); + if (this.users[id].expiry == 0) date = new Date(); date.setMonth(date.getMonth() + (+fields[0].value)) date.setDate(date.getDate() + (+fields[1].value)); date.setHours(date.getHours() + (+fields[2].value)); @@ -1740,12 +2063,13 @@ export class accountsList { setVisibility = (users: string[], visible: boolean) => { + console.log(`setting ${users.length} users as visible: ${visible}`); this._table.textContent = ""; - for (let id of this._ordering) { + for (let id of this._search.ordering) { if (visible && users.indexOf(id) != -1) { - this._table.appendChild(this._users[id].asElement()); + this._table.appendChild(this.users[id].asElement()); } else if (!visible && users.indexOf(id) == -1) { - this._table.appendChild(this._users[id].asElement()); + this._table.appendChild(this.users[id].asElement()); } } } @@ -1761,9 +2085,9 @@ export class accountsList { focusAccount = (userID: string) => { console.log("focusing user", userID); - this._searchBox.value = `id:"${userID}"`; + this._c.searchBox.value = `id:"${userID}"`; this._search.onSearchBoxChange(); - if (userID in this._users) this._users[userID].focus(); + if (userID in this.users) this.users[userID].focus(); } public static readonly _accountURLEvent = "account-url"; @@ -1771,7 +2095,6 @@ export class accountsList { this.focusAccount(event.detail); }); - // FIXME: Use Query Param! so it doesn't get cleared by pages.ts. isAccountURL = () => { const urlParams = new URLSearchParams(window.location.search); const userID = urlParams.get("user"); @@ -1784,314 +2107,6 @@ export class accountsList { this.focusAccount(userID); } - constructor() { - this._populateNumbers(); - - this._counter = new RecordCounter(document.getElementById("accounts-record-counter")); - - this._users = {}; - this._selectAll.checked = false; - this._selectAll.onchange = () => { - this.selectAll = this._selectAll.checked; - }; - document.addEventListener("accounts-reload", () => this.reload()); - document.addEventListener("accountCheckEvent", () => { this._checkCount++; this._checkCheckCount(); }); - document.addEventListener("accountUncheckEvent", () => { this._checkCount--; this._checkCheckCount(); }); - this._addUserButton.onclick = () => { - this._populateAddUserProfiles(); - window.modals.addUser.toggle(); - }; - this._addUserForm.addEventListener("submit", this._addUser); - - this._deleteNotify.onchange = () => { - if (this._deleteNotify.checked) { - this._deleteReason.classList.remove("unfocused"); - } else { - this._deleteReason.classList.add("unfocused"); - } - }; - this._modifySettings.onclick = this.modifyUsers; - this._modifySettings.classList.add("unfocused"); - - if (window.ombiEnabled) - this._applyOmbi.parentElement.classList.remove("unfocused"); - else - this._applyOmbi.parentElement.classList.add("unfocused"); - if (window.jellyseerrEnabled) - this._applyJellyseerr.parentElement.classList.remove("unfocused"); - else - this._applyJellyseerr.parentElement.classList.add("unfocused"); - - const checkSource = () => { - const profileSpan = this._modifySettingsProfile.nextElementSibling as HTMLSpanElement; - const userSpan = this._modifySettingsUser.nextElementSibling as HTMLSpanElement; - if (this._modifySettingsProfile.checked) { - this._userSelect.parentElement.classList.add("unfocused"); - this._profileSelect.parentElement.classList.remove("unfocused") - profileSpan.classList.add("@high"); - profileSpan.classList.remove("@low"); - userSpan.classList.remove("@high"); - userSpan.classList.add("@low"); - this._applyOmbi.parentElement.classList.remove("unfocused"); - this._applyJellyseerr.parentElement.classList.remove("unfocused"); - } else { - this._userSelect.parentElement.classList.remove("unfocused"); - this._profileSelect.parentElement.classList.add("unfocused"); - userSpan.classList.add("@high"); - userSpan.classList.remove("@low"); - profileSpan.classList.remove("@high"); - profileSpan.classList.add("@low"); - this._applyOmbi.parentElement.classList.add("unfocused"); - this._applyJellyseerr.parentElement.classList.add("unfocused"); - } - }; - this._modifySettingsProfile.onchange = checkSource; - this._modifySettingsUser.onchange = checkSource; - - if (window.referralsEnabled) { - const profileSpan = this._enableReferralsProfile.nextElementSibling as HTMLSpanElement; - const inviteSpan = this._enableReferralsInvite.nextElementSibling as HTMLSpanElement; - const checkReferralSource = () => { - console.log("States:", this._enableReferralsProfile.checked, this._enableReferralsInvite.checked); - if (this._enableReferralsProfile.checked) { - this._referralsInviteSelect.parentElement.classList.add("unfocused"); - this._referralsProfileSelect.parentElement.classList.remove("unfocused") - profileSpan.classList.add("@high"); - profileSpan.classList.remove("@low"); - inviteSpan.classList.remove("@high"); - inviteSpan.classList.add("@low"); - } else { - this._referralsInviteSelect.parentElement.classList.remove("unfocused"); - this._referralsProfileSelect.parentElement.classList.add("unfocused"); - inviteSpan.classList.add("@high"); - inviteSpan.classList.remove("@low"); - profileSpan.classList.remove("@high"); - profileSpan.classList.add("@low"); - } - }; - profileSpan.onclick = () => { - this._enableReferralsProfile.checked = true; - this._enableReferralsInvite.checked = false; - checkReferralSource(); - }; - inviteSpan.onclick = () => {; - this._enableReferralsInvite.checked = true; - this._enableReferralsProfile.checked = false; - checkReferralSource(); - }; - this._enableReferrals.onclick = () => { - this.enableReferrals(); - profileSpan.onclick(null); - }; - } - - this._deleteUser.onclick = this.deleteUsers; - this._deleteUser.classList.add("unfocused"); - - this._announceButton.onclick = this.announce; - this._announceButton.parentElement.classList.add("unfocused"); - - this._extendExpiry.onclick = () => { this.extendExpiry(); }; - this._removeExpiry.onclick = () => { this.removeExpiry(); }; - this._expiryDropdown.classList.add("unfocused"); - this._extendExpiryDate.classList.add("unfocused"); - - this._extendExpiryTextInput.onkeyup = () => { - this._extendExpiryTextInput.parentElement.parentElement.classList.remove("opacity-60"); - this._extendExpiryFieldInputs.classList.add("opacity-60"); - this._usingExtendExpiryTextInput = true; - this._displayExpiryDate(); - } - - this._extendExpiryTextInput.onclick = () => { - this._extendExpiryTextInput.parentElement.parentElement.classList.remove("opacity-60"); - this._extendExpiryFieldInputs.classList.add("opacity-60"); - this._usingExtendExpiryTextInput = true; - this._displayExpiryDate(); - }; - - this._extendExpiryFieldInputs.onclick = () => { - this._extendExpiryFieldInputs.classList.remove("opacity-60"); - this._extendExpiryTextInput.parentElement.parentElement.classList.add("opacity-60"); - this._usingExtendExpiryTextInput = false; - this._displayExpiryDate(); - }; - - for (let field of ["months", "days", "hours", "minutes"]) { - (document.getElementById("extend-expiry-"+field) as HTMLSelectElement).onchange = () => { - this._extendExpiryFieldInputs.classList.remove("opacity-60"); - this._extendExpiryTextInput.parentElement.parentElement.classList.add("opacity-60"); - this._usingExtendExpiryTextInput = false; - this._displayExpiryDate(); - }; - } - - this._disableEnable.onclick = this.enableDisableUsers; - this._disableEnable.parentElement.classList.add("unfocused"); - - this._enableExpiry.onclick = () => { this.extendExpiry(true); }; - this._enableExpiryNotify.onchange = () => { - if (this._enableExpiryNotify.checked) { - this._enableExpiryReason.classList.remove("unfocused"); - } else { - this._enableExpiryReason.classList.add("unfocused"); - } - }; - - if (!window.usernameEnabled) { - this._addUserName.classList.add("unfocused"); - this._addUserName = this._addUserEmail; - } - - if (!window.linkResetEnabled) { - this._sendPWR.classList.add("unfocused"); - } else { - this._sendPWR.onclick = this.sendPWR; - } - /*if (!window.emailEnabled) { - this._deleteNotify.parentElement.classList.add("unfocused"); - this._deleteNotify.checked = false; - }*/ - - let conf: SearchConfiguration = { - filterArea: this._filterArea, - sortingByButton: this._sortingByButton, - searchOptionsHeader: this._searchOptionsHeader, - notFoundPanel: this._notFoundPanel, - filterList: document.getElementById("accounts-filter-list"), - search: this._searchBox, - queries: this._queries, - setVisibility: this.setVisibility, - clearSearchButtonSelector: ".accounts-search-clear", - onSearchCallback: (_0: number, _1: boolean, _2: boolean) => { - this._checkCheckCount(); - } - }; - this._search = new Search(conf); - this._search.items = this._users; - - - this._announceTextarea.onkeyup = this.loadPreview; - addDiscord = newDiscordSearch(window.lang.strings("linkDiscord"), window.lang.strings("searchDiscordUser"), window.lang.strings("add"), (user: DiscordUser, id: string) => { - _post("/users/discord", {jf_id: id, discord_id: user.id}, (req: XMLHttpRequest) => { - if (req.readyState == 4) { - document.dispatchEvent(new CustomEvent("accounts-reload")); - if (req.status != 200) { - window.notifications.customError("errorConnectDiscord", window.lang.notif("errorFailureCheckLogs")); - return - } - window.notifications.customSuccess("discordConnected", window.lang.notif("accountConnected")); - window.modals.discord.close() - } - }); - }); - - this._announceSaveButton.onclick = this.saveAnnouncement; - const announceVarUsername = document.getElementById("announce-variables-username") as HTMLSpanElement; - announceVarUsername.onclick = () => { - insertText(this._announceTextarea, announceVarUsername.children[0].textContent); - this.loadPreview(); - }; - - const headerNames: string[] = ["username", "access-jfa", "email", "telegram", "matrix", "discord", "expiry", "last-active", "referrals"]; - const headerGetters: string[] = ["name", "accounts_admin", "email", "telegram", "matrix", "discord", "expiry", "last_active", "referrals_enabled"]; - for (let i = 0; i < headerNames.length; i++) { - const header: HTMLTableHeaderCellElement = document.querySelector(".accounts-header-" + headerNames[i]) as HTMLTableHeaderCellElement; - if (header !== null) { - this._columns[header.className] = new Column(header, Object.getOwnPropertyDescriptor(user.prototype, headerGetters[i]).get); - } - } - - // Start off sorting by Name - const defaultSort = () => { - this._activeSortColumn = document.getElementsByClassName("accounts-header-" + headerNames[0])[0].className; - document.dispatchEvent(new CustomEvent("header-click", { detail: this._activeSortColumn })); - this._columns[this._activeSortColumn].ascending = true; - this._columns[this._activeSortColumn].hideIcon(); - this._sortingByButton.parentElement.classList.add("hidden"); - this.showHideSearchOptionsHeader(); - }; - - this._sortingByButton.parentElement.addEventListener("click", defaultSort); - - document.addEventListener("header-click", (event: CustomEvent) => { - this._ordering = this._columns[event.detail].sort(this._users); - this._search.ordering = this._ordering; - this._activeSortColumn = event.detail; - this._sortingByButton.innerHTML = this._columns[event.detail].buttonContent; - this._sortingByButton.parentElement.classList.remove("hidden"); - // console.log("ordering by", event.detail, ": ", this._ordering); - if (!(this._search.inSearch)) { - this.setVisibility(this._ordering, true); - this._notFoundPanel.classList.add("unfocused"); - } else { - const results = this._search.search(this._searchBox.value); - this.setVisibility(results, true); - if (results.length == 0) { - this._notFoundPanel.classList.remove("unfocused"); - } else { - this._notFoundPanel.classList.add("unfocused"); - } - } - this.showHideSearchOptionsHeader(); - }); - - defaultSort(); - this.showHideSearchOptionsHeader(); - - this._search.generateFilterList(); - - this.registerURLListener(); - } - - reload = (callback?: () => void) => { - this._counter.reset() - this._counter.getTotal("/users/count"); - - _get("/users", null, (req: XMLHttpRequest) => { - if (req.readyState == 4 && req.status == 200) { - let resp = req.response as UsersDTO; - // same method as inviteList.reload() - let accountsOnDOM: { [id: string]: boolean } = {}; - for (let id in this._users) { accountsOnDOM[id] = true; } - for (let u of resp.users) { - if (u.id in this._users) { - this._users[u.id].update(u); - delete accountsOnDOM[u.id]; - } else { - this.add(u); - } - } - for (let id in accountsOnDOM) { - this._users[id].remove(); - delete this._users[id]; - } - // console.log("reload, so sorting by", this._activeSortColumn); - this._ordering = this._columns[this._activeSortColumn].sort(this._users); - this._search.ordering = this._ordering; - - this._counter.loaded = this._ordering.length; - - if (this._search.inSearch) { - const results = this._search.search(this._searchBox.value); - if (results.length == 0) { - this._notFoundPanel.classList.remove("unfocused"); - } else { - this._notFoundPanel.classList.add("unfocused"); - } - this.setVisibility(results, true); - } else { - this._counter.shown = this._counter.loaded; - this.setVisibility(this._ordering, true); - this._notFoundPanel.classList.add("unfocused"); - } - this._checkCheckCount(); - - if (callback) callback(); - } - }); - this.loadTemplates(); - } } export const accountURLEvent = (id: string) => { return new CustomEvent(accountsList._accountURLEvent, {"detail": id}) }; @@ -2104,13 +2119,15 @@ type Getter = () => GetterReturnType; // Listen for broadcast event from others, check its not us by comparing the header className in the message, then hide the arrow icon class Column { private _header: HTMLTableHeaderCellElement; + private _name: string; private _headerContent: string; private _getter: Getter; private _ascending: boolean; private _active: boolean; - constructor(header: HTMLTableHeaderCellElement, getter: Getter) { + constructor(header: HTMLTableHeaderCellElement, name: string, getter: Getter) { this._header = header; + this._name = name; this._headerContent = this._header.textContent; this._getter = getter; this._ascending = true; @@ -2127,10 +2144,10 @@ class Column { this._active = true; this._header.setAttribute("aria-sort", this._headerContent); this.updateHeader(); - document.dispatchEvent(new CustomEvent("header-click", { detail: this._header.className })); + document.dispatchEvent(new CustomEvent("header-click", { detail: this._name })); }); document.addEventListener("header-click", (event: CustomEvent) => { - if (event.detail != this._header.className) { + if (event.detail != this._name) { this._active = false; this._header.removeAttribute("aria-sort"); this.hideIcon(); @@ -2160,15 +2177,17 @@ class Column { if (!this._active) return; this.updateHeader(); this._header.setAttribute("aria-sort", this._headerContent); - document.dispatchEvent(new CustomEvent("header-click", { detail: this._header.className })); + document.dispatchEvent(new CustomEvent("header-click", { detail: this._name })); } // Sorts the user list. previouslyActive is whether this column was previously sorted by, indicating that the direction should change. sort = (users: { [id: string]: user }): string[] => { let userIDs = Object.keys(users); userIDs.sort((a: string, b: string): number => { - const av: GetterReturnType = this._getter.call(users[a]); - const bv: GetterReturnType = this._getter.call(users[b]); + let av: GetterReturnType = this._getter.call(users[a]); + if (typeof av === "string") av = av.toLowerCase(); + let bv: GetterReturnType = this._getter.call(users[b]); + if (typeof bv === "string") bv = bv.toLowerCase(); if (av < bv) return this._ascending ? -1 : 1; if (av > bv) return this._ascending ? 1 : -1; return 0; diff --git a/ts/modules/activity.ts b/ts/modules/activity.ts index 59ed865..5780962 100644 --- a/ts/modules/activity.ts +++ b/ts/modules/activity.ts @@ -1,7 +1,8 @@ -import { _get, _post, _delete, toDateString, addLoader, removeLoader } from "../modules/common.js"; -import { Search, SearchConfiguration, QueryType, SearchableItem } from "../modules/search.js"; +import { _get, _post, _delete, toDateString } from "../modules/common.js"; +import { SearchConfiguration, QueryType, SearchableItem, SearchableItems } from "../modules/search.js"; import { accountURLEvent } from "../modules/accounts.js"; import { inviteURLEvent } from "../modules/invites.js"; +import { PaginatedList } from "./list.js"; declare var window: GlobalWindow; @@ -32,6 +33,123 @@ var activityTypeMoods = { "deleteInvite": -1 }; +// window.lang doesn't exist at page load, so I made this a function that's invoked by activityList. +const queries = (): { [field: string]: QueryType } => { return { + "id": { + name: window.lang.strings("activityID"), + getter: "id", + bool: false, + string: true, + date: false + }, + "title": { + name: window.lang.strings("title"), + getter: "title", + bool: false, + string: true, + date: false + }, + "user": { + name: window.lang.strings("usersMentioned"), + getter: "mentionedUsers", + bool: false, + string: true, + date: false + }, + "actor": { + name: window.lang.strings("actor"), + description: window.lang.strings("actorDescription"), + getter: "actor", + bool: false, + string: true, + date: false + }, + "referrer": { + name: window.lang.strings("referrer"), + getter: "referrer", + bool: true, + string: true, + date: false + }, + "date": { + name: window.lang.strings("date"), + getter: "date", + bool: false, + string: false, + date: true + }, + "account-creation": { + name: window.lang.strings("accountCreationFilter"), + getter: "accountCreation", + bool: true, + string: false, + date: false + }, + "account-deletion": { + name: window.lang.strings("accountDeletionFilter"), + getter: "accountDeletion", + bool: true, + string: false, + date: false + }, + "account-disabled": { + name: window.lang.strings("accountDisabledFilter"), + getter: "accountDisabled", + bool: true, + string: false, + date: false + }, + "account-enabled": { + name: window.lang.strings("accountEnabledFilter"), + getter: "accountEnabled", + bool: true, + string: false, + date: false + }, + "contact-linked": { + name: window.lang.strings("contactLinkedFilter"), + getter: "contactLinked", + bool: true, + string: false, + date: false + }, + "contact-unlinked": { + name: window.lang.strings("contactUnlinkedFilter"), + getter: "contactUnlinked", + bool: true, + string: false, + date: false + }, + "password-change": { + name: window.lang.strings("passwordChangeFilter"), + getter: "passwordChange", + bool: true, + string: false, + date: false + }, + "password-reset": { + name: window.lang.strings("passwordResetFilter"), + getter: "passwordReset", + bool: true, + string: false, + date: false + }, + "invite-created": { + name: window.lang.strings("inviteCreatedFilter"), + getter: "inviteCreated", + bool: true, + string: false, + date: false + }, + "invite-deleted": { + name: window.lang.strings("inviteDeletedFilter"), + getter: "inviteDeleted", + bool: true, + string: false, + date: false + } +}}; + // var moodColours = ["~warning", "~neutral", "~urge"]; export var activityReload = new CustomEvent("activity-reload"); @@ -346,369 +464,130 @@ export class Activity implements activity, SearchableItem { asElement = () => { return this._card; }; } -export class RecordCounter { - private _container: HTMLElement; - private _totalRecords: HTMLElement; - private _loadedRecords: HTMLElement; - private _shownRecords: HTMLElement; - private _total: number; - private _loaded: number; - private _shown: number; - constructor(container: HTMLElement) { - this._container = container; - this._container.innerHTML = ` - - - - `; - this._totalRecords = document.getElementsByClassName("records-total")[0] as HTMLElement; - this._loadedRecords = document.getElementsByClassName("records-loaded")[0] as HTMLElement; - this._shownRecords = document.getElementsByClassName("records-shown")[0] as HTMLElement; - this.total = 0; - this.loaded = 0; - this.shown = 0; - } - - reset() { - this.total = 0; - this.loaded = 0; - this.shown = 0; - } - - // Sets the total using a PageCountDTO-returning API endpoint. - getTotal(endpoint: string) { - _get(endpoint, null, (req: XMLHttpRequest) => { - if (req.readyState != 4 || req.status != 200) return; - this.total = req.response["count"] as number; - }); - } - - get total(): number { return this._total; } - set total(v: number) { - this._total = v; - this._totalRecords.textContent = window.lang.var("strings", "totalRecords", `${v}`); - } - - get loaded(): number { return this._loaded; } - set loaded(v: number) { - this._loaded = v; - this._loadedRecords.textContent = window.lang.var("strings", "loadedRecords", `${v}`); - } - - get shown(): number { return this._shown; } - set shown(v: number) { - this._shown = v; - this._shownRecords.textContent = window.lang.var("strings", "shownRecords", `${v}`); - } -} +interface ActivitiesReqDTO extends PaginatedReqDTO { + type: string[]; +}; interface ActivitiesDTO extends paginatedDTO { activities: activity[]; } -export class activityList { - private _activityList: HTMLElement; - private _activities: { [id: string]: Activity } = {}; - private _ordering: string[] = []; - private _filterArea = document.getElementById("activity-filter-area"); - private _searchOptionsHeader = document.getElementById("activity-search-options-header"); - private _sortingByButton = document.getElementById("activity-sort-by-field") as HTMLButtonElement; - private _notFoundPanel = document.getElementById("activity-not-found"); - private _searchBox = document.getElementById("activity-search") as HTMLInputElement; - private _sortDirection = document.getElementById("activity-sort-direction") as HTMLButtonElement; - private _loader = document.getElementById("activity-loader"); - private _loadMoreButton = document.getElementById("activity-load-more") as HTMLButtonElement; - private _loadAllButton = document.getElementById("activity-load-all") as HTMLButtonElement; - private _refreshButton = document.getElementById("activity-refresh") as HTMLButtonElement; - private _keepSearchingDescription = document.getElementById("activity-keep-searching-description"); - private _keepSearchingButton = document.getElementById("activity-keep-searching"); +export class activityList extends PaginatedList { + protected _activityList: HTMLElement; + // protected _sortingByButton = document.getElementById("activity-sort-by-field") as HTMLButtonElement; + protected _sortDirection = document.getElementById("activity-sort-direction") as HTMLButtonElement; - private _counter: RecordCounter; + protected _ascending: boolean; + + get activities(): { [id: string]: Activity } { return this._search.items as { [id: string]: Activity }; } + // set activities(v: { [id: string]: Activity }) { this._search.items = v as SearchableItems; } + + constructor() { + super({ + loader: document.getElementById("activity-loader"), + loadMoreButton: document.getElementById("activity-load-more") as HTMLButtonElement, + loadAllButton: document.getElementById("activity-load-all") as HTMLButtonElement, + refreshButton: document.getElementById("activity-refresh") as HTMLButtonElement, + keepSearchingDescription: document.getElementById("activity-keep-searching-description"), + keepSearchingButton: document.getElementById("activity-keep-searching"), + filterArea: document.getElementById("activity-filter-area"), + searchOptionsHeader: document.getElementById("activity-search-options-header"), + searchBox: document.getElementById("activity-search") as HTMLInputElement, + notFoundPanel: document.getElementById("activity-not-found"), + recordCounter: document.getElementById("activity-record-counter"), + totalEndpoint: "/activity/count", + getPageEndpoint: "/activity", + limit: 10, + newElementsFromPage: (resp: paginatedDTO) => { + let ordering: string[] = this._search.ordering; + for (let act of ((resp as ActivitiesDTO).activities || [])) { + this.activities[act.id] = new Activity(act); + ordering.push(act.id); + } + }, + updateExistingElementsFromPage: (resp: paginatedDTO) => { + // FIXME: Implement updates to existing elements! + for (let id of Object.keys(this.activities)) { + delete this.activities[id]; + } + this._search.setOrdering([], this._c.defaultSortField, this.ascending); + this._c.newElementsFromPage(resp); + }, + defaultSortField: "time", + pageLoadCallback: (req: XMLHttpRequest) => { + if (req.readyState != 4) return; + if (req.status != 200) { + window.notifications.customError("loadActivitiesError", window.lang.notif("errorLoadActivities")); + return; + } + } + }); - private _search: Search; - private _ascending: boolean; - private _hasLoaded: boolean; - private _lastLoad: number; - private _page: number = 0; - private _lastPage: boolean; + this._activityList = document.getElementById("activity-card-list") + document.addEventListener("activity-reload", this.reload); + let searchConfig: SearchConfiguration = { + filterArea: this._c.filterArea, + // Exclude this: We only sort by date, and don't want to show a redundant header indicating so. + // sortingByButton: this._sortingByButton, + searchOptionsHeader: this._c.searchOptionsHeader, + notFoundPanel: this._c.notFoundPanel, + search: this._c.searchBox, + clearSearchButtonSelector: ".activity-search-clear", + serverSearchButtonSelector: ".activity-search-server", + queries: queries(), + setVisibility: this.setVisibility, + filterList: document.getElementById("activity-filter-list"), + // notFoundCallback: this._notFoundCallback, + onSearchCallback: null, + searchServer: null, + clearServerSearch: null, + } + + this.initSearch(searchConfig); + + this.ascending = false; + this._sortDirection.addEventListener("click", () => this.ascending = !this.ascending); + } setVisibility = (activities: string[], visible: boolean) => { this._activityList.textContent = ``; - for (let id of this._ordering) { + for (let id of this._search.ordering) { if (visible && activities.indexOf(id) != -1) { - this._activityList.appendChild(this._activities[id].asElement()); + this._activityList.appendChild(this.activities[id].asElement()); } else if (!visible && activities.indexOf(id) == -1) { - this._activityList.appendChild(this._activities[id].asElement()); + this._activityList.appendChild(this.activities[id].asElement()); } } } reload = () => { - this._lastLoad = Date.now(); - this._lastPage = false; - this._loadMoreButton.textContent = window.lang.strings("loadMore"); - this._loadMoreButton.disabled = false; - this._loadAllButton.classList.remove("unfocused"); - this._loadAllButton.disabled = false; - - this._counter.reset(); - this._counter.getTotal("/activity/count"); - - // this._page = 0; - let limit = 10; - if (this._page != 0) { - limit *= this._page+1; - }; - - let send = { - "type": [], - "limit": limit, - "page": 0, - "ascending": this.ascending - } - - - _post("/activity", send, (req: XMLHttpRequest) => { - if (req.readyState != 4) return; - if (req.status != 200) { - window.notifications.customError("loadActivitiesError", window.lang.notif("errorLoadActivities")); - return; - } - - this._hasLoaded = true; - // Allow refreshes every 15s - this._refreshButton.disabled = true; - setTimeout(() => this._refreshButton.disabled = false, 15000); - - let resp = req.response as ActivitiesDTO; - // FIXME: Don't destroy everything each reload! - this._activities = {}; - this._ordering = []; - - for (let act of resp.activities) { - this._activities[act.id] = new Activity(act); - this._ordering.push(act.id); - } - this._search.items = this._activities; - this._search.ordering = this._ordering; - - this._counter.loaded = this._ordering.length; - - if (this._search.inSearch) { - this._search.onSearchBoxChange(true); - this._loadAllButton.classList.remove("unfocused"); - } else { - this._counter.shown = this._counter.loaded; - this.setVisibility(this._ordering, true); - this._loadAllButton.classList.add("unfocused"); - this._notFoundPanel.classList.add("unfocused"); - } - }, true); + this._reload(); } loadMore = (callback?: () => void, loadAll: boolean = false) => { - this._lastLoad = Date.now(); - this._loadMoreButton.disabled = true; - // this._loadAllButton.disabled = true; - const timeout = setTimeout(() => { - this._loadMoreButton.disabled = false; - // this._loadAllButton.disabled = false; - }, 1000); - this._page += 1; - - let send = { - "type": [], - "limit": 10, - "page": this._page, - "ascending": this._ascending - }; - - // this._activityList.classList.add("unfocused"); - // addLoader(this._loader, false, true); - - _post("/activity", send, (req: XMLHttpRequest) => { - if (req.readyState != 4) return; - if (req.status != 200) { - window.notifications.customError("loadActivitiesError", window.lang.notif("errorLoadActivities")); - return; + this._loadMore( + loadAll, + (req: XMLHttpRequest) => { + if (req.readyState != 4) return; + if (req.status != 200) return; + if (callback) callback(); } - - let resp = req.response as ActivitiesDTO; - - this._lastPage = resp.last_page; - if (this._lastPage) { - clearTimeout(timeout); - this._loadMoreButton.disabled = true; - removeLoader(this._loadAllButton); - this._loadAllButton.classList.add("unfocused"); - this._loadMoreButton.textContent = window.lang.strings("noMoreResults"); - } - - for (let act of resp.activities) { - this._activities[act.id] = new Activity(act); - this._ordering.push(act.id); - } - // this._search.items = this._activities; - // this._search.ordering = this._ordering; - - this._counter.loaded = this._ordering.length; - - if (this._search.inSearch || loadAll) { - if (this._lastPage) { - loadAll = false; - } - this._search.onSearchBoxChange(true, loadAll); - } else { - this.setVisibility(this._ordering, true); - this._notFoundPanel.classList.add("unfocused"); - } - - if (callback) callback(); - // removeLoader(this._loader); - // this._activityList.classList.remove("unfocused"); - }, true); + ); } - private _queries: { [field: string]: QueryType } = { - "id": { - name: window.lang.strings("activityID"), - getter: "id", - bool: false, - string: true, - date: false - }, - "title": { - name: window.lang.strings("title"), - getter: "title", - bool: false, - string: true, - date: false - }, - "user": { - name: window.lang.strings("usersMentioned"), - getter: "mentionedUsers", - bool: false, - string: true, - date: false - }, - "actor": { - name: window.lang.strings("actor"), - description: window.lang.strings("actorDescription"), - getter: "actor", - bool: false, - string: true, - date: false - }, - "referrer": { - name: window.lang.strings("referrer"), - getter: "referrer", - bool: true, - string: true, - date: false - }, - "date": { - name: window.lang.strings("date"), - getter: "date", - bool: false, - string: false, - date: true - }, - "account-creation": { - name: window.lang.strings("accountCreationFilter"), - getter: "accountCreation", - bool: true, - string: false, - date: false - }, - "account-deletion": { - name: window.lang.strings("accountDeletionFilter"), - getter: "accountDeletion", - bool: true, - string: false, - date: false - }, - "account-disabled": { - name: window.lang.strings("accountDisabledFilter"), - getter: "accountDisabled", - bool: true, - string: false, - date: false - }, - "account-enabled": { - name: window.lang.strings("accountEnabledFilter"), - getter: "accountEnabled", - bool: true, - string: false, - date: false - }, - "contact-linked": { - name: window.lang.strings("contactLinkedFilter"), - getter: "contactLinked", - bool: true, - string: false, - date: false - }, - "contact-unlinked": { - name: window.lang.strings("contactUnlinkedFilter"), - getter: "contactUnlinked", - bool: true, - string: false, - date: false - }, - "password-change": { - name: window.lang.strings("passwordChangeFilter"), - getter: "passwordChange", - bool: true, - string: false, - date: false - }, - "password-reset": { - name: window.lang.strings("passwordResetFilter"), - getter: "passwordReset", - bool: true, - string: false, - date: false - }, - "invite-created": { - name: window.lang.strings("inviteCreatedFilter"), - getter: "inviteCreated", - bool: true, - string: false, - date: false - }, - "invite-deleted": { - name: window.lang.strings("inviteDeletedFilter"), - getter: "inviteDeleted", - bool: true, - string: false, - date: false - } - }; - get ascending(): boolean { return this._ascending; } set ascending(v: boolean) { this._ascending = v; this._sortDirection.innerHTML = `${window.lang.strings("sortDirection")} `; + // FIXME?: We don't actually re-sort the list here, instead just use setOrdering to apply this.ascending before a reload. + this._search.setOrdering(this._search.ordering, this._c.defaultSortField, this.ascending); if (this._hasLoaded) { this.reload(); } } - detectScroll = () => { - if (!this._hasLoaded) return; - // console.log(window.innerHeight + document.documentElement.scrollTop, document.scrollingElement.scrollHeight); - if (Math.abs(window.innerHeight + document.documentElement.scrollTop - document.scrollingElement.scrollHeight) < 50) { - // window.notifications.customSuccess("scroll", "Reached bottom."); - // Wait .5s between loads - if (this._lastLoad + 500 > Date.now()) return; - this.loadMore(); - } - } - - private _prevResultCount = 0; - - private _notFoundCallback = (notFound: boolean) => { + /*private _notFoundCallback = (notFound: boolean) => { if (notFound) this._loadMoreButton.classList.add("unfocused"); else this._loadMoreButton.classList.remove("unfocused"); @@ -719,55 +598,6 @@ export class activityList { this._keepSearchingButton.classList.add("unfocused"); this._keepSearchingDescription.classList.add("unfocused"); } - }; + };*/ - constructor() { - this._activityList = document.getElementById("activity-card-list"); - document.addEventListener("activity-reload", this.reload); - - this._counter = new RecordCounter(document.getElementById("activity-record-counter")); - - let conf: SearchConfiguration = { - filterArea: this._filterArea, - sortingByButton: this._sortingByButton, - searchOptionsHeader: this._searchOptionsHeader, - notFoundPanel: this._notFoundPanel, - search: this._searchBox, - clearSearchButtonSelector: ".activity-search-clear", - queries: this._queries, - setVisibility: this.setVisibility, - filterList: document.getElementById("activity-filter-list"), - // notFoundCallback: this._notFoundCallback, - onSearchCallback: (visibleCount: number, newItems: boolean, loadAll: boolean) => { - this._counter.shown = visibleCount; - - if (this._search.inSearch && !this._lastPage) this._loadAllButton.classList.remove("unfocused"); - else this._loadAllButton.classList.add("unfocused"); - - if (visibleCount < 10 || loadAll) { - if (!newItems || this._prevResultCount != visibleCount || (visibleCount == 0 && !this._lastPage) || loadAll) this.loadMore(() => {}, loadAll); - } - this._prevResultCount = visibleCount; - } - } - this._search = new Search(conf); - this._search.generateFilterList(); - - this._hasLoaded = false; - this.ascending = false; - this._sortDirection.addEventListener("click", () => this.ascending = !this.ascending); - - this._loadMoreButton.onclick = () => this.loadMore(); - this._loadAllButton.onclick = () => { - addLoader(this._loadAllButton, true); - this.loadMore(() => {}, true); - }; - /* this._keepSearchingButton.onclick = () => { - addLoader(this._keepSearchingButton, true); - this.loadMore(() => removeLoader(this._keepSearchingButton, true)); - }; */ - this._refreshButton.onclick = this.reload; - - window.onscroll = this.detectScroll; - } } diff --git a/ts/modules/list.ts b/ts/modules/list.ts new file mode 100644 index 0000000..0978317 --- /dev/null +++ b/ts/modules/list.ts @@ -0,0 +1,328 @@ +import { _get, _post, addLoader, removeLoader } from "./common"; +import { Search, SearchConfiguration, SearchableItems } from "./search"; + +declare var window: GlobalWindow; + +export class RecordCounter { + private _container: HTMLElement; + private _totalRecords: HTMLElement; + private _loadedRecords: HTMLElement; + private _shownRecords: HTMLElement; + private _selectedRecords: HTMLElement; + private _total: number; + private _loaded: number; + private _shown: number; + private _selected: number; + constructor(container: HTMLElement) { + this._container = container; + this._container.innerHTML = ` + + + + + `; + this._totalRecords = document.getElementsByClassName("records-total")[0] as HTMLElement; + this._loadedRecords = document.getElementsByClassName("records-loaded")[0] as HTMLElement; + this._shownRecords = document.getElementsByClassName("records-shown")[0] as HTMLElement; + this._selectedRecords = document.getElementsByClassName("records-selected")[0] as HTMLElement; + this.total = 0; + this.loaded = 0; + this.shown = 0; + } + + reset() { + this.total = 0; + this.loaded = 0; + this.shown = 0; + this.selected = 0; + } + + // Sets the total using a PageCountDTO-returning API endpoint. + getTotal(endpoint: string) { + _get(endpoint, null, (req: XMLHttpRequest) => { + if (req.readyState != 4 || req.status != 200) return; + this.total = req.response["count"] as number; + }); + } + + get total(): number { return this._total; } + set total(v: number) { + this._total = v; + this._totalRecords.textContent = window.lang.var("strings", "totalRecords", `${v}`); + } + + get loaded(): number { return this._loaded; } + set loaded(v: number) { + this._loaded = v; + this._loadedRecords.textContent = window.lang.var("strings", "loadedRecords", `${v}`); + } + + get shown(): number { return this._shown; } + set shown(v: number) { + this._shown = v; + this._shownRecords.textContent = window.lang.var("strings", "shownRecords", `${v}`); + } + + get selected(): number { return this._selected; } + set selected(v: number) { + this._selected = v; + if (v == 0) this._selectedRecords.textContent = ``; + else this._selectedRecords.textContent = window.lang.var("strings", "selectedRecords", `${v}`); + } +} + +export interface PaginatedListConfig { + loader: HTMLElement; + loadMoreButton: HTMLButtonElement; + loadAllButton: HTMLButtonElement; + refreshButton: HTMLButtonElement; + keepSearchingDescription: HTMLElement; + keepSearchingButton: HTMLElement; + notFoundPanel: HTMLElement; + filterArea: HTMLElement; + searchOptionsHeader: HTMLElement; + searchBox: HTMLInputElement; + recordCounter: HTMLElement; + totalEndpoint: string; + getPageEndpoint: string; + limit: number; + newElementsFromPage: (resp: paginatedDTO) => void; + updateExistingElementsFromPage: (resp: paginatedDTO) => void; + defaultSortField: string; + pageLoadCallback?: (req: XMLHttpRequest) => void; +} + +export abstract class PaginatedList { + protected _c: PaginatedListConfig; + + protected _search: Search; + + protected _counter: RecordCounter; + + protected _hasLoaded: boolean; + protected _lastLoad: number; + protected _page: number = 0; + protected _lastPage: boolean; + get lastPage(): boolean { return this._lastPage }; + set lastPage(v: boolean) { + this._lastPage = v; + if (v) { + this._c.loadAllButton.classList.add("unfocused"); + this._c.loadMoreButton.textContent = window.lang.strings("noMoreResults"); + this._c.loadMoreButton.disabled = true; + } else { + this._c.loadMoreButton.textContent = window.lang.strings("loadMore"); + this._c.loadMoreButton.disabled = false; + if (this._search.inSearch) { + this._c.loadAllButton.classList.remove("unfocused"); + } + } + } + + protected _previousPageSize = 0; + + // Stores a PaginatedReqDTO-implementing thing. + // A standard PaginatedReqDTO will be overridden entirely, + // but a ServerSearchDTO will keep it's fields. + protected _searchParams: PaginatedReqDTO; + defaultParams = (): PaginatedReqDTO => { + return { + limit: 0, + page: 0, + sortByField: "", + ascending: false + }; + } + + constructor(c: PaginatedListConfig) { + this._c = c; + this._counter = new RecordCounter(this._c.recordCounter); + this._hasLoaded = false; + + this._c.loadMoreButton.onclick = () => this.loadMore(null, false); + this._c.loadAllButton.onclick = () => { + addLoader(this._c.loadAllButton, true); + this.loadMore(null, true); + }; + /* this._keepSearchingButton.onclick = () => { + addLoader(this._keepSearchingButton, true); + this.loadMore(() => removeLoader(this._keepSearchingButton, true)); + }; */ + // Since this.reload doesn't exist, we need an arrow function to wrap it. + // FIXME: Make sure it works though! + this._c.refreshButton.onclick = () => this.reload(); + } + + initSearch = (searchConfig: SearchConfiguration) => { + const previousCallback = searchConfig.onSearchCallback; + searchConfig.onSearchCallback = (visibleCount: number, newItems: boolean, loadAll: boolean) => { + this._counter.shown = visibleCount; + + // if (this._search.inSearch && !this.lastPage) this._c.loadAllButton.classList.remove("unfocused"); + // else this._c.loadAllButton.classList.add("unfocused"); + + // FIXME: Figure out why this makes sense and make it clearer. + if ((visibleCount < this._c.limit && !this.lastPage) || loadAll) { + if (!newItems || + this._previousPageSize != visibleCount || + (visibleCount == 0 && !this.lastPage) || + loadAll + ) { + this.loadMore(() => {}, loadAll); + } + } + this._previousPageSize = visibleCount; + if (previousCallback) previousCallback(visibleCount, newItems, loadAll); + }; + const previousServerSearch = searchConfig.searchServer; + searchConfig.searchServer = (params: PaginatedReqDTO, newSearch: boolean) => { + this._searchParams = params; + if (newSearch) this.reload(); + else this.loadMore(null, false); + + if (previousServerSearch) previousServerSearch(params, newSearch); + }; + searchConfig.clearServerSearch = () => { + this._page = 0; + this.reload(); + } + this._search = new Search(searchConfig); + this._search.generateFilterList(); + this.lastPage = false; + }; + + // Sets the elements with "name"s in "elements" as visible or not. + public abstract setVisibility: (elements: string[], visible: boolean) => void; + + // Removes all elements, and reloads the first page. + public abstract reload: () => void; + protected _reload = ( + callback?: (req: XMLHttpRequest) => void + ) => { + this._lastLoad = Date.now(); + this.lastPage = false; + + this._counter.reset(); + this._counter.getTotal(this._c.totalEndpoint); + + // Reload all currently visible elements, i.e. Load a new page of size (limit*(page+1)). + let limit = this._c.limit; + if (this._page != 0) { + limit *= this._page+1; + } + + let params = this._search.inServerSearch ? this._searchParams : this.defaultParams(); + params.limit = limit; + params.page = 0; + if (params.sortByField == "") { + params.sortByField = this._c.defaultSortField; + params.ascending = true; + } + + _post(this._c.getPageEndpoint, params, (req: XMLHttpRequest) => { + if (req.readyState != 4) return; + if (req.status != 200) { + if (this._c.pageLoadCallback) this._c.pageLoadCallback(req); + if (callback) callback(req); + return; + } + + this._hasLoaded = true; + // Allow refreshes every 15s + this._c.refreshButton.disabled = true; + setTimeout(() => this._c.refreshButton.disabled = false, 15000); + + let resp = req.response as paginatedDTO; + + this.lastPage = resp.last_page; + + this._c.updateExistingElementsFromPage(resp); + + this._counter.loaded = this._search.ordering.length; + + this._search.onSearchBoxChange(true); + if (this._search.inSearch) { + // this._c.loadAllButton.classList.remove("unfocused"); + } else { + this._counter.shown = this._counter.loaded; + this.setVisibility(this._search.ordering, true); + this._c.loadAllButton.classList.add("unfocused"); + this._c.notFoundPanel.classList.add("unfocused"); + } + if (this._c.pageLoadCallback) this._c.pageLoadCallback(req); + if (callback) callback(req); + }, true); + } + + // Loads the next page. If "loadAll", all pages will be loaded until the last is reached. + public abstract loadMore: (callback: () => void, loadAll: boolean) => void; + protected _loadMore = ( + loadAll: boolean = false, + callback?: (req: XMLHttpRequest) => void + ) => { + this._lastLoad = Date.now(); + this._c.loadMoreButton.disabled = true; + const timeout = setTimeout(() => { + this._c.loadMoreButton.disabled = false; + }, 1000); + this._page += 1; + + let params = this._search.inServerSearch ? this._searchParams : this.defaultParams(); + params.limit = this._c.limit; + params.page = this._page; + if (params.sortByField == "") { + params.sortByField = this._c.defaultSortField; + params.ascending = true; + } + + _post(this._c.getPageEndpoint, params, (req: XMLHttpRequest) => { + if (req.readyState != 4) return; + if (req.status != 200) { + if (this._c.pageLoadCallback) this._c.pageLoadCallback(req); + if (callback) callback(req); + return; + } + + let resp = req.response as paginatedDTO; + + // Check before setting this.lastPage so we have a chance to cancel the timeout. + if (resp.last_page) { + clearTimeout(timeout); + removeLoader(this._c.loadAllButton); + } + + this.lastPage = resp.last_page; + + this._c.newElementsFromPage(resp); + + this._counter.loaded = this._search.ordering.length; + + if (this._search.inSearch || loadAll) { + if (this.lastPage) { + loadAll = false; + } + this._search.onSearchBoxChange(true, loadAll); + } else { + this.setVisibility(this._search.ordering, true); + this._c.notFoundPanel.classList.add("unfocused"); + } + if (this._c.pageLoadCallback) this._c.pageLoadCallback(req); + if (callback) callback(req); + }, true) + } + + // Should be assigned to window.onscroll whenever the list is in view. + detectScroll = () => { + if (!this._hasLoaded || this.lastPage) return; + // console.log(window.innerHeight + document.documentElement.scrollTop, document.scrollingElement.scrollHeight); + if (Math.abs(window.innerHeight + document.documentElement.scrollTop - document.scrollingElement.scrollHeight) < 50) { + // window.notifications.customSuccess("scroll", "Reached bottom."); + // Wait .5s between loads + if (this._lastLoad + 500 > Date.now()) return; + this.loadMore(null, false); + } + } + +} + + diff --git a/ts/modules/search.ts b/ts/modules/search.ts index a0a446a..e93b653 100644 --- a/ts/modules/search.ts +++ b/ts/modules/search.ts @@ -32,29 +32,49 @@ export interface QueryType { export interface SearchConfiguration { filterArea: HTMLElement; - sortingByButton: HTMLButtonElement; + sortingByButton?: HTMLButtonElement; searchOptionsHeader: HTMLElement; notFoundPanel: HTMLElement; notFoundCallback?: (notFound: boolean) => void; filterList: HTMLElement; clearSearchButtonSelector: string; + serverSearchButtonSelector: string; search: HTMLInputElement; queries: { [field: string]: QueryType }; setVisibility: (items: string[], visible: boolean) => void; onSearchCallback: (visibleCount: number, newItems: boolean, loadAll: boolean) => void; + searchServer: (params: PaginatedReqDTO, newSearch: boolean) => void; + clearServerSearch: () => void; loadMore?: () => void; } +export interface ServerSearchReqDTO extends PaginatedReqDTO { + searchTerms: string[]; + queries: QueryDTO[]; +} + +// FIXME: Generate ServerSearchReqDTO using Query.asDTO methods in serverSearch()! + +export interface QueryDTO { + class: "bool" | "string" | "date"; + // QueryType.getter + field: string; + operator: QueryOperator; + value: boolean | string | DateAttempt; +}; + export abstract class Query { protected _subject: QueryType; protected _operator: QueryOperator; protected _card: HTMLElement; - constructor(subject: QueryType, operator: QueryOperator) { + constructor(subject: QueryType | null, operator: QueryOperator) { this._subject = subject; this._operator = operator; - this._card = document.createElement("span"); - this._card.ariaLabel = window.lang.strings("clickToRemoveFilter"); + if (subject != null) { + this._card = document.createElement("span"); + this._card.ariaLabel = window.lang.strings("clickToRemoveFilter"); + } } set onclick(v: () => void) { @@ -62,8 +82,16 @@ export abstract class Query { } asElement(): HTMLElement { return this._card; } -} + + public abstract compare(subjectValue: any): boolean; + asDTO(): QueryDTO { + let out = {} as QueryDTO; + out.field = this._subject.getter; + out.operator = this._operator; + return out; + } +} export class BoolQuery extends Query { protected _value: boolean; @@ -96,13 +124,20 @@ export class BoolQuery extends Query { public compare(subjectBool: boolean): boolean { return ((subjectBool && this._value) || (!subjectBool && !this._value)) } + + asDTO(): QueryDTO { + let out = super.asDTO(); + out.class = "bool"; + out.value = this._value; + return out; + } } export class StringQuery extends Query { protected _value: string; constructor(subject: QueryType, value: string) { super(subject, QueryOperator.Equal); - this._value = value; + this._value = value.toLowerCase(); this._card.classList.add("button", "~neutral", "@low", "center", "mx-2", "h-full"); this._card.innerHTML = ` ${subject.name}: "${this._value}" @@ -110,6 +145,17 @@ export class StringQuery extends Query { } get value(): string { return this._value; } + + public compare(subjectString: string): boolean { + return subjectString.toLowerCase().includes(this._value); + } + + asDTO(): QueryDTO { + let out = super.asDTO(); + out.class = "string"; + out.value = this._value; + return out; + } } export interface DateAttempt { @@ -151,7 +197,6 @@ export class DateQuery extends Query { constructor(subject: QueryType, operator: QueryOperator, value: ParsedDate) { super(subject, operator); this._value = value; - console.log("op:", operator, "date:", value); this._card.classList.add("button", "~neutral", "@low", "center", "m-2", "h-full"); let dateText = QueryOperatorToDateText(operator); this._card.innerHTML = ` @@ -204,30 +249,58 @@ export class DateQuery extends Query { } return subjectDate > temp; } + + asDTO(): QueryDTO { + let out = super.asDTO(); + out.class = "date"; + out.value = this._value.attempt; + return out; + } } - -// FIXME: Continue taking stuff from search function, making XQuery classes! - - - export interface SearchableItem { matchesSearch: (query: string) => boolean; } +export type SearchableItems = { [id: string]: SearchableItem }; + export class Search { private _c: SearchConfiguration; + private _sortField: string = ""; + private _ascending: boolean = true; private _ordering: string[] = []; - private _items: { [id: string]: SearchableItem }; - inSearch: boolean; + private _items: SearchableItems = {}; + // Search queries (filters) + private _queries: Query[] = []; + // Plain-text search terms + private _searchTerms: string[] = []; + inSearch: boolean = false; + private _inServerSearch: boolean = false; + get inServerSearch(): boolean { return this._inServerSearch; } + set inServerSearch(v: boolean) { + this._inServerSearch = v; + if (!v) { + this._c.clearServerSearch(); + } + } + private _serverSearchButtons: HTMLElement[]; + + // Returns a list of identifiers (keys in items, values in ordering). search = (query: String): string[] => { this._c.filterArea.textContent = ""; query = query.toLowerCase(); let result: string[] = [...this._ordering]; + // If we're in a server search already, the results are already correct. + if (this.inServerSearch) return result; + + let words: string[] = []; + let queries = []; + let searchTerms = []; + let quoteSymbol = ``; let queryStart = -1; @@ -258,7 +331,6 @@ export class Search { } } words.push(query.substring(queryStart, end).replace(/['"]/g, "")); - console.log("pushed", words); queryStart = -1; } } @@ -266,28 +338,31 @@ export class Search { query = ""; for (let word of words) { + // 1. Normal search text, no filters or anything if (!word.includes(":")) { + searchTerms.push(word); let cachedResult = [...result]; for (let id of cachedResult) { - const u = this._items[id]; + const u = this.items[id]; if (!u.matchesSearch(word)) { result.splice(result.indexOf(id), 1); } } continue; } + // 2. A filter query of some sort. const split = [word.substring(0, word.indexOf(":")), word.substring(word.indexOf(":")+1)]; if (!(split[0] in this._c.queries)) continue; const queryFormat = this._c.queries[split[0]]; - let formattedQuery = [] + let q: Query | null = null; if (queryFormat.bool) { let [boolState, isBool] = BoolQuery.paramsFromString(split[1]); if (isBool) { - let q = new BoolQuery(queryFormat, boolState); + q = new BoolQuery(queryFormat, boolState); q.onclick = () => { for (let quote of [`"`, `'`, ``]) { this._c.search.value = this._c.search.value.replace(split[0] + ":" + quote + split[1] + quote, ""); @@ -297,24 +372,21 @@ export class Search { this._c.filterArea.appendChild(q.asElement()); - // console.log("is bool, state", boolState); // So removing elements doesn't affect us let cachedResult = [...result]; for (let id of cachedResult) { - const u = this._items[id]; + const u = this.items[id]; const value = Object.getOwnPropertyDescriptor(Object.getPrototypeOf(u), queryFormat.getter).get.call(u); - // console.log("got", queryFormat.getter + ":", value); // Remove from result if not matching query if (!q.compare(value)) { // console.log("not matching, result is", result); result.splice(result.indexOf(id), 1); + } else { } } - continue } - } - if (queryFormat.string) { - const q = new StringQuery(queryFormat, split[1]); + } else if (queryFormat.string) { + q = new StringQuery(queryFormat, split[1]); q.onclick = () => { for (let quote of [`"`, `'`, ``]) { @@ -328,18 +400,16 @@ export class Search { let cachedResult = [...result]; for (let id of cachedResult) { - const u = this._items[id]; + const u = this.items[id]; const value = Object.getOwnPropertyDescriptor(Object.getPrototypeOf(u), queryFormat.getter).get.call(u).toLowerCase(); - if (!(value.includes(split[1]))) { + if (!q.compare(value)) { result.splice(result.indexOf(id), 1); } } - continue; - } - if (queryFormat.date) { + } else if (queryFormat.date) { let [parsedDate, op, isDate] = DateQuery.paramsFromString(split[1]); if (!isDate) continue; - const q = new DateQuery(queryFormat, op, parsedDate); + q = new DateQuery(queryFormat, op, parsedDate); q.onclick = () => { for (let quote of [`"`, `'`, ``]) { @@ -354,7 +424,7 @@ export class Search { let cachedResult = [...result]; for (let id of cachedResult) { - const u = this._items[id]; + const u = this.items[id]; const unixValue = Object.getOwnPropertyDescriptor(Object.getPrototypeOf(u), queryFormat.getter).get.call(u); if (unixValue == 0) { result.splice(result.indexOf(id), 1); @@ -362,20 +432,24 @@ export class Search { } let value = new Date(unixValue*1000); - let match = q.compare(value); - if (!match) { + if (!q.compare(value)) { result.splice(result.indexOf(id), 1); } } } + + if (q != null) queries.push(q); } + + this._queries = queries; + this._searchTerms = searchTerms; return result; } showHideSearchOptionsHeader = () => { - const sortingBy = !(this._c.sortingByButton.parentElement.classList.contains("hidden")); + let sortingBy = false; + if (this._c.sortingByButton) sortingBy = !(this._c.sortingByButton.parentElement.classList.contains("hidden")); const hasFilters = this._c.filterArea.textContent != ""; - console.log("sortingBy", sortingBy, "hasFilters", hasFilters); if (sortingBy || hasFilters) { this._c.searchOptionsHeader.classList.remove("hidden"); } else { @@ -383,14 +457,24 @@ export class Search { } } - + // -all- elements. get items(): { [id: string]: SearchableItem } { return this._items; } - set items(v: { [id: string]: SearchableItem }) { - this._items = v; + // set items(v: { [id: string]: SearchableItem }) { + // this._items = v; + // } + + // The order of -all- elements (even those hidden), by their identifier. + get ordering(): string[] { return this._ordering; } + // Specifically dis-allow setting ordering itself, so that setOrdering is used instead (for the field and ascending params). + // set ordering(v: string[]) { this._ordering = v; } + setOrdering = (v: string[], field: string, ascending: boolean) => { + this._ordering = v; + this._sortField = field; + this._ascending = ascending; } - get ordering(): string[] { return this._ordering; } - set ordering(v: string[]) { this._ordering = v; } + get sortField(): string { return this._sortField; } + get ascending(): boolean { return this._ascending; } onSearchBoxChange = (newItems: boolean = false, loadAll: boolean = false) => { const query = this._c.search.value; @@ -402,11 +486,23 @@ export class Search { const results = this.search(query); this._c.setVisibility(results, true); this._c.onSearchCallback(results.length, newItems, loadAll); + if (this.inServerSearch) { + this._serverSearchButtons.forEach((v: HTMLElement) => { + v.classList.add("@low"); + v.classList.remove("@high"); + }); + } else { + this._serverSearchButtons.forEach((v: HTMLElement) => { + v.classList.add("@high"); + v.classList.remove("@low"); + }); + } this.showHideSearchOptionsHeader(); if (results.length == 0) { this._c.notFoundPanel.classList.remove("unfocused"); } else { this._c.notFoundPanel.classList.add("unfocused"); + } if (this._c.notFoundCallback) this._c.notFoundCallback(results.length == 0); } @@ -420,9 +516,8 @@ export class Search { this._c.search.setSelectionRange(newPos, newPos); this._c.search.oninput(null as any); }; - - + // FIXME: Make XQuery classes less specifically for in-progress searches, and include this code for making info button things. generateFilterList = () => { // Generate filter buttons for (let queryName of Object.keys(this._c.queries)) { @@ -497,17 +592,55 @@ export class Search { } } + onServerSearch = () => { + const newServerSearch = !this.inServerSearch; + this.inServerSearch = true; + this._c.searchServer(this.serverSearchParams(this._searchTerms, this._queries), newServerSearch); + } + + serverSearchParams = (searchTerms: string[], queries: Query[]): PaginatedReqDTO => { + let req: ServerSearchReqDTO = { + searchTerms: searchTerms, + queries: queries.map((q: Query) => q.asDTO()), + limit: -1, + page: 0, + sortByField: this.sortField, + ascending: this.ascending + }; + return req; + } + constructor(c: SearchConfiguration) { + // FIXME: Remove! + if (c.search.id.includes("accounts")) { + (window as any).s = this; + } this._c = c; - this._c.search.oninput = () => this.onSearchBoxChange(); + this._c.search.oninput = () => { + this.inServerSearch = false; + this.onSearchBoxChange(); + } + this._c.search.addEventListener("keyup", (ev: KeyboardEvent) => { + if (ev.key == "Enter") { + this.onServerSearch(); + } + }); const clearSearchButtons = Array.from(document.querySelectorAll(this._c.clearSearchButtonSelector)) as Array; for (let b of clearSearchButtons) { b.addEventListener("click", () => { this._c.search.value = ""; + this.inServerSearch = false; this.onSearchBoxChange(); }); } + + this._serverSearchButtons = Array.from(document.querySelectorAll(this._c.serverSearchButtonSelector)) as Array; + for (let b of this._serverSearchButtons) { + b.addEventListener("click", () => { + this.onServerSearch(); + }); + } } } diff --git a/ts/modules/tabs.ts b/ts/modules/tabs.ts index 3f7d78b..fc700cf 100644 --- a/ts/modules/tabs.ts +++ b/ts/modules/tabs.ts @@ -1,7 +1,5 @@ import { PageManager, Page } from "../modules/pages.js"; -declare var window: GlobalWindow; - export interface Tab { page: Page; tabEl: HTMLDivElement; diff --git a/ts/typings/d.ts b/ts/typings/d.ts index a4f7f80..8447fbd 100644 --- a/ts/typings/d.ts +++ b/ts/typings/d.ts @@ -150,14 +150,16 @@ interface inviteList { loadInviteURL: () => void; } -// Finally added to typescript, dont need this anymore. -// declare interface SubmitEvent extends Event { -// submitter: HTMLInputElement; -// } - interface paginatedDTO { last_page: boolean; } +interface PaginatedReqDTO { + limit: number; + page: number; + sortByField: string; + ascending: boolean; +}; + declare var config: Object; declare var modifiedConfig: Object; diff --git a/usercache.go b/usercache.go index cec988f..9b2e050 100644 --- a/usercache.go +++ b/usercache.go @@ -2,56 +2,63 @@ package main import ( "cmp" + "fmt" + "slices" + "strings" "sync" "time" ) const ( // FIXME: Follow mediabrowser, or make tuneable, or both - WEB_USER_CACHE_SYNC = 30 * time.Second + WEB_USER_CACHE_SYNC = 30 * time.Second + USER_DEFAULT_SORT_FIELD = "name" ) type UserCache struct { Cache []respUser + Ref []*respUser + Sorted bool LastSync time.Time Lock sync.Mutex } -func (c *UserCache) Gen(app *appContext) ([]respUser, error) { +func (c *UserCache) gen(app *appContext) error { // FIXME: I don't like this. if !time.Now().After(c.LastSync.Add(WEB_USER_CACHE_SYNC)) { - return c.Cache, nil + return nil } c.Lock.Lock() users, err := app.jf.GetUsers(false) if err != nil { - return nil, err + return err } c.Cache = make([]respUser, len(users)) for i, jfUser := range users { c.Cache[i] = app.userSummary(jfUser) } + c.Ref = make([]*respUser, len(c.Cache)) + for i := range c.Cache { + c.Ref[i] = &(c.Cache[i]) + } + c.Sorted = false c.LastSync = time.Now() c.Lock.Unlock() - return c.Cache, nil + return nil } -type Less func(a, b *respUser) bool -type SortableUserList struct { - Cache []respUser - lessFunc Less -} - -func (sc *SortableUserList) Len() int { - return len(sc.Cache) -} - -func (sc *SortableUserList) Swap(i, j int) { - sc.Cache[i], sc.Cache[j] = sc.Cache[j], sc.Cache[i] -} - -func (sc *SortableUserList) Less(i, j int) bool { - return sc.lessFunc(&sc.Cache[i], &sc.Cache[j]) +func (c *UserCache) Gen(app *appContext, sorted bool) ([]*respUser, error) { + if err := c.gen(app); err != nil { + return nil, err + } + if sorted && !c.Sorted { + c.Lock.Lock() + // FIXME: Check we want ascending! + c.Sort(c.Ref, USER_DEFAULT_SORT_FIELD, true) + c.Sorted = true + c.Lock.Unlock() + } + return c.Ref, nil } // instead of making a Less for bools, just convert them to integers @@ -66,93 +73,303 @@ func bool2int(b bool) int { return i } +// Returns -1 if respUser < value, 0 if equal, 1 is greater than +type Sorter func(a, b *respUser) int + // Allow sorting by respUser's struct fields (well, it's JSON-representation's fields) -// Ugly I know, but at least cmp.Less exists. -// Done with vim macros, thank god they exist -func SortUsersBy(u []respUser, field string) SortableUserList { - s := SortableUserList{Cache: u} +func SortUsersBy(field string) Sorter { + switch field { + case "id": + return func(a, b *respUser) int { + return cmp.Compare(strings.ToLower(a.ID), strings.ToLower(b.ID)) + } + case "name": + return func(a, b *respUser) int { + return cmp.Compare(strings.ToLower(a.Name), strings.ToLower(b.Name)) + } + case "email": + return func(a, b *respUser) int { + return cmp.Compare(strings.ToLower(a.Email), strings.ToLower(b.Email)) + } + case "notify_email": + return func(a, b *respUser) int { + return cmp.Compare(bool2int(a.NotifyThroughEmail), bool2int(b.NotifyThroughEmail)) + } + case "last_active": + return func(a, b *respUser) int { + return cmp.Compare(a.LastActive, b.LastActive) + } + case "admin": + return func(a, b *respUser) int { + return cmp.Compare(bool2int(a.Admin), bool2int(b.Admin)) + } + case "expiry": + return func(a, b *respUser) int { + return cmp.Compare(a.Expiry, b.Expiry) + } + case "disabled": + return func(a, b *respUser) int { + return cmp.Compare(bool2int(a.Disabled), bool2int(b.Disabled)) + } + case "telegram": + return func(a, b *respUser) int { + return cmp.Compare(strings.ToLower(a.Telegram), strings.ToLower(b.Telegram)) + } + case "notify_telegram": + return func(a, b *respUser) int { + return cmp.Compare(bool2int(a.NotifyThroughTelegram), bool2int(b.NotifyThroughTelegram)) + } + case "discord": + return func(a, b *respUser) int { + return cmp.Compare(strings.ToLower(a.Discord), strings.ToLower(b.Discord)) + } + case "discord_id": + return func(a, b *respUser) int { + return cmp.Compare(strings.ToLower(a.DiscordID), strings.ToLower(b.DiscordID)) + } + case "notify_discord": + return func(a, b *respUser) int { + return cmp.Compare(bool2int(a.NotifyThroughDiscord), bool2int(b.NotifyThroughDiscord)) + } + case "matrix": + return func(a, b *respUser) int { + return cmp.Compare(strings.ToLower(a.Matrix), strings.ToLower(b.Matrix)) + } + case "notify_matrix": + return func(a, b *respUser) int { + return cmp.Compare(bool2int(a.NotifyThroughMatrix), bool2int(b.NotifyThroughMatrix)) + } + case "label": + return func(a, b *respUser) int { + return cmp.Compare(strings.ToLower(a.Label), strings.ToLower(b.Label)) + } + case "accounts_admin": + return func(a, b *respUser) int { + return cmp.Compare(bool2int(a.AccountsAdmin), bool2int(b.AccountsAdmin)) + } + case "referrals_enabled": + return func(a, b *respUser) int { + return cmp.Compare(bool2int(a.ReferralsEnabled), bool2int(b.ReferralsEnabled)) + } + } + panic(fmt.Errorf("got invalid field %s", field)) + return nil +} + +type Filter func(*respUser) bool + +type CompareResult int + +const ( + Lesser CompareResult = -1 + Equal CompareResult = 0 + Greater CompareResult = 1 +) + +// One day i'll figure out Go generics +/*type FilterValue interface { + bool | string | DateAttempt +}*/ + +type DateAttempt struct { + Year *int `json:"year,omitempty"` + Month *int `json:"month,omitempty"` + Day *int `json:"day,omitempty"` + Hour *int `json:"hour,omitempty"` + Minute *int `json:"minute,omitempty"` +} + +// Compares a Unix timestamp. +// We want to compare only the fields given in DateAttempt, +// so we copy subjectDate and apply on those fields from this._value. +func (d DateAttempt) Compare(subject int64) int { + subjectTime := time.Unix(subject, 0) + yy, mo, dd := subjectTime.Date() + hh, mm, _ := subjectTime.Clock() + if d.Year != nil { + yy = *d.Year + } + if d.Month != nil { + // Month in Javascript is zero-based, so we need to increment it + mo = time.Month((*d.Month) + 1) + } + if d.Day != nil { + dd = *d.Day + } + if d.Hour != nil { + hh = *d.Hour + } + if d.Minute != nil { + mm = *d.Minute + } + return subjectTime.Compare(time.Date(yy, mo, dd, hh, mm, 0, 0, nil)) +} + +// FIXME: Consider using QueryDTO.Class rather than assuming type from name? Probably not worthwhile though. +func FilterUsersBy(field string, op QueryOperator, value any) Filter { + operator := Equal + switch op { + case LesserOperator: + operator = Lesser + case EqualOperator: + operator = Equal + case GreaterOperator: + operator = Greater + } switch field { case "id": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(a.ID, b.ID) + return func(a *respUser) bool { + return cmp.Compare(strings.ToLower(a.ID), strings.ToLower(value.(string))) == int(operator) } - case "name": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(a.Name, b.Name) + return func(a *respUser) bool { + return cmp.Compare(strings.ToLower(a.Name), strings.ToLower(value.(string))) == int(operator) } case "email": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(a.Email, b.Email) + return func(a *respUser) bool { + return cmp.Compare(strings.ToLower(a.Email), strings.ToLower(value.(string))) == int(operator) } case "notify_email": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(bool2int(a.NotifyThroughEmail), bool2int(b.NotifyThroughEmail)) + return func(a *respUser) bool { + return cmp.Compare(bool2int(a.NotifyThroughEmail), bool2int(value.(bool))) == int(operator) } case "last_active": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(a.LastActive, b.LastActive) + return func(a *respUser) bool { + return value.(DateAttempt).Compare(a.LastActive) == int(operator) } case "admin": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(bool2int(a.Admin), bool2int(b.Admin)) + return func(a *respUser) bool { + return cmp.Compare(bool2int(a.Admin), bool2int(value.(bool))) == int(operator) } case "expiry": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(a.Expiry, b.Expiry) + return func(a *respUser) bool { + return value.(DateAttempt).Compare(a.Expiry) == int(operator) } case "disabled": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(bool2int(a.Disabled), bool2int(b.Disabled)) + return func(a *respUser) bool { + return cmp.Compare(bool2int(a.Disabled), bool2int(value.(bool))) == int(operator) } case "telegram": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(a.Telegram, b.Telegram) + return func(a *respUser) bool { + return cmp.Compare(strings.ToLower(a.Telegram), strings.ToLower(value.(string))) == int(operator) } case "notify_telegram": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(bool2int(a.NotifyThroughTelegram), bool2int(b.NotifyThroughTelegram)) + return func(a *respUser) bool { + return cmp.Compare(bool2int(a.NotifyThroughTelegram), bool2int(value.(bool))) == int(operator) } case "discord": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(a.Discord, b.Discord) + return func(a *respUser) bool { + return cmp.Compare(strings.ToLower(a.Discord), strings.ToLower(value.(string))) == int(operator) } case "discord_id": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(a.DiscordID, b.DiscordID) + return func(a *respUser) bool { + return cmp.Compare(strings.ToLower(a.DiscordID), strings.ToLower(value.(string))) == int(operator) } case "notify_discord": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(bool2int(a.NotifyThroughDiscord), bool2int(b.NotifyThroughDiscord)) + return func(a *respUser) bool { + return cmp.Compare(bool2int(a.NotifyThroughDiscord), bool2int(value.(bool))) == int(operator) } case "matrix": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(a.Matrix, b.Matrix) + return func(a *respUser) bool { + return cmp.Compare(strings.ToLower(a.Matrix), strings.ToLower(value.(string))) == int(operator) } case "notify_matrix": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(bool2int(a.NotifyThroughMatrix), bool2int(b.NotifyThroughMatrix)) + return func(a *respUser) bool { + return cmp.Compare(bool2int(a.NotifyThroughMatrix), bool2int(value.(bool))) == int(operator) } case "label": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(a.Label, b.Label) + return func(a *respUser) bool { + return cmp.Compare(strings.ToLower(a.Label), strings.ToLower(value.(string))) == int(operator) } case "accounts_admin": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(bool2int(a.AccountsAdmin), bool2int(b.AccountsAdmin)) + return func(a *respUser) bool { + return cmp.Compare(bool2int(a.AccountsAdmin), bool2int(value.(bool))) == int(operator) } case "referrals_enabled": - s.lessFunc = func(a, b *respUser) bool { - return cmp.Less(bool2int(a.ReferralsEnabled), bool2int(b.ReferralsEnabled)) + return func(a *respUser) bool { + return cmp.Compare(bool2int(a.ReferralsEnabled), bool2int(value.(bool))) == int(operator) } } - return s + panic(fmt.Errorf("got invalid field %s", field)) + return nil } -type Filter func(yield func(*respUser) bool) - -type FilterableList struct { - Cache []respUser - filterFunc Filter +func (ru *respUser) MatchesSearch(term string) bool { + return (strings.Contains(ru.ID, term) || + strings.Contains(strings.ToLower(ru.Name), term) || + strings.Contains(strings.ToLower(ru.Label), term) || + strings.Contains(strings.ToLower(ru.Email), term) || + strings.Contains(strings.ToLower(ru.Discord), term) || + strings.Contains(strings.ToLower(ru.Matrix), term) || + strings.Contains(strings.ToLower(ru.Telegram), term)) +} + +type QueryClass string + +const ( + BoolQuery QueryClass = "bool" + StringQuery QueryClass = "string" + DateQuery QueryClass = "date" +) + +type QueryOperator string + +const ( + LesserOperator QueryOperator = "<" + EqualOperator QueryOperator = "=" + GreaterOperator QueryOperator = ">" +) + +type QueryDTO struct { + Class QueryClass `json:"class"` + Field string `json:"field"` + Operator QueryOperator `json:"operator"` + // string | bool | DateAttempt + Value any `json:"value"` +} + +type ServerSearchReqDTO struct { + PaginatedReqDTO + SearchTerms []string `json:"searchTerms"` + Queries []QueryDTO `json:"queries"` +} + +// Filter by AND-ing all search terms and queries. +func (c *UserCache) Filter(users []*respUser, terms []string, queries []QueryDTO) []*respUser { + filters := make([]Filter, len(queries)) + for i, q := range queries { + filters[i] = FilterUsersBy(q.Field, q.Operator, q.Value) + } + // FIXME: Properly consider pre-allocation size + out := make([]*respUser, 0, len(users)/4) + for i := range users { + match := true + for _, term := range terms { + if !users[i].MatchesSearch(term) { + match = false + break + } + } + if !match { + continue + } + for _, filter := range filters { + if filter == nil || !filter(users[i]) { + match = false + break + } + } + if match { + out = append(out, users[i]) + } + } + return out +} + +func (c *UserCache) Sort(users []*respUser, field string, ascending bool) { + slices.SortFunc(users, SortUsersBy(field)) + if !ascending { + slices.Reverse(users) + } } From b19efc4ee6f352ed7fad8d3c3269d07c4191d05c Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Wed, 21 May 2025 15:20:39 +0100 Subject: [PATCH 029/249] search: more server-search refinement fixed bugs, added extra text on "no results found" to suggest server searching, and conditionally disable the button based on search content and current sort. Activities page still broken. Also fixed up cache generation, only one should ever run now, as should sorting. Two time thresholds exist, one to trigger a re-sync but do it in the background (i.e. send the old one to the requester), and one to re-sync and wait for it. --- api-users.go | 16 +++- css/tooltip.css | 6 ++ html/admin.html | 40 +++++---- lang/admin/en-us.json | 2 + scripts/account-gen/main.go | 14 ++- ts/modules/accounts.ts | 27 +++--- ts/modules/activity.ts | 17 ++-- ts/modules/list.ts | 38 ++++---- ts/modules/search.ts | 171 ++++++++++++++++++++++-------------- usercache.go | 99 ++++++++++++++++----- 10 files changed, 281 insertions(+), 149 deletions(-) diff --git a/api-users.go b/api-users.go index a4e6214..bbaa9d7 100644 --- a/api-users.go +++ b/api-users.go @@ -4,6 +4,7 @@ import ( "fmt" "net/url" "os" + "slices" "strings" "time" @@ -949,19 +950,26 @@ func (app *appContext) SearchUsers(gc *gin.Context) { } var resp getUsersDTO - userList, err := app.userCache.Gen(app, false) + userList, err := app.userCache.Gen(app, req.SortByField == USER_DEFAULT_SORT_FIELD) if err != nil { app.err.Printf(lm.FailedGetUsers, lm.Jellyfin, err) respond(500, "Couldn't get users", gc) return } var filtered []*respUser - if (req.SearchTerms != nil && len(req.SearchTerms) != 0) || (req.Queries != nil && len(req.Queries) != 0) { + if len(req.SearchTerms) != 0 || len(req.Queries) != 0 { filtered = app.userCache.Filter(userList, req.SearchTerms, req.Queries) } else { - filtered = userList + filtered = slices.Clone(userList) + } + + if req.SortByField == USER_DEFAULT_SORT_FIELD { + if req.Ascending != USER_DEFAULT_SORT_ASCENDING { + slices.Reverse(filtered) + } + } else { + app.userCache.Sort(filtered, req.SortByField, req.Ascending) } - app.userCache.Sort(filtered, req.SortByField, req.Ascending) startIndex := (req.Page * req.Limit) if startIndex < len(filtered) { diff --git a/css/tooltip.css b/css/tooltip.css index 85a289e..fc92a1d 100644 --- a/css/tooltip.css +++ b/css/tooltip.css @@ -27,6 +27,12 @@ right: 0; } +.tooltip.above .content { + bottom: 2.5rem; + left: 0; + right: 0; +} + .tooltip.darker .content { background-color: rgba(0, 0, 0, 0.8); } diff --git a/html/admin.html b/html/admin.html index 2a9a8fc..23e70e9 100644 --- a/html/admin.html +++ b/html/admin.html @@ -726,7 +726,10 @@
- + {{ .strings.searchAllRecords }}
@@ -810,20 +813,23 @@
-
- {{ .strings.noResultsFound }} - {{ .strings.keepSearchingDescription }} +
+ {{ .strings.noResultsFound }} + {{ .strings.noResultsFoundLocally }}
-
-
- - +
+ + +
@@ -843,7 +849,7 @@
- + {{ .strings.searchAllRecords }}
@@ -867,9 +873,9 @@
-
- {{ .strings.noResultsFound }} - {{ .strings.keepSearchingDescription }} +
+ {{ .strings.noResultsFound }} + {{ .strings.noResultsFoundLocally }}
-
- - +
+ + +
diff --git a/lang/admin/en-us.json b/lang/admin/en-us.json index ff3dec1..d420ee8 100644 --- a/lang/admin/en-us.json +++ b/lang/admin/en-us.json @@ -58,6 +58,7 @@ "disabled": "Disabled", "sendPWR": "Send Password Reset", "noResultsFound": "No Results Found", + "noResultsFoundLocally": "Only loaded records were searched. You can load more, or perform the search over all records on the server.", "keepSearching": "Keep Searching", "keepSearchingDescription": "Only the current loaded activities were searched. Click below if you wish to search all activities.", "contactThrough": "Contact through:", @@ -136,6 +137,7 @@ "filters": "Filters", "clickToRemoveFilter": "Click to remove this filter.", "clearSearch": "Clear search", + "searchAll": "Search all", "searchAllRecords": "Search all records (on server)", "actions": "Actions", "searchOptions": "Search Options", diff --git a/scripts/account-gen/main.go b/scripts/account-gen/main.go index 47faa6f..c61928f 100644 --- a/scripts/account-gen/main.go +++ b/scripts/account-gen/main.go @@ -14,8 +14,9 @@ import ( ) var ( - names = []string{"Aaron", "Agnes", "Bridget", "Brandon", "Dolly", "Drake", "Elizabeth", "Erika", "Geoff", "Graham", "Haley", "Halsey", "Josie", "John", "Kayleigh", "Luka", "Melissa", "Nasreen", "Paul", "Ross", "Sam", "Talib", "Veronika", "Zaynab"} - COUNT = 3000 + names = []string{"Aaron", "Agnes", "Bridget", "Brandon", "Dolly", "Drake", "Elizabeth", "Erika", "Geoff", "Graham", "Haley", "Halsey", "Josie", "John", "Kayleigh", "Luka", "Melissa", "Nasreen", "Paul", "Ross", "Sam", "Talib", "Veronika", "Zaynab", "Graig", "Rhoda", "Tyler", "Quentin", "Melinda", "Zelma", "Jack", "Clifton", "Sherry", "Boyce", "Elma", "Jere", "Shelby", "Caitlin", "Bertie", "Mallory", "Thelma", "Charley", "Santo", "Merrill", "Royal", "Jefferson", "Ester", "Dee", "Susanna", "Adriana", "Alfonso", "Lillie", "Carmen", "Federico", "Ernie", "Kory", "Kimberly", "Donn", "Lilian", "Irvin", "Sherri", "Cordell", "Adrienne", "Edwin", "Serena", "Otis", "Latasha", "Johanna", "Clarence", "Noe", "Mindy", "Felix", "Audra"} + COUNT = 4000 + DELAY = 1 * time.Millisecond ) const ( @@ -101,11 +102,12 @@ func main() { rand.Seed(time.Now().Unix()) for i := 0; i < COUNT; i++ { - name := names[rand.Intn(len(names))] + strconv.Itoa(rand.Intn(100)) + name := names[rand.Intn(len(names))] + strconv.Itoa(rand.Intn(500)) user, status, err := jf.NewUser(name, PASSWORD) if (status != 200 && status != 201 && status != 204) || err != nil { - log.Fatalf("Acc no %d: Failed to create user \"%s\" (%d): %+v\n", i, name, status, err) + log.Printf("Acc no %d: Failed to create user \"%s\" (%d): %+v\n", i, name, status, err) + continue } if rand.Intn(100) > 65 { @@ -116,13 +118,17 @@ func main() { user.Policy.IsDisabled = true } + time.Sleep(DELAY / 4) status, err = jf.SetPolicy(user.ID, user.Policy) if (status != 200 && status != 201 && status != 204) || err != nil { log.Fatalf("Acc no %d: Failed to set policy for user \"%s\" (%d): %+v\n", i, name, status, err) } if rand.Intn(100) > 20 { + time.Sleep(DELAY / 4) jfTemp.Authenticate(name, PASSWORD) } + log.Printf("Acc %d done\n", i) + time.Sleep(DELAY / 4) } } diff --git a/ts/modules/accounts.ts b/ts/modules/accounts.ts index a95b14f..46f50b3 100644 --- a/ts/modules/accounts.ts +++ b/ts/modules/accounts.ts @@ -9,6 +9,9 @@ import { PaginatedList } from "./list.js"; declare var window: GlobalWindow; +const USER_DEFAULT_SORT_FIELD = "name"; +const USER_DEFAULT_SORT_ASCENDING = true; + const dateParser = require("any-date-parser"); interface User { @@ -911,16 +914,14 @@ export class accountsList extends PaginatedList { loadMoreButton: document.getElementById("accounts-load-more") as HTMLButtonElement, loadAllButton: document.getElementById("accounts-load-all") as HTMLButtonElement, refreshButton: document.getElementById("accounts-refresh") as HTMLButtonElement, - keepSearchingDescription: document.getElementById("accounts-keep-searching-description"), - keepSearchingButton: document.getElementById("accounts-keep-searching"), filterArea: document.getElementById("accounts-filter-area"), searchOptionsHeader: document.getElementById("accounts-search-options-header"), searchBox: document.getElementById("accounts-search") as HTMLInputElement, - notFoundPanel: document.getElementById("accounts-not-found"), recordCounter: document.getElementById("accounts-record-counter"), totalEndpoint: "/users/count", getPageEndpoint: "/users", - limit: 4, + itemsPerPage: 40, + maxItemsLoadedForSearch: 200, newElementsFromPage: (resp: paginatedDTO) => { for (let u of ((resp as UsersDTO).users || [])) { if (u.id in this.users) { @@ -962,7 +963,8 @@ export class accountsList extends PaginatedList { this._search.ascending ); }, - defaultSortField: "name", + defaultSortField: USER_DEFAULT_SORT_FIELD, + defaultSortAscending: USER_DEFAULT_SORT_ASCENDING, pageLoadCallback: (req: XMLHttpRequest) => { if (req.readyState != 4) return; // FIXME: Error message @@ -975,7 +977,8 @@ export class accountsList extends PaginatedList { filterArea: this._c.filterArea, sortingByButton: this._sortingByButton, searchOptionsHeader: this._c.searchOptionsHeader, - notFoundPanel: this._c.notFoundPanel, + notFoundPanel: document.getElementById("accounts-not-found"), + notFoundLocallyText: document.getElementById("accounts-no-local-results"), filterList: document.getElementById("accounts-filter-list"), search: this._c.searchBox, queries: queries(), @@ -1188,7 +1191,7 @@ export class accountsList extends PaginatedList { // Start off sorting by username (this._c.defaultSortField) const defaultSort = () => { document.dispatchEvent(new CustomEvent("header-click", { detail: this._c.defaultSortField })); - this._columns[this._c.defaultSortField].ascending = true; + this._columns[this._c.defaultSortField].ascending = this._c.defaultSortAscending; this._columns[this._c.defaultSortField].hideIcon(); this._sortingByButton.parentElement.classList.add("hidden"); this._search.showHideSearchOptionsHeader(); @@ -1209,15 +1212,17 @@ export class accountsList extends PaginatedList { this._search.onSearchBoxChange(); } else { this.setVisibility(this._search.ordering, true); - this._c.notFoundPanel.classList.add("unfocused"); + this._search.setNotFoundPanelVisibility(false); + this._search.setServerSearchButtonsDisabled( + event.detail == this._c.defaultSortField && this._columns[event.detail].ascending == this._c.defaultSortAscending + ); } this._search.showHideSearchOptionsHeader(); }); defaultSort(); - this._search.showHideSearchOptionsHeader(); - this._search.generateFilterList(); + this._search.showHideSearchOptionsHeader(); this.registerURLListener(); } @@ -2168,7 +2173,7 @@ class Column { // Returns the inner HTML to show in the "Sorting By" button. get buttonContent() { - return `` + window.lang.strings("sortingBy") + ": " + `` + this._headerContent; + return `` + window.lang.strings("sortingBy") + ": " + `` + this._headerContent; } get ascending() { return this._ascending; } diff --git a/ts/modules/activity.ts b/ts/modules/activity.ts index 5780962..7f63017 100644 --- a/ts/modules/activity.ts +++ b/ts/modules/activity.ts @@ -6,6 +6,9 @@ import { PaginatedList } from "./list.js"; declare var window: GlobalWindow; +const ACTIVITY_DEFAULT_SORT_FIELD = "time"; +const ACTIVITY_DEFAULT_SORT_ASCENDING = false; + export interface activity { id: string; type: string; @@ -488,16 +491,14 @@ export class activityList extends PaginatedList { loadMoreButton: document.getElementById("activity-load-more") as HTMLButtonElement, loadAllButton: document.getElementById("activity-load-all") as HTMLButtonElement, refreshButton: document.getElementById("activity-refresh") as HTMLButtonElement, - keepSearchingDescription: document.getElementById("activity-keep-searching-description"), - keepSearchingButton: document.getElementById("activity-keep-searching"), filterArea: document.getElementById("activity-filter-area"), searchOptionsHeader: document.getElementById("activity-search-options-header"), searchBox: document.getElementById("activity-search") as HTMLInputElement, - notFoundPanel: document.getElementById("activity-not-found"), recordCounter: document.getElementById("activity-record-counter"), totalEndpoint: "/activity/count", getPageEndpoint: "/activity", - limit: 10, + itemsPerPage: 20, + maxItemsLoadedForSearch: 200, newElementsFromPage: (resp: paginatedDTO) => { let ordering: string[] = this._search.ordering; for (let act of ((resp as ActivitiesDTO).activities || [])) { @@ -513,7 +514,8 @@ export class activityList extends PaginatedList { this._search.setOrdering([], this._c.defaultSortField, this.ascending); this._c.newElementsFromPage(resp); }, - defaultSortField: "time", + defaultSortField: ACTIVITY_DEFAULT_SORT_FIELD, + defaultSortAscending: ACTIVITY_DEFAULT_SORT_ASCENDING, pageLoadCallback: (req: XMLHttpRequest) => { if (req.readyState != 4) return; if (req.status != 200) { @@ -531,7 +533,8 @@ export class activityList extends PaginatedList { // Exclude this: We only sort by date, and don't want to show a redundant header indicating so. // sortingByButton: this._sortingByButton, searchOptionsHeader: this._c.searchOptionsHeader, - notFoundPanel: this._c.notFoundPanel, + notFoundPanel: document.getElementById("activity-not-found"), + notFoundLocallyText: document.getElementById("activity-no-local-results"), search: this._c.searchBox, clearSearchButtonSelector: ".activity-search-clear", serverSearchButtonSelector: ".activity-search-server", @@ -546,7 +549,7 @@ export class activityList extends PaginatedList { this.initSearch(searchConfig); - this.ascending = false; + this.ascending = this._c.defaultSortAscending; this._sortDirection.addEventListener("click", () => this.ascending = !this.ascending); } diff --git a/ts/modules/list.ts b/ts/modules/list.ts index 0978317..414b550 100644 --- a/ts/modules/list.ts +++ b/ts/modules/list.ts @@ -76,19 +76,18 @@ export interface PaginatedListConfig { loadMoreButton: HTMLButtonElement; loadAllButton: HTMLButtonElement; refreshButton: HTMLButtonElement; - keepSearchingDescription: HTMLElement; - keepSearchingButton: HTMLElement; - notFoundPanel: HTMLElement; filterArea: HTMLElement; searchOptionsHeader: HTMLElement; searchBox: HTMLInputElement; recordCounter: HTMLElement; totalEndpoint: string; getPageEndpoint: string; - limit: number; + itemsPerPage: number; + maxItemsLoadedForSearch: number; newElementsFromPage: (resp: paginatedDTO) => void; updateExistingElementsFromPage: (resp: paginatedDTO) => void; defaultSortField: string; + defaultSortAscending: boolean; pageLoadCallback?: (req: XMLHttpRequest) => void; } @@ -109,13 +108,13 @@ export abstract class PaginatedList { if (v) { this._c.loadAllButton.classList.add("unfocused"); this._c.loadMoreButton.textContent = window.lang.strings("noMoreResults"); + this._search.setServerSearchButtonsDisabled(this._search.inServerSearch); this._c.loadMoreButton.disabled = true; } else { this._c.loadMoreButton.textContent = window.lang.strings("loadMore"); this._c.loadMoreButton.disabled = false; - if (this._search.inSearch) { - this._c.loadAllButton.classList.remove("unfocused"); - } + this._search.setServerSearchButtonsDisabled(false); + this._c.loadAllButton.classList.remove("unfocused"); } } @@ -160,9 +159,15 @@ export abstract class PaginatedList { // if (this._search.inSearch && !this.lastPage) this._c.loadAllButton.classList.remove("unfocused"); // else this._c.loadAllButton.classList.add("unfocused"); - + + if (this._search.sortField == this._c.defaultSortField && this._search.ascending == this._c.defaultSortAscending) { + this._search.setServerSearchButtonsDisabled(!this._search.inSearch) + } else { + this._search.setServerSearchButtonsDisabled(false) + } + // FIXME: Figure out why this makes sense and make it clearer. - if ((visibleCount < this._c.limit && !this.lastPage) || loadAll) { + if ((visibleCount < this._c.itemsPerPage && this._counter.loaded < this._c.maxItemsLoadedForSearch && !this.lastPage) || loadAll) { if (!newItems || this._previousPageSize != visibleCount || (visibleCount == 0 && !this.lastPage) || @@ -183,6 +188,7 @@ export abstract class PaginatedList { if (previousServerSearch) previousServerSearch(params, newSearch); }; searchConfig.clearServerSearch = () => { + console.log("Clearing server search"); this._page = 0; this.reload(); } @@ -195,6 +201,7 @@ export abstract class PaginatedList { public abstract setVisibility: (elements: string[], visible: boolean) => void; // Removes all elements, and reloads the first page. + // FIXME: Share more code between reload and loadMore, and go over the logic, it's messy. public abstract reload: () => void; protected _reload = ( callback?: (req: XMLHttpRequest) => void @@ -206,7 +213,7 @@ export abstract class PaginatedList { this._counter.getTotal(this._c.totalEndpoint); // Reload all currently visible elements, i.e. Load a new page of size (limit*(page+1)). - let limit = this._c.limit; + let limit = this._c.itemsPerPage; if (this._page != 0) { limit *= this._page+1; } @@ -216,7 +223,7 @@ export abstract class PaginatedList { params.page = 0; if (params.sortByField == "") { params.sortByField = this._c.defaultSortField; - params.ascending = true; + params.ascending = this._c.defaultSortAscending; } _post(this._c.getPageEndpoint, params, (req: XMLHttpRequest) => { @@ -246,8 +253,7 @@ export abstract class PaginatedList { } else { this._counter.shown = this._counter.loaded; this.setVisibility(this._search.ordering, true); - this._c.loadAllButton.classList.add("unfocused"); - this._c.notFoundPanel.classList.add("unfocused"); + // this._search.showHideNotFoundPanel(false); } if (this._c.pageLoadCallback) this._c.pageLoadCallback(req); if (callback) callback(req); @@ -268,11 +274,11 @@ export abstract class PaginatedList { this._page += 1; let params = this._search.inServerSearch ? this._searchParams : this.defaultParams(); - params.limit = this._c.limit; + params.limit = this._c.itemsPerPage; params.page = this._page; if (params.sortByField == "") { params.sortByField = this._c.defaultSortField; - params.ascending = true; + params.ascending = this._c.defaultSortAscending; } _post(this._c.getPageEndpoint, params, (req: XMLHttpRequest) => { @@ -304,7 +310,7 @@ export abstract class PaginatedList { this._search.onSearchBoxChange(true, loadAll); } else { this.setVisibility(this._search.ordering, true); - this._c.notFoundPanel.classList.add("unfocused"); + this._search.setNotFoundPanelVisibility(false); } if (this._c.pageLoadCallback) this._c.pageLoadCallback(req); if (callback) callback(req); diff --git a/ts/modules/search.ts b/ts/modules/search.ts index e93b653..92f99ec 100644 --- a/ts/modules/search.ts +++ b/ts/modules/search.ts @@ -35,6 +35,7 @@ export interface SearchConfiguration { sortingByButton?: HTMLButtonElement; searchOptionsHeader: HTMLElement; notFoundPanel: HTMLElement; + notFoundLocallyText: HTMLElement; notFoundCallback?: (notFound: boolean) => void; filterList: HTMLElement; clearSearchButtonSelector: string; @@ -91,6 +92,16 @@ export abstract class Query { out.operator = this._operator; return out; } + + get subject(): QueryType { return this._subject; } + + getValueFromItem(item: SearchableItem): any { + return Object.getOwnPropertyDescriptor(Object.getPrototypeOf(item), this.subject.getter).get.call(item); + } + + compareItem(item: SearchableItem): boolean { + return this.compare(this.getValueFromItem(item)); + } } export class BoolQuery extends Query { @@ -278,30 +289,19 @@ export class Search { private _inServerSearch: boolean = false; get inServerSearch(): boolean { return this._inServerSearch; } set inServerSearch(v: boolean) { + const previous = this._inServerSearch; this._inServerSearch = v; - if (!v) { + if (!v && previous != v) { this._c.clearServerSearch(); } } private _serverSearchButtons: HTMLElement[]; - // Returns a list of identifiers (keys in items, values in ordering). - search = (query: String): string[] => { - this._c.filterArea.textContent = ""; - + static tokenizeSearch = (query: string): string[] => { query = query.toLowerCase(); - let result: string[] = [...this._ordering]; - // If we're in a server search already, the results are already correct. - if (this.inServerSearch) return result; - - let words: string[] = []; - let queries = []; - let searchTerms = []; - - let quoteSymbol = ``; let queryStart = -1; let lastQuote = -1; @@ -335,19 +335,17 @@ export class Search { } } } + return words; + } - query = ""; - for (let word of words) { + parseTokens = (tokens: string[]): [string[], Query[]] => { + let queries: Query[] = []; + let searchTerms: string[] = []; + + for (let word of tokens) { // 1. Normal search text, no filters or anything if (!word.includes(":")) { searchTerms.push(word); - let cachedResult = [...result]; - for (let id of cachedResult) { - const u = this.items[id]; - if (!u.matchesSearch(word)) { - result.splice(result.indexOf(id), 1); - } - } continue; } // 2. A filter query of some sort. @@ -369,21 +367,6 @@ export class Search { } this._c.search.oninput((null as Event)); }; - - this._c.filterArea.appendChild(q.asElement()); - - // So removing elements doesn't affect us - let cachedResult = [...result]; - for (let id of cachedResult) { - const u = this.items[id]; - const value = Object.getOwnPropertyDescriptor(Object.getPrototypeOf(u), queryFormat.getter).get.call(u); - // Remove from result if not matching query - if (!q.compare(value)) { - // console.log("not matching, result is", result); - result.splice(result.indexOf(id), 1); - } else { - } - } } } else if (queryFormat.string) { q = new StringQuery(queryFormat, split[1]); @@ -395,17 +378,6 @@ export class Search { } this._c.search.oninput((null as Event)); } - - this._c.filterArea.appendChild(q.asElement()); - - let cachedResult = [...result]; - for (let id of cachedResult) { - const u = this.items[id]; - const value = Object.getOwnPropertyDescriptor(Object.getPrototypeOf(u), queryFormat.getter).get.call(u).toLowerCase(); - if (!q.compare(value)) { - result.splice(result.indexOf(id), 1); - } - } } else if (queryFormat.date) { let [parsedDate, op, isDate] = DateQuery.paramsFromString(split[1]); if (!isDate) continue; @@ -419,13 +391,61 @@ export class Search { this._c.search.oninput((null as Event)); } - - this._c.filterArea.appendChild(q.asElement()); + } + + if (q != null) queries.push(q); + } + return [searchTerms, queries]; + } - let cachedResult = [...result]; + // Returns a list of identifiers (used as keys in items, values in ordering). + search = (query: string): string[] => { + this._c.filterArea.textContent = ""; + + let result: string[] = [...this._ordering]; + // If we're in a server search already, the results are already correct. + if (this.inServerSearch) return result; + + const [searchTerms, queries] = this.parseTokens(Search.tokenizeSearch(query)); + + query = ""; + + for (let term of searchTerms) { + let cachedResult = [...result]; + for (let id of cachedResult) { + const u = this.items[id]; + if (!u.matchesSearch(term)) { + result.splice(result.indexOf(id), 1); + } + } + } + for (let q of queries) { + this._c.filterArea.appendChild(q.asElement()); + let cachedResult = [...result]; + if (q.subject.bool) { for (let id of cachedResult) { const u = this.items[id]; - const unixValue = Object.getOwnPropertyDescriptor(Object.getPrototypeOf(u), queryFormat.getter).get.call(u); + // Remove from result if not matching query + if (!q.compareItem(u)) { + // console.log("not matching, result is", result); + result.splice(result.indexOf(id), 1); + } + } + } else if (q.subject.string) { + for (let id of cachedResult) { + const u = this.items[id]; + // We want to compare case-insensitively, so we get value, lower-case it then compare, + // rather than doing both with compareItem. + const value = q.getValueFromItem(u).toLowerCase(); + if (!q.compare(value)) { + result.splice(result.indexOf(id), 1); + } + } + } else if(q.subject.date) { + for (let id of cachedResult) { + const u = this.items[id]; + // Getter here returns a unix timestamp rather than a date, so we can't use compareItem. + const unixValue = q.getValueFromItem(u); if (unixValue == 0) { result.splice(result.indexOf(id), 1); continue; @@ -437,12 +457,11 @@ export class Search { } } } - - if (q != null) queries.push(q); } this._queries = queries; this._searchTerms = searchTerms; + return result; } @@ -486,25 +505,37 @@ export class Search { const results = this.search(query); this._c.setVisibility(results, true); this._c.onSearchCallback(results.length, newItems, loadAll); - if (this.inServerSearch) { - this._serverSearchButtons.forEach((v: HTMLElement) => { - v.classList.add("@low"); - v.classList.remove("@high"); - }); - } else { - this._serverSearchButtons.forEach((v: HTMLElement) => { - v.classList.add("@high"); - v.classList.remove("@low"); - }); + if (this.inSearch) { + if (this.inServerSearch) { + this._serverSearchButtons.forEach((v: HTMLElement) => { + v.classList.add("@low"); + v.classList.remove("@high"); + }); + } else { + this._serverSearchButtons.forEach((v: HTMLElement) => { + v.classList.add("@high"); + v.classList.remove("@low"); + }); + } } this.showHideSearchOptionsHeader(); - if (results.length == 0) { + this.setNotFoundPanelVisibility(results.length == 0); + if (this._c.notFoundCallback) this._c.notFoundCallback(results.length == 0); + } + + setNotFoundPanelVisibility = (visible: boolean) => { + if (this._inServerSearch || !this.inSearch) { + this._c.notFoundLocallyText.classList.add("unfocused"); + } else if (this.inSearch) { + this._c.notFoundLocallyText.classList.remove("unfocused"); + } + if (visible) { + console.log("showing not found panel"); this._c.notFoundPanel.classList.remove("unfocused"); } else { + console.log("hiding not found panel"); this._c.notFoundPanel.classList.add("unfocused"); - } - if (this._c.notFoundCallback) this._c.notFoundCallback(results.length == 0); } fillInFilter = (name: string, value: string, offset?: number) => { @@ -610,6 +641,10 @@ export class Search { return req; } + setServerSearchButtonsDisabled = (disabled: boolean) => { + this._serverSearchButtons.forEach((v: HTMLButtonElement) => v.disabled = disabled); + } + constructor(c: SearchConfiguration) { // FIXME: Remove! if (c.search.id.includes("accounts")) { diff --git a/usercache.go b/usercache.go index 9b2e050..7864667 100644 --- a/usercache.go +++ b/usercache.go @@ -11,8 +11,12 @@ import ( const ( // FIXME: Follow mediabrowser, or make tuneable, or both - WEB_USER_CACHE_SYNC = 30 * time.Second - USER_DEFAULT_SORT_FIELD = "name" + // After cache is this old, re-sync, but do it in the background and return the old cache. + WEB_USER_CACHE_SYNC = 30 * time.Second + // After cache is this old, re-sync and wait for it and return the new cache. + WEB_USER_CACHE_WAIT_FOR_SYNC = 5 * time.Minute + USER_DEFAULT_SORT_FIELD = "name" + USER_DEFAULT_SORT_ASCENDING = true ) type UserCache struct { @@ -20,30 +24,67 @@ type UserCache struct { Ref []*respUser Sorted bool LastSync time.Time - Lock sync.Mutex + SyncLock sync.Mutex + Syncing bool + SortLock sync.Mutex + Sorting bool } +// FIXME: If shouldSync, sync in background and return old version. If shouldWaitForSync, wait for sync and return new one. +// FIXME: If locked, just wait for unlock and return someone elses work. func (c *UserCache) gen(app *appContext) error { - // FIXME: I don't like this. - if !time.Now().After(c.LastSync.Add(WEB_USER_CACHE_SYNC)) { + shouldWaitForSync := time.Now().After(c.LastSync.Add(WEB_USER_CACHE_WAIT_FOR_SYNC)) || c.Ref == nil || len(c.Ref) == 0 + shouldSync := time.Now().After(c.LastSync.Add(WEB_USER_CACHE_SYNC)) + + if !shouldSync { return nil } - c.Lock.Lock() - users, err := app.jf.GetUsers(false) - if err != nil { + + syncStatus := make(chan error) + + go func(status chan error, c *UserCache) { + c.SyncLock.Lock() + alreadySyncing := c.Syncing + // We're either already syncing or will be + c.Syncing = true + c.SyncLock.Unlock() + if !alreadySyncing { + users, err := app.jf.GetUsers(false) + if err != nil { + c.SyncLock.Lock() + c.Syncing = false + c.SyncLock.Unlock() + status <- err + return + } + cache := make([]respUser, len(users)) + for i, jfUser := range users { + cache[i] = app.userSummary(jfUser) + } + ref := make([]*respUser, len(cache)) + for i := range cache { + ref[i] = &(cache[i]) + } + c.Cache = cache + c.Ref = ref + c.Sorted = false + c.LastSync = time.Now() + + c.SyncLock.Lock() + c.Syncing = false + c.SyncLock.Unlock() + } else { + for c.Syncing { + continue + } + } + status <- nil + }(syncStatus, c) + + if shouldWaitForSync { + err := <-syncStatus return err } - c.Cache = make([]respUser, len(users)) - for i, jfUser := range users { - c.Cache[i] = app.userSummary(jfUser) - } - c.Ref = make([]*respUser, len(c.Cache)) - for i := range c.Cache { - c.Ref[i] = &(c.Cache[i]) - } - c.Sorted = false - c.LastSync = time.Now() - c.Lock.Unlock() return nil } @@ -52,11 +93,21 @@ func (c *UserCache) Gen(app *appContext, sorted bool) ([]*respUser, error) { return nil, err } if sorted && !c.Sorted { - c.Lock.Lock() - // FIXME: Check we want ascending! - c.Sort(c.Ref, USER_DEFAULT_SORT_FIELD, true) - c.Sorted = true - c.Lock.Unlock() + c.SortLock.Lock() + alreadySorting := c.Sorting + c.Sorting = true + c.SortLock.Unlock() + if !alreadySorting { + c.Sort(c.Ref, USER_DEFAULT_SORT_FIELD, USER_DEFAULT_SORT_ASCENDING) + c.Sorted = true + c.SortLock.Lock() + c.Sorting = false + c.SortLock.Unlock() + } else { + for c.Sorting { + continue + } + } } return c.Ref, nil } From 58c7b695c9acff57e47f02de62e1ab085e0c0444 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Wed, 21 May 2025 21:45:53 +0100 Subject: [PATCH 030/249] activities: fix slow load w/ lots of users Added ID/Name indexing to mediabrowser, and cleaned it up a little bit. Was taking ~2s with 5000 users and firing tons of requests at Jellyfin, now take ~160ms from cold boot, ~1ms with cache. --- api-activities.go | 2 -- go.mod | 2 +- go.sum | 4 ++-- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/api-activities.go b/api-activities.go index 6d62751..d121aa4 100644 --- a/api-activities.go +++ b/api-activities.go @@ -119,7 +119,6 @@ func (app *appContext) GetActivities(gc *gin.Context) { var results []Activity err := app.storage.db.Find(&results, query) - if err != nil { app.err.Printf(lm.FailedDBReadActivities, err) } @@ -128,7 +127,6 @@ func (app *appContext) GetActivities(gc *gin.Context) { Activities: make([]ActivityDTO, len(results)), } resp.LastPage = len(results) != req.Limit - for i, act := range results { resp.Activities[i] = ActivityDTO{ ID: act.ID, diff --git a/go.mod b/go.mod index 6b17a34..b4edb41 100644 --- a/go.mod +++ b/go.mod @@ -43,7 +43,6 @@ require ( github.com/hrfee/jfa-go/logger v0.0.0-20241105225412-da4470bc4fbc github.com/hrfee/jfa-go/logmessages v0.0.0-20241105225412-da4470bc4fbc github.com/hrfee/jfa-go/ombi v0.0.0-20241105225412-da4470bc4fbc - github.com/hrfee/mediabrowser v0.3.25 github.com/itchyny/timefmt-go v0.1.6 github.com/lithammer/shortuuid/v3 v3.0.7 github.com/mailgun/mailgun-go/v4 v4.18.1 @@ -98,6 +97,7 @@ require ( github.com/google/flatbuffers v24.3.25+incompatible // indirect github.com/google/uuid v1.6.0 // indirect github.com/gorilla/websocket v1.5.3 // indirect + github.com/hrfee/mediabrowser v0.3.27 // indirect github.com/josharian/intern v1.0.0 // indirect github.com/json-iterator/go v1.1.12 // indirect github.com/klauspost/compress v1.17.11 // indirect diff --git a/go.sum b/go.sum index c9c85b6..bfeb19e 100644 --- a/go.sum +++ b/go.sum @@ -205,8 +205,8 @@ github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/ad github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg= github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ= -github.com/hrfee/mediabrowser v0.3.25 h1:UxpSSTmr5q12gKfeOR2ommvA/xhrP2rxVWmpWjDPRUY= -github.com/hrfee/mediabrowser v0.3.25/go.mod h1:PnHZbdxmbv1wCVdAQyM7nwPwpVj9fdKx2EcET7sAk+U= +github.com/hrfee/mediabrowser v0.3.27 h1:8bxPamBFLD1Xqy6pf6M3Oc5GUQ0iU/flO0S64G1AsIM= +github.com/hrfee/mediabrowser v0.3.27/go.mod h1:PnHZbdxmbv1wCVdAQyM7nwPwpVj9fdKx2EcET7sAk+U= github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8= github.com/itchyny/timefmt-go v0.1.6 h1:ia3s54iciXDdzWzwaVKXZPbiXzxxnv1SPGFfM/myJ5Q= github.com/itchyny/timefmt-go v0.1.6/go.mod h1:RRDZYC5s9ErkjQvTvvU7keJjxUYzIISJGxm9/mAERQg= From d0f740f99d544246d339e6487cc32bbe1cb091ef Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Thu, 22 May 2025 14:08:17 +0100 Subject: [PATCH 031/249] usercache: cleanup, also elsewhere removed some old FIXMEs and documented usercache nicely for once, renaming some things too. --- api-users.go | 6 +-- log.go | 2 +- logmessages/logmessages.go | 3 +- main.go | 2 +- ts/modules/search.ts | 4 +- usercache.go | 86 ++++++++++++++++++++++---------------- 6 files changed, 57 insertions(+), 46 deletions(-) diff --git a/api-users.go b/api-users.go index bbaa9d7..0ab670d 100644 --- a/api-users.go +++ b/api-users.go @@ -903,7 +903,7 @@ func (app *appContext) userSummary(jfUser mediabrowser.User) respUser { // @tags Activity func (app *appContext) GetUserCount(gc *gin.Context) { resp := PageCountDTO{} - userList, err := app.userCache.Gen(app, false) + userList, err := app.userCache.GetUserDTOs(app, false) if err != nil { app.err.Printf(lm.FailedGetUsers, lm.Jellyfin, err) respond(500, "Couldn't get users", gc) @@ -925,7 +925,7 @@ func (app *appContext) GetUsers(gc *gin.Context) { // We're sending all users, so this is always true resp.LastPage = true var err error - resp.UserList, err = app.userCache.Gen(app, true) + resp.UserList, err = app.userCache.GetUserDTOs(app, true) if err != nil { app.err.Printf(lm.FailedGetUsers, lm.Jellyfin, err) respond(500, "Couldn't get users", gc) @@ -950,7 +950,7 @@ func (app *appContext) SearchUsers(gc *gin.Context) { } var resp getUsersDTO - userList, err := app.userCache.Gen(app, req.SortByField == USER_DEFAULT_SORT_FIELD) + userList, err := app.userCache.GetUserDTOs(app, req.SortByField == USER_DEFAULT_SORT_FIELD) if err != nil { app.err.Printf(lm.FailedGetUsers, lm.Jellyfin, err) respond(500, "Couldn't get users", gc) diff --git a/log.go b/log.go index 636f342..f1b79e2 100644 --- a/log.go +++ b/log.go @@ -59,7 +59,7 @@ func logOutput() (closeFunc func(), err error) { // Regex that removes ANSI color escape sequences. Used for outputting to log file and log cache. var stripColors = func() *regexp.Regexp { - r, err := regexp.Compile("\\x1b\\[[0-9;]*m") + r, err := regexp.Compile(`\x1b\[[0-9;]*m`) if err != nil { log.Fatalf("Failed to compile color escape regexp: %v", err) } diff --git a/logmessages/logmessages.go b/logmessages/logmessages.go index 9e8249b..160ce3b 100644 --- a/logmessages/logmessages.go +++ b/logmessages/logmessages.go @@ -118,8 +118,7 @@ const ( SetAdminNotify = "Set \"%s\" to %t for admin address \"%s\"" // *jellyseerr*.go - FailedGetUsers = "Failed to get user(s) from %s: %v" - // FIXME: Once done, look back at uses of FailedGetUsers for places where this would make more sense. + FailedGetUsers = "Failed to get user(s) from %s: %v" FailedGetUser = "Failed to get user \"%s\" from %s: %v" FailedGetJellyseerrNotificationPrefs = "Failed to get user \"%s\"'s notification prefs from " + Jellyseerr + ": %v" FailedSyncContactMethods = "Failed to sync contact methods with %s: %v" diff --git a/main.go b/main.go index cb6d2c4..edb863c 100644 --- a/main.go +++ b/main.go @@ -528,7 +528,7 @@ func start(asDaemon, firstCall bool) { // NOTE: The order in which these are placed in app.contactMethods matters. // Add new ones to the end. - // FIXME: Add proxies. + // Proxies are added a little later through ContactMethodLinker[].SetTransport. if discordEnabled { app.discord, err = newDiscordDaemon(app) if err != nil { diff --git a/ts/modules/search.ts b/ts/modules/search.ts index 92f99ec..b0a2a18 100644 --- a/ts/modules/search.ts +++ b/ts/modules/search.ts @@ -54,8 +54,6 @@ export interface ServerSearchReqDTO extends PaginatedReqDTO { queries: QueryDTO[]; } -// FIXME: Generate ServerSearchReqDTO using Query.asDTO methods in serverSearch()! - export interface QueryDTO { class: "bool" | "string" | "date"; // QueryType.getter @@ -647,7 +645,7 @@ export class Search { constructor(c: SearchConfiguration) { // FIXME: Remove! - if (c.search.id.includes("accounts")) { + if (c.search.id.includes("activity")) { (window as any).s = this; } this._c = c; diff --git a/usercache.go b/usercache.go index 7864667..194b7d2 100644 --- a/usercache.go +++ b/usercache.go @@ -10,7 +10,6 @@ import ( ) const ( - // FIXME: Follow mediabrowser, or make tuneable, or both // After cache is this old, re-sync, but do it in the background and return the old cache. WEB_USER_CACHE_SYNC = 30 * time.Second // After cache is this old, re-sync and wait for it and return the new cache. @@ -19,6 +18,11 @@ const ( USER_DEFAULT_SORT_ASCENDING = true ) +// UserCache caches the transport representation of users, +// complementing the built-in cache of the mediabrowser package. +// Synchronisation runs in the background and consumers receive +// old data for responsiveness unless an extended expiry time has passed. +// It also provides methods for sorting, searching and filtering server-side. type UserCache struct { Cache []respUser Ref []*respUser @@ -30,9 +34,11 @@ type UserCache struct { Sorting bool } -// FIXME: If shouldSync, sync in background and return old version. If shouldWaitForSync, wait for sync and return new one. -// FIXME: If locked, just wait for unlock and return someone elses work. -func (c *UserCache) gen(app *appContext) error { +// MaybeSync (maybe) syncs the cache, resulting in updated UserCache.Cache/.Ref/.Sorted. +// Only syncs if WEB_USER_CACHE_SYNC duration has passed since last one. +// If WEB_USER_CACHE_WAIT_FOR_SYNC duration has passed, this will block until a sync is complete, otherwise it will sync in the background +// (expecting you to use the old cache data). Only one sync will run at a time. +func (c *UserCache) MaybeSync(app *appContext) error { shouldWaitForSync := time.Now().After(c.LastSync.Add(WEB_USER_CACHE_WAIT_FOR_SYNC)) || c.Ref == nil || len(c.Ref) == 0 shouldSync := time.Now().After(c.LastSync.Add(WEB_USER_CACHE_SYNC)) @@ -88,8 +94,8 @@ func (c *UserCache) gen(app *appContext) error { return nil } -func (c *UserCache) Gen(app *appContext, sorted bool) ([]*respUser, error) { - if err := c.gen(app); err != nil { +func (c *UserCache) GetUserDTOs(app *appContext, sorted bool) ([]*respUser, error) { + if err := c.MaybeSync(app); err != nil { return nil, err } if sorted && !c.Sorted { @@ -124,10 +130,11 @@ func bool2int(b bool) int { return i } -// Returns -1 if respUser < value, 0 if equal, 1 is greater than +// Sorter compares the given field of two respUsers, returning -1 if a < b, 0 if a == b, 1 if a > b. type Sorter func(a, b *respUser) int // Allow sorting by respUser's struct fields (well, it's JSON-representation's fields) +// SortUsersBy returns a Sorter function, which compares the given field of two respUsers, returning -1 if a < b, 0 if a == b, 1 if a > b. func SortUsersBy(field string) Sorter { switch field { case "id": @@ -204,11 +211,8 @@ func SortUsersBy(field string) Sorter { } } panic(fmt.Errorf("got invalid field %s", field)) - return nil } -type Filter func(*respUser) bool - type CompareResult int const ( @@ -256,10 +260,13 @@ func (d DateAttempt) Compare(subject int64) int { return subjectTime.Compare(time.Date(yy, mo, dd, hh, mm, 0, 0, nil)) } -// FIXME: Consider using QueryDTO.Class rather than assuming type from name? Probably not worthwhile though. -func FilterUsersBy(field string, op QueryOperator, value any) Filter { +// Filter returns true if a specific field in the passed respUser matches some internally defined value. +type Filter func(*respUser) bool + +// AsFilter returns a Filter function, which compares the queries value to the corresponding field's value in a passed respUser. +func (q QueryDTO) AsFilter() Filter { operator := Equal - switch op { + switch q.Operator { case LesserOperator: operator = Lesser case EqualOperator: @@ -268,84 +275,84 @@ func FilterUsersBy(field string, op QueryOperator, value any) Filter { operator = Greater } - switch field { + switch q.Field { case "id": return func(a *respUser) bool { - return cmp.Compare(strings.ToLower(a.ID), strings.ToLower(value.(string))) == int(operator) + return cmp.Compare(strings.ToLower(a.ID), strings.ToLower(q.Value.(string))) == int(operator) } case "name": return func(a *respUser) bool { - return cmp.Compare(strings.ToLower(a.Name), strings.ToLower(value.(string))) == int(operator) + return cmp.Compare(strings.ToLower(a.Name), strings.ToLower(q.Value.(string))) == int(operator) } case "email": return func(a *respUser) bool { - return cmp.Compare(strings.ToLower(a.Email), strings.ToLower(value.(string))) == int(operator) + return cmp.Compare(strings.ToLower(a.Email), strings.ToLower(q.Value.(string))) == int(operator) } case "notify_email": return func(a *respUser) bool { - return cmp.Compare(bool2int(a.NotifyThroughEmail), bool2int(value.(bool))) == int(operator) + return cmp.Compare(bool2int(a.NotifyThroughEmail), bool2int(q.Value.(bool))) == int(operator) } case "last_active": return func(a *respUser) bool { - return value.(DateAttempt).Compare(a.LastActive) == int(operator) + return q.Value.(DateAttempt).Compare(a.LastActive) == int(operator) } case "admin": return func(a *respUser) bool { - return cmp.Compare(bool2int(a.Admin), bool2int(value.(bool))) == int(operator) + return cmp.Compare(bool2int(a.Admin), bool2int(q.Value.(bool))) == int(operator) } case "expiry": return func(a *respUser) bool { - return value.(DateAttempt).Compare(a.Expiry) == int(operator) + return q.Value.(DateAttempt).Compare(a.Expiry) == int(operator) } case "disabled": return func(a *respUser) bool { - return cmp.Compare(bool2int(a.Disabled), bool2int(value.(bool))) == int(operator) + return cmp.Compare(bool2int(a.Disabled), bool2int(q.Value.(bool))) == int(operator) } case "telegram": return func(a *respUser) bool { - return cmp.Compare(strings.ToLower(a.Telegram), strings.ToLower(value.(string))) == int(operator) + return cmp.Compare(strings.ToLower(a.Telegram), strings.ToLower(q.Value.(string))) == int(operator) } case "notify_telegram": return func(a *respUser) bool { - return cmp.Compare(bool2int(a.NotifyThroughTelegram), bool2int(value.(bool))) == int(operator) + return cmp.Compare(bool2int(a.NotifyThroughTelegram), bool2int(q.Value.(bool))) == int(operator) } case "discord": return func(a *respUser) bool { - return cmp.Compare(strings.ToLower(a.Discord), strings.ToLower(value.(string))) == int(operator) + return cmp.Compare(strings.ToLower(a.Discord), strings.ToLower(q.Value.(string))) == int(operator) } case "discord_id": return func(a *respUser) bool { - return cmp.Compare(strings.ToLower(a.DiscordID), strings.ToLower(value.(string))) == int(operator) + return cmp.Compare(strings.ToLower(a.DiscordID), strings.ToLower(q.Value.(string))) == int(operator) } case "notify_discord": return func(a *respUser) bool { - return cmp.Compare(bool2int(a.NotifyThroughDiscord), bool2int(value.(bool))) == int(operator) + return cmp.Compare(bool2int(a.NotifyThroughDiscord), bool2int(q.Value.(bool))) == int(operator) } case "matrix": return func(a *respUser) bool { - return cmp.Compare(strings.ToLower(a.Matrix), strings.ToLower(value.(string))) == int(operator) + return cmp.Compare(strings.ToLower(a.Matrix), strings.ToLower(q.Value.(string))) == int(operator) } case "notify_matrix": return func(a *respUser) bool { - return cmp.Compare(bool2int(a.NotifyThroughMatrix), bool2int(value.(bool))) == int(operator) + return cmp.Compare(bool2int(a.NotifyThroughMatrix), bool2int(q.Value.(bool))) == int(operator) } case "label": return func(a *respUser) bool { - return cmp.Compare(strings.ToLower(a.Label), strings.ToLower(value.(string))) == int(operator) + return cmp.Compare(strings.ToLower(a.Label), strings.ToLower(q.Value.(string))) == int(operator) } case "accounts_admin": return func(a *respUser) bool { - return cmp.Compare(bool2int(a.AccountsAdmin), bool2int(value.(bool))) == int(operator) + return cmp.Compare(bool2int(a.AccountsAdmin), bool2int(q.Value.(bool))) == int(operator) } case "referrals_enabled": return func(a *respUser) bool { - return cmp.Compare(bool2int(a.ReferralsEnabled), bool2int(value.(bool))) == int(operator) + return cmp.Compare(bool2int(a.ReferralsEnabled), bool2int(q.Value.(bool))) == int(operator) } } - panic(fmt.Errorf("got invalid field %s", field)) - return nil + panic(fmt.Errorf("got invalid q.Field %s", q.Field)) } +// MatchesSearch checks (case-insensitively) if any string field in respUser includes the term string. func (ru *respUser) MatchesSearch(term string) bool { return (strings.Contains(ru.ID, term) || strings.Contains(strings.ToLower(ru.Name), term) || @@ -356,6 +363,7 @@ func (ru *respUser) MatchesSearch(term string) bool { strings.Contains(strings.ToLower(ru.Telegram), term)) } +// QueryClass is the class of a query (the datatype), i.e. bool, string or date. type QueryClass string const ( @@ -364,6 +372,7 @@ const ( DateQuery QueryClass = "date" ) +// QueryOperator is the operator used for comparison in a filter, i.e. <, = or >. type QueryOperator string const ( @@ -372,6 +381,7 @@ const ( GreaterOperator QueryOperator = ">" ) +// QueryDTO is the transport representation of a Query, sent from the web app. type QueryDTO struct { Class QueryClass `json:"class"` Field string `json:"field"` @@ -380,17 +390,20 @@ type QueryDTO struct { Value any `json:"value"` } +// ServerSearchReqDTO is a usual PaginatedReqDTO with added fields for searching and filtering. type ServerSearchReqDTO struct { PaginatedReqDTO SearchTerms []string `json:"searchTerms"` Queries []QueryDTO `json:"queries"` } -// Filter by AND-ing all search terms and queries. +// Filter reduces the passed slice of *respUsers +// by searching for each term of terms[] with respUser.MatchesSearch, +// and by evaluating Queries with Query.AsFilter(). func (c *UserCache) Filter(users []*respUser, terms []string, queries []QueryDTO) []*respUser { filters := make([]Filter, len(queries)) for i, q := range queries { - filters[i] = FilterUsersBy(q.Field, q.Operator, q.Value) + filters[i] = q.AsFilter() } // FIXME: Properly consider pre-allocation size out := make([]*respUser, 0, len(users)/4) @@ -418,6 +431,7 @@ func (c *UserCache) Filter(users []*respUser, terms []string, queries []QueryDTO return out } +// Sort sorts the given slice of of *respUsers in-place by the field name given, in ascending or descending order. func (c *UserCache) Sort(users []*respUser, field string, ascending bool) { slices.SortFunc(users, SortUsersBy(field)) if !ascending { From 64a144034daa7f890224d1b3277eb01fa97bc859 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Thu, 22 May 2025 18:03:18 +0100 Subject: [PATCH 032/249] config: add user cache async/sync timeout options previously were constants in usercache.go, now app.userCache is instantiated in main.go with NewUserCache(time.Duration, time.Duration). --- config.go | 4 ++++ main.go | 9 +++++++-- usercache.go | 35 +++++++++++++++++++++-------------- 3 files changed, 32 insertions(+), 16 deletions(-) diff --git a/config.go b/config.go index 53f846f..9ad5b59 100644 --- a/config.go +++ b/config.go @@ -188,6 +188,10 @@ func (app *appContext) loadConfig() error { app.config.Section("jellyfin").Key("device").SetValue("jfa-go") app.config.Section("jellyfin").Key("device_id").SetValue(fmt.Sprintf("jfa-go-%s-%s", version, commit)) + app.MustSetValue("jellyfin", "cache_timeout", "30") + app.MustSetValue("jellyfin", "web_cache_async_timeout", "1") + app.MustSetValue("jellyfin", "web_cache_sync_timeout", "10") + LOGIP = app.config.Section("advanced").Key("log_ips").MustBool(false) LOGIPU = app.config.Section("advanced").Key("log_ips_users").MustBool(false) diff --git a/main.go b/main.go index edb863c..2ec8f7c 100644 --- a/main.go +++ b/main.go @@ -134,7 +134,7 @@ type appContext struct { pwrCaptchas map[string]Captcha ConfirmationKeys map[string]map[string]ConfirmationKey // Map of invite code to jwt to request confirmationKeysLock sync.Mutex - userCache UserCache + userCache *UserCache } func generateSecret(length int) (string, error) { @@ -406,7 +406,7 @@ func start(asDaemon, firstCall bool) { // Initialize jellyfin/emby connection server := app.config.Section("jellyfin").Key("server").String() - cacheTimeout := int(app.config.Section("jellyfin").Key("cache_timeout").MustUint(30)) + cacheTimeout := app.config.Section("jellyfin").Key("cache_timeout").MustInt() stringServerType := app.config.Section("jellyfin").Key("type").String() timeoutHandler := mediabrowser.NewNamedTimeoutHandler("Jellyfin", "\""+server+"\"", true) if stringServerType == "emby" { @@ -469,6 +469,11 @@ func start(asDaemon, firstCall bool) { } } + app.userCache = NewUserCache( + time.Minute*time.Duration(app.config.Section("jellyfin").Key("web_cache_async_timeout").MustInt()), + time.Minute*time.Duration(app.config.Section("jellyfin").Key("web_cache_sync_timeout").MustInt()), + ) + // Since email depends on language, the email reload in loadConfig won't work first time. // Email also handles its own proxying, as (SMTP atleast) doesn't use a HTTP transport. app.email = NewEmailer(app) diff --git a/usercache.go b/usercache.go index 194b7d2..5d52542 100644 --- a/usercache.go +++ b/usercache.go @@ -10,12 +10,8 @@ import ( ) const ( - // After cache is this old, re-sync, but do it in the background and return the old cache. - WEB_USER_CACHE_SYNC = 30 * time.Second - // After cache is this old, re-sync and wait for it and return the new cache. - WEB_USER_CACHE_WAIT_FOR_SYNC = 5 * time.Minute - USER_DEFAULT_SORT_FIELD = "name" - USER_DEFAULT_SORT_ASCENDING = true + USER_DEFAULT_SORT_FIELD = "name" + USER_DEFAULT_SORT_ASCENDING = true ) // UserCache caches the transport representation of users, @@ -28,19 +24,30 @@ type UserCache struct { Ref []*respUser Sorted bool LastSync time.Time - SyncLock sync.Mutex - Syncing bool - SortLock sync.Mutex - Sorting bool + // After cache is this old, re-sync, but do it in the background and return the old cache. + SyncTimeout time.Duration + // After cache is this old, re-sync and wait for it and return the new cache. + WaitForSyncTimeout time.Duration + SyncLock sync.Mutex + Syncing bool + SortLock sync.Mutex + Sorting bool +} + +func NewUserCache(syncTimeout, waitForSyncTimeout time.Duration) *UserCache { + return &UserCache{ + SyncTimeout: syncTimeout, + WaitForSyncTimeout: waitForSyncTimeout, + } } // MaybeSync (maybe) syncs the cache, resulting in updated UserCache.Cache/.Ref/.Sorted. -// Only syncs if WEB_USER_CACHE_SYNC duration has passed since last one. -// If WEB_USER_CACHE_WAIT_FOR_SYNC duration has passed, this will block until a sync is complete, otherwise it will sync in the background +// Only syncs if c.SyncTimeout duration has passed since last one. +// If c.WaitForSyncTimeout duration has passed, this will block until a sync is complete, otherwise it will sync in the background // (expecting you to use the old cache data). Only one sync will run at a time. func (c *UserCache) MaybeSync(app *appContext) error { - shouldWaitForSync := time.Now().After(c.LastSync.Add(WEB_USER_CACHE_WAIT_FOR_SYNC)) || c.Ref == nil || len(c.Ref) == 0 - shouldSync := time.Now().After(c.LastSync.Add(WEB_USER_CACHE_SYNC)) + shouldWaitForSync := time.Now().After(c.LastSync.Add(c.WaitForSyncTimeout)) || c.Ref == nil || len(c.Ref) == 0 + shouldSync := time.Now().After(c.LastSync.Add(c.SyncTimeout)) if !shouldSync { return nil From 1ec3ddad9f7ca06be427ef669eee6252297f1215 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Thu, 22 May 2025 21:08:25 +0100 Subject: [PATCH 033/249] accounts: infinite scroll for performance Found out the bottleneck when ~2000 or more elements are loaded isn't the search or sort or anything, but the DOM. An infinite scroll implementation is added, where elements are added to the DOM as you scroll. May still be a little buggy, and can't yet cope with screen resizes. Also, the "shown" indicator is broken. --- config/config-base.yaml | 14 ++++ ts/admin.ts | 2 +- ts/modules/accounts.ts | 51 ++++++------- ts/modules/activity.ts | 23 ++---- ts/modules/common.ts | 17 +++++ ts/modules/list.ts | 158 ++++++++++++++++++++++++++++++++++++---- ts/modules/search.ts | 18 +++-- 7 files changed, 216 insertions(+), 67 deletions(-) diff --git a/config/config-base.yaml b/config/config-base.yaml index 16a021f..4fc1a00 100644 --- a/config/config-base.yaml +++ b/config/config-base.yaml @@ -65,6 +65,20 @@ sections: type: number value: 30 description: Timeout of user cache in minutes. Set to 0 to disable. + - setting: web_cache_async_timeout + name: User search cache asynchronous timeout (minutes) + requires_restart: true + advanced: true + type: number + value: 1 + description: "Synchronise after cache is this old, but don't wait for it: The accounts tab will load quickly but show old results until the next request." + - setting: web_cache_sync_timeout + name: User search cache synchronous timeout (minutes) + requires_restart: true + advanced: true + type: number + value: 10 + description: "Synchronise after cache is this old, and wait for it: The accounts tab may take a little longer to load while it does." - setting: type name: Server type requires_restart: true diff --git a/ts/admin.ts b/ts/admin.ts index 45aea1a..a8d054d 100644 --- a/ts/admin.ts +++ b/ts/admin.ts @@ -192,7 +192,7 @@ login.onLogin = () => { window.updater = new Updater(); // FIXME: Decide whether to autoload activity or not reloadProfileNames(); - setInterval(() => { window.invites.reload(); accounts.reload(); }, 30*1000); + setInterval(() => { window.invites.reload(); accounts.reloadIfNotInScroll(); }, 30*1000); // Triggers pre and post funcs, even though we're already on that page window.tabs.switch(window.tabs.current); } diff --git a/ts/modules/accounts.ts b/ts/modules/accounts.ts index 46f50b3..22cda3d 100644 --- a/ts/modules/accounts.ts +++ b/ts/modules/accounts.ts @@ -1,11 +1,13 @@ -import { _get, _post, _delete, toggleLoader, addLoader, removeLoader, toDateString, insertText, toClipboard } from "../modules/common.js"; -import { templateEmail } from "../modules/settings.js"; +import { _get, _post, _delete, toggleLoader, addLoader, removeLoader, toDateString, insertText, toClipboard } from "../modules/common" +import { templateEmail } from "../modules/settings" import { Marked } from "@ts-stack/markdown"; -import { stripMarkdown } from "../modules/stripmd.js"; -import { DiscordUser, newDiscordSearch } from "../modules/discord.js"; -import { Search, SearchConfiguration, QueryType, SearchableItem, SearchableItems } from "../modules/search.js"; -import { HiddenInputField } from "./ui.js"; -import { PaginatedList } from "./list.js"; +import { stripMarkdown } from "../modules/stripmd" +import { DiscordUser, newDiscordSearch } from "../modules/discord" +import { SearchConfiguration, QueryType, SearchableItem, SearchableItemDataAttribute } from "../modules/search" +import { HiddenInputField } from "./ui" +import { PaginatedList } from "./list" + +// FIXME: Find and define a threshold after which searches are no longer performed on input (or just in general by the browser). declare var window: GlobalWindow; @@ -780,7 +782,10 @@ class user implements User, SearchableItem { }); get id() { return this._id; } - set id(v: string) { this._id = v; } + set id(v: string) { + this._id = v; + this._row.setAttribute(SearchableItemDataAttribute, v); + } update = (user: User) => { @@ -821,10 +826,8 @@ interface UsersDTO extends paginatedDTO { users: User[]; } -interface UsersReqDTO extends PaginatedReqDTO {}; - export class accountsList extends PaginatedList { - private _table = document.getElementById("accounts-list") as HTMLTableSectionElement; + protected _container = document.getElementById("accounts-list") as HTMLTableSectionElement; private _addUserButton = document.getElementById("accounts-add-user") as HTMLSpanElement; private _announceButton = document.getElementById("accounts-announce") as HTMLSpanElement; @@ -973,6 +976,9 @@ export class accountsList extends PaginatedList { }); this._populateNumbers(); + // FIXME: Remove! + (window as any).s = this; + let searchConfig: SearchConfiguration = { filterArea: this._c.filterArea, sortingByButton: this._sortingByButton, @@ -1253,7 +1259,7 @@ export class accountsList extends PaginatedList { set selectAll(state: boolean) { let count = 0; for (let id in this.users) { - if (this._table.contains(this.users[id].asElement())) { // Only select visible elements + if (this._container.contains(this.users[id].asElement())) { // Only select visible elements this.users[id].selected = state; count++; } @@ -1268,7 +1274,7 @@ export class accountsList extends PaginatedList { for (let id of this._search.ordering) { if (!(inRange || id == startID)) continue; inRange = true; - if (!(this._table.contains(this.users[id].asElement()))) continue; + if (!(this._container.contains(this.users[id].asElement()))) continue; this.users[id].selected = true; if (id == endID) return; } @@ -1300,7 +1306,7 @@ export class accountsList extends PaginatedList { } else { let visibleCount = 0; for (let id in this.users) { - if (this._table.contains(this.users[id].asElement())) { + if (this._container.contains(this.users[id].asElement())) { visibleCount++; } } @@ -1403,7 +1409,7 @@ export class accountsList extends PaginatedList { private _collectUsers = (): string[] => { let list: string[] = []; for (let id in this.users) { - if (this._table.contains(this.users[id].asElement()) && this.users[id].selected) { list.push(id); } + if (this._container.contains(this.users[id].asElement()) && this.users[id].selected) { list.push(id); } } return list; } @@ -2065,20 +2071,7 @@ export class accountsList extends PaginatedList { this._displayExpiryDate(); window.modals.extendExpiry.show(); } - - - setVisibility = (users: string[], visible: boolean) => { - console.log(`setting ${users.length} users as visible: ${visible}`); - this._table.textContent = ""; - for (let id of this._search.ordering) { - if (visible && users.indexOf(id) != -1) { - this._table.appendChild(this.users[id].asElement()); - } else if (!visible && users.indexOf(id) == -1) { - this._table.appendChild(this.users[id].asElement()); - } - } - } - + private _populateAddUserProfiles = () => { this._addUserProfile.textContent = ""; let innerHTML = ``; diff --git a/ts/modules/activity.ts b/ts/modules/activity.ts index 7f63017..5eb0387 100644 --- a/ts/modules/activity.ts +++ b/ts/modules/activity.ts @@ -1,5 +1,5 @@ import { _get, _post, _delete, toDateString } from "../modules/common.js"; -import { SearchConfiguration, QueryType, SearchableItem, SearchableItems } from "../modules/search.js"; +import { SearchConfiguration, QueryType, SearchableItem, SearchableItems, SearchableItemDataAttribute } from "../modules/search.js"; import { accountURLEvent } from "../modules/accounts.js"; import { inviteURLEvent } from "../modules/invites.js"; import { PaginatedList } from "./list.js"; @@ -353,7 +353,10 @@ export class Activity implements activity, SearchableItem { } get id(): string { return this._act.id; } - set id(v: string) { this._act.id = v; } + set id(v: string) { + this._act.id = v; + this._card.setAttribute(SearchableItemDataAttribute, v); + } get user_id(): string { return this._act.user_id; } set user_id(v: string) { this._act.user_id = v; } @@ -379,6 +382,7 @@ export class Activity implements activity, SearchableItem { this._card = document.createElement("div"); this._card.classList.add("card", "@low", "my-2"); + this._card.innerHTML = `
@@ -476,7 +480,7 @@ interface ActivitiesDTO extends paginatedDTO { } export class activityList extends PaginatedList { - protected _activityList: HTMLElement; + protected _container: HTMLElement; // protected _sortingByButton = document.getElementById("activity-sort-by-field") as HTMLButtonElement; protected _sortDirection = document.getElementById("activity-sort-direction") as HTMLButtonElement; @@ -525,7 +529,7 @@ export class activityList extends PaginatedList { } }); - this._activityList = document.getElementById("activity-card-list") + this._container = document.getElementById("activity-card-list") document.addEventListener("activity-reload", this.reload); let searchConfig: SearchConfiguration = { @@ -553,17 +557,6 @@ export class activityList extends PaginatedList { this._sortDirection.addEventListener("click", () => this.ascending = !this.ascending); } - setVisibility = (activities: string[], visible: boolean) => { - this._activityList.textContent = ``; - for (let id of this._search.ordering) { - if (visible && activities.indexOf(id) != -1) { - this._activityList.appendChild(this.activities[id].asElement()); - } else if (!visible && activities.indexOf(id) == -1) { - this._activityList.appendChild(this.activities[id].asElement()); - } - } - } - reload = () => { this._reload(); } diff --git a/ts/modules/common.ts b/ts/modules/common.ts index 40b5ddd..e417431 100644 --- a/ts/modules/common.ts +++ b/ts/modules/common.ts @@ -306,3 +306,20 @@ export function unicodeB64Encode(s: string): string { const bin = String.fromCodePoint(...encoded); return btoa(bin); } + +// Only allow running a function every n milliseconds. +// Source: Clément Prévost at https://stackoverflow.com/questions/27078285/simple-throttle-in-javascript +// function foo(bar: T): T { +export function throttle (callback: () => void, limitMilliseconds: number): () => void { + var waiting = false; // Initially, we're not waiting + return function () { // We return a throttled function + if (!waiting) { // If we're not waiting + callback.apply(this, arguments); // Execute users function + waiting = true; // Prevent future invocations + setTimeout(function () { // After a period of time + waiting = false; // And allow future invocations + }, limitMilliseconds); + } + } +} + diff --git a/ts/modules/list.ts b/ts/modules/list.ts index 414b550..bac8acc 100644 --- a/ts/modules/list.ts +++ b/ts/modules/list.ts @@ -1,5 +1,5 @@ -import { _get, _post, addLoader, removeLoader } from "./common"; -import { Search, SearchConfiguration, SearchableItems } from "./search"; +import { _get, _post, addLoader, removeLoader, throttle } from "./common"; +import { Search, SearchConfiguration } from "./search"; declare var window: GlobalWindow; @@ -93,7 +93,22 @@ export interface PaginatedListConfig { export abstract class PaginatedList { protected _c: PaginatedListConfig; - + + // Container to append items to. + protected _container: HTMLElement; + // List of visible IDs (i.e. those set with setVisibility). + protected _visible: string[]; + protected _scroll = { + rowHeight: 0, + screenHeight: 0, + // Render this many screen's worth of content below the viewport. + renderNExtraScreensWorth: 3, + rowsOnPage: 0, + rendered: 0, + initialRenderCount: 0, + scrollLoading: false + }; + protected _search: Search; protected _counter: RecordCounter; @@ -148,7 +163,6 @@ export abstract class PaginatedList { this.loadMore(() => removeLoader(this._keepSearchingButton, true)); }; */ // Since this.reload doesn't exist, we need an arrow function to wrap it. - // FIXME: Make sure it works though! this._c.refreshButton.onclick = () => this.reload(); } @@ -198,7 +212,80 @@ export abstract class PaginatedList { }; // Sets the elements with "name"s in "elements" as visible or not. - public abstract setVisibility: (elements: string[], visible: boolean) => void; + setVisibilityNaive = (elements: string[], visible: boolean) => { + let timer = this._search.timeSearches ? performance.now() : null; + if (visible) this._visible = elements; + else this._visible = this._search.ordering.filter(v => !elements.includes(v)); + const frag = document.createDocumentFragment() + for (let i = 0; i < this._visible.length; i++) { + frag.appendChild(this._search.items[this._visible[i]].asElement()) + } + this._container.replaceChildren(frag); + if (this._search.timeSearches) { + const totalTime = performance.now() - timer; + console.log(`setVisibility took ${totalTime}ms`); + } + } + + // FIXME: Call on window resize/zoom + // FIXME: On reload, load enough pages to fill required space. + // FIXME: Might have broken _counter.shown! + // Sets the elements with "name"s in "elements" as visible or not. + // appendedItems==true implies "elements" is the previously rendered elements plus some new ones on the end. Knowing this means the page's infinite scroll doesn't have to be reset. + setVisibility = (elements: string[], visible: boolean, appendedItems: boolean = false) => { + let timer = this._search.timeSearches ? performance.now() : null; + if (visible) this._visible = elements; + else this._visible = this._search.ordering.filter(v => !elements.includes(v)); + if (this._visible.length == 0) return; + + this._scroll.screenHeight = Math.max( + document.documentElement.clientHeight, + window.innerHeight || 0 + ); + + if (!appendedItems) { + // Wipe old elements and render 1 new one, so we can take the element height. + this._container.replaceChildren(this._search.items[this._visible[0]].asElement()) + } + + this.computeScrollInfo(); + + let baseIndex = 1; + if (appendedItems) { + baseIndex = this._scroll.rendered; + } + const frag = document.createDocumentFragment() + for (let i = baseIndex; i < this._scroll.initialRenderCount; i++) { + frag.appendChild(this._search.items[this._visible[i]].asElement()) + } + this._scroll.rendered = Math.max(baseIndex, this._scroll.initialRenderCount); + // appendChild over replaceChildren because there's already elements on the DOM + this._container.appendChild(frag); + + if (this._search.timeSearches) { + const totalTime = performance.now() - timer; + console.log(`setVisibility took ${totalTime}ms`); + } + } + + // Computes required scroll info, requiring one on-DOM item. Should be computed on page resize and this._visible change. + computeScrollInfo = () => { + this._scroll.rowHeight = this._search.items[this._visible[0]].asElement().offsetHeight; + + // We want to have _scroll.renderNScreensWorth*_scroll.screenHeight or more elements rendered always. + this._scroll.rowsOnPage = Math.floor(this._scroll.screenHeight / this._scroll.rowHeight); + + // Initial render of min(_visible.length, max(rowsOnPage*renderNExtraScreensWorth, itemsPerPage)), skipping 1 as we already did it. + this._scroll.initialRenderCount = Math.min(this._visible.length, Math.max((this._scroll.renderNExtraScreensWorth+1)*this._scroll.rowsOnPage, this._c.itemsPerPage)); + } + + // returns the item index to render up to for the given scroll position. + // might return a value greater than this._visible.length, indicating a need for a page load. + maximumItemsToRender = (scrollY: number): number => { + const bottomScroll = scrollY + ((this._scroll.renderNExtraScreensWorth+1)*this._scroll.screenHeight); + const bottomIdx = Math.floor(bottomScroll / this._scroll.rowsOnPage); + return bottomIdx; + } // Removes all elements, and reloads the first page. // FIXME: Share more code between reload and loadMore, and go over the logic, it's messy. @@ -309,26 +396,65 @@ export abstract class PaginatedList { } this._search.onSearchBoxChange(true, loadAll); } else { - this.setVisibility(this._search.ordering, true); + // Since results come to us ordered already, we can assume "ordering" + // will be identical to pre-page-load but with extra elements at the end, + // allowing infinite scroll to continue + this.setVisibility(this._search.ordering, true, true); this._search.setNotFoundPanelVisibility(false); } if (this._c.pageLoadCallback) this._c.pageLoadCallback(req); if (callback) callback(req); }, true) } - - // Should be assigned to window.onscroll whenever the list is in view. - detectScroll = () => { - if (!this._hasLoaded || this.lastPage) return; - // console.log(window.innerHeight + document.documentElement.scrollTop, document.scrollingElement.scrollHeight); - if (Math.abs(window.innerHeight + document.documentElement.scrollTop - document.scrollingElement.scrollHeight) < 50) { - // window.notifications.customSuccess("scroll", "Reached bottom."); - // Wait .5s between loads - if (this._lastLoad + 500 > Date.now()) return; - this.loadMore(null, false); + + loadNItems = (n: number) => { + const cb = () => { + if (this._counter.loaded > n) return; + this.loadMore(cb, false); + } + cb(); + } + + // As reloading can disrupt long-scrolling, this function will only do it if you're at the top of the page, essentially. + public reloadIfNotInScroll = () => { + if (this.maximumItemsToRender(window.scrollY) < this._scroll.initialRenderCount) { + return this.reload(); } } + _detectScroll = () => { + if (!this._hasLoaded || this._scroll.scrollLoading) return; + if (this._visible.length == 0) return; + const endIdx = this.maximumItemsToRender(window.scrollY); + // If you've scrolled back up, do nothing + if (endIdx <= this._scroll.rendered) return; + + const realEndIdx = Math.min(endIdx, this._visible.length); + const frag = document.createDocumentFragment(); + for (let i = this._scroll.rendered; i < realEndIdx; i++) { + frag.appendChild(this._search.items[this._visible[i]].asElement()); + } + this._scroll.rendered = realEndIdx; + this._container.appendChild(frag); + + if (endIdx >= this._visible.length) { + if (this.lastPage || this._lastLoad + 500 > Date.now()) return; + this._scroll.scrollLoading = true; + const cb = () => { + if (this._visible.length < endIdx && !this.lastPage) { + this.loadMore(cb, false) + return; + } + this._scroll.scrollLoading = false; + this._detectScroll(); + }; + cb(); + return; + } + } + + // Should be assigned to window.onscroll whenever the list is in view. + detectScroll = throttle(this._detectScroll, 200); } diff --git a/ts/modules/search.ts b/ts/modules/search.ts index b0a2a18..b8d9388 100644 --- a/ts/modules/search.ts +++ b/ts/modules/search.ts @@ -269,8 +269,12 @@ export class DateQuery extends Query { export interface SearchableItem { matchesSearch: (query: string) => boolean; + // FIXME: SearchableItem should really be ListItem or something, this isn't for search! + asElement: () => HTMLElement; } +export const SearchableItemDataAttribute = "data-search-item"; + export type SearchableItems = { [id: string]: SearchableItem }; export class Search { @@ -294,6 +298,9 @@ export class Search { } } + // Intended to be set from the JS console, if true searches are timed. + timeSearches: boolean = false; + private _serverSearchButtons: HTMLElement[]; static tokenizeSearch = (query: string): string[] => { @@ -398,6 +405,7 @@ export class Search { // Returns a list of identifiers (used as keys in items, values in ordering). search = (query: string): string[] => { + let timer = this.timeSearches ? performance.now() : null; this._c.filterArea.textContent = ""; let result: string[] = [...this._ordering]; @@ -460,6 +468,10 @@ export class Search { this._queries = queries; this._searchTerms = searchTerms; + if (this.timeSearches) { + const totalTime = performance.now() - timer; + console.log(`Search took ${totalTime}ms`); + } return result; } @@ -528,10 +540,8 @@ export class Search { this._c.notFoundLocallyText.classList.remove("unfocused"); } if (visible) { - console.log("showing not found panel"); this._c.notFoundPanel.classList.remove("unfocused"); } else { - console.log("hiding not found panel"); this._c.notFoundPanel.classList.add("unfocused"); } } @@ -644,10 +654,6 @@ export class Search { } constructor(c: SearchConfiguration) { - // FIXME: Remove! - if (c.search.id.includes("activity")) { - (window as any).s = this; - } this._c = c; this._c.search.oninput = () => { From bdae52fad7c1e249649ae76dfe4792086567782f Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Thu, 22 May 2025 21:38:30 +0100 Subject: [PATCH 034/249] accounts: add credit for infinite scroll --- ts/modules/list.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/ts/modules/list.ts b/ts/modules/list.ts index bac8acc..cf4a507 100644 --- a/ts/modules/list.ts +++ b/ts/modules/list.ts @@ -98,6 +98,9 @@ export abstract class PaginatedList { protected _container: HTMLElement; // List of visible IDs (i.e. those set with setVisibility). protected _visible: string[]; + // Infinite-scroll related data. + // Implementation partially based on this blog post, thank you Miina Lervik: + // https://www.bekk.christmas/post/2021/02/how-to-lazy-render-large-data-tables-to-up-performance protected _scroll = { rowHeight: 0, screenHeight: 0, From 47188da5c2947084debe59ca01aa607c586ef59c Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Fri, 23 May 2025 13:53:16 +0100 Subject: [PATCH 035/249] accounts: fix infinite scroll over-loading, use scrollend+polyfill calculation for number of rows to be drawn was wrong, fixed now. To compensate for overshooting with fast scrolling, speed is calculated using previous scrollY in rows/scroll, and used to render more rows. Also, the "scrollend" event is used to load more at the end of a scroll always. Since this isn't available on safari/webkit(2gtk), a polyfill has been added. --- package-lock.json | 12 +++++++ package.json | 1 + ts/admin.ts | 11 ++++--- ts/modules/list.ts | 79 ++++++++++++++++++++++++++++++++++------------ ts/modules/tabs.ts | 3 +- ts/typings/d.ts | 2 +- 6 files changed, 82 insertions(+), 26 deletions(-) diff --git a/package-lock.json b/package-lock.json index cd02357..23aaab8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,6 +9,7 @@ "version": "1.0.0", "license": "ISC", "dependencies": { + "@af-utils/scrollend-polyfill": "^0.0.14", "@ts-stack/markdown": "^1.4.0", "@types/node": "^20.3.0", "a17t": "^0.10.1", @@ -36,6 +37,12 @@ "esbuild": "^0.18.20" } }, + "node_modules/@af-utils/scrollend-polyfill": { + "version": "0.0.14", + "resolved": "https://registry.npmjs.org/@af-utils/scrollend-polyfill/-/scrollend-polyfill-0.0.14.tgz", + "integrity": "sha512-pThXK3XqbWeJHJJAEzhNqCEgOiZ7Flk/Wj/uM6+TGJuA/3n/NeKP3C+5o4jt79i46Cc18iA0kJaMd056GQTfYQ==", + "license": "MIT" + }, "node_modules/@alloc/quick-lru": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/@alloc/quick-lru/-/quick-lru-5.2.0.tgz", @@ -7293,6 +7300,11 @@ } }, "dependencies": { + "@af-utils/scrollend-polyfill": { + "version": "0.0.14", + "resolved": "https://registry.npmjs.org/@af-utils/scrollend-polyfill/-/scrollend-polyfill-0.0.14.tgz", + "integrity": "sha512-pThXK3XqbWeJHJJAEzhNqCEgOiZ7Flk/Wj/uM6+TGJuA/3n/NeKP3C+5o4jt79i46Cc18iA0kJaMd056GQTfYQ==" + }, "@alloc/quick-lru": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/@alloc/quick-lru/-/quick-lru-5.2.0.tgz", diff --git a/package.json b/package.json index 441a052..64a083a 100644 --- a/package.json +++ b/package.json @@ -17,6 +17,7 @@ }, "homepage": "https://github.com/hrfee/jfa-go#readme", "dependencies": { + "@af-utils/scrollend-polyfill": "^0.0.14", "@ts-stack/markdown": "^1.4.0", "@types/node": "^20.3.0", "a17t": "^0.10.1", diff --git a/ts/admin.ts b/ts/admin.ts index a8d054d..925e58d 100644 --- a/ts/admin.ts +++ b/ts/admin.ts @@ -127,7 +127,7 @@ let isInviteURL = window.invites.isInviteURL(); let isAccountURL = accounts.isAccountURL(); // load tabs -const tabs: { id: string, url: string, reloader: () => void }[] = [ +const tabs: { id: string, url: string, reloader: () => void, unloader?: () => void }[] = [ { id: "invites", url: "", @@ -148,16 +148,19 @@ const tabs: { id: string, url: string, reloader: () => void }[] = [ // Don't keep loading the same item on every tab refresh isAccountURL = false; } - window.onscroll = accounts.detectScroll; + accounts.bindPageEvents(); }), + unloader: accounts.unbindPageEvents + }, { id: "activity", url: "activity", reloader: () => { activity.reload() - window.onscroll = activity.detectScroll; + activity.bindPageEvents(); }, + unloader: activity.unbindPageEvents }, { id: "settings", @@ -171,7 +174,7 @@ const defaultTab = tabs[0]; window.tabs = new Tabs(); for (let tab of tabs) { - window.tabs.addTab(tab.id, window.pages.Admin + "/" + tab.url, null, tab.reloader); + window.tabs.addTab(tab.id, window.pages.Admin + "/" + tab.url, null, tab.reloader, tab.unloader || null); } let matchedTab = false diff --git a/ts/modules/list.ts b/ts/modules/list.ts index cf4a507..9f2507e 100644 --- a/ts/modules/list.ts +++ b/ts/modules/list.ts @@ -1,5 +1,6 @@ import { _get, _post, addLoader, removeLoader, throttle } from "./common"; import { Search, SearchConfiguration } from "./search"; +import "@af-utils/scrollend-polyfill"; declare var window: GlobalWindow; @@ -106,10 +107,11 @@ export abstract class PaginatedList { screenHeight: 0, // Render this many screen's worth of content below the viewport. renderNExtraScreensWorth: 3, - rowsOnPage: 0, rendered: 0, initialRenderCount: 0, - scrollLoading: false + scrollLoading: false, + // Used to calculate scroll speed, so more pages are loaded when scrolling fast. + lastScrollY: 0, }; protected _search: Search; @@ -230,7 +232,6 @@ export abstract class PaginatedList { } } - // FIXME: Call on window resize/zoom // FIXME: On reload, load enough pages to fill required space. // FIXME: Might have broken _counter.shown! // Sets the elements with "name"s in "elements" as visible or not. @@ -241,17 +242,20 @@ export abstract class PaginatedList { else this._visible = this._search.ordering.filter(v => !elements.includes(v)); if (this._visible.length == 0) return; - this._scroll.screenHeight = Math.max( - document.documentElement.clientHeight, - window.innerHeight || 0 - ); - if (!appendedItems) { // Wipe old elements and render 1 new one, so we can take the element height. this._container.replaceChildren(this._search.items[this._visible[0]].asElement()) } - this.computeScrollInfo(); + this._computeScrollInfo(); + + // Initial render of min(_visible.length, max(rowsOnPage*renderNExtraScreensWorth, itemsPerPage)), skipping 1 as we already did it. + this._scroll.initialRenderCount = Math.floor(Math.min( + this._visible.length, + Math.max( + ((this._scroll.renderNExtraScreensWorth+1)*this._scroll.screenHeight)/this._scroll.rowHeight, + this._c.itemsPerPage) + )); let baseIndex = 1; if (appendedItems) { @@ -272,21 +276,20 @@ export abstract class PaginatedList { } // Computes required scroll info, requiring one on-DOM item. Should be computed on page resize and this._visible change. - computeScrollInfo = () => { + _computeScrollInfo = () => { + this._scroll.screenHeight = Math.max( + document.documentElement.clientHeight, + window.innerHeight || 0 + ); + this._scroll.rowHeight = this._search.items[this._visible[0]].asElement().offsetHeight; - - // We want to have _scroll.renderNScreensWorth*_scroll.screenHeight or more elements rendered always. - this._scroll.rowsOnPage = Math.floor(this._scroll.screenHeight / this._scroll.rowHeight); - - // Initial render of min(_visible.length, max(rowsOnPage*renderNExtraScreensWorth, itemsPerPage)), skipping 1 as we already did it. - this._scroll.initialRenderCount = Math.min(this._visible.length, Math.max((this._scroll.renderNExtraScreensWorth+1)*this._scroll.rowsOnPage, this._c.itemsPerPage)); } // returns the item index to render up to for the given scroll position. // might return a value greater than this._visible.length, indicating a need for a page load. maximumItemsToRender = (scrollY: number): number => { const bottomScroll = scrollY + ((this._scroll.renderNExtraScreensWorth+1)*this._scroll.screenHeight); - const bottomIdx = Math.floor(bottomScroll / this._scroll.rowsOnPage); + const bottomIdx = Math.floor(bottomScroll / this._scroll.rowHeight); return bottomIdx; } @@ -425,12 +428,24 @@ export abstract class PaginatedList { } } + _detectScroll = () => { if (!this._hasLoaded || this._scroll.scrollLoading) return; if (this._visible.length == 0) return; - const endIdx = this.maximumItemsToRender(window.scrollY); + const scrollY = window.scrollY; + const scrollSpeed = scrollY - this._scroll.lastScrollY; + this._scroll.lastScrollY = scrollY; // If you've scrolled back up, do nothing - if (endIdx <= this._scroll.rendered) return; + if (scrollSpeed < 0) return; + let endIdx = this.maximumItemsToRender(scrollY); + + // Throttling this function means we might not catch up in time if the user scrolls fast, + // so we calculate the scroll speed (in rows/call) from the previous scrollY value. + // This still might not be enough, so hackily we'll just scale it up. + // With onscrollend, this is less necessary, but with both I wasn't able to hit the bottom of the page on my mouse. + const rowsPerScroll = Math.round((scrollSpeed / this._scroll.rowHeight)); + // Render extra pages depending on scroll speed + endIdx += rowsPerScroll*2; const realEndIdx = Math.min(endIdx, this._visible.length); const frag = document.createDocumentFragment(); @@ -439,7 +454,7 @@ export abstract class PaginatedList { } this._scroll.rendered = realEndIdx; this._container.appendChild(frag); - + if (endIdx >= this._visible.length) { if (this.lastPage || this._lastLoad + 500 > Date.now()) return; this._scroll.scrollLoading = true; @@ -448,6 +463,7 @@ export abstract class PaginatedList { this.loadMore(cb, false) return; } + this._scroll.scrollLoading = false; this._detectScroll(); }; @@ -458,6 +474,29 @@ export abstract class PaginatedList { // Should be assigned to window.onscroll whenever the list is in view. detectScroll = throttle(this._detectScroll, 200); + + computeScrollInfo = throttle(this._computeScrollInfo, 200); + + // Should be called in window resize + redrawScroll = throttle(() => { + // FIXME: Make sure this is enough when rows resize, and that we don't need to re-setVisibility. + this._computeScrollInfo(); + // this.setVisibility(this._visible, true, false); + }, 200); + + // bindPageEvents binds window event handlers for when this list/tab containing it is visible. + bindPageEvents = () => { + window.addEventListener("scroll", this.detectScroll); + // Not available on safari, we include a polyfill though. + window.addEventListener("scrollend", this.detectScroll); + window.addEventListener("resize", this.redrawScroll); + }; + + unbindPageEvents = () => { + window.removeEventListener("scroll", this.detectScroll); + window.removeEventListener("scrollend", this.detectScroll); + window.removeEventListener("resize", this.redrawScroll); + } } diff --git a/ts/modules/tabs.ts b/ts/modules/tabs.ts index fc700cf..ade6824 100644 --- a/ts/modules/tabs.ts +++ b/ts/modules/tabs.ts @@ -24,7 +24,7 @@ export class Tabs implements Tabs { }); } - addTab = (tabID: string, url: string, preFunc = () => void {}, postFunc = () => void {},) => { + addTab = (tabID: string, url: string, preFunc = () => void {}, postFunc = () => void {}, unloadFunc = () => void {}) => { let tab: Tab = { page: null, tabEl: document.getElementById("tab-" + tabID) as HTMLDivElement, @@ -50,6 +50,7 @@ export class Tabs implements Tabs { tab.buttonEl.classList.remove("active"); tab.buttonEl.classList.remove("~urge"); tab.tabEl.classList.add("unfocused"); + if (unloadFunc) unloadFunc(); return true; }, shouldSkip: () => false, diff --git a/ts/typings/d.ts b/ts/typings/d.ts index 8447fbd..a1df5c8 100644 --- a/ts/typings/d.ts +++ b/ts/typings/d.ts @@ -91,7 +91,7 @@ declare interface NotificationBox { declare interface Tabs { current: string; - addTab: (tabID: string, url: string, preFunc?: () => void, postFunc?: () => void) => void; + addTab: (tabID: string, url: string, preFunc?: () => void, postFunc?: () => void, unloadFunc?: () => void) => void; switch: (tabID: string, noRun?: boolean, keepURL?: boolean) => void; } From 4a92712c90bc8cb8bea2438086dd8253482cb3c2 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Fri, 23 May 2025 14:53:39 +0100 Subject: [PATCH 036/249] list: fix RecordCounter, inf scroll in search, activities --- ts/modules/accounts.ts | 6 +-- ts/modules/activity.ts | 9 +++-- ts/modules/list.ts | 83 +++++++++++++++++++++--------------------- ts/modules/search.ts | 10 ++--- 4 files changed, 55 insertions(+), 53 deletions(-) diff --git a/ts/modules/accounts.ts b/ts/modules/accounts.ts index 22cda3d..8ae2b6b 100644 --- a/ts/modules/accounts.ts +++ b/ts/modules/accounts.ts @@ -977,7 +977,7 @@ export class accountsList extends PaginatedList { this._populateNumbers(); // FIXME: Remove! - (window as any).s = this; + (window as any).acc = this; let searchConfig: SearchConfiguration = { filterArea: this._c.filterArea, @@ -988,10 +988,10 @@ export class accountsList extends PaginatedList { filterList: document.getElementById("accounts-filter-list"), search: this._c.searchBox, queries: queries(), - setVisibility: this.setVisibility, + setVisibility: null, clearSearchButtonSelector: ".accounts-search-clear", serverSearchButtonSelector: ".accounts-search-server", - onSearchCallback: (_0: number, _1: boolean, _2: boolean) => { + onSearchCallback: (_0: boolean, _1: boolean) => { this._checkCheckCount(); }, searchServer: null, diff --git a/ts/modules/activity.ts b/ts/modules/activity.ts index 5eb0387..a168cee 100644 --- a/ts/modules/activity.ts +++ b/ts/modules/activity.ts @@ -509,13 +509,13 @@ export class activityList extends PaginatedList { this.activities[act.id] = new Activity(act); ordering.push(act.id); } + this._search.setOrdering(ordering, this._c.defaultSortField, this.ascending); }, updateExistingElementsFromPage: (resp: paginatedDTO) => { - // FIXME: Implement updates to existing elements! + // FIXME: Implement updates to existing elements, rather than just wiping each time. for (let id of Object.keys(this.activities)) { delete this.activities[id]; } - this._search.setOrdering([], this._c.defaultSortField, this.ascending); this._c.newElementsFromPage(resp); }, defaultSortField: ACTIVITY_DEFAULT_SORT_FIELD, @@ -528,6 +528,9 @@ export class activityList extends PaginatedList { } } }); + + // FIXME: Remove! + (window as any).act = this; this._container = document.getElementById("activity-card-list") document.addEventListener("activity-reload", this.reload); @@ -543,7 +546,7 @@ export class activityList extends PaginatedList { clearSearchButtonSelector: ".activity-search-clear", serverSearchButtonSelector: ".activity-search-server", queries: queries(), - setVisibility: this.setVisibility, + setVisibility: null, filterList: document.getElementById("activity-filter-list"), // notFoundCallback: this._notFoundCallback, onSearchCallback: null, diff --git a/ts/modules/list.ts b/ts/modules/list.ts index 9f2507e..b21a408 100644 --- a/ts/modules/list.ts +++ b/ts/modules/list.ts @@ -22,10 +22,10 @@ export class RecordCounter { `; - this._totalRecords = document.getElementsByClassName("records-total")[0] as HTMLElement; - this._loadedRecords = document.getElementsByClassName("records-loaded")[0] as HTMLElement; - this._shownRecords = document.getElementsByClassName("records-shown")[0] as HTMLElement; - this._selectedRecords = document.getElementsByClassName("records-selected")[0] as HTMLElement; + this._totalRecords = this._container.getElementsByClassName("records-total")[0] as HTMLElement; + this._loadedRecords = this._container.getElementsByClassName("records-loaded")[0] as HTMLElement; + this._shownRecords = this._container.getElementsByClassName("records-shown")[0] as HTMLElement; + this._selectedRecords = this._container.getElementsByClassName("records-selected")[0] as HTMLElement; this.total = 0; this.loaded = 0; this.shown = 0; @@ -138,7 +138,7 @@ export abstract class PaginatedList { } } - protected _previousPageSize = 0; + protected _previousVisibleItemCount = 0; // Stores a PaginatedReqDTO-implementing thing. // A standard PaginatedReqDTO will be overridden entirely, @@ -173,9 +173,7 @@ export abstract class PaginatedList { initSearch = (searchConfig: SearchConfiguration) => { const previousCallback = searchConfig.onSearchCallback; - searchConfig.onSearchCallback = (visibleCount: number, newItems: boolean, loadAll: boolean) => { - this._counter.shown = visibleCount; - + searchConfig.onSearchCallback = (newItems: boolean, loadAll: boolean) => { // if (this._search.inSearch && !this.lastPage) this._c.loadAllButton.classList.remove("unfocused"); // else this._c.loadAllButton.classList.add("unfocused"); @@ -186,17 +184,17 @@ export abstract class PaginatedList { } // FIXME: Figure out why this makes sense and make it clearer. - if ((visibleCount < this._c.itemsPerPage && this._counter.loaded < this._c.maxItemsLoadedForSearch && !this.lastPage) || loadAll) { + if ((this._visible.length < this._c.itemsPerPage && this._counter.loaded < this._c.maxItemsLoadedForSearch && !this.lastPage) || loadAll) { if (!newItems || - this._previousPageSize != visibleCount || - (visibleCount == 0 && !this.lastPage) || + this._previousVisibleItemCount != this._visible.length || + (this._visible.length == 0 && !this.lastPage) || loadAll ) { this.loadMore(() => {}, loadAll); } } - this._previousPageSize = visibleCount; - if (previousCallback) previousCallback(visibleCount, newItems, loadAll); + this._previousVisibleItemCount = this._visible.length; + if (previousCallback) previousCallback(newItems, loadAll); }; const previousServerSearch = searchConfig.searchServer; searchConfig.searchServer = (params: PaginatedReqDTO, newSearch: boolean) => { @@ -211,28 +209,28 @@ export abstract class PaginatedList { this._page = 0; this.reload(); } + searchConfig.setVisibility = this.setVisibility; this._search = new Search(searchConfig); this._search.generateFilterList(); this.lastPage = false; }; // Sets the elements with "name"s in "elements" as visible or not. - setVisibilityNaive = (elements: string[], visible: boolean) => { - let timer = this._search.timeSearches ? performance.now() : null; - if (visible) this._visible = elements; - else this._visible = this._search.ordering.filter(v => !elements.includes(v)); - const frag = document.createDocumentFragment() - for (let i = 0; i < this._visible.length; i++) { - frag.appendChild(this._search.items[this._visible[i]].asElement()) - } - this._container.replaceChildren(frag); - if (this._search.timeSearches) { - const totalTime = performance.now() - timer; - console.log(`setVisibility took ${totalTime}ms`); - } - } - - // FIXME: On reload, load enough pages to fill required space. + // setVisibilityNaive = (elements: string[], visible: boolean) => { + // let timer = this._search.timeSearches ? performance.now() : null; + // if (visible) this._visible = elements; + // else this._visible = this._search.ordering.filter(v => !elements.includes(v)); + // const frag = document.createDocumentFragment() + // for (let i = 0; i < this._visible.length; i++) { + // frag.appendChild(this._search.items[this._visible[i]].asElement()) + // } + // this._container.replaceChildren(frag); + // if (this._search.timeSearches) { + // const totalTime = performance.now() - timer; + // console.log(`setVisibility took ${totalTime}ms`); + // } + // } + // FIXME: Might have broken _counter.shown! // Sets the elements with "name"s in "elements" as visible or not. // appendedItems==true implies "elements" is the previously rendered elements plus some new ones on the end. Knowing this means the page's infinite scroll doesn't have to be reset. @@ -240,7 +238,12 @@ export abstract class PaginatedList { let timer = this._search.timeSearches ? performance.now() : null; if (visible) this._visible = elements; else this._visible = this._search.ordering.filter(v => !elements.includes(v)); - if (this._visible.length == 0) return; + console.log(elements.length, visible, this._visible.length); + this._counter.shown = this._visible.length; + if (this._visible.length == 0) { + this._container.textContent = ``; + return; + } if (!appendedItems) { // Wipe old elements and render 1 new one, so we can take the element height. @@ -277,6 +280,8 @@ export abstract class PaginatedList { // Computes required scroll info, requiring one on-DOM item. Should be computed on page resize and this._visible change. _computeScrollInfo = () => { + if (this._visible.length == 0) return; + this._scroll.screenHeight = Math.max( document.documentElement.clientHeight, window.innerHeight || 0 @@ -340,7 +345,7 @@ export abstract class PaginatedList { this._counter.loaded = this._search.ordering.length; - this._search.onSearchBoxChange(true); + this._search.onSearchBoxChange(true, false, false); if (this._search.inSearch) { // this._c.loadAllButton.classList.remove("unfocused"); } else { @@ -400,7 +405,7 @@ export abstract class PaginatedList { if (this.lastPage) { loadAll = false; } - this._search.onSearchBoxChange(true, loadAll); + this._search.onSearchBoxChange(true, true, loadAll); } else { // Since results come to us ordered already, we can assume "ordering" // will be identical to pre-page-load but with extra elements at the end, @@ -423,15 +428,14 @@ export abstract class PaginatedList { // As reloading can disrupt long-scrolling, this function will only do it if you're at the top of the page, essentially. public reloadIfNotInScroll = () => { - if (this.maximumItemsToRender(window.scrollY) < this._scroll.initialRenderCount) { + if (this._visible.length == 0 || this.maximumItemsToRender(window.scrollY) < this._scroll.initialRenderCount) { return this.reload(); } } _detectScroll = () => { - if (!this._hasLoaded || this._scroll.scrollLoading) return; - if (this._visible.length == 0) return; + if (!this._hasLoaded || this._scroll.scrollLoading || this._visible.length == 0) return; const scrollY = window.scrollY; const scrollSpeed = scrollY - this._scroll.lastScrollY; this._scroll.lastScrollY = scrollY; @@ -460,6 +464,7 @@ export abstract class PaginatedList { this._scroll.scrollLoading = true; const cb = () => { if (this._visible.length < endIdx && !this.lastPage) { + // FIXME: This causes scroll-to-top when in search. this.loadMore(cb, false) return; } @@ -472,17 +477,11 @@ export abstract class PaginatedList { } } - // Should be assigned to window.onscroll whenever the list is in view. detectScroll = throttle(this._detectScroll, 200); computeScrollInfo = throttle(this._computeScrollInfo, 200); - // Should be called in window resize - redrawScroll = throttle(() => { - // FIXME: Make sure this is enough when rows resize, and that we don't need to re-setVisibility. - this._computeScrollInfo(); - // this.setVisibility(this._visible, true, false); - }, 200); + redrawScroll = this.computeScrollInfo; // bindPageEvents binds window event handlers for when this list/tab containing it is visible. bindPageEvents = () => { diff --git a/ts/modules/search.ts b/ts/modules/search.ts index b8d9388..4c77717 100644 --- a/ts/modules/search.ts +++ b/ts/modules/search.ts @@ -42,8 +42,8 @@ export interface SearchConfiguration { serverSearchButtonSelector: string; search: HTMLInputElement; queries: { [field: string]: QueryType }; - setVisibility: (items: string[], visible: boolean) => void; - onSearchCallback: (visibleCount: number, newItems: boolean, loadAll: boolean) => void; + setVisibility: (items: string[], visible: boolean, appendedItems: boolean) => void; + onSearchCallback: (newItems: boolean, loadAll: boolean) => void; searchServer: (params: PaginatedReqDTO, newSearch: boolean) => void; clearServerSearch: () => void; loadMore?: () => void; @@ -505,7 +505,7 @@ export class Search { get sortField(): string { return this._sortField; } get ascending(): boolean { return this._ascending; } - onSearchBoxChange = (newItems: boolean = false, loadAll: boolean = false) => { + onSearchBoxChange = (newItems: boolean = false, appendedItems: boolean = false, loadAll: boolean = false) => { const query = this._c.search.value; if (!query) { this.inSearch = false; @@ -513,8 +513,8 @@ export class Search { this.inSearch = true; } const results = this.search(query); - this._c.setVisibility(results, true); - this._c.onSearchCallback(results.length, newItems, loadAll); + this._c.setVisibility(results, true, appendedItems); + this._c.onSearchCallback(newItems, loadAll); if (this.inSearch) { if (this.inServerSearch) { this._serverSearchButtons.forEach((v: HTMLElement) => { From 31d3e52229921621b8d8872805bb9ca40b7c564a Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Fri, 23 May 2025 15:02:42 +0100 Subject: [PATCH 037/249] activities: fix updateExistingElements, rename forgot to wipe this._ordering, so search was attempting to run on non-existent items. Also renamed the two functions to appendNewItems and replaceWithNewItems, this makes more sense to me. --- ts/modules/accounts.ts | 4 ++-- ts/modules/activity.ts | 10 +++++++--- ts/modules/list.ts | 10 +++++----- 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/ts/modules/accounts.ts b/ts/modules/accounts.ts index 8ae2b6b..fd642d7 100644 --- a/ts/modules/accounts.ts +++ b/ts/modules/accounts.ts @@ -925,7 +925,7 @@ export class accountsList extends PaginatedList { getPageEndpoint: "/users", itemsPerPage: 40, maxItemsLoadedForSearch: 200, - newElementsFromPage: (resp: paginatedDTO) => { + appendNewItems: (resp: paginatedDTO) => { for (let u of ((resp as UsersDTO).users || [])) { if (u.id in this.users) { this.users[u.id].update(u); @@ -940,7 +940,7 @@ export class accountsList extends PaginatedList { this._search.ascending ); }, - updateExistingElementsFromPage: (resp: paginatedDTO) => { + replaceWithNewItems: (resp: paginatedDTO) => { let accountsOnDOM: { [id: string]: boolean } = {}; for (let id of Object.keys(this.users)) { accountsOnDOM[id] = true; } diff --git a/ts/modules/activity.ts b/ts/modules/activity.ts index a168cee..26d8a93 100644 --- a/ts/modules/activity.ts +++ b/ts/modules/activity.ts @@ -503,7 +503,7 @@ export class activityList extends PaginatedList { getPageEndpoint: "/activity", itemsPerPage: 20, maxItemsLoadedForSearch: 200, - newElementsFromPage: (resp: paginatedDTO) => { + appendNewItems: (resp: paginatedDTO) => { let ordering: string[] = this._search.ordering; for (let act of ((resp as ActivitiesDTO).activities || [])) { this.activities[act.id] = new Activity(act); @@ -511,12 +511,16 @@ export class activityList extends PaginatedList { } this._search.setOrdering(ordering, this._c.defaultSortField, this.ascending); }, - updateExistingElementsFromPage: (resp: paginatedDTO) => { + replaceWithNewItems: (resp: paginatedDTO) => { // FIXME: Implement updates to existing elements, rather than just wiping each time. + + // Remove existing items for (let id of Object.keys(this.activities)) { delete this.activities[id]; } - this._c.newElementsFromPage(resp); + // And wipe their ordering + this._search.setOrdering([], this._c.defaultSortField, this.ascending); + this._c.appendNewItems(resp); }, defaultSortField: ACTIVITY_DEFAULT_SORT_FIELD, defaultSortAscending: ACTIVITY_DEFAULT_SORT_ASCENDING, diff --git a/ts/modules/list.ts b/ts/modules/list.ts index b21a408..2335a2c 100644 --- a/ts/modules/list.ts +++ b/ts/modules/list.ts @@ -85,8 +85,8 @@ export interface PaginatedListConfig { getPageEndpoint: string; itemsPerPage: number; maxItemsLoadedForSearch: number; - newElementsFromPage: (resp: paginatedDTO) => void; - updateExistingElementsFromPage: (resp: paginatedDTO) => void; + appendNewItems: (resp: paginatedDTO) => void; + replaceWithNewItems: (resp: paginatedDTO) => void; defaultSortField: string; defaultSortAscending: boolean; pageLoadCallback?: (req: XMLHttpRequest) => void; @@ -238,7 +238,7 @@ export abstract class PaginatedList { let timer = this._search.timeSearches ? performance.now() : null; if (visible) this._visible = elements; else this._visible = this._search.ordering.filter(v => !elements.includes(v)); - console.log(elements.length, visible, this._visible.length); + // console.log(elements.length, visible, this._visible.length); this._counter.shown = this._visible.length; if (this._visible.length == 0) { this._container.textContent = ``; @@ -341,7 +341,7 @@ export abstract class PaginatedList { this.lastPage = resp.last_page; - this._c.updateExistingElementsFromPage(resp); + this._c.replaceWithNewItems(resp); this._counter.loaded = this._search.ordering.length; @@ -397,7 +397,7 @@ export abstract class PaginatedList { this.lastPage = resp.last_page; - this._c.newElementsFromPage(resp); + this._c.appendNewItems(resp); this._counter.loaded = this._search.ordering.length; From 792296e3bca4bb3122d89f19cc52f395a26aa8f4 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Fri, 23 May 2025 16:37:42 +0100 Subject: [PATCH 038/249] activity: basic query support only supports queries of fields actually in Activity. The web UI only directly queries two of these, ID and Time (mistakenly referneced as date in the web ui previously). Later commits will come up with creative ways of dealing with all the other query types. --- activitysort.go | 137 +++++++++++++++++++++++++++++++++++++++++ api-activities.go | 85 +++++++++++++------------ api-users.go | 4 +- models.go | 10 --- ts/modules/activity.ts | 4 +- 5 files changed, 185 insertions(+), 55 deletions(-) create mode 100644 activitysort.go diff --git a/activitysort.go b/activitysort.go new file mode 100644 index 0000000..7cd8af9 --- /dev/null +++ b/activitysort.go @@ -0,0 +1,137 @@ +package main + +import ( + "fmt" + "strings" + + "github.com/timshannon/badgerhold/v4" +) + +const ( + ACTIVITY_DEFAULT_SORT_FIELD = "Time" + // This will be default anyway, as the default value of a bool field is false. + // ACTIVITY_DEFAULT_SORT_ASCENDING = false +) + +func activityDTONameToField(field string) string { + // Only "ID" and "Time" of these are actually searched by the UI. + // We support the rest though for other consumers of the API. + switch field { + case "id": + return "ID" + case "type": + return "Type" + case "user_id": + return "UserID" + case "username": + return "Username" + case "source_type": + return "SourceType" + case "source": + return "Source" + case "source_username": + return "SourceUsername" + case "invite_code": + return "InviteCode" + case "value": + return "Value" + case "time": + return "Time" + case "ip": + return "IP" + } + return "unknown" + // Only these query types actually search the ActivityDTO data. +} + +func activityTypeGetterNameToType(getter string) ActivityType { + switch getter { + case "accountCreation": + return ActivityCreation + case "accountDeletion": + return ActivityDeletion + case "accountDisabled": + return ActivityDisabled + case "accountEnabled": + return ActivityEnabled + case "contactLinked": + return ActivityContactLinked + case "contactUnlinked": + return ActivityContactUnlinked + case "passwordChange": + return ActivityChangePassword + case "passwordReset": + return ActivityResetPassword + case "inviteCreated": + return ActivityCreateInvite + case "inviteDeleted": + return ActivityDeleteInvite + } + return ActivityUnknown +} + +// AsDBQuery returns a mutated "query" filtering for the conditions in "q". +func (q QueryDTO) AsDBQuery(query *badgerhold.Query) *badgerhold.Query { + if query == nil { + query = &badgerhold.Query{} + } + // Special case for activity type: + // In the app, there isn't an "activity:" query, but rather "<~fieldname>:true/false" queries. + // For other API consumers, we also handle the former later. + activityType := activityTypeGetterNameToType(q.Field) + if activityType != ActivityUnknown { + criterion := query.And("Type") + if q.Operator != EqualOperator { + panic(fmt.Errorf("impossible operator for activity type: %v", q.Operator)) + } + if q.Value.(bool) == true { + query = criterion.Eq(activityType) + } else { + query = criterion.Ne(activityType) + } + return query + } + + fieldName := activityDTONameToField(q.Field) + if fieldName == "unknown" { + panic("FIXME: Support all the weird queries of the web UI!") + } + criterion := query.And(fieldName) + + // FIXME: Deal with dates like we do in usercache.go + switch q.Operator { + case LesserOperator: + query = criterion.Lt(q.Value) + case EqualOperator: + query = criterion.Eq(q.Value) + case GreaterOperator: + query = criterion.Gt(q.Value) + } + return query +} + +// ActivityMatchesSearchAsDBBaseQuery returns a base query (which you should then apply other mutations to) matching the search "term" to Activities by searching all fields. Does not search the generated title like the web app. +func ActivityMatchesSearchAsDBBaseQuery(terms []string) *badgerhold.Query { + subQuery := &badgerhold.Query{} + // I don't believe you can just do Where("*"), so instead run for each field. + for _, fieldName := range []string{"ID", "Type", "UserID", "Username", "SourceType", "Source", "SourceUsername", "InviteCode", "Value", "IP"} { + criterion := badgerhold.Where(fieldName) + // No case-insentive Contains method, so we use MatchFunc instead + subQuery = subQuery.Or(criterion.MatchFunc(func(ra *badgerhold.RecordAccess) (bool, error) { + field := ra.Field() + // _, ok := field.(string) + // if !ok { + // return false, fmt.Errorf("field not string: %s", fieldName) + // } + lower := strings.ToLower(field.(string)) + for _, term := range terms { + if strings.Contains(lower, term) { + return true, nil + } + } + return false, nil + })) + } + + return subQuery +} diff --git a/api-activities.go b/api-activities.go index d121aa4..eda15a4 100644 --- a/api-activities.go +++ b/api-activities.go @@ -6,32 +6,6 @@ import ( "github.com/timshannon/badgerhold/v4" ) -func stringToActivityType(v string) ActivityType { - switch v { - case "creation": - return ActivityCreation - case "deletion": - return ActivityDeletion - case "disabled": - return ActivityDisabled - case "enabled": - return ActivityEnabled - case "contactLinked": - return ActivityContactLinked - case "contactUnlinked": - return ActivityContactUnlinked - case "changePassword": - return ActivityChangePassword - case "resetPassword": - return ActivityResetPassword - case "createInvite": - return ActivityCreateInvite - case "deleteInvite": - return ActivityDeleteInvite - } - return ActivityUnknown -} - func activityTypeToString(v ActivityType) string { switch v { case ActivityCreation: @@ -58,6 +32,32 @@ func activityTypeToString(v ActivityType) string { return "unknown" } +func stringToActivityType(v string) ActivityType { + switch v { + case "creation": + return ActivityCreation + case "deletion": + return ActivityDeletion + case "disabled": + return ActivityDisabled + case "enabled": + return ActivityEnabled + case "contactLinked": + return ActivityContactLinked + case "contactUnlinked": + return ActivityContactUnlinked + case "changePassword": + return ActivityChangePassword + case "resetPassword": + return ActivityResetPassword + case "createInvite": + return ActivityCreateInvite + case "deleteInvite": + return ActivityDeleteInvite + } + return ActivityUnknown +} + func stringToActivitySource(v string) ActivitySource { switch v { case "user": @@ -88,33 +88,36 @@ func activitySourceToString(v ActivitySource) string { // @Summary Get the requested set of activities, Paginated, filtered and sorted. Is a POST because of some issues I was having, ideally should be a GET. // @Produce json -// @Param GetActivitiesDTO body GetActivitiesDTO true "search parameters" +// @Param ServerSearchReqDTO body ServerSearchReqDTO true "search parameters" // @Success 200 {object} GetActivitiesRespDTO // @Router /activity [post] // @Security Bearer // @tags Activity func (app *appContext) GetActivities(gc *gin.Context) { - req := GetActivitiesDTO{} + req := ServerSearchReqDTO{} gc.BindJSON(&req) - query := &badgerhold.Query{} - activityTypes := make([]any, len(req.Type)) - for i, v := range req.Type { - activityTypes[i] = stringToActivityType(v) - } - if len(activityTypes) != 0 { - query = badgerhold.Where("Type").In(activityTypes...) + if req.SortByField == "" { + req.SortByField = USER_DEFAULT_SORT_FIELD + } else { + req.SortByField = activityDTONameToField(req.SortByField) } + var query *badgerhold.Query + if len(req.SearchTerms) != 0 { + query = ActivityMatchesSearchAsDBBaseQuery(req.SearchTerms) + } else { + query = &badgerhold.Query{} + } + + for _, q := range req.Queries { + query = q.AsDBQuery(query) + } + + query = query.SortBy(req.SortByField) if !req.Ascending { query = query.Reverse() } - query = query.SortBy("Time") - - if req.Limit == 0 { - req.Limit = 10 - } - query = query.Skip(req.Page * req.Limit).Limit(req.Limit) var results []Activity diff --git a/api-users.go b/api-users.go index 0ab670d..c061d01 100644 --- a/api-users.go +++ b/api-users.go @@ -936,14 +936,14 @@ func (app *appContext) GetUsers(gc *gin.Context) { // @Summary Get a paginated, searchable list of Jellyfin users. // @Produce json -// @Param getUsersReqDTO body getUsersReqDTO true "search / pagination parameters" +// @Param ServerSearchReqDTO body ServerSearchReqDTO true "search / pagination parameters" // @Success 200 {object} getUsersDTO // @Failure 500 {object} stringResponse // @Router /users [post] // @Security Bearer // @tags Users func (app *appContext) SearchUsers(gc *gin.Context) { - req := getUsersReqDTO{} + req := ServerSearchReqDTO{} gc.BindJSON(&req) if req.SortByField == "" { req.SortByField = USER_DEFAULT_SORT_FIELD diff --git a/models.go b/models.go index 7e6b31c..144bfcf 100644 --- a/models.go +++ b/models.go @@ -175,10 +175,6 @@ type PaginatedReqDTO struct { Ascending bool `json:"ascending"` } -type getUsersReqDTO struct { - ServerSearchReqDTO -} - type getUsersDTO struct { UserList []*respUser `json:"users"` LastPage bool `json:"last_page"` @@ -445,12 +441,6 @@ type ActivityDTO struct { IP string `json:"ip"` } -type GetActivitiesDTO struct { - // "SortByField" ignores, it's always time. - PaginatedReqDTO - Type []string `json:"type"` // Types of activity to get. Leave blank for all. -} - type GetActivitiesRespDTO struct { PaginatedDTO Activities []ActivityDTO `json:"activities"` diff --git a/ts/modules/activity.ts b/ts/modules/activity.ts index 26d8a93..7716f8c 100644 --- a/ts/modules/activity.ts +++ b/ts/modules/activity.ts @@ -74,9 +74,9 @@ const queries = (): { [field: string]: QueryType } => { return { string: true, date: false }, - "date": { + "time": { name: window.lang.strings("date"), - getter: "date", + getter: "time", bool: false, string: false, date: true From 9715f90a48fd2913af6e3e0e6da98a4ad54b2c75 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Mon, 26 May 2025 15:09:40 +0100 Subject: [PATCH 039/249] search: fix server-side dates, add mentionedUsers, referrer, time QueryDTO.Value being classed as "any" meant DateAttempts would be unmarshaled as map[string]any, so a custom UnmarshalJSON checks the data type and unmarshals into a DateAttempt if needed. mentionedUers, referrer and time matching implemented for activity search. Also, fixed multi-class queries (e.g. date -and- bool for last-active). --- activitysort.go | 137 +++++++++++++++++++++++++++++++++++++++---- api-activities.go | 43 +++++++------- ts/modules/search.ts | 6 +- usercache.go | 46 ++++++++++++--- 4 files changed, 188 insertions(+), 44 deletions(-) diff --git a/activitysort.go b/activitysort.go index 7cd8af9..8a020f6 100644 --- a/activitysort.go +++ b/activitysort.go @@ -3,7 +3,9 @@ package main import ( "fmt" "strings" + "time" + "github.com/hrfee/mediabrowser" "github.com/timshannon/badgerhold/v4" ) @@ -70,17 +72,22 @@ func activityTypeGetterNameToType(getter string) ActivityType { return ActivityUnknown } +// andField appends to the existing query if not nil, and otherwise creates a new one. +func andField(q *badgerhold.Query, field string) *badgerhold.Criterion { + if q == nil { + return badgerhold.Where(field) + } + return q.And(field) +} + // AsDBQuery returns a mutated "query" filtering for the conditions in "q". func (q QueryDTO) AsDBQuery(query *badgerhold.Query) *badgerhold.Query { - if query == nil { - query = &badgerhold.Query{} - } // Special case for activity type: // In the app, there isn't an "activity:" query, but rather "<~fieldname>:true/false" queries. // For other API consumers, we also handle the former later. activityType := activityTypeGetterNameToType(q.Field) if activityType != ActivityUnknown { - criterion := query.And("Type") + criterion := andField(query, "Type") if q.Operator != EqualOperator { panic(fmt.Errorf("impossible operator for activity type: %v", q.Operator)) } @@ -93,12 +100,13 @@ func (q QueryDTO) AsDBQuery(query *badgerhold.Query) *badgerhold.Query { } fieldName := activityDTONameToField(q.Field) - if fieldName == "unknown" { - panic("FIXME: Support all the weird queries of the web UI!") + // Fail if unrecognized, or recognized as time (we handle this with DateAttempt.Compare separately). + if fieldName == "unknown" || fieldName == "Time" { + // Caller is expected to fall back to ActivityDBQueryFromSpecialField after this. + return nil } - criterion := query.And(fieldName) + criterion := andField(query, fieldName) - // FIXME: Deal with dates like we do in usercache.go switch q.Operator { case LesserOperator: query = criterion.Lt(q.Value) @@ -112,12 +120,13 @@ func (q QueryDTO) AsDBQuery(query *badgerhold.Query) *badgerhold.Query { // ActivityMatchesSearchAsDBBaseQuery returns a base query (which you should then apply other mutations to) matching the search "term" to Activities by searching all fields. Does not search the generated title like the web app. func ActivityMatchesSearchAsDBBaseQuery(terms []string) *badgerhold.Query { - subQuery := &badgerhold.Query{} + var baseQuery *badgerhold.Query = nil // I don't believe you can just do Where("*"), so instead run for each field. - for _, fieldName := range []string{"ID", "Type", "UserID", "Username", "SourceType", "Source", "SourceUsername", "InviteCode", "Value", "IP"} { + // FIXME: Match username and source_username and source_type and type + for _, fieldName := range []string{"ID", "UserID", "Source", "InviteCode", "Value", "IP"} { criterion := badgerhold.Where(fieldName) // No case-insentive Contains method, so we use MatchFunc instead - subQuery = subQuery.Or(criterion.MatchFunc(func(ra *badgerhold.RecordAccess) (bool, error) { + f := criterion.MatchFunc(func(ra *badgerhold.RecordAccess) (bool, error) { field := ra.Field() // _, ok := field.(string) // if !ok { @@ -130,8 +139,110 @@ func ActivityMatchesSearchAsDBBaseQuery(terms []string) *badgerhold.Query { } } return false, nil - })) + }) + if baseQuery == nil { + baseQuery = f + } else { + baseQuery = baseQuery.Or(f) + } } - return subQuery + return baseQuery +} + +func (act Activity) SourceIsUser() bool { + return (act.SourceType == ActivityUser || act.SourceType == ActivityAdmin) && act.Source != "" +} + +func (act Activity) MustGetUsername(jf *mediabrowser.MediaBrowser) string { + if act.Type == ActivityDeletion || act.Type == ActivityCreation { + return act.Value + } + if act.UserID == "" { + return "" + } + // Don't care abt errors, user.Name will be blank in that case anyway + user, _ := jf.UserByID(act.UserID, false) + return user.Name +} + +func (act Activity) MustGetSourceUsername(jf *mediabrowser.MediaBrowser) string { + if !act.SourceIsUser() { + return "" + } + // Don't care abt errors, user.Name will be blank in that case anyway + user, _ := jf.UserByID(act.Source, false) + return user.Name +} + +func ActivityDBQueryFromSpecialField(jf *mediabrowser.MediaBrowser, query *badgerhold.Query, q QueryDTO) *badgerhold.Query { + switch q.Field { + case "mentionedUsers": + query = matchMentionedUsersAsQuery(jf, query, q) + case "actor": + query = matchActorAsQuery(jf, query, q) + case "referrer": + query = matchReferrerAsQuery(jf, query, q) + case "time": + query = matchTimeAsQuery(query, q) + default: + panic(fmt.Errorf("unknown activity query field %s", q.Field)) + } + return query +} + +// matchMentionedUsersAsQuery is a custom match function for the "mentionedUsers" getter/query type. +func matchMentionedUsersAsQuery(jf *mediabrowser.MediaBrowser, query *badgerhold.Query, q QueryDTO) *badgerhold.Query { + criterion := andField(query, "UserID") + query = criterion.MatchFunc(func(ra *badgerhold.RecordAccess) (bool, error) { + act := ra.Record().(*Activity) + usernames := act.MustGetUsername(jf) + " " + act.MustGetSourceUsername(jf) + return strings.Contains(strings.ToLower(usernames), strings.ToLower(q.Value.(string))), nil + }) + return query +} + +// matchActorAsQuery is a custom match function for the "actor" getter/query type. +func matchActorAsQuery(jf *mediabrowser.MediaBrowser, query *badgerhold.Query, q QueryDTO) *badgerhold.Query { + criterion := andField(query, "SourceType") + query = criterion.MatchFunc(func(ra *badgerhold.RecordAccess) (bool, error) { + act := ra.Record().(*Activity) + matchString := activitySourceToString(act.SourceType) + if act.SourceType == ActivityAdmin || act.SourceType == ActivityUser && act.SourceIsUser() { + matchString += " " + act.MustGetSourceUsername(jf) + } + return strings.Contains(strings.ToLower(matchString), strings.ToLower(q.Value.(string))), nil + }) + return query +} + +// matchReferrerAsQuery is a custom match function for the "referrer" getter/query type. +func matchReferrerAsQuery(jf *mediabrowser.MediaBrowser, query *badgerhold.Query, q QueryDTO) *badgerhold.Query { + criterion := andField(query, "Type") + query = criterion.MatchFunc(func(ra *badgerhold.RecordAccess) (bool, error) { + act := ra.Record().(*Activity) + if act.Type == ActivityCreation || act.SourceType == ActivityUser || !act.SourceIsUser() { + return false, nil + } + return strings.Contains(strings.ToLower(act.MustGetSourceUsername(jf)), strings.ToLower(q.Value.(string))), nil + }) + return query +} + +// mathcTimeAsQuery is a custom match function for the "time" getter/query type. Roughly matches the same way as the web app, and in usercache.go. +func matchTimeAsQuery(query *badgerhold.Query, q QueryDTO) *badgerhold.Query { + operator := Equal + switch q.Operator { + case LesserOperator: + operator = Lesser + case EqualOperator: + operator = Equal + case GreaterOperator: + operator = Greater + } + criterion := andField(query, "Time") + query = criterion.MatchFunc(func(ra *badgerhold.RecordAccess) (bool, error) { + return q.Value.(DateAttempt).Compare(ra.Field().(time.Time)) == int(operator), nil + }) + return query } diff --git a/api-activities.go b/api-activities.go index eda15a4..3f2e6c6 100644 --- a/api-activities.go +++ b/api-activities.go @@ -106,11 +106,19 @@ func (app *appContext) GetActivities(gc *gin.Context) { if len(req.SearchTerms) != 0 { query = ActivityMatchesSearchAsDBBaseQuery(req.SearchTerms) } else { - query = &badgerhold.Query{} + query = nil } for _, q := range req.Queries { - query = q.AsDBQuery(query) + nq := q.AsDBQuery(query) + if nq == nil { + nq = ActivityDBQueryFromSpecialField(app.jf, query, q) + } + query = nq + } + + if query == nil { + query = &badgerhold.Query{} } query = query.SortBy(req.SortByField) @@ -132,28 +140,21 @@ func (app *appContext) GetActivities(gc *gin.Context) { resp.LastPage = len(results) != req.Limit for i, act := range results { resp.Activities[i] = ActivityDTO{ - ID: act.ID, - Type: activityTypeToString(act.Type), - UserID: act.UserID, - SourceType: activitySourceToString(act.SourceType), - Source: act.Source, - InviteCode: act.InviteCode, - Value: act.Value, - Time: act.Time.Unix(), - IP: act.IP, + ID: act.ID, + Type: activityTypeToString(act.Type), + UserID: act.UserID, + SourceType: activitySourceToString(act.SourceType), + Source: act.Source, + InviteCode: act.InviteCode, + Value: act.Value, + Time: act.Time.Unix(), + IP: act.IP, + Username: act.MustGetUsername(app.jf), + SourceUsername: act.MustGetSourceUsername(app.jf), } if act.Type == ActivityDeletion || act.Type == ActivityCreation { - resp.Activities[i].Username = act.Value + // Username would've been in here, clear it to avoid confusion to the consumer resp.Activities[i].Value = "" - } else if user, err := app.jf.UserByID(act.UserID, false); err == nil { - resp.Activities[i].Username = user.Name - } - - if (act.SourceType == ActivityUser || act.SourceType == ActivityAdmin) && act.Source != "" { - user, err := app.jf.UserByID(act.Source, false) - if err == nil { - resp.Activities[i].SourceUsername = user.Name - } } } diff --git a/ts/modules/search.ts b/ts/modules/search.ts index 4c77717..0370ca0 100644 --- a/ts/modules/search.ts +++ b/ts/modules/search.ts @@ -373,7 +373,8 @@ export class Search { this._c.search.oninput((null as Event)); }; } - } else if (queryFormat.string) { + } + if (queryFormat.string) { q = new StringQuery(queryFormat, split[1]); q.onclick = () => { @@ -383,7 +384,8 @@ export class Search { } this._c.search.oninput((null as Event)); } - } else if (queryFormat.date) { + } + if (queryFormat.date) { let [parsedDate, op, isDate] = DateQuery.paramsFromString(split[1]); if (!isDate) continue; q = new DateQuery(queryFormat, op, parsedDate); diff --git a/usercache.go b/usercache.go index 5d52542..b9dc246 100644 --- a/usercache.go +++ b/usercache.go @@ -2,6 +2,7 @@ package main import ( "cmp" + "encoding/json" "fmt" "slices" "strings" @@ -241,13 +242,12 @@ type DateAttempt struct { Minute *int `json:"minute,omitempty"` } -// Compares a Unix timestamp. +// Compare roughly compares a time.Time to a DateAttempt. // We want to compare only the fields given in DateAttempt, // so we copy subjectDate and apply on those fields from this._value. -func (d DateAttempt) Compare(subject int64) int { - subjectTime := time.Unix(subject, 0) - yy, mo, dd := subjectTime.Date() - hh, mm, _ := subjectTime.Clock() +func (d DateAttempt) Compare(subject time.Time) int { + yy, mo, dd := subject.Date() + hh, mm, _ := subject.Clock() if d.Year != nil { yy = *d.Year } @@ -264,7 +264,13 @@ func (d DateAttempt) Compare(subject int64) int { if d.Minute != nil { mm = *d.Minute } - return subjectTime.Compare(time.Date(yy, mo, dd, hh, mm, 0, 0, nil)) + // FIXME: Transmit timezone in request maybe? + return subject.Compare(time.Date(yy, mo, dd, hh, mm, 0, 0, time.UTC)) +} + +// CompareUnix roughly compares a unix timestamp to a DateAttempt. +func (d DateAttempt) CompareUnix(subject int64) int { + return d.Compare(time.Unix(subject, 0)) } // Filter returns true if a specific field in the passed respUser matches some internally defined value. @@ -301,7 +307,7 @@ func (q QueryDTO) AsFilter() Filter { } case "last_active": return func(a *respUser) bool { - return q.Value.(DateAttempt).Compare(a.LastActive) == int(operator) + return q.Value.(DateAttempt).CompareUnix(a.LastActive) == int(operator) } case "admin": return func(a *respUser) bool { @@ -309,7 +315,7 @@ func (q QueryDTO) AsFilter() Filter { } case "expiry": return func(a *respUser) bool { - return q.Value.(DateAttempt).Compare(a.Expiry) == int(operator) + return q.Value.(DateAttempt).CompareUnix(a.Expiry) == int(operator) } case "disabled": return func(a *respUser) bool { @@ -397,6 +403,30 @@ type QueryDTO struct { Value any `json:"value"` } +// UnmarshalJSON allows unmarshaling QueryDTO.Value into a DateAttempt type, rather than just a map. +func (q *QueryDTO) UnmarshalJSON(data []byte) error { + type _QueryDTO QueryDTO + var temp _QueryDTO + if err := json.Unmarshal(data, &temp); err != nil { + return err + } + *q = QueryDTO(temp) + switch q.Value.(type) { + case string: + case bool: + return nil + case map[string]any: + var do struct { + Value DateAttempt `json:"value"` + } + if err := json.Unmarshal(data, &do); err != nil { + return err + } + q.Value = do.Value + } + return nil +} + // ServerSearchReqDTO is a usual PaginatedReqDTO with added fields for searching and filtering. type ServerSearchReqDTO struct { PaginatedReqDTO From ef253de56b48df972eae0ee6a39c7cf44239258e Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Mon, 26 May 2025 16:06:41 +0100 Subject: [PATCH 040/249] search: add localOnly to web app queries, fix string+bool queries localOnly: true in a queryType means it won't be sent to the server, but will be evaluated by the web app on the returned search results. --- activitysort.go | 13 ++++-- ts/modules/activity.ts | 3 +- ts/modules/search.ts | 90 +++++++++++++++++++++++++++++++----------- usercache.go | 30 ++++++++++++-- 4 files changed, 104 insertions(+), 32 deletions(-) diff --git a/activitysort.go b/activitysort.go index 8a020f6..d7aab59 100644 --- a/activitysort.go +++ b/activitysort.go @@ -43,7 +43,6 @@ func activityDTONameToField(field string) string { return "IP" } return "unknown" - // Only these query types actually search the ActivityDTO data. } func activityTypeGetterNameToType(getter string) ActivityType { @@ -221,10 +220,18 @@ func matchReferrerAsQuery(jf *mediabrowser.MediaBrowser, query *badgerhold.Query criterion := andField(query, "Type") query = criterion.MatchFunc(func(ra *badgerhold.RecordAccess) (bool, error) { act := ra.Record().(*Activity) - if act.Type == ActivityCreation || act.SourceType == ActivityUser || !act.SourceIsUser() { + if act.Type != ActivityCreation || act.SourceType != ActivityUser || !act.SourceIsUser() { return false, nil } - return strings.Contains(strings.ToLower(act.MustGetSourceUsername(jf)), strings.ToLower(q.Value.(string))), nil + sourceUsername := act.MustGetSourceUsername(jf) + if q.Class == BoolQuery { + val := sourceUsername != "" + if q.Value.(bool) == false { + val = !val + } + return val, nil + } + return strings.Contains(strings.ToLower(sourceUsername), strings.ToLower(q.Value.(string))), nil }) return query } diff --git a/ts/modules/activity.ts b/ts/modules/activity.ts index 7716f8c..c332d33 100644 --- a/ts/modules/activity.ts +++ b/ts/modules/activity.ts @@ -50,7 +50,8 @@ const queries = (): { [field: string]: QueryType } => { return { getter: "title", bool: false, string: true, - date: false + date: false, + localOnly: true }, "user": { name: window.lang.strings("usersMentioned"), diff --git a/ts/modules/search.ts b/ts/modules/search.ts index 0370ca0..46bb7fa 100644 --- a/ts/modules/search.ts +++ b/ts/modules/search.ts @@ -28,6 +28,7 @@ export interface QueryType { date: boolean; dependsOnElement?: string; // Format for querySelector show?: boolean; + localOnly?: boolean // Indicates can't be performed server-side. } export interface SearchConfiguration { @@ -84,7 +85,8 @@ export abstract class Query { public abstract compare(subjectValue: any): boolean; - asDTO(): QueryDTO { + asDTO(): QueryDTO | null { + if (this.localOnly) return null; let out = {} as QueryDTO; out.field = this._subject.getter; out.operator = this._operator; @@ -100,6 +102,8 @@ export abstract class Query { compareItem(item: SearchableItem): boolean { return this.compare(this.getValueFromItem(item)); } + + get localOnly(): boolean { return this._subject.localOnly ? true : false; } } export class BoolQuery extends Query { @@ -134,8 +138,9 @@ export class BoolQuery extends Query { return ((subjectBool && this._value) || (!subjectBool && !this._value)) } - asDTO(): QueryDTO { + asDTO(): QueryDTO | null { let out = super.asDTO(); + if (out === null) return null; out.class = "bool"; out.value = this._value; return out; @@ -159,8 +164,9 @@ export class StringQuery extends Query { return subjectString.toLowerCase().includes(this._value); } - asDTO(): QueryDTO { + asDTO(): QueryDTO | null { let out = super.asDTO(); + if (out === null) return null; out.class = "string"; out.value = this._value; return out; @@ -259,8 +265,9 @@ export class DateQuery extends Query { return subjectDate > temp; } - asDTO(): QueryDTO { + asDTO(): QueryDTO | null { let out = super.asDTO(); + if (out === null) return null; out.class = "date"; out.value = this._value.attempt; return out; @@ -372,6 +379,8 @@ export class Search { } this._c.search.oninput((null as Event)); }; + queries.push(q); + continue; } } if (queryFormat.string) { @@ -384,6 +393,8 @@ export class Search { } this._c.search.oninput((null as Event)); } + queries.push(q); + continue; } if (queryFormat.date) { let [parsedDate, op, isDate] = DateQuery.paramsFromString(split[1]); @@ -398,37 +409,48 @@ export class Search { this._c.search.oninput((null as Event)); } + queries.push(q); + continue; } - - if (q != null) queries.push(q); + // if (q != null) queries.push(q); } return [searchTerms, queries]; } - + // Returns a list of identifiers (used as keys in items, values in ordering). - search = (query: string): string[] => { - let timer = this.timeSearches ? performance.now() : null; - this._c.filterArea.textContent = ""; - + searchParsed = (searchTerms: string[], queries: Query[]): string[] => { let result: string[] = [...this._ordering]; - // If we're in a server search already, the results are already correct. - if (this.inServerSearch) return result; + // If we're in a server search already, the results are (probably) already correct. + if (this.inServerSearch) { + let hasLocalOnlyQueries = false; + for (const q of queries) { + if (q.localOnly) { + hasLocalOnlyQueries = true; + break; + } + } + if (!hasLocalOnlyQueries) return result; + // Continue on if really necessary + } - const [searchTerms, queries] = this.parseTokens(Search.tokenizeSearch(query)); - - query = ""; - - for (let term of searchTerms) { - let cachedResult = [...result]; - for (let id of cachedResult) { - const u = this.items[id]; - if (!u.matchesSearch(term)) { - result.splice(result.indexOf(id), 1); + // Normal searches can be evaluated by the server, so skip this if we've already ran one. + if (!this.inServerSearch) { + for (let term of searchTerms) { + let cachedResult = [...result]; + for (let id of cachedResult) { + const u = this.items[id]; + if (!u.matchesSearch(term)) { + result.splice(result.indexOf(id), 1); + } } } } + for (let q of queries) { this._c.filterArea.appendChild(q.asElement()); + // Skip if this query has already been performed by the server. + if (this.inServerSearch && !(q.localOnly)) continue; + let cachedResult = [...result]; if (q.subject.bool) { for (let id of cachedResult) { @@ -466,7 +488,18 @@ export class Search { } } } + return result; + } + // Returns a list of identifiers (used as keys in items, values in ordering). + search = (query: string): string[] => { + let timer = this.timeSearches ? performance.now() : null; + this._c.filterArea.textContent = ""; + + const [searchTerms, queries] = this.parseTokens(Search.tokenizeSearch(query)); + + let result = this.searchParsed(searchTerms, queries); + this._queries = queries; this._searchTerms = searchTerms; @@ -476,6 +509,11 @@ export class Search { } return result; } + + // postServerSearch performs local-only queries after a server search if necessary. + postServerSearch = () => { + this.searchParsed(this._searchTerms, this._queries); + }; showHideSearchOptionsHeader = () => { let sortingBy = false; @@ -642,12 +680,16 @@ export class Search { serverSearchParams = (searchTerms: string[], queries: Query[]): PaginatedReqDTO => { let req: ServerSearchReqDTO = { searchTerms: searchTerms, - queries: queries.map((q: Query) => q.asDTO()), + queries: [], // queries.map((q: Query) => q.asDTO()) won't work as localOnly queries return null limit: -1, page: 0, sortByField: this.sortField, ascending: this.ascending }; + for (const q of queries) { + const dto = q.asDTO(); + if (dto !== null) req.queries.push(dto); + } return req; } diff --git a/usercache.go b/usercache.go index b9dc246..07e6868 100644 --- a/usercache.go +++ b/usercache.go @@ -306,16 +306,38 @@ func (q QueryDTO) AsFilter() Filter { return cmp.Compare(bool2int(a.NotifyThroughEmail), bool2int(q.Value.(bool))) == int(operator) } case "last_active": - return func(a *respUser) bool { - return q.Value.(DateAttempt).CompareUnix(a.LastActive) == int(operator) + switch q.Class { + case DateQuery: + return func(a *respUser) bool { + return q.Value.(DateAttempt).CompareUnix(a.LastActive) == int(operator) + } + case BoolQuery: + return func(a *respUser) bool { + val := a.LastActive != 0 + if q.Value.(bool) == false { + val = !val + } + return val + } } case "admin": return func(a *respUser) bool { return cmp.Compare(bool2int(a.Admin), bool2int(q.Value.(bool))) == int(operator) } case "expiry": - return func(a *respUser) bool { - return q.Value.(DateAttempt).CompareUnix(a.Expiry) == int(operator) + switch q.Class { + case DateQuery: + return func(a *respUser) bool { + return q.Value.(DateAttempt).CompareUnix(a.Expiry) == int(operator) + } + case BoolQuery: + return func(a *respUser) bool { + val := a.Expiry != 0 + if q.Value.(bool) == false { + val = !val + } + return val + } } case "disabled": return func(a *respUser) bool { From 699cbee2401b20e2e7023d8901152466215d45d5 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Mon, 26 May 2025 17:28:09 +0100 Subject: [PATCH 041/249] search: fix "search all" button disabling logic, more just a few more general fixes. Also changed the "Search all" button to say "Search/sort all". --- lang/admin/en-us.json | 4 ++-- ts/modules/accounts.ts | 11 +++++------ ts/modules/list.ts | 30 +++++++++++++++++++++--------- ts/modules/search.ts | 22 ++++++++++------------ 4 files changed, 38 insertions(+), 29 deletions(-) diff --git a/lang/admin/en-us.json b/lang/admin/en-us.json index d420ee8..6638176 100644 --- a/lang/admin/en-us.json +++ b/lang/admin/en-us.json @@ -137,8 +137,8 @@ "filters": "Filters", "clickToRemoveFilter": "Click to remove this filter.", "clearSearch": "Clear search", - "searchAll": "Search all", - "searchAllRecords": "Search all records (on server)", + "searchAll": "Search/sort all", + "searchAllRecords": "Search/sort all records (on server)", "actions": "Actions", "searchOptions": "Search Options", "matchText": "Match Text", diff --git a/ts/modules/accounts.ts b/ts/modules/accounts.ts index fd642d7..de96b94 100644 --- a/ts/modules/accounts.ts +++ b/ts/modules/accounts.ts @@ -1188,7 +1188,7 @@ export class accountsList extends PaginatedList { const headerNames: string[] = ["username", "access-jfa", "email", "telegram", "matrix", "discord", "expiry", "last-active", "referrals"]; const headerGetters: string[] = ["name", "accounts_admin", "email", "telegram", "matrix", "discord", "expiry", "last_active", "referrals_enabled"]; for (let i = 0; i < headerNames.length; i++) { - const header: HTMLTableHeaderCellElement = document.querySelector(".accounts-header-" + headerNames[i]) as HTMLTableHeaderCellElement; + const header: HTMLTableCellElement = document.querySelector(".accounts-header-" + headerNames[i]) as HTMLTableCellElement; if (header !== null) { this._columns[headerGetters[i]] = new Column(header, headerGetters[i], Object.getOwnPropertyDescriptor(user.prototype, headerGetters[i]).get); } @@ -1219,10 +1219,9 @@ export class accountsList extends PaginatedList { } else { this.setVisibility(this._search.ordering, true); this._search.setNotFoundPanelVisibility(false); - this._search.setServerSearchButtonsDisabled( - event.detail == this._c.defaultSortField && this._columns[event.detail].ascending == this._c.defaultSortAscending - ); } + this._search.inServerSearch = false; + this.autoSetServerSearchButtonsDisabled(); this._search.showHideSearchOptionsHeader(); }); @@ -2116,14 +2115,14 @@ type Getter = () => GetterReturnType; // When list is refreshed, accountList calls method of the specific Column and re-orders accordingly. // Listen for broadcast event from others, check its not us by comparing the header className in the message, then hide the arrow icon class Column { - private _header: HTMLTableHeaderCellElement; + private _header: HTMLTableCellElement; private _name: string; private _headerContent: string; private _getter: Getter; private _ascending: boolean; private _active: boolean; - constructor(header: HTMLTableHeaderCellElement, name: string, getter: Getter) { + constructor(header: HTMLTableCellElement, name: string, getter: Getter) { this._header = header; this._name = name; this._headerContent = this._header.textContent; diff --git a/ts/modules/list.ts b/ts/modules/list.ts index 2335a2c..b3f0d8a 100644 --- a/ts/modules/list.ts +++ b/ts/modules/list.ts @@ -128,14 +128,13 @@ export abstract class PaginatedList { if (v) { this._c.loadAllButton.classList.add("unfocused"); this._c.loadMoreButton.textContent = window.lang.strings("noMoreResults"); - this._search.setServerSearchButtonsDisabled(this._search.inServerSearch); this._c.loadMoreButton.disabled = true; } else { this._c.loadMoreButton.textContent = window.lang.strings("loadMore"); this._c.loadMoreButton.disabled = false; - this._search.setServerSearchButtonsDisabled(false); this._c.loadAllButton.classList.remove("unfocused"); } + this.autoSetServerSearchButtonsDisabled(); } protected _previousVisibleItemCount = 0; @@ -171,17 +170,30 @@ export abstract class PaginatedList { this._c.refreshButton.onclick = () => this.reload(); } + autoSetServerSearchButtonsDisabled = () => { + const serverSearchSortChanged = this._search.inServerSearch && (this._searchParams.sortByField != this._search.sortField || this._searchParams.ascending != this._search.ascending); + if (this._search.inServerSearch) { + if (serverSearchSortChanged) { + this._search.setServerSearchButtonsDisabled(false); + } else { + this._search.setServerSearchButtonsDisabled(this.lastPage); + } + return; + } + if (!this._search.inSearch && this._search.sortField == this._c.defaultSortField && this._search.ascending == this._c.defaultSortAscending) { + this._search.setServerSearchButtonsDisabled(true); + return; + } + this._search.setServerSearchButtonsDisabled(false); + } + initSearch = (searchConfig: SearchConfiguration) => { const previousCallback = searchConfig.onSearchCallback; searchConfig.onSearchCallback = (newItems: boolean, loadAll: boolean) => { // if (this._search.inSearch && !this.lastPage) this._c.loadAllButton.classList.remove("unfocused"); // else this._c.loadAllButton.classList.add("unfocused"); - - if (this._search.sortField == this._c.defaultSortField && this._search.ascending == this._c.defaultSortAscending) { - this._search.setServerSearchButtonsDisabled(!this._search.inSearch) - } else { - this._search.setServerSearchButtonsDisabled(false) - } + + this.autoSetServerSearchButtonsDisabled(); // FIXME: Figure out why this makes sense and make it clearer. if ((this._visible.length < this._c.itemsPerPage && this._counter.loaded < this._c.maxItemsLoadedForSearch && !this.lastPage) || loadAll) { @@ -205,7 +217,7 @@ export abstract class PaginatedList { if (previousServerSearch) previousServerSearch(params, newSearch); }; searchConfig.clearServerSearch = () => { - console.log("Clearing server search"); + console.trace("Clearing server search"); this._page = 0; this.reload(); } diff --git a/ts/modules/search.ts b/ts/modules/search.ts index 46bb7fa..d27c4d7 100644 --- a/ts/modules/search.ts +++ b/ts/modules/search.ts @@ -420,18 +420,16 @@ export class Search { // Returns a list of identifiers (used as keys in items, values in ordering). searchParsed = (searchTerms: string[], queries: Query[]): string[] => { let result: string[] = [...this._ordering]; - // If we're in a server search already, the results are (probably) already correct. - if (this.inServerSearch) { - let hasLocalOnlyQueries = false; - for (const q of queries) { - if (q.localOnly) { - hasLocalOnlyQueries = true; - break; - } - } - if (!hasLocalOnlyQueries) return result; - // Continue on if really necessary - } + // If we didn't care about rendering the query cards, we could run this to (maybe) return early. + // if (this.inServerSearch) { + // let hasLocalOnlyQueries = false; + // for (const q of queries) { + // if (q.localOnly) { + // hasLocalOnlyQueries = true; + // break; + // } + // } + // } // Normal searches can be evaluated by the server, so skip this if we've already ran one. if (!this.inServerSearch) { From f6044578c01185f706def62e60926c0b15563aaa Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Mon, 26 May 2025 21:28:46 +0100 Subject: [PATCH 042/249] list: fix activities sort, css improvements fixed activities sorting. less oddities from me not knowing how to use flex boxes. Also kinda standardised a button-inside-input thing, so added a .gap- > .inside-input selector which works on gap-1 and gap-2. --- css/base.css | 16 ++++++++ html/admin.html | 84 +++++++++++++++++++++--------------------- ts/crash.ts | 1 - ts/modules/accounts.ts | 45 ++++++++++++++-------- ts/modules/activity.ts | 14 +++++-- ts/modules/list.ts | 2 +- ts/modules/login.ts | 2 +- ts/modules/search.ts | 25 +++++++++---- ts/user.ts | 2 +- 9 files changed, 119 insertions(+), 72 deletions(-) diff --git a/css/base.css b/css/base.css index d9b53e6..2c084c2 100644 --- a/css/base.css +++ b/css/base.css @@ -470,3 +470,19 @@ section.section:not(.\~neutral) { } } +:root { + /* seems to be the sweet spot */ + --inside-input-base: -2.6rem; + + /* thought --spacing would do the trick but apparently not */ + --tailwind-spacing: 0.25rem; +} + +/* places buttons inside a sibling input element (hopefully), based on the flex gap of the parent. */ +.gap-1 > .button.inside-input { + margin-left: calc(var(--inside-input-base) - 1.0*var(--tailwind-spacing)); +} + +.gap-2 > .button.inside-input { + margin-left: calc(var(--inside-input-base) - 2.0*var(--tailwind-spacing)); +} diff --git a/html/admin.html b/html/admin.html index 23e70e9..b2dda34 100644 --- a/html/admin.html +++ b/html/admin.html @@ -715,7 +715,7 @@
-
+