UT_LMHost.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        Action (C++)
 *
 * COMMENTS:
 *
 */

#ifndef __UT_LMHost_h__
#define __UT_LMHost_h__

#include "UT_API.h"

#define UT_SESI_LMHOST_REGISTRY_VALUE   \
        "LicenseServer"
#define UT_SESI_LMHOST_ENVVAR           \
        "SESI_LMHOST"

#include "UT_StringHolder.h"
#include "UT_WorkBuffer.h"

#include <SYS/SYS_Compiler.h>

class UT_String;
class UT_StringArray;

class UT_API UT_LMHost
{
public:
    enum AppType
    {
        APPLICATION,
        SYSTEM
    };

    /// Override the default location for the user license file.
    static void overrideUserLicenseFile(const UT_StringHolder& path);
    /// This is the location where the .sesi_preferences file is kept.
    static void getUserLicenseFile(UT_WorkBuffer& filename);
    // Location of the cookie store
    SYS_NO_DISCARD_RESULT static UT_WorkBuffer databaseFile(
        AppType app_type,
        const UT_StringRef& name);
    // Location of the application folder
    SYS_NO_DISCARD_RESULT static UT_WorkBuffer applicationFolder(
            AppType app_type);

    // Delimeters for different config types
    static const char* redundantToken() { return ","; }
    static const char* multiConnectToken() { return ";"; }

    static bool  parseHostString(const char *host_str, UT_StringArray &hosts);
    static void  packHostString(const UT_StringArray &hosts,
                                    UT_String &host_str, bool is_redundant = true);

    // Compare two host lists together. Check if each host matches up to the
    // period of end-of-string, and make sure they differ only in nonalpha
    // characters.
    // The idea is that "boston", "boston-2", "boston.local", "boston-2.local"
    // "boston:3080", "boston.local:3080" all match each other
    //
    // NOTE:
    //  The reason "boston" and boston-2" are considered matching hostnames
    //  is that on OSX when a Mac joins a network and there is some residual
    //  host name on that network a -1, -2, -3, ... suffix is added to
    //  disambiguate the machines.
    static bool areHostNamesEqual(UT_String host1, UT_String host2);
    static bool areHostNamesEqual(const UT_StringArray& hosts1,
                                const UT_StringArray& hosts2);
    // This tests strictly the hostname (no port or other information can be
    // located in the two strings
    static bool testHostnames(const char* host1, const char* host2);

    // Get the users full name using the current uid
    static bool userFullName(UT_StringHolder& name);
    // Get the fully qualified domain name
    static bool fullyQualifiedDomainName(UT_StringHolder &hostname);
};

#endif