Source code for stoqlib.lib.crashreport

# -*- coding: utf-8 -*-
# vi:si:et:sw=4:sts=4:ts=4

## Copyright (C) 2011 Async Open Source <>
## All rights reserved
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU Lesser 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
## GNU Lesser General Public License for more details.
## You should have received a copy of the GNU Lesser General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., or visit:
## Author(s): Stoq Team <>
""" Crash report logic """

import datetime
import hashlib
import logging
import sys
import time
import traceback
import os

import gobject
from kiwi.component import get_utility
from kiwi.utils import gsignal

    import raven
    has_raven = True
except ImportError:
    has_raven = False

import stoq
from stoqlib.database.runtime import get_default_store
from stoqlib.lib.environment import is_developer_mode
from stoqlib.lib.interfaces import IAppInfo
from stoqlib.lib.osutils import get_product_key
from stoqlib.lib.osutils import get_system_locale
from stoqlib.lib.parameters import sysparam
from stoqlib.lib.pluginmanager import InstalledPlugin
from stoqlib.lib.threadutils import schedule_in_main_thread
from stoqlib.lib.uptime import get_uptime
from stoqlib.lib.webservice import WebService, get_main_cnpj

log = logging.getLogger(__name__)
_tracebacks = []

_N_TRIES = 3

def _get_revision(module):
    if not hasattr(module, 'library'):
        return ''

    if not hasattr(module.library, 'get_revision'):
        return ''

    revision = module.library.get_revision()
    if revision is None:
        return ''
    return revision

def _fix_version(version):
    if isinstance(version, (list, tuple)):
        version = '.'.join(map(str, version))
    return str(version)

[docs]def collect_report(): report_ = {} # Date and uptime report_['date'] ='%Y-%m-%d %H:%M:%S') report_['tz'] = time.tzname report_['uptime'] = get_uptime() report_['locale'] = get_system_locale() # Python and System import platform report_['architecture'] = ' '.join(platform.architecture()) report_['distribution'] = ' '.join(platform.dist()) report_['python_version'] = _fix_version(sys.version_info) report_['uname'] = ' '.join(platform.uname()) report_['system'] = platform.system() # Stoq application info = get_utility(IAppInfo, None) if info and info.get('name'): report_['app_name'] = info.get('name') report_['app_version'] = _fix_version(info.get('ver')) # External dependencies import gtk report_['pygtk_version'] = _fix_version(gtk.pygtk_version) report_['gtk_version'] = _fix_version(gtk.gtk_version) import kiwi report_['kiwi_version'] = _fix_version( kiwi.__version__.version + (_get_revision(kiwi), )) import psycopg2 try: parts = psycopg2.__version__.split(' ') extra = ' '.join(parts[1:]) report_['psycopg_version'] = _fix_version( map(int, parts[0].split('.')) + [extra]) except Exception: report_['psycopg_version'] = _fix_version(psycopg2.__version__) import reportlab report_['reportlab_version'] = _fix_version(reportlab.Version) import stoqdrivers report_['stoqdrivers_version'] = _fix_version( stoqdrivers.__version__ + (_get_revision(stoqdrivers), )) report_['product_key'] = get_product_key() try: from stoqlib.lib.kiwilibrary import library report_['bdist_type'] = library.bdist_type except Exception: pass # PostgreSQL database server try: from stoqlib.database.settings import get_database_version default_store = get_default_store() report_['postgresql_version'] = _fix_version( get_database_version(default_store)) report_['demo'] = sysparam.get_bool('DEMO_MODE') report_['hash'] = sysparam.get_string('USER_HASH') report_['cnpj'] = get_main_cnpj(default_store) report_['plugins'] = ', '.join( InstalledPlugin.get_plugin_names(default_store)) except Exception: pass # Tracebacks report_['tracebacks'] = {} for i, trace in enumerate(_tracebacks): t = ''.join(traceback.format_exception(*trace)) # Eliminate duplicates: md5sum = hashlib.md5(t).hexdigest() report_['tracebacks'][md5sum] = t if info and info.get('log'): report_['log'] = open(info.get('log')).read() report_['log_name'] = info.get('log') return report_
[docs]def collect_traceback(tb, output=True, submit=False): """Collects traceback which might be submitted @output: if it is to be printed @submit: if it is to be submitted immediately """ _tracebacks.append(tb) if output: traceback.print_exception(*tb) if has_raven and not is_developer_mode(): # pragma no cover extra = collect_report() extra.pop('tracebacks') sentry_url = os.environ.get( 'STOQ_SENTRY_URL', ('https://89169350b0c0434895e315aa6490341a:' '')) client = raven.Client(sentry_url, release=stoq.version) if hasattr(client, 'user_context'): client.user_context({'id': extra.get('hash', None), 'username': extra.get('cnpj', None)}) # Don't sent logs to sentry if 'log' in extra: del extra['log'] if 'log_name' in extra: del extra['log_name'] tags = {} for name in ['architecture', 'cnpj', 'system', 'app_name', 'bdist_type', 'app_version', 'distribution', 'python_version', 'psycopg_version', 'pygtk_version', 'gtk_version', 'kiwi_version', 'reportlab_version', 'stoqdrivers_version', 'postgresql_version']: value = extra.pop(name, None) if value is None: continue tags[name] = value client.captureException(tb, tags=tags, extra=extra) if is_developer_mode() and submit: rs = ReportSubmitter() r = rs.submit() r.get_response()
[docs]def has_tracebacks(): return bool(_tracebacks)
[docs]class ReportSubmitter(gobject.GObject): gsignal('failed', object) gsignal('submitted', object) def __init__(self): gobject.GObject.__init__(self) self._count = 0 self._api = WebService() = collect_report() def _done(self, args): self.emit('submitted', args) def _error(self, args): self.emit('failed', args)
[docs] def submit(self): return self._api.bug_report(, callback=self._on_report__callback, errback=self._on_report__errback)
def _on_report__callback(self, response): if response.status_code == 200: self._on_success(response.json()) else: self._on_error() def _on_report__errback(self, failure): self._on_error(failure) def _on_error(self, data=None):'Failed to report bug: %r count=%d' % (data, self._count)) if self._count < _N_TRIES: self.submit() else: schedule_in_main_thread(self.emit, 'failed', data) self._count += 1 def _on_success(self, data):'Finished sending bugreport: %r' % (data, )) schedule_in_main_thread(self.emit, 'submitted', data)