Ensure debug mode is enabled for user reports. (#8)

This should hopefully stop the stream of unhelpful reports.

There is now a dialog yes/no to confirm creating the issue/uploading log. Plently of issues have undoubtedly come from curious users checking any setting they can.

Some issues have also been failing to submit due to the unicode error that caused the issue also causing the issue reporter to fail. It seems to always be from unicode contained in large JSON or XML files which is included in the exception args. When the issue formatter tries to split the exception data on newlines there is then a list hundreds of items long that is passed to the xbmcgui Dialog object which only takes a max of 3, causing failure. We now omit the data which caused the exception which is ok because ther is enough information in the log to get to the source which caused it including the position of the offending unicode character.

Author: glennguy

lib/aussieaddonscommon/issue_reporter.py

@@ -157,7 +157,9 @@ def is_reportable(exc_type, exc_value, exc_traceback):
     """
 
     # AttributeError: global name 'foo' is not defined
-    error = '%s: %s' % (exc_type.__name__, ', '.join(exc_value.args))
+    error = '%s: %s' % (
+        exc_type.__name__, ', '.join(
+            utils.ensure_ascii(x) for x in exc_value.args))
 
     # Don't show any dialogs when user cancels
     if exc_type.__name__ == 'SystemExit':

lib/aussieaddonscommon/utils.py

@@ -1,4 +1,5 @@
 import htmlentitydefs
+import json
 import os
 import re
 import sys
@@ -116,10 +117,14 @@ def format_error_summary():
     error message.
     """
     exc_type, exc_value, exc_traceback = sys.exc_info()
+
+    args = list(exc_value)
+    if exc_type == UnicodeEncodeError:
+        args.pop(1)  # remove error data, likely to be very long xml
     return "%s (%d) - %s: %s" % (
         os.path.basename(exc_traceback.tb_frame.f_code.co_filename),
         exc_traceback.tb_lineno, exc_type.__name__,
-        ', '.join(exc_value.args))
+        ', '.join([ensure_ascii(x) for x in args]))
 
 
 def log_error(message=None):
@@ -246,8 +251,24 @@ def is_valid_country(connection_info, message=None):
     return True
 
 
+def is_debug():
+    try:
+        json_query = ('{"jsonrpc":"2.0","id":1,"method":'
+                      '"Settings.GetSettingValue","params":'
+                      '{"setting":"debug.showloginfo"}}')
+        result = json.loads(xbmc.executeJSONRPC(json_query))
+        return result['result']['value']
+    except RuntimeError:
+        return True
+
+
 def user_report():
-    send_report('User initiated report', user_initiated=True)
+    if is_debug():
+        send_report('User initiated report', user_initiated=True)
+    else:
+        dialog_message(['Debug logging not enabled. '
+                        'Please enable debug logging,  restart Kodi, '
+                        'recreate the issue and try again.'])
 
 
 def send_report(title, trace=None, connection_info=None, user_initiated=False):
@@ -261,14 +282,20 @@ def send_report(title, trace=None, connection_info=None, user_initiated=False):
         if user_initiated:
             if not is_valid_country(connection_info):
                 return
-
+            if not xbmcgui.Dialog().yesno('{0} v{1}'.format(
+                get_addon_name(), get_addon_version()),
+                    'Please confirm you would like to submit an issue report '
+                    'and upload your logfile to Github. '):
+                return
         # Show dialog spinner, and close afterwards
         xbmc.executebuiltin("ActivateWindow(busydialog)")
         report_url = issue_reporter.report_issue(title, trace, connection_info)
 
         split_url = report_url.replace('/issue-reports', ' /issue-reports')
         dialog_message(['Thanks! Your issue has been reported to: ',
-                       split_url])
+                        split_url,
+                        'Please visit and describe the issue in order for '
+                        'us to assist.'])
         return report_url
     except Exception:
         traceback.print_exc()
@@ -298,7 +325,7 @@ def handle_error(message):
 
     # AttributeError: global name 'foo' is not defined
     error = '%s: %s' % (exc_type.__name__,
-                        ', '.join(str(e) for e in exc_value.args))
+                        ', '.join(ensure_ascii(e) for e in exc_value.args))
 
     message = format_dialog_error(message)