forked from brvier/KhtNotes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sync.py
633 lines (562 loc) · 26.9 KB
/
sync.py
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
#!/usr/bin/python
# -a*- coding: utf-8 -*-
#
# Copyright (c) 2011 Benoit HERVIER <khertan@khertan.net>
# Licenced under GPLv3
## 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; version 3 only.
##
## 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.
import os.path
import os
import threading
from PySide.QtCore import QObject, Slot, Signal, Property
from note import Note, getValidFilename
from settings import Settings
import time
import json
import logger
import logging
import md5util
import sys
from webdav.Connection import WebdavError
def local2utc(secs):
if time.daylight:
return secs - time.timezone
else:
return secs - time.altzone
def webdavPathJoin(path, *args):
for arg in args:
if path.endswith(u"/"):
path = path + arg
else:
path = path + u"/" + arg
return path
class Sync(QObject):
'''Sync class'''
def __init__(self,):
QObject.__init__(self)
self._running = False
#logging.getLogger(_defaultLoggerName).setLevel(logging.WARNING)
self.logger = logger.getDefaultLogger()
self._localDataFolder = Note.NOTESPATH
if not os.path.exists(self._localDataFolder):
os.mkdir(self._localDataFolder)
self._remoteDataFolder = 'KhtNotes'
def localBasename(self, path):
return os.path.relpath(path, self._localDataFolder)
def remoteBasename(self, path):
return os.path.relpath(path, os.path.join(self.webdavBasePath,
self._remoteDataFolder))
@Slot()
def launch(self):
''' Sync the notes in a thread'''
if not self._get_running():
self._set_running(True)
self.thread = threading.Thread(target=self._wsync)
self.thread.start()
def _wsync(self):
try:
self._sync_connect()
except Exception, err:
self.on_error.emit(unicode(err))
self.on_running = False
self.logger.error('%s:%s' % (unicode(type(err)), unicode(err)))
def readSettings(self,):
#Read Settings
settings = Settings()
self.webdavHost = settings.webdavHost
self.webdavBasePath = settings.webdavBasePath
webdavLogin = settings.webdavLogin
webdavPasswd = settings.webdavPasswd
useAutoMerge = settings.autoMerge
self._remoteDataFolder = settings.remoteFolder
return webdavLogin, webdavPasswd, useAutoMerge
def createConnection(self, webdavLogin, webdavPasswd):
from webdav.WebdavClient import CollectionStorer, AuthorizationError, \
parseDigestAuthInfo
#from webdav.logger import _defaultLoggerName
isConnected = False
webdavConnection = CollectionStorer(self.webdavHost
+ self.webdavBasePath,
validateResourceNames=False)
webdavConnection.connection.logger.setLevel(logging.WARNING)
time_delta = None
#Test KhtNotes folder and authenticate
authFailures = 0
while authFailures < 4:
try:
webdavConnection.validate()
response = webdavConnection.getSpecificOption('date')
print response
try:
import rfc822
local_datetime = int(time.time())
self.logger.debug('Timezone: %f, Timealtzone: %f',
time.timezone, time.altzone)
self.logger.debug('Server Time: %s' % response)
remote_datetime = rfc822.parsedate(response)
self.logger.debug('Parsed server time %s' %
str(remote_datetime))
time_delta = local2utc(time.mktime(remote_datetime)) \
- local_datetime
self.logger.debug('Time delta: %f' % time_delta)
except Exception, err:
time_delta = None
print 'error parsing date', err
self.logger.error('Failed to parse datetime: %s:%s'
% (unicode(type(err)), unicode(err)))
isConnected = True
break # break out of the authorization failure counter
except AuthorizationError, err:
if err.authType == "Basic":
webdavConnection.connection.\
addBasicAuthorization(webdavLogin, webdavPasswd)
elif err.authType == "Digest":
info = parseDigestAuthInfo(err.authInfo)
webdavConnection.connection.\
addDigestAuthorization(webdavLogin,
webdavPasswd,
realm=info["realm"],
qop=info["qop"],
nonce=info["nonce"])
elif authFailures >= 2:
self.on_error.emit('Wrong login or password')
self.logger.error('Wrong login or password')
else:
self.logger.error('%s:%s' % (unicode(type(err)),
unicode(err)))
self.on_error.emit(unicode(err) + ':' + unicode(err))
except Exception, err2:
self.on_error.emit(unicode(type(err2)) + ':' + unicode(err2))
self.logger.error(unicode(type(err2)) + ':' + unicode(err2))
print unicode(type(err2)) + ':' + unicode(err2)
authFailures += 1
return (isConnected, webdavConnection, time_delta)
def _sync_connect(self,):
'''Sync the notes with a webdav server'''
webdavLogin, webdavPasswd, useAutoMerge = self.readSettings()
#Create Connection
isConnected, webdavConnection, time_delta = \
self.createConnection(webdavLogin, webdavPasswd)
if isConnected:
self._sync_files(webdavConnection, time_delta, useAutoMerge)
self._set_running(False)
self.on_finished.emit()
def _sync_files(self, webdavConnection, time_delta, useAutoMerge):
try:
#Reset webdav path
webdavConnection.path = self.webdavBasePath
#Check that KhtNotes folder exists at root or create it and
#and lock Collections
self._check_khtnotes_folder_and_lock(webdavConnection)
#Get remote filenames and timestamps
remote_filenames = \
self._get_remote_filenames(webdavConnection)
#Get local filenames and timestamps
local_filenames = self._get_local_filenames()
#Compare with last sync index
lastsync_remote_filenames, \
lastsync_local_filenames = self._get_lastsync_filenames()
#Sync intelligency (or not)
#It use a local index with timestamp of the server files
#1/ As most webdav server didn t support setting
# modification datetime on ressources
#2/ Main target is owncloud where webdavserver didn't
# implent delta-v versionning
#3/ Notes should be editable in the owncloud interface
# but i would like to support other webdav server
# so an owncloud apps isn t acceptable
#Delete remote file deleted
for filename in set(lastsync_remote_filenames) \
- set(remote_filenames):
if filename in local_filenames.keys():
if int(local2utc(lastsync_remote_filenames[filename] -
time_delta)) \
>= int(local_filenames[filename]):
self._local_delete(filename)
else:
#Else we have a conflict local file is newer than
#deleted one
self.logger.debug('Delete conflictServer: '
'%s : %s >= %s'
% (filename,
int(
local2utc(
lastsync_remote_filenames
[filename]) - time_delta),
int(
local_filenames
[filename])))
self._upload(webdavConnection, filename,
None, time_delta)
#Delete local file deleted
for filename in set(lastsync_local_filenames) \
- set(local_filenames):
if filename in remote_filenames:
if int(lastsync_local_filenames[filename]) \
>= int(local2utc(remote_filenames[filename] -
time_delta)):
self._remote_delete(webdavConnection, filename)
else:
#We have a conflict remote file is newer than what
#we try to delete
self.logger.debug(
'Delete conflictLocal: %s' % filename)
self._download(webdavConnection, filename,
None, time_delta)
#What to do with new remote file
for filename in set(remote_filenames) \
- set(lastsync_remote_filenames):
if filename not in local_filenames.keys():
self._download(webdavConnection, filename,
None, time_delta)
else:
#Conflict : it s a new file so we haven't sync it yet
self.logger.debug('New conflictServer: %s' % filename)
self._conflictServer(webdavConnection,
filename, time_delta,
useAutoMerge)
#What to do with new local file
for filename in set(local_filenames) \
- set(lastsync_local_filenames):
if filename not in remote_filenames.keys():
self._upload(webdavConnection, filename,
None, time_delta)
else:
#Conflict : it s a new file so we haven't sync it yet
self.logger.debug('New conflictLocal: %s' % filename)
self._conflictLocal(webdavConnection,
filename, time_delta, useAutoMerge)
#What to do with file not really new
#but not really deleted
for filename in set(local_filenames)\
.intersection(lastsync_local_filenames) \
- set(remote_filenames) \
.union(lastsync_remote_filenames):
self._upload(webdavConnection, filename,
None, time_delta)
for filename in set(remote_filenames) \
.intersection(lastsync_remote_filenames) \
- set(local_filenames).union(lastsync_local_filenames):
self._download(webdavConnection, filename,
None, time_delta)
#Check what's updated remotly
rupdated = [filename for filename
in (set(remote_filenames).
intersection(lastsync_remote_filenames))
if remote_filenames[filename]
!= lastsync_remote_filenames[filename]]
lupdated = [filename for filename
in (set(local_filenames).
intersection(lastsync_local_filenames))
if local_filenames[filename]
!= lastsync_local_filenames[filename]]
for filename in set(rupdated) - set(lupdated):
self._download(webdavConnection, filename,
None, time_delta)
for filename in set(lupdated) - set(rupdated):
self._upload(webdavConnection, filename,
None, time_delta)
for filename in set(lupdated).intersection(rupdated):
if int(local2utc(remote_filenames[filename])
- time_delta) \
> int(local_filenames[filename]):
self.logger.debug(
'Updated conflictLocal: %s' % filename)
self._conflictLocal(webdavConnection, filename,
time_delta, useAutoMerge)
elif int(local2utc(remote_filenames[filename])
- time_delta) \
< int(local_filenames[filename]):
self.logger.debug('Updated conflictServer: %s'
% filename)
self._conflictServer(webdavConnection, filename,
time_delta, useAutoMerge)
else:
self.logger.debug('Up to date: %s' % filename)
#Build and write index
self._write_index(webdavConnection, time_delta)
#Un_lock the collection
self._unlock(webdavConnection)
except Exception, err:
import traceback
print traceback.format_exc()
self.on_error.emit(unicode(err))
self.logger.debug('Global sync error : %s' % unicode(err))
def _conflictServer(self, webdavConnection, filename,
time_delta, useAutoMerge):
'''Priority to local'''
self.logger.debug('conflictServer: %s' % filename)
lpath = os.path.join(self._localDataFolder, filename)
cpath = os.path.join(self._localDataFolder,
os.path.splitext(filename)[0] + '.Conflict.txt')
bpath = os.path.join(self._localDataFolder, 'merge.sync',
filename)
self._download(webdavConnection,
filename,
os.path.splitext(filename)[0] + '.Conflict.txt',
time_delta)
#Test if it s a real conflict
if md5util.md5sum(lpath) == md5util.md5sum(cpath):
os.remove(cpath)
else:
if useAutoMerge and os.path.exists(bpath):
self._mergeFiles(lpath, bpath, cpath)
os.remove(cpath)
self._upload(webdavConnection,
filename, filename, time_delta)
else:
#Else duplicate
self._upload(webdavConnection, os.path.splitext(
filename)[0] + '.Conflict.txt', None, time_delta)
def _mergeFiles(self, lpath, bpath, cpath):
from merge3.merge3 import Merge3
a = file(lpath, 'rt').readlines()
try:
base = file(bpath, 'rt').readlines()
except:
base = file(cpath, 'rt').readlines()
b = file(cpath, 'rt').readlines()
m3 = Merge3(base, a, b)
with open(lpath, 'wb') as fh:
fh.writelines(m3.merge())
def _conflictLocal(self, webdavConnection, filename,
time_delta, useAutoMerge):
'''Priority to server'''
self.logger.debug('conflictLocal: %s', filename)
lpath = os.path.join(self._localDataFolder, filename)
cpath = os.path.join(self._localDataFolder,
os.path.splitext(filename)[0] + '.Conflict.txt')
bpath = os.path.join(self._localDataFolder, '.merge.sync',
filename)
os.rename(lpath, cpath)
self._download(webdavConnection,
filename,
filename,
time_delta)
#Test if it s a real conflict
if md5util.md5sum(lpath) == md5util.md5sum(cpath):
os.remove(cpath)
else:
if useAutoMerge and os.path.exists(bpath):
self._mergeFiles(lpath, bpath, cpath)
os.remove(cpath)
self._upload(webdavConnection,
filename, filename, time_delta)
else:
self._upload(webdavConnection, os.path.splitext(filename)[0] +
'.Conflict.txt', None, time_delta)
def _get_lastsync_filenames(self):
index = {'remote': [], 'local': []}
try:
with open(
os.path.join(
self._localDataFolder,
u'.index.sync')
.encode(sys.getfilesystemencoding()),
'rb') as fh:
index = json.load(fh)
except (IOError, TypeError, ValueError), err:
self.logger.debug(
'First sync detected or error: %s' % unicode(err))
if type(index) == list:
return index # for compatibility with older release
return (index['remote'], index['local'])
def _write_index(self, webdavConnection, time_delta):
'''Generate index for the next sync and base for merge'''
import shutil
import glob
index = {'remote': self._get_remote_filenames(webdavConnection),
'local': self._get_local_filenames()}
with open(os.path.join(
self._localDataFolder, u'.index.sync'), 'wb') as fh:
json.dump(index, fh)
merge_dir = os.path.join(
self._localDataFolder, u'.merge.sync/')
if os.path.exists(merge_dir):
shutil.rmtree(merge_dir)
os.makedirs(merge_dir)
for filename in glob.glob(os.path.join(self._localDataFolder,
'*.txt')):
try:
if os.path.isfile(filename):
shutil.copy(filename,
os.path.join(merge_dir,
self.localBasename(filename)))
except IOError, err:
print err, 'filename:', filename, ' merge_dir:', merge_dir
def _rm_remote_index(self,):
'''Delete the remote index stored locally'''
try:
with open(os.path.join(
self._localDataFolder, '.index.sync'), 'rb') as fh:
index = json.load(fh)
with open(os.path.join(
self._localDataFolder, '.index.sync'), 'wb') as fh:
json.dump(({}, index[1]), fh)
except:
self.logger.debug('No remote index stored locally')
def _move(self, webdavConnection, src, dst):
'''Move/Rename a note on webdav'''
webdavConnection.path = self._get_notes_path()
resource = webdavConnection.addResource(src)
resource.move(self.webdavHost + self._get_notes_path() + dst)
def _upload(self, webdavConnection, local_filename,
remote_filename, time_delta):
#TODO set modification time on local file as
#"it s not possible on remote
try:
if not remote_filename:
remote_filename = local_filename
self.logger.debug('Upload %s to %s' %
(local_filename, remote_filename))
rdirname, rfilename = (os.path.dirname(remote_filename),
os.path.basename(remote_filename))
print rdirname, rfilename
webdavConnection.path = webdavPathJoin(self._get_notes_path(),
rdirname, '')
try:
webdavConnection.validate()
except WebdavError, err:
webdavConnection.path = webdavPathJoin(self._get_notes_path())
webdavConnection.addCollection(rdirname)
webdavConnection.path = webdavPathJoin(self._get_notes_path(),
rdirname, '')
print webdavConnection.path
resource = webdavConnection.addResource(rfilename)
lpath = os.path.join(self._localDataFolder, local_filename)
with open(lpath, 'rb') as fh:
resource.uploadFile(fh)
mtime = local2utc(time.mktime(resource.readStandardProperties()
.getLastModified())) - time_delta
os.utime(lpath, (-1, mtime))
except WebdavError, err:
self.on_error.emit('%s:%s' % (unicode(err),
unicode(remote_filename)))
def _download(self, webdavConnection, remote_filename,
local_filename, time_delta):
if not local_filename:
local_filename = remote_filename
self.logger.debug('Download %s to %s' %
(remote_filename, local_filename))
rdirname, rfilename = (os.path.dirname(remote_filename),
os.path.basename(remote_filename))
print rdirname, rfilename
webdavConnection.path = webdavPathJoin(self._get_notes_path(),
rdirname, rfilename)
print webdavConnection.path
if not os.path.exists(os.path.join(self._localDataFolder,
os.path.dirname(local_filename))):
os.makedirs(os.path.join(self._localDataFolder,
os.path.dirname(local_filename)))
lpath = os.path.join(self._localDataFolder,
os.path.dirname(local_filename),
getValidFilename(
os.path.basename(local_filename)))
webdavConnection.downloadFile(lpath)
mtime = local2utc(time.mktime(webdavConnection
.readStandardProperties()
.getLastModified())) - time_delta
os.utime(lpath, (-1, mtime))
def _remote_delete(self, webdavConnection, filename):
webdavConnection.path = self._get_notes_path()
webdavConnection.deleteResource(filename)
self.logger.debug('remote_delete: %s' % filename)
def _local_delete(self, filename):
os.remove(os.path.join(self._localDataFolder, filename))
self.logger.debug('local_delete: %s' % filename)
def _unlock(self, filename):
#TODO
pass
def _get_notes_path(self):
khtnotesPath = self.webdavBasePath
if not khtnotesPath.endswith('/'):
return khtnotesPath + '/' + self._remoteDataFolder + '/'
else:
return khtnotesPath + self._remoteDataFolder + '/'
def _check_khtnotes_folder_and_lock(self, webdavConnection):
'''Check that khtnotes folder exists on webdav'''
try:
khtnotesPath = self._get_notes_path()
self.logger.debug('WebdavConnection Path: %s'
% webdavConnection.path)
if not khtnotesPath in webdavConnection.listResources().keys():
webdavConnection.addCollection(self._remoteDataFolder + '/')
#So here it s a new share, and if have old index file
#locally notes will be lose
self._rm_remote_index()
#TODO : Lock
except Exception, err:
self.logger.error(unicode(err))
import traceback
print traceback.format_exc()
raise
return True
def __get_remote_filenames(self, webdavConnection, path):
index = {}
webdavConnection.path = path
for resource, properties in webdavConnection.getCollectionContents():
if properties.getResourceType() != 'resource':
index.update(self.__get_remote_filenames(webdavConnection,
resource.path))
else:
index[self.remoteBasename(resource.path)] = \
time.mktime(properties.getLastModified())
return index
def _get_remote_filenames(self, webdavConnection):
'''Check Remote Index'''
webdavConnection.path = self._get_notes_path()
index = self.__get_remote_filenames(webdavConnection,
self._get_notes_path())
try:
del index['']
except KeyError:
pass
try:
del index['.index.sync']
except KeyError:
pass
#self.logger.debug('_get_remote_filenames: %s' % unicode(index))
#Cleaning a bit for test:)
#for filename in index.keys():
# self._remote_delete(webdavConnection, filename)
#index = self._get_remote_filenames(webdavConnection)
return index
def _get_local_filenames(self):
index = {}
for root, folders, files in os.walk(self._localDataFolder):
if self.localBasename(root) != u'.merge.sync':
for filename in files:
index[self.localBasename(os.path.join(root,
filename))] = \
round(os.path.getmtime(
os.path.join(root, filename)))
try:
del index['.index.sync']
except KeyError:
pass
#self.logger.debug('_get_local_filenames: %s' % unicode(index))
return index
def _write(self, uid, data, timestamp=None):
''' Write the document to a file '''
note = Note(uid=uid)
note.write(data)
if timestamp is not None:
note.overwrite_timestamp()
def _get_running(self):
return self._running
def _set_running(self, b):
self._running = b
self.on_running.emit()
on_finished = Signal()
on_error = Signal(unicode)
on_running = Signal()
running = Property(bool, _get_running, _set_running, notify=on_running)
if __name__ == '__main__':
s = Sync()
s.launch()