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.TagTypes import TagType, TagTypes
  11 from PLC.SiteTags import SiteTag, SiteTags
  12
  13 # need to import so the core classes get decorated with caller_may_write_tag
  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
  46         sites = Sites (self.api, site_tag['site_id'])
  47         if not sites:
  48             raise PLCInvalidArgument("No such site %d"%site_tag['site_id'])
  49         site=sites[0]
  50
  51         # check authorizations
  52         site.caller_may_write_tag(self.api,self.caller,tag_type)
  53
  54         site_tag['value'] = value
  55         site_tag.sync()
  56
  57         self.object_ids = [site_tag['site_tag_id']]
  58         return 1