#!/usr/bin/python

import shutil
import sys
import os
import isi.backup.tape as tape
import isi.backup.ndmp as ndmp
import isi.backup.settings as settings
import isi.backup.dumpdates as dumpdates
import isi.backup.context_list as context_list
import isi.backup.context as context
import isi.fs.snapshot.manage as snapman
import isi.fs.snapshot.error as snaperr
import isi.gconfig as gcfg
from isi.backup.config import *

from syslog import syslog, LOG_ERR, LOG_WARNING, LOG_NOTICE

def tape_upgrade():
    if os.path.exists("/ifs/.ifsvar/modules/fc/devices_xml_updated") or \
        (not os.path.exists("/ifs/.ifsvar/modules/fc/devices.xml")):
            return 0
    # upgrade tape/mc devices from xml into gconfig
    syslog(LOG_NOTICE, "Upgrade tape/mc devices start")
    try:
        tapecfg = tape.TapeConfig()
    except ConfigError, msg:
        syslog(LOG_ERR, "Error loading tape configuration file: %s" % msg)
	return 1

    try:
        tapeConfigCtx = gcfg.open(gcfg.gcfg_tape).ctx_new()
    except ConfigError, msg:
        syslog(LOG_ERR, "Error to open tape gconfig file: %s" % msg)
	return 1
    # write tape devices into gconfig
    tapes_gcfg = []
    tapedevs = tapecfg.getTapeDevices(None)
    for dev in tapedevs:
	tapeTmp = {}
	tapeTmp['devicename'] = str(dev.name)
	tapeTmp['state'] = str(dev.state)
	tapeTmp['wwnn'] = long(dev.wwnn, 16)
	tapeTmp['product'] = str(dev.product)
	tapeTmp['serial'] = str(dev.serial)
	tapeTmp['opencount'] = int(dev.opencount)
	tapePaths = []
	for path in dev.paths:
	    tapePathTmp = {}
	    tapePathTmp['node'] = int(path.node)
	    tapePathTmp['port'] = int(path.port)
	    tapePathTmp['target'] = int(path.target)
            tapePathTmp['lun'] = int(path.lun)
	    tapePathTmp['wwpn'] = long(path.wwpn, 16)
	    tapePathTmp['portid'] = int(path.portid, 16)
	    tapePathTmp['devname'] = str(path.devname)
	    tapePathTmp['passname'] = str(path.passname)
	    tapePathTmp['state'] = str(path.state)
	    tapePathTmp['opencount'] = int(path.opencount)
	    tapePaths.append(tapePathTmp)
	tapeTmp['paths'] = tapePaths
	tapes_gcfg.append(tapeTmp)
    try:
        tapeConfigCtx.write('devices.tape', tapes_gcfg)
    except ConfigError, msg:
        syslog(LOG_ERR, "Faild to write tape devices into gconfig")
	return 1
    # write media changers into gconfig
    mcs_gcfg = []
    mcdevs = tapecfg.getMcDevices(None)
    for dev in mcdevs:
        mcTmp = {}
	mcTmp['devicename'] = str(dev.name)
	mcTmp['state'] = str(dev.state)
	mcTmp['wwnn'] = long(dev.wwnn, 16)
	mcTmp['product'] = str(dev.product)
	mcTmp['serial'] = str(dev.serial)
	mcTmp['opencount'] = int(dev.opencount)
	mcPaths = []
	for path in dev.paths:
            mcPathTmp = {}
	    mcPathTmp['node'] = int(path.node)
	    mcPathTmp['port'] = int(path.port)
	    mcPathTmp['target'] = int(path.target)
	    mcPathTmp['lun'] = int(path.lun)
	    mcPathTmp['wwpn'] = long(path.wwpn, 16)
	    mcPathTmp['portid'] = int(path.portid, 16)
	    mcPathTmp['devname'] = str(path.devname)
	    mcPathTmp['passname'] = str(path.passname)
	    mcPathTmp['state'] = str(path.state)
	    mcPathTmp['opencount'] = int(path.opencount)
            mcPaths.append(mcPathTmp)
	mcTmp['paths'] = mcPaths
        mcs_gcfg.append(mcTmp)
    try:
        tapeConfigCtx.write('devices.mc', mcs_gcfg)
        tapeConfigCtx.commit()
    except ConfigError, msg:
        syslog(LOG_ERR, "Faild to write mc devices into gconfig")
	return 1
    if os.path.exists("/ifs/.ifsvar/modules/fc/devices.xml.lock"):
        os.remove("/ifs/.ifsvar/modules/fc/devices.xml.lock")
    open("/ifs/.ifsvar/modules/fc/devices_xml_updated", "a").close()
    syslog(LOG_NOTICE, "Upgrade tape/mc devices complete")
    return 0

def ndmp_config_upgrade():
    if os.path.exists("/ifs/.ifsvar/modules/ndmp/config_xml_updated") or \
        (not os.path.exists("/ifs/.ifsvar/modules/ndmp/config.xml")):
	    return 0
    # upgrade ndmp config from xml into gconfig
    syslog(LOG_NOTICE, "Upgrade NDMP config start")
    try:
	ndmpcfg = ndmp.NdmpConfig()
        # ndmp settings
	port = ndmpcfg.getPort()
	dma = ndmpcfg.getDma()
	breMaxContexts = ndmpcfg.getMaxBreContexts()
        # ndmp diagnostics
	protocolVersion = ndmpcfg.getDiagSetting('ProtocolVersion')
	diagLevel = ndmpcfg.getDiagSetting('DiagLevel')
	traceLevel = ndmpcfg.getDiagSetting('TraceLevel')
        # ndmp users
        users = ndmpcfg.getUsers()
    except ConfigError, msg:
	syslog(LOG_ERR, "Error loading ndmp configuration file: %s" % msg)
	return 1
    try:
        ndmpConfigCtx = gcfg.open(gcfg.gcfg_ndmp_config).ctx_new()
    except ConfigError, msg:
        syslog(LOG_ERR, "Error to open ndmp config gconfig file: %s" % msg)
	return 1

    # write ndmp settings into gconfig
    settings_gcfg = {}
    if port:
        settings_gcfg['port'] = int(port)
    if dma:
        settings_gcfg['dma'] = str(dma)
    if breMaxContexts:
        settings_gcfg['max_bre_contexts'] = int(breMaxContexts)
    try:
        ndmpConfigCtx.write('settings', settings_gcfg)
    except ConfigError, msg:
        syslog(LOG_ERR, "Faild to write ndmp settings into gconfig")
	return 1

    # write ndmp diagnostics into gconfig
    diag_gcfg = {}
    if protocolVersion:
        diag_gcfg['protocol_version'] = int(protocolVersion)
    if diagLevel:
        diag_gcfg['diag_level'] = int(diagLevel)
    if traceLevel:
        diag_gcfg['trace_level'] = int(traceLevel)
    try:
        ndmpConfigCtx.write('diagnostics', diag_gcfg)
    except ConfigError, msg:
        syslog(LOG_ERR, "Faild to write ndmp diagnostics into gconfig")
	return 1
    # write ndmp users into gconfig
    users_gcfg = []
    for user in users:
        userTmp = {}
        password = ndmpcfg.getUserPassword(user)
	userTmp['username'] = str(user)
	userTmp['password'] = str(password)
	users_gcfg.append(userTmp)
    try:
        ndmpConfigCtx.write('users', users_gcfg)
        ndmpConfigCtx.commit()
    except ConfigError, msg:
        syslog(LOG_ERR, "Faild to write ndmp users into gconfig")
	return 1
    if os.path.exists("/ifs/.ifsvar/modules/ndmp/config.xml.lock"):
	os.remove("/ifs/.ifsvar/modules/ndmp/config.xml.lock")
    open("/ifs/.ifsvar/modules/ndmp/config_xml_updated", "a").close()
    syslog(LOG_NOTICE, "Upgrade NDMP config complete")
    return 0

def ndmp_dumpdates_upgrade():
    if os.path.exists("/ifs/.ifsvar/modules/ndmp/dumpdates_xml_updated") or \
	(not os.path.exists("/ifs/.ifsvar/modules/ndmp/dumpdates.xml")):
            return 0
    # upgrade ndmp dumpdates from xml into gconfig
    syslog(LOG_NOTICE, "Upgrade NDMP dumpdates start")
    try:
        ndmpdumpdates = dumpdates.ndmpDumpdates()
    except DumpdatesError, msg:
        syslog(LOG_ERR, "Error loading dumpdates file: %s" % msg)
	return 1
    entries = ndmpdumpdates.listRecords()
    try:
        ndmpDumpdatesCtx = gcfg.open(gcfg.gcfg_ndmp_dumpdates).ctx_new()
    except ConfigError, msg:
        syslog(LOG_ERR, "Faild to open ndmp dumpdates gconfig file: %s" % msg)
	return 1

    # write ndmp dumpdates into gconfig
    dumpdates_gcfg = []
    for entry in entries:
        dumpdateTmp = {}
	dumpdateTmp['path'] = str(entry.path)
	dumpdateTmp['date'] = int(entry.date)
	dumpdateTmp['level'] = int(entry.level)
	dumpdateTmp['snapid'] = long(entry.snapid)
	dumpdates_gcfg.append(dumpdateTmp)
    try:
        ndmpDumpdatesCtx.write('dumpdates', dumpdates_gcfg)
        ndmpDumpdatesCtx.commit()
    except ConfigError, msg:
        syslog(LOG_ERR, "Faild to write ndmp dumpdates into gconfig")
	return 1
    if os.path.exists("/ifs/.ifsvar/modules/ndmp/dumpdates.xml.lock"):
	os.remove("/ifs/.ifsvar/modules/ndmp/dumpdates.xml.lock")
    open("/ifs/.ifsvar/modules/ndmp/dumpdates_xml_updated", "a").close()
    syslog(LOG_NOTICE, "Upgrade NDMP dumpdates complete")
    return 0

def ndmp_settings_variables_upgrade():
    if os.path.exists("/ifs/.ifsvar/modules/ndmp/settings_xml_updated") or \
	(not os.path.exists("/ifs/.ifsvar/modules/ndmp/settings.xml")):
	return 0
    # upgrade ndmp settings variables from xml into gconfig
    syslog(LOG_NOTICE, "Upgrade NDMP settings start")
    try:
        ndmp_settings = settings.ndmpSettings()
    except ConfigError, msg:
        syslog(LOG_ERR, "Error loading settings.xml file: %s" % msg)
	return 1
    entries = ndmp_settings.listSettingsVariablesEntries("", "")
    try:
        ndmpSettingsVariablesCtx = \
            gcfg.open(gcfg.gcfg_ndmp_settings_variables).ctx_new()
    except ConfigError, msg:
        syslog(LOG_ERR,
	    "Faild to open settings variables gconfig file: %s" % msg)
	return 1
    # write ndmp settings variables into gconfig
    paths_gcfg = []
    for entry in entries:
	pathTmp = {}
	pathTmp['path'] = str(entry.path)
	envsTmp = []
        for name,value in entry.envmap.iteritems():
            envTmp = {}
	    envTmp['name'] = str(name)
	    envTmp['value'] = str(value)
	    envsTmp.append(envTmp)
        pathTmp['envs'] = envsTmp
        paths_gcfg.append(pathTmp)
    try:
        ndmpSettingsVariablesCtx.write('paths', paths_gcfg)
        ndmpSettingsVariablesCtx.commit()
    except ConfigError, msg:
        syslog(LOG_ERR,
	    "Faild to write ndmp settings variables into gconfig")
	return 1
    if os.path.exists("/ifs/.ifsvar/modules/ndmp/settings.xml.lock"):
	os.remove("/ifs/.ifsvar/modules/ndmp/settings.xml.lock")
    open("/ifs/.ifsvar/modules/ndmp/settings_xml_updated", "a").close()
    syslog(LOG_NOTICE, "Upgrade NDMP settings complete")
    return 0

def delete_bre_contexts_snapshots():
    if os.path.exists("/ifs/.ifsvar/modules/ndmp/context_list_xml_updated") or \
	(not os.path.exists("/ifs/.ifsvar/modules/ndmp/context_list.xml")):
            return 0
    # delete all bre snapshots
    syslog(LOG_NOTICE, "Upgrade NDMP contexts start")
    bre_err = 0
    try:
        ndmpcfg = context_list.ContextListConfig()
        ctxes = ndmpcfg.getContextList()
    except ConfigError, msg:
        syslog(LOG_ERR, "Error loading context configuration file: %s" %
	    msg)
	return 1
    for ctx in ctxes:
	rwObj = context.ReadWriteContext()
	rwObj.my_init(ctx)
	snap_shot = rwObj.getArgument ('snap-name');
	if not snap_shot:
            continue
	try:
            this_snap = snapman.Snap(snap_shot, 'Default')
	    this_snap.open()
	except snaperr.Error, se:
	    syslog(LOG_WARNING, 'Failed to open snapshot %s for deletion: %s.'
	        % (snap_shot, str(se)))
	    continue
	target = this_snap.getRealName()
	if target is None:
	    continue
	try:
	    snapman.snapshotDelete(target)
	except snaperr.Error, se:
	    syslog(LOG_WARNING, 'Cannot remove snapshot %s: %s.' %
	        (target[0], str(se)))
    # delete all existing BRE contexts
    path = "/ifs/.ifsvar/modules/ndmp/contexts"
    for bre in os.listdir(path):
        if bre == "backup" or bre == "restore" or bre == "bre":
	    continue
        bre_path = os.path.join(path, bre)
	try:
            shutil.rmtree(bre_path)
	except IOError as e:
	    syslog(LOG_WARNING, 'Failed to delete %s: %s.' % (bre_path, str(e)))
	    bre_err = 1
	    continue

    if os.path.exists("/ifs/.ifsvar/modules/ndmp/context_list.xml.lock"):
	os.remove("/ifs/.ifsvar/modules/ndmp/context_list.xml.lock")
    if bre_err:
        return 1
    open("/ifs/.ifsvar/modules/ndmp/context_list_xml_updated", "a").close()
    syslog(LOG_NOTICE, "Upgrade NDMP contexts complete")
    return 0

def main():
    if not os.path.exists("/ifs/.ifsvar/modules/ndmp/isi_ndmp_upgrade_already_ran"):
	syslog(LOG_NOTICE, "NDMP upgrade start")
	err = 0
        err |= tape_upgrade()
        err |= ndmp_config_upgrade()
        err |= ndmp_dumpdates_upgrade()
        err |= ndmp_settings_variables_upgrade()
        err |= delete_bre_contexts_snapshots()
	if err:
	    syslog(LOG_NOTICE, "NDMP upgrade incomplete")
	else:
            open("/ifs/.ifsvar/modules/ndmp/isi_ndmp_upgrade_already_ran", 'a').close()
	    if os.path.exists("/ifs/.ifsvar/modules/fc/devices_xml_updated"):
	        os.remove("/ifs/.ifsvar/modules/fc/devices_xml_updated")
	    if os.path.exists("/ifs/.ifsvar/modules/ndmp/config_xml_updated"):
	        os.remove("/ifs/.ifsvar/modules/ndmp/config_xml_updated")
	    if os.path.exists("/ifs/.ifsvar/modules/ndmp/dumpdates_xml_updated"):
	        os.remove("/ifs/.ifsvar/modules/ndmp/dumpdates_xml_updated")
	    if os.path.exists("/ifs/.ifsvar/modules/ndmp/settings_xml_updated"):
	        os.remove("/ifs/.ifsvar/modules/ndmp/settings_xml_updated")
	    if os.path.exists("/ifs/.ifsvar/modules/ndmp/context_list_xml_updated"):
	        os.remove("/ifs/.ifsvar/modules/ndmp/context_list_xml_updated")
	    if os.path.exists("/ifs/.ifsvar/modules/ndmp/isi_ndmp_upgrade_running"):
	        os.remove("/ifs/.ifsvar/modules/ndmp/isi_ndmp_upgrade_running")
            syslog(LOG_NOTICE, "NDMP upgrade complete")
    else:
	syslog(LOG_NOTICE, "NDMP upgrade not required")

if __name__ == '__main__':
    main()
