Factor out time formatting functions.
[cumulus.git] / util.h
1 /* Cumulus: Efficient Filesystem Backup to the Cloud
2  * Copyright (C) 2007 The Cumulus Developers
3  * See the AUTHORS file for a list of contributors.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19
20 /* Utility functions for converting various datatypes to text format (and
21  * later, for parsing them back, perhaps). */
22
23 #ifndef _LBS_FORMAT_H
24 #define _LBS_FORMAT_H
25
26 #include <iostream>
27 #include <map>
28 #include <string>
29
30 std::string uri_encode(const std::string &in);
31 std::string uri_decode(const std::string &in);
32 std::string encode_int(long long n, int base=10);
33
34 long long parse_int(const std::string &s);
35 void cloexec(int fd);
36
37 void fatal(std::string msg) __attribute__((noreturn));
38
39 /* Date/time string formatting and parsing utility functions.  All data and
40  * methods are static, so this class should not be instantiated. */
41 class TimeFormat {
42 public:
43     // Abbreviated time format encoded in snapshot file names.
44     static const char FORMAT_FILENAME[];
45     // A timestamp, in UTC, written out in an ISO 8601 format (compatible with
46     // the SQLite datetime function).
47     static const char FORMAT_ISO8601[];
48     // Similar to the above, but including a timezone offset.
49     static const char FORMAT_LOCALTIME[];
50
51     static std::string format(time_t timestamp, const char *format, bool utc);
52
53     static std::string isoformat(time_t timestamp)
54         { return format(timestamp, FORMAT_ISO8601, true); }
55
56 private:
57     TimeFormat() { }
58 };
59
60 #endif // _LBS_TARSTORE_H