File indexing completed on 2024-04-21 04:43:22

 /*
     This file is part of the Polkit-qt project
     SPDX-FileCopyrightText: 2009 Jaroslav Reznik <jreznik@redhat.com>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef POLKITQT1_AGENT_LISTENER_H
 #define POLKITQT1_AGENT_LISTENER_H
 
 #include <QObject>
 #include <QScopedPointer>
 
 #include "polkitqt1-agent-session.h"
 
 #define POLKIT_AGENT_I_KNOW_API_IS_SUBJECT_TO_CHANGE 1
 
 typedef struct _PolkitAgentListener PolkitAgentListener;
 
 namespace PolkitQt1
 {
 class Subject;
 class Identity;
 class Details;
 }
 
 namespace PolkitQt1
 {
 
 namespace Agent
 {
 
 class ListenerPrivate;
 /**
  * \class Listener polkitqt1-agent-listener.h Listener
  * \author Jaroslav Reznik <jreznik@redhat.com>
  *
  * \brief Listener is abstract class used for implementing authentication agents.
  *
  * To implement an authentication agent, just subclass this class and implement
  * virtual functions initiateAuthentication, initiateAuthenticationFinish
  * and cancelAuthentication.
  *
  * You can also use Session class to authenticate users however it isn't required.
  * \sa Session
  */
 class POLKITQT1_AGENT_EXPORT Listener : public QObject
 {
     Q_OBJECT
     Q_DISABLE_COPY(Listener)
 public:
     /**
      * \brief Constructor of Listener class
      */
     Listener(QObject *parent = nullptr);
 
     /**
      * \brief Constructor of Listener class from PolkitAgentListener
      *
      * \warning Use this only if you are completely aware of what are you doing!
      *
      * \param listener Pointer to the PolkitAgentListener
      * \param parent
      */
     explicit Listener(PolkitAgentListener *listener, QObject *parent = nullptr);
 
     ~Listener() override;
 
     /**
      * \brief Registers listener with polkit daemon as an authentication agent for \p subject.
      *
      * This is implemented by registering a DBus object at \p objectPath on the unique
      * name assigned by the system message bus.
      *
      * Whenever the polkit daemon needs to authenticate a processes that is related to \p subject,
      * the methods initiateAuthentication and initiateAuthenticationFinish will be evoked.
      *
      * \param subject Subject that listener will be registered for
      * \param objectPath DBus object path
      * \return \c True if the polkitqt1-agent-listener.has been registered, \c False otherwise
      */
     bool registerListener(const PolkitQt1::Subject &subject, const QString &objectPath);
 
     /**
      * \brief Returns pointer to the PolkitAgentListener.
      *
      * \warning Use this only if you are completely aware of what are you doing!
      *
      * \return PolkitAgentListener
      */
     const PolkitAgentListener *listener();
 
 public Q_SLOTS:
     /**
      * \brief Initiate authentication for the action
      *
      * This method will be called on a registered authentication agent when the user owning
      * the session needs to prove he is one of the identities listed in \p identities.
      *
      * \note You have to reimplement this method in the subclass.
      *
      * \param actionId The action to authenticate for
      * \param message The message to present to the user
      * \param iconName The name of the icon which is representing the action
      * \param details Details describing the action
      * \param cookie The cookie for the authentization request
      * \param identities A list of Identity object that the user can choose to authenticate as
      * \param result This AsyncResult MUST be completed by using complete() method when the
      *        authentication is done. You can pass it to the constructor of the Session class
      *        and then call session->result()->complete() to mark the action as done.
      */
     virtual void initiateAuthentication(const QString &actionId,
                                         const QString &message,
                                         const QString &iconName,
                                         const PolkitQt1::Details &details,
                                         const QString &cookie,
                                         const PolkitQt1::Identity::List &identities,
                                         PolkitQt1::Agent::AsyncResult *result) = 0;
 
     /**
      * TODO: Is this method really required ?
      * \brief Finishes an authentication request from the polkit daemon.
      *
      * \note You have to reimplement this method in the subclass.
      *
      * \see initiateAuthentication
      */
     virtual bool initiateAuthenticationFinish() = 0;
 
     /**
      * TODO: Is this method really required ?
      * \brief Cancels an authentication request from the polkit daemon.
      *
      * \note You have to reimplement this method in the subclass.
      *
      * \see initiateAuthentication
      */
     virtual void cancelAuthentication() = 0;
 
 private:
     QScopedPointer<ListenerPrivate> d;
 };
 }
 
 }
 
 #endif