ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

runelite-client: add hiscore manager

Browse Source
This commit is contained in:
Adam
2018-05-12 18:26:14 -04:00
parent bc2c959e7a
commit 3f55610612
2 changed files with 205 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
runelite-client/src/main/java/net/runelite/client/game/HiscoreLoader.java Normal file
View File

@@ -0,0 +1,88 @@
/*
* Copyright (c) 2018, Adam <Adam@sigterm.info>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.client.game;
import com.google.common.cache.CacheLoader;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.ListeningExecutorService;
import com.google.common.util.concurrent.MoreExecutors;
import java.io.IOException;
import java.util.concurrent.ScheduledExecutorService;
import lombok.extern.slf4j.Slf4j;
import static net.runelite.client.game.HiscoreManager.EMPTY;
import static net.runelite.client.game.HiscoreManager.NONE;
import net.runelite.http.api.hiscore.HiscoreClient;
import net.runelite.http.api.hiscore.HiscoreEndpoint;
import net.runelite.http.api.hiscore.HiscoreResult;
@Slf4j
class HiscoreLoader extends CacheLoader<HiscoreManager.HiscoreKey, HiscoreResult>
{
private final ListeningExecutorService executorService;
private final HiscoreClient hiscoreClient;
HiscoreLoader(ScheduledExecutorService executor, HiscoreClient client)
{
this.executorService = MoreExecutors.listeningDecorator(executor);
this.hiscoreClient = client;
}
@Override
public HiscoreResult load(HiscoreManager.HiscoreKey hiscoreKey) throws Exception
{
return EMPTY;
}
@Override
public ListenableFuture<HiscoreResult> reload(HiscoreManager.HiscoreKey hiscoreKey, HiscoreResult oldValue)
{
log.debug("Submitting hiscore lookup for {} type {}", hiscoreKey.getUsername(), hiscoreKey.getType());
return executorService.submit(() -> fetch(hiscoreKey));
}
private HiscoreResult fetch(HiscoreManager.HiscoreKey hiscoreKey)
{
String username = hiscoreKey.getUsername();
HiscoreEndpoint endpoint = hiscoreKey.getType();
try
{
HiscoreResult result = hiscoreClient.lookup(username, endpoint);
if (result == null)
{
return NONE;
}
return result;
}
catch (IOException ex)
{
log.warn("Unable to look up hiscore!", ex);
return NONE;
}
}
}

117
runelite-client/src/main/java/net/runelite/client/game/HiscoreManager.java Normal file
View File

@@ -0,0 +1,117 @@
/*
* Copyright (c) 2018, Adam <Adam@sigterm.info>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.client.game;
import com.google.common.cache.CacheBuilder;
import com.google.common.cache.LoadingCache;
import java.io.IOException;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import javax.inject.Inject;
import javax.inject.Singleton;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import net.runelite.api.Client;
import net.runelite.client.callback.ClientThread;
import net.runelite.http.api.hiscore.HiscoreClient;
import net.runelite.http.api.hiscore.HiscoreEndpoint;
import net.runelite.http.api.hiscore.HiscoreResult;
@Singleton
@Slf4j
public class HiscoreManager
{
@AllArgsConstructor
@Data
static class HiscoreKey
{
String username;
HiscoreEndpoint type;
}
static final HiscoreResult EMPTY = new HiscoreResult();
static final HiscoreResult NONE = new HiscoreResult();
private final HiscoreClient hiscoreClient = new HiscoreClient();
private final LoadingCache<HiscoreKey, HiscoreResult> hiscoreCache;
@Inject
public HiscoreManager(Client client, ScheduledExecutorService executor, ClientThread clientThread)
{
hiscoreCache = CacheBuilder.newBuilder()
.maximumSize(128L)
.expireAfterWrite(1, TimeUnit.HOURS)
.build(new HiscoreLoader(executor, hiscoreClient));
}
/**
* Synchronously look up a players hiscore from a specified endpoint
*
* @param username Players username
* @param endpoint Hiscore endpoint
* @return HiscoreResult or null
* @throws IOException Upon error in fetching hiscore
*/
public HiscoreResult lookup(String username, HiscoreEndpoint endpoint) throws IOException
{
HiscoreKey hiscoreKey = new HiscoreKey(username, endpoint);
HiscoreResult hiscoreResult = hiscoreCache.getIfPresent(hiscoreKey);
if (hiscoreResult != null && hiscoreResult != EMPTY)
{
return hiscoreResult == NONE ? null : hiscoreResult;
}
hiscoreResult = hiscoreClient.lookup(username, endpoint);
if (hiscoreResult == null)
{
hiscoreCache.put(hiscoreKey, NONE);
return null;
}
hiscoreCache.put(hiscoreKey, hiscoreResult);
return hiscoreResult;
}
/**
* Asynchronously look up a players hiscore from a specified endpoint
*
* @param username Players username
* @param endpoint Hiscore endpoint
* @return HiscoreResult or null
*/
public HiscoreResult lookupAsync(String username, HiscoreEndpoint endpoint)
{
HiscoreKey hiscoreKey = new HiscoreKey(username, endpoint);
HiscoreResult hiscoreResult = hiscoreCache.getIfPresent(hiscoreKey);
if (hiscoreResult != null && hiscoreResult != EMPTY)
{
return hiscoreResult == NONE ? null : hiscoreResult;
}
hiscoreCache.refresh(hiscoreKey);
return null;
}
}