Method CreateSettingsFile

pkg/ddevapp/apptypes.go:302–371

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

()

// 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 && app.Type != nodeps.AppTypeGeneric {
		util.Warning("Not creating CMS settings files because disable_settings_management=true or project type doesn't require settings")
		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 = util.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 settings-directory .gitignore if it would be in top-level directory, where
		// there is almost certainly already a gitignore (like Backdrop)
		// Don't accidentally override the existing .ddev/.gitignore as well
		// TODO: we may want to append to .ddev/.gitignore if needed.
		if path.Dir(app.SiteSettingsPath) != app.AppRoot && path.Dir(app.SiteSettingsPath) != app.GetConfigPath("") && app.SiteDdevSettingsFile != "" {
			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)
			}