Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 1 | #!/usr/bin/python -u |
| 2 | |
| 3 | import gobject |
| 4 | import dbus |
| 5 | import dbus.service |
| 6 | import dbus.mainloop.glib |
Adriana Kobylak | 41a925e | 2016-01-28 16:44:27 -0600 | [diff] [blame] | 7 | import os |
| 8 | import os.path as path |
Adriana Kobylak | 256be78 | 2016-08-24 15:43:16 -0500 | [diff] [blame] | 9 | import sys |
Brad Bishop | 5ef7fe6 | 2016-05-17 08:39:17 -0400 | [diff] [blame] | 10 | from obmc.dbuslib.bindings import DbusProperties, get_dbus |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 11 | from IPy import IP |
Adriana Kobylak | 256be78 | 2016-08-24 15:43:16 -0500 | [diff] [blame] | 12 | |
Brad Bishop | 966fcd5 | 2016-09-29 09:22:32 -0400 | [diff] [blame] | 13 | settings_file_path = os.path.join( |
| 14 | sys.prefix, |
| 15 | 'share', |
| 16 | 'phosphor-settings') |
Adriana Kobylak | 256be78 | 2016-08-24 15:43:16 -0500 | [diff] [blame] | 17 | sys.path.insert(1, settings_file_path) |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 18 | import settings_file as s |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 19 | import re |
Sergey Solomin | 62b55f3 | 2016-10-13 10:40:27 -0500 | [diff] [blame] | 20 | import obmc.mapper |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 21 | |
| 22 | DBUS_NAME = 'org.openbmc.settings.Host' |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 23 | CONTROL_INTF = 'org.openbmc.Settings' |
| 24 | |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 25 | def 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 | |
| 38 | def create_object(settings): |
| 39 | """Create and format objects. |
| 40 | |
Sergey Solomin | 62b55f3 | 2016-10-13 10:40:27 -0500 | [diff] [blame] | 41 | Parse dictionary file and return all objects and settings |
| 42 | in the following format: {obj_name {settings}} |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 43 | """ |
Sergey Solomin | f68b864 | 2016-11-14 16:26:17 -0600 | [diff] [blame] | 44 | bus = get_dbus() |
Sergey Solomin | 62b55f3 | 2016-10-13 10:40:27 -0500 | [diff] [blame] | 45 | mapper = obmc.mapper.Mapper(bus) |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 46 | allobjects = {} |
Sergey Solomin | 62b55f3 | 2016-10-13 10:40:27 -0500 | [diff] [blame] | 47 | queries = {} |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 48 | 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 Solomin | 62b55f3 | 2016-10-13 10:40:27 -0500 | [diff] [blame] | 53 | for i in compound_key[2:len(compound_key)-2]: |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 54 | obj_name = obj_name + "/" + i |
| 55 | |
| 56 | setting = compound_key[len(compound_key) - 2] |
| 57 | attribute = compound_key[len(compound_key) - 1] |
Sergey Solomin | 62b55f3 | 2016-10-13 10:40:27 -0500 | [diff] [blame] | 58 | 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 Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 66 | s[attribute] = val |
Sergey Solomin | 62b55f3 | 2016-10-13 10:40:27 -0500 | [diff] [blame] | 67 | 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 Spinler | 371dd02 | 2016-12-15 12:48:04 -0600 | [diff] [blame^] | 72 | |
| 73 | if setting['keyregex'] == 'host': |
| 74 | # Always create at least one host object. |
| 75 | paths = set(paths + ['/org/openbmc/control/host0']) |
| 76 | |
Sergey Solomin | 62b55f3 | 2016-10-13 10:40:27 -0500 | [diff] [blame] | 77 | 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 Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 83 | return allobjects |
Brad Bishop | 2a9fe66 | 2016-08-31 12:37:35 -0400 | [diff] [blame] | 84 | |
Brad Bishop | 5ef7fe6 | 2016-05-17 08:39:17 -0400 | [diff] [blame] | 85 | class HostSettingsObject(DbusProperties): |
Adriana Kobylak | 41a925e | 2016-01-28 16:44:27 -0600 | [diff] [blame] | 86 | def __init__(self, bus, name, settings, path): |
Brad Bishop | c1e5e9f | 2016-09-29 09:40:01 -0400 | [diff] [blame] | 87 | super(HostSettingsObject, self).__init__( |
| 88 | conn=bus, |
| 89 | object_path=name, |
| 90 | validator=self.input_validator) |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 91 | self.bus = bus |
Adriana Kobylak | 41a925e | 2016-01-28 16:44:27 -0600 | [diff] [blame] | 92 | self.path = path |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 93 | self.name = name |
| 94 | self.settings = settings |
Yi Li | 5ebab48 | 2016-11-22 16:34:18 +0800 | [diff] [blame] | 95 | self.fname = name[name.rfind("/")+1:] + '-' |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 96 | |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 97 | # Needed to ignore the validation on default networkconfig values as |
| 98 | # opposed to user giving the same. |
| 99 | self.adminmode = True |
| 100 | |
Adriana Kobylak | 41a925e | 2016-01-28 16:44:27 -0600 | [diff] [blame] | 101 | if not os.path.exists(path): |
| 102 | os.mkdir(path) |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 103 | |
| 104 | # Listen to changes in the property values and sync them to the BMC |
Brad Bishop | 2a9fe66 | 2016-08-31 12:37:35 -0400 | [diff] [blame] | 105 | bus.add_signal_receiver( |
| 106 | self.settings_signal_handler, |
| 107 | dbus_interface="org.freedesktop.DBus.Properties", |
| 108 | signal_name="PropertiesChanged", |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 109 | path=name) |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 110 | |
| 111 | # Create the dbus properties |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 112 | for setting in settings.itervalues(): |
Sergey Solomin | 62b55f3 | 2016-10-13 10:40:27 -0500 | [diff] [blame] | 113 | if setting['type'] is 'instance_query': |
| 114 | continue |
| 115 | self.set_settings_property( |
Yi Li | 5ebab48 | 2016-11-22 16:34:18 +0800 | [diff] [blame] | 116 | setting['name'], setting['type'], setting['default'], |
| 117 | self.fname) |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 118 | # Done with consuming factory settings. |
| 119 | self.adminmode = False |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 120 | |
Sergey Solomin | 62b55f3 | 2016-10-13 10:40:27 -0500 | [diff] [blame] | 121 | def get_bmc_value(self, name, fname): |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 122 | try: |
Sergey Solomin | 62b55f3 | 2016-10-13 10:40:27 -0500 | [diff] [blame] | 123 | with open(path.join(self.path, fname + name), 'r') as f: |
Adriana Kobylak | 41a925e | 2016-01-28 16:44:27 -0600 | [diff] [blame] | 124 | return f.read() |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 125 | except (IOError): |
| 126 | pass |
Adriana Kobylak | 41a925e | 2016-01-28 16:44:27 -0600 | [diff] [blame] | 127 | return None |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 128 | |
Brad Bishop | 2a9fe66 | 2016-08-31 12:37:35 -0400 | [diff] [blame] | 129 | # 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 Solomin | 62b55f3 | 2016-10-13 10:40:27 -0500 | [diff] [blame] | 133 | def set_settings_property(self, attr_name, attr_type, value, fname): |
| 134 | bmcv = self.get_bmc_value(attr_name, fname) |
Adriana Kobylak | 41a925e | 2016-01-28 16:44:27 -0600 | [diff] [blame] | 135 | if bmcv: |
| 136 | value = bmcv |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 137 | 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 Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 143 | |
| 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 Solomin | 62b55f3 | 2016-10-13 10:40:27 -0500 | [diff] [blame] | 146 | def set_system_settings(self, name, value, fname): |
| 147 | bmcv = self.get_bmc_value(name, fname) |
Adriana Kobylak | 41a925e | 2016-01-28 16:44:27 -0600 | [diff] [blame] | 148 | if bmcv != value: |
Sergey Solomin | 62b55f3 | 2016-10-13 10:40:27 -0500 | [diff] [blame] | 149 | filepath = path.join(self.path, fname + name) |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 150 | with open(filepath, 'w') as f: |
Adriana Kobylak | 41a925e | 2016-01-28 16:44:27 -0600 | [diff] [blame] | 151 | f.write(str(value)) |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 152 | |
| 153 | # Signal handler for when one ore more settings properties were updated. |
| 154 | # This will sync the changes to the BMC. |
Brad Bishop | 2a9fe66 | 2016-08-31 12:37:35 -0400 | [diff] [blame] | 155 | def settings_signal_handler( |
Yi Li | 5ebab48 | 2016-11-22 16:34:18 +0800 | [diff] [blame] | 156 | self, interface_name, changed_properties, invalidated_properties): |
Adriana Kobylak | 41a925e | 2016-01-28 16:44:27 -0600 | [diff] [blame] | 157 | for name, value in changed_properties.items(): |
Yi Li | 5ebab48 | 2016-11-22 16:34:18 +0800 | [diff] [blame] | 158 | self.set_system_settings(name, value, self.fname) |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 159 | |
| 160 | # Placeholder signal. Needed to register the settings interface. |
Adriana Kobylak | 41a925e | 2016-01-28 16:44:27 -0600 | [diff] [blame] | 161 | @dbus.service.signal(DBUS_NAME, signature='s') |
| 162 | def SettingsUpdated(self, sname): |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 163 | pass |
| 164 | |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 165 | def validate_regex(self, regex, value): |
| 166 | if not re.compile(regex).search(value): |
Brad Bishop | c1e5e9f | 2016-09-29 09:40:01 -0400 | [diff] [blame] | 167 | raise ValueError("Invalid input. Data does not satisfy regex") |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 168 | |
| 169 | def validate_range(self, min, max, value): |
| 170 | if value not in range(min, max): |
Brad Bishop | c1e5e9f | 2016-09-29 09:40:01 -0400 | [diff] [blame] | 171 | raise ValueError("Invalid input. Data not in allowed range") |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 172 | |
| 173 | def validate_list_ignore_case(self, lst, value): |
| 174 | if value.lower() not in map(lambda val: val.lower(), lst): |
Brad Bishop | c1e5e9f | 2016-09-29 09:40:01 -0400 | [diff] [blame] | 175 | raise ValueError("Invalid input. Data not in allowed values") |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 176 | |
| 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 Bishop | c1e5e9f | 2016-09-29 09:40:01 -0400 | [diff] [blame] | 190 | raise ValueError("Invalid Network Data. No white spaces allowed") |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 191 | |
| 192 | config = value.split(',') |
| 193 | for key_value in config: |
Brad Bishop | c1e5e9f | 2016-09-29 09:40:01 -0400 | [diff] [blame] | 194 | key, value = key_value.split('=') |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 195 | if not key or not value: |
Brad Bishop | c1e5e9f | 2016-09-29 09:40:01 -0400 | [diff] [blame] | 196 | raise ValueError("Invalid key or Data") |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 197 | |
| 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 Bishop | c1e5e9f | 2016-09-29 09:40:01 -0400 | [diff] [blame] | 203 | IP(value) |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 204 | |
| 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 Bishop | c1e5e9f | 2016-09-29 09:40:01 -0400 | [diff] [blame] | 218 | raise ValueError( |
| 219 | "Invalid Network Data. All information is mandatory") |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 220 | |
| 221 | # Validate to see if the changes are in order |
| 222 | def input_validator(self, iface, proprty, value): |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 223 | # User entered key is not present |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 224 | shk = None |
| 225 | for attr in self.settings.itervalues(): |
| 226 | if attr['name'] == proprty: |
| 227 | shk = attr |
| 228 | |
| 229 | if shk is None: |
Brad Bishop | c1e5e9f | 2016-09-29 09:40:01 -0400 | [diff] [blame] | 230 | raise KeyError("Invalid Property") |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 231 | |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 232 | validation = shk.get('validation', None) |
| 233 | |
| 234 | if validation == 'list': |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 235 | self.validate_list_ignore_case(shk['allowed'], value) |
| 236 | |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 237 | elif validation == 'range': |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 238 | self.validate_range(shk['min'], shk['max']+1, value) |
| 239 | |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 240 | elif validation == 'regex': |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 241 | self.validate_regex(shk['regex'], value) |
| 242 | |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 243 | elif validation == 'custom': |
Brad Bishop | c1e5e9f | 2016-09-29 09:40:01 -0400 | [diff] [blame] | 244 | getattr(self, shk['method'])(value) |
Vishwanatha Subbanna | 5b090c6 | 2016-09-21 15:49:26 +0530 | [diff] [blame] | 245 | |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 246 | if __name__ == '__main__': |
| 247 | dbus.mainloop.glib.DBusGMainLoop(set_as_default=True) |
| 248 | |
Brad Bishop | 5ef7fe6 | 2016-05-17 08:39:17 -0400 | [diff] [blame] | 249 | bus = get_dbus() |
Sergey Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 250 | 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 Solomin | 4a2433f | 2016-10-03 10:22:57 -0500 | [diff] [blame] | 256 | mainloop = gobject.MainLoop() |
Brad Bishop | 2cbef3d | 2016-08-31 12:40:13 -0400 | [diff] [blame] | 257 | name = dbus.service.BusName(DBUS_NAME, bus) |
Adriana Kobylak | 4c60e5e | 2016-01-10 15:22:45 -0600 | [diff] [blame] | 258 | print "Running HostSettingsService" |
| 259 | mainloop.run() |
Brad Bishop | 31c42f0 | 2016-09-29 09:35:32 -0400 | [diff] [blame] | 260 | |
| 261 | # vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4 |