/usr/lib/python3/dist-packages/reportbug/utils.py is in python3-reportbug 7.1.8ubuntu1.
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 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 | #
# utils module - common functions for reportbug UIs
# Written by Chris Lawrence <lawrencc@debian.org>
# Copyright (C) 1999-2008 Chris Lawrence
# Copyright (C) 2008-2017 Sandro Tosi <morph@debian.org>
#
# This program is freely distributable per the following license:
#
# Permission to use, copy, modify, and distribute this software and its
# documentation for any purpose and without fee is hereby granted,
# provided that the above copyright notice appears in all copies and that
# both that copyright notice and this permission notice appear in
# supporting documentation.
#
# I DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL I
# BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
# DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
# WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
# ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
# SOFTWARE.
import sys
import os
import re
import platform
try:
import pwd
from .tempfiles import TempFile, tempfile_prefix, cleanup_temp_file
except ImportError as e:
if platform.system() == 'Windows':
pass
else:
print(e)
sys.exit(1)
import shlex
import email
import socket
import subprocess
import pipes
from .urlutils import open_url
from string import ascii_letters, digits
# Paths for dpkg
DPKGLIB = '/var/lib/dpkg'
AVAILDB = os.path.join(DPKGLIB, 'available')
STATUSDB = os.path.join(DPKGLIB, 'status')
# Headers other than these become email headers for debbugs servers
PSEUDOHEADERS = ('Package', 'Source', 'Version', 'Severity', 'File', 'Tags',
'Justification', 'Followup-For', 'Owner', 'User', 'Usertags',
'Forwarded', 'Control')
# These pseudo-headers can be repeated in the report
REPEATABLE_PSEUDOHEADERS = ['Control',]
MODES = {'novice': 'Offer simple prompts, bypassing technical questions.',
'standard': 'Offer more extensive prompts, including asking about '
'things that a moderately sophisticated user would be expected to '
'know about Debian.',
'advanced': 'Like standard, but assumes you know a bit more about '
'Debian, including "incoming".',
'expert': 'Bypass most handholding measures and preliminary triage '
'routines. This mode should not be used by people unfamiliar with '
'Debian\'s policies and operating procedures.'}
MODELIST = ['novice', 'standard', 'advanced', 'expert']
for mode in MODELIST:
exec('MODE_%s=%d' % (mode.upper(), MODELIST.index(mode)))
del mode
# moved here since it needs the MODE_* vars to be defined
from . import debbugs
# it needs to be imported after debbugs
from .ui import text_ui as ui
from reportbug.ui import AVAILABLE_UIS
NEWBIELINE = """Dear Maintainer,
*** Reporter, please consider answering these questions, where appropriate ***
* What led up to the situation?
* What exactly did you do (or not do) that was effective (or
ineffective)?
* What was the outcome of this action?
* What outcome did you expect instead?
*** End of the template - remove these template lines ***"""
fhs_directories = ['/', '/usr', '/usr/share', '/var', '/usr/X11R6',
'/usr/man', '/usr/doc', '/usr/bin']
# A map between codenames and suites
CODENAME2SUITE = {'wheezy': 'oldoldstable',
'jessie': 'oldstable',
'stretch': 'stable',
'buster': 'testing',
'bullseye': 'next-testing',
'sid': 'unstable',
'experimental': 'experimental'}
SUITE2CODENAME = dict([(suite, codename) for codename, suite in list(CODENAME2SUITE.items())])
def realpath(filename):
filename = os.path.abspath(filename)
bits = filename.split('/')
for i in range(2, len(bits) + 1):
component = '/'.join(bits[0:i])
if component in fhs_directories:
continue
if os.path.islink(component):
resolved = os.readlink(component)
(dir, file) = os.path.split(component)
resolved = os.path.normpath(os.path.join(dir, resolved))
newpath = os.path.join(*[resolved] + bits[i:])
return realpath(newpath)
return filename
pathdirs = ['/usr/sbin', '/usr/bin', '/sbin', '/bin', '/usr/X11R6/bin',
'/usr/games']
def search_path_for(filename):
d, f = os.path.split(filename)
if d:
return realpath(filename)
path = os.environ.get("PATH", os.defpath).split(':')
for d in pathdirs:
if d not in path:
path.append(d)
for d in path:
fullname = os.path.join(d, f)
if os.path.exists(fullname):
return realpath(fullname)
return None
def which_editor(specified_editor=None):
""" Determine which editor program to use.
:parameters:
`specified_editor`
Specified editor for reportbug, to be used in preference
to other settings.
:return value:
Command to invoke for selected editor program.
"""
debian_default_editor = "/usr/bin/sensible-editor"
for editor in [specified_editor,
os.environ.get("VISUAL"),
os.environ.get("EDITOR"),
debian_default_editor]:
if editor:
break
return editor
def glob_escape(filename):
filename = re.sub(r'([*?\[\]])', r'\\\1', filename)
return filename
def search_pipe(searchfile, use_dlocate=True):
arg = pipes.quote(searchfile)
if use_dlocate and os.path.exists('/usr/bin/dlocate'):
pipe = os.popen('COLUMNS=79 dlocate -S %s 2>/dev/null' % arg)
else:
use_dlocate = False
pipe = os.popen('COLUMNS=79 dpkg --search %s 2>/dev/null' % arg)
return (pipe, use_dlocate)
def get_command_output(cmd):
use_shell = False
if isinstance(cmd, str) and ' ' in cmd:
use_shell = True
return subprocess.run(cmd, shell=use_shell, stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode(errors='backslashreplace')
def query_dpkg_for(filename, use_dlocate=True):
try:
x = os.getcwd()
except OSError:
os.chdir('/')
searchfilename = glob_escape(filename)
(pipe, dlocate_used) = search_pipe(searchfilename, use_dlocate)
packages = {}
for line in pipe:
line = line.strip()
# Ignore diversions
if 'diversion by' in line:
continue
(package, path) = line.split(': ', 1)
path = path.strip()
packlist = package.split(', ')
for package in packlist:
if package in packages:
packages[package].append(path)
else:
packages[package] = [path]
pipe.close()
# Try again without dlocate if no packages found
if not packages and dlocate_used:
return query_dpkg_for(filename, use_dlocate=False)
return filename, packages
def find_package_for(filename, pathonly=False):
"""Find the package(s) containing this file."""
packages = {}
# tries to match also files in /var/lib/dpkg/info/
if filename.startswith('/var/lib/dpkg/info/'):
dpkg_info = re.compile(r'/var/lib/dpkg/info/(.+)\.[^.]+')
m = dpkg_info.match(filename)
# callee want a dict as second pair element...
packages[m.group(1)] = ''
return (filename, packages)
if filename[0] == '/':
fn, pkglist = query_dpkg_for(filename)
if pkglist:
return fn, pkglist
newfilename = search_path_for(filename)
if pathonly and not newfilename:
return (filename, None)
return query_dpkg_for(newfilename or filename)
def find_rewritten(username):
for filename in ['/etc/email-addresses']:
if os.path.exists(filename):
try:
fp = open(filename, errors='backslashreplace')
except IOError:
continue
for line in fp:
line = line.strip().split('#')[0]
if not line:
continue
try:
name, alias = line.split(':')
if name.strip() == username:
return alias.strip()
except ValueError:
print('Invalid entry in %s' % filename)
return None
def check_email_addr(addr):
"""Simple check for email validity"""
if '@' not in addr:
return False
if addr.count('@') != 1:
return False
localpart, domainpart = addr.split('@')
if localpart.startswith('.') or localpart.endswith('.'):
return False
if '.' not in domainpart:
return False
if domainpart.startswith('.') or domainpart.endswith('.'):
return False
return True
def get_email_addr(addr):
return email.utils.getaddresses([addr,])[0]
def get_email(emailaddr='', realname=''):
return get_email_addr(get_user_id(emailaddr, realname))
def get_user_id(emailaddr='', realname='', charset='utf-8'):
uid = os.getuid()
info = pwd.getpwuid(uid)
emailaddr = (os.environ.get('REPORTBUGEMAIL', emailaddr) or
os.environ.get('DEBEMAIL') or os.environ.get('EMAIL'))
emailaddr = emailaddr or find_rewritten(info[0]) or info[0]
if '@' not in emailaddr:
if os.path.exists('/etc/mailname'):
domainname = open('/etc/mailname').readline().strip()
else:
domainname = socket.getfqdn()
emailaddr = emailaddr + '@' + domainname
# Handle EMAIL if it's formatted as 'Bob <bob@host>'.
if '<' in emailaddr or '(' in emailaddr:
realname, emailaddr = get_email_addr(emailaddr)
if not realname:
realname = (os.environ.get('DEBFULLNAME') or os.environ.get('DEBNAME')
or os.environ.get('NAME'))
if not realname:
realname = info[4].split(',', 1)[0]
# Convert & in gecos field 4 to capitalized logname: #224231
realname = realname.replace('&', info[0].capitalize())
if not realname:
return emailaddr
return email.utils.formataddr((realname, emailaddr))
statuscache = {}
def get_package_status(package, avail=False):
if not avail and package in statuscache:
return statuscache[package]
versionre = re.compile('Version: ')
packagere = re.compile('Package: ')
priorityre = re.compile('Priority: ')
dependsre = re.compile('(Pre-)?Depends: ')
recsre = re.compile('Recommends: ')
suggestsre = re.compile('Suggests: ')
conffilesre = re.compile('Conffiles:')
maintre = re.compile('Maintainer: ')
statusre = re.compile('Status: ')
originre = re.compile('Origin: ')
bugsre = re.compile('Bugs: ')
descre = re.compile('Description(?:-[a-zA-Z]+)?: ')
fullre = re.compile(' ')
srcre = re.compile('Source: ')
sectionre = re.compile('Section: ')
pkgversion = pkgavail = maintainer = status = origin = None
bugs = vendor = priority = desc = src_name = section = None
conffiles = []
fulldesc = []
depends = []
recommends = []
suggests = []
confmode = False
descmode = False
state = ''
try:
x = os.getcwd()
except OSError:
os.chdir('/')
packarg = pipes.quote(package)
if avail:
output = get_command_output(
"LC_ALL=C.UTF-8 apt-cache show %s 2>/dev/null" % packarg)
else:
output = get_command_output(
"COLUMNS=79 dpkg --status %s 2>/dev/null" % packarg)
for line in output.split(os.linesep):
line = line.rstrip()
if not line:
continue
if descmode:
if line[0] == ' ':
fulldesc.append(line)
else:
descmode = False
if confmode:
if line[:2] != ' /':
confmode = False
else:
# re is used to identify also conffiles with spaces in the name
conffiles += re.findall(r' (.+) ([0-9a-f]+).*$', line)
if versionre.match(line):
(crud, pkgversion) = line.split(": ", 1)
elif statusre.match(line):
(crud, status) = line.split(": ", 1)
elif priorityre.match(line):
(crud, priority) = line.split(": ", 1)
elif packagere.match(line):
(crud, pkgavail) = line.split(": ", 1)
elif originre.match(line):
(crud, origin) = line.split(": ", 1)
elif bugsre.match(line):
(crud, bugs) = line.split(": ", 1)
elif descre.match(line):
(crud, desc) = line.split(": ", 1)
descmode = True
elif dependsre.match(line):
(crud, thisdepends) = line.split(": ", 1)
# Remove versioning crud
thisdepends = [[y.split()[0] for y in x.split('|')]
for x in (thisdepends.split(', '))]
depends.extend(thisdepends)
elif recsre.match(line):
(crud, thisdepends) = line.split(": ", 1)
# Remove versioning crud
thisdepends = [[y.split()[0] for y in x.split('|')]
for x in (thisdepends.split(', '))]
recommends.extend(thisdepends)
elif suggestsre.match(line):
(crud, thisdepends) = line.split(": ", 1)
# Remove versioning crud
thisdepends = [[y.split()[0] for y in x.split('|')]
for x in (thisdepends.split(', '))]
suggests.extend(thisdepends)
elif conffilesre.match(line):
confmode = True
elif maintre.match(line):
crud, maintainer = line.split(": ", 1)
elif srcre.match(line):
crud, src_name = line.split(": ", 1)
src_name = src_name.split()[0]
elif sectionre.match(line):
crud, section = line.split(": ", 1)
installed = False
if status:
state = status.split()[2]
installed = (state not in ('config-files', 'not-installed'))
reportinfo = None
if bugs:
reportinfo = debbugs.parse_bts_url(bugs)
elif origin:
if origin in debbugs.SYSTEMS:
vendor = debbugs.SYSTEMS[origin]['name']
reportinfo = (debbugs.SYSTEMS[origin].get('type', 'debbugs'),
debbugs.SYSTEMS[origin]['btsroot'])
else:
vendor = origin.capitalize()
else:
vendor = ''
info = (pkgversion, pkgavail, tuple(depends), tuple(recommends),
tuple(conffiles),
maintainer, installed, origin, vendor, reportinfo, priority,
desc, src_name, os.linesep.join(fulldesc), state, tuple(suggests),
section)
if not avail:
statuscache[package] = info
return info
# dbase = []
# avail = []
# Object that essentially chunkifies the output of apt-cache dumpavail
class AvailDB(object):
def __init__(self, fp=None, popenob=None):
self.popenob = popenob
if fp:
self.fp = fp
elif popenob:
self.fp = popenob.stdout
def __iter__(self):
return self
def __next__(self):
chunk = ''
while True:
if self.popenob:
if self.popenob.returncode:
break
line = self.fp.readline()
if not line:
break
if line == '\n':
return chunk
chunk += str(line)
if chunk:
return chunk
raise StopIteration
def __del__(self):
# print >> sys.stderr, 'availdb cleanup', repr(self.popenob), repr(self.fp)
if self.popenob:
# Clear the pipe before shutting it down
while True:
if self.popenob.returncode:
break
stuff = self.fp.read(65536)
if not stuff:
break
self.popenob.wait()
if self.fp:
self.fp.close()
def get_dpkg_database():
try:
fp = open(STATUSDB, errors="backslashreplace")
if fp:
return AvailDB(fp=fp)
except IOError:
print('Unable to open', STATUSDB, file=sys.stderr)
sys.exit(1)
def get_avail_database():
# print >> sys.stderr, 'Searching available database'
subp = subprocess.Popen(('apt-cache', 'dumpavail'), stdout=subprocess.PIPE)
return AvailDB(popenob=subp)
def available_package_description(package):
data = get_command_output('apt-cache show ' + pipes.quote(package))
descre = re.compile('^Description(?:-[a-zA-Z]+)?: (.*)$')
for line in data.split('\n'):
m = descre.match(line)
if m:
return m.group(1)
return None
def get_source_name(package):
packages = []
data = get_command_output('apt-cache showsrc ' + pipes.quote(package))
packre = re.compile(r'^Package: (.*)$')
for line in data.split('\n'):
m = packre.match(line)
if m:
return m.group(1)
return None
def get_source_package(package):
packages = []
retlist = []
found = {}
data = get_command_output('apt-cache showsrc ' + pipes.quote(package))
binre = re.compile(r'^Binary: (.*)$')
for line in data.split('\n'):
m = binre.match(line)
if m:
packs = m.group(1)
packlist = re.split(r',\s*', packs)
packages += packlist
for p in packages:
desc = available_package_description(p)
if desc and (p not in found):
retlist += [(p, desc)]
found[p] = desc
retlist.sort()
return retlist
def get_package_info(packages, skip_notfound=False):
if not packages:
return []
packinfo = get_dpkg_database()
pkgname = r'(?:[\S]+(?:$|,\s+))'
groupfor = {}
searchpkgs = []
searchbits = []
for (group, package) in packages:
groupfor[package] = group
escpkg = re.escape(package)
searchpkgs.append(escpkg)
searchbits = [
# Package regular expression
r'^(?P<hdr>Package):\s+(' + '|'.join(searchpkgs) + ')$',
# Provides regular expression
r'^(?P<hdr>Provides):\s+' + pkgname + r'*(?P<pkg>' + '|'.join(searchpkgs) +
r')(?:$|,\s+)' + pkgname + '*$'
]
groups = list(groupfor.values())
found = {}
searchobs = [re.compile(x, re.MULTILINE) for x in searchbits]
packob = re.compile('^Package: (?P<pkg>.*)$', re.MULTILINE)
statob = re.compile('^Status: (?P<stat>.*)$', re.MULTILINE)
versob = re.compile('^Version: (?P<vers>.*)$', re.MULTILINE)
descob = re.compile('^Description(?:-[a-zA-Z]+)?: (?P<desc>.*)$', re.MULTILINE)
ret = []
for p in packinfo:
for ob in searchobs:
m = ob.search(p)
if m:
pack = packob.search(p).group('pkg')
stat = statob.search(p).group('stat')
sinfo = stat.split()
stat = sinfo[0][0] + sinfo[2][0]
# check if the package is installed, and in that case, retrieve
# its information; if the first char is not 'i' (installed) or
# the second is 'n' (not-installed), then skip data retrieval
if stat[0] != 'i' or stat[1] == 'n':
continue
if m.group('hdr') == 'Provides':
provides = m.group('pkg')
else:
provides = None
vers = versob.search(p).group('vers')
desc = descob.search(p).group('desc')
info = (pack, stat, vers, desc, provides)
ret.append(info)
group = groupfor.get(pack)
if group:
for item in group:
found[item] = True
if provides not in found:
found[provides] = True
if skip_notfound:
return ret
for group in groups:
notfound = [x for x in group if x not in found]
if len(notfound) == len(group):
if group not in found:
ret.append((' | '.join(group), 'pn', '<none>',
'(no description available)', None))
return ret
def packages_providing(package):
aret = get_package_info([((package,), package)], skip_notfound=True)
ret = []
for pkg in aret:
ret.append((pkg[0], pkg[3]))
return ret
def get_dependency_info(package, depends, rel="depends on"):
if not depends:
return ('\n%s %s no packages.\n' % (package, rel))
dependencies = []
for dep in depends:
# drop possible architecture qualifier from package names
dep = [d.split(':')[0] for d in dep]
for bit in dep:
dependencies.append((tuple(dep), bit))
depinfo = "\nVersions of packages %s %s:\n" % (package, rel)
packs = {}
for info in get_package_info(dependencies):
pkg = info[0]
if pkg not in packs:
packs[pkg] = info
elif info[4]:
if not packs[pkg][4]:
packs[pkg] = info
deplist = list(packs.values())
deplist.sort()
deplist2 = []
# extract the info we need, also add provides where it fits
for (pack, status, vers, desc, provides) in deplist:
if provides:
pack += ' [' + provides + ']'
deplist2.append((pack, vers, status))
deplist = deplist2
# now we can compute the max possible value for each column, that can be the
# max of all its values, or the space left from the other column; this way,
# the sum of the 2 fields is never > 73 (hence the resulting line is <80
# columns)
maxp = max([len(x[0]) for x in deplist])
maxv = max([len(x[1]) for x in deplist])
widthp = min(maxp, 73 - maxv)
widthv = min(maxv, 73 - widthp)
for (pack, vers, status) in deplist:
# we format the string specifying to align it in a field of a given
# dimension (the first {width*}) but also limit its size (the second
# {width*}
info = '{0:3.3} {1:{widthp}.{widthp}} {2:{widthv}.{widthv}}'.format(
status, pack, vers, widthp=widthp, widthv=widthv)
# remove tailing white spaces
depinfo += info.rstrip() + '\n'
return depinfo
def get_changed_config_files(conffiles, nocompress=False):
confinfo = {}
changed = []
for (filename, md5sum) in conffiles:
try:
fp = open(filename, errors='backslashreplace')
except IOError as msg:
confinfo[filename] = msg
continue
filemd5 = get_command_output('md5sum ' + pipes.quote(filename)).split()[0]
if filemd5 == md5sum:
continue
changed.append(filename)
thisinfo = 'changed:\n'
for line in fp:
if not line:
continue
if line == '\n' and not nocompress:
continue
if line[0] == '#' and not nocompress:
continue
thisinfo += line
confinfo[filename] = thisinfo
return confinfo, changed
DISTORDER = ['oldstable', 'stable', 'testing', 'unstable', 'experimental']
def get_debian_release_info():
debvers = debinfo = verfile = warn = ''
dists = []
output = get_command_output('apt-cache policy 2>/dev/null')
if output:
mre = re.compile(r'\s+(\d+)\s+.*$\s+release\s.*o=(Ubuntu|Debian|Debian Ports),a=([^,]+),', re.MULTILINE)
found = {}
# XXX: When Python 2.4 rolls around, rewrite this
for match in mre.finditer(output):
pword, distname = match.group(1, 3)
if distname in DISTORDER:
pri, dist = int(pword), DISTORDER.index(distname)
else:
pri, dist = int(pword), len(DISTORDER)
found[(pri, dist, distname)] = True
if found:
dists = list(found.keys())
dists.sort()
dists.reverse()
dists = [(x[0], x[2]) for x in dists]
debvers = dists[0][1]
try:
with open('/etc/debian_version', errors='backslashreplace') as fob:
verfile = fob.readline().strip()
except IOError:
print('Unable to open /etc/debian_version', file=sys.stderr)
if verfile:
debinfo += 'Debian Release: ' + verfile + '\n'
if debvers:
debinfo += ' APT prefers ' + debvers + '\n'
if dists:
# Should wrap this eventually...
# policystr = pprint.pformat(dists)
policystr = ', '.join([str(x) for x in dists])
debinfo += ' APT policy: %s\n' % policystr
if warn:
debinfo += warn
return debinfo
def lsb_release_info():
return get_command_output('lsb_release -a 2>/dev/null')
def get_arch():
arch = get_command_output('COLUMNS=79 dpkg --print-architecture 2>/dev/null').strip()
if not arch:
un = os.uname()
arch = un[4]
arch = re.sub(r'i[456]86', 'i386', arch)
arch = re.sub(r's390x', 's390', arch)
arch = re.sub(r'ppc', 'powerpc', arch)
return arch
def get_multiarch():
out = get_command_output('COLUMNS=79 dpkg --print-foreign-architectures 2>/dev/null')
return ', '.join(out.splitlines())
def generate_blank_report(package, pkgversion, severity, justification,
depinfo, confinfo, foundfile='', incfiles='',
system='debian', exinfo=None, type=None, klass='',
subject='', tags='', body='', mode=MODE_EXPERT,
pseudos=None, debsumsoutput=None, issource=False):
# For now...
from . import bugreport
sysinfo = (package not in ('wnpp', 'ftp.debian.org'))
# followup is where bugreport expects the notification of the bug reportbug
# to follow-up, but reportbug pass this information with 'exinfo'
rep = bugreport.bugreport(package, version=pkgversion, severity=severity,
justification=justification, filename=foundfile,
mode=mode, subject=subject, tags=tags, body=body,
pseudoheaders=pseudos, followup=exinfo, type=type,
system=system, depinfo=depinfo, sysinfo=sysinfo,
confinfo=confinfo, incfiles=incfiles,
debsumsoutput=debsumsoutput, issource=issource)
return str(rep)
def get_cpu_cores():
cpucount = 0
try:
fob = open('/proc/cpuinfo')
except IOError:
print('Unable to open /proc/cpuinfo', file=sys.stderr)
return 0
for line in fob:
if line.startswith('processor'):
cpucount += 1
# Alpha platform
if line.startswith('cpus detected'):
cpucount = int(line.split()[-1])
fob.close()
return max(cpucount, 1)
class our_lex(shlex.shlex):
def get_token(self):
token = shlex.shlex.get_token(self)
if token is None or not len(token):
return token
if (token[0] == token[-1]) and token[0] in self.quotes:
token = token[1:-1]
return token
USERFILE = os.path.expanduser('~/.reportbugrc')
FILES = ('/etc/reportbug.conf', USERFILE)
CONFIG_ARGS = (
'sendto', 'severity', 'mua', 'mta', 'email', 'realname', 'bts', 'verify',
'replyto', 'http_proxy', 'smtphost', 'editor', 'debconf', 'justification',
'sign', 'nocc', 'nocompress', 'dontquery', 'noconf', 'mirrors', 'keyid',
'headers', 'interface', 'template', 'mode', 'check_available', 'query_src',
'printonly', 'offline', 'check_uid', 'smtptls', 'smtpuser', 'smtppasswd',
'paranoid', 'mbox_reader_cmd', 'max_attachment_size')
class Mua:
command = ""
name = ""
def __init__(self, command):
self.command = command
self.name = command.split()[0]
def send(self, filename):
mua = self.command
if '%s' not in mua:
mua += ' %s'
return ui.system(mua % pipes.quote(filename))
def get_name(self):
return self.name
class Gnus(Mua):
name = "gnus"
def __init__(self):
pass
def send(self, filename):
elisp = """(progn
(load-file "/usr/share/reportbug/reportbug.el")
(tfheen-reportbug-insert-template "%s"))"""
filename = re.sub("[\"\\\\]", "\\\\\\g<0>", filename)
elisp = pipes.quote(elisp % filename)
return ui.system("emacsclient --no-wait --eval %s 2>/dev/null"
" || emacs --eval %s" % (elisp, elisp))
MUA = {
'mutt': Mua('mutt -H'),
'mh': Mua('/usr/bin/mh/comp -use -file'),
'gnus': Gnus(),
'claws-mail': Mua('claws-mail --compose-from-file'),
}
MUA['nmh'] = MUA['mh']
# TODO: convert them to class methods
MUAVERSION = {
MUA['mutt']: 'mutt -v',
MUA['mh']: '/usr/bin/mh/comp -use -file',
MUA['gnus']: 'emacs --version',
MUA['claws-mail']: 'claws-mail --version',
}
def mua_is_supported(mua):
# check if the mua is supported by reportbug
if mua == 'mh' or mua == MUA['mh']:
mua_tmp = 'mh'
elif mua == 'nmh' or mua == MUA['nmh']:
mua_tmp = 'mh'
elif mua == 'gnus' or mua == MUA['gnus']:
mua_tmp = 'gnus'
elif mua == 'mutt' or mua == MUA['mutt']:
mua_tmp = 'mutt'
elif mua == 'claws-mail' or mua == MUA['claws-mail']:
mua_tmp = 'claws-mail'
else:
mua_tmp = mua
if mua_tmp not in MUA:
return False
else:
return True
def mua_exists(mua):
# check if the mua is available on the system
if mua == 'mh' or mua == MUA['mh']:
mua_tmp = MUA['mh']
elif mua == 'nmh' or mua == MUA['nmh']:
mua_tmp = MUA['mh']
elif mua == 'gnus' or mua == MUA['gnus']:
mua_tmp = MUA['gnus']
elif mua == 'mutt' or mua == MUA['mutt']:
mua_tmp = MUA['mutt']
elif mua == 'claws-mail' or mua == MUA['claws-mail']:
mua_tmp = MUA['claws-mail']
else:
mua_tmp = MUA[mua]
output = '/dev/null'
if os.path.exists(output):
try:
returnvalue = subprocess.call(MUAVERSION[mua_tmp],
stdout=open(output, 'w', errors='backslashreplace'),
stderr=subprocess.STDOUT,
shell=True)
except (IOError, OSError):
returnvalue = subprocess.call(MUAVERSION[mua_tmp], shell=True)
else:
returnvalue = subprocess.call(MUAVERSION[mua_tmp], shell=True)
# 127 is the shell standard return value to indicate a 'command not found' result
if returnvalue == 127:
return False
else:
return True
def mua_name(mua):
# in case the user specifies only the mua name in --mua, returns the default options
if mua in MUA:
return MUA[mua]
else:
return mua
def first_run():
return not os.path.exists(USERFILE)
def parse_config_files():
args = {}
for filename in FILES:
if os.path.exists(filename):
try:
lex = our_lex(open(filename, errors="backslashreplace"), posix=True)
except IOError as msg:
continue
lex.wordchars = lex.wordchars + '-.@/:<>'
token = lex.get_token()
while token:
token = token.lower()
if token in ('quiet', 'maintonly', 'submit'):
args['sendto'] = token
elif token == 'severity':
token = lex.get_token().lower()
if token in list(debbugs.SEVERITIES.keys()):
args['severity'] = token
elif token == 'header':
args['headers'] = args.get('headers', []) + [lex.get_token()]
elif token in ('no-cc', 'cc'):
args['nocc'] = (token == 'no-cc')
elif token in ('no-compress', 'compress'):
args['nocompress'] = (token == 'no-compress')
elif token in ('no-query-bts', 'query-bts'):
args['dontquery'] = (token == 'no-query-bts')
elif token in ('config-files', 'no-config-files'):
args['noconf'] = (token == 'no-config-files')
elif token in ('printonly', 'template', 'offline'):
args[token] = True
elif token in ('email', 'realname', 'replyto', 'http_proxy',
'smtphost', 'editor', 'mua', 'mta', 'smtpuser',
'smtppasswd', 'justification', 'keyid',
'mbox_reader_cmd'):
bit = lex.get_token()
args[token] = bit
elif token in ('no-smtptls', 'smtptls'):
args['smtptls'] = (token == 'smtptls')
elif token == 'sign':
token = lex.get_token().lower()
if token in ('pgp', 'gpg'):
args['sign'] = token
elif token == 'gnupg':
args['sign'] = 'gpg'
elif token == 'none':
args['sign'] = ''
elif token == 'ui':
token = lex.get_token().lower()
if token in list(AVAILABLE_UIS.keys()):
args['interface'] = token
elif token == 'mode':
arg = lex.get_token().lower()
if arg in list(MODES.keys()):
args[token] = arg
elif token == 'bts':
token = lex.get_token().lower()
if token in list(debbugs.SYSTEMS.keys()):
args['bts'] = token
elif token == 'mirror':
args['mirrors'] = args.get('mirrors', []) + [lex.get_token()]
elif token in ('no-check-available', 'check-available'):
args['check_available'] = (token == 'check-available')
elif token == 'reportbug_version':
# Currently ignored; might be used for compat purposes
# eventually
w_version = lex.get_token().lower()
elif token in MUA:
args['mua'] = MUA[token]
elif token in ('query-source', 'no-query-source'):
args['query_src'] = (token == 'query-source')
elif token in ('debconf', 'no-debconf'):
args['debconf'] = (token == 'debconf')
elif token in ('verify', 'no-verify'):
args['verify'] = (token == 'verify')
elif token in ('check-uid', 'no-check-uid'):
args['check_uid'] = (token == 'check-uid')
elif token in ('paranoid', 'no-paranoid'):
args['paranoid'] = (token == 'paranoid')
elif token == 'max_attachment_size':
arg = lex.get_token()
args['max_attachment_size'] = int(arg)
elif token == 'envelopefrom':
token = lex.get_token().lower()
args['envelopefrom'] = token
else:
sys.stderr.write('Unrecognized token: %s\n' % token)
token = lex.get_token()
return args
def parse_bug_control_file(filename):
submitas = submitto = None
reportwith = []
supplemental = []
fh = open(filename, errors='backslashreplace')
for line in fh:
line = line.strip()
parts = line.split(': ')
if len(parts) != 2:
continue
header, data = parts[0].lower(), parts[1]
if header == 'submit-as':
submitas = data
elif header == 'send-to':
submitto = data
elif header == 'report-with':
reportwith += data.split(' ')
elif header == 'package-status':
supplemental += data.split(' ')
return submitas, submitto, reportwith, supplemental
def cleanup_msg(dmessage, headers, pseudos, type):
pseudoheaders = []
# Handle non-pseduo-headers
headerre = re.compile(r'^([^:]+):\s*(.*)$', re.I)
newsubject = message = ''
parsing = lastpseudo = True
# Include the headers that were passed in too!
newheaders = []
for header in headers:
mob = headerre.match(header)
if mob:
newheaders.append(mob.groups())
# Get the pseudo-headers fields
PSEUDOS = []
for ph in pseudos:
mob = headerre.match(ph)
if mob:
PSEUDOS.append(mob.group(1))
for line in dmessage.split(os.linesep):
if not line and parsing:
parsing = False
elif parsing:
mob = headerre.match(line)
# GNATS and debbugs have different ideas of what a pseudoheader
# is...
if mob and ((type == 'debbugs' and
mob.group(1) not in PSEUDOHEADERS and
mob.group(1) not in PSEUDOS) or
(type == 'gnats' and mob.group(1)[0] != '>')):
newheaders.append(mob.groups())
lastpseudo = False
continue
elif mob:
# Normalize pseudo-header
lastpseudo = False
key, value = mob.groups()
if key[0] != '>':
# Normalize hyphenated headers to capitalize each word
key = '-'.join([x.capitalize() for x in key.split('-')])
pseudoheaders.append((key, value))
elif not lastpseudo and len(newheaders):
# Assume we have a continuation line
lastheader = newheaders[-1]
newheaders[-1] = (lastheader[0], lastheader[1] + '\n' + line)
continue
else:
# Permit bogus headers in the pseudoheader section
headers.append(re.split(r':\s+', line, 1))
elif line.strip() != NEWBIELINE:
message += line + '\n'
ph = []
if type == 'gnats':
for header, content in pseudoheaders:
if content:
ph += ["%s: %s" % (header, content)]
else:
ph += [header]
else:
ph2 = {}
repeatable_ph = []
# generate a list of pseudoheaders, but without duplicates
# we take the list of pseudoheaders defined in reportbug and add
# the ones passed by the user (if not already present). We are not using
# set(..) because we want to preserve the item order of PSEUDOHEADERS
pseudo_list = list(PSEUDOHEADERS)
for p in PSEUDOS:
if p not in pseudo_list:
pseudo_list.append(p)
for header, content in pseudoheaders:
# if either in the canonical pseudo-headers list or in those passed on the command line
if header in pseudo_list:
if header not in REPEATABLE_PSEUDOHEADERS:
ph2[header] = content
else:
repeatable_ph += ['%s: %s' % (header, content)]
else:
newheaders.append((header, content))
for header in pseudo_list:
if header in ph2:
ph += ['%s: %s' % (header, ph2[header])]
ph.extend(repeatable_ph)
return message, newheaders, ph
def launch_mbox_reader(cmd, url, http_proxy, timeout):
"""Runs the command specified by cmd passing the mbox file
downloaded from url as a parameter. If cmd is None or fails, then
fallback to mail program."""
mbox = open_url(url, http_proxy, timeout)
if mbox is None:
return
(fd, fname) = TempFile()
try:
for line in mbox.splitlines():
fd.write(line + '\n')
fd.close()
if cmd is not None:
try:
cmd = cmd % fname
except TypeError:
cmd = "%s %s" % (cmd, fname)
error = os.system(cmd)
if not error:
return
# fallback
os.system('mail -f ' + fname)
finally:
os.unlink(fname)
def get_running_kernel_pkg():
"""Return the package of the currently running kernel, needed to force
assignment for 'kernel' package to a real one"""
system = platform.system()
release = platform.release()
if system == 'Linux':
return 'linux-image-' + release
elif system == 'GNU/kFreeBSD':
return 'kfreebsd-image-' + release
else:
return None
def exec_and_parse_bugscript(handler, bugscript):
"""Execute and parse the output of the package bugscript, in particular
identifying the headers and pseudo-headers blocks, if present"""
fh, filename = TempFile()
fh.close()
rc = os.system('LC_ALL=C %s %s %s' % (handler, pipes.quote(bugscript),
pipes.quote(filename)))
isheaders = False
ispseudoheaders = False
isattachments = False
headers = pseudoheaders = text = ''
attachments = []
fp = open(filename, errors="backslashreplace")
for line in fp.readlines():
# we identify the blocks for headers and pseudo-h
if line == '-- BEGIN HEADERS --\n':
isheaders = True
elif line == '-- END HEADERS --\n':
isheaders = False
elif line == '-- BEGIN PSEUDOHEADERS --\n':
ispseudoheaders = True
elif line == '-- END PSEUDOHEADERS --\n':
ispseudoheaders = False
elif line == '-- BEGIN ATTACHMENTS --\n':
isattachments = True
elif line == '-- END ATTACHMENTS --\n':
isattachments = False
else:
if isheaders:
headers += line
elif ispseudoheaders:
pseudoheaders += line
elif isattachments:
attachments.append(line.strip())
else:
text += line
fp.close()
cleanup_temp_file(filename)
return (rc, headers, pseudoheaders, text, attachments)
def check_package_name(pkg):
"""Check the package name against Debian Policy:
https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Source
Returns True if the package name is valid."""
pkg_re = re.compile(r'^[a-z0-9][a-z0-9+-\.]+$')
return True if pkg_re.match(pkg) else False
def get_init_system():
"""Determines the init system on the current machine"""
init = 'unable to detect'
if os.path.isdir('/run/systemd/system'):
init = 'systemd (via /run/systemd/system)'
if not subprocess.call('. /lib/lsb/init-functions ; init_is_upstart', shell=True):
init = 'upstart (via init_is_upstart())'
elif os.path.isfile('/sbin/init') and not os.path.islink('/sbin/init'):
init = 'sysvinit (via /sbin/init)'
return init
def get_lsm_info():
"""Determines the linux security module enabled on the current machine
Returns None if there is no LSM enabled on the machine or if the state
cannot be determined."""
lsminfo = None
if os.path.exists('/usr/bin/aa-enabled') \
and (subprocess.call(['/usr/bin/aa-enabled', '--quiet']) == 0):
lsminfo = 'AppArmor: enabled'
if os.path.exists('/usr/sbin/selinuxenabled') and (subprocess.call(['/usr/sbin/selinuxenabled']) == 0):
if lsminfo is None:
lsminfo = 'SELinux: enabled - '
else:
lsminfo += '; SELinux: enabled - '
enforce_status = subprocess.check_output(['/usr/sbin/getenforce']).decode('ascii')
lsminfo += 'Mode: %s - ' % enforce_status[:-1]
with open('/etc/selinux/config', 'r') as f:
lines = f.readlines()
for line in lines:
if line.startswith('SELINUXTYPE='):
lsminfo += 'Policy name: %s' % line.split('=')[1][:-1]
break
return lsminfo
|