/usr/lib/python3/dist-packages/dep11/parsers.py is in python3-dep11 0.4.0-1build1.
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 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 | #!/usr/bin/env python3
"""
Reads AppStream XML metadata and metadata from
XDG .desktop files.
"""
# Copyright (c) 2014 Abhishek Bhattacharjee <abhishek.bhattacharjee11@gmail.com>
# Copyright (c) 2014 Matthias Klumpp <mak@debian.org>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 3.0 of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this program.
import re
from configparser import RawConfigParser
import lxml.etree as et
from xml.sax.saxutils import escape
from io import StringIO
from dep11.component import DEP11Component, ProvidedItemType
from dep11.utils import str_enc_dec
def read_desktop_data(cpt, dcontent):
'''
Parses a .desktop file and sets ComponentData properties
'''
df = RawConfigParser(allow_no_value=True)
items = None
try:
df.readfp(StringIO(dcontent))
items = df.items("Desktop Entry")
if df.get("Desktop Entry", "Type") != "Application":
# ignore this file, isn't an application
cpt.add_hint("not-an-application")
return False
try:
if df.get("Desktop Entry", "NoDisplay") == "True":
# we ignore this .desktop file, shouldn't be displayed
cpt.add_hint("invisible-application")
return False
except:
# we don't care if the NoDisplay variable doesn't exist
# if it isn't there, the file should be processed
pass
except Exception as e:
# this .desktop file is not interesting
cpt.add_hint("desktop-file-read-error", str(e))
return True
# if we reached this step, we are dealing with a GUI desktop app
cpt.kind = 'desktop-app'
for item in items:
if len(item) != 2:
continue
key = item[0]
value = str_enc_dec(item[1])
if not value:
continue
if key.startswith("name"):
if key == 'name':
cpt.name['C'] = value
else:
cpt.name[key[5:-1]] = value
elif key == 'categories':
value = value.split(';')
value.pop()
cpt.categories = value
elif key.startswith('comment'):
if key == 'comment':
cpt.summary['C'] = value
else:
cpt.summary[key[8:-1]] = value
elif key.startswith('keywords'):
value = re.split(';|,', value)
if not value[-1]:
value.pop()
if key[8:] == '':
if cpt.keywords:
if set(value) not in \
[set(val) for val in
cpt.keywords.values()]:
cpt.keywords.update(
{'C': list(map(str_enc_dec, value))}
)
else:
cpt.keywords = {
'C': list(map(str_enc_dec, value))
}
else:
if cpt.keywords:
if set(value) not in \
[set(val) for val in
cpt.keywords.values()]:
cpt.keywords.update(
{key[9:-1]: list(map(str_enc_dec, value))}
)
else:
cpt.keywords = {
key[9:-1]: list(map(str_enc_dec, value))
}
elif key == 'mimetype':
value = value.split(';')
if len(value) > 1:
value.pop()
for val in value:
cpt.add_provided_item(
ProvidedItemType.MIMETYPE, val
)
elif key == 'icon':
cpt.icon = value
return True
def _get_tag_locale(subs):
attr_dic = subs.attrib
if attr_dic:
locale = attr_dic.get('{http://www.w3.org/XML/1998/namespace}lang')
if locale:
return locale
return "C"
def _parse_description_tag(subs):
'''
Handles the description tag
'''
def prepare_desc_string(s):
'''
Clears linebreaks and XML-escapes the resulting string
'''
if not s:
return ""
s = s.strip()
s = " ".join(s.split())
return escape(s)
ddict = dict()
# The description tag translation is combined per language,
# for faster parsing on the client side.
# In case no translation is found, the untranslated version is used instead.
# the DEP-11 YAML stores the description as HTML
for usubs in subs:
locale = _get_tag_locale(usubs)
if usubs.tag == 'p':
if not locale in ddict:
ddict[locale] = ""
ddict[locale] += "<p>%s</p>" % str_enc_dec(prepare_desc_string(usubs.text))
elif usubs.tag == 'ul' or usubs.tag == 'ol':
tmp_dict = dict()
# find the right locale, or fallback to untranslated
for u_usubs in usubs:
locale = _get_tag_locale(u_usubs)
if not locale in tmp_dict:
tmp_dict[locale] = ""
if u_usubs.tag == 'li':
tmp_dict[locale] += "<li>%s</li>" % str_enc_dec(prepare_desc_string(u_usubs.text))
for locale, value in tmp_dict.items():
if not locale in ddict:
# This should not happen (but better be prepared)
ddict[locale] = ""
ddict[locale] += "<%s>%s</%s>" % (usubs.tag, value, usubs.tag)
return ddict
def _parse_screenshots_tag(subs):
'''
Handles screenshots, caption, source-image etc.
'''
shots = []
for usubs in subs:
# for one screeshot tag
if usubs.tag == 'screenshot':
screenshot = dict()
attr_dic = usubs.attrib
if attr_dic.get('type'):
if attr_dic['type'] == 'default':
screenshot['default'] = True
# in case of old styled xmls
url = usubs.text
if url:
url = url.strip()
screenshot['source-image'] = {'url': url}
shots.append(screenshot)
continue
# else look for captions and image tag
for tags in usubs:
if tags.tag == 'caption':
# for localisation
attr_dic = tags.attrib
if attr_dic:
for v in attr_dic.values():
key = v
else:
key = 'C'
if screenshot.get('caption'):
screenshot['caption'][key] = str_enc_dec(tags.text)
else:
screenshot['caption'] = {key: str_enc_dec(tags.text)}
if tags.tag == 'image':
screenshot['source-image'] = {'url': tags.text}
# only add the screenshot if we have a source image
if screenshot.get ('source-image'):
shots.append(screenshot)
return shots
def _parse_releases_tag(relstag):
'''
Parses a releases tag and returns the last three releases
'''
rels = list()
for subs in relstag:
# for one screeshot tag
if subs.tag != 'release':
continue
release = dict()
attr_dic = subs.attrib
if attr_dic.get('version'):
release['version'] = attr_dic['version']
if attr_dic.get('timestamp'):
try:
release['unix-timestamp'] = int(attr_dic['timestamp'])
except:
# the timestamp was wrong - we silently ignore the error
# TODO: Emit warning hint
continue
else:
# we can't use releases which don't have a timestamp
# TODO: Emit a warning hint here
continue
# else look for captions and image tag
for usubs in subs:
if usubs.tag == 'description':
release['description'] = _parse_description_tag(usubs)
rels.append(release)
# sort releases, newest first
rels = sorted(rels, key=lambda k: k['unix-timestamp'], reverse=True)
if len(rels) > 3:
return rels[:3]
return rels
def read_appstream_upstream_xml(cpt, xml_content):
'''
Reads the appdata from the xml file in usr/share/appdata.
Sets ComponentData properties
'''
root = None
try:
root = et.fromstring(bytes(xml_content, 'utf-8'))
except Exception as e:
cpt.add_hint("metainfo-parse-error", str(e))
return
if root is None:
cpt.add_hint("metainfo-parse-error", "Error is unknown, the root node was null.")
if root.tag == 'application':
# we parse ancient AppStream XML, but it is a good idea to update it to make use of newer features, remove some ancient
# oddities and to simplify the parser in future. So we add a hint for that.
cpt.add_hint("ancient-metadata")
key = root.attrib.get('type')
if key:
if key == 'desktop':
cpt.kind = 'desktop-app'
else:
# for other components like addon,codec, inputmethod etc
cpt.kind = root.attrib['type']
for subs in root:
locale = _get_tag_locale(subs)
if subs.tag == 'id':
cpt.cid = subs.text
# legacy support
key = subs.attrib.get('type')
if key and not cpt.kind:
if key == 'desktop':
cpt.kind = 'desktop-app'
else:
cpt.kind = key
elif subs.tag == "name":
cpt.name[locale] = subs.text
elif subs.tag == "summary":
cpt.summary[locale] = subs.text
elif subs.tag == "description":
desc = _parse_description_tag(subs)
cpt.description = desc
elif subs.tag == "screenshots":
screen = _parse_screenshots_tag(subs)
cpt.screenshots = screen
elif subs.tag == "provides":
for bins in subs:
if bins.tag == "binary":
cpt.add_provided_item(
ProvidedItemType.BINARY, bins.text
)
if bins.tag == 'library':
cpt.add_provided_item(
ProvidedItemType.LIBRARY, bins.text
)
if bins.tag == 'dbus':
if not cpt.provides.get(ProvidedItemType.DBUS):
cpt.provides[ProvidedItemType.DBUS] = list()
bus_kind = bins.attrib.get('type')
if bus_kind == "session":
bus_kind = "user"
if bus_kind:
cpt.provides[ProvidedItemType.DBUS].append({'type': bus_kind, 'service': bins.text})
if bins.tag == 'firmware':
if not cpt.provides.get(ProvidedItemType.FIRMWARE):
cpt.provides[ProvidedItemType.FIRMWARE] = list()
fw_type = bins.attrib.get('type')
fw_data = {'type': fw_type}
_valid = True
if fw_type == "flashed":
fw_data['guid'] = bins.text
elif fw_type == "runtime":
fw_data['fname'] = bins.text
else:
_valid = False
if _valid:
cpt.provides[ProvidedItemType.FIRMWARE].append(fw_data)
if bins.tag == 'python2':
cpt.add_provided_item(
ProvidedItemType.PYTHON_2, bins.text
)
if bins.tag == 'python3':
cpt.add_provided_item(
ProvidedItemType.PYTHON_3, bins.text
)
if bins.tag == 'codec':
cpt.add_provided_item(
ProvidedItemType.CODEC, bins.text
)
elif subs.tag == "url":
if cpt.url:
cpt.url.update({subs.attrib['type']: subs.text})
else:
cpt.url = {subs.attrib['type']: subs.text}
elif subs.tag == "project_license":
cpt.project_license = subs.text
elif subs.tag == "project_group":
cpt.project_group = subs.text
elif subs.tag == "developer_name":
cpt.developer_name[locale] = subs.text
elif subs.tag == "extends":
cpt.extends.append(subs.text)
elif subs.tag == "compulsory_for_desktop":
cpt.compulsory_for_desktops.append(subs.text)
elif subs.tag == "releases":
releases = _parse_releases_tag(subs)
cpt.releases = releases
|