quickshell/src/services/polkit/flow.hpp

#pragma once

#include <qobject.h>
#include <qproperty.h>
#include <qqmlintegration.h>

#include "../../core/retainable.hpp"
#include "identity.hpp"
#include "listener.hpp"

namespace qs::service::polkit {
class Session;

class AuthFlow
    : public QObject
    , public Retainable {
	Q_OBJECT;
	QML_ELEMENT;
	Q_DISABLE_COPY_MOVE(AuthFlow);
	QML_UNCREATABLE("AuthFlow can only be obtained from PolkitAgent.");

	// clang-format off
	/// The main message to present to the user.
	Q_PROPERTY(QString message READ message CONSTANT);

	/// The icon to present to the user in association with the message.
	///
	/// The icon name follows the [FreeDesktop icon naming specification](https://specifications.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html).
	/// Use @@Quickshell.Quickshell.iconPath() to resolve the icon name to an
	/// actual file path for display.
	Q_PROPERTY(QString iconName READ iconName CONSTANT);

	/// The action ID represents the action that is being authorized.
	///
	/// This is a machine-readable identifier.
	Q_PROPERTY(QString actionId READ actionId CONSTANT);

	/// A cookie that identifies this authentication request.
	///
	/// This is an internal identifier and not recommended to show to users.
	Q_PROPERTY(QString cookie READ cookie CONSTANT);

	/// The list of identities that may be used to authenticate.
	///
	/// Each identity may be a user or a group. You may select any of them to
	/// authenticate by setting @@selectedIdentity. By default, the first identity
	/// in the list is selected.
	Q_PROPERTY(QList<qs::service::polkit::Identity*> identities READ identities CONSTANT);

	/// The identity that will be used to authenticate.
	///
	/// Changing this will abort any ongoing authentication conversations and start a new one.
	Q_PROPERTY(qs::service::polkit::Identity* selectedIdentity READ default WRITE setSelectedIdentity NOTIFY selectedIdentityChanged BINDABLE selectedIdentity);

	/// Indicates that a response from the user is required from the user,
	/// typically a password.
	Q_PROPERTY(bool isResponseRequired READ default NOTIFY isResponseRequiredChanged BINDABLE isResponseRequired);

	/// This message is used to prompt the user for required input.
	Q_PROPERTY(QString inputPrompt READ default NOTIFY inputPromptChanged BINDABLE inputPrompt);

	/// Indicates whether the user's response should be visible. (e.g. for passwords this should be false)
	Q_PROPERTY(bool responseVisible READ default NOTIFY responseVisibleChanged BINDABLE responseVisible);

	/// An additional message to present to the user.
	///
	/// This may be used to show errors or supplementary information.
	/// See @@supplementaryIsError to determine if this is an error message.
	Q_PROPERTY(QString supplementaryMessage READ default NOTIFY supplementaryMessageChanged BINDABLE supplementaryMessage);

	/// Indicates whether the supplementary message is an error.
	Q_PROPERTY(bool supplementaryIsError READ default NOTIFY supplementaryIsErrorChanged BINDABLE supplementaryIsError);

	/// Has the authentication request been completed.
	Q_PROPERTY(bool isCompleted READ default NOTIFY isCompletedChanged BINDABLE isCompleted);

	/// Indicates whether the authentication request was successful.
	Q_PROPERTY(bool isSuccessful READ default NOTIFY isSuccessfulChanged BINDABLE isSuccessful);

	/// Indicates whether the current authentication request was cancelled.
	Q_PROPERTY(bool isCancelled READ default NOTIFY isCancelledChanged BINDABLE isCancelled);

	/// Indicates whether an authentication attempt has failed at least once during this authentication flow.
	Q_PROPERTY(bool failed READ default NOTIFY failedChanged BINDABLE failed);
	// clang-format on

public:
	explicit AuthFlow(AuthRequest* request, QList<Identity*>&& identities, QObject* parent = nullptr);
	~AuthFlow() override;

	/// Cancel the ongoing authentication request from the agent side.
	void cancelFromAgent();

	/// Submit a response to a request that was previously emitted. Typically the password.
	Q_INVOKABLE void submit(const QString& value);
	/// Cancel the ongoing authentication request from the user side.
	Q_INVOKABLE void cancelAuthenticationRequest();

	[[nodiscard]] const QString& message() const { return this->mRequest->message; };
	[[nodiscard]] const QString& iconName() const { return this->mRequest->iconName; };
	[[nodiscard]] const QString& actionId() const { return this->mRequest->actionId; };
	[[nodiscard]] const QString& cookie() const { return this->mRequest->cookie; };
	[[nodiscard]] const QList<Identity*>& identities() const { return this->mIdentities; };

	[[nodiscard]] QBindable<Identity*> selectedIdentity() { return &this->bSelectedIdentity; };
	void setSelectedIdentity(Identity* identity);

	[[nodiscard]] QBindable<bool> isResponseRequired() { return &this->bIsResponseRequired; };
	[[nodiscard]] QBindable<QString> inputPrompt() { return &this->bInputPrompt; };
	[[nodiscard]] QBindable<bool> responseVisible() { return &this->bResponseVisible; };

	[[nodiscard]] QBindable<QString> supplementaryMessage() { return &this->bSupplementaryMessage; };
	[[nodiscard]] QBindable<bool> supplementaryIsError() { return &this->bSupplementaryIsError; };

	[[nodiscard]] QBindable<bool> isCompleted() { return &this->bIsCompleted; };
	[[nodiscard]] QBindable<bool> isSuccessful() { return &this->bIsSuccessful; };
	[[nodiscard]] QBindable<bool> isCancelled() { return &this->bIsCancelled; };
	[[nodiscard]] QBindable<bool> failed() { return &this->bFailed; };

	[[nodiscard]] AuthRequest* authRequest() const { return this->mRequest; };

signals:
	/// Emitted whenever an authentication request completes successfully.
	void authenticationSucceeded();

	/// Emitted whenever an authentication request completes unsuccessfully.
	///
	/// This may be because the user entered the wrong password or otherwise
	/// failed to authenticate.
	/// This signal is not emitted when the user canceled the request or it
	/// was cancelled by the PolKit daemon.
	///
	/// After this signal, a new session is automatically started for the same
	/// identity.
	void authenticationFailed();

	/// Emitted when an ongoing authentication request is cancelled by the PolKit daemon.
	void authenticationRequestCancelled();

	void selectedIdentityChanged();
	void isResponseRequiredChanged();
	void inputPromptChanged();
	void responseVisibleChanged();
	void supplementaryMessageChanged();
	void supplementaryIsErrorChanged();
	void isCompletedChanged();
	void isSuccessfulChanged();
	void isCancelledChanged();
	void failedChanged();

private slots:
	// Signals received from session objects.
	void request(const QString& message, bool echo);
	void completed(bool gainedAuthorization);
	void showError(const QString& message);
	void showInfo(const QString& message);

private:
	/// Start a session for the currently selected identity and the current request.
	void setupSession();

	Session* currentSession = nullptr;
	AuthRequest* mRequest = nullptr;
	QList<Identity*> mIdentities;

	// clang-format off
	Q_OBJECT_BINDABLE_PROPERTY(AuthFlow, Identity*, bSelectedIdentity, &AuthFlow::selectedIdentityChanged);
	Q_OBJECT_BINDABLE_PROPERTY(AuthFlow, bool, bIsResponseRequired, &AuthFlow::isResponseRequiredChanged);
	Q_OBJECT_BINDABLE_PROPERTY(AuthFlow, QString, bInputPrompt, &AuthFlow::inputPromptChanged);
	Q_OBJECT_BINDABLE_PROPERTY(AuthFlow, bool, bResponseVisible, &AuthFlow::responseVisibleChanged);
	Q_OBJECT_BINDABLE_PROPERTY(AuthFlow, QString, bSupplementaryMessage, &AuthFlow::supplementaryMessageChanged);
	Q_OBJECT_BINDABLE_PROPERTY(AuthFlow, bool, bSupplementaryIsError, &AuthFlow::supplementaryIsErrorChanged);
	Q_OBJECT_BINDABLE_PROPERTY(AuthFlow, bool, bIsCompleted, &AuthFlow::isCompletedChanged);
	Q_OBJECT_BINDABLE_PROPERTY(AuthFlow, bool, bIsSuccessful, &AuthFlow::isSuccessfulChanged);
	Q_OBJECT_BINDABLE_PROPERTY(AuthFlow, bool, bIsCancelled, &AuthFlow::isCancelledChanged);
	Q_OBJECT_BINDABLE_PROPERTY(AuthFlow, bool, bFailed, &AuthFlow::failedChanged);
	// clang-format on
};
} // namespace qs::service::polkit