-
Notifications
You must be signed in to change notification settings - Fork 7
/
FileTransferSession.py
469 lines (374 loc) · 19.3 KB
/
FileTransferSession.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
# Copyright (C) 2009-2011 AG Projects. See LICENSE for details.
#
from Foundation import NSLocalizedString
import datetime
import os
import re
import time
import uuid
from collections import deque
from application.notification import NotificationCenter, IObserver, NotificationData
from application.python import Null
from sipsimple.account import Account, BonjourAccount
from sipsimple.configuration.settings import SIPSimpleSettings
from sipsimple.core import ToHeader, SIPURI, Route
from sipsimple.lookup import DNSLookup
from sipsimple.session import Session
from sipsimple.streams.msrp.filetransfer import FileTransferStream, FileSelector
from sipsimple.threading.green import run_in_green_thread
from sipsimple.util import ISOTimestamp
from zope.interface import implementer
from BlinkLogger import BlinkLogger
from HistoryManager import FileTransferHistory, ChatHistory
from util import call_later, run_in_gui_thread, format_size, format_date, format_identity_to_string
def format_duration(t):
s = ""
if t.days > 0:
s += "%d days, " % t.days
s += "%02d:%02d:%02d" % (t.seconds / 3600, (t.seconds / 60) % 60, t.seconds % 60)
return s
class FileTransferInfo(object):
def __init__(self, transfer_id=None, direction=None, local_uri=None, remote_uri=None, file_path=None, bytes_transfered=0, file_size=0, status=None):
self.transfer_id = transfer_id
self.direction = direction
self.local_uri = local_uri
self.remote_uri = remote_uri
self.file_path = file_path
self.bytes_transfered = bytes_transfered
self.file_size = file_size
self.status = status
@implementer(IObserver)
class FileTransfer(object):
direction = None # to be set by subclasses
session = None
stream = None
handler = None
status = ""
remote_identity = None
target_uri = None
transfer_rate = None
last_rate_pos = 0
last_rate_time = None
rate_history = None
ft_info = None
bytes = 0
total_bytes = 0
progress = None
start_time = None
end_time = None
@property
def file_selector(self):
return self.stream.file_selector if self.stream is not None else None
@property
def progress_text(self):
return self.status
@property
def file_size(self):
return self.file_selector and self.file_selector.size
@property
def file_type(self):
return self.file_selector and self.file_selector.type
@property
def file_path(self):
return self.file_selector.name if self.file_selector is not None else ''
@property
def file_pos(self):
return self.bytes
def format_progress(self):
t = NSLocalizedString("Transferred %s of ", "Label") % format_size(self.bytes, 1024) + format_size(self.total_bytes, 1024)
if self.transfer_rate is not None:
if self.transfer_rate == 0:
status = t + " (" + NSLocalizedString("stalled", "Label") + ")"
else:
eta = (self.total_bytes - self.bytes) / self.transfer_rate
if eta < 60:
time_left = NSLocalizedString("Less than 1 minute", "Label")
elif eta < 60*60:
e = eta/60
time_left = NSLocalizedString("About %i minutes", "Label") % e
else:
time_left = "%s left" % format_duration(datetime.timedelta(seconds=eta))
status = t + " - %s/s - %s" % (format_size(self.transfer_rate, bits=True), time_left)
else:
status = t
return status
def update_transfer_rate(self):
now = time.time()
if self.last_rate_time is not None:
dt = now - self.last_rate_time
if dt >= 1:
db = self.file_pos - self.last_rate_pos
transfer_rate = db / dt
self.rate_history.append(transfer_rate)
self.last_rate_time = now
self.last_rate_pos = self.file_pos
self.transfer_rate = int(sum(self.rate_history) / len(self.rate_history))
else:
self.last_rate_time = now
self.last_rate_pos = self.file_pos
self.rate_history = deque(maxlen=5)
notification_center = NotificationCenter()
notification_center.post_notification("BlinkFileTransferSpeedDidUpdate", sender=self)
def add_to_history(self):
FileTransferHistory().add_transfer(transfer_id=self.ft_info.transfer_id, direction=self.ft_info.direction, local_uri=self.ft_info.local_uri, remote_uri=self.ft_info.remote_uri, file_path=self.ft_info.file_path, bytes_transfered=self.ft_info.bytes_transfered, file_size=self.ft_info.file_size or 0, status=self.ft_info.status)
message = "<h3>%s File Transfer</h3>" % self.ft_info.direction.capitalize()
message += "<p>%s (%s)" % (self.ft_info.file_path, format_size(self.ft_info.file_size or 0))
media_type = 'file-transfer'
local_uri = self.ft_info.local_uri
remote_uri = self.ft_info.remote_uri
direction = self.ft_info.direction
status = 'delivered' if self.ft_info.status == 'completed' else 'failed'
cpim_from = self.ft_info.remote_uri
cpim_to = self.ft_info.remote_uri
timestamp = str(ISOTimestamp.now())
ChatHistory().add_message(self.ft_info.transfer_id, media_type, local_uri, remote_uri, direction, cpim_from, cpim_to, timestamp, message, "html", "0", status)
def end(self):
if self._ended:
return
self._ended = True
if self.session is not None:
print('Session will end %s in state %s' % (self.session, self.session.state))
self.session.end()
status = NSLocalizedString("Cancelled", "Label")
self._terminate(failure_reason="Cancelled", failure_status=status)
self.log_info("File Transfer has been cancelled")
def _terminate(self, failure_reason=None, failure_status=None):
notification_center = NotificationCenter()
if failure_reason is None:
self.log_info("File Transfer ended (%i of %i bytes transferred)" % (self.bytes, self.total_bytes))
self.end_time = datetime.datetime.now()
t = NSLocalizedString("Completed transfer of ", "Label")
self.status = t + format_size(self.file_size) + NSLocalizedString(" in ", "Label") + format_duration(self.end_time-self.start_time) + " " + format_date(self.end_time)
self.ft_info.status = "completed"
self.ft_info.bytes_transfered = self.file_selector.size
else:
if failure_status is None:
if self.total_bytes:
self.log_info("File Transfer was interrupted")
self.status = NSLocalizedString("Transferred %s of ", "Label") % format_size(self.bytes, 1024) + format_size(self.total_bytes) + " - " + failure_reason
else:
self.log_info("File Transfer was cancelled")
self.status = failure_reason
else:
self.log_info("File Transfer failed: %s" % failure_reason)
self.status = failure_status
self.ft_info.status = "failed"
self.ft_info.bytes_transfered = self.file_pos
if self.session is not None and self.stream is not None and self.handler is not None:
notification_center.remove_observer(self, sender=self.stream)
notification_center.remove_observer(self, sender=self.handler)
self.session = None
self.stream = None
self.handler = None
self.transfer_rate = None
notification_center.post_notification("BlinkFileTransferDidEnd", sender=self, data=NotificationData(file_path=self.ft_info.file_path, error=failure_reason is not None))
self.add_to_history()
@run_in_gui_thread
def handle_notification(self, notification):
handler = getattr(self, '_NH_%s' % notification.name, Null)
handler(notification)
def _NH_MediaStreamDidNotInitialize(self, notification):
self._terminate(failure_reason=notification.data.reason)
def _NH_MediaStreamDidStart(self, notification):
self.log_info("File transfer in progress...")
self.ft_info.status = "transferring"
self.start_time = datetime.datetime.now()
notification.center.post_notification("BlinkFileTransferDidStart", sender=self)
def _NH_FileTransferHandlerDidInitialize(self, notification):
self.progress = None
# The filename is now properly initialized
self.ft_info.file_path = self.file_path
notification.center.post_notification("BlinkFileTransferDidInitialize", self)
def _NH_FileTransferHandlerError(self, notification):
self.log_info("Error while handling file transfer: %s" % notification.data.error)
def _NH_FileTransferHandlerDidEnd(self, notification):
if self.direction == 'incoming':
if self.stream.direction == 'sendonly':
call_later(3, self.session.end)
else:
call_later(1, self.session.end)
else:
self.session.end()
self._terminate(failure_reason=notification.data.reason)
def _NH_FileTransferHandlerDidStart(self, notification):
self.status = NSLocalizedString("Starting File Transfer...", "Label")
notification.center.post_notification("BlinkFileTransferUpdate", sender=self)
def _NH_FileTransferHandlerProgress(self, notification):
self.bytes = notification.data.transferred_bytes
self.total_bytes = notification.data.total_bytes
progress = int(self.bytes * 100 / self.total_bytes)
if self.progress is None or progress > self.progress:
self.progress = progress
self.update_transfer_rate()
self.status = self.format_progress()
notification.center.post_notification("BlinkFileTransferProgress", sender=self, data=NotificationData(progress=progress))
def log_info(self, text):
BlinkLogger().log_info("[%s file transfer with %s] %s" % (self.direction.title(), self.remote_identity, text))
def lookup_destination(self, uri):
self.log_info("Lookup destination for %s" % uri)
is_ip_address = re.match("^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$", uri.host.decode()) or ":" in uri.host.decode()
if self.account is BonjourAccount() and is_ip_address:
tls_name = self.account.sip.tls_name
transport = uri.transport.decode() if isinstance(uri.transport, bytes) else uri.transport
transport = 'tls' if uri.secure else transport.lower()
port = uri.port or (5061 if transport=='tls' else 5060)
routes = [Route(address=uri.host, port=port, transport=transport, tls_name=tls_name or uri.host)]
self.connect(routes)
return
self.lookup_dns(uri)
@run_in_green_thread
def lookup_dns(self, target_uri):
settings = SIPSimpleSettings()
lookup = DNSLookup()
notification_center = NotificationCenter()
notification_center.add_observer(self, sender=lookup)
if self.account is BonjourAccount():
tls_name = target_uri.host
else:
if self.account.id.domain == target_uri.host.decode():
tls_name = self.account.sip.tls_name or self.account.id.domain
else:
tls_name = target_uri.host.decode()
uri = target_uri
if self.account is not BonjourAccount():
if self.account.sip.outbound_proxy is not None:
proxy = self.account.sip.outbound_proxy
uri = SIPURI(host=proxy.host, port=proxy.port, parameters={'transport': proxy.transport})
self.log_info("Starting DNS lookup for %s via proxy %s" % (target_uri.host.decode(), uri))
elif self.account.sip.always_use_my_proxy:
uri = SIPURI(host=self.account.id.domain)
self.log_info("Starting DNS lookup for %s via proxy of account %s" % (target_uri.host.decode(), self.account.id))
self.log_info("Starting DNS lookup for %s" % target_uri.host.decode())
lookup.lookup_sip_proxy(uri, settings.sip.transport_list, tls_name=tls_name)
def _NH_DNSLookupDidSucceed(self, notification):
notification.center.remove_observer(self, sender=notification.sender)
routes = notification.data.result
if not routes:
self._terminate(failure_reason="Destination not found")
return
self.connect(routes)
def _NH_DNSLookupDidFail(self, notification):
notification.center.remove_observer(self, sender=notification.sender)
if self._ended:
return
self.log_info("DNS Lookup for SIP routes failed: '%s'" % notification.data.error)
status = NSLocalizedString("DNS Lookup failed", "Label")
self._terminate(failure_reason=notification.data.error, failure_status=status)
def connect(self, routes):
notification_center = NotificationCenter()
if self._ended:
self.log_info("File transfer has already ended")
return
self.session = Session(self.account)
self.stream = FileTransferStream(self._file_selector, 'sendonly' if self.transfer_type=='push' else 'recvonly', transfer_id=self.ft_info.transfer_id)
self.handler = self.stream.handler
notification_center.add_observer(self, sender=self.stream)
notification_center.add_observer(self, sender=self.handler)
self.log_info("Sending %s file transfer request via %s..." % (self.transfer_type, routes[0]))
self.session.connect(ToHeader(self.target_uri), routes, [self.stream])
class IncomingFileTransferHandler(FileTransfer):
direction = 'incoming'
def __init__(self, session, stream):
self.session = session
self.stream = stream
self.handler = stream.handler
self.account = session.account
self.remote_identity = format_identity_to_string(session.remote_identity)
@property
def target_text(self):
return "From " + self.remote_identity
def start(self):
notification_center = NotificationCenter()
file_path = self.file_path.decode() if isinstance(self.file_path, bytes) else self.file_path
self.ft_info = FileTransferInfo(transfer_id=self.stream.transfer_id,
direction='incoming',
local_uri=format_identity_to_string(self.account) if self.account is not BonjourAccount() else 'bonjour@local' ,
file_size=self.file_selector.size,
remote_uri=self.remote_identity,
file_path=file_path)
self.log_info("Will write file to %s" % file_path)
self.status = NSLocalizedString("Accepting File Transfer...", "Label")
notification_center.add_observer(self, sender=self.stream)
notification_center.add_observer(self, sender=self.handler)
self.log_info("Initiating Incoming File Transfer")
notification_center.post_notification("BlinkFileTransferNewIncoming", sender=self)
def end(self):
if self.session is not None:
self.session.end()
class OutgoingPushFileTransferHandler(FileTransfer):
direction = 'outgoing'
transfer_type = 'push'
def __init__(self, account, target_uri, file_path):
self.account = account
self._file_selector = FileSelector.for_file(file_path)
self.remote_identity = format_identity_to_string(target_uri)
self.target_uri = target_uri
self._ended = False
@property
def target_text(self):
t = NSLocalizedString("To %s", "Label") % self.remote_identity
f = NSLocalizedString("from account %s", "Label") % self.account.id
return t + " " + f
def retry(self):
self._ended = False
self._file_selector = FileSelector.for_file(self._file_selector.name)
self.bytes = 0
self.total_bytes = 0
self.progress = None
self.last_rate_pos = 0
self.last_rate_time = None
self.rate_history = None
self.session = None
self.stream = None
self.handler = None
self.transfer_rate = None
self.start(restart=True)
def start(self, restart=False):
notification_center = NotificationCenter()
file_path = self._file_selector.name.decode() if isinstance(self._file_selector.name, bytes) else self._file_selector.name
self.ft_info = FileTransferInfo(transfer_id=str(uuid.uuid4()),
direction='outgoing',
file_size=self._file_selector.size,
local_uri=format_identity_to_string(self.account) if self.account is not BonjourAccount() else 'bonjour@local',
remote_uri=self.remote_identity,
file_path=file_path)
self.status = NSLocalizedString("Offering File...", "Label")
self.ft_info.status = "proposing"
self.lookup_destination(self.target_uri)
if restart:
notification_center.post_notification("BlinkFileTransferWillRestart", self)
else:
notification_center.post_notification("BlinkFileTransferNewOutgoing", sender=self)
def _NH_FileTransferHandlerHashProgress(self, notification):
progress = int(notification.data.processed * 100 / notification.data.total)
if self.progress is None or progress > self.progress:
self.progress = progress
notification.center.post_notification('BlinkFileTransferHashProgress', sender=self, data=NotificationData(progress=progress))
class OutgoingPullFileTransferHandler(FileTransfer):
direction = 'outgoing'
transfer_type = 'pull'
def __init__(self, account, target_uri, filename, hash):
self.account = account
self._file_selector = FileSelector(name=os.path.basename(filename), hash=hash)
self.remote_identity = format_identity_to_string(target_uri)
self.target_uri = SIPURI.new(target_uri)
self._ended = False
@property
def target_text(self):
f = NSLocalizedString("From %s", "Label") % self.target_uri
t = NSLocalizedString("to account %s", "Label") % self.account.id
return f + " " + t
def start(self):
notification_center = NotificationCenter()
file_path = self._file_selector.name.decode() if isinstance(self._file_selector.name, bytes) else self._file_selector.name
self.ft_info = FileTransferInfo(transfer_id=str(uuid.uuid4()),
direction='incoming',
local_uri=format_identity_to_string(self.account) if self.account is not BonjourAccount() else 'bonjour@local',
file_size=0,
remote_uri=self.remote_identity,
file_path=file_path)
self.log_info("Pull File Transfer Request started %s" % file_path)
notification_center.post_notification("BlinkFileTransferNewOutgoing", self)
self.status = NSLocalizedString("Requesting File...", "Label")
self.ft_info.status = "requesting"
self.lookup_destination(self.target_uri)