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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
"""
Copyright (C) 2023 Michael Ablassmeier <abi@grinser.de>
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 os
import sys
import zlib
import zipfile
import logging
import time
import builtins
from typing import IO, Union, Tuple, Any
from libvirtnbdbackup.output import exceptions
if sys.version_info >= (3, 8):
from typing import Literal
else:
from typing_extensions import Literal
log = logging.getLogger("output")
class target:
"""Directs output stream to either regular directory or
zipfile. If other formats are added class should be
used as generic wrapper for open()/write()/close() functions.
"""
class Directory:
"""Backup to target directory"""
def __init__(self) -> None:
self.fileHandle: IO[Any]
self.chksum: int = 1
def create(self, targetDir) -> None:
"""Create wrapper"""
log.debug("Create: %s", targetDir)
if os.path.exists(targetDir):
if not os.path.isdir(targetDir):
raise exceptions.OutputCreateDirectory(
"Specified target is a file, not a directory"
)
if not os.path.exists(targetDir):
try:
os.makedirs(targetDir)
except OSError as e:
raise exceptions.OutputCreateDirectory(
f"Failed to create target directory: [{e}]"
)
def open(
self,
targetFile: str,
mode: Union[
Literal["w"], Literal["wb"], Literal["rb"], Literal["r"]
] = "wb",
) -> IO[Any]:
"""Open target file"""
try:
# pylint: disable=unspecified-encoding,consider-using-with
self.fileHandle = builtins.open(targetFile, mode)
return self.fileHandle
except OSError as e:
raise exceptions.OutputOpenException(
f"Opening target file [{targetFile}] failed: {e}"
) from e
def write(self, data: bytes) -> int:
"""Write wrapper"""
self.chksum = zlib.adler32(data, self.chksum)
written = self.fileHandle.write(data)
assert written == len(data)
return written
def read(self, size=-1) -> int:
"""Read wrapper"""
return self.fileHandle.read(size)
def flush(self) -> None:
"""Flush wrapper"""
return self.fileHandle.flush()
def truncate(self, size: int) -> None:
"""Truncate target file"""
try:
self.fileHandle.truncate(size)
self.fileHandle.seek(0)
except OSError as e:
raise exceptions.OutputException(
f"Failed to truncate target file: [{e}]"
) from e
def close(self) -> None:
"""Close wrapper"""
log.debug("Close file")
self.fileHandle.close()
def seek(self, tgt: int, whence: int = 0) -> int:
"""Seek wrapper"""
return self.fileHandle.seek(tgt, whence)
def checksum(self) -> int:
"""Return computed checksum"""
cur = self.chksum
self.chksum = 1
return cur
class Zip:
"""Backup to zip file"""
def __init__(self) -> None:
self.zipStream: zipfile.ZipFile
self.zipFileStream: IO[bytes]
log.info("Writing zip file stream to stdout")
try:
# pylint: disable=consider-using-with
self.zipStream = zipfile.ZipFile(
sys.stdout.buffer, "x", zipfile.ZIP_STORED
)
except zipfile.error as e:
raise exceptions.OutputOpenException(
f"Failed to open zip file: {e}"
) from e
def create(self, targetDir) -> None:
"""Create wrapper"""
log.debug("Create: %s", targetDir)
target.Directory().create(targetDir)
def open(self, fileName: str, mode: Literal["w"] = "w") -> IO[bytes]:
"""Open wrapper"""
zipFile = zipfile.ZipInfo(
filename=os.path.basename(fileName),
)
dateTime: time.struct_time = time.localtime(time.time())
timeStamp: Tuple[int, int, int, int, int, int] = (
dateTime.tm_year,
dateTime.tm_mon,
dateTime.tm_mday,
dateTime.tm_hour,
dateTime.tm_min,
dateTime.tm_sec,
)
zipFile.date_time = timeStamp
zipFile.compress_type = zipfile.ZIP_STORED
try:
# pylint: disable=consider-using-with
self.zipFileStream = self.zipStream.open(
zipFile, mode, force_zip64=True
)
return self.zipFileStream
except zipfile.error as e:
raise exceptions.OutputOpenException(
f"Failed to open zip stream: {e}"
) from e
return False
def truncate(self, size: int) -> None:
"""Truncate target file"""
raise RuntimeError("Not implemented")
def write(self, data: bytes) -> int:
"""Write wrapper"""
return self.zipFileStream.write(data)
def close(self) -> None:
"""Close wrapper"""
log.debug("Close file")
self.zipFileStream.close()
def checksum(self) -> None:
"""Checksum: not implemented for zip file"""
return
|
