Fix missing permissions for newer android version

albertogeniola · albertogeniola · commit 3c4c12441c92 · 2024-12-05T23:02:48.000+01:00
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/app/build.gradle b/app/build.gradle
@@ -10,7 +10,7 @@ android {
         minSdkVersion 16
         targetSdkVersion 35
         versionCode 20
-        versionName "0.0.10"
+        versionName "0.0.11"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
 
@@ -85,4 +85,8 @@ dependencies {
 
     // required to avoid crash on Android 12 API 31
     implementation 'androidx.work:work-runtime-ktx:2.7.1'
+
+    // Token bucket
+    implementation ('org.isomorphism:token-bucket:1.7')
+    implementation 'com.google.guava:guava:33.3.1-android'
 }
diff --git a/app/src/main/java/com/albertogeniola/merossconf/ui/fragments/pair/AbstractWifiFragment.java b/app/src/main/java/com/albertogeniola/merossconf/ui/fragments/pair/AbstractWifiFragment.java
@@ -44,12 +44,7 @@ public abstract class AbstractWifiFragment extends Fragment {
     private final Timer mTimer;
     private WifiManager mWifiManager;
     private ConnectivityManager mConnectivityManager;
-    private static final String[] WIFI_PERMS = new String[] {
-            Manifest.permission.NEARBY_WIFI_DEVICES,
-            Manifest.permission.ACCESS_FINE_LOCATION,
-            Manifest.permission.CHANGE_WIFI_STATE,
-            Manifest.permission.CHANGE_NETWORK_STATE};
-
+    private static String[] WIFI_PERMS = null;
     private static final int REQUEST_PERMISSION_CODE = 1;
 
     // holds the state of the wifi connection attempt
@@ -85,10 +80,24 @@ public AbstractWifiFragment() {
     public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
 
+        if (android.os.Build.VERSION.SDK_INT <= 32) {
+            WIFI_PERMS = new String[]{
+                    Manifest.permission.ACCESS_COARSE_LOCATION,
+                    Manifest.permission.ACCESS_FINE_LOCATION,
+                    Manifest.permission.CHANGE_WIFI_STATE,
+                    Manifest.permission.CHANGE_NETWORK_STATE};
+        } else {
+            WIFI_PERMS = new String[]{
+                    Manifest.permission.NEARBY_WIFI_DEVICES,
+                    Manifest.permission.ACCESS_FINE_LOCATION,
+                    Manifest.permission.CHANGE_WIFI_STATE,
+                    Manifest.permission.CHANGE_NETWORK_STATE};
+        }
+
         multiplePermissionsContract = new ActivityResultContracts.RequestMultiplePermissions();
         multiplePermissionLauncher = registerForActivityResult(multiplePermissionsContract, isGranted -> {
             if (isGranted.containsValue(false)) {
-                multiplePermissionLauncher.launch(WIFI_PERMS);
+                askPermissions(multiplePermissionLauncher);
                 onMissingWifiPermissions(mTargetSsid);
             } else {
                 onWifiPermissionsGranted(mTargetSsid, mTargetBssid);
@@ -116,7 +125,7 @@ public void onDestroyView() {
         super.onDestroyView();
 
         // Unschedule the timeout task, if any
-        if (mTimeoutTask!=null) {
+        if (mTimeoutTask != null) {
             mTimeoutTask.cancel();
             mTimeoutTask = null;
         }
@@ -185,7 +194,6 @@ private boolean hasPermissions(String[] permissions) {
 
     private void askPermissions(ActivityResultLauncher<String[]> multiplePermissionLauncher) {
         if (!hasPermissions(WIFI_PERMS)) {
-            Log.d("PERMISSIONS", "Launching multiple contract permission launcher for ALL required permissions");
             multiplePermissionLauncher.launch(WIFI_PERMS);
         } else {
             Log.d("PERMISSIONS", "All permissions are already granted");
@@ -199,11 +207,12 @@ public void onResume() {
 
     /**
      * Starts the wifi connection to the specified ssid
-     * @param targetSsid Target Wifi SSID to connect to
-     * @param targetBssid (Optional) Target BSSID
+     *
+     * @param targetSsid       Target Wifi SSID to connect to
+     * @param targetBssid      (Optional) Target BSSID
      * @param targetPassphrase (Optional) Wifi passphrase to use
-     * @param reason A reason to show to the user that explains why Wifi is being requested.
-     * @param timeout Number of milliseconds to wait before issuing a timeout to the wifi operation
+     * @param reason           A reason to show to the user that explains why Wifi is being requested.
+     * @param timeout          Number of milliseconds to wait before issuing a timeout to the wifi operation
      * @throws PermissionNotGrantedException In case no enough permissions have been granted
      *                                       to the app by the user. In such case, permissions
      *                                       is automatically requested by this method.
@@ -223,7 +232,7 @@ public void startWifiConnection(String targetSsid,
         if (!AndroidUtils.checkPermissions(requireContext(), WIFI_PERMS)) {
 
             // If a reason was specified, show it here.
-            if (reason!=null) {
+            if (reason != null) {
                 AlertDialog.Builder builder = new AlertDialog.Builder(getActivity());
                 builder.setMessage(reason).setTitle("Wifi Access Request");
                 AlertDialog dialog = builder.create();
@@ -232,7 +241,6 @@ public void startWifiConnection(String targetSsid,
 
             // If the user did not yet grant Wifi and Location permissions, ask them here and abort the connection.
             askPermissions(multiplePermissionLauncher);
-            //requestPermissions(WIFI_PERMS, REQUEST_PERMISSION_CODE);
 
             // Return false, so the caller know it has to retry the operation after the
             // user's consent to use wifi
@@ -259,26 +267,28 @@ public void startWifiConnection(String targetSsid,
      * Starts the connection attempt against the legacy API.
      * To do so, it registers a broadcast receiver for the network connection events and
      * waits for the connection to attempt to the specified network.
+     *
      * @param ssid
      * @param passphrase
-     * @param timeout Timeout in milliseconds
+     * @param timeout    Timeout in milliseconds
      */
-    @SuppressLint("MissingPermission") //This piece of code is called only after permissions have bee granted
+    @SuppressLint("MissingPermission")
+    //This piece of code is called only after permissions have bee granted
     private void startWifiConnectionLegacy(String ssid, @Nullable String passphrase, int timeout) {
 
         WifiConfiguration targetWifiConf = null;
 
         // Locate the existing network configuration entry.
         for (android.net.wifi.WifiConfiguration conf : mWifiManager.getConfiguredNetworks()) {
 
-            if (conf.SSID.compareTo("\""+ssid+"\"") == 0) {
+            if (conf.SSID.compareTo("\"" + ssid + "\"") == 0) {
                 // Found a matching configuration: make sure the network passphrase is OK
-                if (conf.preSharedKey != null && conf.preSharedKey.length()>0 && Strings.isEmpty(passphrase) || Strings.isEmpty(conf.preSharedKey) && !Strings.isEmpty(passphrase)) {
-                    Log.i(TAG, "Network configuration ("+conf.networkId+") ignored: passphrase mismatch.");
+                if (conf.preSharedKey != null && conf.preSharedKey.length() > 0 && Strings.isEmpty(passphrase) || Strings.isEmpty(conf.preSharedKey) && !Strings.isEmpty(passphrase)) {
+                    Log.i(TAG, "Network configuration (" + conf.networkId + ") ignored: passphrase mismatch.");
                     continue;
                 }
                 // If we reach this part, it means we found a valid, consistent wifi configuration to be used.
-                Log.i(TAG, "Network configuration ("+conf.networkId+") found for ssid "+ssid+".");
+                Log.i(TAG, "Network configuration (" + conf.networkId + ") found for ssid " + ssid + ".");
                 targetWifiConf = conf;
                 break;
             }
@@ -288,10 +298,10 @@ private void startWifiConnectionLegacy(String ssid, @Nullable String passphrase,
         if (targetWifiConf == null || targetWifiConf.networkId == -1) {
             Log.i(TAG, "Adding new Wifi configuration for the desired network.");
             targetWifiConf = new android.net.wifi.WifiConfiguration();
-            targetWifiConf.SSID = "\""+ssid+"\"";
+            targetWifiConf.SSID = "\"" + ssid + "\"";
 
             if (!Strings.isEmpty(passphrase)) {
-                targetWifiConf.preSharedKey = "\""+passphrase+"\"";
+                targetWifiConf.preSharedKey = "\"" + passphrase + "\"";
                 targetWifiConf.allowedKeyManagement.set(WifiConfiguration.KeyMgmt.WPA_PSK);
             } else {
                 targetWifiConf.allowedKeyManagement.set(WifiConfiguration.KeyMgmt.NONE);
@@ -302,7 +312,7 @@ private void startWifiConnectionLegacy(String ssid, @Nullable String passphrase,
         }
 
         // Disconnect from current network
-        Log.i(TAG, "Forcing disconnection/reconnection to the selected wifi "+targetWifiConf);
+        Log.i(TAG, "Forcing disconnection/reconnection to the selected wifi " + targetWifiConf);
         mWifiManager.disconnect();
 
         // Start the timeout countdown
@@ -322,7 +332,7 @@ private void startWifiConnectionAndroidQ(String ssid, @Nullable String bssid, @N
                 .setSsid(ssid);
 
         if (bssid != null) {
-            specifierBuilder.setBssid( MacAddress.fromString(bssid));
+            specifierBuilder.setBssid(MacAddress.fromString(bssid));
         }
 
         if (passphrase != null)
@@ -343,6 +353,7 @@ private void startWifiConnectionAndroidQ(String ssid, @Nullable String bssid, @N
      * Registers a broadcast received that listens to WIFI_STATE changes. It also sets the value
      * of the SSID to configure the broadcast receiver to intercept the desired network
      * connection.
+     *
      * @param ssid SSID value that represent the network we are looking for
      */
     private void registerWifiBroadcastReceiver(String ssid) {
@@ -392,7 +403,7 @@ private void unRegisterWifiBroadcastReceiver() {
 
     private void notifyWifiConnected() {
         mWifiConnectionAttemptInProgress = false;
-        if (mTimeoutTask!=null) {
+        if (mTimeoutTask != null) {
             mTimeoutTask.cancel();
             mTimeoutTask = null;
         }
@@ -401,7 +412,7 @@ private void notifyWifiConnected() {
 
     private void notifyWifiUnavailable() {
         mWifiConnectionAttemptInProgress = false;
-        if (mTimeoutTask!=null) {
+        if (mTimeoutTask != null) {
             mTimeoutTask.cancel();
             mTimeoutTask = null;
         }
@@ -452,7 +463,7 @@ public void run() {
         @Override
         public void onReceive(Context context, Intent intent) {
             String action = intent.getAction();
-            if (WifiManager.NETWORK_STATE_CHANGED_ACTION .equals(action)) {
+            if (WifiManager.NETWORK_STATE_CHANGED_ACTION.equals(action)) {
                 NetworkInfo networkInfo = intent.getParcelableExtra(WifiManager.EXTRA_NETWORK_INFO);
                 if (networkInfo == null) {
                     Log.w(TAG, "Network info is null!");
@@ -463,7 +474,7 @@ public void onReceive(Context context, Intent intent) {
                 String connectedSsid = null;
                 String connectedBssid = null;
 
-                if (connectionInfo!=null) {
+                if (connectionInfo != null) {
                     connectedSsid = connectionInfo.getSSID();
                     connectedBssid = connectionInfo.getBSSID();
                 }
@@ -475,9 +486,9 @@ public void onReceive(Context context, Intent intent) {
                     Log.i(TAG, "WifiState updated. Connected:  " + networkInfo.isConnected() + ", SSID: " + connectedSsid);
 
                 if (networkInfo.getType() == ConnectivityManager.TYPE_WIFI && networkInfo.isConnected()) {
-                    Log.i(TAG, "WifiState updated. Current SSID: "+connectedSsid);
+                    Log.i(TAG, "WifiState updated. Current SSID: " + connectedSsid);
 
-                    String quotedSsid = "\""+mTargetSsid+"\"";
+                    String quotedSsid = "\"" + mTargetSsid + "\"";
                     if (quotedSsid.compareTo(connectedSsid) == 0) {
                         // Ok, we found the network we were looking for.
                         notifyWifiConnected();
diff --git a/app/src/main/java/com/albertogeniola/merossconf/ui/fragments/pair/ScanDevicesFragment.java b/app/src/main/java/com/albertogeniola/merossconf/ui/fragments/pair/ScanDevicesFragment.java
@@ -6,13 +6,13 @@
 import static android.Manifest.permission.CHANGE_WIFI_STATE;
 import static android.Manifest.permission.NEARBY_WIFI_DEVICES;
 
+import android.annotation.SuppressLint;
 import android.content.BroadcastReceiver;
 import android.content.Context;
 import android.content.DialogInterface;
 import android.content.Intent;
 import android.content.IntentFilter;
 import android.content.pm.PackageManager;
-import android.location.LocationManager;
 import android.net.wifi.ScanResult;
 import android.net.wifi.WifiManager;
 import android.os.Bundle;
@@ -51,33 +51,39 @@
 import com.google.android.material.floatingactionbutton.FloatingActionButton;
 import com.google.android.material.snackbar.Snackbar;
 
+import org.isomorphism.util.TokenBucket;
+import org.isomorphism.util.TokenBuckets;
+
 import java.util.ArrayList;
 import java.util.List;
+import java.util.concurrent.TimeUnit;
 
 public class ScanDevicesFragment extends Fragment {
-    private static final int REQUEST_PERMISSION_CODE = 1;
-    private static final String TAG = "ScanDevicesFragment";
-
     private PairActivityViewModel pairActivityViewModel;
 
     private WifiManager wifiManager = null;
-    private LocationManager locationManager = null;
     private ProgressBar scanningProgressBar;
     private FloatingActionButton fab;
     private MerossWifiScanAdapter adapter = new MerossWifiScanAdapter();
     private SwipeRefreshLayout swipeContainer;
     private Handler uiHandler;
     private boolean scanning;
     private ActivityResultLauncher<String[]> multiplePermissionLauncher;
-
     private static String[] REQUIRED_PERMISSIONS = null;
-
+    private static final String STATE_N_TOKENS = "_state_num_tokens";
+    private static final long DEFAULT_N_SCANS_PER_INTERVAL = 4;
+    private static final long DEFAULT_INTERVAL_MINUTES = 2;
+    private final TokenBucket scanBucket = TokenBuckets.builder().withCapacity(DEFAULT_N_SCANS_PER_INTERVAL).withFixedIntervalRefillStrategy(DEFAULT_N_SCANS_PER_INTERVAL, DEFAULT_INTERVAL_MINUTES, TimeUnit.MINUTES).build();
 
     @Override
     public void onCreate(@Nullable Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
-
+        long tokens = DEFAULT_N_SCANS_PER_INTERVAL; // by default we are only allowed
+        if (savedInstanceState != null)
+            tokens = savedInstanceState.getLong(STATE_N_TOKENS);
+        scanBucket.refill(tokens);
         if (android.os.Build.VERSION.SDK_INT > 32){
+            // For releases > 32, we just need
             REQUIRED_PERMISSIONS = new String[] {
                     NEARBY_WIFI_DEVICES,
                     ACCESS_FINE_LOCATION,
@@ -86,7 +92,8 @@ public void onCreate(@Nullable Bundle savedInstanceState) {
                     CHANGE_NETWORK_STATE
             };
         } else{
-            // do something for phones running an SDK before lollipop
+            // For releases <= 32, we need to ask also for location permissions in order to scan
+            // wifis
             REQUIRED_PERMISSIONS = new String[] {
                     ACCESS_FINE_LOCATION,
                     ACCESS_COARSE_LOCATION,
@@ -95,7 +102,6 @@ public void onCreate(@Nullable Bundle savedInstanceState) {
         }
 
         this.wifiManager = (WifiManager) getContext().getApplicationContext().getSystemService(Context.WIFI_SERVICE);
-        this.locationManager = (LocationManager)getContext().getSystemService(Context.LOCATION_SERVICE);
         this.uiHandler = new Handler(Looper.getMainLooper());
         scanning = false;
         pairActivityViewModel = new ViewModelProvider(requireActivity()).get(PairActivityViewModel.class);
@@ -141,6 +147,12 @@ public void onDestroy() {
         super.onDestroy();
     }
 
+    @Override
+    public void onSaveInstanceState(final Bundle outState) {
+        super.onSaveInstanceState(outState);
+        outState.putLong(STATE_N_TOKENS, scanBucket.getNumTokens());
+    }
+
     @Override
     public View onCreateView(
             LayoutInflater inflater, ViewGroup container,
@@ -244,6 +256,12 @@ public void onStart() {
     }
 
     private void startScan() {
+        if (!scanBucket.tryConsume(1)) {
+            long seconds = scanBucket.getDurationUntilNextRefill(TimeUnit.SECONDS);
+            Toast.makeText(ScanDevicesFragment.this.getContext(), "Scan rate limited. Wait " + seconds + " seconds before scanning again.", Toast.LENGTH_SHORT).show();
+            return ;
+        }
+
         if (scanning) {
             Toast.makeText(ScanDevicesFragment.this.getContext(), "Scan already in progress.", Toast.LENGTH_SHORT).show();
             return;
@@ -261,7 +279,6 @@ private void startScan() {
                 @Override
                 public void onClick(DialogInterface dialog, int which) {
                     askPermissions(multiplePermissionLauncher);
-                    //requestPermissions(REQUIRED_PERMISSIONS, REQUEST_PERMISSION_CODE);
                 }
             });
             permissionAlert.setNegativeButton("Cancel", new DialogInterface.OnClickListener() {
@@ -307,10 +324,12 @@ private void updateScanData(List<ScanResult> wifiNetworks) {
         this.scanning = false;
     }
 
+    @SuppressLint("MissingPermission") // Scan is only triggered upon permissions checks
     private void scanSuccess() {
         updateScanData(wifiManager.getScanResults());
     }
 
+    @SuppressLint("MissingPermission") // Scan is only triggered upon permissions checks
     private void scanFailure() {
         // handle failure: new scan did NOT succeed
         // consider using old scan results: these are the OLD results!
diff --git a/app/src/main/res/layout/activity_pair.xml b/app/src/main/res/layout/activity_pair.xml
@@ -7,6 +7,7 @@
     tools:context=".PairActivity">
 
     <com.google.android.material.appbar.AppBarLayout
+        android:fitsSystemWindows="true"
         android:layout_width="match_parent"
         android:layout_height="wrap_content">
 
diff --git a/app/src/main/res/layout/fragment_scan.xml b/app/src/main/res/layout/fragment_scan.xml
@@ -32,6 +32,7 @@
         android:layout_height="wrap_content"
         android:layout_gravity="bottom|end"
         android:layout_margin="@dimen/fab_margin"
+        android:contentDescription="Scans the wifi networks"
         android:src="@drawable/ic_refresh_black_24dp"
         app:layout_constraintBottom_toBottomOf="parent"
         app:layout_constraintEnd_toEndOf="parent" />
