source: code/trunk/logger.go@ 215

Last change on this file since 215 was 215, checked in by contact, 5 years ago

Introduce messageLogger

This centralizes formatting related to message logging in a single
place.

File size: 2.8 KB
Line 
1package soju
2
3import (
4 "fmt"
5 "os"
6 "path/filepath"
7 "strings"
8 "time"
9
10 "gopkg.in/irc.v3"
11)
12
13type messageLogger struct {
14 conn *upstreamConn
15 entity string
16
17 filename string
18 file *os.File
19}
20
21func newMessageLogger(uc *upstreamConn, entity string) *messageLogger {
22 return &messageLogger{
23 conn: uc,
24 entity: entity,
25 }
26}
27
28func (ml *messageLogger) Append(msg *irc.Message) error {
29 s := formatMessage(msg)
30 if s == "" {
31 return nil
32 }
33
34 // TODO: enforce maximum open file handles (LRU cache of file handles)
35 // TODO: handle non-monotonic clock behaviour
36 now := time.Now()
37 year, month, day := now.Date()
38 filename := fmt.Sprintf("%04d-%02d-%02d.log", year, month, day)
39 if ml.filename != filename {
40 if ml.file != nil {
41 ml.file.Close()
42 }
43
44 // TODO: handle/forbid network/entity names with illegal path characters
45 dir := filepath.Join(ml.conn.srv.LogPath, ml.conn.user.Username, ml.conn.network.Name, ml.entity)
46 if err := os.MkdirAll(dir, 0700); err != nil {
47 return fmt.Errorf("failed to create logs directory %q: %v", dir, err)
48 }
49
50 path := filepath.Join(dir, filename)
51 f, err := os.OpenFile(path, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0600)
52 if err != nil {
53 return fmt.Errorf("failed to open log file %q: %v", path, err)
54 }
55
56 ml.filename = filename
57 ml.file = f
58 }
59
60 _, err := fmt.Fprintf(ml.file, "[%02d:%02d:%02d] %s\n", now.Hour(), now.Minute(), now.Second(), s)
61 if err != nil {
62 return fmt.Errorf("failed to log message to %q: %v", ml.filename, err)
63 }
64 return nil
65}
66
67func (ml *messageLogger) Close() error {
68 if ml.file == nil {
69 return nil
70 }
71 return ml.file.Close()
72}
73
74// formatMessage formats a message log line. It assumes a well-formed IRC
75// message.
76func formatMessage(msg *irc.Message) string {
77 switch strings.ToUpper(msg.Command) {
78 case "NICK":
79 return fmt.Sprintf("*** %s is now known as %s", msg.Prefix.Name, msg.Params[0])
80 case "JOIN":
81 return fmt.Sprintf("*** Joins: %s (%s@%s)", msg.Prefix.Name, msg.Prefix.User, msg.Prefix.Host)
82 case "PART":
83 var reason string
84 if len(msg.Params) > 1 {
85 reason = msg.Params[1]
86 }
87 return fmt.Sprintf("*** Parts: %s (%s@%s) (%s)", msg.Prefix.Name, msg.Prefix.User, msg.Prefix.Host, reason)
88 case "KICK":
89 nick := msg.Params[1]
90 var reason string
91 if len(msg.Params) > 2 {
92 reason = msg.Params[2]
93 }
94 return fmt.Sprintf("*** %s was kicked by %s (%s)", nick, msg.Prefix.Name, reason)
95 case "QUIT":
96 var reason string
97 if len(msg.Params) > 0 {
98 reason = msg.Params[0]
99 }
100 return fmt.Sprintf("*** Quits: %s (%s@%s) (%s)", msg.Prefix.Name, msg.Prefix.User, msg.Prefix.Host, reason)
101 case "MODE":
102 return fmt.Sprintf("*** %s sets mode: %s", msg.Prefix.Name, strings.Join(msg.Params[1:], " "))
103 case "PRIVMSG", "NOTICE":
104 return fmt.Sprintf("<%s> %s", msg.Prefix.Name, msg.Params[1])
105 default:
106 return ""
107 }
108}
Note: See TracBrowser for help on using the repository browser.