Updated RootShell, Fixed some bugs related to re-using commands (disallowed command re-use)

Author: Stericson

build.gradle

@@ -2,6 +2,11 @@ buildscript {
     repositories {
         jcenter()
     }
+
+    repositories {
+        maven { url 'http://repo1.maven.org/maven2' }
+    }
+
     dependencies {
         classpath 'com.android.tools.build:gradle:1.5.0'
         classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'
@@ -12,8 +17,6 @@ repositories {
     jcenter()
 }
 
-apply from: 'https://gist.githubusercontent.com/larsgrefer/30b36bd74b162631f143/raw/d4155e673d7908193eb65f9bb6640250d7f282d8/git-version.gradle'
-
 apply plugin: 'com.android.library'
 
 android {
@@ -22,7 +25,7 @@ android {
 
     defaultConfig {
         minSdkVersion 11
-        targetSdkVersion 21
+        targetSdkVersion 23
         versionName project.version
     }
 
@@ -34,39 +37,4 @@ android {
 
 dependencies {
     testCompile 'junit:junit:4.12'
-}
-
-apply plugin: 'com.github.dcendents.android-maven'
-
-android.libraryVariants.all { variant ->
-
-    if (variant.name.contains("release")) {
-        task("sources${variant.name.capitalize()}Jar", type: Jar) {
-            from variant.javaCompile.source
-            classifier = 'sources'
-        }
-
-        task("javadoc${variant.name.capitalize()}", type: Javadoc) {
-            description "Generates Javadoc for $variant.name."
-            source = variant.javaCompile.source
-            ext.androidJar = "${android.sdkDirectory}/platforms/${android.compileSdkVersion}/android.jar"
-            classpath = files(variant.javaCompile.classpath.files) + files(ext.androidJar)
-            options.links("http://docs.oracle.com/javase/7/docs/api/");
-            options.links("http://developer.android.com/reference/");
-            options.addStringOption('Xdoclint:none', '-quiet')
-            failOnError false
-        }
-
-        task("javadoc${variant.name.capitalize()}Jar", type: Jar, dependsOn: "javadoc${variant.name.capitalize()}") {
-            description "Generates Javadoc Jar for $variant.name."
-            classifier = 'javadoc'
-            from tasks.findByPath("javadoc${variant.name.capitalize()}").destinationDir
-        }
-
-        artifacts {
-            archives tasks.findByPath("javadoc${variant.name.capitalize()}Jar")
-            archives tasks.findByPath("sources${variant.name.capitalize()}Jar")
-        }
-    }
-}
-
+}

src/main/java/com/stericson/RootShell/RootShell.java

@@ -45,7 +45,7 @@ public class RootShell {
 
     public static boolean debugMode = false;
 
-    public static final String version = "RootShell v1.3";
+    public static final String version = "RootShell v1.4";
 
     /**
      * Setting this to false will disable the handler that is used
@@ -141,6 +141,7 @@ public void commandOutput(int id, String line) {
             commandWait(RootShell.getShell(false), command);
 
         } catch (Exception e) {
+            RootShell.log("Exception: " + e);
             return false;
         }
 
@@ -152,11 +153,22 @@ public void commandOutput(int id, String line) {
 
         result.clear();
 
+        command = new Command(0, false, cmdToExecute + file) {
+            @Override
+            public void commandOutput(int id, String line) {
+                RootShell.log(line);
+                result.add(line);
+
+                super.commandOutput(id, line);
+            }
+        };
+
         try {
             RootShell.getShell(true).add(command);
             commandWait(RootShell.getShell(true), command);
 
         } catch (Exception e) {
+            RootShell.log("Exception: " + e);
             return false;
         }
 
@@ -176,20 +188,22 @@ public void commandOutput(int id, String line) {
 
     /**
      * @param binaryName String that represent the binary to find.
+     * @param singlePath boolean that represents whether to return a single path or multiple.
      *
      * @return <code>List<String></code> containing the locations the binary was found at.
      */
-    public static List<String> findBinary(final String binaryName) {
-        return findBinary(binaryName, null);
+    public static List<String> findBinary(String binaryName, boolean singlePath) {
+        return findBinary(binaryName, null, singlePath);
     }
 
     /**
      * @param binaryName <code>String</code> that represent the binary to find.
      * @param searchPaths <code>List<String></code> which contains the paths to search for this binary in.
+     * @param singlePath boolean that represents whether to return a single path or multiple.
      *
      * @return <code>List<String></code> containing the locations the binary was found at.
      */
-    public static List<String> findBinary(final String binaryName, List<String> searchPaths) {
+    public static List<String> findBinary(final String binaryName, List<String> searchPaths, boolean singlePath) {
 
         final List<String> foundPaths = new ArrayList<String>();
 
@@ -228,12 +242,16 @@ public void commandOutput(int id, String line) {
                     }
                 };
 
-                RootShell.getShell(false).add(cc);
+                cc = RootShell.getShell(false).add(cc);
                 commandWait(RootShell.getShell(false), cc);
 
+                if(foundPaths.size() > 0 && singlePath) {
+                    break;
+                }
             }
 
             found = !foundPaths.isEmpty();
+
         } catch (Exception e) {
             RootShell.log(binaryName + " was not found, more information MAY be available with Debugging on.");
         }
@@ -251,6 +269,11 @@ public void commandOutput(int id, String line) {
                 if (RootShell.exists(path + binaryName)) {
                     RootShell.log(binaryName + " was found here: " + path);
                     foundPaths.add(path);
+
+                    if(foundPaths.size() > 0 && singlePath) {
+                        break;
+                    }
+
                 } else {
                     RootShell.log(binaryName + " was NOT found here: " + path);
                 }
@@ -394,14 +417,14 @@ public void commandOutput(int id, String line) {
      */
     public static boolean isBusyboxAvailable()
     {
-        return (findBinary("busybox")).size() > 0;
+        return (findBinary("busybox", true)).size() > 0;
     }
 
     /**
      * @return <code>true</code> if su was found.
      */
     public static boolean isRootAvailable() {
-        return (findBinary("su")).size() > 0;
+        return (findBinary("su", true)).size() > 0;
     }
 
     /**

src/main/java/com/stericson/RootShell/execution/Command.java

@@ -46,6 +46,9 @@ public class Command {
 
     Handler mHandler = null;
 
+    //Has this command already been used?
+    protected boolean used = false;
+
     boolean executing = false;
 
     String[] command = {};
@@ -159,8 +162,8 @@ public final void finish()
     }
 
     protected final void finishCommand() {
-        executing = false;
-        finished = true;
+        this.executing = false;
+        this.finished = true;
         this.notifyAll();
     }
 
@@ -202,7 +205,8 @@ protected final void setExitCode(int code) {
     }
 
     protected final void startExecution() {
-        executionMonitor = new ExecutionMonitor();
+        this.used = true;
+        executionMonitor = new ExecutionMonitor(this);
         executionMonitor.setPriority(Thread.MIN_PRIORITY);
         executionMonitor.start();
         executing = true;
@@ -259,34 +263,28 @@ protected final void output(int id, String line) {
         }
     }
 
-    public final void resetCommand()
-    {
-        this.finished = false;
-        this.totalOutput = 0;
-        this.totalOutputProcessed = 0;
-        this.executing = false;
-        this.terminated = false;
-        this.exitCode = -1;
-    }
-
     private class ExecutionMonitor extends Thread {
 
+        private final Command command;
+
+        public ExecutionMonitor(Command command) {
+            this.command = command;
+        }
+
         public void run() {
 
-            if(timeout > 0)
+            if(command.timeout > 0)
             {
-                //We need to kill the command after the given timeout
-                while (!finished) {
-
-                    synchronized (Command.this) {
-                        try {
-                            Command.this.wait(timeout);
-                        } catch (InterruptedException e) {
-                        }
+                synchronized (command) {
+                    try {
+                        RootShell.log("Command " + command.id + " is waiting for: " + command.timeout);
+                        command.wait(command.timeout);
+                    } catch (InterruptedException e) {
+                        RootShell.log("Exception: " + e);
                     }
 
-                    if (!finished) {
-                        RootShell.log("Timeout Exception has occurred.");
+                    if (!command.isFinished()) {
+                        RootShell.log("Timeout Exception has occurred for command: " + command.id + ".");
                         terminate("Timeout Exception");
                     }
                 }

src/main/java/com/stericson/RootShell/execution/Shell.java

@@ -251,13 +251,17 @@ public Command add(Command command) throws IOException {
                     "Unable to add commands to a closed shell");
         }
 
+        if(command.used) {
+            //The command has been used, don't re-use...
+            throw new IllegalStateException(
+                    "This command has already been executed. (Don't re-use command instances.)");
+        }
+
         while (this.isCleaning) {
             //Don't add commands while cleaning
             ;
         }
 
-        command.resetCommand();
-
         this.commands.add(command);
 
         this.notifyThreads();
@@ -594,10 +598,15 @@ public void run() {
                         cmd.startExecution();
                         RootShell.log("Executing: " + cmd.getCommand() + " with context: " + shellContext);
 
+                        //write the command
                         outputStream.write(cmd.getCommand());
+                        outputStream.flush();
+
+                        //write the token...
                         String line = "\necho " + token + " " + totalExecuted + " $?\n";
                         outputStream.write(line);
                         outputStream.flush();
+
                         write++;
                         totalExecuted++;
                     } else if (close) {
@@ -611,11 +620,10 @@ public void run() {
                         return;
                     }
                 }
-            } catch (IOException e) {
-                RootShell.log(e.getMessage(), RootShell.LogLevel.ERROR, e);
-            } catch (InterruptedException e) {
+            } catch (IOException | InterruptedException e) {
                 RootShell.log(e.getMessage(), RootShell.LogLevel.ERROR, e);
-            } finally {
+            }
+            finally {
                 write = 0;
                 closeQuietly(outputStream);
             }
@@ -687,6 +695,7 @@ public void run() {
                         /**
                          * token is suffix of output, send output part to implementer
                          */
+                        RootShell.log("Found token, line: " + outputLine);
                         command.output(command.id, outputLine.substring(0, pos));
                     }
 
@@ -741,6 +750,7 @@ public void run() {
 
                                 command.setExitCode(exitCode);
                                 command.commandFinished();
+
                                 command = null;
 
                                 read++;
@@ -814,12 +824,12 @@ public void processErrors(Command command) {
         }
     }
 
-    public static void runRootCommand(Command command) throws IOException, TimeoutException, RootDeniedException {
-        Shell.startRootShell().add(command);
+    public static Command runRootCommand(Command command) throws IOException, TimeoutException, RootDeniedException {
+        return Shell.startRootShell().add(command);
     }
 
-    public static void runCommand(Command command) throws IOException, TimeoutException {
-        Shell.startShell().add(command);
+    public static Command runCommand(Command command) throws IOException, TimeoutException {
+        return Shell.startShell().add(command);
     }
 
     public static Shell startRootShell() throws IOException, TimeoutException, RootDeniedException {