1

"""

     2

    Mount filesystems.

     3

"""

     4

     5

from pvl.backup.invoke import invoke, optargs, command

     6

     7

import contextlib

     8

import os, os.path

     9

import logging

    10

import tempfile

    11

    12

log = logging.getLogger('pvl.backup.mount')

    13

    14

    15

class MountError (Exception) :

    16

    pass

    17

    18

class Mount (object) :

    19

    """

    20

        Trivial filesystem mounting

    21

    """

    22

    23

    MOUNT   = '/bin/mount'

    24

    UMOUNT  = '/bin/umount'

    25

    26

    27

    def __init__ (self, dev, mnt, readonly=False, sudo=None) :

    28

        """

    29

            dev         - device path

    30

            mnt         - mount path

    31

            readonly    - mount readonly

    32

            sudo        - invoke sudo

    33

        """

    34

    35

        self.dev = dev

    36

        self.mnt = mnt

    37

        self.readonly = readonly

    38

        self.sudo = sudo

    39

    40

    @property

    41

    def path (self) :

    42

        return self.mnt

    43

    44

    def options (self) :

    45

        """

    46

            Mount options as a comma-separated string.

    47

        """

    48

    49

        options = [

    50

                ('ro' if self.readonly else None),

    51

        ]

    52

    53

        return ','.join(option for option in options if option)

    54

    55

    def open (self) :

    56

        """

    57

            Mount

    58

        """

    59

    60

        # check

    61

        if not os.path.isdir(self.mnt) :

    62

            raise MountError("Mountpoint is not a directory: {mnt}".format(mnt=self.mnt))

    63

    65

            raise MountError("Mountpoint is already mounted: {mnt}".format(mnt=self.mnt))

    66

    67

        if not os.path.exists(self.dev) :

    68

            raise MountError("Device does not exist: {dev}".format(dev=self.dev))

    69

    70

        # mount

    71

        invoke(self.MOUNT, optargs(self.dev, self.mnt, options=self.options()), sudo=self.sudo)

    72

    85

    def close (self) :

    86

        """

    87

            Un-mount

    88

        """

    89

    90

        # check

    92

            raise MountError("Mountpoint is not mounted: {mnt}".format(mnt=self.mnt))

    93

    94

        # umount

    95

        invoke(self.UMOUNT, optargs(self.mnt), sudo=self.sudo)

    96

    97

    def __repr__ (self) :

    98

        return "Mount(dev={dev}, mnt={mnt})".format(

    99

                dev     = repr(self.dev),

   100

                mnt     = repr(self.mnt),

   101

        )

   102

   103

    def __str__ (self) :

   104

        return self.mnt

   105

   106

@contextlib.contextmanager

   107

def mount (dev, mnt=None, name_hint='tmp', **kwargs) :

   108

    """

   109

        Use a temporary mount:

   110

   111

        with mount('/dev/...', readonly=True) as mount:

   112

            ...

   113

   114

        Mounts at the given mountpoint path, or a tempdir

   115

    """

   116

   117

    if mnt is None :

   118

        mnt = tmpdir = tempfile.mkdtemp(suffix='.mnt', prefix=name_hint)

   119

   120

        log.debug("using tmp mnt: %s", tmpdir)

   121

   122

    else :

   123

        tmpdir = None

   124

   125

    log.debug("mount: %s -> %s", dev, mnt)

   126

   127

    # with tempdir

   128

    try :

   129

        mount = Mount(dev, mnt, **kwargs)

   130

   131

        # open

   132

        log.debug("open: %s", mount)

   133

        mount.open()

   134

   135

        try :

   136

            log.debug("got: %s", mount)

   137

            yield mount

   138

   139

        finally:

   140

            # cleanup

   141

            log.debug("cleanup: %s", mount)

   148

   149

    finally:

   150

        if tmpdir :

   151

            # cleanup

   152

            log.debug("cleanup tmp mnt: %s", tmpdir)

   153

            os.rmdir(tmpdir)

   154