Issue 1771 - Update RootTools

src/org/adblockplus/android/configurators/IptablesProxyConfigurator.java

 /*
  * This file is part of Adblock Plus <http://adblockplus.org/>,
  * Copyright (C) 2006-2014 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 package org.adblockplus.android.configurators;
 
 import java.io.File;
 import java.io.FileNotFoundException;
+import java.io.IOException;
 import java.net.InetAddress;
+import java.util.ArrayList;
 import java.util.List;
+import java.util.concurrent.Semaphore;
+import java.util.concurrent.TimeoutException;
 
 import org.adblockplus.android.Utils;
 
-import com.stericson.RootTools.RootTools;
-
 import android.content.Context;
 import android.util.Log;
 
+import com.stericson.RootTools.RootTools;
+import com.stericson.RootTools.exceptions.RootDeniedException;
+import com.stericson.RootTools.execution.Command;
+import com.stericson.RootTools.execution.Shell;
+
 /**
  * Proxy registration using RootTools and iptables.
  */
 public class IptablesProxyConfigurator implements ProxyConfigurator
 {
   private static final String TAG = Utils.getTag(IptablesProxyConfigurator.class);
   private static final int DEFAULT_TIMEOUT = 3000;
   private static final String IPTABLES_RETURN = " -t nat -m owner --uid-owner {{UID}} -A OUTPUT -p tcp -j RETURN\n";
   private static final String IPTABLES_ADD_HTTP = " -t nat -A OUTPUT -p tcp --dport 80 -j REDIRECT --to {{PORT}}\n";
 
   private final Context context;
   private String iptables;
   private boolean isRegistered = false;
 
   public IptablesProxyConfigurator(final Context context)
   {
     this.context = context;
   }
 
+  private static List<String> sendShell(final String command, final int timeout) throws IOException, TimeoutException,

[Felix Dahlke, 2014/11/19 10:38:39]

I think "sendShell" is not a great name, I can see why they changed it. How
about going with "runRootCommand" or something similar here instead, for
clarity?

[René Jeschke, 2014/11/24 13:07:57]

Right, makes sense, will change this.

+      RootDeniedException
+  {
+    final CommandOutput cmd = new CommandOutput(0, DEFAULT_TIMEOUT, command);
+
+    Shell.runRootCommand(cmd);
+
+    cmd.waitForCompletion();
+
+    return cmd.output;
+  }
+
   @Override
   public boolean initialize()
   {
     try
     {
+      // If we don't set `handlerEnabled` to `false`, RootTools uses Handlers
+      // which get executed on the UI thread which in fact renders it useless
+      // for our purpose (as it either finished too late or blocks forever).
+      RootTools.handlerEnabled = false;
+
       if (!RootTools.isAccessGiven())
       {
         throw new IllegalStateException("No root access");
       }
 
       final File ipt = this.context.getFileStreamPath("iptables");
 
       if (!ipt.exists())
       {
         throw new FileNotFoundException("No iptables executable");
       }
 
       final String path = ipt.getAbsolutePath();
 
-      RootTools.sendShell("chmod 700 " + path, DEFAULT_TIMEOUT);
+      sendShell("chmod 700 " + path, DEFAULT_TIMEOUT);
 
       boolean compatible = false;
       boolean version = false;
 
       final String command = path + " --version\n" + path + " -L -t nat -n\n";
 
-      final List<String> result = RootTools.sendShell(command, DEFAULT_TIMEOUT);
+      final List<String> result = sendShell(command, DEFAULT_TIMEOUT);
 
       for (final String line : result)
       {
         if (line.contains("OUTPUT"))
         {
           compatible = true;
         }
         if (line.contains("v1.4."))
         {
           version = true;
@@ skipping 22 matching lines @@
     {
       final int uid = this.context.getPackageManager().getPackageInfo(this.context.getPackageName(), 0).applicationInfo.uid;
 
       final StringBuilder cmd = new StringBuilder();
       cmd.append(this.iptables);
       cmd.append(IPTABLES_RETURN.replace("{{UID}}", String.valueOf(uid)));
       cmd.append('\n');
       cmd.append(this.iptables);
       cmd.append(IPTABLES_ADD_HTTP.replace("{{PORT}}", String.valueOf(port)));
 
-      RootTools.sendShell(cmd.toString(), DEFAULT_TIMEOUT);
+      sendShell(cmd.toString(), DEFAULT_TIMEOUT);
 
       this.isRegistered = true;
 
       return true;
     }
     catch (final Exception e)
     {
       // I leave this logging message for now, passing 'init' and failing 'register' definitely is a failure
       Log.e(TAG, "Couldn't register proxy using iptables.", e);
       return false;
     }
   }
 
   @Override
   public void unregisterProxy()
   {
     try
     {
-      RootTools.sendShell(this.iptables + " -t nat -F OUTPUT", DEFAULT_TIMEOUT);
+      sendShell(this.iptables + " -t nat -F OUTPUT", DEFAULT_TIMEOUT);
     }
     catch (final Exception e)
     {
       Log.w(TAG, "Failed to unregister proxy using iptables.", e);
     }
     finally
     {
       this.isRegistered = false;
     }
   }
@@ skipping 15 matching lines @@
 
       final File ipt = context.getFileStreamPath("iptables");
 
       if (!ipt.exists())
       {
         throw new FileNotFoundException("No iptables executable");
       }
 
       final String path = ipt.getAbsolutePath();
 
-      RootTools.sendShell("chmod 700 " + path, DEFAULT_TIMEOUT);
+      sendShell("chmod 700 " + path, DEFAULT_TIMEOUT);
 
       boolean compatible = false;
       boolean version = false;
 
       String command = path + " --version\n" + path + " -L -t nat -n\n";
 
-      final List<String> result = RootTools.sendShell(command, DEFAULT_TIMEOUT);
+      final List<String> result = sendShell(command, DEFAULT_TIMEOUT);
 
       for (final String line : result)
       {
         if (line.contains("OUTPUT"))
         {
           compatible = true;
         }
         if (line.contains("v1.4."))
         {
           version = true;
         }
       }
 
       if (!(compatible && version))
       {
         throw new IllegalStateException("Incompatible iptables excutable");
       }
 
       command = path + " -L -t nat -n\n";
 
-      return RootTools.sendShell(command, DEFAULT_TIMEOUT);
+      return sendShell(command, DEFAULT_TIMEOUT);
     }
     catch (final Throwable t)
     {
       return null;
     }
   }
 
   @Override
   public ProxyRegistrationType getType()
   {
@@ skipping 10 matching lines @@
   public boolean isSticky()
   {
     return false;
   }
 
   @Override
   public String toString()
   {
     return "[ProxyConfigurator: " + this.getType() + "]";
   }
+
+  private final static class CommandOutput extends Command

[Felix Dahlke, 2014/11/19 10:38:39]

Shouldn't this rather be "OutputCommand" (or anything else ending in "Command"),
since it's a command, not an "output"?

[René Jeschke, 2014/11/24 13:07:57]

Right, will also change this.

+  {
+    private final Semaphore completionNotify = new Semaphore(1);

[Felix Dahlke, 2014/11/19 10:38:39]

This confused me a little bit, being a verb (bit unusual for field names). How
about just "running" or something?

[René Jeschke, 2014/11/24 13:07:57]

"running" as name for a flag would mean sense, but I'm using a Semaphore here,
which is used for waiting/counting.

I will come up with something different, still.

[René Jeschke, 2015/01/23 13:37:36]

Ok, I changed this to running as I don't have a better name (except
'semaphore').

Thing is, 'running' is wrong, as running is either true or false. A semaphore
has no true/false it is an integer.

Still, maybe someone finds a better name in the future^^

[Felix Dahlke, 2015/01/27 08:45:36]

True, but I figure for a semaphore with one permit, it seems OK.

+
+    public List<String> output = new ArrayList<String>();
+
+    public CommandOutput(final int id, final int timeout, final String command)
+    {
+      super(id, timeout, command);
+
+      this.completionNotify.acquireUninterruptibly();
+    }
+
+    @Override
+    public void commandOutput(int id, String line)
+    {
+      this.output.add(line);
+    }
+
+    @Override
+    public void commandCompleted(int id, int exitCode)
+    {
+      this.completionNotify.release();
+    }
+
+    @Override
+    public void commandTerminated(int id, String reason)
+    {
+      this.completionNotify.release();
+    }
+
+    public void waitForCompletion()
+    {
+      this.completionNotify.acquireUninterruptibly();
+    }
+  }
 }