[gnome-shell] appMenu: Optionally include favorites section

[Marge Bot <marge-bot src gnome org>]

commit 0cde447891ae33b851f7952ee9569f1f69d0ce77
Author: Florian Müllner <fmuellner gnome org>
Date:   Wed Aug 11 23:50:50 2021 +0200

    appMenu: Optionally include favorites section
    
    The context menu in the overview includes actions for managing
    favorites. Add those to the AppMenu class, but make it another
    option as the actions would be slightly weird in the top bar menu.
    
    Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/1948>

 js/ui/appMenu.js | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 50 insertions(+), 1 deletion(-)
---
diff --git a/js/ui/appMenu.js b/js/ui/appMenu.js
index 425faebb52..9d1bcd30b6 100644
--- a/js/ui/appMenu.js
+++ b/js/ui/appMenu.js
@@ -2,14 +2,17 @@
 /* exported AppMenu */
 const { Clutter, Gio, GLib, Meta, Shell, St } = imports.gi;
 
-const PopupMenu = imports.ui.popupMenu;
+const AppFavorites = imports.ui.appFavorites;
 const Main = imports.ui.main;
+const ParentalControlsManager = imports.misc.parentalControlsManager;
+const PopupMenu = imports.ui.popupMenu;
 
 var AppMenu = class AppMenu extends PopupMenu.PopupMenu {
     /**
      * @param {Clutter.Actor} sourceActor - actor the menu is attached to
      * @param {St.Side} side - arrow side
      * @param {object} params - options
+     * @param {bool} params.favoritesSection - show items to add/remove favorite
      * @param {bool} params.showSingleWindow - show window section for a single window
      */
     constructor(sourceActor, side = St.Side.TOP, params = {}) {
@@ -25,11 +28,15 @@ var AppMenu = class AppMenu extends PopupMenu.PopupMenu {
         this.actor.add_style_class_name('app-menu');
 
         const {
+            favoritesSection = false,
             showSingleWindows = false,
         } = params;
 
         this._app = null;
         this._appSystem = Shell.AppSystem.get_default();
+        this._parentalControlsManager = ParentalControlsManager.getDefault();
+        this._appFavorites = AppFavorites.getAppFavorites();
+        this._enableFavorites = favoritesSection;
         this._showSingleWindows = showSingleWindows;
 
         this._windowsChangedId = 0;
@@ -57,6 +64,16 @@ var AppMenu = class AppMenu extends PopupMenu.PopupMenu {
 
         this.addMenuItem(new PopupMenu.PopupSeparatorMenuItem());
 
+        this._toggleFavoriteItem = this.addAction('', () => {
+            const appId = this._app.get_id();
+            if (this._appFavorites.isFavorite(appId))
+                this._appFavorites.removeFavorite(appId);
+            else
+                this._appFavorites.addFavorite(appId);
+        });
+
+        this.addMenuItem(new PopupMenu.PopupSeparatorMenuItem());
+
         this._detailsItem = this.addAction(_('Show Details'), async () => {
             const id = this._app.get_id();
             const args = GLib.Variant.new('(ss)', [id, '']);
@@ -83,8 +100,21 @@ var AppMenu = class AppMenu extends PopupMenu.PopupMenu {
             this._appSystem,
             this._appSystem.connect('app-state-changed',
                 this._onAppStateChanged.bind(this)),
+        ], [
+            this._parentalControlsManager,
+            this._parentalControlsManager.connect('app-filter-changed',
+                () => this._updateFavoriteItem()),
+        ], [
+            this._appFavorites,
+            this._appFavorites.connect('changed',
+                () => this._updateFavoriteItem()),
+        ], [
+            global.settings,
+            global.settings.connect('writable-changed::favorite-apps',
+                () => this._updateFavoriteItem()),
         ]);
         this._updateQuitItem();
+        this._updateFavoriteItem();
         this._updateDetailsVisibility();
     }
 
@@ -106,6 +136,24 @@ var AppMenu = class AppMenu extends PopupMenu.PopupMenu {
             this._app?.can_open_new_window() && !actions.includes('new-window');
     }
 
+    _updateFavoriteItem() {
+        const appInfo = this._app?.app_info;
+        const canFavorite = appInfo &&
+            this._enableFavorites &&
+            global.settings.is_writable('favorite-apps') &&
+            this._parentalControlsManager.shouldShowApp(appInfo);
+
+        this._toggleFavoriteItem.visible = canFavorite;
+
+        if (!canFavorite)
+            return;
+
+        const { id } = this._app;
+        this._toggleFavoriteItem.label.text = this._appFavorites.isFavorite(id)
+            ? _('Remove from Favorites')
+            : _('Add to Favorites');
+    }
+
     _updateDetailsVisibility() {
         const sw = this._appSystem.lookup_app('org.gnome.Software.desktop');
         this._detailsItem.visible = sw !== null;
@@ -173,6 +221,7 @@ var AppMenu = class AppMenu extends PopupMenu.PopupMenu {
 
         this._updateQuitItem();
         this._updateNewWindowItem();
+        this._updateFavoriteItem();
     }
 
     _queueUpdateWindowsSection() {