dokku/plugins/common/data.go

package common

import (
	"errors"
	"fmt"
	"os"
	"path/filepath"
)

// CreateAppDataDirectory creates a data directory for the given plugin/app combination with the correct permissions
func CreateAppDataDirectory(pluginName, appName string) error {
	directory := GetAppDataDirectory(pluginName, appName)
	if err := os.MkdirAll(directory, 0755); err != nil {
		return err
	}

	return SetPermissions(SetPermissionInput{
		Filename: directory,
		Mode:     os.FileMode(0755),
	})
}

// CreateDataDirectory creates a data directory for the given plugin/app combination with the correct permissions
func CreateDataDirectory(pluginName string) error {
	directory := GetDataDirectory(pluginName)
	if err := os.MkdirAll(directory, 0755); err != nil {
		return err
	}

	return SetPermissions(SetPermissionInput{
		Filename: directory,
		Mode:     os.FileMode(0755),
	})
}

// GetAppDataDirectory returns the path to the data directory for the given plugin/app combination
func GetAppDataDirectory(pluginName string, appName string) string {
	return filepath.Join(GetDataDirectory(pluginName), appName)
}

// GetDataDirectory returns the path to the data directory for the specified plugin
func GetDataDirectory(pluginName string) string {
	return filepath.Join(MustGetEnv("DOKKU_LIB_ROOT"), "data", pluginName)
}

// MigrateAppDataDirectory migrates the data directory for one app to another
func MigrateAppDataDirectory(pluginName string, oldAppName string, newAppName string) error {
	if err := CloneAppData(pluginName, oldAppName, newAppName); err != nil {
		return err
	}

	return RemoveAppDataDirectory(pluginName, oldAppName)
}

// RemoveAppDataDirectory removes the path to the data directory for the given plugin/app combination
func RemoveAppDataDirectory(pluginName, appName string) error {
	return os.RemoveAll(GetAppDataDirectory(pluginName, appName))
}

// CloneAppData copies the data from one app to another
func CloneAppData(pluginName string, oldAppName string, newAppName string) error {
	oldDataDir := GetAppDataDirectory(pluginName, oldAppName)
	if !DirectoryExists(oldDataDir) {
		return CreateAppDataDirectory(pluginName, newAppName)
	}

	newDataDir := GetAppDataDirectory(pluginName, newAppName)
	if err := Copy(oldDataDir, newDataDir); err != nil {
		return fmt.Errorf("Unable to clone app data to new location: %v", err.Error())
	}

	return nil
}

// SetupAppData ensures each app has a data directory
func SetupAppData(pluginName string) error {
	if err := CreateDataDirectory(pluginName); err != nil {
		return err
	}

	apps, err := UnfilteredDokkuApps()
	if err != nil && !errors.Is(err, NoAppsExist) {
		return nil
	}

	for _, appName := range apps {
		if err := CreateAppDataDirectory(pluginName, appName); err != nil {
			return err
		}
	}

	return nil
}