########################################################################## # # pgAdmin 4 - PostgreSQL Tools # # Copyright (C) 2013 - 2022, The pgAdmin Development Team # This software is released under the PostgreSQL Licence # ########################################################################## """Implements Restore Utility""" import simplejson as json import os from flask import render_template, request, current_app, \ url_for, Response from flask_babel import gettext as _ from flask_security import login_required, current_user from pgadmin.misc.bgprocess.processes import BatchProcess, IProcessDesc from pgadmin.utils import PgAdminModule, get_storage_directory, html, \ fs_short_path, document_dir, does_utility_exist, get_server from pgadmin.utils.ajax import make_json_response, bad_request from config import PG_DEFAULT_DRIVER from pgadmin.model import Server, SharedServer from pgadmin.utils.constants import MIMETYPE_APP_JS # set template path for sql scripts MODULE_NAME = 'restore' server_info = {} class RestoreModule(PgAdminModule): """ class RestoreModule(Object): It is a utility which inherits PgAdminModule class and define methods to load its own javascript file. """ LABEL = _('Restore') def get_own_javascripts(self): """" Returns: list: js files used by this module """ return [{ 'name': 'pgadmin.tools.restore', 'path': url_for('restore.index') + 'restore', 'when': None }] def get_exposed_url_endpoints(self): """ Returns: list: URL endpoints for backup module """ return ['restore.create_job', 'restore.utility_exists'] # Create blueprint for RestoreModule class blueprint = RestoreModule( MODULE_NAME, __name__, static_url_path='' ) class RestoreMessage(IProcessDesc): def __init__(self, _sid, _bfile, *_args): self.sid = _sid self.bfile = _bfile self.cmd = '' def cmd_arg(x): if x: x = x.replace('\\', '\\\\') x = x.replace('"', '\\"') x = x.replace('""', '\\"') return ' "' + x + '"' return '' for arg in _args: if arg and len(arg) >= 2 and arg[:2] == '--': self.cmd += ' ' + arg else: self.cmd += cmd_arg(arg) def get_server_details(self): # Fetch the server details like hostname, port, roles etc s = get_server(self.sid) from pgadmin.utils.driver import get_driver driver = get_driver(PG_DEFAULT_DRIVER) manager = driver.connection_manager(self.sid) host = manager.local_bind_host if manager.use_ssh_tunnel else s.host port = manager.local_bind_port if manager.use_ssh_tunnel else s.port return s.name, host, port @property def message(self): name, host, port = self.get_server_details() return _("Restoring backup on the server '{0}'").format( "{0} ({1}:{2})".format( html.safe_str(name), html.safe_str(host), html.safe_str(port) ), ) @property def type_desc(self): return _("Restoring backup on the server") def details(self, cmd, args): name, host, port = self.get_server_details() res = '
' res += html.safe_str( _( "Restoring backup on the server '{0}'..." ).format( "{0} ({1}:{2})".format(name, host, port) ) ) res += '
' res += _("Running command:") res += '
' res += html.safe_str(cmd + self.cmd) res += '
' return res @blueprint.route("/") @login_required def index(): return bad_request(errormsg=_("This URL cannot be called directly.")) @blueprint.route("/restore.js") @login_required def script(): """render own javascript""" return Response( response=render_template( "restore/js/restore.js", _=_ ), status=200, mimetype=MIMETYPE_APP_JS ) def filename_with_file_manager_path(_file): """ Args: file: File name returned from client file manager Returns: Filename to use for backup with full path taken from preference """ # Set file manager directory from preference storage_dir = get_storage_directory() if storage_dir: _file = os.path.join(storage_dir, _file.lstrip('/').lstrip('\\')) elif not os.path.isabs(_file): _file = os.path.join(document_dir(), _file) if not os.path.isfile(_file) and not os.path.exists(_file): return None return fs_short_path(_file) def _get_create_req_data(): """ Get data from request for create restore job. :return: return data if no error occurred. """ if request.form: data = json.loads(request.form['data'], encoding='utf-8') else: data = json.loads(request.data, encoding='utf-8') try: _file = filename_with_file_manager_path(data['file']) except Exception as e: return True, bad_request(errormsg=str(e)), data if _file is None: return True, make_json_response( status=410, success=0, errormsg=_("File could not be found.") ), data, _file return False, '', data, _file def _connect_server(sid): """ Get server object and try to connect with it. :param sid: Server ID. :return: if not error occurred then return connection data. """ server = get_server(sid) if server is None: return True, make_json_response( success=0, errormsg=_("Could not find the specified server.") ), None, None, None, None, None # To fetch MetaData for the server from pgadmin.utils.driver import get_driver driver = get_driver(PG_DEFAULT_DRIVER) manager = driver.connection_manager(server.id) conn = manager.connection() connected = conn.connected() if not connected: return True, make_json_response( success=0, errormsg=_("Please connect to the server first.") ), driver, manager, conn, connected, server return False, '', driver, manager, conn, connected, server def set_param(key, param, data, args): """ check and add parameter to args list. :param key: Key. :param param: Parameter to be add in the args list. :param data: Data. :param args: args list. :return: Return true if key in data else return false. """ if key in data and data[key]: args.append(param) return True return False def set_value(key, param, data, args, default_value=None): """ Add values to args list if key not present in data set default value. :param key: Key. :param param: Parameter to be add in the args list. :param data: Data. :param args: args list. :param default_value: default value flag. :return: """ if key in data and data[key] is not None and data[key] != '': args.append(param) args.append(data[key]) elif default_value is not None: args.append(param) args.append(default_value) def _set_value_with_schema(data, key, args, param, driver, conn): """ Set value if with_schema flag is true. :param data: Data. :param key: Key. :param args: args list. :param param: parameter to be add in the args list. :param driver: Driver. :param conn: connection. :return: """ if isinstance(data[key], list): s, t = data[key] args.extend([ param, driver.qtIdent( conn, s ) + '.' + driver.qtIdent(conn, t) ]) else: for s, o in data[key]: args.extend([ param, driver.qtIdent( conn, s ) + '.' + driver.qtIdent(conn, o) ]) def set_multiple(key, param, data, args, driver, conn, with_schema=True): if key in data and \ len(data[key]) > 0: if with_schema: # TODO:// This is temporary # Once object tree is implemented then we will use # list of tuples 'else' part _set_value_with_schema(data, key, args, param, driver, conn) else: for o in data[key]: args.extend([param, o]) return True return False def _set_args_param_values(data, manager, server, driver, conn, _file): """ add args to the list. :param data: Data. :param manager: Manager. :param server: Server. :param driver: Driver. :param conn: Connection. :param _file: File. :return: args list. """ args = [] if 'list' in data: args.append('--list') else: args.extend([ '--host', manager.local_bind_host if manager.use_ssh_tunnel else server.host, '--port', str(manager.local_bind_port) if manager.use_ssh_tunnel else str(server.port), '--username', server.username, '--no-password' ]) set_value('role', '--role', data, args) set_value('database', '--dbname', data, args) if data['format'] == 'directory': args.extend(['--format=d']) set_param('pre_data', '--section=pre-data', data, args) set_param('data', '--section=data', data, args) set_param('post_data', '--section=post-data', data, args) if not set_param('only_data', '--data-only', data, args): set_param('dns_owner', '--no-owner', data, args) set_param('dns_privilege', '--no-privileges', data, args) set_param('dns_tablespace', '--no-tablespaces', data, args) if not set_param('only_schema', '--schema-only', data, args): set_param('disable_trigger', '--disable-triggers', data, args) set_param('include_create_database', '--create', data, args) set_param('clean', '--clean', data, args) set_param('single_transaction', '--single-transaction', data, args) set_param('no_data_fail_table', '--no-data-for-failed-tables', data, args) set_param('use_set_session_auth', '--use-set-session-authorization', data, args) set_param('exit_on_error', '--exit-on-error', data, args) if manager.version >= 110000: set_param('no_comments', '--no-comments', data, args) set_value('no_of_jobs', '--jobs', data, args) set_param('verbose', '--verbose', data, args) set_multiple('schemas', '--schema', data, args, driver, conn, False) set_multiple('tables', '--table', data, args, driver, conn, False) set_multiple('functions', '--function', data, args, driver, conn, False) set_multiple('triggers', '--trigger', data, args, driver, conn, False) set_multiple('trigger_funcs', '--function', data, args, driver, conn, False) set_multiple('indexes', '--index', data, args, driver, conn, False) args.append(fs_short_path(_file)) return args @blueprint.route('/job/', methods=['POST'], endpoint='create_job') @login_required def create_restore_job(sid): """ Args: sid: Server ID Creates a new job for restore task Returns: None """ is_error, errmsg, data, _file = _get_create_req_data() if is_error: return errmsg is_error, errmsg, driver, manager, conn, \ connected, server = _connect_server(sid) if is_error: return errmsg utility = manager.utility('restore') ret_val = does_utility_exist(utility) if ret_val: return make_json_response( success=0, errormsg=ret_val ) args = _set_args_param_values(data, manager, server, driver, conn, _file) try: p = BatchProcess( desc=RestoreMessage( server.id, data['file'].encode('utf-8') if hasattr( data['file'], 'encode' ) else data['file'], *args ), cmd=utility, args=args ) manager.export_password_env(p.id) # Check for connection timeout and if it is greater than 0 then # set the environment variable PGCONNECT_TIMEOUT. if manager.connect_timeout > 0: env = dict() env['PGCONNECT_TIMEOUT'] = str(manager.connect_timeout) p.set_env_variables(server, env=env) else: p.set_env_variables(server) p.start() jid = p.id except Exception as e: current_app.logger.exception(e) return make_json_response( status=410, success=0, errormsg=str(e) ) # Return response return make_json_response( data={'job_id': jid, 'Success': 1} ) @blueprint.route( '/utility_exists/', endpoint='utility_exists' ) @login_required def check_utility_exists(sid): """ This function checks the utility file exist on the given path. Args: sid: Server ID Returns: None """ # Fetch the server details like hostname, port, roles etc server = get_server(sid) if server is None: return make_json_response( success=0, errormsg=_("Could not find the specified server.") ) from pgadmin.utils.driver import get_driver driver = get_driver(PG_DEFAULT_DRIVER) manager = driver.connection_manager(server.id) utility = manager.utility('restore') ret_val = does_utility_exist(utility) if ret_val: return make_json_response( success=0, errormsg=ret_val ) return make_json_response(success=1)