dokku/plugins/cron/subcommands.go

package cron

import (
	"encoding/json"
	"errors"
	"fmt"
	"os"
	"strings"

	"github.com/dokku/dokku/plugins/common"

	"github.com/ryanuber/columnize"
	"mvdan.cc/sh/v3/shell"
)

// CommandList lists all scheduled cron tasks for a given app
func CommandList(appName string, format string) error {
	if format == "" {
		format = "stdout"
	}

	if format != "stdout" && format != "json" {
		return fmt.Errorf("Invalid format specified, supported formats: json, stdout")
	}

	var tasks []CronTask
	if appName == "--global" {
		var err error
		tasks, err = FetchGlobalCronTasks()
		if err != nil {
			return err
		}
	} else {
		var err error
		if err := common.VerifyAppName(appName); err != nil {
			return err
		}
		tasks, err = FetchCronTasks(FetchCronTasksInput{AppName: appName})
		if err != nil {
			return err
		}
	}

	if format == "stdout" {
		output := []string{"ID | Schedule | Concurrency | Maintenance | Command"}
		for _, task := range tasks {
			maintenance := "false"
			if task.Maintenance {
				if task.TaskInMaintenance {
					maintenance = "true (task)"
				} else if task.AppInMaintenance {
					maintenance = "true (app)"
				}
			}
			output = append(output, fmt.Sprintf("%s | %s | %s | %s | %s", task.ID, task.Schedule, task.ConcurrencyPolicy, maintenance, task.Command))
		}

		result := columnize.SimpleFormat(output)
		fmt.Println(result)
		return nil
	}

	out, err := json.Marshal(tasks)
	if err != nil {
		return err
	}
	common.Log(string(out))

	return nil
}

// CommandReport displays a cron report for one or more apps
func CommandReport(appName string, format string, infoFlag string) error {
	if len(appName) == 0 {
		apps, err := common.DokkuApps()
		if err != nil {
			if errors.Is(err, common.NoAppsExist) {
				common.LogWarn(err.Error())
				return nil
			}
			return err
		}
		for _, appName := range apps {
			if err := ReportSingleApp(appName, format, infoFlag); err != nil {
				return err
			}
		}
		return nil
	}

	return ReportSingleApp(appName, format, infoFlag)
}

// CommandResume resumes a cron task
func CommandResume(appName string, cronID string) error {
	return CommandSet(appName, fmt.Sprintf("%s%s", MaintenancePropertyPrefix, cronID), "")
}

// CommandRun executes a cron task on the fly
func CommandRun(appName string, cronID string, detached bool) error {
	if err := common.VerifyAppName(appName); err != nil {
		return err
	}

	tasks, err := FetchCronTasks(FetchCronTasksInput{AppName: appName})
	if err != nil {
		return err
	}

	if cronID == "" {
		return fmt.Errorf("Please specify a Cron ID from the output of 'dokku cron:list %s'", appName)
	}

	command := ""
	concurrencyPolicy := "allow"
	for _, task := range tasks {
		if task.ID == cronID {
			command = task.Command
			concurrencyPolicy = task.ConcurrencyPolicy
		}
	}

	if command == "" {
		return fmt.Errorf("No matching Cron ID found. Please specify a Cron ID from the output of 'dokku cron:list %s'", appName)
	}

	fields, err := shell.Fields(command, func(name string) string {
		return ""
	})
	if err != nil {
		return fmt.Errorf("Could not parse command: %s", err)
	}

	if detached {
		os.Setenv("DOKKU_DETACH_CONTAINER", "1")
		os.Setenv("DOKKU_DISABLE_TTY", "true")
	}

	os.Setenv("DOKKU_CONCURRENCY_POLICY", concurrencyPolicy)
	os.Setenv("DOKKU_CRON_ID", cronID)
	os.Setenv("DOKKU_RM_CONTAINER", "1")
	os.Setenv("DOKKU_RUN_TTL_SECONDS", "86400")
	scheduler := common.GetAppScheduler(appName)
	args := append([]string{scheduler, appName, "0", "--"}, fields...)
	_, err = common.CallPlugnTrigger(common.PlugnTriggerInput{
		Trigger:     "scheduler-run",
		Args:        args,
		StreamStdio: true,
	})
	if err != nil {
		// return an error with an empty message to avoid
		// printing the error message twice
		return errors.New("")
	}
	return err
}

// CommandSet set or clear a cron property for an app
func CommandSet(appName string, property string, value string) error {
	if err := validateSetValue(appName, property, value); err != nil {
		return err
	}

	validProperties := DefaultProperties
	globalProperties := GlobalProperties
	if strings.HasPrefix(property, MaintenancePropertyPrefix) {
		if appName == "--global" {
			return fmt.Errorf("Task maintenance properties cannot be set globally")
		}

		cronTaskID := strings.TrimPrefix(property, MaintenancePropertyPrefix)
		if cronTaskID == "" {
			return fmt.Errorf("Invalid task maintenance property, missing ID")
		}

		tasks, err := FetchCronTasks(FetchCronTasksInput{AppName: appName})
		if err != nil {
			return err
		}

		for _, task := range tasks {
			if task.ID == cronTaskID {
				validProperties[property] = ""
				globalProperties[property] = false
				break
			}
		}

		if _, ok := validProperties[property]; !ok {
			return fmt.Errorf("Invalid task maintenance property, no matching task ID found: %s", property)
		}
	}

	common.CommandPropertySet("cron", appName, property, value, validProperties, globalProperties)
	scheduler := common.GetAppScheduler(appName)
	triggerArgs := []string{scheduler, appName}
	if appName == "--global" {
		triggerArgs = []string{scheduler}
	}
	_, err := common.CallPlugnTrigger(common.PlugnTriggerInput{
		Trigger:     "scheduler-cron-write",
		Args:        triggerArgs,
		StreamStdio: true,
	})
	return err
}

// CommandSuspend suspends a cron task
func CommandSuspend(appName string, cronID string) error {
	return CommandSet(appName, fmt.Sprintf("%s%s", MaintenancePropertyPrefix, cronID), "true")
}