//%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.
//
//==============================================================================
//
// Author: Nitin Upasani, Hewlett-Packard Company (Nitin_Upasani@hp.com)
//
// Modified By: Sushma Fernandes,
//                 Hewlett-Packard Company (sushma_fernandes@hp.com)
//              Yi Zhou Hewlett-Packard Company (yi_zhou@hp.com)
//              Sean Keenan (sean.keenan@hp.com)
//              Josephine Eskaline Joyce, IBM (jojustin@in.ibm.com) for PEP # 101
//              Vageesh Umesh, IBM (vagumesh@in.ibm.com) for BUG#2543
//              Carol Ann Krug Graves, Hewlett-Packard Company
//                  (carolann_graves@hp.com)
//
//%/////////////////////////////////////////////////////////////////////////////

#include <Pegasus/Common/Config.h>
#include <cstdlib>
//#include <dlfcn.h>
#include <Pegasus/Common/FileSystem.h>
#include <Pegasus/Common/Tracer.h>
#include "HandlerTable.h"

PEGASUS_USING_STD;
PEGASUS_NAMESPACE_BEGIN

HandlerTable::HandlerTable()
{
}

CIMHandler* HandlerTable::getHandler(
    const String& handlerId,
    CIMRepository* repository)
{
    CIMHandler * handler;
    {
        ReadLock lock(_handlerTableLock);
        handler = _lookupHandler(handlerId);
	if (handler)
        {
            return (handler);
        }
    }

    {
        WriteLock lock(_handlerTableLock);
	handler = _lookupHandler(handlerId);
        // Note: Lock handler table until handler initialize is done.
	// This is ok for handler since the initialization is simple.
	if (!handler)
        {
            handler = _loadHandler(handlerId);
            handler->initialize(repository);
        }

        return (handler);
    }
}

CIMHandler* HandlerTable::_lookupHandler(const String& handlerId)
{
    for (Uint32 i = 0, n = _handlers.size(); i < n; i++)
	if (String::equal(_handlers[i].handlerId, handlerId))
	    return _handlers[i].handler;

    return 0;
}

typedef CIMHandler* (*CreateHandlerFunc)(const String&);

CIMHandler* HandlerTable::_loadHandler(const String& handlerId)
{
#if defined (PEGASUS_OS_VMS)
    String provDir = ConfigManager::getInstance()->getCurrentValue("providerDir");
    String fileName = ConfigManager::getHomedPath(provDir) + "/" + 
                       FileSystem::buildLibraryFileName(handlerId) + ".exe";
#elif defined(PEGASUS_OS_OS400)
    Uint32 lastSlash = handlerId.reverseFind('/');
    if (lastSlash == PEG_NOT_FOUND)
      throw DynamicLoadFailed(handlerId);
    String fileName = handlerId.subString(0, lastSlash);
    String os400HandlerId = handlerId.subString(lastSlash + 1);
#else
    String fileName = ConfigManager::getHomedPath((PEGASUS_DEST_LIB_DIR) +
        String("/") + FileSystem::buildLibraryFileName(handlerId));
#endif

    HandlerEntry entry(handlerId, fileName);

    if (!entry.handlerLibrary.load())
    {
#if defined(PEGASUS_OS_TYPE_WINDOWS)
        throw DynamicLoadFailed(fileName);
#else
        throw DynamicLoadFailed(entry.handlerLibrary.getLoadErrorMessage());
#endif
    }

    // Lookup the create handler symbol:

    CreateHandlerFunc func = (CreateHandlerFunc)
        entry.handlerLibrary.getSymbol("PegasusCreateHandler");

    if (!func)
    {
	throw DynamicLookupFailed("PegasusCreateHandler");
    }

    // Create the handler:

    entry.handler = func(handlerId);

    //
    //  ATTN: to support dynamically pluggable handlers, the entry.handler
    //  returned from the PegasusCreateHandler_<handlerId> function would
    //  need to be validated to be non-null
    //
    PEGASUS_ASSERT(entry.handler);

    _handlers.append(entry);

    return entry.handler;
}

HandlerTable::~HandlerTable()
{
    for( Uint32 i = 0; i < _handlers.size(); i++ )
    {
        //
        //  Call handler's terminate() method
        //
        try
        {
            _handlers[i].handler->terminate();
        }
        catch (...)
        {
            PEGASUS_ASSERT(0);
            PEG_TRACE_STRING(TRC_DISCARDED_DATA, Tracer::LEVEL3,
                "Unknown error caught from " +
                _handlers[i].handlerId +
                " terminate() method");
        }

        delete _handlers[i].handler;
    }
}

PEGASUS_NAMESPACE_END