---

CdbBdbSViewP.cc

Go to the documentation of this file.

// File and Version Information:
//      $Id: CdbBdbSViewP.cc,v 1.16 2004/12/08 09:26:55 gapon Exp $

/// Implementation file for the CdbBdbSViewP class
/**
  * @see CdbBdbSViewP
  */

#include "BaBar/BaBar.hh"

#include "CdbBdbShared/CdbBdbSViewP.hh"

#include "CdbBdbShared/CdbBdbSFolderP.hh"
#include "CdbBdbShared/CdbBdbSFolderPItr.hh"
#include "CdbBdbShared/CdbBdbSRegistryP.hh"
#include "CdbBdbShared/CdbBdbSViewCollectionP.hh"
#include "CdbBdbShared/CdbBdbSRallocatorP.hh"

#include "CdbBase/CdbPathName.hh"

#include <assert.h>
using std::cout;
using std::endl;
using std::ostream;

CdbBdbSViewP::CdbBdbSViewP( const char*                             theName,
                            d_UShort                                theId,
                            const char*                             theDescription,
                            const BdbTime&                          theCreationTime,
                            const BdbTime&                          theMinValidityTime,
                            const BdbTime&                          theMaxValidityTime,
                            const BdbRef(CdbBdbSConfigCollectionP)& theDefaultConfigRef ) :
    CdbBdbSCollectionElementP( theName,
                               theId ),
    _description(theDescription),
    _created(theCreationTime),
    _minValidityTime(theMinValidityTime),
    _maxValidityTime(theMaxValidityTime),
    _defaultConfigRef(theDefaultConfigRef),
    _rootFolderRef(0),
    _isFrozen(d_False)
{
    assert( 0 != theDescription );
    assert(( BdbTime::minusInfinity != theCreationTime ) && ( BdbTime::plusInfinity != theCreationTime ));

    _rootFolderRef = new( ooThis( )) CdbBdbSFolderP( CdbPathName::separator( ),
                                                     "The ROOT folder of the current view",
                                                     theCreationTime,
                                                     ooThis( ),
                                                     0 );
}

CdbBdbSViewP::~CdbBdbSViewP( ) 
{ }

CdbStatus
CdbBdbSViewP::clone( BdbRef(CdbBdbSViewP)& theRef,
                     const char*           theName,
                     const char*           theDescription ) const
{
    const char* errorStr = "CdbBdbSViewP::clone() -- ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

        BdbTime operationTime( BdbTime::now( ));

      // Get to the local registry

        BdbHandle(CdbBdbSRegistryP) rH;
        if( CdbStatus::Success != CdbBdbSRegistryP::findLocal( rH )) {
            cout << errorStr << endl
                 << "    Failed to locate the local registry." << endl;
            break;
        }

      // Get collection(s)

        BdbRef(CdbBdbSViewCollectionP) vCollRef = rH->viewCollection( );
        assert( ! BdbIsNull(vCollRef));

        BdbRef(CdbBdbSRallocatorP< d_UShort >) vRaRef = rH->viewRallocator( );
        assert( ! BdbIsNull(vRaRef));

      // Make sure there is no view with such name in the collection

        if( CdbStatus::Success == vCollRef->find( theName,
                                                  theRef )) {
            cout << errorStr << endl
                 << "    A view with specified name already exists." << endl;
            break;
        }

      // Allocate identifier for the view

        d_UShort vId;
        if( CdbStatus::Success != vRaRef->allocate( vId )) {
            cout << errorStr << endl
                 << "    Failed to allocate a view identifier." << endl;
            break;
        }

      // Make a copy of the default configuration if any

        BdbRef(CdbBdbSConfigCollectionP) configRef;
        if( !BdbIsNull(_defaultConfigRef)) {
            if( CdbStatus::Success != _defaultConfigRef->clone( configRef,
                                                                vCollRef )) {
                cout << errorStr << endl
                     << "    Failed to clone the default configuration object." << endl;

                vRaRef->release( vId );

                break;
            }
        }

      // Determine the location of the new object first, then create
      // the new object.


        theRef = new( vCollRef ) CdbBdbSViewP( theName,
                                               vId,
                                               theDescription,
                                               operationTime,
                                               _minValidityTime,
                                               _maxValidityTime,
                                               configRef );
        assert( ! BdbIsNull(theRef));

      // Nown browse the original view and copy its folders, conditions and their
      // configurations into the output view.

        if( CdbStatus::Success != cloneComponents( _rootFolderRef,
                                                   theRef->_rootFolderRef )) {
            cout << errorStr << endl
                 << "    Failed to clone the components of the view object." << endl;

            vRaRef->release( vId );
            BdbDelete(theRef);

            break;
        }

      // Register this view in the collection

        if( CdbStatus::Success != vCollRef->insert( theRef )) {
            cout << errorStr << endl
                 << "    Failed to insert new view into the collection." << endl;

            vRaRef->release( vId );
            BdbDelete(theRef);

            break;
        }

      // Done

        result = CdbStatus::Success;

    } while( false );

    return result;
}

ooString(32)
CdbBdbSViewP::description( ) const
{
    return _description;
}

BdbTime
CdbBdbSViewP::created( ) const
{
    return _created;
}

BdbTime
CdbBdbSViewP::minValidity( ) const
{
    return _minValidityTime;
}

BdbTime
CdbBdbSViewP::maxValidity( ) const
{
    return _maxValidityTime;
}

BdbRef(CdbBdbSConfigCollectionP)
CdbBdbSViewP::defaultConfig( ) const
{
    return _defaultConfigRef;
}

BdbRef(CdbBdbSFolderP)
CdbBdbSViewP::rootFolder( ) const
{
    return _rootFolderRef;
}

bool
CdbBdbSViewP::isFrozen( ) const
{
    return _isFrozen;
}

void
CdbBdbSViewP::freeze( )
{
    ooUpdate( );
    _isFrozen = d_True;
}

void
CdbBdbSViewP::warm( )
{
    ooUpdate( );
    _isFrozen = d_False;
}

CdbStatus
CdbBdbSViewP::setDefaultConfig( const BdbRef(CdbBdbSConfigCollectionP)& theConfigRef )
{
    const char* errorStr = "CdbBdbSViewP::setDefaultConfig() - ERROR.";

    ooUpdate( );

    CdbStatus result = CdbStatus::Error;
    do {

      // Check the current state of the view

        if( isFrozen( )) {
            cout << errorStr << endl
                 << "    This view is already frozen, which means that it can't be" << endl
                 << "    reconfigured anymore." << endl;
            break;
        }

      // Replace and delete (if any) the previously known configuration
      // with the new one.
      //
      // NOTE: If the passed reference is the same than the one we have then
      //       we don't remove existing one to avoid dangling references.
      //       Known reference might be passed if a client has updated configuration
      //       and explictly wants this configuration to present.

        if( ! BdbIsNull(_defaultConfigRef)) {
            if( theConfigRef != _defaultConfigRef ) BdbDelete(_defaultConfigRef);
        }
        _defaultConfigRef = theConfigRef;

      // Done

        result = CdbStatus::Success;

    } while( false );

    return result;
}

CdbStatus
CdbBdbSViewP::setConfig( const char*                             thePathName,
                         const BdbRef(CdbBdbSConfigCollectionP)& theConfigRef,
                         bool                                    dontDestroyConfigObject )
{
    const char* errorStr = "CdbBdbSViewP::setConfig() - ERROR.";

    ooUpdate( );

    CdbStatus result = CdbStatus::Error;
    do {

      // Check the current state of the view

        if( isFrozen( )) {
            cout << errorStr << endl
                 << "    This view is already frozen, which means that it can't be" << endl
                 << "    reconfigured anymore." << endl;
            break;
        }

      // Find the condition

        BdbRef(CdbBdbSConditionAtFolderP) cRef;
        if( CdbStatus::Success != findCondition( thePathName,
                                                 cRef )) {
            result = CdbStatus::NotFound;
            break;
        }

      // Finish

        result = cRef->setConfig( theConfigRef,
                                  dontDestroyConfigObject );

    } while( false );

    return result;
}

CdbStatus
CdbBdbSViewP::createFolder( const char*    thePathName,
                            const char*    theNewFolderName,
                            const char*    theDescription,
                            const BdbTime& theCreationTime )
{
    const char* errorStr = "CdbBdbSViewP::createFolder() - ERROR.";

    ooUpdate( );

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName fPath( theNewFolderName );

        if(( ! fPath.isValid( )) || fPath.isRoot( ) || fPath.isComposite( )) {
            cout << errorStr << endl
                 << "    Illegal new folder name passed to the procedure." << endl
                 << "    A non-composite and non-root folder name was expected." << endl
                 << "        PASSED NAME: \"" << theNewFolderName << "\"" << endl;
            break;
        }

      // Check the current state of the view

        if( isFrozen( )) {
            cout << errorStr << endl
                 << "    This view is already frozen, which means that it can't be" << endl
                 << "    reconfigured anymore." << endl;
            break;
        }
    
      // Find the "host" folder.

        BdbRef(CdbBdbSFolderP) hRef;

        result = findFolder( thePathName, hRef );
        if( CdbStatus::Success != result ) break;

      // Create new object

        BdbRef(CdbBdbSFolderP) fRef = new( ooThis( )) CdbBdbSFolderP( theNewFolderName,
                                                                      theDescription,
                                                                      theCreationTime,
                                                                      ooThis( ),
                                                                      hRef );

      // Do the final registration. Remove the previously created
      // object if it does not work.

        result = hRef->insert( fRef );
        if( CdbStatus::Success != result ) BdbDelete( fRef );

    } while( false );

    return result;
}

CdbStatus
CdbBdbSViewP::createFolder( const char*    theFullPathName,
                            const char*    theDescription,
                            const BdbTime& theCreationTime )
{
    const char* errorStr = "CdbBdbSViewP::createFolder(recursive) - ERROR.";

    ooUpdate( );

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName fPath( theFullPathName );

        if(( ! fPath.isValid( )) || ( ! fPath.isAbsolute( ))) {
            cout << errorStr << endl
                 << "    Illegal folder name passed to the procedure." << endl
                 << "    A valid, absolute folder name was expected." << endl
                 << "        PASSED NAME: \"" << theFullPathName << "\"" << endl;
            break;
        }

      // Check the current state of the view

        if( isFrozen( )) {
            cout << errorStr << endl
                 << "    This view is already frozen, which means that it can't be" << endl
                 << "    reconfigured anymore." << endl;
            break;
        }
    
      // Just quit if the ROOT folder was specified simple because this folder
      // must always exist.

        if( fPath.isRoot( )) {
            result = CdbStatus::Success;
        } else {

          // Delegate operation to create the rest of the path to the "root" folder.
          //
          // NOTE: This is a recursive operation. The "root" folder may propagate
          //       down the chain.

            result = _rootFolderRef->createFolder( fPath.afterFirst( ).toString( ).c_str( ),
                                                   theDescription,
                                                   theCreationTime );
        }

    } while( false );

    return result;
}

CdbStatus
CdbBdbSViewP::createCondition( const char*                             thePathName,
                               const char*                             theNewConditionName,
                               const char*                             theDescription,
                               const BdbTime&                          theCreationTime,
                               const CdbBdbSId&                        theId,
                               const BdbRef(CdbBdbSConfigCollectionP)& theConfigRef )
{
    ooUpdate( );

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName cPath( theNewConditionName );

        if(( ! cPath.isValid( )) || cPath.isRoot( ) || cPath.isComposite( )) {
            cout << "CdbBdbSViewP::createCondition() - ERROR." << endl
                 << "    Illegal new condition name passed to the procedure." << endl
                 << "    A non-composite and non-root condition name was expected." << endl
                 << "        PASSED NAME: \"" << theNewConditionName << "\"" << endl;
            break;
        }

      // Check the current state of the view

        if( isFrozen( )) {
            cout << "CdbBdbSViewP::createCondition() - ERROR." << endl
                 << "    This view is already frozen, which means that it can't be" << endl
                 << "    reconfigured anymore." << endl;
            break;
        }

      // Find the "host" folder.

        BdbRef(CdbBdbSFolderP) hRef;

        result = findFolder( thePathName, hRef );
        if( CdbStatus::Success != result ) break;

      // Create new object

        BdbRef(CdbBdbSConditionAtFolderP) cRef
            = new( ooThis( )) CdbBdbSConditionAtFolderP( theNewConditionName,
                                                         theDescription,
                                                         theCreationTime,
                                                         theId,
                                                         hRef,
                                                         theConfigRef );

      // Do the final registration. Remove the previously created
      // object if it does not work.

        result = hRef->insert( cRef );
        if( CdbStatus::Success != result ) BdbDelete( cRef );

    } while( false );

    return result;
}

CdbStatus
CdbBdbSViewP::removeFolder( const char* thePathName,
                            bool        forceFlag )
{
    ooUpdate( );

    const char* errorStr = "CdbBdbSViewP::removeFolder( ) - ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName fName( thePathName );

        if( fName.isValid( ) && fName.isRoot( )) {
            cout << errorStr << endl
                 << "    The ROOT folder can't be deleted in this way. It can only be" << endl
                 << "    deleted with its host view." << endl;
            break;
        }

      // Check the current state of the view

        if( isFrozen( )) {
            cout << "CdbBdbSViewP::removeFolder() - ERROR." << endl
                 << "    This view is already frozen, which means that it can't be" << endl
                 << "    reconfigured anymore." << endl;
            break;
        }

      // Find the "host" folder.

        BdbRef(CdbBdbSFolderP) fRef;

        result = findFolder( fName.beforeLast( ).toString( ).c_str( ), fRef );
        if( CdbStatus::Success != result ) break;

      // And finally - ask the "host" to follow up with the actual removal.

        result = fRef->removeFolder( fName.last( ),
                                     forceFlag );

    } while( false );

    return result;
}

CdbStatus
CdbBdbSViewP::removeCondition( const char* thePathName )
{
    ooUpdate( );

    const char* errorStr = "CdbBdbSViewP::removeCondition( ) - ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName fName( thePathName );

        if( fName.isValid( ) && fName.isRoot( )) {
            cout << errorStr << endl
                 << "    The ROOT name can't be passed to this procedure." << endl;
            break;
        }

      // Check the current state of the view

        if( isFrozen( )) {
            cout << "CdbBdbSViewP::removeCondition() - ERROR." << endl
                 << "    This view is already frozen, which means that it can't be" << endl
                 << "    reconfigured anymore." << endl;
            break;
        }

      // Find the "host" folder.

        BdbRef(CdbBdbSFolderP) fRef;

        result = findFolder( fName.beforeLast( ).toString( ).c_str( ), fRef );
        if( CdbStatus::Success != result ) break;

      // And finally - ask the "host" to follow up with the actual removal.

        result = fRef->removeCondition( fName.last( ));

    } while( false );

    return result;
}

CdbStatus
CdbBdbSViewP::findFolder( const char*             thePathName,
                          BdbRef(CdbBdbSFolderP)& theRef ) const
{
    const char* errorStr = "CdbBdbSViewP::findFolder( ) - ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName fPath( thePathName );

        if( ! ( fPath.isValid( ) && fPath.isAbsolute( ))) {
            cout << errorStr << endl
                 << "    Illegal path name passed to the procedure: " << thePathName << endl;
            break;
        }

      // Proceed with search

        if( fPath.isRoot( )) theRef = _rootFolderRef;
        else
            return _rootFolderRef->findFolder( fPath.afterFirst( ),
                                               theRef );
     // Done

        result = CdbStatus::Success;

    } while( false );

    return result;
}

CdbStatus
CdbBdbSViewP::findCondition( const char*                        thePathName,
                             BdbRef(CdbBdbSConditionAtFolderP)& theRef ) const
{
    const char* errorStr = "CdbBdbSViewP::findCondition( ) - ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName cPath( thePathName );

        if( ! ( cPath.isValid( ) && cPath.isAbsolute( ) && ( ! cPath.isRoot( )))) {
            cout << errorStr << endl
                 << "    Illegal path name passed to the procedure: " << thePathName << endl;
            break;
        }

      // Find a folder hosting the condition

        BdbRef(CdbBdbSFolderP) fRef;
        if( CdbStatus::Success != findFolder( cPath.beforeLast( ).toString( ).c_str( ), fRef )) {
            result = CdbStatus::NotFound;
            break;
        }

      // Find the desired condition itself

        result = fRef->findCondition( cPath.last( ), theRef );

    } while( false );

    return result;
}

CdbStatus
CdbBdbSViewP::folderIterator( CdbItr< const char* >& theItr ) const
{
  // Since we're not passing any parent folder to this iterator
  // then only ROOT folder will be delivered by it.
  //
  // NOTE: There is no memory leak in this code because the ownership
  //       over the created instance of the iterator will be passed
  //       to the generic iterator.

    theItr = CdbItr< const char* >( new CdbBdbSFolderPItr( ));
    return CdbStatus::Success;
}

void
CdbBdbSViewP::dump( ostream& o ) const
{
    o << "          NAME: " << name( ).head( ) << endl
      << "            ID: " << id( ) << endl
      << "   DESCRIPTION: " << _description.head( ) << endl
      << "       CREATED: " << _created << endl
      << "  MIN.VALIDITY: " << _minValidityTime << endl
      << "  MAX.VALIDITY: " << _maxValidityTime << endl
      << "     IS FROZEN: " << ( _isFrozen ? "Yes" : "No" ) << endl
      << "DEFAULT CONFIG: " << _defaultConfigRef.sprint( ) << endl;

    if( !BdbIsNull(_defaultConfigRef)) {
        o << "......................................................." << endl
          << endl;
        _defaultConfigRef->dump( o );
        o << "......................................................." << endl;
    }
}

CdbStatus
CdbBdbSViewP::cloneComponents( const BdbRef(CdbBdbSFolderP)& theInFolderRef,
                               const BdbRef(CdbBdbSFolderP)& theOutFolderRef )
{

    const char* errorStr = "CdbBdbSViewP::cloneComponents( ) - ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Clone conditions if any

        {
            CdbItr< const char* > cInItr;
            if( CdbStatus::Success != theInFolderRef->conditionIterator( cInItr )) {
                cout << errorStr << endl
                     << "    Failed to set up an iterator of conditions." << endl;
                break;
            }

            bool failed = false;

            while( cInItr.next( )) {

                BdbRef(CdbBdbSConditionAtFolderP) cInRef;
                if( CdbStatus::Success != theInFolderRef->findCondition( CdbPathName( cInItr.value( )),
                                                                         cInRef )) {
                    cout << errorStr << endl
                         << "    Failed to find the condition. The input view may be" << endl
                         << "    internally inconsistent." << endl;

                    failed = true;
                    break;
                }
                BdbRef(CdbBdbSConfigCollectionP) configOutRef = 0;
                {
                    BdbRef(CdbBdbSConfigCollectionP) configInRef = cInRef->config( );
                    if( !BdbIsNull(configInRef)) {
                        if( CdbStatus::Success != configInRef->clone( configOutRef,
                                                                      theOutFolderRef )) {
                            cout << errorStr << endl
                                 << "    Failed to clone the condition's configuration object." << endl;

                            failed = true;
                            break;
                        }
                    }
                }
                BdbRef(CdbBdbSConditionAtFolderP) cOutRef;
                cOutRef = new( theOutFolderRef ) CdbBdbSConditionAtFolderP( cInRef->name( ),
                                                                            cInRef->description( ),
                                                                            theOutFolderRef->created( ),
                                                                            cInRef->id( ),
                                                                            theOutFolderRef,
                                                                            configOutRef );
                assert( !BdbIsNull(cOutRef));

                if( CdbStatus::Success != theOutFolderRef->insert( cOutRef )) {

                    cout << errorStr << endl
                         << "    Failed to insert cloned condition into its parrent folder." << endl;

                    BdbDelete(cOutRef);

                    failed = true;
                    break;
                }
            }
            if( failed ) break;
        }

      // Clone folders if any

        {
            CdbItr< const char* > fInItr;
            if( CdbStatus::Success != theInFolderRef->folderIterator( fInItr )) {
                cout << errorStr << endl
                     << "    Failed to set up an iterator of folders." << endl;
                break;
            }

            bool failed = false;

            while( fInItr.next( )) {

                BdbRef(CdbBdbSFolderP) fInRef;
                if( CdbStatus::Success != theInFolderRef->findFolder( CdbPathName( fInItr.value( )),
                                                                      fInRef )) {
                    cout << errorStr << endl
                         << "    Failed to find the folder. The input view may be" << endl
                         << "    internally inconsistent." << endl;

                    failed = true;
                    break;
                }
                BdbRef(CdbBdbSFolderP) fOutRef;
                fOutRef = new( theOutFolderRef ) CdbBdbSFolderP( fInRef->name( ),
                                                                 fInRef->description( ),
                                                                 theOutFolderRef->created( ),
                                                                 theOutFolderRef->parentView( ),
                                                                 theOutFolderRef );
                assert( !BdbIsNull(fOutRef));

                if( CdbStatus::Success != theOutFolderRef->insert( fOutRef )) {

                    cout << errorStr << endl
                         << "    Failed to insert cloned folder into its parrent folder." << endl;

                    BdbDelete(fOutRef);

                    failed = true;
                    break;
                }

              // Proceed down the newly created folder

                if( CdbStatus::Success != cloneComponents( fInRef,
                                                           fOutRef )) {
                    failed = true;
                    break;
                }

            }
            if( failed ) break;
        }

      // Done

        result = CdbStatus::Success;

    } while( false );

    return result;
}

/////////////////
// End Of File //
/////////////////

---