audacity::sentry::AnonymizedMessage Class Reference

A class, that stores anonymized message. More...

#include <AnonymizedMessage.h>

Collaboration diagram for audacity::sentry::AnonymizedMessage:

Public Member Functions
	AnonymizedMessage ()=default
	Creates an empty message. More...
	AnonymizedMessage (const AnonymizedMessage &)=default
	AnonymizedMessage (AnonymizedMessage &&)=default
AnonymizedMessage &	operator= (const AnonymizedMessage &)=default
AnonymizedMessage &	operator= (AnonymizedMessage &&)=default
	AnonymizedMessage (std::string message)
	Creates a message from std::string. More...
	AnonymizedMessage (const std::wstring &message)
	Creates a message from std::wstring. More...
	AnonymizedMessage (const wxString &message)
	Creates a message from wxString. More...
	AnonymizedMessage (const char *message)
	Creates a message from const char*. More...
	AnonymizedMessage (const wchar_t *message)
	Creates a message from const wchar_t*. More...
bool	Empty () const noexcept
	Checks, if the message is empty. More...
size_t	Length () const noexcept
	Returns the length of the message. More...
const std::string &	GetString () const noexcept
	Returns the UTF8 representation of the message. More...
wxString	ToWXString () const noexcept
	Convert the message to wxString. More...
const char *	c_str () const noexcept
	Checks, if the message is empty. More...
size_t	length () const noexcept
	Returns the length of the message. More...

Private Member Functions
void	CleanupPaths ()

Private Attributes
std::string	mMessage

Detailed Description

A class, that stores anonymized message.

Input message is anonymized by looking for path-like patterns. Messages are stored in UTF8 format.

Definition at line 25 of file AnonymizedMessage.h.

Constructor & Destructor Documentation

AnonymizedMessage() [1/8]

audacity::sentry::AnonymizedMessage::AnonymizedMessage ( )

default

Creates an empty message.

AnonymizedMessage() [2/8]

audacity::sentry::AnonymizedMessage::AnonymizedMessage ( const AnonymizedMessage &  )

default

AnonymizedMessage() [3/8]

audacity::sentry::AnonymizedMessage::AnonymizedMessage ( AnonymizedMessage &&  )

default

AnonymizedMessage() [4/8]

audacity::sentry::AnonymizedMessage::AnonymizedMessage

(

std::string

message

)

Creates a message from std::string.

Definition at line 22 of file AnonymizedMessage.cpp.

    : mMessage(std::move(message))
{
   CleanupPaths();
}

References CleanupPaths().

Here is the call graph for this function:

AnonymizedMessage() [5/8]

audacity::sentry::AnonymizedMessage::AnonymizedMessage

(

const std::wstring &

message

)

Creates a message from std::wstring.

Definition at line 28 of file AnonymizedMessage.cpp.

    : AnonymizedMessage(ToUTF8(message))
{
}

AnonymizedMessage() [6/8]

audacity::sentry::AnonymizedMessage::AnonymizedMessage

(

const wxString &

message

)

Creates a message from wxString.

Definition at line 33 of file AnonymizedMessage.cpp.

    : AnonymizedMessage(ToUTF8(message))
{
}

AnonymizedMessage() [7/8]

audacity::sentry::AnonymizedMessage::AnonymizedMessage

(

const char *

message

)

Creates a message from const char*.

Definition at line 38 of file AnonymizedMessage.cpp.

    : AnonymizedMessage(std::string(message))
{
}

AnonymizedMessage() [8/8]

audacity::sentry::AnonymizedMessage::AnonymizedMessage

(

const wchar_t *

message

)

Creates a message from const wchar_t*.

Definition at line 43 of file AnonymizedMessage.cpp.

    : AnonymizedMessage(ToUTF8(message))
{
}

Member Function Documentation

c_str()

const char * audacity::sentry::AnonymizedMessage::c_str ( ) const

noexcept

Checks, if the message is empty.

Definition at line 68 of file AnonymizedMessage.cpp.

{
   return mMessage.c_str();
}

References mMessage.

Referenced by audacity::sentry::Report::ReportImpl::ReportImpl(), and audacity::sentry::anonymous_namespace{SentryReport.cpp}::SerializeException().

Here is the caller graph for this function:

CleanupPaths()

void audacity::sentry::AnonymizedMessage::CleanupPaths ( )

private

Definition at line 78 of file AnonymizedMessage.cpp.

{
   // Finding the path boundary in the arbitrary text is a hard task.
   // We assume that spaces cannot be a part of the path.
   // In the worst case - we will get <path> <path>
   static const std::regex re(
      R"(\b(?:(?:[a-zA-Z]:)?[\\/]?)?(?:[^<>:"/|\\/?\s*]+[\\/]+)*(?:[^<>:"/|\\/?*\s]+\.\w+)?)");
 
   mMessage = std::regex_replace(
      mMessage, re, "<path>", std::regex_constants::match_not_null);
}

References mMessage.

Referenced by AnonymizedMessage().

Here is the caller graph for this function:

Empty()

bool audacity::sentry::AnonymizedMessage::Empty ( ) const

noexcept

Checks, if the message is empty.

Definition at line 48 of file AnonymizedMessage.cpp.

{
   return mMessage.empty();
}

References mMessage.

GetString()

const std::string & audacity::sentry::AnonymizedMessage::GetString ( ) const

noexcept

Returns the UTF8 representation of the message.

Definition at line 58 of file AnonymizedMessage.cpp.

{
   return mMessage;
}

References mMessage.

Length()

size_t audacity::sentry::AnonymizedMessage::Length ( ) const

noexcept

Returns the length of the message.

Definition at line 53 of file AnonymizedMessage.cpp.

{
   return mMessage.size();
}

References mMessage.

length()

size_t audacity::sentry::AnonymizedMessage::length ( ) const

noexcept

Returns the length of the message.

Definition at line 73 of file AnonymizedMessage.cpp.

{
   return mMessage.length();
}

References mMessage.

Referenced by audacity::sentry::Report::ReportImpl::ReportImpl(), and audacity::sentry::anonymous_namespace{SentryReport.cpp}::SerializeException().

Here is the caller graph for this function:

operator=() [1/2]

AnonymizedMessage & audacity::sentry::AnonymizedMessage::operator= ( AnonymizedMessage &&  )

default

operator=() [2/2]

AnonymizedMessage & audacity::sentry::AnonymizedMessage::operator= ( const AnonymizedMessage &  )

default

ToWXString()

wxString audacity::sentry::AnonymizedMessage::ToWXString ( ) const

noexcept

Convert the message to wxString.

Definition at line 63 of file AnonymizedMessage.cpp.

{
   return audacity::ToWXString(mMessage);
}

References mMessage, and audacity::ToWXString().

Here is the call graph for this function:

Member Data Documentation

mMessage

std::string audacity::sentry::AnonymizedMessage::mMessage

private

Definition at line 66 of file AnonymizedMessage.h.

Referenced by c_str(), CleanupPaths(), Empty(), GetString(), Length(), length(), and ToWXString().

---

The documentation for this class was generated from the following files:

• AnonymizedMessage.h
• AnonymizedMessage.cpp