1

"""

     2

    Load Hosts from config files.

     3

"""

     4

     5

import configobj

     6

import logging; log = logging.getLogger('pvl.hosts')

     7

import optparse

     8

import os.path

     9

import pvl.args

    10

import sys

    11

    12

from pvl.hosts.host import Host

    13

    14

def optparser (parser):

    15

    hosts = optparse.OptionGroup(parser, "Hosts config files")

    16

    hosts.add_option('--hosts-charset',         metavar='CHARSET',  default='utf-8', 

    17

            help="Encoding used for host files")

    18

    19

    hosts.add_option('--hosts-domain',          metavar='DOMAIN',

    20

            help="Default domain for hosts. Default uses config file basename")

    21

    22

    hosts.add_option('--hosts-include',         metavar='PATH',

    23

            help="Optional path for hosts includes, in addition to the host config dir")

    24

    25

    return hosts

    26

    27

class HostConfigError (Exception):

    28

    """

    29

        Generic error for file path.

    30

    """

    31

    32

    def __init__ (self, config, error):

    33

        self.config = config

    34

        self.error = error

    35

    36

    def __str__ (self):

    37

        return "{self.config}: {self.error}".format(self=self)        

    38

    39

class HostConfigObjError (Exception):

    40

    """

    41

        An error from ConfigObj for a config file path.

    42

    """

    43

    44

    def __init__ (self, config, error):

    45

        self.config = config

    46

        self.error = error

    47

    48

        self.line_contents = error.line

    49

    50

    def __str__ (self):

    51

        return "{self.config}:{self.error.line_number}: {self.error.message}".format(self=self)        

    52

    53

def apply_host_expand (options, range, name, domain, **params):

    54

    """

    55

        Expand a templated host item.

    56

    """

    57

    58

    name = pvl.dns.zone.parse_generate_field(name)

    59

    60

    # expand all fields

    61

    params = {param: pvl.dns.zone.parse_generate_field(value) for param, value in params.iteritems()}

    62

    63

    for i in range:

    64

        yield name(i), {param: value(i) for param, value in params.iteritems()}

    65

    66

def parse_expand(name):

    67

    """

    68

        Parse a name containing an optional expansion part.

    69

    70

            name:           hostname containing optional "{...}" part

    71

    72

        Returns (name, range or None).

    73

    """

    74

    75

    if '{' in name:

    76

        # consume the first {...} token as the range

    77

        pre, name = name.split('{', 1)

    78

        range, post = name.split('}', 1)

    79

    80

        # if there's a second {...} token, it will be re-composed into ${...}

    81

        name = pre + "$" + post

    82

    83

        # TODO: raise HostConfigError

    84

        range = pvl.dns.zone.parse_generate_range(range)

    85

    else:

    86

        range = None

    87

    88

    return name, range

    89

   135

def apply_host_config (options, parent, name,

   136

        domain=None,

   137

        **config

   138

):

   139

    """

   140

        Yield Hosts from a given config section.

   141

   142

            options     global options

   143

            parent      parent filename/section containing this host item, or None.

   144

                        used for domain

   145

            name        name of the section (or file) containing this host item.

   146

                        used for hostname

   147

            **config    host parameters

   148

    """

   149

   150

    if domain:

   151

        log.debug("%s: using explicit domain: %s", name, domain)

   152

    elif '.' in name:

   153

        log.debug("%s: using as fqdn without domain", name)

   154

        domain = None

   155

    elif parent:

   156

        log.debug("%s: default domain to section: %s", name, parent)

   157

        domain = parent

   158

    elif options.hosts_domain:

   159

        log.debug("%s: default domain to --hosts-domain: %s", name, options.hosts_domain)

   160

        domain = options.hosts_domain

   161

    else:

   162

        raise HostConfigError(None, "{name}: no domain given".format(name=name))

   163

   164

    # expand 

   165

    name, range = parse_expand(name)

   166

   167

    if range:

   168

        configs_iter = apply_host_expand(options, range, name, domain, **config)

   169

    else:

   170

        configs_iter = [(name, config)]

   171

   172

    for name, config in configs_iter:

   174

   175

def apply_host_includes (options, config_path, include):

   176

    """

   177

        Yield files from a given config's include=... value

   178

    """

   179

   180

    include_paths = [os.path.dirname(config_path)]

   181

   182

    if options.hosts_include:

   183

        include_paths.append[options.hosts_include]

   184

   185

    for include in include.split():

   186

        for include_path in include_paths:

   187

            path = os.path.join(include_path, include)

   188

            if os.path.exists(path):

   189

                break

   190

        else:

   191

            raise HostConfigError(config_path, "Unable to find include {include} in include path: {include_path}".format(

   192

                    include=include,

   193

                    include_path=' '.join(include_paths),

   194

            ))

   195

   196

        if include.endswith('/'):

   197

            for name in os.listdir(path):

   198

                file_path = os.path.join(path, name)

   199

   200

                if name.startswith('.'):

   201

                    pass

   202

                elif not os.path.exists(file_path):

   203

                    log.warn("%s: skip nonexistant include: %s", config_path, file_path)

   204

                else:

   205

                    log.info("%s: include: %s", config_path, file_path)

   206

                    yield open(file_path)

   207

   208

        else:

   209

            log.info("%s: include: %s", config_path, path)

   210

            yield open(path)

   211

   212

def apply_hosts_config (options, path, name, config, defaults={}, parent=None):

   213

    """

   214

        Load hosts from a configobj.Section (which can be the top-level ConfigObj).

   215

   216

            options         global options

   217

            path            filesystem path of file (for errors)

   218

            name            name of section/file

   219

            config          configobj.Section

   220

            defaults        hierarchial section defaults

   221

            parent          optional parent section for included files

   222

    """

   223

   224

    # items in this section

   225

    section = dict(defaults)

   226

    for scalar in config.scalars:

   227

        section[scalar] = config[scalar]

   228

   229

    if config.sections:

   230

        # this is a top-level section that includes hosts

   231

        log.info("%s: @%s", path, name)

   232

   233

        # process includes?

   234

        includes = section.pop('include', '')

   235

   236

        for file in apply_host_includes(options, path, includes):

   237

            # within our domain context

   238

            for host in apply_hosts_file(options, file, parent=name):

   239

                yield host

   240

   241

        # recurse until we hit a scalar-only section representing a host

   242

        for section_name in config.sections:

   243

            log.debug("%s: %s: %s", path, name, section_name)

   244

   245

            for host in apply_hosts_config(options, path, section_name, config[section_name], defaults=section, parent=name):

   246

                yield host

   247

   248

    elif parent:

   249

        # this is a host section

   250

        log.debug("%s: %s@%s", path, name, parent)

   251

   252

        try:

   253

            for host in apply_host_config(options, parent, name, **section):

   254

                log.info("%s: %s", path, host)

   255

   256

                yield host

   257

   258

        except HostConfigError as error:

   259

            # add in config path

   260

            error.config = path

   261

            raise

   262

   263

    else:

   264

        raise HostConfigError(path, "No sections in config")

   265

   266

def apply_hosts_file (options, file, parent=None):

   267

    """

   268

        Load Hosts from a file path.

   269

   270

            path:str        filesystem path

   271

            parent          included from given name

   272

   273

        Raises

   274

            HostConfigError

   275

            HostConfigObjError

   276

    """

   277

   278

    # use file basename as default domain

   279

    path = file.name

   280

    name = os.path.basename(path)

   281

   282

    try:

   283

        config = configobj.ConfigObj(file,

   284

                raise_errors    = True, # raise ConfigPObjError immediately

   285

                interpolation   = 'Template',

   286

                encoding        = options.hosts_charset,

   287

        )

   288

    except configobj.ConfigObjError as ex:

   289

        raise HostConfigObjError(path, ex)

   290

   291

    return apply_hosts_config(options, path, name, config, parent=parent)

   292

   293

def apply_hosts (options, files):

   294

    """

   295

        Load Hosts from files.

   296

   297

            files:[str]     list of filesystem paths

   298

    """

   299

   300

    for path in files:

   301

        try:

   302

            file = open(path)

   303

        except IOError as ex:

   304

            raise HostConfigError(path, ex.strerror)

   305

   306

        for host in apply_hosts_file(options, file):

   307

            yield host

   308

   309

def apply (options, args):

   310

    """

   311

        Load Hosts from arguments.

   312

    """

   313

   314

    try:

   315

        # load hosts from configs

   316

        hosts = list(apply_hosts(options, args))

   317

    except HostConfigObjError as error:

   318

        log.error("%s", error)

   319

        log.error("\t%s", error.line_contents)

   320

        sys.exit(2)

   321

   322

    except HostConfigError as error:

   323

        log.error("%s", error)

   324

        sys.exit(2)

   325

   326

    # stable ordering

   327

    hosts = sorted(hosts, key=Host.sort_key)

   328

   329

    return hosts