validatorfilesize.cpp

/*
 * SPDX-FileCopyrightText: (C) 2018-2025 Matthias Fehring <mf@huessenbergnetz.de>
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#include "validatorfilesize_p.h"
 
#include <cmath>
#include <limits>
 
using namespace Cutelyst;
using namespace Qt::StringLiterals;
 
ValidatorFileSize::ValidatorFileSize(const QString &field,
                                     Option option,
                                     const QVariant &min,
                                     const QVariant &max,
                                     const ValidatorMessages &messages,
                                     const QString &defValKey)
    : ValidatorRule(*new ValidatorFileSizePrivate(field, option, min, max, messages, defValKey))
{
}
 
ValidatorFileSize::~ValidatorFileSize() = default;
 
bool ValidatorFileSize::validate(const QString &value,
                                 double min,
                                 double max,
                                 Cutelyst::ValidatorFileSize::Option option,
                                 const QLocale &locale,
                                 double *fileSize)
{
    bool valid = true;
 
    const QString str = value.simplified();
    QString digitPart;
    QString symbolPart;
    bool decimalPointFound = false;
    const QString decimalPoint(locale.decimalPoint());
    int multiplier     = 0;
    bool binary        = false;
    bool byteSignFound = false;
    ValidatorFileSizePrivate::StartsWith startsWith{ValidatorFileSizePrivate::StartsWith::NotSet};
 
    for (const QChar &ch : str) {
        if (valid) {
            const char16_t uc = ch.toUpper().unicode();
            if (((uc >= ValidatorRulePrivate::ascii_0) && (uc <= ValidatorRulePrivate::ascii_9)) ||
                (ch == decimalPoint)) {
                if (startsWith == ValidatorFileSizePrivate::StartsWith::NotSet) {
                    startsWith = ValidatorFileSizePrivate::StartsWith::DigitPart;
                }
                if (ch == decimalPoint) {
                    if (decimalPointFound) {
                        qCDebug(C_VALIDATOR).nospace()
                            << "ValidatorFileSize: Validation failed for " << value << ": "
                            << "two decimal seperators in a row";
                        valid = false;
                        break;
                    } else {
                        decimalPointFound = true;
                    }
                }
                if ((symbolPart.isEmpty() &&
                     (startsWith == ValidatorFileSizePrivate::StartsWith::DigitPart)) ||
                    (!symbolPart.isEmpty() &&
                     (startsWith == ValidatorFileSizePrivate::StartsWith::SymbolPart))) {
                    digitPart.append(ch);
                } else {
                    qCDebug(C_VALIDATOR).nospace() << "ValidatorFileSize: Validation failed for "
                                                   << value << ": " << "symbol inside digit part";
                    valid = false;
                    break;
                }
            } else if ((uc != ValidatorRulePrivate::asciiTab) &&
                       (uc != ValidatorRulePrivate::asciiSpace)) { // not a digit or decimal point
                                                                   // and not a space or tab
                if (startsWith == ValidatorFileSizePrivate::StartsWith::NotSet) {
                    startsWith = ValidatorFileSizePrivate::StartsWith::SymbolPart;
                }
                if ((digitPart.isEmpty() &&
                     (startsWith == ValidatorFileSizePrivate::StartsWith::SymbolPart)) ||
                    (!digitPart.isEmpty() &&
                     (startsWith == ValidatorFileSizePrivate::StartsWith::DigitPart))) {
                    switch (uc) {
                    case ValidatorFileSizePrivate::ascii_K:
                    {
                        if (multiplier > 0) {
                            valid = false;
                            qCDebug(C_VALIDATOR).nospace()
                                << "ValdatorFileSize: Validation failed for " << value << ": "
                                << "unit symbol K already found";
                        } else {
                            multiplier = 1;
                            symbolPart.append(ch);
                        }
                    } break;
                    case ValidatorFileSizePrivate::ascii_M:
                    {
                        if (multiplier > 0) {
                            valid = false;
                            qCDebug(C_VALIDATOR).nospace()
                                << "ValdatorFileSize: Validation failed for " << value << ": "
                                << "unit symbol M already found";
                        } else {
                            multiplier = 2;
                            symbolPart.append(ch);
                        }
                    } break;
                    case ValidatorFileSizePrivate::ascii_G:
                    {
                        if (multiplier > 0) {
                            valid = false;
                            qCDebug(C_VALIDATOR).nospace()
                                << "ValdatorFileSize: Validation failed for " << value << ": "
                                << "unit symbol G already found";
                        } else {
                            multiplier = 3;
                            symbolPart.append(ch);
                        }
                    } break;
                    case ValidatorFileSizePrivate::ascii_T:
                    {
                        if (multiplier > 0) {
                            valid = false;
                            qCDebug(C_VALIDATOR).nospace()
                                << "ValdatorFileSize: Validation failed for " << value << ": "
                                << "unit symbol T already found";
                        } else {
                            multiplier = 4;
                            symbolPart.append(ch);
                        }
                    } break;
                    case ValidatorFileSizePrivate::ascii_P:
                    {
                        if (multiplier > 0) {
                            valid = false;
                            qCDebug(C_VALIDATOR).nospace()
                                << "ValdatorFileSize: Validation failed for " << value << ": "
                                << "unit symbol P already found";
                        } else {
                            multiplier = 5;
                            symbolPart.append(ch);
                        }
                    } break;
                    case ValidatorFileSizePrivate::ascii_E:
                    {
                        if (multiplier > 0) {
                            valid = false;
                            qCDebug(C_VALIDATOR).nospace()
                                << "ValdatorFileSize: Validation failed for " << value << ": "
                                << "unit symbol E already found";
                        } else {
                            multiplier = 6;
                            symbolPart.append(ch);
                        }
                    } break;
                    case ValidatorRulePrivate::ascii_Z:
                    {
                        if (multiplier > 0) {
                            valid = false;
                            qCDebug(C_VALIDATOR).nospace()
                                << "ValdatorFileSize: Validation failed for " << value << ": "
                                << "unit symbol Z already found";
                        } else {
                            multiplier = 7;
                            symbolPart.append(ch);
                        }
                    } break;
                    case ValidatorFileSizePrivate::ascii_Y:
                    {
                        if (multiplier > 0) {
                            valid = false;
                            qCDebug(C_VALIDATOR).nospace()
                                << "ValdatorFileSize: Validation failed for " << value << ": "
                                << "unit symbol Y already found";
                        } else {
                            multiplier = 8;
                            symbolPart.append(ch);
                        }
                    } break;
                    case ValidatorFileSizePrivate::ascii_I:
                    {
                        if ((multiplier == 0) || binary) {
                            valid = false;
                            qCDebug(C_VALIDATOR).nospace()
                                << "ValdatorFileSize: Validation failed for " << value << ": "
                                << "binary indicator I already found or no unit symbol given "
                                   "before";
                        } else {
                            binary = true;
                            symbolPart.append(ch);
                        }
                    } break;
                    case ValidatorFileSizePrivate::ascii_B:
                    {
                        if (byteSignFound) {
                            valid = false;
                            qCDebug(C_VALIDATOR).nospace()
                                << "ValdatorFileSize: Validation failed for " << value << ": "
                                << "byte symbol B already found";
                        } else {
                            byteSignFound = true;
                            symbolPart.append(ch);
                        }
                    } break;
                    case ValidatorRulePrivate::asciiTab:
                    case ValidatorRulePrivate::asciiSpace:
                        break;
                    default:
                        valid = false;
                        qCDebug(C_VALIDATOR).nospace()
                            << "ValdatorFileSize: Validation failed for " << value << ": "
                            << "invalid character in symbol part";
                        break;
                    }
                } else {
                    valid = false;
                    break;
                }
            }
        } else {
            break;
        }
    }
 
    if ((option == OnlyBinary) && !binary) {
        valid = false;
    } else if ((option == OnlyDecimal) && binary) {
        valid = false;
    } else if (option == ForceBinary) {
        binary = true;
    } else if (option == ForceDecimal) {
        binary = false;
    }
 
    if (valid) {
        bool ok     = false;
        double size = locale.toDouble(digitPart, &ok);
        if (!ok) {
            valid = false;
        } else {
            if (multiplier > 0) {
                const double _mult =
                    binary ? std::exp2(multiplier * 10) : std::pow(10.0, multiplier * 3);
                size *= _mult;
            }
            if ((min >= 1.0) && (size < min)) {
                valid = false;
            }
            if ((max >= 1.0) && (size > max)) {
                valid = false;
            }
            if (valid && fileSize) {
                *fileSize = size;
            }
        }
    }
 
    return valid;
}
 
ValidatorReturnType ValidatorFileSize::validate(Context *c, const ParamsMultiMap &params) const
{
    ValidatorReturnType result;
 
    Q_D(const ValidatorFileSize);
 
    const QString v = value(params);
 
    if (!v.isEmpty()) {
 
        double min = -1;
        double max = -1;
        bool ok    = true;
        if (d->min.isValid()) {
            min = ValidatorFileSizePrivate::extractDouble(c, params, d->min, &ok);
            if (!ok) {
                qCWarning(C_VALIDATOR).noquote()
                    << debugString(c) << "Invalid minimum size comparison data";
                result.errorMessage = validationDataError(
                    c, static_cast<int>(ValidatorRulePrivate::ErrorType::InvalidMin));
            }
        }
 
        if (ok && d->max.isValid()) {
            max = ValidatorFileSizePrivate::extractDouble(c, params, d->max, &ok);
            if (!ok) {
                qCWarning(C_VALIDATOR).noquote()
                    << debugString(c) << "Invalid maximum size comparison data";
                result.errorMessage = validationDataError(
                    c, static_cast<int>(ValidatorRulePrivate::ErrorType::InvalidMax));
            }
        }
 
        if (ok) {
            double size = 0;
            if (ValidatorFileSize::validate(v, min, max, d->option, c->locale(), &size)) {
                if (size < static_cast<double>(std::numeric_limits<qulonglong>::max())) {
                    // best solution would be something like std::ullround, but there is only
                    // std:llround that returns a signed long long instead of unsigend, so still
                    // using this approach works best
                    // NOLINTNEXTLINE(bugprone-incorrect-roundings)
                    result.value.setValue<qulonglong>(static_cast<qulonglong>(size + 0.5));
                } else {
                    result.value.setValue(size);
                }
            } else {
                result.errorMessage = validationError(c);
                qCWarning(C_VALIDATOR).noquote()
                    << debugString(c) << v << "is not a valid data size string";
            }
        }
 
    } else {
        defaultValue(c, &result);
    }
 
    return result;
}
 
void ValidatorFileSize::validateCb(Context *c, const ParamsMultiMap &params, ValidatorRtFn cb) const
{
    cb(validate(c, params));
}
 
QString ValidatorFileSize::genericValidationError(Context *c, const QVariant &errorData) const
{
    Q_D(const ValidatorFileSize);
    Q_UNUSED(errorData)
    const QString _label = label(c);
    if (d->min.isValid() || d->max.isValid()) {
        if (_label.isEmpty()) {
            //% "Invalid file size or file size not within the allowed limits."
            return c->qtTrId("cutelyst-valfilesize-genvalerr-minmax");
        } else {
            //% "The value in the “%1” field is either not a valid file size or "
            //% "not within the allowed limits."
            return c->qtTrId("cutelyst-valfilesize-genvalerr-minmax-label").arg(_label);
        }
    } else {
        if (_label.isEmpty()) {
            //% "Invalid file size."
            return c->qtTrId("cutelyst-valfilesize-genvalerr");
        } else {
            //% "The “%1” field does not contain a valid file size."
            return c->qtTrId("cutelyst-valfilesize-genvalerr-label").arg(_label);
        }
    }
}
 
QString ValidatorFileSize::genericValidationDataError(Context *c, const QVariant &errorData) const
{
    const QString _label = label(c);
 
    const auto errorType = static_cast<ValidatorRulePrivate::ErrorType>(errorData.toInt());
 
    if (_label.isEmpty()) {
        switch (errorType) {
        case ValidatorRulePrivate::ErrorType::InvalidMin:
            //% "The minimum file size comparison value is not valid."
            return c->qtTrId("cutelyst-valfilesize-genvaldataerr-min");
        case ValidatorRulePrivate::ErrorType::InvalidMax:
            //% "The maximum file size comparison value is not valid."
            return c->qtTrId("cutelyst-valfilesize-genvaldataerr-max");
        case ValidatorRulePrivate::ErrorType::InvalidType:
            // NOLINTNEXTLINE(cppcoreguidelines-avoid-do-while)
            Q_UNREACHABLE();
            return {};
        }
    } else {
        switch (errorType) {
        case ValidatorRulePrivate::ErrorType::InvalidMin:
            //% "The minimum file size comparison value for the “%1” field is not valid."
            return c->qtTrId("cutelyst-valfilesize-genvaldataerr-min-label").arg(_label);
        case ValidatorRulePrivate::ErrorType::InvalidMax:
            //% "The maximum file size comparison value for the “%1” field is not valid."
            return c->qtTrId("cutelyst-valfilesize-genvaldataerr-max-label").arg(_label);
        case ValidatorRulePrivate::ErrorType::InvalidType:
            // NOLINTNEXTLINE(cppcoreguidelines-avoid-do-while)
            Q_UNREACHABLE();
            return {};
        }
    }
 
#if QT_VERSION >= QT_VERSION_CHECK(6, 5, 0)
    // NOLINTNEXTLINE(cppcoreguidelines-avoid-do-while)
    Q_UNREACHABLE_RETURN({});
#else
    return {};
#endif
}
 
void ValidatorFileSize::inputPattern(Context *c, const QString &stashKey)
{
    Q_ASSERT(c);
    const QString pattern =
        c->locale().textDirection() == Qt::LeftToRight
            ? u"^\\d+[%1]?\\d*\\s*[KkMmGgTt]?[Ii]?[Bb]?"_s.arg(c->locale().decimalPoint())
            : u"[KkMmGgTt]?[Ii]?[Bb]?\\s*\\d+[%1]?\\d*"_s.arg(c->locale().decimalPoint());
    c->setStash(stashKey, pattern);
}