kmail/filterlog.cpp

   1 /*
   2     This file is part of KMail.
   3     Copyright (c) 2003 Andreas Gungl <a.gungl@gmx.de>
   4
   5     KMail is free software; you can redistribute it and/or modify it
   6     under the terms of the GNU General Public License, version 2, as
   7     published by the Free Software Foundation.
   8
   9     KMail is distributed in the hope that it will be useful, but
  10     WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12     General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18     In addition, as a special exception, the copyright holders give
  19     permission to link the code of this program with any edition of
  20     the Qt library by Trolltech AS, Norway (or with modified versions
  21     of Qt that use the same license as Qt), and distribute linked
  22     combinations including the two.  You must obey the GNU General
  23     Public License in all respects for all of the code used other than
  24     Qt.  If you modify this file, you may extend this exception to
  25     your version of the file, but you are not obligated to do so.  If
  26     you do not wish to do so, delete this exception statement from
  27     your version.
  28 */
  29
  30
  31 #include "filterlog.h"
  32
  33 #include "messageviewer/util.h"
  34
  35 #include <kdebug.h>
  36
  37 #include <QFile>
  38 #include <QByteArray>
  39 #include <QTime>
  40
  41 #include <sys/stat.h>
  42
  43
  44 using namespace KMail;
  45
  46
  47 FilterLog * FilterLog::mSelf = NULL;
  48
  49
  50 FilterLog::FilterLog()
  51 {
  52   mSelf = this;
  53   // start with logging disabled by default
  54   mLogging = false;
  55   // better limit the log to 512 KByte to avoid out of memory situations
  56   // when the log i sgoing to become very long
  57   mMaxLogSize = 512 * 1024;
  58   mCurrentLogSize = 0;
  59   mAllowedTypes =  meta | patternDesc | ruleResult |
  60                    patternResult | appliedAction;
  61 }
  62
  63
  64 FilterLog::~FilterLog()
  65 {}
  66
  67
  68 FilterLog * FilterLog::instance()
  69 {
  70   if ( !mSelf ) mSelf = new FilterLog();
  71   return mSelf;
  72 }
  73
  74
  75 void FilterLog::add( const QString& logEntry, ContentType contentType )
  76 {
  77   if ( isLogging() && ( mAllowedTypes & contentType ) )
  78   {
  79     QString timedLog = '[' + QTime::currentTime().toString() + "] ";
  80     if ( contentType & ~meta )
  81       timedLog += logEntry;
  82     else
  83       timedLog = logEntry;
  84     mLogEntries.append( timedLog );
  85     emit logEntryAdded( timedLog );
  86     mCurrentLogSize += timedLog.length();
  87     checkLogSize();
  88   }
  89 }
  90
  91
  92 void FilterLog::setMaxLogSize( long size )
  93 {
  94   if ( size < -1)
  95     size = -1;
  96   // do not allow less than 1 KByte except unlimited (-1)
  97   if ( size >= 0 && size < 1024 )
  98     size = 1024;
  99   mMaxLogSize = size;
 100   emit logStateChanged();
 101   checkLogSize();
 102 }
 103
 104
 105 void FilterLog::dump()
 106 {
 107 #ifndef NDEBUG
 108   kDebug() << "----- starting filter log -----";
 109   for ( QStringList::ConstIterator it = mLogEntries.constBegin();
 110         it != mLogEntries.constEnd(); ++it )
 111   {
 112     kDebug() << *it;
 113   }
 114   kDebug() << "------ end of filter log ------";
 115 #endif
 116 }
 117
 118
 119 void FilterLog::checkLogSize()
 120 {
 121   if ( mCurrentLogSize > mMaxLogSize && mMaxLogSize > -1 )
 122   {
 123     kDebug() << "Filter log: memory limit reached, starting to discard old items, size ="
 124                   << QString::number( mCurrentLogSize );
 125     // avoid some kind of hysteresis, shrink the log to 90% of its maximum
 126     while ( mCurrentLogSize > ( mMaxLogSize * 0.9 ) )
 127     {
 128       QStringList::Iterator it = mLogEntries.begin();
 129       if ( it != mLogEntries.end())
 130       {
 131         mCurrentLogSize -= (*it).length();
 132         mLogEntries.erase( it );
 133         kDebug() << "Filter log: new size ="
 134                       << QString::number( mCurrentLogSize );
 135       }
 136       else
 137       {
 138         kDebug() << "Filter log: size reduction disaster!";
 139         clear();
 140       }
 141     }
 142     emit logShrinked();
 143   }
 144 }
 145
 146
 147 bool FilterLog::saveToFile( const QString &fileName )
 148 {
 149     QFile file( fileName );
 150     if( file.open( QIODevice::WriteOnly ) ) {
 151       fchmod( file.handle(), MessageViewer::Util::getWritePermissions() );
 152       {
 153         QDataStream ds( &file );
 154         for ( QStringList::const_iterator it = mLogEntries.constBegin();
 155               it != mLogEntries.constEnd(); ++it )
 156         {
 157           const QString tmpString = *it + '\n';
 158           QByteArray cstr( tmpString.toLocal8Bit() );
 159           ds.writeRawData( cstr.data(), cstr.size() );
 160         }
 161       }
 162       return true;
 163     }
 164     else
 165       return false;
 166 }
 167
 168
 169 #include "filterlog.moc"