3.5.0 (#25)

* Heartbeat and SystemManager overhaul

* Asteroids, black holes, and mines now have their own classes; Consoles report how they can be claimed, you can send a Collection of packets, fixed a bug in the HeartbeatManager, blocks attempt to send a packet via an ArtemisNetworkInterface that isn't running; Ship now has a clone constructor; bases now handle their pitch, roll, and heading properties; fixed a bug when sending ArtemisPlayer objects; fixed a bug in retrieving a Vessel's torpedo tubes, added constructors for bases, players, and NPCs that will auto-populate some fields based on a Vessel or Ship; unknown properties can now be read or set individually; moved the side property to ArtemisShielded rather than BaseArtemisShip (so now bases have a side); fixed a concurrency issue with World;

* Fixed a bug in base side parsing

* Made certain parsing errors non-fatal

* Minor comment tweaks

* Made timeout more generous on ThreadedArtemisNetworkInterfaceTest to address false positives

* System grid overhaul

* ProxyDemo doesn't send duplicate heartbeat packets anymore

* Pushed getVisibility() up to ArtemisObject

* Minor tweaks

* Updated documentation

* Anomaly types now have human-readable names

* Reworked ENEMY or OTHER detection to use sides first

* Updated scan handling, added getNameString(), removed isEnemy(), tag support, WorldListeners

* Fixed #9

* Fixed #24

* Fixed problem with computing fractional positions between grid points

* BiomechRagePacket and TensionPacket

* PausePacket now uses a simple boolean rather than a BoolState

* ServerDiscoveryResponder now reports username for host like Artemis does

* Added BoolState.toValue()

* Fixed problems with Grid updates losing data

* Code cleanup and documentation

* ArtemisOrientable now extends ArtemisObject

* ArtemisShielded now extends ArtemisOrientable

* Fixed problem with improper undock detection

* Added callsign extraction, getVessel() won't NPE if passed null Context

* Updated tests

* Fixed incorrect BeamFiredPacket parsing

* Added <distributionManagement>

* Renamed HOMING to TORPEDO to match terminology change in the game

* Improved documentation and toString()s

* Fixed copyNodes() bug that created inaccurate copies

* Fixed error in comment

Author: rjwut

CONTRIBUTING.md

@@ -1,10 +1,10 @@
 You want to contribute to IAN's development? That's awesome! 👍 Here's some information about how to best help:
 
 ### Report a bug or missing feature
-[Check to see if I already know about it.](https://github.com/rjwut/ian/issues) If not, [submit a new issue](https://github.com/rjwut/ian/issues/new). Be sure to include any relevant details. For example, a bug report should include 1) what you expected to happen 2) what actually happened, 3) a complete list of steps to reproduce the error, and 4) any error message you received (especially stack traces).
+[Check to see if I already know about it.](https://github.com/rjwut/ian/issues) If not, [submit a new issue](https://github.com/rjwut/ian/issues/new). Be sure to include any relevant details. For example, a bug report should include 1) a list of the specific steps which led to the error, 2) what you expected to happen, 3) what actually happened, 4) any error message you received (especially stack traces), and 5) any other information you believe would be helpful.
 
 ### Improve our knowledge of the Artemis protocol
 If you're handy with a packet sniffer, you can be of great use helping us [document the Artemis protocol](https://github.com/artemis-nerds/protocol-docs). Create issues on that project with any information you discover (or, if you know HTML, you can submit a pull request on the documentation itself). Improvements to the protocol documentation are eventually implemented in IAN.
 
 ### Implement a feature or fix a bug
-Are you a Java developer? Feel free to implement a feature or bug fix for IAN yourself! Fork the repository, apply the changes to your copy, then submit a pull request. Note that we're trying to improve our testing coverage, so including unit tests would be appreciated.
+Are you a Java developer? Feel free to implement a feature or bug fix for IAN yourself! Fork the repository, apply the changes to your copy, then submit a pull request. Note, however, that any one version of IAN targets a specific version of *Artemis*, so be sure you aren't writing something that will be incompatible with the targeted version.

README.md

@@ -1,8 +1,10 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.walkertribe</groupId>
 	<artifactId>ian</artifactId>
-	<version>3.4.0</version>
+	<version>3.5.0</version>
 	<name>Interface for Artemis Networking (IAN)</name>
 	<description>UNOFFICIAL Java library for communicating with Artemis Spaceship Bridge Simulator servers and clients.</description>
 	<url>https://github.com/rjwut/ian</url>
@@ -25,6 +27,13 @@
 		<url>https://github.com/rjwut/ian</url>
 		<connection>scm:git:git://github.com/rjwut/ian.git</connection>
 	</scm>
+	<distributionManagement>
+		<repository>
+			<id>github</id>
+			<name>GitHub Packages</name>
+			<url>https://maven.pkg.github.com/rjwut/ian</url>
+		</repository>
+	</distributionManagement>
 	<properties>
 		<maven.compiler.source>1.7</maven.compiler.source>
 		<maven.compiler.target>1.7</maven.compiler.target>

pom.xml

@@ -1,8 +1,8 @@
 package com.walkertribe.ian;
 
 import com.walkertribe.ian.model.Model;
+import com.walkertribe.ian.util.Grid;
 import com.walkertribe.ian.vesseldata.VesselData;
-import com.walkertribe.ian.vesseldata.VesselInternals;
 
 /**
  * Interface for classes which can return Artemis resources.
@@ -22,8 +22,8 @@ public interface Context {
 	public Model getModel(String dxsPaths);
 
 	/**
-	 * Given the path to an .snt file, returns a VesselInternals object that
-	 * describes the node grid stored in that file.
+	 * Given the path to an .snt file, returns a Grid object that describes the
+	 * node nodes stored in that file. Grids returned by this method are locked.
 	 */
-	public VesselInternals getInternals(String sntPath);
+	public Grid getGrid(String sntPath);
 }

src/main/java/com/walkertribe/ian/Context.java

@@ -1,7 +1,9 @@
 package com.walkertribe.ian;
 
+import java.io.BufferedInputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.OutputStream;
 import java.net.MalformedURLException;
 import java.util.HashMap;
 import java.util.Map;
@@ -15,22 +17,31 @@
 import org.xml.sax.XMLReader;
 import org.xml.sax.helpers.DefaultHandler;
 
+import com.walkertribe.ian.enums.ShipSystem;
 import com.walkertribe.ian.model.Model;
 import com.walkertribe.ian.model.SAXModelHandler;
+import com.walkertribe.ian.util.ByteArrayReader;
+import com.walkertribe.ian.util.Grid;
+import com.walkertribe.ian.util.GridCoord;
+import com.walkertribe.ian.util.GridNode;
 import com.walkertribe.ian.vesseldata.SAXVesselDataHandler;
 import com.walkertribe.ian.vesseldata.VesselData;
-import com.walkertribe.ian.vesseldata.VesselInternals;
 
 /**
  * Context implementation that loads resources from a path using a provided
  * PathResolver, and caches the results.
  * @author rjwut
  */
 public class DefaultContext implements Context {
+    private static final int EMPTY_NODE_VALUE = -2;
+    private static final int HALLWAY_NODE_VALUE = -1;
+    private static final int BLOCK_SIZE = 32;
+    private static final byte[] RESERVED = new byte[16];
+
 	private PathResolver pathResolver;
 	private VesselData vesselData;
 	private Map<String, Model> modelMap = new HashMap<String, Model>();
-	private Map<String, VesselInternals> internalsMap = new HashMap<String, VesselInternals>();
+	private Map<String, Grid> gridMap = new HashMap<String, Grid>();
 
 	/**
 	 * Creates a new Context using the given PathResolver.
@@ -82,20 +93,55 @@ public Model getModel(String dxsPaths) {
 	}
 
 	/**
-	 * Given the path to an .snt file, returns a VesselInternals object that
-	 * describes the node grid stored in that file. The VesselInternals will be
-	 * cached in this object, and the cached VesselInternals will be used for
+	 * Given the path to an .snt file, returns a Grid object that describes the node nodes stored in
+	 * that file. The Grid will be cached in this object, and the cached Grid will be used for
 	 * subsequent requests for the same .snt file.
 	 */
-	public VesselInternals getInternals(String sntPath) {
-		VesselInternals internals = internalsMap.get(sntPath);
+	public Grid getGrid(String sntPath) {
+		Grid grid = gridMap.get(sntPath);
 
-		if (internals == null) {
-			internals = loadInternals(sntPath);
-			internalsMap.put(sntPath, internals);
+		if (grid == null) {
+			grid = readSnt(sntPath);
+			gridMap.put(sntPath, grid);
 		}
 
-		return internals;
+		return grid;
+	}
+
+	/**
+	 * Outputs the given Grid as an .snt file. An IllegalStateException will be thrown if any node
+	 * is encountered which doesn't contain the required information.
+	 */
+	public void writeSnt(Grid grid, OutputStream out) throws IOException {
+	    final byte[] buffer = new byte[4];
+
+	    for (int x = 0; x < GridCoord.MAX_X; x++) {
+            for (int y = 0; y < GridCoord.MAX_X; y++) {
+                for (int z = 0; z < GridCoord.MAX_X; z++) {
+                    GridCoord coord = GridCoord.get(x, y, z);
+                    writeFloat(buffer, out, coord.x());
+                    writeFloat(buffer, out, coord.y());
+                    writeFloat(buffer, out, coord.z());
+                    GridNode node = grid.getNode(coord);
+                    int type;
+
+                    if (node == null || !node.isAccessible()) {
+                        type = EMPTY_NODE_VALUE;
+                    } else {
+                        ShipSystem system = node.getSystem();
+
+                        if (system == null) {
+                            type = HALLWAY_NODE_VALUE;
+                        } else {
+                            type = system.ordinal();
+                        }
+                    }
+
+                    writeInt(buffer, out, type);
+                    out.write(RESERVED);
+                }
+            }
+        }
 	}
 
 	/**
@@ -125,14 +171,55 @@ private Model loadModel(String dxsPaths) {
 	}
 
 	/**
-	 * Creates and returns a VesselInternals object loaded from the indicated
-	 * .snt file.
+	 * Creates and returns a Grid object loaded from the indicated .snt file.
 	 */
-	private VesselInternals loadInternals(String sntPath) {
+	private Grid readSnt(String sntPath) {
 		InputStream in = null;
 
 		try {
-			return new VesselInternals(pathResolver.get(sntPath));
+		    in = pathResolver.get(sntPath);
+
+		    if (!(in instanceof BufferedInputStream)) {
+	            in = new BufferedInputStream(in);
+	        }
+
+		    byte[] buffer = new byte[BLOCK_SIZE];
+		    final ShipSystem[] systems = ShipSystem.values();
+		    Grid grid = new Grid();
+
+	        try {
+	            for (int x = 0; x < GridCoord.MAX_X; x++) {
+	                for (int y = 0; y < GridCoord.MAX_Y; y++) {
+	                    for (int z = 0; z < GridCoord.MAX_Z; z++) {
+	                        GridCoord coords = GridCoord.get(x, y, z);
+	                        ByteArrayReader.readBytes(in, BLOCK_SIZE, buffer);
+	                        ByteArrayReader reader = new ByteArrayReader(buffer);
+	                        float shipX = reader.readFloat();
+	                        float shipY = reader.readFloat();
+	                        float shipZ = reader.readFloat();
+	                        int type = reader.readInt();
+	                        GridNode node;
+
+	                        if (type == EMPTY_NODE_VALUE) {
+	                            node = new GridNode(grid, coords, shipX, shipY, shipZ, false);
+	                        } else if (type == HALLWAY_NODE_VALUE) {
+                                node = new GridNode(grid, coords, shipX, shipY, shipZ, true);
+	                        } else {
+                                node = new GridNode(grid, coords, shipX, shipY, shipZ, systems[type]);
+	                        }
+
+	                        grid.setNode(node);
+	                    }
+	                }
+	            }
+
+	            grid.lock();
+	            return grid;
+	        } catch (InterruptedException ex) {
+	            throw new RuntimeException(ex);
+	        } catch (IOException ex) {
+	            throw new RuntimeException(ex);
+	        }
 		} catch (MalformedURLException ex) {
 			throw new RuntimeException(ex);
 		} catch (IOException ex) {
@@ -168,4 +255,22 @@ private void parseXml(String path, DefaultHandler handler) {
 			throw new RuntimeException(ex);
 		}
 	}
+
+    /**
+     * Writes a float value to the given OutputStream.
+     */
+    private static void writeFloat(byte[] buffer, OutputStream out, float v) throws IOException {
+        writeInt(buffer, out, Float.floatToRawIntBits(v));
+    }
+
+    /**
+     * Writes an int value to the given OutputStream.
+     */
+    private static void writeInt(byte[] buffer, OutputStream out, int v) throws IOException {
+        buffer[0] = (byte) (0xff & v);
+        buffer[1] = (byte) (0xff & (v >> 8));
+        buffer[2] = (byte) (0xff & (v >> 16));
+        buffer[3] = (byte) (0xff & (v >> 24));
+        out.write(buffer, 0, 4);
+    }
 }

src/main/java/com/walkertribe/ian/DefaultContext.java

@@ -5,24 +5,26 @@
  * @author rjwut
  */
 public enum AnomalyType {
-	HIDENS_POWER_CELL(Upgrade.HIDENS_POWER_CELL),
-	VIGORANIUM_NODULE(Upgrade.VIGORANIUM_NODULE),
-	CETROCITE_HEATSINKS(Upgrade.CETROCITE_HEATSINKS),
-	LATERAL_ARRAY(Upgrade.LATERAL_ARRAY),
-	TAURON_FOCUSERS(Upgrade.TAURON_FOCUSERS),
-	INFUSION_P_COILS(Upgrade.INFUSION_P_COILS),
-	CARPACTION_COILS(Upgrade.CARPACTION_COILS),
-	SECRET_CODE_CASE(Upgrade.SECRET_CODE_CASE),
-	BEACON,
-	SPACE_JUNK;
+	HIDENS_POWER_CELL("HiDens Power Cell", Upgrade.HIDENS_POWER_CELL),
+	VIGORANIUM_NODULE("Vigoranium Nodule", Upgrade.VIGORANIUM_NODULE),
+	CETROCITE_HEATSINKS("Cetrocite Crystal", Upgrade.CETROCITE_HEATSINKS),
+	LATERAL_ARRAY("Lateral Array", Upgrade.LATERAL_ARRAY),
+	TAURON_FOCUSERS("Tauron Focusers", Upgrade.TAURON_FOCUSERS),
+	INFUSION_P_COILS("Infusion P-Coils", Upgrade.INFUSION_P_COILS),
+	CARPACTION_COILS("Carapaction Coils", Upgrade.CARPACTION_COILS),
+	SECRET_CODE_CASE("Secret Code Case", Upgrade.SECRET_CODE_CASE),
+	BEACON("Beacon"),
+	SPACE_JUNK("Space Junk");
 
+    private String name;
 	private Upgrade mUpgrade;
 
-	private AnomalyType() {
-		// for beacons and space junk
+	private AnomalyType(String name) {
+	    this.name = name;
 	}
 
-	private AnomalyType(Upgrade upgrade) {
+	private AnomalyType(String name, Upgrade upgrade) {
+	    this(name);
 		mUpgrade = upgrade;
 	}
 
@@ -33,4 +35,9 @@ private AnomalyType(Upgrade upgrade) {
 	public Upgrade getUpgrade() {
 		return mUpgrade;
 	}
+
+	@Override
+	public String toString() {
+	    return name;
+	}
 }

src/main/java/com/walkertribe/ian/enums/AnomalyType.java

@@ -1,13 +1,14 @@
 package com.walkertribe.ian.enums;
 
 import com.walkertribe.ian.Context;
-import com.walkertribe.ian.util.BoolState;
+import com.walkertribe.ian.vesseldata.Faction;
 import com.walkertribe.ian.vesseldata.Vessel;
 import com.walkertribe.ian.world.ArtemisNpc;
 import com.walkertribe.ian.world.ArtemisObject;
+import com.walkertribe.ian.world.ArtemisPlayer;
 
 /**
- * The types of ArtemisObjects to which players can send COMMs messages. 
+ * The types of ArtemisObjects to which players can send COMMs messages.
  * @author rjwut
  */
 public enum CommsRecipientType {
@@ -49,27 +50,42 @@ public CommsMessage messageFromId(int id) {
 	};
 
 	/**
-	 * Returns the CommsRecipientType that corresponds to the given
-	 * ArtemisObject; or null if the object in question cannot receive COMMs
-	 * messages.
+	 * Returns the CommsRecipientType that corresponds to the given ArtemisObject;
+	 * or null if the object in question cannot receive COMMs messages. In the
+	 * case of an NPC, the CommsRecipient type might be ENEMY or OTHER; which one
+	 * is determined by checking to see if they are on the same side as the
+	 * player. In the rare case that one or both of the sides are unknown, it will
+	 * fall back on using the Context to retrieve the NPC's faction and checking
+	 * see if it has the ENEMY attribute. If neither method works, fromObject()
+	 * throw an IllegalStateException.
 	 */
-	public static CommsRecipientType fromObject(ArtemisObject obj, Context ctx) {
-		ObjectType type = obj.getType();
+	public static CommsRecipientType fromObject(ArtemisPlayer sender, ArtemisObject recipient, Context ctx) {
+		ObjectType type = recipient.getType();
 
 		switch (type) {
 		case PLAYER_SHIP:
 			return PLAYER;
 		case BASE:
 			return BASE;
 		case NPC_SHIP:
-			ArtemisNpc npc = (ArtemisNpc) obj;
-			Vessel vessel = npc.getVessel(ctx);
-			boolean enemy;
+			ArtemisNpc npc = (ArtemisNpc) recipient;
+			Boolean enemy = null;
+			byte senderSide = sender.getSide();
+			byte recipientSide = npc.getSide();
 
-			if (vessel != null) {
-				enemy = vessel.getFaction().is(FactionAttribute.ENEMY);
-			} else {
-				enemy = BoolState.safeValue(npc.isEnemy());
+			if (senderSide != -1 && recipientSide != -1) {
+			    enemy = senderSide != recipientSide;
+			} else if (ctx != null) {
+	            Vessel vessel = npc.getVessel(ctx);
+	            Faction faction = vessel.getFaction();
+
+	            if (faction != null) {
+	                enemy = faction.is(FactionAttribute.ENEMY);
+	            }
+			}
+
+			if (enemy == null) {
+			    throw new IllegalStateException("Cannot determine if recipient is enemy");
 			}
 
 			return enemy ? ENEMY : OTHER;
@@ -82,4 +98,4 @@ public static CommsRecipientType fromObject(ArtemisObject obj, Context ctx) {
 	 * Returns the CommsMessage value that corresponds to the given message ID.
 	 */
 	public abstract CommsMessage messageFromId(int id);
-}
+}