"""
python API module for BootConf
see source for bootconf.py for a good API reference

Michael DeHaan <mdehaan@redhat.com>
"""

import exceptions
import os
import traceback

import config
import utils
import sync
import check

_config = config.Config()

class BootAPI:


    def __init__(self):
       """
       Constructor...
       """
       self.debug = 1
       # FIXME: deserializer/serializer error
       # handling probably not up to par yet
       self.deserialize()


    def clear(self):
       """
       Forget about current list of profiles, distros, and systems
       """
       if self.debug:
           print "BootAPI::clear"
       _config.clear()


    def systems(self):
       """
       Return the current list of systems
       """
       if self.debug:
           print "BootAPI::systems"
       return _config.systems()


    def profiles(self):
       """
       Return the current list of profiles
       """
       if self.debug:
           print "BootAPI::profiles"
       return _config.profiles()


    def distros(self):
       """
       Return the current list of distributions
       """
       if self.debug:
           print "BootAPI::distros"
       return _config.distros()


    def new_system(self):
       """
       Return a blank, unconfigured system, unattached to a collection
       """
       if self.debug:
           print "BootAPI::new_system"
       return _config.new_system()


    def new_distro(self):
       """
       Create a blank, unconfigured distro, unattached to a collection.
       """
       if self.debug:
           print "BootAPI::new_distro"
       return _config.new_distro()


    def new_profile(self):
       """
       Create a blank, unconfigured profile, unattached to a collection
       """
       if self.debug:
           print "BootAPI::new_profile"
       return _config.new_profile()

    def check(self):
       """
       See if all preqs for network booting are valid.  This returns
       a list of strings containing instructions on things to correct.
       An empty list means there is nothing to correct, but that still
       doesn't mean there are configuration errors.  This is mainly useful
       for human admins, who may, for instance, forget to properly set up
       their TFTP servers for PXE, etc.
       """
       if self.debug:
           print "BootAPI::check"
       return check.BootCheck(_config).run()


    def sync(self,dry_run=True):
       """
       Take the values currently written to the configuration files in
       /etc, and /var, and build out the information tree found in
       /tftpboot.  Any operations done in the API that have not been
       saved with serialize() will NOT be synchronized with this command.
       """
       if self.debug:
           print "BootAPI::sync"
       # config.deserialize(); # neccessary?
       return sync.BootSync(_config).sync(dry_run)


    def serialize(self):
       """
       Save the config file(s) to disk.
       """
       if self.debug:
           print "BootAPI::serialize"
       _config.serialize()

    def deserialize(self):
       """
       Load the current configuration from config file(s)
       """
       if self.debug:
           print "BootAPI::deserialize"
       _config.deserialize()

    def last_error(self):
       if self.debug:
           print "BootAPI::last_error"
       return utils.last_error()