CodeMirror/xpipe
1
0
Fork 0
mirror of https://github.com/xpipe-io/xpipe.git synced 2024-07-08 15:56:09 +12:00
Code Issues Packages Projects Releases Wiki Activity

Various shell connection optimizations

Browse source
This commit is contained in:
crschnick 2023-02-01 10:15:51 +00:00
parent e57a952a62
commit f35ff6fcd4
14 changed files with 83 additions and 94 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
app/src/main/java/io/xpipe/app/comp/storage/store/StoreEntryComp.java
View file

@ -8,7 +8,6 @@ import io.xpipe.app.core.AppI18n;
import io.xpipe.app.prefs.AppPrefs;
import io.xpipe.app.storage.DataStorage;
import io.xpipe.extension.I18n;
import io.xpipe.extension.event.ErrorEvent;
import io.xpipe.extension.fxcomps.Comp;
import io.xpipe.extension.fxcomps.SimpleComp;
import io.xpipe.extension.fxcomps.SimpleCompStructure;
@ -21,6 +20,7 @@ import io.xpipe.extension.fxcomps.impl.PrettyImageComp;
import io.xpipe.extension.fxcomps.util.PlatformThread;
import io.xpipe.extension.fxcomps.util.SimpleChangeListener;
import io.xpipe.extension.util.OsHelper;
import io.xpipe.extension.util.ThreadHelper;
import javafx.beans.binding.Bindings;
import javafx.beans.property.SimpleStringProperty;
import javafx.css.PseudoClass;
@ -103,7 +103,9 @@ public class StoreEntryComp extends SimpleComp {
var storeIcon = imageComp.createRegion();
storeIcon.getStyleClass().add("icon");
if (entry.getState().getValue().isUsable()) {
new FancyTooltipAugment<>(new SimpleStringProperty(entry.getEntry().getProvider().getDisplayName())).augment(storeIcon);
new FancyTooltipAugment<>(new SimpleStringProperty(
entry.getEntry().getProvider().getDisplayName()))
.augment(storeIcon);
}
return storeIcon;
}
@ -122,7 +124,6 @@ public class StoreEntryComp extends SimpleComp {
var storeIcon = createIcon();
grid.getColumnConstraints()
.addAll(
createShareConstraint(grid, STORE_TYPE_WIDTH), createShareConstraint(grid, NAME_WIDTH),
@ -167,11 +168,9 @@ public class StoreEntryComp extends SimpleComp {
var button = new IconButtonComp(
actionProvider.getIcon(entry.getEntry().getStore().asNeeded()), () -> {
try {
ThreadHelper.runFailableAsync(() -> {
actionProvider.execute(entry.getEntry().getStore().asNeeded());
} catch (Exception e) {
ErrorEvent.fromThrowable(e).handle();
}
});
});
button.apply(new FancyTooltipAugment<>(
actionProvider.getName(entry.getEntry().getStore().asNeeded())));
@ -224,11 +223,9 @@ public class StoreEntryComp extends SimpleComp {
var icon = actionProvider.getIcon(entry.getEntry().getStore().asNeeded());
var item = new MenuItem(null, new FontIcon(icon));
item.setOnAction(event -> {
try {
ThreadHelper.runFailableAsync(() -> {
actionProvider.execute(entry.getEntry().getStore().asNeeded());
} catch (Exception e) {
ErrorEvent.fromThrowable(e).handle();
}
});
});
item.textProperty().bind(name);
item.disableProperty().bind(Bindings.not(p.getValue()));

4
app/src/main/java/io/xpipe/app/grid/AppInstaller.java
View file

@ -11,7 +11,6 @@ import io.xpipe.core.process.ShellProcessControl;
import io.xpipe.core.process.ShellTypes;
import io.xpipe.core.store.ShellStore;
import io.xpipe.core.util.XPipeInstallation;
import io.xpipe.core.util.XPipeTempDirectory;
import io.xpipe.extension.util.ScriptHelper;
import lombok.Getter;
@ -38,8 +37,7 @@ public class AppInstaller {
if (s.isLocal()) {
targetFile = localFile.toString();
} else {
targetFile = FileNames.join(
XPipeTempDirectory.get(s), localFile.getFileName().toString());
targetFile = FileNames.join(s.getTemporaryDirectory(), localFile.getFileName().toString());
try (CommandProcessControl c = s.command(s.getShellType().getStreamFileWriteCommand(targetFile))
.start()) {
c.discardOut();

2
build.gradle
View file

@ -19,8 +19,6 @@ def getArchName() {
return arch
}
println(System.getenv('RELEASE'))
project.ext {
ci = System.getenv('CI') != null
os = org.gradle.internal.os.OperatingSystem.current()

5
core/src/main/java/io/xpipe/core/process/ShellProcessControl.java
View file

@ -15,6 +15,11 @@ public interface ShellProcessControl extends ProcessControl {
String prepareIntermediateTerminalOpen(String content) throws Exception;
String getTemporaryDirectory() throws Exception;
public void checkRunning() throws Exception;
default String executeStringSimpleCommand(String command) throws Exception {
try (CommandProcessControl c = command(command).start()) {
return c.readOrThrow();

8
core/src/main/java/io/xpipe/core/process/ShellTypes.java
View file

@ -162,10 +162,10 @@ public class ShellTypes {
var command = new ArrayList<String>();
for (String line : content.split("(\n|\r\n)")) {
command.add("echo " + escapeStringValue(line) + ">> \"" + file + "\"");
command.add("echo." + ">> \"" + file + "\"");
var echoCommand = line.isEmpty() ? "echo." : "echo " + escapeStringValue(line);
command.add(echoCommand + ">> \"" + file + "\"");
}
return String.join("&", command);
return String.join("&", command).replaceFirst(">>", ">");
}
@Override
@ -437,7 +437,7 @@ public class ShellTypes {
}
public String getScriptEchoCommand(String s) {
return "#!" + getExecutable() + "\n" + getEchoCommand(s, false) + "\nrm -- \"$0\"";
return getEchoCommand(s, false) + "\nrm -- \"$0\"";
}
@Override

7
ext/proc/src/main/java/io/xpipe/ext/proc/CommandProcessControlImpl.java
View file

@ -51,6 +51,7 @@ public class CommandProcessControlImpl extends ProcessControlImpl implements Com
private final Function<ShellProcessControl, String> terminalCommand;
private CommandProcessControlInputStream stdout;
private CommandProcessControlInputStream stderr;
private String displayCommand;
private boolean elevated;
private boolean manageParent;
private int exitCode = -1;
@ -177,8 +178,9 @@ public class CommandProcessControlImpl extends ProcessControlImpl implements Com
TrackEvent.withTrace("proc", "Starting command execution ...")
.tag("baseCommand", ShellHelper.censor(baseCommand, sensitive))
.tag("shellType", parent.getShellType().getName())
.tag("elevated", elevated)
.handle();
displayCommand = baseCommand;
if (elevated) {
string = ElevationHelper.elevateNormalCommand(string, parent, baseCommand);
}
@ -225,7 +227,8 @@ public class CommandProcessControlImpl extends ProcessControlImpl implements Com
}
}
TrackEvent.withTrace("proc", "Stdout finished")
TrackEvent.withDebug("proc", "Command finished")
.tag("command", displayCommand)
.tag("finishReason", r)
.tag("exitCode", exitCode)
.handle();

6
ext/proc/src/main/java/io/xpipe/ext/proc/DockerStore.java
View file

@ -59,11 +59,9 @@ public class DockerStore extends JacksonizedValue implements MachineStore {
"docker exec -i " + containerName + " " + ShellTypes.BASH.getNormalOpenCommand(),
(shellProcessControl, s) -> {
if (s != null) {
return "docker exec -it " + containerName + " "
+ ShellTypes.BASH.executeCommandWithShell(s);
return "docker exec -it " + containerName + " " + s;
} else {
return "docker exec -it " + containerName + " "
+ ShellTypes.BASH.getNormalOpenCommand();
return "docker exec -it " + containerName;
}
})
.elevated(shellProcessControl -> true);

24
ext/proc/src/main/java/io/xpipe/ext/proc/LocalProcessControlImpl.java
View file

@ -72,10 +72,13 @@ public class LocalProcessControlImpl extends ShellProcessControlImpl {
getStdin().close();
stdinClosed = true;
shellType = null;
charset = null;
uuid = null;
command = null;
if (!PrefsProvider.get(ProcPrefs.class).enableCaching().get()) {
shellType = null;
charset = null;
command = null;
tempDirectory = null;
}
try {
process.waitFor(EXIT_TIMEOUT, TimeUnit.MILLISECONDS);
@ -106,13 +109,12 @@ public class LocalProcessControlImpl extends ShellProcessControlImpl {
@Override
public String prepareIntermediateTerminalOpen(String content) throws Exception {
try (var pc = start()) {
var file = ScriptHelper.constructOpenWithInitScriptCommand(pc, initCommands, content);
var initCommand = ScriptHelper.constructOpenWithInitScriptCommand(pc, initCommands, content);
TrackEvent.withDebug("proc", "Writing open init script")
.tag("file", file)
.tag("initCommand", initCommand)
.tag("content", content)
.handle();
return file;
return initCommand;
}
}
@ -146,8 +148,12 @@ public class LocalProcessControlImpl extends ShellProcessControlImpl {
process = Runtime.getRuntime().exec(args.toArray(String[]::new));
stdinClosed = false;
running = true;
shellType = ShellHelper.determineType(this, Charset.defaultCharset(), command, null, startTimeout);
charset = shellType.determineCharset(this);
if (shellType == null) {
shellType = ShellHelper.determineType(this, Charset.defaultCharset(), command, null, startTimeout);
}
if (charset == null) {
charset = shellType.determineCharset(this);
}
osType = OsType.getLocal();
for (String s : initCommands) {

19
ext/proc/src/main/java/io/xpipe/ext/proc/ShellProcessControlImpl.java
View file

@ -5,6 +5,7 @@ import io.xpipe.core.process.OsType;
import io.xpipe.core.process.ShellProcessControl;
import io.xpipe.core.process.ShellType;
import io.xpipe.core.util.SecretValue;
import io.xpipe.core.util.XPipeTempDirectory;
import io.xpipe.ext.proc.util.ShellReader;
import lombok.Getter;
import lombok.NonNull;
@ -22,6 +23,7 @@ public abstract class ShellProcessControlImpl extends ProcessControlImpl impleme
protected UUID uuid;
protected String command;
protected List<String> initCommands = new ArrayList<>();
protected String tempDirectory;
@Getter
protected ShellType shellType;
@ -32,6 +34,23 @@ public abstract class ShellProcessControlImpl extends ProcessControlImpl impleme
@Getter
protected SecretValue elevationPassword;
@Override
public String getTemporaryDirectory() throws Exception {
if (tempDirectory == null) {
checkRunning();
tempDirectory = XPipeTempDirectory.get(this);
}
return tempDirectory;
}
@Override
public void checkRunning() throws Exception {
if (!isRunning()) {
throw new IllegalStateException("Shell process control is not running");
}
}
@Override
public ShellProcessControl sensitive() {
this.sensitive = true;

1
ext/proc/src/main/java/io/xpipe/ext/proc/SshProcessControlImpl.java
View file

@ -196,6 +196,7 @@ public class SshProcessControlImpl extends ShellProcessControlImpl {
shellType = null;
charset = null;
command = null;
tempDirectory = null;
}
getStderr().close();

41
ext/proc/src/main/java/io/xpipe/ext/proc/SubShellProcessControlImpl.java
View file

@ -47,54 +47,26 @@ public class SubShellProcessControlImpl extends ShellProcessControlImpl {
@Override
public String prepareTerminalOpen() throws Exception {
if (isRunning()) {
exitAndWait();
}
try (var parentPc = parent.start()) {
var operator = parent.getShellType().getOrConcatenationOperator();
var consoleCommand = this.terminalCommand.apply(parent, null);
var elevated = elevationFunction.test(parent);
if (elevated) {
consoleCommand = ElevationHelper.elevateTerminalCommand(consoleCommand, parent);
}
var openCommand = "";
try (var pc = start()) {
var initCommand = ScriptHelper.constructOpenWithInitScriptCommand(pc, initCommands, null);
openCommand = consoleCommand + " " + initCommand + operator
+ parent.getShellType().getPauseCommand();
TrackEvent.withDebug("proc", "Preparing for terminal open")
.tag("initCommand", initCommand)
.tag("openCommand", openCommand)
.handle();
}
return parent.prepareIntermediateTerminalOpen(openCommand);
}
return prepareIntermediateTerminalOpen(null);
}
@Override
public String prepareIntermediateTerminalOpen(String content) throws Exception {
public String prepareIntermediateTerminalOpen(String toExecuteInThis) throws Exception {
if (this.terminalCommand == null) {
throw new UnsupportedOperationException("Terminal open not supported");
}
try (var pc = start()) {
var operator = parent.getShellType().getOrConcatenationOperator();
var file = ScriptHelper.createExecScript(this, content, false);
var terminalCommand = this.terminalCommand.apply(parent, file);
var initCommand = ScriptHelper.constructOpenWithInitScriptCommand(pc, initCommands, toExecuteInThis);
var terminalCommand = this.terminalCommand.apply(parent, initCommand);
var elevated = elevationFunction.test(parent);
if (elevated) {
terminalCommand = ElevationHelper.elevateTerminalCommand(terminalCommand, parent);
}
var initCommand = ScriptHelper.constructOpenWithInitScriptCommand(pc, initCommands, terminalCommand);
var openCommand = initCommand + operator + parent.getShellType().getPauseCommand();
var openCommand = terminalCommand + operator + parent.getShellType().getPauseCommand();
TrackEvent.withDebug("proc", "Preparing for terminal open")
.tag("file", file)
.tag("content", ShellHelper.censor(content, sensitive))
.tag("openCommand", openCommand)
.tag("toExecuteInThis", ShellHelper.censor(toExecuteInThis, sensitive))
.tag("initCommand", initCommand)
.handle();
@ -277,6 +249,7 @@ public class SubShellProcessControlImpl extends ShellProcessControlImpl {
shellType = null;
charset = null;
command = null;
tempDirectory = null;
}
uuid = null;
}

4
ext/proc/src/main/java/io/xpipe/ext/proc/util/ShellHelper.java
View file

@ -21,6 +21,10 @@ public class ShellHelper {
private static final String DETECTOR_COMMAND = "echo " + DETECTOR_STRING;
public static String censor(String command, boolean sensitive ) {
if (command == null) {
return command;
}
if (!sensitive) {
return command;
}

35
extension/src/main/java/io/xpipe/extension/util/ScriptHelper.java
View file

@ -6,7 +6,6 @@ import io.xpipe.core.process.ShellProcessControl;
import io.xpipe.core.process.ShellType;
import io.xpipe.core.store.ShellStore;
import io.xpipe.core.util.SecretValue;
import io.xpipe.core.util.XPipeTempDirectory;
import io.xpipe.extension.event.TrackEvent;
import lombok.SneakyThrows;
@ -15,10 +14,10 @@ import java.util.Random;
public class ScriptHelper {
public static int getConnectionHash(String command) {
// This deterministic approach can cause permission problems when two different users execute the same command on a system
public static int getScriptId() {
// A deterministic approach can cause permission problems when two different users execute the same command on a system
// Therefore, use a random approach
return new Random().nextInt(Integer.MAX_VALUE);
//return Math.abs(Objects.hash(command, XPipeSession.get().getSystemSessionId()));
}
@SneakyThrows
@ -44,7 +43,8 @@ public class ScriptHelper {
}
if (toExecuteInShell != null) {
content += toExecuteInShell + nl;
// Normalize line endings
content += String.join(nl, toExecuteInShell.lines().toList()) + nl;
content += t.getExitCommand() + nl;
}
@ -52,19 +52,11 @@ public class ScriptHelper {
return t.getInitFileOpenCommand(initFile);
}
public static String prepend(ShellProcessControl processControl, List<String> init, String commands) {
var prefix = init != null && init.size() > 0
? String.join(processControl.getShellType().getNewLine().getNewLineString(), init)
+ processControl.getShellType().getNewLine().getNewLineString()
: "";
return prefix + commands;
}
@SneakyThrows
public static String createExecScript(ShellProcessControl processControl, String content, boolean restart) {
var fileName = "exec-" + getConnectionHash(content);
var fileName = "exec-" + getScriptId();
ShellType type = processControl.getShellType();
var temp = XPipeTempDirectory.get(processControl);
var temp = processControl.getTemporaryDirectory();
var file = FileNames.join(temp, fileName + "." + type.getScriptFileEnding());
return createExecScript(processControl, file, content, restart);
}
@ -75,20 +67,15 @@ public class ScriptHelper {
ShellType type = processControl.getShellType();
content = type.prepareScriptContent(content);
if (processControl.executeBooleanSimpleCommand(type.getFileExistsCommand(file))) {
return file;
}
TrackEvent.withTrace("proc", "Writing exec script")
.tag("file", file)
.tag("content", content)
.handle();
processControl.executeSimpleCommand(type.getFileTouchCommand(file), "Failed to create script " + file);
// processControl.executeSimpleCommand(type.getFileTouchCommand(file), "Failed to create script " + file);
processControl.executeSimpleCommand(type.getTextFileWriteCommand(content, file));
processControl.executeSimpleCommand(
type.getMakeExecutableCommand(file), "Failed to make script " + file + " executable");
processControl.executeSimpleCommand(type.getTextFileWriteCommand(content, file));
return file;
}
@ -96,8 +83,8 @@ public class ScriptHelper {
public static String createAskPassScript(
SecretValue pass, ShellProcessControl parent, ShellType type, boolean restart) {
var content = type.getScriptEchoCommand(pass.getSecretValue());
var temp = XPipeTempDirectory.get(parent);
var file = FileNames.join(temp, "askpass-" + getConnectionHash(content) + "." + type.getScriptFileEnding());
var temp = parent.getTemporaryDirectory();
var file = FileNames.join(temp, "askpass-" + getScriptId() + "." + type.getScriptFileEnding());
return createExecScript(parent, file, content, restart);
}
}

2
version
View file

@ -1 +1 @@
0.4.22
0.4.23