identity.h

/*
    Copyright (c) 2002-2004 Marc Mutz <mutz@kde.org>
    Copyright (c) 2007 Tom Albers <tomalbers@kde.nl>
    Author: Stefan Taferner <taferner@kde.org>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library 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 Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef KPIMIDENTITES_IDENTITY_H
#define KPIMIDENTITES_IDENTITY_H

#include "kpimidentities_export.h"
#include "signature.h"

#include <kdemacros.h>

#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QList>
#include <QtCore/QHash>
#include <QtCore/QVariant>

namespace KPIMIdentities
{
  class Identity;
  class Signature;
}
class KConfigGroup;
class QDataStream;
class QMimeData;

namespace KPIMIdentities
{

  static const char s_uoid[] = "uoid";
  static const char s_identity[] = "Identity";
  static const char s_name[] = "Name";
  static const char s_organization[] = "Organization";
  static const char s_pgps[] = "PGP Signing Key";
  static const char s_pgpe[] = "PGP Encryption Key";
  static const char s_smimes[] = "SMIME Signing Key";
  static const char s_smimee[] = "SMIME Encryption Key";
  static const char s_prefcrypt[] = "Preferred Crypto Message Format";
  static const char s_email[] = "Email Address"; // TODO: KDE5: Rename to s_primaryEmail
  static const char s_replyto[] = "Reply-To Address";
  static const char s_bcc[] = "Bcc";
  static const char s_cc[] = "Cc";
  static const char s_vcard[] = "VCardFile";
  static const char s_transport[] = "Transport";
  static const char s_fcc[] = "Fcc";
  static const char s_drafts[] = "Drafts";
  static const char s_templates[] = "Templates";
  static const char s_dict[] =  "Dictionary";
  static const char s_xface[] =  "X-Face";
  static const char s_xfaceenabled[] =  "X-FaceEnabled";
  static const char s_signature[] =  "Signature";
  static const char s_emailAliases[] = "Email Aliases";
  static const char s_attachVcard[] = "Attach Vcard";
  static const char s_autocorrectionLanguage[] = "Autocorrection Language";
  static const char s_disabledFcc[] = "Disable Fcc";
  static const char s_pgpautosign[] = "Pgp Auto Sign";
  static const char s_defaultDomainName[] = "Default Domain";

  KPIMIDENTITIES_EXPORT QDataStream &operator<<
  ( QDataStream &stream, const KPIMIdentities::Identity &ident );
  KPIMIDENTITIES_EXPORT QDataStream &operator>>
  ( QDataStream &stream, KPIMIdentities::Identity &ident );

class KPIMIDENTITIES_EXPORT Identity
{
    // only the identity manager should be able to construct and
    // destruct us, but then we get into problems with using
    // QValueList<Identity> and especially qHeapSort().
    friend class IdentityManager;

    friend KPIMIDENTITIES_EXPORT QDataStream &operator<<
    ( QDataStream &stream, const KPIMIdentities::Identity &ident );
    friend KPIMIDENTITIES_EXPORT QDataStream &operator>>
    ( QDataStream &stream, KPIMIdentities::Identity &ident );

    public:
      typedef QList<Identity> List;

      explicit Identity( const QString &id=QString(),
                         const QString &realName=QString(),
                         const QString &emailAddr=QString(),
                         const QString &organization=QString(),
                         const QString &replyToAddress=QString() );

      ~Identity();

      bool operator== ( const Identity &other ) const;

      bool operator!= ( const Identity &other ) const;

      bool operator< ( const Identity &other ) const;

      bool operator> ( const Identity &other ) const;

      bool operator<= ( const Identity &other ) const;

      bool operator>= ( const Identity &other ) const;

      bool mailingAllowed() const;

      QString identityName() const;

      void setIdentityName( const QString &name );

      bool isDefault() const;

      uint uoid() const;

      QString fullName() const;
      void setFullName( const QString& );

      QString organization() const;
      void setOrganization( const QString& );

      QByteArray pgpEncryptionKey() const;
      void setPGPEncryptionKey( const QByteArray &key );

      QByteArray pgpSigningKey() const;
      void setPGPSigningKey( const QByteArray &key );

      QByteArray smimeEncryptionKey() const;
      void setSMIMEEncryptionKey( const QByteArray &key );

      QByteArray smimeSigningKey() const;
      void setSMIMESigningKey( const QByteArray &key );

      QString preferredCryptoMessageFormat() const;
      void setPreferredCryptoMessageFormat( const QString& );

      KPIMIDENTITIES_DEPRECATED QString emailAddr() const;
      KPIMIDENTITIES_DEPRECATED void setEmailAddr( const QString& );

      QString primaryEmailAddress() const;
      void setPrimaryEmailAddress( const QString & email );

      const QStringList emailAliases() const;
      void setEmailAliases( const QStringList & aliases );

      bool matchesEmailAddress( const QString & addr ) const;

      QString vCardFile() const;
      void setVCardFile( const QString& );

      QString fullEmailAddr() const;

      QString replyToAddr() const;
      void setReplyToAddr( const QString& );

      QString bcc() const;
      void setBcc( const QString& );

      QString cc() const;
      void setCc( const QString& );

      bool attachVcard() const;
      void setAttachVcard(bool attach);

      QString autocorrectionLanguage() const;
      void setAutocorrectionLanguage(const QString& language);

      bool disabledFcc() const;
      void setDisabledFcc(bool);

      bool pgpAutoSign() const;
      void setPgpAutoSign(bool);

      QString defaultDomainName() const;
      void setDefaultDomainName(const QString &domainName);


      void setSignature( const Signature &sig );
      Signature &signature(); /* _not_ const! */

      QString signatureText( bool *ok = 0 ) const;

      bool signatureIsInlinedHtml() const;

      QString transport() const;
      void setTransport( const QString& );

      QString fcc() const;
      void setFcc( const QString& );

      QString drafts() const;
      void setDrafts( const QString& );

      QString templates() const;
      void setTemplates( const QString& );

      QString dictionary() const;
      void setDictionary( const QString& );

      QString xface() const;
      void setXFace( const QString& );
      bool isXFaceEnabled() const;
      void setXFaceEnabled( const bool );

      QVariant property( const QString &key ) const;
      void setProperty( const QString &key, const QVariant &value );

      static const Identity &null();
      bool isNull() const;

      static QString mimeDataType();
      static bool canDecode( const QMimeData* );
      void populateMimeData( QMimeData* );
      static Identity fromMimeData( const QMimeData* );

      void readConfig( const KConfigGroup & );

      void writeConfig( KConfigGroup & ) const;

      void setIsDefault( bool flag );

      void setUoid( uint aUoid );

    protected:
      QString verifyAkonadiId(const QString& str) const;

      bool signatureIsCommand() const;

      bool signatureIsPlainFile() const;

      bool signatureIsInline() const;

      QString signatureFile() const;
      void setSignatureFile( const QString& );

      QString signatureInlineText() const;
      void setSignatureInlineText( const QString& );

      bool useSignatureFile() const;

      Signature mSignature;
      bool      mIsDefault;
      QHash<QString, QVariant>   mPropertiesMap;
};

}

#endif /*kpim_identity_h*/