Made wake-on-lan chainable in a very human readable format and gave it an async method to avoid network on main thread issues

Author: stealthcopter

library/src/main/java/com/stealthcopter/networktools/MACTools.java

@@ -0,0 +1,59 @@
+package com.stealthcopter.networktools;
+
+import android.support.annotation.NonNull;
+
+import java.util.regex.Pattern;
+
+public class MACTools {
+
+    private static final Pattern PATTERN_MAC =
+            Pattern.compile(
+                    "^([0-9A-Fa-f]{2}[\\.:-]){5}([0-9A-Fa-f]{2})$");
+
+    // This class is not to be instantiated
+    private MACTools() {
+    }
+
+
+    /**
+     * Validates a provided MAC address
+     *
+     * @param macAddress - the MAC address to check
+     *
+     * @return - true if it is valid MAC address in IEEE802 format (either hyphen or colon seperated)
+     *               eg: "01:23:45:67:89:AB:CD:EF" or "01-23-45-67-89-AB-CD-EF"
+     */
+    public static boolean isValidMACAddress(final String macAddress) {
+        return PATTERN_MAC.matcher(macAddress).matches();
+    }
+
+
+    /**
+     * Convert a MAC string to bytes
+     *
+     * @param macStr - MAC string in IEEE802 format (either hyphen or colon seperated)
+     *               eg: "01:23:45:67:89:AB:CD:EF" or "01-23-45-67-89-AB-CD-EF"
+     *
+     * @return - MAC formatted in bytes
+     * @throws IllegalArgumentException - if mac address is invalid
+     */
+    public static byte[] getMacBytes(@NonNull String macStr) throws IllegalArgumentException {
+
+        if (macStr == null) throw new IllegalArgumentException("Mac Address cannot be null");
+
+        byte[] bytes = new byte[6];
+        String[] hex = macStr.split("(\\:|\\-)");
+        if (hex.length != 6) {
+            throw new IllegalArgumentException("Invalid MAC address.");
+        }
+        try {
+            for (int i = 0; i < 6; i++) {
+                bytes[i] = (byte) Integer.parseInt(hex[i], 16);
+            }
+        } catch (NumberFormatException e) {
+            throw new IllegalArgumentException("Invalid hex digit in MAC address.");
+        }
+        return bytes;
+    }
+
+}

library/src/main/java/com/stealthcopter/networktools/Ping.java

@@ -21,8 +21,10 @@ private Ping() {
     public interface PingListener{
         void onResult(PingResult pingResult);
         void onFinished(PingStats pingStats);
+        void onError(Exception e);
     }
 
+    private String addressString = null;
     private InetAddress address;
     private int timeOutMillis = 1000;
     private int delayBetweenScansMillis = 0;
@@ -31,14 +33,16 @@ public interface PingListener{
 
     /**
      * Set the address to ping
+     *
+     * Note that a lookup is not performed here so that we do not accidentally perform a network
+     * request on the UI thread.
+     *
      * @param address - Address to be pinged
      * @return this object to allow chaining
-     * @throws UnknownHostException
      */
-    public static Ping onAddress(@NonNull String address) throws UnknownHostException {
+    public static Ping onAddress(@NonNull String address) {
         Ping ping = new Ping();
-        InetAddress ia = InetAddress.getByName(address);
-        ping.setAddress(ia);
+        ping.setAddressString(address);
         return ping;
     }
 
@@ -90,6 +94,25 @@ private void setAddress(InetAddress address) {
         this.address = address;
     }
 
+    /**
+     * Set the address string which will be resolved to an address by resolveAddressString()
+     * @param addressString - String of the address to be pinged
+     */
+    private void setAddressString(String addressString) {
+        this.addressString = addressString;
+    }
+
+    /**
+     * Parses the addressString to an address
+     *
+     * @throws UnknownHostException - if host cannot be found
+     */
+    private void resolveAddressString() throws UnknownHostException {
+        if (address == null && addressString !=null){
+            address = InetAddress.getByName(addressString);
+        }
+    }
+
     /**
      * Cancel a running ping
      */
@@ -99,10 +122,14 @@ public void cancel() {
 
     /**
      * Perform a synchronous ping and return a result, will ignore number of times.
+     *
+     * Note that this should be performed on a background thread as it will perform a network
+     * request
      * @return - ping result
      */
-    public PingResult doPing(){
+    public PingResult doPing() throws UnknownHostException {
         cancelled = false;
+        resolveAddressString();
         return PingTools.doPing(address, timeOutMillis);
     }
 
@@ -117,6 +144,18 @@ public Ping doPing(final PingListener pingListener){
             @Override
             public void run() {
 
+                try {
+                    resolveAddressString();
+                } catch (UnknownHostException e) {
+                    pingListener.onError(e);
+                    return;
+                }
+
+                if (address == null){
+                    pingListener.onError(new NullPointerException("Address is null"));
+                    return;
+                }
+
                 long pingsCompleted = 0;
                 long noLostPackets = 0;
                 float totalPingTime = 0;

library/src/main/java/com/stealthcopter/networktools/PortScan.java

@@ -66,26 +66,7 @@ public static PortScan onAddress(@NonNull String address) throws UnknownHostExce
     public static PortScan onAddress(@NonNull InetAddress ia) {
         PortScan portScan = new PortScan();
         portScan.setAddress(ia);
-
-        // Try and work out automatically what kind of host we are scanning
-        // local host (this device) / local network / remote
-        if (IPTools.isIpAddressLocalhost(ia)){
-            // If we are scanning a the localhost set the timeout to be very short so we get faster results
-            // This will be overridden if user calls setTimeoutMillis manually.
-            portScan.timeOutMillis = TIMEOUT_LOCALHOST;
-            portScan.noThreads = DEFAULT_THREADS_LOCALHOST;
-        }
-        else if (IPTools.isIpAddressLocalNetwork(ia)){
-            // Assume local network (not infallible)
-            portScan.timeOutMillis = TIMEOUT_LOCALNETWORK;
-            portScan.noThreads = DEFAULT_THREADS_LOCALNETWORK;
-        }
-        else{
-            // Assume remote network timeouts
-            portScan.timeOutMillis = TIMEOUT_REMOTE;
-            portScan.noThreads = DEFAULT_THREADS_REMOTE;
-        }
-
+        portScan.setDefaultThreadsAndTimeouts();
         return portScan;
     }
 
@@ -218,6 +199,26 @@ private void setAddress(InetAddress address) {
         this.address = address;
     }
 
+    private void setDefaultThreadsAndTimeouts(){
+        // Try and work out automatically what kind of host we are scanning
+        // local host (this device) / local network / remote
+        if (IPTools.isIpAddressLocalhost(address)){
+            // If we are scanning a the localhost set the timeout to be very short so we get faster results
+            // This will be overridden if user calls setTimeoutMillis manually.
+            timeOutMillis = TIMEOUT_LOCALHOST;
+            noThreads = DEFAULT_THREADS_LOCALHOST;
+        }
+        else if (IPTools.isIpAddressLocalNetwork(address)){
+            // Assume local network (not infallible)
+            timeOutMillis = TIMEOUT_LOCALNETWORK;
+            noThreads = DEFAULT_THREADS_LOCALNETWORK;
+        }
+        else{
+            // Assume remote network timeouts
+            timeOutMillis = TIMEOUT_REMOTE;
+            noThreads = DEFAULT_THREADS_REMOTE;
+        }
+    }
 
      /**
       *
@@ -226,7 +227,7 @@ private void setAddress(InetAddress address) {
       * @return self
       * @throws IllegalAccessException - if no threads is less than 1
       */
-    public PortScan setNoThreads(int noThreads) throws IllegalAccessException {
+    public PortScan setNoThreads(int noThreads) throws IllegalArgumentException {
         if (noThreads < 1) throw new IllegalArgumentException("Cannot have less than 1 thread");
         this.noThreads = noThreads;
         return this;