conf/get.go

package conf

import (
	"os"
	"strings"
	"strconv"
)

// GetSections returns the list of sections in the configuration.
// (The default section always exists.)
func (c *ConfigFile) GetSections() (sections []string) {
	sections = make([]string, len(c.data));

	i := 0;
	for s, _ := range c.data {
		sections[i] = s;
		i++;
	}

	return sections;
}

// HasSection checks if the configuration has the given section.
// (The default section always exists.)
func (c *ConfigFile) HasSection(section string) bool {
	_, ok := c.data[strings.ToLower(section)];

	return ok;
}


// GetOptions returns the list of options available in the given section.
// It returns an error if the section does not exist and an empty list if the section is empty.
// Options within the default section are also included.
func (c *ConfigFile) GetOptions(section string) (options []string, err os.Error) {
	section = strings.ToLower(section);

	if _, ok := c.data[section]; !ok {
		return nil, GetError{SectionNotFound, "", "", section, ""}
	}

	options = make([]string, len(c.data[DefaultSection])+len(c.data[section]));
	i := 0;
	for s, _ := range c.data[DefaultSection] {
		options[i] = s;
		i++;
	}
	for s, _ := range c.data[section] {
		options[i] = s;
		i++;
	}

	return options, nil;
}


// HasOption checks if the configuration has the given option in the section.
// It returns false if either the option or section do not exist.
func (c *ConfigFile) HasOption(section string, option string) bool {
	section = strings.ToLower(section);
	option = strings.ToLower(option);

	if _, ok := c.data[section]; !ok {
		return false
	}

	_, okd := c.data[DefaultSection][option];
	_, oknd := c.data[section][option];

	return okd || oknd;
}


// GetRawString gets the (raw) string value for the given option in the section.
// The raw string value is not subjected to unfolding, which was illustrated in the beginning of this documentation.
// It returns an error if either the section or the option do not exist.
func (c *ConfigFile) GetRawString(section string, option string) (value string, err os.Error) {
	section = strings.ToLower(section);
	option = strings.ToLower(option);

	if _, ok := c.data[section]; ok {
		if value, ok = c.data[section][option]; ok {
			return value, nil
		}
		return "", GetError{OptionNotFound, "", "", section, option};
	}
	return "", GetError{SectionNotFound, "", "", section, option};
}


// GetString gets the string value for the given option in the section.
// If the value needs to be unfolded (see e.g. %(host)s example in the beginning of this documentation),
// then GetString does this unfolding automatically, up to DepthValues number of iterations.
// It returns an error if either the section or the option do not exist, or the unfolding cycled.
func (c *ConfigFile) GetString(section string, option string) (value string, err os.Error) {
	value, err = c.GetRawString(section, option);
	if err != nil {
		return "", err
	}

	section = strings.ToLower(section);

	var i int;

	for i = 0; i < DepthValues; i++ {	// keep a sane depth
		vr := varRegExp.ExecuteString(value);
		if len(vr) == 0 {
			break
		}

		noption := value[vr[2]:vr[3]];
		noption = strings.ToLower(noption);

		nvalue, _ := c.data[DefaultSection][noption];	// search variable in default section
		if _, ok := c.data[section][noption]; ok {
			nvalue = c.data[section][noption]
		}
		if nvalue == "" {
			return "", GetError{OptionNotFound, "", "", section, option}
		}

		// substitute by new value and take off leading '%(' and trailing ')s'
		value = value[0:vr[2]-2] + nvalue + value[vr[3]+2:];
	}

	if i == DepthValues {
		return "", GetError{MaxDepthReached, "", "", section, option}
	}

	return value, nil;
}


// GetInt has the same behaviour as GetString but converts the response to int.
func (c *ConfigFile) GetInt(section string, option string) (value int, err os.Error) {
	sv, err := c.GetString(section, option);
	if err == nil {
		value, err = strconv.Atoi(sv)
		if err != nil {
			err = GetError{CouldNotParse, "int", sv, section, option}
		}
	}

	return value, err;
}


// GetFloat has the same behaviour as GetString but converts the response to float.
func (c *ConfigFile) GetFloat(section string, option string) (value float, err os.Error) {
	sv, err := c.GetString(section, option);
	if err == nil {
		value, err = strconv.Atof(sv)
		if err != nil {
			err = GetError{CouldNotParse, "float", sv, section, option}
		}
	}

	return value, err;
}


// GetBool has the same behaviour as GetString but converts the response to bool.
// See constant BoolStrings for string values converted to bool.
func (c *ConfigFile) GetBool(section string, option string) (value bool, err os.Error) {
	sv, err := c.GetString(section, option);
	if err != nil {
		return false, err
	}

	value, ok := BoolStrings[strings.ToLower(sv)];
	if !ok {
		return false, GetError{CouldNotParse, "bool", sv, section, option}
	}

	return value, nil;
}