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
|
# Copyright (C) 2014 Lars Wirzenius
#
# 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 <http://www.gnu.org/licenses/>.
import json
import obnamlib
class DumpRepositoryPlugin(obnamlib.ObnamPlugin):
def enable(self):
self.app.add_subcommand(
'dump-repo', self.cmd_dump_repo, arg_synopsis='')
self.app.settings.boolean(
['dump-repo-file-metadata'],
'dump metadata about files?')
def cmd_dump_repo(self, args):
'''Dump (some) data structures from a repository.
This is a debugging aid for Obnam developers. It writes out
some of the binary data structures in a repository in JSON
format so they can be inspected by the developer for problems.
The dump is not complete, however.
'''
repo = self.app.get_repository_object()
for obj in self.dump_repository(repo):
json.dump(obj, self.app.output, indent=4)
self.app.output.write('\n')
repo.close()
def dump_repository(self, repo):
yield self.dump_client_list(repo)
yield self.dump_chunk_ids(repo)
for client_name in repo.get_client_names():
for x in self.dump_client(repo, client_name):
yield x
def dump_client_list(self, repo):
return {
'client-list': list(repo.get_client_names()),
}
def dump_chunk_ids(self, repo):
return {
'chunk-ids': list(repo.get_chunk_ids()),
}
def dump_client(self, repo, client_name):
yield {
'client-name': client_name,
'encryption-key': repo.get_client_encryption_key_id(client_name),
'client-keys': self.dump_client_keys(repo, client_name),
}
for gen_id in repo.get_client_generation_ids(client_name):
yield self.dump_generation(repo, client_name, gen_id)
def dump_client_keys(self, repo, client_name):
return dict(
(obnamlib.repo_key_name(key),
repo.get_client_key(client_name, key))
for key in repo.get_allowed_client_keys()
if key != obnamlib.REPO_CLIENT_TEST_KEY
)
def dump_client_generation_ids(self, repo, client_name):
return [
repo.make_generation_spec(gen_id)
for gen_id in repo.get_client_generation_ids(client_name)
]
def dump_generation(self, repo, client_name, gen_id):
obj = {
'client-name': client_name,
'generation-id': repo.make_generation_spec(gen_id),
'generation-keys': self.dump_generation_keys(repo, gen_id),
'generation-chunk-ids':
self.dump_generation_chunk_ids(repo, gen_id),
}
if self.app.settings['dump-repo-file-metadata']:
obj['files'] = self.dump_generation_files(repo, gen_id)
return obj
def dump_generation_keys(self, repo, gen_id):
return dict(
(obnamlib.repo_key_name(key),
repo.get_generation_key(gen_id, key))
for key in repo.get_allowed_generation_keys()
if key != obnamlib.REPO_GENERATION_TEST_KEY
)
def dump_generation_chunk_ids(self, repo, gen_id):
return repo.get_generation_chunk_ids(gen_id)
def dump_generation_files(self, repo, gen_id):
result = {}
for filename in repo.walk_generation(gen_id, '/'):
result[filename] = {
'file-chunk-ids': repo.get_file_chunk_ids(gen_id, filename),
'file-keys': self.dump_file_keys(repo, gen_id, filename),
}
return result
def dump_file_keys(self, repo, gen_id, filename):
return dict(
(obnamlib.repo_key_name(key),
repo.get_file_key(gen_id, filename, key))
for key in repo.get_allowed_file_keys()
if key != obnamlib.REPO_FILE_TEST_KEY
)
|
