#!/usr/bin/python
#
# Copyright (c) 2003 Intel Corporation
# All rights reserved.
#
# Copyright (c) 2004-2006 The Trustees of Princeton University
# All rights reserved.

import os, string

from Exceptions import *
import utils
import systeminfo
import BootAPI
import ModelOptions
import notify_messages
import modprobe

def Run( vars, log, filename = "/etc/modprobe.conf"):
    """
    write out the system file /etc/modprobe.conf with the current
    set of modules.

    returns a tuple of the number of network driver lines and storage
    driver lines written as (networkcount,storagecount)
    """

    # write out the modprobe.conf file for the system. make sure
    # the order of the ethernet devices are listed in the same order
    # as the boot cd loaded the modules. this is found in /tmp/loadedmodules
    # ultimately, the order will only match the boot cd order if
    # the kernel modules have the same name - which should be true for the later
    # version boot cds because they use the same kernel version.
    # older boot cds use a 2.4.19 kernel, and its possible some of the network
    # module names have changed, in which case the system might not boot
    # if the network modules are activated in a different order that the
    # boot cd.

    log.write( "\n\nStep: WriteModProbeConfig.\n" )

    # make sure we have this class loaded
    
    try:
        SYSIMG_PATH= vars["SYSIMG_PATH"]
        if SYSIMG_PATH == "":
            raise ValueError, "SYSIMG_PATH"

    except KeyError, var:
        raise BootManagerException, "Missing variable in vars: %s\n" % var
    except ValueError, var:
        raise BootManagerException, "Variable in vars, shouldn't be: %s\n" % var

    sysmods= systeminfo.get_system_modules(vars, log)
    if sysmods is None:
        raise BootManagerException, "Unable to get list of system modules."
        
    # parse the existing modprobe.conf file, if one exists
    mfile = "%s/%s" % (SYSIMG_PATH,filename)
    m = modprobe.Modprobe()
    if os.path.exists(mfile):
        m.input(mfile)

    blacklist = modprobe.Modprobe()
    blacklistfiles = os.listdir("/etc/modprobe.d")
    for blf in blacklistfiles:
        if os.path.exists("/etc/modprobe.d/%s"%blf):
            blacklist.input("/etc/modprobe.d/%s"%blf)
        
    # storage devices
    m.optionsset("ata_generic","all_generic_ide=1")
    scsi_count= 0
    for a_mod in sysmods[systeminfo.MODULE_CLASS_SCSI]:
        if m.blacklistget(a_mod) <> None or \
               blacklist.blacklistget(a_mod) <> None:
            continue
        m.aliasset("scsi_hostadapter%d"%scsi_count,a_mod)
        scsi_count= scsi_count + 1

    # network devices
    eth_count= 0
    for a_mod in sysmods[systeminfo.MODULE_CLASS_NETWORK]:
        if m.blacklistget(a_mod) <> None or \
               blacklist.blacklistget(a_mod) <> None:
            continue
        m.aliasset("eth%d"%eth_count,a_mod)
        eth_count= eth_count + 1
    m.output(mfile, "BootManager")
    m.output("%s.bak"%mfile, "BootManager") # write a backup version of this file

    # dump the modprobe.conf file to the log (not to screen)
    log.write( "Contents of new modprobe.conf file:\n" )
    modulesconf_file= file("%s/%s" % (SYSIMG_PATH,filename), "r" )
    contents= modulesconf_file.read()
    log.write( contents + "\n" )
    modulesconf_file.close()
    modulesconf_file= None
    log.write( "End contents of new modprobe.conf file.\n" )

    # before we do the real kexec, check to see if we had any
    # network drivers written to modprobe.conf. if not, return -1,
    # which will cause this node to be switched to a debug state.
    if eth_count == 0:
        log.write( "\nIt appears we don't have any network drivers. Aborting.\n" )
        
        vars['RUN_LEVEL']= 'failboot'
        vars['STATE_CHANGE_NOTIFY']= 1
        vars['STATE_CHANGE_NOTIFY_MESSAGE']= \
             notify_messages.MSG_NO_DETECTED_NETWORK
        raise BootManagerException, \
              notify_messages.MSG_NO_DETECTED_NETWORK