validator_duration.cpp

Go to the documentation of this file.

// Copyright (c) 2006-2025  Made to Order Software Corp.  All Rights Reserved
//
// https://snapwebsites.org/project/advgetopt
// contact@m2osw.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 of the License, 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.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
// self
//
#include    "advgetopt/validator_duration.h"
 
#include    "advgetopt/validator_double.h"
 
 
// cppthread
//
#include    <cppthread/log.h>
 
 
// snapdev
//
#include    <snapdev/trim_string.h>
 
 
// last include
//
#include    <snapdev/poison.h>
 
 
 
namespace advgetopt
{
 
 
 
namespace
{
 
 
 
class validator_duration_factory
    : public validator_factory
{
public:
    validator_duration_factory()
    {
        validator::register_validator(*this);
    }
 
    virtual std::string get_name() const override
    {
        return std::string("duration");
    }
 
    virtual std::shared_ptr<validator> create(string_list_t const & data) const override
    {
        return std::make_shared<validator_duration>(data);
    }
};
 
validator_duration_factory      g_validator_duration_factory;
 
 
 
} // no name namespace
 
 
 
 
 
validator_duration::validator_duration(string_list_t const & flag_list)
{
    for(auto r : flag_list)
    {
        if(r == "small")
        {
            f_flags &= ~VALIDATOR_DURATION_LONG;
        }
        else if(r == "large")
        {
            f_flags |= VALIDATOR_DURATION_LONG;
        }
        else if(!r.empty() && (r[0] | 0x20) >= 'a' && (r[0] | 0x20) <= 'z')
        {
            double const factor(suffix_to_factor(r, f_flags, -1.0));
            if(factor < 0.0)
            {
                cppthread::log << cppthread::log_level_t::error
                               << r
                               << " is not a valid duration suffix or flag."
                               << cppthread::end;
                continue;
            }
            f_default_factor = factor;
        }
        else
        {
            range_t range;
            std::string::size_type const pos(r.find("..."));
            if(pos == std::string::npos)
            {
                if(!convert_string(r, f_flags, f_default_factor, range.f_minimum))
                {
                    cppthread::log << cppthread::log_level_t::error
                                   << r
                                   << " is not a valid duration."
                                   << cppthread::end;
                    continue;
                }
                range.f_maximum = range.f_minimum;
            }
            else
            {
                std::string const min_value(snapdev::trim_string(r.substr(0, pos)));
                if(!min_value.empty())
                {
                    if(!convert_string(min_value, f_flags, f_default_factor, range.f_minimum))
                    {
                        cppthread::log << cppthread::log_level_t::error
                                       << min_value
                                       << " is not a valid value for your range's start;"
                                          " it must be a valid duration,"
                                          " optionally preceded by a sign (+ or -)."
                                       << cppthread::end;
                        continue;
                    }
                }
 
                std::string const max_value(snapdev::trim_string(r.substr(pos + 3)));
                if(!max_value.empty())
                {
                    if(!convert_string(max_value, f_flags, f_default_factor, range.f_maximum))
                    {
                        cppthread::log << cppthread::log_level_t::error
                                       << max_value
                                       << " is not a valid value for your range's end;"
                                          " it must be a valid duration,"
                                          " optionally preceded by a sign (+ or -)."
                                       << cppthread::end;
                        continue;
                    }
                }
 
                if(range.f_minimum > range.f_maximum)
                {
                    cppthread::log << cppthread::log_level_t::error
                                   << min_value
                                   << " has to be smaller or equal to "
                                   << max_value
                                   << "; you have an invalid duration range."
                                   << cppthread::end;
                    continue;
                }
            }
            f_allowed_values.push_back(range);
        }
    }
}
 
 
std::string validator_duration::name() const
{
    return std::string("duration");
}
 
 
bool validator_duration::validate(std::string const & value) const
{
    double result(0);
    if(!convert_string(value, f_flags, f_default_factor, result))
    {
        set_error("not a valid duration.");
        return false;
    }
 
    if(f_allowed_values.empty())
    {
        return true;
    }
 
    for(auto f : f_allowed_values)
    {
        if(result >= f.f_minimum
        && result <= f.f_maximum)
        {
            return true;
        }
    }
 
    set_error("out of range.");
    return false;
}
 
 
bool validator_duration::convert_string(
      std::string const & value
    , flag_t flags
    , double suffix_default_factor
    , double & result)
{
    result = 0.0;
 
    // TODO: use libutf8 to walk the string and skip all UTF-8 spaces
    //
    char const * s(value.c_str());
    while(isspace(*s))
    {
        ++s;
    }
    if(*s == '\0')
    {
        return false;
    }
 
    double r(0.0);
    while(*s != '\0')
    {
        // get the number
        //
        char const * number(s);
        if(*s == '+'
        || *s == '-')
        {
            ++s;
        }
        while(*s >= '0' && *s <= '9')
        {
            ++s;
        }
        if(*s == '.')
        {
            do
            {
                ++s;
            }
            while(*s >= '0' && *s <= '9');
            if(*s == '.')
            {
                // this would otherwise allow "2..8 year" which is probably
                // a mistake (i.e. not "2.s" and ".8 year")
                //
                return false;
            }
        }
        double n(0.0);
        if(!validator_double::convert_string(
                  (*number == '.' ? "0" : "") + std::string(number, s - number)
                , n))
        {
            return false;
        }
 
        while(isspace(*s))
        {
            ++s;
        }
 
        // get the suffix
        //
        std::string suffix;
        for(;; ++s)
        {
            if(*s >= 'A'
            && *s <= 'Z')
            {
                // make lowercase as we're at it
                //
                suffix += *s + 0x20;
            }
            else if(*s >= 'a'
                 && *s <= 'z')
            {
                suffix += *s;
            }
            else
            {
                break;
            }
        }
 
        double const factor(suffix_to_factor(suffix, flags, suffix_default_factor));
        if(factor < 0.0)
        {
            return false;
        }
 
        // TODO: catch ERANGE errors
        //
        r += n * factor;
 
        while(isspace(*s))
        {
            ++s;
        }
    }
 
    result = r;
 
    return true;
}
 
 
double validator_duration::suffix_to_factor(
      std::string const & suffix
    , flag_t flags
    , double suffix_default_factor)
{
    // if empty use default
    //
    if(suffix.empty())
    {
        return suffix_default_factor;
    }
 
    switch(suffix[0])
    {
    case 'd':
        if(suffix == "d"
        || suffix == "day"
        || suffix == "days")
        {
            return 86400.0;
        }
        break;
 
    case 'h':
        if(suffix == "h"
        || suffix == "hour"
        || suffix == "hours")
        {
            return 3600.0;
        }
        break;
 
    case 'm':
        if(suffix == "m")
        {
            if((flags & VALIDATOR_DURATION_LONG) != 0)
            {
                return 86400.0 * 30.0;    // 1 month
            }
            else
            {
                return 60.0;              // 1 minute
            }
        }
        else if(suffix == "minute"
             || suffix == "minutes")
        {
            return 60.0;
        }
        else if(suffix == "month"
             || suffix == "months")
        {
            return 86400.0 * 30.0;
        }
        else if(suffix == "mi"
             || suffix == "microsecond"
             || suffix == "microseconds")
        {
            return 0.000001;
        }
        else if(suffix == "ms"
             || suffix == "millisecond"
             || suffix == "milliseconds")
        {
            return 0.001;
        }
        break;
 
    case 'n':
        if(suffix == "ns"
        || suffix == "nanosecond"
        || suffix == "nanoseconds")
        {
            return 0.000000001;
        }
        break;
 
    case 's':
        if(suffix == "s"
        || suffix == "second"
        || suffix == "seconds")
        {
            return 1.0;
        }
        break;
 
    case 'w':
        if(suffix == "w"
        || suffix == "week"
        || suffix == "weeks")
        {
            return 86400.0 * 7.0;
        }
        break;
 
    case 'y':
        if(suffix == "y"
        || suffix == "year"
        || suffix == "years")
        {
            return 86400.0 * 365.0;
        }
        break;
 
    }
 
    return -1.0;
}
 
 
 
} // namespace advgetopt
// vim: ts=4 sw=4 et