version 1.33, 2008/05/07 19:41:42
|
version 1.45, 2012/12/24 08:44:58
|
|
|
//%2006//////////////////////////////////////////////////////////////////////// |
//%LICENSE//////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
// Licensed to The Open Group (TOG) under one or more contributor license |
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
// agreements. Refer to the OpenPegasusNOTICE.txt file distributed with |
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.; |
// this work for additional information regarding copyright ownership. |
// IBM Corp.; EMC Corporation, The Open Group. |
// Each contributor licenses this file to you under the OpenPegasus Open |
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; |
// Source License; you may not use this file except in compliance with the |
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
// License. |
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
// |
// EMC Corporation; VERITAS Software Corporation; The Open Group. |
// Permission is hereby granted, free of charge, to any person obtaining a |
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
// copy of this software and associated documentation files (the "Software"), |
// EMC Corporation; Symantec Corporation; The Open Group. |
// to deal in the Software without restriction, including without limitation |
// |
// the rights to use, copy, modify, merge, publish, distribute, sublicense, |
// Permission is hereby granted, free of charge, to any person obtaining a copy |
// and/or sell copies of the Software, and to permit persons to whom the |
// of this software and associated documentation files (the "Software"), to |
// Software is furnished to do so, subject to the following conditions: |
// deal in the Software without restriction, including without limitation the |
// |
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
// The above copyright notice and this permission notice shall be included |
// sell copies of the Software, and to permit persons to whom the Software is |
// in all copies or substantial portions of the Software. |
// furnished to do so, subject to the following conditions: |
// |
// |
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN |
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED |
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT |
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR |
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN |
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
// 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. |
|
// | // |
//============================================================================== |
////////////////////////////////////////////////////////////////////////// |
// | // |
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#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> |
|
|
// Constructs TraceFileHandler | // Constructs TraceFileHandler |
//////////////////////////////////////////////////////////////////////////////// | //////////////////////////////////////////////////////////////////////////////// |
| |
TraceFileHandler::TraceFileHandler() |
TraceFileHandler::TraceFileHandler(): |
{ |
_fileName(0), |
_fileName = 0; |
_fileHandle(0), |
_fileHandle = 0; |
_logErrorBitField(0), |
_wroteToLog = false; |
_configHasChanged(true) |
#ifdef PEGASUS_PLATFORM_LINUX_GENERIC_GNU | #ifdef PEGASUS_PLATFORM_LINUX_GENERIC_GNU |
_baseFileName = 0; |
,_baseFileName(0), |
_fileCount = 0; |
_fileCount(0) |
#endif | #endif |
|
{ |
} | } |
| |
//////////////////////////////////////////////////////////////////////////////// | //////////////////////////////////////////////////////////////////////////////// |
|
|
{ | { |
fclose(_fileHandle); | fclose(_fileHandle); |
} | } |
delete [] _fileName; |
free(_fileName); |
#ifdef PEGASUS_PLATFORM_LINUX_GENERIC_GNU | #ifdef PEGASUS_PLATFORM_LINUX_GENERIC_GNU |
delete [] _baseFileName; |
free(_baseFileName); |
#endif | #endif |
} | } |
| |
//////////////////////////////////////////////////////////////////////////////// | //////////////////////////////////////////////////////////////////////////////// |
// Sets the filename to the given filename and opens the file in append |
// The configuration of the trace has been updated. |
// mode |
// At the next trace write, change to the new configuration. |
//////////////////////////////////////////////////////////////////////////////// | //////////////////////////////////////////////////////////////////////////////// |
|
void TraceFileHandler::configurationUpdated() |
|
{ |
|
_configHasChanged = true; |
|
} |
| |
Uint32 TraceFileHandler::setFileName(const char* fileName) |
//////////////////////////////////////////////////////////////////////////////// |
|
// If the trace configuration has been updated, |
|
// close the old file and open the new file. |
|
//////////////////////////////////////////////////////////////////////////////// |
|
void TraceFileHandler::_reConfigure() |
{ | { |
// If a file is already open, close it |
AutoMutex writeLock(writeMutex); |
if (_fileHandle) |
|
|
if(!_configHasChanged) |
{ | { |
fclose(_fileHandle); |
// An other thread does already the re-configuration. |
_fileHandle = 0; |
// do nothing. |
|
return; |
} | } |
| |
delete [] _fileName; |
free(_fileName); |
_fileName = 0; | _fileName = 0; |
#ifdef PEGASUS_PLATFORM_LINUX_GENERIC_GNU | #ifdef PEGASUS_PLATFORM_LINUX_GENERIC_GNU |
delete [] _baseFileName; |
free(_baseFileName); |
_baseFileName = 0; | _baseFileName = 0; |
#endif | #endif |
| |
if (!isValidFilePath(fileName)) |
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; |
} | } |
_fileHandle = _openFile(fileName); |
|
|
_fileName = strdup((const char*)Tracer::_getInstance() |
|
->_traceFile.getCString()); |
|
|
|
// If a file is already open, close it. |
|
if (_fileHandle) |
|
{ |
|
fclose(_fileHandle); |
|
_fileHandle = 0; |
|
} |
|
|
|
_fileHandle = _openFile(_fileName); |
if (!_fileHandle) | if (!_fileHandle) |
{ | { |
return 1; |
// return with no message. _openFile() already wrote one. |
|
free(_fileName); |
|
_fileName = 0; |
|
// wait for a new trace file |
|
_configHasChanged=false; |
|
return; |
} | } |
| |
_fileName = new char[strlen(fileName)+1]; |
|
strcpy(_fileName, fileName); |
|
#ifdef PEGASUS_PLATFORM_LINUX_GENERIC_GNU | #ifdef PEGASUS_PLATFORM_LINUX_GENERIC_GNU |
_baseFileName = new char[strlen(fileName)+1]; |
_baseFileName = strdup(_fileName); |
strcpy(_baseFileName, fileName); |
|
#endif | #endif |
| |
return 0; |
_configHasChanged=false; |
|
|
|
return; |
} | } |
| |
FILE* TraceFileHandler::_openFile(const char* fileName) | FILE* TraceFileHandler::_openFile(const char* fileName) |
|
|
if (!fileHandle) | if (!fileHandle) |
{ | { |
// Unable to open file, log a message | // Unable to open file, log a message |
Logger::put_l( |
MessageLoaderParms parm( |
Logger::ERROR_LOG, |
"Common.TraceFileHandler.FAILED_TO_OPEN_FILE_SYSMSG", |
System::CIMSERVER, |
"Failed to open file $0: $1", |
Logger::WARNING, |
fileName,PEGASUS_SYSTEM_ERRORMSG_NLS); |
"Common.TraceFileHandler.FAILED_TO_OPEN_FILE", |
_logError(TRCFH_FAILED_TO_OPEN_FILE_SYSMSG,parm); |
"Failed to open file $0", |
|
fileName); |
|
return 0; | return 0; |
} | } |
| |
|
|
// | // |
if (!System::verifyFileOwnership(fileName)) | if (!System::verifyFileOwnership(fileName)) |
{ | { |
Logger::put_l(Logger::ERROR_LOG, System::CIMSERVER, Logger::WARNING, |
MessageLoaderParms parm( |
"Common.TraceFileHandler.UNEXPECTED_FILE_OWNER", | "Common.TraceFileHandler.UNEXPECTED_FILE_OWNER", |
"File $0 is not owned by user $1.", fileName, |
"File $0 is not owned by user $1.", |
|
fileName, |
System::getEffectiveUserName()); | System::getEffectiveUserName()); |
|
_logError(TRCFH_UNEXPECTED_FILE_OWNER,parm); |
fclose(fileHandle); | fclose(fileHandle); |
return 0; | return 0; |
} | } |
|
|
String(fileName), (_S_IREAD|_S_IWRITE)) ) | String(fileName), (_S_IREAD|_S_IWRITE)) ) |
#endif | #endif |
{ | { |
Logger::put_l( |
MessageLoaderParms parm( |
Logger::ERROR_LOG, |
|
System::CIMSERVER, |
|
Logger::WARNING, |
|
"Common.TraceFileHandler.FAILED_TO_SET_FILE_PERMISSIONS", | "Common.TraceFileHandler.FAILED_TO_SET_FILE_PERMISSIONS", |
"Failed to set permissions on file $0", | "Failed to set permissions on file $0", |
fileName); | fileName); |
|
_logError(TRCFH_FAILED_TO_SET_FILE_PERMISSIONS,parm); |
fclose(fileHandle); | fclose(fileHandle); |
return 0; | return 0; |
} | } |
|
|
return fileHandle; | return fileHandle; |
} | } |
| |
Boolean TraceFileHandler::isValidFilePath(const char* filePath) |
void TraceFileHandler::_logError( |
{ |
ErrLogMessageIds msgID, |
String fileName = String(filePath); |
const MessageLoaderParms & parms) |
|
{ |
// Check if the file path is a directory |
static Boolean isLogErrorProgress = false; |
FileSystem::translateSlashes(fileName); |
// msgID has to be within range, else we have a severe coding error |
if (FileSystem::isDirectory(fileName)) |
PEGASUS_ASSERT((msgID >= TRCFH_FAILED_TO_OPEN_FILE_SYSMSG) && |
{ |
(msgID <= TRCFH_UNABLE_TO_WRITE_TRACE_TO_FILE)); |
return false; |
if (!isLogErrorProgress) |
} |
|
|
|
// Check if the file exists and is writable |
|
if (FileSystem::exists(fileName)) |
|
{ |
|
return FileSystem::canWrite(fileName); |
|
} |
|
|
|
// Check if directory is writable |
|
Uint32 index = fileName.reverseFind('/'); |
|
|
|
if (index != PEG_NOT_FOUND) |
|
{ | { |
String dirName = fileName.subString(0,index); |
isLogErrorProgress = true; |
|
if ((_logErrorBitField & (1 << msgID)) == 0) |
if (dirName.size() == 0) |
|
{ | { |
dirName = "/"; |
// 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; |
if (!FileSystem::isDirectory(dirName)) |
|
{ |
|
return false; |
|
} | } |
|
|
return FileSystem::canWrite(dirName); |
|
} | } |
| |
String currentDir; |
|
|
|
// Check if there is permission to write in the |
|
// current working directory |
|
FileSystem::getCurrentDirectory(currentDir); |
|
| |
return FileSystem::canWrite(currentDir); |
|
} |
|
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |