mediawiki_queryrevision.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2011-03-22
 * Description : a Iface C++ interface
 *
 * Copyright (C) 2011-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2011      by Hormiere Guillaume <hormiere dot guillaume at gmail dot com>
 * Copyright (C) 2011      by Manuel Campomanes <campomanes dot manuel at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_MEDIAWIKI_QUERYREVISION_H
#define DIGIKAM_MEDIAWIKI_QUERYREVISION_H
 
// Qt includes
 
#include <QDateTime>
#include <QList>
#include <QString>
 
// Local includes
 
#include "mediawiki_job.h"
#include "mediawiki_revision.h"
 
namespace MediaWiki
{
 
class Iface;
class QueryRevisionPrivate;
 
class QueryRevision : public Job
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QueryRevision)
 
public:
 
    enum Direction
    {
        Older,
 
        Newer
    };
 
    enum Token
    {
        Rollback
    };
 
    enum
    {
        WrongRevisionId = Job::UserDefinedError + 1,
 
        MultiPagesNotAllowed,
 
        TitleAccessDenied,
 
        TooManyParams,
 
        SectionNotFound
    };
 
    enum Property
    {
        Ids         = 0x01,
        Flags       = 0x02,
        Timestamp   = 0x04,
        User        = 0x08,
        Comment     = 0x10,
        Size        = 0x20,
        Content     = 0x40
    };
    Q_DECLARE_FLAGS(Properties, Property)
 
public:
 
    explicit QueryRevision(Iface& MediaWiki, QObject* const parent = nullptr);
 
    ~QueryRevision() override;
 
    void start() override;
 
    void setPageId(unsigned int pageId);
 
    void setRevisionId(unsigned int revisionId);
 
    void setPageName(const QString& pageName);
 
    void setProperties(Properties properties);
 
    void setLimit(int limit);
 
    void setStartId(int startId);
 
    void setEndId(int endId);
 
    void setStartTimestamp(const QDateTime& start);
 
    void setEndTimestamp(const QDateTime& end);
 
    void setUser(const QString& user);
 
    void setExcludeUser(const QString& excludeUser);
 
    void setDirection(QueryRevision::Direction direction);
 
    void setGenerateXML(bool generateXML);
 
    void setSection(int section);
 
    void setToken(QueryRevision::Token token);
 
    void setExpandTemplates(bool expandTemplates);
 
Q_SIGNALS:
 
    void revision(const QList<Revision>& revision);
 
private Q_SLOTS:
 
    void doWorkSendRequest();
    void doWorkProcessReply();
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS(QueryRevision::Properties)
 
} // namespace MediaWiki
 
#endif // DIGIKAM_MEDIAWIKI_QUERYREVISION_H