Add printers applet (#8485)

This applet is a fork of the printers applet from cinnamon-spices (https://github.com/linuxmint/cinnamon-spices-applets/tree/master/printers@linux-man) by @linux-man. Thanks and credits to @linux-man for his great work on this applet!

data/org.cinnamon.gschema.xml.in

@@ -31,7 +31,7 @@
     </key>
 
     <key name="enabled-applets" type="as">
-      <default>['panel1:right:0:systray@cinnamon.org', 'panel1:left:0:menu@cinnamon.org', 'panel1:left:1:show-desktop@cinnamon.org', 'panel1:left:2:grouped-window-list@cinnamon.org', 'panel1:right:1:keyboard@cinnamon.org', 'panel1:right:2:notifications@cinnamon.org', 'panel1:right:3:[email protected]', 'panel1:right:5:[email protected]', 'panel1:right:6:[email protected]', 'panel1:right:7:[email protected]', 'panel1:right:8:[email protected]', 'panel1:right:9:[email protected]']</default>
+      <default>['panel1:left:0:menu@cinnamon.org', 'panel1:left:1:show-desktop@cinnamon.org', 'panel1:left:2:grouped-window-list@cinnamon.org', 'panel1:right:0:systray@cinnamon.org', 'panel1:right:1:notifications@cinnamon.org', 'panel1:right:2:printers@cinnamon.org', 'panel1:right:3:removable-drives@cinnamon.org', 'panel1:right:4:keyboard@cinnamon.org', 'panel1:right:5:[email protected]', 'panel1:right:6:[email protected]', 'panel1:right:7:[email protected]', 'panel1:right:8:[email protected]', 'panel1:right:9:[email protected]']</default>
       <_summary>Uuids of applets to enable</_summary>
       <_description>
         Cinnamon applets have a uuid property; this key lists applets

files/usr/share/cinnamon/applets/printers@cinnamon.org/applet.js

@@ -0,0 +1,264 @@
+const Applet = imports.ui.applet;
+const Lang = imports.lang;
+const Gio = imports.gi.Gio;
+const PopupMenu = imports.ui.popupMenu;
+const Mainloop = imports.mainloop;
+const Settings = imports.ui.settings;
+const St = imports.gi.St;
+const Util = imports.misc.util;
+
+const PANEL_EDIT_MODE_KEY = "panel-edit-mode";
+const APPLET_PATH = imports.ui.appletManager.appletMeta['[email protected]'].path;
+
+
+class CinnamonPrintersApplet extends Applet.TextIconApplet {
+    constructor(metadata, orientation, panel_height, instance_id) {
+        super(orientation, panel_height, instance_id);
+
+        this.setAllowedLayout(Applet.AllowedLayout.BOTH);
+
+        this._cupsSignal = Gio.DBus.system.signal_subscribe(null, 'org.cups.cupsd.Notifier', null, '/org/cups/cupsd/Notifier', null, Gio.DBusSignalFlags.NONE, this.onCupsSignal.bind(this));
+
+        this.set_applet_tooltip(_("Printers"));
+
+        this.menu = new Applet.AppletPopupMenu(this, orientation);
+        this.menu.connect('open-state-changed', Lang.bind(this, this.onMenuOpened));
+
+        this.menuManager = new PopupMenu.PopupMenuManager(this);
+        this.menuManager.addMenu(this.menu);
+
+        this.settings = new Settings.AppletSettings(this, metadata.uuid, instance_id);
+        this.settings.bindProperty(Settings.BindingDirection.IN, 'show-icon', 'show_icon', this.update, null);
+
+        global.settings.connect('changed::' + PANEL_EDIT_MODE_KEY, Lang.bind(this, this._on_panel_edit_mode_changed));
+
+        this.jobsCount = 0;
+        this.printersCount = 0;
+        this.printWarning = false;
+        this.printStatus = '';
+        this.updating = false;
+        this.showLater = false;
+        this.printers = [];
+        this.set_applet_icon_symbolic_name('printer');
+        this.update();
+    }
+
+    on_applet_clicked() {
+        if(!this.menu.isOpen && this.updating) {
+            this.showLater = true;
+            return;
+        }
+        this.menu.toggle();
+        if(!this.printWarning && !this.menu.isOpen) {
+            this.update();
+        }
+    }
+
+    on_applet_removed_from_panel() {
+        this.settings.finalize();
+    }
+
+    _on_panel_edit_mode_changed () {
+        if (global.settings.get_boolean(PANEL_EDIT_MODE_KEY)) {
+            this.actor.show();
+        } else {
+            this.update();
+        }
+    }
+
+    onCupsSignal() {
+        if(this.printWarning) return;
+        this.printWarning = true;
+        Mainloop.timeout_add_seconds(3, Lang.bind(this, this.warningTimeout));
+        this.update();
+    }
+
+    warningTimeout() {
+        this.printWarning = false;
+        this.update();
+    }
+
+    onMenuOpened() {
+        if(this.sendSubMenu != null) {
+            this.sendSubMenu.close();
+            this.sendSubMenu.open();
+        }
+        if(this.cancelSubMenu != null) {
+            this.cancelSubMenu.close();
+            this.cancelSubMenu.open();
+        }
+        if(this.sendSubMenu != null) {
+            this.sendSubMenu.close();
+        }
+    }
+
+    onShowPrintersClicked() {
+        Util.spawn(['system-config-printer']);
+    }
+
+    onShowJobsClicked(item) {
+        Util.spawn(['system-config-printer', '--show-jobs', item.label.text]);
+    }
+
+    onCancelAllJobsClicked() {
+        Util.spawn_async(['python3', APPLET_PATH + '/cancel-print-dialog.py', 'all'], Lang.bind(this, function(out) {
+            if(out.trim() == "Cancel") {
+                for(var n = 0; n < this.printers.length; n++) {
+                    Util.spawn(['cancel', '-a', this.printers[n]]);
+                }
+            }
+        }));
+    }
+
+    onCancelJobClicked(item) {
+        Util.spawn_async(['python3', APPLET_PATH + '/cancel-print-dialog.py'], Lang.bind(this, function(out) {
+            if(out.trim() == "Cancel") {
+                Util.spawn(['cancel', item.job]);
+            }
+        }));
+    }
+
+    onSendToFrontClicked(item) {
+        Util.spawn(['lp', '-i', item.job, '-q 100']);
+    }
+
+    update() {
+        if(this.updating || this.menu.isOpen) return;
+        this.updating = true;
+        this.jobsCount = 0;
+        this.printersCount = 0;
+        this.menu.removeAll();
+        let printers = new PopupMenu.PopupIconMenuItem(_("Printers"), 'printer', St.IconType.SYMBOLIC);
+        printers.connect('activate', Lang.bind(this, this.onShowPrintersClicked));
+        this.menu.addMenuItem(printers);
+        this.menu.addMenuItem(new PopupMenu.PopupSeparatorMenuItem);
+
+        //Add Printers
+        Util.spawn_async(['python3', APPLET_PATH + '/lpstat-a.py'], Lang.bind(this, function(out) {
+            this.printers = [];
+            Util.spawn_async(['/usr/bin/lpstat', '-d'], Lang.bind(this, function(out2) {//To check default printer
+                if(out2.split(': ')[1] != undefined) {
+                    out2 = out2.split(': ')[1].trim();
+                } else {
+                    out2 = 'no default';
+                }
+                out = out.split('\n');
+                if(out.includes('No printers available!')) {
+                    out = []
+                }
+                this.printersCount = out.length - 2;
+                for(var n = 0; n < this.printersCount; n++) {
+                    let printer = out[n].split(' ')[0].trim();
+                    this.printers.push(printer);
+                    let printerItem = new PopupMenu.PopupIconMenuItem(printer, 'emblem-documents', St.IconType.SYMBOLIC);
+                    if(out2.toString() == printer.toString()) {
+                        printerItem.addActor(new St.Icon({ style_class: 'popup-menu-icon', icon_name: 'emblem-default', icon_type: St.IconType.SYMBOLIC }));
+                    }
+                    printerItem.connect('activate', Lang.bind(printerItem, this.onShowJobsClicked));
+                    this.menu.addMenuItem(printerItem);
+                }
+                this.menu.addMenuItem(new PopupMenu.PopupSeparatorMenuItem);
+
+                //Add Jobs
+                Util.spawn_async(['/usr/bin/lpstat', '-o'], Lang.bind(this, function(out) {
+                    //Cancel all Jobs
+                    if(out.length > 0) {
+                        let cancelAll = new PopupMenu.PopupIconMenuItem(_("Cancel all jobs"), 'edit-delete', St.IconType.SYMBOLIC);
+                        cancelAll.connect('activate', Lang.bind(this, this.onCancelAllJobsClicked));
+                        this.menu.addMenuItem(cancelAll);
+
+                        let _cancelSubMenu = new PopupMenu.PopupSubMenuMenuItem(null);
+                        _cancelSubMenu.actor.set_style_class_name('');
+                        this.cancelSubMenu = _cancelSubMenu.menu;
+                        this.menu.addMenuItem(_cancelSubMenu);
+                    }
+                    //Cancel Job
+                    out = out.split(/\n/);
+                    this.jobsCount = out.length - 1;
+                    Util.spawn_async(['/usr/bin/lpq', '-a'], Lang.bind(this, function(out2) {
+                        out2 = out2.replace(/\n/g, ' ').split(/\s+/);
+                        let sendJobs = [];
+                        for(var n = 0; n < out.length - 1; n++) {
+                            let line = out[n].split(' ')[0].split('-');
+                            let job = line.slice(-1)[0];
+                            let printer = line.slice(0, -1).join('-');
+                            let doc = out2[out2.indexOf(job) + 1];
+                            for(var m = out2.indexOf(job) + 2; m < out2.length - 1; m++) {
+                                if(isNaN(out2[m]) || out2[m + 1] != 'bytes') {
+                                    doc = doc + ' ' + out2[m];
+                                } else {
+                                    break;
+                                }
+                            }
+                            if(doc.length > 30) {
+                                doc = doc + '...';
+                            }
+                            let text = '(' + job + ') ' + _("'%s' on %s").format(doc, printer);
+                            let jobItem = new PopupMenu.PopupIconMenuItem(text, 'edit-delete', St.IconType.SYMBOLIC);
+                            if(out2[out2.indexOf(job) - 2] == 'active') {
+                                jobItem.addActor(new St.Icon({ style_class: 'popup-menu-icon', icon_name: 'emblem-default', icon_type: St.IconType.SYMBOLIC }));
+                            }
+                            jobItem.job = job;
+                            jobItem.connect('activate', Lang.bind(jobItem, this.onCancelJobClicked));
+                            this.cancelSubMenu.addMenuItem(jobItem);
+                            if(out2[out2.indexOf(job) - 2] != 'active' && out2[out2.indexOf(job) - 2] != '1st') {
+                                sendJobs.push(new PopupMenu.PopupIconMenuItem(text, 'go-up', St.IconType.SYMBOLIC));
+                                sendJobs[sendJobs.length - 1].job = job;
+                                sendJobs[sendJobs.length - 1].connect('activate', Lang.bind(sendJobs[sendJobs.length - 1], this.onSendToFrontClicked));
+                            }
+                        }
+
+                        //Send to Front
+                        if(sendJobs.length > 0) {
+                            let _sendSubMenu = new PopupMenu.PopupSubMenuMenuItem(_("Send to front"));
+                            this.sendSubMenu =_sendSubMenu.menu;
+                            for(var i = 0; i < sendJobs.length; i++) {
+                                this.sendSubMenu.addMenuItem(sendJobs[i]);
+                            }
+                            this.menu.addMenuItem(_sendSubMenu);
+                        }
+                        this.updating = false;
+                        if(this.cancelSubMenu != null) {
+                            this.cancelSubMenu.open();
+                        }
+                        if(this.showLater) {
+                            this.showLater = false;
+                            this.menu.open();
+                        }
+
+                        //Update Icon
+                        if(this.jobsCount > 0) {
+                            this.set_applet_label(this.jobsCount.toString());
+                        } else {
+                            this.set_applet_label('');
+                        }
+                        if(this.show_icon == 'always' || (this.show_icon == 'printers' && this.printersCount > 0) || (this.show_icon == 'jobs' && this.jobsCount > 0) || global.settings.get_boolean(PANEL_EDIT_MODE_KEY)) {
+                            this.actor.show();
+                        } else {
+                            this.actor.hide();
+                        }
+                        Util.spawn_async(['/usr/bin/lpstat', '-l'], Lang.bind(this, function(out) {
+                            if(out != '') {
+                                let printStatus = out.split('\n')[1].trim();
+                                this.set_applet_tooltip(printStatus);
+                            } else {
+                                this.set_applet_tooltip(_("Printers"));
+                            }
+                            if(this.printWarning) {
+                                this.set_applet_icon_symbolic_name('printer-warning');
+                            } else if(this.jobsCount > 0) {
+                                this.set_applet_icon_symbolic_name('printer-printing');
+                            } else {
+                                this.set_applet_icon_symbolic_name('printer');
+                            }
+                        }));
+                    }))
+                }))
+            }))
+        }))
+    }
+};
+
+function main(metadata, orientation, panel_height, instance_id) {
+    return new CinnamonPrintersApplet(metadata, orientation, panel_height, instance_id);
+}

files/usr/share/cinnamon/applets/printers@cinnamon.org/cancel-print-dialog.py

@@ -0,0 +1,38 @@
+#!/usr/bin/python3
+
+import sys
+import gi
+gi.require_version('Gtk', '3.0')
+from gi.repository import Gtk
+import gettext
+
+# i18n
+gettext.install("cinnamon", "/usr/share/locale")
+
+class CancelPrintJob():
+    def __init__(self):
+        self.message_dialog = Gtk.MessageDialog(
+            parent=Gtk.Window(),
+            type=Gtk.MessageType.QUESTION,
+            title=window_title,
+            message_format=message,
+            buttons=Gtk.ButtonsType.NONE
+            )
+        self.message_dialog.add_buttons(continue_button_text, True, cancel_button_text, False)
+
+        response = self.message_dialog.run()
+        if response:
+            print("Continue")
+        else:
+            print("Cancel")
+        self.message_dialog.destroy()
+
+if __name__ == "__main__":
+    window_title = _("Cancel Job")
+    message = _("Do you really want to cancel this job?")
+    cancel_button_text = _("Cancel Job")
+    continue_button_text = _("Keep Printing")
+    if len(sys.argv) == 2 and sys.argv[1] == "all":
+        message = _("Do you really want to cancel all jobs?")
+        cancel_button_text = _("Cancel All Jobs")
+    CancelPrintJob()

files/usr/share/cinnamon/applets/printers@cinnamon.org/lpstat-a.py

@@ -0,0 +1,8 @@
+#!/usr/bin/python3
+
+import subprocess
+
+try:
+    print(subprocess.check_output(['/usr/bin/lpstat', '-a']).decode("utf-8"))
+except subprocess.CalledProcessError as e:
+    print("No printers available!")

files/usr/share/cinnamon/applets/printers@cinnamon.org/metadata.json

@@ -0,0 +1,7 @@
+{
+ "uuid": "[email protected]",
+ "name": "Printers",
+ "description": "Manage print jobs",
+ "icon": "printer",
+ "max-instances": -1
+}

files/usr/share/cinnamon/applets/printers@cinnamon.org/settings-schema.json

@@ -0,0 +1,13 @@
+{
+    "section1": {
+        "type": "section",
+        "description": "Appearance"
+    },
+    "show-icon": {
+        "type": "radiogroup",
+        "default": "printers",
+        "description": "Show printer icon",
+        "options": { "Always": "always", "When printers exist": "printers", "When printing": "jobs"},
+        "tooltip": "Choose when to show the printer icon in the panel"
+    }
+}