blob: 0205ea54c78cd3456f1bbb9add9cabf9d1f49b72 [file] [log] [blame]
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -06001#!/usr/bin/python -u
2
3import gobject
4import dbus
5import dbus.service
6import dbus.mainloop.glib
Adriana Kobylak41a925e2016-01-28 16:44:27 -06007import os
8import os.path as path
Adriana Kobylak256be782016-08-24 15:43:16 -05009import sys
Brad Bishop5ef7fe62016-05-17 08:39:17 -040010from obmc.dbuslib.bindings import DbusProperties, get_dbus
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +053011from IPy import IP
Adriana Kobylak256be782016-08-24 15:43:16 -050012
Brad Bishop966fcd52016-09-29 09:22:32 -040013settings_file_path = os.path.join(
14 sys.prefix,
15 'share',
16 'phosphor-settings')
Adriana Kobylak256be782016-08-24 15:43:16 -050017sys.path.insert(1, settings_file_path)
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -060018import settings_file as s
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +053019import re
Sergey Solomin62b55f32016-10-13 10:40:27 -050020import obmc.mapper
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -060021
22DBUS_NAME = 'org.openbmc.settings.Host'
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -060023CONTROL_INTF = 'org.openbmc.Settings'
24
Sergey Solomin4a2433f2016-10-03 10:22:57 -050025def walk_nest(d, keys =()):
26 """Arrange dictionary keys and values.
27
28 Walk the dictionary and establish every possible path
29 returned to and processed by 'create_object' below
30 """
31 if isinstance(d, dict):
32 for k, v in d.iteritems():
33 for rv in walk_nest(v, keys + (k, )):
34 yield rv
35 else:
36 yield keys, d
37
38def create_object(settings):
39 """Create and format objects.
40
Sergey Solomin62b55f32016-10-13 10:40:27 -050041 Parse dictionary file and return all objects and settings
42 in the following format: {obj_name {settings}}
Sergey Solomin4a2433f2016-10-03 10:22:57 -050043 """
Sergey Solominf68b8642016-11-14 16:26:17 -060044 bus = get_dbus()
Sergey Solomin62b55f32016-10-13 10:40:27 -050045 mapper = obmc.mapper.Mapper(bus)
Sergey Solomin4a2433f2016-10-03 10:22:57 -050046 allobjects = {}
Sergey Solomin62b55f32016-10-13 10:40:27 -050047 queries = {}
Sergey Solomin4a2433f2016-10-03 10:22:57 -050048 for compound_key, val in walk_nest(settings):
49 obj_name = compound_key[0].lower()
50 obj_name = obj_name.replace(".","/")
51 obj_name = "/" + obj_name + "0"
52
Sergey Solomin62b55f32016-10-13 10:40:27 -050053 for i in compound_key[2:len(compound_key)-2]:
Sergey Solomin4a2433f2016-10-03 10:22:57 -050054 obj_name = obj_name + "/" + i
55
56 setting = compound_key[len(compound_key) - 2]
57 attribute = compound_key[len(compound_key) - 1]
Sergey Solomin62b55f32016-10-13 10:40:27 -050058 if settings.get(compound_key[0], {}).get('query', {}):
59 q = queries.setdefault(obj_name, {})
60 s = q.setdefault(
61 setting, {'name': None, 'type': None, 'default': None})
62 else:
63 o = allobjects.setdefault(obj_name, {})
64 s = o.setdefault(
65 setting, {'name': None, 'type': None, 'default': None})
Sergey Solomin4a2433f2016-10-03 10:22:57 -050066 s[attribute] = val
Sergey Solomin62b55f32016-10-13 10:40:27 -050067 for settings in queries.itervalues():
68 for setting in settings.itervalues():
69 if setting['type'] is not 'instance_query':
70 continue
71 paths = mapper.get_subtree_paths(setting['subtree'], 0)
Matt Spinler371dd022016-12-15 12:48:04 -060072
73 if setting['keyregex'] == 'host':
74 # Always create at least one host object.
75 paths = set(paths + ['/org/openbmc/control/host0'])
76
Sergey Solomin62b55f32016-10-13 10:40:27 -050077 for path in paths:
78 m = re.search(setting['matchregex'], path)
79 if not m:
80 continue
81 allobjects.setdefault(
82 "/org/openbmc/settings/" + m.group(1), settings)
Sergey Solomin4a2433f2016-10-03 10:22:57 -050083 return allobjects
Brad Bishop2a9fe662016-08-31 12:37:35 -040084
Brad Bishop5ef7fe62016-05-17 08:39:17 -040085class HostSettingsObject(DbusProperties):
Adriana Kobylak41a925e2016-01-28 16:44:27 -060086 def __init__(self, bus, name, settings, path):
Brad Bishopc1e5e9f2016-09-29 09:40:01 -040087 super(HostSettingsObject, self).__init__(
88 conn=bus,
89 object_path=name,
90 validator=self.input_validator)
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +053091 self.bus = bus
Adriana Kobylak41a925e2016-01-28 16:44:27 -060092 self.path = path
Sergey Solomin4a2433f2016-10-03 10:22:57 -050093 self.name = name
94 self.settings = settings
Yi Li5ebab482016-11-22 16:34:18 +080095 self.fname = name[name.rfind("/")+1:] + '-'
Sergey Solomin4a2433f2016-10-03 10:22:57 -050096
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +053097 # Needed to ignore the validation on default networkconfig values as
98 # opposed to user giving the same.
99 self.adminmode = True
100
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600101 if not os.path.exists(path):
102 os.mkdir(path)
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600103
104 # Listen to changes in the property values and sync them to the BMC
Brad Bishop2a9fe662016-08-31 12:37:35 -0400105 bus.add_signal_receiver(
106 self.settings_signal_handler,
107 dbus_interface="org.freedesktop.DBus.Properties",
108 signal_name="PropertiesChanged",
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500109 path=name)
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600110
111 # Create the dbus properties
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500112 for setting in settings.itervalues():
Sergey Solomin62b55f32016-10-13 10:40:27 -0500113 if setting['type'] is 'instance_query':
114 continue
115 self.set_settings_property(
Yi Li5ebab482016-11-22 16:34:18 +0800116 setting['name'], setting['type'], setting['default'],
117 self.fname)
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530118 # Done with consuming factory settings.
119 self.adminmode = False
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600120
Sergey Solomin62b55f32016-10-13 10:40:27 -0500121 def get_bmc_value(self, name, fname):
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600122 try:
Sergey Solomin62b55f32016-10-13 10:40:27 -0500123 with open(path.join(self.path, fname + name), 'r') as f:
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600124 return f.read()
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600125 except (IOError):
126 pass
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600127 return None
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600128
Brad Bishop2a9fe662016-08-31 12:37:35 -0400129 # Create dbus properties based on bmc value.
130 # This will be either a value previously set,
131 # or the default file value if the BMC value
132 # does not exist.
Sergey Solomin62b55f32016-10-13 10:40:27 -0500133 def set_settings_property(self, attr_name, attr_type, value, fname):
134 bmcv = self.get_bmc_value(attr_name, fname)
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600135 if bmcv:
136 value = bmcv
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500137 if attr_type == "i":
138 self.Set(DBUS_NAME, attr_name, int(value))
139 elif attr_type == "s":
140 self.Set(DBUS_NAME, attr_name, str(value))
141 elif attr_type == "b":
142 self.Set(DBUS_NAME, attr_name, bool(value))
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600143
144 # Save the settings to the BMC. This will write the settings value in
145 # individual files named by the property name to the BMC.
Sergey Solomin62b55f32016-10-13 10:40:27 -0500146 def set_system_settings(self, name, value, fname):
147 bmcv = self.get_bmc_value(name, fname)
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600148 if bmcv != value:
Sergey Solomin62b55f32016-10-13 10:40:27 -0500149 filepath = path.join(self.path, fname + name)
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600150 with open(filepath, 'w') as f:
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600151 f.write(str(value))
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600152
153 # Signal handler for when one ore more settings properties were updated.
154 # This will sync the changes to the BMC.
Brad Bishop2a9fe662016-08-31 12:37:35 -0400155 def settings_signal_handler(
Yi Li5ebab482016-11-22 16:34:18 +0800156 self, interface_name, changed_properties, invalidated_properties):
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600157 for name, value in changed_properties.items():
Yi Li5ebab482016-11-22 16:34:18 +0800158 self.set_system_settings(name, value, self.fname)
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600159
160 # Placeholder signal. Needed to register the settings interface.
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600161 @dbus.service.signal(DBUS_NAME, signature='s')
162 def SettingsUpdated(self, sname):
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600163 pass
164
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530165 def validate_regex(self, regex, value):
166 if not re.compile(regex).search(value):
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400167 raise ValueError("Invalid input. Data does not satisfy regex")
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530168
169 def validate_range(self, min, max, value):
170 if value not in range(min, max):
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400171 raise ValueError("Invalid input. Data not in allowed range")
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530172
173 def validate_list_ignore_case(self, lst, value):
174 if value.lower() not in map(lambda val: val.lower(), lst):
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400175 raise ValueError("Invalid input. Data not in allowed values")
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530176
177 # validate host network configuration
178 # need "ipaddress=,prefix=,gateway=,mac=,addr_type="
179 # Must be able to handle any order
180 def validate_net_config(self, value):
181 if self.adminmode:
182 return
183
184 # Need all of these to be given by the user.
185 user_config = []
186 all_config = ['ipaddress', 'prefix', 'gateway', 'mac', 'addr_type']
187
188 # This has a hard data format mentioned above so no blanks allowed.
189 if value.count(" ") or value.count("=") != 5:
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400190 raise ValueError("Invalid Network Data. No white spaces allowed")
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530191
192 config = value.split(',')
193 for key_value in config:
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400194 key, value = key_value.split('=')
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530195 if not key or not value:
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400196 raise ValueError("Invalid key or Data")
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530197
198 # Add the current key seen so we can compare at the end to see
199 # if all values have been given
200 user_config.append(key.lower())
201
202 if key.lower() == 'ipaddress' or key.lower() == 'gateway':
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400203 IP(value)
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530204
205 elif key.lower() == 'mac':
206 regex = '([a-fA-F0-9]{2}[:|\-]?){6}'
207 self.validate_regex(regex, value)
208
209 elif key.lower() == 'prefix':
210 self.validate_range(0, 33, int(value))
211
212 elif key.lower() == 'addr_type':
213 allowed = ["STATIC", "DYNAMIC"]
214 self.validate_list_ignore_case(allowed, value)
215
216 # Did user pass everything ??
217 if set(all_config) - set(user_config):
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400218 raise ValueError(
219 "Invalid Network Data. All information is mandatory")
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530220
221 # Validate to see if the changes are in order
222 def input_validator(self, iface, proprty, value):
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530223 # User entered key is not present
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500224 shk = None
225 for attr in self.settings.itervalues():
226 if attr['name'] == proprty:
227 shk = attr
228
229 if shk is None:
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400230 raise KeyError("Invalid Property")
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530231
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500232 validation = shk.get('validation', None)
233
234 if validation == 'list':
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530235 self.validate_list_ignore_case(shk['allowed'], value)
236
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500237 elif validation == 'range':
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530238 self.validate_range(shk['min'], shk['max']+1, value)
239
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500240 elif validation == 'regex':
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530241 self.validate_regex(shk['regex'], value)
242
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500243 elif validation == 'custom':
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400244 getattr(self, shk['method'])(value)
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530245
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600246if __name__ == '__main__':
247 dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)
248
Brad Bishop5ef7fe62016-05-17 08:39:17 -0400249 bus = get_dbus()
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500250 allobjects = create_object(s.SETTINGS)
251 lastobject = None
252 objs = []
253 for o, settings in allobjects.iteritems():
254 objs.append(HostSettingsObject(bus, o, settings, "/var/lib/obmc/"))
255 objs[-1].unmask_signals()
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500256 mainloop = gobject.MainLoop()
Brad Bishop2cbef3d2016-08-31 12:40:13 -0400257 name = dbus.service.BusName(DBUS_NAME, bus)
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600258 print "Running HostSettingsService"
259 mainloop.run()
Brad Bishop31c42f02016-09-29 09:35:32 -0400260
261# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4