setup.py 11.2 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
import os
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
17
import sys
18
19
import threading
import logging
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
20
import ctypes
21

22
23
from functools import wraps

24
from agkyra.syncer.utils import join_path, ThreadSafeDict
25
from agkyra.syncer.database import TransactedConnection
26
from agkyra.syncer.messaging import Messager
27
from agkyra.syncer import utils, common, database
28

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

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
45
46
DEFAULT_PITHOS_LIST_INTERVAL = 5
DEFAULT_CONNECTION_RETRY_LIMIT = 3
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
47
INSTANCES_NAME = 'instances'
48
49
50

thread_local_data = threading.local()

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
51
52
53
54
55
56
57
58
59
60
61
if getattr(sys, 'frozen', False):
    # we are running in a |PyInstaller| bundle
    BASEDIR = sys._MEIPASS
    ISFROZEN = True
else:
    # we are running in a normal Python environment
    CURDIR = os.path.dirname(os.path.realpath(__file__))
    BASEDIR = os.path.dirname(CURDIR)
    ISFROZEN = False

RESOURCES = os.path.join(BASEDIR, 'resources')
62

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
63
64
65
66
67
def get_instance(elems):
    data = "".join(elems)
    return utils.hash_string(data)


68
69
def ssl_fall_back(method):
    """Catch an SSL error while executing a method, patch kamaki and retry"""
70
    @wraps(method)
71
72
73
74
75
76
77
    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)')
78
            https.patch_with_certs(os.path.join(RESOURCES, 'cacert.pem'))
79
80
81
82
            return method(self, *args, **kwargs)
    return wrap


Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
83
84
85
86
87
88
89
90
91
92
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)


Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
93
94
95
96
def win_hide_file(path):
    ctypes.windll.kernel32.SetFileAttributesW(path, 2)


97
class SyncerSettings():
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
98
    def __init__(self, auth_url, auth_token, container, local_root_path,
99
                 *args, **kwargs):
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
100
101
102
103
104
        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
105
        self.auth_url = utils.normalize_standard_suffix(auth_url)
106
        self.auth_token = auth_token
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
107
        self.container = utils.normalize_standard_suffix(container)
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
108
109
110
111

        self.ignore_ssl = kwargs.get("ignore_ssl", False)
        if self.ignore_ssl:
            https.patch_ignore_ssl()
112
113
114
        elif kwargs.get('ca_certs', None):
            https.patch_with_certs(kwargs['ca_certs'])

115
116
117
        self.endpoint = self._get_pithos_client(
            auth_url, auth_token, container)

118
119
        container_exists = self.check_container_exists(container)

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
120
        home_dir = utils.to_unicode(os.path.expanduser('~'))
121
        default_settings_path = join_path(home_dir, GLOBAL_SETTINGS_NAME)
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
122
123
        self.settings_path = utils.to_unicode(
            kwargs.get("agkyra_path", default_settings_path))
124
        self.create_dir(self.settings_path)
125

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
126
127
128
129
        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)
130
        local_root_path_exists = os.path.isdir(self.local_root_path)
131

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
132
133
        self.cache_name = utils.to_unicode(
            kwargs.get("cache_name", DEFAULT_CACHE_NAME))
134
135
        self.cache_path = join_path(self.local_root_path, self.cache_name)

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
136
137
        self.cache_hide_name = utils.to_unicode(
            kwargs.get("cache_hide_name", DEFAULT_CACHE_HIDE_NAME))
138
139
        self.cache_hide_path = join_path(self.cache_path, self.cache_hide_name)

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
140
141
        self.cache_stage_name = utils.to_unicode(
            kwargs.get("cache_stage_name", DEFAULT_CACHE_STAGE_NAME))
142
143
144
        self.cache_stage_path = join_path(self.cache_path,
                                          self.cache_stage_name)

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
145
146
        self.cache_fetch_name = utils.to_unicode(
            kwargs.get("cache_fetch_name", DEFAULT_CACHE_FETCH_NAME))
147
148
        self.cache_fetch_path = join_path(self.cache_path,
                                          self.cache_fetch_name)
149
150
151
152
153
154
155
156
157
158

        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)
        self.create_dir(self.instance_path)

        self.dbname = utils.to_unicode(kwargs.get("dbname", DEFAULT_DBNAME))
        self.full_dbname = join_path(self.instance_path, self.dbname)
159
160
161
        self.syncer_dbtuple = common.DBTuple(
            dbtype=database.SyncerDB,
            dbname=self.full_dbname)
162
163
164

        db_existed = os.path.isfile(self.full_dbname)
        if not db_existed:
165
            database.initialize(self.syncer_dbtuple)
166

167
        self.mtime_lag = 0
168
        self.case_insensitive = False
169

170
171
172
173
174
175
176
177
178
        if not db_existed:
            self.set_localfs_enabled(True)
            self.create_local_dirs()
            self.set_pithos_enabled(True)
            if not container_exists:
                self.mk_container(container)
        else:
            if not local_root_path_exists:
                self.set_localfs_enabled(False)
179
180
            else:
                self.create_local_dirs()
181
182
            if not container_exists:
                self.set_pithos_enabled(False)
183

184
        self.heartbeat = ThreadSafeDict()
185
186
        self.action_max_wait = kwargs.get("action_max_wait",
                                          DEFAULT_ACTION_MAX_WAIT)
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
187
188
189
190
191
192
193
        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

194
        self.messager = Messager()
195

196
197
198
    def create_local_dirs(self):
        self.create_dir(self.local_root_path)
        self.create_dir(self.cache_path)
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
199
200
        if utils.iswin():
            win_hide_file(self.cache_path)
201
202
203
        self.create_dir(self.cache_hide_path)
        self.create_dir(self.cache_stage_path)
        self.create_dir(self.cache_fetch_path)
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
204
        self.set_mtime_lag()
205
        self.set_case_insensitive()
206
207
208
209
210
211
212
213

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

214
    def set_mtime_lag(self):
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
215
        lag = self.determine_mtime_lag()
216
        logger.info("Setting mtime_lag = %s" % lag)
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed
217
        self.mtime_lag = lag
218

219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
    def determine_fs_case_insensitive(self):
        path = self.cache_hide_path
        altered = path.upper() if not path.isupper() else path.lower()
        try:
            os.stat(altered)
            return True
        except OSError:
            return False

    def set_case_insensitive(self):
        case_insensitive = self.determine_fs_case_insensitive()
        case = "in" if case_insensitive else ""
        logger.info("Filesystem is case-%ssensitive" % case)
        self.case_insensitive = case_insensitive

234
235
236
237
238
239
    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)
240
        os.makedirs(path)
241
242
        return path

243
    @ssl_fall_back
244
245
246
247
248
249
250
251
252
253
254
255
256
    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']
257
            return PithosClient(PITHOS_URL, token, account, container)
258
259
260
        except ClientError:
            logger.error("Failed to initialize Pithos client")
            raise
261
262

    def check_container_exists(self, container):
263
        try:
264
265
            self.endpoint.get_container_info(container)
            return True
266
267
        except ClientError as e:
            if e.status == 404:
268
                return False
269
270
271
            else:
                raise

272
273
274
275
276
277
278
279
280
    def mk_container(self, container):
        try:
            self.endpoint.create_container(container)
            logger.warning("Creating container '%s'" % container)
        except ClientError:
            logger.error("Failed to create container '%s'" % container)
            raise

    def set_localfs_enabled(self, enabled):
281
282
        with TransactedConnection(self.syncer_dbtuple) as db:
            self._set_localfs_enabled(db, enabled)
283
284
285
286
287

    def _set_localfs_enabled(self, db, enabled):
        db.set_config("localfs_enabled", enabled)

    def set_pithos_enabled(self, enabled):
288
289
        with TransactedConnection(self.syncer_dbtuple) as db:
            self._set_pithos_enabled(db, enabled)
290
291
292
293
294

    def _set_pithos_enabled(self, db, enabled):
        db.set_config("pithos_enabled", enabled)

    def localfs_is_enabled(self):
295
296
        with TransactedConnection(self.syncer_dbtuple) as db:
            return self._localfs_is_enabled(db)
297
298
299
300
301

    def _localfs_is_enabled(self, db):
        return db.get_config("localfs_enabled")

    def pithos_is_enabled(self):
302
303
        with TransactedConnection(self.syncer_dbtuple) as db:
            return self._pithos_is_enabled(db)
304
305
306
307
308
309
310
311

    def _pithos_is_enabled(self, db):
        return db.get_config("pithos_enabled")

    def _sync_is_enabled(self, db):
        return self._localfs_is_enabled(db) and self._pithos_is_enabled(db)

    def purge_db_archives_and_enable(self):
312
313
314
315
        with TransactedConnection(self.syncer_dbtuple) as db:
            self._purge_db_archives_and_enable(db)

    def _purge_db_archives_and_enable(self, db):
316
317
318
319
320
321
322
        db.purge_archives()
        if not self._localfs_is_enabled(db):
            self.create_local_dirs()
            self._set_localfs_enabled(db, True)
        if not self._pithos_is_enabled(db):
            self._set_pithos_enabled(db, True)
            self.mk_container(self.container)