"encoding/binary"
"errors"
"fmt"
- "github.com/go-playground/validator/v10"
"golang.org/x/text/encoding/charmap"
"gopkg.in/yaml.v3"
"io"
"log/slog"
"net"
"os"
- "path"
"path/filepath"
"strings"
"sync"
- "sync/atomic"
"time"
)
type Server struct {
NetInterface string
Port int
- Accounts map[string]*Account
- Agreement []byte
- Clients map[[2]byte]*ClientConn
- fileTransfers map[[4]byte]*FileTransfer
-
- Config *Config
+ Config Config
ConfigDir string
Logger *slog.Logger
- banner []byte
- PrivateChatsMu sync.Mutex
- PrivateChats map[[4]byte]*PrivateChat
-
- nextClientID atomic.Uint32
TrackerPassID [4]byte
- statsMu sync.Mutex
- Stats *Stats
+ Stats Counter
FS FileStore // Storage backend to use for File storage
outbox chan Transaction
- mux sync.Mutex
- threadedNewsMux sync.Mutex
- ThreadedNews *ThreadedNews
+ // TODO
+ Agreement []byte
+ banner []byte
+ // END TODO
- flatNewsMux sync.Mutex
- FlatNews []byte
+ FileTransferMgr FileTransferMgr
+ ChatMgr ChatManager
+ ClientMgr ClientManager
+ AccountManager AccountManager
+ ThreadedNewsMgr ThreadedNewsMgr
+ BanList BanMgr
- banListMU sync.Mutex
- banList map[string]*time.Time
+ MessageBoard io.ReadWriteSeeker
}
-func (s *Server) CurrentStats() Stats {
- s.statsMu.Lock()
- defer s.statsMu.Unlock()
+// NewServer constructs a new Server from a config dir
+func NewServer(config Config, configDir, netInterface string, netPort int, logger *slog.Logger, fs FileStore) (*Server, error) {
+ server := Server{
+ NetInterface: netInterface,
+ Port: netPort,
+ Config: config,
+ ConfigDir: configDir,
+ Logger: logger,
+ outbox: make(chan Transaction),
+ Stats: NewStats(),
+ FS: fs,
+ ChatMgr: NewMemChatManager(),
+ ClientMgr: NewMemClientMgr(),
+ FileTransferMgr: NewMemFileTransferMgr(),
+ }
+
+ // generate a new random passID for tracker registration
+ _, err := rand.Read(server.TrackerPassID[:])
+ if err != nil {
+ return nil, err
+ }
+
+ server.Agreement, err = os.ReadFile(filepath.Join(configDir, agreementFile))
+ if err != nil {
+ return nil, err
+ }
+
+ server.AccountManager, err = NewYAMLAccountManager(filepath.Join(configDir, "Users/"))
+ if err != nil {
+ return nil, fmt.Errorf("error loading accounts: %w", err)
+ }
+
+ // If the FileRoot is an absolute path, use it, otherwise treat as a relative path to the config dir.
+ if !filepath.IsAbs(server.Config.FileRoot) {
+ server.Config.FileRoot = filepath.Join(configDir, server.Config.FileRoot)
+ }
+
+ server.banner, err = os.ReadFile(filepath.Join(server.ConfigDir, server.Config.BannerFile))
+ if err != nil {
+ return nil, fmt.Errorf("error opening banner: %w", err)
+ }
+
+ if server.Config.EnableTrackerRegistration {
+ server.Logger.Info(
+ "Tracker registration enabled",
+ "frequency", fmt.Sprintf("%vs", trackerUpdateFrequency),
+ "trackers", server.Config.Trackers,
+ )
+
+ go server.registerWithTrackers()
+ }
- stats := s.Stats
- stats.CurrentlyConnected = len(s.Clients)
+ // Start Client Keepalive go routine
+ go server.keepaliveHandler()
- return *stats
+ return &server, nil
}
-type PrivateChat struct {
- Subject string
- ClientConn map[[2]byte]*ClientConn
+func (s *Server) CurrentStats() map[string]interface{} {
+ return s.Stats.Values()
}
func (s *Server) ListenAndServe(ctx context.Context) error {
}
func (s *Server) sendTransaction(t Transaction) error {
- s.mux.Lock()
- client, ok := s.Clients[t.clientID]
- s.mux.Unlock()
+ client := s.ClientMgr.Get(t.clientID)
- if !ok || client == nil {
+ if client == nil {
return nil
}
agreementFile = "Agreement.txt"
)
-// NewServer constructs a new Server from a config dir
-// TODO: move config file reads out of this function
-func NewServer(configDir, netInterface string, netPort int, logger *slog.Logger, fs FileStore) (*Server, error) {
- server := Server{
- NetInterface: netInterface,
- Port: netPort,
- Accounts: make(map[string]*Account),
- Config: new(Config),
- Clients: make(map[[2]byte]*ClientConn),
- fileTransfers: make(map[[4]byte]*FileTransfer),
- PrivateChats: make(map[[4]byte]*PrivateChat),
- ConfigDir: configDir,
- Logger: logger,
- outbox: make(chan Transaction),
- Stats: &Stats{Since: time.Now()},
- ThreadedNews: &ThreadedNews{},
- FS: fs,
- banList: make(map[string]*time.Time),
- }
-
- var err error
-
- // generate a new random passID for tracker registration
- if _, err := rand.Read(server.TrackerPassID[:]); err != nil {
- return nil, err
- }
-
- server.Agreement, err = os.ReadFile(filepath.Join(configDir, agreementFile))
- if err != nil {
- return nil, err
- }
-
- if server.FlatNews, err = os.ReadFile(filepath.Join(configDir, "MessageBoard.txt")); err != nil {
- return nil, err
- }
-
- // try to load the ban list, but ignore errors as this file may not be present or may be empty
- //_ = server.loadBanList(filepath.Join(configDir, "Banlist.yaml"))
-
- _ = loadFromYAMLFile(filepath.Join(configDir, "Banlist.yaml"), &server.banList)
-
- err = loadFromYAMLFile(filepath.Join(configDir, "ThreadedNews.yaml"), &server.ThreadedNews)
- if err != nil {
- return nil, fmt.Errorf("error loading threaded news: %w", err)
- }
-
- err = server.loadConfig(filepath.Join(configDir, "config.yaml"))
- if err != nil {
- return nil, fmt.Errorf("error loading config: %w", err)
- }
-
- if err := server.loadAccounts(filepath.Join(configDir, "Users/")); err != nil {
- return nil, err
- }
-
- // If the FileRoot is an absolute path, use it, otherwise treat as a relative path to the config dir.
- if !filepath.IsAbs(server.Config.FileRoot) {
- server.Config.FileRoot = filepath.Join(configDir, server.Config.FileRoot)
- }
-
- server.banner, err = os.ReadFile(filepath.Join(server.ConfigDir, server.Config.BannerFile))
- if err != nil {
- return nil, fmt.Errorf("error opening banner: %w", err)
- }
-
- if server.Config.EnableTrackerRegistration {
- server.Logger.Info(
- "Tracker registration enabled",
- "frequency", fmt.Sprintf("%vs", trackerUpdateFrequency),
- "trackers", server.Config.Trackers,
- )
-
- go func() {
- for {
- tr := &TrackerRegistration{
- UserCount: server.userCount(),
- PassID: server.TrackerPassID,
- Name: server.Config.Name,
- Description: server.Config.Description,
- }
- binary.BigEndian.PutUint16(tr.Port[:], uint16(server.Port))
- for _, t := range server.Config.Trackers {
- if err := register(&RealDialer{}, t, tr); err != nil {
- server.Logger.Error("unable to register with tracker %v", "error", err)
- }
- server.Logger.Debug("Sent Tracker registration", "addr", t)
- }
-
- time.Sleep(trackerUpdateFrequency * time.Second)
+func (s *Server) registerWithTrackers() {
+ for {
+ tr := &TrackerRegistration{
+ UserCount: len(s.ClientMgr.List()),
+ PassID: s.TrackerPassID,
+ Name: s.Config.Name,
+ Description: s.Config.Description,
+ }
+ binary.BigEndian.PutUint16(tr.Port[:], uint16(s.Port))
+ for _, t := range s.Config.Trackers {
+ if err := register(&RealDialer{}, t, tr); err != nil {
+ s.Logger.Error(fmt.Sprintf("unable to register with tracker %v", t), "error", err)
}
- }()
- }
-
- // Start Client Keepalive go routine
- go server.keepaliveHandler()
-
- return &server, nil
-}
-
-func (s *Server) userCount() int {
- s.mux.Lock()
- defer s.mux.Unlock()
+ }
- return len(s.Clients)
+ time.Sleep(trackerUpdateFrequency * time.Second)
+ }
}
+// keepaliveHandler
func (s *Server) keepaliveHandler() {
for {
time.Sleep(idleCheckInterval * time.Second)
- s.mux.Lock()
- for _, c := range s.Clients {
+ for _, c := range s.ClientMgr.List() {
+ c.mu.Lock()
+
c.IdleTime += idleCheckInterval
- if c.IdleTime > userIdleSeconds && !c.Idle {
- c.Idle = true
- c.flagsMU.Lock()
+ // Check if the user
+ if c.IdleTime > userIdleSeconds && !c.Flags.IsSet(UserFlagAway) {
c.Flags.Set(UserFlagAway, 1)
- c.flagsMU.Unlock()
- c.sendAll(
+
+ c.SendAll(
TranNotifyChangeUser,
NewField(FieldUserID, c.ID[:]),
NewField(FieldUserFlags, c.Flags[:]),
NewField(FieldUserIconID, c.Icon),
)
}
+ c.mu.Unlock()
}
- s.mux.Unlock()
- }
-}
-
-func (s *Server) writeBanList() error {
- s.banListMU.Lock()
- defer s.banListMU.Unlock()
-
- out, err := yaml.Marshal(s.banList)
- if err != nil {
- return err
}
- err = os.WriteFile(
- filepath.Join(s.ConfigDir, "Banlist.yaml"),
- out,
- 0666,
- )
- return err
-}
-
-func (s *Server) writeThreadedNews() error {
- s.threadedNewsMux.Lock()
- defer s.threadedNewsMux.Unlock()
-
- out, err := yaml.Marshal(s.ThreadedNews)
- if err != nil {
- return err
- }
- err = s.FS.WriteFile(
- filepath.Join(s.ConfigDir, "ThreadedNews.yaml"),
- out,
- 0666,
- )
- return err
}
func (s *Server) NewClientConn(conn io.ReadWriteCloser, remoteAddr string) *ClientConn {
- s.mux.Lock()
- defer s.mux.Unlock()
-
clientConn := &ClientConn{
Icon: []byte{0, 0}, // TODO: make array type
Connection: conn,
Server: s,
RemoteAddr: remoteAddr,
- transfers: map[int]map[[4]byte]*FileTransfer{
- FileDownload: {},
- FileUpload: {},
- FolderDownload: {},
- FolderUpload: {},
- bannerDownload: {},
- },
- }
-
- s.nextClientID.Add(1)
-
- binary.BigEndian.PutUint16(clientConn.ID[:], uint16(s.nextClientID.Load()))
- s.Clients[clientConn.ID] = clientConn
-
- return clientConn
-}
-
-// NewUser creates a new user account entry in the server map and config file
-func (s *Server) NewUser(login, name, password string, access accessBitmap) error {
- s.mux.Lock()
- defer s.mux.Unlock()
-
- account := NewAccount(login, name, password, access)
-
- // Create account file, returning an error if one already exists.
- file, err := os.OpenFile(
- filepath.Join(s.ConfigDir, "Users", path.Join("/", login)+".yaml"),
- os.O_CREATE|os.O_EXCL|os.O_WRONLY, 0644,
- )
- if err != nil {
- return fmt.Errorf("error creating account file: %w", err)
- }
- defer file.Close()
-
- b, err := yaml.Marshal(account)
- if err != nil {
- return err
- }
-
- _, err = file.Write(b)
- if err != nil {
- return fmt.Errorf("error writing account file: %w", err)
- }
-
- s.Accounts[login] = account
-
- return nil
-}
-
-func (s *Server) UpdateUser(login, newLogin, name, password string, access accessBitmap) error {
- s.mux.Lock()
- defer s.mux.Unlock()
-
- // If the login has changed, rename the account file.
- if login != newLogin {
- err := os.Rename(
- filepath.Join(s.ConfigDir, "Users", path.Join("/", login)+".yaml"),
- filepath.Join(s.ConfigDir, "Users", path.Join("/", newLogin)+".yaml"),
- )
- if err != nil {
- return fmt.Errorf("error renaming account file: %w", err)
- }
- s.Accounts[newLogin] = s.Accounts[login]
- s.Accounts[newLogin].Login = newLogin
- delete(s.Accounts, login)
- }
-
- account := s.Accounts[newLogin]
- account.Access = access
- account.Name = name
- account.Password = password
-
- out, err := yaml.Marshal(&account)
- if err != nil {
- return err
- }
-
- if err := os.WriteFile(filepath.Join(s.ConfigDir, "Users", newLogin+".yaml"), out, 0666); err != nil {
- return fmt.Errorf("error writing account file: %w", err)
- }
-
- return nil
-}
-// DeleteUser deletes the user account
-func (s *Server) DeleteUser(login string) error {
- s.mux.Lock()
- defer s.mux.Unlock()
-
- err := s.FS.Remove(filepath.Join(s.ConfigDir, "Users", path.Join("/", login)+".yaml"))
- if err != nil {
- return err
+ ClientFileTransferMgr: NewClientFileTransferMgr(),
}
- delete(s.Accounts, login)
+ s.ClientMgr.Add(clientConn)
- return nil
-}
-
-func (s *Server) connectedUsers() []Field {
- //s.mux.Lock()
- //defer s.mux.Unlock()
-
- var connectedUsers []Field
- for _, c := range sortedClients(s.Clients) {
- b, err := io.ReadAll(&User{
- ID: c.ID,
- Icon: c.Icon,
- Flags: c.Flags[:],
- Name: string(c.UserName),
- })
- if err != nil {
- return nil
- }
- connectedUsers = append(connectedUsers, NewField(FieldUsernameWithInfo, b))
- }
- return connectedUsers
+ return clientConn
}
// loadFromYAMLFile loads data from a YAML file into the provided data structure.
return decoder.Decode(data)
}
-// loadAccounts loads account data from disk
-func (s *Server) loadAccounts(userDir string) error {
- matches, err := filepath.Glob(filepath.Join(userDir, "*.yaml"))
- if err != nil {
- return err
- }
-
- if len(matches) == 0 {
- return fmt.Errorf("no accounts found in directory: %s", userDir)
- }
-
- for _, file := range matches {
- var account Account
- if err = loadFromYAMLFile(file, &account); err != nil {
- return fmt.Errorf("error loading account %s: %w", file, err)
- }
-
- s.Accounts[account.Login] = &account
- }
- return nil
-}
-
-func (s *Server) loadConfig(path string) error {
- fh, err := s.FS.Open(path)
- if err != nil {
- return err
- }
-
- decoder := yaml.NewDecoder(fh)
- err = decoder.Decode(s.Config)
- if err != nil {
- return err
- }
-
- validate := validator.New()
- err = validate.Struct(s.Config)
- if err != nil {
- return err
- }
- return nil
-}
-
func sendBanMessage(rwc io.Writer, message string) {
t := NewTransaction(
TranServerMsg,
// Check if remoteAddr is present in the ban list
ipAddr := strings.Split(remoteAddr, ":")[0]
- if banUntil, ok := s.banList[ipAddr]; ok {
+ if isBanned, banUntil := s.BanList.IsBanned(ipAddr); isBanned {
// permaban
if banUntil == nil {
sendBanMessage(rwc, "You are permanently banned on this server")
encodedPassword := clientLogin.GetField(FieldUserPassword).Data
c.Version = clientLogin.GetField(FieldVersion).Data
- login := string(encodeString(clientLogin.GetField(FieldUserLogin).Data))
+ login := clientLogin.GetField(FieldUserLogin).DecodeObfuscatedString()
if login == "" {
login = GuestAccount
}
- c.logger = s.Logger.With("remoteAddr", remoteAddr, "login", login)
+ c.logger = s.Logger.With("ip", ipAddr, "login", login)
// If authentication fails, send error reply and close connection
if !c.Authenticate(login, encodedPassword) {
c.Icon = clientLogin.GetField(FieldUserIconID).Data
}
- c.Lock()
- c.Account = c.Server.Accounts[login]
- c.Unlock()
+ c.Account = c.Server.AccountManager.Get(login)
+ if c.Account == nil {
+ return nil
+ }
if clientLogin.GetField(FieldUserName).Data != nil {
- if c.Authorize(accessAnyName) {
+ if c.Authorize(AccessAnyName) {
c.UserName = clientLogin.GetField(FieldUserName).Data
} else {
c.UserName = []byte(c.Account.Name)
}
}
- if c.Authorize(accessDisconUser) {
+ if c.Authorize(AccessDisconUser) {
c.Flags.Set(UserFlagAdmin, 1)
}
// Send user access privs so client UI knows how to behave
c.Server.outbox <- NewTransaction(TranUserAccess, c.ID, NewField(FieldUserAccess, c.Account.Access[:]))
- // Accounts with accessNoAgreement do not receive the server agreement on login. The behavior is different between
+ // Accounts with AccessNoAgreement do not receive the server agreement on login. The behavior is different between
// client versions. For 1.2.3 client, we do not send TranShowAgreement. For other client versions, we send
// TranShowAgreement but with the NoServerAgreement field set to 1.
- if c.Authorize(accessNoAgreement) {
+ if c.Authorize(AccessNoAgreement) {
// If client version is nil, then the client uses the 1.2.3 login behavior
if c.Version != nil {
c.Server.outbox <- NewTransaction(TranShowAgreement, c.ID, NewField(FieldNoServerAgreement, []byte{1}))
// Notify other clients on the server that the new user has logged in. For 1.5+ clients we don't have this
// information yet, so we do it in TranAgreed instead
- for _, t := range c.notifyOthers(
+ for _, t := range c.NotifyOthers(
NewTransaction(
TranNotifyChangeUser, [2]byte{0, 0},
NewField(FieldUserName, c.UserName),
}
}
- c.Server.mux.Lock()
- c.Server.Stats.ConnectionCounter += 1
- if len(s.Clients) > c.Server.Stats.ConnectionPeak {
- c.Server.Stats.ConnectionPeak = len(s.Clients)
+ c.Server.Stats.Increment(StatConnectionCounter, StatCurrentlyConnected)
+ defer c.Server.Stats.Decrement(StatCurrentlyConnected)
+
+ if len(s.ClientMgr.List()) > c.Server.Stats.Get(StatConnectionPeak) {
+ c.Server.Stats.Set(StatConnectionPeak, len(s.ClientMgr.List()))
}
- c.Server.mux.Unlock()
// Scan for new transactions and handle them as they come in.
for scanner.Scan() {
return nil
}
-func (s *Server) NewPrivateChat(cc *ClientConn) [4]byte {
- s.PrivateChatsMu.Lock()
- defer s.PrivateChatsMu.Unlock()
-
- var randID [4]byte
- _, _ = rand.Read(randID[:])
-
- s.PrivateChats[randID] = &PrivateChat{
- ClientConn: make(map[[2]byte]*ClientConn),
- }
- s.PrivateChats[randID].ClientConn[cc.ID] = cc
-
- return randID
-}
-
-const dlFldrActionSendFile = 1
-const dlFldrActionResumeFile = 2
-const dlFldrActionNextFile = 3
-
// handleFileTransfer receives a client net.Conn from the file transfer server, performs the requested transfer type, then closes the connection
func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) error {
defer dontPanic(s.Logger)
return fmt.Errorf("error reading file transfer: %w", err)
}
+ fileTransfer := s.FileTransferMgr.Get(t.ReferenceNumber)
+ if fileTransfer == nil {
+ return errors.New("invalid transaction ID")
+ }
+
defer func() {
- s.mux.Lock()
- delete(s.fileTransfers, t.ReferenceNumber)
- s.mux.Unlock()
+ s.FileTransferMgr.Delete(t.ReferenceNumber)
// Wait a few seconds before closing the connection: this is a workaround for problems
// observed with Windows clients where the client must initiate close of the TCP connection before
time.Sleep(3 * time.Second)
}()
- s.mux.Lock()
- fileTransfer, ok := s.fileTransfers[t.ReferenceNumber]
- s.mux.Unlock()
- if !ok {
- return errors.New("invalid transaction ID")
- }
-
- defer func() {
- fileTransfer.ClientConn.transfersMU.Lock()
- delete(fileTransfer.ClientConn.transfers[fileTransfer.Type], t.ReferenceNumber)
- fileTransfer.ClientConn.transfersMU.Unlock()
- }()
-
rLogger := s.Logger.With(
"remoteAddr", ctx.Value(contextKeyReq).(requestCtx).remoteAddr,
"login", fileTransfer.ClientConn.Account.Login,
}
switch fileTransfer.Type {
- case bannerDownload:
+ case BannerDownload:
if _, err := io.Copy(rwc, bytes.NewBuffer(s.banner)); err != nil {
return fmt.Errorf("error sending banner: %w", err)
}
case FileDownload:
- s.Stats.DownloadCounter += 1
- s.Stats.DownloadsInProgress += 1
+ s.Stats.Increment(StatDownloadCounter, StatDownloadsInProgress)
defer func() {
- s.Stats.DownloadsInProgress -= 1
+ s.Stats.Decrement(StatDownloadsInProgress)
}()
err = DownloadHandler(rwc, fullPath, fileTransfer, s.FS, rLogger, true)
if err != nil {
- return fmt.Errorf("file download error: %w", err)
+ return fmt.Errorf("file download: %w", err)
}
case FileUpload:
- s.Stats.UploadCounter += 1
- s.Stats.UploadsInProgress += 1
- defer func() { s.Stats.UploadsInProgress -= 1 }()
+ s.Stats.Increment(StatUploadCounter, StatUploadsInProgress)
+ defer func() {
+ s.Stats.Decrement(StatUploadsInProgress)
+ }()
err = UploadHandler(rwc, fullPath, fileTransfer, s.FS, rLogger, s.Config.PreserveResourceForks)
if err != nil {
}
case FolderDownload:
- s.Stats.DownloadCounter += 1
- s.Stats.DownloadsInProgress += 1
- defer func() { s.Stats.DownloadsInProgress -= 1 }()
+ s.Stats.Increment(StatDownloadCounter, StatDownloadsInProgress)
+ defer func() {
+ s.Stats.Decrement(StatDownloadsInProgress)
+ }()
err = DownloadFolderHandler(rwc, fullPath, fileTransfer, s.FS, rLogger, s.Config.PreserveResourceForks)
if err != nil {
}
case FolderUpload:
- s.Stats.UploadCounter += 1
- s.Stats.UploadsInProgress += 1
- defer func() { s.Stats.UploadsInProgress -= 1 }()
+ s.Stats.Increment(StatUploadCounter, StatUploadsInProgress)
+ defer func() {
+ s.Stats.Decrement(StatUploadsInProgress)
+ }()
+
rLogger.Info(
"Folder upload started",
"dstPath", fullPath,
git.r.bdr.sh / rbdr / mobius / blobdiff