PLC/Methods/UpdateSiteTag.py

   1 #
   2 # Thierry Parmentelat - INRIA
   3 #
   4 from PLC.Faults import *
   5 from PLC.Method import Method
   6 from PLC.Parameter import Parameter, Mixed
   7 from PLC.Auth import Auth
   8
   9 from PLC.Sites import Site, Sites
  10 from PLC.Nodes import Nodes
  11 from PLC.TagTypes import TagType, TagTypes
  12 from PLC.SiteTags import SiteTag, SiteTags
  13
  14 from PLC.AuthorizeHelpers import AuthorizeHelpers
  15
  16 class UpdateSiteTag(Method):
  17     """
  18     Updates the value of an existing site setting
  19
  20     Admins have full access.  Non-admins need to
  21     (1) have at least one of the roles attached to the tagtype,
  22     and (2) belong in the same site as the tagged subject.
  23
  24     Returns 1 if successful, faults otherwise.
  25     """
  26
  27     roles = ['admin', 'pi', 'tech', 'user']
  28
  29     accepts = [
  30         Auth(),
  31         SiteTag.fields['site_tag_id'],
  32         SiteTag.fields['value']
  33         ]
  34
  35     returns = Parameter(int, '1 if successful')
  36
  37     def call(self, auth, site_tag_id, value):
  38         site_tags = SiteTags(self.api, [site_tag_id])
  39         if not site_tags:
  40             raise PLCInvalidArgument, "No such site setting %r"%site_tag_id
  41         site_tag = site_tags[0]
  42
  43         tag_type_id = site_tag['tag_type_id']
  44         tag_type = TagTypes (self.api,[tag_type_id])[0]
  45         site = Sites (self.api, site_tag['site_id'])
  46
  47         # check authorizations
  48         if 'admin' in self.caller['roles']:
  49             pass
  50         elif not AuthorizeHelpers.caller_may_access_tag_type (self.api, self.caller, tag_type):
  51             raise PLCPermissionDenied, "%s, forbidden tag %s"%(self.name,tag_type['tagname'])
  52         elif AuthorizeHelpers.person_belongs_to_site (self.api, self.caller, site):
  53             pass
  54         else:
  55             raise PLCPermissionDenied, "%s: you must be part of the subject site"%self.name
  56
  57         site_tag['value'] = value
  58         site_tag.sync()
  59
  60         self.object_ids = [site_tag['site_tag_id']]
  61         return 1