kpmcore/src/fs/filesystem.h

245 lines
8.8 KiB
C++

/*************************************************************************
* Copyright (C) 2012 by Volker Lanz <vl@fidra.de> *
* Copyright (C) 2015 by Teo Mrnjavac <teo@kde.org> *
* Copyright (C) 2016 by Andrius Štikonas <andrius@stikonas.eu> *
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License as *
* published by the Free Software Foundation; either version 3 of *
* the License, or (at your option) any later version. *
* *
* 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 General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>.*
*************************************************************************/
#if !defined(FILESYSTEM__H)
#define FILESYSTEM__H
#include "util/libpartitionmanagerexport.h"
#include <QtGlobal>
#include <QColor>
#include <QStringList>
#include <QString>
#include <QList>
#include <QUrl>
#include <array>
class Device;
class Report;
/** Base class for all FileSystems.
Represents a file system and handles support for various types of operations that can
be performed on those.
@author Volker Lanz <vl@fidra.de>
*/
class LIBKPMCORE_EXPORT FileSystem
{
Q_DISABLE_COPY(FileSystem)
public:
class SupportTool
{
public:
explicit SupportTool(const QString& n = QString(), const QUrl& u = QUrl()) : name(n), url(u) {}
const QString name;
const QUrl url;
};
/** Supported FileSystem types */
enum Type {
Unknown = 0,
Extended = 1,
Ext2 = 2,
Ext3 = 3,
Ext4 = 4,
LinuxSwap = 5,
Fat16 = 6,
Fat32 = 7,
Ntfs = 8,
ReiserFS = 9,
Reiser4 = 10,
Xfs = 11,
Jfs = 12,
Hfs = 13,
HfsPlus = 14,
Ufs = 15,
Unformatted = 16,
Btrfs = 17,
Hpfs = 18,
Luks = 19,
Ocfs2 = 20,
Zfs = 21,
Exfat = 22,
Nilfs2 = 23,
Lvm2_PV = 24,
F2fs = 25,
__lastType = 26
};
/** The type of support for a given FileSystem action */
enum CommandSupportType {
cmdSupportNone = 0, /**< no support */
cmdSupportCore = 1, /**< internal support */
cmdSupportFileSystem = 2, /**< supported by some external command */
cmdSupportBackend = 4 /**< supported by the backend */
};
static const std::array< QColor, __lastType > defaultColorCode;
Q_DECLARE_FLAGS(CommandSupportTypes, CommandSupportType)
protected:
FileSystem(qint64 firstsector, qint64 lastsector, qint64 sectorsused, const QString& label, FileSystem::Type t);
public:
virtual ~FileSystem() {}
public:
virtual qint64 readUsedCapacity(const QString& deviceNode) const;
virtual QString readLabel(const QString& deviceNode) const;
virtual bool create(Report& report, const QString& deviceNode) const;
virtual bool resize(Report& report, const QString& deviceNode, qint64 newLength) const;
virtual bool move(Report& report, const QString& deviceNode, qint64 newStartSector) const;
virtual bool writeLabel(Report& report, const QString& deviceNode, const QString& newLabel);
virtual bool copy(Report& report, const QString& targetDeviceNode, const QString& sourceDeviceNode) const;
virtual bool backup(Report& report, const Device& sourceDevice, const QString& deviceNode, const QString& filename) const;
virtual bool remove(Report& report, const QString& deviceNode) const;
virtual bool check(Report& report, const QString& deviceNode) const;
virtual bool updateUUID(Report& report, const QString& deviceNode) const;
virtual QString readUUID(const QString& deviceNode) const;
virtual bool updateBootSector(Report& report, const QString& deviceNode) const;
virtual CommandSupportType supportGetUsed() const {
return cmdSupportNone; /**< @return CommandSupportType for getting used capacity */
}
virtual CommandSupportType supportGetLabel() const {
return cmdSupportNone; /**< @return CommandSupportType for reading label*/
}
virtual CommandSupportType supportCreate() const {
return cmdSupportNone; /**< @return CommandSupportType for creating */
}
virtual CommandSupportType supportGrow() const {
return cmdSupportNone; /**< @return CommandSupportType for growing */
}
virtual CommandSupportType supportShrink() const {
return cmdSupportNone; /**< @return CommandSupportType for shrinking */
}
virtual CommandSupportType supportMove() const {
return cmdSupportNone; /**< @return CommandSupportType for moving */
}
virtual CommandSupportType supportCheck() const {
return cmdSupportNone; /**< @return CommandSupportType for checking */
}
virtual CommandSupportType supportCopy() const {
return cmdSupportNone; /**< @return CommandSupportType for copying */
}
virtual CommandSupportType supportBackup() const {
return cmdSupportNone; /**< @return CommandSupportType for backing up */
}
virtual CommandSupportType supportSetLabel() const {
return cmdSupportNone; /**< @return CommandSupportType for setting label*/
}
virtual CommandSupportType supportUpdateUUID() const {
return cmdSupportNone; /**< @return CommandSupportType for updating the UUID */
}
virtual CommandSupportType supportGetUUID() const {
return cmdSupportNone; /**< @return CommandSupportType for reading the UUID */
}
virtual qint64 minCapacity() const;
virtual qint64 maxCapacity() const;
virtual qint64 maxLabelLength() const;
virtual SupportTool supportToolName() const;
virtual bool supportToolFound() const;
virtual QString name() const;
virtual FileSystem::Type type() const {
return m_Type; /**< @return the FileSystem's type */
}
static QString nameForType(FileSystem::Type t);
static QList<FileSystem::Type> types();
static FileSystem::Type typeForName(const QString& s);
static FileSystem::Type detectFileSystem(const QString& partitionPath);
virtual bool canMount(const QString&) const {
return false; /**< @return true if this FileSystem can be mounted */
}
virtual bool canUnmount(const QString&) const {
return true; /**< @return true if this FileSystem can be unmounted */
}
virtual QString mountTitle() const;
virtual QString unmountTitle() const;
virtual bool mount(const QString& deviceNode, const QString& mountPoint);
virtual bool unmount(Report& report, const QString& deviceNode);
qint64 firstSector() const {
return m_FirstSector; /**< @return the FileSystem's first sector */
}
qint64 lastSector() const {
return m_LastSector; /**< @return the FileSystem's last sector */
}
qint64 length() const {
return lastSector() - firstSector() + 1; /**< @return the FileSystem's length */
}
void setFirstSector(qint64 s) {
m_FirstSector = s; /**< @param s the new first sector */
}
void setLastSector(qint64 s) {
m_LastSector = s; /**< @param s the new last sector */
}
void move(qint64 newStartSector);
const QString& label() const {
return m_Label; /**< @return the FileSystem's label */
}
qint64 sectorsUsed() const {
return m_SectorsUsed; /**< @return the sectors in use on the FileSystem */
}
const QString& uuid() const {
return m_UUID; /**< @return the FileSystem's UUID */
}
void setSectorsUsed(qint64 s) {
m_SectorsUsed = s; /**< @param s the new value for sectors in use */
}
void setLabel(const QString& s) {
m_Label = s; /**< @param s the new label */
}
void setUUID(const QString& s) {
m_UUID = s; /**< @param s the new UUID */
}
protected:
static bool findExternal(const QString& cmdName, const QStringList& args = QStringList(), int exptectedCode = 1);
protected:
FileSystem::Type m_Type;
qint64 m_FirstSector;
qint64 m_LastSector;
qint64 m_SectorsUsed;
QString m_Label;
QString m_UUID;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(FileSystem::CommandSupportTypes)
#endif