New plugin: Stickers

This plugin implements XEP-0449 and allows the user to send and receive stickers. Sticker packs that are not published on the user's account can be uploaded and published on sign-in, if configured. The same holds true for stickers that are published on the user's account but not locally present, except that they are downloaded on sign-in. Animated stickers, though currently only GIFs, are also supported with the ability to turn off animations.

The button that shows a menu for selecting the sticker to send is also searchable and updates when a new sticker pack gets added. It searches for matchin in either a sticker's "description" (desc) or one of its "suggests".

When a sticker is not known, the sticker pack gets automatically downloaded and added. This, however, can be turned off. In that case, a button is shown that asks the user if the sticker pack should be downloaded.

As just deleting the folder containing the sticker pack does not delete it from the account, this plugin also features a UI for removing sticker packs:

There are, however, currently two problems:

• The stickers are always sent unencrypted. At least with OMEMO, all non-whitelisted tags are filtered out before sending.
• As a rework of the conversation view is currently in progress, I would have to rewrite the plugin a bit when that MR is merged.

I should note that the plugin does not support importing or creating sticker packs. For my testing purposes I have created a script that takes a JSON representation of a sticker pack - that this plugin uses internally - and updates it so that the plugin can work with it. I feel like it is out of scope of the plugin, or at least of this first MR.

Under Linux the plugin requires stickers to be located at ~/.local/share/gajim/plugins_data/stickers/<sticker pack ID>/<sticker file>. The folder must contain a info.json file that describes the sticker pack and looks like this:

{
  "id": "0c58051a78fcd4ecf982f136",
  "name": "A sticker pack",
  "summary": "A description",
  "stickers": [
    {
      "type": "image/png",
      "hashes": [
        {
          "algo": "sha-256",
          "value": "8b76e01a4cd9ef8b3d63541459b1718b62c6073271b4e14cd0a9d3155964f13b"
        }
      ],
      "size": "14015",
      "dimension": "113x110",
      "desc": ":grin:",
      "suggests": [":blobgrin:"],
      "filename": "grin.png",
      "url": ""
    },
    [...]
  ]
}

The URL attribute of a sticker can be left empty as the plugin updates it automatically when the sticker pack has been published.

I tested this plugin on two Linux machines and it works. It requires a Gajim version newer than a290db02.

stickers/gtk/config.py

@@ -16,39 +16,16 @@
 #
 
 from gi.repository import Gtk
-from gi.repository import Gio
-from gi.repository import GObject
 
 from gajim.common.i18n import _
+from gajim.common.helpers import open_file
 from gajim.plugins.gui import GajimPluginConfigDialog
 from gajim.plugins.helpers import get_builder
 from gajim.gui.dialogs import ConfirmationDialog
 from gajim.gui.dialogs import DialogButton
 
-class StickerPackObject(GObject.GObject):
-    def __init__(self, name, summary, amount, id_):
-        self._name = name
-        self._summary = summary
-        self._amount = amount
-        self._id = id_
-
-        GObject.GObject.__init__(self)
-
-    @property
-    def name(self):
-        return self._name
-
-    @property
-    def summary(self):
-        return self._summary
-
-    @property
-    def amount(self):
-        return self._amount
-
-    @property
-    def id_(self):
-        return self._id
+from stickers.utils import sticker_data_path
+from stickers.gtk.stickers import StickerStorage
 
 class StickersConfigDialog(GajimPluginConfigDialog):
     def init(self):
@@ -59,46 +36,39 @@ class StickersConfigDialog(GajimPluginConfigDialog):
         box.pack_start(self._ui.stickers_config_dialog, True, True, 0)
         self._ui.connect_signals(self)
 
-        self._list_model = Gio.ListStore()
-        self._ui.get_object('STICKER_WIDTH').set_range(0, 400)
-        self._ui.get_object('STICKER_WIDTH').set_increments(1, -1)
-        self._ui.get_object('sticker_packs_list').bind_model(self._list_model, self._create_sticker_pack_row)
+        self._list_model = StickerStorage().get_model()
+        self._ui.sticker_width.set_range(0, 400)
+        self._ui.sticker_width.set_increments(1, -1)
+        self._ui.sticker_packs_list.bind_model(self._list_model, self._create_sticker_pack_row)
+
+        self._ui.reload_sticker_packs.connect('clicked', self.on_sticker_packs_reload_clicked)
+        self._ui.sticker_packs_location_button.connect('clicked', lambda x: open_file(sticker_data_path()))
 
         def set_wrapper(setting):
             return lambda widget: self._on_setting_changed(widget, setting)
 
-        for setting in ('DOWNLOAD_NEW', 'DOWNLOAD_NEW_SIGNIN', 'UPLOAD_NEW_SIGNIN', 'SHOW_ANIMATED_STICKERS'):
-            self._ui.get_object(setting).connect('toggled', set_wrapper(setting))
-        self._ui.get_object('STICKER_WIDTH').connect('value-changed', set_wrapper('STICKER_WIDTH'))
-
-    def on_sticker_pack_added(self, pack):
-        '''
-        Called when a new sticker pack has been added.
-        '''
-        self._list_model.append(StickerPackObject(pack.name,
-                                                  pack.summary,
-                                                  len(pack.stickers),
-                                                  pack.id_))
-
-    def on_sticker_pack_removed(self, pack):
-        '''
-        Called when a sticker pack has been removed.
-        '''
-        # Find the correct index in the ListStore
-        index = -1
-        for index_ in range(self._list_model.get_n_items()):
-            if self._list_model.get_item(index_).id_ == pack.id_:
-                index = index_
-                break
-
-        if index != -1:
-            self._list_model.remove(index)
+        for setting in ('download_new', 'download_new_signin', 'upload_new_signin', 'show_animated_stickers'):
+            getattr(self._ui, setting).set_active(self.plugin.config[setting.upper()])
+            getattr(self._ui, setting).connect('toggled', set_wrapper(setting.upper()))
+        self._ui.sticker_width.connect('value-changed', set_wrapper('STICKER_WIDTH'))
+
+    def on_sticker_packs_reload_clicked(self, button):
+        def reload_sticker_packs():
+            self.plugin.reload_sticker_packs()
+
+        ConfirmationDialog(
+                _('Reload Sticker Packs'),
+                _('Are you sure you want to reload all sticker packs?'),
+                _('Depending on the amount of installed sticker packs this might take some time.'),
+                [DialogButton.make('Cancel'),
+                 DialogButton.make('Accept',
+                                   callback=reload_sticker_packs)]).show()
 
     def on_run(self):
         # Update all config settings
-        for setting in ('DOWNLOAD_NEW', 'DOWNLOAD_NEW_SIGNIN', 'UPLOAD_NEW_SIGNIN', 'SHOW_ANIMATED_STICKERS'):
-            self._ui.get_object(setting).set_active(self.plugin.config[setting])
-        self._ui.get_object('STICKER_WIDTH').set_value(self.plugin.config['STICKER_WIDTH'])
+        for setting in ('download_new', 'download_new_signin', 'upload_new_signin', 'show_animated_stickers'):
+            getattr(self._ui, setting).set_active(self.plugin.config[setting.upper()])
+        self._ui.sticker_width.set_value(self.plugin.config['STICKER_WIDTH'])
 
     def _on_setting_changed(self, widget, data):
         if isinstance(widget, Gtk.CheckButton):
@@ -110,7 +80,7 @@ class StickersConfigDialog(GajimPluginConfigDialog):
 
     def _on_delete_button_clicked(self, id_):
         def delete_sticker_pack():
-            self.plugin.delete_sticker_pack(id_)
+            self.plugin.retract_sticker_pack(id_)
 
         ConfirmationDialog(
                 _('Delete Sticker Pack'),
@@ -120,11 +90,21 @@ class StickersConfigDialog(GajimPluginConfigDialog):
                  DialogButton.make('Remove',
                                    callback=delete_sticker_pack)]).show()
 
+    def _on_upload_button_clicked(self, id_):
+        self.plugin.upload_sticker_pack(id_)
+
     def _create_sticker_pack_row(self, pack):
         item = get_builder(self.plugin.local_file_path('gtk/config_stickers_listitem.ui'))
-        item.get_object('header').set_markup(_('<b>%s</b>') % pack.name)
-        item.get_object('summary').set_text(pack.summary)
-        item.get_object('amount').set_text(_('%s stickers') % pack.amount)
-        item.get_object('delete_button').connect('clicked', lambda x: self._on_delete_button_clicked(pack.id_))
-
-        return item.get_object('sticker_pack_list_item')
+        # TODO: If available, display the localized version of the sticker pack's
+        #       name and summary
+        item.header.set_markup(f'<b>{pack.name}</b>')
+        item.summary.set_text(pack.summary)
+        item.amount.set_text(_('%s stickers') % pack.amount)
+        item.delete_button.connect('clicked', lambda x: self._on_delete_button_clicked(pack.id_))
+
+        if pack.uploaded:
+            item.upload_button.destroy()
+        else:
+            item.upload_button.connect('clicked', lambda x: self._on_upload_button_clicked(pack.id_))
+
+        return item.sticker_pack_list_item