ircabot/captcha.h

/*
* Copyright (c) 2014 Omkar Kanase
*
* This software is provided 'as-is', without any express or implied
* warranty.  In no event will the authors be held liable for any damages
* arising from the use of this software.
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
* 1. The origin of this software must not be misrepresented; you must not
* claim that you wrote the original software. If you use this software
* in a product, an acknowledgment in the product documentation would be
* appreciated but is not required.
* 2. Altered source versions must be plainly marked as such, and must not be
* misrepresented as being the original software.
* 3. This notice may not be removed or altered from any source distribution.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright (c) 2022 Acetone
* Updated for IRCaBot project
* Usage example:
* #include <QApplication>
* int main(int argc, char *argv[]) {
*    QApplication a(argc, argv);
*    Captcha cp;
*    cp.randomize();
*    cp.generateText(5);
*    QFile f("f.png");
*    if (f.open(QIODevice::WriteOnly)) {
*        f.write(cp.captchaPngByteArray()); // ready to use PNG file
*        f.close();
*    }
*    qInfo() << cp.captchaText(); // answer
* }
*/

#ifndef CAPTCHA_H
#define CAPTCHA_H

#include <QObject>
#include <QFont>
#include <QImage>
#include <QTime>
#include <QVector>
#include <QStringList>
#include <QDebug>
#include <QFile>
#include <QTextStream>
#include <QPainter>
#include <QPainterPath>
#include <QtMath>
#include <QBuffer>

class Captcha : public QObject
{
    Q_OBJECT
    Q_ENUMS(DeformType)
    Q_ENUMS(TextGenerationMode)
    Q_PROPERTY(QFont font READ font WRITE setFont)
    Q_PROPERTY(QImage captchaImage READ captchaImage)
    Q_PROPERTY(QString captchaText READ captchaText WRITE setCaptchaText)
    Q_PROPERTY(DeformType deformationType READ deformationType WRITE setDeformationType)
    Q_PROPERTY(TextGenerationMode textGeneration READ textGeneration WRITE setTextGeneration)
    Q_PROPERTY(QStringList dictionary READ dictionary WRITE setDictionary)
    Q_PROPERTY(QColor fontColor READ fontColor WRITE setFontColor)
    Q_PROPERTY(QColor backColor READ backColor WRITE setBackColor)
    Q_PROPERTY(bool drawLines READ drawLines WRITE setDrawLines)
    Q_PROPERTY(bool drawEllipses READ drawEllipses WRITE setDrawEllipses)
    Q_PROPERTY(bool drawNoise READ drawNoise WRITE setDrawNoise)
    Q_PROPERTY(int noiseCount READ noiseCount WRITE setNoiseCount)
    Q_PROPERTY(int lineCount READ lineCount WRITE setLineCount)
    Q_PROPERTY(int ellipseCount READ ellipseCount WRITE setEllipseCount)
    Q_PROPERTY(int lineWidth READ lineWidth WRITE setLineWidth)
    Q_PROPERTY(int ellipseMinRadius READ ellipseMinRadius WRITE setEllipseMinRadius)
    Q_PROPERTY(int ellipseMaxRadius READ ellipseMaxRadius WRITE setEllipseMaxRadius)
    Q_PROPERTY(int noisePointSize READ noisePointSize WRITE setNoisePointSize)

public:
    enum DeformType
    {
        Deform_SinCurve
    };

	enum TextGenerationMode
	{
		TextGeneration_Random,
		TextGeneration_Dictionary
	};

public:
    explicit Captcha(QObject *parent = nullptr);

    QByteArray captchaPngByteArray() const;
    QFont font() const;
    QImage captchaImage() const;
    DeformType deformationType() const;
    QString captchaText() const;    
    TextGenerationMode textGeneration() const;    
    const QStringList &dictionary() const;    
    QColor fontColor() const;
    QColor backColor() const;    
    bool drawLines() const;
    bool drawEllipses() const;
    bool drawNoise() const;
    int noiseCount() const;
    int lineCount() const;
    int ellipseCount() const;
    int lineWidth() const;
    int ellipseMinRadius() const;
    int ellipseMaxRadius() const;
    int noisePointSize() const;

signals:
    void captchaGenerated(const QImage& img, QString text);

public slots:
    void setFont(const QFont& arg);
    void setDeformationType(DeformType arg);
    void updateCaptcha();
    void randomize();
	void generateText(int noOfChars = 5, bool includeNumbers = false, bool includeSymbols = false, bool allCapital = true);
    void setCaptchaText(QString arg);    
    void setTextGeneration(TextGenerationMode arg);
    void setDictionary(const QStringList& arg);
    void loadDictionary(QString FileName);    
    void setFontColor(QColor arg);
    void setBackColor(QColor arg);
    void setSinDeform(qreal hAmplitude, qreal hFrequency, qreal vAmplitude, qreal vFrequency);
    QPair<QString, QImage> generateCaptcha();    
    void setDrawLines(bool arg);
    void setDrawEllipses(bool arg);
    void setDrawNoise(bool arg);
    void setNoiseCount(int arg);
    void setLineCount(int arg);
    void setEllipseCount(int arg);
    void setLineWidth(int arg);
    void setEllipseMinRadius(int arg);
    void setEllipseMaxRadius(int arg);
    void setNoisePointSize(int arg);
	void setDifficulty(int val);

private:
    qreal m_hmod1;
    qreal m_hmod2;

    qreal m_vmod1;
    qreal m_vmod2;

    QFont m_font;
    QImage m_captchaImage;
    DeformType m_deformationType;
    QString m_captchaText;  
    TextGenerationMode m_textGeneration;
    QStringList m_dictionary;
    QColor m_fontColor;
    QColor m_backColor;
    qreal m_padding;
    bool m_drawLines;
    bool m_drawEllipses;
    bool m_drawNoise;
    int m_noiseCount;
    int m_lineCount;
    int m_ellipseCount;
    int m_lineWidth;
    int m_ellipseMinRadius;
    int m_ellipseMaxRadius;
    int m_noisePointSize;
};

#endif // CAPTCHA_H