add site_tags : GetSites() now returns 'site_tag_ids' attribute.
[plcapi.git] / PLC / SiteTags.py
1 # $Id: SiteTags.py 14587 2009-07-19 13:18:50Z thierry $
2 # $URL: http://svn.planet-lab.org/svn/PLCAPI/tags/PLCAPI-4.3-27/PLC/SiteTags.py $
3 #
4 # Thierry Parmentelat - INRIA
5 #
6 # $Revision: 14587 $
7 #
8 from PLC.Faults import *
9 from PLC.Parameter import Parameter
10 from PLC.Filter import Filter
11 from PLC.Table import Row, Table
12 from PLC.TagTypes import TagType, TagTypes
13 from PLC.Sites import Site
14
15 class SiteTag(Row):
16     """
17     Representation of a row in the site_tag.
18     To use, instantiate with a dict of values.
19     """
20
21     table_name = 'site_tag'
22     primary_key = 'site_tag_id'
23     fields = {
24         'site_tag_id': Parameter(int, "Site setting identifier"),
25         'site_id': Site.fields['site_id'],
26         'login_base': Site.fields['login_base'],
27         'tag_type_id': TagType.fields['tag_type_id'],
28         'tagname': TagType.fields['tagname'],
29         'description': TagType.fields['description'],
30         'category': TagType.fields['category'],
31         'min_role_id': TagType.fields['min_role_id'],
32         'value': Parameter(str, "Site setting value"),
33         ### relations
34         
35         }
36
37 class SiteTags(Table):
38     """
39     Representation of row(s) from the site_tag table in the
40     database.
41     """
42
43     def __init__(self, api, site_tag_filter = None, columns = None):
44         Table.__init__(self, api, SiteTag, columns)
45
46         sql = "SELECT %s FROM view_site_tags WHERE True" % \
47               ", ".join(self.columns)
48
49         if site_tag_filter is not None:
50             if isinstance(site_tag_filter, (list, tuple, set)):
51                 site_tag_filter = Filter(SiteTag.fields, {'site_tag_id': site_tag_filter})
52             elif isinstance(site_tag_filter, dict):
53                 site_tag_filter = Filter(SiteTag.fields, site_tag_filter)
54             elif isinstance(site_tag_filter, int):
55                 site_tag_filter = Filter(SiteTag.fields, {'site_tag_id': [site_tag_filter]})
56             else:
57                 raise PLCInvalidArgument, "Wrong site setting filter %r"%site_tag_filter
58             sql += " AND (%s) %s" % site_tag_filter.sql(api)
59
60
61         self.selectall(sql)