source: geniuswebcore/geniusweb/actions/FileLocation.py

# Generated from java by J2P
from __future__ import annotations
from pathlib import Path
from pyson.JsonValue import JsonValue
from tudelft.utilities.tools.safehash import safehash
from tudelft.utilities.tools.systemproperties import systemproperties
from typing import Any
from typing import Optional
from typing import cast
from uuid import UUID
from uuid import uuid4
import os


class FileLocation:
 '''
 This contains a "system independent" {@link File}. This is represented by a
 {@link UUID}. See {@link #getFile()} to get the file referenced by this. The
 file may or may not yet exist (depending on whether your party already wrote
 some contents in that file in previous runs), may or may not be empty (your
 choice), and can contain any type of data. The original intent of this is
 that parties can store learned data in this file, while the name can be kept
 for later re-use in later runs (eg negotiation sessions) on the same machine.
 <p>
 This file is to be used locally on some other machine (typically a
 partiesserver). This object itself only contains a file name.
 {@link #getFile()} turns it into a system-specific {@link File}. <br>
 <h2>WARNING</h2> if used multiple times on different machines, multiple,
 separate files will be involved, there is no magical synchronization of
 multiple items with the same UUID used on different machines.

 '''
 
 def __init__(self, name:Optional[UUID]):
  '''
  @param name the name of the file (must be UUID to prevent injection of
              bad filenames like /.. or C:) Use {@link #FileLocation()} to
              create new FileLocation. That should ensure a new UUID that
              does not collide with existing ones. If null, a random UUID
              is created.

  '''
  self.__name:UUID = None
  super().__init__()
  if (name is None):
   name=uuid4()
  if not(os.path.exists(FileLocation.__rootfolder)):
   os.mkdir(FileLocation.__rootfolder)
  self.__name=name
 
 @JsonValue()
 def getUUID(self) -> Optional[UUID]:
  return self.__name
 
 def getFile(self) -> str:
  '''
  
  @return Actual file that can be used for read/write operations. This file
          usually resides in the geniusweb folder inside the java.io.tmpdir
          system property. This temp dir depends on the run configuration,
          eg some directory inside the user's home directory, or a temp
          folder inside tomcat.

  '''
  return str(Path() / FileLocation.__TMP / FileLocation.__GENIUSWEB / str(self.__name))
 
 #Override
 def __repr__(self) -> str:
  return "FileLocation[" + str(self.__name) + "]"
 
 #Override
 def __hash__(self) -> int:
  prime:int = 31
  result:int = 1
  result=((prime * result) + (0 if ((self.__name is None)) else safehash(self.__name)))
  return result
 
 #Override
 def __eq__(self,obj:Optional[Any]) -> bool:
  if (self is obj):
   return True
  if (obj is None):
   return False
  if (type(self) is not type(obj)):
   return False
  other:Optional[FileLocation] = cast(FileLocation,obj)
  if (self.__name is None):
   if (other.__name is not None):
    return False
  else:
   if not(self.__name == other.__name):
    return False
  return True
 @staticmethod
 def _static_init_():
  FileLocation.__TMP:str = systemproperties()["java.io.tmpdir"]
  FileLocation.__GENIUSWEB:str = "geniusweb"
  FileLocation.__rootpath:Path = Path() / FileLocation.__TMP / FileLocation.__GENIUSWEB
  FileLocation.__rootfolder:str = str(FileLocation.__rootpath)
FileLocation._static_init_()