mirror of
https://github.com/inspircd/inspircd.git
synced 2025-03-09 10:39:02 -04:00
90d9d02c9e
Unfortunately because of leap years we can't really make duration strings exact. Because of this we have always added 6 hours on to each year to make it correct over time. However, we did not do this in any kind of consistent way which resulted in weird roundtripped duration strings which made this very confusing for users While I'm touching the duration code I've also cleaned it up.
85 lines
3.2 KiB
C++
85 lines
3.2 KiB
C++
/*
|
|
* InspIRCd -- Internet Relay Chat Daemon
|
|
*
|
|
* Copyright (C) 2023-2024 Sadie Powell <sadie@witchery.services>
|
|
*
|
|
* This file is part of InspIRCd. InspIRCd 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, version 2.
|
|
*
|
|
* 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, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
|
|
#pragma once
|
|
|
|
namespace Duration
|
|
{
|
|
/** Converts a string containing a duration to the number of seconds it
|
|
* represents returning 0 on error.
|
|
*
|
|
* The string should should be in the format 1y2w3d4h6m5s which represents
|
|
* one year, two weeks, three days, four hours, six minutes, and five
|
|
* seconds. If called with this duration 33,019,565 will be returned.
|
|
*
|
|
* @param str A string containing a duration.
|
|
* @return Either the number of seconds in the duration or 0 on error.
|
|
*/
|
|
CoreExport unsigned long From(const std::string& str);
|
|
|
|
/** Determines whether a duration string is valid.
|
|
* @param str The duration string to check.
|
|
*/
|
|
CoreExport bool IsValid(const std::string& str);
|
|
|
|
/** Converts a number of seconds to a duration string.
|
|
*
|
|
* e.g. 33,019,565 will result in 1y2w3d4h6m5s which represents one year,
|
|
* two weeks, three days, four hours, six minutes, and five seconds.
|
|
*/
|
|
CoreExport std::string ToString(unsigned long duration);
|
|
|
|
/** Attempts to converts a string containing a duration to the number of
|
|
* seconds it represents returning whether the conversion succeeded.
|
|
*
|
|
* The string should should be in the format 1y2w3d4h6m5s which represents
|
|
* one year, two weeks, three days, four hours, six minutes, and five
|
|
* seconds. If called with this duration 33,019,565 will be returned.
|
|
*
|
|
* @param str A string containing a duration.
|
|
* @param duration The location to store the resulting duration.
|
|
* @return True if the conversion succeeded; otherwise, false.
|
|
*/
|
|
CoreExport bool TryFrom(const std::string& str, unsigned long& duration);
|
|
}
|
|
|
|
namespace Time
|
|
{
|
|
/** Converts a UNIX timestamp to a time string.
|
|
*
|
|
* @param ts The timestamp to convert to a string.
|
|
* @param format A snprintf format string to output the timestamp in.
|
|
* @param utc If the timestamp is a UTC timestamp then true or false if the
|
|
* timestamp is a local timestamp.
|
|
*/
|
|
CoreExport std::string ToString(time_t ts, const char* format = nullptr, bool utc = false);
|
|
|
|
/** Converts a duration from now to a time string.
|
|
*
|
|
* @param duration The duration from now to convert to a string.
|
|
* @param format A snprintf format string to output the timestamp in.
|
|
* @param utc If the timestamp is a UTC timestamp then true or false if the
|
|
* timestamp is a local timestamp.
|
|
*/
|
|
inline std::string FromNow(unsigned long duration, const char* format = nullptr, bool utc = false)
|
|
{
|
|
return ToString(ServerInstance->Time() + duration, format, utc);
|
|
}
|
|
}
|