Merge lp:~brian-murray/ubuntu/oneiric/apport/conffile-handling into lp:~ubuntu-core-dev/ubuntu/oneiric/apport/ubuntu

[Brian Murray]

This branch raises a yes / no dialog in the event that a conffile is modified so that the reporter can make an informed decision about including the modified conffile.

I'd really rather that ui be a required argument to attach_conffiles so that source package hooks must pass ui to it as its possible the person writing the source package hook isn't familiar with the conffiles provided by the package and their contents.

If need be I'm willing to modify the source package hooks that call attach_conffiles to pass ui and then change the argument so that it no longer defaults to None.

[Martin Pitt (pitti)]

Thanks for this!

Some remarks:

 * Please don't change the API of attach_conffiles, i. e. add the new ui argument as the last one.
 * attach_conffiles() should not crash with a None ui, i. e. please check ui before calling yesno.
 * Needs "from apport import unicode_gettext as _" and wrapping the user visible string in _() for i18n
 * the "report[key] = '[modified]'" can just go into the else branch of the third if, and the first two ifs (which are redundant, "not False" is true) can be removed.

Thanks,

Martin

review: Needs Fixing

[lp:~brian-murray/ubuntu/oneiric/apport/conffile-handling]

1802. By Brian Murray on 2011-07-20

modifications based off reviewer feedback

[Brian Murray (brian-murray)]

I've updated the branch but did not implement the i18n bit as I think this would be an inconsistent experience for the reporter as source package hooks calls to ui are not translated.

[Martin Pitt (pitti)]

Thanks!

review: Approve

=== modified file 'apport/hookutils.py'
--- apport/hookutils.py	2011-07-14 16:13:38 +0000
+++ apport/hookutils.py	2011-07-20 16:36:13 +0000
@@ -80,7 +80,7 @@
             key += '_'
     report[key] = read_file(path)
 
-def attach_conffiles(report, package, conffiles=None):
+def attach_conffiles(report, package, conffiles=None, ui=None):
     '''Attach information about any modified or deleted conffiles'''
 
     try:
@@ -111,7 +111,14 @@
             calculated_md5sum = m.hexdigest()
 
             if calculated_md5sum != default_md5sum:
-                report[key] = contents
+                if ui:
+                    response = ui.yesno("It seems you have modified the contents of '%s'.  Would you like to add the contents of it to your bug report?" % path)
+                    if response:
+                        report[key] = contents
+                    else:
+                        report[key] = '[modified]'
+                else:
+                    report[key] = '[modified]'
                 statinfo = os.stat(path)
                 mtime = datetime.datetime.fromtimestamp(statinfo.st_mtime)
                 mtime_key = 'mtime.conffile.' + path_to_key(path)

=== modified file 'data/general-hooks/ubuntu.py'
--- data/general-hooks/ubuntu.py	2011-07-20 05:01:57 +0000
+++ data/general-hooks/ubuntu.py	2011-07-20 16:36:13 +0000
@@ -18,7 +18,7 @@
 from apport.hookutils import *
 from apport import unicode_gettext as _
 
-def add_info(report):
+def add_info(report, ui):
     add_release_info(report)
 
     add_kernel_info(report)
@@ -61,7 +61,7 @@
     if 'Package' in report:
         package = report['Package'].split()[0]
         if package and 'attach_conffiles' in dir():
-            attach_conffiles(report, package)
+            attach_conffiles(report, package, 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']:

=== modified file 'debian/changelog'
--- debian/changelog	2011-07-20 05:01:57 +0000
+++ debian/changelog	2011-07-20 16:36:13 +0000
@@ -1,3 +1,4 @@
+<<<<<<< TREE
 apport (1.21.2-0ubuntu6) UNRELELASED; urgency=low
 
   * data/general-hooks/ubuntu.py:
@@ -7,6 +8,16 @@
 
  -- Brian Murray <[e-mail]>  Tue, 19 Jul 2011 13:01:37 -0700
 
+=======
+apport (1.21.2-0ubuntu6) oneiric; urgency=low
+
+  * apport/hookutils.py:
+    - raise a yes no dialog in the event a conffile has been modified
+      (LP: #811203)
+
+ -- Brian Murray <[e-mail]>  Tue, 19 Jul 2011 15:10:21 -0700
+
+>>>>>>> MERGE-SOURCE
 apport (1.21.2-0ubuntu5) oneiric; urgency=low
 
   * data/general-hooks/ubuntu.py: