applet.js

// Custom Applications Menu Cinnamon Applet
// Developed by Nicolas LLOBERA - nllobera@gmail.com
// Modified by Sahil Ahuja - sahilahuja@gmail.com
// version: 2.0 (12-09-2013)
// License: GPLv3
// Copyright © 2016 Sahil Ahuja

/* Import */
const Applet = imports.ui.applet;
const Cinnamon = imports.gi.Cinnamon;
const Gettext = imports.gettext;
const _ = Gettext.gettext;
const Gio = imports.gi.Gio;
const GLib = imports.gi.GLib;
const Gtk = imports.gi.Gtk;
const Lang = imports.lang;
const Main = imports.ui.main;
const PopupMenu = imports.ui.popupMenu;
const St = imports.gi.St;

const appletUUID = 'custom-apps-menu@sahil87';
const AppletDirectory = imports.ui.appletManager.appletMeta[appletUUID].path;

imports.searchPath.push(AppletDirectory);
const PopupMenuExtension = imports.popupMenuExtension;

const AppSys = Cinnamon.AppSystem.get_default();
let SettingsFile;

function MyApplet(orientation) {
    this._init(orientation);
}
MyApplet.prototype = {
    __proto__: Applet.IconApplet.prototype,

    _init: function(orientation) {
        Applet.IconApplet.prototype._init.call(this, orientation);

        try {
            this.set_applet_icon_name("emblem-favorite");
            this.set_applet_tooltip("Custom Applications Menu");

            //Select the correct SettingsFile
            SettingsFile = AppletDirectory + "/applications.json";
            let SettingsFileOverride = AppletDirectory + "/applications-override.json";
            let file = Gio.file_new_for_path(SettingsFileOverride);
            if(file.query_exists(null)) {
                SettingsFile = SettingsFileOverride;
            }

            // watch settings file for changes
            file = Gio.file_new_for_path(SettingsFile);
            this._monitor = file.monitor(Gio.FileMonitorFlags.NONE, null);
            this._monitor.connect('changed', Lang.bind(this, this._on_settingsfile_changed));

            this.menuManager = new PopupMenu.PopupMenuManager(this);
            this.menu = new Applet.AppletPopupMenu(this, orientation);
            this.menuManager.addMenu(this.menu);

            this._readSettings();
            this._createMenuRecursive(this.menu, this.applications);
            this._createContextMenu();
        }
        catch (e) {
            global.logError(e);
        };
    },

    on_applet_clicked: function(event) {
        this.menu.toggle();
    },

    // if applications.json is modified
    _on_settingsfile_changed: function() {
        this._readSettings();
        this.menu.removeAll();
        this._createMenuRecursive(this.menu, this.applications);
    },

    // create the menu items from the applications array
    _createMenuRecursive: function(parentMenuItem, applications) {
        for (var i=0; i<applications.length; i++) {
            var application = applications[i];

            // if the current application has been unactivated
            if ("active" in application && !application.active)
                continue;

            // get command, displayName and icon from the desktop file
            // only fill empty values
            if (typeof(application.desktopFile) === "string") // if desktopFile is defined and a string
                this._getDataFromDesktopFile(application);

            // default icon name
            if (typeof(application.iconName) === "undefined")
                application.iconName = "image-missing";

            // if it's a menu
            if ("menu" in application) {
                // PopupSubMenuMenuItem without icon makes the menu larger
                /*var menuItem;
                if (typeof(application.iconName) === "undefined")
                    menuItem = new PopupMenu.PopupSubMenuMenuItem(application.displayName);
                else
                    menuItem = new PopupMenuExtension.PopupLeftImageSubMenuMenuItem(application.displayName, application.iconName);*/

                if (typeof(application.displayName) === "undefined")
                    application.displayName = "sub-menu";

                var menuItem = new PopupMenuExtension.PopupLeftImageSubMenuMenuItem(application.displayName, application.iconName);

                this._createMenuRecursive(menuItem.menu, application.menu);

                parentMenuItem.addMenuItem(menuItem);
            }
            else {
                if (typeof(application.command) !== "string") { // if command is not defined or not a string, go to the next application
                    global.logError("Undefined or unvalid command for item " + (i+1) + ".");
                    continue;
                }
                else if (application.command === "S")
                    parentMenuItem.addMenuItem(new PopupMenu.PopupSeparatorMenuItem());
                else {
                    // default display name
                    if (typeof(application.displayName) === "undefined")
                        application.displayName = application.command.split(" ")[0];

                    this._createMenuItem(parentMenuItem, application);
                }
            }
        }
    },

    // extract the command, the name and the icone name from the desktop file
    _getDataFromDesktopFile: function(application) {
        let appInfo = null;
        let desktopFile = application.desktopFile + ".desktop";
        let app = AppSys.lookup_app(desktopFile);
        if (!app) {
            // for cinnamon-settings for instance
            app = AppSys.lookup_settings_app(desktopFile);
        }

        if (app)
            appInfo = app.get_app_info();
        else {
            global.logError("Desktop file " + application.desktopFile + " not found");
            return;
        }

        if (typeof(application.command) === "undefined")
            application.command = appInfo.get_commandline();

        if (typeof(application.displayName) === "undefined")
            application.displayName = appInfo.get_name();

        if (typeof(application.iconName) === "undefined") {
            let icon = appInfo.get_icon();
            if (icon) {
                if (icon instanceof(Gio.FileIcon))
                    application.iconName = icon.get_file().get_path();
                else
                    application.iconName = icon.get_names().toString();
            }
        }
    },

    // parse the applications.json file into the applications variable
    _readSettings: function() {
        let jsonFileContent = Cinnamon.get_file_contents_utf8_sync(SettingsFile);
        this.applications = JSON.parse(jsonFileContent);
    },

    _createMenuItem: function(parentMenuItem, application) {
        var menuItem = new PopupMenuExtension.PopupImageLeftMenuItem(
            application.displayName, application.iconName, application.command);
        menuItem.connect("activate", function(actor, event) {
            // As application variable is not accessible here,
            // the application variable is passed to the PopupImageLeftMenuItem ctor to be accessible throw the actor argument
            // which is the menuItem itself
            Main.Util.spawnCommandLine(actor.command);
        });
        parentMenuItem.addMenuItem(menuItem);
    },

    _createContextMenu: function() {
        this.edit_menu_item = new Applet.MenuItem(_("Edit"), Gtk.STOCK_EDIT, function() {
            Main.Util.spawnCommandLine("xdg-open " + SettingsFile);
        });
        this._applet_context_menu.addMenuItem(this.edit_menu_item);

        this.help_menu_item = new Applet.MenuItem(_("Help"), Gtk.STOCK_HELP, function() {
            Main.Util.spawnCommandLine("xdg-open " + AppletDirectory + "/README.txt");
        });
        this._applet_context_menu.addMenuItem(this.help_menu_item);

        this.about_menu_item = new Applet.MenuItem(_("About"), Gtk.STOCK_ABOUT,  function() {
            Main.Util.spawnCommandLine("xdg-open " + AppletDirectory + "/ABOUT.txt");
        });
        this._applet_context_menu.addMenuItem(this.about_menu_item);
    }
};


function main(metadata, orientation) {
    return new MyApplet(orientation);
}