version 1.7, 2003/07/31 14:36:33
|
version 1.44, 2012/12/21 11:28:21
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%LICENSE//////////////////////////////////////////////////////////////// |
// |
|
// Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM, |
|
// The Open Group, Tivoli Systems |
|
// |
|
// 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. |
|
// |
|
//============================================================================== |
|
// | // |
// Author: Sushma Fernandes, Hewlett-Packard Company (sushma_fernandes@hp.com) |
// Licensed to The Open Group (TOG) under one or more contributor license |
|
// agreements. Refer to the OpenPegasusNOTICE.txt file distributed with |
|
// this work for additional information regarding copyright ownership. |
|
// Each contributor licenses this file to you under the OpenPegasus Open |
|
// Source License; you may not use this file except in compliance with the |
|
// License. |
|
// |
|
// 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. |
// | // |
// Modified By: Rudy Schuet (rudy.schuet@compaq.com) 11/12/01 |
////////////////////////////////////////////////////////////////////////// |
// added nsk platform support |
|
// | // |
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#include <fstream> |
|
#include <iostream> |
|
#include <Pegasus/Common/FileSystem.h> | #include <Pegasus/Common/FileSystem.h> |
|
#include <Pegasus/Common/Tracer.h> |
#include <Pegasus/Common/TraceFileHandler.h> | #include <Pegasus/Common/TraceFileHandler.h> |
|
#include <Pegasus/Common/Logger.h> |
| |
#if defined(PEGASUS_OS_TYPE_WINDOWS) | #if defined(PEGASUS_OS_TYPE_WINDOWS) |
# include <Pegasus/Common/TraceFileHandlerWindows.cpp> | # include <Pegasus/Common/TraceFileHandlerWindows.cpp> |
#elif defined(PEGASUS_OS_TYPE_UNIX) |
#elif defined(PEGASUS_OS_TYPE_UNIX) || defined(PEGASUS_OS_VMS) |
# include <Pegasus/Common/TraceFileHandlerUnix.cpp> |
# include <Pegasus/Common/TraceFileHandlerPOSIX.cpp> |
#elif defined(PEGASUS_OS_TYPE_NSK) |
|
# include <Pegasus/Common/TraceFileHandlerNsk.cpp> |
|
#else | #else |
# error "Unsupported platform" | # error "Unsupported platform" |
#endif | #endif |
|
|
// Constructs TraceFileHandler | // Constructs TraceFileHandler |
//////////////////////////////////////////////////////////////////////////////// | //////////////////////////////////////////////////////////////////////////////// |
| |
TraceFileHandler::TraceFileHandler () |
TraceFileHandler::TraceFileHandler(): |
|
_fileName(0), |
|
_fileHandle(0), |
|
_logErrorBitField(0), |
|
_configHasChanged(true), |
|
#ifdef PEGASUS_PLATFORM_LINUX_GENERIC_GNU |
|
_baseFileName(0), |
|
_fileCount(0) |
|
#endif |
{ | { |
_fileName = 0; |
|
_fileHandle = 0; |
|
_wroteToLog = false; |
|
} | } |
| |
//////////////////////////////////////////////////////////////////////////////// | //////////////////////////////////////////////////////////////////////////////// |
|
|
{ | { |
fclose(_fileHandle); | fclose(_fileHandle); |
} | } |
if (_fileName) |
free(_fileName); |
{ |
#ifdef PEGASUS_PLATFORM_LINUX_GENERIC_GNU |
delete []_fileName; |
free(_baseFileName); |
|
#endif |
} | } |
|
|
|
//////////////////////////////////////////////////////////////////////////////// |
|
// The configuration of the trace has been updated. |
|
// At the next trace write, change to the new configuration. |
|
//////////////////////////////////////////////////////////////////////////////// |
|
void TraceFileHandler::configurationUpdated() |
|
{ |
|
_configHasChanged = true; |
} | } |
| |
//////////////////////////////////////////////////////////////////////////////// | //////////////////////////////////////////////////////////////////////////////// |
// Sets the filename to the given filename and opens the file in append |
// If the trace configuration has been updated, |
// mode |
// close the old file and open the new file. |
//////////////////////////////////////////////////////////////////////////////// | //////////////////////////////////////////////////////////////////////////////// |
|
void TraceFileHandler::_reConfigure() |
|
{ |
|
AutoMutex writeLock(writeMutex); |
| |
Uint32 TraceFileHandler::setFileName(const char* fileName) |
if(!_configHasChanged) |
{ | { |
if (!isValidFilePath(fileName)) |
// An other thread does already the re-configuration. |
|
// do nothing. |
|
return; |
|
} |
|
|
|
free(_fileName); |
|
_fileName = 0; |
|
#ifdef PEGASUS_PLATFORM_LINUX_GENERIC_GNU |
|
free(_baseFileName); |
|
_baseFileName = 0; |
|
#endif |
|
|
|
if (Tracer::_getInstance() ->_traceFile.size() == 0) |
{ | { |
return 1; |
// if the file name is empty/NULL pointer do nothing |
|
// wait for a new trace file. |
|
_configHasChanged=false; |
|
return; |
} | } |
// Check if a file is already open, if so close it |
|
|
_fileName = strdup((const char*)Tracer::_getInstance() |
|
->_traceFile.getCString()); |
|
|
|
// If a file is already open, close it. |
if (_fileHandle) | if (_fileHandle) |
{ | { |
fclose(_fileHandle); | fclose(_fileHandle); |
|
_fileHandle = 0; |
} | } |
| |
// Now open the file |
_fileHandle = _openFile(_fileName); |
_fileHandle = fopen(fileName,"a+"); |
|
if (!_fileHandle) | if (!_fileHandle) |
{ | { |
// Unable to open file, log a message |
// return with no message. _openFile() already wrote one. |
//l10n |
free(_fileName); |
//Logger::put(Logger::DEBUG_LOG,"Tracer",Logger::WARNING, |
_fileName = 0; |
//"Failed to open File $0",fileName); |
// wait for a new trace file |
Logger::put_l(Logger::DEBUG_LOG,"Tracer",Logger::WARNING, |
_configHasChanged=false; |
"Common.TraceFileHandler.FAILED_TO_OPEN_FILE", |
return; |
"Failed to open File $0",fileName); |
|
return 1; |
|
} |
|
else |
|
{ |
|
if (_fileName) |
|
{ |
|
delete [] _fileName; |
|
} |
|
_fileName = new char [strlen(fileName)+1]; |
|
strcpy (_fileName,fileName); |
|
} |
|
return 0; |
|
} | } |
| |
Boolean TraceFileHandler::isValidFilePath(const char* filePath) |
#ifdef PEGASUS_PLATFORM_LINUX_GENERIC_GNU |
{ |
_baseFileName = strdup(_fileName); |
String fileName = String(filePath); |
#endif |
| |
// Check if the file path is a directory |
_configHasChanged=false; |
FileSystem::translateSlashes(fileName); |
|
if (FileSystem::isDirectory(fileName)) |
|
{ |
|
return 0; |
|
} |
|
| |
// Check if the file exists and is writable |
return; |
if (FileSystem::exists(fileName)) |
|
{ |
|
if (!FileSystem::canWrite(fileName)) |
|
{ |
|
return 0; |
|
} |
|
else |
|
{ |
|
return 1; |
|
} |
|
} | } |
else |
|
{ |
|
// Check if directory is writable |
|
Uint32 index = fileName.reverseFind('/'); |
|
| |
if (index != PEG_NOT_FOUND) |
FILE* TraceFileHandler::_openFile(const char* fileName) |
{ | { |
String dirName = fileName.subString(0,index); |
#ifdef PEGASUS_OS_VMS |
if (!FileSystem::isDirectory(dirName)) |
// FILE* fileHandle = fopen(fileName,"a+", "shr=get,put,upd"); |
|
FILE* fileHandle = fopen(fileName,"w", "shr=get,put,upd"); |
|
#else |
|
FILE* fileHandle = fopen(fileName,"a+"); |
|
#endif |
|
if (!fileHandle) |
{ | { |
|
// Unable to open file, log a message |
|
MessageLoaderParms parm( |
|
"Common.TraceFileHandler.FAILED_TO_OPEN_FILE_SYSMSG", |
|
"Failed to open file $0: $1", |
|
fileName,PEGASUS_SYSTEM_ERRORMSG_NLS); |
|
_logError(TRCFH_FAILED_TO_OPEN_FILE_SYSMSG,parm); |
return 0; | return 0; |
} | } |
if (!FileSystem::canWrite(dirName) ) |
|
|
// |
|
// Verify that the file has the correct owner |
|
// |
|
if (!System::verifyFileOwnership(fileName)) |
{ | { |
|
MessageLoaderParms parm( |
|
"Common.TraceFileHandler.UNEXPECTED_FILE_OWNER", |
|
"File $0 is not owned by user $1.", |
|
fileName, |
|
System::getEffectiveUserName()); |
|
_logError(TRCFH_UNEXPECTED_FILE_OWNER,parm); |
|
fclose(fileHandle); |
return 0; | return 0; |
} | } |
else |
|
{ |
|
return 1; |
|
} |
|
} |
|
else |
|
{ |
|
String currentDir; |
|
|
|
// Check if there is permission to write in the |
|
// current working directory |
|
FileSystem::getCurrentDirectory(currentDir); |
|
| |
if (!FileSystem::canWrite(currentDir)) |
// |
|
// Set the file permissions to 0600 |
|
// |
|
#if !defined(PEGASUS_OS_TYPE_WINDOWS) |
|
if (!FileSystem::changeFilePermissions( |
|
String(fileName), (S_IRUSR|S_IWUSR)) ) |
|
#else |
|
if (!FileSystem::changeFilePermissions( |
|
String(fileName), (_S_IREAD|_S_IWRITE)) ) |
|
#endif |
{ | { |
|
MessageLoaderParms parm( |
|
"Common.TraceFileHandler.FAILED_TO_SET_FILE_PERMISSIONS", |
|
"Failed to set permissions on file $0", |
|
fileName); |
|
_logError(TRCFH_FAILED_TO_SET_FILE_PERMISSIONS,parm); |
|
fclose(fileHandle); |
return 0; | return 0; |
} | } |
else |
|
{ |
return fileHandle; |
return 1; |
} |
} |
|
|
void TraceFileHandler::_logError( |
|
ErrLogMessageIds msgID, |
|
const MessageLoaderParms & parms) |
|
{ |
|
static Boolean isLogErrorProgress = false; |
|
// msgID has to be within range, else we have a severe coding error |
|
PEGASUS_ASSERT((msgID >= TRCFH_FAILED_TO_OPEN_FILE_SYSMSG) && |
|
(msgID <= TRCFH_UNABLE_TO_WRITE_TRACE_TO_FILE)); |
|
if (!isLogErrorProgress) |
|
{ |
|
isLogErrorProgress = true; |
|
if ((_logErrorBitField & (1 << msgID)) == 0) |
|
{ |
|
// log message not yet written, write log message |
|
Logger::put_l( |
|
Logger::ERROR_LOG, |
|
System::CIMSERVER, |
|
Logger::WARNING, |
|
parms); |
|
// mark bit in log error field to flag that specific log message |
|
// has been written |
|
_logErrorBitField |= (1 << msgID); |
} | } |
|
isLogErrorProgress = false; |
} | } |
return 1; |
|
} | } |
|
|
|
|
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |