1

"""

     2

    Host definitions.

     3

"""

     4

     5

import pvl.args

     6

import pvl.dns.zone

     7

     8

import configobj

     9

import ipaddr

    10

import optparse

    11

    12

def optparser (parser) :

    13

    hosts = optparse.OptionGroup(parser, "Hosts input")

    14

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

    15

            help="Encoding used for host files")

    16

    17

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

    18

            help="Default domain for hosts")

    19

    20

    return hosts

    21

    22

class Host (object) :

    23

    @classmethod

    24

    def expand (cls, options, host, range, ip, **opts) :

    25

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

    26

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

    27

    28

        for i in range :

    29

            yield cls.build(options, host(i),

    30

                    ip  = ip(i),

    31

                    **opts

    32

            )

    33

    34

    @classmethod

    35

    def config (cls, options, host, ip=None, **extra) :

    36

        """

    37

            Yield Hosts from a config section's scalars.

    38

        """

    39

    40

        if '{' in host :

    41

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

    42

            range, post = host.rsplit('}', 1)

    43

    44

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

    45

            host = pre + "$" + post

    46

    47

            for host in cls.expand(options, host, range, ip, **extra) :

    48

                yield host

    49

        else :

    50

            yield cls.build(options, host, ip=ip, **extra)

    51

    52

    @classmethod

    53

    def build (cls, options, host, domain=None, ip=None, ip6=None, owner=None, boot=None, **extra) :

    54

        """

    55

            Return a Host from a config section's scalars.

    56

        """

    57

    58

        ethernet = []

    59

        alias = []

    60

    61

        for attr, value in extra.iteritems() :

    62

            if attr.startswith('ethernet') :

    63

                ethernet.append(value)

    64

            elif attr.startswith('alias') :

    65

                alias.append(value)

    66

            else :

    67

                raise ValueError("Unknown host attr: %s=%s" % (attr, value))

    68

    69

        if domain is None :

    70

            domain = options.hosts_domain

    71

    72

        return cls(host,

    73

                domain      = domain,

    74

                ip          = ipaddr.IPv4Address(ip) if ip else None,

    75

                ip6         = ipaddr.IPv6Address(ip6) if ip6 else None,

    76

                ethernet    = ethernet,

    77

                alias       = alias,

    78

                owner       = owner,

    79

                boot        = boot,

    80

        )

    81

    82

    def __init__ (self, host, domain=None, ip=None, ip6=None, ethernet=(), alias=(), owner=None, boot=None) :

    83

        """

    84

            host        - str

    85

            domain      - str

    86

            ip          - ipaddr.IPv4Address

    87

            ip6         - ipaddr.IPv6Address

    88

            ethernet    - list

    89

            alias       - list

    90

            owner       - str: LDAP uid

    91

        """

    92

        self.host = host

    93

        self.domain = domain

    94

        self.ip = ip

    95

        self.ip6 = ip6

    96

        self.ethernet = ethernet

    97

        self.alias = alias

    98

        self.owner = owner

    99

        self.boot = boot

   100

   101

    def __str__ (self) :

   102

        return str(self.host)

   103

   104

def apply_hosts_file (options, file) :

   105

    """

   106

        Load Hosts from a file.

   107

    """

   108

    config = configobj.ConfigObj(file,

   109

            encoding    = options.hosts_charset,

   110

    )

   111

   112

    for name in config.sections :

   113

        for host in Host.config(options, name, **config[name]) :

   114

            yield host

   115

   116

def apply_hosts (options, files) :

   117

    """

   118

        Load Hosts from files.

   119

    """

   120

   121

    for file in files :

   122

        for host in apply_hosts_file(options, file) :

   123

            yield host

   124

   125

def sort_hosts (options, hosts) :

   126

    """

   127

        Yields hosts with a sorting key.

   128

    """

   129

   130

    for host in hosts :

   131

        if host.ip :

   132

            sort = host.ip

   133

        else :

   134

            # sorts first

   135

            sort = ipaddr.IPAddress(0)

   136

   137

        yield sort, host

   138

   139

def apply (options, args) :

   140

    """

   141

        Load Hosts from arguments.

   142

    """

   143

   144

    # without unicode

   145

    files = pvl.args.apply_files(args, 'r')

   146

   147

    # load configs

   148

    hosts = apply_hosts(options, files)

   149

   150

    # sort

   151

    hosts = list(sort_hosts(options, hosts))

   152

    hosts.sort()

   153

    hosts = [host for sort, host in hosts]

   154

   155

    return hosts