Merge branch 'mjmfighter-MapAPI_Updates'

Author: Grover-c13

src/main/java/com/pokegoapi/api/map/Map.java

@@ -12,20 +12,22 @@
  *     You should have received a copy of the GNU General Public License
  *     along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-
 package com.pokegoapi.api.map;
 
 import POGOProtos.Map.Fort.FortDataOuterClass;
 import POGOProtos.Map.Fort.FortTypeOuterClass;
 import POGOProtos.Map.MapCellOuterClass;
 import POGOProtos.Map.Pokemon.MapPokemonOuterClass;
+import POGOProtos.Map.Pokemon.NearbyPokemonOuterClass;
 import POGOProtos.Map.Pokemon.WildPokemonOuterClass;
+import POGOProtos.Map.SpawnPointOuterClass;
 import POGOProtos.Networking.Requests.Messages.*;
 import POGOProtos.Networking.Requests.RequestTypeOuterClass;
 import POGOProtos.Networking.Responses.*;
 import com.google.protobuf.InvalidProtocolBufferException;
 import com.pokegoapi.api.PokemonGo;
 import com.pokegoapi.api.map.Pokemon.CatchablePokemon;
+import com.pokegoapi.api.map.Pokemon.NearbyPokemon;
 import com.pokegoapi.api.map.fort.FortDetails;
 import com.pokegoapi.exceptions.LoginFailedException;
 import com.pokegoapi.exceptions.RemoteServerException;
@@ -36,37 +38,38 @@
 import java8.util.function.Function;
 import java8.util.stream.Collectors;
 import java8.util.stream.StreamSupport;
+import lombok.Getter;
+import lombok.Setter;
 
 import java.util.ArrayList;
 import java.util.List;
 
 import static com.pokegoapi.google.common.geometry.S2CellId.MAX_LEVEL;
 
 public class Map {
-	private static long NEW_MAP_OBJECTS_EXPIRY = 60000; // 60 seconds
-	private PokemonGo api;
+
+	private final PokemonGo api;
+	private MapObjects cachedMapObjects;
+	@Getter
+	@Setter
+	private boolean useCache;
+
+	@Setter
+	@Getter
+	private long mapObjectsExpiry;
+
 	private long lastMapUpdate;
-	private MapObjects lastMapObjects;
-	private long lastLong;
-	private long lastLat;
 
 	public Map(PokemonGo api) {
 		this.api = api;
+		cachedMapObjects = new MapObjects(api);
 		lastMapUpdate = 0;
+		useCache = true;
 	}
 
-	/**
-	 * Gets a new map objects if there has been a lat/long change or the last request was done greater then NEW_MAP_OBJECTS_EXPIRY
-	 *
-	 * @return List<CatchablePokemon> at your current location
-	 */
-	private MapObjects getRetainedMapObject() throws LoginFailedException, RemoteServerException {
-		// get new MapObjects or used existing one
-		if (api.getLatitude() != lastLat && api.getLongitude() != lastLong || (System.currentTimeMillis() - lastMapUpdate) > NEW_MAP_OBJECTS_EXPIRY) {
-			getMapObjects(); // should update the lastMapObjects variable
-		}
-
-		return lastMapObjects;
+	public void clearCache(){
+		this.lastMapUpdate = 0;
+		this.cachedMapObjects = new MapObjects(api);
 	}
 
 	/**
@@ -76,18 +79,66 @@ private MapObjects getRetainedMapObject() throws LoginFailedException, RemoteSer
 	 */
 	public List<CatchablePokemon> getCatchablePokemon() throws LoginFailedException, RemoteServerException {
 		List<CatchablePokemon> catchablePokemons = new ArrayList<>();
-		MapObjects objects = getRetainedMapObject();
+		MapObjects objects = getMapObjects();
 
-		for (MapPokemonOuterClass.MapPokemon mapPokemon : objects.getCatchablePokemons()) {
+		for(MapPokemonOuterClass.MapPokemon mapPokemon : objects.getCatchablePokemons()){
 			catchablePokemons.add(new CatchablePokemon(api, mapPokemon));
 		}
-		for (WildPokemonOuterClass.WildPokemon wildPokemon : objects.getWildPokemons()) {
+
+		for(WildPokemonOuterClass.WildPokemon wildPokemon : objects.getWildPokemons()){
 			catchablePokemons.add(new CatchablePokemon(api, wildPokemon));
 		}
 
 		return catchablePokemons;
 	}
 
+	/**
+	 * Returns a list of nearby pokemon (non-catchable)
+	 *
+	 * @return List<NearbyPokemon> at your current location
+	 */
+	public List<NearbyPokemon> getNearbyPokemon() throws LoginFailedException, RemoteServerException {
+		List<NearbyPokemon> pokemons = new ArrayList<>();
+		MapObjects objects = getMapObjects();
+
+		for (NearbyPokemonOuterClass.NearbyPokemon pokemon : objects.getNearbyPokemons()) {
+			pokemons.add(new NearbyPokemon(pokemon));
+		}
+
+		return pokemons;
+	}
+
+	/**
+	 * Returns a list of spawn points
+	 *
+	 * @return List<Point> list of spawn points
+	 */
+	public List<Point> getSpawnPoints() throws LoginFailedException, RemoteServerException {
+		List<Point> points = new ArrayList<>();
+		MapObjects objects = getMapObjects();
+
+		for (SpawnPointOuterClass.SpawnPoint point : objects.getSpawnPoints()) {
+			points.add(new Point(point));
+		}
+
+		return points;
+	}
+
+	/**
+	 * Returns a list of decimated spawn points at current location
+	 *
+	 * @return List<Point> list of spawn points
+	 */
+	public List<Point> getDecimatedSpawnPoints() throws LoginFailedException, RemoteServerException {
+		List<Point> points = new ArrayList<>();
+		MapObjects objects = getMapObjects();
+
+		for (SpawnPointOuterClass.SpawnPoint point : objects.getDecimatedSpawnPoints()) {
+			points.add(new Point(point));
+		}
+
+		return points;
+	}
 
 	/**
 	 * Returns MapObjects around your current location
@@ -169,15 +220,20 @@ public MapObjects getMapObjects(List<Long> cellIds, double latitude, double long
 	 * @return MapObjects in the given cells
 	 */
 	public MapObjects getMapObjects(List<Long> cellIds) throws LoginFailedException, RemoteServerException {
+
+		if(useCache && (System.currentTimeMillis() - lastMapUpdate > mapObjectsExpiry)){
+			lastMapUpdate = 0;
+			cachedMapObjects = new MapObjects(api);
+		}
+
 		GetMapObjectsMessageOuterClass.GetMapObjectsMessage.Builder builder = GetMapObjectsMessageOuterClass.GetMapObjectsMessage.newBuilder()
 				.setLatitude(api.getLatitude())
 				.setLongitude(api.getLongitude());
 
-		int i = 0;
 		for (Long cellId : cellIds) {
 			builder.addCellId(cellId);
 			builder.addSinceTimestampMs(lastMapUpdate);
-			i++;
+
 		}
 
 		ServerRequest serverRequest = new ServerRequest(RequestTypeOuterClass.RequestType.GET_MAP_OBJECTS, builder.build());
@@ -209,8 +265,12 @@ public FortTypeOuterClass.FortType apply(FortDataOuterClass.FortData t) {
 			result.addPokestops(groupedForts.get(FortTypeOuterClass.FortType.CHECKPOINT));
 		}
 
-		lastMapObjects = result;
-		lastMapUpdate = System.currentTimeMillis();
+		if(useCache){
+			cachedMapObjects.update(result);
+			result = cachedMapObjects;
+			lastMapUpdate = System.currentTimeMillis();
+		}
+
 		return result;
 	}
 
@@ -244,7 +304,7 @@ public List<Long> getCellIds(double latitude, double longitude, int width) {
 		return cells;
 	}
 
-	public FortDetails getFortDetails(String id, long lon, long lat) throws LoginFailedException, RemoteServerException {
+	public FortDetails getFortDetails(String id, double lon, double lat) throws LoginFailedException, RemoteServerException {
 		FortDetailsMessageOuterClass.FortDetailsMessage reqMsg = FortDetailsMessageOuterClass.FortDetailsMessage.newBuilder()
 				.setFortId(id)
 				.setLatitude(lat)
@@ -326,4 +386,4 @@ public CatchPokemonResponseOuterClass.CatchPokemonResponse catchPokemon(MapPokem
 		}
 		return response;
 	}
-}
+}

src/main/java/com/pokegoapi/api/map/MapObjects.java

@@ -117,4 +117,42 @@ public void addPokestops(Collection<FortDataOuterClass.FortData> pokestops) {
 	public boolean isComplete() {
 		return complete;
 	}
+
+	public void update(MapObjects other){
+
+		nearbyPokemons.clear();
+		addNearbyPokemons(other.getNearbyPokemons());
+
+		catchablePokemons.clear();
+		addCatchablePokemons(other.getCatchablePokemons());
+
+		wildPokemons.clear();
+		addWildPokemons(other.getWildPokemons());
+
+		decimatedSpawnPoints.clear();
+		addDecimatedSpawnPoints(other.getDecimatedSpawnPoints());
+
+		spawnPoints.clear();
+		addSpawnPoints(other.getSpawnPoints());
+
+		for(FortDataOuterClass.FortData otherGym : other.getGyms()){
+			for(FortDataOuterClass.FortData gym : getGyms()){
+				if(otherGym.getId().equals(gym.getId())){
+					gyms.remove(gym);
+					break;
+				}
+			}
+			gyms.add(otherGym);
+		}
+
+		for(Pokestop otherPokestop : other.getPokestops()){
+			for(Pokestop pokestop : pokestops){
+				if(otherPokestop.getId().equals(pokestop.getId())){
+					pokestops.remove(pokestop);
+					break;
+				}
+			}
+			pokestops.add(otherPokestop);
+		}
+	}
 }

src/main/java/com/pokegoapi/api/map/Point.java

@@ -0,0 +1,39 @@
+/*
+ *     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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+package com.pokegoapi.api.map;
+
+import POGOProtos.Map.SpawnPointOuterClass;
+import lombok.Getter;
+import lombok.Setter;
+
+public class Point {
+	@Getter
+	@Setter
+	private static double longitude;
+	@Getter
+	@Setter
+	private static double latitude;
+
+	public Point(double latitude, double longitude) {
+		this.latitude = latitude;
+		this.longitude = longitude;
+	}
+
+	public Point(SpawnPointOuterClass.SpawnPoint spawnpoint) {
+		this.latitude = spawnpoint.getLatitude();
+		this.longitude = spawnpoint.getLongitude();
+	}
+}

src/main/java/com/pokegoapi/api/map/Pokemon/NearbyPokemon.java

@@ -0,0 +1,39 @@
+/*
+ *     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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+package com.pokegoapi.api.map.Pokemon;
+
+import POGOProtos.Enums.PokemonIdOuterClass;
+import POGOProtos.Map.Pokemon.NearbyPokemonOuterClass;
+
+public class NearbyPokemon {
+	private NearbyPokemonOuterClass.NearbyPokemon proto;
+
+	public NearbyPokemon(NearbyPokemonOuterClass.NearbyPokemon proto) {
+		this.proto = proto;
+	}
+
+	public PokemonIdOuterClass.PokemonId getPokemonId() {
+		return proto.getPokemonId();
+	}
+
+	public float getDistanceInMeters() {
+		return proto.getDistanceInMeters();
+	}
+
+	public long getEncounterId() {
+		return proto.getEncounterId();
+	}
+}