fankes/termux-app
2
0
Fork 0
mirror of https://github.com/fankes/termux-app.git synced 2025-09-07 03:05:18 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update ExecutionCommand to make current and previous state private to prevent direct modification

Browse Source 
- Helper functions are now provided to check for common states. The currentState and previousState must only be modified via setState()
- Some errCode values are also provided to prevent hardcoded value usage.
- The stdout, stderr and arguments will now be truncated for logcat to honour its LOGGER_ENTRY_MAX_LEN limits
This commit is contained in:
agnostic-apollo
2021-03-25 09:20:09 +05:00
parent 922f4f4ae5
commit 7ca20fdeb3
2 changed files with 52 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
app/src/main/java/com/termux/app/RunCommandService.java
View File

@@ -193,7 +193,7 @@ public class RunCommandService extends Service {
// If invalid action passed, then just return // If invalid action passed, then just return
if (!RUN_COMMAND_SERVICE.ACTION_RUN_COMMAND.equals(intent.getAction())) { if (!RUN_COMMAND_SERVICE.ACTION_RUN_COMMAND.equals(intent.getAction())) {
errmsg = this.getString(R.string.error_run_command_service_invalid_intent_action, intent.getAction()); errmsg = this.getString(R.string.error_run_command_service_invalid_intent_action, intent.getAction());
executionCommand.setStateFailed(1, errmsg, null); executionCommand.setStateFailed(ExecutionCommand.RESULT_CODE_FAILED, errmsg, null);
PluginUtils.processPluginExecutionCommandError(this, LOG_TAG, executionCommand); PluginUtils.processPluginExecutionCommandError(this, LOG_TAG, executionCommand);
return Service.START_NOT_STICKY; return Service.START_NOT_STICKY;
} }
@@ -213,7 +213,7 @@ public class RunCommandService extends Service {
// If "allow-external-apps" property to not set to "true", then just return // If "allow-external-apps" property to not set to "true", then just return
errmsg = PluginUtils.checkIfRunCommandServiceAllowExternalAppsPolicyIsViolated(this); errmsg = PluginUtils.checkIfRunCommandServiceAllowExternalAppsPolicyIsViolated(this);
if (errmsg != null) { if (errmsg != null) {
executionCommand.setStateFailed(1, errmsg, null); executionCommand.setStateFailed(ExecutionCommand.RESULT_CODE_FAILED, errmsg, null);
PluginUtils.processPluginExecutionCommandError(this, LOG_TAG, executionCommand); PluginUtils.processPluginExecutionCommandError(this, LOG_TAG, executionCommand);
return Service.START_NOT_STICKY; return Service.START_NOT_STICKY;
} }
@@ -228,7 +228,7 @@ public class RunCommandService extends Service {
false, false); false, false);
if (errmsg != null) { if (errmsg != null) {
errmsg += "\n" + this.getString(R.string.msg_executable_absolute_path, executionCommand.executable); errmsg += "\n" + this.getString(R.string.msg_executable_absolute_path, executionCommand.executable);
executionCommand.setStateFailed(1, errmsg, null); executionCommand.setStateFailed(ExecutionCommand.RESULT_CODE_FAILED, errmsg, null);
PluginUtils.processPluginExecutionCommandError(this, LOG_TAG, executionCommand); PluginUtils.processPluginExecutionCommandError(this, LOG_TAG, executionCommand);
return Service.START_NOT_STICKY; return Service.START_NOT_STICKY;
} }
@@ -249,7 +249,7 @@ public class RunCommandService extends Service {
true); true);
if (errmsg != null) { if (errmsg != null) {
errmsg += "\n" + this.getString(R.string.msg_working_directory_absolute_path, executionCommand.workingDirectory); errmsg += "\n" + this.getString(R.string.msg_working_directory_absolute_path, executionCommand.workingDirectory);
executionCommand.setStateFailed(1, errmsg, null); executionCommand.setStateFailed(ExecutionCommand.RESULT_CODE_FAILED, errmsg, null);
PluginUtils.processPluginExecutionCommandError(this, LOG_TAG, executionCommand); PluginUtils.processPluginExecutionCommandError(this, LOG_TAG, executionCommand);
return Service.START_NOT_STICKY; return Service.START_NOT_STICKY;
} }

66
app/src/main/java/com/termux/models/ExecutionCommand.java
View File

@@ -1,5 +1,6 @@
package com.termux.models; package com.termux.models;
import android.app.Activity;
import android.app.PendingIntent; import android.app.PendingIntent;
import android.net.Uri; import android.net.Uri;
@@ -49,14 +50,20 @@ public class ExecutionCommand {
} }
// Define errCode values
// TODO: Define custom values for different cases
public final static int RESULT_CODE_OK = Activity.RESULT_OK;
public final static int RESULT_CODE_OK_MINOR_FAILURES = Activity.RESULT_FIRST_USER;
public final static int RESULT_CODE_FAILED = Activity.RESULT_FIRST_USER + 1;
/** The optional unique id for the {@link ExecutionCommand}. */ /** The optional unique id for the {@link ExecutionCommand}. */
public Integer id; public Integer id;
/** The current state of the {@link ExecutionCommand}. */ /** The current state of the {@link ExecutionCommand}. */
public ExecutionState currentState = ExecutionState.PRE_EXECUTION; private ExecutionState currentState = ExecutionState.PRE_EXECUTION;
/** The previous state of the {@link ExecutionCommand}. */ /** The previous state of the {@link ExecutionCommand}. */
public ExecutionState previousState = ExecutionState.PRE_EXECUTION; private ExecutionState previousState = ExecutionState.PRE_EXECUTION;
/** The executable for the {@link ExecutionCommand}. */ /** The executable for the {@link ExecutionCommand}. */
@@ -110,7 +117,7 @@ public class ExecutionCommand {
/** The internal error code of {@link ExecutionCommand}. */ /** The internal error code of {@link ExecutionCommand}. */
public Integer errCode; public Integer errCode = RESULT_CODE_OK;
/** The internal error message of {@link ExecutionCommand}. */ /** The internal error message of {@link ExecutionCommand}. */
public String errmsg; public String errmsg;
/** The internal exceptions of {@link ExecutionCommand}. */ /** The internal exceptions of {@link ExecutionCommand}. */
@@ -137,7 +144,7 @@ public class ExecutionCommand {
@NonNull @NonNull
@Override @Override
public String toString() { public String toString() {
if(currentState.getValue() < ExecutionState.EXECUTED.getValue()) if(!hasExecuted())
return getExecutionInputLogString(this, true); return getExecutionInputLogString(this, true);
else { else {
return getExecutionOutputLogString(this, true); return getExecutionOutputLogString(this, true);
@@ -156,8 +163,7 @@ public class ExecutionCommand {
StringBuilder logString = new StringBuilder(); StringBuilder logString = new StringBuilder();
logString.append(executionCommand.getIdLogString()); logString.append(executionCommand.getCommandIdAndLabelLogString()).append(":");
logString.append(executionCommand.getCommandLabelLogString()).append(":");
if(executionCommand.previousState != ExecutionState.PRE_EXECUTION) if(executionCommand.previousState != ExecutionState.PRE_EXECUTION)
logString.append("\n").append(executionCommand.getPreviousStateLogString()); logString.append("\n").append(executionCommand.getPreviousStateLogString());
@@ -194,8 +200,7 @@ public class ExecutionCommand {
StringBuilder logString = new StringBuilder(); StringBuilder logString = new StringBuilder();
logString.append(executionCommand.getIdLogString()); logString.append(executionCommand.getCommandIdAndLabelLogString()).append(":");
logString.append(executionCommand.getCommandLabelLogString()).append(":");
logString.append("\n").append(executionCommand.getPreviousStateLogString()); logString.append("\n").append(executionCommand.getPreviousStateLogString());
logString.append("\n").append(executionCommand.getCurrentStateLogString()); logString.append("\n").append(executionCommand.getCurrentStateLogString());
@@ -219,7 +224,7 @@ public class ExecutionCommand {
public static String getExecutionErrLogString(ExecutionCommand executionCommand, boolean ignoreNull) { public static String getExecutionErrLogString(ExecutionCommand executionCommand, boolean ignoreNull) {
StringBuilder logString = new StringBuilder(); StringBuilder logString = new StringBuilder();
if(!ignoreNull || (executionCommand.errCode != null && executionCommand.errCode != 0)) { if(!ignoreNull || (executionCommand.isStateFailed())) {
logString.append("\n").append(executionCommand.getErrCodeLogString()); logString.append("\n").append(executionCommand.getErrCodeLogString());
logString.append("\n").append(executionCommand.getErrmsgLogString()); logString.append("\n").append(executionCommand.getErrmsgLogString());
logString.append("\n").append(executionCommand.geStackTracesLogString()); logString.append("\n").append(executionCommand.geStackTracesLogString());
@@ -332,6 +337,10 @@ public class ExecutionCommand {
return "Execution Command"; return "Execution Command";
} }
public String getCommandIdAndLabelLogString() {
return getIdLogString() + getCommandLabelLogString();
}
public String getExecutableLogString() { public String getExecutableLogString() {
return "Executable: `" + executable + "`"; return "Executable: `" + executable + "`";
} }
@@ -380,11 +389,11 @@ public class ExecutionCommand {
} }
public String getStdoutLogString() { public String getStdoutLogString() {
return getMultiLineLogStringEntry("Stdout", stdout, "-"); return getMultiLineLogStringEntry("Stdout", TextDataUtils.getTruncatedCommandOutput(stdout, TextDataUtils.LOGGER_ENTRY_SIZE_LIMIT_IN_BYTES / 5, false, false, true), "-");
} }
public String getStderrLogString() { public String getStderrLogString() {
return getMultiLineLogStringEntry("Stderr", stderr, "-"); return getMultiLineLogStringEntry("Stderr", TextDataUtils.getTruncatedCommandOutput(stderr, TextDataUtils.LOGGER_ENTRY_SIZE_LIMIT_IN_BYTES / 5, false, false, true), "-");
} }
public String getExitCodeLogString() { public String getExitCodeLogString() {
@@ -464,7 +473,9 @@ public class ExecutionCommand {
if (argumentsArray != null && argumentsArray.length != 0) { if (argumentsArray != null && argumentsArray.length != 0) {
argumentsString.append("\n```\n"); argumentsString.append("\n```\n");
for (int i = 0; i != argumentsArray.length; i++) { for (int i = 0; i != argumentsArray.length; i++) {
argumentsString.append(getSingleLineLogStringEntry("Arg " + (i + 1), argumentsArray[i], "-")).append("`\n"); argumentsString.append(getSingleLineLogStringEntry("Arg " + (i + 1),
TextDataUtils.getTruncatedCommandOutput(argumentsArray[i], TextDataUtils.LOGGER_ENTRY_SIZE_LIMIT_IN_BYTES / 5, true, false, true),
"-")).append("`\n");
} }
argumentsString.append("```"); argumentsString.append("```");
} else{ } else{
@@ -495,7 +506,7 @@ public class ExecutionCommand {
public boolean setState(ExecutionState newState) { public boolean setState(ExecutionState newState) {
// The state transition cannot go back or change if already at {@link ExecutionState#SUCCESS} // The state transition cannot go back or change if already at {@link ExecutionState#SUCCESS}
if(newState.getValue() < currentState.getValue() || currentState == ExecutionState.SUCCESS) { if(newState.getValue() < currentState.getValue() || currentState == ExecutionState.SUCCESS) {
Logger.logError("Invalid ExecutionCommand state transition from \"" + currentState.getName() + "\" to " + "\"" + newState.getName() + "\""); Logger.logError("Invalid "+ getCommandIdAndLabelLogString() + " state transition from \"" + currentState.getName() + "\" to " + "\"" + newState.getName() + "\"");
return false; return false;
} }
@@ -510,15 +521,18 @@ public class ExecutionCommand {
} }
public boolean setStateFailed(int errCode, String errmsg, Throwable throwable) { public boolean setStateFailed(int errCode, String errmsg, Throwable throwable) {
if(errCode < 1) if (errCode > RESULT_CODE_OK) {
return false; this.errCode = errCode;
} else {
Logger.logWarn("Ignoring invalid " + getCommandIdAndLabelLogString() + " errCode value \"" + errCode + "\". Force setting it to RESULT_CODE_FAILED \"" + RESULT_CODE_FAILED + "\"");
this.errCode = RESULT_CODE_FAILED;
}
this.errmsg = errmsg;
if(!setState(ExecutionState.FAILED)) if(!setState(ExecutionState.FAILED))
return false; return false;
this.errCode = errCode;
this.errmsg = errmsg;
if(this.throwableList == null) if(this.throwableList == null)
this.throwableList = new ArrayList<>(); this.throwableList = new ArrayList<>();
@@ -528,4 +542,20 @@ public class ExecutionCommand {
return true; return true;
} }
public boolean isStateFailed() {
if(currentState != ExecutionState.FAILED)
return false;
if(errCode <= RESULT_CODE_OK) {
Logger.logWarn("The " + getCommandIdAndLabelLogString() + " has an invalid errCode value \"" + errCode + "\" while having ExecutionState.FAILED state.");
return false;
} else {
return true;
}
}
public boolean hasExecuted() {
return currentState.getValue() >= ExecutionState.EXECUTED.getValue();
}
} }