Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
cn.nukkit.nbt.NBTIO Maven / Gradle / Ivy
package cn.nukkit.nbt;
import cn.nukkit.api.PowerNukkitDifference;
import cn.nukkit.api.PowerNukkitXDifference;
import cn.nukkit.api.PowerNukkitXOnly;
import cn.nukkit.api.Since;
import cn.nukkit.block.Block;
import cn.nukkit.block.BlockUnknown;
import cn.nukkit.block.customblock.CustomBlock;
import cn.nukkit.blockproperty.*;
import cn.nukkit.blockproperty.exception.BlockPropertyNotFoundException;
import cn.nukkit.blockstate.BlockState;
import cn.nukkit.blockstate.BlockStateRegistry;
import cn.nukkit.item.Item;
import cn.nukkit.item.ItemID;
import cn.nukkit.nbt.stream.FastByteArrayOutputStream;
import cn.nukkit.nbt.stream.NBTInputStream;
import cn.nukkit.nbt.stream.NBTOutputStream;
import cn.nukkit.nbt.stream.PGZIPOutputStream;
import cn.nukkit.nbt.tag.CompoundTag;
import cn.nukkit.nbt.tag.Tag;
import cn.nukkit.utils.ThreadCache;
import lombok.extern.log4j.Log4j2;
import org.jetbrains.annotations.NotNull;
import java.io.*;
import java.nio.ByteOrder;
import java.nio.file.Files;
import java.nio.file.StandardCopyOption;
import java.util.Collection;
import java.util.NoSuchElementException;
import java.util.TreeMap;
import java.util.zip.Deflater;
import java.util.zip.DeflaterOutputStream;
import java.util.zip.GZIPInputStream;
/**
* A Named Binary Tag library for Nukkit Project
*/
@PowerNukkitDifference(since = "1.4.0.0-PN", info = "Fixed resource leaks")
@PowerNukkitDifference(since = "1.4.0.0-PN", info = "It's the caller responsibility to close the provided streams")
@PowerNukkitDifference(since = "1.4.0.0-PN", info = "Fixed output streams not being finished correctly")
@PowerNukkitDifference(since = "1.4.0.0-PN", info = "Added defensive close invocations to byte array streams")
@Log4j2
public class NBTIO {
public static CompoundTag putItemHelper(Item item) {
return putItemHelper(item, null);
}
public static CompoundTag putItemHelper(Item item, Integer slot) {
CompoundTag tag = new CompoundTag((String) null)
.putByte("Count", item.getCount())
.putShort("Damage", item.getDamage());
int id = item.getId();
if (id == ItemID.STRING_IDENTIFIED_ITEM || Block.ID_TO_CUSTOM_BLOCK.containsKey(255 - id)) {
tag.putString("Name", item.getNamespaceId());
} else {
tag.putShort("id", item.getId());
}
if (slot != null) {
tag.putByte("Slot", slot);
}
if (item.hasCompoundTag()) {
tag.putCompound("tag", item.getNamedTag());
}
return tag;
}
@PowerNukkitXDifference(info = "not limit name and id because the return value of fromString not null")
public static Item getItemHelper(CompoundTag tag) {
if (!tag.containsByte("Count")) {
return Item.get(0);
}
int damage = !tag.containsShort("Damage") ? 0 : tag.getShort("Damage");
int amount = tag.getByte("Count");
Item item;
if (tag.containsShort("id")) {
int id = (short) tag.getShort("id");
item = fixWoolItem(id, damage, amount);
if (item == null) {
try {
item = Item.get(id, damage, amount);
} catch (Exception e) {
item = Item.fromString(tag.getString("id"));
if (item.getDamage() == 0) {
item.setDamage(damage);
}
item.setCount(amount);
}
}
} else {
item = Item.fromString(tag.getString("Name"));
if (item.getDamage() == 0) {
item.setDamage(damage);
}
item.setCount(amount);
}
Tag tagTag = tag.get("tag");
if (tagTag instanceof CompoundTag compoundTag) {
item.setNamedTag(compoundTag);
}
return item;
}
@PowerNukkitXOnly
@Since("1.19.60-r1")
public static CompoundTag putBlockHelper(Block block) {
return putBlockHelper(block, "Block");
}
@PowerNukkitXOnly
@Since("1.19.80-r3")
public static CompoundTag putBlockHelper(Block block, String nbtName) {
String[] states = BlockStateRegistry.getKnownBlockStateIdByRuntimeId(block.getRuntimeId()).split(";");
CompoundTag result = new CompoundTag(nbtName).putString("name", states[0]);
var nbt = new CompoundTag("", new TreeMap<>());
if (block instanceof CustomBlock) {
for (var str : block.getProperties().getNames()) {
BlockProperty property = block.getCurrentState().getProperty(str);
if (property instanceof BooleanBlockProperty) {
nbt.putBoolean(str, block.getCurrentState().getBooleanValue(str));
} else if (property instanceof IntBlockProperty) {
nbt.putInt(str, block.getCurrentState().getIntValue(str));
} else if (property instanceof UnsignedIntBlockProperty) {
nbt.putInt(str, block.getCurrentState().getIntValue(str));
} else if (property instanceof ArrayBlockProperty arrayBlockProperty) {
if (arrayBlockProperty.isOrdinal()) {
if (property.getBitSize() > 1) {
nbt.putInt(str, Integer.parseInt(block.getCurrentState().getPersistenceValue(str)));
} else {
nbt.putBoolean(str, !block.getCurrentState().getPersistenceValue(str).equals("0"));
}
} else {
nbt.putString(str, block.getCurrentState().getPersistenceValue(str));
}
}
}
} else {
for (int i = 1, len = states.length; i < len; ++i) {
String[] split = states[i].split("=");
String propertyTypeString = PropertyTypes.getPropertyTypeString(split[0]);
if (propertyTypeString != null) {
switch (propertyTypeString) {
case "BOOLEAN" -> nbt.putBoolean(split[0], Integer.parseInt(split[1]) == 1);
case "ENUM" -> nbt.putString(split[0], split[1]);
case "INTEGER" -> nbt.putInt(split[0], Integer.parseInt(split[1]));
}
}
}
}
result.putCompound("states", nbt);
return result.putInt("version", BlockStateRegistry.blockPaletteVersion.get());
}
@PowerNukkitXOnly
@Since("1.19.60-r1")
@NotNull
public static Block getBlockHelper(@NotNull CompoundTag block) {
if (!block.containsString("name")) return Block.get(0);
StringBuilder state = new StringBuilder(block.getString("name"));
CompoundTag states = block.getCompound("states");
states.getTags().forEach((k, v) -> state.append(';').append(k).append('=').append(v.parseValue()));
var blockStateId = state.toString();
try {
var blockState = BlockState.of(blockStateId);
return blockState.getBlock();
} catch (BlockPropertyNotFoundException | UnknownRuntimeIdException e) {
int runtimeId = BlockStateRegistry.getKnownRuntimeIdByBlockStateId(blockStateId);
if (runtimeId == -1) {
log.debug("Unsupported block found in creativeitems.json: {}", blockStateId);
return BlockState.AIR.getBlock();
}
int blockId = BlockStateRegistry.getBlockIdByRuntimeId(runtimeId);
BlockState defaultBlockState = BlockState.of(blockId);
if (defaultBlockState.getProperties().equals(BlockUnknown.PROPERTIES)) {
log.debug("Unsupported block found in creativeitems.json: {}", blockStateId);
return BlockState.AIR.getBlock();
}
log.error("Failed to load the creative item with {}", blockStateId, e);
return BlockState.AIR.getBlock();
} catch (NoSuchElementException e) {
log.debug("No Such Element in creativeitems.json: {}", blockStateId, e);
} catch (Exception e) {
log.error("Failed to load the creative item {}", blockStateId, e);
return BlockState.AIR.getBlock();
}
return BlockState.AIR.getBlock();
}
private static Item fixWoolItem(int id, int damage, int count) {
//TODO 回退之前的方块更新方案，现在有更好的解决方式，下个版本移除这段代码
if (damage == 0) {
switch (id) {
case -552 -> {
return Item.get(35, 8, count);
}
case -553 -> {
return Item.get(35, 7, count);
}
case -554 -> {
return Item.get(35, 15, count);
}
case -555 -> {
return Item.get(35, 12, count);
}
case -556 -> {
return Item.get(35, 14, count);
}
case -557 -> {
return Item.get(35, 1, count);
}
case -558 -> {
return Item.get(35, 4, count);
}
case -559 -> {
return Item.get(35, 5, count);
}
case -560 -> {
return Item.get(35, 13, count);
}
case -561 -> {
return Item.get(35, 9, count);
}
case -562 -> {
return Item.get(35, 3, count);
}
case -563 -> {
return Item.get(35, 11, count);
}
case -564 -> {
return Item.get(35, 10, count);
}
case -565 -> {
return Item.get(35, 2, count);
}
case -566 -> {
return Item.get(35, 6, count);
}
}
}
return Item.get(id, damage, count);
}
public static CompoundTag read(File file) throws IOException {
return read(file, ByteOrder.BIG_ENDIAN);
}
public static CompoundTag read(File file, ByteOrder endianness) throws IOException {
if (!file.exists()) return null;
try (FileInputStream inputStream = new FileInputStream(file)) {
return read(inputStream, endianness);
}
}
public static CompoundTag read(InputStream inputStream) throws IOException {
return read(inputStream, ByteOrder.BIG_ENDIAN);
}
public static CompoundTag read(InputStream inputStream, ByteOrder endianness) throws IOException {
return read(inputStream, endianness, false);
}
public static CompoundTag read(InputStream inputStream, ByteOrder endianness, boolean network) throws IOException {
Tag tag = Tag.readNamedTag(new NBTInputStream(inputStream, endianness, network));
if (tag instanceof CompoundTag) {
return (CompoundTag) tag;
}
throw new IOException("Root tag must be a named compound tag");
}
public static Tag readTag(InputStream inputStream, ByteOrder endianness, boolean network) throws IOException {
return Tag.readNamedTag(new NBTInputStream(inputStream, endianness, network));
}
public static CompoundTag read(byte[] data) throws IOException {
return read(data, ByteOrder.BIG_ENDIAN);
}
public static CompoundTag read(byte[] data, ByteOrder endianness) throws IOException {
try (InputStream inputStream = new ByteArrayInputStream(data)) {
return read(inputStream, endianness);
}
}
public static CompoundTag read(byte[] data, ByteOrder endianness, boolean network) throws IOException {
try (InputStream inputStream = new ByteArrayInputStream(data)) {
return read(inputStream, endianness, network);
}
}
public static CompoundTag readCompressed(InputStream inputStream) throws IOException {
return readCompressed(inputStream, ByteOrder.BIG_ENDIAN);
}
public static CompoundTag readCompressed(InputStream inputStream, ByteOrder endianness) throws IOException {
try (InputStream gzip = new GZIPInputStream(inputStream);
InputStream buffered = new BufferedInputStream(gzip)) {
return read(buffered, endianness);
}
}
public static CompoundTag readCompressed(byte[] data) throws IOException {
return readCompressed(data, ByteOrder.BIG_ENDIAN);
}
public static CompoundTag readCompressed(byte[] data, ByteOrder endianness) throws IOException {
try (InputStream bytes = new ByteArrayInputStream(data);
InputStream gzip = new GZIPInputStream(bytes);
InputStream buffered = new BufferedInputStream(gzip)) {
return read(buffered, endianness, true);
}
}
public static CompoundTag readNetworkCompressed(InputStream inputStream) throws IOException {
return readNetworkCompressed(inputStream, ByteOrder.BIG_ENDIAN);
}
public static CompoundTag readNetworkCompressed(InputStream inputStream, ByteOrder endianness) throws IOException {
try (InputStream gzip = new GZIPInputStream(inputStream);
InputStream buffered = new BufferedInputStream(gzip)) {
return read(buffered, endianness);
}
}
public static CompoundTag readNetworkCompressed(byte[] data) throws IOException {
return readNetworkCompressed(data, ByteOrder.BIG_ENDIAN);
}
public static CompoundTag readNetworkCompressed(byte[] data, ByteOrder endianness) throws IOException {
try (InputStream bytes = new ByteArrayInputStream(data);
InputStream gzip = new GZIPInputStream(bytes);
InputStream buffered = new BufferedInputStream(gzip)) {
return read(buffered, endianness, true);
}
}
public static byte[] write(CompoundTag tag) throws IOException {
return write(tag, ByteOrder.BIG_ENDIAN);
}
public static byte[] write(CompoundTag tag, ByteOrder endianness) throws IOException {
return write(tag, endianness, false);
}
public static byte[] write(CompoundTag tag, ByteOrder endianness, boolean network) throws IOException {
return write((Tag) tag, endianness, network);
}
public static byte[] write(Tag tag, ByteOrder endianness, boolean network) throws IOException {
FastByteArrayOutputStream baos = ThreadCache.fbaos.get().reset();
try (NBTOutputStream stream = new NBTOutputStream(baos, endianness, network)) {
Tag.writeNamedTag(tag, stream);
return baos.toByteArray();
}
}
public static byte[] write(Collection tags) throws IOException {
return write(tags, ByteOrder.BIG_ENDIAN);
}
public static byte[] write(Collection tags, ByteOrder endianness) throws IOException {
return write(tags, endianness, false);
}
public static byte[] write(Collection tags, ByteOrder endianness, boolean network) throws IOException {
FastByteArrayOutputStream baos = ThreadCache.fbaos.get().reset();
try (NBTOutputStream stream = new NBTOutputStream(baos, endianness, network)) {
for (CompoundTag tag : tags) {
Tag.writeNamedTag(tag, stream);
}
return baos.toByteArray();
}
}
public static void write(CompoundTag tag, File file) throws IOException {
write(tag, file, ByteOrder.BIG_ENDIAN);
}
public static void write(CompoundTag tag, File file, ByteOrder endianness) throws IOException {
try (FileOutputStream outputStream = new FileOutputStream(file)) {
write(tag, outputStream, endianness);
}
}
public static void write(CompoundTag tag, OutputStream outputStream) throws IOException {
write(tag, outputStream, ByteOrder.BIG_ENDIAN);
}
public static void write(CompoundTag tag, OutputStream outputStream, ByteOrder endianness) throws IOException {
write(tag, outputStream, endianness, false);
}
public static void write(CompoundTag tag, OutputStream outputStream, ByteOrder endianness, boolean network) throws IOException {
Tag.writeNamedTag(tag, new NBTOutputStream(outputStream, endianness, network));
}
public static byte[] writeNetwork(Tag tag) throws IOException {
FastByteArrayOutputStream baos = ThreadCache.fbaos.get().reset();
try (NBTOutputStream stream = new NBTOutputStream(baos, ByteOrder.LITTLE_ENDIAN, true)) {
Tag.writeNamedTag(tag, stream);
}
return baos.toByteArray();
}
public static byte[] writeGZIPCompressed(CompoundTag tag) throws IOException {
return writeGZIPCompressed(tag, ByteOrder.BIG_ENDIAN);
}
public static byte[] writeGZIPCompressed(CompoundTag tag, ByteOrder endianness) throws IOException {
FastByteArrayOutputStream baos = ThreadCache.fbaos.get().reset();
writeGZIPCompressed(tag, baos, endianness);
return baos.toByteArray();
}
public static void writeGZIPCompressed(CompoundTag tag, OutputStream outputStream) throws IOException {
writeGZIPCompressed(tag, outputStream, ByteOrder.BIG_ENDIAN);
}
public static void writeGZIPCompressed(CompoundTag tag, OutputStream outputStream, ByteOrder endianness) throws IOException {
PGZIPOutputStream gzip = new PGZIPOutputStream(outputStream);
write(tag, gzip, endianness);
gzip.finish();
}
public static byte[] writeNetworkGZIPCompressed(CompoundTag tag) throws IOException {
return writeNetworkGZIPCompressed(tag, ByteOrder.BIG_ENDIAN);
}
public static byte[] writeNetworkGZIPCompressed(CompoundTag tag, ByteOrder endianness) throws IOException {
FastByteArrayOutputStream baos = ThreadCache.fbaos.get().reset();
writeNetworkGZIPCompressed(tag, baos, endianness);
return baos.toByteArray();
}
public static void writeNetworkGZIPCompressed(CompoundTag tag, OutputStream outputStream) throws IOException {
writeNetworkGZIPCompressed(tag, outputStream, ByteOrder.BIG_ENDIAN);
}
public static void writeNetworkGZIPCompressed(CompoundTag tag, OutputStream outputStream, ByteOrder endianness) throws IOException {
PGZIPOutputStream gzip = new PGZIPOutputStream(outputStream);
write(tag, gzip, endianness, true);
gzip.finish();
}
public static void writeZLIBCompressed(CompoundTag tag, OutputStream outputStream) throws IOException {
writeZLIBCompressed(tag, outputStream, ByteOrder.BIG_ENDIAN);
}
public static void writeZLIBCompressed(CompoundTag tag, OutputStream outputStream, ByteOrder endianness) throws IOException {
writeZLIBCompressed(tag, outputStream, Deflater.DEFAULT_COMPRESSION, endianness);
}
public static void writeZLIBCompressed(CompoundTag tag, OutputStream outputStream, int level) throws IOException {
writeZLIBCompressed(tag, outputStream, level, ByteOrder.BIG_ENDIAN);
}
public static void writeZLIBCompressed(CompoundTag tag, OutputStream outputStream, int level, ByteOrder endianness) throws IOException {
DeflaterOutputStream out = new DeflaterOutputStream(outputStream, new Deflater(level));
write(tag, out, endianness);
out.finish();
}
public static void safeWrite(CompoundTag tag, File file) throws IOException {
File tmpFile = new File(file.getAbsolutePath() + "_tmp");
if (tmpFile.exists()) {
tmpFile.delete();
}
write(tag, tmpFile);
Files.move(tmpFile.toPath(), file.toPath(), StandardCopyOption.REPLACE_EXISTING, StandardCopyOption.ATOMIC_MOVE);
}
/**
* The following methods
* only used for LevelEventGenericPacket
* which do not write/read tag id and name
*/
@PowerNukkitXOnly
@Since("1.19.21-r3")
public static byte[] writeValue(CompoundTag tag) throws IOException {
return writeValue(tag, ByteOrder.BIG_ENDIAN);
}
@PowerNukkitXOnly
@Since("1.19.21-r3")
public static byte[] writeValue(CompoundTag tag, ByteOrder endianness) throws IOException {
return writeValue(tag, endianness, false);
}
@PowerNukkitXOnly
@Since("1.19.21-r3")
public static byte[] writeValue(CompoundTag tag, ByteOrder endianness, boolean network) throws IOException {
return writeValue((Tag) tag, endianness, network);
}
@PowerNukkitXOnly
@Since("1.19.21-r3")
public static byte[] writeValue(Tag tag, ByteOrder endianness, boolean network) throws IOException {
FastByteArrayOutputStream baos = ThreadCache.fbaos.get().reset();
try (NBTOutputStream stream = new NBTOutputStream(baos, endianness, network)) {
Tag.writeValue(tag, stream);
return baos.toByteArray();
}
}
@PowerNukkitXOnly
@Since("1.19.21-r3")
public static CompoundTag readCompoundValue(InputStream inputStream, ByteOrder endianness, boolean network) throws IOException {
return Tag.readCompoundValue(new NBTInputStream(inputStream, endianness, network));
}
}
