XSConsoleState.py

# Copyright (c) 2007-2009 Citrix Systems Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 only.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

import re, os, pickle

from XSConsoleBases import *
from XSConsoleLang import *
from XSConsoleLog import *

class State:
    instance = None
    savePath = '/etc/xsconsole'
    saveLeafname = 'state.txt'
    thisVersion = 9

    #***
    #*** Increment thisVersion (above) when adding attributes to this object
    #***
    def __init__(self):
        self.version = self.thisVersion
        self.authTimeoutSeconds = 5*60
        self.passwordChangeRequired = False # IsPasswordSet now takes care of this
        self.modified = True
        self.rebootMessage = None
        self.weStoppedXAPI = False
        self.verboseBoot = False
        self.keymap = None
        self.sleepSeconds = 30*60

    @classmethod
    def SaveFilename(self):
        return self.savePath+'/'+self.saveLeafname

    @classmethod
    def Inst(cls):
        # Load the saved state if we can, otherwise create a default object
        if cls.instance is None:
            isFirstBoot = True
            try:
                if os.path.isfile(cls.SaveFilename()):
                    saveFile = open(cls.SaveFilename(), "rb")
                    unpickler = pickle.Unpickler(saveFile)
                    cls.instance = unpickler.load()
                    saveFile.close()
                    isFirstBoot = False
                    if cls.instance.version != cls.instance.thisVersion:
                        # Version mismatch - don't use the state information
                        cls.instance = None
                        XSLog('State file version mismatch - discarding')
            except Exception as e:
                cls.instance = None

            if cls.instance is None:
                cls.instance = State()
                XSLog('No saved state available - using default state')

            # Fill in pseudo-state
            cls.instance.isFirstBoot = isFirstBoot
            cls.instance.MakeSane()

        return cls.instance

    def AuthTimeoutSeconds(self):
        return self.authTimeoutSeconds

    def PasswordChangeRequired(self):
        return self.passwordChangeRequired

    def PasswordChangeRequiredSet(self, inValue):
        self.passwordChangeRequired = inValue
        self.modified = True

    def RebootMessage(self):
        return self.rebootMessage

    def RebootMessageSet(self, inValue):
        self.rebootMessage = inValue
        self.modified = True

    def VerboseBoot(self):
        return self.verboseBoot

    def VerboseBootSet(self, inValue):
        self.verboseBoot = inValue
        self.modified = True

    def Keymap(self):
        return self.keymap

    def KeymapSet(self, inValue):
        self.keymap = inValue
        self.modified = True

    def IsFirstBoot(self):
        return self.isFirstBoot

    def WeStoppedXAPI(self):
        return self.weStoppedXAPI

    def WeStoppedXAPISet(self, inValue):
        self.weStoppedXAPI = inValue
        self.modified = True

    def AuthTimeoutSecondsSet(self, inSeconds): # Don't call this directly - use Auth.TimeoutSecondsSet
        if inSeconds < 60:
            raise Exception("Cannot set a session timeout of less than one minute")
        if self.authTimeoutSeconds != inSeconds:
            self.authTimeoutSeconds = inSeconds
            self.modified = True

    def AuthTimeoutMinutes(self):
        return int((self.AuthTimeoutSeconds() + 30) / 60)

    def SleepSeconds(self):
        return self.sleepSeconds

    def MakeSane(self):
        self.authTimeoutSeconds = int(self.authTimeoutSeconds)
        if self.authTimeoutSeconds < 60:
            AuthTimeoutSecondsSet(60)

    def SaveIfRequired(self):
        if self.modified:
            self.MakeSane()
            try:
                if not os.path.isdir(self.savePath):
                    os.mkdir(self.savePath, 0o700)

                saveFile = open(self.SaveFilename(), "wb")
                pickler = pickle.Pickler(saveFile)
                self.modified = False # Set unmodified before saving
                pickler.dump(self)
                saveFile.close()
                XSLog('Saved state file')
            except Exception as e:
                XSLogFailure('Failed to save state file', e)