Function start_process

web/pgadmin/tools/psql/__init__.py:296–369

Start the pty terminal and execute psql command and emit results to user. :param data: :return:

(data)

@sio.on('start_process', namespace='/pty')
@socket_login_required
def start_process(data):
    """
    Start the pty terminal and execute psql command and emit results to user.
    :param data:
    :return:
    """
    @copy_current_request_context
    def read_and_forward_pty_output(sid, data):
        pty_handel_io(connection_data, data, sid)

    # Check user is authenticated and PSQL is enabled in config.
    if current_user.is_authenticated and config.ENABLE_PSQL:
        connection_data = []
        connection_successful = False
        try:
            db = ''
            if data['db']:
                db = underscore_unescape(data['db'])

            data['db'] = db

            _, manager = _get_connection(int(data['sid']), data)
            psql_utility = manager.utility('sql')
            if psql_utility is None or not os.path.exists(psql_utility):
                sio.emit('pty-output',
                         {
                             'result': gettext(
                                 'PSQL utility not found. Specify the valid '
                                 'binary path in the preferences for the '
                                 'appropriate server version, or select '
                                 '"Set as default" to use an existing binary '
                                 'path.'),
                             'error': True},
                         namespace='/pty', room=request.sid)
                return
            connection_data = get_connection_str(psql_utility, db,
                                                 manager)
            connection_successful = True
        except Exception as e:
            # If any error raised during the start the PSQL emit error to UI.
            # request.sid: This sid is socket id.
            error_msg = 'Error while running psql command: {0}'.format(e)
            if str(e) == 'Server is not connected.':
                error_msg = 'Error while opening psql tool: {0}'.format(e)

            sio.emit('conn_error',
                     {'error': error_msg},
                     namespace='/pty',
                     room=request.sid)

        if connection_successful:
            try:
                if str(data['sid']) not in app.config['sid_soid_mapping']:
                    # request.sid: refer request.sid as socket id.
                    app.config['sid_soid_mapping'][str(data['sid'])] = list()
                    app.config['sid_soid_mapping'][str(data['sid'])].append(
                        request.sid)
                else: