imaplist.cpp

/**********************************************************************
 *
 *   imapinfo.cc  - IMAP4rev1 EXAMINE / SELECT handler
 *   Copyright (C) 2000 Sven Carstens <s.carstens@gmx.de>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *   Send comments and bug fixes to
 *
 *********************************************************************/

/*
  References:
    RFC 2060 - Internet Message Access Protocol - Version 4rev1 - December 1996
    RFC 2192 - IMAP URL Scheme - September 1997
    RFC 1731 - IMAP Authentication Mechanisms - December 1994
               (Discusses KERBEROSv4, GSSAPI, and S/Key)
    RFC 2195 - IMAP/POP AUTHorize Extension for Simple Challenge/Response
             - September 1997 (CRAM-MD5 authentication method)
    RFC 2104 - HMAC: Keyed-Hashing for Message Authentication - February 1997

  Supported URLs:
    imap://server/ - Prompt for user/pass, list all folders in home directory
    imap://user:pass@server/ - Uses LOGIN to log in
    imap://user;AUTH=method:pass@server/ - Uses AUTHENTICATE to log in

    imap://server/folder/ - List messages in folder
 */

#include "imaplist.h"
#include "imapparser.h"

#include <kimap/rfccodecs.h>

#include <kdebug.h>

imapList::imapList (): parser_(0), noInferiors_ (false),
noSelect_ (false), marked_ (false), unmarked_ (false),
hasChildren_ (false), hasNoChildren_ (false)
{
}

imapList::imapList (const imapList & lr):parser_(lr.parser_),
hierarchyDelimiter_ (lr.hierarchyDelimiter_),
name_ (lr.name_),
noInferiors_ (lr.noInferiors_),
noSelect_ (lr.noSelect_), marked_ (lr.marked_), unmarked_ (lr.unmarked_),
hasChildren_ (lr.hasChildren_), hasNoChildren_ (lr.hasNoChildren_),
attributes_ (lr.attributes_)
{
}

imapList & imapList::operator = (const imapList & lr)
{
  // Avoid a = a.
  if ( this == &lr ) {
    return *this;
  }

  parser_ = lr.parser_;
  hierarchyDelimiter_ = lr.hierarchyDelimiter_;
  name_ = lr.name_;
  noInferiors_ = lr.noInferiors_;
  noSelect_ = lr.noSelect_;
  marked_ = lr.marked_;
  unmarked_ = lr.unmarked_;
  hasChildren_ = lr.hasChildren_;
  hasNoChildren_ = lr.hasNoChildren_;
  attributes_ = lr.attributes_;

  return *this;
}

imapList::imapList (const QString & inStr, imapParser &parser)
: parser_(&parser),
noInferiors_ (false),
noSelect_ (false),
marked_ (false), unmarked_ (false), hasChildren_ (false),
hasNoChildren_ (false)
{
  parseString s;
  s.data = inStr.toLatin1();

  if ( s[0] != '(' ) {
    return;                     //not proper format for us
  }

  s.pos++;  // tie off (

  parseAttributes( s );

  s.pos++;  // tie off )
  parser_->skipWS( s );

  hierarchyDelimiter_ = QString::fromLatin1( parser_->parseOneWord( s ) );
  if ( hierarchyDelimiter_ == "NIL" ) {
    hierarchyDelimiter_.clear();
  }
  name_ = QString::fromUtf8( KIMAP::decodeImapFolderName( parser_->parseLiteral( s ) ) );  // decode modified UTF7
}

void imapList::parseAttributes( parseString & str )
{

  while ( !str.isEmpty() && str[0] != ')' ) {
    QString orig = QString::fromLatin1( parser_->parseOneWord( str ) );
    attributes_ << orig;
    QString attribute = orig.toLower();
    if ( attribute.contains( "\\noinferiors" ) ) {
      noInferiors_ = true;
    } else if ( attribute.contains( "\\noselect" ) ) {
      noSelect_ = true;
    } else if ( attribute.contains( "\\marked" ) ) {
      marked_ = true;
    } else if ( attribute.contains( "\\unmarked" ) ) {
      unmarked_ = true;
    } else if ( attribute.contains( "\\haschildren" ) ) {
      hasChildren_ = true;
    } else if ( attribute.contains( "\\hasnochildren" ) ) {
      hasNoChildren_ = true;
    } else {
      kDebug( 7116 ) << "imapList::imapList: bogus attribute" << attribute;
    }
  }
}