mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
5d226f86b6
* Remove ANSIBLE_METADATA * remove from other modules * remove from plugins and scripts
228 lines
6.7 KiB
Python
228 lines
6.7 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2012, Afterburn <https://github.com/afterburn>
|
|
# (c) 2013, Aaron Bull Schaefer <aaron@elasticdog.com>
|
|
# (c) 2015, Jonathan Lestrelin <jonathan.lestrelin@gmail.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: pear
|
|
short_description: Manage pear/pecl packages
|
|
description:
|
|
- Manage PHP packages with the pear package manager.
|
|
author:
|
|
- Jonathan Lestrelin (@jle64) <jonathan.lestrelin@gmail.com>
|
|
options:
|
|
name:
|
|
description:
|
|
- Name of the package to install, upgrade, or remove.
|
|
required: true
|
|
|
|
state:
|
|
description:
|
|
- Desired state of the package.
|
|
default: "present"
|
|
choices: ["present", "absent", "latest"]
|
|
executable:
|
|
description:
|
|
- Path to the pear executable
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Install pear package
|
|
- pear:
|
|
name: Net_URL2
|
|
state: present
|
|
|
|
# Install pecl package
|
|
- pear:
|
|
name: pecl/json_post
|
|
state: present
|
|
|
|
# Upgrade package
|
|
- pear:
|
|
name: Net_URL2
|
|
state: latest
|
|
|
|
# Remove packages
|
|
- pear:
|
|
name: Net_URL2,pecl/json_post
|
|
state: absent
|
|
'''
|
|
|
|
import os
|
|
|
|
from ansible.module_utils._text import to_text
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
|
|
def get_local_version(pear_output):
|
|
"""Take pear remoteinfo output and get the installed version"""
|
|
lines = pear_output.split('\n')
|
|
for line in lines:
|
|
if 'Installed ' in line:
|
|
installed = line.rsplit(None, 1)[-1].strip()
|
|
if installed == '-':
|
|
continue
|
|
return installed
|
|
return None
|
|
|
|
|
|
def _get_pear_path(module):
|
|
if module.params['executable'] and os.path.isfile(module.params['executable']):
|
|
result = module.params['executable']
|
|
else:
|
|
result = module.get_bin_path('pear', True, [module.params['executable']])
|
|
return result
|
|
|
|
|
|
def get_repository_version(pear_output):
|
|
"""Take pear remote-info output and get the latest version"""
|
|
lines = pear_output.split('\n')
|
|
for line in lines:
|
|
if 'Latest ' in line:
|
|
return line.rsplit(None, 1)[-1].strip()
|
|
return None
|
|
|
|
|
|
def query_package(module, name, state="present"):
|
|
"""Query the package status in both the local system and the repository.
|
|
Returns a boolean to indicate if the package is installed,
|
|
and a second boolean to indicate if the package is up-to-date."""
|
|
if state == "present":
|
|
lcmd = "%s info %s" % (_get_pear_path(module), name)
|
|
lrc, lstdout, lstderr = module.run_command(lcmd, check_rc=False)
|
|
if lrc != 0:
|
|
# package is not installed locally
|
|
return False, False
|
|
|
|
rcmd = "%s remote-info %s" % (_get_pear_path(module), name)
|
|
rrc, rstdout, rstderr = module.run_command(rcmd, check_rc=False)
|
|
|
|
# get the version installed locally (if any)
|
|
lversion = get_local_version(rstdout)
|
|
|
|
# get the version in the repository
|
|
rversion = get_repository_version(rstdout)
|
|
|
|
if rrc == 0:
|
|
# Return True to indicate that the package is installed locally,
|
|
# and the result of the version number comparison
|
|
# to determine if the package is up-to-date.
|
|
return True, (lversion == rversion)
|
|
|
|
return False, False
|
|
|
|
|
|
def remove_packages(module, packages):
|
|
remove_c = 0
|
|
# Using a for loop in case of error, we can report the package that failed
|
|
for package in packages:
|
|
# Query the package first, to see if we even need to remove
|
|
installed, updated = query_package(module, package)
|
|
if not installed:
|
|
continue
|
|
|
|
cmd = "%s uninstall %s" % (_get_pear_path(module), package)
|
|
rc, stdout, stderr = module.run_command(cmd, check_rc=False)
|
|
|
|
if rc != 0:
|
|
module.fail_json(msg="failed to remove %s: %s" % (package, to_text(stdout + stderr)))
|
|
|
|
remove_c += 1
|
|
|
|
if remove_c > 0:
|
|
|
|
module.exit_json(changed=True, msg="removed %s package(s)" % remove_c)
|
|
|
|
module.exit_json(changed=False, msg="package(s) already absent")
|
|
|
|
|
|
def install_packages(module, state, packages):
|
|
install_c = 0
|
|
|
|
for i, package in enumerate(packages):
|
|
# if the package is installed and state == present
|
|
# or state == latest and is up-to-date then skip
|
|
installed, updated = query_package(module, package)
|
|
if installed and (state == 'present' or (state == 'latest' and updated)):
|
|
continue
|
|
|
|
if state == 'present':
|
|
command = 'install'
|
|
|
|
if state == 'latest':
|
|
command = 'upgrade'
|
|
|
|
cmd = "%s %s %s" % (_get_pear_path(module), command, package)
|
|
rc, stdout, stderr = module.run_command(cmd, check_rc=False)
|
|
|
|
if rc != 0:
|
|
module.fail_json(msg="failed to install %s: %s" % (package, to_text(stdout + stderr)))
|
|
|
|
install_c += 1
|
|
|
|
if install_c > 0:
|
|
module.exit_json(changed=True, msg="installed %s package(s)" % (install_c))
|
|
|
|
module.exit_json(changed=False, msg="package(s) already installed")
|
|
|
|
|
|
def check_packages(module, packages, state):
|
|
would_be_changed = []
|
|
for package in packages:
|
|
installed, updated = query_package(module, package)
|
|
if ((state in ["present", "latest"] and not installed) or
|
|
(state == "absent" and installed) or
|
|
(state == "latest" and not updated)):
|
|
would_be_changed.append(package)
|
|
if would_be_changed:
|
|
if state == "absent":
|
|
state = "removed"
|
|
module.exit_json(changed=True, msg="%s package(s) would be %s" % (
|
|
len(would_be_changed), state))
|
|
else:
|
|
module.exit_json(change=False, msg="package(s) already %s" % state)
|
|
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec=dict(
|
|
name=dict(aliases=['pkg'], required=True),
|
|
state=dict(default='present', choices=['present', 'installed', "latest", 'absent', 'removed']),
|
|
executable=dict(default=None, required=False, type='path')),
|
|
supports_check_mode=True)
|
|
|
|
p = module.params
|
|
|
|
# normalize the state parameter
|
|
if p['state'] in ['present', 'installed']:
|
|
p['state'] = 'present'
|
|
elif p['state'] in ['absent', 'removed']:
|
|
p['state'] = 'absent'
|
|
|
|
if p['name']:
|
|
pkgs = p['name'].split(',')
|
|
|
|
pkg_files = []
|
|
for i, pkg in enumerate(pkgs):
|
|
pkg_files.append(None)
|
|
|
|
if module.check_mode:
|
|
check_packages(module, pkgs, p['state'])
|
|
|
|
if p['state'] in ['present', 'latest']:
|
|
install_packages(module, p['state'], pkgs)
|
|
elif p['state'] == 'absent':
|
|
remove_packages(module, pkgs)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|