PLC/Methods/UpdateNode.py

   1 # $Id$
   2 from PLC.Faults import *
   3 from PLC.Method import Method
   4 from PLC.Parameter import Parameter, Mixed
   5 from PLC.Table import Row
   6 from PLC.Auth import Auth
   7
   8 from PLC.Nodes import Node, Nodes
   9 from PLC.TagTypes import TagTypes
  10 from PLC.NodeTags import NodeTags
  11 from PLC.Methods.AddNodeTag import AddNodeTag
  12 from PLC.Methods.UpdateNodeTag import UpdateNodeTag
  13
  14 can_update = ['hostname', 'boot_state', 'model', 'version','key', 'session', 'boot_nonce', 'site_id'] + \
  15               Node.related_fields.keys()
  16
  17 class UpdateNode(Method):
  18     """
  19     Updates a node. Only the fields specified in node_fields are
  20     updated, all other fields are left untouched.
  21
  22     PIs and techs can update only the nodes at their sites. Only
  23     admins can update the key, session, and boot_nonce fields.
  24
  25     Returns 1 if successful, faults otherwise.
  26     """
  27
  28     roles = ['admin', 'pi', 'tech']
  29
  30     node_fields = Row.accepted_fields(can_update,[Node.fields,Node.related_fields,Node.tags])
  31
  32     accepts = [
  33         Auth(),
  34         Mixed(Node.fields['node_id'],
  35               Node.fields['hostname']),
  36         node_fields
  37         ]
  38
  39     returns = Parameter(int, '1 if successful')
  40
  41     def call(self, auth, node_id_or_hostname, node_fields):
  42
  43         # split provided fields
  44         [native,related,tags,rejected] = Row.split_fields(node_fields,[Node.fields,Node.related_fields,Node.tags])
  45
  46         if rejected:
  47             raise PLCInvalidArgument, "Cannot update Node column(s) %r"%rejected
  48
  49         # Remove admin only fields
  50         if 'admin' not in self.caller['roles']:
  51             for key in 'key', 'session', 'boot_nonce', 'site_id':
  52                 if native.has_key(key):
  53                     del native[key]
  54
  55         # Get account information
  56         nodes = Nodes(self.api, [node_id_or_hostname])
  57         if not nodes:
  58             raise PLCInvalidArgument, "No such node %r"%node_id_or_hostname
  59         node = nodes[0]
  60
  61         if node['peer_id'] is not None:
  62             raise PLCInvalidArgument, "Not a local node %r"%node_id_or_hostname
  63
  64         # Authenticated function
  65         assert self.caller is not None
  66
  67         # If we are not an admin, make sure that the caller is a
  68         # member of the site at which the node is located.
  69         if 'admin' not in self.caller['roles']:
  70             if node['site_id'] not in self.caller['site_ids']:
  71                 raise PLCPermissionDenied, "Not allowed to delete nodes from specified site"
  72
  73         # Make requested associations
  74         for (k,v) in related.iteritems():
  75             node.associate(auth, k,v)
  76
  77         node.update(native)
  78         node.update_last_updated(commit=False)
  79         node.sync(commit=True)
  80
  81         for (tagname,value) in tags.iteritems():
  82             # the tagtype instance is assumed to exist, just check that
  83             if not TagTypes(self.api,{'tagname':tagname}):
  84                 raise PLCInvalidArgument,"No such TagType %s"%tagname
  85             node_tags=NodeTags(self.api,{'tagname':tagname,'node_id':node['node_id']})
  86             if not node_tags:
  87                 AddNodeTag(self.api).__call__(auth,node['node_id'],tagname,value)
  88             else:
  89                 UpdateNodeTag(self.api).__call__(auth,node_tags[0]['node_tag_id'],value)
  90
  91         # Logging variables
  92         self.event_objects = {'Node': [node['node_id']]}
  93         if 'hostname' in node:
  94             self.message = 'Node %s updated'%node['hostname']
  95         else:
  96             self.message = 'Node %d updated'%node['node_id']
  97         self.message += " [%s]." % (", ".join(node_fields.keys()),)
  98         if 'boot_state' in node_fields.keys():
  99                 self.message += ' boot_state updated to %s' % node_fields['boot_state']
 100
 101         return 1