Changeset 636 in code

Timestamp:

Oct 13, 2021, 8:58:34 AM (4 years ago)

Author:

contact

Message:

Add bouncer MOTD

Closes: ​https://todo.sr.ht/~emersion/soju/137

Location:

trunk

Files:

• cmd/soju/main.go (modified) (5 diffs)
• config/config.go (modified) (2 diffs)
• doc/soju.1.scd (modified) (2 diffs)
• downstream.go (modified) (2 diffs)
• irc.go (modified) (1 diff)
• server.go (modified) (3 diffs)

trunk/cmd/soju/main.go

@@ -6 +6 @@
         "flag"
         "fmt"
+        "io/ioutil"
         "log"
         "net"
@@ -37 +38 @@
 }
 
+func loadMOTD(srv *soju.Server, filename string) error {
+        if filename == "" {
+                return nil
+        }
+
+        b, err := ioutil.ReadFile(filename)
+        if err != nil {
+                return err
+        }
+        srv.SetMOTD(strings.TrimSpace(string(b)))
+        return nil
+}
+
 func main() {
         var listen []string
@@ -92 +106 @@
         srv.Debug = debug
 
+        if err := loadMOTD(srv, cfg.MOTDPath); err != nil {
+                log.Fatalf("failed to load MOTD: %v", err)
+        }
+
         for _, listen := range cfg.Listen {
                 listenURI := listen
@@ -225 +243 @@
                 switch sig {
                 case syscall.SIGHUP:
+                        log.Print("reloading TLS certificate and MOTD")
                         if cfg.TLS != nil {
-                                log.Print("reloading TLS certificate")
                                 cert, err := tls.LoadX509KeyPair(cfg.TLS.CertPath, cfg.TLS.KeyPath)
                                 if err != nil {
@@ -233 +251 @@
                                 }
                                 tlsCert.Store(&cert)
+                        }
+                        if err := loadMOTD(srv, cfg.MOTDPath); err != nil {
+                                log.Printf("failed to reload MOTD: %v", err)
                         }
                 case syscall.SIGINT, syscall.SIGTERM:

trunk/config/config.go

@@ -41 +41 @@
         Hostname string
         TLS      *TLS
+        MOTDPath string
 
         SQLDriver string
@@ -129 +130 @@
                                 return nil, fmt.Errorf("directive %q: %v", d.Name, err)
                         }
+                case "motd":
+                        if err := d.ParseParams(&srv.MOTDPath); err != nil {
+                                return nil, err
+                        }
                 default:
                         return nil, fmt.Errorf("unknown directive %q", d.Name)

trunk/doc/soju.1.scd

@@ -45 +45 @@
 be done by adding a "@<client>" suffix to the username.
 
-soju will reload the TLS certificate and key when it receives the HUP signal.
+soju will reload the TLS certificate/key and the MOTD file when it receives the
+HUP signal.
 
 Administrators can broadcast a message to all bouncer users via _/notice
@@ -143 +144 @@
         Maximum number of networks per user. By default, there is no limit.
 
+*motd* <path>
+        Path to the MOTD file. The bouncer MOTD is sent to clients which aren't
+        bound to a specific network. By default, no MOTD is sent.
+
 # IRC SERVICE
 

trunk/downstream.go

@@ -1120 +1120 @@
                 dc.SendMessage(msg)
         }
-        motdHint := "No MOTD"
         if uc := dc.upstream(); uc != nil {
-                motdHint = "Use /motd to read the message of the day"
                 dc.SendMessage(&irc.Message{
                         Prefix:  dc.srv.prefix(),
@@ -1129 +1127 @@
                 })
         }
-        dc.SendMessage(&irc.Message{
-                Prefix:  dc.srv.prefix(),
-                Command: irc.ERR_NOMOTD,
-                Params:  []string{dc.nick, motdHint},
-        })
+
+        if motd := dc.user.srv.MOTD(); motd != "" && dc.network == nil {
+                for _, msg := range generateMOTD(dc.srv.prefix(), dc.nick, motd) {
+                        dc.SendMessage(msg)
+                }
+        } else {
+                motdHint := "No MOTD"
+                if dc.network != nil {
+                        motdHint = "Use /motd to read the message of the day"
+                }
+                dc.SendMessage(&irc.Message{
+                        Prefix:  dc.srv.prefix(),
+                        Command: irc.ERR_NOMOTD,
+                        Params:  []string{dc.nick, motdHint},
+                })
+        }
 
         dc.updateNick()

trunk/irc.go

@@ -380 +380 @@
 }
 
+func generateMOTD(prefix *irc.Prefix, nick string, motd string) []*irc.Message {
+        var msgs []*irc.Message
+        msgs = append(msgs, &irc.Message{
+                Prefix:  prefix,
+                Command: irc.RPL_MOTDSTART,
+                Params:  []string{nick, fmt.Sprintf("- Message of the Day -")},
+        })
+
+        for _, l := range strings.Split(motd, "\n") {
+                msgs = append(msgs, &irc.Message{
+                        Prefix:  prefix,
+                        Command: irc.RPL_MOTD,
+                        Params:  []string{nick, l},
+                })
+        }
+
+        msgs = append(msgs, &irc.Message{
+                Prefix:  prefix,
+                Command: irc.RPL_ENDOFMOTD,
+                Params:  []string{nick, "End of /MOTD command."},
+        })
+
+        return msgs
+}
+
 type joinSorter struct {
         channels []string

trunk/server.go

@@ -64 +64 @@
         listeners map[net.Listener]struct{}
         users     map[string]*user
+
+        motd atomic.Value // string
 }
 
 func NewServer(db Database) *Server {
-        return &Server{
+        srv := &Server{
                 Logger:          log.New(log.Writer(), "", log.LstdFlags),
                 HistoryLimit:    1000,
@@ -75 +77 @@
                 users:           make(map[string]*user),
         }
+        srv.motd.Store("")
+        return srv
 }
 
@@ -269 +273 @@
         return &stats
 }
+
+func (s *Server) SetMOTD(motd string) {
+        s.motd.Store(motd)
+}
+
+func (s *Server) MOTD() string {
+        return s.motd.Load().(string)
+}