Merge ~bryce/ubuntu/+source/squid:fix-lp676141-noble into ubuntu/+source/squid:ubuntu/noble-devel

[Bryce Harrington]

Adds an apport hook for squid, that adds a couple config files and (optionally) some log files.

Bug: https://bugs.launchpad.net/ubuntu/+source/squid/+bug/676141
PPA: https://launchpad.net/~bryce/+archive/ubuntu/squid-fix-lp676141

To test, install this package on noble, and then run:
  $ python3 /usr/share/apport/package-hooks/source_squid.py

This will dump to the console what it would attach to the bug. Unfortunately squid's config file consists of a huge amount of commented out lines, but I don't think it's worth filtering pre-submission and risk losing something important.

[Utkarsh Gupta (utkarsh)]

review: Needs Information

[Utkarsh Gupta (utkarsh)]

review: Approve

[git-ubuntu bot (git-ubuntu-bot)]

Approvers: bryce, utkarsh
Uploaders: bryce, utkarsh
MP auto-approved

review: Approve

[Bryce Harrington (bryce)]

Thanks Utkarsh, uploaded:

Successfully signed dsc, buildinfo, changes files
Vcs-Git: https://git.launchpad.net/~bryce/ubuntu/+source/squid
Vcs-Git-Commit: fecdce8b53d7d071786cef2fae8143a96d85a0ce
Vcs-Git-Ref: refs/heads/fix-lp676141-noble
$ dput ubuntu ../squid_6.5-1ubuntu2_source.changes
gpg: ../squid_6.5-1ubuntu2_source.changes: Valid signature from E603B2578FB8F0FB
gpg: ../squid_6.5-1ubuntu2.dsc: Valid signature from E603B2578FB8F0FB
D: Setting host argument.
Checking signature on .changes
Checking signature on .dsc
Uploading to ubuntu (via ftp to upload.ubuntu.com):
  Uploading squid_6.5-1ubuntu2.dsc: done.
  Uploading squid_6.5-1ubuntu2.debian.tar.xz: done.
  Uploading squid_6.5-1ubuntu2_source.buildinfo: done.
  Uploading squid_6.5-1ubuntu2_source.changes: done.
Successfully uploaded packages.

diff --git a/debian/changelog b/debian/changelog
index 1eb4efa..e279bbd 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+squid (6.5-1ubuntu2) noble; urgency=medium
+
+  * d/source_squid.py, d/rules: Add apport hook
+    (LP: #676141)
+
+ -- Bryce Harrington <[e-mail]>  Thu, 18 Jan 2024 15:13:36 -0800
+
 squid (6.5-1ubuntu1) noble; urgency=medium
 
   * Merge with Debian unstable (LP: #2040426). Remaining changes:
diff --git a/debian/rules b/debian/rules
index df1c1f5..8c6860a 100755
--- a/debian/rules
+++ b/debian/rules
@@ -165,6 +165,10 @@ execute_after_dh_auto_install:
 	dh_apparmor --profile-name=usr.sbin.squid -psquid
 
 override_dh_install:
+	# Apport hook
+	dh_install -psquid-common debian/source_squid.py \
+		usr/share/apport/package-hooks/
+
 	dh_install -psquid -psquid-common -psquidclient -psquid-cgi -psquid-purge \
 		--sourcedir=$(INSTALLDIR)
 	dh_install -psquid-openssl \
diff --git a/debian/source_squid.py b/debian/source_squid.py
new file mode 100644
index 0000000..c23e6da
--- /dev/null
+++ b/debian/source_squid.py
@@ -0,0 +1,54 @@
+#!/usr/bin/python3
+
+'''
+Apport package hook for Squid
+
+Copyright (C) 2022 Canonical Ltd.
+Author: Bryce Harrington <[e-mail]>
+
+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.path
+from apport.hookutils import attach_file_if_exists
+
+
+def add_info(report, ui=None):
+    '''Attaches squid-specific information to the Apport bug report.'''
+    def _add_file(report, filepath):
+        filename = os.path.basename(filepath)
+        attach_file_if_exists(report, filepath, key=filename)
+
+    # Configs
+    _add_file(report, '/etc/squid/squid.conf')
+    _add_file(report, '/etc/squid/squid.d/debian.conf')
+
+    if ui is None:
+        return
+
+    # Logs
+    response = ui.yesno(
+        "The contents of your Squid cache.log and access.log files "
+        "may help developers diagnose your bug more quickly.  "
+        "However, they may contain sensitive " "information.  "
+        "Do you want to include them in your bug report?"
+    )
+    if response is None:
+        # user cancelled
+        raise StopIteration
+    if response is True:
+        # Attach files
+        _add_file(report, '/var/log/squid/access.log')
+        _add_file(report, '/var/log/squid/cache.log')
+
+
+### DEBUGGING ###
+if __name__ == '__main__':
+    report = {}
+    add_info(report, None)
+    for key in report:
+        print(f'[{key}]\n{report[key]}')