diff --git a/docgen.sh b/docgen.sh index 5c1788a0..19b60b89 100755 --- a/docgen.sh +++ b/docgen.sh @@ -15,6 +15,7 @@ pydocmd simple jc.parsers.du+ > ../docs/parsers/du.md pydocmd simple jc.parsers.env+ > ../docs/parsers/env.md pydocmd simple jc.parsers.free+ > ../docs/parsers/free.md pydocmd simple jc.parsers.fstab+ > ../docs/parsers/fstab.md +pydocmd simple jc.parsers.group+ > ../docs/parsers/group.md pydocmd simple jc.parsers.history+ > ../docs/parsers/history.md pydocmd simple jc.parsers.hosts+ > ../docs/parsers/hosts.md pydocmd simple jc.parsers.id+ > ../docs/parsers/id.md diff --git a/docs/parsers/group.md b/docs/parsers/group.md new file mode 100644 index 00000000..dd9de4a6 --- /dev/null +++ b/docs/parsers/group.md @@ -0,0 +1,141 @@ +# jc.parsers.group +jc - JSON CLI output utility /etc/group file Parser + +Usage: + + specify --group as the first argument if the piped input is coming from /etc/group + +Compatibility: + + 'linux', 'darwin', 'aix', 'freebsd' + +Examples: + + $ cat /etc/group | jc --group -p + [ + { + "group_name": "nobody", + "password": "*", + "gid": -2, + "group_list": [] + }, + { + "group_name": "nogroup", + "password": "*", + "gid": -1, + "group_list": [] + }, + { + "group_name": "wheel", + "password": "*", + "gid": 0, + "group_list": [ + "root" + ] + }, + { + "group_name": "certusers", + "password": "*", + "gid": 29, + "group_list": [ + "root", + "_jabber", + "_postfix", + "_cyrus", + "_calendar", + "_dovecot" + ] + }, + ... + ] + + $ cat /etc/group | jc --group -p -r + [ + { + "group_name": "nobody", + "password": "*", + "gid": "-2", + "group_list": [ + "" + ] + }, + { + "group_name": "nogroup", + "password": "*", + "gid": "-1", + "group_list": [ + "" + ] + }, + { + "group_name": "wheel", + "password": "*", + "gid": "0", + "group_list": [ + "root" + ] + }, + { + "group_name": "certusers", + "password": "*", + "gid": "29", + "group_list": [ + "root", + "_jabber", + "_postfix", + "_cyrus", + "_calendar", + "_dovecot" + ] + }, + ... + ] + +## info +```python +info(self, /, *args, **kwargs) +``` + +## process +```python +process(proc_data) +``` + +Final processing to conform to the schema. + +Parameters: + + proc_data: (dictionary) raw structured data to process + +Returns: + + List of dictionaries. Structured data with the following schema: + + [ + { + "group_name": string, + "password": string, + "gid": integer, + "group_list": [ + string + ] + } + ] + +## parse +```python +parse(data, raw=False, quiet=False) +``` + +Main text parsing function + +Parameters: + + data: (string) text data to parse + raw: (boolean) output preprocessed JSON if True + quiet: (boolean) suppress warning messages if True + +Returns: + + List of dictionaries. Raw or processed structured data. + diff --git a/jc/cli.py b/jc/cli.py index ea8baa5a..6a7a25bc 100644 --- a/jc/cli.py +++ b/jc/cli.py @@ -33,6 +33,7 @@ parsers = [ 'env', 'free', 'fstab', + 'group', 'history', 'hosts', 'id', diff --git a/jc/parsers/group.py b/jc/parsers/group.py new file mode 100644 index 00000000..ea4c8499 --- /dev/null +++ b/jc/parsers/group.py @@ -0,0 +1,190 @@ +"""jc - JSON CLI output utility /etc/group file Parser + +Usage: + + specify --group as the first argument if the piped input is coming from /etc/group + +Compatibility: + + 'linux', 'darwin', 'aix', 'freebsd' + +Examples: + + $ cat /etc/group | jc --group -p + [ + { + "group_name": "nobody", + "password": "*", + "gid": -2, + "group_list": [] + }, + { + "group_name": "nogroup", + "password": "*", + "gid": -1, + "group_list": [] + }, + { + "group_name": "wheel", + "password": "*", + "gid": 0, + "group_list": [ + "root" + ] + }, + { + "group_name": "certusers", + "password": "*", + "gid": 29, + "group_list": [ + "root", + "_jabber", + "_postfix", + "_cyrus", + "_calendar", + "_dovecot" + ] + }, + ... + ] + + $ cat /etc/group | jc --group -p -r + [ + { + "group_name": "nobody", + "password": "*", + "gid": "-2", + "group_list": [ + "" + ] + }, + { + "group_name": "nogroup", + "password": "*", + "gid": "-1", + "group_list": [ + "" + ] + }, + { + "group_name": "wheel", + "password": "*", + "gid": "0", + "group_list": [ + "root" + ] + }, + { + "group_name": "certusers", + "password": "*", + "gid": "29", + "group_list": [ + "root", + "_jabber", + "_postfix", + "_cyrus", + "_calendar", + "_dovecot" + ] + }, + ... + ] +""" +import jc.utils + + +class info(): + version = '1.0' + description = '/etc/group file parser' + author = 'Kelly Brazil' + author_email = 'kellyjonbrazil@gmail.com' + # details = 'enter any other details here' + + # compatible options: linux, darwin, cygwin, win32, aix, freebsd + compatible = ['linux', 'darwin', 'aix', 'freebsd'] + + +__version__ = info.version + + +def process(proc_data): + """ + Final processing to conform to the schema. + + Parameters: + + proc_data: (dictionary) raw structured data to process + + Returns: + + List of dictionaries. Structured data with the following schema: + + [ + { + "group_name": string, + "password": string, + "gid": integer, + "group_list": [ + string + ] + } + ] + """ + for entry in proc_data: + int_list = ['gid'] + for key in int_list: + if key in entry: + try: + key_int = int(entry[key]) + entry[key] = key_int + except (ValueError): + entry[key] = None + + if entry['group_list'] == ['']: + entry['group_list'] = [] + + return proc_data + + +def parse(data, raw=False, quiet=False): + """ + Main text parsing function + + Parameters: + + data: (string) text data to parse + raw: (boolean) output preprocessed JSON if True + quiet: (boolean) suppress warning messages if True + + Returns: + + List of dictionaries. Raw or processed structured data. + """ + if not quiet: + jc.utils.compatibility(__name__, info.compatible) + + raw_output = [] + cleandata = data.splitlines() + + # Clear any blank lines + cleandata = list(filter(None, cleandata)) + + if cleandata: + for entry in cleandata: + if entry.startswith('#'): + continue + + output_line = {} + fields = entry.split(':') + + output_line['group_name'] = fields[0] + output_line['password'] = fields[1] + output_line['gid'] = fields[2] + output_line['group_list'] = fields[3].split(',') + + raw_output.append(output_line) + + if raw: + return raw_output + else: + return process(raw_output)