File: logperiod.hpp

package info (click to toggle)
openvpn3-client 24.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 19,384 kB
  • sloc: cpp: 180,128; python: 11,591; ansic: 1,878; sh: 1,767; java: 402; lisp: 81; makefile: 44
file content (175 lines) | stat: -rw-r--r-- 4,602 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
//    OpenVPN -- An application to securely tunnel IP networks
//               over a single port, with support for SSL/TLS-based
//               session authentication and key exchange,
//               packet encryption, packet authentication, and
//               packet compression.
//
//    Copyright (C) 2012-2022 OpenVPN Inc.
//
//    This program is free software: you can redistribute it and/or modify
//    it under the terms of the GNU Affero General Public License Version 3
//    as published by the Free Software Foundation.
//
//    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 Affero General Public License for more details.
//
//    You should have received a copy of the GNU Affero General Public License
//    along with this program in the COPYING file.
//    If not, see <http://www.gnu.org/licenses/>.

#ifndef OPENVPN_LOG_LOGPERIOD_H
#define OPENVPN_LOG_LOGPERIOD_H

#include <sys/time.h> // for time_t

#include <string>
#include <sstream>
#include <iomanip> // for setfill and setw

#include <openvpn/common/olong.hpp>
#include <openvpn/common/exception.hpp>
#include <openvpn/time/time.hpp>
#include <openvpn/time/timestr.hpp>

namespace openvpn {
class LogPeriod
{
  public:
    OPENVPN_EXCEPTION(log_period_error);

    enum Period
    {
        UNDEF,
        DAILY,
        HOURLY,
        BY_MINUTE,
    };

    LogPeriod()
        : start_(0),
          end_(0),
          period_(UNDEF)
    {
    }

    LogPeriod(const Period period, const time_t base)
    {
        period_ = period;
        const olong p = period_sec(period_);
        start_ = period_base(period_, base);
        end_ = start_ + p;
    }

    LogPeriod(const LogPeriod &other, const int index)
    {
        period_ = other.period_;
        const olong p = period_sec(period_);
        start_ = other.start_ + p * olong(index);
        end_ = start_ + p;
    }

    bool is_current(const time_t now) const
    {
        const olong onow = olong(now);
        return onow >= start_ && onow < end_;
    }

    bool defined() const
    {
        return period_ != UNDEF;
    }

    time_t expires_in(const time_t now)
    {
        const olong onow = olong(now);
        if (onow < end_)
            return end_ - onow;
        else
            return 0;
    }

    std::string to_string_verbose() const
    {
        return date_time(start_) + " -> " + date_time(end_);
    }

    std::string to_string() const
    {
        std::ostringstream os;
        struct tm lt;
        const time_t time = time_t(start_);
        if (!localtime_r(&time, &lt))
            throw log_period_error("to_string localtime_r");
        os << std::setfill('0');
        os << std::setw(4) << (lt.tm_year + 1900) << '.' << std::setw(2) << (lt.tm_mon + 1) << '.' << std::setw(2) << lt.tm_mday;
        if (period_ == HOURLY || period_ == BY_MINUTE)
            os << '-' << std::setw(2) << lt.tm_hour << ':' << std::setw(2) << lt.tm_min;
        return os.str();
    }

    static Period period_from_string(const std::string &str)
    {
        if (str == "daily")
            return DAILY;
        else if (str == "hourly")
            return HOURLY;
        else if (str == "by_minute")
            return BY_MINUTE;
        else
            throw log_period_error("unknown period: " + str);
    }

  private:
    static olong period_sec(const Period p)
    {
        switch (p)
        {
        case DAILY:
            return 86400;
        case HOURLY:
            return 3600;
        case BY_MINUTE:
            return 60;
        default:
            throw log_period_error("undefined period");
        }
    }

    static olong period_base(const Period p, const time_t time)
    {
        struct tm lt;
        if (!localtime_r(&time, &lt))
            throw log_period_error("period_base localtime_r");
        switch (p)
        {
        case DAILY:
            lt.tm_hour = 0;
            lt.tm_min = 0;
            lt.tm_sec = 0;
            break;
        case HOURLY:
            lt.tm_min = 0;
            lt.tm_sec = 0;
            break;
        case BY_MINUTE:
            lt.tm_sec = 0;
            break;
        default:
            throw log_period_error("unknown period");
        }
        const time_t ret = mktime(&lt);
        if (ret == -1)
            throw log_period_error("mktime");
        return olong(ret);
    }

  private:
    olong start_;
    olong end_;
    Period period_;
};
} // namespace openvpn

#endif