gp_csv: Parse the audit.csv file which records audit settings
[nivanova/samba-autobuild/.git] / python / samba / gp_parse / gp_csv.py
1 # GPO Parser for audit extensions
2 #
3 # Copyright (C) Andrew Bartlett <abartlet@samba.org> 2018
4 # Written by Garming Sam <garming@catalyst.net.nz>
5 #
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
10 #
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 #
19
20 import codecs
21 import csv
22 import io
23
24 from io import BytesIO
25 from xml.etree.ElementTree import Element, SubElement
26
27 from samba.gp_parse import GPParser
28
29 # [MS-GPAC] Group Policy Audit Configuration
30 class GPAuditCsvParser(GPParser):
31     encoding = 'utf-8'
32     header = None
33     lines = []
34
35     def parse(self, contents):
36         self.lines = []
37         reader = UnicodeReader(BytesIO(contents),
38                                encoding=self.encoding)
39
40         self.header = reader.next()
41         for row in reader:
42             line = {}
43             for i, x in enumerate(row):
44                 line[self.header[i]] = x
45
46             self.lines.append(line)
47             # print line
48
49     def write_xml(self, filename):
50         with file(filename, 'wb') as f:
51             root = Element('CsvFile')
52             child = SubElement(root, 'Row')
53             for e in self.header:
54                 value = SubElement(child, 'Value')
55                 value.text = e
56
57             for line in self.lines:
58                 child = SubElement(root, 'Row')
59                 for e in [line[x] for x in self.header]:
60                     value = SubElement(child, 'Value')
61                     value.text = e
62
63             self.write_pretty_xml(root, f)
64
65
66         # contents = codecs.open(filename, encoding='utf-8').read()
67         # self.load_xml(fromstring(contents))
68
69     def load_xml(self, root):
70         header = True
71         self.lines = []
72
73         for r in root.findall('Row'):
74             if header:
75                 header = False
76                 self.header = []
77                 for v in r.findall('Value'):
78                     self.header.append(v.text.decode(self.output_encoding))
79             else:
80                 line = {}
81                 for i, v in enumerate(r.findall('Value')):
82                     line[self.header[i]] = v.text if v.text is not None else ''
83                     line[self.header[i]] = line[self.header[i]].decode(self.output_encoding)
84
85                 self.lines.append(line)
86
87     def write_binary(self, filename):
88         with file(filename, 'wb') as f:
89             # This should be using a unicode writer, but it seems to be in the
90             # right encoding at least by default.
91             #
92             # writer = UnicodeWriter(f, quoting=csv.QUOTE_MINIMAL)
93             writer = csv.writer(f, quoting=csv.QUOTE_MINIMAL)
94             writer.writerow(self.header)
95             for line in self.lines:
96                 writer.writerow([line[x] for x in self.header])
97
98
99 # The following classes come from the Python documentation
100 # https://docs.python.org/3.0/library/csv.html
101
102
103 class UTF8Recoder:
104     """
105     Iterator that reads an encoded stream and reencodes the input to UTF-8
106     """
107     def __init__(self, f, encoding):
108         self.reader = codecs.getreader(encoding)(f)
109
110     def __iter__(self):
111         return self
112
113     def next(self):
114         return next(self.reader).encode("utf-8")
115
116     __next__ = next
117
118 class UnicodeReader:
119     """
120     A CSV reader which will iterate over lines in the CSV file "f",
121     which is encoded in the given encoding.
122     """
123
124     def __init__(self, f, dialect=csv.excel, encoding="utf-8", **kwds):
125         f = UTF8Recoder(f, encoding)
126         self.reader = csv.reader(f, dialect=dialect, **kwds)
127
128     def next(self):
129         row = next(self.reader)
130         return [unicode(s, "utf-8") for s in row]
131
132     def __iter__(self):
133         return self
134
135     __next__ = next
136
137 class UnicodeWriter:
138     """
139     A CSV writer which will write rows to CSV file "f",
140     which is encoded in the given encoding.
141     """
142
143     def __init__(self, f, dialect=csv.excel, encoding="utf-8", **kwds):
144         # Redirect output to a queue
145         self.queue = io.StringIO()
146         self.writer = csv.writer(self.queue, dialect=dialect, **kwds)
147         self.stream = f
148         self.encoder = codecs.getincrementalencoder(encoding)()
149
150     def writerow(self, row):
151         self.writer.writerow([s.encode("utf-8") for s in row])
152         # Fetch UTF-8 output from the queue ...
153         data = self.queue.getvalue()
154         data = data.decode("utf-8")
155         # ... and reencode it into the target encoding
156         data = self.encoder.encode(data)
157         # write to the target stream
158         self.stream.write(data)
159         # empty queue
160         self.queue.truncate(0)
161
162     def writerows(self, rows):
163         for row in rows:
164             self.writerow(row)