* Add support for storing DM history between users in a SQLite3 database. * Opt-in by editing your settings.toml to set DirectMessageHistory/Enabled=true * Retention days (default 90) will flush old DMs on app startup. * On the front-end, DM history is checked when a DM thread is opened.
253 lines
5.5 KiB
Go
253 lines
5.5 KiB
Go
package config
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"html/template"
|
|
"os"
|
|
|
|
"git.kirsle.net/apps/barertc/pkg/log"
|
|
"github.com/BurntSushi/toml"
|
|
"github.com/google/uuid"
|
|
)
|
|
|
|
// Version of the config format - when new fields are added, it will attempt
|
|
// to write the settings.toml to disk so new defaults populate.
|
|
var currentVersion = 11
|
|
|
|
// Config for your BareRTC app.
|
|
type Config struct {
|
|
Version int // will re-save your settings.toml on migrations
|
|
|
|
JWT struct {
|
|
Enabled bool
|
|
Strict bool
|
|
SecretKey string
|
|
LandingPageURL string
|
|
}
|
|
|
|
Title string
|
|
Branding string
|
|
WebsiteURL string
|
|
|
|
CORSHosts []string
|
|
AdminAPIKey string
|
|
PermitNSFW bool
|
|
|
|
UseXForwardedFor bool
|
|
|
|
WebSocketReadLimit int64
|
|
WebSocketSendTimeout int
|
|
MaxImageWidth int
|
|
PreviewImageWidth int
|
|
|
|
TURN TurnConfig
|
|
|
|
PublicChannels []Channel
|
|
|
|
WebhookURLs []WebhookURL
|
|
|
|
VIP VIP
|
|
|
|
MessageFilters []*MessageFilter
|
|
|
|
DirectMessageHistory DirectMessageHistory
|
|
|
|
Logging Logging
|
|
}
|
|
|
|
type TurnConfig struct {
|
|
URLs []string
|
|
Username string
|
|
Credential string
|
|
}
|
|
|
|
type VIP struct {
|
|
Name string
|
|
Branding string
|
|
Icon string
|
|
MutuallySecret bool
|
|
}
|
|
|
|
type DirectMessageHistory struct {
|
|
Enabled bool
|
|
SQLiteDatabase string
|
|
RetentionDays int
|
|
DisclaimerMessage string
|
|
}
|
|
|
|
// GetChannels returns a JavaScript safe array of the default PublicChannels.
|
|
func (c Config) GetChannels() template.JS {
|
|
data, _ := json.Marshal(c.PublicChannels)
|
|
return template.JS(data)
|
|
}
|
|
|
|
// GetChannel looks up and returns a channel by ID.
|
|
func (c Config) GetChannel(id string) (Channel, bool) {
|
|
for _, ch := range c.PublicChannels {
|
|
if ch.ID == id {
|
|
return ch, true
|
|
}
|
|
}
|
|
return Channel{}, false
|
|
}
|
|
|
|
// Channel config for a default public room.
|
|
type Channel struct {
|
|
ID string // Like "lobby"
|
|
Name string // Like "Main Chat Room"
|
|
Icon string `toml:",omitempty"` // CSS class names for room icon (optional)
|
|
VIP bool // For VIP users only
|
|
|
|
// ChatServer messages to send to the user immediately upon connecting.
|
|
WelcomeMessages []string
|
|
}
|
|
|
|
// WebhookURL allows tighter integration with your website.
|
|
type WebhookURL struct {
|
|
Name string
|
|
Enabled bool
|
|
URL string
|
|
}
|
|
|
|
// Logging configs to monitor channels or usernames.
|
|
type Logging struct {
|
|
Enabled bool
|
|
Directory string
|
|
Channels []string
|
|
Usernames []string
|
|
}
|
|
|
|
// Current loaded configuration.
|
|
var Current = DefaultConfig()
|
|
|
|
// DefaultConfig returns sensible defaults and will write the initial
|
|
// settings.toml file to disk.
|
|
func DefaultConfig() Config {
|
|
var c = Config{
|
|
Title: "BareRTC",
|
|
Branding: "BareRTC",
|
|
WebsiteURL: "https://www.example.com",
|
|
AdminAPIKey: uuid.New().String(),
|
|
CORSHosts: []string{
|
|
"https://www.example.com",
|
|
},
|
|
WebSocketReadLimit: 1024 * 1024 * 40, // 40 MB.
|
|
WebSocketSendTimeout: 10, // seconds
|
|
MaxImageWidth: 1280,
|
|
PreviewImageWidth: 360,
|
|
PublicChannels: []Channel{
|
|
{
|
|
ID: "lobby",
|
|
Name: "Lobby",
|
|
WelcomeMessages: []string{
|
|
"Welcome to the chat server!",
|
|
"Please follow the basic rules:\n\n1. Have fun\n2. Be kind",
|
|
},
|
|
},
|
|
{
|
|
ID: "offtopic",
|
|
Name: "Off Topic",
|
|
WelcomeMessages: []string{
|
|
"Welcome to the Off Topic channel!",
|
|
},
|
|
},
|
|
{
|
|
ID: "vip",
|
|
Name: "VIPs Only",
|
|
VIP: true,
|
|
WelcomeMessages: []string{
|
|
"This channel is only for operators and VIPs.",
|
|
},
|
|
},
|
|
},
|
|
TURN: TurnConfig{
|
|
URLs: []string{
|
|
"stun:stun.l.google.com:19302",
|
|
},
|
|
},
|
|
WebhookURLs: []WebhookURL{
|
|
{
|
|
Name: "report",
|
|
URL: "https://example.com/barertc/report",
|
|
},
|
|
{
|
|
Name: "profile",
|
|
URL: "https://example.com/barertc/user-profile",
|
|
},
|
|
},
|
|
VIP: VIP{
|
|
Name: "VIP",
|
|
Branding: "<em>VIP Members</em>",
|
|
Icon: "fa fa-circle",
|
|
},
|
|
MessageFilters: []*MessageFilter{
|
|
{
|
|
PublicChannels: true,
|
|
PrivateChannels: true,
|
|
KeywordPhrases: []string{
|
|
`\bswear words\b`,
|
|
`\b(swearing|cursing)\b`,
|
|
`suck my ([^\s]+)`,
|
|
},
|
|
CensorMessage: true,
|
|
ChatServerResponse: "Watch your language.",
|
|
},
|
|
},
|
|
DirectMessageHistory: DirectMessageHistory{
|
|
Enabled: false,
|
|
SQLiteDatabase: "database.sqlite",
|
|
RetentionDays: 90,
|
|
DisclaimerMessage: `<i class="fa fa-info-circle mr-1"></i> <strong>Reminder:</strong> please conduct yourself honorably in Direct Messages.`,
|
|
},
|
|
Logging: Logging{
|
|
Directory: "./logs",
|
|
Channels: []string{"lobby", "offtopic"},
|
|
Usernames: []string{},
|
|
},
|
|
}
|
|
c.JWT.Strict = true
|
|
return c
|
|
}
|
|
|
|
// LoadSettings reads a settings.toml from disk if available.
|
|
func LoadSettings() error {
|
|
data, err := os.ReadFile("./settings.toml")
|
|
if err != nil {
|
|
// Settings file didn't exist, create the default one.
|
|
if os.IsNotExist(err) {
|
|
WriteSettings()
|
|
return nil
|
|
}
|
|
|
|
return err
|
|
}
|
|
|
|
_, err = toml.Decode(string(data), &Current)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Have we added new config fields? Save the settings.toml.
|
|
if Current.Version != currentVersion {
|
|
log.Warn("New options are available for your settings.toml file. Your settings will be re-saved now.")
|
|
Current.Version = currentVersion
|
|
if err := WriteSettings(); err != nil {
|
|
log.Error("Couldn't write your settings.toml file: %s", err)
|
|
}
|
|
}
|
|
|
|
return err
|
|
}
|
|
|
|
// WriteSettings will commit the settings.toml to disk.
|
|
func WriteSettings() error {
|
|
log.Error("Note: initial settings.toml was written to disk.")
|
|
var buf = new(bytes.Buffer)
|
|
err := toml.NewEncoder(buf).Encode(Current)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return os.WriteFile("./settings.toml", buf.Bytes(), 0644)
|
|
}
|