Converts “normal“ passwords to application passwords. More...

#include <Fuoten/API/ConvertToAppPassword>

Inheritance diagram for Fuoten::ConvertToAppPassword:

Public Member Functions
	ConvertToAppPassword (QObject *parent=nullptr)
	Contructs a new ConvertToAppPassword object with the given parent.
	~ConvertToAppPassword () override
	Destroys the ConvertToAppPassword object.
Q_INVOKABLE void	execute () override
	Executes the API request.
Public Member Functions inherited from Fuoten::Component
	Component (QObject *parent=nullptr)
	Constructs a component with the given parent.
	~Component () override
	Destroys the Component object.
AbstractConfiguration *	configuration () const
	Returns a pointer to the AbstractConfiguration that is currently set.
Error *	error () const
	Returns a pointer to an Error object, if any error occurred.
bool	inOperation () const
	Returns true while the API request is running.
bool	isUseStorageEnabled () const
	Getter function for the useStorage property.
AbstractNotificator *	notificator () const
	Getter function for the notificator property.
quint16	requestTimeout () const
	Returns the currently set request timeout.
void	setConfiguration (AbstractConfiguration *nAbstractConfiguration)
	Sets a pointer to a AbstractConfiguration to use for the API request.
void	setNotificator (AbstractNotificator *notificator)
	Setter function for the notificator property.
void	setRequestTimeout (quint16 seconds)
	Sets the timeout for the API request in seconds.
void	setStorage (AbstractStorage *localStorage)
	Setter function for the storage property.
void	setUseStorage (bool useStorage)
	Setter function for the useStorage property.
void	setWipeManager (WipeManager *wipeManager)
	Setter function for the wipeManager property.
AbstractStorage *	storage () const
	Getter function for the storage property.
WipeManager *	wipeManager () const
	Getter function for the wipeManager property.

Protected Member Functions
void	extractError (QNetworkReply *reply) override
	Extracts the error data from the API response.
void	successCallback () override
	Extracts the newly generated application password from the API response.
Protected Member Functions inherited from Fuoten::Component
void	addRequestHeader (const QByteArray &headerName, const QByteArray &headerValue)
	Adds a header to the HTTP request.
void	addRequestHeaders (const QHash< QByteArray, QByteArray > &headers)
	Adds headers to the HTTP request.
virtual bool	checkInput ()
	Performs basic input checks.
virtual bool	checkOutput ()
	Performs basic output checks.
QJsonDocument	jsonResult () const
	Returns the JSON result document.
void	notify (AbstractNotificator::Type type, QtMsgType severity, const QVariant &data) const
	Checks if a notificator has been set and will use it to notify the user.
void	notify (const Error *e) const
	Checks if a notificator has been set and will use it to notify about an occured error.
QHash< QByteArray, QByteArray >	requestHeaders () const
	Returns the currently set HTTP headers for the request.
void	sendRequest ()
	Sends the request to the server.
void	setApiRoute (const QString &route)
	Sets the API route.
void	setApiRoute (const QStringList &routeParts)
	Sets the API route constructed from a route part list.
void	setError (Error *nError)
	Sets the pointer of the error property.
void	setExpectedJSONType (ExpectedJSONType type)
	Sets the expected JSON type for initial output check.
void	setInOperation (bool nInOperation)
	Sets the value of the inOperation property.
void	setNetworkOperation (QNetworkAccessManager::Operation operation)
	Sets the operation the network manager should perform for this call.
void	setPayload (const QByteArray &payload)
	Sets the payload for the request.
void	setPayload (const QJsonObject &payload)
	Sets the payload for the request.
void	setRequestHeaders (const QHash< QByteArray, QByteArray > &headers)
	Sets the headers to use for the HTTP request.
void	setRequiresAuth (bool reqAuth)
	Set this to true if the request requires authentication.
void	setUrlQuery (const QUrlQuery &query)
	Sets the URL query for the request.

Additional Inherited Members
Public Types inherited from Fuoten::Component
enum	ExpectedJSONType : quint8 { Empty = 0 , Array = 1 , Object = 2 }
	Defines the expected JSON type. More...
Properties inherited from Fuoten::Component
Fuoten::AbstractConfiguration *	configuration
	Pointer to an AbstractConfiguration derived object.
Fuoten::Error *	error
	Pointer to an error object, if any error occurred.
bool	inOperation
	Returns true while the request is in operation.
Fuoten::AbstractNotificator *	notificator
	Pointer to an object derived from AbstractNotificator.
quint16	requestTimeout
	Timeout in seconds for network requests.
Fuoten::AbstractStorage *	storage
	Pointer to an AbstractStorage derived object.
bool	useStorage
	If `true` (the default), a local storage should be used in the successCallback() function to further process the request results.
Fuoten::WipeManager *	wipeManager
	Pointer to a WipeManager to handle remote wipe requests.
Signals inherited from Fuoten::Component
void	configurationChanged (Fuoten::AbstractConfiguration *configuration)
	This signal is emitted when the pointer to the AbstractConfiguration object changes.
void	errorChanged (Fuoten::Error *error)
	This signal is emitted when the pointer to the Error object changes. error will be a nullptr if no error occurred or the current error has been reset.
void	failed (Fuoten::Error *error)
	Emit this signal in a subclass when the request failed for some reason.
void	inOperationChanged (bool inOperation)
	This signal is emitted when the in operation status changes.
void	notificatorChanged (Fuoten::AbstractNotificator *notificator)
	Notifier signal for the notificator property.
void	requestTimeoutChanged (quint16 requestTimeout)
	This signal is emitte when the timeout for the request changes.
void	sslErrors (QNetworkReply *reply, const QList< QSslError > &errors)
	This signal is emitted if the SSL/TLS session encountered errors during the set up.
void	storageChanged (Fuoten::AbstractStorage *storage)
	Notifier signal for the storage property.
void	succeeded (const QJsonDocument &result)
	Emit this signal in a subclass when the request was successful.
void	useStorageChanged (bool useStorage)
	Notifier signal for the useStorage property.
void	wipeManagerChanged (Fuoten::WipeManager *wipeManager)
	Notifier signal for the wipeManager property.
Static Public Member Functions inherited from Fuoten::Component
static AbstractConfiguration *	defaultConfiguration ()
	Returns the global default configuration.
static QNetworkAccessManager *	defaultNam ()
	Returns the global network access manager.
static AbstractNotificator *	defaultNotificator ()
	Returns the global default notificator.
static AbstractStorage *	defaultStorage ()
	Returns the global default storage.
static WipeManager *	defaultWipeManager ()
	Returns the global default wipe manager.
static AbstractNamFactory *	networkAccessManagerFactory ()
	Returns the currently set network access manager factory.
static void	setDefaultConfiguration (AbstractConfiguration *config)
	Sets the global default configuration.
static void	setDefaultNam (QNetworkAccessManager *nam)
	Sets the global default network access manager.
static void	setDefaultNotificator (AbstractNotificator *notificator)
	Sets the global default notificator.
static void	setDefaultStorage (AbstractStorage *storage)
	Sets the global default storage.
static void	setDefaultWipeManager (WipeManager *wipeManager)
	Sets the global default wipe manager.
static void	setNetworkAccessManagerFactory (AbstractNamFactory *factory)
	Sets the network access manager factory. The factory will be used to create QNetworkAccessManager objects on demand. If no factory is set, a default QNetworkAccessManager object will be created. The Component class will take ownership of the created QNetworkAccessManager.

Detailed Description

Converts “normal“ passwords to application passwords.

Nextcloud’s OCS API supports the automatic upgrade from “normal“ passwords to application specific passwords. This class implements this API call. Running execute() will send a GET request to the /ocs/v2.php/core/getapppassword API endpoint with the currently configured username and password for authorization.

If a 403 HTTP status is returned, the current password is already an application password and Component::succeeded() will be emitted containing an empty QJsonDocument.

If a 200 HTTP status code is returned, the used password was not an application password and the response contains a newly generated application password that will be set to AbstractConfiguration::setPassword(). Also the Component::succeeded() signal will be emitted containing the returned JSON data.

If an error occured or the returned HTTP status is neither 200 or 403, Component::failed() will be emitted and Comonent::error() will contain information about the occured Error.

Note: This API call will use AbstractConfiguration::getLoginFlowUserAgent() to set the User-Agent header of the request to generate a user friendly application name user agent that will be shown in the configuration backend of the Nextcloud.

Since: 0.8.0

Mandatory properties: Component::configuration

API route: Not part of the News App API, uses general Nextcloud OCS API at /ocs/v2.php/core/getapppassword

Method: GET

Constructor & Destructor Documentation

◆ ConvertToAppPassword()

ConvertToAppPassword::ConvertToAppPassword ( QObject * parent = nullptr )

explicit

Contructs a new ConvertToAppPassword object with the given parent.

◆ ~ConvertToAppPassword()

ConvertToAppPassword::~ConvertToAppPassword ( )

override

Destroys the ConvertToAppPassword object.

Member Function Documentation

◆ execute()

void ConvertToAppPassword::execute ( )

overridevirtual

Executes the API request.

Implements Fuoten::Component.

◆ extractError()

void ConvertToAppPassword::extractError ( QNetworkReply * reply )

overrideprotectedvirtual

Extracts the error data from the API response.

If the API responded with a 403 HTTP status code, the used password is already an application password and all is fine and Component::succeeded() will be emitted with an empty QJsonDocument.

For all other errors Component::failed() will be emitted and Component::error() will contain the Error information.

Reimplemented from Fuoten::Component.

◆ successCallback()

void ConvertToAppPassword::successCallback ( )

overrideprotectedvirtual

Extracts the newly generated application password from the API response.

If the response contains a non-empty application password, it will be set to AbstractConfiguration::setPassword() and Component::succeeded() will be emitted, otherwise the error data from the response will be extracted and Component::failed() will be emitted while Component::error() will contain the Error information.

Implements Fuoten::Component.

The documentation for this class was generated from the following files:

Fuoten/API/converttoapppassword.h
Fuoten/API/converttoapppassword.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members