forgejo/cmd/doctor.go

// Copyright 2019 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package cmd

import (
	"context"
	"fmt"
	golog "log"
	"os"
	"path/filepath"
	"strings"
	"text/tabwriter"

	"forgejo.org/models/db"
	"forgejo.org/models/migrations"
	migrate_base "forgejo.org/models/migrations/base"
	"forgejo.org/modules/container"
	"forgejo.org/modules/log"
	"forgejo.org/modules/setting"
	"forgejo.org/services/doctor"

	"github.com/urfave/cli/v3"
)

// CmdDoctor represents the available doctor sub-command.
func cmdDoctor() *cli.Command {
	return &cli.Command{
		Name:        "doctor",
		Usage:       "Diagnose and optionally fix problems, convert or re-create database tables",
		Description: "A command to diagnose problems with the current Forgejo instance according to the given configuration. Some problems can optionally be fixed by modifying the database or data storage.",

		Commands: []*cli.Command{
			cmdDoctorCheck(),
			cmdRecreateTable(),
			cmdDoctorConvert(),
		},
	}
}

func cmdDoctorCheck() *cli.Command {
	return &cli.Command{
		Name:        "check",
		Usage:       "Diagnose and optionally fix problems",
		Description: "A command to diagnose problems with the current Forgejo instance according to the given configuration. Some problems can optionally be fixed by modifying the database or data storage.",
		Action:      runDoctorCheck,
		Flags: []cli.Flag{
			&cli.BoolFlag{
				Name:  "list",
				Usage: "List the available checks",
			},
			&cli.BoolFlag{
				Name:  "default",
				Usage: "Run the default checks (if neither --run or --all is set, this is the default behaviour)",
			},
			&cli.StringSliceFlag{
				Name:  "run",
				Usage: "Run the provided checks - (if --default is set, the default checks will also run)",
			},
			&cli.BoolFlag{
				Name:  "all",
				Usage: "Run all the available checks",
			},
			&cli.BoolFlag{
				Name:  "fix",
				Usage: "Automatically fix what we can",
			},
			&cli.StringFlag{
				Name:  "log-file",
				Usage: `Name of the log file (no verbose log output by default). Set to "-" to output to stdout`,
			},
			&cli.BoolFlag{
				Name:    "color",
				Aliases: []string{"H"},
				Usage:   "Use color for outputted information",
			},
		},
	}
}

func cmdRecreateTable() *cli.Command {
	return &cli.Command{
		Name:      "recreate-table",
		Usage:     "Recreate tables from XORM definitions and copy the data.",
		ArgsUsage: "[TABLE]... : (TABLEs to recreate - leave blank for all)",
		Flags: []cli.Flag{
			&cli.BoolFlag{
				Name:  "debug",
				Usage: "Print SQL commands sent",
			},
		},
		Description: `The database definitions Forgejo uses change across versions, sometimes changing default values and leaving old unused columns.

This command will cause Xorm to recreate tables, copying over the data and deleting the old table.

You should back-up your database before doing this and ensure that your database is up-to-date first.`,
		Action: runRecreateTable,
	}
}

func runRecreateTable(stdCtx context.Context, ctx *cli.Command) error {
	stdCtx, cancel := installSignals(stdCtx)
	defer cancel()

	// Redirect the default golog to here
	golog.SetFlags(0)
	golog.SetPrefix("")
	golog.SetOutput(log.LoggerToWriter(log.GetLogger(log.DEFAULT).Info))

	debug := ctx.Bool("debug")
	setting.MustInstalled()
	setting.LoadDBSetting()

	if debug {
		setting.InitSQLLoggersForCli(log.DEBUG)
	} else {
		setting.InitSQLLoggersForCli(log.INFO)
	}

	setting.Database.LogSQL = debug
	if err := db.InitEngine(stdCtx); err != nil {
		fmt.Println(err)
		fmt.Println("Check if you are using the right config file. You can use a --config directive to specify one.")
		return nil
	}

	args := ctx.Args()
	names := make([]string, 0, ctx.NArg())
	for i := range ctx.NArg() {
		names = append(names, args.Get(i))
	}

	beans, err := db.NamesToBean(names...)
	if err != nil {
		return err
	}
	recreateTables := migrate_base.RecreateTables(beans...)

	return db.InitEngineWithMigration(stdCtx, func(x db.Engine) error {
		engine, err := db.GetMasterEngine(x)
		if err != nil {
			return err
		}

		if err := migrations.EnsureUpToDate(engine); err != nil {
			return err
		}

		return recreateTables(engine)
	})
}

func setupDoctorDefaultLogger(ctx *cli.Command, colorize bool) {
	// Silence the default loggers
	setupConsoleLogger(log.FATAL, log.CanColorStderr, os.Stderr)

	logFile := ctx.String("log-file")
	switch logFile {
	case "":
		return // if no doctor log-file is set, do not show any log from default logger
	case "-":
		setupConsoleLogger(log.TRACE, colorize, os.Stdout)
	default:
		logFile, _ = filepath.Abs(logFile)
		writeMode := log.WriterMode{Level: log.TRACE, WriterOption: log.WriterFileOption{FileName: logFile}}
		writer, err := log.NewEventWriter("console-to-file", "file", writeMode)
		if err != nil {
			log.FallbackErrorf("unable to create file log writer: %v", err)
			return
		}
		log.GetManager().GetLogger(log.DEFAULT).ReplaceAllWriters(writer)
	}
}

func runDoctorCheck(stdCtx context.Context, ctx *cli.Command) error {
	stdCtx, cancel := installSignals(stdCtx)
	defer cancel()

	colorize := log.CanColorStdout
	if ctx.IsSet("color") {
		colorize = ctx.Bool("color")
	}

	setupDoctorDefaultLogger(ctx, colorize)

	// Finally redirect the default golang's log to here
	golog.SetFlags(0)
	golog.SetPrefix("")
	golog.SetOutput(log.LoggerToWriter(log.GetLogger(log.DEFAULT).Info))

	if ctx.IsSet("list") {
		w := tabwriter.NewWriter(os.Stdout, 0, 8, 1, '\t', 0)
		_, _ = w.Write([]byte("Default\tName\tTitle\n"))
		doctor.SortChecks(doctor.Checks)
		for _, check := range doctor.Checks {
			if check.IsDefault {
				_, _ = w.Write([]byte{'*'})
			}
			_, _ = w.Write([]byte{'\t'})
			_, _ = w.Write([]byte(check.Name))
			_, _ = w.Write([]byte{'\t'})
			_, _ = w.Write([]byte(check.Title))
			_, _ = w.Write([]byte{'\n'})
		}
		return w.Flush()
	}

	var checks []*doctor.Check
	if ctx.Bool("all") {
		checks = make([]*doctor.Check, len(doctor.Checks))
		copy(checks, doctor.Checks)
	} else if ctx.IsSet("run") {
		addDefault := ctx.Bool("default")
		runNamesSet := container.SetOf(ctx.StringSlice("run")...)
		for _, check := range doctor.Checks {
			if (addDefault && check.IsDefault) || runNamesSet.Contains(check.Name) {
				checks = append(checks, check)
				runNamesSet.Remove(check.Name)
			}
		}
		if len(runNamesSet) > 0 {
			return fmt.Errorf("unknown checks: %q", strings.Join(runNamesSet.Values(), ","))
		}
	} else {
		for _, check := range doctor.Checks {
			if check.IsDefault {
				checks = append(checks, check)
			}
		}
	}
	return doctor.RunChecks(stdCtx, colorize, ctx.Bool("fix"), checks)
}