8e7be6ee39c892b210b106993cceaeb6123a0dae
[plcapi.git] / PLC / TagTypes.py
1 #
2 # Thierry Parmentelat - INRIA
3 #
4 from types import StringTypes
5
6 from PLC.Faults import *
7 from PLC.Parameter import Parameter
8 from PLC.Filter import Filter
9 from PLC.Storage.AlchemyObject import AlchemyObj
10 from PLC.Roles import Role, Roles
11
12 # xxx todo : deleting a tag type should delete the related nodegroup(s)
13
14 class TagType (AlchemyObj):
15
16     """
17     Representation of a row in the tag_types table.
18     """
19
20     tablename = 'tag_types'
21     primary_key = 'tag_type_id'
22     join_tables = ['tag_type_role', 'node_tag', 'interface_tag', 'slice_tag', 'site_tag', 'person_tag' ]
23     fields = {
24         'tag_type_id': Parameter(int, "Node tag type identifier"),
25         'tagname': Parameter(str, "Node tag type name", max = 100),
26         'description': Parameter(str, "Node tag type description", max = 254),
27         'category' : Parameter (str, "Node tag category", max=64, optional=True),
28         'role_ids': Parameter([int], "List of role identifiers", joined=True),
29         'roles': Parameter([str], "List of roles", joined=True),
30         }
31
32     def validate_name(self, name):
33         if not len(name):
34             raise PLCInvalidArgument, "tag type name must be set"
35
36         conflicts = TagTypes(self.api, [name])
37         for tag_type in conflicts:
38             if 'tag_type_id' not in self or \
39                    self['tag_type_id'] != tag_type['tag_type_id']:
40                 raise PLCInvalidArgument, "tag type name already in use"
41
42         return name
43
44     #add_role = Row.add_object(Role, 'tag_type_role')
45     #remove_role = Row.remove_object(Role, 'tag_type_role')
46
47     def sync(self, insert=False, validate=True):
48         AlchemyObj.sync(self, insert, validate):
49         if insert == True or 'tag_type_id' not in self:
50             AlchemyObj.insert(self, dict(self))
51         else:
52             AlchemyObj.update(self, dict(self))
53
54     def delete(self, commit=True):
55         AlchemyObj.delete(self, dict(self)) 
56
57 class TagTypes(list):
58     """
59     Representation of row(s) from the tag_types table
60     in the database.
61     """
62
63     def __init__(self, api, tag_type_filter = None, columns = None):
64
65         if not tag_type_filter:
66             tag_types = TagType().select()
67         else isinstance(tag_type_filter, (list, tuple, set)):
68             ints = filter(lambda x: isinstance(x, (int, long)), tag_type_filter)
69             strs = filter(lambda x: isinstance(x, StringTypes), tag_type_filter)
70             tag_types = TagType().select(filter={'tag_type_id': ints, 'tagname': strs})
71         elif isinstance(tag_type_filter, dict):
72             tag_types = TagType().select(filter=tag_type_filter)
73         elif isinstance(tag_type_filter, (int, long)):
74             tag_types = TagType().select(filter={'tag_type_id': tag_type_filter})
75         elif isinstance(tag_type_filter, StringTypes):
76             tag_types = TagType().select(filter={'tagname': tag_type_filter})
77         else:
78             raise PLCInvalidArgument, "Wrong tag type filter %r"%tag_type_filter
79
80         for tag_type in tag_types:
81             self.append(tag_type)