FileHandler.h

Go to the documentation of this file.

// $Id: FileHandler.h,v 1.16.4.1 2011/03/07 11:33:04 mommsen Exp $

#ifndef EventFilter_StorageManager_FileHandler_h
#define EventFilter_StorageManager_FileHandler_h

#include "EventFilter/StorageManager/interface/Configuration.h"
#include "EventFilter/StorageManager/interface/DbFileHandler.h"
#include "EventFilter/StorageManager/interface/FilesMonitorCollection.h"
#include "EventFilter/StorageManager/interface/Utils.h"
#include "IOPool/Streamer/interface/MsgHeader.h"

#include "boost/shared_ptr.hpp"

#include <stdint.h>
#include <string>
#include <sys/types.h>


namespace stor {

  class I2OChain;

  class FileHandler
  {
  public:
        
    FileHandler
    (
      FilesMonitorCollection::FileRecordPtr,
      const DbFileHandlerPtr,
      const DiskWritingParams&,
      const uint64_t& maxFileSize
     );
    
    virtual ~FileHandler() {};
 
    void writeEvent(const I2OChain&);

    bool tooOld(const utils::TimePoint_t currentTime = utils::getCurrentTime());

    bool isFromLumiSection(const uint32_t lumiSection);

    bool tooLarge(const uint64_t& dataSize);


    // File parameter getters //
    
    uint32_t events() const;
    
    uint32_t lumiSection() const
    { return fileRecord_->lumiSection; }
    
    uint64_t fileSize() const;

    virtual void closeFile(const FilesMonitorCollection::FileRecord::ClosingReason&) = 0;


  protected:

    virtual void do_writeEvent(const I2OChain& event) = 0;

    
    // File parameter setters //

    inline void setAdler(uint32_t s)
    { adler_ = s; }
    
    
    // File bookkeeping //
    
    void writeToSummaryCatalog() const;

    void updateDatabase() const;


    void insertFileInDatabase() const;

    
    // File system interaction //
    
    void moveFileToClosed
    (
      const FilesMonitorCollection::FileRecord::ClosingReason&
    );


  private:

    uint64_t checkFileSizeMatch(const std::string& fileName, const uint64_t& size) const;

    bool sizeMismatch(const uint64_t& initialSize, const uint64_t& finalSize) const;

    void makeFileReadOnly(const std::string& fileName) const;

    void renameFile(const std::string& openFileName, const std::string& closedFileName) const;
    
    void checkDirectories() const;
    
    std::string logFile(const DiskWritingParams&) const;

    double calcPctDiff(const uint64_t&, const uint64_t&) const;
    

  private:

    //Prevent copying of the FileHandler
    FileHandler(FileHandler const&);
    FileHandler& operator=(FileHandler const&);


  protected:

    FilesMonitorCollection::FileRecordPtr fileRecord_;
    const DbFileHandlerPtr dbFileHandler_;

    utils::TimePoint_t firstEntry_;                // time when first event was writen
    utils::TimePoint_t lastEntry_;                 // time when latest event was writen

    const DiskWritingParams& diskWritingParams_;
    
  private:
    
    const uint64_t maxFileSize_;                    // maximal file size in bytes
    
    const std::string  logPath_;                    // log path
    const std::string  logFile_;                    // log file including path
    std::string  cmsver_;                           // CMSSW version string

    uint32_t adler_;                                // adler32 checksum for streamer file
  };
  
} // stor namespace

#endif // EventFilter_StorageManager_FileHandler_h