linuxmuster/linuxmuster-linuxclient7

View on GitHub
usr/lib/python3/dist-packages/linuxmusterLinuxclient7/environment.py

Summary

Maintainability
A
0 mins
Test Coverage
import os
from linuxmusterLinuxclient7 import constants, user, logging

def export(keyValuePair):
    """
    Export an environment variable

    :param keyValuePair: Key value pair in format `key=value`
    :type keyValuePait: str
    :return: True or False
    :rtype: bool
    """
    logging.debug("Saving export '{}' to tmp file".format(keyValuePair))
    
    envList = keyValuePair.split("=")
    if len(envList) == 2:
        os.putenv(envList[0], envList[1])
    
    return _appendToTmpEnvFile("export", keyValuePair)

def unset(key):
    """
    Unset a previously exported environment variable

    :param key: The key to unset
    :type key: str
    :return: True or False
    :rtype: bool
    """
    logging.debug("Saving unset '{}' to tmp file".format(key))
    return _appendToTmpEnvFile("unset", key)

# --------------------
# - Helper functions -
# --------------------

def _isApplicable():
    if not user.isInAD():
        logging.error("Modifying environment variables of non-AD users is not supported by lmn-export and lmn-unset!")
        return False
    elif "LinuxmusterLinuxclient7EnvFixActive" not in os.environ or os.environ["LinuxmusterLinuxclient7EnvFixActive"] != "1":
        logging.error("lmn-export and lmn-unset may only be used inside of linuxmuster-linuxclient7 hooks!")
        return False
    else:
        return True

def _appendToTmpEnvFile(mode, keyValuePair):
    if not _isApplicable():
        return False
    
    tmpEnvironmentFilePath = constants.tmpEnvironmentFilePath.format(user.username())
    fileOpenMode = "a" if os.path.exists(tmpEnvironmentFilePath) else "w"

    try:
        with open(tmpEnvironmentFilePath, fileOpenMode) as tmpEnvironmentFile:
            tmpEnvironmentFile.write("\n{0} '{1}'".format(mode, keyValuePair))
            return True
    except Exception as e:
        logging.exception(e)
        return False