/*
2013 Measuring Broadband America Program
Mobile Measurement Android Application
Copyright (C) 2012 SamKnows Ltd.
The FCC Measuring Broadband America (MBA) Program's Mobile Measurement Effort developed in cooperation with SamKnows Ltd. and diverse stakeholders employs an client-server based anonymized data collection approach to gather broadband performance data in an open and transparent manner with the highest commitment to protecting participants privacy. All data collected is thoroughly analyzed and processed prior to public release to ensure that subscribers’ privacy interests are protected.
Data related to the radio characteristics of the handset, information about the handset type and operating system (OS) version, the GPS coordinates available from the handset at the time each test is run, the date and time of the observation, and the results of active test results are recorded on the handset in JSON(JavaScript Object Notation) nested data elements within flat files. These JSON files are then transmitted to storage servers at periodic intervals after the completion of active test measurements.
This Android application source code is made available under the GNU GPL2 for testing purposes only and intended for participants in the SamKnows/FCC Measuring Broadband American program. It is not intended for general release and this repository may be disabled at any time.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program 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 this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package com.samknows.measurement.schedule.datacollection;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.json.JSONObject;
import org.w3c.dom.Element;
import android.content.Context;
import android.location.Location;
import android.location.LocationListener;
import android.location.LocationManager;
import android.os.Bundle;
import android.os.Looper;
import com.samknows.measurement.AppSettings;
import com.samknows.measurement.Logger;
import com.samknows.measurement.environment.DCSData;
import com.samknows.measurement.environment.LocationData;
import com.samknows.measurement.schedule.ScheduleConfig.LocationType;
import com.samknows.measurement.storage.PassiveMetric;
import com.samknows.measurement.test.TestContext;
import com.samknows.measurement.util.DCSStringBuilder;
import com.samknows.measurement.util.XmlUtils;
public class LocationDataCollector extends BaseDataCollector implements LocationListener{
private static final long serialVersionUID = 1L;
private long time;
private long listenerDelay;
// private float listenerMinDst;
private boolean getLastKnown;
private transient List<Location> locations;
List<DCSData> data = new ArrayList<DCSData>();
private transient LocationManager manager;
private boolean gotLastLocation;
private LocationType locationType;
private String lastKnownLocation;
private Location lastKnown;
@Override
public void start(TestContext tc) {
super.start(tc);
locations = Collections.synchronizedList(new ArrayList<Location>());
manager = (LocationManager) tc.getSystemService(Context.LOCATION_SERVICE);
locationType = AppSettings.getInstance().getLocationServiceType();
//if the provider in the settings is gps but the service is not enable fail over to network provider
if(locationType == LocationType.gps &&!manager.isProviderEnabled(LocationManager.GPS_PROVIDER)){
locationType = LocationType.network;
}
if(locationType != LocationType.gps && locationType != LocationType.network){
throw new RuntimeException("unknown location type: " + locationType);
}
String provider = locationType == LocationType.gps ? LocationManager.GPS_PROVIDER : LocationManager.NETWORK_PROVIDER;
if(getLastKnown){
lastKnown = manager.getLastKnownLocation(provider);
if (lastKnown != null) {
data.add(new LocationData(true, lastKnown, locationType));
lastKnownLocation = locationToDCSString("LASTKNOWNLOCATION", lastKnown);
}
}
gotLastLocation = false;
manager.requestLocationUpdates(provider, 0, 0,
LocationDataCollector.this, Looper.getMainLooper());
Logger.d(this, "start collecting location data from: " + provider);
try {
Logger.d(this, "sleeping: " + time);
Thread.sleep(time);
} catch (InterruptedException e) {
e.printStackTrace();
}
//stop listening for location updates if we are on network. That is done because network location uses network and breaks NetworkCondition
if (locationType == LocationType.network) {
manager.removeUpdates(this);
}
}
@Override
public void clearData(){
data.clear();
}
/**
* returns true if got location
* @param time
* @return
*/
public synchronized boolean waitForLocation(long time) {
if (!gotLastLocation) {
try {
wait(time);
} catch (InterruptedException e) {
Logger.e(this, "Interruption while waiting for location", e);
}
}
return gotLastLocation;
}
@Override
public void stop(TestContext ctx) {
if(isEnabled){
super.stop(ctx);
manager.removeUpdates(this);
lastReceivedTime = -1;
Logger.d(this, "location datas: " + locations.size());
Logger.d(this, "stop collecting location data");
}else{
Logger.d(this, "LocationDataCollector is not enabled");
}
}
private long lastReceivedTime=-1;
@Override
public synchronized void onLocationChanged(Location location) {
if (location != null) {
long timeDiff = System.currentTimeMillis() - lastReceivedTime;
if (lastReceivedTime == -1 || timeDiff > listenerDelay) {
lastReceivedTime = System.currentTimeMillis();
locations.add(location);
data.add(new LocationData(location,locationType));
Logger.d(this, "received new location");
gotLastLocation = true;
notifyAll();
}
}
}
@Override
public List<String> getOutput() {
List<String> list = new ArrayList<String>();
for(DCSData d: data){
list.addAll(d.convert());
}
return list;
}
@Override
public List<JSONObject> getPassiveMetric() {
List<JSONObject> ret = new ArrayList<JSONObject>();
if(lastKnown != null){
ret.addAll(locationToPassiveMetric(lastKnown));
}
for(Location l: locations){
ret.addAll(locationToPassiveMetric(l));
}
return ret;
}
private String locationToDCSString(String id, Location loc) {
return new DCSStringBuilder().append(id)
.append(loc.getTime() / 1000)
.append(locationType + "")
.append(loc.getLatitude())
.append(loc.getLongitude())
.append(loc.getAccuracy())
.build();
}
//Receive a Location object and returns a JSONObject ready to be inserted in the database
//and displayed to the interface
private List<JSONObject> locationToPassiveMetric(Location loc){
List<JSONObject> ret = new ArrayList<JSONObject>();
ret.add(PassiveMetric.create(PassiveMetric.METRIC_TYPE.LOCATIONPROVIDER, loc.getTime(), locationType+""));
ret.add(PassiveMetric.create(PassiveMetric.METRIC_TYPE.LATITUDE, loc.getTime(), loc.getLatitude()));
ret.add(PassiveMetric.create(PassiveMetric.METRIC_TYPE.LONGITUDE, loc.getTime(), loc.getLongitude()));
ret.add(PassiveMetric.create(PassiveMetric.METRIC_TYPE.ACCURACY, loc.getTime(), loc.getAccuracy()+" m"));
return ret;
}
@Override
public void onStatusChanged(String provider, int status, Bundle extras) {}
@Override
public void onProviderEnabled(String provider) {}
@Override
public void onProviderDisabled(String provider) {}
//---------------------------------------------------------
public static BaseDataCollector parseXml(Element node) {
LocationDataCollector c = new LocationDataCollector();
String time = node.getAttribute("time");
c.time = XmlUtils.convertTime(time);
String listenerDelay = node.getAttribute("listenerDelay");
c.listenerDelay = XmlUtils.convertTime(listenerDelay);
// c.listenerMinDst = Float.valueOf(node.getAttribute("listenerMinDistance"));
c.getLastKnown = Boolean.parseBoolean(node.getAttribute("lastKnown"));
return c;
}
@Override
public List<JSONObject> getJSONOutput(){
List<JSONObject> ret = new ArrayList<JSONObject>();
for(DCSData d:data){
ret.addAll(d.convertToJSON());
}
return ret;
}
}