Support for PokeHash hasher (#833)

Author: Gegy

library/src/main/java/com/pokegoapi/api/PokemonGo.java

@@ -55,6 +55,7 @@
 import com.pokegoapi.util.ClientInterceptor;
 import com.pokegoapi.util.SystemTimeImpl;
 import com.pokegoapi.util.Time;
+import com.pokegoapi.util.hash.HashProvider;
 import lombok.Getter;
 import lombok.Setter;
 import okhttp3.OkHttpClient;
@@ -128,6 +129,9 @@ public class PokemonGo {
 	@Getter
 	private Heartbeat heartbeat = new Heartbeat(this);
 
+	@Getter
+	private HashProvider hashProvider;
+
 	/**
 	 * Instantiates a new Pokemon go.
 	 *
@@ -186,17 +190,22 @@ public PokemonGo(OkHttpClient client) {
 	 * Login user with the provided provider
 	 *
 	 * @param credentialProvider the credential provider
+	 * @param hashProvider to provide hashes
 	 * @throws LoginFailedException When login fails
 	 * @throws RemoteServerException When server fails
 	 * @throws CaptchaActiveException if a captcha is active and the message can't be sent
 	 */
-	public void login(CredentialProvider credentialProvider)
+	public void login(CredentialProvider credentialProvider, HashProvider hashProvider)
 			throws LoginFailedException, CaptchaActiveException, RemoteServerException {
 		this.loggingIn = true;
 		if (credentialProvider == null) {
-			throw new NullPointerException("Credential Provider is null");
+			throw new NullPointerException("Credential Provider can not be null!");
+		} else if (hashProvider == null) {
+			throw new NullPointerException("Hash Provider can not be null!");
 		}
 		this.credentialProvider = credentialProvider;
+		this.hashProvider = hashProvider;
+
 		startTime = currentTimeMillis();
 		inventories = new Inventories(this);
 		settings = new Settings(this);
@@ -209,7 +218,7 @@ private void initialize() throws RemoteServerException, CaptchaActiveException,
 		playerProfile.updateProfile();
 
 		ServerRequest downloadConfigRequest = new ServerRequest(RequestType.DOWNLOAD_REMOTE_CONFIG_VERSION,
-				CommonRequests.getDownloadRemoteConfigVersionMessageRequest());
+				CommonRequests.getDownloadRemoteConfigVersionMessageRequest(this));
 		fireRequestBlock(downloadConfigRequest, RequestType.GET_BUDDY_WALKED);
 		getAssetDigest();
 
@@ -310,7 +319,7 @@ private void fireRequestBlock(ServerRequest request, RequestType... exclude)
 	 */
 	public void getAssetDigest() throws RemoteServerException, CaptchaActiveException, LoginFailedException {
 		fireRequestBlock(new ServerRequest(RequestType.GET_ASSET_DIGEST,
-				CommonRequests.getGetAssetDigestMessageRequest()).exclude(RequestType.GET_BUDDY_WALKED));
+				CommonRequests.getGetAssetDigestMessageRequest(this)).exclude(RequestType.GET_BUDDY_WALKED));
 	}
 
 	/**
@@ -625,4 +634,11 @@ public void awaitChallenge() throws InterruptedException {
 	public void enqueueTask(Runnable task) {
 		heartbeat.enqueueTask(task);
 	}
+
+	/**
+	 * @return the version of the API being used
+	 */
+	public int getVersion() {
+		return hashProvider.getHashVersion();
+	}
 }

library/src/main/java/com/pokegoapi/api/inventory/Inventories.java

@@ -15,11 +15,13 @@
 
 package com.pokegoapi.api.inventory;
 
+import POGOProtos.Data.PokemonDataOuterClass.PokemonData;
 import POGOProtos.Enums.PokemonFamilyIdOuterClass;
 import POGOProtos.Enums.PokemonIdOuterClass.PokemonId;
 import POGOProtos.Inventory.AppliedItemOuterClass.AppliedItem;
 import POGOProtos.Inventory.AppliedItemsOuterClass.AppliedItems;
 import POGOProtos.Inventory.EggIncubatorOuterClass;
+import POGOProtos.Inventory.EggIncubatorsOuterClass.EggIncubators;
 import POGOProtos.Inventory.InventoryItemDataOuterClass;
 import POGOProtos.Inventory.InventoryItemOuterClass;
 import POGOProtos.Inventory.Item.ItemDataOuterClass.ItemData;
@@ -146,12 +148,13 @@ public void updateInventories(GetInventoryResponse response) {
 			InventoryItemDataOuterClass.InventoryItemData itemData = inventoryItem.getInventoryItemData();
 
 			// hatchery
-			if (itemData.getPokemonData().getPokemonId() == PokemonId.MISSINGNO && itemData.getPokemonData().getIsEgg()) {
-				hatchery.addEgg(new EggPokemon(itemData.getPokemonData()));
+			PokemonData pokemonData = itemData.getPokemonData();
+			if (pokemonData.getPokemonId() == PokemonId.MISSINGNO && pokemonData.getIsEgg()) {
+				hatchery.addEgg(new EggPokemon(pokemonData));
 			}
 
 			// pokebank
-			if (itemData.getPokemonData().getPokemonId() != PokemonId.MISSINGNO) {
+			if (pokemonData.getPokemonId() != PokemonId.MISSINGNO) {
 				pokebank.addPokemon(new Pokemon(api, inventoryItem.getInventoryItemData().getPokemonData()));
 			}
 
@@ -183,7 +186,8 @@ public void updateInventories(GetInventoryResponse response) {
 			}
 
 			if (itemData.hasEggIncubators()) {
-				for (EggIncubatorOuterClass.EggIncubator incubator : itemData.getEggIncubators().getEggIncubatorList()) {
+				EggIncubators eggIncubators = itemData.getEggIncubators();
+				for (EggIncubatorOuterClass.EggIncubator incubator : eggIncubators.getEggIncubatorList()) {
 					EggIncubator eggIncubator = new EggIncubator(api, incubator);
 					synchronized (this.lock) {
 						incubators.remove(eggIncubator);

library/src/main/java/com/pokegoapi/api/inventory/PokeBank.java

@@ -141,16 +141,16 @@ public Pokemon getPokemonById(final Long id) {
 	/**
 	 * Releases multiple pokemon in a single request
 	 *
-	 * @param pokemons the pokemon to release
+	 * @param releasePokemon the pokemon to release
 	 * @return the amount of candies for each pokemon family
 	 * @throws CaptchaActiveException if a captcha is active and a message cannot be sent
 	 * @throws LoginFailedException the login fails
 	 * @throws RemoteServerException if the server errors
 	 */
-	public Map<PokemonFamilyId, Integer> releasePokemon(Pokemon... pokemons)
+	public Map<PokemonFamilyId, Integer> releasePokemon(Pokemon... releasePokemon)
 			throws CaptchaActiveException, LoginFailedException, RemoteServerException {
 		ReleasePokemonMessage.Builder releaseBuilder = ReleasePokemonMessage.newBuilder();
-		for (Pokemon pokemon : pokemons) {
+		for (Pokemon pokemon : releasePokemon) {
 			if (!pokemon.isDeployed()) {
 				releaseBuilder.addPokemonIds(pokemon.getId());
 			}
@@ -167,6 +167,14 @@ public Map<PokemonFamilyId, Integer> releasePokemon(Pokemon... pokemons)
 			ReleasePokemonResponse releaseResponse = ReleasePokemonResponse.parseFrom(releaseRequest.getData());
 			Map<PokemonFamilyId, Integer> candyCount = new HashMap<>();
 			if (releaseResponse.getResult() == Result.SUCCESS && inventoryResponse.getSuccess()) {
+				synchronized (this.lock) {
+					for (Pokemon pokemon : releasePokemon) {
+						this.pokemons.remove(pokemon);
+					}
+				}
+				for (Pokemon pokemon : releasePokemon) {
+					api.getInventories().getPokebank().removePokemon(pokemon);
+				}
 				List<InventoryItem> items = inventoryResponse.getInventoryDelta().getInventoryItemsList();
 				for (InventoryItem item : items) {
 					InventoryItemData data = item.getInventoryItemData();

library/src/main/java/com/pokegoapi/api/pokemon/Pokemon.java

@@ -185,7 +185,7 @@ public boolean canPowerUp() {
 	 *
 	 * @param considerMaxCPLimitForPlayerLevel Consider max cp limit for actual player level
 	 * @return the boolean
-	 * @throws NoSuchItemException   If the PokemonId value cannot be found in the {@link PokemonMetaRegistry}.
+	 * @throws NoSuchItemException   If the PokemonId value cannot be found in the {@link com.pokegoapi.main.PokemonMeta}.
 	 */
 	public boolean canPowerUp(boolean considerMaxCPLimitForPlayerLevel)
 			throws NoSuchItemException {
@@ -464,4 +464,14 @@ public int getCPInPercentageMaxPlayerLevel() throws NoSuchItemException {
 	public double getIvInPercentage() {
 		return ((Math.floor((this.getIvRatio() * 100) * 100)) / 100);
 	}
+
+	@Override
+	public int hashCode() {
+		return (int) getId();
+	}
+
+	@Override
+	public boolean equals(Object obj) {
+		return obj instanceof Pokemon && ((Pokemon) obj).getId() == getId();
+	}
 }

library/src/main/java/com/pokegoapi/exceptions/hash/HashException.java

@@ -0,0 +1,34 @@
+/*
+ *     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.exceptions.hash;
+
+public class HashException extends Exception {
+	public HashException() {
+		super();
+	}
+
+	public HashException(String reason) {
+		super(reason);
+	}
+
+	public HashException(Throwable exception) {
+		super(exception);
+	}
+
+	public HashException(String reason, Throwable exception) {
+		super(reason, exception);
+	}
+}

library/src/main/java/com/pokegoapi/util/Constant.java renamed to library/src/main/java/com/pokegoapi/exceptions/hash/HashLimitExceededException.java

@@ -13,14 +13,18 @@
  *     along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-package com.pokegoapi.util;
+package com.pokegoapi.exceptions.hash;
 
-/**
- * Created by iGio90 on 27/08/16.
- */
+public class HashLimitExceededException extends HashException {
+	public HashLimitExceededException() {
+		super();
+	}
 
-public class Constant {
-	public static final int APP_VERSION = 4500;
+	public HashLimitExceededException(String reason) {
+		super(reason);
+	}
 
-	public static final long UNK25 = -1553869577012279119L;
+	public HashLimitExceededException(Throwable exception) {
+		super(exception);
+	}
 }

library/src/main/java/com/pokegoapi/main/CommonRequests.java

@@ -39,7 +39,6 @@
 import com.pokegoapi.exceptions.CaptchaActiveException;
 import com.pokegoapi.exceptions.LoginFailedException;
 import com.pokegoapi.exceptions.RemoteServerException;
-import com.pokegoapi.util.Constant;
 
 import java.util.HashMap;
 import java.util.LinkedHashMap;
@@ -158,25 +157,27 @@ public void parse(PokemonGo api, ByteString data, RequestType requestType)
 	/**
 	 * Constant for repetitive usage of DownloadRemoteConfigVersionMessage request
 	 *
+	 * @param api the current API instance
 	 * @return DownloadRemoteConfigVersionMessage
 	 */
-	public static DownloadRemoteConfigVersionMessage getDownloadRemoteConfigVersionMessageRequest() {
+	public static DownloadRemoteConfigVersionMessage getDownloadRemoteConfigVersionMessageRequest(PokemonGo api) {
 		return DownloadRemoteConfigVersionMessage
 				.newBuilder()
 				.setPlatform(Platform.IOS)
-				.setAppVersion(Constant.APP_VERSION)
+				.setAppVersion(api.getVersion())
 				.build();
 	}
 
 	/**
 	 * Constant for repetitive usage of GetAssetDigestMessage request
 	 *
+	 * @param api the current API instance
 	 * @return GetAssetDigestMessage
 	 */
-	public static GetAssetDigestMessage getGetAssetDigestMessageRequest() {
+	public static GetAssetDigestMessage getGetAssetDigestMessageRequest(PokemonGo api) {
 		return GetAssetDigestMessage.newBuilder()
 				.setPlatform(Platform.IOS)
-				.setAppVersion(Constant.APP_VERSION)
+				.setAppVersion(api.getVersion())
 				.build();
 	}
 

library/src/main/java/com/pokegoapi/main/RequestHandler.java

@@ -28,6 +28,7 @@
 import com.pokegoapi.exceptions.CaptchaActiveException;
 import com.pokegoapi.exceptions.LoginFailedException;
 import com.pokegoapi.exceptions.RemoteServerException;
+import com.pokegoapi.exceptions.hash.HashException;
 import com.pokegoapi.util.AsyncHelper;
 import com.pokegoapi.util.Log;
 import com.pokegoapi.util.Signature;
@@ -177,9 +178,10 @@ public void sendServerRequests(ServerRequest... serverRequests)
 	 * @throws RemoteServerException the remote server exception
 	 * @throws LoginFailedException the login failed exception
 	 * @throws CaptchaActiveException if a captcha is active and the message can't be sent
+	 * @throws HashException if hashing fails
 	 */
 	private AuthTicket internalSendServerRequests(AuthTicket authTicket, ServerRequest... serverRequests)
-			throws RemoteServerException, CaptchaActiveException, LoginFailedException {
+			throws RemoteServerException, CaptchaActiveException, LoginFailedException, HashException {
 		AuthTicket newAuthTicket = authTicket;
 		if (serverRequests.length == 0) {
 			return authTicket;
@@ -384,7 +386,7 @@ public void run() {
 					continue;
 				}
 				continue;
-			} catch (RemoteServerException | LoginFailedException | CaptchaActiveException e) {
+			} catch (RemoteServerException | LoginFailedException | CaptchaActiveException | HashException e) {
 				for (AsyncServerRequest request : requests) {
 					resultMap.put(request.getId(), ResultOrException.getError(e));
 				}