Propellor.Property.ConfFile

Generic conffiles with sections

type SectionStart = Line -> Bool

find the line that is the start of the wanted section (eg, == "Foo")

type SectionPast = Line -> Bool

find a line that indicates we are past the section (eg, a new section header)

type AdjustSection = [Line] -> [Line]

run on all lines in the section, including the SectionStart line; can add, delete, and modify lines, or even delete entire section

type InsertSection = [Line] -> [Line]

if SectionStart does not find the section in the file, this is used to insert the section somewhere within it

adjustSection :: Desc -> SectionStart -> SectionPast -> AdjustSection -> InsertSection -> FilePath -> Property UnixLike

Adjusts a section of conffile.

Windows .ini files

type IniSection = String

Name of a section of an .ini file. This value is put in square braces to generate the section header.

type IniKey = String

Name of a configuration setting within a .ini file.

containsIniSetting :: FilePath -> (IniSection, IniKey, String) -> Property UnixLike

Ensures that a .ini file exists and contains a section with a key=value setting.

lacksIniSetting :: FilePath -> (IniSection, IniKey, String) -> Property UnixLike

Removes a key=value setting from a section of an .ini file. Note that the section heading is left in the file, so this is not a perfect reversion of containsIniSetting.

hasIniSection :: FilePath -> IniSection -> [(IniKey, String)] -> Property UnixLike

Ensures that a .ini file exists and contains a section with a given key=value list of settings.

lacksIniSection :: FilePath -> IniSection -> Property UnixLike

Ensures that a .ini file does not contain the specified section.

iniFileContains :: FilePath -> [(IniSection, [(IniKey, String)])] -> RevertableProperty UnixLike UnixLike

Specifies the whole content of a .ini file.

Revertijg this causes the file not to exist.

Conffiles that are actually shell scripts setting env vars

type ShellKey = String

Key for a shell conffile property. Conventionally uppercase letters and numbers with underscores for separators. See files in /etc/default.

containsShellSetting :: FilePath -> (ShellKey, String) -> Property UnixLike

Ensures a shell conffile (like those in /etc/default) exists and has a key=value pair.

Comments out any further settings of that key further down the file, to avoid those taking precedence.

lacksShellSetting :: FilePath -> (ShellKey, String) -> Property UnixLike

Comments out a key=value pair in a shell conffile.

Does not delete the file if empty, and does not uncomment any lines, so not a perfect reversion of containsShellSetting.