github.com/ddev/ddev@v1.23.2-0.20240519125000-d824ffe36ff3/pkg/ddevapp/apptypes.go

package ddevapp

import (
	"fmt"
	"os"
	"path"
	"path/filepath"
	"sort"
	"strings"

	"github.com/ddev/ddev/pkg/nodeps"
	"github.com/ddev/ddev/pkg/util"
	"github.com/maruel/natural"
	"github.com/pkg/errors"
)

// appTypeFuncs prototypes
//
// settingsCreator
type settingsCreator func(*DdevApp) (string, error)

// uploadDirs
type uploadDirs func(*DdevApp) []string

// hookDefaultComments should probably change its arg from string to app when
// config refactor is done.
type hookDefaultComments func() []byte

// composerCreateAllowedPaths
type composerCreateAllowedPaths func(app *DdevApp) ([]string, error)

// appTypeSettingsPaths
type appTypeSettingsPaths func(app *DdevApp)

// appTypeDetect returns true if the app is of the specified type
type appTypeDetect func(app *DdevApp) bool

// postImportDBAction can take actions after import (like warning user about
// required actions on Wordpress.
type postImportDBAction func(app *DdevApp) error

// configOverrideAction allows a particular apptype to override elements
// of the config for that apptype. Key example is drupal6 needing php56
type configOverrideAction func(app *DdevApp) error

// postConfigAction allows actions to take place at the end of ddev config
type postConfigAction func(app *DdevApp) error

// postStartAction allows actions to take place at the end of ddev start
type postStartAction func(app *DdevApp) error

// importFilesAction
type importFilesAction func(app *DdevApp, uploadDir, importPath, extractPath string) error

// defaultWorkingDirMap returns the app type's default working directory map
type defaultWorkingDirMap func(app *DdevApp, defaults map[string]string) map[string]string

// appTypeFuncs struct defines the functions that can be called (if populated)
// for a given appType.
type appTypeFuncs struct {
	settingsCreator
	uploadDirs
	hookDefaultComments
	composerCreateAllowedPaths
	appTypeSettingsPaths
	appTypeDetect
	postImportDBAction
	configOverrideAction
	postConfigAction
	postStartAction
	importFilesAction
	defaultWorkingDirMap
}

// appTypeMatrix is a static map that defines the various functions to be called
// for each apptype (CMS).
var appTypeMatrix map[string]appTypeFuncs

func init() {
	appTypeMatrix = map[string]appTypeFuncs{
		nodeps.AppTypeBackdrop: {
			settingsCreator:            createBackdropSettingsFile,
			uploadDirs:                 getBackdropUploadDirs,
			hookDefaultComments:        getBackdropHooks,
			appTypeSettingsPaths:       setBackdropSiteSettingsPaths,
			appTypeDetect:              isBackdropApp,
			postImportDBAction:         backdropPostImportDBAction,
			postStartAction:            backdropPostStartAction,
			importFilesAction:          backdropImportFilesAction,
			defaultWorkingDirMap:       docrootWorkingDir,
			composerCreateAllowedPaths: getBackdropComposerCreateAllowedPaths,
		},

		nodeps.AppTypeCakePHP: {
			appTypeDetect:        isCakephpApp,
			configOverrideAction: cakephpConfigOverrideAction,
			postStartAction:      cakephpPostStartAction,
		},

		nodeps.AppTypeCraftCms: {
			importFilesAction:    craftCmsImportFilesAction,
			appTypeDetect:        isCraftCmsApp,
			configOverrideAction: craftCmsConfigOverrideAction,
			postStartAction:      craftCmsPostStartAction,
		},

		nodeps.AppTypeDjango4: {
			settingsCreator:      django4SettingsCreator,
			appTypeDetect:        isDjango4App,
			configOverrideAction: django4ConfigOverrideAction,
			postConfigAction:     django4PostConfigAction,
			postStartAction:      django4PostStartAction,
		},

		nodeps.AppTypeDrupal6: {
			settingsCreator:            createDrupalSettingsPHP,
			uploadDirs:                 getDrupalUploadDirs,
			hookDefaultComments:        getDrupal6Hooks,
			appTypeSettingsPaths:       setDrupalSiteSettingsPaths,
			appTypeDetect:              isDrupal6App,
			configOverrideAction:       drupal6ConfigOverrideAction,
			postStartAction:            drupal6PostStartAction,
			importFilesAction:          drupalImportFilesAction,
			defaultWorkingDirMap:       docrootWorkingDir,
			composerCreateAllowedPaths: getDrupalComposerCreateAllowedPaths,
		},

		nodeps.AppTypeDrupal7: {
			settingsCreator:            createDrupalSettingsPHP,
			uploadDirs:                 getDrupalUploadDirs,
			hookDefaultComments:        getDrupal7Hooks,
			appTypeSettingsPaths:       setDrupalSiteSettingsPaths,
			appTypeDetect:              isDrupal7App,
			configOverrideAction:       drupal7ConfigOverrideAction,
			postStartAction:            drupal7PostStartAction,
			importFilesAction:          drupalImportFilesAction,
			defaultWorkingDirMap:       docrootWorkingDir,
			composerCreateAllowedPaths: getDrupalComposerCreateAllowedPaths,
		},

		nodeps.AppTypeDrupal: {
			settingsCreator:            createDrupalSettingsPHP,
			uploadDirs:                 getDrupalUploadDirs,
			hookDefaultComments:        getDrupalHooks,
			appTypeSettingsPaths:       setDrupalSiteSettingsPaths,
			appTypeDetect:              isDrupalApp,
			configOverrideAction:       drupalConfigOverrideAction,
			postStartAction:            drupalPostStartAction,
			importFilesAction:          drupalImportFilesAction,
			composerCreateAllowedPaths: getDrupalComposerCreateAllowedPaths,
		},

		nodeps.AppTypeLaravel: {
			appTypeDetect:   isLaravelApp,
			postStartAction: laravelPostStartAction,
		},

		nodeps.AppTypeSilverstripe: {
			appTypeDetect:        isSilverstripeApp,
			postStartAction:      silverstripePostStartAction,
			configOverrideAction: silverstripeConfigOverrideAction,
			uploadDirs:           getSilverstripeUploadDirs,
		},

		nodeps.AppTypeMagento: {
			settingsCreator:      createMagentoSettingsFile,
			uploadDirs:           getMagentoUploadDirs,
			appTypeSettingsPaths: setMagentoSiteSettingsPaths,
			appTypeDetect:        isMagentoApp,
			importFilesAction:    magentoImportFilesAction,
		},

		nodeps.AppTypeMagento2: {
			settingsCreator:      createMagento2SettingsFile,
			uploadDirs:           getMagento2UploadDirs,
			appTypeSettingsPaths: setMagento2SiteSettingsPaths,
			appTypeDetect:        isMagento2App,
			configOverrideAction: magento2ConfigOverrideAction,
			importFilesAction:    magentoImportFilesAction,
		},

		nodeps.AppTypePHP: {
			postStartAction: nil,
		},

		nodeps.AppTypePython: {
			appTypeDetect:        isPythonApp,
			configOverrideAction: pythonConfigOverrideAction,
			postConfigAction:     pythonPostConfigAction,
		},

		nodeps.AppTypeShopware6: {
			appTypeDetect:        isShopware6App,
			appTypeSettingsPaths: setShopware6SiteSettingsPaths,
			uploadDirs:           getShopwareUploadDirs,
			postStartAction:      shopware6PostStartAction,
			importFilesAction:    shopware6ImportFilesAction,
		},

		nodeps.AppTypeTYPO3: {
			settingsCreator:      createTypo3SettingsFile,
			uploadDirs:           getTypo3UploadDirs,
			hookDefaultComments:  getTypo3Hooks,
			appTypeSettingsPaths: setTypo3SiteSettingsPaths,
			appTypeDetect:        isTypo3App,
			importFilesAction:    typo3ImportFilesAction,
		},

		nodeps.AppTypeWordPress: {
			settingsCreator:      createWordpressSettingsFile,
			uploadDirs:           getWordpressUploadDirs,
			hookDefaultComments:  getWordpressHooks,
			appTypeSettingsPaths: setWordpressSiteSettingsPaths,
			appTypeDetect:        isWordpressApp,
			importFilesAction:    wordpressImportFilesAction,
		},
	}

	drupalAlias := appTypeMatrix[nodeps.AppTypeDrupal]
	drupalAlias.appTypeDetect = nil
	for _, alias := range []string{nodeps.AppTypeDrupal8, nodeps.AppTypeDrupal9, nodeps.AppTypeDrupal10} {
		appTypeMatrix[alias] = drupalAlias
	}
}

// CreateSettingsFile creates the settings file (like settings.php) for the
// provided app is the apptype has a settingsCreator function.
// It also preps the ddev directory, including setting up the .ddev gitignore
func (app *DdevApp) CreateSettingsFile() (string, error) {
	err := PrepDdevDirectory(app)
	if err != nil {
		util.Warning("Unable to PrepDdevDirectory: %v", err)
	}

	app.SetApptypeSettingsPaths()

	if app.DisableSettingsManagement && app.Type != nodeps.AppTypePHP {
		util.Warning("Not creating CMS settings files because disable_settings_management=true")
		return "", nil
	}

	// Drupal and WordPress love to change settings files to be unwriteable.
	// Chmod them to something we can work with in the event that they already
	// exist.
	if app.SiteSettingsPath != "" {
		chmodTargets := []string{filepath.Dir(app.SiteSettingsPath), app.SiteDdevSettingsFile}
		for _, fp := range chmodTargets {
			fileInfo, err := os.Stat(fp)
			if err != nil {
				// We're not doing anything about this error other than warning,
				// and will have to deal with the same check in settingsCreator.
				if !os.IsNotExist(err) {
					util.Warning("Unable to ensure write permissions: %v", err)
				}

				continue
			}

			perms := 0644
			if fileInfo.IsDir() {
				perms = 0755
			}

			err = os.Chmod(fp, os.FileMode(perms))
			if err != nil {
				return "", fmt.Errorf("could not change permissions on file %s to make it writeable: %v", fp, err)
			}
		}
	}

	// If we have a function to do the settings creation, do it, otherwise
	// ignore it.
	if appFuncs, ok := appTypeMatrix[app.GetType()]; ok && appFuncs.settingsCreator != nil {
		settingsPath, err := appFuncs.settingsCreator(app)
		if err != nil {
			util.Warning("Unable to create settings file '%s': %v", app.SiteSettingsPath, err)
		}

		// Don't create gitignore if it would be in top-level directory, where
		// there is almost certainly already a gitignore (like Backdrop)
		if path.Dir(app.SiteSettingsPath) != app.AppRoot {
			if err = CreateGitIgnore(filepath.Dir(app.SiteSettingsPath), filepath.Base(app.SiteDdevSettingsFile), "drushrc.php"); err != nil {
				util.Warning("Failed to write .gitignore in %s: %v", filepath.Dir(app.SiteDdevSettingsFile), err)
			}
		}
		return settingsPath, nil
	}

	// If the project is not running, it makes no sense to sync it
	if s, _ := app.SiteStatus(); s == SiteRunning {
		err = app.MutagenSyncFlush()
		if err != nil {
			return "", err
		}
	}

	return "", nil
}

// GetHookDefaultComments gets the actual text of the config.yaml hook suggestions
// for a given apptype
func (app *DdevApp) GetHookDefaultComments() []byte {
	if appFuncs, ok := appTypeMatrix[app.Type]; ok && appFuncs.hookDefaultComments != nil {
		suggestions := appFuncs.hookDefaultComments()
		return suggestions
	}
	return []byte("")
}

// GetComposerCreateAllowedPaths gets all paths relative to the app root that are allowed to be present
// for a given apptype when running ddev composer create
func (app *DdevApp) GetComposerCreateAllowedPaths() ([]string, error) {
	var allowed []string

	// doc root
	allowed = append(allowed, nodeps.PathWithSlashesToArray(app.GetRelativeDirectory(app.GetDocroot()))...)

	// composer root
	allowed = append(allowed, nodeps.PathWithSlashesToArray(app.GetRelativeDirectory(app.GetComposerRoot(false, false)))...)

	// allow upload dirs
	// upload dirs are probably always relative and with slashes, but we run
	// it through GetRelativeDirectory() just in case.
	uploadDirs := app.getUploadDirsRelative()
	for _, uploadDir := range uploadDirs {
		allowed = append(allowed, nodeps.PathWithSlashesToArray(app.GetRelativeDirectory(uploadDir))...)
	}

	// Settings files
	allowed = append(allowed, nodeps.PathWithSlashesToArray(app.GetRelativeDirectory(app.SiteSettingsPath))...)
	allowed = append(allowed, nodeps.PathWithSlashesToArray(app.GetRelativeDirectory(app.SiteDdevSettingsFile))...)

	// If we have a function to do the settings creation, allow .gitignore
	// see CreateSettingsFile
	if appFuncs, ok := appTypeMatrix[app.GetType()]; ok && appFuncs.settingsCreator != nil {
		// We don't create gitignore if it would be in top-level directory, where
		// there is almost certainly already a gitignore (like Backdrop)
		if path.Dir(app.SiteSettingsPath) != app.AppRoot {
			allowed = append(allowed, nodeps.PathWithSlashesToArray(app.GetRelativeDirectory(filepath.Join(filepath.Dir(app.SiteSettingsPath), ".gitignore")))...)
		}
	}

	if appFuncs, ok := appTypeMatrix[app.Type]; ok && appFuncs.composerCreateAllowedPaths != nil {
		paths, err := appFuncs.composerCreateAllowedPaths(app)
		if err != nil {
			return []string{""}, err
		}
		for _, path := range paths {
			allowed = append(allowed, nodeps.PathWithSlashesToArray(app.GetRelativeDirectory(path))...)
		}
	}
	allowed = util.SliceToUniqueSlice(&allowed)
	sort.Strings(allowed)
	return allowed, nil
}

// SetApptypeSettingsPaths chooses and sets the settings.php/settings.local.php
// and related paths for a given app.
func (app *DdevApp) SetApptypeSettingsPaths() {
	if appFuncs, ok := appTypeMatrix[app.Type]; ok && appFuncs.appTypeSettingsPaths != nil {
		appFuncs.appTypeSettingsPaths(app)
	}
}

// DetectAppType calls each apptype's detector until it finds a match,
// or returns 'php' as a last resort.
func (app *DdevApp) DetectAppType() string {
	for appTypeName, appFuncs := range appTypeMatrix {
		if appFuncs.appTypeDetect != nil && appFuncs.appTypeDetect(app) {
			return appTypeName
		}
	}

	return nodeps.AppTypePHP
}

// PostImportDBAction calls each apptype's detector until it finds a match,
// or returns 'php' as a last resort.
func (app *DdevApp) PostImportDBAction() error {

	if appFuncs, ok := appTypeMatrix[app.Type]; ok && appFuncs.postImportDBAction != nil {
		return appFuncs.postImportDBAction(app)
	}

	return nil
}

// ConfigFileOverrideAction gives a chance for an apptype to override any element
// of config.yaml that it needs to
func (app *DdevApp) ConfigFileOverrideAction(overrideExistingConfig bool) error {
	if appFuncs, ok := appTypeMatrix[app.Type]; ok && appFuncs.configOverrideAction != nil && (overrideExistingConfig || !app.ConfigExists()) {
		origDB := app.Database
		err := appFuncs.configOverrideAction(app)
		if err != nil {
			return err
		}
		// If the override function has changed the database type
		// check to make sure that there's not one already existing
		if origDB != app.Database {
			// We can't upgrade database if it already exists
			dbType, err := app.GetExistingDBType()
			if err != nil {
				return err
			}
			recommendedDBType := app.Database.Type + ":" + app.Database.Version
			if dbType == "" {
				// Assume that we don't have a database yet
				util.Success("Configuring %s project with database type '%s'", app.Type, recommendedDBType)
			} else if dbType != recommendedDBType {
				util.Warning("%s project already has database type set to non-recommended: %s, not changing it to recommended %s", app.Type, dbType, recommendedDBType)
				app.Database = origDB
			}
		}
	}

	return nil
}

// PostConfigAction gives a chance for an apptype to override do something at
// the end of ddev config.
func (app *DdevApp) PostConfigAction() error {
	if appFuncs, ok := appTypeMatrix[app.Type]; ok && appFuncs.postConfigAction != nil {
		return appFuncs.postConfigAction(app)
	}

	return nil
}

// PostStartAction gives a chance for an apptype to do something after the app
// has been started.
func (app *DdevApp) PostStartAction() error {
	if appFuncs, ok := appTypeMatrix[app.Type]; ok && appFuncs.postStartAction != nil {
		return appFuncs.postStartAction(app)
	}

	return nil
}

// dispatchImportFilesAction executes the relevant import files workflow for each app type.
func (app *DdevApp) dispatchImportFilesAction(uploadDir, importPath, extractPath string) error {
	if strings.TrimSpace(uploadDir) == "" {
		return errors.Errorf("upload_dirs is not set for this project (%s)", app.Type)
	}

	if appFuncs, ok := appTypeMatrix[app.Type]; ok {
		// if a specific action is not defined, use a generic action
		if appFuncs.importFilesAction == nil {
			appFuncs.importFilesAction = genericImportFilesAction
		}
		return appFuncs.importFilesAction(app, uploadDir, importPath, extractPath)
	}

	return fmt.Errorf("this project type (%s) does not support import-files", app.Type)
}

// DefaultWorkingDirMap returns the app type's default working directory map.
func (app *DdevApp) DefaultWorkingDirMap() map[string]string {
	_, _, username := util.GetContainerUIDGid()
	// Default working directory values are defined here.
	// Services working directories can be overridden by app types if needed.
	defaults := map[string]string{
		"web": "/var/www/html/",
		"db":  "/home/" + username,
	}

	if appFuncs, ok := appTypeMatrix[app.Type]; ok && appFuncs.defaultWorkingDirMap != nil {
		return appFuncs.defaultWorkingDirMap(app, defaults)
	}

	if app.Database.Type == nodeps.Postgres {
		defaults["db"] = "/var/lib/postgresql"
	}
	return defaults
}

// docrootWorkingDir handles the shared case in which the web service working directory is the docroot.
func docrootWorkingDir(app *DdevApp, defaults map[string]string) map[string]string {
	defaults["web"] = path.Join("/var/www/html", app.Docroot)

	return defaults
}

// IsValidAppType is a helper function to determine if an app type is valid, returning
// true if the given app type is valid and configured and false otherwise.
func IsValidAppType(apptype string) bool {
	if _, ok := appTypeMatrix[apptype]; !ok {
		return false
	}

	return true
}

// GetValidAppTypes returns the valid apptype keys from the appTypeMatrix
func GetValidAppTypes() []string {
	keys := make([]string, 0, len(appTypeMatrix))
	for k := range appTypeMatrix {
		keys = append(keys, k)
		sort.Sort(natural.StringSlice(keys))
	}
	return keys
}

// GetValidAppTypesWithoutAliases returns the valid apptype keys from the appTypeMatrix without aliases like
// drupal8/9/10
func GetValidAppTypesWithoutAliases() []string {
	keys := make([]string, 0, len(appTypeMatrix))
	for k := range appTypeMatrix {
		if k == nodeps.AppTypeDrupal8 || k == nodeps.AppTypeDrupal9 || k == nodeps.AppTypeDrupal10 {
			continue
		}
		keys = append(keys, k)
	}
	sort.Strings(keys)
	return keys
}