/usr/lib/python3/dist-packages/menulibre/MenuEditor.py is in menulibre 2.2.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 | #!/usr/bin/python3
# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
# MenuLibre - Advanced fd.o Compliant Menu Editor
# Copyright (C) 2012-2018 Sean Davis <smd.seandavis@gmail.com>
# Copyright (C) 2016-2018 OmegaPhil <OmegaPhil@startmail.com>
#
# Portions of this file are adapted from Alacarte Menu Editor,
# Copyright (C) 2006 Travis Watkins, Heinrich Wendel
#
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 3, as published
# by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranties of
# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
# PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
import locale
import os
import xml.dom.minidom
import xml.parsers.expat
from locale import gettext as _
from xml.sax.saxutils import escape
import logging
logger = logging.getLogger('menulibre') # noqa
import gi
gi.require_version('GMenu', '3.0') # noqa
from gi.repository import GdkPixbuf, Gio, GLib, GMenu, Gtk
from . import util
from .util import MenuItemTypes, escapeText
locale.textdomain('menulibre')
icon_theme = Gtk.IconTheme.get_default()
menu_name = ""
def get_default_menu():
"""Return the filename of the default application menu."""
return '%s%s' % (util.getDefaultMenuPrefix(), 'applications.menu')
def load_fallback_icon(icon_size):
"""If icon loading fails, load a fallback icon instead."""
info = icon_theme.lookup_icon(
"image-missing", icon_size,
Gtk.IconLookupFlags.GENERIC_FALLBACK | Gtk.IconLookupFlags.USE_BUILTIN)
return info.load_icon()
def load_icon(gicon, icon_size):
"""Load an icon, either from the icon theme or from a filename."""
pixbuf = None
if gicon is None:
return None
else:
info = icon_theme.lookup_by_gicon(gicon, icon_size, 0)
if info is None:
pixbuf = load_fallback_icon(icon_size)
else:
try:
pixbuf = info.load_icon()
except GLib.GError:
pixbuf = load_fallback_icon(icon_size)
if pixbuf.get_width() != icon_size or pixbuf.get_height() != icon_size:
pixbuf = pixbuf.scale_simple(
icon_size, icon_size, GdkPixbuf.InterpType.HYPER)
return pixbuf
def menu_to_treestore(treestore, parent, menu_items):
"""Convert the Alacarte menu to a standard treestore."""
for item in menu_items:
item_type = item[0]
if item_type == MenuItemTypes.SEPARATOR:
displayed_name = "<s> </s>"
# Translators: Separator menu item
tooltip = _("Separator")
categories = ""
filename = None
icon = None
icon_name = ""
show = True
else:
displayed_name = escape(item[2]['display_name'])
show = item[2]['show']
tooltip = escapeText(item[2]['comment'])
categories = item[2]['categories']
icon = item[2]['icon']
filename = item[2]['filename']
icon_name = item[2]['icon_name']
treeiter = treestore.append(
parent, [displayed_name, tooltip, categories, item_type,
icon, icon_name, filename, False, show])
if item_type == MenuItemTypes.DIRECTORY:
treestore = menu_to_treestore(treestore, treeiter, item[3])
return treestore
def get_treestore():
"""Get the TreeStore implementation of the current menu."""
# Name, Comment, Categories, MenuItemType, GIcon (TreeView), icon-name,
# Filename, exp, show
treestore = Gtk.TreeStore(str, str, str, int, Gio.Icon, str, str, bool,
bool)
menu = get_menus()[0]
return menu_to_treestore(treestore, None, menu)
def get_submenus(menu, tree_dir):
"""Get the submenus for a tree directory."""
structure = []
for child in menu.getContents(tree_dir):
if isinstance(child, GMenu.TreeSeparator):
structure.append([MenuItemTypes.SEPARATOR, child, None, None])
else:
if isinstance(child, GMenu.TreeEntry):
item_type = MenuItemTypes.APPLICATION
entry_id = child.get_desktop_file_id()
app_info = child.get_app_info()
icon = app_info.get_icon()
icon_name = "applications-other"
display_name = app_info.get_display_name()
generic_name = app_info.get_generic_name()
comment = app_info.get_description()
keywords = app_info.get_keywords()
categories = app_info.get_categories()
executable = app_info.get_executable()
filename = child.get_desktop_file_path()
submenus = None
is_hidden = app_info.get_is_hidden()
no_display = app_info.get_nodisplay()
show_in = app_info.get_show_in()
hidden = is_hidden or no_display or not show_in
elif isinstance(child, GMenu.TreeDirectory):
item_type = MenuItemTypes.DIRECTORY
entry_id = child.get_menu_id()
icon = child.get_icon()
icon_name = "folder"
display_name = child.get_name()
generic_name = child.get_generic_name()
comment = child.get_comment()
keywords = []
categories = ""
executable = None
filename = child.get_desktop_file_path()
hidden = child.get_is_nodisplay()
submenus = get_submenus(menu, child)
if isinstance(icon, Gio.ThemedIcon):
icon_name = icon.get_names()[0]
elif isinstance(icon, Gio.FileIcon):
icon_name = icon.get_file().get_path()
details = {'display_name': display_name,
'generic_name': generic_name,
'comment': comment,
'keywords': keywords,
'categories': categories,
'executable': executable,
'filename': filename,
'icon': icon,
'icon_name': icon_name,
'show': not hidden}
entry = [item_type, entry_id, details, submenus]
structure.append(entry)
return structure
def get_menus():
"""Get the menus from the MenuEditor"""
menu = MenuEditor()
structure = []
toplevels = []
global menu_name
menu_name = menu.tree.get_root_directory().get_menu_id()
for child in menu.getMenus(None):
toplevels.append(child)
for top in toplevels:
structure.append(get_submenus(menu, top[0]))
return structure
def removeWhitespaceNodes(node):
"""Remove whitespace nodes from the xml dom."""
remove_list = []
for child in node.childNodes:
if child.nodeType == xml.dom.minidom.Node.TEXT_NODE:
child.data = child.data.strip()
if not child.data.strip():
remove_list.append(child)
elif child.hasChildNodes():
removeWhitespaceNodes(child)
for node in remove_list:
node.parentNode.removeChild(node)
def getUserMenuXml(tree):
"""Return the header portions of the menu xml file."""
system_file = util.getSystemMenuPath(
os.path.basename(tree.get_canonical_menu_path()))
name = tree.get_root_directory().get_menu_id()
menu_xml = "<!DOCTYPE Menu PUBLIC '-//freedesktop//DTD Menu 1.0//EN'" \
" 'http://standards.freedesktop.org/menu-spec/menu-1.0.dtd'>\n"
menu_xml += "<Menu>\n <Name>" + name + "</Name>\n "
menu_xml += "<MergeFile type=\"parent\">" + system_file + \
"</MergeFile>\n</Menu>\n"
return menu_xml
class MenuEditor(object):
"""MenuEditor class, adapted and minimized from Alacarte Menu Editor."""
def __init__(self, basename=None):
"""init"""
# Remember to keep menulibre-menu-validate's GMenu object creation
# in-sync with this code
basename = basename or get_default_menu()
self.tree = GMenu.Tree.new(basename,
GMenu.TreeFlags.SHOW_EMPTY |
GMenu.TreeFlags.INCLUDE_EXCLUDED |
GMenu.TreeFlags.INCLUDE_NODISPLAY |
GMenu.TreeFlags.SHOW_ALL_SEPARATORS |
GMenu.TreeFlags.SORT_DISPLAY_NAME)
self.load()
self.path = os.path.join(
util.getUserMenuPath(), self.tree.props.menu_basename)
logger.debug("Using menu: %s" % self.path)
self.loadDOM()
def loadDOM(self):
"""loadDOM"""
try:
self.dom = xml.dom.minidom.parse(self.path)
except (IOError, xml.parsers.expat.ExpatError):
self.dom = xml.dom.minidom.parseString(
getUserMenuXml(self.tree))
removeWhitespaceNodes(self.dom)
def load(self):
"""load"""
if not self.tree.load_sync():
raise ValueError("can not load menu tree %r" %
(self.tree.props.menu_basename,))
def getMenus(self, parent):
"""getMenus"""
if parent is None:
yield (self.tree.get_root_directory(), True)
return
item_iter = parent.iter()
item_type = item_iter.next()
while item_type != GMenu.TreeItemType.INVALID:
if item_type == GMenu.TreeItemType.DIRECTORY:
item = item_iter.get_directory()
yield (item, self.isVisible(item))
item_type = item_iter.next()
def getContents(self, item):
"""getContents"""
contents = []
item_iter = item.iter()
item_type = item_iter.next()
found_directories = []
while item_type != GMenu.TreeItemType.INVALID:
item = None
if item_type == GMenu.TreeItemType.DIRECTORY:
item = item_iter.get_directory()
desktop = item.get_desktop_file_path()
if desktop is None or desktop in found_directories:
# Do not include directories without filenames.
# Do not include duplicate directories.
item = None
else:
found_directories.append(desktop)
elif item_type == GMenu.TreeItemType.ENTRY:
item = item_iter.get_entry()
elif item_type == GMenu.TreeItemType.HEADER:
item = item_iter.get_header()
elif item_type == GMenu.TreeItemType.ALIAS:
item = item_iter.get_alias()
elif item_type == GMenu.TreeItemType.SEPARATOR:
item = item_iter.get_separator()
if item:
contents.append(item)
item_type = item_iter.next()
return contents
|