crashreport.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#ifndef INCLUDED_DESKTOP_CRASHREPORT_HXX
#define INCLUDED_DESKTOP_CRASHREPORT_HXX

#include <desktop/dllapi.h>

#include <rtl/ustring.hxx>
#include <osl/mutex.hxx>

#include <config_features.h>

// vector not sort the entries
#include <memory>
#include <vector>
#include <deque>
#include <string>

namespace google_breakpad
{
class ExceptionHandler;
}

class
#if HAVE_FEATURE_BREAKPAD
// MSVC 2013 has undefined symbols for inline functions if it's exported
CRASHREPORT_DLLPUBLIC
#endif
/*class*/ CrashReporter
{
public:
    typedef enum {AddItem, Write, Create} tAddKeyHandling;
#if HAVE_FEATURE_BREAKPAD
    static void addKeyValue(const OUString& rKey, const OUString& rValue, tAddKeyHandling AddKeyHandling);

    static void installExceptionHandler();
    static void removeExceptionHandler();

    static void setActiveSfxObjectName(const OUString& rActiveSfxObjectName);
    static OUString getActiveSfxObjectName();

    static void logUnoCommand(const OUString& rUnoCommand);
    static OUString getLoggedUnoCommands();

    static bool crashReportInfoExists();

    static bool readSendConfig(std::string& response);

    static bool IsDumpEnable();

private:
    static osl::Mutex maMutex;
    static osl::Mutex maActiveSfxObjectNameMutex;
    static osl::Mutex maUnoLogCmdMutex;
    static bool mbInit;
    typedef  struct _mpair
    {
        OUString first;
        OUString second;
        _mpair(const OUString& First, const OUString& Second)
        {
            first  = First;
            second = Second;
        };
    } mpair;

    typedef std::vector<mpair> vmaKeyValues;
    static vmaKeyValues maKeyValues; // used to temporarily save entries before the old info has been uploaded
    typedef std::deque<OUString> vmaloggedUnoCommands;
    static vmaloggedUnoCommands maloggedUnoCommands;
    static OUString msActiveSfxObjectName;

    static std::unique_ptr<google_breakpad::ExceptionHandler> mpExceptionHandler;

    static std::string getIniFileName();
    static void writeCommonInfo();
    static void writeSystemInfo();
    static void writeToFile(std::ios_base::openmode Openmode);
    // when we create the ExceptionHandler we have no access to the user
    // profile yet, so update when we have access
    static void updateMinidumpLocation();

#else
    // Add dummy methods for the non-breakpad case. That allows us to use
    // // the code without linking to the lib and without adding HAVE_FEATURE_BREAKPAD
    // // everywhere we want to log something to the crash report system.
    inline static void addKeyValue(SAL_UNUSED_PARAMETER const OUString& /*rKey*/, SAL_UNUSED_PARAMETER const OUString& /*rValue*/, SAL_UNUSED_PARAMETER tAddKeyHandling /*AddKeyHandling*/) {};
    inline static void setActiveSfxObjectName(SAL_UNUSED_PARAMETER const OUString& /*rActiveSfxObjectName*/) {};
    inline static OUString getActiveSfxObjectName()
    {
        return OUString();
    }
    inline static void logUnoCommand(SAL_UNUSED_PARAMETER const OUString& /*rUnoCommand*/) {};
    inline static OUString getLoggedUnoCommands()
    {
        return OUString();
    }
#endif // HAVE_FEATURE_BREAKPAD
};

#endif // INCLUDED_DESKTOP_CRASHREPORT_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */