mailcommon/filterimporterexporter.cpp

   1 /*
   2     This file is part of KMail.
   3     Copyright (c) 2007 Till Adam <adam@kde.org>
   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 #include "filterimporterexporter.h"
  31 #include "filterimporterexporter_p.h"
  32
  33 #include "filteraction.h"
  34 #include "mailfilter.h"
  35
  36 #include <kconfig.h>
  37 #include <kdebug.h>
  38 #include <kfiledialog.h>
  39 #include <kmessagebox.h>
  40 #include <kpushbutton.h>
  41 #include <messageviewer/autoqpointer.h>
  42 #include <messageviewer/util.h>
  43
  44 #include <QtCore/QRegExp>
  45 #include <QtGui/QListWidget>
  46 #include <QtGui/QVBoxLayout>
  47
  48 using namespace MailCommon;
  49
  50 FilterSelectionDialog::FilterSelectionDialog( QWidget *parent )
  51   : KDialog( parent )
  52 {
  53   setObjectName( "filterselection" );
  54   setModal( true );
  55   setCaption( i18n( "Select Filters" ) );
  56   setButtons( Ok | Cancel );
  57   setDefaultButton( Ok );
  58   showButtonSeparator( true );
  59
  60   QVBoxLayout* const top = new QVBoxLayout( mainWidget() );
  61   filtersListWidget = new QListWidget();
  62   top->addWidget( filtersListWidget );
  63   filtersListWidget->setAlternatingRowColors( true );
  64   filtersListWidget->setSortingEnabled( false );
  65   filtersListWidget->setSelectionMode( QAbstractItemView::NoSelection );
  66
  67   QHBoxLayout* const buttonLayout = new QHBoxLayout();
  68   top->addLayout( buttonLayout );
  69   selectAllButton = new KPushButton( i18n( "Select All" ) );
  70   buttonLayout->addWidget( selectAllButton );
  71   unselectAllButton = new KPushButton( i18n( "Unselect All" ) );
  72   buttonLayout->addWidget( unselectAllButton );
  73
  74   connect( selectAllButton, SIGNAL(clicked()), this, SLOT(slotSelectAllButton()) );
  75   connect( unselectAllButton, SIGNAL(clicked()), this, SLOT(slotUnselectAllButton()) );
  76
  77   resize( 300, 350 );
  78 }
  79
  80 FilterSelectionDialog::~FilterSelectionDialog()
  81 {
  82 }
  83
  84 void FilterSelectionDialog::setFilters( const QList<MailFilter *> &filters )
  85 {
  86   if ( filters.isEmpty() ) {
  87     enableButtonOk( false );
  88     return;
  89   }
  90
  91   originalFilters = filters;
  92   filtersListWidget->clear();
  93
  94   foreach ( const MailFilter *filter, filters ) {
  95     QListWidgetItem *item = new QListWidgetItem( filter->name(), filtersListWidget );
  96     item->setFlags( Qt::ItemIsUserCheckable | Qt::ItemIsEnabled );
  97     item->setCheckState( Qt::Checked );
  98   }
  99 }
 100
 101 QList<MailFilter*> FilterSelectionDialog::selectedFilters() const
 102 {
 103   QList<MailFilter*> filters;
 104
 105   const int filterCount = filtersListWidget->count();
 106   for ( int i = 0; i < filterCount; ++i ) {
 107     const QListWidgetItem *item = filtersListWidget->item( i );
 108     if ( item->checkState() == Qt::Checked )
 109       filters << originalFilters[ i ];
 110   }
 111
 112   return filters;
 113 }
 114
 115 void FilterSelectionDialog::slotUnselectAllButton()
 116 {
 117   const int filterCount = filtersListWidget->count();
 118   for ( int i = 0; i < filterCount; ++i ) {
 119     QListWidgetItem * const item = filtersListWidget->item( i );
 120     item->setCheckState( Qt::Unchecked );
 121   }
 122 }
 123
 124 void FilterSelectionDialog::slotSelectAllButton()
 125 {
 126   const int filterCount = filtersListWidget->count();
 127   for ( int i = 0; i < filterCount; ++i ) {
 128     QListWidgetItem * const item = filtersListWidget->item( i );
 129     item->setCheckState( Qt::Checked );
 130   }
 131 }
 132
 133 QList<MailFilter*> FilterImporterExporter::readFiltersFromConfig( const KSharedConfig::Ptr config )
 134 {
 135   const KConfigGroup group = config->group( "General" );
 136
 137   const int numFilters = group.readEntry( "filters", 0 );
 138
 139   QList<MailFilter*> filters;
 140   for ( int i = 0; i < numFilters; ++i ) {
 141     const QString groupName = QString::fromLatin1( "Filter #%1" ).arg( i );
 142
 143     const KConfigGroup group = config->group( groupName );
 144     MailFilter *filter = new MailFilter( group );
 145     filter->purify();
 146     if ( filter->isEmpty() ) {
 147 #ifndef NDEBUG
 148       kDebug() << "Filter" << filter->asString() << "is empty!";
 149 #endif
 150       delete filter;
 151     } else
 152       filters.append( filter );
 153   }
 154
 155   return filters;
 156 }
 157
 158 void FilterImporterExporter::writeFiltersToConfig( const QList<MailFilter*> &filters, KSharedConfig::Ptr config )
 159 {
 160   // first, delete all filter groups:
 161   const QStringList filterGroups =
 162     config->groupList().filter( QRegExp( "Filter #\\d+" ) );
 163
 164   foreach ( const QString &group, filterGroups )
 165     config->deleteGroup( group );
 166
 167   int i = 0;
 168   foreach ( const MailFilter *filter, filters ) {
 169     if ( !filter->isEmpty() ) {
 170       const QString groupName = QString::fromLatin1( "Filter #%1" ).arg( i );
 171
 172       KConfigGroup group = config->group( groupName );
 173       filter->writeConfig( group );
 174       ++i;
 175     }
 176   }
 177
 178   KConfigGroup group = config->group( "General" );
 179   group.writeEntry( "filters", i );
 180
 181   config->sync();
 182 }
 183
 184 class FilterImporterExporter::Private
 185 {
 186   public:
 187     Private( QWidget *parent )
 188      : mParent( parent)
 189     {
 190     }
 191
 192     QWidget *mParent;
 193 };
 194
 195
 196 FilterImporterExporter::FilterImporterExporter( QWidget *parent )
 197   : d( new Private( parent ) )
 198 {
 199 }
 200
 201 FilterImporterExporter::~FilterImporterExporter()
 202 {
 203   delete d;
 204 }
 205
 206 QList<MailFilter *> FilterImporterExporter::importFilters()
 207 {
 208   const QString fileName = KFileDialog::getOpenFileName( QDir::homePath(), QString(),
 209                                                          d->mParent, i18n( "Import Filters" ) );
 210   if ( fileName.isEmpty() )
 211     return QList<MailFilter*>(); // cancel
 212
 213   {
 214     QFile file( fileName );
 215     if ( !file.open( QIODevice::ReadOnly ) ) {
 216       KMessageBox::error( d->mParent,
 217                           i18n( "The selected file is not readable. "
 218                                 "Your file access permissions might be insufficient.") );
 219       return QList<MailFilter*>();
 220     }
 221   }
 222
 223   const KSharedConfig::Ptr config = KSharedConfig::openConfig( fileName );
 224   const QList<MailFilter*> imported = readFiltersFromConfig( config );
 225
 226   FilterSelectionDialog dlg( d->mParent );
 227   dlg.setFilters( imported );
 228
 229   return (dlg.exec() == QDialog::Accepted ? dlg.selectedFilters() : QList<MailFilter*>());
 230 }
 231
 232 void FilterImporterExporter::exportFilters( const QList<MailFilter*> &filters )
 233 {
 234   const KUrl saveUrl = KFileDialog::getSaveUrl( QDir::homePath(), QString(),
 235                                                 d->mParent, i18n( "Export Filters" ) );
 236
 237   if ( saveUrl.isEmpty() || !MessageViewer::Util::checkOverwrite( saveUrl, d->mParent ) )
 238       return;
 239
 240   KSharedConfig::Ptr config = KSharedConfig::openConfig( saveUrl.toLocalFile() );
 241   MessageViewer::AutoQPointer<FilterSelectionDialog> dlg( new FilterSelectionDialog( d->mParent ) );
 242   dlg->setFilters( filters );
 243   if ( dlg->exec() == QDialog::Accepted && dlg )
 244     writeFiltersToConfig( dlg->selectedFilters(), config );
 245 }
 246
 247 #include "filterimporterexporter_p.moc"