// -*- c++ -*-
/*
    This file is part of the KDE libraries
    SPDX-FileCopyrightText: 2002 Jan-Pascal van Best <janpascal@vanbest.org>

    SPDX-License-Identifier: LGPL-2.0-or-later
*/

#ifndef KIO_DAVJOB_H
#define KIO_DAVJOB_H

#include "global.h"
#include "kiocore_export.h"
#include "transferjob.h"

#include <QObject>
#include <QPointer>
#include <QString>
#include <QStringList>

#include <sys/stat.h>
#include <sys/types.h>

namespace KIO
{

class DavJobPrivate;
/*!
 * \class KIO::DavJob
 * \inheaderfile KIO/DavJob
 * \inmodule KIOCore
 *
 * The transfer job pumps data into and/or out of a KIO worker.
 * Data is sent to the worker on request of the worker ( dataReq).
 * If data coming from the worker can not be handled, the
 * reading of data from the worker should be suspended.
 * \sa KIO::davPropFind()
 * \sa KIO::davPropPatch()
 * \sa KIO::davSearch()
 */
class KIOCORE_EXPORT DavJob : public TransferJob
{
    Q_OBJECT
public:
    /*!
     * Returns the response data.
     * \since 5.86
     */
    QByteArray responseData() const;

protected Q_SLOTS:
    void slotFinished() override;
    void slotData(const QByteArray &data) override;

protected:
    KIOCORE_NO_EXPORT DavJob(DavJobPrivate &dd, int, const QString &);

private:
    Q_DECLARE_PRIVATE(DavJob)
};

/*!
 * \relates KIO::DavJob
 *
 * Creates a new DavJob that issues a PROPFIND command. PROPFIND retrieves
 * the properties of the resource identified by the given \a url.
 *
 * \a url the URL of the resource
 *
 * \a properties a propfind document that describes the properties that
 *        should be retrieved
 *
 * \a depth the depth of the request. Can be "0", "1" or "infinity"
 *
 * \a flags We support HideProgressInfo here
 *
 * Returns the new DavJob
 * \since 5.84
 */
KIOCORE_EXPORT DavJob *davPropFind(const QUrl &url, const QString &properties, const QString &depth, JobFlags flags = DefaultFlags);

/*!
 * \relates KIO::DavJob
 *
 * Creates a new DavJob that issues a PROPPATCH command. PROPPATCH sets
 * the properties of the resource identified by the given \a url.
 *
 * \a url the URL of the resource
 *
 * \a properties a PROPPACTCH document that describes the properties that
 *        should be modified and its new values
 *
 * \a flags We support HideProgressInfo here
 *
 * Returns the new DavJob
 * \since 5.84
 */
KIOCORE_EXPORT DavJob *davPropPatch(const QUrl &url, const QString &properties, JobFlags flags = DefaultFlags);

/*!
 * \relates KIO::DavJob
 *
 * Creates a new DavJob that issues a SEARCH command.
 *
 * \a url the URL of the resource
 *
 * \a nsURI the URI of the search method's qualified name
 *
 * \a qName the local part of the search method's qualified name
 *
 * \a query the search string
 *
 * \a flags We support HideProgressInfo here
 *
 * Returns the new DavJob
 */
KIOCORE_EXPORT DavJob *davSearch(const QUrl &url, const QString &nsURI, const QString &qName, const QString &query, JobFlags flags = DefaultFlags);

/*!
 * \relates KIO::DavJob
 *
 * Creates a new DavJob that issues a REPORT command.
 *
 * \a url the URL of the resource
 *
 * \a report a REPORT document that describes the request to make
 *
 * \a depth the depth of the request. Can be "0", "1" or "infinity"
 *
 * \a flags We support HideProgressInfo here
 *
 * Returns the new DavJob
 */
KIOCORE_EXPORT DavJob *davReport(const QUrl &url, const QString &report, const QString &depth, JobFlags flags = DefaultFlags);

/*!
 * \relates KIO::DavJob
 *
 * Creates a new DavJob that issues a MKCOL command.
 *
 * \a url the URL of the resource
 *
 * \a properties a MKCOL document that describes the request to make
 *
 * \a flags We support HideProgressInfo here
 *
 * Returns the new DavJob
 *
 * \since 6.27.0
 */
KIOCORE_EXPORT DavJob *davMkCol(const QUrl &url, const QString &properties, JobFlags flags = DefaultFlags);

} // namespace KIO

#endif