blob: 1b529e6fbd13916b253187e348420e338fe90d02 [file] [log] [blame] [raw]
package li.cil.oc.server.component
import java.io.FileNotFoundException
import java.io.IOException
import java.util
import li.cil.oc.Constants
import li.cil.oc.api.driver.DeviceInfo.DeviceAttribute
import li.cil.oc.api.driver.DeviceInfo.DeviceClass
import li.cil.oc.Settings
import li.cil.oc.api.Network
import li.cil.oc.api.driver.DeviceInfo
import li.cil.oc.api.fs.Label
import li.cil.oc.api.fs.Mode
import li.cil.oc.api.fs.{FileSystem => IFileSystem}
import li.cil.oc.api.machine.Arguments
import li.cil.oc.api.machine.Callback
import li.cil.oc.api.machine.Context
import li.cil.oc.api.network.EnvironmentHost
import li.cil.oc.api.network._
import li.cil.oc.api.prefab
import li.cil.oc.api.prefab.AbstractValue
import li.cil.oc.common.SaveHandler
import li.cil.oc.server.{PacketSender => ServerPacketSender}
import li.cil.oc.util.ExtendedNBT._
import net.minecraft.nbt.NBTTagCompound
import net.minecraft.nbt.NBTTagIntArray
import net.minecraft.nbt.NBTTagList
import net.minecraftforge.common.util.Constants.NBT
import scala.collection.convert.WrapAsJava._
import scala.collection.mutable
class FileSystem(val fileSystem: IFileSystem, var label: Label, val host: Option[EnvironmentHost], val sound: Option[String], val speed: Int) extends prefab.ManagedEnvironment with DeviceInfo {
override val node = Network.newNode(this, Visibility.Network).
withComponent("filesystem", Visibility.Neighbors).
withConnector().
create()
private val owners = mutable.Map.empty[String, mutable.Set[Int]]
final val readCosts = Array(1.0 / 1, 1.0 / 4, 1.0 / 7, 1.0 / 10, 1.0 / 13, 1.0 / 15)
final val seekCosts = Array(1.0 / 1, 1.0 / 4, 1.0 / 7, 1.0 / 10, 1.0 / 13, 1.0 / 15)
final val writeCosts = Array(1.0 / 1, 1.0 / 2, 1.0 / 3, 1.0 / 4, 1.0 / 5, 1.0 / 6)
// ----------------------------------------------------------------------- //
private final lazy val deviceInfo = Map(
DeviceAttribute.Class -> DeviceClass.Volume,
DeviceAttribute.Description -> "Filesystem",
DeviceAttribute.Vendor -> Constants.DeviceInfo.DefaultVendor,
DeviceAttribute.Product -> "MPFS.21.6",
DeviceAttribute.Capacity -> (fileSystem.spaceTotal * 1.024).toInt.toString,
DeviceAttribute.Size -> fileSystem.spaceTotal.toString,
DeviceAttribute.Clock -> (((2000 / readCosts(speed)).toInt / 100).toString + "/" + ((2000 / seekCosts(speed)).toInt / 100).toString + "/" + ((2000 / writeCosts(speed)).toInt / 100).toString)
)
override def getDeviceInfo: util.Map[String, String] = deviceInfo
// ----------------------------------------------------------------------- //
@Callback(direct = true, doc = """function():string -- Get the current label of the drive.""")
def getLabel(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
if (label != null) result(label.getLabel) else null
}
@Callback(doc = """function(value:string):string -- Sets the label of the drive. Returns the new value, which may be truncated.""")
def setLabel(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
if (label == null) throw new Exception("drive does not support labeling")
if (args.checkAny(0) == null) label.setLabel(null)
else label.setLabel(args.checkString(0))
result(label.getLabel)
}
@Callback(direct = true, doc = """function():boolean -- Returns whether the file system is read-only.""")
def isReadOnly(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
result(fileSystem.isReadOnly)
}
@Callback(direct = true, doc = """function():number -- The overall capacity of the file system, in bytes.""")
def spaceTotal(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
val space = fileSystem.spaceTotal
if (space < 0) result(Double.PositiveInfinity)
else result(space)
}
@Callback(direct = true, doc = """function():number -- The currently used capacity of the file system, in bytes.""")
def spaceUsed(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
result(fileSystem.spaceUsed)
}
@Callback(direct = true, doc = """function(path:string):boolean -- Returns whether an object exists at the specified absolute path in the file system.""")
def exists(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
diskActivity()
result(fileSystem.exists(clean(args.checkString(0))))
}
@Callback(direct = true, doc = """function(path:string):number -- Returns the size of the object at the specified absolute path in the file system.""")
def size(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
diskActivity()
result(fileSystem.size(clean(args.checkString(0))))
}
@Callback(direct = true, doc = """function(path:string):boolean -- Returns whether the object at the specified absolute path in the file system is a directory.""")
def isDirectory(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
diskActivity()
result(fileSystem.isDirectory(clean(args.checkString(0))))
}
@Callback(direct = true, doc = """function(path:string):number -- Returns the (real world) timestamp of when the object at the specified absolute path in the file system was modified.""")
def lastModified(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
diskActivity()
result(fileSystem.lastModified(clean(args.checkString(0))))
}
@Callback(doc = """function(path:string):table -- Returns a list of names of objects in the directory at the specified absolute path in the file system.""")
def list(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
Option(fileSystem.list(clean(args.checkString(0)))) match {
case Some(list) =>
diskActivity()
Array(list)
case _ => null
}
}
@Callback(doc = """function(path:string):boolean -- Creates a directory at the specified absolute path in the file system. Creates parent directories, if necessary.""")
def makeDirectory(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
def recurse(path: String): Boolean = !fileSystem.exists(path) && (fileSystem.makeDirectory(path) ||
(recurse(path.split("/").dropRight(1).mkString("/")) && fileSystem.makeDirectory(path)))
val success = recurse(clean(args.checkString(0)))
diskActivity()
result(success)
}
@Callback(doc = """function(path:string):boolean -- Removes the object at the specified absolute path in the file system.""")
def remove(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
def recurse(parent: String): Boolean = (!fileSystem.isDirectory(parent) ||
fileSystem.list(parent).forall(child => recurse(parent + "/" + child))) && fileSystem.delete(parent)
val success = recurse(clean(args.checkString(0)))
diskActivity()
result(success)
}
@Callback(doc = """function(from:string, to:string):boolean -- Renames/moves an object from the first specified absolute path in the file system to the second.""")
def rename(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
val success = fileSystem.rename(clean(args.checkString(0)), clean(args.checkString(1)))
diskActivity()
result(success)
}
@Callback(direct = true, doc = """function(handle:userdata) -- Closes an open file descriptor with the specified handle.""")
def close(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
close(context, checkHandle(args, 0))
null
}
@Callback(direct = true, limit = 4, doc = """function(path:string[, mode:string='r']):userdata -- Opens a new file descriptor and returns its handle.""")
def open(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
if (owners.get(context.node.address).fold(false)(_.size >= Settings.get.maxHandles)) {
throw new IOException("too many open handles")
}
val path = args.checkString(0)
val mode = args.optString(1, "r")
val handle = fileSystem.open(clean(path), parseMode(mode))
if (handle > 0) {
owners.getOrElseUpdate(context.node.address, mutable.Set.empty[Int]) += handle
}
diskActivity()
result(new HandleValue(node.address, handle))
}
@Callback(direct = true, limit = 15, doc = """function(handle:userdata, count:number):string or nil -- Reads up to the specified amount of data from an open file descriptor with the specified handle. Returns nil when EOF is reached.""")
def read(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
context.consumeCallBudget(readCosts(speed))
val handle = checkHandle(args, 0)
val n = math.min(Settings.get.maxReadBuffer, math.max(0, args.checkInteger(1)))
checkOwner(context.node.address, handle)
Option(fileSystem.getHandle(handle)) match {
case Some(file) =>
// Limit size of read buffer to avoid crazy allocations.
val buffer = new Array[Byte](n)
val read = file.read(buffer)
if (read >= 0) {
val bytes =
if (read == buffer.length)
buffer
else {
val bytes = new Array[Byte](read)
Array.copy(buffer, 0, bytes, 0, read)
bytes
}
if (!node.tryChangeBuffer(-Settings.get.hddReadCost * bytes.length)) {
throw new IOException("not enough energy")
}
diskActivity()
result(bytes)
}
else {
result(Unit)
}
case _ => throw new IOException("bad file descriptor")
}
}
@Callback(direct = true, doc = """function(handle:userdata, whence:string, offset:number):number -- Seeks in an open file descriptor with the specified handle. Returns the new pointer position.""")
def seek(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
context.consumeCallBudget(seekCosts(speed))
val handle = checkHandle(args, 0)
val whence = args.checkString(1)
val offset = args.checkInteger(2)
checkOwner(context.node.address, handle)
Option(fileSystem.getHandle(handle)) match {
case Some(file) =>
whence match {
case "cur" => file.seek(file.position + offset)
case "set" => file.seek(offset)
case "end" => file.seek(file.length + offset)
case _ => throw new IllegalArgumentException("invalid mode")
}
result(file.position)
case _ => throw new IOException("bad file descriptor")
}
}
@Callback(direct = true, doc = """function(handle:userdata, value:string):boolean -- Writes the specified data to an open file descriptor with the specified handle.""")
def write(context: Context, args: Arguments): Array[AnyRef] = fileSystem.synchronized {
context.consumeCallBudget(writeCosts(speed))
val handle = checkHandle(args, 0)
val value = args.checkByteArray(1)
if (!node.tryChangeBuffer(-Settings.get.hddWriteCost * value.length)) {
throw new IOException("not enough energy")
}
checkOwner(context.node.address, handle)
Option(fileSystem.getHandle(handle)) match {
case Some(file) =>
file.write(value)
diskActivity()
result(true)
case _ => throw new IOException("bad file descriptor")
}
}
// ----------------------------------------------------------------------- //
def checkHandle(args: Arguments, index: Int) = {
if (args.isInteger(index)) {
args.checkInteger(index)
} else args.checkAny(0) match {
case handle: HandleValue => handle.handle
case _ => throw new IOException("bad file descriptor")
}
}
def close(context: Context, handle: Int): Unit = {
Option(fileSystem.getHandle(handle)) match {
case Some(file) =>
owners.get(context.node.address) match {
case Some(set) if set.remove(handle) => file.close()
case _ => throw new IOException("bad file descriptor")
}
case _ => throw new IOException("bad file descriptor")
}
}
// ----------------------------------------------------------------------- //
override def onMessage(message: Message) = fileSystem.synchronized {
super.onMessage(message)
if (message.name == "computer.stopped" || message.name == "computer.started") {
owners.get(message.source.address) match {
case Some(set) =>
set.foreach(handle => Option(fileSystem.getHandle(handle)) match {
case Some(file) => file.close()
case _ => // Invalid handle... huh.
})
set.clear()
case _ => // Computer had no open files.
}
}
}
override def onDisconnect(node: Node) = fileSystem.synchronized {
super.onDisconnect(node)
if (node == this.node) {
fileSystem.close()
}
else if (owners.contains(node.address)) {
for (handle <- owners(node.address)) {
Option(fileSystem.getHandle(handle)) match {
case Some(file) => file.close()
case _ =>
}
}
owners.remove(node.address)
}
}
// ----------------------------------------------------------------------- //
override def load(nbt: NBTTagCompound) {
super.load(nbt)
nbt.getTagList("owners", NBT.TAG_COMPOUND).foreach((ownerNbt: NBTTagCompound) => {
val address = ownerNbt.getString("address")
if (address != "") {
owners += address -> ownerNbt.getIntArray("handles").to[mutable.Set]
}
})
if (label != null) {
label.load(nbt)
}
fileSystem.load(nbt.getCompoundTag("fs"))
}
override def save(nbt: NBTTagCompound) = fileSystem.synchronized {
super.save(nbt)
if (label != null) {
label.save(nbt)
}
if (!SaveHandler.savingForClients) {
val ownersNbt = new NBTTagList()
for ((address, handles) <- owners) {
val ownerNbt = new NBTTagCompound()
ownerNbt.setString("address", address)
ownerNbt.setTag("handles", new NBTTagIntArray(handles.toArray))
ownersNbt.appendTag(ownerNbt)
}
nbt.setTag("owners", ownersNbt)
nbt.setNewCompoundTag("fs", fileSystem.save)
}
}
// ----------------------------------------------------------------------- //
private def clean(path: String) = {
val result = com.google.common.io.Files.simplifyPath(path)
if (result.startsWith("../") || result == "..") throw new FileNotFoundException(path)
if (result == "/" || result == ".") ""
else result
}
private def parseMode(value: String): Mode = {
if (("r" == value) || ("rb" == value)) return Mode.Read
if (("w" == value) || ("wb" == value)) return Mode.Write
if (("a" == value) || ("ab" == value)) return Mode.Append
throw new IllegalArgumentException("unsupported mode")
}
private def checkOwner(owner: String, handle: Int) =
if (!owners.contains(owner) || !owners(owner).contains(handle))
throw new IOException("bad file descriptor")
private def diskActivity() {
(sound, host) match {
case (Some(s), Some(h)) => ServerPacketSender.sendFileSystemActivity(node, h, s)
case _ =>
}
}
}
final class HandleValue extends AbstractValue {
def this(owner: String, handle: Int) = {
this()
this.owner = owner
this.handle = handle
}
var owner = ""
var handle = 0
override def dispose(context: Context): Unit = {
super.dispose(context)
if (context.node() != null && context.node().network() != null) {
val node = context.node().network().node(owner)
if (node != null) {
node.host() match {
case fs: FileSystem => try fs.close(context, handle) catch {
case _: Throwable => // Ignore, already closed.
}
}
}
}
}
override def load(nbt: NBTTagCompound): Unit = {
super.load(nbt)
owner = nbt.getString("owner")
handle = nbt.getInteger("handle")
}
override def save(nbt: NBTTagCompound): Unit = {
super.save(nbt)
nbt.setInteger("handle", handle)
nbt.setString("owner", owner)
}
override def toString: String = handle.toString
}