Merge pull request #4908 from berenddeboer/portinstall

Support to install software on FreeBSD using portinstall.

library/packaging/portinstall

+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) 2013, berenddeboer
+# Written by berenddeboer <berend@pobox.com>
+# Based on pkgng module written by bleader <bleader at ratonland.org>
+#
+# This module is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This software is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this software.  If not, see <http://www.gnu.org/licenses/>.
+
+
+DOCUMENTATION = '''
+---
+module: portinstall
+short_description: Installing packages from FreeBSD's ports system
+description:
+    - Manage packages for FreeBSD using 'portinstall'.
+version_added: "1.3"
+options:
+    name:
+        description:
+            - name of package to install/remove
+        required: true
+    state:
+        description:
+            - state of the package
+        choices: [ 'present', 'absent' ]
+        required: false
+        default: present
+    use_packages:
+        description:
+            - use packages instead of ports whenever available
+        choices: [ 'yes', 'no' ]
+        required: false
+        default: yes
+author: berenddeboer
+notes:
+'''
+
+EXAMPLES = '''
+# Install package foo
+- portinstall: name=foo state=present
+
+# Install package security/cyrus-sasl2-saslauthd
+- portinstall: name=security/cyrus-sasl2-saslauthd state=present
+
+# Remove packages foo and bar
+- portinstall: name=foo,bar state=absent
+'''
+
+
+import json
+import shlex
+import os
+import sys
+
+def query_package(module, name):
+
+    pkg_info_path = module.get_bin_path('pkg_info', False)
+
+    # Assume that if we have pkg_info, we haven't upgraded to pkgng
+    if pkg_info_path:
+        pkgng = False
+        pkg_glob_path = module.get_bin_path('pkg_glob', True)
+        rc, out, err = module.run_command("%s -e `pkg_glob %s`" % (pkg_info_path, name))
+    else:
+        pkgng = True
+        pkg_info_path = module.get_bin_path('pkg', True)
+        pkg_info_path = pkg_info_path + " info"
+        rc, out, err = module.run_command("%s %s" % (pkg_info_path, name))
+
+    found = rc == 0
+
+    if not found:
+        # databases/mysql55-client installs as mysql-client, so try solving
+        # that the ugly way. Pity FreeBSD doesn't have a fool proof way of checking
+        # some package is installed
+        name_without_digits = re.sub('[0-9]', '', name)
+        if name != name_without_digits:
+            if pkgng:
+                rc, out, err = module.run_command("%s %s" % (pkg_info_path, name_without_digits))
+            else:
+                rc, out, err = module.run_command("%s `%s %s`" % (pkg_info_path, pkg_glob_path, name_without_digits))
+
+        found = rc == 0
+
+    return found
+
+
+def matching_packages(module, name):
+
+    ports_glob_path = module.get_bin_path('ports_glob', True)
+    rc, out, err = module.run_command("%s %s | wc" % (ports_glob_path, name))
+    parts = out.split()
+    occurrences = int(parts[0])
+    if occurrences == 0:
+        name_without_digits = re.sub('[0-9]', '', name)
+        if name != name_without_digits:
+            rc, out, err = module.run_command("%s %s | wc" % (ports_glob_path, name_without_digits))
+            parts = out.split()
+            occurrences = int(parts[0])
+    return occurrences
+
+
+def remove_packages(module, packages):
+
+    remove_c = 0
+    pkg_glob_path = module.get_bin_path('pkg_glob', True)
+
+    # If pkg_delete not found, we assume pkgng
+    pkg_delete_path = module.get_bin_path('pkg_delete', False)
+    if not pkg_delete_path:
+        pkg_delete_path = module.get_bin_path('pkg', True)
+        pkg_delete_path = pkg_delete_path + " delete -y"
+
+    # Using a for loop incase 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
+        if not query_package(module, package):
+            continue
+
+        rc, out, err = module.run_command("%s `%s %s`" % (pkg_delete_path, pkg_glob_path, package))
+
+        if query_package(module, package):
+            name_without_digits = re.sub('[0-9]', '', package)
+            rc, out, err = module.run_command("%s `%s %s`" % (pkg_delete_path, pkg_glob_path, name_without_digits))
+            if query_package(module, package):
+                module.fail_json(msg="failed to remove %s: %s" % (package, out))
+
+        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, packages, use_packages):
+
+    install_c = 0
+
+    # If portinstall not found, automagically install
+    portinstall_path = module.get_bin_path('portinstall', False)
+    if not portinstall_path:
+        pkg_path = module.get_bin_path('pkg', False)
+        if pkg_path:
+            module.run_command("pkg install -y portupgrade")
+        portinstall_path = module.get_bin_path('portinstall', True)
+
+    if use_packages == "yes":
+        portinstall_params="--use-packages"
+    else:
+        portinstall_params=""
+
+    for package in packages:
+        if query_package(module, package):
+            continue
+
+        # TODO: check how many match
+        matches = matching_packages(module, package)
+        if matches == 1:
+            rc, out, err = module.run_command("%s --batch %s %s" % (portinstall_path, portinstall_params, package))
+            if not query_package(module, package):
+                module.fail_json(msg="failed to install %s: %s" % (package, out))
+        elif matches == 0:
+            module.fail_json(msg="no matches for package %s" % (package))
+        else:
+            module.fail_json(msg="%s matches found for package name %s" % (matches, package))
+
+        install_c += 1
+
+    if install_c > 0:
+        module.exit_json(changed=True, msg="present %s package(s)" % (install_c))
+
+    module.exit_json(changed=False, msg="package(s) already present")
+
+
+def main():
+    module = AnsibleModule(
+            argument_spec    = dict(
+                state        = dict(default="present", choices=["present","absent"]),
+                name         = dict(aliases=["pkg"], required=True),
+                use_packages = dict(type='bool', choices=BOOLEANS, default='yes')))
+
+    p = module.params
+
+    pkgs = p["name"].split(",")
+
+    if p["state"] == "present":
+        install_packages(module, pkgs, p["use_packages"])
+
+    elif p["state"] == "absent":
+        remove_packages(module, pkgs)
+
+# this is magic, see lib/ansible/module_common.py
+#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
+
+main()