GBSObject.py

Go to the documentation of this file.

import os

import GBSConfig
from GBSLogger import Log, logger 
from GBSIOHelper import GBSIOHelper

class GBSObject :
    """Base for all "role playing" objects.

    This class the basis for persistancy.

    This class provides no (directly) user callable methods
    although they can be used via the classes that inherit from it."""

    def __init__(self,name,parent,model):
        self.__name          = name             # Object name, must be unique within scope of parent
        self.__parent        = parent           # Parent (None for Manager)
        self.__model         = model            # Model name
        Log(self,logger.SYNOPSIS,"Creating a " + self.GetType() + " named " + self.__name)

        # After creation, either read current state from disk, if state file exists,
        # or create state file (and if necessary supporting directory) if it doesn't.

        if os.path.isfile(self.GetStoreLocation()):
            self.Read()
        else:
            parentDir = self.GetStoreLocation("parent_dir")
            if not os.path.isdir(parentDir): os.mkdir(parentDir,0770)
            self.Write()

    def GetType(self): return "GBSObject"

    def __repr__(self) :
        return self.GetType() + " named '" + self.__name + "' stored in "  + self.GetStoreLocation()

            
    #  Standard Getters
    
    def GetName(self):          return self.__name
    def GetModel(self):         return self.__model
    def GetParent(self):        return self.__parent

    def GetStoreLocation(self,type="self"):

        """Return storage location: parent directory, self or child directory.

        type is one of  "parent_dir"  parent's child directory
                        "self"        object's state file
                        "child_dir"   directory for own children"""
        
        loc = ""
        if self.__parent == None : loc = GBSConfig.GetConfig().GetValue("DataDirectory")
        else :                     loc = self.__parent.GetStoreLocation("parent_dir") + "/" + self.__parent.GetName()
        if type != "parent_dir": loc += "/" + self.GetName() 
        if type == "self":       loc += ".state"
        return loc

    #  I/O

    def MakeChildDirectory(self):

        """If directory used to store child objects does not exist, create it"""

        child_dir = self.GetStoreLocation("child_dir")
        if not os.path.isdir(child_dir):
            Log(self,logger.SYNOPSIS,"Creating directory for child objects:" + str(child_dir))
            if os.mkdir(child_dir,0755):
                Log(self,logger.ERROR,"Failed to create directory for child objects:" + str(child_dir))

    def Read(self):        self.__DoIO("r")
    def Write(self):       self.__DoIO("w")
    def WriteFamily(self): self.Write()

    ######  Private Methods (not user callable)  ###### 

    def __DoIO(self,mode):
        Log(self,logger.SYNOPSIS,"Doing I/O mode:" + str(mode) + " on " + GBSObject.__repr__(self))
        ioh = GBSIOHelper(self.GetStoreLocation(),mode)
        self._DoMemberIO(ioh)
        ioh.Close()

    def _DoMemberIO(self,ioh):
        self.__model = ioh("Model Name","s",self.__model)
        self.__name  = ioh("Object Name","s",self.__name)


    def Rename(self,new_name):
        """Rename to new_name (does not perform I/O - that must be done by caller)."""
        self.__name = new_name
        return

---