From 9e49237f01d0d229eaf3698da962dc700125113a Mon Sep 17 00:00:00 2001
From: Lukas Vacek <lucas.vacek@gmail.com>
Date: Wed, 25 Feb 2015 01:36:38 +0100
Subject: [PATCH] Command dispatching   - code to parse and dispatch commands
 added   - ResponseWriter utility class added   - Password command
 implementation added

Several bugfixes
  - wakelock added
  - preferences properly loaded (first start)
  - rebinding removed
---
 .idea/inspectionProfiles/Project_Default.xml  |   1 +
 app/src/main/AndroidManifest.xml              |   1 +
 .../luv/mockgeofix/CommandDispatcher.java     |  60 ++++++++++
 .../github/luv/mockgeofix/MainActivity.java   |   2 +-
 .../github/luv/mockgeofix/MockGeoFixApp.java  |   3 +
 .../luv/mockgeofix/MockLocationService.java   | 104 +++++++++---------
 .../luv/mockgeofix/SettingsActivity.java      |  41 +++++++
 .../luv/mockgeofix/command/Command.java       |   7 ++
 .../mockgeofix/command/PasswordCommand.java   |  58 ++++++++++
 .../luv/mockgeofix/util/ResponseWriter.java   |  46 ++++++++
 app/src/main/res/values/strings.xml           |   3 +
 11 files changed, 272 insertions(+), 54 deletions(-)
 create mode 100644 app/src/main/java/github/luv/mockgeofix/CommandDispatcher.java
 create mode 100644 app/src/main/java/github/luv/mockgeofix/command/Command.java
 create mode 100644 app/src/main/java/github/luv/mockgeofix/command/PasswordCommand.java
 create mode 100644 app/src/main/java/github/luv/mockgeofix/util/ResponseWriter.java

diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
index 76213cf..af74255 100644
--- a/.idea/inspectionProfiles/Project_Default.xml
+++ b/.idea/inspectionProfiles/Project_Default.xml
@@ -19,6 +19,7 @@
       <option name="processLiterals" value="true" />
       <option name="processComments" value="true" />
     </inspection_tool>
+    <inspection_tool class="TrivialIf" enabled="false" level="WARNING" enabled_by_default="false" />
     <inspection_tool class="TryWithIdenticalCatches" enabled="false" level="WARNING" enabled_by_default="false" />
   </profile>
 </component>
\ No newline at end of file
diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml
index 8eb9562..71bb756 100644
--- a/app/src/main/AndroidManifest.xml
+++ b/app/src/main/AndroidManifest.xml
@@ -4,6 +4,7 @@
 
     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.ACCESS_NETWORK_SATE" />
+    <uses-permission android:name="android.permission.WAKE_LOCK" />
 
     <application
         android:name=".MockGeoFixApp"
diff --git a/app/src/main/java/github/luv/mockgeofix/CommandDispatcher.java b/app/src/main/java/github/luv/mockgeofix/CommandDispatcher.java
new file mode 100644
index 0000000..6d5a0cc
--- /dev/null
+++ b/app/src/main/java/github/luv/mockgeofix/CommandDispatcher.java
@@ -0,0 +1,60 @@
+package github.luv.mockgeofix;
+
+import android.content.Context;
+import android.util.Log;
+
+import java.nio.channels.SocketChannel;
+
+import github.luv.mockgeofix.command.PasswordCommand;
+import github.luv.mockgeofix.util.ResponseWriter;
+
+public class CommandDispatcher {
+    String TAG = "CommandDispatcher";
+
+    static private CommandDispatcher instance = new CommandDispatcher();
+    static public CommandDispatcher getInstance() { return instance; }
+    private CommandDispatcher() {}
+
+    protected Context mContext;
+    protected PasswordCommand passwordCommand;
+
+    static public void init(Context context) {
+        getInstance()._init(context);
+    }
+
+    static public void dispatch(SocketChannel client, String command) {
+        getInstance()._verifyInitiated();
+        getInstance()._dispatch(client, command);
+    }
+
+    protected void _init(Context context) {
+        if (mContext != null) {
+            throw new AssertionError("CommandDispatcher.init called twice!");
+        }
+        mContext = context;
+        passwordCommand = new PasswordCommand(context);
+    }
+
+    protected void _dispatch(SocketChannel client, String command) {
+        String cmd = command.split(" ", 2)[0].toLowerCase();
+        if (cmd.equals("password")) {
+            passwordCommand.execute(client, command);
+        } else if (cmd.equals("geo")) {
+            if ( passwordCommand.passwordRequired() && (! passwordCommand.loggedIn(client)) ) {
+                ResponseWriter.notLoggedIn(client);
+            } else {
+                Log.i(TAG, "GEO FIX::" + command);
+            }
+        } else if (cmd.equals("help")) {
+            Log.i(TAG, "GEO HELP::" + command);
+        } else {
+            ResponseWriter.unknownCommand(client);
+        }
+    }
+
+    private void _verifyInitiated() {
+        if (mContext == null) {
+            throw new AssertionError("CommandDispatcher.init has not been called!");
+        }
+    }
+}
diff --git a/app/src/main/java/github/luv/mockgeofix/MainActivity.java b/app/src/main/java/github/luv/mockgeofix/MainActivity.java
index 9f107c9..0681ae2 100644
--- a/app/src/main/java/github/luv/mockgeofix/MainActivity.java
+++ b/app/src/main/java/github/luv/mockgeofix/MainActivity.java
@@ -105,11 +105,11 @@ protected void onCreate(Bundle savedInstanceState) {
 
     @Override
     protected void onDestroy() {
-        super.onDestroy();
         if (mService != null && mConn != null) {
             unbindService(mConn);
         }
         unregisterReceiver(receiver);
+        super.onDestroy();
     }
 
     protected synchronized  void updateListensOn() {
diff --git a/app/src/main/java/github/luv/mockgeofix/MockGeoFixApp.java b/app/src/main/java/github/luv/mockgeofix/MockGeoFixApp.java
index 987a68b..8f04fe6 100644
--- a/app/src/main/java/github/luv/mockgeofix/MockGeoFixApp.java
+++ b/app/src/main/java/github/luv/mockgeofix/MockGeoFixApp.java
@@ -2,10 +2,13 @@
 
 import android.app.Application;
 import android.content.Intent;
+import android.preference.PreferenceManager;
 
 public class MockGeoFixApp extends Application {
     @Override
     public void onCreate() {
+        PreferenceManager.setDefaultValues(this, R.xml.pref, false);
+        CommandDispatcher.init(getApplicationContext());
         Intent i = new Intent(getApplicationContext(), MockLocationService.class);
         startService(i);
     }
diff --git a/app/src/main/java/github/luv/mockgeofix/MockLocationService.java b/app/src/main/java/github/luv/mockgeofix/MockLocationService.java
index a5068f7..d6fcaf5 100644
--- a/app/src/main/java/github/luv/mockgeofix/MockLocationService.java
+++ b/app/src/main/java/github/luv/mockgeofix/MockLocationService.java
@@ -5,6 +5,7 @@
 import android.content.Intent;
 import android.content.SharedPreferences;
 import android.os.IBinder;
+import android.os.PowerManager;
 import android.preference.PreferenceManager;
 import android.util.Log;
 
@@ -28,7 +29,7 @@
 import java.util.HashMap;
 import java.util.Vector;
 
-public class MockLocationService extends Service implements SharedPreferences.OnSharedPreferenceChangeListener {
+public class MockLocationService extends Service {
     String TAG = "MockLocationService";
 
     protected MockLocationThread mThread = null;
@@ -52,8 +53,6 @@ public void onCreate() {
         super.onCreate();
         pref = PreferenceManager.getDefaultSharedPreferences(
                 getApplicationContext());
-
-        pref.registerOnSharedPreferenceChangeListener(this);
     }
 
     @Override
@@ -66,16 +65,6 @@ public IBinder onBind(Intent intent) {
         return mBinder;
     }
 
-    @Override
-    public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
-        if (key.equals("listen_port") || key.equals("listen_ip")) {
-            if (mThread != null) {
-                mThread.rebind();
-                mThread.interrupt();
-            }
-        }
-    }
-
     /* interface to be used by clients */
     public boolean isRunning() {
         return !(mThread == null);
@@ -97,7 +86,7 @@ public void stop() {
     }
     /* end of interface */
 
-    /* methods used my MockLocationThread
+    /* methods used by MockLocationThread
        to communicate its' state */
     protected void threadHasStopped() {
         mThread = null;
@@ -116,7 +105,7 @@ protected Vector<SocketAddress> getBindAddresses() {
         Vector<SocketAddress> ret = new Vector<>();
 
         /* retrieve port settings from preferences */
-        String portStr = pref.getString("listen_port", "");
+        String portStr = pref.getString("listen_port", "5554");
         int port;
         try {
             port = Integer.parseInt(portStr);
@@ -171,16 +160,17 @@ class MockLocationThread extends Thread {
     public MockLocationThread(Context context, MockLocationService service) {
         mContext = context;
         mService = service;
+        PowerManager mgr = (PowerManager)context
+                .getSystemService(Context.POWER_SERVICE);
+        mWakeLock = mgr.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK,
+                "MockGeoFixWakeLock");
     }
     private boolean mStop = false;
-    private boolean mRebind = false;
 
     private HashMap<Socket, Boolean> mClientDiscard = new HashMap<>();
     private HashMap<Socket, ByteBuffer> mClientBuffers = new HashMap<>();
 
-    public void rebind() {
-        mRebind = true;
-    }
+    protected PowerManager.WakeLock mWakeLock = null;
 
     public void kill() {
         mStop = true;
@@ -190,44 +180,41 @@ public void kill() {
     @Override
     public void run() {
         super.run();
+        Selector selector = null;
         try {
+            selector = Selector.open();
+            mBindAddresses = mService.getBindAddresses();
+            for (SocketAddress address : mBindAddresses) {
+                ServerSocketChannel ssc = ServerSocketChannel.open();
+                ssc.configureBlocking(false);
+                ssc.socket().setReuseAddress(true);
+                ssc.socket().bind(address);
+                ssc.register(selector, SelectionKey.OP_ACCEPT);
+            }
+            try {
+                mWakeLock.acquire();
+            } catch (SecurityException ex) {
+                Log.e(TAG, "WakeLock not acquired - permission denied for WakeLock.");
+            }
+            mService.threadHasStartedSuccessfully();
+
             while (!mStop) {
-                Selector selector = Selector.open();
-                mBindAddresses = mService.getBindAddresses();
-                for (SocketAddress address : mBindAddresses) {
-                    ServerSocketChannel ssc = ServerSocketChannel.open();
-                    ssc.configureBlocking(false);
-                    ssc.socket().setReuseAddress(true);
-                    ssc.socket().bind(address);
-                    ssc.register(selector, SelectionKey.OP_ACCEPT);
-                }
-                mService.threadHasStartedSuccessfully();
-                try {
-                    while (!mStop && !mRebind) {
-                        //Log.d(TAG, "running");
-                        selector.select();
-                        for (SelectionKey key : selector.selectedKeys()) {
-                            if (key.isAcceptable() && key.channel() instanceof ServerSocketChannel) {
-                                // accept connection
-                                SocketChannel client = ((ServerSocketChannel)key.channel()).accept();
-                                if (client != null) {
-                                    client.configureBlocking(false);
-                                    client.socket().setTcpNoDelay(true);
-                                    client.register(selector, SelectionKey.OP_READ);
-                                }
-                            }
-                            if (key.isReadable() && key.channel() instanceof SocketChannel) {
-                                onIncomingData((SocketChannel) key.channel());
-                            }
+                selector.select();
+                for (SelectionKey key : selector.selectedKeys()) {
+                    if (key.isAcceptable() && key.channel() instanceof ServerSocketChannel) {
+                        // accept connection
+                        SocketChannel client = ((ServerSocketChannel) key.channel()).accept();
+                        if (client != null) {
+                            client.configureBlocking(false);
+                            client.socket().setTcpNoDelay(true);
+                            client.register(selector, SelectionKey.OP_READ);
                         }
-                        selector.selectedKeys().clear();
                     }
-                } finally {
-                    for (SelectionKey key : selector.keys()) {
-                        try { key.channel().close(); } catch (IOException ignored) {}
+                    if (key.isReadable() && key.channel() instanceof SocketChannel) {
+                        onIncomingData((SocketChannel) key.channel());
                     }
-                    selector.close();
                 }
+                selector.selectedKeys().clear();
             }
         } catch (SocketException e) {
             Log.e(TAG, e.toString() );
@@ -240,6 +227,15 @@ public void run() {
         } catch (IOException e) {
             Log.e(TAG, e.toString() );
         } finally {
+            if (mWakeLock.isHeld()) {
+                mWakeLock.release();
+            }
+            if (selector != null) {
+                for (SelectionKey key : selector.keys()) {
+                    try { key.channel().close(); } catch (IOException ignored) {}
+                }
+                try { selector.close(); } catch (IOException ignored) {}
+            }
             mService.threadHasStopped();
         }
     }
@@ -292,7 +288,8 @@ void processBuffer(SocketChannel client, ByteBuffer buffer) {
         while (line != null) {
             // process line
             try {
-                Log.i(TAG, "::"+new String(line, "UTF-8"));
+                String command = new String(line, "UTF-8").replace("\r\n","").replace("\n","");
+                CommandDispatcher.dispatch(client, command);
             } catch (UnsupportedEncodingException ignored) {}
             line = getLine(buffer);
         }
@@ -302,7 +299,8 @@ void processBuffer(SocketChannel client, ByteBuffer buffer) {
             line = new byte[buffer.limit()];
             buffer.get(line);
             try {
-                Log.i(TAG, "::"+new String(line, "UTF-8"));
+                String command = new String(line, "UTF-8").replace("\r\n","").replace("\n","");
+                CommandDispatcher.dispatch(client, command);
             } catch (UnsupportedEncodingException ignored) {}
             buffer.clear();
             mClientDiscard.put(client.socket(), Boolean.TRUE);
diff --git a/app/src/main/java/github/luv/mockgeofix/SettingsActivity.java b/app/src/main/java/github/luv/mockgeofix/SettingsActivity.java
index 30cbd8d..53a6720 100644
--- a/app/src/main/java/github/luv/mockgeofix/SettingsActivity.java
+++ b/app/src/main/java/github/luv/mockgeofix/SettingsActivity.java
@@ -1,6 +1,11 @@
 package github.luv.mockgeofix;
 
+import android.content.ComponentName;
+import android.content.Context;
+import android.content.Intent;
+import android.content.ServiceConnection;
 import android.os.Bundle;
+import android.os.IBinder;
 import android.preference.CheckBoxPreference;
 import android.preference.EditTextPreference;
 import android.preference.ListPreference;
@@ -23,14 +28,41 @@ public class SettingsActivity extends PreferenceActivity
         implements Preference.OnPreferenceChangeListener {
     static final String TAG = "SettingsActivity";
 
+    private MockLocationService mService = null;
+    private boolean mShowNeedsReset = false;
+    private ServiceConnection mConn = new ServiceConnection() {
+        @Override
+        public void onServiceConnected(ComponentName name, IBinder binder) {
+            mService = ((MockLocationService.Binder)binder).getService();
+        }
+        @Override
+        public void onServiceDisconnected(ComponentName name) {
+            mService = null;
+        }
+    };
+
+    @Override
+    protected void onDestroy() {
+        if (mService != null && mConn != null) {
+            unbindService(mConn);
+        }
+        super.onDestroy();
+    }
+
     @Override
     protected void onPostCreate(Bundle savedInstanceState) {
         super.onPostCreate(savedInstanceState);
+        bindService(new Intent(getApplicationContext(),MockLocationService.class),
+                mConn,
+                Context.BIND_AUTO_CREATE
+        );
         setupSimplePreferencesScreen();
+        mShowNeedsReset = false;
         bindPreference(findPreference("listen_port"));
         bindPreference(findPreference("listen_ip"));
         bindPreference(findPreference("password"));
         bindPreference(findPreference("require_password"));
+        mShowNeedsReset = true;
     }
 
 
@@ -145,6 +177,15 @@ public boolean onPreferenceChange(Preference pref, Object value) {
                 pref.setSummary(stringValue);
             }
         }
+
+        /* Warn the user that the change won't take effect until the service is restarted */
+        if (pref.getKey().equals("listen_port") || pref.getKey().equals("listen_ip")) {
+            if (mShowNeedsReset && (mService != null && mService.isRunning()) ) {
+                Toast.makeText(getApplicationContext(), getString(R.string.note_needsreset),
+                        Toast.LENGTH_LONG).show();
+            }
+        }
+
         return true;
     }
 }
diff --git a/app/src/main/java/github/luv/mockgeofix/command/Command.java b/app/src/main/java/github/luv/mockgeofix/command/Command.java
new file mode 100644
index 0000000..e8aee61
--- /dev/null
+++ b/app/src/main/java/github/luv/mockgeofix/command/Command.java
@@ -0,0 +1,7 @@
+package github.luv.mockgeofix.command;
+
+import java.nio.channels.SocketChannel;
+
+public interface Command {
+    public void execute(SocketChannel client, String command);
+}
diff --git a/app/src/main/java/github/luv/mockgeofix/command/PasswordCommand.java b/app/src/main/java/github/luv/mockgeofix/command/PasswordCommand.java
new file mode 100644
index 0000000..fe015fc
--- /dev/null
+++ b/app/src/main/java/github/luv/mockgeofix/command/PasswordCommand.java
@@ -0,0 +1,58 @@
+package github.luv.mockgeofix.command;
+
+import android.content.Context;
+import android.content.SharedPreferences;
+import android.preference.PreferenceManager;
+import android.util.Log;
+
+import java.nio.channels.SocketChannel;
+import java.util.WeakHashMap;
+
+import github.luv.mockgeofix.util.ResponseWriter;
+
+public class PasswordCommand implements Command {
+    static String TAG = "PasswordCommand";
+
+    protected SharedPreferences pref = null;
+    protected WeakHashMap<SocketChannel, Boolean> mIsLoggedIn = new WeakHashMap<>();
+
+    public PasswordCommand(Context context) {
+        pref = PreferenceManager.getDefaultSharedPreferences(context);
+    }
+
+    @Override
+    public void execute(SocketChannel client, String command) {
+        if (pref == null) {
+            Log.e(TAG, "internal error: pref is null");
+            ResponseWriter.writeLine(client, "KO: Internal Error in 'PasswordCommand'.");
+            return;
+        }
+        String password = command.split(" ", 2)[1];
+        String storedPassword = pref.getString("password","");
+        if (password.equals(storedPassword)) {
+            mIsLoggedIn.put(client, Boolean.TRUE);
+        } else {
+            mIsLoggedIn.put(client, Boolean.FALSE);
+        }
+    }
+
+    public boolean loggedIn(SocketChannel client) {
+        if ( mIsLoggedIn.get(client) == Boolean.TRUE ) {
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    public boolean passwordRequired() {
+        if (pref == null) {
+            Log.e(TAG, "internal error: pref is null");
+            // later on we blow up and send "KO: Internal Error in 'PasswordCommand'."
+            // to client.
+            // Unless pref is set in the meantime, than things get weird and
+            // hard to debug :). But as pref is set only in the constructor, we should be fine.
+            return true;
+        }
+        return pref.getBoolean("require_password",false);
+    }
+}
diff --git a/app/src/main/java/github/luv/mockgeofix/util/ResponseWriter.java b/app/src/main/java/github/luv/mockgeofix/util/ResponseWriter.java
new file mode 100644
index 0000000..35c6053
--- /dev/null
+++ b/app/src/main/java/github/luv/mockgeofix/util/ResponseWriter.java
@@ -0,0 +1,46 @@
+package github.luv.mockgeofix.util;
+
+import android.util.Log;
+
+import java.io.IOException;
+import java.nio.ByteBuffer;
+import java.nio.CharBuffer;
+import java.nio.channels.SocketChannel;
+import java.nio.charset.CharacterCodingException;
+import java.nio.charset.Charset;
+import java.nio.charset.CharsetEncoder;
+
+public class ResponseWriter {
+    static String TAG = "ResponseWriter";
+
+    static Charset charset = Charset.forName("UTF-8");
+    static CharsetEncoder encoder = charset.newEncoder();
+
+    public static boolean write(SocketChannel client, String response) {
+        try {
+            ByteBuffer r = encoder.encode(CharBuffer.wrap(response));
+            while (r.hasRemaining()) {
+                client.write(r);
+            }
+            return true;
+        } catch (CharacterCodingException ex) {
+            Log.e(TAG, "CharacterCodingException suppressed");
+            return false;
+        } catch (IOException ex) {
+            try { client.close(); } catch (IOException ignored) {}
+            return false;
+        }
+    }
+
+    public static boolean writeLine(SocketChannel client, String response) {
+        return write(client, response+"\r\n");
+    }
+
+    public static boolean unknownCommand(SocketChannel client) {
+        return write(client, "KO: unknown command, try 'help'\r\n");
+    }
+
+    public static boolean notLoggedIn(SocketChannel client) {
+        return write(client, "KO: password required. You must log in first. Use 'password'\r\n");
+    }
+}
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
index 42f609a..c691019 100644
--- a/app/src/main/res/values/strings.xml
+++ b/app/src/main/res/values/strings.xml
@@ -43,5 +43,8 @@
     <string name="err_address_already_in_use">Binding error. Address/port already in use.</string>
     <string name="err_socket_permission_denied">Binding error. Permission denied. (You should use port number >=1024.)</string>
 
+    <!-- notes -->
+    <string name="note_needsreset">Note: This change won\'t take effect until you restart the service.</string>
+
 
 </resources>