File: addr_ip_from_cmd.py

package info (click to toggle)
ddupdate 0.7.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 420 kB
  • sloc: python: 1,899; sh: 38; makefile: 35
file content (59 lines) | stat: -rw-r--r-- 1,691 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
"""
ddupdate plugin supporting getting ip address from a command.

See: ddupdate(8)

"""

import re
import subprocess

from ddupdate.ddplugin import \
    AddressPlugin, AddressError, IpAddr, dict_of_opts


class IpFromCmdPlugin(AddressPlugin):
    """
    Use ip4 address obtained from a command.

    The command is invoked without parameters, and should return one or
    two space-separated words on stdout. Each word must either a valid
    ipv4 or ipv6 address. Anything which is not parsed as addresses
    is treated as an error message.

    Note that when invoked in a systemd context, the environment
    for the command is more or less empty.

    The command invoked is specified in the cmd option

    Options:
        cmd=command

    netrc:
        Nothing
    """

    _name = 'ip-from-command'
    _oneliner = 'Obtain address from a command'

    def get_ip(self, log, options):
        """Implement AddressPlugin.get_ip()."""
        opts = dict_of_opts(options)
        if 'cmd' not in opts:
            raise AddressError('Required option cmd= missing, giving up.')
        cmd = opts['cmd']
        log.debug('Running: %s', cmd)
        addr = IpAddr()
        result = subprocess.getoutput(cmd).strip()
        log.debug('result: %s', result)
        pat = re.compile(r'\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}')
        pat6 = re.compile(r'[:0-9a-f]{12,}(\s|\Z)')
        for word in result.split():
            if pat.fullmatch(word):
                addr.v4 = word
            elif pat6.fullmatch(word):
                addr.v6 = word
            else:
                raise AddressError(
                    'Cannot parse command output: ' + result)
        return addr