blob: 77e200bc7496cd1d3552045006fbc5c90c130195 [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 Solomin62b55f32016-10-13 10:40:27 -050044 mapper = obmc.mapper.Mapper(bus)
Sergey Solomin4a2433f2016-10-03 10:22:57 -050045 allobjects = {}
Sergey Solomin62b55f32016-10-13 10:40:27 -050046 queries = {}
Sergey Solomin4a2433f2016-10-03 10:22:57 -050047 for compound_key, val in walk_nest(settings):
48 obj_name = compound_key[0].lower()
49 obj_name = obj_name.replace(".","/")
50 obj_name = "/" + obj_name + "0"
51
Sergey Solomin62b55f32016-10-13 10:40:27 -050052 for i in compound_key[2:len(compound_key)-2]:
Sergey Solomin4a2433f2016-10-03 10:22:57 -050053 obj_name = obj_name + "/" + i
54
55 setting = compound_key[len(compound_key) - 2]
56 attribute = compound_key[len(compound_key) - 1]
Sergey Solomin62b55f32016-10-13 10:40:27 -050057 if settings.get(compound_key[0], {}).get('query', {}):
58 q = queries.setdefault(obj_name, {})
59 s = q.setdefault(
60 setting, {'name': None, 'type': None, 'default': None})
61 else:
62 o = allobjects.setdefault(obj_name, {})
63 s = o.setdefault(
64 setting, {'name': None, 'type': None, 'default': None})
Sergey Solomin4a2433f2016-10-03 10:22:57 -050065 s[attribute] = val
Sergey Solomin62b55f32016-10-13 10:40:27 -050066 for settings in queries.itervalues():
67 for setting in settings.itervalues():
68 if setting['type'] is not 'instance_query':
69 continue
70 paths = mapper.get_subtree_paths(setting['subtree'], 0)
71 for path in paths:
72 m = re.search(setting['matchregex'], path)
73 if not m:
74 continue
75 allobjects.setdefault(
76 "/org/openbmc/settings/" + m.group(1), settings)
Sergey Solomin4a2433f2016-10-03 10:22:57 -050077 return allobjects
Brad Bishop2a9fe662016-08-31 12:37:35 -040078
Brad Bishop5ef7fe62016-05-17 08:39:17 -040079class HostSettingsObject(DbusProperties):
Adriana Kobylak41a925e2016-01-28 16:44:27 -060080 def __init__(self, bus, name, settings, path):
Brad Bishopc1e5e9f2016-09-29 09:40:01 -040081 super(HostSettingsObject, self).__init__(
82 conn=bus,
83 object_path=name,
84 validator=self.input_validator)
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +053085 self.bus = bus
Adriana Kobylak41a925e2016-01-28 16:44:27 -060086 self.path = path
Sergey Solomin4a2433f2016-10-03 10:22:57 -050087 self.name = name
88 self.settings = settings
Sergey Solomin62b55f32016-10-13 10:40:27 -050089 fname = name[name.rfind("/")+1:] + '-'
Sergey Solomin4a2433f2016-10-03 10:22:57 -050090
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +053091 # Needed to ignore the validation on default networkconfig values as
92 # opposed to user giving the same.
93 self.adminmode = True
94
Adriana Kobylak41a925e2016-01-28 16:44:27 -060095 if not os.path.exists(path):
96 os.mkdir(path)
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -060097
98 # Listen to changes in the property values and sync them to the BMC
Brad Bishop2a9fe662016-08-31 12:37:35 -040099 bus.add_signal_receiver(
100 self.settings_signal_handler,
101 dbus_interface="org.freedesktop.DBus.Properties",
102 signal_name="PropertiesChanged",
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500103 path=name)
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600104
105 # Create the dbus properties
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500106 for setting in settings.itervalues():
Sergey Solomin62b55f32016-10-13 10:40:27 -0500107 if setting['type'] is 'instance_query':
108 continue
109 self.set_settings_property(
110 setting['name'], setting['type'], setting['default'], fname)
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530111 # Done with consuming factory settings.
112 self.adminmode = False
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600113
Sergey Solomin62b55f32016-10-13 10:40:27 -0500114 def get_bmc_value(self, name, fname):
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600115 try:
Sergey Solomin62b55f32016-10-13 10:40:27 -0500116 with open(path.join(self.path, fname + name), 'r') as f:
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600117 return f.read()
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600118 except (IOError):
119 pass
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600120 return None
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600121
Brad Bishop2a9fe662016-08-31 12:37:35 -0400122 # Create dbus properties based on bmc value.
123 # This will be either a value previously set,
124 # or the default file value if the BMC value
125 # does not exist.
Sergey Solomin62b55f32016-10-13 10:40:27 -0500126 def set_settings_property(self, attr_name, attr_type, value, fname):
127 bmcv = self.get_bmc_value(attr_name, fname)
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600128 if bmcv:
129 value = bmcv
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500130 if attr_type == "i":
131 self.Set(DBUS_NAME, attr_name, int(value))
132 elif attr_type == "s":
133 self.Set(DBUS_NAME, attr_name, str(value))
134 elif attr_type == "b":
135 self.Set(DBUS_NAME, attr_name, bool(value))
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600136
137 # Save the settings to the BMC. This will write the settings value in
138 # individual files named by the property name to the BMC.
Sergey Solomin62b55f32016-10-13 10:40:27 -0500139 def set_system_settings(self, name, value, fname):
140 bmcv = self.get_bmc_value(name, fname)
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600141 if bmcv != value:
Sergey Solomin62b55f32016-10-13 10:40:27 -0500142 filepath = path.join(self.path, fname + name)
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600143 with open(filepath, 'w') as f:
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600144 f.write(str(value))
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600145
146 # Signal handler for when one ore more settings properties were updated.
147 # This will sync the changes to the BMC.
Brad Bishop2a9fe662016-08-31 12:37:35 -0400148 def settings_signal_handler(
Sergey Solomin62b55f32016-10-13 10:40:27 -0500149 self, interface_name, changed_properties, invalidated_properties,
150 fname):
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600151 for name, value in changed_properties.items():
Sergey Solomin62b55f32016-10-13 10:40:27 -0500152 self.set_system_settings(name, value, fname)
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600153
154 # Placeholder signal. Needed to register the settings interface.
Adriana Kobylak41a925e2016-01-28 16:44:27 -0600155 @dbus.service.signal(DBUS_NAME, signature='s')
156 def SettingsUpdated(self, sname):
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600157 pass
158
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530159 def validate_regex(self, regex, value):
160 if not re.compile(regex).search(value):
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400161 raise ValueError("Invalid input. Data does not satisfy regex")
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530162
163 def validate_range(self, min, max, value):
164 if value not in range(min, max):
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400165 raise ValueError("Invalid input. Data not in allowed range")
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530166
167 def validate_list_ignore_case(self, lst, value):
168 if value.lower() not in map(lambda val: val.lower(), lst):
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400169 raise ValueError("Invalid input. Data not in allowed values")
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530170
171 # validate host network configuration
172 # need "ipaddress=,prefix=,gateway=,mac=,addr_type="
173 # Must be able to handle any order
174 def validate_net_config(self, value):
175 if self.adminmode:
176 return
177
178 # Need all of these to be given by the user.
179 user_config = []
180 all_config = ['ipaddress', 'prefix', 'gateway', 'mac', 'addr_type']
181
182 # This has a hard data format mentioned above so no blanks allowed.
183 if value.count(" ") or value.count("=") != 5:
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400184 raise ValueError("Invalid Network Data. No white spaces allowed")
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530185
186 config = value.split(',')
187 for key_value in config:
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400188 key, value = key_value.split('=')
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530189 if not key or not value:
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400190 raise ValueError("Invalid key or Data")
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530191
192 # Add the current key seen so we can compare at the end to see
193 # if all values have been given
194 user_config.append(key.lower())
195
196 if key.lower() == 'ipaddress' or key.lower() == 'gateway':
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400197 IP(value)
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530198
199 elif key.lower() == 'mac':
200 regex = '([a-fA-F0-9]{2}[:|\-]?){6}'
201 self.validate_regex(regex, value)
202
203 elif key.lower() == 'prefix':
204 self.validate_range(0, 33, int(value))
205
206 elif key.lower() == 'addr_type':
207 allowed = ["STATIC", "DYNAMIC"]
208 self.validate_list_ignore_case(allowed, value)
209
210 # Did user pass everything ??
211 if set(all_config) - set(user_config):
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400212 raise ValueError(
213 "Invalid Network Data. All information is mandatory")
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530214
215 # Validate to see if the changes are in order
216 def input_validator(self, iface, proprty, value):
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530217 # User entered key is not present
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500218 shk = None
219 for attr in self.settings.itervalues():
220 if attr['name'] == proprty:
221 shk = attr
222
223 if shk is None:
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400224 raise KeyError("Invalid Property")
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530225
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500226 validation = shk.get('validation', None)
227
228 if validation == 'list':
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530229 self.validate_list_ignore_case(shk['allowed'], value)
230
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500231 elif validation == 'range':
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530232 self.validate_range(shk['min'], shk['max']+1, value)
233
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500234 elif validation == 'regex':
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530235 self.validate_regex(shk['regex'], value)
236
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500237 elif validation == 'custom':
Brad Bishopc1e5e9f2016-09-29 09:40:01 -0400238 getattr(self, shk['method'])(value)
Vishwanatha Subbanna5b090c62016-09-21 15:49:26 +0530239
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600240if __name__ == '__main__':
241 dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)
242
Brad Bishop5ef7fe62016-05-17 08:39:17 -0400243 bus = get_dbus()
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500244 allobjects = create_object(s.SETTINGS)
245 lastobject = None
246 objs = []
247 for o, settings in allobjects.iteritems():
248 objs.append(HostSettingsObject(bus, o, settings, "/var/lib/obmc/"))
249 objs[-1].unmask_signals()
Sergey Solomin4a2433f2016-10-03 10:22:57 -0500250 mainloop = gobject.MainLoop()
Brad Bishop2cbef3d2016-08-31 12:40:13 -0400251 name = dbus.service.BusName(DBUS_NAME, bus)
Adriana Kobylak4c60e5e2016-01-10 15:22:45 -0600252 print "Running HostSettingsService"
253 mainloop.run()
Brad Bishop31c42f02016-09-29 09:35:32 -0400254
255# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4