kmail/mailinglist-magic.cpp

   1 // -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
   2
   3 #include "mailinglist-magic.h"
   4
   5 #include "kmmessage.h"
   6
   7 #include <kconfig.h>
   8 #include <kconfiggroup.h>
   9 #include <kurl.h>
  10 #include <kdebug.h>
  11
  12 #include <QStringList>
  13 #include <QByteArray>
  14
  15 using namespace KMail;
  16
  17 typedef QString (*MagicDetectorFunc) (const KMMessage *, QByteArray &, QString &);
  18
  19 /* Sender: (owner-([^@]+)|([^@+]-owner)@ */
  20 static QString check_sender(const KMMessage  *message,
  21                             QByteArray &header_name,
  22                             QString &header_value )
  23 {
  24   QString header = message->headerField( "Sender" );
  25
  26   if ( header.isEmpty() )
  27     return QString();
  28
  29   if ( header.left( 6 ) == "owner-" )
  30   {
  31     header_name = "Sender";
  32     header_value = header;
  33     header = header.mid( 6, header.indexOf( '@' ) - 6 );
  34
  35   } else {
  36     int index = header.indexOf( "-owner@ " );
  37     if ( index == -1 )
  38       return QString();
  39
  40     header.truncate( index );
  41     header_name = "Sender";
  42     header_value = header;
  43   }
  44
  45   return header;
  46 }
  47
  48 /* X-BeenThere: ([^@]+) */
  49 static QString check_x_beenthere(const KMMessage  *message,
  50                                  QByteArray &header_name,
  51                                  QString &header_value )
  52 {
  53   QString header = message->headerField( "X-BeenThere" );
  54   if ( header.isNull() || header.indexOf( '@' ) == -1 )
  55     return QString();
  56
  57   header_name = "X-BeenThere";
  58   header_value = header;
  59   header.truncate( header.indexOf( '@' ) );
  60   return header;
  61 }
  62
  63 /* Delivered-To:: <([^@]+) */
  64 static QString check_delivered_to(const KMMessage  *message,
  65                                   QByteArray &header_name,
  66                                   QString &header_value )
  67 {
  68   QString header = message->headerField( "Delivered-To" );
  69   if ( header.isNull() || header.left(13 ) != "mailing list"
  70        || header.indexOf( '@' ) == -1 )
  71     return QString();
  72
  73   header_name = "Delivered-To";
  74   header_value = header;
  75
  76   return header.mid( 13, header.indexOf( '@' ) - 13 );
  77 }
  78
  79 /* X-Mailing-List: <?([^@]+) */
  80 static QString check_x_mailing_list(const KMMessage  *message,
  81                                     QByteArray &header_name,
  82                                     QString &header_value )
  83 {
  84   QString header = message->headerField( "X-Mailing-List");
  85   if ( header.isEmpty() )
  86     return QString();
  87
  88   if ( header.indexOf( '@' ) < 1 )
  89     return QString();
  90
  91   header_name = "X-Mailing-List";
  92   header_value = header;
  93   if ( header[0] == '<' )
  94     header = header.mid(1,  header.indexOf( '@' ) - 1);
  95   else
  96     header.truncate( header.indexOf( '@' ) );
  97   return header;
  98 }
  99
 100 /* List-Id: [^<]* <([^.]+) */
 101 static QString check_list_id(const KMMessage  *message,
 102                              QByteArray &header_name,
 103                              QString &header_value )
 104 {
 105   int lAnglePos, firstDotPos;
 106   QString header = message->headerField( "List-Id" );
 107   if ( header.isEmpty() )
 108     return QString();
 109
 110   lAnglePos = header.indexOf( '<' );
 111   if ( lAnglePos < 0 )
 112     return QString();
 113
 114   firstDotPos = header.indexOf( '.', lAnglePos );
 115   if ( firstDotPos < 0 )
 116     return QString();
 117
 118   header_name = "List-Id";
 119   header_value = header.mid( lAnglePos );
 120   header = header.mid( lAnglePos + 1, firstDotPos - lAnglePos - 1 );
 121   return header;
 122 }
 123
 124
 125 /* List-Post: <mailto:[^< ]*>) */
 126 static QString check_list_post(const KMMessage  *message,
 127                                QByteArray &header_name,
 128                                QString &header_value )
 129 {
 130   QString header = message->headerField( "List-Post" );
 131   if ( header.isEmpty() )
 132     return QString();
 133
 134   int lAnglePos = header.indexOf( "<mailto:" );
 135   if ( lAnglePos < 0 )
 136     return QString();
 137
 138   header_name = "List-Post";
 139   header_value = header;
 140   header = header.mid( lAnglePos + 8, header.length());
 141   header.truncate( header.indexOf('@') );
 142   return header;
 143 }
 144
 145 /* Mailing-List: list ([^@]+) */
 146 static QString check_mailing_list(const KMMessage  *message,
 147                                   QByteArray &header_name,
 148                                   QString &header_value )
 149 {
 150   QString header = message->headerField( "Mailing-List");
 151   if ( header.isEmpty() )
 152     return QString();
 153
 154   if (header.left( 5 ) != "list " || header.indexOf( '@' ) < 5 )
 155     return QString();
 156
 157   header_name = "Mailing-List";
 158   header_value = header;
 159   header = header.mid(5,  header.indexOf( '@' ) - 5);
 160   return header;
 161 }
 162
 163
 164 /* X-Loop: ([^@]+) */
 165 static QString check_x_loop(const KMMessage  *message,
 166                             QByteArray &header_name,
 167                             QString &header_value ){
 168   QString header = message->headerField( "X-Loop");
 169   if ( header.isEmpty() )
 170     return QString();
 171
 172   if (header.indexOf( '@' ) < 2 )
 173     return QString();
 174
 175   header_name = "X-Loop";
 176   header_value = header;
 177   header.truncate(header.indexOf( '@' ));
 178   return header;
 179 }
 180
 181 /* X-ML-Name: (.+) */
 182 static QString check_x_ml_name(const KMMessage  *message,
 183                                QByteArray &header_name,
 184                                QString &header_value ){
 185   QString header = message->headerField( "X-ML-Name");
 186   if ( header.isEmpty() )
 187     return QString();
 188
 189   header_name = "X-ML-Name";
 190   header_value = header;
 191   header.truncate(header.indexOf( '@' ));
 192   return header;
 193 }
 194
 195 MagicDetectorFunc magic_detector[] =
 196 {
 197   check_list_id,
 198   check_list_post,
 199   check_sender,
 200   check_x_mailing_list,
 201   check_mailing_list,
 202   check_delivered_to,
 203   check_x_beenthere,
 204   check_x_loop,
 205   check_x_ml_name
 206 };
 207
 208 static const int num_detectors = sizeof (magic_detector) / sizeof (magic_detector[0]);
 209
 210 static QStringList
 211 headerToAddress( const QString& header )
 212 {
 213   QStringList addr;
 214   int start = 0;
 215   int end = 0;
 216
 217   if ( header.isEmpty() )
 218     return addr;
 219
 220   while ( (start = header.indexOf( "<", start )) != -1 ) {
 221     if ( (end = header.indexOf( ">", ++start ) ) == -1 ) {
 222       kDebug()<<"Serious mailing list header parsing error !";
 223       return addr;
 224     }
 225     kDebug()<<"Mailing list ="<<header.mid( start, end - start );
 226     addr.append( header.mid( start, end - start ) );
 227   }
 228   return  addr;
 229 }
 230
 231 MailingList
 232 MailingList::detect( const KMMessage *message )
 233 {
 234   MailingList mlist;
 235
 236   mlist.setPostURLS( headerToAddress(
 237                        message->headerField( "List-Post" ) ) );
 238   mlist.setHelpURLS( headerToAddress(
 239                        message->headerField( "List-Help" ) ) );
 240   mlist.setSubscribeURLS( headerToAddress(
 241                             message->headerField( "List-Subscribe" ) ) );
 242   mlist.setUnsubscribeURLS( headerToAddress(
 243                               message->headerField( "List-Unsubscribe" ) ) );
 244   mlist.setArchiveURLS( headerToAddress(
 245                           message->headerField( "List-Archive" ) ) );
 246   mlist.setId( message->headerField( "List-Id" ) );
 247
 248   return mlist;
 249 }
 250
 251 QString
 252 MailingList::name( const KMMessage  *message, QByteArray &header_name,
 253                    QString &header_value )
 254 {
 255   QString mlist;
 256   header_name = QByteArray();
 257   header_value.clear();
 258
 259   if ( !message )
 260     return QString();
 261
 262   for (int i = 0; i < num_detectors; i++) {
 263     mlist = magic_detector[i] (message, header_name, header_value);
 264     if ( !mlist.isNull() )
 265       return mlist;
 266   }
 267
 268   return QString();
 269 }
 270
 271 MailingList::MailingList()
 272   : mFeatures( None ), mHandler( KMail )
 273 {
 274 }
 275
 276 int
 277 MailingList::features() const
 278 {
 279   return mFeatures;
 280 }
 281
 282 void
 283 MailingList::setHandler( MailingList::Handler han )
 284 {
 285   mHandler = han;
 286 }
 287 MailingList::Handler
 288 MailingList::handler() const
 289 {
 290   return mHandler;
 291 }
 292
 293 void
 294 MailingList::setPostURLS ( const KUrl::List& lst )
 295 {
 296   mFeatures |= Post;
 297   if ( lst.empty() ) {
 298     mFeatures ^= Post;
 299   }
 300   mPostURLS = lst;
 301 }
 302 KUrl::List
 303 MailingList::postURLS() const
 304 {
 305   return mPostURLS;
 306 }
 307
 308 void
 309 MailingList::setSubscribeURLS( const KUrl::List& lst )
 310 {
 311   mFeatures |= Subscribe;
 312   if ( lst.empty() ) {
 313     mFeatures ^= Subscribe;
 314   }
 315
 316   mSubscribeURLS = lst;
 317 }
 318 KUrl::List
 319 MailingList::subscribeURLS() const
 320 {
 321   return mSubscribeURLS;
 322 }
 323
 324 void
 325 MailingList::setUnsubscribeURLS( const KUrl::List& lst )
 326 {
 327   mFeatures |= Unsubscribe;
 328   if ( lst.empty() ) {
 329     mFeatures ^= Unsubscribe;
 330   }
 331
 332   mUnsubscribeURLS = lst;
 333 }
 334 KUrl::List MailingList::unsubscribeURLS() const
 335 {
 336   return mUnsubscribeURLS;
 337 }
 338
 339 void
 340 MailingList::setHelpURLS( const KUrl::List& lst )
 341 {
 342   mFeatures |= Help;
 343   if ( lst.empty() ) {
 344     mFeatures ^= Help;
 345   }
 346
 347   mHelpURLS = lst;
 348 }
 349 KUrl::List
 350 MailingList::helpURLS() const
 351 {
 352   return mHelpURLS;
 353 }
 354
 355 void
 356 MailingList::setArchiveURLS( const KUrl::List& lst )
 357 {
 358   mFeatures |= Archive;
 359   if ( lst.empty() ) {
 360     mFeatures ^= Archive;
 361   }
 362
 363   mArchiveURLS = lst;
 364 }
 365 KUrl::List
 366 MailingList::archiveURLS() const
 367 {
 368   return mArchiveURLS;
 369 }
 370
 371 void
 372 MailingList::setId( const QString& str )
 373 {
 374   mFeatures |= Id;
 375   if ( str.isEmpty() ) {
 376     mFeatures ^= Id;
 377   }
 378
 379   mId = str;
 380 }
 381 QString
 382 MailingList::id() const
 383 {
 384   return mId;
 385 }
 386
 387 void
 388 MailingList::writeConfig( KConfigGroup & config ) const
 389 {
 390   config.writeEntry( "MailingListFeatures", mFeatures );
 391   config.writeEntry( "MailingListHandler", (int)mHandler );
 392   config.writeEntry( "MailingListId",  mId );
 393   config.writeEntry( "MailingListPostingAddress", mPostURLS.toStringList() );
 394   config.writeEntry( "MailingListSubscribeAddress", mSubscribeURLS.toStringList() );
 395   config.writeEntry( "MailingListUnsubscribeAddress", mUnsubscribeURLS.toStringList() );
 396   config.writeEntry( "MailingListArchiveAddress", mArchiveURLS.toStringList() );
 397   config.writeEntry( "MailingListHelpAddress", mHelpURLS.toStringList() );
 398 }
 399
 400 void
 401 MailingList::readConfig( KConfigGroup & config )
 402 {
 403   mFeatures =  config.readEntry( "MailingListFeatures", 0 );
 404   mHandler = static_cast<MailingList::Handler>(
 405     config.readEntry( "MailingListHandler", (int)MailingList::KMail ) );
 406
 407   mId = config.readEntry("MailingListId");
 408   mPostURLS        = config.readEntry( "MailingListPostingAddress", QStringList() );
 409   mSubscribeURLS   = config.readEntry( "MailingListSubscribeAddress", QStringList() );
 410   mUnsubscribeURLS = config.readEntry( "MailingListUnsubscribeAddress", QStringList() );
 411   mArchiveURLS     = config.readEntry( "MailingListArchiveAddress", QStringList() );
 412   mHelpURLS        = config.readEntry( "MailingListHelpAddress", QStringList() );
 413 }