aboutsummaryrefslogtreecommitdiff
path: root/paludis/util/fs_path.cc
blob: b3857eab0fd7f74cc2e52ee2b4266c37491b5824 (plain)
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2010, 2011 Ciaran McCreesh
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis 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., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include <paludis/util/fs_path.hh>
#include <paludis/util/fs_error.hh>
#include <paludis/util/fs_stat.hh>
#include <paludis/util/pimp-impl.hh>
#include <paludis/util/exception.hh>
#include <paludis/util/stringify.hh>
#include <paludis/util/options.hh>
#include <paludis/util/timestamp.hh>
#include <paludis/util/log.hh>
#include <paludis/util/sequence-impl.hh>
#include <paludis/util/set-impl.hh>
#include <paludis/util/wrapped_output_iterator-impl.hh>
#include <paludis/util/wrapped_forward_iterator-impl.hh>

#include <cstdio>
#include <string>
#include <climits>
#include <cstdlib>
#include <cstring>
#include <errno.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <fcntl.h>
#include <unistd.h>

#include "config.h"

using namespace paludis;

namespace paludis
{
    template <>
    struct Imp<FSPath>
    {
        std::string path;

        Imp(const std::string & p) :
            path(p)
        {
        }
    };
}

FSPath::FSPath(const std::string & path) :
    _imp(path)
{
    _normalise();
}

FSPath::FSPath(const FSPath & other) :
    _imp(other._imp->path)
{
}

FSPath::~FSPath() = default;

FSStat
FSPath::stat() const
{
    return FSStat(*this);
}

FSPath &
FSPath::operator= (const FSPath & other)
{
    _imp->path = other._imp->path;
    return *this;
}

FSPath &
FSPath::operator/= (const FSPath & rhs)
{
    if (rhs._imp->path == "/")
        return *this;

    if (_imp->path.empty() || '/' != _imp->path.at(_imp->path.length() - 1))
        _imp->path.append("/");

    if (! rhs._imp->path.empty())
    {
        if ('/' == rhs._imp->path.at(0))
            _imp->path.append(rhs._imp->path.substr(1));
        else
            _imp->path.append(rhs._imp->path);
    }

    return *this;
}

FSPath &
FSPath::operator/= (const std::string & rhs)
{
    return operator/= (FSPath(rhs));
}

FSPath
FSPath::operator/ (const FSPath & rhs) const
{
    FSPath result(*this);
    result /= rhs;
    return result;
}

FSPath
FSPath::operator/ (const std::string & rhs) const
{
    return *this / FSPath(rhs);
}

bool
paludis::operator== (const FSPath & me, const FSPath & other)
{
    return me._imp->path == other._imp->path;
}

bool
paludis::operator!= (const FSPath & me, const FSPath & other)
{
    return ! operator== (me, other);
}

void
FSPath::_normalise()
{
    try
    {
        if (std::string::npos != _imp->path.find("//"))
        {
            std::string new_path;
            std::string::size_type p(0);
            while (p < _imp->path.length())
            {
                if ('/' == _imp->path[p])
                {
                    new_path += '/';
                    while (++p < _imp->path.length())
                        if ('/' != _imp->path[p])
                            break;
                }
                else
                    new_path += _imp->path[p++];
            }
            _imp->path = new_path;
        }

        if (! _imp->path.empty())
            if ('/' == _imp->path.at(_imp->path.length() - 1))
                _imp->path.erase(_imp->path.length() - 1);
        if (_imp->path.empty())
            _imp->path = "/";
    }
    catch (const std::exception & e)
    {
        Context c("When normalising FSPath path '" + _imp->path + "':");
        throw InternalError(PALUDIS_HERE,
                "caught std::exception '" + stringify(e.what()) + "'");
    }
}

const std::string
FSPath::basename() const
{
    if (_imp->path == "/")
        return _imp->path;

    return _imp->path.substr(_imp->path.rfind('/') + 1);
}

FSPath
FSPath::strip_leading(const FSPath & f) const
{
    std::string root(stringify(f));

    if (root == "/")
        root.clear();
    if (0 != _imp->path.compare(0, root.length(), root))
        throw FSError("Can't strip leading '" + root + "' from FSPath '" + _imp->path + "'");
    return FSPath(_imp->path.substr(root.length()));
}

bool
FSPath::starts_with(const FSPath & f) const
{
    std::string root(stringify(f));

    if (root == "/")
        root.clear();
    root.append("/");
    return 0 == (_imp->path + "/").compare(0, root.length(), root);
}

FSPath
FSPath::dirname() const
{
    if (_imp->path == "/")
        return FSPath(_imp->path);

    return FSPath(_imp->path.substr(0, _imp->path.rfind('/')));
}

FSPath
FSPath::realpath() const
{
    Context context("When fetching realpath of '" + stringify(_imp->path) + "':");

#ifdef HAVE_CANONICALIZE_FILE_NAME
    char * r(canonicalize_file_name(_imp->path.c_str()));
    if (! r)
        throw FSError("Could not resolve path '" + _imp->path + "'");
    FSPath result(r);
    std::free(r);
    return result;
#else
    char r[PATH_MAX + 1];
    std::memset(r, 0, PATH_MAX + 1);
    if (! exists())
        throw FSError("Could not resolve path '" + _imp->path + "'");
    if (! ::realpath(_imp->path.c_str(), r))
        throw FSError("Could not resolve path '" + _imp->path + "'");
    FSPath result(r);
    if (! result.exists())
        throw FSError("Could not resolve path '" + _imp->path + "'");
    return result;
#endif
}

FSPath
FSPath::realpath_if_exists() const
{
    Context context("When fetching realpath of '" + stringify(_imp->path) + "', if it exists:");

#ifdef HAVE_CANONICALIZE_FILE_NAME
    char * r(canonicalize_file_name(_imp->path.c_str()));
    if (! r)
        return *this;
    FSPath result(r);
    std::free(r);
    return result;
#else
    char r[PATH_MAX + 1];
    std::memset(r, 0, PATH_MAX + 1);
    if (! exists())
        return *this;
    if (! ::realpath(_imp->path.c_str(), r))
        return *this;
    FSPath result(r);
    if (! result.exists())
        return *this;
    return result;
#endif
}

FSPath
FSPath::cwd()
{
    char r[PATH_MAX + 1];
    std::memset(r, 0, PATH_MAX + 1);
    if (! ::getcwd(r, PATH_MAX))
        throw FSError("Could not get current working directory");
    return FSPath(r);
}

std::ostream &
paludis::operator<< (std::ostream & s, const FSPath & f)
{
    s << f._imp->path;
    return s;
}

bool
FSPath::mkdir(const mode_t mode, const FSPathMkdirOptions & options) const
{
    if (0 == ::mkdir(_imp->path.c_str(), mode))
        return true;

    int e(errno);
    if (e == EEXIST && options[fspmkdo_ok_if_exists])
    {
        if (stat().is_directory())
            return false;
        throw FSError("mkdir '" + _imp->path + "' failed: target exists and is not a directory");
    }
    else
        throw FSError("mkdir '" + _imp->path + "' failed: " + ::strerror(e));
}

bool
FSPath::symlink(const std::string & target) const
{
    if (0 == ::symlink(target.c_str(), _imp->path.c_str()))
        return true;

    int e(errno);
    if (e == EEXIST)
    {
        if (stat().is_symlink() && target == readlink())
            return false;
        throw FSError("symlink '" + _imp->path + "' to '" + target + "' failed: target exists");
    }
    else
        throw FSError("symlink '" + _imp->path + "' to '" + target + "' failed: " + ::strerror(e));
}

bool
FSPath::unlink() const
{
#ifdef HAVE_LCHFLAGS
    if (0 != ::lchflags(_imp->path.c_str(), 0))
    {
        int e(errno);
        if (e != ENOENT)
            throw FSError("lchflags for unlink '" + _imp->path + "' failed: " + ::strerror(e));
    }
#endif

    if (0 == ::unlink(_imp->path.c_str()))
        return true;

    int e(errno);
    if (e == ENOENT)
        return false;
    else
        throw FSError("unlink '" + _imp->path + "' failed: " + ::strerror(e));
}

bool
FSPath::rmdir() const
{
    if (0 == ::rmdir(_imp->path.c_str()))
        return true;

    int e(errno);
    if (e == ENOENT)
        return false;
    else
        throw FSError("rmdir '" + _imp->path + "' failed: " + ::strerror(e));
}

bool
FSPath::utime(const Timestamp & t) const
{
    Context context("When setting utime for '" + stringify(_imp->path) + "':");

#ifdef HAVE_UTIMENSAT
    static bool utimensat_works(true);

    if (utimensat_works)
    {
        struct timespec ts[2] = { t.as_timespec(), t.as_timespec() };
        if (0 == ::utimensat(AT_FDCWD, _imp->path.c_str(), ts, 0))
            return true;

        int e(errno);
        if (e == ENOENT)
            return false;
        else if (e == ENOSYS)
        {
            utimensat_works = false;
            Log::get_instance()->message("util.fs_entry.utime.utimensat_unimplemented", ll_debug, lc_context)
                << "utimensat(2) not implemented by this kernel, using utimes(2)";
        }
        else
            throw FSError("utimensat '" + _imp->path + "' failed: " + ::strerror(e));
    }
#endif

    struct timeval tv[2] = { t.as_timeval(), t.as_timeval() };
    if (0 == ::utimes(_imp->path.c_str(), tv))
        return true;

    int e(errno);
    if (e == ENOENT)
        return false;
    else
        throw FSError("utimes '" + _imp->path + "' failed: " + ::strerror(e));
}

std::string
FSPath::readlink() const
{
    char buf[PATH_MAX + 1];
    std::memset(buf, 0, PATH_MAX + 1);
    if (-1 == ::readlink(_imp->path.c_str(), buf, PATH_MAX))
        throw FSError("readlink '" + _imp->path + "' failed: " + ::strerror(errno));
    return buf;
}

void
FSPath::chown(const uid_t new_owner, const gid_t new_group) const
{
    if (0 != ::chown(_imp->path.c_str(), new_owner, new_group))
        throw FSError("chown '" + _imp->path + "' to '" + stringify(new_owner) + "', '"
                + stringify(new_group) + "' failed: " + ::strerror(errno));
}

void
FSPath::lchown(const uid_t new_owner, const gid_t new_group) const
{
    if (0 != ::lchown(_imp->path.c_str(), new_owner, new_group))
        throw FSError("lchown '" + _imp->path + "' to '" + stringify(new_owner) + "', '"
                + stringify(new_group) + "' failed: " + ::strerror(errno));
}

void
FSPath::chmod(const mode_t mode) const
{
    if (0 != ::chmod(_imp->path.c_str(), mode))
        throw FSError("chmod '" + _imp->path + "' failed: " + ::strerror(errno));
}

void
FSPath::rename(const FSPath & new_name) const
{
    if (0 != std::rename(_imp->path.c_str(), new_name._imp->path.c_str()))
        throw FSError("rename('" + stringify(_imp->path) + "', '" + stringify(new_name._imp->path) + "') failed: " +
                ::strerror(errno));
}

bool
FSPathComparator::operator() (const FSPath & a, const FSPath & b) const
{
    return stringify(a) < stringify(b);
}

namespace paludis
{
    template class PALUDIS_VISIBLE Sequence<FSPath>;
    template class PALUDIS_VISIBLE WrappedForwardIterator<Sequence<FSPath>::ConstIteratorTag, const FSPath>;
    template class PALUDIS_VISIBLE WrappedForwardIterator<Sequence<FSPath>::ReverseConstIteratorTag, const FSPath>;
    template class PALUDIS_VISIBLE WrappedOutputIterator<Sequence<FSPath>::InserterTag, FSPath>;

    template class PALUDIS_VISIBLE Set<FSPath, FSPathComparator>;
    template class PALUDIS_VISIBLE WrappedForwardIterator<Set<FSPath, FSPathComparator>::ConstIteratorTag, const FSPath>;

    template class Pimp<FSPath>;
}