setup.py 8.08 KB
Newer Older
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Copyright (C) 2015 GRNET S.A.
#
# 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/>.

16
17
18
19
import os
import threading
import logging

20
21
from functools import wraps

22
from agkyra.syncer.utils import join_path, ThreadSafeDict
23
from agkyra.syncer.database import SqliteFileStateDB
24
from agkyra.syncer.messaging import Messager
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
25
from agkyra.syncer import utils
26

27
from kamaki.clients import ClientError, KamakiSSLError
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

from kamaki.clients.astakos import AstakosClient
from kamaki.clients.pithos import PithosClient
from kamaki.clients.utils import https

logger = logging.getLogger(__name__)


DEFAULT_CACHE_NAME = '.agkyra_cache'
DEFAULT_CACHE_HIDE_NAME = 'hidden'
DEFAULT_CACHE_STAGE_NAME = 'staged'
DEFAULT_CACHE_FETCH_NAME = 'fetched'
GLOBAL_SETTINGS_NAME = '.agkyra'
DEFAULT_DBNAME = "syncer.db"
DEFAULT_ACTION_MAX_WAIT = 10
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
43
44
DEFAULT_PITHOS_LIST_INTERVAL = 5
DEFAULT_CONNECTION_RETRY_LIMIT = 3
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
45
INSTANCES_NAME = 'instances'
46
47
48
49

thread_local_data = threading.local()


Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
50
51
52
53
54
def get_instance(elems):
    data = "".join(elems)
    return utils.hash_string(data)


55
56
def ssl_fall_back(method):
    """Catch an SSL error while executing a method, patch kamaki and retry"""
57
    @wraps(method)
58
59
60
61
62
63
64
65
66
67
68
69
70
    def wrap(self, *args, **kwargs):
        try:
            return method(self, *args, **kwargs)
        except KamakiSSLError as ssle:
            logger.debug('Kamaki SSL failed %s' % ssle)
            logger.info(
                'Kamaki SSL failed, fall back to certifi (mozilla certs)')
            import certifi
            https.patch_with_certs(certifi.where())
            return method(self, *args, **kwargs)
    return wrap


Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
71
72
73
74
75
76
77
78
79
80
def check_encoding():
    platform = utils.PLATFORM
    encoding = utils.ENCODING
    if platform.startswith("linux"):
        if not encoding.lower() in ['utf-8', 'utf8']:
            raise Exception(
                "Cannot operate with encoding %s. Please use UTF-8."
                % encoding)


81
class SyncerSettings():
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
82
    def __init__(self, auth_url, auth_token, container, local_root_path,
83
                 *args, **kwargs):
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
84
85
86
87
88
        check_encoding()
        auth_url = utils.to_unicode(auth_url)
        auth_token = utils.to_unicode(auth_token)
        container = utils.to_unicode(container)
        local_root_path = utils.to_unicode(local_root_path)
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
89
        self.auth_url = utils.normalize_standard_suffix(auth_url)
90
        self.auth_token = auth_token
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
91
        self.container = utils.normalize_standard_suffix(container)
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
92
93
94
95

        self.ignore_ssl = kwargs.get("ignore_ssl", False)
        if self.ignore_ssl:
            https.patch_ignore_ssl()
96
97
98
        elif kwargs.get('ca_certs', None):
            https.patch_with_certs(kwargs['ca_certs'])

99
100
101
        self.endpoint = self._get_pithos_client(
            auth_url, auth_token, container)

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
102
        home_dir = utils.to_unicode(os.path.expanduser('~'))
103
        default_settings_path = join_path(home_dir, GLOBAL_SETTINGS_NAME)
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
104
105
        self.settings_path = utils.to_unicode(
            kwargs.get("agkyra_path", default_settings_path))
106
        self.create_dir(self.settings_path)
107

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
108
109
110
111
112
113
114
115
116
117
118
        self.instances_path = join_path(self.settings_path, INSTANCES_NAME)
        self.create_dir(self.instances_path)

        self.local_root_path = utils.normalize_local_suffix(local_root_path)
        self.create_dir(self.local_root_path)

        self.user_id = self.endpoint.account
        self.instance = get_instance(
            [self.auth_url, self.user_id,
             self.container, self.local_root_path])
        self.instance_path = join_path(self.instances_path, self.instance)
119
120
        self.create_dir(self.instance_path)

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
121
        self.dbname = utils.to_unicode(kwargs.get("dbname", DEFAULT_DBNAME))
122
123
124
        self.full_dbname = join_path(self.instance_path, self.dbname)
        self.get_db(initialize=True)

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
125
126
        self.cache_name = utils.to_unicode(
            kwargs.get("cache_name", DEFAULT_CACHE_NAME))
127
128
129
        self.cache_path = join_path(self.local_root_path, self.cache_name)
        self.create_dir(self.cache_path)

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
130
131
        self.cache_hide_name = utils.to_unicode(
            kwargs.get("cache_hide_name", DEFAULT_CACHE_HIDE_NAME))
132
133
134
        self.cache_hide_path = join_path(self.cache_path, self.cache_hide_name)
        self.create_dir(self.cache_hide_path)

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
135
136
        self.cache_stage_name = utils.to_unicode(
            kwargs.get("cache_stage_name", DEFAULT_CACHE_STAGE_NAME))
137
138
139
140
        self.cache_stage_path = join_path(self.cache_path,
                                          self.cache_stage_name)
        self.create_dir(self.cache_stage_path)

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
141
142
        self.cache_fetch_name = utils.to_unicode(
            kwargs.get("cache_fetch_name", DEFAULT_CACHE_FETCH_NAME))
143
144
145
146
        self.cache_fetch_path = join_path(self.cache_path,
                                          self.cache_fetch_name)
        self.create_dir(self.cache_fetch_path)

147
        self.heartbeat = ThreadSafeDict()
148
149
        self.action_max_wait = kwargs.get("action_max_wait",
                                          DEFAULT_ACTION_MAX_WAIT)
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
150
151
152
153
154
155
156
        self.pithos_list_interval = kwargs.get("pithos_list_interval",
                                               DEFAULT_PITHOS_LIST_INTERVAL)

        self.connection_retry_limit = kwargs.get(
            "connection_retry_limit", DEFAULT_CONNECTION_RETRY_LIMIT)
        self.endpoint.CONNECTION_RETRY_LIMIT = self.connection_retry_limit

157
        self.messager = Messager()
158

159
160
161
162
163
164
165
166
167
        self.mtime_lag = self.determine_mtime_lag()

    def determine_mtime_lag(self):
        st = os.stat(self.cache_path)
        mtime = st.st_mtime
        if mtime.is_integer():
            return 1.1
        return 0

168
169
170
171
172
173
174
175
    def get_db(self, initialize=False):
        dbs = getattr(thread_local_data, "dbs", None)
        if dbs is not None:
            db = dbs.get(self.full_dbname)
        else:
            db = None

        if db is None:
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
176
177
            logger.debug("Connecting db: '%s', thread: %s" %
                         (self.full_dbname, threading.current_thread().ident))
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
            db = SqliteFileStateDB(self.full_dbname, initialize=initialize)
            if dbs is None:
                thread_local_data.dbs = {}
            thread_local_data.dbs[self.full_dbname] = db
        return db

    def create_dir(self, path):
        if os.path.exists(path):
            if os.path.isdir(path):
                return
            raise Exception("Cannot create dir '%s'; file exists" % path)
        logger.warning("Creating dir: '%s'" % path)
        os.mkdir(path)
        return path

193
    @ssl_fall_back
194
195
196
197
198
199
200
201
202
203
204
205
206
    def _get_pithos_client(self, auth_url, token, container):
        try:
            astakos = AstakosClient(auth_url, token)
        except ClientError:
            logger.error("Failed to authenticate user token")
            raise
        try:
            PITHOS_URL = astakos.get_endpoint_url(PithosClient.service_type)
        except ClientError:
            logger.error("Failed to get endpoints for Pithos")
            raise
        try:
            account = astakos.user_info['id']
207
            client = PithosClient(PITHOS_URL, token, account, container)
208
209
210
        except ClientError:
            logger.error("Failed to initialize Pithos client")
            raise
211
212
213
214
        try:
            client.get_container_info(container)
        except ClientError as e:
            if e.status == 404:
215
216
                logger.warning(
                    "Container '%s' does not exist, creating..." % container)
217
218
219
220
221
222
223
224
225
                try:
                    client.create_container(container)
                except ClientError:
                    logger.error("Failed to create container '%s'" % container)
                    raise
            else:
                raise

        return client