File indexing completed on 2024-04-14 03:51:24

 /*
     This file is part of the KContacts framework.
     SPDX-FileCopyrightText: 2001 Cornelius Schumacher <schumacher@kde.org>
     SPDX-FileCopyrightText: 2003 Carsten Pfeiffer <pfeiffer@kde.org>
     SPDX-FileCopyrightText: 2005 Ingo Kloecker <kloecker@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #include <QDate>
 #include <QRegularExpression>
 #include <QSharedData>
 #include <QUuid>
 
 #include "kcontacts_debug.h"
 #include <KLocalizedString>
 
 #include "addressee.h"
 #include "addresseehelper_p.h"
 #include "parametermap_p.h"
 
 using namespace KContacts;
 
 static bool matchBinaryPattern(int value, int pattern);
 
 template<class L>
 static bool listEquals(const QList<L> &list, const QList<L> &pattern);
 static bool listEquals(const QStringList &list, const QStringList &pattern);
 
 struct CustomData {
     QString name;
     QString value;
 };
 
 inline bool operator==(const CustomData &a, const CustomData &b)
 {
     return std::tie(a.name, a.value) == std::tie(b.name, b.value);
 }
 
 inline bool operator!=(const CustomData &a, const CustomData &b)
 {
     return std::tie(a.name, a.value) != std::tie(b.name, b.value);
 }
 
 inline bool operator<(const CustomData &a, const CustomData &b)
 {
     return a.name < b.name;
 }
 
 class Q_DECL_HIDDEN Addressee::Private : public QSharedData
 {
 public:
     Private()
         : mUid(QUuid::createUuid().toString().mid(1, 36))
         , mEmpty(true)
         , mChanged(false)
         , mBirthdayWithTime(false)
     {
         // We avoid the curly braces so the string is RFC4122 compliant and can be used as urn
     }
 
     Private(const Private &other)
         : QSharedData(other)
     {
         mUid = other.mUid;
         mName = other.mName;
         mFormattedName = other.mFormattedName;
         mFamilyName = other.mFamilyName;
         mGivenName = other.mGivenName;
         mAdditionalName = other.mAdditionalName;
         mPrefix = other.mPrefix;
         mSuffix = other.mSuffix;
         mBirthday = other.mBirthday;
         mBirthdayWithTime = other.mBirthdayWithTime;
         mMailer = other.mMailer;
         mTimeZone = other.mTimeZone;
         mGeo = other.mGeo;
         mDepartment = other.mDepartment;
         mNote = other.mNote;
         mProductId = other.mProductId;
         mRevision = other.mRevision;
         mSortString = other.mSortString;
         mSecrecy = other.mSecrecy;
         mLogo = other.mLogo;
         mPhoto = other.mPhoto;
         mSound = other.mSound;
 
         mPhoneNumbers = other.mPhoneNumbers;
         mAddresses = other.mAddresses;
         mKeys = other.mKeys;
         mLangs = other.mLangs;
         mGender = other.mGender;
         mEmails = other.mEmails;
         mCategories = other.mCategories;
         mCustomFields = other.mCustomFields;
         mCalendarUrl = other.mCalendarUrl;
         mSoundListExtra = other.mSoundListExtra;
         mPhotoExtraList = other.mPhotoExtraList;
         mLogoExtraList = other.mLogoExtraList;
         mUrlExtraList = other.mUrlExtraList;
         mMembers = other.mMembers;
         mRelationships = other.mRelationships;
         mSources = other.mSources;
         mEmpty = other.mEmpty;
         mImpps = other.mImpps;
         mChanged = other.mChanged;
         mTitleExtraList = other.mTitleExtraList;
         mRoleExtraList = other.mRoleExtraList;
         mOrgExtraList = other.mOrgExtraList;
     }
 
     ~Private()
     {
     }
 
     std::vector<CustomData>::iterator findByName(const QString &qualifiedName)
     {
         return std::find_if(mCustomFields.begin(), mCustomFields.end(), [&qualifiedName](const CustomData &info) {
             return info.name == qualifiedName;
         });
     }
 
     std::vector<CustomData>::const_iterator findByName(const QString &qualifiedName) const
     {
         return std::find_if(mCustomFields.cbegin(), mCustomFields.cend(), [&qualifiedName](const CustomData &info) {
             return info.name == qualifiedName;
         });
     }
 
     QString mUid;
     QString mName;
     QString mFormattedName;
     QString mFamilyName;
     QString mGivenName;
     QString mAdditionalName;
     QString mPrefix;
     QString mSuffix;
     QDateTime mBirthday;
     QString mMailer;
     TimeZone mTimeZone;
     Geo mGeo;
     QString mDepartment;
     QString mNote;
     QString mProductId;
     QDateTime mRevision;
     QString mSortString;
     Secrecy mSecrecy;
     Picture mLogo;
     Picture mPhoto;
     Sound mSound;
 
     PhoneNumber::List mPhoneNumbers;
     Address::List mAddresses;
     Key::List mKeys;
     Email::List mEmails;
     Lang::List mLangs;
     Impp::List mImpps;
     Gender mGender;
     QString mKind;
     QStringList mCategories;
     std::vector<CustomData> mCustomFields;
     CalendarUrl::List mCalendarUrl;
     Sound::List mSoundListExtra;
     Picture::List mPhotoExtraList;
     Picture::List mLogoExtraList;
     ResourceLocatorUrl::List mUrlExtraList;
     QList<QUrl> mSources;
     QStringList mMembers;
     Related::List mRelationships;
     FieldGroup::List mFieldGroupList;
     Title::List mTitleExtraList;
     Role::List mRoleExtraList;
     Org::List mOrgExtraList;
     NickName::List mNickNameExtraList;
     ClientPidMap::List mClientPidMapList;
     bool mEmpty : 1;
     bool mChanged : 1;
     bool mBirthdayWithTime;
 };
 
 Addressee::Addressee()
     : d(new Private)
 {
 }
 
 Addressee::~Addressee()
 {
 }
 
 Addressee::Addressee(const Addressee &other)
     : d(other.d)
 {
 }
 
 Addressee &Addressee::operator=(const Addressee &other)
 {
     if (this != &other) {
         d = other.d;
     }
 
     return *this;
 }
 
 bool Addressee::operator==(const Addressee &addressee) const
 {
     if (d->mUid != addressee.d->mUid) {
         qCDebug(KCONTACTS_LOG) << "uid differs";
         return false;
     }
 
     if (d->mName != addressee.d->mName //
         && !(d->mName.isEmpty() && addressee.d->mName.isEmpty())) {
         qCDebug(KCONTACTS_LOG) << "name differs";
         return false;
     }
 
     if (d->mFormattedName != addressee.d->mFormattedName //
         && !(d->mFormattedName.isEmpty() && addressee.d->mFormattedName.isEmpty())) {
         qCDebug(KCONTACTS_LOG) << "formattedName differs";
         return false;
     }
 
     if (d->mFamilyName != addressee.d->mFamilyName //
         && !(d->mFamilyName.isEmpty() && addressee.d->mFamilyName.isEmpty())) {
         qCDebug(KCONTACTS_LOG) << "familyName differs";
         return false;
     }
 
     if (d->mGivenName != addressee.d->mGivenName //
         && !(d->mGivenName.isEmpty() && addressee.d->mGivenName.isEmpty())) {
         qCDebug(KCONTACTS_LOG) << "givenName differs";
         return false;
     }
 
     if (d->mAdditionalName != addressee.d->mAdditionalName //
         && !(d->mAdditionalName.isEmpty() && addressee.d->mAdditionalName.isEmpty())) {
         qCDebug(KCONTACTS_LOG) << "additionalName differs";
         return false;
     }
 
     if (d->mPrefix != addressee.d->mPrefix //
         && !(d->mPrefix.isEmpty() && addressee.d->mPrefix.isEmpty())) {
         qCDebug(KCONTACTS_LOG) << "prefix differs";
         return false;
     }
 
     if (d->mSuffix != addressee.d->mSuffix //
         && !(d->mSuffix.isEmpty() && addressee.d->mSuffix.isEmpty())) {
         qCDebug(KCONTACTS_LOG) << "suffix differs";
         return false;
     }
 
     if (d->mBirthday != addressee.d->mBirthday //
         || d->mBirthdayWithTime != addressee.d->mBirthdayWithTime) {
         qCDebug(KCONTACTS_LOG) << "birthday differs";
         return false;
     }
 
     if (d->mMailer != addressee.d->mMailer //
         && !(d->mMailer.isEmpty() && addressee.d->mMailer.isEmpty())) {
         qCDebug(KCONTACTS_LOG) << "mailer differs";
         return false;
     }
 
     if (d->mTimeZone != addressee.d->mTimeZone) {
         qCDebug(KCONTACTS_LOG) << "timeZone differs";
         return false;
     }
 
     if (d->mGeo != addressee.d->mGeo) {
         qCDebug(KCONTACTS_LOG) << "geo differs";
         return false;
     }
 
     if (d->mDepartment != addressee.d->mDepartment //
         && !(d->mDepartment.isEmpty() && addressee.d->mDepartment.isEmpty())) {
         qCDebug(KCONTACTS_LOG) << "department differs";
         return false;
     }
 
     if (d->mNote != addressee.d->mNote //
         && !(d->mNote.isEmpty() && addressee.d->mNote.isEmpty())) {
         qCDebug(KCONTACTS_LOG) << "note differs";
         return false;
     }
 
     if (d->mProductId != addressee.d->mProductId //
         && !(d->mProductId.isEmpty() && addressee.d->mProductId.isEmpty())) {
         qCDebug(KCONTACTS_LOG) << "productId differs";
         return false;
     }
 
     if (d->mSortString != addressee.d->mSortString //
         && !(d->mSortString.isEmpty() && addressee.d->mSortString.isEmpty())) {
         qCDebug(KCONTACTS_LOG) << "sortString differs";
         return false;
     }
 
     if (d->mSecrecy != addressee.d->mSecrecy) {
         qCDebug(KCONTACTS_LOG) << "secrecy differs";
         return false;
     }
 
     if (d->mLogo != addressee.d->mLogo) {
         qCDebug(KCONTACTS_LOG) << "logo differs";
         return false;
     }
 
     if (d->mPhoto != addressee.d->mPhoto) {
         qCDebug(KCONTACTS_LOG) << "photo differs";
         return false;
     }
 
     if (d->mSound != addressee.d->mSound) {
         qCDebug(KCONTACTS_LOG) << "sound differs";
         return false;
     }
 
     if (!listEquals(d->mPhoneNumbers, addressee.d->mPhoneNumbers)) {
         qCDebug(KCONTACTS_LOG) << "phoneNumbers differs";
         return false;
     }
 
     if (!listEquals(d->mAddresses, addressee.d->mAddresses)) {
         qCDebug(KCONTACTS_LOG) << "addresses differs";
         return false;
     }
 
     if (!listEquals(d->mKeys, addressee.d->mKeys)) {
         qCDebug(KCONTACTS_LOG) << "keys differs";
         return false;
     }
     if (!listEquals(d->mEmails, addressee.d->mEmails)) {
         qCDebug(KCONTACTS_LOG) << "emails differs";
         return false;
     }
 
     if (!listEquals(d->mCategories, addressee.d->mCategories)) {
         qCDebug(KCONTACTS_LOG) << "categories differs";
         return false;
     }
 
     if (d->mCustomFields != addressee.d->mCustomFields) {
         qCDebug(KCONTACTS_LOG) << "custom differs";
         return false;
     }
     if (d->mLangs != addressee.d->mLangs) {
         qCDebug(KCONTACTS_LOG) << "langs differs";
         return false;
     }
     if (d->mImpps != addressee.d->mImpps) {
         qCDebug(KCONTACTS_LOG) << "impps differs";
         return false;
     }
     if (d->mGender != addressee.d->mGender) {
         qCDebug(KCONTACTS_LOG) << "gender differs";
         return false;
     }
     if (d->mKind != addressee.d->mKind) {
         qCDebug(KCONTACTS_LOG) << "kind differs";
         return false;
     }
     if (!listEquals(d->mCalendarUrl, addressee.d->mCalendarUrl)) {
         qCDebug(KCONTACTS_LOG) << "calendarUrl differs";
         return false;
     }
     if (!listEquals(d->mSoundListExtra, addressee.d->mSoundListExtra)) {
         qCDebug(KCONTACTS_LOG) << "Extra sound differs";
         return false;
     }
     if (!listEquals(d->mPhotoExtraList, addressee.d->mPhotoExtraList)) {
         qCDebug(KCONTACTS_LOG) << "Extra photo differs";
         return false;
     }
     if (!listEquals(d->mLogoExtraList, addressee.d->mLogoExtraList)) {
         qCDebug(KCONTACTS_LOG) << "Extra logo differs";
         return false;
     }
     if (!listEquals(d->mUrlExtraList, addressee.d->mUrlExtraList)) {
         qCDebug(KCONTACTS_LOG) << "Extra url differs";
         return false;
     }
     if (!listEquals(d->mMembers, addressee.d->mMembers)) {
         qCDebug(KCONTACTS_LOG) << "Extra url differs";
         return false;
     }
     if (!listEquals(d->mRelationships, addressee.d->mRelationships)) {
         qCDebug(KCONTACTS_LOG) << "Relationships differs";
         return false;
     }
     if (!listEquals(d->mSources, addressee.d->mSources)) {
         qCDebug(KCONTACTS_LOG) << "Sources differs";
         return false;
     }
 
     if (!listEquals(d->mFieldGroupList, addressee.d->mFieldGroupList)) {
         qCDebug(KCONTACTS_LOG) << "Field Groups differs";
         return false;
     }
 
     if (!listEquals(d->mTitleExtraList, addressee.d->mTitleExtraList)) {
         qCDebug(KCONTACTS_LOG) << "Extra TitleList differs";
         return false;
     }
 
     if (!listEquals(d->mRoleExtraList, addressee.d->mRoleExtraList)) {
         qCDebug(KCONTACTS_LOG) << "Extra RoleList differs";
         return false;
     }
 
     if (!listEquals(d->mOrgExtraList, addressee.d->mOrgExtraList)) {
         qCDebug(KCONTACTS_LOG) << "Extra Organization List differs";
         return false;
     }
 
     if (!listEquals(d->mNickNameExtraList, addressee.d->mNickNameExtraList)) {
         qCDebug(KCONTACTS_LOG) << "Extra NickName List differs";
         return false;
     }
 
     if (!listEquals(d->mClientPidMapList, addressee.d->mClientPidMapList)) {
         qCDebug(KCONTACTS_LOG) << "ClientPidMap List differs";
         return false;
     }
     return true;
 }
 
 bool Addressee::operator!=(const Addressee &a) const
 {
     return !(a == *this);
 }
 
 bool Addressee::isEmpty() const
 {
     return d->mEmpty;
 }
 
 void Addressee::setUid(const QString &id)
 {
     if (id == d->mUid) {
         return;
     }
 
     d->mEmpty = false;
     d->mUid = id;
 }
 
 QString Addressee::uid() const
 {
     return d->mUid;
 }
 
 QString Addressee::uidLabel()
 {
     return i18n("Unique Identifier");
 }
 
 void Addressee::setName(const QString &name)
 {
     if (name == d->mName) {
         return;
     }
 
     d->mEmpty = false;
     d->mName = name;
 }
 
 QString Addressee::name() const
 {
     return d->mName;
 }
 
 QString Addressee::nameLabel()
 {
     return i18n("Name");
 }
 
 void Addressee::setKind(const QString &kind)
 {
     if (kind == d->mKind) {
         return;
     }
 
     d->mEmpty = false;
     d->mKind = kind;
 }
 
 QString Addressee::kind() const
 {
     return d->mKind;
 }
 
 void Addressee::insertExtraSound(const Sound &sound)
 {
     d->mEmpty = false;
     d->mSoundListExtra.append(sound);
 }
 
 Sound::List Addressee::extraSoundList() const
 {
     return d->mSoundListExtra;
 }
 
 void Addressee::insertExtraPhoto(const Picture &picture)
 {
     d->mEmpty = false;
     d->mPhotoExtraList.append(picture);
 }
 
 Picture::List Addressee::extraPhotoList() const
 {
     return d->mPhotoExtraList;
 }
 
 void Addressee::insertExtraLogo(const Picture &logo)
 {
     d->mEmpty = false;
     d->mLogoExtraList.append(logo);
 }
 
 Picture::List Addressee::extraLogoList() const
 {
     return d->mLogoExtraList;
 }
 
 void Addressee::setExtraSoundList(const Sound::List &soundList)
 {
     d->mEmpty = false;
     d->mSoundListExtra = soundList;
 }
 
 void Addressee::setExtraPhotoList(const Picture::List &pictureList)
 {
     d->mEmpty = false;
     d->mPhotoExtraList = pictureList;
 }
 
 void Addressee::setExtraLogoList(const Picture::List &logoList)
 {
     d->mEmpty = false;
     d->mLogoExtraList = logoList;
 }
 
 void Addressee::insertExtraUrl(const ResourceLocatorUrl &url)
 {
     if (url.isValid()) {
         d->mEmpty = false;
         d->mUrlExtraList.append(url);
     }
 }
 
 void Addressee::setExtraUrlList(const ResourceLocatorUrl::List &urlList)
 {
     d->mEmpty = false;
     d->mUrlExtraList = urlList;
 }
 
 ResourceLocatorUrl::List Addressee::extraUrlList() const
 {
     return d->mUrlExtraList;
 }
 
 void Addressee::insertSourceUrl(const QUrl &url)
 {
     d->mEmpty = false;
     d->mSources.append(url);
 }
 
 void Addressee::setSourcesUrlList(const QList<QUrl> &urlList)
 {
     d->mEmpty = false;
     d->mSources = urlList;
 }
 
 QList<QUrl> Addressee::sourcesUrlList() const
 {
     return d->mSources;
 }
 
 FieldGroup::List Addressee::fieldGroupList() const
 {
     return d->mFieldGroupList;
 }
 
 void Addressee::setFieldGroupList(const FieldGroup::List &fieldGroupList)
 {
     d->mEmpty = false;
     d->mFieldGroupList = fieldGroupList;
 }
 
 void Addressee::insertFieldGroup(const FieldGroup &fieldGroup)
 {
     if (fieldGroup.isValid()) {
         d->mEmpty = false;
         // TODO don't duplicate ?
         d->mFieldGroupList.append(fieldGroup);
     }
 }
 
 ClientPidMap::List Addressee::clientPidMapList() const
 {
     return d->mClientPidMapList;
 }
 
 void Addressee::setClientPidMapList(const ClientPidMap::List &clientpidmaplist)
 {
     d->mEmpty = false;
     d->mClientPidMapList = clientpidmaplist;
 }
 
 void Addressee::insertClientPidMap(const ClientPidMap &clientpidmap)
 {
     if (clientpidmap.isValid()) {
         d->mEmpty = false;
         // TODO don't duplicate ?
         d->mClientPidMapList.append(clientpidmap);
     }
 }
 
 void Addressee::insertImpp(const Impp &impp)
 {
     if (impp.isValid()) {
         d->mEmpty = false;
         // Don't duplicate ?
         d->mImpps.append(impp);
     }
 }
 
 void Addressee::setImppList(const Impp::List &imppList)
 {
     d->mEmpty = false;
     d->mImpps = imppList;
 }
 
 Impp::List Addressee::imppList() const
 {
     return d->mImpps;
 }
 
 void Addressee::insertCalendarUrl(const CalendarUrl &calendarUrl)
 {
     d->mEmpty = false;
     // TODO verify that there is not same calendarurl
     if (calendarUrl.isValid()) {
         d->mCalendarUrl.append(calendarUrl);
     }
 }
 
 CalendarUrl::List Addressee::calendarUrlList() const
 {
     return d->mCalendarUrl;
 }
 
 void Addressee::setFormattedName(const QString &formattedName)
 {
     if (formattedName == d->mFormattedName) {
         return;
     }
 
     d->mEmpty = false;
     d->mFormattedName = formattedName;
 }
 
 QString Addressee::formattedName() const
 {
     return d->mFormattedName;
 }
 
 QString Addressee::formattedNameLabel()
 {
     return i18n("Formatted Name");
 }
 
 void Addressee::setFamilyName(const QString &familyName)
 {
     if (familyName == d->mFamilyName) {
         return;
     }
 
     d->mEmpty = false;
     d->mFamilyName = familyName;
 }
 
 QString Addressee::familyName() const
 {
     return d->mFamilyName;
 }
 
 QString Addressee::familyNameLabel()
 {
     return i18n("Family Name");
 }
 
 void Addressee::setGivenName(const QString &givenName)
 {
     if (givenName == d->mGivenName) {
         return;
     }
 
     d->mEmpty = false;
     d->mGivenName = givenName;
 }
 
 QString Addressee::givenName() const
 {
     return d->mGivenName;
 }
 
 QString Addressee::givenNameLabel()
 {
     return i18n("Given Name");
 }
 
 void Addressee::setAdditionalName(const QString &additionalName)
 {
     if (additionalName == d->mAdditionalName) {
         return;
     }
 
     d->mEmpty = false;
     d->mAdditionalName = additionalName;
 }
 
 QString Addressee::additionalName() const
 {
     return d->mAdditionalName;
 }
 
 QString Addressee::additionalNameLabel()
 {
     return i18n("Additional Names");
 }
 
 void Addressee::setPrefix(const QString &prefix)
 {
     if (prefix == d->mPrefix) {
         return;
     }
 
     d->mEmpty = false;
     d->mPrefix = prefix;
 }
 
 QString Addressee::prefix() const
 {
     return d->mPrefix;
 }
 
 QString Addressee::prefixLabel()
 {
     return i18n("Honorific Prefixes");
 }
 
 void Addressee::setSuffix(const QString &suffix)
 {
     if (suffix == d->mSuffix) {
         return;
     }
 
     d->mEmpty = false;
     d->mSuffix = suffix;
 }
 
 QString Addressee::suffix() const
 {
     return d->mSuffix;
 }
 
 QString Addressee::suffixLabel()
 {
     return i18n("Honorific Suffixes");
 }
 
 void Addressee::setNickName(const QString &nickName)
 {
     NickName t(nickName);
     if (!d->mNickNameExtraList.isEmpty()) {
         t = d->mNickNameExtraList.takeFirst();
         t.setNickName(nickName);
         d->mNickNameExtraList.prepend(t);
         d->mEmpty = false;
     } else {
         insertExtraNickName(t);
     }
 }
 
 void Addressee::setNickName(const NickName &nickName)
 {
     insertExtraNickName(nickName);
 }
 
 void Addressee::insertExtraNickName(const NickName &nickName)
 {
     if (nickName.isValid()) {
         d->mEmpty = false;
         d->mNickNameExtraList.append(nickName);
     }
 }
 
 void Addressee::setExtraNickNameList(const NickName::List &nickNameList)
 {
     d->mEmpty = false;
     d->mNickNameExtraList = nickNameList;
 }
 
 NickName::List Addressee::extraNickNameList() const
 {
     return d->mNickNameExtraList;
 }
 
 QString Addressee::nickName() const
 {
     if (d->mNickNameExtraList.isEmpty()) {
         return {};
     } else {
         return d->mNickNameExtraList.at(0).nickname();
     }
 }
 
 QString Addressee::nickNameLabel()
 {
     return i18n("Nick Name");
 }
 
 void Addressee::setBirthday(const QDateTime &birthday, bool withTime)
 {
     if (birthday == d->mBirthday && d->mBirthdayWithTime == withTime) {
         return;
     }
 
     d->mEmpty = false;
     d->mBirthday = birthday;
     if (!withTime) {
         d->mBirthday.setTime(QTime());
     }
     d->mBirthdayWithTime = withTime;
 }
 
 void Addressee::setBirthday(const QDate &birthday)
 {
     if (birthday == d->mBirthday.date() && !d->mBirthdayWithTime) {
         return;
     }
 
     d->mEmpty = false;
     d->mBirthday = QDateTime(birthday, QTime());
     d->mBirthdayWithTime = false;
 }
 
 QDateTime Addressee::birthday() const
 {
     return d->mBirthday;
 }
 
 bool Addressee::birthdayHasTime() const
 {
     return d->mBirthdayWithTime;
 }
 
 QString Addressee::birthdayLabel()
 {
     return i18n("Birthday");
 }
 
 QString Addressee::homeAddressStreetLabel()
 {
     return i18n("Home Address Street");
 }
 
 QString Addressee::homeAddressPostOfficeBoxLabel()
 {
     return i18n("Home Address Post Office Box");
 }
 
 QString Addressee::homeAddressLocalityLabel()
 {
     return i18n("Home Address City");
 }
 
 QString Addressee::homeAddressRegionLabel()
 {
     return i18n("Home Address State");
 }
 
 QString Addressee::homeAddressPostalCodeLabel()
 {
     return i18n("Home Address Zip Code");
 }
 
 QString Addressee::homeAddressCountryLabel()
 {
     return i18n("Home Address Country");
 }
 
 QString Addressee::homeAddressLabelLabel()
 {
     return i18n("Home Address Label");
 }
 
 QString Addressee::businessAddressStreetLabel()
 {
     return i18n("Business Address Street");
 }
 
 QString Addressee::businessAddressPostOfficeBoxLabel()
 {
     return i18n("Business Address Post Office Box");
 }
 
 QString Addressee::businessAddressLocalityLabel()
 {
     return i18n("Business Address City");
 }
 
 QString Addressee::businessAddressRegionLabel()
 {
     return i18n("Business Address State");
 }
 
 QString Addressee::businessAddressPostalCodeLabel()
 {
     return i18n("Business Address Zip Code");
 }
 
 QString Addressee::businessAddressCountryLabel()
 {
     return i18n("Business Address Country");
 }
 
 QString Addressee::businessAddressLabelLabel()
 {
     return i18n("Business Address Label");
 }
 
 QString Addressee::homePhoneLabel()
 {
     return i18n("Home Phone");
 }
 
 QString Addressee::businessPhoneLabel()
 {
     return i18n("Business Phone");
 }
 
 QString Addressee::mobilePhoneLabel()
 {
     return i18n("Mobile Phone");
 }
 
 QString Addressee::homeFaxLabel()
 {
     return i18n("Home Fax");
 }
 
 QString Addressee::businessFaxLabel()
 {
     return i18n("Business Fax");
 }
 
 QString Addressee::carPhoneLabel()
 {
     return i18n("Car Phone");
 }
 
 QString Addressee::isdnLabel()
 {
     return i18n("ISDN");
 }
 
 QString Addressee::pagerLabel()
 {
     return i18n("Pager");
 }
 
 QString Addressee::emailLabel()
 {
     return i18n("Email Address");
 }
 
 void Addressee::setMailer(const QString &mailer)
 {
     if (mailer == d->mMailer) {
         return;
     }
 
     d->mEmpty = false;
     d->mMailer = mailer;
 }
 
 QString Addressee::mailer() const
 {
     return d->mMailer;
 }
 
 QString Addressee::mailerLabel()
 {
     return i18n("Mail Client");
 }
 
 void Addressee::setTimeZone(const TimeZone &timeZone)
 {
     if (timeZone == d->mTimeZone) {
         return;
     }
 
     d->mEmpty = false;
     d->mTimeZone = timeZone;
 }
 
 TimeZone Addressee::timeZone() const
 {
     return d->mTimeZone;
 }
 
 QString Addressee::timeZoneLabel()
 {
     return i18n("Time Zone");
 }
 
 void Addressee::setGeo(const Geo &geo)
 {
     if (geo == d->mGeo) {
         return;
     }
 
     d->mEmpty = false;
     d->mGeo = geo;
 }
 
 Geo Addressee::geo() const
 {
     return d->mGeo;
 }
 
 QString Addressee::geoLabel()
 {
     return i18n("Geographic Position");
 }
 
 void Addressee::setTitle(const QString &title)
 {
     Title t(title);
     if (!d->mTitleExtraList.isEmpty()) {
         t = d->mTitleExtraList.takeFirst();
         t.setTitle(title);
         d->mTitleExtraList.prepend(t);
         d->mEmpty = false;
     } else {
         insertExtraTitle(title);
     }
 }
 
 void Addressee::setTitle(const Title &title)
 {
     insertExtraTitle(title);
 }
 
 void Addressee::insertExtraTitle(const Title &title)
 {
     if (title.isValid()) {
         d->mEmpty = false;
         d->mTitleExtraList.append(title);
     }
 }
 
 QString Addressee::title() const
 {
     if (d->mTitleExtraList.isEmpty()) {
         return {};
     } else {
         return d->mTitleExtraList.at(0).title();
     }
 }
 
 Title::List Addressee::extraTitleList() const
 {
     return d->mTitleExtraList;
 }
 
 void Addressee::setExtraTitleList(const Title::List &urltitle)
 {
     d->mEmpty = false;
     d->mTitleExtraList = urltitle;
 }
 
 QString Addressee::titleLabel()
 {
     return i18nc("a person's title", "Title");
 }
 
 void Addressee::setRole(const QString &role)
 {
     Role t(role);
     if (!d->mRoleExtraList.isEmpty()) {
         t = d->mRoleExtraList.takeFirst();
         t.setRole(role);
         d->mRoleExtraList.prepend(t);
         d->mEmpty = false;
     } else {
         insertExtraRole(t);
     }
 }
 
 void Addressee::setRole(const Role &role)
 {
     insertExtraRole(role);
 }
 
 void Addressee::insertExtraRole(const Role &role)
 {
     if (role.isValid()) {
         d->mEmpty = false;
         d->mRoleExtraList.append(role);
     }
 }
 
 void Addressee::setExtraRoleList(const Role::List &roleList)
 {
     d->mEmpty = false;
     d->mRoleExtraList = roleList;
 }
 
 Role::List Addressee::extraRoleList() const
 {
     return d->mRoleExtraList;
 }
 
 QString Addressee::role() const
 {
     if (d->mRoleExtraList.isEmpty()) {
         return {};
     } else {
         return d->mRoleExtraList.at(0).role();
     }
 }
 
 QString Addressee::roleLabel()
 {
     return i18nc("of a person in an organization", "Role");
 }
 
 void Addressee::setOrganization(const QString &organization)
 {
     Org t(organization);
     if (!d->mOrgExtraList.isEmpty()) {
         t = d->mOrgExtraList.takeFirst();
         t.setOrganization(organization);
         d->mOrgExtraList.prepend(t);
         d->mEmpty = false;
     } else {
         insertExtraOrganization(t);
     }
 }
 
 void Addressee::setOrganization(const Org &organization)
 {
     insertExtraOrganization(organization);
 }
 
 void Addressee::insertExtraOrganization(const Org &organization)
 {
     if (organization.isValid()) {
         d->mEmpty = false;
         d->mOrgExtraList.append(organization);
     }
 }
 
 void Addressee::setExtraOrganizationList(const Org::List &orgList)
 {
     d->mEmpty = false;
     d->mOrgExtraList = orgList;
 }
 
 Org::List Addressee::extraOrganizationList() const
 {
     return d->mOrgExtraList;
 }
 
 QString Addressee::organization() const
 {
     if (d->mOrgExtraList.isEmpty()) {
         return {};
     } else {
         return d->mOrgExtraList.at(0).organization();
     }
 }
 
 QString Addressee::organizationLabel()
 {
     return i18n("Organization");
 }
 
 void Addressee::setDepartment(const QString &department)
 {
     if (department == d->mDepartment) {
         return;
     }
 
     d->mEmpty = false;
     d->mDepartment = department;
 }
 
 QString Addressee::department() const
 {
     return d->mDepartment;
 }
 
 QString Addressee::departmentLabel()
 {
     return i18n("Department");
 }
 
 void Addressee::setNote(const QString &note)
 {
     if (note == d->mNote) {
         return;
     }
 
     d->mEmpty = false;
     d->mNote = note;
 }
 
 QString Addressee::note() const
 {
     return d->mNote;
 }
 
 QString Addressee::noteLabel()
 {
     return i18n("Note");
 }
 
 void Addressee::setProductId(const QString &productId)
 {
     if (productId == d->mProductId) {
         return;
     }
 
     d->mEmpty = false;
     d->mProductId = productId;
 }
 
 QString Addressee::productId() const
 {
     return d->mProductId;
 }
 
 QString Addressee::productIdLabel()
 {
     return i18n("Product Identifier");
 }
 
 void Addressee::setRevision(const QDateTime &revision)
 {
     if (revision == d->mRevision) {
         return;
     }
 
     d->mEmpty = false;
     d->mRevision = revision;
 }
 
 QDateTime Addressee::revision() const
 {
     return d->mRevision;
 }
 
 QString Addressee::revisionLabel()
 {
     return i18n("Revision Date");
 }
 
 void Addressee::setSortString(const QString &sortString)
 {
     if (sortString == d->mSortString) {
         return;
     }
 
     d->mEmpty = false;
     d->mSortString = sortString;
 }
 
 QString Addressee::sortString() const
 {
     return d->mSortString;
 }
 
 QString Addressee::sortStringLabel()
 {
     return i18n("Sort String");
 }
 
 void Addressee::setUrl(const QUrl &url)
 {
     KContacts::ResourceLocatorUrl resourceLocator;
     resourceLocator.setUrl(url);
     insertExtraUrl(resourceLocator);
 }
 
 void Addressee::setUrl(const ResourceLocatorUrl &url)
 {
     insertExtraUrl(url);
 }
 
 ResourceLocatorUrl Addressee::url() const
 {
     if (d->mUrlExtraList.isEmpty()) {
         return ResourceLocatorUrl();
     } else {
         return d->mUrlExtraList.at(0);
     }
 }
 
 QString Addressee::urlLabel()
 {
     return i18n("Homepage");
 }
 
 void Addressee::setSecrecy(const Secrecy &secrecy)
 {
     if (secrecy == d->mSecrecy) {
         return;
     }
 
     d->mEmpty = false;
     d->mSecrecy = secrecy;
 }
 
 Secrecy Addressee::secrecy() const
 {
     return d->mSecrecy;
 }
 
 QString Addressee::secrecyLabel()
 {
     return i18n("Security Class");
 }
 
 void Addressee::setLogo(const Picture &logo)
 {
     if (logo == d->mLogo) {
         return;
     }
 
     d->mEmpty = false;
     d->mLogo = logo;
 }
 
 Picture Addressee::logo() const
 {
     return d->mLogo;
 }
 
 QString Addressee::logoLabel()
 {
     return i18n("Logo");
 }
 
 void Addressee::setPhoto(const Picture &photo)
 {
     if (photo == d->mPhoto) {
         return;
     }
 
     d->mEmpty = false;
     d->mPhoto = photo;
 }
 
 Picture Addressee::photo() const
 {
     return d->mPhoto;
 }
 
 QString Addressee::photoLabel()
 {
     return i18n("Photo");
 }
 
 void Addressee::setSound(const Sound &sound)
 {
     if (sound == d->mSound) {
         return;
     }
 
     d->mEmpty = false;
     d->mSound = sound;
 }
 
 Sound Addressee::sound() const
 {
     return d->mSound;
 }
 
 QString Addressee::soundLabel()
 {
     return i18n("Sound");
 }
 
 void Addressee::setNameFromString(const QString &s)
 {
     QString str = s;
     // remove enclosing quotes from string
     if (str.length() > 1 && s[0] == QLatin1Char('"') && s[s.length() - 1] == QLatin1Char('"')) {
         str = s.mid(1, s.length() - 2);
     }
 
     setFormattedName(str);
     setName(str);
 
     // clear all name parts
     setPrefix(QString());
     setGivenName(QString());
     setAdditionalName(QString());
     setFamilyName(QString());
     setSuffix(QString());
 
     if (str.isEmpty()) {
         return;
     }
 
     static QString spaceStr = QStringLiteral(" ");
     static QString emptyStr = QStringLiteral("");
     AddresseeHelper *helper = AddresseeHelper::self();
 
     int i = str.indexOf(QLatin1Char(','));
     if (i < 0) {
         QStringList parts = str.split(spaceStr);
         int leftOffset = 0;
         int rightOffset = parts.count() - 1;
 
         QString suffix;
         while (rightOffset >= 0) {
             if (helper->containsSuffix(parts[rightOffset])) {
                 suffix.prepend(parts[rightOffset] + (suffix.isEmpty() ? emptyStr : spaceStr));
                 rightOffset--;
             } else {
                 break;
             }
         }
         setSuffix(suffix);
 
         if (rightOffset < 0) {
             return;
         }
 
         if (rightOffset - 1 >= 0 && helper->containsPrefix(parts[rightOffset - 1].toLower())) {
             setFamilyName(parts[rightOffset - 1] + spaceStr + parts[rightOffset]);
             rightOffset--;
         } else {
             if (helper->treatAsFamilyName()) {
                 setFamilyName(parts[rightOffset]);
             } else {
                 setGivenName(parts[rightOffset]);
             }
         }
 
         QString prefix;
         while (leftOffset < rightOffset) {
             if (helper->containsTitle(parts[leftOffset])) {
                 prefix.append((prefix.isEmpty() ? emptyStr : spaceStr) + parts[leftOffset]);
                 leftOffset++;
             } else {
                 break;
             }
         }
         setPrefix(prefix);
 
         if (leftOffset < rightOffset) {
             setGivenName(parts[leftOffset]);
             leftOffset++;
         }
 
         QString additionalName;
         while (leftOffset < rightOffset) {
             additionalName.append((additionalName.isEmpty() ? emptyStr : spaceStr) + parts[leftOffset]);
             leftOffset++;
         }
         setAdditionalName(additionalName);
     } else {
         QString part1 = str.left(i);
         QString part2 = str.mid(i + 1);
 
         QStringList parts = part1.split(spaceStr);
         int leftOffset = 0;
         int rightOffset = parts.count() - 1;
 
         if (!parts.isEmpty()) {
             QString suffix;
             while (rightOffset >= 0) {
                 if (helper->containsSuffix(parts[rightOffset])) {
                     suffix.prepend(parts[rightOffset] + (suffix.isEmpty() ? emptyStr : spaceStr));
                     rightOffset--;
                 } else {
                     break;
                 }
             }
             setSuffix(suffix);
 
             if (rightOffset - 1 >= 0 && helper->containsPrefix(parts[rightOffset - 1].toLower())) {
                 setFamilyName(parts[rightOffset - 1] + spaceStr + parts[rightOffset]);
                 rightOffset--;
             } else {
                 setFamilyName(parts[rightOffset]);
             }
 
             QString prefix;
             while (leftOffset < rightOffset) {
                 if (helper->containsTitle(parts[leftOffset])) {
                     prefix.append((prefix.isEmpty() ? emptyStr : spaceStr) + parts[leftOffset]);
                     leftOffset++;
                 } else {
                     break;
                 }
             }
         } else {
             setPrefix(QString());
             setFamilyName(QString());
             setSuffix(QString());
         }
 
         parts = part2.split(spaceStr);
 
         leftOffset = 0;
         rightOffset = parts.count();
 
         if (!parts.isEmpty()) {
             QString prefix;
             while (leftOffset < rightOffset) {
                 if (helper->containsTitle(parts[leftOffset])) {
                     prefix.append((prefix.isEmpty() ? emptyStr : spaceStr) + parts[leftOffset]);
                     leftOffset++;
                 } else {
                     break;
                 }
             }
             setPrefix(prefix);
 
             if (leftOffset < rightOffset) {
                 setGivenName(parts[leftOffset]);
                 leftOffset++;
             }
 
             QString additionalName;
             while (leftOffset < rightOffset) {
                 additionalName.append((additionalName.isEmpty() ? emptyStr : spaceStr) + parts[leftOffset]);
                 leftOffset++;
             }
             setAdditionalName(additionalName);
         } else {
             setGivenName(QString());
             setAdditionalName(QString());
         }
     }
 }
 
 QString Addressee::realName() const
 {
     QString n(formattedName());
     if (!n.isEmpty()) {
         return n;
     }
 
     n = assembledName();
     if (!n.isEmpty()) {
         return n;
     }
 
     n = name();
     if (!n.isEmpty()) {
         return n;
     }
 
     return organization();
 }
 
 QString Addressee::assembledName() const
 {
     // clang-format off
     const QString name = prefix() + QLatin1Char(' ')
                          + givenName() + QLatin1Char(' ')
                          + additionalName() + QLatin1Char(' ')
                          + familyName() + QLatin1Char(' ')
                          + suffix();
     // clang-format on
 
     return name.simplified();
 }
 
 QString Addressee::fullEmail(const QString &email) const
 {
     QString e;
     if (email.isNull()) {
         e = preferredEmail();
     } else {
         e = email;
     }
     if (e.isEmpty()) {
         return QString();
     }
 
     QString text;
     if (realName().isEmpty()) {
         text = e;
     } else {
         QRegularExpression needQuotes(QStringLiteral("[^ 0-9A-Za-z\\x{0080}-\\x{FFFF}]"));
         if (realName().indexOf(needQuotes) != -1) {
             QString name = realName();
             name.replace(QLatin1String("\""), QLatin1String("\\\""));
             text = QLatin1String("\"") + name + QLatin1String("\" <") + e + QLatin1Char('>');
         } else {
             text = realName() + QLatin1String(" <") + e + QLatin1Char('>');
         }
     }
 
     return text;
 }
 
 void Addressee::addEmail(const Email &email)
 {
     const QString mailAddr = email.mail();
     auto it = std::find_if(d->mEmails.begin(), d->mEmails.end(), [&mailAddr](const Email &e) {
         return e.mail() == mailAddr;
     });
     if (it != d->mEmails.end()) { // Already exists, modify it
         *it = email;
         if (email.isPreferred()) {
             // Move it to the beginning of mEmails
             std::rotate(d->mEmails.begin(), it, it + 1);
         }
         return;
     }
 
     // Add it to the list
     d->mEmpty = false;
     if (email.isPreferred()) {
         d->mEmails.prepend(email);
     } else {
         d->mEmails.append(email);
     }
 }
 
 void Addressee::removeEmail(const QString &email)
 {
     for (int i = 0; i < d->mEmails.size(); ++i) {
         if (d->mEmails.at(i).mail() == email) {
             d->mEmails.removeAt(i);
         }
     }
 }
 
 QString Addressee::preferredEmail() const
 {
     if (d->mEmails.isEmpty()) {
         return QString();
     } else {
         return d->mEmails.first().mail();
     }
 }
 
 QStringList Addressee::emails() const
 {
     QStringList list;
     const int numberOfEmail = d->mEmails.size();
     list.reserve(numberOfEmail);
     for (int i = 0; i < numberOfEmail; ++i) {
         list << d->mEmails.at(i).mail();
     }
 
     return list;
 }
 
 Email::List Addressee::emailList() const
 {
     return d->mEmails;
 }
 
 void Addressee::setEmails(const QStringList &emails)
 {
     d->mEmails.clear();
     const int numEmails = emails.size();
     d->mEmails.reserve(numEmails);
     for (int i = 0; i < numEmails; ++i) {
         d->mEmails.append(Email(emails.at(i)));
     }
     d->mEmpty = false;
 }
 
 void Addressee::setEmailList(const Email::List &list)
 {
     d->mEmails = list;
     d->mEmpty = false;
 }
 
 void Addressee::removeLang(const QString &language)
 {
     for (int i = 0; i < d->mLangs.size(); ++i) {
         if (d->mLangs.at(i).language() == language) {
             d->mLangs.removeAt(i);
         }
     }
 }
 
 void Addressee::setLangs(const Lang::List &langs)
 {
     d->mLangs = langs;
     d->mEmpty = false;
 }
 
 void Addressee::insertLang(const Lang &language)
 {
     const QString languageStr = language.language();
     if (languageStr.simplified().isEmpty()) {
         return;
     }
     d->mEmpty = false;
 
     auto it = std::find_if(d->mLangs.begin(), d->mLangs.end(), [&languageStr](const Lang &lang) {
         return lang.language() == languageStr;
     });
     if (it != d->mLangs.end()) {
         (*it).setParams(language.params());
         return;
     }
 
     d->mLangs.append(language);
 }
 
 Lang::List Addressee::langs() const
 {
     return d->mLangs;
 }
 
 void Addressee::setGender(const Gender &gender)
 {
     if (gender == d->mGender) {
         return;
     }
 
     d->mEmpty = false;
     d->mGender = gender;
 }
 
 Gender Addressee::gender() const
 {
     return d->mGender;
 }
 
 void Addressee::insertPhoneNumber(const PhoneNumber &phoneNumber)
 {
     d->mEmpty = false;
 
     auto it = std::find_if(d->mPhoneNumbers.begin(), d->mPhoneNumbers.end(), [&phoneNumber](const PhoneNumber &pNumber) {
         return pNumber.id() == phoneNumber.id();
     });
     if (it != d->mPhoneNumbers.end()) {
         *it = phoneNumber;
         return;
     }
 
     if (!phoneNumber.number().simplified().isEmpty()) {
         d->mPhoneNumbers.append(phoneNumber);
     }
 }
 
 void Addressee::removePhoneNumber(const PhoneNumber &phoneNumber)
 {
     auto it = std::find_if(d->mPhoneNumbers.begin(), d->mPhoneNumbers.end(), [&phoneNumber](const PhoneNumber &p) {
         return p.id() == phoneNumber.id();
     });
 
     if (it != d->mPhoneNumbers.end()) {
         d->mPhoneNumbers.erase(it);
     }
 }
 
 PhoneNumber Addressee::phoneNumber(PhoneNumber::Type type) const
 {
     PhoneNumber phoneNumber(QString(), type);
 
     for (const PhoneNumber &phone : d->mPhoneNumbers) {
         if (matchBinaryPattern(phone.type(), type)) {
             if (phone.type() & PhoneNumber::Pref) {
                 return phone;
             } else if (phoneNumber.number().isEmpty()) {
                 phoneNumber = phone;
             }
         }
     }
 
     return phoneNumber;
 }
 
 PhoneNumber::List Addressee::phoneNumbers() const
 {
     return d->mPhoneNumbers;
 }
 
 void Addressee::setPhoneNumbers(const PhoneNumber::List &phoneNumbers)
 {
     d->mEmpty = false;
     d->mPhoneNumbers.clear();
     d->mPhoneNumbers = phoneNumbers;
 }
 
 PhoneNumber::List Addressee::phoneNumbers(PhoneNumber::Type type) const
 {
     PhoneNumber::List list;
 
     std::copy_if(d->mPhoneNumbers.cbegin(), d->mPhoneNumbers.cend(), std::back_inserter(list), [type](const auto &phone) {
         return matchBinaryPattern(phone.type(), type);
     });
     return list;
 }
 
 PhoneNumber Addressee::findPhoneNumber(const QString &id) const
 {
     auto it = std::find_if(d->mPhoneNumbers.cbegin(), d->mPhoneNumbers.cend(), [&id](const PhoneNumber &phone) {
         return phone.id() == id;
     });
 
     return it != d->mPhoneNumbers.cend() ? *it : PhoneNumber{};
 }
 
 void Addressee::insertKey(const Key &key)
 {
     d->mEmpty = false;
 
     auto it = std::find_if(d->mKeys.begin(), d->mKeys.end(), [&key](Key &existing) {
         return existing.id() == key.id();
     });
     if (it != d->mKeys.end()) {
         *it = key;
     } else {
         d->mKeys.append(key);
     }
 }
 
 void Addressee::removeKey(const Key &key)
 {
     auto it = std::remove_if(d->mKeys.begin(), d->mKeys.end(), [&key](const Key &k) {
         return k.id() == key.id();
     });
     d->mKeys.erase(it, d->mKeys.end());
 }
 
 Key Addressee::key(Key::Type type, const QString &customTypeString) const
 {
     for (const auto &key : d->mKeys) {
         if (key.type() == type) {
             if (type == Key::Custom) {
                 if (customTypeString.isEmpty()) {
                     return key;
                 } else {
                     if (key.customTypeString() == customTypeString) {
                         return key;
                     }
                 }
             } else {
                 return key;
             }
         }
     }
     return Key(QString(), type);
 }
 
 void Addressee::setKeys(const Key::List &list)
 {
     d->mKeys = list;
     d->mEmpty = false;
 }
 
 Key::List Addressee::keys() const
 {
     return d->mKeys;
 }
 
 Key::List Addressee::keys(Key::Type type, const QString &customTypeString) const
 {
     Key::List list;
     auto matchFunc = [type, &customTypeString](const Key &key) {
         if (key.type() == type) {
             if (type == Key::Custom) {
                 if (customTypeString.isEmpty()) {
                     return true;
                 } else {
                     if (key.customTypeString() == customTypeString) {
                         return true;
                     }
                 }
             } else {
                 return true;
             }
         }
         return false;
     };
 
     std::copy_if(d->mKeys.cbegin(), d->mKeys.cend(), std::back_inserter(list), matchFunc);
 
     return list;
 }
 
 Key Addressee::findKey(const QString &id) const
 {
     auto it = std::find_if(d->mKeys.cbegin(), d->mKeys.cend(), [&id](const Key &key) {
         return key.id() == id;
     });
 
     return it != d->mKeys.cend() ? *it : Key{};
 }
 
 QString Addressee::toString() const
 {
     QString str = QLatin1String("Addressee {\n");
     str += QStringLiteral("  Uid: %1\n").arg(uid());
 
     str += QStringLiteral("  Name: %1\n").arg(name());
     str += QStringLiteral("  FormattedName: %1\n").arg(formattedName());
     str += QStringLiteral("  FamilyName: %1\n").arg(familyName());
     str += QStringLiteral("  GivenName: %1\n").arg(givenName());
     str += QStringLiteral("  AdditionalName: %1\n").arg(additionalName());
     str += QStringLiteral("  Prefix: %1\n").arg(prefix());
     str += QStringLiteral("  Suffix: %1\n").arg(suffix());
     str += QStringLiteral("  NickName: %1\n").arg(nickName());
     str += QStringLiteral("  Birthday: %1\n").arg(birthday().toString());
     str += QStringLiteral("  Mailer: %1\n").arg(mailer());
     str += QStringLiteral("  TimeZone: %1\n").arg(timeZone().toString());
     str += QStringLiteral("  Geo: %1\n").arg(geo().toString());
     str += QStringLiteral("  Title: %1\n").arg(title());
     str += QStringLiteral("  Role: %1\n").arg(role());
     str += QStringLiteral("  Organization: %1\n").arg(organization());
     str += QStringLiteral("  Department: %1\n").arg(department());
     str += QStringLiteral("  Note: %1\n").arg(note());
     str += QStringLiteral("  ProductId: %1\n").arg(productId());
     str += QStringLiteral("  Revision: %1\n").arg(revision().toString());
     str += QStringLiteral("  SortString: %1\n").arg(sortString());
     str += QStringLiteral("  Url: %1\n").arg(url().url().url());
     str += QStringLiteral("  Secrecy: %1\n").arg(secrecy().toString());
     str += QStringLiteral("  Logo: %1\n").arg(logo().toString());
     str += QStringLiteral("  Photo: %1\n").arg(photo().toString());
     str += QStringLiteral("  Sound: %1\n").arg(sound().toString());
     str += QStringLiteral("  Gender: %1\n").arg(gender().toString());
     str += QStringLiteral("  Kind: %1\n").arg(kind());
 
     str += QLatin1String("  Emails {\n");
     const Email::List listEmail = d->mEmails;
     for (const Email &email : listEmail) {
         str += email.toString();
     }
     str += QLatin1String("  }\n");
 
     str += QLatin1String("  Langs {\n");
     const Lang::List listLang = d->mLangs;
     for (const Lang &lang : listLang) {
         str += lang.toString();
     }
     str += QLatin1String("  }\n");
 
     str += QLatin1String("  PhoneNumbers {\n");
     const PhoneNumber::List phones = phoneNumbers();
     for (const auto &p : phones) {
         str += p.toString();
     }
     str += QLatin1String("  }\n");
 
     str += QLatin1String("  Addresses {\n");
     const Address::List addrList = addresses();
     for (const auto &addr : addrList) {
         str += addr.toString();
     }
     str += QLatin1String("  }\n");
 
     str += QLatin1String("  Keys {\n");
     const Key::List keyList = keys();
     for (const auto &k : keyList) {
         str += k.toString();
     }
     str += QLatin1String("  }\n");
 
     str += QLatin1String("}\n");
 
     return str;
 }
 
 void Addressee::insertAddress(const Address &address)
 {
     if (address.isEmpty()) {
         return;
     }
 
     d->mEmpty = false;
 
     auto it = std::find_if(d->mAddresses.begin(), d->mAddresses.end(), [&address](const Address &addr) {
         return addr.id() == address.id();
     });
     if (it != d->mAddresses.end()) {
         *it = address;
         return;
     }
 
     d->mAddresses.append(address);
 }
 
 void Addressee::removeAddress(const Address &address)
 {
     auto it = std::find_if(d->mAddresses.begin(), d->mAddresses.end(), [&address](const Address &addr) {
         return addr.id() == address.id();
     });
     if (it != d->mAddresses.end()) {
         d->mAddresses.erase(it);
     }
 }
 
 void Addressee::setAddresses(const Address::List &addresses)
 {
     d->mEmpty = false;
     d->mAddresses = addresses;
 }
 
 Address Addressee::address(Address::Type type) const
 {
     Address address(type);
     for (const Address &addr : d->mAddresses) {
         if (matchBinaryPattern(addr.type(), type)) {
             if (addr.type() & Address::Pref) {
                 return addr;
             } else if (address.isEmpty()) {
                 address = addr;
             }
         }
     }
 
     return address;
 }
 
 Address::List Addressee::addresses() const
 {
     return d->mAddresses;
 }
 
 Address::List Addressee::addresses(Address::Type type) const
 {
     Address::List list;
 
     std::copy_if(d->mAddresses.cbegin(), d->mAddresses.cend(), std::back_inserter(list), [type](const Address &addr) {
         return matchBinaryPattern(addr.type(), type);
     });
 
     return list;
 }
 
 Address Addressee::findAddress(const QString &id) const
 {
     auto it = std::find_if(d->mAddresses.cbegin(), d->mAddresses.cend(), [&id](const Address &addr) {
         return addr.id() == id;
     });
     return it != d->mAddresses.cend() ? *it : Address{};
 }
 
 void Addressee::insertCategory(const QString &c)
 {
     d->mEmpty = false;
 
     if (d->mCategories.contains(c)) {
         return;
     }
 
     d->mCategories.append(c);
 }
 
 void Addressee::removeCategory(const QString &category)
 {
     if (d->mCategories.contains(category)) {
         d->mCategories.removeAll(category);
     }
 }
 
 bool Addressee::hasCategory(const QString &category) const
 {
     return d->mCategories.contains(category);
 }
 
 void Addressee::setCategories(const QStringList &c)
 {
     d->mEmpty = false;
 
     d->mCategories = c;
 }
 
 QStringList Addressee::categories() const
 {
     return d->mCategories;
 }
 
 void Addressee::insertMember(const QString &member)
 {
     d->mEmpty = false;
 
     if (d->mMembers.contains(member)) {
         return;
     }
 
     d->mMembers.append(member);
 }
 
 void Addressee::setMembers(const QStringList &m)
 {
     d->mEmpty = false;
     d->mMembers = m;
 }
 
 QStringList Addressee::members() const
 {
     return d->mMembers;
 }
 
 void Addressee::insertRelationship(const Related &relation)
 {
     d->mEmpty = false;
 
     if (d->mRelationships.contains(relation)) {
         return;
     }
 
     d->mRelationships.append(relation);
 }
 
 void Addressee::setRelationships(const Related::List &c)
 {
     d->mEmpty = false;
     d->mRelationships = c;
 }
 
 Related::List Addressee::relationships() const
 {
     return d->mRelationships;
 }
 
 static const auto VENDOR_ID = QStringLiteral("KADDRESSBOOK");
 static const auto X_ANNIVERSARY = QStringLiteral("X-Anniversary");
 static const auto X_ASSISTANTSNAME = QStringLiteral("X-AssistantsName");
 static const auto BLOGFEED = QStringLiteral("BlogFeed");
 static const auto X_MANAGERSNAME = QStringLiteral("X-ManagersName");
 static const auto X_OFFICE = QStringLiteral("X-Office");
 static const auto X_PROFESSION = QStringLiteral("X-Profession");
 static const auto X_SPOUSESNAME = QStringLiteral("X-SpousesName");
 
 QDate Addressee::anniversary() const
 {
     return QDate::fromString(custom(VENDOR_ID, X_ANNIVERSARY), Qt::ISODate);
 }
 
 void Addressee::setAnniversary(const QDate &anniversary)
 {
     if (anniversary.isValid()) {
         insertCustom(VENDOR_ID, X_ANNIVERSARY, anniversary.toString(Qt::ISODate));
     } else {
         removeCustom(VENDOR_ID, X_ANNIVERSARY);
     }
 }
 
 QString Addressee::assistantsName() const
 {
     return custom(VENDOR_ID, X_ASSISTANTSNAME);
 }
 
 void Addressee::setAssistantsName(const QString &assistantsName)
 {
     if (!assistantsName.isEmpty()) {
         insertCustom(VENDOR_ID, X_ASSISTANTSNAME, assistantsName);
     } else {
         removeCustom(VENDOR_ID, X_ASSISTANTSNAME);
     }
 }
 
 QUrl Addressee::blogFeed() const
 {
     return QUrl(custom(VENDOR_ID, BLOGFEED));
 }
 
 void Addressee::setBlogFeed(const QUrl &blogFeed)
 {
     if (!blogFeed.isEmpty()) {
         insertCustom(VENDOR_ID, BLOGFEED, blogFeed.url());
     } else {
         removeCustom(VENDOR_ID, BLOGFEED);
     }
 }
 
 QString Addressee::managersName() const
 {
     return custom(VENDOR_ID, X_MANAGERSNAME);
 }
 
 void Addressee::setManagersName(const QString &managersName)
 {
     if (!managersName.isEmpty()) {
         insertCustom(VENDOR_ID, X_MANAGERSNAME, managersName);
     } else {
         removeCustom(VENDOR_ID, X_MANAGERSNAME);
     }
 }
 
 QString Addressee::office() const
 {
     return custom(VENDOR_ID, X_OFFICE);
 }
 
 void Addressee::setOffice(const QString &office)
 {
     if (!office.isEmpty()) {
         insertCustom(VENDOR_ID, X_OFFICE, office);
     } else {
         removeCustom(VENDOR_ID, X_OFFICE);
     }
 }
 
 QString Addressee::profession() const
 {
     return custom(VENDOR_ID, X_PROFESSION);
 }
 
 void Addressee::setProfession(const QString &profession)
 {
     if (!profession.isEmpty()) {
         insertCustom(VENDOR_ID, X_PROFESSION, profession);
     } else {
         removeCustom(VENDOR_ID, X_PROFESSION);
     }
 }
 
 QString Addressee::spousesName() const
 {
     return custom(VENDOR_ID, X_SPOUSESNAME);
 }
 
 void Addressee::setSpousesName(const QString &spousesName)
 {
     if (!spousesName.isEmpty()) {
         insertCustom(VENDOR_ID, X_SPOUSESNAME, spousesName);
     } else {
         removeCustom(VENDOR_ID, X_SPOUSESNAME);
     }
 }
 
 void Addressee::insertCustom(const QString &app, const QString &name, const QString &value)
 {
     if (value.isEmpty() || name.isEmpty() || app.isEmpty()) {
         return;
     }
 
     d->mEmpty = false;
 
     const QString qualifiedName = app + QLatin1Char('-') + name;
 
     auto it = d->findByName(qualifiedName);
     if (it != d->mCustomFields.end()) {
         it->value = value;
     } else {
         const CustomData newdata{qualifiedName, value};
         auto beforeIt = std::lower_bound(d->mCustomFields.begin(), d->mCustomFields.end(), newdata);
         d->mCustomFields.insert(beforeIt, newdata);
     }
 }
 
 void Addressee::removeCustom(const QString &app, const QString &name)
 {
     const QString qualifiedName = app + QLatin1Char('-') + name;
     auto it = d->findByName(qualifiedName);
     if (it != d->mCustomFields.end()) {
         d->mCustomFields.erase(it);
     }
 }
 
 QString Addressee::custom(const QString &app, const QString &name) const
 {
     const QString qualifiedName = app + QLatin1Char('-') + name;
     auto it = d->findByName(qualifiedName);
     return it != d->mCustomFields.cend() ? it->value : QString{};
 }
 
 void Addressee::setCustoms(const QStringList &customs)
 {
     d->mEmpty = false;
 
     d->mCustomFields.clear();
 
     // Less than 10 elements in "customs", we needn't use a set
     QStringList seen;
     for (const QString &custom : customs) {
         const int index = custom.indexOf(QLatin1Char(':'));
         if (index == -1) {
             continue;
         }
 
         const QString qualifiedName = custom.left(index);
         const QString value = custom.mid(index + 1);
 
         if (!seen.contains(qualifiedName)) {
             d->mCustomFields.push_back({qualifiedName, value});
             seen.push_back(qualifiedName);
         }
     }
     std::sort(d->mCustomFields.begin(), d->mCustomFields.end());
 }
 
 QStringList Addressee::customs() const
 {
     QStringList result;
     result.reserve(d->mCustomFields.size());
 
     static const QLatin1Char sep(':');
     for (const auto &[name, value] : d->mCustomFields) {
         result << name + sep + value;
     }
 
     return result;
 }
 
 void Addressee::parseEmailAddress(const QString &rawEmail, QString &fullName, QString &email)
 {
     // This is a simplified version of KPIM::splitAddress().
 
     fullName.clear();
     email.clear();
     if (rawEmail.isEmpty()) {
         return; // KPIM::AddressEmpty;
     }
 
     // The code works on 8-bit strings, so convert the input to UTF-8.
     QByteArray address = rawEmail.toUtf8();
 
     QByteArray displayName;
     QByteArray addrSpec;
     QByteArray comment;
 
     // The following is a primitive parser for a mailbox-list (cf. RFC 2822).
     // The purpose is to extract a displayable string from the mailboxes.
     // Comments in the addr-spec are not handled. No error checking is done.
 
     enum sourceLevel {
         TopLevel,
         InComment,
         InAngleAddress,
     };
     sourceLevel context = TopLevel;
     bool inQuotedString = false;
     int commentLevel = 0;
     bool stop = false;
 
     for (char *p = address.data(); *p && !stop; ++p) {
         switch (context) {
         case TopLevel:
             switch (*p) {
             case '"':
                 inQuotedString = !inQuotedString;
                 displayName += *p;
                 break;
             case '(':
                 if (!inQuotedString) {
                     context = InComment;
                     commentLevel = 1;
                 } else {
                     displayName += *p;
                 }
                 break;
             case '<':
                 if (!inQuotedString) {
                     context = InAngleAddress;
                 } else {
                     displayName += *p;
                 }
                 break;
             case '\\': // quoted character
                 displayName += *p;
                 ++p; // skip the '\'
                 if (*p) {
                     displayName += *p;
                 } else {
                     // return KPIM::UnexpectedEnd;
                     goto ABORT_PARSING;
                 }
                 break;
             case ',':
                 if (!inQuotedString) {
                     // if ( allowMultipleAddresses )
                     //  stop = true;
                     // else
                     //  return KPIM::UnexpectedComma;
                     goto ABORT_PARSING;
                 } else {
                     displayName += *p;
                 }
                 break;
             default:
                 displayName += *p;
             }
             break;
         case InComment:
             switch (*p) {
             case '(':
                 ++commentLevel;
                 comment += *p;
                 break;
             case ')':
                 --commentLevel;
                 if (commentLevel == 0) {
                     context = TopLevel;
                     comment += ' '; // separate the text of several comments
                 } else {
                     comment += *p;
                 }
                 break;
             case '\\': // quoted character
                 comment += *p;
                 ++p; // skip the '\'
                 if (*p) {
                     comment += *p;
                 } else {
                     // return KPIM::UnexpectedEnd;
                     goto ABORT_PARSING;
                 }
                 break;
             default:
                 comment += *p;
             }
             break;
         case InAngleAddress:
             switch (*p) {
             case '"':
                 inQuotedString = !inQuotedString;
                 addrSpec += *p;
                 break;
             case '>':
                 if (!inQuotedString) {
                     context = TopLevel;
                 } else {
                     addrSpec += *p;
                 }
                 break;
             case '\\': // quoted character
                 addrSpec += *p;
                 ++p; // skip the '\'
                 if (*p) {
                     addrSpec += *p;
                 } else {
                     // return KPIM::UnexpectedEnd;
                     goto ABORT_PARSING;
                 }
                 break;
             default:
                 addrSpec += *p;
             }
             break;
         } // switch ( context )
     }
 
 ABORT_PARSING:
     displayName = displayName.trimmed();
     comment = comment.trimmed();
     addrSpec = addrSpec.trimmed();
     fullName = QString::fromUtf8(displayName);
     email = QString::fromUtf8(addrSpec); // check for errors
     if (inQuotedString) {
         return; // KPIM::UnbalancedQuote;
     }
     if (context == InComment) {
         return; // KPIM::UnbalancedParens;
     }
     if (context == InAngleAddress) {
         return; // KPIM::UnclosedAngleAddr;
     }
 
     if (addrSpec.isEmpty()) {
         if (displayName.isEmpty()) {
             return; // KPIM::NoAddressSpec;
         } else {
             // addrSpec = displayName;
             // displayName.truncate( 0 );
             // Address of the form "foo@bar" or "foo@bar (Name)".
             email = fullName;
             fullName = QString::fromUtf8(comment);
         }
     }
 
     email = email.toLower();
 
     // Check that the full name is not enclosed in balanced double quotes.
     // If it is then remove them.
     const unsigned int len = fullName.length();
     if (len < 3) { // not long enough to be
         return;
     }
     if (fullName.startsWith(QLatin1Char('"')) && fullName.endsWith(QLatin1Char('"'))) {
         fullName = fullName.mid(1, len - 2);
     }
 }
 
 void Addressee::setChanged(bool value)
 {
     d->mChanged = value;
 }
 
 bool Addressee::changed() const
 {
     return d->mChanged;
 }
 
 QString Addressee::mimeType()
 {
     return QStringLiteral("text/directory");
 }
 
 QDataStream &KContacts::operator<<(QDataStream &s, const Addressee &a)
 {
     s << a.d->mUid;
 
     s << a.d->mName;
     s << a.d->mFormattedName;
     s << a.d->mFamilyName;
     s << a.d->mGivenName;
     s << a.d->mAdditionalName;
     s << a.d->mPrefix;
     s << a.d->mSuffix;
     s << a.d->mBirthday;
     s << a.d->mBirthdayWithTime;
     s << a.d->mMailer;
     s << a.d->mTimeZone;
     s << a.d->mGeo;
     s << a.d->mDepartment;
     s << a.d->mNote;
     s << a.d->mProductId;
     s << a.d->mRevision;
     s << a.d->mSortString;
     s << a.d->mSecrecy;
     s << a.d->mLogo;
     s << a.d->mPhoto;
     s << a.d->mSound;
     s << a.d->mPhoneNumbers;
     s << a.d->mAddresses;
     s << a.d->mEmails;
     s << a.d->mCategories;
     s << a.customs();
     s << a.d->mKeys;
     s << a.d->mLangs;
     s << a.d->mGender;
     s << a.d->mKind;
     s << a.d->mCalendarUrl;
     s << a.d->mSoundListExtra;
     s << a.d->mPhotoExtraList;
     s << a.d->mLogoExtraList;
     s << a.d->mUrlExtraList;
     s << a.d->mMembers;
     s << a.d->mRelationships;
     s << a.d->mSources;
     s << a.d->mImpps;
     s << a.d->mFieldGroupList;
     s << a.d->mTitleExtraList;
     s << a.d->mRoleExtraList;
     s << a.d->mOrgExtraList;
     s << a.d->mNickNameExtraList;
     s << a.d->mClientPidMapList;
 
     return s;
 }
 
 QDataStream &KContacts::operator>>(QDataStream &s, Addressee &a)
 {
     s >> a.d->mUid;
 
     s >> a.d->mName;
     s >> a.d->mFormattedName;
     s >> a.d->mFamilyName;
     s >> a.d->mGivenName;
     s >> a.d->mAdditionalName;
     s >> a.d->mPrefix;
     s >> a.d->mSuffix;
     s >> a.d->mBirthday;
     s >> a.d->mBirthdayWithTime;
     s >> a.d->mMailer;
     s >> a.d->mTimeZone;
     s >> a.d->mGeo;
     s >> a.d->mDepartment;
     s >> a.d->mNote;
     s >> a.d->mProductId;
     s >> a.d->mRevision;
     s >> a.d->mSortString;
     s >> a.d->mSecrecy;
     s >> a.d->mLogo;
     s >> a.d->mPhoto;
     s >> a.d->mSound;
     s >> a.d->mPhoneNumbers;
     s >> a.d->mAddresses;
     s >> a.d->mEmails;
     s >> a.d->mCategories;
     QStringList customFields;
     s >> customFields;
     a.setCustoms(customFields);
     s >> a.d->mKeys;
     s >> a.d->mLangs;
     s >> a.d->mGender;
     s >> a.d->mKind;
     s >> a.d->mCalendarUrl;
     s >> a.d->mSoundListExtra;
     s >> a.d->mPhotoExtraList;
     s >> a.d->mLogoExtraList;
     s >> a.d->mUrlExtraList;
     s >> a.d->mMembers;
     s >> a.d->mRelationships;
     s >> a.d->mSources;
     s >> a.d->mImpps;
     s >> a.d->mFieldGroupList;
     s >> a.d->mTitleExtraList;
     s >> a.d->mRoleExtraList;
     s >> a.d->mOrgExtraList;
     s >> a.d->mNickNameExtraList;
     s >> a.d->mClientPidMapList;
     a.d->mEmpty = false;
 
     return s;
 }
 
 bool matchBinaryPattern(int value, int pattern)
 {
     /**
       We want to match all telephonnumbers/addresses which have the bits in the
       pattern set. More are allowed.
       if pattern == 0 we have a special handling, then we want only those with
       exactly no bit set.
      */
     if (pattern == 0) {
         return value == 0;
     } else {
         return pattern == (pattern & value);
     }
 }
 
 template<class L>
 bool listEquals(const QList<L> &list, const QList<L> &pattern)
 {
     if (list.count() != pattern.count()) {
         return false;
     }
     const int numberOfElement(list.count());
     for (int i = 0; i < numberOfElement; ++i) {
         if (!pattern.contains(list[i])) {
             return false;
         }
     }
 
     return true;
 }
 
 bool listEquals(const QStringList &list, const QStringList &pattern)
 {
     if (list.count() != pattern.count()) {
         return false;
     }
 
     const int numberOfElement(list.count());
     for (int i = 0; i < numberOfElement; ++i) {
         if (!pattern.contains(list[i])) {
             return false;
         }
     }
 
     return true;
 }
 
 void Addressee::setBirthdayProperty(const QDateTime &birthday) {
     // The property setter cannot pass withTime, so we have to guess.
     setBirthday(birthday, birthday.time().msecsSinceStartOfDay() != 0);
 }
 
 #include "moc_addressee.cpp"