logrotate.cpp

Go to the documentation of this file.

Go to the SVN repository for this file.

/*  $Id: logrotate.cpp 33815 2007-05-04 17:18:18Z kazimird $
* ===========================================================================
*
*                            PUBLIC DOMAIN NOTICE
*               National Center for Biotechnology Information
*
*  This software/database is a "United States Government Work" under the
*  terms of the United States Copyright Act.  It was written as part of
*  the author's official duties as a United States Government employee and
*  thus cannot be copyrighted.  This software/database is freely available
*  to the public for use. The National Library of Medicine and the U.S.
*  Government have not placed any restriction on its use or reproduction.
*
*  Although all reasonable efforts have been taken to ensure the accuracy
*  and reliability of the software and data, the NLM and the U.S.
*  Government do not and cannot warrant the performance or results that
*  may be obtained by using this software or data. The NLM and the U.S.
*  Government disclaim all warranties, express or implied, including
*  warranties of performance, merchantability or fitness for any particular
*  purpose.
*
*  Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
* Author:  Aaron Ucko, NCBI
*
* File Description:
*   File streams supporting log rotation
*
* ===========================================================================
*/
 
#include <ncbi_pch.hpp>
#include <util/logrotate.hpp>
#include <corelib/ncbifile.hpp>
 
BEGIN_NCBI_SCOPE
 
class CRotatingLogStreamBuf : public CNcbiFilebuf {
public:
    CRotatingLogStreamBuf(CRotatingLogStream* stream, const string& filename,
                          CNcbiStreamoff limit, IOS_BASE::openmode mode);
    CNcbiStreamoff Rotate(void); // returns number of bytes in old log
 
protected:
    virtual CT_INT_TYPE overflow(CT_INT_TYPE c = CT_EOF);
    virtual int sync(void);
 
private:
    CRotatingLogStream* m_Stream;
    string              m_FileName;
    CNcbiStreampos      m_Size;
    CNcbiStreamoff      m_Limit; // in bytes
    IOS_BASE::openmode  m_Mode;
};
 
 
CRotatingLogStreamBuf::CRotatingLogStreamBuf(CRotatingLogStream* stream,
                                             const string&       filename,
                                             CT_OFF_TYPE         limit,
                                             IOS_BASE::openmode  mode)
    : m_Stream(stream),
      m_FileName(filename),
      m_Size(0),
      m_Limit(limit),
      m_Mode(mode)
{
    open(m_FileName.c_str(), m_Mode);
    m_Size = seekoff(0, IOS_BASE::cur, IOS_BASE::out);
}
 
 
CNcbiStreamoff CRotatingLogStreamBuf::Rotate(void)
{
    CNcbiStreampos old_size = m_Size;
    close();
    string old_name = m_FileName; // Copy in case x_BackupName mutates.
    string new_name = m_Stream->x_BackupName(m_FileName);
    if ( !new_name.empty() ) {
        CFile(new_name).Remove();
        CFile(old_name).Rename(new_name);
    }
    open(m_FileName.c_str(), m_Mode);
    m_Size = seekoff(0, IOS_BASE::cur, IOS_BASE::out);
    return m_Size - old_size;
}
 
 
// The use of new_size in overflow and sync is to avoid
// double-counting when one calls the other.  (Which, if either, is
// actually lower-level seems to vary with compiler.)
 
CT_INT_TYPE CRotatingLogStreamBuf::overflow(CT_INT_TYPE c)
{
    // The only operators CNcbiStreampos reliably seems to support
    // are += and -=, so stick to those. :-/
    CNcbiStreampos new_size = m_Size, old_size = m_Size;
    new_size += pptr() - pbase();
    if ( !CT_EQ_INT_TYPE(c, CT_EOF) ) {
        new_size += 1;
    }
    // Perform output first, in case switching files discards data.
    CT_INT_TYPE result = CNcbiFilebuf::overflow(c);
    if (m_Size - old_size < 0) {
        return result; // assume filebuf::overflow called Rotate via sync.
    }
    // Don't assume the buffer's actually empty; some implementations
    // seem to handle the case of pptr() being null by setting the
    // pointers and writing c to the buffer but not actually flushing
    // it to disk. :-/
    new_size -= pptr() - pbase();
    m_Size = new_size;
    // Hold off on rotating logs until actually producing new output
    // (even if they were already overdue for rotation), to avoid a
    // possible recursive double-rotation scenario.
    if (m_Size - CNcbiStreampos(0) >= m_Limit  &&  m_Size != old_size) {
        Rotate();
    }
    return result;
}
 
 
int CRotatingLogStreamBuf::sync(void)
{
    // Perform output first, in case switching files discards data.
    CNcbiStreampos new_size = m_Size, old_size = m_Size;
    new_size += pptr() - pbase();
    int result = CNcbiFilebuf::sync();
    if (m_Size - old_size < 0) {
        return result; // assume filebuf::sync called Rotate via overflow.
    }
    // pptr() ought to equal pbase() now, but just in case...
    new_size -= pptr() - pbase();
    m_Size = new_size;
    // Hold off on rotating logs until actually producing new output.
    if (m_Size - CNcbiStreampos(0) >= m_Limit  &&  m_Size != old_size) {
        Rotate();
    }
    return result;
}
 
 
 
CRotatingLogStream::CRotatingLogStream(const string& filename,
                                       CNcbiStreamoff limit, openmode mode)
    : CNcbiOstream(new CRotatingLogStreamBuf(this, filename, limit, mode))
{
}
 
CRotatingLogStream::~CRotatingLogStream()
{
    delete rdbuf();
}
 
 
CNcbiStreamoff CRotatingLogStream::Rotate(void)
{
    flush();
    return dynamic_cast<CRotatingLogStreamBuf*>(rdbuf())->Rotate();
}
 
 
string CRotatingLogStream::x_BackupName(string& name)
{
#if defined(NCBI_OS_UNIX) && !defined(NCBI_OS_CYGWIN)
    return name + CurrentTime().AsString(".Y-M-D-Z-h:m:s");
#else
    // Colons are special; avoid them.
    return name + CurrentTime().AsString(".Y-M-D-Z-h-m-s");
#endif
}
 
 
END_NCBI_SCOPE