com.orion.ext.process.BaseProcessExecutor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of orion-ext Show documentation
orion extended module
There is a newer version: 1.0.8
/*
 * Copyright (c) 2019 - present Jiahang Li (kit.orionsec.cn [email protected]).
 *
 * The MIT License (MIT)
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package com.orion.ext.process;

import com.orion.lang.able.Executable;
import com.orion.lang.able.SafeCloseable;
import com.orion.lang.constant.Const;
import com.orion.lang.utils.Strings;
import com.orion.lang.utils.Systems;
import com.orion.lang.utils.collect.Lists;

import java.util.*;

/**
 * 命令处理器基类
 *
 * @author Jiahang Li
 * @version 1.0.0
 * @since 2020/10/12 15:59
 */
public abstract class BaseProcessExecutor implements Executable, SafeCloseable {

    /**
     * 系统命令
     */
    private static final ArrayList COMMAND;

    static {
        COMMAND = new ArrayList<>();
        if (Systems.BE_WINDOWS) {
            COMMAND.add("cmd");
            COMMAND.add("/c");
        } else {
            COMMAND.add("/bin/bash");
            COMMAND.add("-c");
        }
    }

    /**
     * 命令
     */
    protected String[] command;

    /**
     * 命令执行文件夹
     */
    protected String dir;

    /**
     * 是否将异常流合并到标准流
     */
    protected boolean redirectError;

    /**
     * 当前环境变量
     */
    protected Map env;

    /**
     * 新增环境变量
     */
    protected Map addEnv;

    /**
     * 删除环境变量
     */
    protected List removeEnv;

    protected BaseProcessExecutor(String command) {
        this(new String[]{command}, null);
    }

    protected BaseProcessExecutor(String[] command) {
        this(command, null);
    }

    protected BaseProcessExecutor(String command, String dir) {
        this(new String[]{command}, dir);
    }

    protected BaseProcessExecutor(String[] command, String dir) {
        this.command = command;
        this.dir = dir;
    }

    /**
     * 关闭
     */
    @Override
    public abstract void close();

    /**
     * 是否正在执行
     *
     * @return true执行中
     */
    public abstract boolean isAlive();

    /**
     * 获取 exit code
     *
     * @return -1未执行完毕 0成功 1失败
     */
    public abstract int getExitCode();

    /**
     * 获取进程
     *
     * @return Process
     */
    public abstract Process getProcess();

    /**
     * 获取进程构建器
     *
     * @return ProcessBuilder
     */
    public abstract ProcessBuilder getProcessBuilder();

    /**
     * 命名使用系统 terminal 执行
     * 如果进程不会自动停止不可以使用, 因为destroy杀死的不是terminal执行的进程, 而是terminal
     *
     * @return this
     */
    public BaseProcessExecutor terminal() {
        List c = getTerminalCommand();
        for (String s : command) {
            c.add(s.replaceAll(Const.LF, Strings.SPACE).replaceAll(Const.CR, Strings.SPACE));
        }
        this.command = c.toArray(new String[0]);
        return this;
    }

    /**
     * 设置命令执行的文件夹
     *
     * @param dir 文件夹
     * @return this
     */
    public BaseProcessExecutor dir(String dir) {
        this.dir = dir;
        return this;
    }

    /**
     * 合并错误流到标准流
     *
     * @return this
     */
    public BaseProcessExecutor redirectError() {
        this.redirectError = true;
        return this;
    }

    /**
     * 添加环境变量
     *
     * @param key   key
     * @param value value
     * @return this
     */
    public BaseProcessExecutor addEnv(String key, String value) {
        if (addEnv == null) {
            this.addEnv = new HashMap<>();
        }
        addEnv.put(key, value);
        return this;
    }

    /**
     * 添加环境变量
     *
     * @param env 环境变量
     * @return this
     */
    public BaseProcessExecutor addEnv(Map env) {
        if (addEnv == null) {
            this.addEnv = new HashMap<>();
        }
        addEnv.putAll(env);
        return this;
    }

    /**
     * 删除环境变量
     *
     * @param keys key
     * @return this
     */
    public BaseProcessExecutor removeEnv(String... keys) {
        if (removeEnv == null) {
            this.removeEnv = new ArrayList<>();
        }
        if (keys != null) {
            removeEnv.addAll(Arrays.asList(keys));
        }
        return this;
    }

    /**
     * 删除环境变量
     *
     * @param keys key
     * @return this
     */
    public BaseProcessExecutor removeEnv(List keys) {
        if (removeEnv == null) {
            this.removeEnv = new ArrayList<>();
        }
        if (keys != null) {
            removeEnv.addAll(keys);
        }
        return this;
    }

    /**
     * 获取系统命令前缀
     *
     * @return 前缀list
     */
    @SuppressWarnings("unchecked")
    protected static List getTerminalCommand() {
        return (List) COMMAND.clone();
    }

    public String[] getCommand() {
        return command;
    }

    public String getDir() {
        return dir;
    }

    public Map getEnv() {
        return env;
    }

    public Map getAddEnv() {
        return addEnv;
    }

    @Override
    public String toString() {
        return Lists.join(Lists.of(command), Strings.SPACE);
    }

}