path: root/src/com.gluster.storage.management.server/WebContent/scripts/Utils.py

#  Copyright (c) 2010 Gluster, Inc. <http://www.gluster.com>
#  This file is part of Gluster Storage Platform.
#
#  Gluster Storage Platform 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; either version 3 of
#  the License, or (at your option) any later version.
#
#  Gluster Storage Platform 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, see
#  <http://www.gnu.org/licenses/>.

import sys
import os
import re
import socket
import struct
import syslog
import subprocess
#import spwd
import time
#import uuid
import tempfile
import grp
import pwd
import inspect
from datetime import datetime
import urllib

import Globals
import Protocol
from Common import *

RUN_COMMAND_ERROR = -1024
LOG_SYSLOG = 1
SYSLOG_REQUIRED = False
LOG_FILE_NAME = None
LOG_FILE_OBJ = None


def _getLogCode(priority):
    if syslog.LOG_EMERG == priority:
        return "M"
    elif syslog.LOG_ALERT == priority:
        return "A"
    elif syslog.LOG_CRIT == priority:
        return "C"
    elif syslog.LOG_ERR == priority:
        return "E"
    elif syslog.LOG_WARNING == priority:
        return "W"
    elif syslog.LOG_NOTICE == priority:
        return "N"
    elif syslog.LOG_INFO == priority:
        return "I"
    elif syslog.LOG_DEBUG == priority:
        return "D"
    else: # UNKNOWN
        return "X"


def setLogFile(fileName):
    global LOG_FILE_NAME

    if fileName:
        LOG_FILE_NAME = fileName
        return True
    return False


def closeLog():
    global LOG_FILE_OBJ
    global SYSLOG_REQUIRED

    if SYSLOG_REQUIRED:
        syslog.closelog()
        SYSLOG_REQUIRED = False
        return True

    if LOG_FILE_OBJ:
        try:
            LOG_FILE_OBJ.close()
            LOG_FILE_OBJ = None
        except IOError, e:
            sys.stderr.write("Failed to close file: %s\n" % e)
            return False
    return True


def openLog(fileName=None):
    global LOG_FILE_NAME
    global LOG_FILE_OBJ
    global SYSLOG_REQUIRED

    if fileName == LOG_SYSLOG:
        syslog.openlog(os.path.basename(sys.argv[0]))
        SYSLOG_REQUIRED = True
        return True

    if fileName:
        LOG_FILE_NAME = fileName

    if not LOG_FILE_NAME:
        return False

    closeLog()

    try:
        LOG_FILE_OBJ = open(LOG_FILE_NAME, "a")
    except IOError, e:
        sys.stderr.write("Failed to open file %s: %s\n" % (LOG_FILE_NAME, e))
        return False
    return True

def record(priority, message=None):
    global LOG_FILE_OBJ
    global SYSLOG_REQUIRED

    stack = inspect.stack()[1]
    if stack[3] == "<module>":
        prefix = "%s:%s:%s" % (stack[1], stack[2], stack[3])
    else:
        prefix = "%s:%s:%s()" % (stack[1], stack[2], stack[3])

    if type(priority) == type("") or type(priority) == type(u""):
        logPriority = syslog.LOG_INFO
        logMessage = priority
    else:
        logPriority = priority
        logMessage = message

    if SYSLOG_REQUIRED:
        syslog.syslog(logPriority, "[%s]: %s" % (prefix, logMessage))
        return

    fp = sys.stderr
    if LOG_FILE_OBJ:
        fp = LOG_FILE_OBJ

    fp.write("[%s] %s [%s]: %s" % (str(datetime.now()), _getLogCode(logPriority), prefix, logMessage))
    if logMessage[-1] != '\n':
        fp.write("\n")
    fp.flush()
    return


def trace(message):
    if message:
        log(syslog.LOG_DEBUG, message)


def isString(value):
    return (type(value) == type("") or type(value) == type(u""))


def getTempFileName():
    filedesc, filename = tempfile.mkstemp(prefix="GSP_")
    os.close(filedesc)
    return filename


def runCommandBG(command, stdinFileObj=None, stdoutFileObj=None, stderrFileObj=None,
                 shell=False, root=None):
    log("runCommandBG(): Trying to execute command [%s]" % command)

    if shell:
        if not isString(command):
            return None
    else:
        if isString(command):
            command = command.split()

    if root == True:
        if shell:
            command = "sudo " + command
        else:
            command = ['sudo'] + command
    elif isString(root):
        if shell:
            command = "sudo -u " + root + " " + command
        else:
            command = ['sudo', '-u', root] + command

    if not stdinFileObj:
        stdinFileObj=subprocess.PIPE
    if not stdoutFileObj:
        stdoutFileObj=subprocess.PIPE
    if not stderrFileObj:
        stderrFileObj=subprocess.PIPE

    try:
        process = subprocess.Popen(command,
                                   bufsize=-1,
                                   stdin=stdinFileObj,
                                   stdout=stdoutFileObj,
                                   stderr=stderrFileObj,
                                   shell=shell)
        return process
    except OSError, e:
        log("runCommandBG(): Failed to run command [%s]: %s" % (command, e))
    return None


def runCommand(command,
               input='', output=False,
               shell=False, root=None):
    rv = {}
    rv["Status"] = RUN_COMMAND_ERROR
    rv["Stdout"] = None
    rv["Stderr"] = None

    try:
        stdinFileName = getTempFileName()
        stdinFileObj = open(stdinFileName, "w")
        stdinFileObj.write(input)
        stdinFileObj.close()
        stdinFileObj = open(stdinFileName, "r")

        stdoutFileName = getTempFileName()
        stdoutFileObj = open(stdoutFileName, "w")

        stderrFileName = getTempFileName()
        stderrFileObj = open(stderrFileName, "w")
    except IOError, e:
        log("Failed to create temporary file for executing command [%s]: %s" % (command, e))
        if output:
            return rv
        return rv["Status"]

    stdoutContent = None
    stderrContent = None

    process = runCommandBG(command,
                           stdinFileObj=stdinFileObj,
                           stdoutFileObj=stdoutFileObj,
                           stderrFileObj=stderrFileObj,
                           shell=shell, root=root)
    if process:
        rv['Status'] = process.wait()
        rv['Stdout'] = open(stdoutFileName).read()
        rv['Stderr'] = open(stderrFileName).read()

    os.remove(stdinFileName)
    os.remove(stdoutFileName)
    os.remove(stderrFileName)

    log("runCommand(): execution status of command [%s] = [%s]" % (command, rv))

    if output:
        return rv
    return rv["Status"]


def runCommandFG(command, stdout=False, stderr=False,
                 shell=False, root=None):
    if stdout or stderr:
        output = True
    else:
        output = False
    return runCommand(command, output=output, shell=shell, root=root)


def IP2Number(ipString):
    try:
        return socket.htonl(struct.unpack("I", socket.inet_aton(ipString))[0])
    except socket.error:
        return None
    except TypeError:
        return None
    except struct.error:
        return None


def Number2IP(number):
    try:
        return socket.inet_ntoa(struct.pack("I", socket.ntohl(number)))
    except socket.error:
        return None
    except AttributeError:
        return None
    except ValueError:
        return None


def computeHostName(hostName):
    if not hostName:
        return False

    hostPrefix = ""
    for i in range(len(hostName), 0, -1):
        pos = i - 1
        if hostName[pos].isdigit():
            continue
        break
    hostPrefix = hostName[:pos+1]
    try:
        hostIndex = int(hostName[pos+1:]) 
    except ValueError:
        hostIndex = 0
    # TODO: Check the availablity of the (server) name
    return "%s%s" % (hostPrefix, hostIndex + 1)


def daemonize():
    try: 
        pid = os.fork() 
        if pid > 0:
            # exit first parent
            sys.exit(0) 
    except OSError, e: 
        #sys.stderr.write("fork #1 failed: %d (%s)\n" % (e.errno, e.strerror))
        return False
	
    # decouple from parent environment
    os.chdir("/") 
    os.setsid() 
    os.umask(0) 
	
    # do second fork
    try: 
        pid = os.fork() 
        if pid > 0:
            # exit from second parent
            sys.exit(0) 
    except OSError, e: 
        #sys.stderr.write("fork #2 failed: %d (%s)\n" % (e.errno, e.strerror))
        return False 
	
    # redirect standard file descriptors
    sys.stdout.flush()
    sys.stderr.flush()
    si = file("/dev/null", 'r')
    so = file("/dev/null", 'a+')
    se = file("/dev/null", 'a+', 0)
    os.dup2(si.fileno(), sys.stdin.fileno())
    os.dup2(so.fileno(), sys.stdout.fileno())
    os.dup2(se.fileno(), sys.stderr.fileno())
    return True


def getDownloadStatus(fileName):
    try:
        lines = [line for line in open(fileName)
                 if "saved" in line or "%" in line]
    except IOError:
        return 0
    if not lines:
        return 0
    if "saved" in lines[-1]:
        return 100
    return lines[-1].split("%")[0].split()[-1]


def getMeminfo():
    """-> dict of data from meminfo (str:int).
    Values are in kilobytes.
    """
    import re
    re_parser = re.compile(r'^(?P<key>\S*):\s*(?P<value>\d*)\s*kB' )
    result = {}
    for line in open('/proc/meminfo'):
        match = re_parser.match(line)
        if not match:
            continue # skip lines that don't parse
        key, value = match.groups(['key', 'value'])
        result[key] = int(value)
    return result


def getCpuUsage():
    """-> dict of cpuid : (usertime, nicetime, systemtime, idletime)
    cpuid "cpu" means the total for all CPUs.
    cpuid "cpuN" means the value for CPU N.
    """
    wanted_records = [line for line in open('/proc/stat') if
                      line.startswith('cpu')]
    result = {}
    for cpuline in wanted_records:
        fields = cpuline.split()[:5]
        data = map(int, fields[1:])
        result[fields[0]] = tuple(data)
    return result


def getLoadavg():
    """-> 5-tuple containing the following numbers in order:
    - 1-minute load average (float)
    - 5-minute load average (float)
    - 15-minute load average (float)
    - Number of threads/processes currently executing (<= number of
    CPUs) (int)
    - Number of threads/processes that exist on the system (int)
    - The PID of the most recently-created process on the system (int)
    """
    loadavgstr = open('/proc/loadavg', 'r').readline().strip()
    data = loadavgstr.split()
    avg1, avg5, avg15 = map(float, data[:3])
    threads_and_procs_running, threads_and_procs_total = map(int,
                                                             data[3].split('/'))
    most_recent_pid = int(data[4])
    ncpus = 1
    final_avg = ""
    if hasattr(os, "sysconf"):
     if os.sysconf_names.has_key("SC_NPROCESSORS_ONLN"):
         # Linux
         ncpus = os.sysconf("SC_NPROCESSORS_ONLN")
         if isinstance(ncpus, int) and ncpus > 0:
             final_avg = "%.2f" % (1.0 * avg1 / ncpus) 

    # Future return everything when needed
    # Commenting this for the time being
    # avg5, avg15, threads_and_procs_running, threads_and_procs_total, most_recent_pid
    return final_avg


def getInfinibandPortStatus():

    """ Check for availability of infiniband port 
    and return which port is active in a key pair value
    """

    # Check for existence of infiniband ports
    value = os.popen ("ls /sys/class/infiniband").readline().strip()

    if not value:
        return None

    portlist = os.popen ("echo /sys/class/infiniband/*/ports/*").readline().split()
    
    portkeys = {}
    
    for port in portlist:
        value = os.popen ("cat %s/state" % 
                          port.strip()).readline().split(':')[1].strip()
        portkeys[port.strip()] = value
        
    return portkeys
        

def getServerCount():
    try:
        return int(open(Globals.SERVER_COUNT_FILE).read().strip())
    except IOError:
        log("failed to read file %s" % Globals.SERVER_COUNT_FILE)
        return 1
    except ValueError:
        log("invalid number format in file %s" % Globals.SERVER_COUNT_FILE)
        return 1


def setServerCount(count):
    try:
        open(Globals.SERVER_COUNT_FILE, "w").write("%s\n" % count)
        return True
    except IOError:
        log("failed to write file %s" % Globals.SERVER_COUNT_FILE)
        return False


def getInstalledServerCount():
    try:
        return int(open(Globals.INSTALLED_SERVER_COUNT_FILE).read().strip())
    except IOError:
        log("failed to read file %s" % Globals.INSTALLED_SERVER_COUNT_FILE)
        return 1
    except ValueError:
        log("invalid number format in file %s" % Globals.INSTALLED_SERVER_COUNT_FILE)
        return 1


def setInstalledServerCount(count):
    try:
        open(Globals.INSTALLED_SERVER_COUNT_FILE, "w").write("%s\n" % count)
        return True
    except IOError:
        log("failed to write file %s" % Globals.INSTALLED_SERVER_COUNT_FILE)
        return False


def getLastInstalledServerIpList():
    ipList = {}
    networkDom = Protocol.XDOM()
    if not networkDom.parseFile(Globals.GLOBAL_NETWORK_FILE):
        log("failed to parse file %s" % Globals.GLOBAL_NETWORK_FILE)
    for tagE in networkDom.getElementsByTagRoute("server.interface"):
        interfaceDom = Protocol.XDOM()
        interfaceDom.setDomObj(tagE)
        ipAddress = interfaceDom.getTextByTagRoute("ipaddr")
        if ipAddress:
            ipList[interfaceDom.getTextByTagRoute("device")] = ipAddress
    return ipList


def getFreeIpAddress(device=None):
    serverCount = getServerCount()
    installedServerCount = getInstalledServerCount()
    if serverCount == installedServerCount:
        return None

    availableServerCount = serverCount - installedServerCount
    ipList = getLastInstalledServerIpList()
    
    if not ipList:
        return None

    if device:
        if device not in ipList.keys():
            return None
        deviceIpAddress = ipList[device]
    else:
        deviceIpAddress = ipList.values()[0]
    ipNumber = IP2Number(deviceIpAddress)

    for i in range((ipNumber + availableServerCount), ipNumber, -1):
        ipAddress = Number2IP(i)
        if runCommandFG(["ping", "-qnc", "1", ipAddress]) != 0:
            return ipAddress
    return None


def getPasswordHash(userName):
    try:
        #return spwd.getspnam(userName).sp_pwd
        return "Not implimented"
    except KeyError:
        return None


def getTransactionKey():
    try:
        tokens = open(Globals.TRANSACTION_KEY_FILE).read().split(',')
    except IOError:
        return None, None
    return tokens


def generateSignature():
    #return str(uuid.uuid4()) + ('--%f' % time.time())
    return ('--%f' % time.time())


def getSignature():
    try:
        return open(Globals.SIGNATURE_FILE).read().strip()
    except IOError:
        log(syslog.LOG_ERR, "unable to read signaure from %s file" % Globals.SIGNATURE_FILE)
        return False


def storeSignature(signature, fileName=Globals.SIGNATURE_FILE):
    try:
        open(fileName, "w").write(signature + "\n")
    except IOError:
        log(syslog.LOG_ERR, "unable to write signature %s to %s file" % (signature, fileName))
        return False
    return True


def isUserExist(userName):
    try:
        grp.getgrnam(userName).gr_gid
        return True
    except KeyError:
        pass
    try:
        pwd.getpwnam(userName).pw_uid
        return True
    except KeyError:
        pass
    return False


def getGsnUserInfo(fileName=Globals.GSN_USER_INFO_FILE):
    userInfo = {}
    userInfo["UserId"] = None
    userInfo["Password"] = None
    try:
        for line in open(fileName):
            line = line.strip()
            k = line[:line.index("=")]
            v = line[line.index("=") + 1:]
            if v[0] == "'" or v[0] == '"':
                v = v[1:]
            if v[-1] == "'" or v[-1] == '"':
                v = v[:-1]
            if k.upper() == "GSN_ID":
                userInfo["UserId"] = v
            if k.upper() == "GSN_PASSWORD":
                userInfo["Password"] = v
    except IOError, e:
        log("Failed to read file %s: %s" % (fileName, e))
    return userInfo


def setGsnUserInfo(userInfo, fileName=Globals.GSN_USER_INFO_FILE):
    try:
        fp = open(fileName, "w")
        fp.write("GSN_ID=%s\n" % userInfo["UserId"])
        fp.write("GSN_PASSWORD=%s\n" % userInfo["Password"])
        fp.close()
        return True
    except IOError, e:
        log("Failed to write file %s: %s" % (fileName, e))
    return False


def getPlatformVersion(fileName=Globals.GLUSTER_VERSION_FILE):
    versionInfo = {}
    versionInfo["Version"] = None
    versionInfo["Update"] = None
    try:
        lines = open(Globals.GLUSTER_VERSION_FILE).readlines()
        for line in open(fileName):
            line = line.strip()
            k = line[:line.index("=")]
            v = line[line.index("=") + 1:]
            if v[0] == "'" or v[0] == '"':
                v = v[1:]
            if v[-1] == "'" or v[-1] == '"':
                v = v[:-1]
            if k.upper() == "VERSION":
                versionInfo["Version"] = v
            if k.upper() == "UPDATE":
                versionInfo["Update"] = v
    except IOError, e:
        log("Failed to read file %s: %s" % (fileName, e))
    return versionInfo


def setPlatformVersion(versionInfo, fileName=Globals.GLUSTER_VERSION_FILE):
    if isString(versionInfo):
        tokens = versionInfo.strip().split(".")
        if len(tokens) < 2:
            log("Invalid version format %s. Expecting <MAJOR>.<MINOR>.<PATCHLEVEL>" % versionInfo)
            return False
        version = ".".join(tokens[:2])
        update = ".".join(tokens[2:])
        if not update:
            update = "0"
    else:
        version = versionInfo["Version"]
        update = versionInfo["Update"]
    try:
        fp = open(fileName, "w")
        fp.write("VERSION=%s\n" % version)
        fp.write("UPDATE=%s\n" % update)
        fp.close()
        return True
    except IOError, e:
        log("Failed to write file %s: %s" % (fileName, e))
    return False


def getGlusterUpdateDom(serverVersion):
    errorMessage = ""
    updateInfoDom = None
    try:
        baseUrl = open(Globals.GLUSTER_UPDATE_SITE_FILE).read().strip()
    except IOError, e:
        log("Failed to read file %s: %s" % (Globals.GLUSTER_UPDATE_SITE_FILE, e))
        errorMessage = "Failed to read update site file"
        return updateInfoDom, errorMessage

    try:
        url = "%s/%s/%s" % (baseUrl, serverVersion, Globals.GLUSTER_UPDATES_FILE)
        connection = urllib.urlopen(url)
        if connection.getcode() != 200:
            connection.close()
            errorMessage = "Error received from server to open URL %s" % url
            return updateInfoDom, errorMessage
        updateInfoString = connection.read()
        connection.close()
    except IOError, e:
        log("Failed to get update information from URL %s: %s" % (url, e))
        errorMessage = "Error getting update information"
        return updateInfoDom, errorMessage

    updateInfoDom = Protocol.XDOM()
    if not updateInfoDom.parseString(updateInfoString):
        log("XML parse error on update information content [%s]" % updateInfoString)
        errorMessage = "Parse error on update information"
        updateInfoDom = None
    return updateInfoDom, errorMessage


def removeFile(fileName, root=False):
    if root:
        if runCommand("rm %s" % fileName, root=True) == 0:
            return True
        return False
    try:
        os.remove(fileName)
        return True
    except OSError, e:
        Utils.log("Failed to remove file %s: %s" % (fileName, e))
    return False


def isLiveMode():
    return os.path.exists(Globals.LIVE_MODE_FILE)