Thread: [PI] Server-Sided Cache Loading

Too many people are still using that worldmap.bin thing that Martin released like 2 years ago or something.
People who are using it mention it and there is always that person who tells them "Just load the cache from the server," but things just haven't changed.

Spoiler for Random bullshit:

Anyway, today I was lurking the snippets board like I normally do, just to look for something that I could put to use that I haven't thought of, or something that I'm too lazy to do myself, and found this.

[Only registered and activated users can see links. ]

This caught my attention, cause I was playing with doors.cfg, and after a while, I got extremely frustrated and gave up. I now hate all doors, in both rsps and irl.

At the end of the OP, I saw the SVN links to Graham's region and cache packages from his Hyperion base. I instantly thought of server sided cache loading, and decided to get to work.

Eventually I was able to get the cache loading fully functional for my PI server, but I wasn't able to get as much use out of it as I hoped I would (It won't load my cache correctly...), so I figured I would just release it.

Difficulty: 4? / 10
You gotta be able to add directories to your compiler and add libraries to your server runner and compiler. I've never had to do this before, so the difficulty is based off of my assumption that at least 1/4th the people who work with PI haven't either.

Classes Modified:
server.world.WorldMap.java

You are also going to be adding a lot of classes that are small modifications of classes from Hyperion.

While you are extracing any zip files, make sure you are extracting them correctly.
To be safe, simply drag the folder inside the archive into the directed location.








Step 1: Downloading and adding the cache

Download this file.
[Only registered and activated users can see links. ]

Spoiler for More shit:

This is the cache that was being loaded from the Hyperion server in the SVN.
This is the only cache, among the ones that I tried, that worked.
It did not load my cache, or PJA's 453 cache without failing.
You might want to try your's anyway. If it works, then use it instead.

Extract the folder into your Data folder. You can find it in the same location as the batch file that runs your server.







Step 2: Adding the necessary library

Download this library.
[Only registered and activated users can see links. ]

Drag that into your deps folder. You can find it in the same location as the Data folder.







Step 3: Adding the cache package

Download this package.
[Only registered and activated users can see links. ]

Drag the folder inside this archive into src.server. This is the same folder that has your Server.java and Config.java in it.







Step 4: Adding the region package

Download this package.
[Only registered and activated users can see links. ]

Drag the folder inside this archive into src.server.world. This is the same folder that has your WorldMap.java in it.







Step 5: Adding the background runner class

Create a new java file titled BlockingExecutorService.java, paste the following code into it, and save it in the src.server.util folder.

Code:

package server.util;

import java.util.Collection;
import java.util.List;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

/**
 * An <code>ExecutorService</code> that waits for all its events to finish
 * executing.
 * @author Graham Edgecombe
 *
 */
public class BlockingExecutorService implements ExecutorService {
	
	/**
	 * The service backing this service.
	 */
	private ExecutorService service;
	
	/**
	 * A list of pending tasks.
	 */
	private BlockingQueue<Future<?>> pendingTasks = new LinkedBlockingQueue<Future<?>>();
	
	/**
	 * Creates the executor service.
	 * @param service The service backing this service.
	 */
	public BlockingExecutorService(ExecutorService service) {
		this.service = service;
	}
	
	/**
	 * Waits for pending tasks to complete.
	 * @throws ExecutionException if an error in a task occurred.
	 */
	public void waitForPendingTasks() throws ExecutionException {
		while(pendingTasks.size() > 0) {
			if(isShutdown()) {
				return;
			}
			try {
				pendingTasks.take().get();
			} catch(InterruptedException e) {
				continue;
			}
		}
	}
	
	/**
	 * Gets the number of pending tasks.
	 * @return The number of pending tasks.
	 */
	public int getPendingTaskAmount() {
		return pendingTasks.size();
	}

	@Override
	public boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException {
		return service.awaitTermination(timeout, unit);
	}

	@Override
	public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks) throws InterruptedException {
		List<Future<T>> futures = service.invokeAll(tasks);
		for(Future<?> future : futures) {
			pendingTasks.add(future);
		}
		return futures;
	}

	@Override
	public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) throws InterruptedException {
		List<Future<T>> futures = service.invokeAll(tasks, timeout, unit);
		for(Future<?> future : futures) {
			pendingTasks.add(future);
		}
		return futures;
	}

	@Override
	public <T> T invokeAny(Collection<? extends Callable<T>> tasks) throws InterruptedException, ExecutionException {
		return service.invokeAny(tasks);
	}

	@Override
	public <T> T invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException {
		return service.invokeAny(tasks, timeout, unit);
	}

	@Override
	public boolean isShutdown() {
		return service.isShutdown();
	}

	@Override
	public boolean isTerminated() {
		return service.isTerminated();
	}

	@Override
	public void shutdown() {
		service.shutdown();
	}

	@Override
	public List<Runnable> shutdownNow() {
		return service.shutdownNow();
	}

	@Override
	public <T> Future<T> submit(Callable<T> task) {
		Future<T> future = service.submit(task);
		pendingTasks.add(future);
		return future;
	}

	@Override
	public Future<?> submit(Runnable task) {
		Future<?> future = service.submit(task);
		pendingTasks.add(future);
		return future;
	}

	@Override
	public <T> Future<T> submit(Runnable task, T result) {
		Future<T> future = service.submit(task, result);
		pendingTasks.add(future);
		return future;
	}

	@Override
	public void execute(Runnable command) {
		service.execute(command);
	}

}

Step 6: Modifying your WorldMap class

Open up src.server.world.WorldMap.java

Add these four imports to the class.

Code:

import java.util.concurrent.Callable;
import java.util.concurrent.Executors;
import server.cache.model.ObjectManager;
import server.util.BlockingExecutorService;
import server.world.GameObject;

Replace this line...

Code:

GameObject go = new GameObject(objectId, objectType, objectX, objectY, objectFace);

...With this one...

Code:

GameObject go = new GameObject(objectId, objectType, objectX, objectY, objectHeight, objectFace);

Right below this line...

Code:

public final class WorldMap {

...Paste this...

Code:

public static int getObjectType(int x, int y) {
		GameObject go = gameObjects.get(y + (x << 16));
		if (go != null && go.x() == x && go.y() == y) {
			return go.type();
		}
		return -1;
	}
	
	private BlockingExecutorService backgroundLoader = new BlockingExecutorService(Executors.newSingleThreadExecutor());
	
	public BlockingExecutorService getBackgroundLoader() {
		return backgroundLoader;
	}
	
	private static final WorldMap worldMap = new WorldMap();
	private ObjectManager objectManager;
	
	public static WorldMap getWorld() {
		return worldMap;
	}
	
	public WorldMap() {
		backgroundLoader.submit(new Callable<Object>() {
			@Override
			public Object call() throws Exception {
				objectManager = new ObjectManager();
				objectManager.load();
				return null;
			}
		});
	}	
	
	public static void addObject(int id, int x, int y, int height, int type, int face) {
		//System.out.println("Adding clipped object.");
		GameObject go = new GameObject(id, type, x, y, height, face);
		if (go.type() != 0) {
			gameObjects.put(go.y() + (go.x() << 16), go);
		}
	}

The only thing I wrote in the above code was the getObjectType variable. This variable returns the type of object that exists in the coords given. If there isn't an object at the given coords, it returns -1.







Step 7: Modifying the GameObject class

Open up src.server.world.GameObject.java, and replace the entire class with this...

Code:

package server.world;

public final class GameObject {
    private int id;
    private int type;
    private int x;
    private int y;
	private int height;
    private int face;

    public GameObject(int id, int type, int x, int y, int height, int face) {
        this.id = id;
        this.type = type;
        this.x = x;
        this.y = y;
		this.height = height;
        this.face = face;
    }

    public int id() {
        return id;
    }

    public int type() {
        return type;
    }

    public int x() {
        return x;
    }

    public int y() {
        return y;
    }
	
	public int height() {
        return height;
    }

	public int getFace() {
		return face;
	}
}

Step 8: Calling the cache loader on server startup

Open up Server.java, and below this line...

Code:

public static void main(java.lang.String args[]) throws NullPointerException, IOException {

...Paste this...

Code:

WorldMap.getWorld();

If you get an error that says "Cannot find symbol WorldMap" or something, add the following import to your Server.java...

Code:

import server.world.WorldMap;

Step 9: Modifying your compiler and server runner
Final step yay

Add the following paths into your Build.bat/Compiler.bat...

Code:

src\server\cache\*.java src\server\world\region\*.java src\server\cache\index\*.java src\server\cache\index\impl\*.java src\server\cache\model\*.java src\server\cache\map\*.java src\server\cache\obj\*.java src\server\cache\util\*.java

Add the following library to your Run.bat/Start Server.bat and your Build.bat/Compiler.bat...

Code:

deps/commons-compress-1.0.jar;

I am not going to make this any clearer.
If you look at it for like 5 minutes you should be able to figure it out.
I don't even like batch files because paths and libraries all need to be jam packed into one line, and when you have word wrap on, it's barely readable.
If you don't already know how to add libraries and paths to batch files, then good luck.







And that should be it.
It is 7.30 AM right now and I've been up all night, so I am tired and possibly forgot something.
Post any compiling errors or issues you come across.
I am like 95% sure I didn't forget anything though.
Please note that even though this can definitely be used for clipping, it does not actually clip for you. That part you should be able to do yourself, with a little experimentation.
If there are any classes that are included in the downloads that can be removed without any compiling errors/cache loading errors, let me know.


Credits:
95% to Graham and any other programmers who helped with Hyperion
5% to me for making it work with Project Insanity servers >.>