mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-11 11:41:32 -07:00
Unflatmap community.general (#5461)
* Move files. * Update imports and references. * Move wrongly placed files. * Reverse redirects, deprecate long → short name redirects. * Simplify contribution guidelines for new modules. * Rewrite BOTMETA. * Add changelog fragment. * Fix ignore.txt files.
This commit is contained in:
Felix Fontein
GitHub
parent
2b0bebc8fc
commit
b531ecdc9b
1033 changed files with 4802 additions and 1989 deletions
397
plugins/modules/osx_defaults.py
Normal file
397
plugins/modules/osx_defaults.py
Normal file
|
|
@ -0,0 +1,397 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright (c) 2014, GeekChimp - Franck Nijhof <franck@geekchimp.com> (DO NOT CONTACT!)
|
||||
# Copyright (c) 2019, Ansible project
|
||||
# Copyright (c) 2019, Abhijeet Kasurde <akasurde@redhat.com>
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: osx_defaults
|
||||
author:
|
||||
# DO NOT RE-ADD GITHUB HANDLE!
|
||||
- Franck Nijhof (!UNKNOWN)
|
||||
short_description: Manage macOS user defaults
|
||||
description:
|
||||
- osx_defaults allows users to read, write, and delete macOS user defaults from Ansible scripts.
|
||||
- macOS applications and other programs use the defaults system to record user preferences and other
|
||||
information that must be maintained when the applications are not running (such as default font for new
|
||||
documents, or the position of an Info panel).
|
||||
options:
|
||||
domain:
|
||||
description:
|
||||
- The domain is a domain name of the form C(com.companyname.appname).
|
||||
type: str
|
||||
default: NSGlobalDomain
|
||||
host:
|
||||
description:
|
||||
- The host on which the preference should apply.
|
||||
- The special value C(currentHost) corresponds to the C(-currentHost) switch of the defaults commandline tool.
|
||||
type: str
|
||||
key:
|
||||
description:
|
||||
- The key of the user preference.
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- The type of value to write.
|
||||
type: str
|
||||
choices: [ array, bool, boolean, date, float, int, integer, string ]
|
||||
default: string
|
||||
array_add:
|
||||
description:
|
||||
- Add new elements to the array for a key which has an array as its value.
|
||||
type: bool
|
||||
default: false
|
||||
value:
|
||||
description:
|
||||
- The value to write.
|
||||
- Only required when I(state=present).
|
||||
type: raw
|
||||
state:
|
||||
description:
|
||||
- The state of the user defaults.
|
||||
- If set to C(list) will query the given parameter specified by C(key). Returns 'null' is nothing found or mis-spelled.
|
||||
- C(list) added in version 2.8.
|
||||
type: str
|
||||
choices: [ absent, list, present ]
|
||||
default: present
|
||||
path:
|
||||
description:
|
||||
- The path in which to search for C(defaults).
|
||||
type: str
|
||||
default: /usr/bin:/usr/local/bin
|
||||
notes:
|
||||
- Apple Mac caches defaults. You may need to logout and login to apply the changes.
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
# TODO: Describe what happens in each example
|
||||
|
||||
- community.general.osx_defaults:
|
||||
domain: com.apple.Safari
|
||||
key: IncludeInternalDebugMenu
|
||||
type: bool
|
||||
value: true
|
||||
state: present
|
||||
|
||||
- community.general.osx_defaults:
|
||||
domain: NSGlobalDomain
|
||||
key: AppleMeasurementUnits
|
||||
type: string
|
||||
value: Centimeters
|
||||
state: present
|
||||
|
||||
- community.general.osx_defaults:
|
||||
domain: /Library/Preferences/com.apple.SoftwareUpdate
|
||||
key: AutomaticCheckEnabled
|
||||
type: int
|
||||
value: 1
|
||||
become: true
|
||||
|
||||
- community.general.osx_defaults:
|
||||
domain: com.apple.screensaver
|
||||
host: currentHost
|
||||
key: showClock
|
||||
type: int
|
||||
value: 1
|
||||
|
||||
- community.general.osx_defaults:
|
||||
key: AppleMeasurementUnits
|
||||
type: string
|
||||
value: Centimeters
|
||||
|
||||
- community.general.osx_defaults:
|
||||
key: AppleLanguages
|
||||
type: array
|
||||
value:
|
||||
- en
|
||||
- nl
|
||||
|
||||
- community.general.osx_defaults:
|
||||
domain: com.geekchimp.macable
|
||||
key: ExampleKeyToRemove
|
||||
state: absent
|
||||
'''
|
||||
|
||||
from datetime import datetime
|
||||
import re
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.six import binary_type, text_type
|
||||
|
||||
|
||||
# exceptions --------------------------------------------------------------- {{{
|
||||
class OSXDefaultsException(Exception):
|
||||
def __init__(self, msg):
|
||||
self.message = msg
|
||||
|
||||
|
||||
# /exceptions -------------------------------------------------------------- }}}
|
||||
|
||||
# class MacDefaults -------------------------------------------------------- {{{
|
||||
class OSXDefaults(object):
|
||||
""" Class to manage Mac OS user defaults """
|
||||
|
||||
# init ---------------------------------------------------------------- {{{
|
||||
def __init__(self, module):
|
||||
""" Initialize this module. Finds 'defaults' executable and preps the parameters """
|
||||
# Initial var for storing current defaults value
|
||||
self.current_value = None
|
||||
self.module = module
|
||||
self.domain = module.params['domain']
|
||||
self.host = module.params['host']
|
||||
self.key = module.params['key']
|
||||
self.type = module.params['type']
|
||||
self.array_add = module.params['array_add']
|
||||
self.value = module.params['value']
|
||||
self.state = module.params['state']
|
||||
self.path = module.params['path']
|
||||
|
||||
# Try to find the defaults executable
|
||||
self.executable = self.module.get_bin_path(
|
||||
'defaults',
|
||||
required=False,
|
||||
opt_dirs=self.path.split(':'),
|
||||
)
|
||||
|
||||
if not self.executable:
|
||||
raise OSXDefaultsException("Unable to locate defaults executable.")
|
||||
|
||||
# Ensure the value is the correct type
|
||||
if self.state != 'absent':
|
||||
self.value = self._convert_type(self.type, self.value)
|
||||
|
||||
# /init --------------------------------------------------------------- }}}
|
||||
|
||||
# tools --------------------------------------------------------------- {{{
|
||||
@staticmethod
|
||||
def is_int(value):
|
||||
as_str = str(value)
|
||||
if (as_str.startswith("-")):
|
||||
return as_str[1:].isdigit()
|
||||
else:
|
||||
return as_str.isdigit()
|
||||
|
||||
@staticmethod
|
||||
def _convert_type(data_type, value):
|
||||
""" Converts value to given type """
|
||||
if data_type == "string":
|
||||
return str(value)
|
||||
elif data_type in ["bool", "boolean"]:
|
||||
if isinstance(value, (binary_type, text_type)):
|
||||
value = value.lower()
|
||||
if value in [True, 1, "true", "1", "yes"]:
|
||||
return True
|
||||
elif value in [False, 0, "false", "0", "no"]:
|
||||
return False
|
||||
raise OSXDefaultsException("Invalid boolean value: {0}".format(repr(value)))
|
||||
elif data_type == "date":
|
||||
try:
|
||||
return datetime.strptime(value.split("+")[0].strip(), "%Y-%m-%d %H:%M:%S")
|
||||
except ValueError:
|
||||
raise OSXDefaultsException(
|
||||
"Invalid date value: {0}. Required format yyy-mm-dd hh:mm:ss.".format(repr(value))
|
||||
)
|
||||
elif data_type in ["int", "integer"]:
|
||||
if not OSXDefaults.is_int(value):
|
||||
raise OSXDefaultsException("Invalid integer value: {0}".format(repr(value)))
|
||||
return int(value)
|
||||
elif data_type == "float":
|
||||
try:
|
||||
value = float(value)
|
||||
except ValueError:
|
||||
raise OSXDefaultsException("Invalid float value: {0}".format(repr(value)))
|
||||
return value
|
||||
elif data_type == "array":
|
||||
if not isinstance(value, list):
|
||||
raise OSXDefaultsException("Invalid value. Expected value to be an array")
|
||||
return value
|
||||
|
||||
raise OSXDefaultsException('Type is not supported: {0}'.format(data_type))
|
||||
|
||||
def _host_args(self):
|
||||
""" Returns a normalized list of commandline arguments based on the "host" attribute """
|
||||
if self.host is None:
|
||||
return []
|
||||
elif self.host == 'currentHost':
|
||||
return ['-currentHost']
|
||||
else:
|
||||
return ['-host', self.host]
|
||||
|
||||
def _base_command(self):
|
||||
""" Returns a list containing the "defaults" executable and any common base arguments """
|
||||
return [self.executable] + self._host_args()
|
||||
|
||||
@staticmethod
|
||||
def _convert_defaults_str_to_list(value):
|
||||
""" Converts array output from defaults to an list """
|
||||
# Split output of defaults. Every line contains a value
|
||||
value = value.splitlines()
|
||||
|
||||
# Remove first and last item, those are not actual values
|
||||
value.pop(0)
|
||||
value.pop(-1)
|
||||
|
||||
# Remove spaces at beginning and comma (,) at the end, unquote and unescape double quotes
|
||||
value = [re.sub('^ *"?|"?,? *$', '', x.replace('\\"', '"')) for x in value]
|
||||
|
||||
return value
|
||||
|
||||
# /tools -------------------------------------------------------------- }}}
|
||||
|
||||
# commands ------------------------------------------------------------ {{{
|
||||
def read(self):
|
||||
""" Reads value of this domain & key from defaults """
|
||||
# First try to find out the type
|
||||
rc, out, err = self.module.run_command(self._base_command() + ["read-type", self.domain, self.key])
|
||||
|
||||
# If RC is 1, the key does not exist
|
||||
if rc == 1:
|
||||
return None
|
||||
|
||||
# If the RC is not 0, then terrible happened! Ooooh nooo!
|
||||
if rc != 0:
|
||||
raise OSXDefaultsException("An error occurred while reading key type from defaults: %s" % out)
|
||||
|
||||
# Ok, lets parse the type from output
|
||||
data_type = out.strip().replace('Type is ', '')
|
||||
|
||||
# Now get the current value
|
||||
rc, out, err = self.module.run_command(self._base_command() + ["read", self.domain, self.key])
|
||||
|
||||
# Strip output
|
||||
out = out.strip()
|
||||
|
||||
# An non zero RC at this point is kinda strange...
|
||||
if rc != 0:
|
||||
raise OSXDefaultsException("An error occurred while reading key value from defaults: %s" % out)
|
||||
|
||||
# Convert string to list when type is array
|
||||
if data_type == "array":
|
||||
out = self._convert_defaults_str_to_list(out)
|
||||
|
||||
# Store the current_value
|
||||
self.current_value = self._convert_type(data_type, out)
|
||||
|
||||
def write(self):
|
||||
""" Writes value to this domain & key to defaults """
|
||||
# We need to convert some values so the defaults commandline understands it
|
||||
if isinstance(self.value, bool):
|
||||
if self.value:
|
||||
value = "TRUE"
|
||||
else:
|
||||
value = "FALSE"
|
||||
elif isinstance(self.value, (int, float)):
|
||||
value = str(self.value)
|
||||
elif self.array_add and self.current_value is not None:
|
||||
value = list(set(self.value) - set(self.current_value))
|
||||
elif isinstance(self.value, datetime):
|
||||
value = self.value.strftime('%Y-%m-%d %H:%M:%S')
|
||||
else:
|
||||
value = self.value
|
||||
|
||||
# When the type is array and array_add is enabled, morph the type :)
|
||||
if self.type == "array" and self.array_add:
|
||||
self.type = "array-add"
|
||||
|
||||
# All values should be a list, for easy passing it to the command
|
||||
if not isinstance(value, list):
|
||||
value = [value]
|
||||
|
||||
rc, out, err = self.module.run_command(self._base_command() + ['write', self.domain, self.key, '-' + self.type] + value,
|
||||
expand_user_and_vars=False)
|
||||
|
||||
if rc != 0:
|
||||
raise OSXDefaultsException('An error occurred while writing value to defaults: %s' % out)
|
||||
|
||||
def delete(self):
|
||||
""" Deletes defaults key from domain """
|
||||
rc, out, err = self.module.run_command(self._base_command() + ['delete', self.domain, self.key])
|
||||
if rc != 0:
|
||||
raise OSXDefaultsException("An error occurred while deleting key from defaults: %s" % out)
|
||||
|
||||
# /commands ----------------------------------------------------------- }}}
|
||||
|
||||
# run ----------------------------------------------------------------- {{{
|
||||
""" Does the magic! :) """
|
||||
|
||||
def run(self):
|
||||
|
||||
# Get the current value from defaults
|
||||
self.read()
|
||||
|
||||
if self.state == 'list':
|
||||
self.module.exit_json(key=self.key, value=self.current_value)
|
||||
|
||||
# Handle absent state
|
||||
if self.state == "absent":
|
||||
if self.current_value is None:
|
||||
return False
|
||||
if self.module.check_mode:
|
||||
return True
|
||||
self.delete()
|
||||
return True
|
||||
|
||||
# There is a type mismatch! Given type does not match the type in defaults
|
||||
value_type = type(self.value)
|
||||
if self.current_value is not None and not isinstance(self.current_value, value_type):
|
||||
raise OSXDefaultsException("Type mismatch. Type in defaults: %s" % type(self.current_value).__name__)
|
||||
|
||||
# Current value matches the given value. Nothing need to be done. Arrays need extra care
|
||||
if self.type == "array" and self.current_value is not None and not self.array_add and \
|
||||
set(self.current_value) == set(self.value):
|
||||
return False
|
||||
elif self.type == "array" and self.current_value is not None and self.array_add and len(list(set(self.value) - set(self.current_value))) == 0:
|
||||
return False
|
||||
elif self.current_value == self.value:
|
||||
return False
|
||||
|
||||
if self.module.check_mode:
|
||||
return True
|
||||
|
||||
# Change/Create/Set given key/value for domain in defaults
|
||||
self.write()
|
||||
return True
|
||||
|
||||
# /run ---------------------------------------------------------------- }}}
|
||||
|
||||
|
||||
# /class MacDefaults ------------------------------------------------------ }}}
|
||||
|
||||
|
||||
# main -------------------------------------------------------------------- {{{
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
domain=dict(type='str', default='NSGlobalDomain'),
|
||||
host=dict(type='str'),
|
||||
key=dict(type='str', no_log=False),
|
||||
type=dict(type='str', default='string', choices=['array', 'bool', 'boolean', 'date', 'float', 'int', 'integer', 'string']),
|
||||
array_add=dict(type='bool', default=False),
|
||||
value=dict(type='raw'),
|
||||
state=dict(type='str', default='present', choices=['absent', 'list', 'present']),
|
||||
path=dict(type='str', default='/usr/bin:/usr/local/bin'),
|
||||
),
|
||||
supports_check_mode=True,
|
||||
required_if=(
|
||||
('state', 'present', ['value']),
|
||||
),
|
||||
)
|
||||
|
||||
try:
|
||||
defaults = OSXDefaults(module=module)
|
||||
module.exit_json(changed=defaults.run())
|
||||
except OSXDefaultsException as e:
|
||||
module.fail_json(msg=e.message)
|
||||
|
||||
|
||||
# /main ------------------------------------------------------------------- }}}
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Add table
Add a link
Reference in a new issue