Add support for bouncer logs
Add bouncer logs, in a network/channel/date.log format, in a similar manner to ZNC log module. PRIVMSG, JOIN, PART, QUIT, MODE are logged. Add a config directive for the logs file, including a way to disable them entirely.
This commit is contained in:
parent
10ea698022
commit
0607b940e2
@ -61,6 +61,7 @@ func main() {
|
|||||||
srv := soju.NewServer(db)
|
srv := soju.NewServer(db)
|
||||||
// TODO: load from config/DB
|
// TODO: load from config/DB
|
||||||
srv.Hostname = cfg.Hostname
|
srv.Hostname = cfg.Hostname
|
||||||
|
srv.LogPath = cfg.LogPath
|
||||||
srv.Debug = debug
|
srv.Debug = debug
|
||||||
|
|
||||||
log.Printf("server listening on %q", cfg.Addr)
|
log.Printf("server listening on %q", cfg.Addr)
|
||||||
|
@ -19,6 +19,7 @@ type Server struct {
|
|||||||
TLS *TLS
|
TLS *TLS
|
||||||
SQLDriver string
|
SQLDriver string
|
||||||
SQLSource string
|
SQLSource string
|
||||||
|
LogPath string
|
||||||
}
|
}
|
||||||
|
|
||||||
func Defaults() *Server {
|
func Defaults() *Server {
|
||||||
@ -72,6 +73,10 @@ func Parse(r io.Reader) (*Server, error) {
|
|||||||
if err := d.parseParams(&srv.SQLDriver, &srv.SQLSource); err != nil {
|
if err := d.parseParams(&srv.SQLDriver, &srv.SQLSource); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
case "log":
|
||||||
|
if err := d.parseParams(&srv.LogPath); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
default:
|
default:
|
||||||
return nil, fmt.Errorf("unknown directive %q", d.Name)
|
return nil, fmt.Errorf("unknown directive %q", d.Name)
|
||||||
}
|
}
|
||||||
|
@ -69,6 +69,9 @@ The config file has one directive per line.
|
|||||||
Set the SQL driver settings. The only supported driver is "sqlite". The
|
Set the SQL driver settings. The only supported driver is "sqlite". The
|
||||||
source is the path to the SQLite database file.
|
source is the path to the SQLite database file.
|
||||||
|
|
||||||
|
*log* <path>
|
||||||
|
Path to the bouncer logs root directory, or empty to disable logging.
|
||||||
|
|
||||||
# IRC SERVICE
|
# IRC SERVICE
|
||||||
|
|
||||||
soju exposes an IRC service called *BouncerServ* to manage the bouncer.
|
soju exposes an IRC service called *BouncerServ* to manage the bouncer.
|
||||||
|
@ -51,6 +51,7 @@ type Server struct {
|
|||||||
Hostname string
|
Hostname string
|
||||||
Logger Logger
|
Logger Logger
|
||||||
RingCap int
|
RingCap int
|
||||||
|
LogPath string
|
||||||
Debug bool
|
Debug bool
|
||||||
|
|
||||||
db *DB
|
db *DB
|
||||||
|
101
upstream.go
101
upstream.go
@ -7,6 +7,8 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"net"
|
"net"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
@ -63,6 +65,13 @@ type upstreamConn struct {
|
|||||||
// set of LIST commands in progress, per downstream
|
// set of LIST commands in progress, per downstream
|
||||||
// access is synchronized with user.pendingLISTsLock
|
// access is synchronized with user.pendingLISTsLock
|
||||||
pendingLISTDownstreamSet map[uint64]struct{}
|
pendingLISTDownstreamSet map[uint64]struct{}
|
||||||
|
|
||||||
|
logs map[string]entityLog
|
||||||
|
}
|
||||||
|
|
||||||
|
type entityLog struct {
|
||||||
|
name string
|
||||||
|
file *os.File
|
||||||
}
|
}
|
||||||
|
|
||||||
func connectToUpstream(network *network) (*upstreamConn, error) {
|
func connectToUpstream(network *network) (*upstreamConn, error) {
|
||||||
@ -97,6 +106,7 @@ func connectToUpstream(network *network) (*upstreamConn, error) {
|
|||||||
availableChannelModes: stdChannelModes,
|
availableChannelModes: stdChannelModes,
|
||||||
availableMemberships: stdMemberships,
|
availableMemberships: stdMemberships,
|
||||||
pendingLISTDownstreamSet: make(map[uint64]struct{}),
|
pendingLISTDownstreamSet: make(map[uint64]struct{}),
|
||||||
|
logs: make(map[string]entityLog),
|
||||||
}
|
}
|
||||||
|
|
||||||
go func() {
|
go func() {
|
||||||
@ -141,7 +151,9 @@ func (uc *upstreamConn) Close() error {
|
|||||||
return fmt.Errorf("upstream connection already closed")
|
return fmt.Errorf("upstream connection already closed")
|
||||||
}
|
}
|
||||||
close(uc.closed)
|
close(uc.closed)
|
||||||
|
for _, log := range uc.logs {
|
||||||
|
log.file.Close()
|
||||||
|
}
|
||||||
uc.endPendingLists(true)
|
uc.endPendingLists(true)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@ -313,6 +325,12 @@ func (uc *upstreamConn) handleMessage(msg *irc.Message) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
target := nick
|
||||||
|
if nick == uc.nick {
|
||||||
|
target = msg.Prefix.Name
|
||||||
|
}
|
||||||
|
uc.AppendLog(target, "<%s> %s", msg.Prefix.Name, text)
|
||||||
|
|
||||||
uc.forEachDownstream(func(dc *downstreamConn) {
|
uc.forEachDownstream(func(dc *downstreamConn) {
|
||||||
dc.SendMessage(&irc.Message{
|
dc.SendMessage(&irc.Message{
|
||||||
Prefix: dc.marshalUserPrefix(uc, msg.Prefix),
|
Prefix: dc.marshalUserPrefix(uc, msg.Prefix),
|
||||||
@ -616,6 +634,7 @@ func (uc *upstreamConn) handleMessage(msg *irc.Message) error {
|
|||||||
if membership, ok := ch.Members[msg.Prefix.Name]; ok {
|
if membership, ok := ch.Members[msg.Prefix.Name]; ok {
|
||||||
delete(ch.Members, msg.Prefix.Name)
|
delete(ch.Members, msg.Prefix.Name)
|
||||||
ch.Members[newNick] = membership
|
ch.Members[newNick] = membership
|
||||||
|
uc.AppendLog(ch.Name, "*** %s is now known as %s", msg.Prefix.Name, newNick)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -659,6 +678,8 @@ func (uc *upstreamConn) handleMessage(msg *irc.Message) error {
|
|||||||
ch.Members[msg.Prefix.Name] = nil
|
ch.Members[msg.Prefix.Name] = nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
uc.AppendLog(ch, "*** Joins: %s (%s@%s)", msg.Prefix.Name, msg.Prefix.User, msg.Prefix.Host)
|
||||||
|
|
||||||
uc.forEachDownstream(func(dc *downstreamConn) {
|
uc.forEachDownstream(func(dc *downstreamConn) {
|
||||||
dc.SendMessage(&irc.Message{
|
dc.SendMessage(&irc.Message{
|
||||||
Prefix: dc.marshalUserPrefix(uc, msg.Prefix),
|
Prefix: dc.marshalUserPrefix(uc, msg.Prefix),
|
||||||
@ -677,6 +698,11 @@ func (uc *upstreamConn) handleMessage(msg *irc.Message) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var reason string
|
||||||
|
if len(msg.Params) > 1 {
|
||||||
|
reason = msg.Params[1]
|
||||||
|
}
|
||||||
|
|
||||||
for _, ch := range strings.Split(channels, ",") {
|
for _, ch := range strings.Split(channels, ",") {
|
||||||
if msg.Prefix.Name == uc.nick {
|
if msg.Prefix.Name == uc.nick {
|
||||||
uc.logger.Printf("parted channel %q", ch)
|
uc.logger.Printf("parted channel %q", ch)
|
||||||
@ -689,6 +715,8 @@ func (uc *upstreamConn) handleMessage(msg *irc.Message) error {
|
|||||||
delete(ch.Members, msg.Prefix.Name)
|
delete(ch.Members, msg.Prefix.Name)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
uc.AppendLog(ch, "*** Parts: %s (%s@%s) (%s)", msg.Prefix.Name, msg.Prefix.User, msg.Prefix.Host, reason)
|
||||||
|
|
||||||
uc.forEachDownstream(func(dc *downstreamConn) {
|
uc.forEachDownstream(func(dc *downstreamConn) {
|
||||||
dc.SendMessage(&irc.Message{
|
dc.SendMessage(&irc.Message{
|
||||||
Prefix: dc.marshalUserPrefix(uc, msg.Prefix),
|
Prefix: dc.marshalUserPrefix(uc, msg.Prefix),
|
||||||
@ -723,6 +751,8 @@ func (uc *upstreamConn) handleMessage(msg *irc.Message) error {
|
|||||||
delete(ch.Members, user)
|
delete(ch.Members, user)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
uc.AppendLog(channel, "*** %s was kicked by %s (%s)", user, msg.Prefix.Name, reason)
|
||||||
|
|
||||||
uc.forEachDownstream(func(dc *downstreamConn) {
|
uc.forEachDownstream(func(dc *downstreamConn) {
|
||||||
params := []string{dc.marshalChannel(uc, channel), dc.marshalNick(uc, user)}
|
params := []string{dc.marshalChannel(uc, channel), dc.marshalNick(uc, user)}
|
||||||
if reason != "" {
|
if reason != "" {
|
||||||
@ -739,12 +769,21 @@ func (uc *upstreamConn) handleMessage(msg *irc.Message) error {
|
|||||||
return fmt.Errorf("expected a prefix")
|
return fmt.Errorf("expected a prefix")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var reason string
|
||||||
|
if len(msg.Params) > 0 {
|
||||||
|
reason = msg.Params[0]
|
||||||
|
}
|
||||||
|
|
||||||
if msg.Prefix.Name == uc.nick {
|
if msg.Prefix.Name == uc.nick {
|
||||||
uc.logger.Printf("quit")
|
uc.logger.Printf("quit")
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, ch := range uc.channels {
|
for _, ch := range uc.channels {
|
||||||
|
if _, ok := ch.Members[msg.Prefix.Name]; ok {
|
||||||
delete(ch.Members, msg.Prefix.Name)
|
delete(ch.Members, msg.Prefix.Name)
|
||||||
|
|
||||||
|
uc.AppendLog(ch.Name, "*** Quits: %s (%s@%s) (%s)", msg.Prefix.Name, msg.Prefix.User, msg.Prefix.Host, reason)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if msg.Prefix.Name != uc.nick {
|
if msg.Prefix.Name != uc.nick {
|
||||||
@ -819,6 +858,12 @@ func (uc *upstreamConn) handleMessage(msg *irc.Message) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
modeMsg := modeStr
|
||||||
|
for _, v := range msg.Params[2:] {
|
||||||
|
modeMsg += " " + v
|
||||||
|
}
|
||||||
|
uc.AppendLog(ch.Name, "*** %s sets mode: %s", msg.Prefix.Name, modeMsg)
|
||||||
|
|
||||||
uc.forEachDownstream(func(dc *downstreamConn) {
|
uc.forEachDownstream(func(dc *downstreamConn) {
|
||||||
params := []string{dc.marshalChannel(uc, name), modeStr}
|
params := []string{dc.marshalChannel(uc, name), modeStr}
|
||||||
params = append(params, msg.Params[2:]...)
|
params = append(params, msg.Params[2:]...)
|
||||||
@ -1152,8 +1197,8 @@ func (uc *upstreamConn) handleMessage(msg *irc.Message) error {
|
|||||||
return fmt.Errorf("expected a prefix")
|
return fmt.Errorf("expected a prefix")
|
||||||
}
|
}
|
||||||
|
|
||||||
var nick string
|
var nick, text string
|
||||||
if err := parseMessageParams(msg, &nick, nil); err != nil {
|
if err := parseMessageParams(msg, &nick, &text); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -1166,6 +1211,12 @@ func (uc *upstreamConn) handleMessage(msg *irc.Message) error {
|
|||||||
break
|
break
|
||||||
}
|
}
|
||||||
|
|
||||||
|
target := nick
|
||||||
|
if nick == uc.nick {
|
||||||
|
target = msg.Prefix.Name
|
||||||
|
}
|
||||||
|
uc.AppendLog(target, "<%s> %s", msg.Prefix.Name, text)
|
||||||
|
|
||||||
uc.network.ring.Produce(msg)
|
uc.network.ring.Produce(msg)
|
||||||
case "INVITE":
|
case "INVITE":
|
||||||
var nick string
|
var nick string
|
||||||
@ -1363,3 +1414,47 @@ func (uc *upstreamConn) SendMessageLabeled(downstreamID uint64, msg *irc.Message
|
|||||||
}
|
}
|
||||||
uc.SendMessage(msg)
|
uc.SendMessage(msg)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TODO: handle moving logs when a network name changes, when support for this is added
|
||||||
|
func (uc *upstreamConn) AppendLog(entity string, format string, a ...interface{}) {
|
||||||
|
if uc.srv.LogPath == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// TODO: enforce maximum open file handles (LRU cache of file handles)
|
||||||
|
// TODO: handle non-monotonic clock behaviour
|
||||||
|
now := time.Now()
|
||||||
|
year, month, day := now.Date()
|
||||||
|
name := fmt.Sprintf("%04d-%02d-%02d.log", year, month, day)
|
||||||
|
log, ok := uc.logs[entity]
|
||||||
|
if !ok || log.name != name {
|
||||||
|
if ok {
|
||||||
|
log.file.Close()
|
||||||
|
delete(uc.logs, entity)
|
||||||
|
}
|
||||||
|
// TODO: handle/forbid network/entity names with illegal path characters
|
||||||
|
dir := filepath.Join(uc.srv.LogPath, uc.user.Username, uc.network.Name, entity)
|
||||||
|
if err := os.MkdirAll(dir, 0600); err != nil {
|
||||||
|
uc.logger.Printf("failed to log message: could not create logs directory %q: %v", dir, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
path := filepath.Join(dir, name)
|
||||||
|
f, err := os.OpenFile(path, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0600)
|
||||||
|
if err != nil {
|
||||||
|
uc.logger.Printf("failed to log message: could not open or create log file %q: %v", path, err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
log = entityLog{
|
||||||
|
name: name,
|
||||||
|
file: f,
|
||||||
|
}
|
||||||
|
uc.logs[entity] = log
|
||||||
|
}
|
||||||
|
|
||||||
|
format = "[%02d:%02d:%02d] " + format + "\n"
|
||||||
|
args := []interface{}{now.Hour(), now.Minute(), now.Second()}
|
||||||
|
args = append(args, a...)
|
||||||
|
|
||||||
|
if _, err := fmt.Fprintf(log.file, format, args...); err != nil {
|
||||||
|
uc.logger.Printf("failed to log message to %q: %v", log.name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user