4 # Copyright (C) 2006, 2007, 2010, 2011 Google Inc.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 """Utility functions for manipulating /etc/hosts.
25 from cStringIO import StringIO
27 from ganeti import pathutils
29 from ganeti.utils import algo
30 from ganeti.utils import io
33 def SetEtcHostsEntry(file_name, ip, hostname, aliases):
34 """Sets the name of an IP address and hostname in /etc/hosts.
37 @param file_name: path to the file to modify (usually C{/etc/hosts})
39 @param ip: the IP address
41 @param hostname: the hostname to be added
43 @param aliases: the list of aliases to add for the hostname
46 # Ensure aliases are unique
47 names = algo.UniqueSequence([hostname] + aliases)
51 def _write_entry(written):
53 out.write("%s\t%s\n" % (ip, " ".join(names)))
57 for line in io.ReadFile(file_name).splitlines(True):
59 if fields and not fields[0].startswith("#") and ip == fields[0]:
60 written = _write_entry(written)
65 io.WriteFile(file_name, data=out.getvalue(), uid=0, gid=0, mode=0644,
66 keep_perms=io.KP_IF_EXISTS)
69 def AddHostToEtcHosts(hostname, ip):
70 """Wrapper around SetEtcHostsEntry.
73 @param hostname: a hostname that will be resolved and added to
74 L{pathutils.ETC_HOSTS}
76 @param ip: The ip address of the host
79 SetEtcHostsEntry(pathutils.ETC_HOSTS, ip, hostname, [hostname.split(".")[0]])
82 def RemoveEtcHostsEntry(file_name, hostname):
83 """Removes a hostname from /etc/hosts.
85 IP addresses without names are removed from the file.
88 @param file_name: path to the file to modify (usually C{/etc/hosts})
90 @param hostname: the hostname to be removed
95 for line in io.ReadFile(file_name).splitlines(True):
97 if len(fields) > 1 and not fields[0].startswith("#"):
100 while hostname in names:
101 names.remove(hostname)
103 out.write("%s %s\n" % (fields[0], " ".join(names)))
108 io.WriteFile(file_name, data=out.getvalue(), uid=0, gid=0, mode=0644,
109 keep_perms=io.KP_IF_EXISTS)
112 def RemoveHostFromEtcHosts(hostname):
113 """Wrapper around RemoveEtcHostsEntry.
116 @param hostname: hostname that will be resolved and its
117 full and shot name will be removed from
118 L{pathutils.ETC_HOSTS}
121 RemoveEtcHostsEntry(pathutils.ETC_HOSTS, hostname)
122 RemoveEtcHostsEntry(pathutils.ETC_HOSTS, hostname.split(".")[0])