mirror of
https://bitbucket.org/projectswg/pswgcommon.git
synced 2026-07-13 21:00:59 -04:00
Added customization-related structs
This commit is contained in:
Mads Boddum
@@ -0,0 +1,233 @@
|
||||
/***********************************************************************************
|
||||
* Copyright (c) 2015 /// Project SWG /// www.projectswg.com *
|
||||
* *
|
||||
* ProjectSWG is the first NGE emulator for Star Wars Galaxies founded on *
|
||||
* July 7th, 2011 after SOE announced the official shutdown of Star Wars Galaxies. *
|
||||
* Our goal is to create an emulator which will provide a server for players to *
|
||||
* continue playing a game similar to the one they used to play. We are basing *
|
||||
* it on the final publish of the game prior to end-game events. *
|
||||
* *
|
||||
* This file is part of Holocore. *
|
||||
* *
|
||||
* -------------------------------------------------------------------------------- *
|
||||
* *
|
||||
* Holocore is free software: you can redistribute it and/or modify *
|
||||
* it under the terms of the GNU Affero General Public License as *
|
||||
* published by the Free Software Foundation, either version 3 of the *
|
||||
* License, or (at your option) any later version. *
|
||||
* *
|
||||
* Holocore 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 Affero General Public License for more details. *
|
||||
* *
|
||||
* You should have received a copy of the GNU Affero General Public License *
|
||||
* along with Holocore. If not, see <http://www.gnu.org/licenses/>. *
|
||||
* *
|
||||
***********************************************************************************/
|
||||
package com.projectswg.common.data.customization;
|
||||
|
||||
import com.projectswg.common.data.swgfile.ClientFactory;
|
||||
import com.projectswg.common.data.swgfile.visitors.CustomizationIDManagerData;
|
||||
import com.projectswg.common.debug.Log;
|
||||
import com.projectswg.common.encoding.Encodable;
|
||||
import com.projectswg.common.network.NetBuffer;
|
||||
import com.projectswg.common.network.NetBufferStream;
|
||||
import com.projectswg.common.persistable.Persistable;
|
||||
|
||||
import java.io.*;
|
||||
import java.nio.ByteBuffer;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* The Customization string is used to set special properties
|
||||
* on objects. This can be lightsaber color, vehicle speed,
|
||||
* facial hair style...
|
||||
*/
|
||||
public class CustomizationString implements Encodable, Persistable {
|
||||
|
||||
private CustomizationIDManagerData table = (CustomizationIDManagerData) ClientFactory.getInfoFromFile("customization/customization_id_manager.iff");
|
||||
private Map<String, CustomizationVariable> variables; // TODO synchronize access
|
||||
|
||||
public CustomizationString() {
|
||||
variables = new LinkedHashMap<>(); // TODO concurrent implementation?
|
||||
}
|
||||
|
||||
boolean isEmpty() {
|
||||
return variables.size() <= 0;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return the amount of characters that would require escaping to be valid UTF-8
|
||||
*/
|
||||
int valuesToEscape() {
|
||||
return (int) variables.values().stream().filter(CustomizationVariable::isReserved).count();
|
||||
}
|
||||
|
||||
@Override
|
||||
public void save(NetBufferStream stream) {
|
||||
stream.addRawArray(encode()); // No length is prepended when adding a raw array
|
||||
}
|
||||
|
||||
@Override
|
||||
public void read(NetBufferStream stream) {
|
||||
decode(NetBuffer.wrap(stream.array()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Puts a new {@link CustomizationVariable} in this {@code CustomizationString}.
|
||||
* @param name is the variable to set
|
||||
* @param value is the assigned value
|
||||
* @return previously assigned {@link CustomizationVariable} value for {@code variableName}
|
||||
*/
|
||||
public CustomizationVariable put(String name, CustomizationVariable value) {
|
||||
return variables.put(name, value);
|
||||
}
|
||||
|
||||
public CustomizationVariable remove(String name) {
|
||||
return variables.remove(name);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void decode(NetBuffer data) {
|
||||
byte[] stringData = data.getArray();
|
||||
|
||||
if (stringData.length == 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
String string = new String(stringData, StandardCharsets.UTF_8);
|
||||
int[] codePoints = string.codePoints().toArray(); // Replaces 0xC3BF with 0xFF
|
||||
int position = 0;
|
||||
byte startOfText = (byte) codePoints[position++];
|
||||
|
||||
if (startOfText != 0x02) {
|
||||
// TODO malformed customization string
|
||||
return;
|
||||
}
|
||||
|
||||
short variableCount = (short) codePoints[position++];
|
||||
|
||||
for (short i = 0; i < variableCount; i++) {
|
||||
short variableId = (short) codePoints[position++];
|
||||
String variableName = table.getVariableName(variableId);
|
||||
|
||||
if (variableName == null) { // Variable ID matched no variable name.
|
||||
Log.w("Variable ID %d had no name associated", variableId);
|
||||
position++; // Skip the associated value
|
||||
continue;
|
||||
}
|
||||
|
||||
CustomizationVariable variable = new CustomizationVariable();
|
||||
|
||||
int current = codePoints[position++];
|
||||
|
||||
if (current == 0xFF) { // This marks an escaped character to follow
|
||||
int next = codePoints[position++];
|
||||
|
||||
switch (next) {
|
||||
case 0x01: // Value is 0
|
||||
variable.setValue(0);
|
||||
break;
|
||||
case 0x02: // Value is 255
|
||||
variable.setValue(0xFF);
|
||||
break;
|
||||
case 0x03: // We shouldn't be meeting an end here. Malformed input.
|
||||
// TODO unexpected end of data
|
||||
break;
|
||||
}
|
||||
} else {
|
||||
variable.setValue(current);
|
||||
}
|
||||
|
||||
variables.put(variableName, variable);
|
||||
}
|
||||
|
||||
if ((position + 2) < codePoints.length) {
|
||||
// TODO too much data remains. Must be corrupt.
|
||||
return;
|
||||
}
|
||||
|
||||
position++; // Escape should be here
|
||||
|
||||
byte endOfText = (byte) codePoints[position++];
|
||||
|
||||
if (endOfText != 0x03) {
|
||||
// TODO malformed customization string
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public byte[] encode() {
|
||||
if (isEmpty()) {
|
||||
// No need to send more than an empty array in this case
|
||||
return ByteBuffer.allocate(Short.BYTES).array();
|
||||
}
|
||||
|
||||
ByteArrayOutputStream out = new ByteArrayOutputStream();
|
||||
Writer writer = new OutputStreamWriter(out, StandardCharsets.UTF_8);
|
||||
|
||||
try {
|
||||
out.write(2); // Marks start of text
|
||||
out.write(variables.size());
|
||||
|
||||
variables.forEach((variableName, variable) -> {
|
||||
short combinedVariable = table.getVariableId(variableName);
|
||||
|
||||
try {
|
||||
writer.write(combinedVariable); // Put variable
|
||||
int value = variable.getValue();
|
||||
|
||||
switch (value) {
|
||||
case 0x00:
|
||||
writer.write(0xFF); // Escape
|
||||
writer.write(0x01); // Put variable value
|
||||
break;
|
||||
case 0xFF:
|
||||
writer.write(0xFF); // Escape
|
||||
writer.write(0x02); // Put variable value
|
||||
break;
|
||||
default:
|
||||
writer.write(value);
|
||||
break;
|
||||
}
|
||||
} catch (/*IO*/Exception e) {
|
||||
Log.e(e);
|
||||
}
|
||||
});
|
||||
|
||||
writer.write(0x0FF); // Escape
|
||||
writer.write(3); // Marks end of text
|
||||
writer.flush();
|
||||
} catch (IOException e) {
|
||||
Log.e(e);
|
||||
}
|
||||
|
||||
byte[] result = out.toByteArray();
|
||||
NetBuffer data = NetBuffer.allocate(Short.BYTES + result.length);
|
||||
|
||||
data.addArray(result); // This will add the array length in little endian order
|
||||
|
||||
return data.array();
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getLength() {
|
||||
if (isEmpty()) {
|
||||
// No need to send more than an empty array in this case
|
||||
return Short.BYTES;
|
||||
}
|
||||
|
||||
// TODO below doesn't give a correct calculation
|
||||
|
||||
int length = Short.BYTES + 4 + variables.size() * 2; // Size, version, variable count, an escaped end-marker and variable ID times amount
|
||||
|
||||
length += valuesToEscape() * 2; // Escape characters add +1 to length each
|
||||
|
||||
return length;
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user