XMLFileCatalog.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
#include <GaudiUtils/IFileCatalog.h>
#include <xercesc/dom/DOMDocument.hpp>
#include <xercesc/dom/DOMElement.hpp>
#include <xercesc/parsers/XercesDOMParser.hpp>
#include <xercesc/sax/ErrorHandler.hpp>
 
#include <memory>
 
// Forward declarations
class IMessageSvc;
 
/*
 *   Gaudi namespace declaration
 */
namespace Gaudi {

  class XMLFileCatalog : public implements<IFileCatalog> {
  protected:
    typedef const std::string& CSTR;
 
  public:
    XMLFileCatalog( CSTR url, IMessageSvc* m );

    std::string createFID() const override;
    CSTR connectInfo() const override { return m_file; }
    void init() override;
    void commit() override;
    void rollback() override {
      if ( dirty() ) init();
    }

    bool readOnly() const override { return m_rdOnly; }
    bool dirty() const override { return m_update; }
    bool existsPFN( CSTR pfn ) const override { return element( pfn, false ) != 0; }
    std::string lookupPFN( CSTR fid ) const override { return lookupFID( fid ); }
    bool existsLFN( CSTR lfn ) const override { return element( lfn, false ) != 0; }
    std::string lookupLFN( CSTR lfn ) const override { return lookupFID( lfn ); }
    bool existsFID( CSTR fid ) const override { return element( fid, false ) != 0; }
    void getPFN( CSTR fid, Files& files ) const override;
    void getLFN( CSTR fid, Files& files ) const override;
    void getFID( Strings& fids ) const override;
    void deleteFID( CSTR FileID ) const override;
    void registerPFN( CSTR fid, CSTR pfn, CSTR ftype ) const override;
    void registerLFN( CSTR fid, CSTR lfn ) const override;
    void registerFID( CSTR fid ) const override;
    void renamePFN( CSTR pfn, CSTR new_pfn ) const override;
    void deletePFN( CSTR pfn ) const override;
    void getMetaData( CSTR fid, Attributes& attr ) const override;
    std::string getMetaDataItem( CSTR fid, CSTR name ) const override;
    void setMetaData( CSTR fid, CSTR name, CSTR value ) const override;
    void dropMetaData( CSTR fid ) const override { dropMetaData( fid, "*" ); }
    void dropMetaData( CSTR fid, CSTR attr ) const override;
 
  private:
    xercesc::DOMDocument* getDoc( bool throw_if_no_exists = true ) const;
    std::string           getfile( bool create );
    void                  printError( CSTR msg, bool throw_exc = true ) const;
    std::string           lookupFID( CSTR lfn ) const;
    xercesc::DOMNode*     element( CSTR fid, bool print_err = true ) const;
    xercesc::DOMNode*     child( xercesc::DOMNode* par, CSTR tag, CSTR attr = "", CSTR val = "" ) const;
    std::pair<xercesc::DOMElement*, xercesc::DOMElement*> i_registerFID( CSTR fid ) const;
    bool                                                  m_rdOnly = false;
    mutable bool                                          m_update = false;
    xercesc::DOMDocument*                                 m_doc    = nullptr;
    std::unique_ptr<xercesc::XercesDOMParser>             m_parser;
    std::unique_ptr<xercesc::ErrorHandler>                m_errHdlr;
    std::string                                           m_file;
    IMessageSvc*                                          m_msgSvc;
  };

  std::string createGuidAsString();
} /* End namespace Gaudi                 */