b6f15c3e3c
This loads latest messages from logs up to a given message ID. This is
similar to the IRCv3 CHATHISTORY LATEST command [1].
[1]: 0c271a5f1d/extensions/chathistory.md (latest)
415 lines
11 KiB
Go
415 lines
11 KiB
Go
package soju
|
|
|
|
import (
|
|
"bufio"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"time"
|
|
|
|
"gopkg.in/irc.v3"
|
|
)
|
|
|
|
const messageLoggerMaxTries = 100
|
|
|
|
type messageLogger struct {
|
|
network *network
|
|
entity string
|
|
|
|
path string
|
|
file *os.File
|
|
}
|
|
|
|
func newMessageLogger(network *network, entity string) *messageLogger {
|
|
return &messageLogger{
|
|
network: network,
|
|
entity: entity,
|
|
}
|
|
}
|
|
|
|
var escapeFilename = strings.NewReplacer("/", "-", "\\", "-")
|
|
|
|
func logPath(network *network, entity string, t time.Time) string {
|
|
user := network.user
|
|
srv := user.srv
|
|
|
|
year, month, day := t.Date()
|
|
filename := fmt.Sprintf("%04d-%02d-%02d.log", year, month, day)
|
|
return filepath.Join(srv.LogPath, escapeFilename.Replace(user.Username), escapeFilename.Replace(network.GetName()), escapeFilename.Replace(entity), filename)
|
|
}
|
|
|
|
func parseMsgID(s string) (network, entity string, t time.Time, offset int64, err error) {
|
|
var year, month, day int
|
|
_, err = fmt.Sscanf(s, "%s %s %04d-%02d-%02d %d", &network, &entity, &year, &month, &day, &offset)
|
|
if err != nil {
|
|
return "", "", time.Time{}, 0, fmt.Errorf("invalid message ID: %v", err)
|
|
}
|
|
t = time.Date(year, time.Month(month), day, 0, 0, 0, 0, time.Local)
|
|
return network, entity, t, offset, nil
|
|
}
|
|
|
|
func formatMsgID(network, entity string, t time.Time, offset int64) string {
|
|
year, month, day := t.Date()
|
|
return fmt.Sprintf("%s %s %04d-%02d-%02d %d", network, entity, year, month, day, offset)
|
|
}
|
|
|
|
// nextMsgID queries the message ID for the next message to be written to f.
|
|
func nextMsgID(network *network, entity string, t time.Time, f *os.File) (string, error) {
|
|
offset, err := f.Seek(0, io.SeekEnd)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
return formatMsgID(network.GetName(), entity, t, offset), nil
|
|
}
|
|
|
|
// lastMsgID queries the last message ID for the given network, entity and
|
|
// date. The message ID returned may not refer to a valid message, but can be
|
|
// used in history queries.
|
|
func lastMsgID(network *network, entity string, t time.Time) (string, error) {
|
|
p := logPath(network, entity, t)
|
|
fi, err := os.Stat(p)
|
|
if os.IsNotExist(err) {
|
|
return formatMsgID(network.GetName(), entity, t, -1), nil
|
|
} else if err != nil {
|
|
return "", err
|
|
}
|
|
return formatMsgID(network.GetName(), entity, t, fi.Size()-1), nil
|
|
}
|
|
|
|
func (ml *messageLogger) Append(msg *irc.Message) (string, error) {
|
|
s := formatMessage(msg)
|
|
if s == "" {
|
|
return "", nil
|
|
}
|
|
|
|
var t time.Time
|
|
if tag, ok := msg.Tags["time"]; ok {
|
|
var err error
|
|
t, err = time.Parse(serverTimeLayout, string(tag))
|
|
if err != nil {
|
|
return "", fmt.Errorf("failed to parse message time tag: %v", err)
|
|
}
|
|
t = t.In(time.Local)
|
|
} else {
|
|
t = time.Now()
|
|
}
|
|
|
|
// TODO: enforce maximum open file handles (LRU cache of file handles)
|
|
// TODO: handle non-monotonic clock behaviour
|
|
path := logPath(ml.network, ml.entity, t)
|
|
if ml.path != path {
|
|
if ml.file != nil {
|
|
ml.file.Close()
|
|
}
|
|
|
|
dir := filepath.Dir(path)
|
|
if err := os.MkdirAll(dir, 0700); err != nil {
|
|
return "", fmt.Errorf("failed to create logs directory %q: %v", dir, err)
|
|
}
|
|
|
|
f, err := os.OpenFile(path, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0600)
|
|
if err != nil {
|
|
return "", fmt.Errorf("failed to open log file %q: %v", path, err)
|
|
}
|
|
|
|
ml.path = path
|
|
ml.file = f
|
|
}
|
|
|
|
msgID, err := nextMsgID(ml.network, ml.entity, t, ml.file)
|
|
if err != nil {
|
|
return "", fmt.Errorf("failed to generate message ID: %v", err)
|
|
}
|
|
|
|
_, err = fmt.Fprintf(ml.file, "[%02d:%02d:%02d] %s\n", t.Hour(), t.Minute(), t.Second(), s)
|
|
if err != nil {
|
|
return "", fmt.Errorf("failed to log message to %q: %v", ml.path, err)
|
|
}
|
|
return msgID, nil
|
|
}
|
|
|
|
func (ml *messageLogger) Close() error {
|
|
if ml.file == nil {
|
|
return nil
|
|
}
|
|
return ml.file.Close()
|
|
}
|
|
|
|
// formatMessage formats a message log line. It assumes a well-formed IRC
|
|
// message.
|
|
func formatMessage(msg *irc.Message) string {
|
|
switch strings.ToUpper(msg.Command) {
|
|
case "NICK":
|
|
return fmt.Sprintf("*** %s is now known as %s", msg.Prefix.Name, msg.Params[0])
|
|
case "JOIN":
|
|
return fmt.Sprintf("*** Joins: %s (%s@%s)", msg.Prefix.Name, msg.Prefix.User, msg.Prefix.Host)
|
|
case "PART":
|
|
var reason string
|
|
if len(msg.Params) > 1 {
|
|
reason = msg.Params[1]
|
|
}
|
|
return fmt.Sprintf("*** Parts: %s (%s@%s) (%s)", msg.Prefix.Name, msg.Prefix.User, msg.Prefix.Host, reason)
|
|
case "KICK":
|
|
nick := msg.Params[1]
|
|
var reason string
|
|
if len(msg.Params) > 2 {
|
|
reason = msg.Params[2]
|
|
}
|
|
return fmt.Sprintf("*** %s was kicked by %s (%s)", nick, msg.Prefix.Name, reason)
|
|
case "QUIT":
|
|
var reason string
|
|
if len(msg.Params) > 0 {
|
|
reason = msg.Params[0]
|
|
}
|
|
return fmt.Sprintf("*** Quits: %s (%s@%s) (%s)", msg.Prefix.Name, msg.Prefix.User, msg.Prefix.Host, reason)
|
|
case "TOPIC":
|
|
var topic string
|
|
if len(msg.Params) > 1 {
|
|
topic = msg.Params[1]
|
|
}
|
|
return fmt.Sprintf("*** %s changes topic to '%s'", msg.Prefix.Name, topic)
|
|
case "MODE":
|
|
return fmt.Sprintf("*** %s sets mode: %s", msg.Prefix.Name, strings.Join(msg.Params[1:], " "))
|
|
case "NOTICE":
|
|
return fmt.Sprintf("-%s- %s", msg.Prefix.Name, msg.Params[1])
|
|
case "PRIVMSG":
|
|
if cmd, params, ok := parseCTCPMessage(msg); ok && cmd == "ACTION" {
|
|
return fmt.Sprintf("* %s %s", msg.Prefix.Name, params)
|
|
} else {
|
|
return fmt.Sprintf("<%s> %s", msg.Prefix.Name, msg.Params[1])
|
|
}
|
|
default:
|
|
return ""
|
|
}
|
|
}
|
|
|
|
func parseMessage(line, entity string, ref time.Time) (*irc.Message, time.Time, error) {
|
|
var hour, minute, second int
|
|
_, err := fmt.Sscanf(line, "[%02d:%02d:%02d] ", &hour, &minute, &second)
|
|
if err != nil {
|
|
return nil, time.Time{}, err
|
|
}
|
|
line = line[11:]
|
|
|
|
var cmd, sender, text string
|
|
if strings.HasPrefix(line, "<") {
|
|
cmd = "PRIVMSG"
|
|
parts := strings.SplitN(line[1:], "> ", 2)
|
|
if len(parts) != 2 {
|
|
return nil, time.Time{}, nil
|
|
}
|
|
sender, text = parts[0], parts[1]
|
|
} else if strings.HasPrefix(line, "-") {
|
|
cmd = "NOTICE"
|
|
parts := strings.SplitN(line[1:], "- ", 2)
|
|
if len(parts) != 2 {
|
|
return nil, time.Time{}, nil
|
|
}
|
|
sender, text = parts[0], parts[1]
|
|
} else if strings.HasPrefix(line, "* ") {
|
|
cmd = "PRIVMSG"
|
|
parts := strings.SplitN(line[2:], " ", 2)
|
|
if len(parts) != 2 {
|
|
return nil, time.Time{}, nil
|
|
}
|
|
sender, text = parts[0], "\x01ACTION "+parts[1]+"\x01"
|
|
} else {
|
|
return nil, time.Time{}, nil
|
|
}
|
|
|
|
year, month, day := ref.Date()
|
|
t := time.Date(year, month, day, hour, minute, second, 0, time.Local)
|
|
|
|
msg := &irc.Message{
|
|
Tags: map[string]irc.TagValue{
|
|
"time": irc.TagValue(t.UTC().Format(serverTimeLayout)),
|
|
},
|
|
Prefix: &irc.Prefix{Name: sender},
|
|
Command: cmd,
|
|
Params: []string{entity, text},
|
|
}
|
|
return msg, t, nil
|
|
}
|
|
|
|
func parseMessagesBefore(network *network, entity string, ref time.Time, limit int, afterOffset int64) ([]*irc.Message, error) {
|
|
path := logPath(network, entity, ref)
|
|
f, err := os.Open(path)
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return nil, nil
|
|
}
|
|
return nil, err
|
|
}
|
|
defer f.Close()
|
|
|
|
historyRing := make([]*irc.Message, limit)
|
|
cur := 0
|
|
|
|
sc := bufio.NewScanner(f)
|
|
|
|
if afterOffset >= 0 {
|
|
if _, err := f.Seek(afterOffset, io.SeekStart); err != nil {
|
|
return nil, nil
|
|
}
|
|
sc.Scan() // skip till next newline
|
|
}
|
|
|
|
for sc.Scan() {
|
|
msg, t, err := parseMessage(sc.Text(), entity, ref)
|
|
if err != nil {
|
|
return nil, err
|
|
} else if msg == nil {
|
|
continue
|
|
} else if !t.Before(ref) {
|
|
break
|
|
}
|
|
|
|
historyRing[cur%limit] = msg
|
|
cur++
|
|
}
|
|
if sc.Err() != nil {
|
|
return nil, sc.Err()
|
|
}
|
|
|
|
n := limit
|
|
if cur < limit {
|
|
n = cur
|
|
}
|
|
start := (cur - n + limit) % limit
|
|
|
|
if start+n <= limit { // ring doesnt wrap
|
|
return historyRing[start : start+n], nil
|
|
} else { // ring wraps
|
|
history := make([]*irc.Message, n)
|
|
r := copy(history, historyRing[start:])
|
|
copy(history[r:], historyRing[:n-r])
|
|
return history, nil
|
|
}
|
|
}
|
|
|
|
func parseMessagesAfter(network *network, entity string, ref time.Time, limit int) ([]*irc.Message, error) {
|
|
path := logPath(network, entity, ref)
|
|
f, err := os.Open(path)
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return nil, nil
|
|
}
|
|
return nil, err
|
|
}
|
|
defer f.Close()
|
|
|
|
var history []*irc.Message
|
|
sc := bufio.NewScanner(f)
|
|
for sc.Scan() && len(history) < limit {
|
|
msg, t, err := parseMessage(sc.Text(), entity, ref)
|
|
if err != nil {
|
|
return nil, err
|
|
} else if msg == nil || !t.After(ref) {
|
|
continue
|
|
}
|
|
|
|
history = append(history, msg)
|
|
}
|
|
if sc.Err() != nil {
|
|
return nil, sc.Err()
|
|
}
|
|
|
|
return history, nil
|
|
}
|
|
|
|
func loadHistoryBeforeTime(network *network, entity string, t time.Time, limit int) ([]*irc.Message, error) {
|
|
history := make([]*irc.Message, limit)
|
|
remaining := limit
|
|
tries := 0
|
|
for remaining > 0 && tries < messageLoggerMaxTries {
|
|
buf, err := parseMessagesBefore(network, entity, t, remaining, -1)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if len(buf) == 0 {
|
|
tries++
|
|
} else {
|
|
tries = 0
|
|
}
|
|
copy(history[remaining-len(buf):], buf)
|
|
remaining -= len(buf)
|
|
year, month, day := t.Date()
|
|
t = time.Date(year, month, day, 0, 0, 0, 0, t.Location()).Add(-1)
|
|
}
|
|
|
|
return history[remaining:], nil
|
|
}
|
|
|
|
func loadHistoryAfterTime(network *network, entity string, t time.Time, limit int) ([]*irc.Message, error) {
|
|
var history []*irc.Message
|
|
remaining := limit
|
|
tries := 0
|
|
now := time.Now()
|
|
for remaining > 0 && tries < messageLoggerMaxTries && t.Before(now) {
|
|
buf, err := parseMessagesAfter(network, entity, t, remaining)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if len(buf) == 0 {
|
|
tries++
|
|
} else {
|
|
tries = 0
|
|
}
|
|
history = append(history, buf...)
|
|
remaining -= len(buf)
|
|
year, month, day := t.Date()
|
|
t = time.Date(year, month, day+1, 0, 0, 0, 0, t.Location())
|
|
}
|
|
return history, nil
|
|
}
|
|
|
|
func truncateDay(t time.Time) time.Time {
|
|
year, month, day := t.Date()
|
|
return time.Date(year, month, day, 0, 0, 0, 0, t.Location())
|
|
}
|
|
|
|
func loadHistoryLatestID(network *network, entity, id string, limit int) ([]*irc.Message, error) {
|
|
var afterTime time.Time
|
|
var afterOffset int64
|
|
if id != "" {
|
|
var idNet, idEntity string
|
|
var err error
|
|
idNet, idEntity, afterTime, afterOffset, err = parseMsgID(id)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if idNet != network.GetName() || idEntity != entity {
|
|
return nil, fmt.Errorf("cannot find message ID: message ID doesn't match network/entity")
|
|
}
|
|
}
|
|
|
|
history := make([]*irc.Message, limit)
|
|
t := time.Now()
|
|
remaining := limit
|
|
tries := 0
|
|
for remaining > 0 && tries < messageLoggerMaxTries && !truncateDay(t).Before(afterTime) {
|
|
var offset int64 = -1
|
|
if afterOffset >= 0 && truncateDay(t).Equal(afterTime) {
|
|
offset = afterOffset
|
|
}
|
|
|
|
buf, err := parseMessagesBefore(network, entity, t, remaining, offset)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if len(buf) == 0 {
|
|
tries++
|
|
} else {
|
|
tries = 0
|
|
}
|
|
copy(history[remaining-len(buf):], buf)
|
|
remaining -= len(buf)
|
|
year, month, day := t.Date()
|
|
t = time.Date(year, month, day, 0, 0, 0, 0, t.Location()).Add(-1)
|
|
}
|
|
|
|
return history[remaining:], nil
|
|
}
|