Java Rsync转义空间

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Java Rsync转义空间相关的知识,希望对你有一定的参考价值。

我试图从jar运行rsync。当源路径没有空格时,一切正常,但是当源路径中有空格时,它会失败。我已经尝试了各种方法来转义空格,根据手册页,例如source.replaceAll(“ s”,“\”)或source.replaceAll(“ s”,“?”),但是没有无济于事。

当我输出运行的命令,然后从命令行运行完全相同的命令时,一切正常。我看不出我做错了什么

我的代码如下:

RsyncCommandLine类

public class RsyncCommandLine {

    /** Logger */
    private static final Logger logger = LogManager.getLogger(RsyncCommandLine.class);

    private CommandLine commandLine = null;

    public String startRsync(String source, String destination) throws IOException {
        commandLine = createCommandLine(source, destination);

        CommandLineExecutorHelper helper = new CommandLineExecutorHelper();
        CommandLineLogOutputStream outputStream = helper.executeCommandLine(commandLine);
        validateResponse(outputStream);
        return convertLinesToString(outputStream.getLines());
    }

    private void validateResponse(CommandLineLogOutputStream outputStream) throws IOException {
        if (outputStream == null) {
            logger.error("outputStream  is not valid");
            throw new IOException("Unable to use rsync. ");
        } else if (outputStream.getExitCode() != 0) {
            logger.error("Exit code: " + outputStream.getExitCode());
            logger.error("Validate Response failed " + outputStream.getLines());
            String errorMessage = exitCodeToErrorMessage(outputStream.getExitCode());
            throw new IOException("Error with request. " + errorMessage);
        } else if (outputStream.getLines() == null || outputStream.getLines().isEmpty()) {
            logger.error("Rsync result: " + outputStream.getLines());
            String errorMessage = "Unable to rsync. ";

            throw new IOException(errorMessage);

        }
    }

    private String exitCodeToErrorMessage(int exitCode) {
        String errorMessage = null;
        switch (exitCode) {
            case 0: errorMessage="Success."; break;
            case 1: errorMessage="Syntax or usage error."; break;
            case 2: errorMessage="Protocol incompatibility."; break;
            case 3: errorMessage="Errors selecting input/output files, dirs."; break;
            case 4: errorMessage="Requested action not supported: an attempt was made to manipulate 64-bit files on a platform that cannot support them; or an option was specified that is supported by the client and not by the server."; break;
            case 5: errorMessage="Error starting client-server protocol."; break;
            case 6: errorMessage="Daemon unable to append to log-file."; break;
            case 10: errorMessage="Error in socket I/O."; break;
            case 11: errorMessage="Error in file I/O."; break;
            case 12: errorMessage="Error in rsync protocol data stream."; break;
            case 13: errorMessage="Errors with program diagnostics."; break;
            case 14: errorMessage="Error in IPC code."; break;
            case 20: errorMessage="Received SIGUSR1 or SIGINT."; break;
            case 21: errorMessage="Some error returned by waitpid()."; break;
            case 22: errorMessage="Error allocating core memory buffers."; break;
            case 23: errorMessage="Partial transfer due to error."; break;
            case 24: errorMessage="Partial transfer due to vanished source files."; break;
            case 25: errorMessage="The --max-delete limit stopped deletions."; break;
            case 30: errorMessage="Timeout in data send/receive."; break;
            case 35: errorMessage="Timeout waiting for daemon connection."; break;
            default: errorMessage="Unrecognised error code.";
        }
        return errorMessage;
    }


    protected String convertLinesToString(List<String> lines) {
        String result = null;

        if (lines != null && !lines.isEmpty()) {
            StringBuilder builder = new StringBuilder();
            for (String line : lines) {
                builder.append(line).append(" ");
            }
            result = builder.toString().trim();
        }
        return result;
    }

    protected CommandLine createCommandLine(String source, String destination) {
        // rsync -rtvuch <source> <destination>

        commandLine = new CommandLine("rsync");
        commandLine.addArgument("-rtvuch");

        String escapedSource = source.trim().replaceAll("\s", "\\ ");
        String escapedDestination = destination.trim().replaceAll("\s", "\\ ");
        commandLine.addArgument(source);
        commandLine.addArgument(escapedDestination);

        logger.debug("escapedSource " + escapedSource);
        logger.debug("escapedDestination " + escapedDestination);

        return commandLine;
    }

}

CommandLineExecutorHelper类 -

public class CommandLineExecutorHelper {

    /** Logger */
    private static final Logger logger = LogManager.getLogger(CommandLineExecutorHelper.class);

    private DefaultExecutor executor = new DefaultExecutor();

    private ExecuteWatchdog watchdog = new ExecuteWatchdog(10000);

    private DefaultExecuteResultHandler resultHandler = new DefaultExecuteResultHandler();


    public CommandLineExecutorHelper() {
        executor.setWatchdog(watchdog);
    }

    public CommandLineLogOutputStream executeCommandLine(CommandLine commandLine) {
        CommandLineLogOutputStream outputStream = new CommandLineLogOutputStream();
        PumpStreamHandler pumpStreamHandler = new PumpStreamHandler(outputStream);
        executor.setStreamHandler(pumpStreamHandler);
        try {
            executor.execute(commandLine, resultHandler);

            resultHandler.waitFor();
            outputStream.setExitCode(resultHandler.getExitValue());
            logger.debug("

commandLine " + commandLine);
            logger.debug("exit code " + resultHandler.getExitValue());
            logger.debug("output " + outputStream.getLines());
        } catch (InterruptedException e) {
            outputStream.addErrorMessage(e.getMessage());
            logger.error("executeCommandLine " + e.getMessage());
        } catch (ExecuteException e) {
            outputStream.addErrorMessage(e.getMessage());
            logger.error("executeCommandLine " + e.getMessage());
        } catch (IOException e) {
            outputStream.addErrorMessage(e.getMessage());
            logger.error("executeCommandLine " + e.getMessage());
        } finally {
            IOUtils.closeQuietly(outputStream);
        }

        return outputStream;
    }
}

CommnadLineOutputStream类 -

public class CommandLineLogOutputStream extends LogOutputStream {
    private int exitCode = -1;

    private final List<String> lines = new LinkedList<>();

    private StringBuilder errorMessages = new StringBuilder();


    /**
     * @return the exitCode
     */
    public int getExitCode() {
        return exitCode;
    }

    /**
     * @param exitCode the exitCode to set
     */
    public void setExitCode(int exitCode) {
        this.exitCode = exitCode;
    }

    /**
     * @return the lines
     */
    public List<String> getLines() {
        return lines;
    }



    /**
     * @return the errorMessages
     */
    public StringBuilder getErrorMessages() {
        return errorMessages;
    }

    /**
     * @param errorMessages the errorMessages to set
     */
    public void setErrorMessages(StringBuilder errorMessages) {
        this.errorMessages = errorMessages;
    }

    public void addErrorMessage(String errorMessage) {
        this.errorMessages.append(errorMessage);
    }


    @Override
    protected void processLine(String line, int logLevel) {
        lines.add(line);
    }

    /* (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder builder = new StringBuilder();
        builder.append("CommandLineLogOutputStream [exitCode=").append(exitCode).append(", lines=").append(lines).append(", errorMessages=").append(errorMessages).append("]");
        return builder.toString();
    }

}

所以当我在没有空间的情况下运行我的jar时它会成功:

java -jar myjar.jar -source "/var/source"

输出命令是:

commandLine [rsync, -rtvuch, "/var/source", /var/dest]

当我对带有空格的路径运行相同的jar时:

java -jar myjar.jar -source "/var/source with spaces"

我收到以下错误消息:

Exit code: 23
Validate Response failed [building file list ... donersync: link_stat "/Users/karen/"/var/source with spaces"" failed: No such file or directory (2), building file list ... donersync: link_stat "/Users/karen/"/var/source with spaces"" failed: No such file or directory (2), , sent 21 bytes  received 20 bytes  82.00 bytes/sec, total size is 0  speedup is 0.00, rsync error: some files could not be transferred (code 23) at /BuildRoot/Library/Caches/com.apple.xbs/Sources/rsync/rsync-47/rsync/main.c(992) [sender=2.6.9]]
Unable to rsync Error with request. Partial transfer due to error.

从文件打开对话框中拾取目标路径。

答案

经过各种输入后,我决定使用ProcessBuilder。然后我使用以下代码使其工作:

public class RsyncCommandLine {

    /** Logger */
    private static final Logger logger = LogManager.getLogger(RsyncCommandLine.class);


    public String startRsync(String source, String destination) throws IOException {
        List<String> commands = createCommandLine(source, destination);
        List<String> lines = new ArrayList<>();
        Integer exitCode = null;
        try {
            ProcessBuilder processBuilder = new ProcessBuilder(commands).redirectErrorStream(true);

            final Process process = processBuilder.start();

            BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(process.getInputStream()));
            String line;
            while ((line = bufferedReader.readLine()) != null) {
                lines.add(line);
            }
            // Allow process to run up to 60 seconds
            process.waitFor(60, TimeUnit.SECONDS);
            // Get exit code from process
            exitCode = process.exitValue();
            //Convert exit code to meaningful statement
            String exitMessage = exitCodeToErrorMessage(exitCode);               
            lines.add(exitMessage);
        } catch (Exception ex) {
            logger.error(ex);
        }

        return convertLinesToString(lines);
    }


    private String exitCodeToErrorMessage(Integer exitCode) {
        String errorMessage = null;
        switch (exitCode) {
        case 0:
            errorMessage = "Success.";
            break;
        case 1:
            errorMessage = "Syntax or usage error.";
            break;
        case 2:
            errorMessage = "Protocol incompatibility.";
            break;
        case 3:
            errorMessage = "Errors selecting input/output files, dirs.";
            break;
        case 4:
            errorMessage = "Requested action not supported: an attempt was made to manipulate 64-bit files on a platform that cannot support them; or an option was specified that is supported by the client and not by the server.";
            break;
        case 5:
            errorMessage = "Error starting client-server protocol.";
            break;
        case 6:
            errorMessage = "Daemon unable to append to log-file.";
            break;
        case 10:
            errorMessage = "Error in socket I/O.";
            break;
        case 11:
            errorMessage = "Error in file I/O.";
            break;
        case 12:
            errorMessage = "Error in rsync protocol data stream.";
            break;
        case 13:
            errorMessage = "Errors with program diagnostics.";
            break;
        case 14:
            errorMessage = "Error in IPC code.";
            break;
        case 20:
            errorMessage = "Received SIGUSR1 or SIGINT.";
            break;
        case 21:
            errorMessage = "Some error returned by waitpid().";
            break;
        case 22:
            errorMessage = "Error allocating core memory buffers.";
            break;
        case 23:
            errorMessage = "Partial transfer due to error.";
            break;
        case 24:
            errorMessage = "Partial transfer due to vanished source files.";
            break;
        case 25:
            errorMessage = "The --max-delete limit stopped deletions.";
            break;
        case 30:
            errorMessage = "Timeout in data send/receive.";
            break;
        case 35:
            errorMessage = "Timeout waiting for daemon connection.";
            break;
        default:
            errorMessage = "Unrecognised error code.";
        }
        return errorMessage;
    }

    protected String convertLinesToString(List<String> lines) {
        String result = null;

        if (lines != null && !lines.isEmpty()) {
            StringBuilder builder = new StringBuilder();
            for (String line : lines) {
                builder.append(line).append(" ");
            }
            result = builder.toString().trim();
        }
        return result;
    }

    protected List<String> createCommandLine(String source, String destination) {
        // rsync -rtvuch <source> <destination>
        List<String> commands = new ArrayList<>();

        commands.add("rsync");
        commands.add("-rtvuch");

        String escapedSource = source.trim();
        String escapedDestination = destination.trim();

        commands.add(escapedSource);
        commands.add(escapedDestination);
        logger.debug("escapedSource " + escapedSource);
        logger.debug("escapedDestination " + escapedDestination);

        return commands;
    }

}
另一答案

你看到答案here

虽然有一个bug around quotes managements in Common Exec,这answers suggests

// When writing a command with space use double "
cmdLine.addArgument(--grep=""" + filter+"""", false"""",false);
另一答案

我认为Apache Commons Exec在这里有一个错误,无法正确处理带有空格的参数。这个开放的bug(m4gic链接到)有几个相互矛盾的解释和解决方法:https://issues.apache.org/jira/browse/EXEC-54

我建议重写你的代码,使用Java内置的“Runtime.exec”函数,使用命令行的String[]形式(或等效的java.lang.ProcessBuilder API)来完全绕过任何shell转义和引用问题。

您将不得不手动处理Apache Commons Exec隐藏的一些技术细节,例如stdout和stderr之间潜在的i / o死锁,但很有可能处理这些,而我认为不可能让Apache在这里做你想做的事。 Apache Commons Exec intro讨论了其中的一些问题。您应该能够在互联网上使用Runtime.execProcessBuilder找到一些示例代码。 GL!

以上是关于Java Rsync转义空间的主要内容,如果未能解决你的问题,请参考以下文章

在java中用反斜杠转义空间

html 从描述HTML代码转义空间

LinkedIn Share API 是不是支持转义片段 URL(hasbang url)

使用 sqlite 的 FTS 片段函数处理 html 转义

Vscode在使用变量之前转义斜杠

Java调用SQL Server的存储过程详解(转)