openkylin
/
apport
mirror of https://gitee.com/openkylin/apport.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

changed debian/source/format to native

This commit is contained in:
luoyaoming 2024-04-30 16:29:45 +08:00
parent 70b7a4bc93
commit a6065fae23
6 changed files with 1 additions and 1348 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

323
debian/patches/Add-bin-oem-getlogs.patch vendored
View File

@ -1,323 +0,0 @@
From: Benjamin Drung <bdrung@ubuntu.com>
Date: Thu, 9 Jun 2022 15:20:43 +0200
Subject: Add bin/oem-getlogs
Forwarded: not-needed
---
bin/oem-getlogs | 307 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 307 insertions(+)
create mode 100755 bin/oem-getlogs
diff --git a/bin/oem-getlogs b/bin/oem-getlogs
new file mode 100755
index 0000000..8e9cd5a
--- /dev/null
+++ b/bin/oem-getlogs
@@ -0,0 +1,307 @@
+#! /usr/bin/python3
+
+"""Get Hardware Enablement related logs"""
+
+# TODO: Address following pylint complaints
+# pylint: disable=invalid-name,missing-function-docstring
+
+import gzip
+import os
+import re
+import shutil
+import subprocess
+import sys
+import tempfile
+import time
+import zipfile
+from argparse import ArgumentParser
+from glob import glob
+from io import BytesIO
+
+import apport
+from apport import hookutils
+from problem_report import CompressedValue
+
+opt_debug = False
+
+
+# Apport helper routines
+def debug(text):
+ if opt_debug:
+ print(f"{text}\n")
+
+
+def attach_command_output(report, command_list, key):
+ debug(" ".join(command_list))
+ log = hookutils.command_output(command_list)
+ if not log or log[:5] == "Error":
+ return
+ report[key] = log
+
+
+def attach_pathglob_as_zip(report, pathglob, key, data_filter=None, mode="b"):
+ """Use zip file here because tarfile module in linux can't
+ properly handle file size 0 with content in /sys directory like
+ edid file. zipfile module works fine here. So we use it.
+
+ mode:
+ a: for ascii mode of data
+ b: for binary mode of data
+ """
+ filelist = []
+ for pg in pathglob:
+ for file in glob(pg):
+ filelist.append(file)
+
+ zipf = BytesIO()
+ with zipfile.ZipFile(zipf, mode="w", compression=zipfile.ZIP_DEFLATED) as zipobj:
+ for f in filelist:
+ if opt_debug:
+ print(key, f)
+ if not os.path.isfile(f):
+ if opt_debug:
+ print(f, "is not a file")
+ continue
+ if mode == "a":
+ with open(f, encoding="ascii") as f_fd:
+ data = f_fd.read()
+ if data_filter is None:
+ zipobj.writestr(f, data)
+ else:
+ zipobj.writestr(f, data_filter(data))
+ else:
+ zipobj.write(f)
+ cvalue = CompressedValue()
+ cvalue.set_value(zipf.getbuffer())
+ report[key + ".zip"] = cvalue
+
+
+def attach_nvidia_debug_logs(report, keep_locale=False):
+ # check if nvidia-bug-report.sh exists
+ nv_debug_command = "nvidia-bug-report.sh"
+
+ if shutil.which(nv_debug_command) is None:
+ if opt_debug:
+ print(nv_debug_command, "does not exist.")
+ return
+
+ env = os.environ.copy()
+ if not keep_locale:
+ env["LC_MESSAGES"] = "C"
+
+ # output result to temp directory
+ nv_tempdir = tempfile.mkdtemp()
+ nv_debug_file = "nvidia-bug-report"
+ nv_debug_fullfile = os.path.join(nv_tempdir, nv_debug_file)
+ nv_debug_cmd = [nv_debug_command, "--output-file", nv_debug_fullfile]
+ try:
+ subprocess.run(
+ nv_debug_cmd,
+ env=env,
+ check=False,
+ stdout=subprocess.DEVNULL,
+ stderr=subprocess.DEVNULL,
+ )
+ nv_debug_fullfile_gz = nv_debug_fullfile + ".gz"
+ hookutils.attach_file_if_exists(
+ report, nv_debug_fullfile_gz, "nvidia-bug-report.gz"
+ )
+ os.unlink(nv_debug_fullfile_gz)
+ os.rmdir(nv_tempdir)
+ except OSError as e:
+ print("Error:", str(e))
+ print("Fail on cleanup", nv_tempdir, ". Please file a bug for it.")
+
+
+def dot():
+ print(".", end="", flush=True)
+
+
+def build_packages():
+ # related packages
+ packages = ["apt", "grub2"]
+
+ # display
+ packages.append("xorg")
+ packages.append("gnome-shell")
+
+ # audio
+ packages.append("alsa-base")
+
+ # hotkey and hotplugs
+ packages.append("udev")
+
+ # networking issues
+ packages.append("network-manager")
+
+ return packages
+
+
+def helper_url_credential_filter(string_with_urls):
+ return re.sub(r"://\w+?:\w+?@", "://USER:SECRET@", string_with_urls)
+
+
+def add_info(report):
+ # Check if the DCD file is exist in the installer.
+ attach_command_output(report, ["ubuntu-report", "show"], "UbuntuReport")
+ dot()
+ hookutils.attach_file_if_exists(report, "/etc/buildstamp", "BuildStamp")
+ dot()
+ attach_pathglob_as_zip(
+ report,
+ ["/sys/firmware/acpi/tables/*", "/sys/firmware/acpi/tables/*/*"],
+ "acpitables",
+ )
+ dot()
+
+ # Basic hardare information
+ hookutils.attach_hardware(report)
+ dot()
+ hookutils.attach_wifi(report)
+ dot()
+
+ hwe_system_commands = {
+ "lspci--xxxx": ["lspci", "-xxxx"],
+ "lshw.json": ["lshw", "-json", "-numeric"],
+ "dmidecode": ["dmidecode"],
+ "fwupdmgr_get-devices": [
+ "fwupdmgr",
+ "get-devices",
+ "--show-all-devices",
+ "--no-unreported-check",
+ ],
+ "boltctl-list": ["boltctl", "list"],
+ "mokutil---sb-state": ["mokutil", "--sb-state"],
+ "tlp-stat": ["tlp-stat"],
+ }
+ for name, command_list in hwe_system_commands.items():
+ attach_command_output(report, command_list, name)
+ dot()
+
+ # More audio related
+ hookutils.attach_alsa(report)
+ dot()
+ audio_system_commands = {
+ "pactl-list": ["pactl", "list"],
+ "aplay-l": ["aplay", "-l"],
+ "aplay-L": ["aplay", "-L"],
+ "arecord-l": ["arecord", "-l"],
+ "arecord-L": ["arecord", "-L"],
+ }
+ for name, command_list in audio_system_commands.items():
+ attach_command_output(report, command_list, name)
+ dot()
+ attach_pathglob_as_zip(
+ report,
+ [
+ "/usr/share/alsa/ucm/*/*",
+ "/usr/share/alsa/ucm2/*",
+ "/usr/share/alsa/ucm2/*/*",
+ "/usr/share/alsa/ucm2/*/*/*",
+ ],
+ "ALSA-UCM",
+ )
+ dot()
+
+ # FIXME: should be included in xorg in the future
+ gfx_system_commands = {
+ "glxinfo": ["glxinfo"],
+ "xrandr": ["xrandr"],
+ "xinput": ["xinput"],
+ }
+ for name, command_list in gfx_system_commands.items():
+ attach_command_output(report, command_list, name)
+ dot()
+ attach_pathglob_as_zip(report, ["/sys/devices/*/*/drm/card?/*/edid"], "EDID")
+ dot()
+
+ # nvidia-bug-reports.sh
+ attach_nvidia_debug_logs(report)
+ dot()
+
+ # FIXME: should be included in thermald in the future
+ attach_pathglob_as_zip(
+ report,
+ ["/etc/thermald/*", "/sys/devices/virtual/thermal/*", "/sys/class/thermal/*"],
+ "THERMALD",
+ )
+ dot()
+
+ # all kernel and system messages
+ attach_pathglob_as_zip(report, ["/var/log/*", "/var/log/*/*"], "VAR_LOG")
+ dot()
+
+ # apt configs
+ attach_pathglob_as_zip(
+ report,
+ [
+ "/etc/apt/apt.conf.d/*",
+ "/etc/apt/sources.list",
+ "/etc/apt/sources.list.d/*.list",
+ "/etc/apt/preferences.d/*",
+ ],
+ "APT_CONFIGS",
+ mode="a",
+ data_filter=helper_url_credential_filter,
+ )
+ dot()
+
+ # TODO: debug information for suspend or hibernate
+
+ # packages installed.
+ attach_command_output(report, ["dpkg", "-l"], "dpkg-l")
+ dot()
+
+ # FIXME: should be included in bluez in the future
+ attach_command_output(report, ["hciconfig", "-a"], "hciconfig-a")
+ dot()
+
+ # FIXME: should be included in dkms in the future
+ attach_command_output(report, ["dkms", "status"], "dkms_status")
+ dot()
+
+ # enable when the feature to include data from package hooks exists.
+ # packages = build_packages()
+ # attach_related_packages(report, packages)
+
+
+def main():
+ parser = ArgumentParser(
+ prog="oem-getlogs",
+ usage="Useage: sudo -E oem-getlogs [-c CASE_ID]",
+ description=__doc__,
+ )
+ parser.add_argument(
+ "-c", "--case-id", help="optional CASE_ID", dest="cid", default=""
+ )
+ args = parser.parse_args()
+
+ # check if we got root permission
+ if os.geteuid() != 0:
+ print("Error: you need to run this program as root")
+ parser.print_help()
+ sys.exit(1)
+
+ print("Start to collect logs: ", end="", flush=True)
+ # create report
+ report = apport.Report()
+ add_info(report)
+
+ # generate filename
+ hostname = os.uname()[1]
+ date_time = time.strftime("%Y%m%d%H%M%S%z", time.localtime())
+ filename_lst = ["oemlogs", hostname]
+ if len(args.cid) > 0:
+ filename_lst.append(args.cid)
+ filename_lst.append(date_time + ".apport.gz")
+ filename = "-".join(filename_lst)
+
+ with gzip.open(filename, "wb") as f:
+ report.write(f)
+ print("\nSaved log to", filename)
+ print("The owner of the file is root. You might want to")
+ print(" chown [user]:[group]", filename)
+
+
+if __name__ == "__main__":
+ main()

944
debian/patches/Add-general-hooks.patch vendored
View File

@ -1,944 +0,0 @@
From: Benjamin Drung <benjamin.drung@canonical.com>
Date: Sat, 13 Apr 2024 00:43:11 +0200
Subject: Add general hooks
Forwarded: not-needed
---
apport/hookutils.py | 17 +
data/general-hooks/cloud_archive.py | 42 +++
data/general-hooks/powerpc.py | 122 +++++++
data/general-hooks/ubuntu-gnome.py | 69 ++++
data/general-hooks/ubuntu.py | 635 ++++++++++++++++++++++++++++++++++++
5 files changed, 885 insertions(+)
create mode 100644 data/general-hooks/cloud_archive.py
create mode 100644 data/general-hooks/powerpc.py
create mode 100644 data/general-hooks/ubuntu-gnome.py
create mode 100644 data/general-hooks/ubuntu.py
diff --git a/apport/hookutils.py b/apport/hookutils.py
index 76f7740..dc5a33b 100644
--- a/apport/hookutils.py
+++ b/apport/hookutils.py
@@ -19,6 +19,7 @@
import base64
import datetime
import glob
+import json
import os
import re
import select
@@ -1085,6 +1086,22 @@ def attach_default_grub(report, key=None):
report[key] = "".join(filtered)
+def attach_casper_md5check(report, location):
+ """Attach the results of the casper md5check of install media."""
+ result = "unknown"
+ mismatches = []
+ if os.path.exists(location):
+ attach_root_command_outputs(report, {"CasperMD5json": f"cat '{location}'"})
+ if "CasperMD5json" in report:
+ check = json.loads(report["CasperMD5json"])
+ result = check["result"]
+ mismatches = check["checksum_missmatch"]
+ report["CasperMD5CheckResult"] = result
+ if mismatches:
+ report["CasperMD5CheckMismatches"] = " ".join(mismatches)
+ report.pop("CasperMD5json", None)
+
+
# backwards compatible API
shared_libraries = apport.fileutils.shared_libraries
links_with_shared_library = apport.fileutils.links_with_shared_library
diff --git a/data/general-hooks/cloud_archive.py b/data/general-hooks/cloud_archive.py
new file mode 100644
index 0000000..85e76a8
--- /dev/null
+++ b/data/general-hooks/cloud_archive.py
@@ -0,0 +1,42 @@
+"""Redirect reports on packages from the Ubuntu Cloud Archive to the
+launchpad cloud-archive project.
+
+Copyright (C) 2013 Canonical Ltd.
+Author: James Page <james.page@ubuntu.com>
+
+This program is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2 of the License, or (at your
+option) any later version. See http://www.gnu.org/copyleft/gpl.html for
+the full text of the license.
+"""
+
+from apport import packaging
+
+
+def add_info(report, unused_ui):
+ """Redirect reports on packages from the Ubuntu Cloud Archive to the
+ launchpad cloud-archive project."""
+ package = report.get("Package")
+ if not package:
+ return
+ package = package.split()[0]
+ try:
+ if (
+ "~cloud" in packaging.get_version(package)
+ and packaging.get_package_origin(package) == "Canonical"
+ ):
+ report[
+ "CrashDB"
+ ] = """\
+{
+ "impl": "launchpad",
+ "project": "cloud-archive",
+ "bug_pattern_url": "http://people.canonical.com/"
+ "~ubuntu-archive/bugpatterns/bugpatterns.xml",
+}
+"""
+ except ValueError as error:
+ if "does not exist" in str(error):
+ return
+ raise error
diff --git a/data/general-hooks/powerpc.py b/data/general-hooks/powerpc.py
new file mode 100644
index 0000000..031b4d6
--- /dev/null
+++ b/data/general-hooks/powerpc.py
@@ -0,0 +1,122 @@
+# This hook collects logs for Power systems and more specific logs for Pseries,
+# PowerNV platforms.
+#
+# Author: Thierry FAUCK <thierry@linux.vnet.ibm.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+"""IBM Power System related information"""
+
+import os
+import pathlib
+import platform
+import subprocess
+import tempfile
+
+from apport.hookutils import (
+ attach_file,
+ attach_file_if_exists,
+ attach_root_command_outputs,
+ command_available,
+ command_output,
+)
+
+
+def _add_tar(report, path, key):
+ (tar_fd, tar_file) = tempfile.mkstemp(prefix="apport.", suffix=".tar")
+ os.close(tar_fd)
+ subprocess.call(["tar", "chf", tar_file, path])
+ if os.path.getsize(tar_file) > 0:
+ report[key] = (tar_file,)
+ # NB, don't cleanup the temp file, it'll get read later by the apport main
+ # code
+
+
+# TODO: Split into smaller functions/methods
+# pylint: disable-next=too-many-branches,too-many-statements
+def add_info(report, unused_ui):
+ """Add IBM Power System related information to report."""
+ arch = platform.machine()
+ if arch not in ["ppc64", "ppc64le"]:
+ return
+
+ is_kernel = report["ProblemType"].startswith("Kernel") or "linux" in report.get(
+ "Package", ""
+ )
+
+ try:
+ contents = pathlib.Path("/proc/cpuinfo").read_text("utf-8")
+ is_pseries = "pSeries" in contents
+ is_power_nv = "PowerNV" in contents
+ is_power_kvm = "emulated by qemu" in contents
+ except IOError:
+ is_pseries = False
+ is_power_nv = False
+ is_power_kvm = False
+
+ if is_pseries or is_power_nv:
+ if is_kernel:
+ _add_tar(report, "/proc/device-tree/", "DeviceTree.tar")
+ attach_file(report, "/proc/misc", "ProcMisc")
+ attach_file(report, "/proc/locks", "ProcLocks")
+ attach_file(report, "/proc/loadavg", "ProcLoadAvg")
+ attach_file(report, "/proc/swaps", "ProcSwaps")
+ attach_file(report, "/proc/version", "ProcVersion")
+ report["cpu_smt"] = command_output(["ppc64_cpu", "--smt"])
+ report["cpu_cores"] = command_output(["ppc64_cpu", "--cores-present"])
+ report["cpu_coreson"] = command_output(["ppc64_cpu", "--cores-on"])
+ # To be executed as root
+ if is_kernel:
+ attach_root_command_outputs(
+ report,
+ {
+ "cpu_runmode": "ppc64_cpu --run-mode",
+ "cpu_freq": "ppc64_cpu --frequency",
+ "cpu_dscr": "ppc64_cpu --dscr",
+ "nvram": "cat /dev/nvram",
+ },
+ )
+ attach_file_if_exists(report, "/var/log/platform")
+
+ if is_pseries and not is_power_kvm:
+ attach_file(report, "/proc/ppc64/lparcfg", "ProcLparCfg")
+ attach_file(report, "/proc/ppc64/eeh", "ProcEeh")
+ attach_file(report, "/proc/ppc64/systemcfg", "ProcSystemCfg")
+ report["lscfg_vp"] = command_output(["lscfg", "-vp"])
+ report["lsmcode"] = command_output(["lsmcode", "-A"])
+ report["bootlist"] = command_output(["bootlist", "-m", "both", "-r"])
+ report["lparstat"] = command_output(["lparstat", "-i"])
+ if command_available("lsvpd"):
+ report["lsvpd"] = command_output(["lsvpd", "--debug"])
+ if command_available("lsvio"):
+ report["lsvio"] = command_output(["lsvio", "-des"])
+ if command_available("servicelog"):
+ report["servicelog_dump"] = command_output(["servicelog", "--dump"])
+ if command_available("servicelog_notify"):
+ report["servicelog_list"] = command_output(["servicelog_notify", "--list"])
+ if command_available("usysattn"):
+ report["usysattn"] = command_output(["usysattn"])
+ if command_available("usysident"):
+ report["usysident"] = command_output(["usysident"])
+ if command_available("serv_config"):
+ report["serv_config"] = command_output(["serv_config", "-l"])
+
+ if is_power_nv:
+ _add_tar(report, "/proc/ppc64/", "ProcPpc64.tar")
+ attach_file_if_exists(report, "/sys/firmware/opal/msglog")
+ if os.path.exists("/var/log/dump"):
+ report["VarLogDump_list"] = command_output(["ls", "-l", "/var/log/dump"])
+ if is_kernel:
+ _add_tar(report, "/var/log/opal-elog", "OpalElog.tar")
diff --git a/data/general-hooks/ubuntu-gnome.py b/data/general-hooks/ubuntu-gnome.py
new file mode 100644
index 0000000..f088500
--- /dev/null
+++ b/data/general-hooks/ubuntu-gnome.py
@@ -0,0 +1,69 @@
+"""Bugs and crashes for the Ubuntu GNOME flavour.
+
+Copyright (C) 2013 Canonical Ltd.
+Author: Martin Pitt <martin.pitt@ubuntu.com>
+
+This program is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2 of the License, or (at your
+option) any later version. See http://www.gnu.org/copyleft/gpl.html for
+the full text of the license.
+"""
+
+# pylint: disable=invalid-name
+# pylint: enable=invalid-name
+
+
+def add_info(report, unused_ui):
+ """Handle bugs and crashes for the Ubuntu GNOME flavour."""
+ release = report.get("DistroRelease", "")
+
+ msg = (
+ "The GNOME3 PPA you are using is no longer supported"
+ " for this Ubuntu release. Please "
+ )
+ # redirect reports against PPA packages to ubuntu-gnome project
+ if "[origin: LP-PPA-gnome3-team-gnome3" in report.get("Package", ""):
+ report[
+ "CrashDB"
+ ] = """\
+{
+ "impl": "launchpad",
+ "project": "ubuntu-gnome",
+ "bug_pattern_url": "http://people.canonical.com/"
+ "~ubuntu-archive/bugpatterns/bugpatterns.xml",
+ "dupdb_url": "http://phillw.net/ubuntu-gnome/apport_duplicates/",
+}
+"""
+
+ # using the staging PPA?
+ if "LP-PPA-gnome3-team-gnome3-staging" in report.get("Package", ""):
+ report.setdefault("Tags", "")
+ report["Tags"] += " gnome3-staging"
+ if release in {"Ubuntu 14.04", "Ubuntu 16.04"}:
+ report["UnreportableReason"] = (
+ f'{msg} run "ppa-purge ppa:gnome3-team/gnome3-staging".'
+ )
+
+ # using the next PPA?
+ elif "LP-PPA-gnome3-team-gnome3-next" in report.get("Package", ""):
+ report.setdefault("Tags", "")
+ report["Tags"] += " gnome3-next"
+ if release in {"Ubuntu 14.04", "Ubuntu 16.04"}:
+ report["UnreportableReason"] = (
+ f'{msg} run "ppa-purge ppa:gnome3-team/gnome3-next".'
+ )
+
+ elif release in {"Ubuntu 14.04", "Ubuntu 16.04"}:
+ report["UnreportableReason"] = (
+ f'{msg} run "ppa-purge ppa:gnome3-team/gnome3".'
+ )
+
+ if "[origin: LP-PPA-gnome3-team-gnome3" in report.get("Dependencies", ""):
+ report.setdefault("Tags", "")
+ report["Tags"] += " gnome3-ppa"
+ if (
+ release in {"Ubuntu 14.04", "Ubuntu 16.04"}
+ and "UnreportableReason" not in report
+ ):
+ report["UnreportableReason"] = f"{msg} use ppa-purge to remove the PPA."
diff --git a/data/general-hooks/ubuntu.py b/data/general-hooks/ubuntu.py
new file mode 100644
index 0000000..ea85631
--- /dev/null
+++ b/data/general-hooks/ubuntu.py
@@ -0,0 +1,635 @@
+"""Attach generally useful information, not specific to any package.
+
+Copyright (C) 2009 Canonical Ltd.
+Authors: Matt Zimmerman <mdz@canonical.com>,
+ Brian Murray <brian@ubuntu.com>
+
+This program is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2 of the License, or (at your
+option) any later version. See http://www.gnu.org/copyleft/gpl.html for
+the full text of the license.
+"""
+
+import os
+import pathlib
+import platform
+import re
+import subprocess
+import sys
+import time
+from gettext import gettext as _
+from glob import glob
+
+import apport.hookutils
+import apport.packaging
+import problem_report
+
+
+def add_info(report, ui):
+ # TODO: Split into smaller functions/methods
+ # pylint: disable=invalid-name,too-many-branches,too-many-locals,too-many-statements
+ # pylint: disable=too-many-nested-blocks
+ """Attach generally useful information, not specific to any package."""
+ _add_release_info(report)
+ _add_kernel_info(report)
+ add_proposed_info(report)
+
+ # collect a condensed version of /proc/cpuinfo
+ apport.hookutils.attach_file(report, "/proc/cpuinfo", "ProcCpuinfo")
+ short_cpuinfo = []
+ for item in reversed(report.get("ProcCpuinfo", "").split("\n")):
+ short_cpuinfo.append(item)
+ if item.startswith("processor\t:"):
+ break
+ short_cpuinfo = reversed(short_cpuinfo)
+ report["ProcCpuinfoMinimal"] = "\n".join(short_cpuinfo)
+ report.pop("ProcCpuinfo")
+
+ hook_errors = [k for k in report.keys() if k.startswith("HookError_")]
+ if hook_errors:
+ report.add_tags(["apport-hook-error"])
+
+ # locally installed python versions can cause a multitude of errors
+ if (
+ report.get("ProblemType") == "Package"
+ or "python" in report.get("InterpreterPath", "")
+ or "python" in report.get("ExecutablePath", "")
+ ):
+ for python in ("python", "python3"):
+ add_python_details(f"{python.title()}Details", python, report)
+
+ try:
+ report["ApportVersion"] = apport.packaging.get_version("apport")
+ except ValueError:
+ # might happen on local installs
+ pass
+
+ # We want to know if people have modified apport's crashdb.conf in case
+ # crashes are reported to Launchpad when they shouldn't be e.g. for a
+ # non-development release.
+ apport.hookutils.attach_conffiles(report, "apport", ui=ui)
+
+ # Should the system have been rebooted?
+ apport.hookutils.attach_file_if_exists(
+ report, "/var/run/reboot-required.pkgs", "RebootRequiredPkgs"
+ )
+
+ casper_md5check = "casper-md5check.json"
+ if "LiveMediaBuild" in report:
+ apport.hookutils.attach_casper_md5check(report, f"/run/{casper_md5check}")
+ else:
+ apport.hookutils.attach_casper_md5check(
+ report, f"/var/log/installer/{casper_md5check}"
+ )
+
+ if report.get("ProblemType") == "Package":
+ # every error report regarding a package should have package manager
+ # version information
+ apport.hookutils.attach_related_packages(report, ["dpkg", "apt"])
+ _check_for_disk_error(report)
+ # check to see if the real root on a persistent media is full
+ if "LiveMediaBuild" in report:
+ st = os.statvfs("/cdrom")
+ free_mb = st.f_bavail * st.f_frsize / 1000000
+ if free_mb < 10:
+ report["UnreportableReason"] = (
+ f"Your system partition has less than {free_mb} MB"
+ f" of free space available, which leads to problems"
+ f" using applications and installing updates."
+ f" Please free some space."
+ )
+
+ _match_error_messages(report)
+
+ # these attachments will not exist if ProblemType is Bug as the package
+ # hook runs after the general hook
+ for attachment in ("DpkgTerminalLog", "VarLogDistupgradeApttermlog"):
+ if attachment in report:
+ log_file = _get_attachment_contents(report, attachment)
+ untrimmed_dpkg_log = log_file
+ _check_attachment_for_errors(report, attachment)
+ trimmed_log = _get_attachment_contents(report, attachment)
+ trimmed_log = trimmed_log.split("\n")
+ lines = []
+ for line in untrimmed_dpkg_log.splitlines():
+ if line not in trimmed_log:
+ lines.append(str(line))
+ elif line in trimmed_log:
+ trimmed_log.remove(line)
+ dpkg_log_without_error = "\n".join(lines)
+
+ # crash reports from live system installer often expose target mount
+ for f in ("ExecutablePath", "InterpreterPath"):
+ if f in report and report[f].startswith("/target/"):
+ report[f] = report[f][7:]
+
+ # Allow filing update-manager bugs with obsolete packages
+ if report.get("Package", "").startswith("update-manager"):
+ os.environ["APPORT_IGNORE_OBSOLETE_PACKAGES"] = "1"
+
+ # file bugs against OEM project for modified packages
+ if "Package" in report:
+ v = report["Package"].split()[1]
+ oem_project = get_oem_project(report)
+ if oem_project and ("common" in v or oem_project in v):
+ report["CrashDB"] = "canonical-oem"
+
+ if "Package" in report:
+ package = report["Package"].split()[0]
+ if package:
+ apport.hookutils.attach_conffiles(report, package, ui=ui)
+
+ # do not file bugs against "upgrade-system" if it is not installed
+ # (LP#404727)
+ if package == "upgrade-system" and "not installed" in report["Package"]:
+ report["UnreportableReason"] = (
+ "You do not have the upgrade-system package installed."
+ " Please report package upgrade failures against the package"
+ " that failed to install, or against upgrade-manager."
+ )
+
+ # build a duplicate signature tag for package reports
+ if report.get("ProblemType") == "Package":
+ if "DpkgTerminalLog" in report:
+ # this was previously trimmed in check_attachment_for_errors
+ termlog = report["DpkgTerminalLog"]
+ elif "VarLogDistupgradeApttermlog" in report:
+ termlog = _get_attachment_contents(report, "VarLogDistupgradeApttermlog")
+ else:
+ termlog = None
+ if termlog:
+ (package, version) = report["Package"].split(None, 1)
+ # for packages that run update-grub include /etc/default/grub
+ UPDATE_BOOT = [
+ "friendly-recovery",
+ "linux",
+ "memtest86+",
+ "plymouth",
+ "ubuntu-meta",
+ "virtualbox-ose",
+ ]
+ ug_failure = (
+ r"/etc/kernel/post(inst|rm)\.d/"
+ r"zz-update-grub exited with return code [1-9]+"
+ )
+ mkconfig_failure = (
+ r"/usr/sbin/grub-mkconfig.*/etc/default/grub: Syntax error"
+ )
+ if re.search(ug_failure, termlog) or re.search(mkconfig_failure, termlog):
+ if report["SourcePackage"] in UPDATE_BOOT:
+ apport.hookutils.attach_default_grub(report, "EtcDefaultGrub")
+ dupe_sig = ""
+ dupe_sig_created = False
+ # messages we expect to see from a package manager (LP: #1692127)
+ pkg_mngr_msgs = re.compile(
+ r"^(Authenticating|De-configuring|Examining|Installing"
+ r"|Preparing|Processing triggers|Purging|Removing|Replaced"
+ r"|Replacing|Setting up|Unpacking|Would remove).*\.\.\.\s*$"
+ )
+ for line in termlog.split("\n"):
+ if pkg_mngr_msgs.search(line):
+ dupe_sig = f"{line}\n"
+ dupe_sig_created = True
+ continue
+ dupe_sig += f"{line}\n"
+ # this doesn't catch 'dpkg-divert: error' LP: #1581399
+ if "dpkg: error" in dupe_sig and line.startswith(" "):
+ if "trying to overwrite" in line:
+ conflict_pkg = re.search("in package (.*) ", line)
+ if conflict_pkg and not apport.packaging.is_distro_package(
+ conflict_pkg.group(1)
+ ):
+ report["UnreportableReason"] = _(
+ "An Ubuntu package has a file conflict with a "
+ "package that is not a genuine Ubuntu package."
+ )
+ report.add_tags(["package-conflict"])
+ if dupe_sig_created:
+ # the duplicate signature should be the first failure
+ report["DuplicateSignature"] = (
+ f"package:{package}:{version}\n{dupe_sig}"
+ )
+ break
+ if dupe_sig:
+ if dpkg_log_without_error.find(dupe_sig) != -1:
+ report["UnreportableReason"] = _(
+ "You have already encountered this package"
+ " installation failure."
+ )
+
+
+def _match_error_messages(report):
+ # There are enough of these now that it is probably worth refactoring...
+ # -mdz
+ if report.get("ProblemType") == "Package":
+ if "failed to install/upgrade: corrupted filesystem tarfile" in report.get(
+ "Title", ""
+ ):
+ report["UnreportableReason"] = (
+ "This failure was caused by a corrupted package download"
+ " or file system corruption."
+ )
+
+ if "is already installed and configured" in report.get("ErrorMessage", ""):
+ report["SourcePackage"] = "dpkg"
+
+
+def _check_attachment_for_errors(report, attachment):
+ # TODO: Split into smaller functions/methods
+ # pylint: disable=too-many-branches,too-many-statements,too-many-nested-blocks
+ if report.get("ProblemType") == "Package":
+ wrong_grub_msg = _(
+ """\
+Your system was initially configured with grub version 2, but you have\
+ removed it from your system in favor of grub 1 without configuring it.\
+ To ensure your bootloader configuration is updated whenever a new kernel\
+ is available, open a terminal and run:
+
+ sudo apt-get install grub-pc
+"""
+ )
+
+ trim_dpkg_log(report)
+ log_file = _get_attachment_contents(report, attachment)
+
+ grub_hook_failure = "DpkgTerminalLog" in report and bool(
+ re.search(
+ r"^Not creating /boot/grub/menu.lst as you wish",
+ report["DpkgTerminalLog"],
+ re.MULTILINE,
+ )
+ )
+
+ if report["Package"] not in ["grub", "grub2"]:
+ # linux-image postinst emits this when update-grub fails
+ # https://wiki.ubuntu.com/KernelTeam/DebuggingUpdateErrors
+ grub_errors = [
+ r"^User postinst hook script \[.*update-grub\] exited with value",
+ r"^run-parts: /etc/kernel/post(inst|rm).d"
+ r"/zz-update-grub exited with return code [1-9]+",
+ r"^/usr/sbin/grub-probe: error",
+ ]
+
+ for grub_error in grub_errors:
+ if attachment in report and re.search(
+ grub_error, log_file, re.MULTILINE
+ ):
+ # File these reports on the grub package instead
+ grub_package = apport.packaging.get_file_package(
+ "/usr/sbin/update-grub"
+ )
+ if (
+ grub_package is None
+ or grub_package == "grub"
+ and "grub-probe" not in log_file
+ ):
+ report["SourcePackage"] = "grub"
+ if os.path.exists("/boot/grub/grub.cfg") and grub_hook_failure:
+ report["UnreportableReason"] = wrong_grub_msg
+ else:
+ report["SourcePackage"] = "grub2"
+
+ if report["Package"] != "initramfs-tools":
+ # update-initramfs emits this when it fails, usually invoked
+ # from the linux-image postinst
+ # https://wiki.ubuntu.com/KernelTeam/DebuggingUpdateErrors
+ if attachment in report and re.search(
+ r"^update-initramfs: failed for ", log_file, re.MULTILINE
+ ):
+ # File these reports on the initramfs-tools package instead
+ report["SourcePackage"] = "initramfs-tools"
+
+ if report["Package"].startswith("linux-image-") and attachment in report:
+ # /etc/kernel/*.d failures from kernel package postinst
+ match = re.search(
+ r"^run-parts: (/etc/kernel/\S+\.d/\S+) exited with return code \d+",
+ log_file,
+ re.MULTILINE,
+ )
+ if match:
+ path = match.group(1)
+ package = apport.packaging.get_file_package(path)
+ if package:
+ report["SourcePackage"] = package
+ report["ErrorMessage"] = match.group(0)
+ if package == "grub-pc" and grub_hook_failure:
+ report["UnreportableReason"] = wrong_grub_msg
+ else:
+ report["UnreportableReason"] = (
+ "This failure was caused by a program"
+ " which did not originate from Ubuntu"
+ )
+
+ error_message = report.get("ErrorMessage")
+ corrupt_package = (
+ "This failure was caused by a corrupted package download"
+ " or file system corruption."
+ )
+ out_of_memory = "This failure was caused by the system running out of memory."
+
+ if "failed to install/upgrade: corrupted filesystem tarfile" in report.get(
+ "Title", ""
+ ):
+ report["UnreportableReason"] = corrupt_package
+
+ if "dependency problems - leaving unconfigured" in error_message:
+ report["UnreportableReason"] = (
+ "This failure is a followup error from a previous"
+ " package install failure."
+ )
+
+ if "failed to allocate memory" in error_message:
+ report["UnreportableReason"] = out_of_memory
+
+ if "cannot access archive" in error_message:
+ report["UnreportableReason"] = corrupt_package
+
+ if re.search(
+ r"(failed to read|failed in write|short read) on buffer copy", error_message
+ ):
+ report["UnreportableReason"] = corrupt_package
+
+ if re.search(
+ r"(failed to read|failed to write|failed to seek"
+ r"|unexpected end of file or stream)",
+ error_message,
+ ):
+ report["UnreportableReason"] = corrupt_package
+
+ if re.search(
+ r"(--fsys-tarfile|dpkg-deb --control) returned error exit status 2",
+ error_message,
+ ):
+ report["UnreportableReason"] = corrupt_package
+
+ if attachment in report and re.search(
+ r"dpkg-deb: error.*is not a debian format archive", log_file, re.MULTILINE
+ ):
+ report["UnreportableReason"] = corrupt_package
+
+ if "is already installed and configured" in report.get("ErrorMessage", ""):
+ # there is insufficient information in the data currently gathered
+ # so gather more data
+ report["SourcePackage"] = "dpkg"
+ report["AptdaemonVersion"] = apport.packaging.get_version("aptdaemon")
+ apport.hookutils.attach_file_if_exists(
+ report, "/var/log/dpkg.log", "DpkgLog"
+ )
+ apport.hookutils.attach_file_if_exists(
+ report, "/var/log/apt/term.log", "AptTermLog"
+ )
+ # gather filenames in /var/crash to see if there is one for dpkg
+ reports = glob("/var/crash/*")
+ if reports:
+ report["CrashReports"] = apport.hookutils.command_output(
+ ["stat", "-c", "%a:%u:%g:%s:%y:%x:%n"] + reports
+ )
+ report.add_tags(["already-installed"])
+
+
+def _check_for_disk_error(report):
+ devs_to_check = []
+ if "Dmesg.txt" not in report and "CurrentDmesg.txt" not in report:
+ return
+ if "Df.txt" not in report:
+ return
+ df_output = report["Df.txt"]
+ device_error = False
+ for line in df_output:
+ line = line.strip("\n")
+ if line.endswith("/") or line.endswith("/usr") or line.endswith("/var"):
+ # without manipulation it'd look like /dev/sda1
+ device = line.split(" ")[0].strip("0123456789")
+ device = device.replace("/dev/", "")
+ devs_to_check.append(device)
+ dmesg = report.get("CurrentDmesg.txt", report["Dmesg.txt"])
+ for line in dmesg:
+ line = line.strip("\n")
+ if "I/O error" in line:
+ # no device in this line
+ if "journal commit I/O error" in line:
+ continue
+ for dev in devs_to_check:
+ if re.search(dev, line):
+ error_device = dev
+ device_error = True
+ break
+ if device_error:
+ report["UnreportableReason"] = (
+ f"This failure was caused by a hardware error on /dev/{error_device}"
+ )
+
+
+def _add_kernel_info(report):
+ # This includes the Ubuntu packaged kernel version
+ apport.hookutils.attach_file_if_exists(
+ report, "/proc/version_signature", "ProcVersionSignature"
+ )
+
+
+def _add_release_info(report):
+ # https://bugs.launchpad.net/bugs/364649
+ media = "/var/log/installer/media-info"
+ apport.hookutils.attach_file_if_exists(report, media, "InstallationMedia")
+ # Preinstalled Raspberry Pi images include a build date breadcrumb
+ apport.hookutils.attach_file_if_exists(report, "/.disk/info", "ImageMediaBuild")
+ if "ImageMediaBuild" in report:
+ report.add_tags([f"{report['Architecture']}-image"])
+ try:
+ compatible = pathlib.Path("/proc/device-tree/compatible").read_bytes()
+ is_a_pi = any(
+ vendor == "raspberrypi"
+ for s in compatible.split(b"\0")
+ if s
+ for vendor, model in (s.decode("ascii").split(",", 1),)
+ )
+ except FileNotFoundError:
+ is_a_pi = False
+ if is_a_pi:
+ report.add_tags(["raspi-image"])
+
+ # if we are running from a live system, add the build timestamp
+ apport.hookutils.attach_file_if_exists(
+ report, "/cdrom/.disk/info", "LiveMediaBuild"
+ )
+ if os.path.exists("/cdrom/.disk/info"):
+ report["CasperVersion"] = apport.packaging.get_version("casper")
+
+ # https://wiki.ubuntu.com/FoundationsTeam/Specs/OemTrackingId
+ apport.hookutils.attach_file_if_exists(
+ report, "/var/lib/ubuntu_dist_channel", "DistributionChannelDescriptor"
+ )
+
+ os_release = platform.freedesktop_os_release()
+ release_codename = os_release.get("VERSION_CODENAME")
+ if release_codename:
+ report.add_tags([release_codename])
+
+ if os.path.exists(media):
+ mtime = os.stat(media).st_mtime
+ human_mtime = time.strftime("%Y-%m-%d", time.gmtime(mtime))
+ delta = time.time() - mtime
+ report["InstallationDate"] = (
+ f"Installed on {human_mtime} ({round(delta / 86400)} days ago)"
+ )
+
+ log = "/var/log/dist-upgrade/main.log"
+ if os.path.exists(log):
+ mtime = os.stat(log).st_mtime
+ human_mtime = time.strftime("%Y-%m-%d", time.gmtime(mtime))
+ delta = time.time() - mtime
+
+ # Would be nice if this also showed which release was originally
+ # installed
+ report["UpgradeStatus"] = (
+ f"Upgraded to {release_codename} on {human_mtime}"
+ f" ({round(delta / 86400)} days ago)"
+ )
+ else:
+ report["UpgradeStatus"] = "No upgrade log present (probably fresh install)"
+
+
+def add_proposed_info(report):
+ """Tag if package comes from -proposed."""
+ if "Package" not in report:
+ return
+ try:
+ (package, version) = report["Package"].split()[:2]
+ except ValueError:
+ print("WARNING: malformed Package field: " + report["Package"])
+ return
+
+ apt_cache = subprocess.run(
+ ["apt-cache", "showpkg", package],
+ check=False,
+ stdout=subprocess.PIPE,
+ text=True,
+ )
+ if apt_cache.returncode != 0:
+ print(f"WARNING: apt-cache showpkg {package} failed")
+ return
+
+ found_proposed = False
+ found_updates = False
+ found_security = False
+ for line in apt_cache.stdout.splitlines():
+ if line.startswith(version + " ("):
+ if "-proposed_" in line:
+ found_proposed = True
+ if "-updates_" in line:
+ found_updates = True
+ if "-security" in line:
+ found_security = True
+
+ if found_proposed and not found_updates and not found_security:
+ report.add_tags(["package-from-proposed"])
+
+
+def get_oem_project(report):
+ """Determine OEM project name from Distribution Channel Descriptor.
+
+ Return None if it cannot be determined or does not exist.
+ """
+ dcd = report.get("DistributionChannelDescriptor", None)
+ if dcd and dcd.startswith("canonical-oem-"):
+ return dcd.split("-")[2]
+ return None
+
+
+def trim_dpkg_log(report):
+ """Trim DpkgTerminalLog to the most recent installation session."""
+ if "DpkgTerminalLog" not in report:
+ return
+ if not report["DpkgTerminalLog"].strip():
+ report["UnreportableReason"] = "/var/log/apt/term.log does not contain any data"
+ return
+ lines = []
+ dpkg_log = report["DpkgTerminalLog"]
+ if isinstance(dpkg_log, bytes):
+ trim_re = re.compile(b"^\\(.* ... \\d+ .*\\)$")
+ start_re = re.compile(b"^Log started:")
+ else:
+ trim_re = re.compile("^\\(.* ... \\d+ .*\\)$")
+ start_re = re.compile("^Log started:")
+ for line in dpkg_log.splitlines():
+ if start_re.match(line) or trim_re.match(line):
+ lines = []
+ continue
+ lines.append(line)
+ # If trimming the log file fails, return the whole log file.
+ if not lines:
+ return
+ if isinstance(lines[0], str):
+ report["DpkgTerminalLog"] = "\n".join(lines)
+ else:
+ report["DpkgTerminalLog"] = "\n".join(
+ [str(line.decode("UTF-8", "replace")) for line in lines]
+ )
+
+
+def _get_attachment_contents(report, attachment):
+ if isinstance(report[attachment], problem_report.CompressedValue):
+ contents = report[attachment].get_value().decode("UTF-8")
+ else:
+ contents = report[attachment]
+ return contents
+
+
+def add_python_details(key, python, report):
+ """Add comma separated details about which python is being used"""
+ python_path = apport.hookutils.command_output(["which", python])
+ if python_path.startswith("Error: "):
+ report[key] = "N/A"
+ return
+ python_link = apport.hookutils.command_output(["readlink", "-f", python_path])
+ python_pkg = apport.fileutils.find_file_package(python_path)
+ if python_pkg:
+ python_pkg_version = apport.packaging.get_version(python_pkg)
+ python_version = apport.hookutils.command_output([python_link, "--version"])
+ data = f"{python_link}, {python_version}"
+ if python_pkg:
+ data += f", {python_pkg}, {python_pkg_version}"
+ else:
+ data += ", unpackaged"
+ report[key] = data
+
+
+def main(): # pylint: disable=missing-function-docstring
+ # for testing: update report file given on command line
+ if len(sys.argv) != 2:
+ sys.stderr.write(f"Usage for testing this hook: {sys.argv[0]} <report file>\n")
+ sys.exit(1)
+
+ report_file = sys.argv[1]
+
+ report = apport.Report()
+ with open(report_file, "rb") as report_fd:
+ report.load(report_fd)
+ report_keys = set(report.keys())
+
+ new_report = report.copy()
+ add_info(new_report, None)
+
+ new_report_keys = set(new_report.keys())
+
+ # Show differences
+ # N.B. Some differences will exist if the report file is not from your
+ # system because the hook runs against your local system.
+ changed = 0
+ for key in sorted(report_keys | new_report_keys):
+ if key in new_report_keys and key not in report_keys:
+ print(f"+{key}: {new_report[key]}")
+ changed += 1
+ elif key in report_keys and key not in new_report_keys:
+ print(f"-{key}: (deleted)")
+ changed += 1
+ elif key in report_keys and key in new_report_keys:
+ if report[key] != new_report[key]:
+ print(f"~{key}: (changed)")
+ changed += 1
+ print(f"{changed} items changed")
+
+
+if __name__ == "__main__":
+ main()

56
debian/patches/Default-to-Ubuntu-crash-DB.patch vendored
View File

@ -1,56 +0,0 @@
From: Benjamin Drung <bdrung@ubuntu.com>
Date: Thu, 9 Jun 2022 15:32:50 +0200
Subject: Default to Ubuntu crash DB
Forwarded: not-needed
---
etc/apport/crashdb.conf | 30 +++++++++++++++++-------------
1 file changed, 17 insertions(+), 13 deletions(-)
diff --git a/etc/apport/crashdb.conf b/etc/apport/crashdb.conf
index f826b7c..3f64a13 100644
--- a/etc/apport/crashdb.conf
+++ b/etc/apport/crashdb.conf
@@ -1,6 +1,18 @@
# map crash database names to CrashDatabase implementations and URLs
-default = 'debug'
+default = 'ubuntu'
+
+def get_oem_project():
+ '''Determine OEM project name from Distribution Channel Descriptor
+
+ Return None if it cannot be determined or does not exist.
+ '''
+ try:
+ dcd = open('/var/lib/ubuntu_dist_channel').read()
+ if dcd.startswith('canonical-oem-'):
+ return dcd.split('-')[2]
+ except IOError:
+ return None
databases = {
'ubuntu': {
@@ -11,18 +23,10 @@ databases = {
'escalation_tag': 'bugpattern-needed',
'escalated_tag': 'bugpattern-written',
},
- 'fedora': {
- # NOTE this will change Fall '07 when RHT switches to bugzilla 3.x!
- 'impl': 'rhbugzilla',
- 'bug_pattern_url': 'http://qa.fedoraproject.org/apport/bugpatterns.xml',
- 'distro': 'fedora'
- },
- 'debian': {
- 'impl': 'debian',
- 'distro': 'debian',
- 'smtphost': 'reportbug.debian.org',
- 'recipient': 'submit@bugs.debian.org',
- 'sender': ''
+ 'canonical-oem': {
+ 'impl': 'launchpad',
+ 'bug_pattern_url': 'http://people.canonical.com/~ubuntu-archive/bugpatterns/bugpatterns.xml',
+ 'project': get_oem_project(),
},
'snap-github': {
'impl': 'github',

20
debian/patches/Disable-Launchpad-crash-reports-for-the-24.04-release.patch vendored
View File

@ -1,20 +0,0 @@
From: Benjamin Drung <benjamin.drung@canonical.com>
Date: Thu, 18 Apr 2024 14:50:33 +0200
Subject: Disable Launchpad crash reports for the 24.04 release
---
etc/apport/crashdb.conf | 1 +
1 file changed, 1 insertion(+)
diff --git a/etc/apport/crashdb.conf b/etc/apport/crashdb.conf
index 3f64a13..3dac679 100644
--- a/etc/apport/crashdb.conf
+++ b/etc/apport/crashdb.conf
@@ -20,6 +20,7 @@ databases = {
'bug_pattern_url': 'http://people.canonical.com/~ubuntu-archive/bugpatterns/bugpatterns.xml',
'dupdb_url': 'http://people.canonical.com/~ubuntu-archive/apport-duplicates',
'distro': 'ubuntu',
+ 'problem_types': ['Bug', 'Package'],
'escalation_tag': 'bugpattern-needed',
'escalated_tag': 'bugpattern-written',
},

4
debian/patches/series vendored
View File

@ -1,4 +0,0 @@
Add-bin-oem-getlogs.patch
Add-general-hooks.patch
Default-to-Ubuntu-crash-DB.patch
Disable-Launchpad-crash-reports-for-the-24.04-release.patch

2
debian/source/format vendored
View File

@ -1 +1 @@
3.0 (quilt)
3.0 (native)