io.appium.settings 3.2.0 → 3.5.0

package/README.md

@@ -134,6 +134,12 @@ $ adb shell am startservice --user 0 -n io.appium.settings/.LocationService --es
 Running the command again stops sending the previously specified location and starts sending updates for the
 new mock location.
 
+Additionally the service allows to provide the following optional parameters to the mocked
+location:
+
+- `speed`: the speed, in meters/second over ground. A float value greater than zero is acceptable.
+- `bearing`: the bearing, in degrees. Bearing is the horizontal direction of travel of this device, and is not related to the device orientation. The input will be wrapped into the range (0.0, 360.0]
+
 Stop sending new mocklocations and clean up everything (remove the mock location providers) by executing:
 ```shell
 $ adb shell am stopservice io.appium.settings/.LocationService
@@ -280,6 +286,23 @@ The example of the resulting data:
 ```
 
 
+## Media Scanning
+
+Since version 3.5 Appium Settings supports broadcast messages handling
+that performs media scanning in response to `io.appium.settings.scan_media`
+intent. This was done due to `android.intent.action.MEDIA_SCANNER_SCAN_FILE` deprecation
+since Android API version 30. To scan the given file or folder for media data simply run:
+
+```bash
+$ adb shell am broadcast -a io.appium.settings.scan_media --es path /sdcard/media
+```
+
+This command will _recursively_ scan all files inside of `/sdcard/media` folder
+and add them to the media library if their MIME types are supported. If the
+file/folder in _path_ does not exist/is not readable or is not provided then an
+error will be returned and the corresponding log message would be written into logs.
+
+
 ## Notes:
 
 * You have to specify the receiver class if the app has never been executed before:

package/app/build.gradle

@@ -1,14 +1,13 @@
 apply plugin: 'com.android.application'
 
 android {
-    compileSdkVersion 28
-    buildToolsVersion '28.0.3'
+    compileSdkVersion 29
 
     defaultConfig {
         minSdkVersion 18
-        targetSdkVersion 28
-        versionCode 27
-        versionName "3.2.0"
+        targetSdkVersion 29
+        versionCode 31
+        versionName "3.5.0"
         applicationId "io.appium.settings"
     }
 

package/app/src/main/AndroidManifest.xml

@@ -4,6 +4,7 @@
     package="io.appium.settings">
 
     <uses-permission android:name="android.permission.DISABLE_KEYGUARD" />
+    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
     <uses-permission android:name="android.permission.WAKE_LOCK"/>
     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
@@ -132,5 +133,8 @@
         <receiver android:name=".receivers.SmsReader"
                   android:exported="true"
                   tools:ignore="ExportedReceiver" />
+        <receiver android:name=".receivers.MediaScannerReceiver"
+            android:exported="true"
+            tools:ignore="ExportedReceiver" />
     </application>
 </manifest>

package/app/src/main/java/io/appium/settings/LocationService.java

@@ -20,7 +20,6 @@ import android.app.Service;
 import android.content.Context;
 import android.content.Intent;
 import android.content.pm.PackageManager;
-import android.location.Criteria;
 import android.location.Location;
 import android.location.LocationManager;
 import android.location.LocationProvider;
@@ -40,21 +39,16 @@ import java.util.TimerTask;
 import io.appium.settings.helpers.NotificationHelpers;
 import io.appium.settings.helpers.PlayServicesHelpers;
 import io.appium.settings.location.FusedLocationProvider;
-import io.appium.settings.location.LocationFactory;
+import io.appium.settings.location.LocationBuilder;
 import io.appium.settings.location.LocationManagerProvider;
 import io.appium.settings.location.MockLocationProvider;
 
 public class LocationService extends Service {
     private static final String TAG = "MOCKED LOCATION SERVICE";
 
-    private static final String LONGITUDE_PARAMETER_KEY = "longitude";
-    private static final String LATITUDE_PARAMETER_KEY = "latitude";
-    private static final String ALTITUDE_PARAMETER_KEY = "altitude";
-
     private static final long UPDATE_INTERVAL_MS = 2000L;
 
     private final List<MockLocationProvider> mockLocationProviders = new LinkedList<>();
-    private final LocationFactory locationFactory = new LocationFactory();
     private final Timer locationUpdatesTimer = new Timer();
     private TimerTask locationUpdateTask;
 
@@ -85,7 +79,6 @@ public class LocationService extends Service {
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
             finishForegroundSetup();
         }
-        Log.i(TAG, "INTENT " + intent.getExtras());
 
         handleIntent(intent);
 
@@ -104,9 +97,9 @@ public class LocationService extends Service {
         if (intent == null) {
             return;
         }
-        // update the locationFactory also if the service is already running to mock
-        updateMockLocationFactory(intent);
-        scheduleLocationUpdate();
+        Log.i(TAG, "INTENT " + intent.getExtras());
+
+        scheduleLocationUpdate(intent);
     }
 
     private void enableLocationProviders() {
@@ -143,7 +136,7 @@ public class LocationService extends Service {
         Log.d(TAG, String.format("Created mock providers: %s", mockLocationProviders.toString()));
     }
 
-    private void scheduleLocationUpdate() {
+    private void scheduleLocationUpdate(final Intent intent) {
         Log.i(TAG, "Scheduling mock location updates");
 
         // If we run 'startservice' again we should schedule an update right away to avoid a delay
@@ -155,7 +148,7 @@ public class LocationService extends Service {
             @Override
             public void run() {
                 for (MockLocationProvider mockLocationProvider : mockLocationProviders) {
-                    Location location = locationFactory.createLocation(mockLocationProvider.getProviderName(), Criteria.ACCURACY_FINE);
+                    Location location = LocationBuilder.buildFromIntent(intent, mockLocationProvider.getProviderName());
                     Log.d(TAG, String.format("Setting location of '%s' to '%s'", mockLocationProvider.getProviderName(), location));
                     try {
                         mockLocationProvider.setLocation(location);
@@ -170,36 +163,6 @@ public class LocationService extends Service {
         locationUpdatesTimer.schedule(locationUpdateTask, 0, UPDATE_INTERVAL_MS);
     }
 
-    private void updateMockLocationFactory(Intent intent) {
-        double longitude;
-        try {
-            longitude = Double.valueOf(intent.getStringExtra("longitude"));
-        } catch (NumberFormatException e) {
-            throw new IllegalArgumentException(
-                    String.format("longitude should be a valid number. '%s' is given instead",
-                            intent.getStringExtra(LONGITUDE_PARAMETER_KEY)));
-        }
-        double latitude;
-        try {
-            latitude = Double.valueOf(intent.getStringExtra("latitude"));
-        } catch (NumberFormatException e) {
-            throw new IllegalArgumentException(
-                    String.format("latitude should be a valid number. '%s' is given instead",
-                            intent.getStringExtra(LATITUDE_PARAMETER_KEY)));
-        }
-        double altitude = 0.0;
-        try {
-            if (intent.hasExtra(ALTITUDE_PARAMETER_KEY)) {
-                altitude = Double.valueOf(intent.getStringExtra(ALTITUDE_PARAMETER_KEY));
-            }
-        } catch (NumberFormatException e) {
-            Log.e(TAG, String.format("altitude should be a valid number. '%s' is given instead",
-                    intent.getStringExtra(ALTITUDE_PARAMETER_KEY)));
-        }
-
-        locationFactory.setLocation(latitude, longitude, altitude);
-    }
-
     private List<MockLocationProvider> createMockProviders(LocationManager locationManager) {
         List<String> providers = locationManager.getAllProviders();
         List<MockLocationProvider> mockProviders = new LinkedList<>();

package/app/src/main/java/io/appium/settings/Settings.java

@@ -24,7 +24,7 @@ import android.os.Bundle;
 import android.os.Handler;
 import android.util.Log;
 
-import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 
 import io.appium.settings.receivers.AnimationSettingReceiver;
@@ -34,6 +34,7 @@ import io.appium.settings.receivers.DataConnectionSettingReceiver;
 import io.appium.settings.receivers.HasAction;
 import io.appium.settings.receivers.LocaleSettingReceiver;
 import io.appium.settings.receivers.LocationInfoReceiver;
+import io.appium.settings.receivers.MediaScannerReceiver;
 import io.appium.settings.receivers.NotificationsReceiver;
 import io.appium.settings.receivers.SmsReader;
 import io.appium.settings.receivers.UnpairBluetoothDevicesReceiver;
@@ -50,18 +51,19 @@ public class Settings extends Activity {
 
         LocationTracker.getInstance().start(this);
 
-        final List<Class<? extends BroadcastReceiver>> receiverClasses = new ArrayList<>();
-        receiverClasses.add(WiFiConnectionSettingReceiver.class);
-        receiverClasses.add(AnimationSettingReceiver.class);
-        receiverClasses.add(DataConnectionSettingReceiver.class);
-        receiverClasses.add(LocaleSettingReceiver.class);
-        receiverClasses.add(LocationInfoReceiver.class);
-        receiverClasses.add(ClipboardReceiver.class);
-        receiverClasses.add(BluetoothConnectionSettingReceiver.class);
-        receiverClasses.add(UnpairBluetoothDevicesReceiver.class);
-        receiverClasses.add(NotificationsReceiver.class);
-        receiverClasses.add(SmsReader.class);
-        registerSettingsReceivers(receiverClasses);
+        registerSettingsReceivers(Arrays.asList(
+                WiFiConnectionSettingReceiver.class,
+                AnimationSettingReceiver.class,
+                DataConnectionSettingReceiver.class,
+                LocaleSettingReceiver.class,
+                LocationInfoReceiver.class,
+                ClipboardReceiver.class,
+                BluetoothConnectionSettingReceiver.class,
+                UnpairBluetoothDevicesReceiver.class,
+                NotificationsReceiver.class,
+                SmsReader.class,
+                MediaScannerReceiver.class
+        ));
 
         // https://developer.android.com/about/versions/oreo/background-location-limits
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {

package/app/src/main/java/io/appium/settings/handlers/BluetoothConnectionSettingHandler.java

@@ -16,9 +16,11 @@
 
 package io.appium.settings.handlers;
 
+import android.annotation.SuppressLint;
 import android.bluetooth.BluetoothAdapter;
 import android.content.Context;
 
+@SuppressLint("MissingPermission")
 public class BluetoothConnectionSettingHandler extends AbstractSettingHandler {
 
     private BluetoothAdapter bluetoothAdapter;

package/app/src/main/java/io/appium/settings/location/LocationBuilder.java

@@ -0,0 +1,83 @@
+/*
+  Copyright 2012-present Appium Committers
+  <p>
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+  <p>
+  http://www.apache.org/licenses/LICENSE-2.0
+  <p>
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+ */
+
+package io.appium.settings.location;
+
+import android.content.Intent;
+import android.location.Criteria;
+import android.location.Location;
+import android.os.Build;
+import android.os.SystemClock;
+import android.support.annotation.Nullable;
+import android.util.Log;
+
+
+public class LocationBuilder {
+
+    private static final String TAG = "MOCKED LOCATION BUILDER";
+    private static final String LONGITUDE_PARAMETER_KEY = "longitude";
+    private static final String LATITUDE_PARAMETER_KEY = "latitude";
+    private static final String ALTITUDE_PARAMETER_KEY = "altitude";
+    private static final String SPEED_PARAMETER_KEY = "speed";
+    private static final String BEARING_PARAMETER_KEY = "bearing";
+
+    @Nullable
+    private static Double extractParam(Intent intent, String paramKey) {
+        Double value = null;
+
+        try {
+            if (intent.hasExtra(paramKey)) {
+                value = Double.parseDouble(intent.getStringExtra(paramKey));
+                Log.i(TAG, String.format("Received parameter: %s, value: %s", paramKey, value));
+            }
+        } catch (NumberFormatException e) {
+            Log.e(TAG, String.format("%s should be a valid number. '%s' is given instead",
+                    paramKey, intent.getStringExtra(paramKey)));
+        }
+        return value;
+    }
+
+    public static Location buildFromIntent(Intent intent, String providerName) {
+        Double longitude = extractParam(intent, LONGITUDE_PARAMETER_KEY);
+        Double latitude = extractParam(intent, LATITUDE_PARAMETER_KEY);
+        Double altitude = extractParam(intent, ALTITUDE_PARAMETER_KEY);
+        Double speed = extractParam(intent, SPEED_PARAMETER_KEY);
+        Double bearing = extractParam(intent, BEARING_PARAMETER_KEY);
+        Location location = new Location(providerName);
+        location.setAccuracy(Criteria.ACCURACY_FINE);
+        if (longitude != null) {
+            location.setLongitude(longitude);
+        }
+        if (latitude != null) {
+            location.setLatitude(latitude);
+        }
+        if (altitude != null) {
+            location.setAltitude(altitude);
+        }
+        if (speed != null) {
+            location.setSpeed(speed.floatValue());
+        }
+        if (bearing != null) {
+            location.setBearing(bearing.floatValue());
+        }
+
+        location.setTime(System.currentTimeMillis());
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN_MR1) {
+            location.setElapsedRealtimeNanos(SystemClock.elapsedRealtimeNanos());
+        }
+        return location;
+    }
+}

package/app/src/main/java/io/appium/settings/receivers/LocationInfoReceiver.java

@@ -45,7 +45,7 @@ public class LocationInfoReceiver extends BroadcastReceiver
         if (location != null) {
             setResultCode(Activity.RESULT_OK);
             // Decimal separator is a dot
-            setResultData(String.format(Locale.US, "%.5f %.5f %.5f",
+            setResultData(String.format(Locale.US, "%.7f %.7f %.7f",
                     location.getLatitude(), location.getLongitude(), location.getAltitude()));
         } else {
             setResultCode(Activity.RESULT_CANCELED);

package/app/src/main/java/io/appium/settings/receivers/MediaScannerReceiver.java

@@ -0,0 +1,91 @@
+/*
+  Copyright 2012-present Appium Committers
+  <p>
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+  <p>
+  http://www.apache.org/licenses/LICENSE-2.0
+  <p>
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+ */
+
+package io.appium.settings.receivers;
+
+import android.app.Activity;
+import android.content.BroadcastReceiver;
+import android.content.Context;
+import android.content.Intent;
+import android.media.MediaScannerConnection;
+import android.util.Log;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+public class MediaScannerReceiver extends BroadcastReceiver
+        implements HasAction {
+    private static final String TAG = MediaScannerReceiver.class.getSimpleName();
+    private static final String ACTION = "io.appium.settings.scan_media";
+    private static final String PATH = "path";
+
+    private List<String> fetchFiles(File root) {
+        if (root.isFile()) {
+            return root.canRead()
+                    ? Collections.singletonList(root.toString())
+                    : Collections.emptyList();
+        }
+        File[] items = root.listFiles();
+        if (items == null) {
+            return Collections.emptyList();
+        }
+        List<String> filePaths = new ArrayList<>();
+        for (File item : items) {
+            filePaths.addAll(fetchFiles(item));
+        }
+        return filePaths;
+    }
+
+    /**
+     * Responds to broadcast requests like
+     * am broadcast -a io.appium.settings.scan_media -e path /sdcard/yolo
+     * by scanning all files/folders under the given path
+     */
+    @Override
+    public void onReceive(Context context, Intent intent) {
+        Log.d(TAG, "Scanning the requested media");
+        if (!intent.hasExtra(PATH)) {
+            Log.e(TAG, "No path has been provided");
+            setResultCode(Activity.RESULT_CANCELED);
+            setResultData("");
+            return;
+        }
+        File item = new File(intent.getStringExtra(PATH));
+        if (!item.exists()) {
+            Log.e(TAG, String.format("The item at '%s' does not exist", item.toString()));
+            setResultCode(Activity.RESULT_CANCELED);
+            setResultData("");
+            return;
+        }
+        List<String> filePaths = fetchFiles(item);
+        if (filePaths.isEmpty()) {
+            Log.i(TAG, String.format("Found no files to scan at '%s'", item.toString()));
+        } else {
+            MediaScannerConnection.scanFile(context, filePaths.toArray(new String[0]), null, null);
+            Log.i(TAG, String.format("Successfully scanned %s file(s) at '%s'",
+                    filePaths.size(), item.toString()));
+        }
+        setResultCode(Activity.RESULT_OK);
+        setResultData("");
+    }
+
+    @Override
+    public String getAction() {
+        return ACTION;
+    }
+}

package/app/src/main/java/io/appium/settings/receivers/SmsReader.java

@@ -58,7 +58,10 @@ public class SmsReader extends BroadcastReceiver implements HasAction {
                 do {
                     JSONObject item = new JSONObject();
                     for (String[] entry : SMS_INFO_MAPPING) {
-                        item.put(entry[1], formatJsonNull(cursor.getString(cursor.getColumnIndex(entry[0]))));
+                        int columnIndex = cursor.getColumnIndex(entry[0]);
+                        if (columnIndex >= 0) {
+                            item.put(entry[1], formatJsonNull(cursor.getString(columnIndex)));
+                        }
                     }
                     items.put(item);
                 } while (cursor.moveToNext() && items.length() < maxCount);

package/app/src/main/java/io/appium/settings/receivers/UnpairBluetoothDevicesReceiver.java

@@ -16,6 +16,7 @@
 
 package io.appium.settings.receivers;
 
+import android.annotation.SuppressLint;
 import android.app.Activity;
 import android.bluetooth.BluetoothAdapter;
 import android.bluetooth.BluetoothDevice;
@@ -27,6 +28,7 @@ import android.util.Log;
 import java.lang.reflect.InvocationTargetException;
 import java.util.Set;
 
+@SuppressLint("MissingPermission")
 public class UnpairBluetoothDevicesReceiver extends BroadcastReceiver implements HasAction {
     private static final String TAG = UnpairBluetoothDevicesReceiver.class.getSimpleName();
 
@@ -69,9 +71,10 @@ public class UnpairBluetoothDevicesReceiver extends BroadcastReceiver implements
         }
     }
 
-    private void unpairBluetoothDevice(BluetoothDevice device) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException {
-        //noinspection JavaReflectionMemberAccess,ConstantConditions,ConfusingArgumentToVarargsMethod
-        device.getClass().getMethod("removeBond", null).invoke(device, null);
+    private void unpairBluetoothDevice(BluetoothDevice device)
+            throws IllegalAccessException, InvocationTargetException, NoSuchMethodException {
+        //noinspection JavaReflectionMemberAccess
+        device.getClass().getMethod("removeBond").invoke(device);
     }
 
     @Override

package/build.gradle

@@ -5,7 +5,7 @@ buildscript {
         jcenter()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.5.3'
+        classpath 'com.android.tools.build:gradle:7.0.3'
     }
 }
 

package/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
-#Thu Dec 19 12:41:17 CET 2019
+#Tue May 19 12:07:24 CEST 2020
 distributionBase=GRADLE_USER_HOME
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.4.1-all.zip
 distributionPath=wrapper/dists
-zipStorePath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.0.2-all.zip

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "io.appium.settings",
-  "version": "3.2.0",
+  "version": "3.5.0",
   "description": "App for dealing with Android settings",
   "main": "index.js",
   "scripts": {

package/app/src/main/java/io/appium/settings/location/LocationFactory.java

@@ -1,52 +0,0 @@
-/*
-  Copyright 2012-present Appium Committers
-  <p>
-  Licensed under the Apache License, Version 2.0 (the "License");
-  you may not use this file except in compliance with the License.
-  You may obtain a copy of the License at
-  <p>
-  http://www.apache.org/licenses/LICENSE-2.0
-  <p>
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
- */
-
-package io.appium.settings.location;
-
-import android.location.Location;
-import android.os.Build;
-import android.os.SystemClock;
-
-public class LocationFactory {
-
-    private double latitude;
-    private double longitude;
-    private double altitude;
-
-
-    public synchronized Location createLocation(String providerName, float accuracy) {
-        Location l = new Location(providerName);
-        l.setAccuracy(accuracy);
-
-        l.setLatitude(latitude);
-        l.setLongitude(longitude);
-        l.setAltitude(altitude);
-        l.setSpeed(0);
-        l.setBearing(0);
-
-        l.setTime(System.currentTimeMillis());
-        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN_MR1) {
-            l.setElapsedRealtimeNanos(SystemClock.elapsedRealtimeNanos());
-        }
-        return l;
-    }
-
-    public synchronized void setLocation(double latitude, double longitude, double altitude) {
-        this.latitude = latitude;
-        this.longitude = longitude;
-        this.altitude = altitude;
-    }
-}