linphone-desktop/Linphone/core/friend/FriendCore.hpp

/*
 * Copyright (c) 2010-2024 Belledonne Communications SARL.
 *
 * This file is part of linphone-desktop
 * (see https://www.linphone.org).
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef FRIEND_CORE_H_
#define FRIEND_CORE_H_

// #include "FriendAddressList.hpp"
#include "core/variant/VariantList.hpp"
#include "model/friend/FriendModel.hpp"
#include "tool/LinphoneEnums.hpp"
#include "tool/thread/SafeConnection.hpp"
#include "tool/thread/SafeSharedPointer.hpp"
#include <linphone++/linphone.hh>

#include <QDateTime>
#include <QMap>
#include <QObject>
#include <QSharedPointer>

// This object is defferent from usual Core. It set internal data from directly from GUI.
// Values are saved on request.
// This allow revert feature.

class CoreModel;
class FriendCore;

class FriendCore : public QObject, public AbstractObject {
	Q_OBJECT

	Q_PROPERTY(QList<QVariant> allAddresses READ getAllAddresses NOTIFY allAddressesChanged)
	Q_PROPERTY(QList<QVariant> phoneNumbers READ getPhoneNumbers NOTIFY phoneNumberChanged)
	Q_PROPERTY(QList<QVariant> addresses READ getAddresses NOTIFY addressChanged)
	Q_PROPERTY(QString givenName READ getGivenName WRITE setGivenName NOTIFY givenNameChanged)
	Q_PROPERTY(QString familyName READ getFamilyName WRITE setFamilyName NOTIFY familyNameChanged)
	Q_PROPERTY(QString displayName READ getDisplayName NOTIFY displayNameChanged)
	Q_PROPERTY(QString organization READ getOrganization WRITE setOrganization NOTIFY organizationChanged)
	Q_PROPERTY(QString job READ getJob WRITE setJob NOTIFY jobChanged)
	Q_PROPERTY(QString defaultAddress READ getDefaultAddress WRITE setDefaultAddress NOTIFY defaultAddressChanged)
	Q_PROPERTY(QDateTime presenceTimestamp READ getPresenceTimestamp NOTIFY presenceTimestampChanged)
	Q_PROPERTY(LinphoneEnums::ConsolidatedPresence consolidatedPresence READ getConsolidatedPresence NOTIFY
	               consolidatedPresenceChanged)
	Q_PROPERTY(bool isSaved READ getIsSaved NOTIFY isSavedChanged)
	Q_PROPERTY(QString pictureUri READ getPictureUri WRITE setPictureUri NOTIFY pictureUriChanged)
	Q_PROPERTY(bool starred READ getStarred WRITE lSetStarred NOTIFY starredChanged)

public:
	// Should be call from model Thread. Will be automatically in App thread after initialization
	static QSharedPointer<FriendCore> create(const std::shared_ptr<linphone::Friend> &contact);
	FriendCore(const std::shared_ptr<linphone::Friend> &contact);
	FriendCore(const FriendCore &friendCore);
	~FriendCore();
	void setSelf(QSharedPointer<FriendCore> me);
	void setSelf(SafeSharedPointer<FriendCore> me);
	void reset(const FriendCore &contact);

	QString getDisplayName() const;

	QString getFamilyName() const;
	void setFamilyName(const QString &name);

	QString getGivenName() const;
	void setGivenName(const QString &name);

	QString getOrganization() const;
	void setOrganization(const QString &name);

	QString getJob() const;
	void setJob(const QString &name);

	bool getStarred() const;
	void onStarredChanged(bool starred);

	QList<QVariant> getPhoneNumbers() const;
	QVariant getPhoneNumberAt(int index) const;
	Q_INVOKABLE void appendPhoneNumber(const QString &label, const QString &number);
	Q_INVOKABLE void removePhoneNumber(int index);
	Q_INVOKABLE void setPhoneNumberAt(int index, const QString &label, const QString &phoneNumber);

	QList<QVariant> getAddresses() const;
	QVariant getAddressAt(int index) const;
	Q_INVOKABLE void appendAddress(const QString &addr);
	Q_INVOKABLE void removeAddress(int index);
	Q_INVOKABLE void setAddressAt(int index, const QString &label, const QString &address);

	void setDefaultAddress(const QString &address);
	QString getDefaultAddress() const;

	QList<QVariant> getAllAddresses() const;

	LinphoneEnums::ConsolidatedPresence getConsolidatedPresence() const;
	void setConsolidatedPresence(LinphoneEnums::ConsolidatedPresence presence);

	QDateTime getPresenceTimestamp() const;
	void setPresenceTimestamp(QDateTime presenceTimestamp);

	bool getIsSaved() const;
	void setIsSaved(bool isSaved);

	QString getPictureUri() const;
	void setPictureUri(const QString &uri);
	void onPictureUriChanged(QString uri);

	void onPresenceReceived(LinphoneEnums::ConsolidatedPresence consolidatedPresence, QDateTime presenceTimestamp);

	Q_INVOKABLE void remove();
	Q_INVOKABLE void save();
	Q_INVOKABLE void undo();

protected:
	void resetPhoneNumbers(QList<QVariant> newList);
	void resetAddresses(QList<QVariant> newList);

signals:
	void contactUpdated();
	void displayNameChanged();
	void givenNameChanged(const QString &name);
	void familyNameChanged(const QString &name);
	void starredChanged();
	void phoneNumberChanged();
	void addressChanged();
	void organizationChanged();
	void jobChanged();
	void consolidatedPresenceChanged(LinphoneEnums::ConsolidatedPresence level);
	void presenceTimestampChanged(QDateTime presenceTimestamp);
	void pictureUriChanged();
	void saved();
	void isSavedChanged(bool isSaved);
	void removed(FriendCore *contact);
	void defaultAddressChanged();
	void allAddressesChanged();

	void lSetStarred(bool starred);

protected:
	void writeIntoModel(std::shared_ptr<FriendModel> model) const;
	void writeFromModel(const std::shared_ptr<FriendModel> &model);

	LinphoneEnums::ConsolidatedPresence mConsolidatedPresence = LinphoneEnums::ConsolidatedPresence::Offline;
	QDateTime mPresenceTimestamp;
	QString mGivenName;
	QString mFamilyName;
	QString mOrganization;
	QString mJob;
	bool mStarred;
	QList<QVariant> mPhoneNumberList;
	QList<QVariant> mAddressList;
	QString mDefaultAddress;
	QString mPictureUri;
	bool mIsSaved;
	std::shared_ptr<FriendModel> mFriendModel;
	QSharedPointer<SafeConnection<FriendCore, FriendModel>> mFriendModelConnection;
	QSharedPointer<SafeConnection<FriendCore, CoreModel>> mCoreModelConnection;

	DECLARE_ABSTRACT_OBJECT
};

Q_DECLARE_METATYPE(FriendCore *)
#endif