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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
#
# Copyright 2002 Ben Escoto <ben@emerose.org>
# Copyright 2007 Kenneth Loafman <kenneth@loafman.com>
#
# This file is part of duplicity.
#
# Duplicity 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 2 of the License, or (at your
# option) any later version.
#
# Duplicity 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 duplicity; if not, write to the Free Software Foundation,
# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Manage temporary files"""
import os
import sys
from duplicity import log
from duplicity import util
from duplicity import path
from duplicity import file_naming
from duplicity import tempdir
from duplicity import globals
from duplicity import gpg
def new_temppath():
"""
Return a new TempPath
"""
filename = tempdir.default().mktemp()
return TempPath(filename)
class TempPath(path.Path):
"""
Path object used as a temporary file
"""
def delete(self):
"""
Forget and delete
"""
path.Path.delete(self)
tempdir.default().forget(self.name)
def open_with_delete(self, mode):
"""
Returns a fileobj. When that is closed, delete file
"""
fh = FileobjHooked(path.Path.open(self, mode))
fh.addhook(self.delete)
return fh
def get_fileobj_duppath(dirpath, partname, permname, remname, overwrite=False):
"""
Return a file object open for writing, will write to filename
Data will be processed and written to a temporary file. When the
return fileobject is closed, rename to final position. filename
must be a recognizable duplicity data file.
"""
if not globals.restart:
td = tempdir.TemporaryDirectory(dirpath.name)
tdpname = td.mktemp()
tdp = TempDupPath(tdpname, parseresults=file_naming.parse(partname))
fh = FileobjHooked(tdp.filtered_open("wb"), tdp=tdp, dirpath=dirpath,
partname=partname, permname=permname, remname=remname)
else:
dp = path.DupPath(dirpath.name, index=(partname,))
mode = "ab"
if overwrite:
mode = "wb"
fh = FileobjHooked(dp.filtered_open(mode), tdp=None, dirpath=dirpath,
partname=partname, permname=permname, remname=remname)
def rename_and_forget():
tdp.rename(dirpath.append(partname))
td.forget(tdpname)
if not globals.restart:
fh.addhook(rename_and_forget)
return fh
def new_tempduppath(parseresults):
"""
Return a new TempDupPath, using settings from parseresults
"""
filename = tempdir.default().mktemp()
return TempDupPath(filename, parseresults=parseresults)
class TempDupPath(path.DupPath):
"""
Like TempPath, but build around DupPath
"""
def delete(self):
"""
Forget and delete
"""
path.DupPath.delete(self)
tempdir.default().forget(self.name)
def filtered_open_with_delete(self, mode):
"""
Returns a filtered fileobj. When that is closed, delete file
"""
fh = FileobjHooked(path.DupPath.filtered_open(self, mode))
fh.addhook(self.delete)
return fh
def open_with_delete(self, mode="rb"):
"""
Returns a fileobj. When that is closed, delete file
"""
assert mode == "rb" # Why write a file and then close it immediately?
fh = FileobjHooked(path.DupPath.open(self, mode))
fh.addhook(self.delete)
return fh
class FileobjHooked:
"""
Simulate a file, but add hook on close
"""
def __init__(self, fileobj, tdp=None, dirpath=None,
partname=None, permname=None, remname=None):
"""
Initializer. fileobj is the file object to simulate
"""
self.fileobj = fileobj # the actual file object
self.closed = False # True if closed
self.hooklist = [] # filled later with thunks to run on close
self.tdp = tdp # TempDupPath object
self.dirpath = dirpath # path to directory
self.partname = partname # partial filename
self.permname = permname # permanent filename
self.remname = remname # remote filename
def write(self, buf):
"""
Write fileobj, return result of write()
"""
return self.fileobj.write(buf)
def flush(self):
"""
Flush fileobj and force sync.
"""
self.fileobj.flush()
os.fsync(self.fileobj.fileno())
def to_partial(self):
"""
We have achieved the first checkpoint, make file visible and permanent.
"""
assert not globals.restart
self.tdp.rename(self.dirpath.append(self.partname))
self.fileobj.flush()
del self.hooklist[0]
def to_remote(self):
"""
We have written the last checkpoint, now encrypt or compress
and send a copy of it to the remote for final storage.
"""
pr = file_naming.parse(self.remname)
src = self.dirpath.append(self.partname)
tgt = self.dirpath.append(self.remname)
src_iter = SrcIter(src)
if pr.compressed:
gpg.GzipWriteFile(src_iter, tgt.name, size=sys.maxsize)
elif pr.encrypted:
gpg.GPGWriteFile(src_iter, tgt.name, globals.gpg_profile, size=sys.maxsize)
else:
os.system("cp -p \"%s\" \"%s\"" % (src.name, tgt.name))
globals.backend.move(tgt) # @UndefinedVariable
def to_final(self):
"""
We are finished, rename to final, gzip if needed.
"""
src = self.dirpath.append(self.partname)
tgt = self.dirpath.append(self.permname)
src_iter = SrcIter(src)
pr = file_naming.parse(self.permname)
if pr.compressed:
gpg.GzipWriteFile(src_iter, tgt.name, size=sys.maxsize)
os.unlink(src.name)
else:
os.rename(src.name, tgt.name)
def read(self, length=-1):
"""
Read fileobj, return result of read()
"""
return self.fileobj.read(length)
def tell(self):
"""
Returns current location of fileobj
"""
return self.fileobj.tell()
def seek(self, offset):
"""
Seeks to a location of fileobj
"""
return self.fileobj.seek(offset)
def close(self):
"""
Close fileobj, running hooks right afterwards
"""
assert not self.fileobj.close()
for hook in self.hooklist:
hook()
def addhook(self, hook):
"""
Add hook (function taking no arguments) to run upon closing
"""
self.hooklist.append(hook)
def get_name(self):
"""
Return the name of the file
"""
return self.fileobj.name
name = property(get_name)
class Block:
"""
Data block to return from SrcIter
"""
def __init__(self, data):
self.data = data
class SrcIter:
"""
Iterate over source and return Block of data.
"""
def __init__(self, src):
self.src = src
self.fp = src.open("rb")
def next(self):
try:
res = Block(self.fp.read(self.get_read_size()))
except Exception:
log.FatalError(_("Failed to read %s: %s") %
(util.ufn(self.src.name), sys.exc_info()),
log.ErrorCode.generic)
if not res.data:
self.fp.close()
raise StopIteration
return res
def get_read_size(self):
return 128 * 1024
def get_footer(self):
return ""
|