LocationActivity.java

  1package eu.siacs.conversations.ui;
  2
  3import android.Manifest;
  4import android.annotation.TargetApi;
  5import android.content.Context;
  6import android.content.SharedPreferences;
  7import android.content.pm.PackageManager;
  8import android.graphics.Bitmap;
  9import android.graphics.BitmapFactory;
 10import android.location.Location;
 11import android.location.LocationListener;
 12import android.location.LocationManager;
 13import android.os.Build;
 14import android.os.Bundle;
 15import android.preference.PreferenceManager;
 16import android.provider.Settings;
 17import android.support.annotation.NonNull;
 18import android.text.TextUtils;
 19import android.util.Log;
 20import android.view.MenuItem;
 21
 22import org.osmdroid.api.IGeoPoint;
 23import org.osmdroid.api.IMapController;
 24import org.osmdroid.config.Configuration;
 25import org.osmdroid.config.IConfigurationProvider;
 26import org.osmdroid.tileprovider.tilesource.XYTileSource;
 27import org.osmdroid.util.GeoPoint;
 28import org.osmdroid.views.MapView;
 29import org.osmdroid.views.overlay.Overlay;
 30
 31import java.io.File;
 32
 33import eu.siacs.conversations.BuildConfig;
 34import eu.siacs.conversations.Config;
 35import eu.siacs.conversations.R;
 36import eu.siacs.conversations.ui.util.LocationHelper;
 37import eu.siacs.conversations.ui.widget.Marker;
 38import eu.siacs.conversations.ui.widget.MyLocation;
 39import eu.siacs.conversations.utils.ThemeHelper;
 40
 41public abstract class LocationActivity extends ActionBarActivity implements LocationListener {
 42	protected LocationManager locationManager;
 43	protected boolean hasLocationFeature;
 44
 45	public static final int REQUEST_CODE_CREATE = 0;
 46	public static final int REQUEST_CODE_FAB_PRESSED = 1;
 47	public static final int REQUEST_CODE_SNACKBAR_PRESSED = 2;
 48
 49	protected static final String KEY_LOCATION = "loc";
 50	protected static final String KEY_ZOOM_LEVEL = "zoom";
 51
 52	protected Location myLoc = null;
 53	private MapView map = null;
 54	protected IMapController mapController = null;
 55
 56	protected Bitmap marker_icon;
 57
 58	protected void clearMarkers() {
 59		synchronized (this.map.getOverlays()) {
 60			for (final Overlay overlay : this.map.getOverlays()) {
 61				if (overlay instanceof Marker || overlay instanceof MyLocation) {
 62					this.map.getOverlays().remove(overlay);
 63				}
 64			}
 65		}
 66	}
 67
 68	protected void updateLocationMarkers() {
 69		clearMarkers();
 70	}
 71
 72	protected XYTileSource tileSource() {
 73		return new XYTileSource("OpenStreetMap",
 74				0, 19, 256, ".png", new String[] {
 75				"https://a.tile.openstreetmap.org/",
 76				"https://b.tile.openstreetmap.org/",
 77				"https://c.tile.openstreetmap.org/" },"© OpenStreetMap contributors");
 78	}
 79
 80	@Override
 81	protected void onCreate(final Bundle savedInstanceState) {
 82		super.onCreate(savedInstanceState);
 83		final Context ctx = getApplicationContext();
 84		setTheme(ThemeHelper.find(this));
 85
 86		final PackageManager packageManager = ctx.getPackageManager();
 87		hasLocationFeature = packageManager.hasSystemFeature(PackageManager.FEATURE_LOCATION) ||
 88				packageManager.hasSystemFeature(PackageManager.FEATURE_LOCATION_GPS) ||
 89				packageManager.hasSystemFeature(PackageManager.FEATURE_LOCATION_NETWORK);
 90		this.locationManager = (LocationManager) this.getSystemService(Context.LOCATION_SERVICE);
 91		this.marker_icon = BitmapFactory.decodeResource(ctx.getResources(), R.drawable.marker);
 92
 93		// Ask for location permissions if location services are enabled and we're
 94		// just starting the activity (we don't want to keep pestering them on every
 95		// screen rotation or if there's no point because it's disabled anyways).
 96		if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M && savedInstanceState == null) {
 97			requestPermissions(REQUEST_CODE_CREATE);
 98		}
 99
100		final IConfigurationProvider config = Configuration.getInstance();
101		config.load(ctx, getPreferences());
102		config.setUserAgentValue(BuildConfig.APPLICATION_ID + "_" + BuildConfig.VERSION_CODE);
103
104		final File f = new File(ctx.getCacheDir() + "/tiles");
105		try {
106			//noinspection ResultOfMethodCallIgnored
107			f.mkdirs();
108		} catch (final SecurityException ignored) {
109		}
110		if (f.exists() && f.isDirectory() && f.canRead() && f.canWrite()) {
111			Log.d(Config.LOGTAG, "Using tile cache at: " + f.getAbsolutePath());
112			config.setOsmdroidTileCache(f.getAbsoluteFile());
113		}
114	}
115
116	@Override
117	protected void onSaveInstanceState(@NonNull final Bundle outState) {
118		super.onSaveInstanceState(outState);
119
120		final IGeoPoint center = map.getMapCenter();
121		outState.putParcelable(KEY_LOCATION, new GeoPoint(
122				center.getLatitude(),
123				center.getLongitude()
124		));
125		outState.putDouble(KEY_ZOOM_LEVEL, map.getZoomLevelDouble());
126	}
127
128	@Override
129	protected void onRestoreInstanceState(@NonNull final Bundle savedInstanceState) {
130		super.onRestoreInstanceState(savedInstanceState);
131
132		if (savedInstanceState.containsKey(KEY_LOCATION)) {
133			mapController.setCenter(savedInstanceState.getParcelable(KEY_LOCATION));
134		}
135		if (savedInstanceState.containsKey(KEY_ZOOM_LEVEL)) {
136			mapController.setZoom(savedInstanceState.getDouble(KEY_ZOOM_LEVEL));
137		}
138	}
139
140	protected void setupMapView(MapView mapView, final GeoPoint pos) {
141		map = mapView;
142		map.setTileSource(tileSource());
143		map.setBuiltInZoomControls(false);
144		map.setMultiTouchControls(true);
145		map.setTilesScaledToDpi(true);
146		mapController = map.getController();
147		mapController.setZoom(Config.Map.INITIAL_ZOOM_LEVEL);
148		mapController.setCenter(pos);
149	}
150
151	protected void gotoLoc() {
152		gotoLoc(map.getZoomLevelDouble() == Config.Map.INITIAL_ZOOM_LEVEL);
153	}
154
155	protected abstract void gotoLoc(final boolean setZoomLevel);
156
157	protected abstract void setMyLoc(final Location location);
158
159	protected void requestLocationUpdates() {
160		if (!hasLocationFeature || locationManager == null) {
161			return;
162		}
163
164		Log.d(Config.LOGTAG, "Requesting location updates...");
165		final Location lastKnownLocationGps;
166		final Location lastKnownLocationNetwork;
167
168		try {
169			if (locationManager.getAllProviders().contains(LocationManager.GPS_PROVIDER)) {
170				lastKnownLocationGps = locationManager.getLastKnownLocation(LocationManager.GPS_PROVIDER);
171
172				if (lastKnownLocationGps != null) {
173					setMyLoc(lastKnownLocationGps);
174				}
175				locationManager.requestLocationUpdates(LocationManager.GPS_PROVIDER, Config.Map.LOCATION_FIX_TIME_DELTA,
176						Config.Map.LOCATION_FIX_SPACE_DELTA, this);
177			} else {
178				lastKnownLocationGps = null;
179			}
180
181			if (locationManager.getAllProviders().contains(LocationManager.NETWORK_PROVIDER)) {
182				lastKnownLocationNetwork = locationManager.getLastKnownLocation(LocationManager.NETWORK_PROVIDER);
183				if (lastKnownLocationNetwork != null && LocationHelper.isBetterLocation(lastKnownLocationNetwork,
184						lastKnownLocationGps)) {
185					setMyLoc(lastKnownLocationNetwork);
186				}
187				locationManager.requestLocationUpdates(LocationManager.NETWORK_PROVIDER, Config.Map.LOCATION_FIX_TIME_DELTA,
188						Config.Map.LOCATION_FIX_SPACE_DELTA, this);
189			}
190
191			// If something else is also querying for location more frequently than we are, the battery is already being
192			// drained. Go ahead and use the existing locations as often as we can get them.
193			if (locationManager.getAllProviders().contains(LocationManager.PASSIVE_PROVIDER)) {
194				locationManager.requestLocationUpdates(LocationManager.PASSIVE_PROVIDER, 0, 0, this);
195			}
196		} catch (final SecurityException ignored) {
197			// Do nothing if the users device has no location providers.
198		}
199	}
200
201	protected void pauseLocationUpdates() throws SecurityException {
202		if (locationManager != null) {
203			locationManager.removeUpdates(this);
204		}
205	}
206
207	@Override
208	public boolean onOptionsItemSelected(final MenuItem item) {
209		switch (item.getItemId()) {
210			case android.R.id.home:
211				finish();
212				return true;
213		}
214		return super.onOptionsItemSelected(item);
215	}
216
217	@Override
218	protected void onPause() {
219		super.onPause();
220		Configuration.getInstance().save(this, getPreferences());
221		map.onPause();
222		try {
223			pauseLocationUpdates();
224		} catch (final SecurityException ignored) {
225		}
226	}
227
228	protected abstract void updateUi();
229
230	protected boolean mapAtInitialLoc() {
231		return map.getZoomLevelDouble() == Config.Map.INITIAL_ZOOM_LEVEL;
232	}
233
234	@Override
235	protected void onResume() {
236		super.onResume();
237		Configuration.getInstance().load(this, getPreferences());
238		map.onResume();
239		this.setMyLoc(null);
240		requestLocationUpdates();
241		updateLocationMarkers();
242		updateUi();
243		map.setTileSource(tileSource());
244		map.setTilesScaledToDpi(true);
245
246		if (mapAtInitialLoc()) {
247			gotoLoc();
248		}
249	}
250
251	@TargetApi(Build.VERSION_CODES.M)
252	protected boolean hasLocationPermissions() {
253		return (checkSelfPermission(Manifest.permission.ACCESS_FINE_LOCATION) == PackageManager.PERMISSION_GRANTED ||
254				checkSelfPermission(Manifest.permission.ACCESS_COARSE_LOCATION) == PackageManager.PERMISSION_GRANTED);
255	}
256
257	@TargetApi(Build.VERSION_CODES.M)
258	protected void requestPermissions(final int request_code) {
259		if (!hasLocationPermissions()) {
260			requestPermissions(
261					new String[]{
262							Manifest.permission.ACCESS_FINE_LOCATION,
263							Manifest.permission.ACCESS_COARSE_LOCATION,
264					},
265					request_code
266			);
267		}
268	}
269
270	@Override
271	public void onRequestPermissionsResult(final int requestCode,
272										   @NonNull final String[] permissions,
273										   @NonNull final int[] grantResults) {
274		super.onRequestPermissionsResult(requestCode, permissions, grantResults);
275		for (int i = 0; i < grantResults.length; i++) {
276			if (Manifest.permission.ACCESS_FINE_LOCATION.equals(permissions[i]) ||
277					Manifest.permission.ACCESS_COARSE_LOCATION.equals(permissions[i])) {
278				if (grantResults[i] == PackageManager.PERMISSION_GRANTED) {
279					requestLocationUpdates();
280				}
281			}
282		}
283	}
284
285	protected SharedPreferences getPreferences() {
286		return PreferenceManager.getDefaultSharedPreferences(getApplicationContext());
287	}
288
289	protected boolean isLocationEnabled() {
290		try {
291			final int locationMode = Settings.Secure.getInt(getContentResolver(), Settings.Secure.LOCATION_MODE);
292			return locationMode != Settings.Secure.LOCATION_MODE_OFF;
293		} catch( final Settings.SettingNotFoundException e ){
294			return false;
295		}
296	}
297}