mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
3ad920c872
* gconftool2: improvements
* added changelog fragment
* typo
* Update changelogs/fragments/4647-gconftool2-command-arg.yaml
Per recommendation from Felix. Danke!
(cherry picked from commit fbff98c5f2)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
229 lines
7.6 KiB
Python
229 lines
7.6 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2016, Kenneth D. Evensen <kevensen@redhat.com>
|
|
# Copyright: (c) 2017, Abhijeet Kasurde <akasurde@redhat.com>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = '''
|
|
module: gconftool2
|
|
author:
|
|
- Kenneth D. Evensen (@kevensen)
|
|
short_description: Edit GNOME Configurations
|
|
description:
|
|
- This module allows for the manipulation of GNOME 2 Configuration via
|
|
gconftool-2. Please see the gconftool-2(1) man pages for more details.
|
|
options:
|
|
key:
|
|
type: str
|
|
description:
|
|
- A GConf preference key is an element in the GConf repository
|
|
that corresponds to an application preference. See man gconftool-2(1)
|
|
required: yes
|
|
value:
|
|
type: str
|
|
description:
|
|
- Preference keys typically have simple values such as strings,
|
|
integers, or lists of strings and integers. This is ignored if the state
|
|
is "get". See man gconftool-2(1)
|
|
value_type:
|
|
type: str
|
|
description:
|
|
- The type of value being set. This is ignored if the state is "get".
|
|
choices: [ bool, float, int, string ]
|
|
state:
|
|
type: str
|
|
description:
|
|
- The action to take upon the key/value.
|
|
required: yes
|
|
choices: [ absent, get, present ]
|
|
config_source:
|
|
type: str
|
|
description:
|
|
- Specify a configuration source to use rather than the default path.
|
|
See man gconftool-2(1)
|
|
direct:
|
|
description:
|
|
- Access the config database directly, bypassing server. If direct is
|
|
specified then the config_source must be specified as well.
|
|
See man gconftool-2(1)
|
|
type: bool
|
|
default: 'no'
|
|
'''
|
|
|
|
EXAMPLES = """
|
|
- name: Change the widget font to "Serif 12"
|
|
community.general.gconftool2:
|
|
key: "/desktop/gnome/interface/font_name"
|
|
value_type: "string"
|
|
value: "Serif 12"
|
|
"""
|
|
|
|
RETURN = '''
|
|
key:
|
|
description: The key specified in the module parameters
|
|
returned: success
|
|
type: str
|
|
sample: /desktop/gnome/interface/font_name
|
|
value_type:
|
|
description: The type of the value that was changed
|
|
returned: success
|
|
type: str
|
|
sample: string
|
|
value:
|
|
description: The value of the preference key after executing the module
|
|
returned: success
|
|
type: str
|
|
sample: "Serif 12"
|
|
...
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
|
|
class GConf2Preference(object):
|
|
def __init__(self, ansible, key, value_type, value,
|
|
direct=False, config_source=""):
|
|
self.ansible = ansible
|
|
self.key = key
|
|
self.value_type = value_type
|
|
self.value = value
|
|
self.config_source = config_source
|
|
self.direct = direct
|
|
|
|
def value_already_set(self):
|
|
return False
|
|
|
|
def call(self, call_type, fail_onerr=True):
|
|
""" Helper function to perform gconftool-2 operations """
|
|
config_source = []
|
|
direct = []
|
|
changed = False
|
|
out = ''
|
|
|
|
# If the configuration source is different from the default, create
|
|
# the argument
|
|
if self.config_source is not None and len(self.config_source) > 0:
|
|
config_source = ["--config-source", self.config_source]
|
|
|
|
# If direct is true, create the argument
|
|
if self.direct:
|
|
direct = ["--direct"]
|
|
|
|
# Execute the call
|
|
cmd = ["gconftool-2"]
|
|
try:
|
|
# If the call is "get", then we don't need as many parameters and
|
|
# we can ignore some
|
|
if call_type == 'get':
|
|
cmd.extend(["--get", self.key])
|
|
# Otherwise, we will use all relevant parameters
|
|
elif call_type == 'set':
|
|
cmd.extend(direct)
|
|
cmd.extend(config_source)
|
|
cmd.extend(["--type", self.value_type, "--{3}".format(call_type), self.key, self.value])
|
|
elif call_type == 'unset':
|
|
cmd.extend(["--unset", self.key])
|
|
|
|
# Start external command
|
|
rc, out, err = self.ansible.run_command(cmd)
|
|
|
|
if err and fail_onerr:
|
|
self.ansible.fail_json(msg='gconftool-2 failed with '
|
|
'error: %s' % (str(err)))
|
|
else:
|
|
changed = True
|
|
|
|
except OSError as exception:
|
|
self.ansible.fail_json(msg='gconftool-2 failed with exception: '
|
|
'%s' % exception)
|
|
return changed, out.rstrip()
|
|
|
|
|
|
def main():
|
|
# Setup the Ansible module
|
|
module = AnsibleModule(
|
|
argument_spec=dict(
|
|
key=dict(type='str', required=True, no_log=False),
|
|
value_type=dict(type='str', choices=['bool', 'float', 'int', 'string']),
|
|
value=dict(type='str'),
|
|
state=dict(type='str', required=True, choices=['absent', 'get', 'present']),
|
|
direct=dict(type='bool', default=False),
|
|
config_source=dict(type='str'),
|
|
),
|
|
supports_check_mode=True
|
|
)
|
|
|
|
state_values = {"present": "set", "absent": "unset", "get": "get"}
|
|
|
|
# Assign module values to dictionary values
|
|
key = module.params['key']
|
|
value_type = module.params['value_type']
|
|
if module.params['value'].lower() == "true":
|
|
value = "true"
|
|
elif module.params['value'] == "false":
|
|
value = "false"
|
|
else:
|
|
value = module.params['value']
|
|
|
|
state = state_values[module.params['state']]
|
|
direct = module.params['direct']
|
|
config_source = module.params['config_source']
|
|
|
|
# Initialize some variables for later
|
|
change = False
|
|
new_value = ''
|
|
|
|
if state != "get":
|
|
if value is None or value == "":
|
|
module.fail_json(msg='State %s requires "value" to be set'
|
|
% str(state))
|
|
elif value_type is None or value_type == "":
|
|
module.fail_json(msg='State %s requires "value_type" to be set'
|
|
% str(state))
|
|
|
|
if direct and config_source is None:
|
|
module.fail_json(msg='If "direct" is "yes" then the ' +
|
|
'"config_source" must be specified')
|
|
elif not direct and config_source is not None:
|
|
module.fail_json(msg='If the "config_source" is specified ' +
|
|
'then "direct" must be "yes"')
|
|
|
|
# Create a gconf2 preference
|
|
gconf_pref = GConf2Preference(module, key, value_type,
|
|
value, direct, config_source)
|
|
# Now we get the current value, if not found don't fail
|
|
dummy, current_value = gconf_pref.call("get", fail_onerr=False)
|
|
|
|
# Check if the current value equals the value we want to set. If not, make
|
|
# a change
|
|
if current_value != value:
|
|
# If check mode, we know a change would have occurred.
|
|
if module.check_mode:
|
|
# So we will set the change to True
|
|
change = True
|
|
# And set the new_value to the value that would have been set
|
|
new_value = value
|
|
# If not check mode make the change.
|
|
else:
|
|
change, new_value = gconf_pref.call(state)
|
|
# If the value we want to set is the same as the current_value, we will
|
|
# set the new_value to the current_value for reporting
|
|
else:
|
|
new_value = current_value
|
|
|
|
facts = dict(gconftool2={'changed': change,
|
|
'key': key,
|
|
'value_type': value_type,
|
|
'new_value': new_value,
|
|
'previous_value': current_value,
|
|
'playbook_value': module.params['value']})
|
|
|
|
module.exit_json(changed=change, ansible_facts=facts)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|