"""
LogrotateConf - files ``/etc/logrotate.conf`` and others
========================================================
Class to parse logrotate confuration files:
- ``/etc/logrotate.conf``
- ``/etc/logrotate.d/*``
See: http://www.linuxmanpages.org/8/logrotate
"""
import string
from insights.core import ConfigParser, LegacyItemAccess, Parser
from insights.core.exceptions import ParseException, SkipComponent
from insights.core.plugins import parser
from insights.parsers import get_active_lines
from insights.parsr import (AnyChar, Choice, EOF, EOL, Forward, InSet, LeftCurly, LineEnd,
Literal, Many, Number, OneLineComment, Opt, PosMarker,
QuotedString, RightCurly, String, WS, WSChar, skip_none)
from insights.parsr.query import Directive, Entry, Section
from insights.specs import Specs
PAIRED_OPTS = (
'prerotate',
'postrotate',
'firstaction',
'lastaction',
)
[docs]
@parser(Specs.logrotate_conf)
class LogrotateConf(Parser, LegacyItemAccess):
"""
Class for parsing ``/etc/logrotate.conf`` and ``/etc/logrotate.d/*``
configuration files.
Sample logrotate configuration file::
# sample file
compress
/var/log/messages {
rotate 5
weekly
postrotate
/sbin/killall -HUP syslogd
endscript
}
"/var/log/httpd/access.log" /var/log/httpd/error.log {
rotate 5
mail www@my.org
size=100k
sharedscripts
postrotate
/sbin/killall -HUP httpd
endscript
}
/var/log/news/news.crit
/var/log/news/olds.crit {
monthly
rotate 2
olddir /var/log/news/old
missingok
postrotate
kill -HUP `cat /var/run/inn.pid`
endscript
nocompress
}
Examples:
>>> type(log_rt)
<class 'insights.parsers.logrotate_conf.LogrotateConf'>
>>> log_rt.options
['compress']
>>> log_rt.log_files
['/var/log/messages', '/var/log/httpd/access.log', '/var/log/httpd/error.log', '/var/log/news/news.crit', '/var/log/news/olds.crit']
>>> log_rt['compress']
True
>>> 'weekly' in log_rt['/var/log/messages']
True
>>> log_rt['/var/log/messages']['postrotate']
['/sbin/killall -HUP syslogd']
Attributes:
data(dict): All parsed options and log files are stored in this
dictionary
options(list): List of global options in the configuration file
log_files(list): List of log files in the configuration file
"""
[docs]
def parse_content(self, content):
def _parse_opts(line):
if '=' in line:
l_sp = line.split('=', 1)
else:
l_sp = line.split(None, 1)
# return a (key, value) tuple
return l_sp[0], l_sp[1] if len(l_sp) == 2 else True
self.data = {}
self.options = []
self.log_files = []
log_opts = script = None
log_files = []
for line in get_active_lines(content):
if log_opts is None:
# not in log_file section
if line.lstrip(' \t\'"').startswith('/'):
# log_file line
log_files.extend([l.strip(' \t\'"') for l in line.rstrip('{').split()])
if line.endswith('{'):
# start of the section
log_opts = {} # empty dict indicates in a log_file section
elif not log_files:
# global options
key1, val = _parse_opts(line)
self.data[key1] = val
self.options.append(key1)
else:
# in log_file section
if line.endswith('}') and script is None:
# end of the section,
# save options for each log_file individually
for lf in log_files:
self.data[lf] = log_opts
# collect all log_files
self.log_files.extend(log_files)
log_files = []
log_opts = None
continue
# script options
if line in PAIRED_OPTS:
# in script section
script = line
log_opts[script] = []
continue
if line == 'endscript':
# end of script section
script = None
continue
if script is not None:
# scripts inner PARED_OPTS
log_opts[script].append(line)
else:
# common options in log_file section
key, val = _parse_opts(line)
log_opts[key] = val
class DocParser(object):
def __init__(self, ctx):
self.ctx = ctx
scripts = set("postrotate prerotate firstaction lastaction preremove".split())
Stanza = Forward()
Spaces = Many(WSChar)
Bare = String(set(string.printable) - (set(string.whitespace) | set("=#{}'\"")))
Num = Number & (WSChar | LineEnd)
Comment = OneLineComment("#").map(lambda x: None)
ScriptStart = WS >> PosMarker(Choice([Literal(s) for s in scripts])) << WS
ScriptEnd = Literal("endscript")
Line = (WS >> AnyChar.until(EOL) << WS).map(lambda x: "".join(x))
Lines = Line.until(ScriptEnd | EOF).map(lambda x: "\n".join(x))
Script = ScriptStart + Lines << Opt(ScriptEnd)
Script = Script.map(lambda x: [x[0], [x[1]], None])
BeginBlock = WS >> LeftCurly << WS
EndBlock = WS >> RightCurly
EqualChars = set("=")
Equal = InSet(EqualChars)
First = PosMarker((Bare | QuotedString)) << Spaces
Attr = Spaces >> (Num | Bare | QuotedString) << Spaces
Rest = Opt(Equal) >> Many(Attr)
Block = BeginBlock >> Many(Stanza).map(skip_none).map(self.to_entries) << EndBlock
Stmt = WS >> (Script | (First + Rest + Opt(Block))) << WS
Stanza <= WS >> (Stmt | Comment) << WS
Doc = Many(Stanza).map(skip_none).map(self.to_entries)
self.Top = Doc << EOF
def to_entries(self, x):
ret = []
for i in x:
name, attrs, body = i
if body:
for n in [name.value] + attrs:
ret.append(Section(name=n, children=body, lineno=name.lineno))
else:
ret.append(Directive(name=name.value, attrs=attrs, lineno=name.lineno))
return ret
def __call__(self, content):
try:
return self.Top(content)
except Exception:
raise ParseException("There was an exception when parsing the logrotate config file.")
[docs]
def parse_doc(content, ctx=None):
""" Parse a configuration document into a tree that can be queried. """
if isinstance(content, list):
content = "\n".join(content)
parse = DocParser(ctx)
result = parse(content)
return Entry(children=result, src=ctx)
[docs]
@parser(Specs.logrotate_conf)
class LogRotateConfPEG(ConfigParser):
"""
Class for parsing ``/etc/logrotate.conf`` and ``/etc/logrotate.d/*``
configuration files.
Note: It cannot handle the case without the target log file before
the braces for now.
Sample logrotate configuration file::
# sample file
compress
/var/log/messages {
rotate 5
weekly
postrotate
/sbin/killall -HUP syslogd
endscript
}
"/var/log/httpd/access.log" /var/log/httpd/error.log {
rotate 5
mail www@my.org
size=100k
sharedscripts
postrotate
/sbin/killall -HUP httpd
endscript
}
/var/log/news/news.crit
/var/log/news/olds.crit {
monthly
rotate 2
olddir /var/log/news/old
missingok
postrotate
kill -HUP `cat /var/run/inn.pid`
endscript
nocompress
}
Examples:
>>> type(log_rt_peg)
<class 'insights.parsers.logrotate_conf.LogRotateConfPEG'>
>>> 'compress' in log_rt_peg
True
>>> 'weekly' in log_rt['/var/log/messages']
True
>>> log_rt_peg['/var/log/messages']['postrotate'][-1].value
'/sbin/killall -HUP syslogd'
"""
[docs]
def parse_doc(self, content):
""" configuration format pre-check for logrotate configuration file"""
stack_list = []
glob_opts = ''
scripts = ('postrotate', 'prerotate', 'firstaction', 'lastaction', 'preremove')
for index, line in enumerate(content):
line = line.split("#")[0].strip()
if line.lstrip(' \t\'"').startswith(('/', '~')) and not stack_list:
# Converting the target file configuration format from set vertically to set with space.
glob_opts += ' ' + line.strip()
content[index] = ''
if line in scripts:
stack_list.append('startscript')
elif line == 'endscript' and stack_list[-1] == 'startscript':
stack_list.pop()
if stack_list and stack_list[-1] == 'startscript':
continue
if '{' in line:
if not stack_list:
content[index] = glob_opts.rstrip('{') + ' {'
glob_opts = ''
stack_list.append('{')
# The '}' must be on a separate line.
elif line == '}' and stack_list[-1] == '{':
stack_list.pop()
if stack_list:
raise SkipComponent("Invalid logrotate config file.")
return parse_doc("\n".join(content), ctx=self)