text: #!/usr/bin/python
  # -*- coding: utf-8 -*-
  
  # (c) 2013, Patrick Pelletier <pp.pelletier@gmail.com>
  # Based on pacman (Afterburn) and pkgin (Shaun Zinck) modules
  #
  # 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
  
  
  ANSIBLE_METADATA = {'metadata_version': '1.1',
                      'status': ['preview'],
                      'supported_by': 'community'}
  
  
  DOCUMENTATION = '''
  ---
  module: opkg
  author: "Patrick Pelletier (@skinp)"
  short_description: Package manager for OpenWrt
  description:
      - Manages OpenWrt packages
  version_added: "1.1"
  options:
      name:
          description:
              - name of package to install/remove
          required: true
      state:
          description:
              - state of the package
          choices: [ 'present', 'absent' ]
          required: false
          default: present
      force:
          description:
              - opkg --force parameter used
          choices:
              - ""
              - "depends"
              - "maintainer"
              - "reinstall"
              - "overwrite"
              - "downgrade"
              - "space"
              - "postinstall"
              - "remove"
              - "checksum"
              - "removal-of-dependent-packages"
          required: false
          default: absent
          version_added: "2.0"
      update_cache:
          description:
              - update the package db first
          required: false
          default: "no"
          choices: [ "yes", "no" ]
  notes:  []
  requirements:
      - opkg
      - python
  '''
  EXAMPLES = '''
  - opkg:
      name: foo
      state: present
  
  - opkg:
      name: foo
      state: present
      update_cache: yes
  
  - opkg:
      name: foo
      state: absent
  
  - opkg:
      name: foo,bar
      state: absent
  
  - opkg:
      name: foo
      state: present
      force: overwrite
  '''
  
  import pipes
  
  def update_package_db(module, opkg_path):
      """ Updates packages list. """
  
      rc, out, err = module.run_command("%s update" % opkg_path)
  
      if rc != 0:
          module.fail_json(msg="could not update package db")
  
  
  def query_package(module, opkg_path, name, state="present"):
      """ Returns whether a package is installed or not. """
  
      if state == "present":
  
          rc, out, err = module.run_command("%s list-installed | grep -q \"^%s \"" % (pipes.quote(opkg_path), pipes.quote(name)), use_unsafe_shell=True)
          if rc == 0:
              return True
  
          return False
  
  
  def remove_packages(module, opkg_path, packages):
      """ Uninstalls one or more packages if installed. """
  
      p = module.params
      force = p["force"]
      if force:
          force = "--force-%s" % force
  
      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
          if not query_package(module, opkg_path, package):
              continue
  
          rc, out, err = module.run_command("%s remove %s %s" % (opkg_path, force, package))
  
          if query_package(module, opkg_path, 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, opkg_path, packages):
      """ Installs one or more packages if not already installed. """
  
      p = module.params
      force = p["force"]
      if force:
          force = "--force-%s" % force
  
      install_c = 0
  
      for package in packages:
          if query_package(module, opkg_path, package):
              continue
  
          rc, out, err = module.run_command("%s install %s %s" % (opkg_path, force, package))
  
          if not query_package(module, opkg_path, package):
              module.fail_json(msg="failed to install %s: %s" % (package, out))
  
          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 present")
  
  
  def main():
      module = AnsibleModule(
          argument_spec=dict(
              name=dict(aliases=["pkg"], required=True),
              state=dict(default="present", choices=["present", "installed", "absent", "removed"]),
              force=dict(default="", choices=["", "depends", "maintainer", "reinstall", "overwrite", "downgrade", "space", "postinstall", "remove",
                                              "checksum", "removal-of-dependent-packages"]),
              update_cache=dict(default="no", aliases=["update-cache"], type='bool')
          )
      )
  
      opkg_path = module.get_bin_path('opkg', True, ['/bin'])
  
      p = module.params
  
      if p["update_cache"]:
          update_package_db(module, opkg_path)
  
      pkgs = p["name"].split(",")
  
      if p["state"] in ["present", "installed"]:
          install_packages(module, opkg_path, pkgs)
  
      elif p["state"] in ["absent", "removed"]:
          remove_packages(module, opkg_path, pkgs)
  
  # import module snippets
  from ansible.module_utils.basic import *
  
  if __name__ == '__main__':
      main()
  