owncast/core/data/datastoreMigrations.go

package data

import (
	"strings"

	"github.com/owncast/owncast/models"
	log "github.com/sirupsen/logrus"
)

const (
	datastoreValuesVersion   = 4
	datastoreValueVersionKey = "DATA_STORE_VERSION"
)

func migrateDatastoreValues(datastore *Datastore) {
	currentVersion, _ := _datastore.GetNumber(datastoreValueVersionKey)
	if currentVersion == 0 {
		currentVersion = datastoreValuesVersion
	}

	for v := currentVersion; v < datastoreValuesVersion; v++ {
		log.Infof("Migration datastore values from %d to %d\n", int(v), int(v+1))
		switch v {
		case 0:
			migrateToDatastoreValues1(datastore)
		case 1:
			migrateToDatastoreValues2(datastore)
		case 2:
			migrateToDatastoreValues3ServingEndpoint3(datastore)
		case 3:
			migrateToDatastoreValues4(datastore)
		default:
			log.Fatalln("missing datastore values migration step")
		}
	}
	if err := _datastore.SetNumber(datastoreValueVersionKey, datastoreValuesVersion); err != nil {
		log.Errorln("error setting datastore value version:", err)
	}
}

func migrateToDatastoreValues1(datastore *Datastore) {
	// Migrate the forbidden usernames to be a slice instead of a string.
	forbiddenUsernamesString, _ := datastore.GetString(blockedUsernamesKey)
	if forbiddenUsernamesString != "" {
		forbiddenUsernamesSlice := strings.Split(forbiddenUsernamesString, ",")
		if err := datastore.SetStringSlice(blockedUsernamesKey, forbiddenUsernamesSlice); err != nil {
			log.Errorln("error migrating blocked username list:", err)
		}
	}

	// Migrate the suggested usernames to be a slice instead of a string.
	suggestedUsernamesString, _ := datastore.GetString(suggestedUsernamesKey)
	if suggestedUsernamesString != "" {
		suggestedUsernamesSlice := strings.Split(suggestedUsernamesString, ",")
		if err := datastore.SetStringSlice(suggestedUsernamesKey, suggestedUsernamesSlice); err != nil {
			log.Errorln("error migrating suggested username list:", err)
		}
	}
}

func migrateToDatastoreValues2(datastore *Datastore) {
	oldAdminPassword, _ := datastore.GetString("stream_key")
	// Avoids double hashing the password
	_ = datastore.SetString("admin_password_key", oldAdminPassword)
	_ = SetStreamKeys([]models.StreamKey{
		{Key: oldAdminPassword, Comment: "Default stream key"},
	})
}

func migrateToDatastoreValues3ServingEndpoint3(_ *Datastore) {
	s3Config := GetS3Config()

	if !s3Config.Enabled {
		return
	}

	_ = SetVideoServingEndpoint(s3Config.ServingEndpoint)
}

func migrateToDatastoreValues4(datastore *Datastore) {
	unhashed_pass, _ := datastore.GetString("admin_password_key")
	err := SetAdminPassword(unhashed_pass)
	if err != nil {
		log.Fatalln("error migrating admin password:", err)
	}
}