summaryrefslogtreecommitdiff
path: root/obnamlib/fmt_ga/format.py
blob: 5314ac53e39dc77f258ac05cd8576db9a7c516a1 (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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# Copyright 2015-2016  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/>.
#
# =*= License: GPL-3+ =*=


import obnamlib


GREEN_ALBATROSS_VERSION = 'green-albatross-20160813'


class RepositoryFormatGA(obnamlib.RepositoryDelegator):

    format = GREEN_ALBATROSS_VERSION

    def __init__(self, **kwargs):
        obnamlib.RepositoryDelegator.__init__(self, **kwargs)

        self.set_client_list_object(obnamlib.GAClientList())
        self.set_client_factory(self._client_factory)

        self.set_chunk_indexes_object(obnamlib.GAChunkIndexes())
        self._checksum_algorithm = kwargs['checksum_algorithm']
        self._chunk_indexes.set_default_checksum_algorithm(
            kwargs['checksum_algorithm'])

        chunk_store = obnamlib.GAChunkStore()
        if 'chunk_size' in kwargs:  # pragma: no cover
            chunk_store.set_max_chunk_size(kwargs['chunk_size'])
        if 'chunk_cache_size' in kwargs:  # pragma: no cover
            chunk_store.set_chunk_cache_size(kwargs['chunk_cache_size'])
        self.set_chunk_store_object(chunk_store)

    def _client_factory(self, client_name):
        client = obnamlib.GAClient(client_name)
        client.set_default_checksum_algorithm(self._checksum_algorithm)
        return client

    def init_repo(self):
        pass

    def close(self):
        pass

    def get_fsck_work_items(self):
        return []

    def get_shared_directories(self):
        return ['client-list', 'chunk-store', 'chunk-indexes']

    #
    # Per-client methods.
    #

    def get_allowed_client_keys(self):
        return []

    def get_client_key(self, client_name, key):  # pragma: no cover
        raise obnamlib.RepositoryClientKeyNotAllowed(
            format=self.format,
            client_name=client_name,
            key_name=obnamlib.repo_key_name(key))

    def set_client_key(self, client_name, key, value):
        raise obnamlib.RepositoryClientKeyNotAllowed(
            format=self.format,
            client_name=client_name,
            key_name=obnamlib.repo_key_name(key))

    def get_client_extra_data_directory(self, client_name):  # pragma: no cover
        if client_name not in self.get_client_names():
            raise obnamlib.RepositoryClientDoesNotExist(
                client_name=client_name)
        return self._client_list.get_client_dirname(client_name)

    def get_allowed_generation_keys(self):
        return [
            obnamlib.REPO_GENERATION_TEST_KEY,
            obnamlib.REPO_GENERATION_STARTED,
            obnamlib.REPO_GENERATION_ENDED,
            obnamlib.REPO_GENERATION_IS_CHECKPOINT,
            obnamlib.REPO_GENERATION_FILE_COUNT,
            obnamlib.REPO_GENERATION_TOTAL_DATA,
            ]

    def get_allowed_file_keys(self):
        return [
            obnamlib.REPO_FILE_TEST_KEY,
            obnamlib.REPO_FILE_MODE,
            obnamlib.REPO_FILE_MTIME_SEC,
            obnamlib.REPO_FILE_MTIME_NSEC,
            obnamlib.REPO_FILE_ATIME_SEC,
            obnamlib.REPO_FILE_ATIME_NSEC,
            obnamlib.REPO_FILE_NLINK,
            obnamlib.REPO_FILE_SIZE,
            obnamlib.REPO_FILE_UID,
            obnamlib.REPO_FILE_USERNAME,
            obnamlib.REPO_FILE_GID,
            obnamlib.REPO_FILE_GROUPNAME,
            obnamlib.REPO_FILE_SYMLINK_TARGET,
            obnamlib.REPO_FILE_XATTR_BLOB,
            obnamlib.REPO_FILE_BLOCKS,
            obnamlib.REPO_FILE_DEV,
            obnamlib.REPO_FILE_INO,
            obnamlib.REPO_FILE_SHA224,
            obnamlib.REPO_FILE_SHA256,
            obnamlib.REPO_FILE_SHA384,
            obnamlib.REPO_FILE_SHA512,
        ]

    def interpret_generation_spec(self, client_name, genspec):
        ids = self.get_client_generation_ids(client_name)
        if not ids:
            raise obnamlib.RepositoryClientHasNoGenerations(
                client_name=client_name)

        if genspec == 'latest':
            return ids[-1]

        for gen_id in ids:
            if self.make_generation_spec(gen_id) == genspec:
                return gen_id

        raise obnamlib.RepositoryGenerationDoesNotExist(
            client_name=client_name, gen_id=genspec)

    def make_generation_spec(self, generation_id):
        return generation_id.gen_number