mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
106 lines
4.4 KiB
Python
106 lines
4.4 KiB
Python
# This code is part of Ansible, but is an independent component.
|
|
# This particular file snippet, and this file snippet only, is BSD licensed.
|
|
# Modules you write using this snippet, which is embedded dynamically by Ansible
|
|
# still belong to the author of the module, and may assign their own license
|
|
# to the complete work.
|
|
#
|
|
# Copyright (c), Jonathan Mainguy <jon@soh.re>, 2015
|
|
# Most of this was originally added by Sven Schliesing @muffl0n in the mysql_user.py module
|
|
# All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without modification,
|
|
# are permitted provided that the following conditions are met:
|
|
#
|
|
# * Redistributions of source code must retain the above copyright
|
|
# notice, this list of conditions and the following disclaimer.
|
|
# * Redistributions in binary form must reproduce the above copyright notice,
|
|
# this list of conditions and the following disclaimer in the documentation
|
|
# and/or other materials provided with the distribution.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
|
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
import os
|
|
|
|
try:
|
|
import pymysql as mysql_driver
|
|
_mysql_cursor_param = 'cursor'
|
|
except ImportError:
|
|
try:
|
|
import MySQLdb as mysql_driver
|
|
import MySQLdb.cursors
|
|
_mysql_cursor_param = 'cursorclass'
|
|
except ImportError:
|
|
mysql_driver = None
|
|
|
|
mysql_driver_fail_msg = 'The PyMySQL (Python 2.7 and Python 3.X) or MySQL-python (Python 2.X) module is required.'
|
|
|
|
|
|
def mysql_connect(module, login_user=None, login_password=None, config_file='', ssl_cert=None, ssl_key=None, ssl_ca=None, db=None, cursor_class=None,
|
|
connect_timeout=30, autocommit=False):
|
|
config = {}
|
|
|
|
if ssl_ca is not None or ssl_key is not None or ssl_cert is not None:
|
|
config['ssl'] = {}
|
|
|
|
if module.params['login_unix_socket']:
|
|
config['unix_socket'] = module.params['login_unix_socket']
|
|
else:
|
|
config['host'] = module.params['login_host']
|
|
config['port'] = module.params['login_port']
|
|
|
|
if os.path.exists(config_file):
|
|
config['read_default_file'] = config_file
|
|
|
|
# If login_user or login_password are given, they should override the
|
|
# config file
|
|
if login_user is not None:
|
|
config['user'] = login_user
|
|
if login_password is not None:
|
|
config['passwd'] = login_password
|
|
if ssl_cert is not None:
|
|
config['ssl']['cert'] = ssl_cert
|
|
if ssl_key is not None:
|
|
config['ssl']['key'] = ssl_key
|
|
if ssl_ca is not None:
|
|
config['ssl']['ca'] = ssl_ca
|
|
if db is not None:
|
|
config['db'] = db
|
|
if connect_timeout is not None:
|
|
config['connect_timeout'] = connect_timeout
|
|
|
|
if _mysql_cursor_param == 'cursor':
|
|
# In case of PyMySQL driver:
|
|
db_connection = mysql_driver.connect(autocommit=autocommit, **config)
|
|
else:
|
|
# In case of MySQLdb driver
|
|
db_connection = mysql_driver.connect(**config)
|
|
if autocommit:
|
|
db_connection.autocommit(True)
|
|
|
|
if cursor_class == 'DictCursor':
|
|
return db_connection.cursor(**{_mysql_cursor_param: mysql_driver.cursors.DictCursor}), db_connection
|
|
else:
|
|
return db_connection.cursor(), db_connection
|
|
|
|
|
|
def mysql_common_argument_spec():
|
|
return dict(
|
|
login_user=dict(type='str', default=None),
|
|
login_password=dict(type='str', no_log=True),
|
|
login_host=dict(type='str', default='localhost'),
|
|
login_port=dict(type='int', default=3306),
|
|
login_unix_socket=dict(type='str'),
|
|
config_file=dict(type='path', default='~/.my.cnf'),
|
|
connect_timeout=dict(type='int', default=30),
|
|
client_cert=dict(type='path', aliases=['ssl_cert']),
|
|
client_key=dict(type='path', aliases=['ssl_key']),
|
|
ca_cert=dict(type='path', aliases=['ssl_ca']),
|
|
)
|