summaryrefslogtreecommitdiffstats
path: root/ipa-client/ipaclient/ipachangeconf.py
blob: 646e0424e4bfc57de95b16d1d0e2b1c1ee9cfe29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
#
# ipachangeconf - configuration filke manipulation classes and functions
# partially based on authconfig code
# Copyright (c) 1999-2007 Red Hat, Inc.
# Author: Simo Sorce <ssorce@redhat.com>
#
# This is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#

import fcntl
import os
import string
import time

def openLocked(filename, perms):
	fd = -1
	try:
		fd = os.open(filename, os.O_RDWR | os.O_CREAT, perms)
		
		fcntl.lockf(fd, fcntl.LOCK_EX)
	except OSError, (errno, strerr):
		if fd != -1:
			try:
				os.close(fd)
			except OSError:
				pass
		raise IOError(errno, strerr)
	return os.fdopen(fd, "r+")


    #TODO: add subsection as a concept
    #      (ex. REALM.NAME = { foo = x bar = y } )
    #TODO: put section delimiters as separating element of the list
    #      so that we can process multiple sections in one go
    #TODO: add a comment all but provided options as a section option
class IPAChangeConf:

    def __init__(self, name):
        self.progname = name
        self.optpre = ("",)
        self.doptpre = self.optpre[0]
        self.assign = (" = ",)
        self.dassign = self.assign[0]
        self.comment = ("#",)
        self.dcomment = self.comment[0]
        self.eol = ("\n",)
        self.deol = self.eol[0]
	#self.sectnamdel = ("[","]")
	self.sectnamdel = ()
        self.newsection = False

    def setProgName(self, name):
        self.progname = name

    def setOptionPrefix(self, prefix):
        if type(prefix) is list:
            self.optpre = prefix
        else:
            self.optpre = (prefix, )
        self.doptpre = self.optpre[0]

    def setOptionAssignment(self, assign):
	if type(assign) is list:
            self.assign = assign
        else:
            self.assign = (assign, )
        self.dassign = self.assign[0]

    def setCommentPrefix(self, comment):
        if type(comment) is list:
            self.comment = comment
        else:
            self.comment = (comment, )
        self.dcomment = self.comment[0]

    def setEndLine(self, eol):
        if type(eol) is list:
            self.eol = eol
        else:
            self.eol = (eol, )
        self.deol = self.eol[0]

    def setSectionNameDelimiters(self, delims):
        self.sectnamdel = delims

    def confDump(self, options):
        output = ""

        #pre conf options delimiter
        output += self.deol
        output += self.dcomment+"["+self.progname+"]--start-line--"+self.deol
        output += self.dcomment+" Generated by authconfig on " + time.strftime("%Y/%m/%d %H:%M:%S") + self.deol
        output += self.dcomment+" DO NOT EDIT THIS SECTION (delimited by --start-line--/--end-line--)"+self.deol
        output += self.dcomment+" Any modification may be deleted or altered by authconfig in future"+self.deol
        output += self.deol

        if self.newsection:
            output += getSectionLine(section)

        #set options
        for opt in options:
            if opt['action'] == "set":
                output += self.doptpre+opt['name']+self.dassign+opt['value']+self.deol

        #post conf options delimiter
        output += self.deol
        output += self.dcomment+"["+self.progname+"]--end-line--"+self.deol
        output += self.deol

        return output

    def matchAutoEnd(self, line):
        if line.endswith("]--end-line--"):
            return True
        return False

    def matchAutoStart(self, line):
        if line.endswith("]--start-line--"):
            return True
        return False

    def matchComment(self, line):
        for v in self.comment:
            if line.strip().startswith(v):
                return True
        return False

    def matchLineOption(self, line, opt):
        parts = line.split(self.dassign, 1)
        if len(parts) < 2:
            return False
        elif parts[0].split() == opt['name'].split():
            return True
        else:
            return False

    def matchSection(self, line):
        cl = "".join(line.strip().split()).lower()
        if len(self.sectnamdel) != 2:
            return False
        if not cl.startswith(self.sectnamdel[0]):
            return False
        if not cl.endswith(self.sectnamdel[1]):
            return False
        return cl[len(self.sectnamdel[0]):-len(self.sectnamdel[1])]            

    def getSectionLine(self, section):
        if len(self.sectnamdel) != 2:
            return section
        return self.sectnamdel[0]+section+self.sectnamdel[1]+self.deol

    def checkLineOption(self, line, options):
        output = ""

        # Check if this is a setting we care about.
        for opt in options:
            if self.matchLineOption(line.strip(), opt):
                output = self.dcomment
                break

        output += line
        return output;

    # Write settings to configuration file
    # file is a path
    # options is a set of dictionaries in the form:
    #     [{'name': 'foo', 'value': 'bar', 'action': 'set/comment'}]
    # section is a section name like 'global'
    def changeConf(self, file, options, section=None):
        autosection = False
	savedsection = None
        done = False
        output = ""
        f = None
        try:
            f = openLocked(file, 0644)

            # Read in the old file.
            for line in f:

                if autosection:
                    if self.matchAutoEnd(line):
                        autosection = False
                    #skip all previous auto-generated lines
                    continue

                if self.matchAutoStart(line):
                    autosection = True
                    continue

                # If it's a comment, just pass it through.
                if self.matchComment(line):
                    output += line
                    continue

                # If it's a section start, note the section name.
                value = self.matchSection(line)
                if value:

                    # Here we are at start if a new section, if the previous one matches
                    # the specified section, dump here before starting the new one
                    # the comparison with section == None is intentional and matches the
                    # request to dump the options at the end of an implicit initial
                    # unmarked section before any section is started
                    if savedsection == section:
                        output += self.confDump(options)
                        done = True

                    savedsection = value
                    output += line
                    continue

                # Comment out options we care about.
                if savedsection == section:
                    output += self.checkLineOption(line, options)
                    continue

                # Copy anything else as is.
                output += line

            if not done:
                if section:
                    self.newsection = True
                output += self.confDump(options)

            # Write it out and close it.
            f.seek(0)
            f.truncate(0)
            f.write(output)
        finally:
            try:
                if f:
                    f.close()
            except IOError:
                pass
        return True