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
634
635
636
637
|
# This file is part of Gajim.
#
# Gajim 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.
#
# Gajim 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 Gajim. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
from typing import Any
from typing import cast
import logging
import os
import re
import uuid
from collections.abc import Callable
from dataclasses import dataclass
from dataclasses import field
from pathlib import Path
from urllib.parse import ParseResult
from urllib.parse import urlparse
from gi.repository import Gio
from gi.repository import GLib
from nbxmpp.const import HTTPRequestError
from nbxmpp.http import HTTPRequest
from nbxmpp.util import convert_tls_error_flags
from gajim.common import app
from gajim.common import configpaths
from gajim.common import regex
from gajim.common.const import MIME_TYPES
from gajim.common.helpers import AdditionalDataDict
from gajim.common.helpers import get_tls_error_phrases
from gajim.common.helpers import load_file_async
from gajim.common.helpers import write_file_async
from gajim.common.i18n import _
from gajim.common.preview_helpers import aes_decrypt
from gajim.common.preview_helpers import create_thumbnail
from gajim.common.preview_helpers import filename_from_uri
from gajim.common.preview_helpers import get_image_paths
from gajim.common.preview_helpers import get_previewable_mime_types
from gajim.common.preview_helpers import guess_mime_type
from gajim.common.preview_helpers import parse_fragment
from gajim.common.preview_helpers import pixbuf_from_data
from gajim.common.preview_helpers import split_geo_uri
from gajim.common.types import GdkPixbufType
from gajim.common.util.http import create_http_request
log = logging.getLogger('gajim.c.preview')
IRI_RX = re.compile(regex.IRI)
PREVIEWABLE_MIME_TYPES = get_previewable_mime_types()
mime_types = set(MIME_TYPES)
# Merge both: if it’s a previewable image, it should be allowed
ALLOWED_MIME_TYPES = mime_types.union(PREVIEWABLE_MIME_TYPES)
AudioSampleT = list[tuple[float, float]]
@dataclass
class AudioPreviewState:
duration: float = 0.0
position: float = 0.0
is_eos: bool = False
speed: float = 1.0
is_timestamp_positive: bool = True
samples: AudioSampleT = field(default_factory=list)
is_audio_analyzed = False
class Preview:
def __init__(self,
uri: str,
urlparts: ParseResult | None,
orig_path: Path | None,
thumb_path: Path | None,
size: int,
widget: Any,
from_us: bool = False,
context: str | None = None
) -> None:
self.id = str(uuid.uuid4())
self._uri = uri
self._urlparts = urlparts
self._filename = filename_from_uri(uri)
self._widget = widget
self._from_us = from_us
self._context = context
self.account = widget.account
self.orig_path = orig_path
self.thumb_path = thumb_path
self.size = size
self.thumbnail: bytes | None = None
self.mime_type: str = ''
self.file_size: int = 0
self.download_in_progress = False
self.info_message: str | None = None
self._request = None
self.key: bytes | None = None
self.iv: bytes | None = None
if self.is_aes_encrypted and urlparts is not None:
try:
self.key, self.iv = parse_fragment(urlparts.fragment)
except ValueError as err:
log.error('Parsing fragment for AES decryption '
'failed: %s', err)
@property
def is_geo_uri(self) -> bool:
return self._uri.startswith('geo:')
@property
def is_web_uri(self) -> bool:
return not self.is_geo_uri
@property
def is_previewable(self) -> bool:
return self.mime_type in PREVIEWABLE_MIME_TYPES
@property
def is_audio(self) -> bool:
is_allowed = bool(self.mime_type in ALLOWED_MIME_TYPES)
return is_allowed and self.mime_type.startswith('audio/')
@property
def uri(self) -> str:
return self._uri
@property
def from_us(self) -> bool:
return self._from_us
@property
def context(self) -> str | None:
return self._context
@property
def filename(self) -> str:
return self._filename
@property
def request(self) -> HTTPRequest:
return self._request
@property
def request_uri(self) -> str:
if self._urlparts is None:
return ''
if self.is_aes_encrypted:
# Remove fragments so we dont transmit it to the server
urlparts = self._urlparts._replace(scheme='https', fragment='')
return urlparts.geturl()
return self._urlparts.geturl()
@property
def is_aes_encrypted(self) -> bool:
if self._urlparts is None:
return False
return self._urlparts.scheme == 'aesgcm'
@property
def thumb_exists(self) -> bool:
if self.thumb_path is None:
return False
return self.thumb_path.exists()
@property
def orig_exists(self) -> bool:
if self.orig_path is None:
return False
return self.orig_path.exists()
def create_thumbnail(self, data: bytes) -> bool:
self.thumbnail = create_thumbnail(data, self.size, self.mime_type)
if self.thumbnail is None:
self.info_message = _('Creating thumbnail failed')
log.warning('Creating thumbnail failed for: %s', self.orig_path)
return False
return True
def update_widget(self, data: GdkPixbufType | None = None) -> None:
self._widget.update(self, data)
def update_progress(self, progress: float, request: HTTPRequest) -> None:
self.download_in_progress = True
self._request = request
self._widget.update_progress(self, progress)
class PreviewManager:
def __init__(self) -> None:
self._orig_dir = Path(configpaths.get('MY_DATA')) / 'downloads'
self._thumb_dir = Path(configpaths.get('MY_CACHE')) / 'downloads.thumb'
if GLib.mkdir_with_parents(str(self._orig_dir), 0o700) != 0:
log.error('Failed to create: %s', self._orig_dir)
if GLib.mkdir_with_parents(str(self._thumb_dir), 0o700) != 0:
log.error('Failed to create: %s', self._thumb_dir)
self._previews: dict[str, Preview] = {}
# Holds active audio preview sessions
# for resuming after switching chats
self._audio_sessions: dict[int, AudioPreviewState] = {}
# References a stop function for each audio preview, which allows us
# to stop previews by preview_id, see stop_audio_except(preview_id)
self._audio_stop_functions: dict[int, Callable[..., None]] = {}
log.info('Supported mime types for preview')
log.info(sorted(PREVIEWABLE_MIME_TYPES))
def get_preview(self, preview_id: str) -> Preview | None:
return self._previews.get(preview_id)
def clear_previews(self) -> None:
self._previews.clear()
def get_audio_state(self,
preview_id: int
) -> AudioPreviewState:
state = self._audio_sessions.get(preview_id)
if state is not None:
return state
self._audio_sessions[preview_id] = AudioPreviewState()
return self._audio_sessions[preview_id]
def register_audio_stop_func(self,
preview_id: int,
stop_func: Callable[..., None]
) -> None:
self._audio_stop_functions[preview_id] = stop_func
def unregister_audio_stop_func(self, preview_id: int) -> None:
self._audio_stop_functions.pop(preview_id, None)
def stop_audio_except(self, preview_id: int) -> None:
# Stops playback of all audio previews except of for preview_id.
# This makes sure that only one preview is played at the time.
for id_, stop_func in self._audio_stop_functions.items():
if id_ != preview_id:
stop_func()
@staticmethod
def _accept_uri(urlparts: ParseResult,
uri: str,
additional_data: AdditionalDataDict) -> bool:
oob_url = additional_data.get_value('gajim', 'oob_url')
# geo
if urlparts.scheme == 'geo':
return True
if not urlparts.netloc:
return False
# aesgcm
if urlparts.scheme == 'aesgcm':
return True
# http/https
if urlparts.scheme in ('https', 'http'):
if app.settings.get('preview_allow_all_images'):
mime_type = guess_mime_type(uri)
if mime_type not in MIME_TYPES:
log.info('%s not in allowed mime types', mime_type)
return False
if mime_type == 'application/octet-stream' and uri != oob_url:
# guess_mime_type yields 'application/octet-stream' for
# paths without suffix. Check oob_url to make sure we
# display a preview for files sent via http upload.
return False
return True
if oob_url is None:
log.info('No oob url for: %s', uri)
return False
if uri != oob_url:
log.info('uri != oob url: %s != %s', uri, oob_url)
return False
return True
log.info('Unsupported URI scheme: %s', uri)
return False
def is_previewable(self,
text: str,
additional_data: AdditionalDataDict | None
) -> bool:
if additional_data is None:
return False
if not IRI_RX.fullmatch(text):
# urlparse removes whitespace (and who knows what else) from URLs,
# so can't be used for validation.
return False
uri = text
try:
urlparts = urlparse(uri)
except Exception:
return False
if not self._accept_uri(urlparts, uri, additional_data):
return False
if urlparts.scheme == 'geo':
try:
split_geo_uri(uri)
except Exception as err:
log.info('Bad geo URI %s: %s', uri, err)
return False
return True
def create_preview(self,
uri: str,
widget: Any,
from_us: bool,
context: str | None = None
) -> None:
if uri.startswith('geo:'):
preview = Preview(uri, None, None, None, 96, widget)
preview.update_widget()
self._previews[preview.id] = preview
return
preview = self._process_web_uri(uri, widget, from_us, context)
self._previews[preview.id] = preview
if not app.settings.get('enable_file_preview'):
preview.update_widget()
return
if not preview.orig_exists:
if context is not None and not from_us:
allow_in_public = app.settings.get('preview_anonymous_muc')
if context == 'public' and not allow_in_public:
preview.update_widget()
return
self.download_content(preview)
elif not preview.thumb_exists:
assert preview.orig_path is not None
load_file_async(preview.orig_path,
self._on_orig_load_finished,
preview)
else:
assert preview.thumb_path is not None
load_file_async(preview.thumb_path,
self._on_thumb_load_finished,
preview)
def _process_web_uri(self,
uri: str,
widget: Any,
from_us: bool,
context: str | None = None
) -> Preview:
urlparts = urlparse(uri)
size = app.settings.get('preview_size')
orig_path, thumb_path = get_image_paths(uri,
urlparts,
size,
self._orig_dir,
self._thumb_dir)
return Preview(uri,
urlparts,
orig_path,
thumb_path,
size,
widget,
from_us,
context=context)
def _on_orig_load_finished(self,
data: bytes | None,
error: Gio.AsyncResult,
preview: Preview) -> None:
if preview.thumb_path is None or preview.orig_path is None:
return
if data is None:
log.error('%s: %s', preview.orig_path.name, error)
return
preview.mime_type = guess_mime_type(preview.orig_path, data)
preview.file_size = os.path.getsize(preview.orig_path)
if preview.is_previewable:
if preview.create_thumbnail(data):
assert preview.thumbnail is not None
write_file_async(preview.thumb_path,
preview.thumbnail,
self._on_thumb_write_finished,
preview)
preview.update_widget()
@staticmethod
def _on_thumb_load_finished(data: bytes | None,
error: Gio.AsyncResult,
preview: Preview) -> None:
if preview.thumb_path is None or preview.orig_path is None:
return
if data is None:
log.error('%s: %s', preview.thumb_path.name, error)
return
preview.thumbnail = data
preview.mime_type = guess_mime_type(preview.orig_path, data)
preview.file_size = os.path.getsize(preview.orig_path)
try:
pixbuf = pixbuf_from_data(preview.thumbnail)
except Exception as err:
log.error('Unable to load: %s, %s',
preview.thumb_path.name,
err)
return
if pixbuf is None:
log.error('Unable to load pixbuf')
return
preview.update_widget(data=pixbuf)
def download_content(self,
preview: Preview,
force: bool = False
) -> None:
if preview.download_in_progress:
log.info('Download already in progress')
return
if preview.account is None:
# History Window can be opened without account context
# This means we can not apply proxy settings
return
log.info('Start downloading: %s', preview.request_uri)
request = create_http_request(preview.account)
request.set_user_data(preview)
request.connect('accept-certificate', self._accept_certificate)
request.connect('content-sniffed', self._on_content_sniffed, force)
request.connect('response-progress', self._on_response_progress)
request.send('GET', preview.request_uri, callback=self._on_finished)
def _accept_certificate(self,
request: HTTPRequest,
certificate: Gio.TlsCertificate,
certificate_errors: Gio.TlsCertificateFlags,
) -> bool:
if not app.settings.get('preview_verify_https'):
return True
phrases = get_tls_error_phrases(
convert_tls_error_flags(certificate_errors))
log.warning(
'TLS verification failed: %s (0x%02x)', phrases, certificate_errors)
preview = cast(Preview, request.get_user_data())
preview.info_message = _('TLS verification failed: %s') % phrases[0]
preview.update_widget()
return False
def _on_content_sniffed(self,
request: HTTPRequest,
content_length: int,
content_type: str,
force: bool
) -> None:
uri = request.get_uri().to_string()
preview = cast(Preview, request.get_user_data())
preview.mime_type = content_type
preview.file_size = content_length
if content_type not in ALLOWED_MIME_TYPES and not force:
log.info('Not an allowed content type: %s, %s', content_type, uri)
request.cancel()
return
if content_length > int(app.settings.get('preview_max_file_size')):
log.info(
'File size (%s) too big for URL: "%s"',
content_length, uri)
if force:
preview.info_message = None
else:
request.cancel()
preview.info_message = _('Automatic preview disabled '
'(file too big)')
preview.update_widget()
def _on_response_progress(self,
request: HTTPRequest,
progress: float,
) -> None:
preview = cast(Preview, request.get_user_data())
preview.update_progress(progress, request)
def _on_finished(self, request: HTTPRequest) -> None:
preview = cast(Preview, request.get_user_data())
preview.download_in_progress = False
if not request.is_complete():
error = request.get_error_string()
log.warning('Download failed: %s - %s', preview.request_uri, error)
if request.get_error() != HTTPRequestError.CANCELLED:
preview.info_message = _('Download failed (%s)') % error
preview.update_widget()
return
preview.info_message = None
data = request.get_data()
if not data:
return
if preview.is_aes_encrypted:
if preview.key is not None and preview.iv is not None:
try:
data = aes_decrypt(preview.key, preview.iv, data)
except Exception as error:
log.exception('Decryption failed')
preview.info_message = _('Decryption failed')
preview.update_widget()
return
if preview.mime_type == 'application/octet-stream':
if preview.orig_path is not None:
preview.mime_type = guess_mime_type(preview.orig_path, data)
write_file_async(preview.orig_path,
data,
self._on_orig_write_finished,
preview)
if not app.settings.get('enable_file_preview'):
preview.update_widget()
return
if preview.is_previewable:
if preview.create_thumbnail(data):
assert preview.thumb_path is not None
write_file_async(preview.thumb_path,
preview.thumbnail,
self._on_thumb_write_finished,
preview)
else:
preview.update_widget()
@staticmethod
def _on_orig_write_finished(_result: bool,
error: GLib.Error | None,
preview: Preview) -> None:
if preview.orig_path is None:
return
if error is not None:
log.error('%s: %s', preview.orig_path.name, error)
return
log.info('File stored: %s', preview.orig_path.name)
preview.file_size = os.path.getsize(preview.orig_path)
if not preview.is_previewable:
# Don’t update preview if thumb is already displayed,
# but update preview for audio files
preview.update_widget()
@staticmethod
def _on_thumb_write_finished(_result: bool,
error: GLib.Error | None,
preview: Preview) -> None:
if preview.thumb_path is None:
return
if error is not None:
log.error('%s: %s', preview.thumb_path.name, error)
if not preview.thumb_exists:
# Generating a preview can fail if the file already exists
# Only abort if thumbnail has not been stored in preview
return
log.info('Thumbnail stored: %s ', preview.thumb_path.name)
if preview.thumbnail is None:
return
try:
pixbuf = pixbuf_from_data(preview.thumbnail)
except Exception as err:
log.error('Unable to load: %s, %s',
preview.thumb_path.name,
err)
return
if pixbuf is None:
log.error('Unable to load pixbuf')
return
preview.update_widget(data=pixbuf)
def cancel_download(self, preview: Preview) -> None:
preview.request.cancel()
|