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 pvl.dns

    11

import sys

    12

    13

from pvl.hosts.host import Host

    14

    15

def optparser (parser):

    16

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

    17

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

    18

            help="Encoding used for host files")

    19

    20

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

    21

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

    22

    23

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

    24

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

    28

    29

    return hosts

    30

    31

class HostConfigError (Exception):

    32

    """

    33

        Generic error for file path.

    34

    """

    35

    36

    def __init__ (self, config, error):

    37

        self.config = config

    38

        self.error = error

    39

    40

    def __str__ (self):

    41

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

    42

    43

class HostConfigObjError (Exception):

    44

    """

    45

        An error from ConfigObj for a config file path.

    46

    """

    47

    48

    def __init__ (self, config, error):

    49

        self.config = config

    50

        self.error = error

    51

    52

        self.line_contents = error.line

    53

    54

    def __str__ (self):

    55

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

    56

    57

def parse_expand(name):

    58

    """

    59

        Parse a name containing an optional expansion part.

    60

    61

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

    62

    63

        Returns (name, range or None).

    64

    """

    65

    66

    if '{' in name:

    67

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

    68

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

    69

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

    70

    71

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

    72

        name = pre + "$" + post

    73

    74

        # TODO: raise HostConfigError

    75

        range = pvl.dns.parse_generate_range(range)

    76

    else:

    77

        range = None

    78

    79

    return name, range

    80

    81

def parse_config_field(field):

    82

    """

    83

        Parse structured config fields.

    84

    85

            [<extension> ":"] <field> ["." <instance>]

    86

    """

    87

    88

    if ':' in field :

    89

        extension, field = field.split(':', 1)

    90

    else:

    91

        extension = None

    92

    93

    if '.' in field :

    94

        field, instance = field.split('.')

    95

    else :

    96

        instance = None

    97

    98

    return extension, field, instance

    99

   100

def apply_host (name, domain, config):

   101

    """

   102

        Return Host from an (expanded) config section.

   103

   104

            name        - (expanded) name of host

   105

            domain      - domain for host

   106

            config      - host config fields to parse

   107

   108

        Fields can either be scalar string values, or instance'd dicts. If a field has both a non-instance'd value and instance'd values,

   109

        the non-instance'd value will be use instance=None:

   110

   111

        Raises ValueError.

   112

    """

   113

   114

    fields = { }

   115

    extensions = fields['extensions'] = { }

   116

   117

    for field, value in config.iteritems():

   118

        extension, field, instance = parse_config_field(field)

   119

   120

        if extension:

   121

            f = extensions.setdefault(extension, {})

   122

        else:

   123

            f = fields

   124

   125

        log.debug("%s@%s: %s:%s.%s = %r", name, domain, extension, field, instance, value)

   126

   127

        if instance:

   128

            if field not in f:

   129

                f[field] = { }

   130

            elif not isinstance(f[field], dict):

   131

                # convert to dict

   132

                f[field] = {None: f[field]}

   133

   134

            f[field][instance] = value

   135

        elif field in f:

   136

            f[field][None] = value

   137

        else:

   138

            f[field] = value

   139

   140

    return Host.build(name, domain, **fields)

   141

   142

def apply_hosts (parent, name, config):

   143

    """

   144

        Yield Hosts from a given config section.

   145

   146

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

   147

                          used for domain

   148

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

   149

                          used for hostname

   150

            config      - host parameters to parse

   151

   152

        Raises ValueError.

   153

    """

   154

   155

    if '@' in name:

   156

        name, domain = name.split('@', 1)

   157

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

   158

    elif '.' in name:

   159

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

   160

        domain = None

   161

    elif parent:

   162

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

   163

        domain = parent

   164

    else:

   165

        # XXX: impossible?

   166

        raise ValueError("no domain given")

   167

   168

    # expand?

   169

    name, range = parse_expand(name)

   170

   171

    if range:

   172

        generate_name = pvl.dns.parse_generate_field(name)

   173

   174

        # expand all fields

   175

        generate_config = {field: pvl.dns.parse_generate_field(value) for field, value in config.iteritems()}

   176

   177

        for i in range:

   178

            yield apply_host(generate_name(i), domain, 

   179

                    {field: value(i) for field, value in generate_config.iteritems()},

   180

            )

   181

   182

    else:

   183

        # single host

   184

        yield apply_host(name, domain, config)

   185

   186

def parse_config_includes (options, config_path, includes, **opts):

   187

    """

   188

        Yield file paths from a given config's include=... value

   189

    """

   190

   191

    # relative

   192

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

   193

   194

    if options.hosts_include:

   195

        include_paths.append(options.hosts_include)

   196

   197

    for include in includes:

   198

        for include_path in include_paths:

   199

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

   200

   201

            if os.path.exists(path):

   202

                break

   203

        else:

   204

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

   205

                    include=include,

   206

                    include_path=' '.join(include_paths),

   207

            ))

   208

   209

   210

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

   211

        yield path

   212

   214

    """

   215

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

   216

   217

            options         global options

   218

            path            filesystem path of file (for errors)

   219

            name            name of this section/file

   220

            config          configobj.Section

   221

            parent          parent section from included files or --hosts-domain

   222

            defaults        hierarchial section defaults

   224

    """

   225

   226

    # items in this section

   227

    section = dict(defaults)

   228

    for scalar in config.scalars:

   229

        section[scalar] = config[scalar]

   230

   231

    # process includes?

   232

    if 'include' in section:

   235

   236

        includes = list(parse_config_includes(options, path, includes))

   237

   238

        # within our domain context

   242

            yield host

   243

    else:

   244

        includes = None

   245

   246

    if config.sections:

   247

        # this is a top-level section that includes hosts

   248

        if parent:

   249

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

   250

   251

            name = pvl.dns.join(name, parent)

   252

        else:

   253

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

   254

   255

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

   256

        for section_name in config.sections:

   257

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

   258

   259

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

   260

                yield host

   261

   262

    elif includes:

   263

        # includes-only zone

   264

        pass

   265

   266

    elif parent:

   267

        # this is a host section

   268

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

   269

   270

        try:

   271

            for host in apply_hosts(parent, name, section):

   272

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

   273

   274

                yield host

   275

   276

        except ValueError as error:

   277

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

   278

   279

            raise HostConfigError(path, "{parent}: {name}: {error}".format(parent=parent, name=name, error=error))

   280

   281

    elif section:

   282

        raise HostConfigError(path, "Top-level hosts are only allowed in included confs")

   283

   284

    else:

   285

        # empty file

   286

        log.info("%s: skip empty conf", path)

   287

   288

def apply_hosts_config (options, file, **opts):

   289

    """

   290

        Load Hosts from a file path.

   291

   292

            file            - opened file object, with .name attribute

   293

   294

        Raises

   295

            HostConfigError

   296

            HostConfigObjError

   297

    """

   298

   299

    # use file basename as default domain

   300

    path = file.name

   301

    name = os.path.basename(path)

   302

   303

    try:

   304

        config = configobj.ConfigObj(file,

   305

                raise_errors    = True, # raise ConfigPObjError immediately

   306

                interpolation   = 'Template',

   307

                encoding        = options.hosts_charset,

   308

        )

   309

    except configobj.ConfigObjError as ex:

   310

        raise HostConfigObjError(path, ex)

   311

   312

    return apply_hosts_configs(options, path, name, config, **opts)

   313

   315

    """

   316

        Load Hosts from a file path.

   319

    """

   324

   325

    try:

   326

        file = open(path)

   327

    except IOError as ex:

   328

        raise HostConfigError(path, ex.strerror)

   329

   331

        yield host

   332

   334

    """

   335

        Load Hosts from a directory, loading each file within the directory.

   336

   339

        Skips .dotfiles.

   340

    """

   341

   346

    for name in sorted(os.listdir(root)):

   347

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

   348

   349

        if name.startswith('.'):

   350

            log.debug("%s: skip dotfile: %s", root, name)

   351

            continue

   352

   353

        if os.path.isdir(path):

   354

            log.debug("%s: skip directory: %s", root, name)

   355

            continue

   356

   358

            yield host

   359

   360

def apply_hosts_files (options, files, **opts):

   361

    """

   362

        Load Hosts from files.

   363

   364

            files:[str]     list of filesystem paths, which may be directories or files

   365

    """

   366

   367

    for path in files:

   368

        if os.path.isdir(path):

   369

            for host in apply_hosts_directory(options, path, **opts):

   370

                yield host

   371

        else:

   372

            for host in apply_hosts_file(options, path, **opts):

   373

                yield host

   374

   375

def apply (options, args):

   376

    """

   377

        Load Hosts from arguments.

   378

   379

        Exits with status=2 if loading the confs fails.

   380

    """

   387

   388

    try:

   389

        # load hosts from configs

   391

    except HostConfigObjError as error:

   392

        log.error("%s", error)

   393

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

   394

        sys.exit(2)

   395

   396

    except HostConfigError as error:

   397

        log.error("%s", error)

   398

        sys.exit(2)

   404

   405

    # stable ordering

   406

    return sorted(hosts, key=Host.sort_key)

   407