Setting tag plcapi-5.4-2
[plcapi.git] / PLC / InitScripts.py
1 #
2 # Functions for interacting with the initscripts table in the database
3 #
4 # Tony Mack <tmack@cs.princeton.edu>
5 # Copyright (C) 2006 The Trustees of Princeton University
6 #
7
8 from types import StringTypes
9 from PLC.Faults import *
10 from PLC.Parameter import Parameter
11 from PLC.Filter import Filter
12 from PLC.Table import Row, Table
13
14 class InitScript(Row):
15     """
16     Representation of a row in the initscripts table. To use,
17     instantiate with a dict of values.
18     """
19
20     table_name = 'initscripts'
21     primary_key = 'initscript_id'
22     join_tables = []
23     fields = {
24         'initscript_id': Parameter(int, "Initscript identifier"),
25         'name': Parameter(str, "Initscript name", max = 254),
26         'enabled': Parameter(bool, "Initscript is active"),
27         'script': Parameter(str, "Initscript"),
28         }
29
30     def validate_name(self, name):
31         """
32         validates the script name
33         """
34
35         conflicts = InitScripts(self.api, [name])
36         for initscript in conflicts:
37             if 'initscript_id' not in self or self['initscript_id'] != initscript['initscript_id']:
38                 raise PLCInvalidArgument, "Initscript name already in use"
39
40         return name
41
42
43 class InitScripts(Table):
44     """
45     Representation of the initscripts table in the database.
46     """
47
48     def __init__(self, api, initscript_filter = None, columns = None):
49         Table.__init__(self, api, InitScript, columns)
50
51         sql = "SELECT %s FROM initscripts WHERE True" % \
52               ", ".join(self.columns)
53
54         if initscript_filter is not None:
55             if isinstance(initscript_filter, (list, tuple, set)):
56                 # Separate the list into integers and strings
57                 ints = filter(lambda x: isinstance(x, (int, long)), initscript_filter)
58                 strs = filter(lambda x: isinstance(x, StringTypes), initscript_filter)
59                 initscript_filter = Filter(InitScript.fields, {'initscript_id': ints, 'name': strs })
60                 sql += " AND (%s) %s" % initscript_filter.sql(api, "OR")
61             elif isinstance(initscript_filter, dict):
62                 initscript_filter = Filter(InitScript.fields, initscript_filter)
63                 sql += " AND (%s) %s" % initscript_filter.sql(api, "AND")
64             elif isinstance(initscript_filter, (int, long)):
65                 initscript_filter = Filter(InitScript.fields, {'initscript_id': initscript_filter})
66                 sql += " AND (%s) %s" % initscript_filter.sql(api, "AND")
67             elif isinstance(initscript_filter, StringTypes):
68                 initscript_filter = Filter(InitScript.fields, {'name': initscript_filter})
69                 sql += " AND (%s) %s" % initscript_filter.sql(api, "AND")
70             else:
71                 raise PLCInvalidArgument, "Wrong initscript filter %r"%initscript_filter
72
73         self.selectall(sql)