langselect.h

/*
 * SPDX-FileCopyrightText: (C) 2018-2022 Matthias Fehring <mf@huessenbergnetz.de>
 * SPDX-License-Identifier: BSD-3-Clause
 */

#ifndef C_UTILS_LANGSELECT_H
#define C_UTILS_LANGSELECT_H

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

#include <QLocale>
#include <QVector>

namespace Cutelyst {

class Context;
class LangSelectPrivate;

class CUTELYST_PLUGIN_UTILS_LANGSELECT_EXPORT LangSelect : public Plugin
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(LangSelect)
public:
    enum Source : quint8 {
        URLQuery = 0, 
        Session = 1,  
        Cookie =
            2, 
        SubDomain = 3, 
        Domain =
            4, 
        AcceptHeader =
            254, 
        Fallback = 255 
    };
    Q_ENUM(Source)

    
    LangSelect(Application *parent, Source source);

    LangSelect(Application *parent);

    virtual ~LangSelect() override;

    void setSupportedLocales(const QVector<QLocale> &locales);

    void setSupportedLocales(const QStringList &locales);

    void addSupportedLocale(const QLocale &locale);

    void addSupportedLocale(const QString &locale);

    void setLocalesFromDir(const QString &path,
                           const QString &name,
                           const QString &prefix = QStringLiteral("."),
                           const QString &suffix = QStringLiteral(".qm"));

    void setLocalesFromDirs(const QString &path, const QString &name);

    QVector<QLocale> supportedLocales() const;

    void setQueryKey(const QString &key);

    void setSessionKey(const QString &key);

    void setCookieName(const QString &name);

    void setSubDomainMap(const QMap<QString, QLocale> &map);

    void setDomainMap(const QMap<QString, QLocale> &map);

    void setFallbackLocale(const QLocale &fallback);

    void setDetectFromHeader(bool enabled);

    void setLanguageCodeStashKey(const QString &key = QStringLiteral("c_langselect_lang"));

    void setLanguageDirStashKey(const QString &key = QStringLiteral("c_langselect_dir"));

    static QVector<QLocale> getSupportedLocales();

    static bool fromUrlQuery(Context *c, const QString &key = QString());

    static bool fromSession(Context *c, const QString &key = QString());

    static bool fromCookie(Context *c, const QString &name = QString());

    static bool
        fromSubDomain(Context *c,
                      const QMap<QString, QLocale> &subDomainMap = QMap<QString, QLocale>());

    static bool fromDomain(Context *c,
                           const QMap<QString, QLocale> &domainMap = QMap<QString, QLocale>());

    static bool fromPath(Context *c, const QString &locale);

protected:
    virtual bool setup(Application *app) override;

private:
    LangSelectPrivate *const d_ptr;
};

} // namespace Cutelyst

#endif // C_UTILS_LANGSELECT_H