File: path.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 (208 lines) | stat: -rw-r--r-- 5,601 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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
//    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/>.

// General-purpose methods for handling filesystem pathnames

#ifndef OPENVPN_COMMON_PATH_H
#define OPENVPN_COMMON_PATH_H

#include <string>

#include <openvpn/common/size.hpp>
#include <openvpn/common/platform.hpp>
#include <openvpn/common/string.hpp>

namespace openvpn {
namespace path {

// Directory separators.  The first char in dirsep is the primary
// separator for the platform, while subsequent chars are also
// recognized as separators.
namespace {
#if defined(OPENVPN_PLATFORM_WIN) || defined(OPENVPN_PATH_SIMULATE_WINDOWS)
// Windows
const char dirsep[] = "\\/"; // CONST GLOBAL
#else
// Unix
const char dirsep[] = "/\\"; // CONST GLOBAL
#endif
} // namespace

// true if char is a directory separator
inline bool is_dirsep(const char c)
{
    for (const char *p = dirsep; *p != '\0'; ++p)
        if (c == *p)
            return true;
    return false;
}

inline bool win_dev(const std::string &path, const bool fully_qualified)
{
#if defined(OPENVPN_PLATFORM_WIN) || defined(OPENVPN_PATH_SIMULATE_WINDOWS)
    // Identify usage such as "c:\\".
    return path.length() >= 3
           && ((path[0] >= 'a' && path[0] <= 'z') || (path[0] >= 'A' && path[0] <= 'Z'))
           && path[1] == ':'
           && (!fully_qualified || is_dirsep(path[2]));
#else
    return false;
#endif
}

// true if path is fully qualified
inline bool is_fully_qualified(const std::string &path)
{
    return win_dev(path, true) || (path.length() > 0 && is_dirsep(path[0]));
}

// does path refer to regular file without directory traversal
inline bool is_flat(const std::string &path)
{
    return path.length() > 0
           && path != "."
           && path != ".."
           && path.find_first_of(dirsep) == std::string::npos
           && !win_dev(path, false);
}

inline std::string basename(const std::string &path)
{
    const size_t pos = path.find_last_of(dirsep);
    if (pos != std::string::npos)
    {
        const size_t p = pos + 1;
        if (p >= path.length())
            return "";
        else
            return path.substr(p);
    }
    else
        return path;
}

inline std::string dirname(const std::string &path)
{
    const size_t pos = path.find_last_of(dirsep);
    if (pos != std::string::npos)
    {
        if (pos == 0)
            return "/";
        else
            return path.substr(0, pos);
    }
    else
        return "";
}

// return true if path is a regular file that doesn't try to traverse via ".." or "/..."
inline bool is_contained(const std::string &path)
{
    if (path.empty())
        return false;
    if (win_dev(path, false))
        return false;
    if (is_dirsep(path[0]))
        return false;

    // look for ".." in path
    enum State
    {
        SEP,        // immediately after separator
        MID,        // middle of dir
        DOT_2,      // looking for second '.'
        POST_DOT_2, // after ".."
    };
    State state = SEP;
    for (const auto c : path)
    {
        switch (state)
        {
        case SEP:
            if (c == '.')
                state = DOT_2;
            else if (!is_dirsep(c))
                state = MID;
            break;
        case MID:
            if (is_dirsep(c))
                state = SEP;
            break;
        case DOT_2:
            if (c == '.')
                state = POST_DOT_2;
            else if (is_dirsep(c))
                state = SEP;
            else
                state = MID;
            break;
        case POST_DOT_2:
            if (is_dirsep(c))
                return false;
            state = MID;
            break;
        }
    }
    return state != POST_DOT_2;
}

inline std::string ext(const std::string &basename)
{
    const size_t pos = basename.find_last_of('.');
    if (pos != std::string::npos)
    {
        const size_t p = pos + 1;
        if (p >= basename.length())
            return "";
        else
            return basename.substr(p);
    }
    else
        return "";
}

inline std::string root(const std::string &basename)
{
    const size_t pos = basename.find_last_of('.');
    if (pos != std::string::npos)
        return basename.substr(0, pos);
    else
        return basename;
}

inline std::string join(const std::string &p1, const std::string &p2)
{
    if (p1.empty() || is_fully_qualified(p2))
        return p2;
    else
        return string::add_trailing_copy(p1, dirsep[0]) + p2;
}

template <typename... Args>
inline std::string join(const std::string &p1, const std::string &p2, Args... args)
{
    return join(join(p1, p2), args...);
}

} // namespace path
} // namespace openvpn

#endif // OPENVPN_COMMON_STRING_H