Mountable.h

/*
 * Copyright (c) [2014-2015] Novell, Inc.
 * Copyright (c) [2016-2026] SUSE LLC
 *
 * All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License 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 General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, contact Novell, Inc.
 *
 * To contact Novell about this file by physical or electronic mail, you may
 * find current contact information at www.novell.com.
 */


#ifndef STORAGE_MOUNTABLE_H
#define STORAGE_MOUNTABLE_H


#include <vector>

#include "storage/Devices/Device.h"
#include "storage/Utils/Swig.h"


namespace storage
{

    class MountPoint;
    class Filesystem;


    enum class FsType {
        UNKNOWN, AUTO, REISERFS, EXT2, EXT3, EXT4, BTRFS, VFAT, XFS, JFS, HFS, NTFS,
        SWAP, HFSPLUS, NFS, NFS4, TMPFS, ISO9660, UDF, NILFS2, MINIX, NTFS3G, F2FS,
        EXFAT, BITLOCKER, VBOXSF, BCACHEFS, SQUASHFS, EROFS1 /* EROFS is a POSIX
        define */
    };


    std::string get_fs_type_name(FsType fs_type);


    enum class MountByType {

        DEVICE,

        UUID,

        LABEL,

        ID,

        PATH,

        PARTUUID,

        PARTLABEL,

    };


    std::string get_mount_by_name(MountByType mount_by_type);


    // abstract class

    class Mountable : public Device
    {
    public:

        static std::vector<Mountable*> get_all(Devicegraph* devicegraph);

        static std::vector<const Mountable*> get_all(const Devicegraph* devicegraph);

        bool supports_mount() const;

        static bool is_valid_path(FsType fs_type, const std::string& path);

        MountPoint* create_mount_point(const std::string& path);

        bool has_mount_point() const;

        MountPoint* get_mount_point();

        const MountPoint* get_mount_point() const;

        void remove_mount_point();

        bool has_filesystem() const;

        Filesystem* get_filesystem();

        const Filesystem* get_filesystem() const;

        MountByType get_mount_by() const ST_DEPRECATED;
        void set_mount_by(MountByType mount_by) ST_DEPRECATED;

        const std::vector<std::string>& get_mount_opts() const ST_DEPRECATED;
        void set_mount_opts(const std::vector<std::string>& mount_opts) ST_DEPRECATED;

        const std::vector<std::string>& get_fstab_options() const ST_DEPRECATED;
        void set_fstab_options(const std::vector<std::string>& mount_opts) ST_DEPRECATED;

    public:

        class Impl;

        Impl& get_impl();
        const Impl& get_impl() const;

    protected:

        Mountable(Impl* impl);
        ST_NO_SWIG Mountable(std::unique_ptr<Device::Impl>&& impl);

    };


    bool is_mountable(const Device* device);

    Mountable* to_mountable(Device* device);

    const Mountable* to_mountable(const Device* device);

}

#endif