# errors.py
# Exception classes for anaconda's storage configuration module.
#
# Copyright (C) 2009  Red Hat, Inc.
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# the GNU General Public License v.2, or (at your option) any later version.
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY expressed or implied, including the implied warranties 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., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.  Any Red Hat trademarks that are incorporated in the
# source code or documentation are not subject to the GNU General Public
# License and may only be used or replicated with the express permission of
# Red Hat, Inc.
#
# Red Hat Author(s): Dave Lehman <dlehman@redhat.com>
#

from .i18n import N_


class StorageError(Exception):

    def __init__(self, *args, **kwargs):
        self.hardware_fault = kwargs.pop("hardware_fault", False)
        super(StorageError, self).__init__(*args, **kwargs)


class NoDisksError(StorageError):
    pass

# Device


class DeviceError(StorageError):
    pass


class DeviceCreateError(DeviceError):
    pass


class DeviceDestroyError(DeviceError):
    pass


class DeviceResizeError(DeviceError):
    pass


class DeviceSetupError(DeviceError):
    pass


class DeviceTeardownError(DeviceError):
    pass


class DeviceUserDeniedFormatError(DeviceError):
    pass


class InconsistentPVSectorSize(DeviceError, ValueError):
    pass


class InconsistentParentSectorSize(InconsistentPVSectorSize, DeviceError, ValueError):
    pass

# DeviceFormat


class DeviceFormatError(StorageError):
    pass


class FormatCreateError(DeviceFormatError):
    pass


class FormatDestroyError(DeviceFormatError):
    pass


class FormatSetupError(DeviceFormatError):
    pass


class FormatTeardownError(DeviceFormatError):
    pass


class FormatResizeError(DeviceFormatError):

    def __init__(self, message, details):
        DeviceFormatError.__init__(self, message)
        self.details = details


class DMRaidMemberError(DeviceFormatError):
    pass


class MultipathMemberError(DeviceFormatError):
    pass


class FSError(DeviceFormatError):
    pass


class FSWriteLabelError(FSError):
    pass


class FSWriteUUIDError(FSError):
    pass


class FSReadLabelError(FSError):
    pass


class FSResizeError(FSError):

    def __init__(self, message, details):
        FSError.__init__(self, message)
        self.details = details


class LUKSError(DeviceFormatError):
    pass


class IntegrityError(LUKSError):
    pass


class BitLockerError(DeviceFormatError):
    pass


class MDMemberError(DeviceFormatError):
    pass


class PhysicalVolumeError(DeviceFormatError):
    pass


class SinglePhysicalVolumeError(DeviceFormatError):
    pass


class SwapSpaceError(DeviceFormatError):
    pass


class DiskLabelError(DeviceFormatError):
    pass


class InvalidDiskLabelError(DiskLabelError):
    pass


class DiskLabelCommitError(DiskLabelError):
    pass


class AlignmentError(DiskLabelError):
    pass

# devicelibs


class RaidError(StorageError):
    pass


class DMError(StorageError):
    pass


class MPathError(StorageError):
    pass


class BTRFSError(StorageError):
    pass


class BTRFSValueError(BTRFSError, ValueError):
    pass


class StratisError(StorageError):
    pass


class LoopError(StorageError):
    pass


class MDRaidError(StorageError):
    pass


class LVMError(StorageError):
    pass

# DeviceTree


class DeviceTreeError(StorageError):
    pass


class NoParentsError(DeviceTreeError):
    pass


class DeviceNotFoundError(StorageError):
    pass


class UnusableConfigurationError(DeviceTreeError, StorageError):
    """ User has an unusable initial storage configuration. """
    suggestion = ""

    def __init__(self, message, dev_name=None):
        super(UnusableConfigurationError, self).__init__(message)
        self.dev_name = dev_name


class DuplicateUUIDError(UnusableConfigurationError, ValueError):
    suggestion = N_("This is usually caused by cloning the device image resulting "
                    "in duplication of the UUID value which should be unique. "
                    "In that case you can either disconnect one of the devices or "
                    "reformat it.")


class DiskLabelScanError(UnusableConfigurationError):
    suggestion = N_("For some reason we were unable to locate a disklabel on a "
                    "disk that the kernel is reporting partitions on. It is "
                    "unclear what the exact problem is. Please file a bug at "
                    "http://bugzilla.redhat.com")


class CorruptGPTError(UnusableConfigurationError):
    suggestion = N_("Either restore the disklabel to a completely working "
                    "state or remove it completely.\n"
                    "Hint: parted can restore it or wipefs can remove it.")


class DuplicateVGError(UnusableConfigurationError):
    suggestion = N_("Rename one of the volume groups so the names are "
                    "distinct.\n"
                    "Hint 1: vgrename accepts UUID in place of the old name.\n"
                    "Hint 2: You can get the VG UUIDs by running "
                    "'pvs -o +vg_uuid'.")


class InvalidMultideviceSelection(UnusableConfigurationError):
    suggestion = N_("All parent devices must be selected when choosing exclusive "
                    "or ignored disks for a multipath or firmware RAID device.")


# DeviceAction


class DeviceActionError(StorageError):
    pass

# partitioning


class PartitioningError(StorageError):
    pass


class NotEnoughFreeSpaceError(StorageError):
    pass

# udev


class UdevError(StorageError):
    pass

# fstab


class UnrecognizedFSTabEntryError(StorageError):
    pass


class FSTabTypeMismatchError(StorageError):
    pass

# factories


class DeviceFactoryError(StorageError):
    pass


class AvailabilityError(StorageError):

    """ Raised if problem determining availability of external resource. """


class EventManagerError(StorageError):
    pass


class EventParamError(StorageError):
    pass

# external dependencies


class DependencyError(StorageError):
    """Raised when an external dependency is missing or not available"""


class EventHandlingError(StorageError):
    pass


class ThreadError(StorageError):
    """ An error occurred in a non-main thread. """

# other


class FCoEError(StorageError, OSError):
    pass


class ISCSIError(StorageError, OSError):
    pass


class NVMeError(StorageError, OSError):
    pass


class GPTVolUUIDError(StorageError):
    pass
