summaryrefslogtreecommitdiff
path: root/kvmd/plugins/msd/__init__.py
blob: 899b6f47234d1bd63b98d67d5c83bce49cbef00a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# ========================================================================== #
#                                                                            #
#    KVMD - The main Pi-KVM daemon.                                          #
#                                                                            #
#    Copyright (C) 2018  Maxim Devaev <[email protected]>                    #
#                                                                            #
#    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 <https://www.gnu.org/licenses/>.  #
#                                                                            #
# ========================================================================== #


import types

from typing import Dict
from typing import Type
from typing import AsyncGenerator

from .. import BasePlugin
from .. import get_plugin_class


# =====
class MsdError(Exception):
    pass


class MsdOperationError(MsdError):
    pass


class MsdOfflineError(MsdOperationError):
    def __init__(self) -> None:
        super().__init__("MSD is not found")


class MsdAlreadyConnectedError(MsdOperationError):
    def __init__(self) -> None:
        super().__init__("MSD is already connected to Server")


class MsdAlreadyDisconnectedError(MsdOperationError):
    def __init__(self) -> None:
        super().__init__("MSD is already disconnected from Server")


class MsdConnectedError(MsdOperationError):
    def __init__(self) -> None:
        super().__init__("MSD connected to Server, but should not")


class MsdIsBusyError(MsdOperationError):
    def __init__(self) -> None:
        super().__init__("Performing another MSD operation, please try again later")


class MsdMultiNotSupported(MsdOperationError):
    def __init__(self) -> None:
        super().__init__("This MSD does not support storing multiple images")


# =====
class BaseMsd(BasePlugin):
    def get_state(self) -> Dict:
        raise NotImplementedError

    async def poll_state(self) -> AsyncGenerator[Dict, None]:
        yield {}
        raise NotImplementedError

    async def reset(self) -> None:
        raise NotImplementedError

    async def cleanup(self) -> None:
        pass

    # =====

    async def connect(self) -> Dict:
        raise NotImplementedError

    async def disconnect(self) -> Dict:
        raise NotImplementedError

    async def select(self, name: str, cdrom: bool) -> Dict:
        raise NotImplementedError

    async def remove(self, name: str) -> Dict:
        raise NotImplementedError

    async def __aenter__(self) -> "BaseMsd":
        raise NotImplementedError

    async def write_image_info(self, name: str, complete: bool) -> None:
        raise NotImplementedError

    async def write_image_chunk(self, chunk: bytes) -> int:
        raise NotImplementedError

    async def __aexit__(
        self,
        _exc_type: Type[BaseException],
        _exc: BaseException,
        _tb: types.TracebackType,
    ) -> None:

        raise NotImplementedError


# =====
def get_msd_class(name: str) -> Type[BaseMsd]:
    return get_plugin_class("msd", name)  # type: ignore