376 lines
13 KiB
Python
376 lines
13 KiB
Python
#!/usr/bin/python
|
|
# encoding: utf-8
|
|
|
|
# (c) 2012, Matt Wright <matt@nobien.net>
|
|
# (c) 2013, Alexander Saltanov <asd@mokote.com>
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible 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.
|
|
#
|
|
# Ansible 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 Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: apt_repository
|
|
short_description: Add and remove APT repositores
|
|
description:
|
|
- Add or remove an APT repositories in Ubuntu and Debian.
|
|
notes:
|
|
- This module works on Debian and Ubuntu and requires only C(python-apt) package.
|
|
- This module supports Debian Squeeze (version 6) as well as its successors.
|
|
- This module treats Debian and Ubuntu distributions separately. So PPA could be installed only on Ubuntu machines.
|
|
options:
|
|
repo:
|
|
required: true
|
|
default: none
|
|
description:
|
|
- A source string for the repository.
|
|
state:
|
|
required: false
|
|
choices: [ "absent", "present" ]
|
|
default: "present"
|
|
description:
|
|
- A source string state.
|
|
author: Alexander Saltanov
|
|
version_added: "0.7"
|
|
requirements: [ python-apt, python-pycurl ]
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Add specified repository into sources list.
|
|
apt_repository: repo='deb http://archive.canonical.com/ubuntu hardy partner' state=present
|
|
|
|
# Add source repository into sources list.
|
|
apt_repository: repo='deb-src http://archive.canonical.com/ubuntu hardy partner' state=present
|
|
|
|
# Remove specified repository from sources list.
|
|
apt_repository: repo='deb http://archive.canonical.com/ubuntu hardy partner' state=absent
|
|
|
|
# On Ubuntu target: add nginx stable repository from PPA and install its signing key.
|
|
# On Debian target: adding PPA is not available, so it will fail immediately.
|
|
apt_repository: repo='ppa:nginx/stable'
|
|
'''
|
|
|
|
import glob
|
|
import json
|
|
import os
|
|
import re
|
|
import tempfile
|
|
|
|
try:
|
|
import apt_pkg
|
|
import aptsources.distro
|
|
distro = aptsources.distro.get_distro()
|
|
HAVE_PYTHON_APT = True
|
|
except ImportError:
|
|
HAVE_PYTHON_APT = False
|
|
|
|
try:
|
|
import pycurl
|
|
HAVE_PYCURL = True
|
|
except ImportError:
|
|
HAVE_PYCURL = False
|
|
|
|
VALID_SOURCE_TYPES = ('deb', 'deb-src')
|
|
|
|
|
|
class CurlCallback:
|
|
def __init__(self):
|
|
self.contents = ''
|
|
|
|
def body_callback(self, buf):
|
|
self.contents = self.contents + buf
|
|
|
|
|
|
class InvalidSource(Exception):
|
|
pass
|
|
|
|
|
|
# Simple version of aptsources.sourceslist.SourcesList.
|
|
# No advanced logic and no backups inside.
|
|
class SourcesList(object):
|
|
def __init__(self):
|
|
self.files = {} # group sources by file
|
|
self.default_file = apt_pkg.config.find_file('Dir::Etc::sourcelist')
|
|
|
|
# read sources.list
|
|
self.load(self.default_file)
|
|
|
|
# read sources.list.d
|
|
for file in glob.iglob('%s/*.list' % apt_pkg.config.find_dir('Dir::Etc::sourceparts')):
|
|
self.load(file)
|
|
|
|
def __iter__(self):
|
|
'''Simple iterator to go over all sources. Empty, non-source, and other not valid lines will be skipped.'''
|
|
for file, sources in self.files.items():
|
|
for n, valid, enabled, source, comment in sources:
|
|
if valid:
|
|
yield file, n, enabled, source, comment
|
|
raise StopIteration
|
|
|
|
def _expand_path(self, filename):
|
|
if '/' in filename:
|
|
return filename
|
|
else:
|
|
return os.path.abspath(os.path.join(apt_pkg.config.find_dir('Dir::Etc::sourceparts'), filename))
|
|
|
|
def _suggest_filename(self, line):
|
|
def _remove_protocol(s):
|
|
if '://' in s:
|
|
return s.split('://')[1]
|
|
else:
|
|
return s
|
|
|
|
def _cleanup_filename(s):
|
|
return '_'.join(re.sub('[^a-zA-Z0-9]', ' ', s).split())
|
|
|
|
parts = [_remove_protocol(part) for part in line.split() if part not in VALID_SOURCE_TYPES]
|
|
return '%s.list' % _cleanup_filename(' '.join(parts[:1]))
|
|
|
|
def _parse(self, line, raise_if_invalid_or_disabled=False):
|
|
valid = False
|
|
enabled = True
|
|
source = ''
|
|
comment = ''
|
|
|
|
line = line.strip()
|
|
if line.startswith('#'):
|
|
enabled = False
|
|
line = line[1:]
|
|
|
|
# Check for another "#" in the line and treat a part after it as a comment.
|
|
i = line.find('#')
|
|
if i > 0:
|
|
comment = line[i+1:].strip()
|
|
line = line[:i]
|
|
|
|
# Split a source into substring to make sure that it is source spec.
|
|
# Duplicated whitespaces in a valid source spec will be removed.
|
|
source = line.strip()
|
|
if source:
|
|
chunks = source.split()
|
|
if chunks[0] in VALID_SOURCE_TYPES:
|
|
valid = True
|
|
source = ' '.join(chunks)
|
|
|
|
if raise_if_invalid_or_disabled and (not valid or not enabled):
|
|
raise InvalidSource(line)
|
|
|
|
return valid, enabled, source, comment
|
|
|
|
def load(self, file):
|
|
group = []
|
|
with open(file, 'r') as f:
|
|
for n, line in enumerate(f):
|
|
valid, enabled, source, comment = self._parse(line)
|
|
group.append((n, valid, enabled, source, comment))
|
|
self.files[file] = group
|
|
|
|
def save(self, module):
|
|
for filename, sources in self.files.items():
|
|
if sources:
|
|
d, fn = os.path.split(filename)
|
|
fd, tmp_path = tempfile.mkstemp(prefix=".%s-" % fn, dir=d)
|
|
os.chmod(os.path.join(fd, tmp_path), 0644)
|
|
|
|
with os.fdopen(fd, 'w') as f:
|
|
for n, valid, enabled, source, comment in sources:
|
|
chunks = []
|
|
if not enabled:
|
|
chunks.append('# ')
|
|
chunks.append(source)
|
|
if comment:
|
|
chunks.append(' # ')
|
|
chunks.append(comment)
|
|
chunks.append('\n')
|
|
line = ''.join(chunks)
|
|
|
|
try:
|
|
f.write(line)
|
|
except IOError as err:
|
|
module.fail_json(msg="Failed to write to file %s: %s" % (tmp_path, unicode(err)))
|
|
module.atomic_move(tmp_path, filename)
|
|
else:
|
|
del self.files[filename]
|
|
if os.path.exists(filename):
|
|
os.remove(filename)
|
|
|
|
def dump(self):
|
|
return '\n'.join([str(i) for i in self])
|
|
|
|
def modify(self, file, n, enabled=None, source=None, comment=None):
|
|
'''
|
|
This function to be used with iterator, so we don't care of invalid sources.
|
|
If source, enabled, or comment is None, original value from line ``n`` will be preserved.
|
|
'''
|
|
valid, enabled_old, source_old, comment_old = self.files[file][n][1:]
|
|
choice = lambda new, old: old if new is None else new
|
|
self.files[file][n] = (n, valid, choice(enabled, enabled_old), choice(source, source_old), choice(comment, comment_old))
|
|
|
|
def _add_valid_source(self, source_new, comment_new, file):
|
|
# We'll try to reuse disabled source if we have it.
|
|
# If we have more than one entry, we will enable them all - no advanced logic, remember.
|
|
found = False
|
|
for filename, n, enabled, source, comment in self:
|
|
if source == source_new:
|
|
self.modify(filename, n, enabled=True)
|
|
found = True
|
|
|
|
if not found:
|
|
if file is None:
|
|
file = self.default_file
|
|
else:
|
|
file = self._expand_path(file)
|
|
|
|
if file not in self.files:
|
|
self.files[file] = []
|
|
|
|
files = self.files[file]
|
|
files.append((len(files), True, True, source_new, comment_new))
|
|
|
|
def add_source(self, line, comment='', file=None):
|
|
source = self._parse(line, raise_if_invalid_or_disabled=True)[2]
|
|
|
|
# Prefer separate files for new sources.
|
|
self._add_valid_source(source, comment, file=file or self._suggest_filename(source))
|
|
|
|
def _remove_valid_source(self, source):
|
|
# If we have more than one entry, we will remove them all (not comment, remove!)
|
|
for filename, n, enabled, src, comment in self:
|
|
if source == src and enabled:
|
|
self.files[filename].pop(n)
|
|
|
|
def remove_source(self, line):
|
|
source = self._parse(line, raise_if_invalid_or_disabled=True)[2]
|
|
self._remove_valid_source(source)
|
|
|
|
|
|
class UbuntuSourcesList(SourcesList):
|
|
|
|
LP_API = 'https://launchpad.net/api/1.0/~%s/+archive/%s'
|
|
|
|
def __init__(self, add_ppa_signing_keys_callback=None):
|
|
self.add_ppa_signing_keys_callback = add_ppa_signing_keys_callback
|
|
super(UbuntuSourcesList, self).__init__()
|
|
|
|
def _get_ppa_info(self, owner_name, ppa_name):
|
|
# we can not use urllib2 here as it does not do cert verification
|
|
lp_api = self.LP_API % (owner_name, ppa_name)
|
|
return self._get_ppa_info_curl(lp_api)
|
|
|
|
def _get_ppa_info_curl(self, lp_api):
|
|
callback = CurlCallback()
|
|
curl = pycurl.Curl()
|
|
curl.setopt(pycurl.SSL_VERIFYPEER, 1)
|
|
curl.setopt(pycurl.SSL_VERIFYHOST, 2)
|
|
curl.setopt(pycurl.WRITEFUNCTION, callback.body_callback)
|
|
curl.setopt(pycurl.URL, str(lp_api))
|
|
curl.setopt(pycurl.HTTPHEADER, ["Accept: application/json"])
|
|
curl.perform()
|
|
curl.close()
|
|
lp_page = callback.contents
|
|
return json.loads(lp_page)
|
|
|
|
def _expand_ppa(self, path):
|
|
ppa = path.split(':')[1]
|
|
ppa_owner = ppa.split('/')[0]
|
|
try:
|
|
ppa_name = ppa.split('/')[1]
|
|
except IndexError:
|
|
ppa_name = 'ppa'
|
|
|
|
line = 'deb http://ppa.launchpad.net/%s/%s/ubuntu %s main' % (ppa_owner, ppa_name, distro.codename)
|
|
return line, ppa_owner, ppa_name
|
|
|
|
def add_source(self, line, comment='', file=None):
|
|
if line.startswith('ppa:'):
|
|
source, ppa_owner, ppa_name = self._expand_ppa(line)
|
|
|
|
if self.add_ppa_signing_keys_callback is not None:
|
|
info = self._get_ppa_info(ppa_owner, ppa_name)
|
|
command = ['apt-key', 'adv', '--recv-keys', '--keyserver', 'keyserver.ubuntu.com', info['signing_key_fingerprint']]
|
|
self.add_ppa_signing_keys_callback(command)
|
|
|
|
file = file or self._suggest_filename('%s_%s' % (line, distro.codename))
|
|
else:
|
|
source = self._parse(line, raise_if_invalid_or_disabled=True)[2]
|
|
file = file or self._suggest_filename(source)
|
|
self._add_valid_source(source, comment, file)
|
|
|
|
def remove_source(self, line):
|
|
if line.startswith('ppa:'):
|
|
source = self._expand_ppa(line)[0]
|
|
else:
|
|
source = self._parse(line, raise_if_invalid_or_disabled=True)[2]
|
|
self._remove_valid_source(source)
|
|
|
|
|
|
def get_add_ppa_signing_key_callback(module):
|
|
def _run_command(command):
|
|
module.run_command(command, check_rc=True)
|
|
|
|
return _run_command if not module.check_mode else None
|
|
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec=dict(
|
|
repo=dict(required=True),
|
|
state=dict(choices=['present', 'absent'], default='present'),
|
|
),
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
if not HAVE_PYTHON_APT:
|
|
module.fail_json(msg='Could not import python modules: apt_pkg. Please install python-apt package.')
|
|
|
|
if not HAVE_PYCURL:
|
|
module.fail_json(msg='Could not import python modules: pycurl. Please install python-pycurl package.')
|
|
|
|
repo = module.params['repo']
|
|
state = module.params['state']
|
|
sourceslist = None
|
|
|
|
if isinstance(distro, aptsources.distro.DebianDistribution):
|
|
sourceslist = SourcesList()
|
|
elif isinstance(distro, aptsources.distro.UbuntuDistribution):
|
|
sourceslist = UbuntuSourcesList(add_ppa_signing_keys_callback=get_add_ppa_signing_key_callback(module))
|
|
else:
|
|
module.fail_json(msg='Module apt_repository supports only Debian and Ubuntu.')
|
|
|
|
sources_before = sourceslist.dump()
|
|
|
|
try:
|
|
if state == 'present':
|
|
sourceslist.add_source(repo)
|
|
elif state == 'absent':
|
|
sourceslist.remove_source(repo)
|
|
except InvalidSource as err:
|
|
module.fail_json(msg='Invalid repository string: %s' % unicode(err))
|
|
|
|
sources_after = sourceslist.dump()
|
|
changed = sources_before != sources_after
|
|
|
|
if not module.check_mode and changed:
|
|
try:
|
|
sourceslist.save(module)
|
|
except OSError as err:
|
|
module.fail_json(msg=unicode(err))
|
|
|
|
module.exit_json(changed=changed, repo=repo, state=state)
|
|
|
|
# this is magic, see lib/ansible/module_common.py
|
|
#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
|
|
|
|
main()
|