knode/kncleanup.cpp

   1 /*
   2     KNode, the KDE newsreader
   3     Copyright (c) 1999-2005 the KNode authors.
   4     See file AUTHORS for details
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10     You should have received a copy of the GNU General Public License
  11     along with this program; if not, write to the Free Software Foundation,
  12     Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, US
  13 */
  14
  15
  16 #include <QDir>
  17 #include <QFile>
  18 #include <QLabel>
  19 #include <QProgressBar>
  20 #include <QVBoxLayout>
  21 #include <QApplication>
  22 #include <QFrame>
  23 #include <QTextStream>
  24 #include <QCloseEvent>
  25
  26 #include <klocale.h>
  27 #include <kmessagebox.h>
  28 #include <kseparator.h>
  29 #include <kdebug.h>
  30
  31 #include "knfolder.h"
  32 #include "knglobals.h"
  33 #include "kncleanup.h"
  34 #include "knconfig.h"
  35 #include "knfoldermanager.h"
  36 #include "kngroupmanager.h"
  37 #include "knarticlemanager.h"
  38 #include "knnntpaccount.h"
  39
  40
  41 KNCleanUp::KNCleanUp() :  d_lg(0)
  42 {
  43 }
  44
  45
  46 KNCleanUp::~KNCleanUp()
  47 {
  48   delete d_lg;
  49 }
  50
  51
  52 void KNCleanUp::start()
  53 {
  54   if ( mColList.isEmpty() )
  55     return;
  56
  57   d_lg = new ProgressDialog( mColList.count() );
  58   d_lg->show();
  59
  60   for ( QList<KNArticleCollection*>::Iterator it = mColList.begin(); it != mColList.end(); ++it ) {
  61     if ( (*it)->type() == KNCollection::CTgroup ) {
  62       d_lg->showMessage( i18n("Deleting expired articles in <b>%1</b>", (*it)->name() ) );
  63       qApp->processEvents();
  64       expireGroup( static_cast<KNGroup*>( (*it) ) );
  65       d_lg->doProgress();
  66     }
  67     else if ( (*it)->type() == KNCollection::CTfolder ) {
  68       d_lg->showMessage( i18n("Compacting folder <b>%1</b>", (*it)->name() ) );
  69       qApp->processEvents();
  70       compactFolder( static_cast<KNFolder*>( (*it) ) );
  71       d_lg->doProgress();
  72     }
  73   }
  74
  75   delete d_lg;
  76   d_lg=0;
  77 }
  78
  79
  80 void KNCleanUp::reset()
  81 {
  82   mColList.clear();
  83   if(d_lg) {
  84     delete d_lg;
  85     d_lg=0;
  86   }
  87 }
  88
  89
  90 void KNCleanUp::expireGroup( KNGroup *g, bool showResult )
  91 {
  92   int expDays=0, idRef=0, foundId=-1, delCnt=0, leftCnt=0, newCnt=0, firstArtNr=g->firstNr(), firstNew=-1;
  93   bool unavailable=false;
  94   KNRemoteArticle *art, *ref;
  95
  96   KNode::Cleanup *conf = g->activeCleanupConfig();
  97
  98   g->setNotUnloadable(true);
  99
 100   if (!g->isLoaded() && !knGlobals.groupManager()->loadHeaders(g)) {
 101     g->setNotUnloadable(false);
 102     return;
 103   }
 104
 105   //find all expired
 106   for(int i=0; i<g->length(); i++) {
 107     art=g->at(i);
 108     if(art->isRead())
 109       expDays = conf->maxAgeForRead();
 110     else
 111       expDays = conf->maxAgeForUnread();
 112
 113     unavailable = false;
 114     if ((art->articleNumber() != -1) && conf->removeUnavailable())
 115       unavailable = (art->articleNumber() < firstArtNr);
 116
 117     art->setExpired( (art->date()->ageInDays() >= expDays) || unavailable );
 118   }
 119
 120   //save threads
 121   if (conf->preserveThreads()) {
 122     for(int i=0; i<g->length(); i++) {
 123       art=g->at(i);
 124       if(!art->isExpired()) {
 125         idRef=art->idRef();
 126         while(idRef!=0) {
 127           ref=g->byId(idRef);
 128           ref->setExpired(false);
 129           idRef=ref->idRef();
 130         }
 131       }
 132     }
 133   }
 134
 135   //restore threading
 136   for(int i=0; i<g->length(); i++) {
 137     art=g->at(i);
 138     if(!art->isExpired()) {
 139       idRef=art->idRef();
 140       foundId=0;
 141       while(foundId==0 && idRef!=0) {
 142         ref=g->byId(idRef);
 143         if(!ref->isExpired()) foundId=ref->id();
 144         idRef=ref->idRef();
 145       }
 146       art->setIdRef(foundId);
 147     }
 148   }
 149
 150   //delete expired
 151   for(int i=0; i<g->length(); i++) {
 152     art=g->at(i);
 153     if(art->isExpired()) {
 154       if(art->isRead())
 155         g->decReadCount();
 156       delCnt++;
 157       if (art->hasContent())
 158         knGlobals.articleManager()->unloadArticle(art, true);
 159     }
 160     else if(art->isNew() && !art->isRead()) {
 161       if(firstNew==-1)
 162         firstNew=i;
 163       newCnt++;
 164     }
 165   }
 166
 167   g->setNotUnloadable(false);
 168
 169   if(delCnt>0) {
 170     g->saveStaticData(g->length(), true);
 171     g->saveDynamicData(g->length(), true);
 172     g->decCount(delCnt);
 173     g->setNewCount(newCnt);
 174     g->setFirstNewIndex(firstNew);
 175     g->saveInfo();
 176     knGlobals.groupManager()->unloadHeaders(g, true);
 177   }
 178   else
 179     g->syncDynamicData();
 180
 181   conf->setLastExpireDate();
 182   g->saveInfo();
 183   leftCnt=g->count();
 184
 185   kDebug(5003) <<"KNCleanUp::expireGroup() :" << g->groupname() <<":"
 186     << delCnt << "deleted ," << leftCnt << "left";
 187
 188   if(showResult)
 189     KMessageBox::information(knGlobals.topWidget,
 190       i18n("<b>%1</b><br />expired: %2<br />left: %3", g->groupname(), delCnt, leftCnt));
 191 }
 192
 193
 194 void KNCleanUp::compactFolder(KNFolder *f)
 195 {
 196   KNLocalArticle *art;
 197
 198   if (!f)
 199     return;
 200
 201   QDir dir(f->path());
 202
 203   if(!dir.exists())
 204     return;
 205
 206   f->setNotUnloadable(true);
 207
 208   if (!f->isLoaded() && !knGlobals.folderManager()->loadHeaders(f)) {
 209     f->setNotUnloadable(false);
 210     return;
 211   }
 212
 213   f->closeFiles();
 214   QFileInfo info(f->m_boxFile);
 215   QString oldName=info.fileName();
 216   QString newName=oldName+".new";
 217   QFile newMBoxFile( info.absolutePath() + '/' + newName );
 218
 219   if( (f->m_boxFile.open(QIODevice::ReadOnly)) && (newMBoxFile.open(QIODevice::WriteOnly)) ) {
 220     QTextStream ts(&newMBoxFile);
 221     ts.setCodec( "ISO 8859-1" );
 222     for(int idx=0; idx<f->length(); idx++) {
 223       art=f->at(idx);
 224       if ( f->m_boxFile.seek( art->startOffset() ) ) {
 225         ts << "From aaa@aaa Mon Jan 01 00:00:00 1997\n";
 226         ts.flush();
 227         art->setStartOffset( newMBoxFile.pos() );
 228         while ( f->m_boxFile.pos() < (uint)art->endOffset() && !f->m_boxFile.atEnd() )
 229           ts << f->m_boxFile.readLine();
 230         ts.flush();
 231         art->setEndOffset( newMBoxFile.pos() );
 232         newMBoxFile.putChar('\n');
 233       }
 234     }
 235
 236     f->syncIndex(true);
 237     newMBoxFile.close();
 238     f->closeFiles();
 239
 240     dir.remove(oldName);
 241     dir.rename(newName, oldName);
 242   }
 243
 244   f->setNotUnloadable(false);
 245 }
 246
 247
 248 //===============================================================================================
 249
 250
 251 KNCleanUp::ProgressDialog::ProgressDialog( int steps, QWidget *parent ) :
 252   KDialog( parent )
 253 {
 254   const int w=400,
 255             h=160;
 256
 257   setCaption(i18n("Cleaning Up"));
 258   setButtons( KDialog::None );
 259
 260   setFixedSize(w,h);
 261   QFrame *top = new QFrame( this );
 262   top->setGeometry(0,0, w,h);
 263
 264   QVBoxLayout *topL=new QVBoxLayout(top);
 265   topL->setSpacing(10);
 266
 267   QLabel *l=new QLabel(i18n("Cleaning up. Please wait..."),top);
 268   topL->addWidget(l);
 269
 270   KSeparator *sep=new KSeparator(top);
 271   topL->addWidget(sep);
 272
 273   m_sg=new QLabel(top);
 274   topL->addWidget(m_sg);
 275
 276   mProgressBar = new QProgressBar( top );
 277   topL->addWidget( mProgressBar );
 278   mProgressBar->setRange( 0, steps );
 279   mProgressBar->setValue( 0 );
 280
 281
 282   if(knGlobals.topWidget->isVisible()) {
 283     int x, y;
 284     x=(knGlobals.topWidget->width()-w)/2;
 285     y=(knGlobals.topWidget->height()-h)/2;
 286     if(x<0 || y<0) {
 287       x=0;
 288       y=0;
 289     }
 290     x+=knGlobals.topWidget->x();
 291     y+=knGlobals.topWidget->y();
 292     move(x,y);
 293   }
 294 }
 295
 296
 297 KNCleanUp::ProgressDialog::~ProgressDialog()
 298 {
 299 }
 300
 301
 302 void KNCleanUp::ProgressDialog::showMessage(const QString &s)
 303 {
 304   m_sg->setText(s);
 305 }
 306
 307
 308 void KNCleanUp::ProgressDialog::doProgress()
 309 {
 310   mProgressBar->setValue( mProgressBar->value() + 1 );
 311 }
 312
 313
 314 void KNCleanUp::ProgressDialog::closeEvent(QCloseEvent *)
 315 {
 316   // do nothing => prevent that the user closes the window
 317 }