version 1.33, 2003/08/04 13:30:39
|
version 1.81, 2008/02/06 20:50:45
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%2006//////////////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM, |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
// The Open Group, Tivoli Systems |
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
|
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.; |
|
// IBM Corp.; EMC Corporation, The Open Group. |
|
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; |
|
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; Symantec Corporation; The Open Group. |
// | // |
// Permission is hereby granted, free of charge, to any person obtaining a copy | // Permission is hereby granted, free of charge, to any person obtaining a copy |
// of this software and associated documentation files (the "Software"), to | // of this software and associated documentation files (the "Software"), to |
|
|
// | // |
//============================================================================== | //============================================================================== |
// | // |
// Author: Mike Brasher (mbrasher@bmc.com) |
|
// |
|
// Modified By: |
|
// Nag Boranna, Hewlett-Packard Company (nagaraja_boranna@hp.com) |
|
// |
|
// Modified By: Dave Rosckes (rosckes@us.ibm.com) |
|
// |
|
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#ifndef Pegasus_System_h | #ifndef Pegasus_System_h |
|
|
| |
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
#include <Pegasus/Common/String.h> | #include <Pegasus/Common/String.h> |
|
#include <Pegasus/Common/Array.h> |
#include <Pegasus/Common/Linkage.h> | #include <Pegasus/Common/Linkage.h> |
#include <Pegasus/Common/Logger.h> | #include <Pegasus/Common/Logger.h> |
|
#include <Pegasus/Common/Network.h> |
// |
#include <sys/stat.h> |
// Protocal Type |
|
// |
|
#define TCP "tcp" |
|
|
|
PEGASUS_NAMESPACE_BEGIN |
|
| |
| |
/** This is an opaque type which is used to represent dynamic library |
#if defined(PEGASUS_OS_TYPE_WINDOWS) |
handles returned by the System::loadDynamicLibrary() method and |
#ifndef mode_t |
accepted by the System::loadDynamicProcedure() method. |
typedef unsigned long mode_t; |
*/ |
#endif |
typedef struct DynamicLibraryHandle_* DynamicLibraryHandle; |
#include <windows.h> |
|
#endif |
| |
/** This is an opaque type which is returned by System::loadDynamicSymbol(). |
#if defined (PEGASUS_OS_TYPE_UNIX) || \ |
Values of this type may be casted to the appropriate target type. |
defined (PEGASUS_OS_VMS) |
*/ |
# include <unistd.h> |
#if !defined(PEGASUS_PLATFORM_ZOS_ZSERIES_IBM) && !defined(PEGASUS_PLATFORM_OS400_ISERIES_IBM) |
# include <fcntl.h> // File locking |
typedef struct DynamicSymbolHandle_* DynamicSymbolHandle; |
# define PEGASUS_UID_T uid_t |
|
# define PEGASUS_GID_T gid_t |
#else | #else |
extern "C" {typedef int (* DynamicSymbolHandle)(void);} |
# define PEGASUS_UID_T Uint32 |
|
# define PEGASUS_GID_T Uint32 |
#endif | #endif |
| |
|
// |
|
// Protocal Type |
|
// |
|
#define TCP "tcp" |
| |
|
PEGASUS_NAMESPACE_BEGIN |
| |
/** The System class defines wrappers for operating system related calls. | /** The System class defines wrappers for operating system related calls. |
These are only placed here if they are extremely light. These are | These are only placed here if they are extremely light. These are |
|
|
*/ | */ |
static void getCurrentTime(Uint32& seconds, Uint32& milliseconds); | static void getCurrentTime(Uint32& seconds, Uint32& milliseconds); |
| |
|
/** Similar to getCurrentTime() above but get microseconds (rather than |
|
milliseconds). |
|
*/ |
|
static void getCurrentTimeUsec(Uint32& seconds, Uint32& microseconds); |
|
|
/** getCurrentASCIITime Gets time/date in a fixed format. The format is | /** getCurrentASCIITime Gets time/date in a fixed format. The format is |
YY MM DD-HH:MM:SS | YY MM DD-HH:MM:SS |
@return Returns String with the ASCII time date. | @return Returns String with the ASCII time date. |
|
|
| |
static Boolean copyFile(const char* fromPath, const char* toPath); | static Boolean copyFile(const char* fromPath, const char* toPath); |
| |
/** Unix issue:<br><br><b>RTLD_<bah></b> issue. Currently Pegasus uses RTLD_NOW during |
static String getHostName(); |
loading of the library if supported by OS. Previous to 2.2, Pegasus used RTLD_GLOBAL on Linux |
static String getFullyQualifiedHostName (); |
- that behaviour is now deprecated. |
static String getSystemCreationClassName (); |
*/ |
|
static DynamicLibraryHandle loadDynamicLibrary(const char* fileName); |
|
| |
static void unloadDynamicLibrary(DynamicLibraryHandle libraryHandle); |
// The following 2 methods are wrappers around system functions |
|
// gethostbyname/gethostbyaddr or gethostbyname_r/gethostbyaddr_r. |
|
// In addition to calling corresponding system functions, these |
|
// methods introduce re-tries when errno is set to TRY_AGAIN. |
|
// Optional parameters are required to cover systems which use '_r' |
|
// versions of the system functions. |
|
static struct hostent* getHostByName( |
|
const char* name, |
|
struct hostent* he = 0, |
|
char* buf = 0, |
|
size_t len = 0); |
|
static struct hostent* getHostByAddr( |
|
const char *addr, |
|
int len, |
|
int type, |
|
struct hostent* he = 0, |
|
char* buf = 0, |
|
size_t buflen = 0); |
|
|
|
#if defined(PEGASUS_OS_ZOS) || \ |
|
defined(PEGASUS_OS_VMS) || \ |
|
defined(PEGASUS_ENABLE_IPV6) |
|
|
|
// The following 2 methods are wrappers around system functions |
|
// getaddrinfo/getnameinfo. |
|
// In addition to calling corresponding system functions, these |
|
// methods introduce re-tries on EAI_AGAIN error returns. |
|
static int getAddrInfo( |
|
const char *hostname, |
|
const char *servname, |
|
const struct addrinfo *hints, |
|
struct addrinfo **res); |
|
static int getNameInfo( |
|
const struct sockaddr *sa, |
|
size_t salen, |
|
char *host, |
|
size_t hostlen, |
|
char *serv, |
|
size_t servlen, |
|
int flags); |
| |
static String dynamicLoadError(void); |
#endif |
| |
static DynamicSymbolHandle loadDynamicSymbol( |
// Gets IP address assosiated with hostName. af indicates the |
DynamicLibraryHandle libraryHandle, |
// type of address (ipv4 or ipv6) returned. |
const char* symbolName); |
static Boolean getHostIP(const String &hostName, int *af, String &hostIP); |
|
|
|
// Gets IP address in binary form. af indicates the type of |
|
// address (ipv4 or ipv6) returned. Address will be copied to dst. |
|
static Boolean acquireIP(const char* hostname, int *af, void *dst); |
| |
static String getHostName(); |
/** |
static String getFullyQualifiedHostName (); |
Returns true if IPv6 stack is active by checking return code from |
static String getSystemCreationClassName (); |
Socket::createSocket() and getSocketError() calls. |
|
|
|
ATTN: We return true if some error other than |
|
PEGASUS_INVALID_ADDRESS_FAMILY is returned while creating the socket |
|
because we will not be sure whether the IPv6 stack is active or not |
|
from the returned error code. Return value of "true" from this method |
|
should not be trusted absolutely. |
|
*/ |
|
#ifdef PEGASUS_ENABLE_IPV6 |
|
static Boolean isIPv6StackActive(); |
|
#endif |
|
|
|
/** |
|
Returns all interface addresses. Both ip4 and ip6 interface addresses |
|
will be returned. |
|
*/ |
|
static Array<String> getInterfaceAddrs(); |
| |
static Uint32 lookupPort( | static Uint32 lookupPort( |
const char * serviceName, | const char * serviceName, |
Uint32 defaultPort); | Uint32 defaultPort); |
| |
|
/** |
|
Attempts to find the given IP address(32bit) on any of the local defined |
|
network interfaces |
|
*/ |
|
static Boolean isIpOnNetworkInterface(Uint32 inIP); |
|
|
|
/** |
|
Attempts to resolve a given hostname |
|
this function possibly can take some as it can request information |
|
from the DNS |
|
|
|
@param resolvedNameIP On successful hostname resolution, this output |
|
parameter contains the IP address that was determined. |
|
@return true if successful, false if not successful. |
|
*/ |
|
static Boolean resolveHostNameAtDNS( |
|
const char* hostname, |
|
Uint32* resolvedNameIP); |
|
|
|
/** |
|
Attempts to resolve a given IP address |
|
this function possibly can take some as it can request information |
|
from the DNS |
|
@param resolvedIP On successful hostname resolution, this output |
|
parameter contains the IP address that was determined. |
|
@return true if successful, false if not successful. |
|
*/ |
|
static Boolean resolveIPAtDNS(Uint32 ip_addr, Uint32 * resolvedIP); |
|
|
|
/** |
|
Bundling function used to determine if a given hostname or IP address |
|
belongs to the local host |
|
this function has the potential to take some time as it will possibly |
|
use the DNS |
|
*/ |
|
static Boolean isLocalHost(const String& hostName); |
|
|
|
/** |
|
Checks binIPAddress represented by address family and returns true |
|
if binary representation matches with loopback ip address. binIPAddress |
|
must be in host-byte order. |
|
*/ |
|
static Boolean isLoopBack(int af, void *binIPAddress); |
|
|
static String getEffectiveUserName(); | static String getEffectiveUserName(); |
| |
/** | /** |
|
|
| |
/** | /** |
This function is used to encrypt the user's password. | This function is used to encrypt the user's password. |
The encryption is compatible with Apache's password file (generated using |
The encryption is compatible with Apache's password file (generated |
the htpasswd command ) |
using the htpasswd command) |
| |
@param password Password to be encrypted. | @param password Password to be encrypted. |
@param salt Two character string chosen from the set [a-zA-Z0-9./]. | @param salt Two character string chosen from the set [a-zA-Z0-9./]. |
|
|
@param userName User name to be checked. | @param userName User name to be checked. |
@return true if the user is a privileged user, else false | @return true if the user is a privileged user, else false |
*/ | */ |
static Boolean isPrivilegedUser(const String userName); |
static Boolean isPrivilegedUser(const String& userName); |
| |
/** | /** |
This function returns the privileged user name on the system. | This function returns the privileged user name on the system. |
|
|
@return the privileged user name | @return the privileged user name |
*/ | */ |
static String getPrivilegedUserName(); | static String getPrivilegedUserName(); |
| |
/** | /** |
This function is used to get the process ID of the calling process. |
This function is used to verify whether the specified user is a member |
|
of the specified user group. |
|
|
|
@param userName User name to be verified. |
|
@param groupName User group name. |
|
|
|
@return true if the user is a member of the user group, false otherwise. |
|
@throw InternalSystemError - If there is an error accessing the |
|
specified user or group information. |
|
*/ |
|
static Boolean isGroupMember(const char* userName, const char* groupName); |
| |
|
/** |
|
Gets the user and group IDs associated with the specified user. |
|
@param userName User name for which to look up user and group IDs. |
|
@param uid User ID for the specified user name. |
|
@param gid Group ID for the specified user name. |
|
@return True if the user and group IDs were retrieved |
|
successfully, false otherwise. |
|
*/ |
|
static Boolean lookupUserId( |
|
const char* userName, |
|
PEGASUS_UID_T& uid, |
|
PEGASUS_GID_T& gid); |
|
|
|
/** |
|
Changes the process user context to the specified user and group. |
|
IMPORTANT: This method is not reentrant and not async signal safe. |
|
It should only be called in a single-threaded program. |
|
@param userName User name to set as the process user context. |
|
@param uid User ID to set as the process user context. |
|
@param gid Group ID to set as the process group context. |
|
@return True if the user context is successfully changed, |
|
false otherwise. |
|
*/ |
|
static Boolean changeUserContext_SingleThreaded( |
|
const char* userName, |
|
const PEGASUS_UID_T& uid, |
|
const PEGASUS_GID_T& gid); |
|
|
|
/** |
|
This function is used to get the process ID of the calling process. |
@return Process ID | @return Process ID |
*/ | */ |
static Uint32 getPID(); | static Uint32 getPID(); |
|
|
// Is absolute path? | // Is absolute path? |
static Boolean is_absolute_path(const char *path); | static Boolean is_absolute_path(const char *path); |
| |
#if defined(PEGASUS_OS_HPUX) |
/** Changes file permissions on the given file. |
static Boolean bindVerbose; |
@param path path of the file. |
#endif |
@param mode the bit-wise inclusive OR of the values for the desired |
|
permissions. |
/** This function is an abstraction for the openlog interface used in the Logger |
@return true on success, false on error and errno is set appropriately. |
class. Each platform intending to use system logs should support this interface |
*/ |
|
static Boolean changeFilePermissions(const char* path, mode_t mode); |
|
|
|
/** Checks whether the specified file is a regular file owned by the |
|
effective user for the current process. |
|
@param path Path of the file to check. |
|
@return True if the file is owned by the effective user for the |
|
current process, false otherwise. |
*/ | */ |
static void openlog(const String); |
static Boolean verifyFileOwnership(const char* path); |
| |
/** This function is an abstraction for the syslog interface used in the Logger |
/** |
class. Each platform intending to use system logs should support this interface |
Flag indicating whether shared libraries are loaded with the |
*/ |
BIND_VERBOSE option. |
static void syslog(Uint32, const char *); |
|
| |
/** This function is an abstraction for the closelog interface used in the Logger |
THIS FLAG IS USED ON HP-UX ONLY. |
class. Each platform intending to use system logs should support this interface |
|
*/ | */ |
|
static Boolean bindVerbose; |
|
|
|
/** |
|
Writes a message to the system log. This method encapsulates the |
|
semantics of opening the system log, writing the specified message, |
|
and closing the log. |
|
|
|
@param ident An identifier to be prepended to the log messages |
|
(typically a program name). |
|
@param severity A severity value to be associated with the message. |
|
Severity values are defined in Logger.h. |
|
@param message A message to be written to the system log. |
|
*/ |
|
static void syslog( |
|
const String& ident, |
|
Uint32 severity, |
|
const char* message); |
|
|
|
static void openlog( |
|
const char *ident, |
|
int logopt, |
|
int facility); |
|
|
static void closelog(); | static void closelog(); |
| |
// System ID constants for Logger::put and Logger::trace | // System ID constants for Logger::put and Logger::trace |
static const String CIMSERVER; | static const String CIMSERVER; |
|
|
|
// System ID constants for Logger::put and Logger::trace |
|
static const String CIMLISTENER; |
|
|
|
}; |
|
|
|
/** |
|
The AutoFileLock class uses an advisory file lock to allow access to a |
|
resource to be controlled. |
|
*/ |
|
class PEGASUS_COMMON_LINKAGE AutoFileLock |
|
{ |
|
public: |
|
|
|
AutoFileLock(const char* fileName); |
|
~AutoFileLock(); |
|
|
|
private: |
|
|
|
AutoFileLock(); |
|
AutoFileLock(const AutoFileLock&); |
|
AutoFileLock& operator=(const AutoFileLock&); |
|
|
|
#ifdef PEGASUS_OS_TYPE_UNIX |
|
struct flock _fl; |
|
int _fd; |
|
#endif |
|
#ifdef PEGASUS_OS_TYPE_WINDOWS |
|
HANDLE _hFile; |
|
#endif |
}; | }; |
| |
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |