PLC/Methods/UpdateInterfaceSetting.py

   1 #
   2 # Thierry Parmentelat - INRIA
   3 #
   4 # $Revision$
   5 #
   6
   7 from PLC.Faults import *
   8 from PLC.Method import Method
   9 from PLC.Parameter import Parameter, Mixed
  10 from PLC.Auth import Auth
  11
  12 from PLC.InterfaceSettings import InterfaceSetting, InterfaceSettings
  13 from PLC.Interfaces import Interface, Interfaces
  14
  15 from PLC.Nodes import Nodes
  16 from PLC.Sites import Sites
  17
  18 class UpdateInterfaceSetting(Method):
  19     """
  20     Updates the value of an existing interface setting
  21
  22     Access rights depend on the interface setting type.
  23
  24     Returns 1 if successful, faults otherwise.
  25     """
  26
  27     roles = ['admin', 'pi', 'tech', 'user']
  28
  29     accepts = [
  30         Auth(),
  31         InterfaceSetting.fields['interface_setting_id'],
  32         InterfaceSetting.fields['value']
  33         ]
  34
  35     returns = Parameter(int, '1 if successful')
  36
  37     object_type = 'Interface'
  38
  39     def call(self, auth, interface_setting_id, value):
  40         interface_settings = InterfaceSettings(self.api, [interface_setting_id])
  41         if not interface_settings:
  42             raise PLCInvalidArgument, "No such interface setting %r"%interface_setting_id
  43         interface_setting = interface_settings[0]
  44
  45         ### reproducing a check from UpdateSliceAttribute, looks dumb though
  46         interfaces = Interfaces(self.api, [interface_setting['interface_id']])
  47         if not interfaces:
  48             raise PLCInvalidArgument, "No such interface %r"%interface_setting['interface_id']
  49         interface = interfaces[0]
  50
  51         assert interface_setting['interface_setting_id'] in interface['interface_setting_ids']
  52
  53         # check permission : it not admin, is the user affiliated with the right site
  54         if 'admin' not in self.caller['roles']:
  55             # locate node
  56             node = Nodes (self.api,[interface['node_id']])[0]
  57             # locate site
  58             site = Sites (self.api, [node['site_id']])[0]
  59             # check caller is affiliated with this site
  60             if self.caller['person_id'] not in site['person_ids']:
  61                 raise PLCPermissionDenied, "Not a member of the hosting site %s"%site['abbreviated_site']
  62
  63             required_min_role = interface_setting_type ['min_role_id']
  64             if required_min_role is not None and \
  65                     min(self.caller['role_ids']) > required_min_role:
  66                 raise PLCPermissionDenied, "Not allowed to modify the specified interface setting, requires role %d",required_min_role
  67
  68         interface_setting['value'] = value
  69         interface_setting.sync()
  70
  71         self.object_ids = [interface_setting['interface_setting_id']]
  72         return 1