upload.h

/*
 * Copyright (C) 2014-2017 Daniel Nicoletti <dantti12@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef UPLOAD_H
#define UPLOAD_H

#include <QtCore/qiodevice.h>

#include <Cutelyst/cutelyst_global.h>
#include <Cutelyst/headers.h>

class QTemporaryFile;

namespace Cutelyst {

class UploadPrivate;

/*! \class Upload upload.h Cutelyst/Upload
 * @brief %Cutelyst %Upload handles file upload request
 */
class CUTELYST_LIBRARY Upload : public QIODevice
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(Upload)
public:
    /**
     * This class provides access to client upload requests
     */
    Upload(UploadPrivate *prv);
    virtual ~Upload() override;

    /**
     * Returns the name of the form field
     */
    QString name() const;

    /**
     * Returns the file name provided by the user agent
     */
    QString filename() const;

    /**
     * Returns the content type provided by the user agent
     */
    QString contentType() const;

    /**
     * Returns the headers provided by the user agent
     */
    Headers headers() const;

    /**
     * Saves this upload to the following location.
     */
    bool save(const QString &filename);

    /**
     * This function creates a temporary file and fill it with
     * the content of this upload.
     * Returns zero if an error occours.
     */
    QTemporaryFile *createTemporaryFile(const QString &templateName = QString());

    /**
     * Reimplemented from QIODevice::pos().
     */
    virtual qint64 pos() const override;

    /**
     * Reimplemented from QIODevice::size().
     */
    virtual qint64 size() const override;

    /**
     * Reimplemented from QIODevice::seek().
     */
    virtual bool seek(qint64 pos) override;

protected:
    /**
     * Reimplemented from QIODevice::readData().
     */
    virtual qint64 readData(char *data, qint64 maxlen) override;

    /**
     * Reimplemented from QIODevice::readLineData().
     */
    virtual qint64 readLineData(char *data, qint64 maxlen) override;

    /**
     * Reimplemented from QIODevice::writeData().
     */
    virtual qint64 writeData(const char * data, qint64 maxSize) override;

    UploadPrivate *d_ptr;
};

typedef QVector<Upload *> Uploads;

}

#endif // UPLOAD_H