hueso/gajim-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[preview] Rewrite plugin

Browse Source
This commit is contained in:
Philipp Hörist
2019-12-25 23:52:56 +01:00
parent ba0b11294a
commit 25bf2d4ed5
6 changed files with 794 additions and 817 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
url_image_preview/config_dialog.py
View File

@@ -21,7 +21,6 @@ from gi.repository import GObject
from gi.repository import Gtk
from gajim.gtk.settings import SettingsDialog
from gajim.gtk.settings import GenericSetting
from gajim.gtk.settings import SpinSetting
from gajim.gtk.const import Setting
from gajim.gtk.const import SettingKind
@@ -40,16 +39,11 @@ class UrlImagePreviewConfigDialog(SettingsDialog):
('10485760', '10 MiB')]
actions = [
('open_menuitem', _('Open')),
('save_as_menuitem', _('Save as')),
('open_folder_menuitem', _('Open Folder')),
('copy_link_location_menuitem', _('Copy Link Location')),
('open_link_in_browser_menuitem', _('Open Link in Browser'))]
geo_providers = [
('no_preview', _('No map preview')),
('Google', _('Google Maps')),
('OSM', _('OpenStreetMap'))]
('open', _('Open')),
('save_as', _('Save as')),
('open_folder', _('Open Folder')),
('copy_link_location', _('Copy Link Location')),
('open_link_in_browser', _('Open Link in Browser'))]
self.plugin = plugin
settings = [
@@ -77,12 +71,6 @@ class UrlImagePreviewConfigDialog(SettingsDialog):
desc=_('Action when left clicking a preview'),
props={'combo_items': actions}),
Setting(SettingKind.COMBO, _('Map Service'),
SettingType.VALUE, self.plugin.config['GEO_PREVIEW_PROVIDER'],
callback=self.on_setting, data='GEO_PREVIEW_PROVIDER',
desc=_('Service used for map previews'),
props={'combo_items': geo_providers}),
Setting(SettingKind.SWITCH, _('HTTPS Verification'),
SettingType.VALUE, self.plugin.config['VERIFY'],
desc=_('Whether to check for a valid certificate'),
@@ -91,8 +79,8 @@ class UrlImagePreviewConfigDialog(SettingsDialog):
SettingsDialog.__init__(self, parent, _('UrlImagePreview Configuration'),
Gtk.DialogFlags.MODAL, settings, None,
extend=[
('PreviewSizeSpinSetting', SizeSpinSetting)])
extend=[('PreviewSizeSpinSetting',
SizeSpinSetting)])
def on_setting(self, value, data):
self.plugin.config[data] = value

10
url_image_preview/context_menu.ui
View File

@@ -5,7 +5,7 @@
<object class="GtkMenu" id="context_menu">
<property name="can_focus">False</property>
<child>
<object class="GtkMenuItem" id="open_menuitem">
<object class="GtkMenuItem" id="open">
<property name="visible">True</property>
<property name="can_focus">False</property>
<property name="label" translatable="yes">_Open</property>
@@ -13,7 +13,7 @@
</object>
</child>
<child>
<object class="GtkMenuItem" id="save_as_menuitem">
<object class="GtkMenuItem" id="save_as">
<property name="visible">True</property>
<property name="can_focus">False</property>
<property name="label" translatable="yes">_Save as</property>
@@ -21,7 +21,7 @@
</object>
</child>
<child>
<object class="GtkMenuItem" id="open_folder_menuitem">
<object class="GtkMenuItem" id="open_folder">
<property name="visible">True</property>
<property name="can_focus">False</property>
<property name="label" translatable="yes">Open _Folder</property>
@@ -35,7 +35,7 @@
</object>
</child>
<child>
<object class="GtkMenuItem" id="copy_link_location_menuitem">
<object class="GtkMenuItem" id="copy_link_location">
<property name="visible">True</property>
<property name="can_focus">False</property>
<property name="label" translatable="yes">_Copy Link</property>
@@ -43,7 +43,7 @@
</object>
</child>
<child>
<object class="GtkMenuItem" id="open_link_in_browser_menuitem">
<object class="GtkMenuItem" id="open_link_in_browser">
<property name="visible">True</property>
<property name="can_focus">False</property>
<property name="label" translatable="yes">Open Link in _Browser</property>

115
url_image_preview/http_functions.py
View File

@@ -1,115 +0,0 @@
# -*- coding: utf-8 -*-
##
## 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/>.
##
import urllib.request as urllib2
import socket
import ssl
import logging
import os
from gajim.common import app
from gajim.plugins.plugins_i18n import _
if os.name == 'nt':
import certifi
log = logging.getLogger('gajim.p.preview.http_functions')
def get_http_head(account, url, verify):
return _get_http_head_direct(url, verify)
def get_http_file(account, attrs):
return _get_http_direct(attrs)
def _get_http_head_direct(url, verify):
log.info('Head request direct for URL: %s', url)
try:
req = urllib2.Request(url)
req.get_method = lambda: 'HEAD'
req.add_header('User-Agent', 'Gajim %s' % app.version)
if not verify:
context = ssl.create_default_context()
context.check_hostname = False
context.verify_mode = ssl.CERT_NONE
log.warning('CERT Verification disabled')
file_ = urllib2.urlopen(req, timeout=30, context=context)
else:
if os.name == 'nt':
file_ = urllib2.urlopen(req, cafile=certifi.where())
else:
file_ = urllib2.urlopen(req)
except Exception as ex:
log.debug('Error', exc_info=True)
return ('', 0)
ctype = file_.headers['Content-Type']
clen = file_.headers['Content-Length']
try:
clen = int(clen)
except (TypeError, ValueError):
pass
return (ctype, clen)
def _get_http_direct(attrs):
'''
Download a file. This function should
be launched in a separated thread.
'''
log.info('Get request direct for URL: %s', attrs['src'])
mem, alt, max_size = b'', '', 2 * 1024 * 1024
if 'max_size' in attrs:
max_size = attrs['max_size']
try:
req = urllib2.Request(attrs['src'])
req.add_header('User-Agent', 'Gajim ' + app.version)
if not attrs['verify']:
context = ssl.create_default_context()
context.check_hostname = False
context.verify_mode = ssl.CERT_NONE
log.warning('CERT Verification disabled')
file_ = urllib2.urlopen(req, timeout=30, context=context)
else:
if os.name == 'nt':
file_ = urllib2.urlopen(req, cafile=certifi.where())
else:
file_ = urllib2.urlopen(req)
except Exception as ex:
log.debug('Error', exc_info=True)
pixbuf = None
alt = attrs.get('alt', 'Broken image')
else:
while True:
try:
temp = file_.read(100)
except socket.timeout as ex:
log.debug('Timeout loading image %s', attrs['src'] + str(ex))
alt = attrs.get('alt', '')
if alt:
alt += '\n'
alt += _('Timeout loading image')
break
if temp:
mem += temp
else:
break
if len(mem) > max_size:
alt = attrs.get('alt', '')
if alt:
alt += '\n'
alt += _('Image is too big')
break
return (mem, alt)

90
url_image_preview/resize_gif.py
View File

@@ -1,90 +0,0 @@
from io import BytesIO
from PIL import Image
def resize_gif(mem, path, resize_to):
frames, result = extract_and_resize_frames(mem, resize_to)
if len(frames) == 1:
frames[0].save(path, optimize=True)
else:
frames[0].save(path,
optimize=True,
save_all=True,
append_images=frames[1:],
duration=result['duration'],
loop=1000)
def analyse_image(mem):
'''
Pre-process pass over the image to determine the mode (full or additive).
Necessary as assessing single frames isn't reliable. Need to know the mode
before processing all frames.
'''
image = Image.open(BytesIO(mem))
results = {
'size': image.size,
'mode': 'full',
'duration': image.info.get('duration', 0)
}
try:
while True:
if image.tile:
tile = image.tile[0]
update_region = tile[1]
update_region_dimensions = update_region[2:]
if update_region_dimensions != image.size:
results['mode'] = 'partial'
break
image.seek(image.tell() + 1)
except EOFError:
pass
return results
def extract_and_resize_frames(mem, resize_to):
result = analyse_image(mem)
image = Image.open(BytesIO(mem))
i = 0
palette = image.getpalette()
last_frame = image.convert('RGBA')
frames = []
try:
while True:
'''
If the GIF uses local colour tables,
each frame will have its own palette.
If not, we need to apply the global palette to the new frame.
'''
if not image.getpalette():
image.putpalette(palette)
new_frame = Image.new('RGBA', image.size)
'''
Is this file a "partial"-mode GIF where frames update a region
of a different size to the entire image?
If so, we need to construct the new frame by
pasting it on top of the preceding frames.
'''
if result['mode'] == 'partial':
new_frame.paste(last_frame)
new_frame.paste(image, (0, 0), image.convert('RGBA'))
# This method preservs aspect ratio
new_frame.thumbnail(resize_to, Image.ANTIALIAS)
frames.append(new_frame)
i += 1
last_frame = new_frame
image.seek(image.tell() + 1)
except EOFError:
pass
return frames, result

1017
url_image_preview/url_image_preview.py
View File

File diff suppressed because it is too large Load Diff

353
url_image_preview/utils.py Normal file
View File

@@ -0,0 +1,353 @@
# This file is part of Image Preview Gajim Plugin.
#
# Image Preview Gajim Plugin 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.
#
# Image Preview Gajim Plugin 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 Image Preview Gajim Plugin.
# If not, see <http://www.gnu.org/licenses/>.
import math
import logging
import binascii
import hashlib
from io import BytesIO
from collections import namedtuple
from pathlib import Path
from urllib.parse import urlparse
from urllib.parse import unquote
from gi.repository import GdkPixbuf
from gi.repository import GLib
from gi.repository import Gtk
from PIL import Image
from cryptography.hazmat.backends import default_backend
from cryptography.hazmat.primitives.ciphers import Cipher
from cryptography.hazmat.primitives.ciphers import algorithms
from cryptography.hazmat.primitives.ciphers.modes import GCM
from gajim.gtk.util import get_cursor
log = logging.getLogger('gajim.p.preview.utils')
Coords = namedtuple('Coords', 'location lat lon')
def resize_gif(image, output_file, resize_to):
frames, result = extract_and_resize_frames(image, resize_to)
frames[0].save(output_file,
format='GIF',
optimize=True,
save_all=True,
append_images=frames[1:],
duration=result['duration'],
loop=1000)
def analyse_image(image):
'''
Pre-process pass over the image to determine the mode (full or additive).
Necessary as assessing single frames isn't reliable. Need to know the mode
before processing all frames.
'''
result = {
'size': image.size,
'mode': 'full',
'duration': image.info.get('duration', 0)
}
try:
while True:
if image.tile:
tile = image.tile[0]
update_region = tile[1]
update_region_dimensions = update_region[2:]
if update_region_dimensions != image.size:
result['mode'] = 'partial'
break
image.seek(image.tell() + 1)
except EOFError:
image.seek(0)
return image, result
def extract_and_resize_frames(image, resize_to):
image, result = analyse_image(image)
i = 0
palette = image.getpalette()
last_frame = image.convert('RGBA')
frames = []
try:
while True:
'''
If the GIF uses local colour tables,
each frame will have its own palette.
If not, we need to apply the global palette to the new frame.
'''
if not image.getpalette():
image.putpalette(palette)
new_frame = Image.new('RGBA', image.size)
'''
Is this file a "partial"-mode GIF where frames update a region
of a different size to the entire image?
If so, we need to construct the new frame by
pasting it on top of the preceding frames.
'''
if result['mode'] == 'partial':
new_frame.paste(last_frame)
new_frame.paste(image, (0, 0), image.convert('RGBA'))
# This method preservs aspect ratio
new_frame.thumbnail(resize_to, Image.ANTIALIAS)
frames.append(new_frame)
i += 1
last_frame = new_frame
image.seek(image.tell() + 1)
except EOFError:
pass
return frames, result
def create_thumbnail(data, size):
thumbnail = create_thumbnail_with_pil(data, size)
if thumbnail is not None:
return thumbnail
return create_thumbnail_with_pixbuf(data, size)
def create_thumbnail_with_pixbuf(data, size):
loader = GdkPixbuf.PixbufLoader()
try:
loader.write(data)
except GLib.Error as error:
log.warning('making pixbuf failed: %s', error)
return None
loader.close()
pixbuf = loader.get_pixbuf()
if size > pixbuf.get_width() and size > pixbuf.get_height():
return data
width, height = get_thumbnail_size(pixbuf, size)
thumbnail = pixbuf.scale_simple(width,
height,
GdkPixbuf.InterpType.BILINEAR)
has_error, bytes_ = thumbnail.save_to_bufferv('png', [], [])
if has_error:
log.warning('saving pixbuf to buffer failed')
return None
return bytes_
def create_thumbnail_with_pil(data, size):
input_file = BytesIO(data)
output_file = BytesIO()
try:
image = Image.open(input_file)
except OSError as error:
log.warning('making pil thumbnail failed: %s', error)
log.warning('fallback to pixbuf')
input_file.close()
output_file.close()
return
image_width, image_height = image.size
if size > image_width and size > image_height:
image.close()
input_file.close()
output_file.close()
return data
if image.format == 'GIF' and image.n_frames > 1:
resize_gif(image, output_file, (size, size))
else:
image.thumbnail((size, size))
image.save(output_file,
format=image.format,
optimize=True)
bytes_ = output_file.getvalue()
image.close()
input_file.close()
output_file.close()
return bytes_
def get_thumbnail_size(pixbuf, size):
# Calculates the new thumbnail size while preserving the aspect ratio
image_width = pixbuf.get_width()
image_height = pixbuf.get_height()
if image_width > image_height:
if image_width > size:
image_height = math.ceil((size / float(image_width) * image_height))
image_width = int(size)
else:
if image_height > size:
image_width = math.ceil((size / float(image_height) * image_width))
image_height = int(size)
return image_width, image_height
def pixbuf_from_data(data):
loader = GdkPixbuf.PixbufLoader()
try:
loader.write(data)
except GLib.Error:
# Fallback to Pillow
input_file = BytesIO(data)
image = Image.open(BytesIO(data)).convert('RGBA')
array = GLib.Bytes.new(image.tobytes())
width, height = image.size
pixbuf = GdkPixbuf.Pixbuf.new_from_bytes(array,
GdkPixbuf.Colorspace.RGB,
True,
8,
width,
height,
width * 4)
image.close()
input_file.close()
return pixbuf
loader.close()
return loader.get_pixbuf()
def create_clickable_image(pixbuf, preview):
if isinstance(pixbuf, GdkPixbuf.PixbufAnimation):
image = Gtk.Image.new_from_animation(pixbuf)
else:
image = Gtk.Image.new_from_pixbuf(pixbuf)
css = '''#Preview {
box-shadow: 0px 0px 3px 0px alpha(@theme_text_color, 0.2);
margin: 5px 10px 5px 10px; }'''
provider = Gtk.CssProvider()
provider.load_from_data(bytes(css.encode()))
context = image.get_style_context()
context.add_provider(provider,
Gtk.STYLE_PROVIDER_PRIORITY_USER)
image.set_name('Preview')
def _on_realize(box):
box.get_window().set_cursor(get_cursor('pointer'))
event_box = Gtk.EventBox()
event_box.connect('realize', _on_realize)
event_box.set_tooltip_text(preview.uri)
event_box.add(image)
event_box.show_all()
return event_box
def parse_fragment(fragment):
if not fragment:
raise ValueError('Invalid fragment')
fragment = binascii.unhexlify(fragment)
key = fragment[16:]
iv = fragment[:16]
if len(key) != 32 or len(iv) != 16:
raise ValueError('Invalid fragment')
return key, iv
def get_image_paths(uri, urlparts, size, orig_dir, thumb_dir):
path = Path(urlparts.path)
web_stem = path.stem
extension = path.suffix
if len(web_stem) > 90:
# Many Filesystems have a limit on filename length
# Most have 255, some encrypted ones only 143
# We add around 50 chars for the hash,
# so the filename should not exceed 90
web_stem = web_stem[:90]
name_hash = hashlib.sha1(str(uri).encode()).hexdigest()
orig_filename = '%s_%s%s' % (web_stem, name_hash, extension)
thumb_filename = '%s_%s_thumb_%s%s' % (web_stem,
name_hash,
size,
extension)
orig_path = Path(orig_dir) / orig_filename
thumb_path = Path(thumb_dir) / thumb_filename
return orig_path, thumb_path
def split_geo_uri(uri):
# Example:
# geo:37.786971,-122.399677,122.3;CRS=epsg:32718;U=20;mapcolors=abc
# Assumption is all coordinates are CRS=WGS-84
# Remove "geo:"
coords = uri[4:]
# Remove arguments
if ';' in coords:
coords, _ = coords.split(';', maxsplit=1)
# Split coords
coords = coords.split(',')
if len(coords) not in (2, 3):
raise ValueError('Invalid geo uri: invalid coord count')
# Remoove coord-c (altitude)
if len(coords) == 3:
coords.pop(2)
lat, lon = coords
if float(lat) < -90 or float(lat) > 90:
raise ValueError('Invalid geo_uri: invalid latitude %s' % lat)
if float(lon) < -180 or float(lon) > 180:
raise ValueError('Invalid geo_uri: invalid longitude %s' % lon)
location = ','.join(coords)
return Coords(location=location, lat=lat, lon=lon)
def filename_from_uri(uri):
urlparts = urlparse(unquote(uri))
path = Path(urlparts.path)
return path.name
def aes_decrypt(preview, payload):
# Use AES128 GCM with the given key and iv to decrypt the payload
data = payload[:-16]
tag = payload[-16:]
decryptor = Cipher(
algorithms.AES(preview.key),
GCM(preview.iv, tag=tag),
backend=default_backend()).decryptor()
return decryptor.update(data) + decryptor.finalize()