//%2006//////////////////////////////////////////////////////////////////////// // // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development // 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 // of this software and associated documentation files (the "Software"), to // deal in the Software without restriction, including without limitation the // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or // sell copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. // //============================================================================== // //%///////////////////////////////////////////////////////////////////////////// #ifndef Pegasus_System_h #define Pegasus_System_h #include #include #include #include #include #if defined(PEGASUS_OS_TYPE_WINDOWS) #ifndef mode_t typedef unsigned long mode_t; #endif #endif #if defined (PEGASUS_OS_TYPE_UNIX) || (PEGASUS_OS_VMS) # ifndef PEGASUS_OS_OS400 # include # endif # include // File locking # define PEGASUS_UID_T uid_t # define PEGASUS_GID_T gid_t #else # define PEGASUS_UID_T Uint32 # define PEGASUS_GID_T Uint32 #endif // // Protocal Type // #define TCP "tcp" PEGASUS_NAMESPACE_BEGIN /** The System class defines wrappers for operating system related calls. These are only placed here if they are extremely light. These are usually just direct wrappers which map more or less one to one to the underlying function. */ class PEGASUS_COMMON_LINKAGE System { public: /** getCurrentTime - Gets the current time as seconds and milliseconds into the provided variables using system functions. @param seconds Return for the seconds component of the time. @param milliseconds Return for the milliseconds component of the time. @return The value is returned in the parameters. The time returned is as defined in number of seconds and milliseconds since 00:00 Coordinated Universal Time (UTC), January 1, 1970, */ 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 YY MM DD-HH:MM:SS @return Returns String with the ASCII time date. */ static String getCurrentASCIITime(); static void sleep(Uint32 seconds); static Boolean exists(const char* path); static Boolean canRead(const char* path); static Boolean canWrite(const char* path); static Boolean getCurrentDirectory(char* path, Uint32 size); static Boolean isDirectory(const char* path); static Boolean changeDirectory(const char* path); static Boolean makeDirectory(const char* path); static Boolean getFileSize(const char* path, Uint32& size); static Boolean removeDirectory(const char* path); static Boolean removeFile(const char* path); static Boolean renameFile(const char* oldPath, const char* newPath); static Boolean copyFile(const char* fromPath, const char* toPath); static String getHostName(); static String getFullyQualifiedHostName (); static String getSystemCreationClassName (); static String getHostIP(const String &hostName); static Uint32 _acquireIP(const char* hostname); static Uint32 lookupPort( const char * serviceName, Uint32 defaultPort); /** Attempts to validate that the input hostName represents the same host as the host represented by the value returned by the getFullyQualifiedHostName() method. @param hostName the host name to validate @return True if the input hostName can be validated to represent the same host; False otherwise */ static Boolean sameHost (const String & hostName); static String getEffectiveUserName(); /** This function is used to input a password with echo disabled. The function reads up to a newline and returns a password of at most 8 characters. @param prompt String containing the message prompt to be displayed @return password obtained from the user */ static String getPassword(const char* prompt); /** This function is used to encrypt the user's password. The encryption is compatible with Apache's password file (generated using the htpasswd command ) @param password Password to be encrypted. @param salt Two character string chosen from the set [a-zA-Z0-9./]. @return Encrypted password. */ static String encryptPassword(const char* password, const char* salt); /** This function is used to verify whether specified user is a user on the local system. @param userName User name to be verified. @return true if the username is valid, else false */ static Boolean isSystemUser(const char* userName); /** Checks whether the given user is a privileged user. @param userName User name to be checked. @return true if the user is a privileged user, else false */ static Boolean isPrivilegedUser(const String& userName); /** This function returns the privileged user name on the system. @return the privileged user name */ static String getPrivilegedUserName(); /** 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. */ #ifndef PEGASUS_OS_OS400 static Boolean lookupUserId( const char* userName, PEGASUS_UID_T& uid, PEGASUS_GID_T& gid); #endif /** Changes the process user context to the specified user and group ID. @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. */ #ifndef PEGASUS_OS_OS400 static Boolean changeUserContext( const PEGASUS_UID_T& uid, const PEGASUS_GID_T& gid); #endif /** This function is used to get the process ID of the calling process. @return Process ID */ static Uint32 getPID(); static Boolean truncateFile(const char* path, size_t newSize); /** Compare two strings but ignore any case differences. This method is provided only because some platforms lack a strcasecmp function in the standard library. */ static Sint32 strcasecmp(const char* s1, const char* s2); /** Return just the file or directory name from the path into basename. This method returns a file or directory name at the end of a path. The path can be relative or absolute. If the path is the root, then empty string is returned. */ static char *extract_file_name(const char *fullpath, char *basename); /** Return just the pathname into dirname. The fullpath can be relative or absolute. This method returns a path minus the file or directory name at the end of a supplied path (fullpath). If the fullpath is the root, then fullpath is returned. The resulting path will contain a trailing slash unless fullpath is a file or directory name, in which case, just the file or directory name is returned. */ static char *extract_file_path(const char *fullpath, char *dirname); // Is absolute path? static Boolean is_absolute_path(const char *path); /** Changes file permissions on the given file. @param path path of the file. @param mode the bit-wise inclusive OR of the values for the desired permissions. @return true on success, false on error and errno is set appropriately. */ 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 Boolean verifyFileOwnership(const char* path); /** Flag indicating whether shared libraries are loaded with the BIND_VERBOSE option. THIS FLAG IS USED ON HP-UX ONLY. */ 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); // System ID constants for Logger::put and Logger::trace 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 }; PEGASUS_NAMESPACE_END #endif /* Pegasus_System_h */