samba python libs: convert 'except X, (tuple)' to 'except X as e'
[samba.git] / python / samba / subnets.py
1 # Add/remove subnets to sites.
2 #
3 # Copyright (C) Catalyst.Net Ltd 2015
4 # Copyright Matthieu Patou <mat@matws.net> 2011
5 #
6 # Catalyst.Net's contribution was written by Douglas Bagnall
7 # <douglas.bagnall@catalyst.net.nz>.
8 #
9 # This program is free software; you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License
20 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
21 #
22
23 import ldb
24 from ldb import FLAG_MOD_ADD, FLAG_MOD_REPLACE, LdbError
25 from sites import SiteNotFoundException
26
27 class SubnetException(Exception):
28     """Base element for Subnet errors"""
29     pass
30
31
32 class SubnetNotFound(SubnetException):
33     """The subnet requested does not exist."""
34     pass
35
36
37 class SubnetAlreadyExists(SubnetException):
38     """The subnet being added already exists."""
39     pass
40
41
42 class SubnetInvalid(SubnetException):
43     """The subnet CIDR is invalid."""
44     pass
45
46
47 class SiteNotFound(SubnetException):
48     """The site to be used for the subnet does not exist."""
49     pass
50
51
52 def create_subnet(samdb, configDn, subnet_name, site_name):
53     """Create a subnet and associate it with a site.
54
55     :param samdb: A samdb connection
56     :param configDn: The DN of the configuration partition
57     :param subnet_name: name of the subnet to create (a CIDR range)
58     :return: None
59     :raise SubnetAlreadyExists: if the subnet to be created already exists.
60     :raise SiteNotFound: if the site does not exist.
61     """
62     ret = samdb.search(base=configDn, scope=ldb.SCOPE_SUBTREE,
63                        expression='(&(objectclass=Site)(cn=%s))' %
64                        ldb.binary_encode(site_name))
65     if len(ret) != 1:
66         raise SiteNotFound('A site with the name %s does not exist' %
67                            site_name)
68     dn_site = ret[0].dn
69
70     if not isinstance(subnet_name, str):
71         raise SubnetInvalid("%s is not a valid subnet (not a string)" % subnet_name)
72
73     dnsubnet = ldb.Dn(samdb, "CN=Subnets,CN=Sites")
74     if dnsubnet.add_base(configDn) == False:
75         raise SubnetException("dnsubnet.add_base() failed")
76     if dnsubnet.add_child("CN=X") == False:
77         raise SubnetException("dnsubnet.add_child() failed")
78     dnsubnet.set_component(0, "CN", subnet_name)
79
80     try:
81         m = ldb.Message()
82         m.dn = dnsubnet
83         m["objectclass"] = ldb.MessageElement("subnet", FLAG_MOD_ADD,
84                                               "objectclass")
85         m["siteObject"] = ldb.MessageElement(str(dn_site), FLAG_MOD_ADD,
86                                              "siteObject")
87         samdb.add(m)
88     except ldb.LdbError as e:
89         (enum, estr) = e.args
90         if enum == ldb.ERR_INVALID_DN_SYNTAX:
91             raise SubnetInvalid("%s is not a valid subnet: %s" % (subnet_name, estr))
92         elif enum == ldb.ERR_ENTRY_ALREADY_EXISTS:
93             # Subnet collisions are checked by exact match only, not
94             # overlapping range. This won't stop you creating
95             # 10.1.1.0/24 when there is already 10.1.0.0/16, or
96             # prevent you from having numerous IPv6 subnets that refer
97             # to the same range (e.g 5::0/16, 5::/16, 5:0:0::/16).
98             raise SubnetAlreadyExists('A subnet with the CIDR %s already exists'
99                                       % subnet_name)
100         else:
101             raise
102
103
104 def delete_subnet(samdb, configDn, subnet_name):
105     """Delete a subnet.
106
107     :param samdb: A samdb connection
108     :param configDn: The DN of the configuration partition
109     :param subnet_name: Name of the subnet to delete
110     :return: None
111     :raise SubnetNotFound: if the subnet to be deleted does not exist.
112     """
113     dnsubnet = ldb.Dn(samdb, "CN=Subnets,CN=Sites")
114     if dnsubnet.add_base(configDn) == False:
115         raise SubnetException("dnsubnet.add_base() failed")
116     if dnsubnet.add_child("CN=X") == False:
117         raise SubnetException("dnsubnet.add_child() failed")
118     dnsubnet.set_component(0, "CN", subnet_name)
119
120     try:
121         ret = samdb.search(base=dnsubnet, scope=ldb.SCOPE_BASE,
122                            expression="objectClass=subnet")
123         if len(ret) != 1:
124             raise SubnetNotFound('Subnet %s does not exist' % subnet_name)
125     except LdbError as e1:
126         (enum, estr) = e1.args
127         if enum == ldb.ERR_NO_SUCH_OBJECT:
128             raise SubnetNotFound('Subnet %s does not exist' % subnet_name)
129
130     samdb.delete(dnsubnet)
131
132 def rename_subnet(samdb, configDn, subnet_name, new_name):
133     """Rename a subnet.
134
135     :param samdb: A samdb connection
136     :param configDn: The DN of the configuration partition
137     :param subnet_name: Name of the subnet to rename
138     :param new_name: New name for the subnet
139     :return: None
140     :raise SubnetNotFound: if the subnet to be renamed does not exist.
141     :raise SubnetExists: if the subnet to be created already exists.
142     """
143     dnsubnet = ldb.Dn(samdb, "CN=Subnets,CN=Sites")
144     if dnsubnet.add_base(configDn) == False:
145         raise SubnetException("dnsubnet.add_base() failed")
146     if dnsubnet.add_child("CN=X") == False:
147         raise SubnetException("dnsubnet.add_child() failed")
148     dnsubnet.set_component(0, "CN", subnet_name)
149
150     newdnsubnet = ldb.Dn(samdb, str(dnsubnet))
151     newdnsubnet.set_component(0, "CN", new_name)
152     try:
153         samdb.rename(dnsubnet, newdnsubnet)
154     except LdbError as e2:
155         (enum, estr) = e2.args
156         if enum == ldb.ERR_NO_SUCH_OBJECT:
157             raise SubnetNotFound('Subnet %s does not exist' % subnet)
158         elif enum == ldb.ERR_ENTRY_ALREADY_EXISTS:
159             raise SubnetAlreadyExists('A subnet with the CIDR %s already exists'
160                                       % new_name)
161         elif enum == ldb.ERR_INVALID_DN_SYNTAX:
162             raise SubnetInvalid("%s is not a valid subnet: %s" % (new_name,
163                                                                   estr))
164         else:
165             raise
166
167 def set_subnet_site(samdb, configDn, subnet_name, site_name):
168     """Assign a subnet to a site.
169
170     This dissociates the subnet from its previous site.
171
172     :param samdb: A samdb connection
173     :param configDn: The DN of the configuration partition
174     :param subnet_name: Name of the subnet
175     :param site_name: Name of the site
176     :return: None
177     :raise SubnetNotFound: if the subnet does not exist.
178     :raise SiteNotFound: if the site does not exist.
179     """
180
181     dnsubnet = ldb.Dn(samdb, "CN=Subnets,CN=Sites")
182     if dnsubnet.add_base(configDn) == False:
183         raise SubnetException("dnsubnet.add_base() failed")
184     if dnsubnet.add_child("CN=X") == False:
185         raise SubnetException("dnsubnet.add_child() failed")
186     dnsubnet.set_component(0, "CN", subnet_name)
187
188     try:
189         ret = samdb.search(base=dnsubnet, scope=ldb.SCOPE_BASE,
190                            expression="objectClass=subnet")
191         if len(ret) != 1:
192             raise SubnetNotFound('Subnet %s does not exist' % subnet_name)
193     except LdbError as e3:
194         (enum, estr) = e3.args
195         if enum == ldb.ERR_NO_SUCH_OBJECT:
196             raise SubnetNotFound('Subnet %s does not exist' % subnet_name)
197
198     dnsite = ldb.Dn(samdb, "CN=Sites")
199     if dnsite.add_base(configDn) == False:
200         raise SubnetException("dnsites.add_base() failed")
201     if dnsite.add_child("CN=X") == False:
202         raise SubnetException("dnsites.add_child() failed")
203     dnsite.set_component(0, "CN", site_name)
204
205     dnservers = ldb.Dn(samdb, "CN=Servers")
206     dnservers.add_base(dnsite)
207
208     try:
209         ret = samdb.search(base=dnsite, scope=ldb.SCOPE_BASE,
210                            expression="objectClass=site")
211         if len(ret) != 1:
212             raise SiteNotFoundException('Site %s does not exist' % site_name)
213     except LdbError as e4:
214         (enum, estr) = e4.args
215         if enum == ldb.ERR_NO_SUCH_OBJECT:
216             raise SiteNotFoundException('Site %s does not exist' % site_name)
217
218     siteDn = str(ret[0].dn)
219
220     m = ldb.Message()
221     m.dn = dnsubnet
222     m["siteObject"] = ldb.MessageElement(siteDn, FLAG_MOD_REPLACE,
223                                          "siteObject")
224     samdb.modify(m)