src/base/utils/fs.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2022-2024  Vladimir Golovnev <glassez@yandex.ru>
   4  * Copyright (C) 2012  Christophe Dumez <chris@qbittorrent.org>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  *
  20  * In addition, as a special exception, the copyright holders give permission to
  21  * link this program with the OpenSSL project's "OpenSSL" library (or with
  22  * modified versions of it that use the same license as the "OpenSSL" library),
  23  * and distribute the linked executables. You must obey the GNU General Public
  24  * License in all respects for all of the code used other than "OpenSSL".  If you
  25  * modify file(s), you may extend this exception to your version of the file(s),
  26  * but you are not obligated to do so. If you do not wish to do so, delete this
  27  * exception statement from your version.
  28  */
  29
  30 #pragma once
  31
  32 /**
  33  * Utility functions related to file system.
  34  */
  35
  36 #include <QString>
  37
  38 #include "base/3rdparty/expected.hpp"
  39 #include "base/global.h"
  40 #include "base/pathfwd.h"
  41
  42 class QDateTime;
  43
  44 namespace Utils::Fs
  45 {
  46     qint64 computePathSize(const Path &path);
  47     qint64 freeDiskSpaceOnPath(const Path &path);
  48
  49     bool isRegularFile(const Path &path);
  50     bool isDir(const Path &path);
  51     bool isReadable(const Path &path);
  52     bool isWritable(const Path &path);
  53     bool isNetworkFileSystem(const Path &path);
  54     QDateTime lastModified(const Path &path);
  55     bool sameFiles(const Path &path1, const Path &path2);
  56
  57     QString toValidFileName(const QString &name, const QString &pad = u" "_s);
  58     Path toValidPath(const QString &name, const QString &pad = u" "_s);
  59     Path toAbsolutePath(const Path &path);
  60     Path toCanonicalPath(const Path &path);
  61
  62     bool copyFile(const Path &from, const Path &to);
  63     bool renameFile(const Path &from, const Path &to);
  64     nonstd::expected<void, QString> removeFile(const Path &path);
  65     nonstd::expected<void, QString> moveFileToTrash(const Path &path);
  66     bool mkdir(const Path &dirPath);
  67     bool mkpath(const Path &dirPath);
  68     bool rmdir(const Path &dirPath);
  69     void removeDirRecursively(const Path &path);
  70     bool smartRemoveEmptyFolderTree(const Path &path);
  71
  72     Path homePath();
  73     Path tempPath();
  74 }