gochan/cmd/gochan-migration/internal/pre2021/bans.go

package pre2021

import (
	"context"
	"database/sql"
	"errors"
	"net"
	"os"
	"strings"
	"time"

	"github.com/gochan-org/gochan/cmd/gochan-migration/internal/common"
	"github.com/gochan-org/gochan/pkg/gcsql"
	"github.com/gochan-org/gochan/pkg/gcutil"
	"github.com/rs/zerolog"
)

type migrationBan struct {
	oldID        int
	allowRead    string
	ip           string
	name         string
	nameIsRegex  bool
	filename     string
	fileChecksum string
	boards       string
	staff        string
	timestamp    time.Time
	expires      time.Time
	permaban     bool
	reason       string
	banType      int
	staffNote    string
	appealAt     time.Time
	canAppeal    bool

	boardIDs []int
	staffID  int
}

func (m *Pre2021Migrator) migrateBansInPlace() error {
	errEv := common.LogError()
	defer errEv.Discard()
	initSQLPath := gcutil.FindResource("sql/initdb_" + m.db.SQLDriver() + ".sql")
	ba, err := os.ReadFile(initSQLPath)
	if err != nil {
		errEv.Err(err).Caller().
			Str("initDBFile", initSQLPath).
			Msg("Failed to read initdb file")
		return err
	}
	statements := strings.Split(string(ba), ";")
	for _, stmt := range statements {
		stmt = strings.TrimSpace(stmt)
		if strings.HasPrefix(stmt, "CREATE TABLE DBPREFIXip_ban") || strings.HasPrefix(stmt, "CREATE TABLE DBPREFIXfilter") {
			_, err = gcsql.ExecSQL(stmt)
			if err != nil {
				errEv.Err(err).Caller().
					Str("statement", stmt).
					Msg("Failed to create table")
				return err
			}
		}
	}
	// since the table names are different, migrateBansToNewDB can be called directly to migrate bans
	return m.migrateBansToNewDB()
}

func (m *Pre2021Migrator) migrateBan(tx *sql.Tx, ban *migrationBan, boardID *int, errEv *zerolog.Event) error {
	migratedBan := &gcsql.IPBan{
		BoardID:    boardID,
		RangeStart: ban.ip,
		RangeEnd:   ban.ip,
		IssuedAt:   ban.timestamp,
	}
	migratedBan.CanAppeal = ban.canAppeal
	migratedBan.AppealAt = ban.appealAt
	migratedBan.ExpiresAt = ban.expires
	migratedBan.Permanent = ban.permaban
	migratedBan.Message = ban.reason
	migratedBan.StaffID = ban.staffID
	migratedBan.StaffNote = ban.staffNote
	if err := gcsql.NewIPBanTx(tx, migratedBan); err != nil {
		errEv.Err(err).Caller().
			Int("oldID", ban.oldID).Msg("Failed to migrate ban")
		return err
	}
	return nil
}

func (m *Pre2021Migrator) migrateBansToNewDB() error {
	errEv := common.LogError()
	defer errEv.Discard()

	tx, err := gcsql.BeginTx()
	if err != nil {
		errEv.Err(err).Caller().Msg("Failed to start transaction")
		return err
	}
	defer tx.Rollback()

	rows, err := m.db.QuerySQL(bansQuery)
	if err != nil {
		errEv.Err(err).Caller().Msg("Failed to get bans")
		return err
	}
	defer rows.Close()

	for rows.Next() {
		var ban migrationBan
		if err = rows.Scan(
			&ban.oldID, &ban.allowRead, &ban.ip, &ban.name, &ban.nameIsRegex, &ban.filename, &ban.fileChecksum,
			&ban.boards, &ban.staff, &ban.timestamp, &ban.expires, &ban.permaban, &ban.reason, &ban.banType, &ban.staffNote, &ban.appealAt, &ban.canAppeal,
		); err != nil {
			errEv.Err(err).Caller().Msg("Failed to scan ban row")
			return err
		}

		if ban.boards != "" && ban.boards != "*" {
			boardDirs := strings.Split(ban.boards, ",")
			for _, dir := range boardDirs {
				dir = strings.TrimSpace(dir)
				boardID, err := gcsql.GetBoardIDFromDir(dir)
				if err != nil {
					if errors.Is(err, gcsql.ErrBoardDoesNotExist) {
						common.Logger().Warn().Str("board", dir).Msg("Found unrecognized ban board")
						continue
					} else {
						errEv.Err(err).Caller().Str("board", dir).Msg("Failed getting board ID from dir")
						return err
					}
				}
				ban.boardIDs = append(ban.boardIDs, boardID)
			}
		}

		migrationUser, err := m.getMigrationUser(errEv)
		if err != nil {
			return err
		}
		ban.staffID, err = gcsql.GetStaffID(ban.staff)
		if errors.Is(err, gcsql.ErrUnrecognizedUsername) {
			// username not found after staff were migrated, use a stand-in account to be updated by the admin later
			common.LogWarning().
				Str("username", ban.staff).
				Str("migrationUser", migrationUser.Username).
				Msg("Ban staff not found in migrated staff table, using migration user instead")
			ban.staffID = migrationUser.ID
		} else if err != nil {
			errEv.Err(err).Caller().Str("username", ban.staff).Msg("Failed to get staff from username")
			return err
		}

		if ban.ip == "" && ban.name == "" && ban.fileChecksum == "" && ban.filename == "" {
			common.LogWarning().Int("banID", ban.oldID).Msg("Found invalid ban (no IP, name, file checksum, or filename set)")
			continue
		}
		if ban.ip != "" {
			if net.ParseIP(ban.ip) == nil {
				gcutil.LogWarning().
					Int("oldID", ban.oldID).
					Str("ip", ban.ip).
					Msg("Found ban with invalid IP address, skipping")
				continue
			}
			if len(ban.boardIDs) == 0 {
				if err = m.migrateBan(tx, &ban, nil, errEv); err != nil {
					return err
				}
			} else {
				for b := range ban.boardIDs {
					if err = m.migrateBan(tx, &ban, &ban.boardIDs[b], errEv); err != nil {
						return err
					}
				}
			}
		}
		if ban.name != "" || ban.fileChecksum != "" || ban.filename != "" {
			filter := &gcsql.Filter{
				StaffID:     &ban.staffID,
				StaffNote:   ban.staffNote,
				IsActive:    true,
				HandleIfAny: true,
				MatchAction: "reject",
				MatchDetail: ban.reason,
			}
			var conditions []gcsql.FilterCondition
			if ban.name != "" {
				nameCondition := gcsql.FilterCondition{
					Field:     "name",
					Search:    ban.name,
					MatchMode: gcsql.ExactMatch,
				}
				if ban.nameIsRegex {
					nameCondition.MatchMode = gcsql.RegexMatch
				}
				conditions = append(conditions, nameCondition)
			}
			if ban.fileChecksum != "" {
				conditions = append(conditions, gcsql.FilterCondition{
					Field:     "checksum",
					MatchMode: gcsql.ExactMatch,
					Search:    ban.fileChecksum,
				})
			}
			if ban.filename != "" {
				filenameCondition := gcsql.FilterCondition{
					Field:     "filename",
					Search:    ban.filename,
					MatchMode: gcsql.ExactMatch,
				}
				if ban.nameIsRegex {
					filenameCondition.MatchMode = gcsql.RegexMatch
				}
				conditions = append(conditions, filenameCondition)
			}
			if err = gcsql.ApplyFilterTx(context.Background(), tx, filter, conditions, ban.boardIDs); err != nil {
				errEv.Err(err).Caller().Int("banID", ban.oldID).Msg("Failed to migrate ban to filter")
				return err
			}
		}
	}

	return tx.Commit()
}

func (m *Pre2021Migrator) MigrateBans() error {
	if m.IsMigratingInPlace() {
		return m.migrateBansInPlace()
	}
	return m.migrateBansToNewDB()
}