Migrate to libpeas-2 (#1501)

jeremypw · leonardo-lemos · web-flow · commit 79d804993b47 · 2025-05-17T14:23:46.000-03:00
* First compilable version

* Emulate previous appearance of Plugins view

* Update ci.yml

* Update io.elementary.code.yml

* Bump glib dependency for libpeas-2

* Rename non-functional Flatpak manifest

* Sync checkbutton with plugin loaded on show

* Action when checkbox toggled

* Fix double parenting

* Sort plugins by name

* Use bind_model and factory

* Lose unused entities

* Cleanup and code style

* Fix initial appearance of preferences dialog

* Add some comments

* Lose commented out code

* Make activate and deactivate methods mandatory to implement

* Fix Flatpak build for OS8

* Fix libsoup3.0-dev dependency

* Fix libsoup name

* Fix ninja build install command

* Revert to '7.1' Sdk

* Update libpeas dependency in README.md

---------

Co-authored-by: Leonardo Lemos &lt;leonardolemos@live.com&gt;
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -22,7 +22,7 @@ jobs:
     - name: Install Dependencies
       run: |
         apt update
-        apt install -y exuberant-ctags libeditorconfig-dev libgail-3-dev libgee-0.8-dev libgit2-glib-1.0-dev libgranite-dev libgtk-3-dev libgtksourceview-4-dev libgtkspell3-3-dev libhandy-1-dev libpeas-dev libsoup2.4-dev libvala-dev libvte-2.91-dev meson valac polkitd libpolkit-gobject-1-dev
+        apt install -y exuberant-ctags libeditorconfig-dev libgail-3-dev libgee-0.8-dev libgit2-glib-1.0-dev libgranite-dev libgtk-3-dev libgtksourceview-4-dev libgtkspell3-3-dev libhandy-1-dev libpeas-2-dev libsoup-3.0-dev libvala-dev libvte-2.91-dev meson valac polkitd libpolkit-gobject-1-dev
     - name: Build
       env:
         DESTDIR: out
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ You'll need the following dependencies:
 * libgtkspell3-3-dev
 * libgranite-dev >= 6.0.0
 * libhandy-1-dev >= 0.90.0
-* libpeas-dev
+* libpeas-2-dev
 * libsoup2.4-dev
 * libvala-0.48-dev (or higher)
 * libvte-2.91-dev
diff --git a/io.elementary.code.yml b/io.elementary.code.yml
@@ -33,16 +33,20 @@ modules:
         url: https://gitlab.gnome.org/GNOME/gtksourceview.git
         tag: '4.8.4'
 
-  - name: peas
+  - name: libpeas
     buildsystem: meson
     config-opts:
-      - '-Dgtk_doc=false'
-      - '-Ddemos=false'
-      - '-Dvapi=true'
+      - -Dlua51=false
+      - -Dgjs=false
     sources:
-      - type: git
-        url: https://gitlab.gnome.org/GNOME/libpeas.git
-        tag: libpeas-1.34.0
+      - type: archive
+        url: https://download.gnome.org/sources/libpeas/2.0/libpeas-2.0.5.tar.xz
+        sha256: 376f2f73d731b54e13ddbab1d91b6382cf6a980524def44df62add15489de6dd
+        x-checker-data:
+          type: gnome
+          versions:
+            <: '2.0.6'
+          name: libpeas
 
   - name: git2-glib
     buildsystem: meson
diff --git a/meson.build b/meson.build
@@ -26,15 +26,14 @@ pluginsdir = get_option('prefix') / get_option('libdir') / meson.project_name()
 gnome = import('gnome')
 i18n = import('i18n')
 
-glib_dep = dependency('glib-2.0', version: '>=2.30.0')
+glib_dep = dependency('glib-2.0', version: '>=2.74.0')
 gio_unix_dep = dependency('gio-unix-2.0', version: '>=2.20')
 gee_dep = dependency('gee-0.8', version: '>=0.8.5')
 gtk_dep = dependency('gtk+-3.0', version: '>=3.6.0')
 granite_dep = dependency('granite', version: '>=6.0.0')
 handy_dep = dependency('libhandy-1', version: '>=0.90.0')
 gtksourceview_dep = dependency('gtksourceview-4')
-peas_dep = dependency('libpeas-1.0')
-peasgtk_dep = dependency('libpeas-gtk-1.0')
+peas_dep = dependency('libpeas-2')
 git_dep = dependency('libgit2-glib-1.0')
 fontconfig_dep = dependency('fontconfig')
 pangofc_dep = dependency('pangoft2')
@@ -59,7 +58,6 @@ dependencies = [
     handy_dep,
     gtksourceview_dep,
     peas_dep,
-    peasgtk_dep,
     git_dep,
     fontconfig_dep,
     pangofc_dep,
diff --git a/plugins/brackets-completion/brackets-completion.vala b/plugins/brackets-completion/brackets-completion.vala
@@ -18,7 +18,7 @@
   END LICENSE
 ***/
 
-public class Scratch.Plugins.BracketsCompletion : Peas.ExtensionBase, Peas.Activatable {
+public class Scratch.Plugins.BracketsCompletion : Peas.ExtensionBase, Scratch.Services.ActivatablePlugin {
     Gee.HashMap<string, string> brackets;
     Gee.HashMap<uint, string> keys;
     const string[] VALID_NEXT_CHARS = {
@@ -278,6 +278,6 @@ public class Scratch.Plugins.BracketsCompletion : Peas.ExtensionBase, Peas.Activ
 [ModuleInit]
 public void peas_register_types (GLib.TypeModule module) {
     var objmodule = module as Peas.ObjectModule;
-    objmodule.register_extension_type (typeof (Peas.Activatable),
+    objmodule.register_extension_type (typeof (Scratch.Services.ActivatablePlugin),
                                      typeof (Scratch.Plugins.BracketsCompletion));
 }
diff --git a/plugins/detect-indent/detect-indent.vala b/plugins/detect-indent/detect-indent.vala
@@ -1,4 +1,4 @@
-public class Scratch.Plugins.DetectIndent: Peas.ExtensionBase, Peas.Activatable {
+public class Scratch.Plugins.DetectIndent: Peas.ExtensionBase, Scratch.Services.ActivatablePlugin {
     const int MAX_LINES = 500;
 
     Scratch.Services.Interface plugins;
@@ -79,7 +79,7 @@ public class Scratch.Plugins.DetectIndent: Peas.ExtensionBase, Peas.Activatable
 public void peas_register_types (GLib.TypeModule module) {
     var objmodule = module as Peas.ObjectModule;
     objmodule.register_extension_type (
-        typeof (Peas.Activatable),
+        typeof (Scratch.Services.ActivatablePlugin),
         typeof (Scratch.Plugins.DetectIndent)
     );
 }
diff --git a/plugins/editorconfig/editorconfig.vala b/plugins/editorconfig/editorconfig.vala
@@ -17,7 +17,7 @@
 * Boston, MA 02110-1301 USA
 */
 
-public class Scratch.Plugins.EditorConfigPlugin: Peas.ExtensionBase, Peas.Activatable {
+public class Scratch.Plugins.EditorConfigPlugin: Peas.ExtensionBase, Scratch.Services.ActivatablePlugin {
     Scratch.Services.Interface plugins;
     public Object object { owned get; construct; }
     private Code.FormatBar format_bar;
@@ -96,5 +96,5 @@ public class Scratch.Plugins.EditorConfigPlugin: Peas.ExtensionBase, Peas.Activa
 [ModuleInit]
 public void peas_register_types (GLib.TypeModule module) {
     var objmodule = module as Peas.ObjectModule;
-    objmodule.register_extension_type (typeof (Peas.Activatable), typeof (Scratch.Plugins.EditorConfigPlugin));
+    objmodule.register_extension_type (typeof (Scratch.Services.ActivatablePlugin), typeof (Scratch.Plugins.EditorConfigPlugin));
 }
diff --git a/plugins/fuzzy-search/fuzzy-search.vala b/plugins/fuzzy-search/fuzzy-search.vala
@@ -6,7 +6,7 @@
  */
 
 
-public class Scratch.Plugins.FuzzySearch: Peas.ExtensionBase, Peas.Activatable {
+public class Scratch.Plugins.FuzzySearch: Peas.ExtensionBase, Scratch.Services.ActivatablePlugin {
     public Object object { owned get; construct; }
     private const uint ACCEL_KEY = Gdk.Key.F;
     private const Gdk.ModifierType ACCEL_MODTYPE = Gdk.ModifierType.MOD1_MASK;
@@ -158,7 +158,7 @@ public class Scratch.Plugins.FuzzySearch: Peas.ExtensionBase, Peas.Activatable {
 public void peas_register_types (GLib.TypeModule module) {
     var objmodule = module as Peas.ObjectModule;
     objmodule.register_extension_type (
-        typeof (Peas.Activatable),
+        typeof (Scratch.Services.ActivatablePlugin),
         typeof (Scratch.Plugins.FuzzySearch)
     );
 }
diff --git a/plugins/highlight-word-selection/highlight-word-selection.vala b/plugins/highlight-word-selection/highlight-word-selection.vala
@@ -18,7 +18,7 @@
   END LICENSE
 ***/
 
-public class Scratch.Plugins.HighlightSelectedWords : Peas.ExtensionBase, Peas.Activatable {
+public class Scratch.Plugins.HighlightSelectedWords : Peas.ExtensionBase, Scratch.Services.ActivatablePlugin {
     Scratch.Widgets.SourceView current_source;
     Scratch.MainWindow? main_window = null;
     Gtk.SourceSearchContext? current_search_context = null;
@@ -145,6 +145,6 @@ public class Scratch.Plugins.HighlightSelectedWords : Peas.ExtensionBase, Peas.A
 [ModuleInit]
 public void peas_register_types (TypeModule module) {
     var objmodule = module as Peas.ObjectModule;
-    objmodule.register_extension_type (typeof (Peas.Activatable),
+    objmodule.register_extension_type (typeof (Scratch.Services.ActivatablePlugin),
                                      typeof (Scratch.Plugins.HighlightSelectedWords));
 }
diff --git a/plugins/markdown-actions/markdown-actions.vala b/plugins/markdown-actions/markdown-actions.vala
@@ -18,7 +18,7 @@
   END LICENSE
 ***/
 
-public class Code.Plugins.MarkdownActions : Peas.ExtensionBase, Peas.Activatable {
+public class Code.Plugins.MarkdownActions : Peas.ExtensionBase, Scratch.Services.ActivatablePlugin {
     Scratch.Widgets.SourceView current_source;
     Scratch.Services.Interface plugins;
 
@@ -243,6 +243,6 @@ public class Code.Plugins.MarkdownActions : Peas.ExtensionBase, Peas.Activatable
 [ModuleInit]
 public void peas_register_types (TypeModule module) {
     var objmodule = module as Peas.ObjectModule;
-    objmodule.register_extension_type (typeof (Peas.Activatable),
+    objmodule.register_extension_type (typeof (Scratch.Services.ActivatablePlugin),
                                      typeof (Code.Plugins.MarkdownActions));
 }
diff --git a/plugins/pastebin/meson.build b/plugins/pastebin/meson.build
@@ -5,7 +5,7 @@ module_files = [
     'pastebin.vala'
 ]
 
-soup_dep = dependency('libsoup-2.4')
+soup_dep = dependency('libsoup-3.0')
 
 module_deps = [
     codecore_dep,
diff --git a/plugins/pastebin/pastebin.vala b/plugins/pastebin/pastebin.vala
@@ -34,6 +34,7 @@ namespace Scratch.Services {
                                      string paste_private, string paste_expire_date,
                                      string paste_format) {
 
+            link = null;
             if (paste_code.length == 0) { link = "No text to paste"; return false; }
 
             string api_url = "https://pastebin.com/api/api_post.php";
@@ -50,15 +51,21 @@ namespace Scratch.Services {
                 "api_paste_expire_date", paste_expire_date,
                 "api_paste_format", paste_format);
 
-            message.set_request ("application/x-www-form-urlencoded", Soup.MemoryUse.COPY, request.data);
+            message.set_request_body_from_bytes ("application/x-www-form-urlencoded", new Bytes (request.data));
             message.set_flags (Soup.MessageFlags.NO_REDIRECT);
 
-            session.send_message (message);
+            Bytes output;
+            try {
+                output = session.send_and_read (message);
+            } catch (Error e) {
+                return false;
+            }
+
 
-            var output = (string) message.response_body.data;
-            link = output;
+            var output_s = (string) output.get_data ();
+            link = output_s;
 
-            if (Uri.parse_scheme (output) == null || message.status_code != 200) {
+            if (Uri.parse_scheme (output_s) == null || message.status_code != 200) {
                 // A URI was not returned
                 return false;
             }
@@ -68,7 +75,7 @@ namespace Scratch.Services {
     }
 }
 
-public class Scratch.Plugins.Pastebin : Peas.ExtensionBase, Peas.Activatable {
+public class Scratch.Plugins.Pastebin : Peas.ExtensionBase, Scratch.Services.ActivatablePlugin {
     GLib.MenuItem? menuitem = null;
     GLib.Menu? share_menu = null;
     public Object object { owned get; construct; }
@@ -147,6 +154,6 @@ public class Scratch.Plugins.Pastebin : Peas.ExtensionBase, Peas.Activatable {
 [ModuleInit]
 public void peas_register_types (GLib.TypeModule module) {
     var objmodule = module as Peas.ObjectModule;
-    objmodule.register_extension_type (typeof (Peas.Activatable),
+    objmodule.register_extension_type (typeof (Scratch.Services.ActivatablePlugin),
                                      typeof (Scratch.Plugins.Pastebin));
 }
diff --git a/plugins/preserve-indent/preserve-indent.vala b/plugins/preserve-indent/preserve-indent.vala
@@ -18,7 +18,7 @@
   END LICENSE
 ***/
 
-public class Scratch.Plugins.PreserveIndent : Peas.ExtensionBase, Peas.Activatable {
+public class Scratch.Plugins.PreserveIndent : Peas.ExtensionBase, Scratch.Services.ActivatablePlugin {
 
     private Scratch.Services.Interface plugins;
     private Gee.TreeSet<weak Services.Document> documents;
@@ -244,6 +244,6 @@ public class Scratch.Plugins.PreserveIndent : Peas.ExtensionBase, Peas.Activatab
 [ModuleInit]
 public void peas_register_types (GLib.TypeModule module) {
     var objmodule = module as Peas.ObjectModule;
-    objmodule.register_extension_type (typeof (Peas.Activatable),
+    objmodule.register_extension_type (typeof (Scratch.Services.ActivatablePlugin),
                                      typeof (Scratch.Plugins.PreserveIndent));
 }
diff --git a/plugins/spell/spell.vala b/plugins/spell/spell.vala
@@ -13,7 +13,7 @@
  * with this program.  If not, see <http://www.gnu.org/licenses/>
  */
 
-public class Scratch.Plugins.Spell: Peas.ExtensionBase, Peas.Activatable {
+public class Scratch.Plugins.Spell: Peas.ExtensionBase, Scratch.Services.ActivatablePlugin {
 
     Scratch.Services.Interface plugins;
 
@@ -160,7 +160,7 @@ public class Scratch.Plugins.Spell: Peas.ExtensionBase, Peas.Activatable {
 public void peas_register_types (GLib.TypeModule module) {
     var objmodule = module as Peas.ObjectModule;
     objmodule.register_extension_type (
-        typeof (Peas.Activatable),
+        typeof (Scratch.Services.ActivatablePlugin),
         typeof (Scratch.Plugins.Spell)
     );
 }
diff --git a/plugins/vim-emulation/vim-emulation.vala b/plugins/vim-emulation/vim-emulation.vala
@@ -18,7 +18,7 @@
   END LICENSE
 ***/
 
-public class Scratch.Plugins.VimEmulation : Peas.ExtensionBase, Peas.Activatable {
+public class Scratch.Plugins.VimEmulation : Peas.ExtensionBase, Scratch.Services.ActivatablePlugin {
     public enum Mode {
         COMMAND,
         INSERT,
@@ -298,6 +298,6 @@ public class Scratch.Plugins.VimEmulation : Peas.ExtensionBase, Peas.Activatable
 [ModuleInit]
 public void peas_register_types (GLib.TypeModule module) {
     var objmodule = module as Peas.ObjectModule;
-    objmodule.register_extension_type (typeof (Peas.Activatable),
+    objmodule.register_extension_type (typeof (Scratch.Services.ActivatablePlugin),
                                      typeof (Scratch.Plugins.VimEmulation));
 }
diff --git a/plugins/word-completion/plugin.vala b/plugins/word-completion/plugin.vala
@@ -18,7 +18,7 @@
  *
  */
 
-public class Scratch.Plugins.Completion : Peas.ExtensionBase, Peas.Activatable {
+public class Scratch.Plugins.Completion : Peas.ExtensionBase, Scratch.Services.ActivatablePlugin {
     public const uint INTERACTIVE_DELAY = 500;
 
     public Object object { owned get; construct; }
@@ -185,6 +185,6 @@ public class Scratch.Plugins.Completion : Peas.ExtensionBase, Peas.Activatable {
 [ModuleInit]
 public void peas_register_types (GLib.TypeModule module) {
     var objmodule = module as Peas.ObjectModule;
-    objmodule.register_extension_type (typeof (Peas.Activatable),
+    objmodule.register_extension_type (typeof (Scratch.Services.ActivatablePlugin),
                                        typeof (Scratch.Plugins.Completion));
 }
diff --git a/src/Dialogs/PreferencesDialog.vala b/src/Dialogs/PreferencesDialog.vala
@@ -144,9 +144,9 @@ public class Scratch.Dialogs.Preferences : Granite.Dialog {
         main_box.add (stackswitcher);
         main_box.add (stack);
 
-        plugins.hook_preferences_dialog (this);
+        plugins.hook_preferences_dialog (this); // Unused?
 
-        if (Peas.Engine.get_default ().get_plugin_list ().length () > 0) {
+        if (plugins.get_n_plugins () > 0) {
             var pbox = plugins.get_view ();
             pbox.vexpand = true;
 
@@ -160,6 +160,11 @@ public class Scratch.Dialogs.Preferences : Granite.Dialog {
         close_button.clicked.connect (() => {
             destroy ();
         });
+
+        //Ensure appearance correct after using libpeas-2
+        realize.connect (() => {
+            stack.set_visible_child_name ("behavior");
+        });
     }
 
     private class SettingSwitch : Gtk.Grid {
diff --git a/src/Services/PluginManager.vala b/src/Services/PluginManager.vala
diff --git a/vapi/libpeas-2.vapi b/vapi/libpeas-2.vapi
